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.

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
Show file tree
Hide file tree
Changes from 20 commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
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
35 changes: 5 additions & 30 deletions .api-reports/api-report-cache.md
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 Expand Up @@ -951,7 +926,7 @@ interface WriteContext extends ReadMergeModifyContext {
// src/cache/inmemory/policies.ts:98:3 - (ae-forgotten-export) The symbol "FragmentMap" needs to be exported by the entry point index.d.ts
// src/cache/inmemory/policies.ts:167:3 - (ae-forgotten-export) The symbol "KeySpecifier" needs to be exported by the entry point index.d.ts
// src/cache/inmemory/policies.ts:167:3 - (ae-forgotten-export) The symbol "KeyArgsFunction" needs to be exported by the entry point index.d.ts
// src/cache/inmemory/types.ts:126:3 - (ae-forgotten-export) The symbol "KeyFieldsFunction" needs to be exported by the entry point index.d.ts
// src/cache/inmemory/types.ts:132:3 - (ae-forgotten-export) The symbol "KeyFieldsFunction" needs to be exported by the entry point index.d.ts

// (No @packageDocumentation comment for this package)

Expand Down
Loading