@apollo/client 3.8.7 → 3.8.9

package/core/watchQueryOptions.js.map

@@ -1 +1 @@
-{"version":3,"file":"watchQueryOptions.js","sourceRoot":"","sources":["../../src/core/watchQueryOptions.ts"],"names":[],"mappings":"","sourcesContent":["import type { DocumentNode } from \"graphql\";\nimport type { TypedDocumentNode } from \"@graphql-typed-document-node/core\";\n\nimport type { FetchResult } from \"../link/core/index.js\";\nimport type {\n  DefaultContext,\n  MutationQueryReducersMap,\n  OperationVariables,\n  MutationUpdaterFunction,\n  OnQueryUpdated,\n  InternalRefetchQueriesInclude,\n} from \"./types.js\";\nimport type { ApolloCache } from \"../cache/index.js\";\nimport type { ObservableQuery } from \"./ObservableQuery.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  | \"standby\";\n\nexport type WatchQueryFetchPolicy = FetchPolicy | \"cache-and-network\";\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 (XXX this is default to lower breaking changes going from AC 1.0 => 2.0)\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 interface QueryOptions<TVariables = OperationVariables, TData = any> {\n  /**\n   * A GraphQL document that consists of a single query to be sent down to the\n   * server.\n   */\n  // TODO REFACTOR: rename this to document. Didn't do it yet because it's in a\n  // lot of tests.\n  query: DocumentNode | TypedDocumentNode<TData, TVariables>;\n\n  /**\n   * A map going from variable name to variable value, where the variables are used\n   * within the GraphQL query.\n   */\n  variables?: TVariables;\n\n  /**\n   * Specifies the {@link ErrorPolicy} to be used for this query\n   */\n  errorPolicy?: ErrorPolicy;\n\n  /**\n   * Context to be passed to link execution chain\n   */\n  context?: DefaultContext;\n\n  /**\n   * Specifies the {@link FetchPolicy} to be used for this query\n   */\n  fetchPolicy?: FetchPolicy;\n\n  /**\n   * The time interval (in milliseconds) on which this query should be\n   * refetched from the server.\n   */\n  pollInterval?: number;\n\n  /**\n   * Whether or not updates to the network status should trigger next on the observer of this query\n   */\n  notifyOnNetworkStatusChange?: boolean;\n\n  /**\n   * Allow returning incomplete data from the cache when a larger query cannot\n   * be fully satisfied by the cache, instead of returning nothing.\n   */\n  returnPartialData?: boolean;\n\n  /**\n   * If `true`, perform a query `refetch` if the query result is marked as\n   * being partial, and the returned data is reset to an empty Object by the\n   * Apollo Client `QueryManager` (due to a cache miss).\n   */\n  partialRefetch?: boolean;\n\n  /**\n   * Whether to canonize cache results before returning them. Canonization\n   * takes some extra time, but it speeds up future deep equality comparisons.\n   * Defaults to false.\n   */\n  canonizeResults?: boolean;\n}\n\n/**\n * Watched query options.\n */\nexport interface WatchQueryOptions<\n  TVariables extends OperationVariables = OperationVariables,\n  TData = any,\n> extends Omit<QueryOptions<TVariables, TData>, \"fetchPolicy\"> {\n  /**\n   * Specifies the {@link FetchPolicy} to be used for this query.\n   */\n  fetchPolicy?: WatchQueryFetchPolicy;\n\n  /**\n   * Specifies the {@link FetchPolicy} to be used after this query has completed.\n   */\n  nextFetchPolicy?:\n    | WatchQueryFetchPolicy\n    | ((\n        this: WatchQueryOptions<TVariables, TData>,\n        currentFetchPolicy: WatchQueryFetchPolicy,\n        context: NextFetchPolicyContext<TData, TVariables>\n      ) => WatchQueryFetchPolicy);\n\n  /**\n   * Defaults to the initial value of options.fetchPolicy, but can be explicitly\n   * configured to specify the WatchQueryFetchPolicy to revert back to whenever\n   * variables change (unless nextFetchPolicy intervenes).\n   */\n  initialFetchPolicy?: WatchQueryFetchPolicy;\n\n  /**\n   * Specifies whether a {@link NetworkStatus.refetch} operation should merge\n   * incoming field data with existing data, or overwrite the existing data.\n   * Overwriting is probably preferable, but merging is currently the default\n   * behavior, for backwards compatibility with Apollo Client 3.x.\n   */\n  refetchWritePolicy?: RefetchWritePolicy;\n}\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 interface FetchMoreQueryOptions<TVariables, TData = any> {\n  query?: DocumentNode | TypedDocumentNode<TData, TVariables>;\n  variables?: Partial<TVariables>;\n  context?: DefaultContext;\n}\n\nexport type UpdateQueryFn<\n  TData = any,\n  TSubscriptionVariables = OperationVariables,\n  TSubscriptionData = TData,\n> = (\n  previousQueryResult: TData,\n  options: {\n    subscriptionData: { data: TSubscriptionData };\n    variables?: TSubscriptionVariables;\n  }\n) => TData;\n\nexport type SubscribeToMoreOptions<\n  TData = any,\n  TSubscriptionVariables = OperationVariables,\n  TSubscriptionData = TData,\n> = {\n  document:\n    | DocumentNode\n    | TypedDocumentNode<TSubscriptionData, TSubscriptionVariables>;\n  variables?: TSubscriptionVariables;\n  updateQuery?: UpdateQueryFn<TData, TSubscriptionVariables, TSubscriptionData>;\n  onError?: (error: Error) => void;\n  context?: DefaultContext;\n};\n\nexport interface SubscriptionOptions<\n  TVariables = OperationVariables,\n  TData = any,\n> {\n  /**\n   * A GraphQL document, often created with `gql` from the `graphql-tag`\n   * package, that contains a single subscription inside of it.\n   */\n  query: DocumentNode | TypedDocumentNode<TData, TVariables>;\n\n  /**\n   * An object that maps from the name of a variable as used in the subscription\n   * GraphQL document to that variable's value.\n   */\n  variables?: TVariables;\n\n  /**\n   * Specifies the {@link FetchPolicy} to be used for this subscription.\n   */\n  fetchPolicy?: FetchPolicy;\n\n  /**\n   * Specifies the {@link ErrorPolicy} to be used for this operation\n   */\n  errorPolicy?: ErrorPolicy;\n\n  /**\n   * Context object to be passed through the link execution chain.\n   */\n  context?: DefaultContext;\n}\n\nexport interface MutationBaseOptions<\n  TData = any,\n  TVariables = OperationVariables,\n  TContext = DefaultContext,\n  TCache extends ApolloCache<any> = ApolloCache<any>,\n> {\n  /**\n   * An object that represents the result of this mutation that will be\n   * optimistically stored before the server has actually returned a result.\n   * This is most often used for optimistic UI, where we want to be able to see\n   * the result of a mutation immediately, and update the UI later if any errors\n   * appear.\n   */\n  optimisticResponse?: TData | ((vars: TVariables) => TData);\n\n  /**\n   * A {@link MutationQueryReducersMap}, which is map from query names to\n   * mutation query reducers. Briefly, this map defines how to incorporate the\n   * results of the mutation into the results of queries that are currently\n   * being watched by your application.\n   */\n  updateQueries?: MutationQueryReducersMap<TData>;\n\n  /**\n   * A list of query names which will be refetched once this mutation has\n   * returned. This is often used if you have a set of queries which may be\n   * affected by a mutation and will have to update. Rather than writing a\n   * mutation query reducer (i.e. `updateQueries`) for this, you can simply\n   * refetch the queries that will be affected and achieve a consistent store\n   * once these queries return.\n   */\n  refetchQueries?:\n    | ((result: FetchResult<TData>) => InternalRefetchQueriesInclude)\n    | InternalRefetchQueriesInclude;\n\n  /**\n   * By default, `refetchQueries` does not wait for the refetched queries to\n   * be completed, before resolving the mutation `Promise`. This ensures that\n   * query refetching does not hold up mutation response handling (query\n   * refetching is handled asynchronously). Set `awaitRefetchQueries` to\n   * `true` if you would like to wait for the refetched queries to complete,\n   * before the mutation can be marked as resolved.\n   */\n  awaitRefetchQueries?: boolean;\n\n  /**\n   * A function which provides an {@link ApolloCache} instance, and the result\n   * of the mutation, to allow the user to update the store based on the\n   * results of the mutation.\n   *\n   * This function will be called twice over the lifecycle of a mutation. Once\n   * at the very beginning if an `optimisticResponse` was provided. The writes\n   * created from the optimistic data will be rolled back before the second time\n   * this function is called which is when the mutation has successfully\n   * resolved. At that point `update` will be called with the *actual* mutation\n   * result and those writes will not be rolled back.\n   *\n   * Note that since this function is intended to be used to update the\n   * store, it cannot be used with a `no-cache` fetch policy. If you're\n   * interested in performing some action after a mutation has completed,\n   * and you don't need to update the store, use the Promise returned from\n   * `client.mutate` instead.\n   */\n  update?: MutationUpdaterFunction<TData, TVariables, TContext, TCache>;\n\n  /**\n   * A function that will be called for each ObservableQuery affected by\n   * this mutation, after the mutation has completed.\n   */\n  onQueryUpdated?: OnQueryUpdated<any>;\n\n  /**\n   * Specifies the {@link ErrorPolicy} to be used for this operation\n   */\n  errorPolicy?: ErrorPolicy;\n\n  /**\n   * An object that maps from the name of a variable as used in the mutation\n   * GraphQL document to that variable's value.\n   */\n  variables?: TVariables;\n\n  /**\n   * The context to be passed to the link execution chain. This context will\n   * only be used with this mutation. It will not be used with\n   * `refetchQueries`. Refetched queries use the context they were\n   * initialized with (since the initial context is stored as part of the\n   * `ObservableQuery` instance). If a specific context is needed when\n   * refetching queries, make sure it is configured (via the\n   * [query `context` option](https://www.apollographql.com/docs/react/api/apollo-client#ApolloClient.query))\n   * when the query is first initialized/run.\n   */\n  context?: TContext;\n}\n\nexport interface MutationOptions<\n  TData = any,\n  TVariables = OperationVariables,\n  TContext = DefaultContext,\n  TCache extends ApolloCache<any> = ApolloCache<any>,\n> extends MutationBaseOptions<TData, TVariables, TContext, TCache> {\n  /**\n   * A GraphQL document, often created with `gql` from the `graphql-tag`\n   * package, that contains a single mutation inside of it.\n   */\n  mutation: DocumentNode | TypedDocumentNode<TData, TVariables>;\n\n  /**\n   * Specifies the {@link MutationFetchPolicy} to be used for this query.\n   * Mutations support only 'network-only' and 'no-cache' fetchPolicy strings.\n   * If fetchPolicy is not provided, it defaults to 'network-only'.\n   */\n  fetchPolicy?: MutationFetchPolicy;\n\n  /**\n   * To avoid retaining sensitive information from mutation root field\n   * arguments, Apollo Client v3.4+ automatically clears any `ROOT_MUTATION`\n   * fields from the cache after each mutation finishes. If you need this\n   * information to remain in the cache, you can prevent the removal by passing\n   * `keepRootFields: true` to the mutation. `ROOT_MUTATION` result data are\n   * also passed to the mutation `update` function, so we recommend obtaining\n   * the results that way, rather than using this option, if possible.\n   */\n  keepRootFields?: boolean;\n}\n"]}
+{"version":3,"file":"watchQueryOptions.js","sourceRoot":"","sources":["../../src/core/watchQueryOptions.ts"],"names":[],"mappings":"","sourcesContent":["import type { DocumentNode } from \"graphql\";\nimport type { TypedDocumentNode } from \"@graphql-typed-document-node/core\";\n\nimport type { FetchResult } from \"../link/core/index.js\";\nimport type {\n  DefaultContext,\n  MutationQueryReducersMap,\n  OperationVariables,\n  MutationUpdaterFunction,\n  OnQueryUpdated,\n  InternalRefetchQueriesInclude,\n} from \"./types.js\";\nimport type { ApolloCache } from \"../cache/index.js\";\nimport type { ObservableQuery } from \"./ObservableQuery.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  | \"standby\";\n\nexport type WatchQueryFetchPolicy = FetchPolicy | \"cache-and-network\";\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 interface QueryOptions<TVariables = OperationVariables, TData = any> {\n  /**\n   * A GraphQL document that consists of a single query to be sent down to the\n   * server.\n   */\n  // TODO REFACTOR: rename this to document. Didn't do it yet because it's in a\n  // lot of tests.\n  query: DocumentNode | TypedDocumentNode<TData, TVariables>;\n\n  /**\n   * A map going from variable name to variable value, where the variables are used\n   * within the GraphQL query.\n   */\n  variables?: TVariables;\n\n  /**\n   * Specifies the {@link ErrorPolicy} to be used for this query\n   */\n  errorPolicy?: ErrorPolicy;\n\n  /**\n   * Context to be passed to link execution chain\n   */\n  context?: DefaultContext;\n\n  /**\n   * Specifies the {@link FetchPolicy} to be used for this query\n   */\n  fetchPolicy?: FetchPolicy;\n\n  /**\n   * The time interval (in milliseconds) on which this query should be\n   * refetched from the server.\n   */\n  pollInterval?: number;\n\n  /**\n   * Whether or not updates to the network status should trigger next on the observer of this query\n   */\n  notifyOnNetworkStatusChange?: boolean;\n\n  /**\n   * Allow returning incomplete data from the cache when a larger query cannot\n   * be fully satisfied by the cache, instead of returning nothing.\n   */\n  returnPartialData?: boolean;\n\n  /**\n   * If `true`, perform a query `refetch` if the query result is marked as\n   * being partial, and the returned data is reset to an empty Object by the\n   * Apollo Client `QueryManager` (due to a cache miss).\n   */\n  partialRefetch?: boolean;\n\n  /**\n   * Whether to canonize cache results before returning them. Canonization\n   * takes some extra time, but it speeds up future deep equality comparisons.\n   * Defaults to false.\n   */\n  canonizeResults?: boolean;\n}\n\n/**\n * Watched query options.\n */\nexport interface WatchQueryOptions<\n  TVariables extends OperationVariables = OperationVariables,\n  TData = any,\n> {\n  /**\n   * Specifies the {@link FetchPolicy} to be used for this query.\n   */\n  fetchPolicy?: WatchQueryFetchPolicy;\n\n  /**\n   * Specifies the {@link FetchPolicy} to be used after this query has completed.\n   */\n  nextFetchPolicy?:\n    | WatchQueryFetchPolicy\n    | ((\n        this: WatchQueryOptions<TVariables, TData>,\n        currentFetchPolicy: WatchQueryFetchPolicy,\n        context: NextFetchPolicyContext<TData, TVariables>\n      ) => WatchQueryFetchPolicy);\n\n  /**\n   * Defaults to the initial value of options.fetchPolicy, but can be explicitly\n   * configured to specify the WatchQueryFetchPolicy to revert back to whenever\n   * variables change (unless nextFetchPolicy intervenes).\n   */\n  initialFetchPolicy?: WatchQueryFetchPolicy;\n\n  /**\n   * Specifies whether a {@link NetworkStatus.refetch} operation should merge\n   * incoming field data with existing data, or overwrite the existing data.\n   * Overwriting is probably preferable, but merging is currently the default\n   * behavior, for backwards compatibility with Apollo Client 3.x.\n   */\n  refetchWritePolicy?: RefetchWritePolicy;\n\n  /** {@inheritDoc @apollo/client!QueryOptions#query:member} */\n  query: DocumentNode | TypedDocumentNode<TData, TVariables>;\n\n  /** {@inheritDoc @apollo/client!QueryOptions#variables:member} */\n  variables?: TVariables;\n\n  /** {@inheritDoc @apollo/client!QueryOptions#errorPolicy:member} */\n  errorPolicy?: ErrorPolicy;\n\n  /** {@inheritDoc @apollo/client!QueryOptions#context:member} */\n  context?: DefaultContext;\n\n  /** {@inheritDoc @apollo/client!QueryOptions#pollInterval:member} */\n  pollInterval?: number;\n\n  /** {@inheritDoc @apollo/client!QueryOptions#notifyOnNetworkStatusChange:member} */\n  notifyOnNetworkStatusChange?: boolean;\n\n  /** {@inheritDoc @apollo/client!QueryOptions#returnPartialData:member} */\n  returnPartialData?: boolean;\n\n  /** {@inheritDoc @apollo/client!QueryOptions#partialRefetch:member} */\n  partialRefetch?: boolean;\n\n  /** {@inheritDoc @apollo/client!QueryOptions#canonizeResults:member} */\n  canonizeResults?: boolean;\n}\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 interface FetchMoreQueryOptions<TVariables, TData = any> {\n  query?: DocumentNode | TypedDocumentNode<TData, TVariables>;\n  variables?: Partial<TVariables>;\n  context?: DefaultContext;\n}\n\nexport type UpdateQueryFn<\n  TData = any,\n  TSubscriptionVariables = OperationVariables,\n  TSubscriptionData = TData,\n> = (\n  previousQueryResult: TData,\n  options: {\n    subscriptionData: { data: TSubscriptionData };\n    variables?: TSubscriptionVariables;\n  }\n) => TData;\n\nexport type SubscribeToMoreOptions<\n  TData = any,\n  TSubscriptionVariables = OperationVariables,\n  TSubscriptionData = TData,\n> = {\n  document:\n    | DocumentNode\n    | TypedDocumentNode<TSubscriptionData, TSubscriptionVariables>;\n  variables?: TSubscriptionVariables;\n  updateQuery?: UpdateQueryFn<TData, TSubscriptionVariables, TSubscriptionData>;\n  onError?: (error: Error) => void;\n  context?: DefaultContext;\n};\n\nexport interface SubscriptionOptions<\n  TVariables = OperationVariables,\n  TData = any,\n> {\n  /**\n   * A GraphQL document, often created with `gql` from the `graphql-tag`\n   * package, that contains a single subscription inside of it.\n   */\n  query: DocumentNode | TypedDocumentNode<TData, TVariables>;\n\n  /**\n   * An object that maps from the name of a variable as used in the subscription\n   * GraphQL document to that variable's value.\n   */\n  variables?: TVariables;\n\n  /**\n   * Specifies the {@link FetchPolicy} to be used for this subscription.\n   */\n  fetchPolicy?: FetchPolicy;\n\n  /**\n   * Specifies the {@link ErrorPolicy} to be used for this operation\n   */\n  errorPolicy?: ErrorPolicy;\n\n  /**\n   * Context object to be passed through the link execution chain.\n   */\n  context?: DefaultContext;\n}\n\nexport interface MutationBaseOptions<\n  TData = any,\n  TVariables = OperationVariables,\n  TContext = DefaultContext,\n  TCache extends ApolloCache<any> = ApolloCache<any>,\n> {\n  /**\n   * An object that represents the result of this mutation that will be\n   * optimistically stored before the server has actually returned a result.\n   * This is most often used for optimistic UI, where we want to be able to see\n   * the result of a mutation immediately, and update the UI later if any errors\n   * appear.\n   */\n  optimisticResponse?: TData | ((vars: TVariables) => TData);\n\n  /**\n   * A {@link MutationQueryReducersMap}, which is map from query names to\n   * mutation query reducers. Briefly, this map defines how to incorporate the\n   * results of the mutation into the results of queries that are currently\n   * being watched by your application.\n   */\n  updateQueries?: MutationQueryReducersMap<TData>;\n\n  /**\n   * A list of query names which will be refetched once this mutation has\n   * returned. This is often used if you have a set of queries which may be\n   * affected by a mutation and will have to update. Rather than writing a\n   * mutation query reducer (i.e. `updateQueries`) for this, you can simply\n   * refetch the queries that will be affected and achieve a consistent store\n   * once these queries return.\n   */\n  refetchQueries?:\n    | ((result: FetchResult<TData>) => InternalRefetchQueriesInclude)\n    | InternalRefetchQueriesInclude;\n\n  /**\n   * By default, `refetchQueries` does not wait for the refetched queries to\n   * be completed, before resolving the mutation `Promise`. This ensures that\n   * query refetching does not hold up mutation response handling (query\n   * refetching is handled asynchronously). Set `awaitRefetchQueries` to\n   * `true` if you would like to wait for the refetched queries to complete,\n   * before the mutation can be marked as resolved.\n   */\n  awaitRefetchQueries?: boolean;\n\n  /**\n   * A function which provides an {@link ApolloCache} instance, and the result\n   * of the mutation, to allow the user to update the store based on the\n   * results of the mutation.\n   *\n   * This function will be called twice over the lifecycle of a mutation. Once\n   * at the very beginning if an `optimisticResponse` was provided. The writes\n   * created from the optimistic data will be rolled back before the second time\n   * this function is called which is when the mutation has successfully\n   * resolved. At that point `update` will be called with the *actual* mutation\n   * result and those writes will not be rolled back.\n   *\n   * Note that since this function is intended to be used to update the\n   * store, it cannot be used with a `no-cache` fetch policy. If you're\n   * interested in performing some action after a mutation has completed,\n   * and you don't need to update the store, use the Promise returned from\n   * `client.mutate` instead.\n   */\n  update?: MutationUpdaterFunction<TData, TVariables, TContext, TCache>;\n\n  /**\n   * A function that will be called for each ObservableQuery affected by\n   * this mutation, after the mutation has completed.\n   */\n  onQueryUpdated?: OnQueryUpdated<any>;\n\n  /**\n   * Specifies the {@link ErrorPolicy} to be used for this operation\n   */\n  errorPolicy?: ErrorPolicy;\n\n  /**\n   * An object that maps from the name of a variable as used in the mutation\n   * GraphQL document to that variable's value.\n   */\n  variables?: TVariables;\n\n  /**\n   * The context to be passed to the link execution chain. This context will\n   * only be used with this mutation. It will not be used with\n   * `refetchQueries`. Refetched queries use the context they were\n   * initialized with (since the initial context is stored as part of the\n   * `ObservableQuery` instance). If a specific context is needed when\n   * refetching queries, make sure it is configured (via the\n   * [query `context` option](https://www.apollographql.com/docs/react/api/apollo-client#ApolloClient.query))\n   * when the query is first initialized/run.\n   */\n  context?: TContext;\n}\n\nexport interface MutationOptions<\n  TData = any,\n  TVariables = OperationVariables,\n  TContext = DefaultContext,\n  TCache extends ApolloCache<any> = ApolloCache<any>,\n> extends MutationBaseOptions<TData, TVariables, TContext, TCache> {\n  /**\n   * A GraphQL document, often created with `gql` from the `graphql-tag`\n   * package, that contains a single mutation inside of it.\n   */\n  mutation: DocumentNode | TypedDocumentNode<TData, TVariables>;\n\n  /**\n   * Specifies the {@link MutationFetchPolicy} to be used for this query.\n   * Mutations support only 'network-only' and 'no-cache' fetchPolicy strings.\n   * If fetchPolicy is not provided, it defaults to 'network-only'.\n   */\n  fetchPolicy?: MutationFetchPolicy;\n\n  /**\n   * To avoid retaining sensitive information from mutation root field\n   * arguments, Apollo Client v3.4+ automatically clears any `ROOT_MUTATION`\n   * fields from the cache after each mutation finishes. If you need this\n   * information to remain in the cache, you can prevent the removal by passing\n   * `keepRootFields: true` to the mutation. `ROOT_MUTATION` result data are\n   * also passed to the mutation `update` function, so we recommend obtaining\n   * the results that way, rather than using this option, if possible.\n   */\n  keepRootFields?: boolean;\n}\n"]}

package/dev/dev.cjs

@@ -5,532 +5,427 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var globals = require('../utilities/globals');
 var tsInvariant = require('ts-invariant');
 
-const errorCodes = // This file is used by the error message display website and the
-// @apollo/client/includeErrors entry point.
-// This file is not meant to be imported manually.
+const errorCodes =
 {
   1: {
     file: "@apollo/client/cache/inmemory/entityStore.js",
     condition: "typeof dataId === \"string\"",
     message: "store.merge expects a string ID"
   },
-
   4: {
     file: "@apollo/client/cache/inmemory/key-extractor.js",
     condition: "extracted !== void 0",
     message: "Missing field '%s' while extracting keyFields from %s"
   },
-
   5: {
     file: "@apollo/client/cache/inmemory/policies.js",
     condition: "!old || old === which",
     message: "Cannot change root %s __typename more than once"
   },
-
   8: {
     file: "@apollo/client/cache/inmemory/policies.js",
     message: "Cannot automatically merge arrays"
   },
-
   9: {
     file: "@apollo/client/cache/inmemory/readFromStore.js",
     message: "No fragment named %s"
   },
-
   10: {
     file: "@apollo/client/cache/inmemory/readFromStore.js",
     condition: "!isReference(value)",
     message: "Missing selection set for object of type %s returned for query field %s"
   },
-
   11: {
     file: "@apollo/client/cache/inmemory/writeToStore.js",
     message: "Could not identify object %s"
   },
-
   13: {
     file: "@apollo/client/cache/inmemory/writeToStore.js",
     message: "No fragment named %s"
   },
-
   15: {
     file: "@apollo/client/core/ApolloClient.js",
-
     message: "To initialize Apollo Client, you must specify a 'cache' property " +
         "in the options object. \n" +
         "For more information, please visit: https://go.apollo.dev/c/docs"
   },
-
   16: {
     file: "@apollo/client/core/ApolloClient.js",
     condition: "options.fetchPolicy !== \"cache-and-network\"",
-
     message: "The cache-and-network fetchPolicy does not work with client.query, because " +
         "client.query can only return a single result. Please use client.watchQuery " +
         "to receive multiple results from the cache and the network, or consider " +
         "using a different fetchPolicy, such as cache-first or network-only."
   },
-
   18: {
     file: "@apollo/client/core/LocalState.js",
     condition: "fragment",
     message: "No fragment named %s"
   },
-
   19: {
     file: "@apollo/client/core/LocalState.js",
     condition: "fragment",
     message: "No fragment named %s"
   },
-
   22: {
     file: "@apollo/client/core/ObservableQuery.js",
     condition: "pollInterval",
     message: "Attempted to start a polling query without a polling interval."
   },
-
   25: {
     file: "@apollo/client/core/QueryManager.js",
     message: "QueryManager stopped while query was in flight"
   },
-
   26: {
     file: "@apollo/client/core/QueryManager.js",
     condition: "mutation",
     message: "mutation option is required. You must specify your GraphQL document in the mutation option."
   },
-
   27: {
     file: "@apollo/client/core/QueryManager.js",
     condition: "fetchPolicy === \"network-only\" || fetchPolicy === \"no-cache\"",
     message: "Mutations support only 'network-only' or 'no-cache' fetchPolicy strings. The default `network-only` behavior automatically writes mutation results to the cache. Passing `no-cache` skips the cache write."
   },
-
   28: {
     file: "@apollo/client/core/QueryManager.js",
     condition: "options.query",
-
     message: "query option is required. You must specify your GraphQL document " +
         "in the query option."
   },
-
   29: {
     file: "@apollo/client/core/QueryManager.js",
     condition: "options.query.kind === \"Document\"",
     message: 'You must wrap the query string in a "gql" tag.'
   },
-
   30: {
     file: "@apollo/client/core/QueryManager.js",
     condition: "!options.returnPartialData",
     message: "returnPartialData option only supported on watchQuery."
   },
-
   31: {
     file: "@apollo/client/core/QueryManager.js",
     condition: "!options.pollInterval",
     message: "pollInterval option only supported on watchQuery."
   },
-
   32: {
     file: "@apollo/client/core/QueryManager.js",
     message: "Store reset while query was in flight (not completed in link chain)"
   },
-
   36: {
     file: "@apollo/client/link/core/ApolloLink.js",
     message: "request is not implemented"
   },
-
   37: {
     file: "@apollo/client/link/http/checkFetcher.js",
     message: "\n\"fetch\" has not been found globally and no fetcher has been configured. To fix this, install a fetch package (like https://www.npmjs.com/package/cross-fetch), instantiate the fetcher, and pass it into your HttpLink constructor. For example:\n\nimport fetch from 'cross-fetch';\nimport { ApolloClient, HttpLink } from '@apollo/client';\nconst client = new ApolloClient({\n  link: new HttpLink({ uri: '/graphql', fetch })\n});\n    "
   },
-
   39: {
     file: "@apollo/client/link/http/serializeFetchParameter.js",
     message: "Network request failed. %s is not serializable: %s"
   },
-
   40: {
     file: "@apollo/client/link/persisted-queries/index.js",
     condition: "options &&\n    (typeof options.sha256 === \"function\" ||\n        typeof options.generateHash === \"function\")",
-
     message: 'Missing/invalid "sha256" or "generateHash" function. Please ' +
         'configure one using the "createPersistedQueryLink(options)" options ' +
         "parameter."
   },
-
   41: {
     file: "@apollo/client/link/persisted-queries/index.js",
     condition: "forward",
     message: "PersistedQueryLink cannot be the last link in the chain."
   },
-
   43: {
     file: "@apollo/client/link/utils/validateOperation.js",
     message: "illegal argument: %s"
   },
-
   44: {
     file: "@apollo/client/react/context/ApolloConsumer.js",
     condition: "context && context.client",
-
     message: 'Could not find "client" in the context of ApolloConsumer. ' +
         "Wrap the root component in an <ApolloProvider>."
   },
-
   45: {
     file: "@apollo/client/react/context/ApolloContext.js",
     condition: "\"createContext\" in React",
-
     message: "Invoking `getApolloContext` in an environment where `React.createContext` is not available.\n" +
         "The Apollo Client functionality you are trying to use is only available in React Client Components.\n" +
         'Please make sure to add "use client" at the top of your file.\n' +
         "For more information, see https://nextjs.org/docs/getting-started/react-essentials#client-components"
   },
-
   46: {
     file: "@apollo/client/react/context/ApolloProvider.js",
     condition: "context.client",
-
     message: "ApolloProvider was not passed a client instance. Make " +
         'sure you pass in your client via the "client" prop.'
   },
-
   47: {
     file: "@apollo/client/react/hoc/hoc-utils.js",
     condition: "this.withRef",
-
     message: "To access the wrapped instance, you need to specify " +
         "{ withRef: true } in the options"
   },
-
   48: {
     file: "@apollo/client/react/hoc/withApollo.js",
     condition: "operationOptions.withRef",
-
     message: "To access the wrapped instance, you need to specify " +
         "{ withRef: true } in the options"
   },
-
   49: {
     file: "@apollo/client/react/hooks/useApolloClient.js",
     condition: "!!client",
-
     message: 'Could not find "client" in the context or passed in as an option. ' +
         "Wrap the root component in an <ApolloProvider>, or pass an ApolloClient " +
         "instance in via options."
   },
-
   51: {
     file: "@apollo/client/react/hooks/useReadQuery.js",
     condition: "internalQueryRef.promiseCache",
-
     message: "It appears that `useReadQuery` was used outside of `useBackgroundQuery`. " +
         "`useReadQuery` is only supported for use with `useBackgroundQuery`. " +
         "Please ensure you are passing the `queryRef` returned from `useBackgroundQuery`."
   },
-
   56: {
     file: "@apollo/client/react/hooks/useSuspenseQuery.js",
     condition: "supportedFetchPolicies.includes(fetchPolicy)",
     message: "The fetch policy `%s` is not supported with suspense."
   },
-
   59: {
     file: "@apollo/client/react/parser/index.js",
     condition: "!!document && !!document.kind",
-
     message: "Argument of %s passed to parser was not a valid GraphQL " +
         "DocumentNode. You may need to use 'graphql-tag' or another method " +
         "to convert your operation into a document"
   },
-
   60: {
     file: "@apollo/client/react/parser/index.js",
     condition: "!fragments.length ||\n    queries.length ||\n    mutations.length ||\n    subscriptions.length",
-
     message: "Passing only a fragment to 'graphql' is not yet supported. " +
         "You must include a query, subscription or mutation as well"
   },
-
   61: {
     file: "@apollo/client/react/parser/index.js",
     condition: "queries.length + mutations.length + subscriptions.length <= 1",
-
     message: "react-apollo only supports a query, subscription, or a mutation per HOC. " +
         "%s had %s queries, %s " +
         "subscriptions and %s mutations. " +
         "You can use 'compose' to join multiple operation types to a component"
   },
-
   62: {
     file: "@apollo/client/react/parser/index.js",
     condition: "definitions.length === 1",
-
     message: "react-apollo only supports one definition per HOC. %s had " +
         "%s definitions. " +
         "You can use 'compose' to join multiple operation types to a component"
   },
-
   63: {
     file: "@apollo/client/react/parser/index.js",
     condition: "operation.type === type",
     message: "Running a %s requires a graphql " + "%s, but a %s was used instead."
   },
-
   64: {
     file: "@apollo/client/testing/core/mocking/mockLink.js",
     condition: "queryWithoutConnection",
     message: "query is required"
   },
-
   65: {
     file: "@apollo/client/utilities/graphql/DocumentTransform.js",
     condition: "Array.isArray(cacheKeys)",
     message: "`getCacheKey` must return an array or undefined"
   },
-
   66: {
     file: "@apollo/client/utilities/graphql/directives.js",
     condition: "evaledValue !== void 0",
     message: "Invalid variable referenced in @%s directive."
   },
-
   67: {
     file: "@apollo/client/utilities/graphql/directives.js",
     condition: "directiveArguments && directiveArguments.length === 1",
     message: "Incorrect number of arguments for the @%s directive."
   },
-
   68: {
     file: "@apollo/client/utilities/graphql/directives.js",
     condition: "ifArgument.name && ifArgument.name.value === \"if\"",
     message: "Invalid argument for the @%s directive."
   },
-
   69: {
     file: "@apollo/client/utilities/graphql/directives.js",
     condition: "ifValue &&\n    (ifValue.kind === \"Variable\" || ifValue.kind === \"BooleanValue\")",
     message: "Argument for the @%s directive must be a variable or a boolean value."
   },
-
   70: {
     file: "@apollo/client/utilities/graphql/fragments.js",
-
     message: "Found a %s operation%s. " +
         "No operations are allowed when using a fragment as a query. Only fragments are allowed."
   },
-
   71: {
     file: "@apollo/client/utilities/graphql/fragments.js",
     condition: "fragments.length === 1",
     message: "Found %s fragments. `fragmentName` must be provided when there is not exactly 1 fragment."
   },
-
   72: {
     file: "@apollo/client/utilities/graphql/fragments.js",
     condition: "fragment",
     message: "No fragment named %s"
   },
-
   73: {
     file: "@apollo/client/utilities/graphql/getFromAST.js",
     condition: "doc && doc.kind === \"Document\"",
     message: "Expecting a parsed GraphQL document. Perhaps you need to wrap the query string in a \"gql\" tag? http://docs.apollostack.com/apollo-client/core.html#gql"
   },
-
   74: {
     file: "@apollo/client/utilities/graphql/getFromAST.js",
     message: "Schema type definitions not allowed in queries. Found: \"%s\""
   },
-
   75: {
     file: "@apollo/client/utilities/graphql/getFromAST.js",
     condition: "operations.length <= 1",
     message: "Ambiguous GraphQL document: contains %s operations"
   },
-
   76: {
     file: "@apollo/client/utilities/graphql/getFromAST.js",
     condition: "queryDef && queryDef.operation === \"query\"",
     message: "Must contain a query definition."
   },
-
   77: {
     file: "@apollo/client/utilities/graphql/getFromAST.js",
     condition: "doc.kind === \"Document\"",
     message: "Expecting a parsed GraphQL document. Perhaps you need to wrap the query string in a \"gql\" tag? http://docs.apollostack.com/apollo-client/core.html#gql"
   },
-
   78: {
     file: "@apollo/client/utilities/graphql/getFromAST.js",
     condition: "doc.definitions.length <= 1",
     message: "Fragment must have exactly one definition."
   },
-
   79: {
     file: "@apollo/client/utilities/graphql/getFromAST.js",
     condition: "fragmentDef.kind === \"FragmentDefinition\"",
     message: "Must be a fragment definition."
   },
-
   80: {
     file: "@apollo/client/utilities/graphql/getFromAST.js",
     message: "Expected a parsed GraphQL query with a query, mutation, subscription, or a fragment."
   },
-
   81: {
     file: "@apollo/client/utilities/graphql/storeUtils.js",
-
     message: "The inline argument \"%s\" of kind \"%s\"" +
         "is not supported. Use variables instead of inline arguments to " +
         "overcome this limitation."
   }
 };
-
 const devDebug = {
   17: {
     file: "@apollo/client/core/ApolloClient.js",
     message: "In client.refetchQueries, Promise.all promise rejected with error %o"
   },
-
   24: {
     file: "@apollo/client/core/ObservableQuery.js",
     message: "Missing cache result fields: %o"
   }
 };
-
 const devLog = {};
-
 const devWarn = {
   2: {
     file: "@apollo/client/cache/inmemory/entityStore.js",
-
     message: "cache.modify: You are trying to write a Reference that is not part of the store: %o\n" +
         "Please make sure to set the `mergeIntoStore` parameter to `true` when creating a Reference that is not part of the store yet:\n" +
         "`toReference(object, true)`"
   },
-
   3: {
     file: "@apollo/client/cache/inmemory/entityStore.js",
-
     message: "cache.modify: Writing an array with a mix of both References and Objects will not result in the Objects being normalized correctly.\n" +
         "Please convert the object instance %o to a Reference before writing it to the cache by calling `toReference(object, true)`."
   },
-
   6: {
     file: "@apollo/client/cache/inmemory/policies.js",
     message: "Inferring subtype %s of supertype %s"
   },
-
   7: {
     file: "@apollo/client/cache/inmemory/policies.js",
     message: "Undefined 'from' passed to readField with arguments %s"
   },
-
   14: {
     file: "@apollo/client/cache/inmemory/writeToStore.js",
     message: "Cache data may be lost when replacing the %s field of a %s object.\n\nThis could cause additional (usually avoidable) network requests to fetch data that were otherwise cached.\n\nTo address this problem (which is not a bug in Apollo Client), %sdefine a custom merge function for the %s field, so InMemoryCache can safely merge these objects:\n\n  existing: %s\n  incoming: %s\n\nFor more information about these options, please refer to the documentation:\n\n  * Ensuring entity objects have IDs: https://go.apollo.dev/c/generating-unique-identifiers\n  * Defining custom merge functions: https://go.apollo.dev/c/merging-non-normalized-objects\n"
   },
-
   20: {
     file: "@apollo/client/core/ObservableQuery.js",
     message: "Called refetch(%o) for query %o, which does not declare a $variables variable.\nDid you mean to call refetch(variables) instead of refetch({ variables })?"
   },
-
   33: {
     file: "@apollo/client/core/QueryManager.js",
     message: "Unknown query named \"%s\" requested in refetchQueries options.include array"
   },
-
   34: {
     file: "@apollo/client/core/QueryManager.js",
     message: "Unknown query %s requested in refetchQueries options.include array"
   },
-
   35: {
     file: "@apollo/client/link/core/ApolloLink.js",
     message: "You are calling concat on a terminating link, which will have no effect %o"
   },
-
   38: {
     file: "@apollo/client/link/http/createHttpLink.js",
     message: "Multipart-subscriptions do not support @defer"
   },
-
   42: {
     file: "@apollo/client/link/utils/toPromise.js",
     message: "Promise Wrapper does not support multiple results from Observable"
   },
-
   50: {
     file: "@apollo/client/react/hooks/useQuery.js",
     message: "Calling default no-op implementation of InternalState#forceUpdate"
   },
-
   52: {
     file: "@apollo/client/react/hooks/useSubscription.js",
     message: "'useSubscription' supports only the 'onSubscriptionData' or 'onData' option, but not both. Only the 'onData' option will be used."
   },
-
   53: {
     file: "@apollo/client/react/hooks/useSubscription.js",
     message: "'onSubscriptionData' is deprecated and will be removed in a future major version. Please use the 'onData' option instead."
   },
-
   54: {
     file: "@apollo/client/react/hooks/useSubscription.js",
     message: "'useSubscription' supports only the 'onSubscriptionComplete' or 'onComplete' option, but not both. Only the 'onComplete' option will be used."
   },
-
   55: {
     file: "@apollo/client/react/hooks/useSubscription.js",
     message: "'onSubscriptionComplete' is deprecated and will be removed in a future major version. Please use the 'onComplete' option instead."
   },
-
   57: {
     file: "@apollo/client/react/hooks/useSuspenseQuery.js",
     message: "Using `returnPartialData` with a `no-cache` fetch policy has no effect. To read partial data from the cache, consider using an alternate fetch policy."
   },
-
   83: {
     file: "@apollo/client/utilities/graphql/transform.js",
-
     message: "Removing an @connection directive even though it does not have a key. " +
         "You may want to use the key parameter to specify a store key."
   }
 };
-
 const devError = {
   12: {
     file: "@apollo/client/cache/inmemory/writeToStore.js",
     message: "Missing field '%s' while writing result %o"
   },
-
   21: {
     file: "@apollo/client/core/ObservableQuery.js",
     message: "Unhandled GraphQL subscription error"
   },
-
   23: {
     file: "@apollo/client/core/ObservableQuery.js",
     message: "Unhandled error"
   },
-
   58: {
     file: "@apollo/client/react/hooks/useSyncExternalStore.js",
     message: "The result of getSnapshot should be cached to avoid an infinite loop"
   },
-
   82: {
     file: "@apollo/client/utilities/graphql/transform.js",
     message: "Could not find operation or fragment"
   }
 };
 
-var version = "3.8.7";
+var version = "3.8.9";
 
 function maybe(thunk) {
     try {
@@ -542,7 +437,8 @@ function maybe(thunk) {
 var global$1 = (maybe(function () { return globalThis; }) ||
     maybe(function () { return window; }) ||
     maybe(function () { return self; }) ||
-    maybe(function () { return global; }) || maybe(function () {
+    maybe(function () { return global; }) ||
+maybe(function () {
     return maybe.constructor("return this")();
 }));
 
@@ -596,9 +492,7 @@ Object.assign(function invariant(condition, message) {
 });
 var ApolloErrorMessageHandler = Symbol.for("ApolloErrorMessageHandler_" + version);
 function stringify(arg) {
-    return typeof arg == "string"
-        ? arg
-        : stringifyForDisplay(arg, 2).slice(0, 1000);
+    return typeof arg == "string" ? arg : (stringifyForDisplay(arg, 2).slice(0, 1000));
 }
 function getHandledErrorMsg(message, messageArgs) {
     if (messageArgs === void 0) { messageArgs = []; }