Skip to content

Commit 2f1dacf

Browse files
phryneasphryneas
committed
chores
1 parent 17d551e commit 2f1dacf

File tree

4 files changed

+456
-221
lines changed

4 files changed

+456
-221
lines changed

‎.api-reports/api-report-cache.api.md‎

Lines changed: 85 additions & 94 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ import { canonicalStringify } from '@apollo/client/utilities';
1010
import type { DataValue } from '@apollo/client';
1111
import type { DeepPartial } from '@apollo/client/utilities';
1212
import type { DocumentNode } from 'graphql';
13+
import type { DocumentNode as DocumentNode_2 } from '@apollo/client';
1314
import type { FieldNode } from 'graphql';
1415
import type { FragmentDefinitionNode } from 'graphql';
1516
import type { FragmentMap } from '@apollo/client/utilities/internal';
@@ -29,7 +30,6 @@ import type { StoreObject } from '@apollo/client/utilities';
2930
import type { StoreValue } from '@apollo/client/utilities';
3031
import { Trie } from '@wry/trie';
3132
import type { TypedDocumentNode } from '@apollo/client';
32-
import type { TypedDocumentNode as TypedDocumentNode_2 } from '@graphql-typed-document-node/core';
3333
import type { Unmasked } from '@apollo/client/masking';
3434

3535
// Warning: (ae-forgotten-export) The symbol "StoreObjectValueMaybeReference" needs to be exported by the entry point index.d.ts
@@ -56,7 +56,7 @@ export namespace ApolloCache {
5656
}
5757

5858
// @public (undocumented)
59-
export abstract class ApolloCache implements DataProxy {
59+
export abstract class ApolloCache {
6060
// (undocumented)
6161
readonly assumeImmutableResults: boolean;
6262
// (undocumented)
@@ -80,13 +80,13 @@ export abstract class ApolloCache implements DataProxy {
8080
// (undocumented)
8181
abstract performTransaction(transaction: Transaction, optimisticId?: string | null): void;
8282
// (undocumented)
83-
abstract read<TData = unknown, TVariables = OperationVariables>(query: Cache_2.ReadOptions<TVariables, TData>): Unmasked<TData> | null;
84-
readFragment<TData = unknown, TVariables = OperationVariables>({ fragment, variables, fragmentName, id, optimistic, returnPartialData, }: Cache_2.ReadFragmentOptions<TData, TVariables>): Unmasked<TData> | null;
83+
abstract read<TData = unknown, TVariables extends OperationVariables = OperationVariables>(query: Cache_2.ReadFnOptions<TData, TVariables>): Unmasked<TData> | null;
84+
readFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>({ fragment, variables, fragmentName, id, optimistic, returnPartialData, }: Cache_2.ReadFragmentOptions<TData, TVariables>): Unmasked<TData> | null;
8585
// (undocumented)
86-
readFragment<TData = unknown, TVariables = OperationVariables>(options: Cache_2.ReadFragmentOptions<TData, TVariables>,
86+
readFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: Cache_2.ReadFragmentOptions<TData, TVariables>,
8787
optimistic: boolean): Unmasked<TData> | null;
88-
readQuery<TData = unknown, TVariables = OperationVariables>({ query, variables, id, optimistic, returnPartialData, }: Cache_2.ReadQueryOptions<TData, TVariables>): Unmasked<TData> | null;
89-
readQuery<TData = unknown, TVariables = OperationVariables>(options: Cache_2.ReadQueryOptions<TData, TVariables>,
88+
readQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>({ query, variables, id, optimistic, returnPartialData, }: Cache_2.ReadQueryOptions<TData, TVariables>): Unmasked<TData> | null;
89+
readQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: Cache_2.ReadQueryOptions<TData, TVariables>,
9090
optimistic: boolean): Unmasked<TData> | null;
9191
// (undocumented)
9292
recordOptimisticTransaction(transaction: Transaction, optimisticId: string): void;
@@ -100,16 +100,16 @@ export abstract class ApolloCache implements DataProxy {
100100
// (undocumented)
101101
transformForLink(document: DocumentNode): DocumentNode;
102102
// (undocumented)
103-
updateFragment<TData = unknown, TVariables = OperationVariables>(options: Cache_2.UpdateFragmentOptions<TData, TVariables>, update: (data: Unmasked<TData> | null) => Unmasked<TData> | null | void): Unmasked<TData> | null;
103+
updateFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: Cache_2.UpdateFragmentOptions<TData, TVariables>, update: (data: Unmasked<TData> | null) => Unmasked<TData> | null | void): Unmasked<TData> | null;
104104
// (undocumented)
105-
updateQuery<TData = unknown, TVariables = OperationVariables>(options: Cache_2.UpdateQueryOptions<TData, TVariables>, update: (data: Unmasked<TData> | null) => Unmasked<TData> | null | void): Unmasked<TData> | null;
105+
updateQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: Cache_2.UpdateQueryOptions<TData, TVariables>, update: (data: Unmasked<TData> | null) => Unmasked<TData> | null | void): Unmasked<TData> | null;
106106
// (undocumented)
107-
abstract watch<TData = unknown, TVariables = OperationVariables>(watch: Cache_2.WatchOptions<TData, TVariables>): () => void;
107+
abstract watch<TData = unknown, TVariables extends OperationVariables = OperationVariables>(watch: Cache_2.WatchOptions<TData, TVariables>): () => void;
108108
watchFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloCache.WatchFragmentOptions<TData, TVariables>): Observable<ApolloCache.WatchFragmentResult<Unmasked<TData>>>;
109109
// (undocumented)
110-
abstract write<TData = unknown, TVariables = OperationVariables>(write: Cache_2.WriteOptions<TData, TVariables>): Reference | undefined;
111-
writeFragment<TData = unknown, TVariables = OperationVariables>({ data, fragment, fragmentName, variables, overwrite, id, broadcast, }: Cache_2.WriteFragmentOptions<TData, TVariables>): Reference | undefined;
112-
writeQuery<TData = unknown, TVariables = OperationVariables>({ data, query, variables, overwrite, id, broadcast, }: Cache_2.WriteQueryOptions<TData, TVariables>): Reference | undefined;
110+
abstract write<TData = unknown, TVariables extends OperationVariables = OperationVariables>(write: Cache_2.WriteOptions<TData, TVariables>): Reference | undefined;
111+
writeFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>({ data, fragment, fragmentName, variables, overwrite, id, broadcast, }: Cache_2.WriteFragmentOptions<TData, TVariables>): Reference | undefined;
112+
writeQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>({ data, query, variables, overwrite, id, broadcast, }: Cache_2.WriteQueryOptions<TData, TVariables>): Reference | undefined;
113113
}
114114

115115
// @public (undocumented)
@@ -134,9 +134,21 @@ namespace Cache_2 {
134134
update(cache: TCache): TUpdateResult;
135135
}
136136
// (undocumented)
137-
interface DiffOptions<TData = unknown, TVariables = OperationVariables> extends Omit<ReadOptions<TVariables, TData>, "rootId"> {
137+
interface DiffOptions<TData = unknown, TVariables extends OperationVariables = OperationVariables> extends Omit<ReadFnOptions<TData, TVariables>, "rootId"> {
138138
}
139139
// (undocumented)
140+
type DiffResult<TData> = {
141+
result: DataValue.Complete<TData>;
142+
complete: true;
143+
missing?: never;
144+
fromOptimisticTransaction?: boolean;
145+
} | {
146+
result: DataValue.Partial<TData> | null;
147+
complete: false;
148+
missing?: MissingFieldError;
149+
fromOptimisticTransaction?: boolean;
150+
};
151+
// (undocumented)
140152
interface EvictOptions {
141153
// (undocumented)
142154
args?: Record<string, any>;
@@ -161,25 +173,54 @@ namespace Cache_2 {
161173
optimistic?: boolean;
162174
}
163175
// (undocumented)
164-
interface ReadOptions<TVariables = OperationVariables, TData = unknown> extends DataProxy.Query<TVariables, TData> {
176+
interface ReadFnOptions<TData = unknown, TVariables extends OperationVariables = OperationVariables> {
177+
id?: string;
165178
// (undocumented)
166179
optimistic: boolean;
167180
// (undocumented)
168181
previousResult?: any;
182+
query: DocumentNode_2 | TypedDocumentNode<TData, TVariables>;
169183
// (undocumented)
170184
returnPartialData?: boolean;
171185
// (undocumented)
172186
rootId?: string;
187+
variables?: TVariables;
188+
}
189+
// (undocumented)
190+
interface ReadFragmentOptions<TData, TVariables extends OperationVariables> {
191+
fragment: DocumentNode_2 | TypedDocumentNode<TData, TVariables>;
192+
fragmentName?: string;
193+
id?: string;
194+
optimistic?: boolean;
195+
returnPartialData?: boolean;
196+
variables?: TVariables;
197+
}
198+
// @deprecated (undocumented)
199+
interface ReadOptions<TVariables extends OperationVariables = OperationVariables, TData = unknown> extends ReadFnOptions<TData, TVariables> {
200+
}
201+
// (undocumented)
202+
interface ReadQueryOptions<TData, TVariables extends OperationVariables> {
203+
id?: string;
204+
optimistic?: boolean;
205+
query: DocumentNode_2 | TypedDocumentNode<TData, TVariables>;
206+
returnPartialData?: boolean;
207+
variables?: TVariables;
173208
}
174209
// (undocumented)
175210
interface ResetOptions {
176211
// (undocumented)
177212
discardWatches?: boolean;
178213
}
179214
// (undocumented)
215+
interface UpdateFragmentOptions<TData, TVariables extends OperationVariables> extends Omit<ReadFragmentOptions<TData, TVariables> & WriteFragmentOptions<TData, TVariables>, "data"> {
216+
}
217+
// (undocumented)
218+
interface UpdateQueryOptions<TData, TVariables extends OperationVariables> extends Omit<ReadQueryOptions<TData, TVariables> & WriteQueryOptions<TData, TVariables>, "data"> {
219+
}
220+
// (undocumented)
180221
type WatchCallback<TData = unknown> = (diff: Cache_2.DiffResult<TData>, lastDiff?: Cache_2.DiffResult<TData>) => void;
181222
// (undocumented)
182-
interface WatchOptions<TData = unknown, TVariables = OperationVariables> extends DiffOptions<TData, TVariables> {
223+
interface WatchOptions<TData = unknown, TVariables extends OperationVariables = OperationVariables> extends DiffOptions<TData, TVariables> {
183224
// (undocumented)
184225
callback: WatchCallback<TData>;
185226
// (undocumented)
@@ -190,20 +231,35 @@ namespace Cache_2 {
190231
watcher?: object;
191232
}
192233
// (undocumented)
193-
interface WriteOptions<TData = unknown, TVariables = OperationVariables> extends Omit<DataProxy.Query<TVariables, TData>, "id">, Omit<DataProxy.WriteOptions<TData>, "data"> {
234+
interface WriteFragmentOptions<TData, TVariables extends OperationVariables> {
235+
broadcast?: boolean;
236+
data: Unmasked<TData>;
237+
fragment: DocumentNode_2 | TypedDocumentNode<TData, TVariables>;
238+
fragmentName?: string;
239+
id?: string;
240+
overwrite?: boolean;
241+
variables?: TVariables;
242+
}
243+
// (undocumented)
244+
interface WriteOptions<TData = unknown, TVariables extends OperationVariables = OperationVariables> {
245+
broadcast?: boolean;
194246
// (undocumented)
195247
dataId?: string;
248+
overwrite?: boolean;
249+
query: DocumentNode_2 | TypedDocumentNode<TData, TVariables>;
196250
// (undocumented)
197251
result: Unmasked<TData>;
252+
variables?: TVariables;
253+
}
254+
// (undocumented)
255+
interface WriteQueryOptions<TData, TVariables extends OperationVariables> {
256+
broadcast?: boolean;
257+
data: Unmasked<TData>;
258+
id?: string;
259+
overwrite?: boolean;
260+
query: DocumentNode_2 | TypedDocumentNode<TData, TVariables>;
261+
variables?: TVariables;
198262
}
199-
import DiffResult = DataProxy.DiffResult;
200-
import ReadQueryOptions = DataProxy.ReadQueryOptions;
201-
import ReadFragmentOptions = DataProxy.ReadFragmentOptions;
202-
import WriteQueryOptions = DataProxy.WriteQueryOptions;
203-
import WriteFragmentOptions = DataProxy.WriteFragmentOptions;
204-
import UpdateQueryOptions = DataProxy.UpdateQueryOptions;
205-
import UpdateFragmentOptions = DataProxy.UpdateFragmentOptions;
206-
import Fragment = DataProxy.Fragment;
207263
}
208264
export { Cache_2 as Cache }
209265

@@ -238,71 +294,6 @@ type CanReadFunction = (value: StoreValue) => boolean;
238294
// @public (undocumented)
239295
export function createFragmentRegistry(...fragments: DocumentNode[]): FragmentRegistryAPI;
240296

241-
// @public (undocumented)
242-
export namespace DataProxy {
243-
// (undocumented)
244-
export type DiffResult<TData> = {
245-
result: DataValue.Complete<TData>;
246-
complete: true;
247-
missing?: never;
248-
fromOptimisticTransaction?: boolean;
249-
} | {
250-
result: DataValue.Partial<TData> | null;
251-
complete: false;
252-
missing?: MissingFieldError;
253-
fromOptimisticTransaction?: boolean;
254-
};
255-
// (undocumented)
256-
export interface Fragment<TVariables, TData> {
257-
fragment: DocumentNode | TypedDocumentNode_2<TData, TVariables>;
258-
fragmentName?: string;
259-
id?: string;
260-
variables?: TVariables;
261-
}
262-
// (undocumented)
263-
export interface Query<TVariables, TData> {
264-
id?: string;
265-
query: DocumentNode | TypedDocumentNode_2<TData, TVariables>;
266-
variables?: TVariables;
267-
}
268-
// (undocumented)
269-
export interface ReadFragmentOptions<TData, TVariables> extends Fragment<TVariables, TData> {
270-
optimistic?: boolean;
271-
returnPartialData?: boolean;
272-
}
273-
// (undocumented)
274-
export interface ReadQueryOptions<TData, TVariables> extends Query<TVariables, TData> {
275-
optimistic?: boolean;
276-
returnPartialData?: boolean;
277-
}
278-
// (undocumented)
279-
export interface UpdateFragmentOptions<TData, TVariables> extends Omit<ReadFragmentOptions<TData, TVariables> & WriteFragmentOptions<TData, TVariables>, "data"> {
280-
}
281-
// (undocumented)
282-
export interface UpdateQueryOptions<TData, TVariables> extends Omit<ReadQueryOptions<TData, TVariables> & WriteQueryOptions<TData, TVariables>, "data"> {
283-
}
284-
// (undocumented)
285-
export interface WriteFragmentOptions<TData, TVariables> extends Fragment<TVariables, TData>, WriteOptions<TData> {
286-
}
287-
// (undocumented)
288-
export interface WriteOptions<TData> {
289-
broadcast?: boolean;
290-
data: Unmasked<TData>;
291-
overwrite?: boolean;
292-
}
293-
// (undocumented)
294-
export interface WriteQueryOptions<TData, TVariables> extends Query<TVariables, TData>, WriteOptions<TData> {
295-
}
296-
}
297-
298-
// @public
299-
export interface DataProxy {
300-
readFragment<TData = unknown, TVariables = OperationVariables>(options: DataProxy.ReadFragmentOptions<TData, TVariables>, optimistic?: boolean): Unmasked<TData> | null;
301-
readQuery<TData = unknown, TVariables = OperationVariables>(options: DataProxy.ReadQueryOptions<TData, TVariables>, optimistic?: boolean): Unmasked<TData> | null;
302-
writeFragment<TData = unknown, TVariables = OperationVariables>(options: DataProxy.WriteFragmentOptions<TData, TVariables>): Reference | undefined;
303-
writeQuery<TData = unknown, TVariables = OperationVariables>(options: DataProxy.WriteQueryOptions<TData, TVariables>): Reference | undefined;
304-
}
305-
306297
// Warning: (ae-forgotten-export) The symbol "KeyFieldsContext" needs to be exported by the entry point index.d.ts
307298
//
308299
// @public (undocumented)
@@ -544,11 +535,11 @@ export class InMemoryCache extends ApolloCache {
544535
// (undocumented)
545536
readonly policies: Policies;
546537
// (undocumented)
547-
read<TData = unknown>(options: Cache_2.ReadOptions<OperationVariables, TData> & {
538+
read<TData = unknown>(options: Cache_2.ReadFnOptions<TData, OperationVariables> & {
548539
returnPartialData: true;
549540
}): TData | DeepPartial<TData> | null;
550541
// (undocumented)
551-
read<TData = unknown>(options: Cache_2.ReadOptions<OperationVariables, TData>): TData | null;
542+
read<TData = unknown>(options: Cache_2.ReadFnOptions<TData, OperationVariables>): TData | null;
552543
// (undocumented)
553544
release(rootId: string, optimistic?: boolean): number;
554545
// (undocumented)
@@ -562,9 +553,9 @@ export class InMemoryCache extends ApolloCache {
562553
// (undocumented)
563554
transformDocument(document: DocumentNode): DocumentNode;
564555
// (undocumented)
565-
watch<TData = unknown, TVariables = OperationVariables>(watch: Cache_2.WatchOptions<TData, TVariables>): () => void;
556+
watch<TData = unknown, TVariables extends OperationVariables = OperationVariables>(watch: Cache_2.WatchOptions<TData, TVariables>): () => void;
566557
// (undocumented)
567-
write<TData = unknown, TVariables = OperationVariables>(options: Cache_2.WriteOptions<TData, TVariables>): Reference | undefined;
558+
write<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: Cache_2.WriteOptions<TData, TVariables>): Reference | undefined;
568559
}
569560

570561
// @public (undocumented)

0 commit comments

Comments
 (0)