Skip to content

Commit 8ce31fa

Browse files
remove DataProxy, inline in ApolloClient and Cache namespaces (#12787)
* remove `DataProxy`, inline in `ApolloClient` and `Cache` namespaces * inline `Query` * inline `Fragment` * inline `WriteOptions` * add `Cache.ReadFnOptions` with flipped generics * ensure that `TVariables extends OperationVariables` in more places * chores * changeset * eslint fix * just flip the options * update mentions * Apply suggestions from code review Co-authored-by: Jerel Miller <[email protected]> * apply review feedback to `ApolloClient` options, too * Clean up Prettier, Size-limit, and Api-Extractor * add types asignability test --------- Co-authored-by: Jerel Miller <[email protected]> Co-authored-by: phryneas <[email protected]>
1 parent baa6bec commit 8ce31fa

19 files changed

+1260
-532
lines changed

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

Lines changed: 82 additions & 94 deletions
Large diffs are not rendered by default.

.api-reports/api-report-core.api.md

Lines changed: 91 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ import { concat } from '@apollo/client/link';
1919
import { createHttpLink } from '@apollo/client/link/http';
2020
import { createSignalIfSupported } from '@apollo/client/link/http';
2121
import { DataMasking } from '@apollo/client/masking';
22-
import { DataProxy } from '@apollo/client/cache';
2322
import type { DeepPartial } from '@apollo/client/utilities';
2423
import { defaultDataIdFromObject } from '@apollo/client/cache';
2524
import { defaultPrinter } from '@apollo/client/link/http';
@@ -115,6 +114,50 @@ export { ApolloCache }
115114

116115
// @public (undocumented)
117116
export namespace ApolloClient {
117+
// (undocumented)
118+
export namespace Base {
119+
// (undocumented)
120+
export interface ReadQueryOptions<TData, TVariables extends OperationVariables> {
121+
id?: string;
122+
optimistic?: boolean;
123+
query: DocumentNode_2 | TypedDocumentNode<TData, TVariables>;
124+
returnPartialData?: boolean;
125+
}
126+
}
127+
// (undocumented)
128+
export namespace Base {
129+
// (undocumented)
130+
export interface ReadFragmentOptions<TData, TVariables extends OperationVariables> {
131+
fragment: DocumentNode_2 | TypedDocumentNode<TData, TVariables>;
132+
fragmentName?: string;
133+
id?: string;
134+
optimistic?: boolean;
135+
returnPartialData?: boolean;
136+
}
137+
}
138+
// (undocumented)
139+
export namespace Base {
140+
// (undocumented)
141+
export interface WriteQueryOptions<TData, TVariables extends OperationVariables> {
142+
broadcast?: boolean;
143+
data: Unmasked<TData>;
144+
id?: string;
145+
overwrite?: boolean;
146+
query: DocumentNode_2 | TypedDocumentNode<TData, TVariables>;
147+
}
148+
}
149+
// (undocumented)
150+
export namespace Base {
151+
// (undocumented)
152+
export interface WriteFragmentOptions<TData, TVariables extends OperationVariables> {
153+
broadcast?: boolean;
154+
data: Unmasked<TData>;
155+
fragment: DocumentNode_2 | TypedDocumentNode<TData, TVariables>;
156+
fragmentName?: string;
157+
id?: string;
158+
overwrite?: boolean;
159+
}
160+
}
118161
// (undocumented)
119162
export interface DefaultOptions {
120163
// (undocumented)
@@ -130,6 +173,34 @@ export namespace ApolloClient {
130173
name?: string;
131174
}
132175
// (undocumented)
176+
export namespace DocumentationTypes {
177+
// (undocumented)
178+
export interface ReadQueryOptions<TData, TVariables extends OperationVariables> extends Base.ReadQueryOptions<TData, TVariables> {
179+
variables?: TVariables;
180+
}
181+
}
182+
// (undocumented)
183+
export namespace DocumentationTypes {
184+
// (undocumented)
185+
export interface WriteQueryOptions<TData, TVariables extends OperationVariables> extends Base.WriteQueryOptions<TData, TVariables> {
186+
variables?: TVariables;
187+
}
188+
}
189+
// (undocumented)
190+
export namespace DocumentationTypes {
191+
// (undocumented)
192+
export interface WriteQueryOptions<TData, TVariables extends OperationVariables> extends Base.WriteQueryOptions<TData, TVariables> {
193+
variables?: TVariables;
194+
}
195+
}
196+
// (undocumented)
197+
export namespace DocumentationTypes {
198+
// (undocumented)
199+
export interface WriteFragmentOptions<TData, TVariables extends OperationVariables> extends Base.WriteFragmentOptions<TData, TVariables> {
200+
variables?: TVariables;
201+
}
202+
}
203+
// (undocumented)
133204
export type MutateOptions<TData = unknown, TVariables extends OperationVariables = OperationVariables, TCache extends ApolloCache = ApolloCache> = {
134205
optimisticResponse?: Unmasked<NoInfer<TData>> | ((vars: TVariables, { IGNORE }: {
135206
IGNORE: IgnoreModifier;
@@ -185,6 +256,10 @@ export namespace ApolloClient {
185256
data: TData | undefined;
186257
error?: ErrorLike;
187258
}
259+
// (undocumented)
260+
export type ReadFragmentOptions<TData, TVariables extends OperationVariables> = Base.ReadFragmentOptions<TData, TVariables> & VariablesOption<TVariables>;
261+
// (undocumented)
262+
export type ReadQueryOptions<TData, TVariables extends OperationVariables> = Base.ReadQueryOptions<TData, TVariables> & VariablesOption<TVariables>;
188263
export interface RefetchQueriesOptions<TCache extends ApolloCache, TResult> {
189264
include?: RefetchQueriesInclude;
190265
onQueryUpdated?: OnQueryUpdated<TResult> | null;
@@ -232,10 +307,14 @@ export namespace ApolloClient {
232307
skipPollAttempt?: () => boolean;
233308
query: DocumentNode_2 | TypedDocumentNode<TData, TVariables>;
234309
} & VariablesOption<NoInfer<TVariables>>;
310+
// (undocumented)
311+
export type WriteFragmentOptions<TData, TVariables extends OperationVariables> = Base.WriteFragmentOptions<TData, TVariables> & VariablesOption<TVariables>;
312+
// (undocumented)
313+
export type WriteQueryOptions<TData, TVariables extends OperationVariables> = Base.WriteQueryOptions<TData, TVariables> & VariablesOption<TVariables>;
235314
}
236315

237316
// @public
238-
export class ApolloClient implements DataProxy {
317+
export class ApolloClient {
239318
// (undocumented)
240319
__actionHookForDevTools(cb: () => any): void;
241320
constructor(options: ApolloClient.Options);
@@ -268,8 +347,13 @@ export class ApolloClient implements DataProxy {
268347
query<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloClient.QueryOptions<TData, TVariables>): Promise<ApolloClient.QueryResult<MaybeMasked<TData>>>;
269348
// (undocumented)
270349
queryDeduplication: boolean;
271-
readFragment<T = unknown, TVariables = OperationVariables>(options: DataProxy.Fragment<TVariables, T>, optimistic?: boolean): Unmasked<T> | null;
272-
readQuery<TData = unknown, TVariables = OperationVariables>(options: DataProxy.Query<TVariables, TData>, optimistic?: boolean): Unmasked<TData> | null;
350+
readFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloClient.ReadFragmentOptions<TData, TVariables>): Unmasked<TData> | null;
351+
// @deprecated
352+
readFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloClient.ReadFragmentOptions<TData, TVariables>, optimistic: boolean): Unmasked<TData> | null;
353+
readQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloClient.ReadQueryOptions<TData, TVariables>): Unmasked<TData> | null;
354+
// @deprecated
355+
readQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloClient.ReadQueryOptions<TData, TVariables>,
356+
optimistic: boolean): Unmasked<TData> | null;
273357
// @deprecated
274358
reFetchObservableQueries: (includeStandby?: boolean) => Promise<ApolloClient.QueryResult<any>[]>;
275359
refetchObservableQueries(includeStandby?: boolean): Promise<ApolloClient.QueryResult<any>[]>;
@@ -283,8 +367,8 @@ export class ApolloClient implements DataProxy {
283367
version: string;
284368
watchFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloClient.WatchFragmentOptions<TData, TVariables>): Observable_2<ApolloClient.WatchFragmentResult<MaybeMasked<TData>>>;
285369
watchQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloClient.WatchQueryOptions<TData, TVariables>): ObservableQuery<TData, TVariables>;
286-
writeFragment<TData = unknown, TVariables = OperationVariables>(options: DataProxy.WriteFragmentOptions<TData, TVariables>): Reference_2 | undefined;
287-
writeQuery<TData = unknown, TVariables = OperationVariables>(options: DataProxy.WriteQueryOptions<TData, TVariables>): Reference_2 | undefined;
370+
writeFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloClient.WriteFragmentOptions<TData, TVariables>): Reference_2 | undefined;
371+
writeQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloClient.WriteQueryOptions<TData, TVariables>): Reference_2 | undefined;
288372
}
289373

290374
// @public @deprecated (undocumented)
@@ -320,8 +404,6 @@ export { createSignalIfSupported }
320404

321405
export { DataMasking }
322406

323-
export { DataProxy }
324-
325407
// @public (undocumented)
326408
export type DataState<TData> = {
327409
data: DataValue.Complete<TData>;
@@ -1066,7 +1148,7 @@ export type WatchQueryOptions<TVariables extends OperationVariables = OperationV
10661148

10671149
// Warnings were encountered during analysis:
10681150
//
1069-
// src/core/ApolloClient.ts:358:5 - (ae-forgotten-export) The symbol "NextFetchPolicyContext" needs to be exported by the entry point index.d.ts
1151+
// src/core/ApolloClient.ts:357:5 - (ae-forgotten-export) The symbol "NextFetchPolicyContext" needs to be exported by the entry point index.d.ts
10701152
// src/core/ObservableQuery.ts:359:5 - (ae-forgotten-export) The symbol "QueryManager" needs to be exported by the entry point index.d.ts
10711153
// src/core/QueryManager.ts:175:5 - (ae-forgotten-export) The symbol "MutationStoreValue" needs to be exported by the entry point index.d.ts
10721154

0 commit comments

Comments
 (0)