@apollo/client 3.13.9-rc.0 → 3.14.0-alpha.1

package/core/types.d.ts

@@ -1,95 +1,19 @@
-import type { DocumentNode, FormattedExecutionResult } from "graphql";
-import type { NextNotification, Observable, ObservableNotification } from "rxjs";
-import type { ApolloCache } from "@apollo/client/cache";
-import type { Cache } from "@apollo/client/cache";
-import type { ClientAwarenessLink } from "@apollo/client/link/client-awareness";
-import type { Unmasked } from "@apollo/client/masking";
-import type { DeepPartial, HKT } from "@apollo/client/utilities";
-import type { ApplyHKTImplementationWithDefault, IsAny } from "@apollo/client/utilities/internal";
+import type { DocumentNode, GraphQLFormattedError } from "graphql";
+import type { ApolloCache } from "../cache/index.js";
+import type { FetchResult, IncrementalPayload } from "../link/core/index.js";
+import type { ApolloError } from "../errors/index.js";
 import type { NetworkStatus } from "./networkStatus.js";
+import type { Resolver } from "./LocalState.js";
 import type { ObservableQuery } from "./ObservableQuery.js";
 import type { QueryOptions } from "./watchQueryOptions.js";
+import type { Cache } from "../cache/index.js";
+import type { IsStrictlyAny } from "../utilities/index.js";
+import type { Unmasked } from "../masking/index.js";
 export type { TypedDocumentNode } from "@graphql-typed-document-node/core";
 export type MethodKeys<T> = {
     [P in keyof T]: T[P] extends Function ? P : never;
 }[keyof T];
-export interface TypeOverrides {
-}
-declare namespace OverridableTypes {
-    export interface Defaults {
-        Streaming: Streaming;
-    }
-    interface Streaming extends HKT {
-        arg1: unknown;
-        return: this["arg1"];
-    }
-    export {};
-}
-/**
- * Returns a representation of `TData` while it is streaming.
- *
- * @defaultValue `TData` if no overrides are provided.
- *
- * @example
- * You can override this type globally - this example shows how to override it
- * with `DeepPartial<TData>`:
- *
- * ```ts
- * import { HKT, DeepPartial } from "@apollo/client/utilities";
- *
- * type StreamingOverride<TData> = DeepPartial<TData>;
- *
- * interface StreamingOverrideHKT extends HKT {
- *   return: StreamingOverride<this["arg1"]>;
- * }
- *
- * declare module "@apollo/client" {
- *   export interface TypeOverrides {
- *     Streaming: StreamingOverrideHKT;
- *   }
- * }
- * ```
- */
-export type Streaming<TData> = ApplyHKTImplementationWithDefault<TypeOverrides, "Streaming", OverridableTypes.Defaults, TData>;
 export interface DefaultContext extends Record<string, any> {
-    /**
-     * Indicates whether `queryDeduplication` was enabled for the request.
-     */
-    queryDeduplication?: boolean;
-    clientAwareness?: ClientAwarenessLink.ClientAwarenessOptions;
-}
-/**
- * Represents an `Error` type, but used throughout Apollo Client to represent
- * errors that may otherwise fail `instanceof` checks if they are cross-realm
- * Error instances (see the [`Error.isError` proposal](https://github.com/tc39/proposal-is-error) for more details).
- *
- * Apollo Client uses several types of errors throughout the client which can be
- * narrowed using `instanceof`:
- * - `CombinedGraphQLErrors` - `errors` returned from a GraphQL result
- * - `CombinedProtocolErrors` - Transport-level errors from multipart subscriptions.
- * - `ServerParseError` - A JSON-parse error when parsing the server response.
- * - `ServerError` - A non-200 server response.
- *
- * @example
- * ```ts
- * import { CombinedGraphQLErrors } from "@apollo/client";
- *
- * try {
- *   await client.query({ query });
- * } catch (error) {
- *   // Use `instanceof` to check for more specific types of errors.
- *   if (error instanceof CombinedGraphQLErrors) {
- *     error.errors.map(graphQLError => console.log(graphQLError.message));
- *   } else {
- *     console.error(errors);
- *   }
- * }
- * ```
- */
-export interface ErrorLike {
-    message: string;
-    name: string;
-    stack?: string;
 }
 export type OnQueryUpdated<TResult> = (observableQuery: ObservableQuery<any>, diff: Cache.DiffResult<any>, lastDiff: Cache.DiffResult<any> | undefined) => boolean | TResult;
 export type RefetchQueryDescriptor = string | DocumentNode;
@@ -97,190 +21,239 @@ export type InternalRefetchQueryDescriptor = RefetchQueryDescriptor | QueryOptio
 type RefetchQueriesIncludeShorthand = "all" | "active";
 export type RefetchQueriesInclude = RefetchQueryDescriptor[] | RefetchQueriesIncludeShorthand;
 export type InternalRefetchQueriesInclude = InternalRefetchQueryDescriptor[] | RefetchQueriesIncludeShorthand;
-export interface RefetchQueriesOptions<TCache extends ApolloCache, TResult> {
+export interface RefetchQueriesOptions<TCache extends ApolloCache<any>, TResult> {
     updateCache?: (cache: TCache) => void;
     include?: RefetchQueriesInclude;
     optimistic?: boolean;
     onQueryUpdated?: OnQueryUpdated<TResult> | null;
 }
-export type RefetchQueriesPromiseResults<TResult> = IsAny<TResult> extends true ? any[] : TResult extends boolean ? QueryResult<any>[] : TResult extends PromiseLike<infer U> ? U[] : TResult[];
+export type RefetchQueriesPromiseResults<TResult> = IsStrictlyAny<TResult> extends true ? any[] : TResult extends boolean ? InteropApolloQueryResult<any>[] : TResult extends PromiseLike<infer U> ? U[] : TResult[];
 export interface RefetchQueriesResult<TResult> extends Promise<RefetchQueriesPromiseResults<TResult>> {
     queries: ObservableQuery<any>[];
     results: InternalRefetchQueriesResult<TResult>[];
 }
-export interface InternalRefetchQueriesOptions<TCache extends ApolloCache, TResult> extends Omit<RefetchQueriesOptions<TCache, TResult>, "include"> {
+export interface InternalRefetchQueriesOptions<TCache extends ApolloCache<any>, TResult> extends Omit<RefetchQueriesOptions<TCache, TResult>, "include"> {
     include?: InternalRefetchQueriesInclude;
     removeOptimistic?: string;
 }
-export type InternalRefetchQueriesResult<TResult> = TResult extends boolean ? Promise<QueryResult<any>> : TResult;
+export type InternalRefetchQueriesResult<TResult> = TResult extends boolean ? Promise<InteropApolloQueryResult<any>> : TResult;
 export type InternalRefetchQueriesMap<TResult> = Map<ObservableQuery<any>, InternalRefetchQueriesResult<TResult>>;
+export type { QueryOptions as PureQueryOptions };
 export type OperationVariables = Record<string, any>;
-export type ApolloQueryResult<TData, TStates extends DataState<TData>["dataState"] = DataState<TData>["dataState"]> = {
+export interface ApolloQueryResult<T> {
+    /**
+     * An object containing the result of your GraphQL query after it completes.
+     * 
+     * This value might be `undefined` if a query results in one or more errors (depending on the query's `errorPolicy`).
+     * 
+     * @docGroup
+     * 
+     * 1. Operation data
+     */
+    data: T;
+    /**
+     * A list of any errors that occurred during server-side execution of a GraphQL operation.
+     * See https://www.apollographql.com/docs/react/data/error-handling/ for more information.
+     */
+    errors?: ReadonlyArray<GraphQLFormattedError>;
     /**
      * The single Error object that is passed to onError and useQuery hooks, and is often thrown during manual `client.query` calls.
      * This will contain both a NetworkError field and any GraphQLErrors.
      * See https://www.apollographql.com/docs/react/data/error-handling/ for more information.
      */
-    error?: ErrorLike;
+    error?: ApolloError;
     loading: boolean;
     networkStatus: NetworkStatus;
+    partial?: boolean;
+}
+/**
+ * @deprecated This type does not exist in Apollo Client 4.0 and is meant as a
+ * bridge between versions for deprecations.
+ */
+export interface InteropApolloQueryResult<T> {
+    /**
+     * An object containing the result of your GraphQL query after it completes.
+     * 
+     * This value might be `undefined` if a query results in one or more errors (depending on the query's `errorPolicy`).
+     * 
+     * @docGroup
+     * 
+     * 1. Operation data
+     */
+    data: T;
     /**
-     * Describes whether `data` is a complete or partial result. This flag is only
-     * set when `returnPartialData` is `true` in query options.
+     * @deprecated `errors` will no longer available on the result in Apollo Client 4.0.
+     * This value is safe to use in Apollo Client 3.x.
      *
-     * @deprecated This field will be removed in a future version of Apollo Client.
+     * **Recommended now**
+     *
+     * No action needed
+     *
+     * **When upgrading**
+     *
+     * `errors` has been consolidated to the `error` property. You will need to
+     * read any errors on the `error` property on the resolved value instead.
      */
-    partial: boolean;
-} & GetDataState<TData, TStates>;
-export type DataState<TData> = {
-    data: TData;
+    errors?: ReadonlyArray<GraphQLFormattedError>;
     /**
-    * Describes the completeness of `data`. - `empty`: No data could be fulfilled from the cache or the result is incomplete. `data` is `undefined`. - `partial`: Some data could be fulfilled from the cache but `data` is incomplete. This is only possible when `returnPartialData` is `true`. - `streaming`: `data` is incomplete as a result of a deferred query and the result is still streaming in. - `complete`: `data` is a fully satisfied query result fulfilled either from the cache or network.
-    */
-    dataState: "complete";
-} | {
-    data: Streaming<TData>;
+     * The single Error object that is passed to onError and useQuery hooks, and is often thrown during manual `client.query` calls.
+     * This will contain both a NetworkError field and any GraphQLErrors.
+     * See https://www.apollographql.com/docs/react/data/error-handling/ for more information.
+     */
+    error?: ApolloError;
     /**
-    * Describes the completeness of `data`. - `empty`: No data could be fulfilled from the cache or the result is incomplete. `data` is `undefined`. - `partial`: Some data could be fulfilled from the cache but `data` is incomplete. This is only possible when `returnPartialData` is `true`. - `streaming`: `data` is incomplete as a result of a deferred query and the result is still streaming in. - `complete`: `data` is a fully satisfied query result fulfilled either from the cache or network.
-    */
-    dataState: "streaming";
-} | {
-    data: DeepPartial<TData>;
+     * @deprecated `loading` will no longer available on the result in Apollo Client 4.0.
+     * This value is always true when the resolved and can safely ignored.
+     */
+    loading: boolean;
     /**
-    * Describes the completeness of `data`. - `empty`: No data could be fulfilled from the cache or the result is incomplete. `data` is `undefined`. - `partial`: Some data could be fulfilled from the cache but `data` is incomplete. This is only possible when `returnPartialData` is `true`. - `streaming`: `data` is incomplete as a result of a deferred query and the result is still streaming in. - `complete`: `data` is a fully satisfied query result fulfilled either from the cache or network.
-    */
-    dataState: "partial";
-} | {
-    data: undefined;
+     * @deprecated `loading` will no longer available on the result in Apollo Client 4.0.
+     * This value is always `NetworkStatus.ready` or `NetworkStatus.error`. To
+     * determine if the result contains an error, read from the `error` or `errors`
+     * property instead.
+     */
+    networkStatus: NetworkStatus;
     /**
-    * Describes the completeness of `data`. - `empty`: No data could be fulfilled from the cache or the result is incomplete. `data` is `undefined`. - `partial`: Some data could be fulfilled from the cache but `data` is incomplete. This is only possible when `returnPartialData` is `true`. - `streaming`: `data` is incomplete as a result of a deferred query and the result is still streaming in. - `complete`: `data` is a fully satisfied query result fulfilled either from the cache or network.
-    */
-    dataState: "empty";
-};
-export type GetDataState<TData, TState extends DataState<TData>["dataState"]> = Extract<DataState<TData>, {
-    dataState: TState;
-}>;
+     * @deprecated `partial` will no longer available on the result in Apollo Client 4.0.
+     * This value is always `false` if there is a data value since the result
+     * never contains partial cache data.
+     */
+    partial?: boolean;
+}
 /**
- * Represents a result that might be complete or still streaming and
- * has been normalized into a plain GraphQL result. When the result is
- * still `streaming`, some fields might not yet be available.
+ * @deprecated This type does not exist in Apollo Client 4.0 and is meant as a
+ * bridge between versions for deprecations.
  */
-export type NormalizedExecutionResult<TData = Record<string, unknown>, TExtensions = Record<string, unknown>> = Omit<FormattedExecutionResult<TData, TExtensions>, "data"> & ({
-    data: TData;
-    /**
-    * Describes the completeness of `data`. - `empty`: No data could be fulfilled from the cache or the result is incomplete. `data` is `undefined`. - `partial`: Some data could be fulfilled from the cache but `data` is incomplete. This is only possible when `returnPartialData` is `true`. - `streaming`: `data` is incomplete as a result of a deferred query and the result is still streaming in. - `complete`: `data` is a fully satisfied query result fulfilled either from the cache or network.
-    */
-    dataState: "complete";
-} | {
-    data: Streaming<TData>;
+interface InteropSingleExecutionResult<TData = Record<string, any>, TContext = DefaultContext, TExtensions = Record<string, any>> {
+    data?: TData | null;
     /**
-    * Describes the completeness of `data`. - `empty`: No data could be fulfilled from the cache or the result is incomplete. `data` is `undefined`. - `partial`: Some data could be fulfilled from the cache but `data` is incomplete. This is only possible when `returnPartialData` is `true`. - `streaming`: `data` is incomplete as a result of a deferred query and the result is still streaming in. - `complete`: `data` is a fully satisfied query result fulfilled either from the cache or network.
-    */
-    dataState: "streaming";
-});
-export type MutationQueryReducer<T> = (previousResult: Record<string, any>, options: {
-    mutationResult: NormalizedExecutionResult<Unmasked<T>>;
-    queryName: string | undefined;
-    queryVariables: Record<string, any>;
-}) => Record<string, any>;
-export type MutationQueryReducersMap<T = {
-    [key: string]: any;
-}> = {
-    [queryName: string]: MutationQueryReducer<T>;
-};
-export type MutationUpdaterFunction<TData, TVariables, TCache extends ApolloCache> = (cache: TCache, result: FormattedExecutionResult<Unmasked<TData>>, options: {
-    context?: DefaultContext;
-    variables?: TVariables;
-}) => void;
-export interface MutateResult<TData = unknown> {
-    /**
-    * The data returned from your mutation. Can be `undefined` if `ignoreResults` is `true`.
-    */
-    data: TData | undefined;
-    /**
-    * If the mutation produces one or more errors, this object contains either an array of `graphQLErrors` or a single `networkError`. Otherwise, this value is `undefined`.
-    * 
-    * For more information, see [Handling operation errors](https://www.apollographql.com/docs/react/data/error-handling/).
-    */
-    error?: ErrorLike;
+     * @deprecated `context` will no longer available on the result in Apollo Client 4.0.
+     */
+    context?: TContext;
     /**
-    * Custom extensions returned from the GraphQL server
-    */
-    extensions?: Record<string, unknown>;
+     * @deprecated `errors` is no longer available on the result in Apollo Client 4.0.
+     * This value is safe to use in Apollo Client 3.x.
+     *
+     * **Recommended now**
+     *
+     * No action needed
+     *
+     * **When upgrading**
+     *
+     * `errors` has been consolidated to the `error` property. You will need to
+     * read any errors on the `error` property on the resolved value instead.
+     */
+    errors?: ReadonlyArray<GraphQLFormattedError>;
+    extensions?: TExtensions;
 }
-export interface SubscribeResult<TData = unknown> {
+/**
+ * @deprecated This type does not exist in Apollo Client 4.0 and is meant as a
+ * bridge between versions for deprecations.
+ */
+export interface InteropMutationExecutionPatchInitialResult<TData = Record<string, any>, TExtensions = Record<string, any>> {
     /**
-    * The data returned from your mutation. Can be `undefined` if `ignoreResults` is `true`.
-    */
-    data: TData | undefined;
+     * @deprecated `hasNext` will no longer available on the result in Apollo Client 4.0.
+     */
+    hasNext?: boolean;
+    data: TData | null | undefined;
     /**
-    * If the mutation produces one or more errors, this object contains either an array of `graphQLErrors` or a single `networkError`. Otherwise, this value is `undefined`.
-    * 
-    * For more information, see [Handling operation errors](https://www.apollographql.com/docs/react/data/error-handling/).
-    */
-    error?: ErrorLike;
+     * @deprecated `incremental` will no longer available on the result in Apollo Client 4.0.
+     */
+    incremental?: never;
     /**
-    * Custom extensions returned from the GraphQL server
-    */
-    extensions?: Record<string, unknown>;
+     * @deprecated `errors` is no longer available on the result in Apollo Client 4.0.
+     * This value is safe to use in Apollo Client 3.x.
+     *
+     * **Recommended now**
+     *
+     * No action needed
+     *
+     * **When upgrading**
+     *
+     * `errors` has been consolidated to the `error` property. You will need to
+     * read any errors on the `error` property on the resolved value instead.
+     */
+    errors?: ReadonlyArray<GraphQLFormattedError>;
+    extensions?: TExtensions;
 }
-export interface QueryResult<TData = unknown> {
+/**
+ * @deprecated This type does not exist in Apollo Client 4.0 and is meant as a
+ * bridge between versions for deprecations.
+ */
+export interface InteropMutationExecutionPatchIncrementalResult<TData = Record<string, any>, TExtensions = Record<string, any>> {
     /**
-    * An object containing the result of your GraphQL query after it completes.
-    * 
-    * This value might be `undefined` if a query results in one or more errors (depending on the query's `errorPolicy`).
-    * 
-    * @docGroup
-    * 
-    * 1. Operation data
-    */
-    data: TData | undefined;
+     * @deprecated `hasNext` will no longer available on the result in Apollo Client 4.0.
+     * This value is safe to use in Apollo Client 3.x.
+     *
+     * **Recommended now**
+     *
+     * No action needed
+     *
+     * **When upgrading**
+     *
+     * `errors` has been consolidated to the `error` property. You will need to
+     * read any errors on the `error` property on the resolved value instead.
+     */
+    hasNext?: boolean;
     /**
-    * If the query produces one or more errors, this object contains either an array of `graphQLErrors` or a single `networkError`. Otherwise, this value is `undefined`.
-    * 
-    * For more information, see [Handling operation errors](https://www.apollographql.com/docs/react/data/error-handling/).
-    * 
-    * @docGroup
-    * 
-    * 1. Operation data
-    */
-    error?: ErrorLike;
-}
-export declare namespace QueryNotification {
-    type NewNetworkStatus<TData> = NextNotification<{
-        resetError?: boolean;
-    }> & {
-        source: "newNetworkStatus";
-    };
-    type SetResult<TData> = NextNotification<ApolloQueryResult<TData>> & {
-        source: "setResult";
-    };
-    type FromNetwork<TData> = ObservableNotification<ApolloQueryResult<TData>> & {
-        source: "network";
-    };
-    type FromCache<TData> = NextNotification<ApolloQueryResult<TData>> & {
-        source: "cache";
-    };
-    type Value<TData> = FromCache<TData> | FromNetwork<TData> | NewNetworkStatus<TData> | SetResult<TData>;
-}
-/** Observable created by initiating a subscription operation. */
-export interface SubscriptionObservable<T> extends Observable<T> {
+     * @deprecated `incremental` will no longer available on the result in Apollo Client 4.0.
+     */
+    incremental?: IncrementalPayload<TData, TExtensions>[];
+    data?: never;
     /**
-     * Used to restart the connection to the link chain. Calling this on a
-     * deduplicated subscription will restart the connection for all observables
-     * that share the request.
+     * @deprecated `errors` is no longer available on the result in Apollo Client 4.0.
+     * This value is safe to use in Apollo Client 3.x.
+     *
+     * **Recommended now**
      *
-     * @example
+     * No action needed
      *
-     * ```ts
-     * const observable = client.subscribe({ query: subscription });
-     * observable.subscribe((value) => {
-     *   // ...
-     * });
+     * **When upgrading**
      *
-     * observable.restart();
-     * ```
+     * `errors` has been consolidated to the `error` property. You will need to
+     * read any errors on the `error` property on the resolved value instead.
      */
-    restart: () => void;
+    errors?: never;
+    extensions?: never;
+}
+/**
+ * @deprecated This type does not exist in Apollo Client 4.0 and is meant as a
+ * bridge between versions for deprecations.
+ */
+export type InteropExecutionPatchResult<TData = Record<string, any>, TExtensions = Record<string, any>> = InteropMutationExecutionPatchInitialResult<TData, TExtensions> | InteropMutationExecutionPatchIncrementalResult<TData, TExtensions>;
+/**
+ * @deprecated This type does not exist in Apollo Client 4.0 and is meant as a
+ * bridge between versions for deprecations.
+ */
+export type InteropMutateResult<TData = Record<string, any>, TContext = DefaultContext, TExtensions = Record<string, any>> = InteropSingleExecutionResult<TData, TContext, TExtensions> | InteropExecutionPatchResult<TData, TExtensions>;
+/**
+ * @deprecated This type does not exist in Apollo Client 4.0 and is meant as a
+ * bridge between versions for deprecations.
+ */
+export type InteropSubscribeResult<TData = Record<string, any>, TContext = DefaultContext, TExtensions = Record<string, any>> = InteropSingleExecutionResult<TData, TContext, TExtensions> | InteropExecutionPatchResult<TData, TExtensions>;
+export type MutationQueryReducer<T> = (previousResult: Record<string, any>, options: {
+    mutationResult: FetchResult<Unmasked<T>>;
+    queryName: string | undefined;
+    queryVariables: Record<string, any>;
+}) => Record<string, any>;
+export type MutationQueryReducersMap<T = {
+    [key: string]: any;
+}> = {
+    [queryName: string]: MutationQueryReducer<T>;
+};
+/**
+ * @deprecated Use `MutationUpdaterFunction` instead.
+ */
+export type MutationUpdaterFn<T = {
+    [key: string]: any;
+}> = (cache: ApolloCache<T>, mutationResult: FetchResult<T>) => void;
+export type MutationUpdaterFunction<TData, TVariables, TContext, TCache extends ApolloCache<any>> = (cache: TCache, result: Omit<FetchResult<Unmasked<TData>>, "context">, options: {
+    context?: TContext;
+    variables?: TVariables;
+}) => void;
+export interface Resolvers {
+    [key: string]: {
+        [field: string]: Resolver;
+    };
 }
-//# sourceMappingURL=types.d.ts.map
+//# sourceMappingURL=types.d.ts.map

package/core/types.js

@@ -1,2 +1,2 @@
 export {};
-//# sourceMappingURL=types.js.map
+//# sourceMappingURL=types.js.map

package/core/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/core/types.ts"],"names":[],"mappings":"","sourcesContent":["import type { DocumentNode, GraphQLFormattedError } from \"graphql\";\n\nimport type { ApolloCache } from \"../cache/index.js\";\nimport type { FetchResult, IncrementalPayload } from \"../link/core/index.js\";\nimport type { ApolloError } from \"../errors/index.js\";\nimport type { NetworkStatus } from \"./networkStatus.js\";\nimport type { Resolver } from \"./LocalState.js\";\nimport type { ObservableQuery } from \"./ObservableQuery.js\";\nimport type { QueryOptions } from \"./watchQueryOptions.js\";\nimport type { Cache } from \"../cache/index.js\";\nimport type { IsStrictlyAny } from \"../utilities/index.js\";\nimport type { Unmasked } from \"../masking/index.js\";\n\nexport type { TypedDocumentNode } from \"@graphql-typed-document-node/core\";\n\nexport type MethodKeys<T> = {\n  [P in keyof T]: T[P] extends Function ? P : never;\n}[keyof T];\n\nexport interface DefaultContext extends Record<string, any> {}\n\nexport type OnQueryUpdated<TResult> = (\n  observableQuery: ObservableQuery<any>,\n  diff: Cache.DiffResult<any>,\n  lastDiff: Cache.DiffResult<any> | undefined\n) => boolean | TResult;\n\nexport type RefetchQueryDescriptor = string | DocumentNode;\nexport type InternalRefetchQueryDescriptor =\n  | RefetchQueryDescriptor\n  | QueryOptions;\n\ntype RefetchQueriesIncludeShorthand = \"all\" | \"active\";\n\nexport type RefetchQueriesInclude =\n  | RefetchQueryDescriptor[]\n  | RefetchQueriesIncludeShorthand;\n\nexport type InternalRefetchQueriesInclude =\n  | InternalRefetchQueryDescriptor[]\n  | RefetchQueriesIncludeShorthand;\n\n// Used by ApolloClient[\"refetchQueries\"]\n// TODO Improve documentation comments for this public type.\nexport interface RefetchQueriesOptions<\n  TCache extends ApolloCache<any>,\n  TResult,\n> {\n  updateCache?: (cache: TCache) => void;\n  // The client.refetchQueries method discourages passing QueryOptions, by\n  // restricting the public type of options.include to exclude QueryOptions as\n  // an available array element type (see InternalRefetchQueriesInclude for a\n  // version of RefetchQueriesInclude that allows legacy QueryOptions objects).\n  include?: RefetchQueriesInclude;\n  optimistic?: boolean;\n  // If no onQueryUpdated function is provided, any queries affected by the\n  // updateCache function or included in the options.include array will be\n  // refetched by default. Passing null instead of undefined disables this\n  // default refetching behavior for affected queries, though included queries\n  // will still be refetched.\n  onQueryUpdated?: OnQueryUpdated<TResult> | null;\n}\n\n// The client.refetchQueries method returns a thenable (PromiseLike) object\n// whose result is an array of Promise.resolve'd TResult values, where TResult\n// is whatever type the (optional) onQueryUpdated function returns. When no\n// onQueryUpdated function is given, TResult defaults to ApolloQueryResult<any>\n// (thanks to default type parameters for client.refetchQueries).\nexport type RefetchQueriesPromiseResults<TResult> =\n  // If onQueryUpdated returns any, all bets are off, so the results array must\n  // be a generic any[] array, which is much less confusing than the union type\n  // we get if we don't check for any. I hoped `any extends TResult` would do\n  // the trick here, instead of IsStrictlyAny, but you can see for yourself what\n  // fails in the refetchQueries tests if you try making that simplification.\n  IsStrictlyAny<TResult> extends true ? any[]\n  : // If the onQueryUpdated function passed to client.refetchQueries returns true\n  // or false, that means either to refetch the query (true) or to skip the\n  // query (false). Since refetching produces an ApolloQueryResult<any>, and\n  // skipping produces nothing, the fully-resolved array of all results produced\n  // will be an ApolloQueryResult<any>[], when TResult extends boolean.\n  TResult extends boolean ? InteropApolloQueryResult<any>[]\n  : // If onQueryUpdated returns a PromiseLike<U>, that thenable will be passed as\n  // an array element to Promise.all, so we infer/unwrap the array type U here.\n  TResult extends PromiseLike<infer U> ? U[]\n  : // All other onQueryUpdated results end up in the final Promise.all array as\n    // themselves, with their original TResult type. Note that TResult will\n    // default to ApolloQueryResult<any> if no onQueryUpdated function is passed\n    // to client.refetchQueries.\n    TResult[];\n\n// The result of client.refetchQueries is thenable/awaitable, if you just want\n// an array of fully resolved results, but you can also access the raw results\n// immediately by examining the additional { queries, results } properties of\n// the RefetchQueriesResult<TResult> object.\nexport interface RefetchQueriesResult<TResult>\n  extends Promise<RefetchQueriesPromiseResults<TResult>> {\n  // An array of ObservableQuery objects corresponding 1:1 to TResult values\n  // in the results arrays (both the TResult[] array below, and the results\n  // array resolved by the Promise above).\n  queries: ObservableQuery<any>[];\n  // These are the raw TResult values returned by any onQueryUpdated functions\n  // that were invoked by client.refetchQueries.\n  results: InternalRefetchQueriesResult<TResult>[];\n}\n\n// Used by QueryManager[\"refetchQueries\"]\nexport interface InternalRefetchQueriesOptions<\n  TCache extends ApolloCache<any>,\n  TResult,\n> extends Omit<RefetchQueriesOptions<TCache, TResult>, \"include\"> {\n  // Just like the refetchQueries option for a mutation, an array of strings,\n  // DocumentNode objects, and/or QueryOptions objects, or one of the shorthand\n  // strings \"all\" or \"active\", to select every (active) query.\n  include?: InternalRefetchQueriesInclude;\n  // This part of the API is a (useful) implementation detail, but need not be\n  // exposed in the public client.refetchQueries API (above).\n  removeOptimistic?: string;\n}\n\nexport type InternalRefetchQueriesResult<TResult> =\n  // If onQueryUpdated returns a boolean, that's equivalent to refetching the\n  // query when the boolean is true and skipping the query when false, so the\n  // internal type of refetched results is Promise<ApolloQueryResult<any>>.\n  TResult extends boolean ? Promise<InteropApolloQueryResult<any>>\n  : // Otherwise, onQueryUpdated returns whatever it returns. If onQueryUpdated is\n    // not provided, TResult defaults to Promise<ApolloQueryResult<any>> (see the\n    // generic type parameters of client.refetchQueries).\n    TResult;\n\nexport type InternalRefetchQueriesMap<TResult> = Map<\n  ObservableQuery<any>,\n  InternalRefetchQueriesResult<TResult>\n>;\n\n// TODO Remove this unnecessary type in Apollo Client 4.\nexport type { QueryOptions as PureQueryOptions };\n\nexport type OperationVariables = Record<string, any>;\n\nexport interface ApolloQueryResult<T> {\n  /** {@inheritDoc @apollo/client!QueryResultDocumentation#data:member} */\n  data: T;\n  /**\n   * A list of any errors that occurred during server-side execution of a GraphQL operation.\n   * See https://www.apollographql.com/docs/react/data/error-handling/ for more information.\n   */\n  errors?: ReadonlyArray<GraphQLFormattedError>;\n  /**\n   * The single Error object that is passed to onError and useQuery hooks, and is often thrown during manual `client.query` calls.\n   * This will contain both a NetworkError field and any GraphQLErrors.\n   * See https://www.apollographql.com/docs/react/data/error-handling/ for more information.\n   */\n  error?: ApolloError;\n  loading: boolean;\n  networkStatus: NetworkStatus;\n  // If result.data was read from the cache with missing fields,\n  // result.partial will be true. Otherwise, result.partial will be falsy\n  // (usually because the property is absent from the result object).\n  partial?: boolean;\n}\n\n/**\n * @deprecated This type does not exist in Apollo Client 4.0 and is meant as a\n * bridge between versions for deprecations.\n */\nexport interface InteropApolloQueryResult<T> {\n  /** {@inheritDoc @apollo/client!QueryResultDocumentation#data:member} */\n  data: T;\n  /**\n   * @deprecated `errors` will no longer available on the result in Apollo Client 4.0.\n   * This value is safe to use in Apollo Client 3.x.\n   *\n   * **Recommended now**\n   *\n   * No action needed\n   *\n   * **When upgrading**\n   *\n   * `errors` has been consolidated to the `error` property. You will need to\n   * read any errors on the `error` property on the resolved value instead.\n   */\n  errors?: ReadonlyArray<GraphQLFormattedError>;\n  /**\n   * The single Error object that is passed to onError and useQuery hooks, and is often thrown during manual `client.query` calls.\n   * This will contain both a NetworkError field and any GraphQLErrors.\n   * See https://www.apollographql.com/docs/react/data/error-handling/ for more information.\n   */\n  error?: ApolloError;\n  /**\n   * @deprecated `loading` will no longer available on the result in Apollo Client 4.0.\n   * This value is always true when the resolved and can safely ignored.\n   */\n  loading: boolean;\n  /**\n   * @deprecated `loading` will no longer available on the result in Apollo Client 4.0.\n   * This value is always `NetworkStatus.ready` or `NetworkStatus.error`. To\n   * determine if the result contains an error, read from the `error` or `errors`\n   * property instead.\n   */\n  networkStatus: NetworkStatus;\n  /**\n   * @deprecated `partial` will no longer available on the result in Apollo Client 4.0.\n   * This value is always `false` if there is a data value since the result\n   * never contains partial cache data.\n   */\n  partial?: boolean;\n}\n\n/**\n * @deprecated This type does not exist in Apollo Client 4.0 and is meant as a\n * bridge between versions for deprecations.\n */\ninterface InteropSingleExecutionResult<\n  TData = Record<string, any>,\n  TContext = DefaultContext,\n  TExtensions = Record<string, any>,\n> {\n  data?: TData | null;\n  /**\n   * @deprecated `context` will no longer available on the result in Apollo Client 4.0.\n   */\n  context?: TContext;\n  /**\n   * @deprecated `errors` is no longer available on the result in Apollo Client 4.0.\n   * This value is safe to use in Apollo Client 3.x.\n   *\n   * **Recommended now**\n   *\n   * No action needed\n   *\n   * **When upgrading**\n   *\n   * `errors` has been consolidated to the `error` property. You will need to\n   * read any errors on the `error` property on the resolved value instead.\n   */\n  errors?: ReadonlyArray<GraphQLFormattedError>;\n  extensions?: TExtensions;\n}\n\n/**\n * @deprecated This type does not exist in Apollo Client 4.0 and is meant as a\n * bridge between versions for deprecations.\n */\nexport interface InteropMutationExecutionPatchInitialResult<\n  TData = Record<string, any>,\n  TExtensions = Record<string, any>,\n> {\n  /**\n   * @deprecated `hasNext` will no longer available on the result in Apollo Client 4.0.\n   */\n  hasNext?: boolean;\n  // if data is present, incremental is not\n  data: TData | null | undefined;\n  /**\n   * @deprecated `incremental` will no longer available on the result in Apollo Client 4.0.\n   */\n  incremental?: never;\n  /**\n   * @deprecated `errors` is no longer available on the result in Apollo Client 4.0.\n   * This value is safe to use in Apollo Client 3.x.\n   *\n   * **Recommended now**\n   *\n   * No action needed\n   *\n   * **When upgrading**\n   *\n   * `errors` has been consolidated to the `error` property. You will need to\n   * read any errors on the `error` property on the resolved value instead.\n   */\n  errors?: ReadonlyArray<GraphQLFormattedError>;\n  extensions?: TExtensions;\n}\n\n/**\n * @deprecated This type does not exist in Apollo Client 4.0 and is meant as a\n * bridge between versions for deprecations.\n */\nexport interface InteropMutationExecutionPatchIncrementalResult<\n  TData = Record<string, any>,\n  TExtensions = Record<string, any>,\n> {\n  /**\n   * @deprecated `hasNext` will no longer available on the result in Apollo Client 4.0.\n   * This value is safe to use in Apollo Client 3.x.\n   *\n   * **Recommended now**\n   *\n   * No action needed\n   *\n   * **When upgrading**\n   *\n   * `errors` has been consolidated to the `error` property. You will need to\n   * read any errors on the `error` property on the resolved value instead.\n   */\n  hasNext?: boolean;\n  /**\n   * @deprecated `incremental` will no longer available on the result in Apollo Client 4.0.\n   */\n  incremental?: IncrementalPayload<TData, TExtensions>[];\n  data?: never;\n  /**\n   * @deprecated `errors` is no longer available on the result in Apollo Client 4.0.\n   * This value is safe to use in Apollo Client 3.x.\n   *\n   * **Recommended now**\n   *\n   * No action needed\n   *\n   * **When upgrading**\n   *\n   * `errors` has been consolidated to the `error` property. You will need to\n   * read any errors on the `error` property on the resolved value instead.\n   */\n  errors?: never;\n  extensions?: never;\n}\n\n/**\n * @deprecated This type does not exist in Apollo Client 4.0 and is meant as a\n * bridge between versions for deprecations.\n */\nexport type InteropExecutionPatchResult<\n  TData = Record<string, any>,\n  TExtensions = Record<string, any>,\n> =\n  | InteropMutationExecutionPatchInitialResult<TData, TExtensions>\n  | InteropMutationExecutionPatchIncrementalResult<TData, TExtensions>;\n\n/**\n * @deprecated This type does not exist in Apollo Client 4.0 and is meant as a\n * bridge between versions for deprecations.\n */\nexport type InteropMutateResult<\n  TData = Record<string, any>,\n  TContext = DefaultContext,\n  TExtensions = Record<string, any>,\n> =\n  | InteropSingleExecutionResult<TData, TContext, TExtensions>\n  | InteropExecutionPatchResult<TData, TExtensions>;\n\n/**\n * @deprecated This type does not exist in Apollo Client 4.0 and is meant as a\n * bridge between versions for deprecations.\n */\nexport type InteropSubscribeResult<\n  TData = Record<string, any>,\n  TContext = DefaultContext,\n  TExtensions = Record<string, any>,\n> =\n  | InteropSingleExecutionResult<TData, TContext, TExtensions>\n  | InteropExecutionPatchResult<TData, TExtensions>;\n\n// This is part of the public API, people write these functions in `updateQueries`.\nexport type MutationQueryReducer<T> = (\n  previousResult: Record<string, any>,\n  options: {\n    mutationResult: FetchResult<Unmasked<T>>;\n    queryName: string | undefined;\n    queryVariables: Record<string, any>;\n  }\n) => Record<string, any>;\n\nexport type MutationQueryReducersMap<T = { [key: string]: any }> = {\n  [queryName: string]: MutationQueryReducer<T>;\n};\n\n/**\n * @deprecated Use `MutationUpdaterFunction` instead.\n */\nexport type MutationUpdaterFn<T = { [key: string]: any }> = (\n  // The MutationUpdaterFn type is broken because it mistakenly uses the same\n  // type parameter T for both the cache and the mutationResult. Do not use this\n  // type unless you absolutely need it for backwards compatibility.\n  cache: ApolloCache<T>,\n  mutationResult: FetchResult<T>\n) => void;\n\nexport type MutationUpdaterFunction<\n  TData,\n  TVariables,\n  TContext,\n  TCache extends ApolloCache<any>,\n> = (\n  cache: TCache,\n  result: Omit<FetchResult<Unmasked<TData>>, \"context\">,\n  options: {\n    context?: TContext;\n    variables?: TVariables;\n  }\n) => void;\nexport interface Resolvers {\n  [key: string]: {\n    [field: string]: Resolver;\n  };\n}\n"]}