Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

disable removeComments, add docmodel, inheritDoc processing #11290

Merged
merged 26 commits into from
Nov 22, 2023
Merged

disable removeComments, add docmodel, inheritDoc processing #11290

Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
04a040a
disable `removeComments`
phryneas Oct 16, 2023
eddb8cc
rollup adjustments
phryneas Oct 16, 2023
f4cd508
use `rollup-plugin-cleanup`
phryneas Oct 16, 2023
65e8386
adjust docblocks, new api report
phryneas Oct 16, 2023
10b5b48
update docblocks to match with docs
phryneas Oct 16, 2023
4fe9ba7
try new `InterfaceTable` docs component
phryneas Oct 25, 2023
9199450
preview build changes
phryneas Oct 25, 2023
99815c0
bump CI
phryneas Oct 25, 2023
da2fea3
some example usages
phryneas Oct 26, 2023
97c6121
do not pack `.d.ts.map` in the package
phryneas Oct 30, 2023
127c7ad
add support for inlining @inheritDoc comments
phryneas Oct 31, 2023
b16f8b5
use new components
phryneas Oct 31, 2023
5d364ed
reduce required frontmatter
phryneas Nov 3, 2023
f9c9ffe
bump CI
phryneas Nov 3, 2023
e554377
bump CI
phryneas Nov 3, 2023
35db4d6
use `customPropertyOrder`
phryneas Nov 3, 2023
3e5e229
move incorrect @params into correct positions
phryneas Nov 3, 2023
68eccdc
api-reports
phryneas Nov 3, 2023
ad77545
formatting
phryneas Nov 3, 2023
1815640
actually trigger docs deploy
phryneas Nov 3, 2023
2a26d9d
add explainer comment
phryneas Nov 16, 2023
a312a44
Merge remote-tracking branch 'origin/main' into pr/comments
phryneas Nov 21, 2023
893d1df
Clean up Prettier, Size-limit, and Api-Extractor
phryneas Nov 21, 2023
7a16383
Apply suggestions from code review
phryneas Nov 21, 2023
56fdb44
update comment
phryneas Nov 21, 2023
77220fe
preparations for deploy
phryneas Nov 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 4 additions & 29 deletions .api-reports/api-report-cache.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ export abstract class ApolloCache<TSerialized> implements DataProxy {
abstract diff<T>(query: Cache_2.DiffOptions): Cache_2.DiffResult<T>;
// (undocumented)
abstract evict(options: Cache_2.EvictOptions): boolean;
// (undocumented)
abstract extract(optimistic?: boolean): TSerialized;
// (undocumented)
gc(): string[];
Expand All @@ -49,7 +48,6 @@ export abstract class ApolloCache<TSerialized> implements DataProxy {
abstract removeOptimistic(id: string): void;
// (undocumented)
abstract reset(options?: Cache_2.ResetOptions): Promise<void>;
// (undocumented)
abstract restore(serializedState: TSerialized): ApolloCache<TSerialized>;
// (undocumented)
transformDocument(document: DocumentNode): DocumentNode;
Expand Down Expand Up @@ -212,40 +210,27 @@ export namespace DataProxy {
};
// (undocumented)
export interface Fragment<TVariables, TData> {
// (undocumented)
fragment: DocumentNode | TypedDocumentNode<TData, TVariables>;
// (undocumented)
fragmentName?: string;
// (undocumented)
id?: string;
// (undocumented)
variables?: TVariables;
}
// (undocumented)
export interface Query<TVariables, TData> {
// (undocumented)
id?: string;
// (undocumented)
query: DocumentNode | TypedDocumentNode<TData, TVariables>;
// (undocumented)
variables?: TVariables;
}
// (undocumented)
export interface ReadFragmentOptions<TData, TVariables> extends Fragment<TVariables, TData> {
// (undocumented)
canonizeResults?: boolean;
// (undocumented)
optimistic?: boolean;
// (undocumented)
returnPartialData?: boolean;
}
// (undocumented)
export interface ReadQueryOptions<TData, TVariables> extends Query<TVariables, TData> {
// (undocumented)
canonizeResults?: boolean;
// (undocumented)
optimistic?: boolean;
// (undocumented)
returnPartialData?: boolean;
}
// (undocumented)
Expand All @@ -259,27 +244,20 @@ export namespace DataProxy {
}
// (undocumented)
export interface WriteOptions<TData> {
// (undocumented)
broadcast?: boolean;
// (undocumented)
data: TData;
// (undocumented)
overwrite?: boolean;
}
// (undocumented)
export interface WriteQueryOptions<TData, TVariables> extends Query<TVariables, TData>, WriteOptions<TData> {
}
}

// @public (undocumented)
// @public
export interface DataProxy {
// (undocumented)
readFragment<FragmentType, TVariables = any>(options: DataProxy.ReadFragmentOptions<FragmentType, TVariables>, optimistic?: boolean): FragmentType | null;
// (undocumented)
readQuery<QueryType, TVariables = any>(options: DataProxy.ReadQueryOptions<QueryType, TVariables>, optimistic?: boolean): QueryType | null;
// (undocumented)
writeFragment<TData = any, TVariables = any>(options: DataProxy.WriteFragmentOptions<TData, TVariables>): Reference | undefined;
// (undocumented)
writeQuery<TData = any, TVariables = any>(options: DataProxy.WriteQueryOptions<TData, TVariables>): Reference | undefined;
}

Expand Down Expand Up @@ -465,7 +443,7 @@ type FieldValueGetter = EntityStore["getFieldValue"];
// @public (undocumented)
type FlavorableWriteContext = Pick<WriteContext, "clientOnly" | "deferred" | "flavors">;

// @public (undocumented)
// @public
interface FragmentMap {
// (undocumented)
[fragmentName: string]: FragmentDefinitionNode;
Expand Down Expand Up @@ -699,7 +677,7 @@ export type Modifiers<T extends Record<string, any> = Record<string, unknown>> =
[FieldName in keyof T]: Modifier<StoreObjectValueMaybeReference<Exclude<T[FieldName], undefined>>>;
}>;

// @public (undocumented)
// @public
export interface NormalizedCache {
// (undocumented)
canRead: CanReadFunction;
Expand All @@ -725,17 +703,14 @@ export interface NormalizedCache {
modify<Entity extends Record<string, any>>(dataId: string, fields: Modifiers<Entity> | AllFieldsModifier<Entity>): boolean;
// (undocumented)
release(rootId: string): number;
// (undocumented)
replace(newData: NormalizedCacheObject): void;
// (undocumented)
retain(rootId: string): number;
// (undocumented)
toObject(): NormalizedCacheObject;
// (undocumented)
toReference: ToReferenceFunction;
}

// @public (undocumented)
// @public
export interface NormalizedCacheObject {
// (undocumented)
[dataId: string]: StoreObject | undefined;
Expand Down
Loading