@apollo/client 4.0.0-rc.4 → 4.0.0-rc.6

package/core/watchQueryOptions.d.ts

@@ -1,14 +1,11 @@
-import type { TypedDocumentNode } from "@graphql-typed-document-node/core";
-import type { DocumentNode } from "graphql";
-import type { ApolloCache } from "@apollo/client/cache";
-import type { IgnoreModifier } from "@apollo/client/cache";
 import type { Unmasked } from "@apollo/client/masking";
 import type { DeepPartial } from "@apollo/client/utilities";
-import type { NoInfer, VariablesOption } from "@apollo/client/utilities/internal";
+import type { ApolloClient } from "./ApolloClient.js";
 import type { ObservableQuery } from "./ObservableQuery.js";
-import type { DefaultContext, ErrorLike, InternalRefetchQueriesInclude, MutationQueryReducersMap, MutationUpdaterFunction, NormalizedExecutionResult, OnQueryUpdated, OperationVariables } from "./types.js";
+import type { OperationVariables } from "./types.js";
 /**
  * fetchPolicy determines where the client may return a result from. The options are:
+ *
  * - cache-first (default): return result from cache. Only fetch from network if cached result is not available.
  * - cache-and-network: return result from cache first (if it exists), then return network result once it's available.
  * - cache-only: return result from cache if available, fail otherwise.
@@ -22,170 +19,19 @@ export type MutationFetchPolicy = Extract<FetchPolicy, "network-only" | "no-cach
 export type RefetchWritePolicy = "merge" | "overwrite";
 /**
  * errorPolicy determines the level of events for errors in the execution result. The options are:
+ *
  * - none (default): any errors from the request are treated like runtime errors and the observable is stopped
  * - ignore: errors from the request do not stop the observable, but also don't call `next`
  * - all: errors are treated like data and will notify observables
  */
 export type ErrorPolicy = "none" | "ignore" | "all";
-/**
- * Query options.
- */
-export type QueryOptions<TVariables extends OperationVariables = OperationVariables, TData = unknown> = {
-    /**
-    * A GraphQL query string parsed into an AST with the gql template literal.
-    * 
-    * @docGroup
-    * 
-    * 1. Operation options
-    */
-    query: DocumentNode | TypedDocumentNode<TData, TVariables>;
-    /**
-    * Specifies how the query handles a response that returns both GraphQL errors and partial results.
-    * 
-    * For details, see [GraphQL error policies](https://www.apollographql.com/docs/react/data/error-handling/#graphql-error-policies).
-    * 
-    * The default value is `none`, meaning that the query result includes error details but not partial results.
-    * 
-    * @docGroup
-    * 
-    * 1. Operation options
-    */
-    errorPolicy?: ErrorPolicy;
-    /**
-    * If you're using [Apollo Link](https://www.apollographql.com/docs/react/api/link/introduction/), this object is the initial value of the `context` object that's passed along your link chain.
-    * 
-    * @docGroup
-    * 
-    * 2. Networking options
-    */
-    context?: DefaultContext;
-    /**
-    * Specifies how the query interacts with the Apollo Client cache during execution (for example, whether it checks the cache for results before sending a request to the server).
-    * 
-    * For details, see [Setting a fetch policy](https://www.apollographql.com/docs/react/data/queries/#setting-a-fetch-policy).
-    * 
-    * The default value is `cache-first`.
-    * 
-    * @docGroup
-    * 
-    * 3. Caching options
-    */
-    fetchPolicy?: FetchPolicy;
-} & VariablesOption<NoInfer<TVariables>>;
-/**
- * Watched query options.
- */
-export type WatchQueryOptions<TVariables extends OperationVariables = OperationVariables, TData = unknown> = {
-    /**
-    * Specifies how the query interacts with the Apollo Client cache during execution (for example, whether it checks the cache for results before sending a request to the server).
-    * 
-    * For details, see [Setting a fetch policy](https://www.apollographql.com/docs/react/data/queries/#setting-a-fetch-policy).
-    * 
-    * The default value is `cache-first`.
-    * 
-    * @docGroup
-    * 
-    * 3. Caching options
-    */
-    fetchPolicy?: WatchQueryFetchPolicy;
-    /**
-    * Specifies the `FetchPolicy` to be used after this query has completed.
-    * 
-    * @docGroup
-    * 
-    * 3. Caching options
-    */
-    nextFetchPolicy?: WatchQueryFetchPolicy | ((this: WatchQueryOptions<TVariables, TData>, currentFetchPolicy: WatchQueryFetchPolicy, context: NextFetchPolicyContext<TData, TVariables>) => WatchQueryFetchPolicy);
-    /**
-    * Defaults to the initial value of options.fetchPolicy, but can be explicitly configured to specify the WatchQueryFetchPolicy to revert back to whenever variables change (unless nextFetchPolicy intervenes).
-    * 
-    * @docGroup
-    * 
-    * 3. Caching options
-    */
-    initialFetchPolicy?: WatchQueryFetchPolicy;
-    /**
-    * Specifies whether a `NetworkStatus.refetch` operation should merge incoming field data with existing data, or overwrite the existing data. Overwriting is probably preferable, but merging is currently the default behavior, for backwards compatibility with Apollo Client 3.x.
-    * 
-    * @docGroup
-    * 
-    * 3. Caching options
-    */
-    refetchWritePolicy?: RefetchWritePolicy;
-    /**
-    * Specifies how the query handles a response that returns both GraphQL errors and partial results.
-    * 
-    * For details, see [GraphQL error policies](https://www.apollographql.com/docs/react/data/error-handling/#graphql-error-policies).
-    * 
-    * The default value is `none`, meaning that the query result includes error details but not partial results.
-    * 
-    * @docGroup
-    * 
-    * 1. Operation options
-    */
-    errorPolicy?: ErrorPolicy;
-    /**
-    * If you're using [Apollo Link](https://www.apollographql.com/docs/react/api/link/introduction/), this object is the initial value of the `context` object that's passed along your link chain.
-    * 
-    * @docGroup
-    * 
-    * 2. Networking options
-    */
-    context?: DefaultContext;
-    /**
-    * Specifies the interval (in milliseconds) at which the query polls for updated results.
-    * 
-    * The default value is `0` (no polling).
-    * 
-    * @docGroup
-    * 
-    * 2. Networking options
-    */
-    pollInterval?: number;
-    /**
-    * If `true`, the in-progress query's associated component re-renders whenever the network status changes or a network error occurs.
-    * 
-    * The default value is `true`.
-    * 
-    * @docGroup
-    * 
-    * 2. Networking options
-    */
-    notifyOnNetworkStatusChange?: boolean;
-    /**
-    * If `true`, the query can return partial results from the cache if the cache doesn't contain results for all queried fields.
-    * 
-    * The default value is `false`.
-    * 
-    * @docGroup
-    * 
-    * 3. Caching options
-    */
-    returnPartialData?: boolean;
-    /**
-    * A callback function that's called whenever a refetch attempt occurs while polling. If the function returns `true`, the refetch is skipped and not reattempted until the next poll interval.
-    * 
-    * @docGroup
-    * 
-    * 2. Networking options
-    */
-    skipPollAttempt?: () => boolean;
-    /**
-    * A GraphQL query string parsed into an AST with the gql template literal.
-    * 
-    * @docGroup
-    * 
-    * 1. Operation options
-    */
-    query: DocumentNode | TypedDocumentNode<TData, TVariables>;
-} & VariablesOption<NoInfer<TVariables>>;
 export interface NextFetchPolicyContext<TData, TVariables extends OperationVariables> {
     reason: "after-fetch" | "variables-changed";
     observable: ObservableQuery<TData, TVariables>;
-    options: WatchQueryOptions<TVariables, TData>;
+    options: ApolloClient.WatchQueryOptions<TData, TVariables>;
     initialFetchPolicy: WatchQueryFetchPolicy;
 }
-export type UpdateQueryOptions<TData, TVariables> = {
+export type UpdateQueryOptions<TData, TVariables extends OperationVariables> = {
     variables?: TVariables;
 } & ({
     /**
@@ -201,7 +47,7 @@ export type UpdateQueryOptions<TData, TVariables> = {
     complete: false;
     previousData: DeepPartial<Unmasked<TData>> | undefined;
 });
-export interface UpdateQueryMapFn<TData = unknown, TVariables = OperationVariables> {
+export interface UpdateQueryMapFn<TData = unknown, TVariables extends OperationVariables = OperationVariables> {
     (
     /**
      * @deprecated This value is not type-safe and may contain partial data. This
@@ -223,142 +69,7 @@ export type SubscribeToMoreUpdateQueryFn<TData = unknown, TVariables extends Ope
         };
     }): Unmasked<TData> | void;
 };
-export interface SubscribeToMoreOptions<TData = unknown, TSubscriptionVariables extends OperationVariables = OperationVariables, TSubscriptionData = TData, TVariables extends OperationVariables = TSubscriptionVariables> {
-    document: DocumentNode | TypedDocumentNode<TSubscriptionData, TSubscriptionVariables>;
-    variables?: TSubscriptionVariables;
-    updateQuery?: SubscribeToMoreUpdateQueryFn<TData, TVariables, TSubscriptionData>;
-    onError?: (error: ErrorLike) => void;
-    context?: DefaultContext;
-}
 export interface SubscribeToMoreFunction<TData, TVariables extends OperationVariables = OperationVariables> {
-    <TSubscriptionData = TData, TSubscriptionVariables extends OperationVariables = TVariables>(options: SubscribeToMoreOptions<TData, TSubscriptionVariables, TSubscriptionData, TVariables>): () => void;
+    <TSubscriptionData = TData, TSubscriptionVariables extends OperationVariables = TVariables>(options: ObservableQuery.SubscribeToMoreOptions<TData, TSubscriptionVariables, TSubscriptionData, TVariables>): () => void;
 }
-export type SubscriptionOptions<TVariables extends OperationVariables = OperationVariables, TData = unknown> = {
-    /**
-    * A GraphQL document, often created with `gql` from the `graphql-tag` package, that contains a single subscription inside of it.
-    */
-    query: DocumentNode | TypedDocumentNode<TData, TVariables>;
-    /**
-    * How you want your component to interact with the Apollo cache. For details, see [Setting a fetch policy](https://www.apollographql.com/docs/react/data/queries/#setting-a-fetch-policy).
-    */
-    fetchPolicy?: FetchPolicy;
-    /**
-    * Specifies the `ErrorPolicy` to be used for this operation
-    */
-    errorPolicy?: ErrorPolicy;
-    /**
-    * Shared context between your component and your network interface (Apollo Link).
-    */
-    context?: DefaultContext;
-    /**
-    * Shared context between your component and your network interface (Apollo Link).
-    */
-    extensions?: Record<string, any>;
-} & VariablesOption<NoInfer<TVariables>>;
-export type MutationOptions<TData = unknown, TVariables extends OperationVariables = OperationVariables, TCache extends ApolloCache = ApolloCache> = {
-    /**
-    * By providing either an object or a callback function that, when invoked after a mutation, allows you to return optimistic data and optionally skip updates via the `IGNORE` sentinel object, Apollo Client caches this temporary (and potentially incorrect) response until the mutation completes, enabling more responsive UI updates.
-    * 
-    * For more information, see [Optimistic mutation results](https://www.apollographql.com/docs/react/performance/optimistic-ui/).
-    * 
-    * @docGroup
-    * 
-    * 3. Caching options
-    */
-    optimisticResponse?: Unmasked<NoInfer<TData>> | ((vars: TVariables, { IGNORE }: {
-        IGNORE: IgnoreModifier;
-    }) => Unmasked<NoInfer<TData>> | IgnoreModifier);
-    /**
-    * A `MutationQueryReducersMap`, which is map from query names to mutation query reducers. Briefly, this map defines how to incorporate the results of the mutation into the results of queries that are currently being watched by your application.
-    */
-    updateQueries?: MutationQueryReducersMap<TData>;
-    /**
-    * An array (or a function that _returns_ an array) that specifies which queries you want to refetch after the mutation occurs.
-    * 
-    * Each array value can be either:
-    * 
-    * - An object containing the `query` to execute, along with any `variables`
-    * 
-    * - A string indicating the operation name of the query to refetch
-    * 
-    * @docGroup
-    * 
-    * 1. Operation options
-    */
-    refetchQueries?: ((result: NormalizedExecutionResult<Unmasked<TData>>) => InternalRefetchQueriesInclude) | InternalRefetchQueriesInclude;
-    /**
-    * If `true`, makes sure all queries included in `refetchQueries` are completed before the mutation is considered complete.
-    * 
-    * The default value is `false` (queries are refetched asynchronously).
-    * 
-    * @docGroup
-    * 
-    * 1. Operation options
-    */
-    awaitRefetchQueries?: boolean;
-    /**
-    * A function used to update the Apollo Client cache after the mutation completes.
-    * 
-    * For more information, see [Updating the cache after a mutation](https://www.apollographql.com/docs/react/data/mutations#updating-the-cache-after-a-mutation).
-    * 
-    * @docGroup
-    * 
-    * 3. Caching options
-    */
-    update?: MutationUpdaterFunction<TData, TVariables, TCache>;
-    /**
-    * Optional callback for intercepting queries whose cache data has been updated by the mutation, as well as any queries specified in the `refetchQueries: [...]` list passed to `client.mutate`.
-    * 
-    * Returning a `Promise` from `onQueryUpdated` will cause the final mutation `Promise` to await the returned `Promise`. Returning `false` causes the query to be ignored.
-    * 
-    * @docGroup
-    * 
-    * 1. Operation options
-    */
-    onQueryUpdated?: OnQueryUpdated<any>;
-    /**
-    * Specifies how the mutation handles a response that returns both GraphQL errors and partial results.
-    * 
-    * For details, see [GraphQL error policies](https://www.apollographql.com/docs/react/data/error-handling/#graphql-error-policies).
-    * 
-    * The default value is `none`, meaning that the mutation result includes error details but _not_ partial results.
-    * 
-    * @docGroup
-    * 
-    * 1. Operation options
-    */
-    errorPolicy?: ErrorPolicy;
-    /**
-    * If you're using [Apollo Link](https://www.apollographql.com/docs/react/api/link/introduction/), this object is the initial value of the `context` object that's passed along your link chain.
-    * 
-    * @docGroup
-    * 
-    * 2. Networking options
-    */
-    context?: DefaultContext;
-    /**
-    * Provide `no-cache` if the mutation's result should _not_ be written to the Apollo Client cache.
-    * 
-    * The default value is `network-only` (which means the result _is_ written to the cache).
-    * 
-    * Unlike queries, mutations _do not_ support [fetch policies](https://www.apollographql.com/docs/react/data/queries/#setting-a-fetch-policy) besides `network-only` and `no-cache`.
-    * 
-    * @docGroup
-    * 
-    * 3. Caching options
-    */
-    fetchPolicy?: MutationFetchPolicy;
-    /**
-    * To avoid retaining sensitive information from mutation root field arguments, Apollo Client v3.4+ automatically clears any `ROOT_MUTATION` fields from the cache after each mutation finishes. If you need this information to remain in the cache, you can prevent the removal by passing `keepRootFields: true` to the mutation. `ROOT_MUTATION` result data are also passed to the mutation `update` function, so we recommend obtaining the results that way, rather than using this option, if possible.
-    */
-    keepRootFields?: boolean;
-    /**
-    * A GraphQL document, often created with `gql` from the `graphql-tag` package, that contains a single mutation inside of it.
-    * 
-    * @docGroup
-    * 
-    * 1. Operation options
-    */
-    mutation: DocumentNode | TypedDocumentNode<TData, TVariables>;
-} & VariablesOption<NoInfer<TVariables>>;
-//# sourceMappingURL=watchQueryOptions.d.ts.map
+//# sourceMappingURL=watchQueryOptions.d.ts.map

package/core/watchQueryOptions.js.map

@@ -1 +1 @@
-{"version":3,"file":"watchQueryOptions.js","sourceRoot":"","sources":["../../src/core/watchQueryOptions.ts"],"names":[],"mappings":"","sourcesContent":["import type { TypedDocumentNode } from \"@graphql-typed-document-node/core\";\nimport type { DocumentNode } from \"graphql\";\n\nimport type { ApolloCache } from \"@apollo/client/cache\";\nimport type { IgnoreModifier } from \"@apollo/client/cache\";\nimport type { Unmasked } from \"@apollo/client/masking\";\nimport type { DeepPartial } from \"@apollo/client/utilities\";\nimport type {\n  NoInfer,\n  VariablesOption,\n} from \"@apollo/client/utilities/internal\";\n\nimport type { ObservableQuery } from \"./ObservableQuery.js\";\nimport type {\n  DefaultContext,\n  ErrorLike,\n  InternalRefetchQueriesInclude,\n  MutationQueryReducersMap,\n  MutationUpdaterFunction,\n  NormalizedExecutionResult,\n  OnQueryUpdated,\n  OperationVariables,\n} from \"./types.js\";\n\n/**\n * fetchPolicy determines where the client may return a result from. The options are:\n * - cache-first (default): return result from cache. Only fetch from network if cached result is not available.\n * - cache-and-network: return result from cache first (if it exists), then return network result once it's available.\n * - cache-only: return result from cache if available, fail otherwise.\n * - no-cache: return result from network, fail if network call doesn't succeed, don't save to cache\n * - network-only: return result from network, fail if network call doesn't succeed, save to cache\n * - standby: only for queries that aren't actively watched, but should be available for refetch and updateQueries.\n */\nexport type FetchPolicy =\n  | \"cache-first\"\n  | \"network-only\"\n  | \"cache-only\"\n  | \"no-cache\";\n\nexport type WatchQueryFetchPolicy =\n  | FetchPolicy\n  | \"cache-and-network\"\n  | \"standby\";\n\nexport type MutationFetchPolicy = Extract<\n  FetchPolicy,\n  | \"network-only\" // default behavior (mutation results written to cache)\n  | \"no-cache\" // alternate behavior (results not written to cache)\n>;\n\nexport type RefetchWritePolicy = \"merge\" | \"overwrite\";\n\n/**\n * errorPolicy determines the level of events for errors in the execution result. The options are:\n * - none (default): any errors from the request are treated like runtime errors and the observable is stopped\n * - ignore: errors from the request do not stop the observable, but also don't call `next`\n * - all: errors are treated like data and will notify observables\n */\nexport type ErrorPolicy = \"none\" | \"ignore\" | \"all\";\n\n/**\n * Query options.\n */\nexport type QueryOptions<\n  TVariables extends OperationVariables = OperationVariables,\n  TData = unknown,\n> = {\n  /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#query:member} */\n  query: DocumentNode | TypedDocumentNode<TData, TVariables>;\n\n  /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#errorPolicy:member} */\n  errorPolicy?: ErrorPolicy;\n\n  /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#context:member} */\n  context?: DefaultContext;\n\n  /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#fetchPolicy:member} */\n  fetchPolicy?: FetchPolicy;\n} & VariablesOption<NoInfer<TVariables>>;\n\n/**\n * Watched query options.\n */\nexport type WatchQueryOptions<\n  TVariables extends OperationVariables = OperationVariables,\n  TData = unknown,\n> = {\n  /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#fetchPolicy:member} */\n  fetchPolicy?: WatchQueryFetchPolicy;\n\n  /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#nextFetchPolicy:member} */\n  nextFetchPolicy?:\n    | WatchQueryFetchPolicy\n    | ((\n        this: WatchQueryOptions<TVariables, TData>,\n        currentFetchPolicy: WatchQueryFetchPolicy,\n        context: NextFetchPolicyContext<TData, TVariables>\n      ) => WatchQueryFetchPolicy);\n\n  /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#initialFetchPolicy:member} */\n  initialFetchPolicy?: WatchQueryFetchPolicy;\n\n  /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#refetchWritePolicy:member} */\n  refetchWritePolicy?: RefetchWritePolicy;\n\n  /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#errorPolicy:member} */\n  errorPolicy?: ErrorPolicy;\n\n  /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#context:member} */\n  context?: DefaultContext;\n\n  /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#pollInterval:member} */\n  pollInterval?: number;\n\n  /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#notifyOnNetworkStatusChange:member} */\n  notifyOnNetworkStatusChange?: boolean;\n\n  /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#returnPartialData:member} */\n  returnPartialData?: boolean;\n\n  /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#skipPollAttempt:member} */\n  skipPollAttempt?: () => boolean;\n\n  /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#query:member} */\n  query: DocumentNode | TypedDocumentNode<TData, TVariables>;\n} & VariablesOption<NoInfer<TVariables>>;\n\nexport interface NextFetchPolicyContext<\n  TData,\n  TVariables extends OperationVariables,\n> {\n  reason: \"after-fetch\" | \"variables-changed\";\n  observable: ObservableQuery<TData, TVariables>;\n  options: WatchQueryOptions<TVariables, TData>;\n  initialFetchPolicy: WatchQueryFetchPolicy;\n}\n\nexport type UpdateQueryOptions<TData, TVariables> = {\n  variables?: TVariables;\n} & (\n  | {\n      /**\n       * Indicate if the previous query result has been found fully in the cache.\n       */\n      complete: true;\n      previousData: Unmasked<TData>;\n    }\n  | {\n      /**\n       * Indicate if the previous query result has not been found fully in the cache.\n       * Might have partial or missing data.\n       */\n      complete: false;\n      previousData: DeepPartial<Unmasked<TData>> | undefined;\n    }\n);\n\nexport interface UpdateQueryMapFn<\n  TData = unknown,\n  TVariables = OperationVariables,\n> {\n  (\n    /**\n     * @deprecated This value is not type-safe and may contain partial data. This\n     * argument will be removed in Apollo Client v5. Use `options.previousData`\n     * instead for a more type-safe value.\n     */\n    unsafePreviousData: DeepPartial<Unmasked<TData>>,\n    options: UpdateQueryOptions<TData, TVariables>\n  ): Unmasked<TData> | void;\n}\n\nexport type SubscribeToMoreUpdateQueryFn<\n  TData = unknown,\n  TVariables extends OperationVariables = OperationVariables,\n  TSubscriptionData = TData,\n> = {\n  (\n    /**\n     * @deprecated This value is not type-safe and may contain partial data. This\n     * argument will be removed in Apollo Client v5. Use `options.previousData`\n     * instead for a more type-safe value.\n     */\n    unsafePreviousData: DeepPartial<Unmasked<TData>>,\n    options: UpdateQueryOptions<TData, TVariables> & {\n      subscriptionData: { data: Unmasked<TSubscriptionData> };\n    }\n  ): Unmasked<TData> | void;\n};\n\nexport interface SubscribeToMoreOptions<\n  TData = unknown,\n  TSubscriptionVariables extends OperationVariables = OperationVariables,\n  TSubscriptionData = TData,\n  TVariables extends OperationVariables = TSubscriptionVariables,\n> {\n  document:\n    | DocumentNode\n    | TypedDocumentNode<TSubscriptionData, TSubscriptionVariables>;\n  variables?: TSubscriptionVariables;\n  updateQuery?: SubscribeToMoreUpdateQueryFn<\n    TData,\n    TVariables,\n    TSubscriptionData\n  >;\n  onError?: (error: ErrorLike) => void;\n  context?: DefaultContext;\n}\n\nexport interface SubscribeToMoreFunction<\n  TData,\n  TVariables extends OperationVariables = OperationVariables,\n> {\n  <\n    TSubscriptionData = TData,\n    TSubscriptionVariables extends OperationVariables = TVariables,\n  >(\n    options: SubscribeToMoreOptions<\n      TData,\n      TSubscriptionVariables,\n      TSubscriptionData,\n      TVariables\n    >\n  ): () => void;\n}\n\nexport type SubscriptionOptions<\n  TVariables extends OperationVariables = OperationVariables,\n  TData = unknown,\n> = {\n  /** {@inheritDoc @apollo/client!SubscriptionOptionsDocumentation#query:member} */\n  query: DocumentNode | TypedDocumentNode<TData, TVariables>;\n\n  /** {@inheritDoc @apollo/client!SubscriptionOptionsDocumentation#fetchPolicy:member} */\n  fetchPolicy?: FetchPolicy;\n\n  /** {@inheritDoc @apollo/client!SubscriptionOptionsDocumentation#errorPolicy:member} */\n  errorPolicy?: ErrorPolicy;\n\n  /** {@inheritDoc @apollo/client!SubscriptionOptionsDocumentation#context:member} */\n  context?: DefaultContext;\n\n  /** {@inheritDoc @apollo/client!SubscriptionOptionsDocumentation#extensions:member} */\n  extensions?: Record<string, any>;\n} & VariablesOption<NoInfer<TVariables>>;\n\nexport type MutationOptions<\n  TData = unknown,\n  TVariables extends OperationVariables = OperationVariables,\n  TCache extends ApolloCache = ApolloCache,\n> = {\n  /** {@inheritDoc @apollo/client!MutationOptionsDocumentation#optimisticResponse:member} */\n  optimisticResponse?:\n    | Unmasked<NoInfer<TData>>\n    | ((\n        vars: TVariables,\n        { IGNORE }: { IGNORE: IgnoreModifier }\n      ) => Unmasked<NoInfer<TData>> | IgnoreModifier);\n\n  /** {@inheritDoc @apollo/client!MutationOptionsDocumentation#updateQueries:member} */\n  updateQueries?: MutationQueryReducersMap<TData>;\n\n  /** {@inheritDoc @apollo/client!MutationOptionsDocumentation#refetchQueries:member} */\n  refetchQueries?:\n    | ((\n        result: NormalizedExecutionResult<Unmasked<TData>>\n      ) => InternalRefetchQueriesInclude)\n    | InternalRefetchQueriesInclude;\n\n  /** {@inheritDoc @apollo/client!MutationOptionsDocumentation#awaitRefetchQueries:member} */\n  awaitRefetchQueries?: boolean;\n\n  /** {@inheritDoc @apollo/client!MutationOptionsDocumentation#update:member} */\n  update?: MutationUpdaterFunction<TData, TVariables, TCache>;\n\n  /** {@inheritDoc @apollo/client!MutationOptionsDocumentation#onQueryUpdated:member} */\n  onQueryUpdated?: OnQueryUpdated<any>;\n\n  /** {@inheritDoc @apollo/client!MutationOptionsDocumentation#errorPolicy:member} */\n  errorPolicy?: ErrorPolicy;\n\n  /** {@inheritDoc @apollo/client!MutationOptionsDocumentation#context:member} */\n  context?: DefaultContext;\n\n  /** {@inheritDoc @apollo/client!MutationOptionsDocumentation#fetchPolicy:member} */\n  fetchPolicy?: MutationFetchPolicy;\n\n  /** {@inheritDoc @apollo/client!MutationOptionsDocumentation#keepRootFields:member} */\n  keepRootFields?: boolean;\n\n  /** {@inheritDoc @apollo/client!MutationOptionsDocumentation#mutation:member} */\n  mutation: DocumentNode | TypedDocumentNode<TData, TVariables>;\n} & VariablesOption<NoInfer<TVariables>>;\n"]}
+{"version":3,"file":"watchQueryOptions.js","sourceRoot":"","sources":["../../src/core/watchQueryOptions.ts"],"names":[],"mappings":"","sourcesContent":["import type { Unmasked } from \"@apollo/client/masking\";\nimport type { DeepPartial } from \"@apollo/client/utilities\";\n\nimport type { ApolloClient } from \"./ApolloClient.js\";\nimport type { ObservableQuery } from \"./ObservableQuery.js\";\nimport type { OperationVariables } from \"./types.js\";\n\n/**\n * fetchPolicy determines where the client may return a result from. The options are:\n *\n * - cache-first (default): return result from cache. Only fetch from network if cached result is not available.\n * - cache-and-network: return result from cache first (if it exists), then return network result once it's available.\n * - cache-only: return result from cache if available, fail otherwise.\n * - no-cache: return result from network, fail if network call doesn't succeed, don't save to cache\n * - network-only: return result from network, fail if network call doesn't succeed, save to cache\n * - standby: only for queries that aren't actively watched, but should be available for refetch and updateQueries.\n */\nexport type FetchPolicy =\n  | \"cache-first\"\n  | \"network-only\"\n  | \"cache-only\"\n  | \"no-cache\";\n\nexport type WatchQueryFetchPolicy =\n  | FetchPolicy\n  | \"cache-and-network\"\n  | \"standby\";\n\nexport type MutationFetchPolicy = Extract<\n  FetchPolicy,\n  | \"network-only\" // default behavior (mutation results written to cache)\n  | \"no-cache\" // alternate behavior (results not written to cache)\n>;\n\nexport type RefetchWritePolicy = \"merge\" | \"overwrite\";\n\n/**\n * errorPolicy determines the level of events for errors in the execution result. The options are:\n *\n * - none (default): any errors from the request are treated like runtime errors and the observable is stopped\n * - ignore: errors from the request do not stop the observable, but also don't call `next`\n * - all: errors are treated like data and will notify observables\n */\nexport type ErrorPolicy = \"none\" | \"ignore\" | \"all\";\n\nexport interface NextFetchPolicyContext<\n  TData,\n  TVariables extends OperationVariables,\n> {\n  reason: \"after-fetch\" | \"variables-changed\";\n  observable: ObservableQuery<TData, TVariables>;\n  options: ApolloClient.WatchQueryOptions<TData, TVariables>;\n  initialFetchPolicy: WatchQueryFetchPolicy;\n}\n\nexport type UpdateQueryOptions<TData, TVariables extends OperationVariables> = {\n  variables?: TVariables;\n} & (\n  | {\n      /**\n       * Indicate if the previous query result has been found fully in the cache.\n       */\n      complete: true;\n      previousData: Unmasked<TData>;\n    }\n  | {\n      /**\n       * Indicate if the previous query result has not been found fully in the cache.\n       * Might have partial or missing data.\n       */\n      complete: false;\n      previousData: DeepPartial<Unmasked<TData>> | undefined;\n    }\n);\n\nexport interface UpdateQueryMapFn<\n  TData = unknown,\n  TVariables extends OperationVariables = OperationVariables,\n> {\n  (\n    /**\n     * @deprecated This value is not type-safe and may contain partial data. This\n     * argument will be removed in Apollo Client v5. Use `options.previousData`\n     * instead for a more type-safe value.\n     */\n    unsafePreviousData: DeepPartial<Unmasked<TData>>,\n    options: UpdateQueryOptions<TData, TVariables>\n  ): Unmasked<TData> | void;\n}\n\nexport type SubscribeToMoreUpdateQueryFn<\n  TData = unknown,\n  TVariables extends OperationVariables = OperationVariables,\n  TSubscriptionData = TData,\n> = {\n  (\n    /**\n     * @deprecated This value is not type-safe and may contain partial data. This\n     * argument will be removed in Apollo Client v5. Use `options.previousData`\n     * instead for a more type-safe value.\n     */\n    unsafePreviousData: DeepPartial<Unmasked<TData>>,\n    options: UpdateQueryOptions<TData, TVariables> & {\n      subscriptionData: { data: Unmasked<TSubscriptionData> };\n    }\n  ): Unmasked<TData> | void;\n};\n\nexport interface SubscribeToMoreFunction<\n  TData,\n  TVariables extends OperationVariables = OperationVariables,\n> {\n  <\n    TSubscriptionData = TData,\n    TSubscriptionVariables extends OperationVariables = TVariables,\n  >(\n    options: ObservableQuery.SubscribeToMoreOptions<\n      TData,\n      TSubscriptionVariables,\n      TSubscriptionData,\n      TVariables\n    >\n  ): () => void;\n}\n"]}

package/dev/setErrorMessageHandler.d.ts

@@ -21,10 +21,10 @@ export type ErrorMessageHandler = {
      * output.
      *
      * @returns The error message to be logged or thrown. If it returns `undefined`,
-     *          the mechanism will fall back to the default:
-     *          A link to https://go.apollo.dev/c/err with Apollo Client version,
-     *          the error message number, and the error message arguments encoded into
-     *          the URL hash.
+     * the mechanism will fall back to the default:
+     * A link to https://go.apollo.dev/c/err with Apollo Client version,
+     * the error message number, and the error message arguments encoded into
+     * the URL hash.
      */ (message: string | number, args: string[]): string | undefined;
 };
 /**

package/dev/setErrorMessageHandler.js.map

@@ -1 +1 @@
-{"version":3,"file":"setErrorMessageHandler.js","sourceRoot":"","sources":["../../src/dev/setErrorMessageHandler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,2CAA2C,CAAC;AAInE,OAAO,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAC;AAgCxD;;GAEG;AACH,MAAM,UAAU,sBAAsB,CAAC,OAA4B;IACjE,MAAM,CAAC,yBAAyB,CAAC,GAAG,OAAsC,CAAC;AAC7E,CAAC","sourcesContent":["import { global } from \"@apollo/client/utilities/internal/globals\";\n\nimport type { ErrorCodes } from \"../invariantErrorCodes.js\";\n\nimport { ApolloErrorMessageHandler } from \"./symbol.js\";\n\n/**\n * The error message handler is a function that is called when a message is\n * logged or an error is thrown to determine the contents of the error message\n * to be logged or thrown.\n */\nexport type ErrorMessageHandler = {\n  /**\n   * @param message - Usually the error message number (as defined in\n   * `@apollo/client/invariantErrorCodes.js`).\n   * In some edge cases, this can already be a string, that can be passed through\n   * as an error message.\n   *\n   * @param args - The placeholders that can be passed into the error message (pre-stringified).\n   * These relate with the `%s` and `%d` [substitution strings](https://developer.mozilla.org/en-US/docs/Web/API/console#using_string_substitutions)\n   * in the error message defined in `@apollo/client/invariantErrorCodes.js`.\n   *\n   * ⚠️ Note that arguments will only be passed in for error messages.\n   * For normal log messages, you will get an empty array here and they will directly\n   * be passed to `console.log` instead, to have the string subsitution done by the\n   * engine, as that allows for nicer (and in the case of a browser, interactive)\n   * output.\n   *\n   * @returns The error message to be logged or thrown. If it returns `undefined`,\n   *          the mechanism will fall back to the default:\n   *          A link to https://go.apollo.dev/c/err with Apollo Client version,\n   *          the error message number, and the error message arguments encoded into\n   *          the URL hash.\n   */ (message: string | number, args: string[]): string | undefined;\n};\n\n/**\n * Overrides the global \"Error Message Handler\" with a custom implementation.\n */\nexport function setErrorMessageHandler(handler: ErrorMessageHandler) {\n  global[ApolloErrorMessageHandler] = handler as typeof handler & ErrorCodes;\n}\n"]}
+{"version":3,"file":"setErrorMessageHandler.js","sourceRoot":"","sources":["../../src/dev/setErrorMessageHandler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,2CAA2C,CAAC;AAInE,OAAO,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAC;AAgCxD;;GAEG;AACH,MAAM,UAAU,sBAAsB,CAAC,OAA4B;IACjE,MAAM,CAAC,yBAAyB,CAAC,GAAG,OAAsC,CAAC;AAC7E,CAAC","sourcesContent":["import { global } from \"@apollo/client/utilities/internal/globals\";\n\nimport type { ErrorCodes } from \"../invariantErrorCodes.js\";\n\nimport { ApolloErrorMessageHandler } from \"./symbol.js\";\n\n/**\n * The error message handler is a function that is called when a message is\n * logged or an error is thrown to determine the contents of the error message\n * to be logged or thrown.\n */\nexport type ErrorMessageHandler = {\n  /**\n   * @param message - Usually the error message number (as defined in\n   * `@apollo/client/invariantErrorCodes.js`).\n   * In some edge cases, this can already be a string, that can be passed through\n   * as an error message.\n   *\n   * @param args - The placeholders that can be passed into the error message (pre-stringified).\n   * These relate with the `%s` and `%d` [substitution strings](https://developer.mozilla.org/en-US/docs/Web/API/console#using_string_substitutions)\n   * in the error message defined in `@apollo/client/invariantErrorCodes.js`.\n   *\n   * ⚠️ Note that arguments will only be passed in for error messages.\n   * For normal log messages, you will get an empty array here and they will directly\n   * be passed to `console.log` instead, to have the string subsitution done by the\n   * engine, as that allows for nicer (and in the case of a browser, interactive)\n   * output.\n   *\n   * @returns The error message to be logged or thrown. If it returns `undefined`,\n   * the mechanism will fall back to the default:\n   * A link to https://go.apollo.dev/c/err with Apollo Client version,\n   * the error message number, and the error message arguments encoded into\n   * the URL hash.\n   */ (message: string | number, args: string[]): string | undefined;\n};\n\n/**\n * Overrides the global \"Error Message Handler\" with a custom implementation.\n */\nexport function setErrorMessageHandler(handler: ErrorMessageHandler) {\n  global[ApolloErrorMessageHandler] = handler as typeof handler & ErrorCodes;\n}\n"]}

package/errors/CombinedGraphQLErrors.d.ts

@@ -2,36 +2,171 @@ import type { FormattedExecutionResult, GraphQLFormattedError } from "graphql";
 import type { FetchResult } from "@apollo/client";
 export declare namespace CombinedGraphQLErrors {
     interface MessageFormatterOptions {
+        /**
+         * The raw result returned from the server.
+         */
         result: FetchResult<unknown>;
+        /**
+         * The default message formatter. Call this to get a string with the default
+         * formatted message.
+         *
+         * @remarks
+         * To format part of the message using the default message formatter, call
+         * the `defaultFormatMessage` function provided to the `options` argument of
+         * your message formatter.
+         *
+         * @example
+         *
+         * The following example prepends a string to the message and uses the
+         * default message formatter to format the error messages.
+         *
+         * ```ts
+         * CombinedGraphQLErrors.formatMessage = (errors, { defaultFormatMessage }) => {
+         *   return `[GraphQL errors]: ${defaultFormatMessage(errors)}`;
+         * };
+         * ```
+         */
         defaultFormatMessage: (errors: ReadonlyArray<GraphQLFormattedError>) => string;
     }
+    /**
+     * By default, `CombinedGraphQLErrors` formats the `message` property by
+     * joining each error's `message` field with a newline. To customize the
+     * format of the `message`, such as changing the delimiter or adding a message
+     * prefix, override the static `formatMessage` method.
+     *
+     * @example
+     *
+     * The following example demonstrates how to format the error message by
+     * joining each error with a comma.
+     *
+     * ```ts
+     * import { CombinedGraphQLErrors } from "@apollo/client/errors";
+     *
+     * CombinedGraphQLErrors.formatMessage = (errors) => {
+     *   return errors.map((error) => error.message).join(", ");
+     * };
+     * ```
+     *
+     * @remarks
+     *
+     * See the [`formatMessage`](https://www.apollographql.com/docs/react/api/errors/CombinedGraphQLErrors#formatmessage) docs for details about the parameters provided to the `formatMessage` function.
+     *
+     * > [!NOTE]
+     * > The message formatter needs to be configured before any operation is executed by Apollo Client, otherwise the default message formatter is used. We recommend configuring the message formatter before initializing your `ApolloClient` instance.
+     *
+     * @param errors - The array of GraphQL errors returned from the server in the
+     * `errors` field of the response.
+     * @param options - Additional context that could be useful when formatting
+     * the message.
+     */
     type MessageFormatter = (errors: ReadonlyArray<GraphQLFormattedError>, options: MessageFormatterOptions) => string;
+    namespace DocumentationTypes {
+        /**
+         * A function that formats the error message used for the error's `message`
+         * property. Override this method to provide your own formatting.
+         *
+         * @remarks
+         *
+         * The `formatMessage` function is called by the `CombinedGraphQLErrors`
+         * constructor to provide a formatted message as the `message` property of the
+         * `CombinedGraphQLErrors` object. Follow the ["Providing a custom message
+         * formatter"](https://www.apollographql.com/docs/react/api/errors/CombinedGraphQLErrors#providing-a-custom-message-formatter) guide to learn how to modify the message format.
+         *
+         * @param errors - The array of GraphQL errors returned from the server in
+         * the `errors` field of the response.
+         * @param options - Additional context that could be useful when formatting
+         * the message.
+         */
+        function formatMessage(errors: ReadonlyArray<GraphQLFormattedError>, options: MessageFormatterOptions): string;
+        interface InstanceProperties {
+            /**
+             * The raw list of GraphQL errors returned by the `errors` field in the GraphQL response.
+             */
+            readonly errors: ReadonlyArray<GraphQLFormattedError>;
+            /**
+             * Partial data returned in the `data` field of the GraphQL response.
+             */
+            readonly data: Record<string, unknown> | null | undefined;
+            /**
+             * Extensions returned by the `extensions` field in the GraphQL response.
+             */
+            readonly extensions: Record<string, unknown> | undefined;
+        }
+    }
 }
 /**
  * Represents the combined list of GraphQL errors returned from the server in a
- * GraphQL response.
+ * GraphQL response. This error type is used when your GraphQL operation returns
+ * errors in the `errors` field of the response.
+ *
+ * @remarks
+ *
+ * When your GraphQL operation encounters errors on the server side (such as
+ * resolver errors, validation errors, or syntax errors), the server returns
+ * these errors in the `errors` array of the GraphQL response. Apollo Client
+ * wraps these errors in a `CombinedGraphQLErrors` object, which provides access
+ * to the individual errors while maintaining additional context about the
+ * response.
+ *
+ * @example
+ *
+ * ```ts
+ * import { CombinedGraphQLErrors } from "@apollo/client/errors";
+ *
+ * // Check if an error is a CombinedGraphQLErrors object
+ * if (CombinedGraphQLErrors.is(error)) {
+ *   // Access individual GraphQL errors
+ *   error.errors.forEach((graphQLError) => {
+ *     console.log(graphQLError.message);
+ *     console.log(graphQLError.path);
+ *     console.log(graphQLError.locations);
+ *   });
+ *
+ *   // Access the original GraphQL result
+ *   console.log(error.result);
+ * }
+ * ```
  */
 export declare class CombinedGraphQLErrors extends Error {
-    /** Determine if an error is a `CombinedGraphQLErrors` instance */
-    static is(error: unknown): error is CombinedGraphQLErrors;
     /**
-     * Formats the error message used for the error `message` property. Override
-     * to provide your own formatting.
+     * A method that determines whether an error is a `CombinedGraphQLErrors`
+     * object. This method enables TypeScript to narrow the error type.
+     *
+     * @example
+     *
+     * ```ts
+     * if (CombinedGraphQLErrors.is(error)) {
+     *   // TypeScript now knows `error` is a CombinedGraphQLErrors object
+     *   console.log(error.errors);
+     * }
+     * ```
      */
+    static is(error: unknown): error is CombinedGraphQLErrors;
+    /**
+    * A function that formats the error message used for the error's `message` property. Override this method to provide your own formatting.
+    * 
+    * @remarks
+    * 
+    * The `formatMessage` function is called by the `CombinedGraphQLErrors` constructor to provide a formatted message as the `message` property of the `CombinedGraphQLErrors` object. Follow the ["Providing a custom message formatter"](https://www.apollographql.com/docs/react/api/errors/CombinedGraphQLErrors#providing-a-custom-message-formatter) guide to learn how to modify the message format.
+    * 
+    * @param errors - The array of GraphQL errors returned from the server in the `errors` field of the response.
+    * 
+    * @param options - Additional context that could be useful when formatting the message.
+    */
     static formatMessage: CombinedGraphQLErrors.MessageFormatter;
     /**
-     * The raw list of GraphQL errors returned in a GraphQL response.
-     */
+    * The raw list of GraphQL errors returned by the `errors` field in the GraphQL response.
+    */
     readonly errors: ReadonlyArray<GraphQLFormattedError>;
     /**
-     * Partial data returned in the GraphQL response.
-     */
+    * Partial data returned in the `data` field of the GraphQL response.
+    */
     readonly data: Record<string, unknown> | null | undefined;
     /**
-     * Extensions added to the result.
-     */
+    * Extensions returned by the `extensions` field in the GraphQL response.
+    */
     readonly extensions: Record<string, unknown> | undefined;
     constructor(result: FormattedExecutionResult<any>);
     constructor(result: FetchResult<any>, errors: ReadonlyArray<GraphQLFormattedError>);
 }
-//# sourceMappingURL=CombinedGraphQLErrors.d.ts.map
+//# sourceMappingURL=CombinedGraphQLErrors.d.ts.map