Skip to content

Add deprecations to query/mutation/subscription result types #12751

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

Merged
merged 15 commits into from
Jun 30, 2025
Merged

Add deprecations to query/mutation/subscription result types #12751

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
d583c8a
Add doc block for data property
jerelmiller Jun 27, 2025
973c69b
Add InteropApolloQueryResult type
jerelmiller Jun 27, 2025
b6d8c84
Use InteropApolloQueryResult
jerelmiller Jun 27, 2025
d8f7814
Future tense
jerelmiller Jun 27, 2025
f126e29
Add InteropMutateResult
jerelmiller Jun 27, 2025
0caaf9b
Add InteropSubscribeResult type
jerelmiller Jun 27, 2025
a07ed6d
Update deprecation message
jerelmiller Jun 27, 2025
fb21a85
Add warning for partialRefetch on watchQuery
jerelmiller Jun 27, 2025
1cc2478
Remove unused import
jerelmiller Jun 27, 2025
8ed634c
Rerun api report
jerelmiller Jun 27, 2025
4f1888c
Warn if using standby fetch policy with client.query
jerelmiller Jun 27, 2025
4703c15
Remove unused import
jerelmiller Jun 27, 2025
7e135c0
Update size limits
jerelmiller Jun 27, 2025
1d1a592
Add changesets
jerelmiller Jun 27, 2025
57d59f7
Merge branch 'release-3.14' into jerel/query-return-deprecations
phryneas Jun 30, 2025
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
86 changes: 75 additions & 11 deletions .api-reports/api-report-core.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,12 +127,12 @@ export class ApolloClient<TCacheShape> implements DataProxy {
//
// (undocumented)
localState: LocalState<TCacheShape>;
mutate<TData = any, TVariables extends OperationVariables = OperationVariables, TContext extends Record<string, any> = DefaultContext, TCache extends ApolloCache<any> = ApolloCache<any>>(options: MutationOptions<TData, TVariables, TContext>): Promise<FetchResult<MaybeMasked<TData>>>;
mutate<TData = any, TVariables extends OperationVariables = OperationVariables, TContext extends Record<string, any> = DefaultContext, TCache extends ApolloCache<any> = ApolloCache<any>>(options: MutationOptions<TData, TVariables, TContext>): Promise<InteropMutateResult<MaybeMasked<TData>>>;
onClearStore(cb: () => Promise<any>): () => void;
onResetStore(cb: () => Promise<any>): () => void;
get prioritizeCacheValues(): boolean;
set prioritizeCacheValues(value: boolean);
query<T = any, TVariables extends OperationVariables = OperationVariables>(options: QueryOptions<TVariables, T>): Promise<ApolloQueryResult<MaybeMasked<T>>>;
query<T = any, TVariables extends OperationVariables = OperationVariables>(options: QueryOptions<TVariables, T>): Promise<InteropApolloQueryResult<MaybeMasked<T>>>;
// (undocumented)
queryDeduplication: boolean;
readFragment<T = any, TVariables = OperationVariables>(options: DataProxy.Fragment<TVariables, T>, optimistic?: boolean): Unmasked<T> | null;
Expand All @@ -147,7 +147,7 @@ export class ApolloClient<TCacheShape> implements DataProxy {
// @deprecated
setResolvers(resolvers: Resolvers | Resolvers[]): void;
stop(): void;
subscribe<T = any, TVariables extends OperationVariables = OperationVariables>(options: SubscriptionOptions<TVariables, T>): Observable<FetchResult<MaybeMasked<T>>>;
subscribe<T = any, TVariables extends OperationVariables = OperationVariables>(options: SubscriptionOptions<TVariables, T>): Observable<InteropSubscribeResult<MaybeMasked<T>>>;
// (undocumented)
readonly typeDefs: ApolloClientOptions<TCacheShape>["typeDefs"];
// (undocumented)
Expand Down Expand Up @@ -279,7 +279,6 @@ export interface ApolloPayloadResult<TData = Record<string, any>, TExtensions =

// @public (undocumented)
export interface ApolloQueryResult<T> {
// (undocumented)
data: T;
error?: ApolloError;
errors?: ReadonlyArray<GraphQLFormattedError>;
Expand Down Expand Up @@ -1259,6 +1258,71 @@ export type InternalRefetchQueriesResult<TResult> = TResult extends boolean ? Pr
// @public (undocumented)
export type InternalRefetchQueryDescriptor = RefetchQueryDescriptor | QueryOptions;

// @public @deprecated (undocumented)
export interface InteropApolloQueryResult<T> {
data: T;
error?: ApolloError;
// @deprecated (undocumented)
errors?: ReadonlyArray<GraphQLFormattedError>;
// @deprecated (undocumented)
loading: boolean;
// @deprecated (undocumented)
networkStatus: NetworkStatus;
// @deprecated (undocumented)
partial?: boolean;
}

// @public @deprecated (undocumented)
export type InteropExecutionPatchResult<TData = Record<string, any>, TExtensions = Record<string, any>> = InteropMutationExecutionPatchInitialResult<TData, TExtensions> | InteropMutationExecutionPatchIncrementalResult<TData, TExtensions>;

// Warning: (ae-forgotten-export) The symbol "InteropSingleExecutionResult" needs to be exported by the entry point index.d.ts
//
// @public @deprecated (undocumented)
export type InteropMutateResult<TData = Record<string, any>, TContext = DefaultContext, TExtensions = Record<string, any>> = InteropSingleExecutionResult<TData, TContext, TExtensions> | InteropExecutionPatchResult<TData, TExtensions>;

// @public @deprecated (undocumented)
export interface InteropMutationExecutionPatchIncrementalResult<TData = Record<string, any>, TExtensions = Record<string, any>> {
// (undocumented)
data?: never;
// @deprecated (undocumented)
errors?: never;
// (undocumented)
extensions?: never;
// @deprecated (undocumented)
hasNext?: boolean;
// @deprecated (undocumented)
incremental?: IncrementalPayload<TData, TExtensions>[];
}

// @public @deprecated (undocumented)
export interface InteropMutationExecutionPatchInitialResult<TData = Record<string, any>, TExtensions = Record<string, any>> {
// (undocumented)
data: TData | null | undefined;
// @deprecated (undocumented)
errors?: ReadonlyArray<GraphQLFormattedError>;
// (undocumented)
extensions?: TExtensions;
// @deprecated (undocumented)
hasNext?: boolean;
// @deprecated (undocumented)
incremental?: never;
}

// @public @deprecated (undocumented)
interface InteropSingleExecutionResult<TData = Record<string, any>, TContext = DefaultContext, TExtensions = Record<string, any>> {
// @deprecated (undocumented)
context?: TContext;
// (undocumented)
data?: TData | null;
// @deprecated (undocumented)
errors?: ReadonlyArray<GraphQLFormattedError>;
// (undocumented)
extensions?: TExtensions;
}

// @public @deprecated (undocumented)
export type InteropSubscribeResult<TData = Record<string, any>, TContext = DefaultContext, TExtensions = Record<string, any>> = InteropSingleExecutionResult<TData, TContext, TExtensions> | InteropExecutionPatchResult<TData, TExtensions>;

// @public (undocumented)
interface InvalidateModifier {
// (undocumented)
Expand Down Expand Up @@ -1700,7 +1764,7 @@ export class ObservableQuery<TData = any, TVariables extends OperationVariables
fetchMoreResult: Unmasked<TFetchData>;
variables: TFetchVars;
}) => Unmasked<TData>;
}): Promise<ApolloQueryResult<MaybeMasked<TFetchData>>>;
}): Promise<InteropApolloQueryResult<MaybeMasked<TFetchData>>>;
// (undocumented)
getCurrentResult(saveAsLastResult?: boolean): ApolloQueryResult<MaybeMasked<TData>>;
// (undocumented)
Expand All @@ -1721,9 +1785,9 @@ export class ObservableQuery<TData = any, TVariables extends OperationVariables
readonly queryId: string;
// (undocumented)
readonly queryName?: string;
refetch(variables?: Partial<TVariables>): Promise<ApolloQueryResult<MaybeMasked<TData>>>;
refetch(variables?: Partial<TVariables>): Promise<InteropApolloQueryResult<MaybeMasked<TData>>>;
// (undocumented)
reobserve(newOptions?: Partial<WatchQueryOptions<TVariables, TData>>, newNetworkStatus?: NetworkStatus): Promise<ApolloQueryResult<MaybeMasked<TData>>>;
reobserve(newOptions?: Partial<WatchQueryOptions<TVariables, TData>>, newNetworkStatus?: NetworkStatus): Promise<InteropApolloQueryResult<MaybeMasked<TData>>>;
// Warning: (ae-forgotten-export) The symbol "Concast" needs to be exported by the entry point index.d.ts
//
// (undocumented)
Expand All @@ -1745,8 +1809,8 @@ export class ObservableQuery<TData = any, TVariables extends OperationVariables
// @internal (undocumented)
protected scheduleNotify(): void;
// (undocumented)
setOptions(newOptions: Partial<WatchQueryOptions<TVariables, TData>>): Promise<ApolloQueryResult<MaybeMasked<TData>>>;
setVariables(variables: TVariables): Promise<ApolloQueryResult<MaybeMasked<TData>> | void>;
setOptions(newOptions: Partial<WatchQueryOptions<TVariables, TData>>): Promise<InteropApolloQueryResult<MaybeMasked<TData>>>;
setVariables(variables: TVariables): Promise<InteropApolloQueryResult<MaybeMasked<TData>> | void>;
// (undocumented)
silentSetOptions(newOptions: Partial<WatchQueryOptions<TVariables, TData>>): void;
startPolling(pollInterval: number): void;
Expand Down Expand Up @@ -2547,8 +2611,8 @@ interface WriteContext extends ReadMergeModifyContext {
// src/cache/inmemory/policies.ts:162:3 - (ae-forgotten-export) The symbol "KeySpecifier" needs to be exported by the entry point index.d.ts
// src/cache/inmemory/policies.ts:162:3 - (ae-forgotten-export) The symbol "KeyArgsFunction" needs to be exported by the entry point index.d.ts
// src/cache/inmemory/types.ts:139:3 - (ae-forgotten-export) The symbol "KeyFieldsFunction" needs to be exported by the entry point index.d.ts
// src/core/ObservableQuery.ts:129:5 - (ae-forgotten-export) The symbol "QueryManager" needs to be exported by the entry point index.d.ts
// src/core/ObservableQuery.ts:130:5 - (ae-forgotten-export) The symbol "QueryInfo" needs to be exported by the entry point index.d.ts
// src/core/ObservableQuery.ts:130:5 - (ae-forgotten-export) The symbol "QueryManager" needs to be exported by the entry point index.d.ts
// src/core/ObservableQuery.ts:131:5 - (ae-forgotten-export) The symbol "QueryInfo" needs to be exported by the entry point index.d.ts
// src/core/QueryManager.ts:160:5 - (ae-forgotten-export) The symbol "MutationStoreValue" needs to be exported by the entry point index.d.ts
// src/core/QueryManager.ts:415:7 - (ae-forgotten-export) The symbol "UpdateQueries" needs to be exported by the entry point index.d.ts
// src/link/http/selectHttpOptionsAndBody.ts:128:32 - (ae-forgotten-export) The symbol "HttpQueryOptions" needs to be exported by the entry point index.d.ts
Expand Down
Loading