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

package/core/types.d.ts

@@ -181,43 +181,120 @@ export type InternalRefetchQueriesMap<TResult> = Map<ObservableQuery<any>, Inter
 export type OperationVariables = Record<string, any>;
 export type ApolloQueryResult<TData, TStates extends DataState<TData>["dataState"] = DataState<TData>["dataState"]> = {
     /**
-     * The single Error object that is passed to onError and useQuery hooks, and is often thrown during manual `client.query` calls.
-     * This will contain both a NetworkError field and any GraphQLErrors.
-     * See https://www.apollographql.com/docs/react/data/error-handling/ for more information.
-     */
+    * A single ErrorLike object describing the error that occured during the latest query execution.
+    * 
+    * For more information, see [Handling operation errors](https://www.apollographql.com/docs/react/data/error-handling/).
+    * 
+    * @docGroup
+    * 
+    * 1. Operation data
+    */
     error?: ErrorLike;
+    /**
+    * If `true`, the query is still in flight and results have not yet been returned.
+    * 
+    * @docGroup
+    * 
+    * 2. Network info
+    */
     loading: boolean;
+    /**
+    * A number indicating the current network state of the query's associated request. [See possible values.](https://github.com/apollographql/apollo-client/blob/d96f4578f89b933c281bb775a39503f6cdb59ee8/src/core/networkStatus.ts#L4)
+    * 
+    * Used in conjunction with the [`notifyOnNetworkStatusChange`](#notifyonnetworkstatuschange) option.
+    * 
+    * @docGroup
+    * 
+    * 2. Network info
+    */
     networkStatus: NetworkStatus;
     /**
-     * Describes whether `data` is a complete or partial result. This flag is only
-     * set when `returnPartialData` is `true` in query options.
-     *
-     * @deprecated This field will be removed in a future version of Apollo Client.
-     */
+    * Describes whether `data` is a complete or partial result. This flag is only set when `returnPartialData` is `true` in query options.
+    * 
+    * @deprecated
+    * 
+    * This field will be removed in a future version of Apollo Client.
+    * 
+    * @docGroup
+    * 
+    * 1. Operation data
+    */
     partial: boolean;
 } & GetDataState<TData, TStates>;
 export type DataState<TData> = {
+    /**
+    * An object containing the result of your GraphQL query after it completes.
+    * 
+    * This value might be `undefined` if a query results in one or more errors (depending on the query's `errorPolicy`).
+    * 
+    * @docGroup
+    * 
+    * 1. Operation data
+    */
     data: DataValue.Complete<TData>;
     /**
     * Describes the completeness of `data`. - `empty`: No data could be fulfilled from the cache or the result is incomplete. `data` is `undefined`. - `partial`: Some data could be fulfilled from the cache but `data` is incomplete. This is only possible when `returnPartialData` is `true`. - `streaming`: `data` is incomplete as a result of a deferred query and the result is still streaming in. - `complete`: `data` is a fully satisfied query result fulfilled either from the cache or network.
+    * 
+    * @docGroup
+    * 
+    * 1. Operation data
     */
     dataState: "complete";
 } | {
+    /**
+    * An object containing the result of your GraphQL query after it completes.
+    * 
+    * This value might be `undefined` if a query results in one or more errors (depending on the query's `errorPolicy`).
+    * 
+    * @docGroup
+    * 
+    * 1. Operation data
+    */
     data: DataValue.Streaming<TData>;
     /**
     * Describes the completeness of `data`. - `empty`: No data could be fulfilled from the cache or the result is incomplete. `data` is `undefined`. - `partial`: Some data could be fulfilled from the cache but `data` is incomplete. This is only possible when `returnPartialData` is `true`. - `streaming`: `data` is incomplete as a result of a deferred query and the result is still streaming in. - `complete`: `data` is a fully satisfied query result fulfilled either from the cache or network.
+    * 
+    * @docGroup
+    * 
+    * 1. Operation data
     */
     dataState: "streaming";
 } | {
+    /**
+    * An object containing the result of your GraphQL query after it completes.
+    * 
+    * This value might be `undefined` if a query results in one or more errors (depending on the query's `errorPolicy`).
+    * 
+    * @docGroup
+    * 
+    * 1. Operation data
+    */
     data: DataValue.Partial<TData>;
     /**
     * Describes the completeness of `data`. - `empty`: No data could be fulfilled from the cache or the result is incomplete. `data` is `undefined`. - `partial`: Some data could be fulfilled from the cache but `data` is incomplete. This is only possible when `returnPartialData` is `true`. - `streaming`: `data` is incomplete as a result of a deferred query and the result is still streaming in. - `complete`: `data` is a fully satisfied query result fulfilled either from the cache or network.
+    * 
+    * @docGroup
+    * 
+    * 1. Operation data
     */
     dataState: "partial";
 } | {
+    /**
+    * An object containing the result of your GraphQL query after it completes.
+    * 
+    * This value might be `undefined` if a query results in one or more errors (depending on the query's `errorPolicy`).
+    * 
+    * @docGroup
+    * 
+    * 1. Operation data
+    */
     data: undefined;
     /**
     * Describes the completeness of `data`. - `empty`: No data could be fulfilled from the cache or the result is incomplete. `data` is `undefined`. - `partial`: Some data could be fulfilled from the cache but `data` is incomplete. This is only possible when `returnPartialData` is `true`. - `streaming`: `data` is incomplete as a result of a deferred query and the result is still streaming in. - `complete`: `data` is a fully satisfied query result fulfilled either from the cache or network.
+    * 
+    * @docGroup
+    * 
+    * 1. Operation data
     */
     dataState: "empty";
 };
@@ -288,7 +365,7 @@ export interface QueryResult<TData = unknown> {
     */
     data: TData | undefined;
     /**
-    * If the query produces one or more errors, this object contains either an array of `graphQLErrors` or a single `networkError`. Otherwise, this value is `undefined`.
+    * A single ErrorLike object describing the error that occured during the latest query execution.
     * 
     * For more information, see [Handling operation errors](https://www.apollographql.com/docs/react/data/error-handling/).
     * 

package/core/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/core/types.ts"],"names":[],"mappings":"","sourcesContent":["import type { DocumentNode, FormattedExecutionResult } from \"graphql\";\nimport type {\n  NextNotification,\n  Observable,\n  ObservableNotification,\n} from \"rxjs\";\n\nimport type { ApolloCache } from \"@apollo/client/cache\";\nimport type { Cache } from \"@apollo/client/cache\";\nimport type { ClientAwarenessLink } from \"@apollo/client/link/client-awareness\";\nimport type { Unmasked } from \"@apollo/client/masking\";\nimport type { DeepPartial, HKT } from \"@apollo/client/utilities\";\nimport type {\n  ApplyHKTImplementationWithDefault,\n  IsAny,\n} from \"@apollo/client/utilities/internal\";\n\nimport type { NetworkStatus } from \"./networkStatus.js\";\nimport type { ObservableQuery } from \"./ObservableQuery.js\";\nimport type { QueryOptions } from \"./watchQueryOptions.js\";\n\nexport type { TypedDocumentNode } from \"@graphql-typed-document-node/core\";\n\nexport type MethodKeys<T> = {\n  [P in keyof T]: T[P] extends Function ? P : never;\n}[keyof T];\n\nexport interface TypeOverrides {}\n\nnamespace OverridableTypes {\n  export interface Defaults {\n    Complete: Complete;\n    Streaming: Streaming;\n    Partial: Partial;\n  }\n\n  interface Complete extends HKT {\n    arg1: unknown; // TData\n    return: this[\"arg1\"];\n  }\n\n  interface Streaming extends HKT {\n    arg1: unknown; // TData\n    return: this[\"arg1\"];\n  }\n\n  interface Partial extends HKT {\n    arg1: unknown; // TData\n    return: DeepPartial<this[\"arg1\"]>;\n  }\n}\n\nexport declare namespace DataValue {\n  /**\n   * Returns a representation of `TData` in it's \"complete\" state.\n   *\n   * @defaultValue `TData` if no overrides are provided.\n   *\n   * @example\n   * You can override this type globally - this example shows how to override it\n   * with `DeepPartial<TData>`:\n   *\n   * ```ts\n   * import { HKT, DeepPartial } from \"@apollo/client/utilities\";\n   *\n   * type CompleteOverride<TData> = TData extends { _complete?: infer _Complete } ? _Complete : TData;\n   *\n   * interface CompleteOverrideHKT extends HKT {\n   *   return: CompleteOverride<this[\"arg1\"]>;\n   * }\n   *\n   * declare module \"@apollo/client\" {\n   *   export interface TypeOverrides {\n   *     Complete: CompleteOverrideHKT;\n   *   }\n   * }\n   * ```\n   */\n  export type Complete<TData> = ApplyHKTImplementationWithDefault<\n    TypeOverrides,\n    \"Complete\",\n    OverridableTypes.Defaults,\n    TData\n  >;\n\n  /**\n   * Returns a representation of `TData` while it is streaming.\n   *\n   * @defaultValue `TData` if no overrides are provided.\n   *\n   * @example\n   * You can override this type globally - this example shows how to override it\n   * with `DeepPartial<TData>`:\n   *\n   * ```ts\n   * import { HKT, DeepPartial } from \"@apollo/client/utilities\";\n   *\n   * type StreamingOverride<TData> = DeepPartial<TData>;\n   *\n   * interface StreamingOverrideHKT extends HKT {\n   *   return: StreamingOverride<this[\"arg1\"]>;\n   * }\n   *\n   * declare module \"@apollo/client\" {\n   *   export interface TypeOverrides {\n   *     Streaming: StreamingOverrideHKT;\n   *   }\n   * }\n   * ```\n   */\n  export type Streaming<TData> = ApplyHKTImplementationWithDefault<\n    TypeOverrides,\n    \"Streaming\",\n    OverridableTypes.Defaults,\n    TData\n  >;\n\n  /**\n   * Returns a representation of `TData` while it is partial.\n   *\n   * @defaultValue `DeepPartial<TData>` if no overrides are provided.\n   *\n   * @example\n   * You can override this type globally - this example shows how to override it\n   * with `DeepPartial<TData>`:\n   *\n   * ```ts\n   * import { HKT, DeepPartial } from \"@apollo/client/utilities\";\n   *\n   * type PartialOverride<TData> = DeepPartial<Complete<TData>>;\n   *\n   * interface PartialOverrideHKT extends HKT {\n   *   return: PartialOverride<this[\"arg1\"]>;\n   * }\n   *\n   * declare module \"@apollo/client\" {\n   *   export interface TypeOverrides {\n   *     Partial: PartialOverrideHKT;\n   *   }\n   * }\n   * ```\n   */\n  export type Partial<TData> = ApplyHKTImplementationWithDefault<\n    TypeOverrides,\n    \"Partial\",\n    OverridableTypes.Defaults,\n    TData\n  >;\n}\nexport interface DefaultContext extends Record<string, any> {\n  /**\n   * Indicates whether `queryDeduplication` was enabled for the request.\n   */\n  queryDeduplication?: boolean;\n  clientAwareness?: ClientAwarenessLink.ClientAwarenessOptions;\n}\n\n/**\n * Represents an `Error` type, but used throughout Apollo Client to represent\n * errors that may otherwise fail `instanceof` checks if they are cross-realm\n * Error instances (see the [`Error.isError` proposal](https://github.com/tc39/proposal-is-error) for more details).\n *\n * Apollo Client uses several types of errors throughout the client which can be\n * narrowed using `instanceof`:\n * - `CombinedGraphQLErrors` - `errors` returned from a GraphQL result\n * - `CombinedProtocolErrors` - Transport-level errors from multipart subscriptions.\n * - `ServerParseError` - A JSON-parse error when parsing the server response.\n * - `ServerError` - A non-200 server response.\n *\n * @example\n * ```ts\n * import { CombinedGraphQLErrors } from \"@apollo/client\";\n *\n * try {\n *   await client.query({ query });\n * } catch (error) {\n *   // Use `instanceof` to check for more specific types of errors.\n *   if (error instanceof CombinedGraphQLErrors) {\n *     error.errors.map(graphQLError => console.log(graphQLError.message));\n *   } else {\n *     console.error(errors);\n *   }\n * }\n * ```\n */\nexport interface ErrorLike {\n  message: string;\n  name: string;\n  stack?: string;\n}\n\nexport type OnQueryUpdated<TResult> = (\n  observableQuery: ObservableQuery<any>,\n  diff: Cache.DiffResult<any>,\n  lastDiff: Cache.DiffResult<any> | undefined\n) => boolean | TResult;\n\nexport type RefetchQueryDescriptor = string | DocumentNode;\nexport type InternalRefetchQueryDescriptor =\n  | RefetchQueryDescriptor\n  | QueryOptions;\n\ntype RefetchQueriesIncludeShorthand = \"all\" | \"active\";\n\nexport type RefetchQueriesInclude =\n  | RefetchQueryDescriptor[]\n  | RefetchQueriesIncludeShorthand;\n\nexport type InternalRefetchQueriesInclude =\n  | InternalRefetchQueryDescriptor[]\n  | RefetchQueriesIncludeShorthand;\n\n// Used by ApolloClient[\"refetchQueries\"]\n// TODO Improve documentation comments for this public type.\nexport interface RefetchQueriesOptions<TCache extends ApolloCache, TResult> {\n  updateCache?: (cache: TCache) => void;\n  // The client.refetchQueries method discourages passing QueryOptions, by\n  // restricting the public type of options.include to exclude QueryOptions as\n  // an available array element type (see InternalRefetchQueriesInclude for a\n  // version of RefetchQueriesInclude that allows legacy QueryOptions objects).\n  include?: RefetchQueriesInclude;\n  optimistic?: boolean;\n  // If no onQueryUpdated function is provided, any queries affected by the\n  // updateCache function or included in the options.include array will be\n  // refetched by default. Passing null instead of undefined disables this\n  // default refetching behavior for affected queries, though included queries\n  // will still be refetched.\n  onQueryUpdated?: OnQueryUpdated<TResult> | null;\n}\n\n// The client.refetchQueries method returns a thenable (PromiseLike) object\n// whose result is an array of Promise.resolve'd TResult values, where TResult\n// is whatever type the (optional) onQueryUpdated function returns. When no\n// onQueryUpdated function is given, TResult defaults to ApolloQueryResult<any>\n// (thanks to default type parameters for client.refetchQueries).\nexport type RefetchQueriesPromiseResults<TResult> =\n  // If onQueryUpdated returns any, all bets are off, so the results array must\n  // be a generic any[] array, which is much less confusing than the union type\n  // we get if we don't check for any. I hoped `any extends TResult` would do\n  // the trick here, instead of IsStrictlyAny, but you can see for yourself what\n  // fails in the refetchQueries tests if you try making that simplification.\n  IsAny<TResult> extends true ? any[]\n  : // If the onQueryUpdated function passed to client.refetchQueries returns true\n  // or false, that means either to refetch the query (true) or to skip the\n  // query (false). Since refetching produces an ApolloQueryResult<any>, and\n  // skipping produces nothing, the fully-resolved array of all results produced\n  // will be an ApolloQueryResult<any>[], when TResult extends boolean.\n  TResult extends boolean ? QueryResult<any>[]\n  : // If onQueryUpdated returns a PromiseLike<U>, that thenable will be passed as\n  // an array element to Promise.all, so we infer/unwrap the array type U here.\n  TResult extends PromiseLike<infer U> ? U[]\n  : // All other onQueryUpdated results end up in the final Promise.all array as\n    // themselves, with their original TResult type. Note that TResult will\n    // default to ApolloQueryResult<any> if no onQueryUpdated function is passed\n    // to client.refetchQueries.\n    TResult[];\n\n// The result of client.refetchQueries is thenable/awaitable, if you just want\n// an array of fully resolved results, but you can also access the raw results\n// immediately by examining the additional { queries, results } properties of\n// the RefetchQueriesResult<TResult> object.\nexport interface RefetchQueriesResult<TResult>\n  extends Promise<RefetchQueriesPromiseResults<TResult>> {\n  // An array of ObservableQuery objects corresponding 1:1 to TResult values\n  // in the results arrays (both the TResult[] array below, and the results\n  // array resolved by the Promise above).\n  queries: ObservableQuery<any>[];\n  // These are the raw TResult values returned by any onQueryUpdated functions\n  // that were invoked by client.refetchQueries.\n  results: InternalRefetchQueriesResult<TResult>[];\n}\n\n// Used by QueryManager[\"refetchQueries\"]\nexport interface InternalRefetchQueriesOptions<\n  TCache extends ApolloCache,\n  TResult,\n> extends Omit<RefetchQueriesOptions<TCache, TResult>, \"include\"> {\n  // Just like the refetchQueries option for a mutation, an array of strings,\n  // DocumentNode objects, and/or QueryOptions objects, or one of the shorthand\n  // strings \"all\" or \"active\", to select every (active) query.\n  include?: InternalRefetchQueriesInclude;\n  // This part of the API is a (useful) implementation detail, but need not be\n  // exposed in the public client.refetchQueries API (above).\n  removeOptimistic?: string;\n}\n\nexport type InternalRefetchQueriesResult<TResult> =\n  // If onQueryUpdated returns a boolean, that's equivalent to refetching the\n  // query when the boolean is true and skipping the query when false, so the\n  // internal type of refetched results is Promise<ApolloQueryResult<any>>.\n  TResult extends boolean ? Promise<QueryResult<any>>\n  : // Otherwise, onQueryUpdated returns whatever it returns. If onQueryUpdated is\n    // not provided, TResult defaults to Promise<ApolloQueryResult<any>> (see the\n    // generic type parameters of client.refetchQueries).\n    TResult;\n\nexport type InternalRefetchQueriesMap<TResult> = Map<\n  ObservableQuery<any>,\n  InternalRefetchQueriesResult<TResult>\n>;\n\nexport type OperationVariables = Record<string, any>;\n\nexport type ApolloQueryResult<\n  TData,\n  TStates extends DataState<TData>[\"dataState\"] = DataState<TData>[\"dataState\"],\n> = {\n  /**\n   * The single Error object that is passed to onError and useQuery hooks, and is often thrown during manual `client.query` calls.\n   * This will contain both a NetworkError field and any GraphQLErrors.\n   * See https://www.apollographql.com/docs/react/data/error-handling/ for more information.\n   */\n  error?: ErrorLike;\n  loading: boolean;\n  networkStatus: NetworkStatus;\n  /**\n   * Describes whether `data` is a complete or partial result. This flag is only\n   * set when `returnPartialData` is `true` in query options.\n   *\n   * @deprecated This field will be removed in a future version of Apollo Client.\n   */\n  partial: boolean;\n} & GetDataState<TData, TStates>;\n\nexport type DataState<TData> =\n  | {\n      data: DataValue.Complete<TData>;\n      /** {@inheritDoc @apollo/client!QueryResultDocumentation#dataState:member} */\n      dataState: \"complete\";\n    }\n  | {\n      data: DataValue.Streaming<TData>;\n      /** {@inheritDoc @apollo/client!QueryResultDocumentation#dataState:member} */\n      dataState: \"streaming\";\n    }\n  | {\n      data: DataValue.Partial<TData>;\n      /** {@inheritDoc @apollo/client!QueryResultDocumentation#dataState:member} */\n      dataState: \"partial\";\n    }\n  | {\n      data: undefined;\n      /** {@inheritDoc @apollo/client!QueryResultDocumentation#dataState:member} */\n      dataState: \"empty\";\n    };\n\nexport type GetDataState<\n  TData,\n  TState extends DataState<TData>[\"dataState\"],\n> = Extract<DataState<TData>, { dataState: TState }>;\n\n/**\n * Represents a result that might be complete or still streaming and\n * has been normalized into a plain GraphQL result. When the result is\n * still `streaming`, some fields might not yet be available.\n */\nexport type NormalizedExecutionResult<\n  TData = Record<string, unknown>,\n  TExtensions = Record<string, unknown>,\n> = Omit<FormattedExecutionResult<TData, TExtensions>, \"data\"> &\n  GetDataState<TData, \"streaming\" | \"complete\">;\n\n// This is part of the public API, people write these functions in `updateQueries`.\nexport type MutationQueryReducer<T> = (\n  previousResult: Record<string, any>,\n  options: {\n    mutationResult: NormalizedExecutionResult<Unmasked<T>>;\n    queryName: string | undefined;\n    queryVariables: Record<string, any>;\n  }\n) => Record<string, any>;\n\nexport type MutationQueryReducersMap<T = { [key: string]: any }> = {\n  [queryName: string]: MutationQueryReducer<T>;\n};\n\nexport type MutationUpdaterFunction<\n  TData,\n  TVariables,\n  TCache extends ApolloCache,\n> = (\n  cache: TCache,\n  result: FormattedExecutionResult<Unmasked<TData>>,\n  options: {\n    context?: DefaultContext;\n    variables?: TVariables;\n  }\n) => void;\n\nexport interface MutateResult<TData = unknown> {\n  /** {@inheritDoc @apollo/client!MutationResultDocumentation#data:member} */\n  data: TData | undefined;\n\n  /** {@inheritDoc @apollo/client!MutationResultDocumentation#error:member} */\n  error?: ErrorLike;\n\n  /** {@inheritDoc @apollo/client!MutationResultDocumentation#extensions:member} */\n  extensions?: Record<string, unknown>;\n}\n\nexport interface SubscribeResult<TData = unknown> {\n  /** {@inheritDoc @apollo/client!MutationResultDocumentation#data:member} */\n  data: TData | undefined;\n\n  /** {@inheritDoc @apollo/client!MutationResultDocumentation#error:member} */\n  error?: ErrorLike;\n\n  /** {@inheritDoc @apollo/client!MutationResultDocumentation#extensions:member} */\n  extensions?: Record<string, unknown>;\n}\n\nexport interface QueryResult<TData = unknown> {\n  /** {@inheritDoc @apollo/client!QueryResultDocumentation#data:member} */\n  data: TData | undefined;\n\n  /** {@inheritDoc @apollo/client!QueryResultDocumentation#error:member} */\n  error?: ErrorLike;\n}\n\nexport declare namespace QueryNotification {\n  type NewNetworkStatus<TData> = NextNotification<{\n    resetError?: boolean;\n  }> & {\n    source: \"newNetworkStatus\";\n  };\n\n  type SetResult<TData> = NextNotification<ApolloQueryResult<TData>> & {\n    source: \"setResult\";\n  };\n\n  type FromNetwork<TData> = ObservableNotification<ApolloQueryResult<TData>> & {\n    source: \"network\";\n  };\n\n  type FromCache<TData> = NextNotification<ApolloQueryResult<TData>> & {\n    source: \"cache\";\n  };\n\n  type Value<TData> =\n    | FromCache<TData>\n    | FromNetwork<TData>\n    | NewNetworkStatus<TData>\n    | SetResult<TData>;\n}\n\n/** Observable created by initiating a subscription operation. */\nexport interface SubscriptionObservable<T> extends Observable<T> {\n  /**\n   * Used to restart the connection to the link chain. Calling this on a\n   * deduplicated subscription will restart the connection for all observables\n   * that share the request.\n   *\n   * @example\n   *\n   * ```ts\n   * const observable = client.subscribe({ query: subscription });\n   * observable.subscribe((value) => {\n   *   // ...\n   * });\n   *\n   * observable.restart();\n   * ```\n   */\n  restart: () => void;\n}\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/core/types.ts"],"names":[],"mappings":"","sourcesContent":["import type { DocumentNode, FormattedExecutionResult } from \"graphql\";\nimport type {\n  NextNotification,\n  Observable,\n  ObservableNotification,\n} from \"rxjs\";\n\nimport type { ApolloCache } from \"@apollo/client/cache\";\nimport type { Cache } from \"@apollo/client/cache\";\nimport type { ClientAwarenessLink } from \"@apollo/client/link/client-awareness\";\nimport type { Unmasked } from \"@apollo/client/masking\";\nimport type { DeepPartial, HKT } from \"@apollo/client/utilities\";\nimport type {\n  ApplyHKTImplementationWithDefault,\n  IsAny,\n} from \"@apollo/client/utilities/internal\";\n\nimport type { NetworkStatus } from \"./networkStatus.js\";\nimport type { ObservableQuery } from \"./ObservableQuery.js\";\nimport type { QueryOptions } from \"./watchQueryOptions.js\";\n\nexport type { TypedDocumentNode } from \"@graphql-typed-document-node/core\";\n\nexport type MethodKeys<T> = {\n  [P in keyof T]: T[P] extends Function ? P : never;\n}[keyof T];\n\nexport interface TypeOverrides {}\n\nnamespace OverridableTypes {\n  export interface Defaults {\n    Complete: Complete;\n    Streaming: Streaming;\n    Partial: Partial;\n  }\n\n  interface Complete extends HKT {\n    arg1: unknown; // TData\n    return: this[\"arg1\"];\n  }\n\n  interface Streaming extends HKT {\n    arg1: unknown; // TData\n    return: this[\"arg1\"];\n  }\n\n  interface Partial extends HKT {\n    arg1: unknown; // TData\n    return: DeepPartial<this[\"arg1\"]>;\n  }\n}\n\nexport declare namespace DataValue {\n  /**\n   * Returns a representation of `TData` in it's \"complete\" state.\n   *\n   * @defaultValue `TData` if no overrides are provided.\n   *\n   * @example\n   * You can override this type globally - this example shows how to override it\n   * with `DeepPartial<TData>`:\n   *\n   * ```ts\n   * import { HKT, DeepPartial } from \"@apollo/client/utilities\";\n   *\n   * type CompleteOverride<TData> = TData extends { _complete?: infer _Complete } ? _Complete : TData;\n   *\n   * interface CompleteOverrideHKT extends HKT {\n   *   return: CompleteOverride<this[\"arg1\"]>;\n   * }\n   *\n   * declare module \"@apollo/client\" {\n   *   export interface TypeOverrides {\n   *     Complete: CompleteOverrideHKT;\n   *   }\n   * }\n   * ```\n   */\n  export type Complete<TData> = ApplyHKTImplementationWithDefault<\n    TypeOverrides,\n    \"Complete\",\n    OverridableTypes.Defaults,\n    TData\n  >;\n\n  /**\n   * Returns a representation of `TData` while it is streaming.\n   *\n   * @defaultValue `TData` if no overrides are provided.\n   *\n   * @example\n   * You can override this type globally - this example shows how to override it\n   * with `DeepPartial<TData>`:\n   *\n   * ```ts\n   * import { HKT, DeepPartial } from \"@apollo/client/utilities\";\n   *\n   * type StreamingOverride<TData> = DeepPartial<TData>;\n   *\n   * interface StreamingOverrideHKT extends HKT {\n   *   return: StreamingOverride<this[\"arg1\"]>;\n   * }\n   *\n   * declare module \"@apollo/client\" {\n   *   export interface TypeOverrides {\n   *     Streaming: StreamingOverrideHKT;\n   *   }\n   * }\n   * ```\n   */\n  export type Streaming<TData> = ApplyHKTImplementationWithDefault<\n    TypeOverrides,\n    \"Streaming\",\n    OverridableTypes.Defaults,\n    TData\n  >;\n\n  /**\n   * Returns a representation of `TData` while it is partial.\n   *\n   * @defaultValue `DeepPartial<TData>` if no overrides are provided.\n   *\n   * @example\n   * You can override this type globally - this example shows how to override it\n   * with `DeepPartial<TData>`:\n   *\n   * ```ts\n   * import { HKT, DeepPartial } from \"@apollo/client/utilities\";\n   *\n   * type PartialOverride<TData> = DeepPartial<Complete<TData>>;\n   *\n   * interface PartialOverrideHKT extends HKT {\n   *   return: PartialOverride<this[\"arg1\"]>;\n   * }\n   *\n   * declare module \"@apollo/client\" {\n   *   export interface TypeOverrides {\n   *     Partial: PartialOverrideHKT;\n   *   }\n   * }\n   * ```\n   */\n  export type Partial<TData> = ApplyHKTImplementationWithDefault<\n    TypeOverrides,\n    \"Partial\",\n    OverridableTypes.Defaults,\n    TData\n  >;\n}\nexport interface DefaultContext extends Record<string, any> {\n  /**\n   * Indicates whether `queryDeduplication` was enabled for the request.\n   */\n  queryDeduplication?: boolean;\n  clientAwareness?: ClientAwarenessLink.ClientAwarenessOptions;\n}\n\n/**\n * Represents an `Error` type, but used throughout Apollo Client to represent\n * errors that may otherwise fail `instanceof` checks if they are cross-realm\n * Error instances (see the [`Error.isError` proposal](https://github.com/tc39/proposal-is-error) for more details).\n *\n * Apollo Client uses several types of errors throughout the client which can be\n * narrowed using `instanceof`:\n * - `CombinedGraphQLErrors` - `errors` returned from a GraphQL result\n * - `CombinedProtocolErrors` - Transport-level errors from multipart subscriptions.\n * - `ServerParseError` - A JSON-parse error when parsing the server response.\n * - `ServerError` - A non-200 server response.\n *\n * @example\n * ```ts\n * import { CombinedGraphQLErrors } from \"@apollo/client\";\n *\n * try {\n *   await client.query({ query });\n * } catch (error) {\n *   // Use `instanceof` to check for more specific types of errors.\n *   if (error instanceof CombinedGraphQLErrors) {\n *     error.errors.map(graphQLError => console.log(graphQLError.message));\n *   } else {\n *     console.error(errors);\n *   }\n * }\n * ```\n */\nexport interface ErrorLike {\n  message: string;\n  name: string;\n  stack?: string;\n}\n\nexport type OnQueryUpdated<TResult> = (\n  observableQuery: ObservableQuery<any>,\n  diff: Cache.DiffResult<any>,\n  lastDiff: Cache.DiffResult<any> | undefined\n) => boolean | TResult;\n\nexport type RefetchQueryDescriptor = string | DocumentNode;\nexport type InternalRefetchQueryDescriptor =\n  | RefetchQueryDescriptor\n  | QueryOptions;\n\ntype RefetchQueriesIncludeShorthand = \"all\" | \"active\";\n\nexport type RefetchQueriesInclude =\n  | RefetchQueryDescriptor[]\n  | RefetchQueriesIncludeShorthand;\n\nexport type InternalRefetchQueriesInclude =\n  | InternalRefetchQueryDescriptor[]\n  | RefetchQueriesIncludeShorthand;\n\n// Used by ApolloClient[\"refetchQueries\"]\n// TODO Improve documentation comments for this public type.\nexport interface RefetchQueriesOptions<TCache extends ApolloCache, TResult> {\n  updateCache?: (cache: TCache) => void;\n  // The client.refetchQueries method discourages passing QueryOptions, by\n  // restricting the public type of options.include to exclude QueryOptions as\n  // an available array element type (see InternalRefetchQueriesInclude for a\n  // version of RefetchQueriesInclude that allows legacy QueryOptions objects).\n  include?: RefetchQueriesInclude;\n  optimistic?: boolean;\n  // If no onQueryUpdated function is provided, any queries affected by the\n  // updateCache function or included in the options.include array will be\n  // refetched by default. Passing null instead of undefined disables this\n  // default refetching behavior for affected queries, though included queries\n  // will still be refetched.\n  onQueryUpdated?: OnQueryUpdated<TResult> | null;\n}\n\n// The client.refetchQueries method returns a thenable (PromiseLike) object\n// whose result is an array of Promise.resolve'd TResult values, where TResult\n// is whatever type the (optional) onQueryUpdated function returns. When no\n// onQueryUpdated function is given, TResult defaults to ApolloQueryResult<any>\n// (thanks to default type parameters for client.refetchQueries).\nexport type RefetchQueriesPromiseResults<TResult> =\n  // If onQueryUpdated returns any, all bets are off, so the results array must\n  // be a generic any[] array, which is much less confusing than the union type\n  // we get if we don't check for any. I hoped `any extends TResult` would do\n  // the trick here, instead of IsStrictlyAny, but you can see for yourself what\n  // fails in the refetchQueries tests if you try making that simplification.\n  IsAny<TResult> extends true ? any[]\n  : // If the onQueryUpdated function passed to client.refetchQueries returns true\n  // or false, that means either to refetch the query (true) or to skip the\n  // query (false). Since refetching produces an ApolloQueryResult<any>, and\n  // skipping produces nothing, the fully-resolved array of all results produced\n  // will be an ApolloQueryResult<any>[], when TResult extends boolean.\n  TResult extends boolean ? QueryResult<any>[]\n  : // If onQueryUpdated returns a PromiseLike<U>, that thenable will be passed as\n  // an array element to Promise.all, so we infer/unwrap the array type U here.\n  TResult extends PromiseLike<infer U> ? U[]\n  : // All other onQueryUpdated results end up in the final Promise.all array as\n    // themselves, with their original TResult type. Note that TResult will\n    // default to ApolloQueryResult<any> if no onQueryUpdated function is passed\n    // to client.refetchQueries.\n    TResult[];\n\n// The result of client.refetchQueries is thenable/awaitable, if you just want\n// an array of fully resolved results, but you can also access the raw results\n// immediately by examining the additional { queries, results } properties of\n// the RefetchQueriesResult<TResult> object.\nexport interface RefetchQueriesResult<TResult>\n  extends Promise<RefetchQueriesPromiseResults<TResult>> {\n  // An array of ObservableQuery objects corresponding 1:1 to TResult values\n  // in the results arrays (both the TResult[] array below, and the results\n  // array resolved by the Promise above).\n  queries: ObservableQuery<any>[];\n  // These are the raw TResult values returned by any onQueryUpdated functions\n  // that were invoked by client.refetchQueries.\n  results: InternalRefetchQueriesResult<TResult>[];\n}\n\n// Used by QueryManager[\"refetchQueries\"]\nexport interface InternalRefetchQueriesOptions<\n  TCache extends ApolloCache,\n  TResult,\n> extends Omit<RefetchQueriesOptions<TCache, TResult>, \"include\"> {\n  // Just like the refetchQueries option for a mutation, an array of strings,\n  // DocumentNode objects, and/or QueryOptions objects, or one of the shorthand\n  // strings \"all\" or \"active\", to select every (active) query.\n  include?: InternalRefetchQueriesInclude;\n  // This part of the API is a (useful) implementation detail, but need not be\n  // exposed in the public client.refetchQueries API (above).\n  removeOptimistic?: string;\n}\n\nexport type InternalRefetchQueriesResult<TResult> =\n  // If onQueryUpdated returns a boolean, that's equivalent to refetching the\n  // query when the boolean is true and skipping the query when false, so the\n  // internal type of refetched results is Promise<ApolloQueryResult<any>>.\n  TResult extends boolean ? Promise<QueryResult<any>>\n  : // Otherwise, onQueryUpdated returns whatever it returns. If onQueryUpdated is\n    // not provided, TResult defaults to Promise<ApolloQueryResult<any>> (see the\n    // generic type parameters of client.refetchQueries).\n    TResult;\n\nexport type InternalRefetchQueriesMap<TResult> = Map<\n  ObservableQuery<any>,\n  InternalRefetchQueriesResult<TResult>\n>;\n\nexport type OperationVariables = Record<string, any>;\n\nexport type ApolloQueryResult<\n  TData,\n  TStates extends DataState<TData>[\"dataState\"] = DataState<TData>[\"dataState\"],\n> = {\n  /** {@inheritDoc @apollo/client!QueryResultDocumentation#error:member} */\n  error?: ErrorLike;\n  /** {@inheritDoc @apollo/client!QueryResultDocumentation#loading:member} */\n  loading: boolean;\n  /** {@inheritDoc @apollo/client!QueryResultDocumentation#networkStatus:member} */\n  networkStatus: NetworkStatus;\n  /** {@inheritDoc @apollo/client!QueryResultDocumentation#partial:member} */\n  partial: boolean;\n} & GetDataState<TData, TStates>;\n\nexport type DataState<TData> =\n  | {\n      /** {@inheritDoc @apollo/client!QueryResultDocumentation#data:member} */\n      data: DataValue.Complete<TData>;\n      /** {@inheritDoc @apollo/client!QueryResultDocumentation#dataState:member} */\n      dataState: \"complete\";\n    }\n  | {\n      /** {@inheritDoc @apollo/client!QueryResultDocumentation#data:member} */\n      data: DataValue.Streaming<TData>;\n      /** {@inheritDoc @apollo/client!QueryResultDocumentation#dataState:member} */\n      dataState: \"streaming\";\n    }\n  | {\n      /** {@inheritDoc @apollo/client!QueryResultDocumentation#data:member} */\n      data: DataValue.Partial<TData>;\n      /** {@inheritDoc @apollo/client!QueryResultDocumentation#dataState:member} */\n      dataState: \"partial\";\n    }\n  | {\n      /** {@inheritDoc @apollo/client!QueryResultDocumentation#data:member} */\n      data: undefined;\n      /** {@inheritDoc @apollo/client!QueryResultDocumentation#dataState:member} */\n      dataState: \"empty\";\n    };\n\nexport type GetDataState<\n  TData,\n  TState extends DataState<TData>[\"dataState\"],\n> = Extract<DataState<TData>, { dataState: TState }>;\n\n/**\n * Represents a result that might be complete or still streaming and\n * has been normalized into a plain GraphQL result. When the result is\n * still `streaming`, some fields might not yet be available.\n */\nexport type NormalizedExecutionResult<\n  TData = Record<string, unknown>,\n  TExtensions = Record<string, unknown>,\n> = Omit<FormattedExecutionResult<TData, TExtensions>, \"data\"> &\n  GetDataState<TData, \"streaming\" | \"complete\">;\n\n// This is part of the public API, people write these functions in `updateQueries`.\nexport type MutationQueryReducer<T> = (\n  previousResult: Record<string, any>,\n  options: {\n    mutationResult: NormalizedExecutionResult<Unmasked<T>>;\n    queryName: string | undefined;\n    queryVariables: Record<string, any>;\n  }\n) => Record<string, any>;\n\nexport type MutationQueryReducersMap<T = { [key: string]: any }> = {\n  [queryName: string]: MutationQueryReducer<T>;\n};\n\nexport type MutationUpdaterFunction<\n  TData,\n  TVariables,\n  TCache extends ApolloCache,\n> = (\n  cache: TCache,\n  result: FormattedExecutionResult<Unmasked<TData>>,\n  options: {\n    context?: DefaultContext;\n    variables?: TVariables;\n  }\n) => void;\n\nexport interface MutateResult<TData = unknown> {\n  /** {@inheritDoc @apollo/client!MutationResultDocumentation#data:member} */\n  data: TData | undefined;\n\n  /** {@inheritDoc @apollo/client!MutationResultDocumentation#error:member} */\n  error?: ErrorLike;\n\n  /** {@inheritDoc @apollo/client!MutationResultDocumentation#extensions:member} */\n  extensions?: Record<string, unknown>;\n}\n\nexport interface SubscribeResult<TData = unknown> {\n  /** {@inheritDoc @apollo/client!MutationResultDocumentation#data:member} */\n  data: TData | undefined;\n\n  /** {@inheritDoc @apollo/client!MutationResultDocumentation#error:member} */\n  error?: ErrorLike;\n\n  /** {@inheritDoc @apollo/client!MutationResultDocumentation#extensions:member} */\n  extensions?: Record<string, unknown>;\n}\n\nexport interface QueryResult<TData = unknown> {\n  /** {@inheritDoc @apollo/client!QueryResultDocumentation#data:member} */\n  data: TData | undefined;\n\n  /** {@inheritDoc @apollo/client!QueryResultDocumentation#error:member} */\n  error?: ErrorLike;\n}\n\nexport declare namespace QueryNotification {\n  type NewNetworkStatus<TData> = NextNotification<{\n    resetError?: boolean;\n  }> & {\n    source: \"newNetworkStatus\";\n  };\n\n  type SetResult<TData> = NextNotification<ApolloQueryResult<TData>> & {\n    source: \"setResult\";\n  };\n\n  type FromNetwork<TData> = ObservableNotification<ApolloQueryResult<TData>> & {\n    source: \"network\";\n  };\n\n  type FromCache<TData> = NextNotification<ApolloQueryResult<TData>> & {\n    source: \"cache\";\n  };\n\n  type Value<TData> =\n    | FromCache<TData>\n    | FromNetwork<TData>\n    | NewNetworkStatus<TData>\n    | SetResult<TData>;\n}\n\n/** Observable created by initiating a subscription operation. */\nexport interface SubscriptionObservable<T> extends Observable<T> {\n  /**\n   * Used to restart the connection to the link chain. Calling this on a\n   * deduplicated subscription will restart the connection for all observables\n   * that share the request.\n   *\n   * @example\n   *\n   * ```ts\n   * const observable = client.subscribe({ query: subscription });\n   * observable.subscribe((value) => {\n   *   // ...\n   * });\n   *\n   * observable.restart();\n   * ```\n   */\n  restart: () => void;\n}\n"]}

package/link/http/HttpLink.d.ts

@@ -4,6 +4,9 @@ import { ApolloLink } from "@apollo/client/link";
 import { ClientAwarenessLink } from "@apollo/client/link/client-awareness";
 import type { print } from "@apollo/client/utilities";
 export declare namespace HttpLink {
+    /**
+     * Options passed to `HttpLink` through request context.
+     */
     interface ContextOptions {
         /**
          * The URL of the GraphQL endpoint to send requests to. Can also be a
@@ -34,8 +37,12 @@ export declare namespace HttpLink {
          * An object that configures advanced `HttpLink` functionality, such as
          * support for persisted queries.
          */
-        http?: HttpOptions;
+        http?: HttpLink.HttpOptions;
     }
+    /**
+     * Options passed to `HttpLink` through the `http` constructor option
+     * or the `http` property of a request context.
+     */
     interface HttpOptions {
         /**
          * If `true`, includes the `extensions` field in operations sent to your
@@ -71,6 +78,9 @@ export declare namespace HttpLink {
          */
         accept?: string[];
     }
+    /**
+     * Options for the `HttpLink` constructor.
+     */
     interface Options {
         /**
          * The URI to use when fetching operations.

package/link/http/HttpLink.js.map

@@ -1 +1 @@
-{"version":3,"file":"HttpLink.js","sourceRoot":"","sources":["../../../src/link/http/HttpLink.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,mBAAmB,EAAE,MAAM,sCAAsC,CAAC;AAG3E,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AA4JjD,MAAM,OAAO,QAAS,SAAQ,UAAU;IACtC,YAAY,UAA0D,EAAE;QACtE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,MAAM,CAChD,IAAI,mBAAmB,CAAC,OAAO,CAAC,EAChC,IAAI,YAAY,CAAC,OAAO,CAAC,CAC1B,CAAC;QACF,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IACvC,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,cAA8D,EAAE,EAChE,EAAE,CAAC,IAAI,QAAQ,CAAC,WAAW,CAAC,CAAC","sourcesContent":["import type { ASTNode } from \"graphql\";\n\nimport type { Operation } from \"@apollo/client/link\";\nimport { ApolloLink } from \"@apollo/client/link\";\nimport { ClientAwarenessLink } from \"@apollo/client/link/client-awareness\";\nimport type { print } from \"@apollo/client/utilities\";\n\nimport { BaseHttpLink } from \"./BaseHttpLink.js\";\n\nexport declare namespace HttpLink {\n  interface ContextOptions {\n    /**\n     * The URL of the GraphQL endpoint to send requests to. Can also be a\n     * function that accepts an `Operation` object and returns the string URL to\n     * use for that operation.\n     */\n    uri?: string | UriFunction;\n\n    /**\n     * An object representing headers to include in the HTTP request, such as\n     * `{Authorization: 'Bearer abc123'}`.\n     */\n    headers?: Record<string, string>;\n\n    /**\n     * The credentials policy to use for this fetch call. Can be `omit`, `include`,\n     * or `same-origin`.\n     */\n    credentials?: RequestCredentials;\n\n    /**\n     * An object containing options to use for this call to `fetch`. If a\n     * particular option is not included in this object, the default value of\n     * that option is used.\n     *\n     * Note that if you set `fetchOptions.method` to `GET`, `HttpLink` follows\n     * [standard GraphQL HTTP GET encoding](http://graphql.org/learn/serving-over-http/#get-request).\n     */\n    fetchOptions?: RequestInit;\n\n    /**\n     * An object that configures advanced `HttpLink` functionality, such as\n     * support for persisted queries.\n     */\n    http?: HttpOptions;\n  }\n\n  export interface HttpOptions {\n    /**\n     * If `true`, includes the `extensions` field in operations sent to your\n     * GraphQL endpoint.\n     *\n     * @defaultValue true\n     */\n    includeExtensions?: boolean;\n\n    /**\n     * If `false`, the GraphQL query string is not included in the request. Set\n     * this option if you're sending a request that uses a [persisted query](https://www.apollographql.com/docs/react/api/link/persisted-queries/).\n     *\n     * @defaultValue true\n     */\n    includeQuery?: boolean;\n\n    /**\n     * If set to true, header names won't be automatically normalized to\n     * lowercase. This allows for non-http-spec-compliant servers that might\n     * expect capitalized header names.\n     *\n     * @defaultValue false\n     */\n    preserveHeaderCase?: boolean;\n\n    /**\n     * A list of additional `accept` headers to include in the request,\n     * as defined in\n     * https://datatracker.ietf.org/doc/html/rfc7231#section-5.3.2\n     *\n     * @example\n     * ```javascript\n     * [\"application/custom+json;q=1.0\"]\n     * ```\n     */\n    accept?: string[];\n  }\n\n  export interface Options {\n    /**\n     * The URI to use when fetching operations.\n     *\n     * Defaults to '/graphql'.\n     */\n    uri?: string | UriFunction;\n\n    /**\n     * Passes the extensions field to your graphql server.\n     *\n     * Defaults to true.\n     */\n    includeExtensions?: boolean;\n\n    /**\n     * A `fetch`-compatible API to use when making requests.\n     */\n    fetch?: typeof fetch;\n\n    /**\n     * An object representing values to be sent as headers on the request.\n     */\n    headers?: Record<string, string>;\n\n    /**\n     * If set to true, header names won't be automatically normalized to\n     * lowercase. This allows for non-http-spec-compliant servers that might\n     * expect capitalized header names.\n     */\n    preserveHeaderCase?: boolean;\n\n    /**\n     * The credentials policy you want to use for the fetch call.\n     */\n    credentials?: string;\n\n    /**\n     * Any overrides of the fetch options argument to pass to the fetch call.\n     */\n    fetchOptions?: any;\n\n    /**\n     * If set to true, use the HTTP GET method for query operations. Mutations\n     * will still use the method specified in fetchOptions.method (which defaults\n     * to POST).\n     */\n    useGETForQueries?: boolean;\n\n    /**\n     * If set to true, the default behavior of stripping unused variables\n     * from the request will be disabled.\n     *\n     * Unused variables are likely to trigger server-side validation errors,\n     * per https://spec.graphql.org/draft/#sec-All-Variables-Used, but this\n     * includeUnusedVariables option can be useful if your server deviates\n     * from the GraphQL specification by not strictly enforcing that rule.\n     */\n    includeUnusedVariables?: boolean;\n    /**\n     * A function to substitute for the default query print function. Can be\n     * used to apply changes to the results of the print function.\n     */\n    print?: Printer;\n  }\n\n  interface Body {\n    query?: string;\n    operationName?: string;\n    variables?: Record<string, any>;\n    extensions?: Record<string, any>;\n  }\n\n  type Printer = (node: ASTNode, originalPrint: typeof print) => string;\n  type UriFunction = (operation: Operation) => string;\n}\n\nexport class HttpLink extends ApolloLink {\n  constructor(options: HttpLink.Options & ClientAwarenessLink.Options = {}) {\n    const { left, right, request } = ApolloLink.concat(\n      new ClientAwarenessLink(options),\n      new BaseHttpLink(options)\n    );\n    super(request);\n    Object.assign(this, { left, right });\n  }\n}\n\n/**\n * @deprecated\n * Use `HttpLink` from `@apollo/client/link/http` instead.\n */\nexport const createHttpLink = (\n  linkOptions: HttpLink.Options & ClientAwarenessLink.Options = {}\n) => new HttpLink(linkOptions);\n"]}
+{"version":3,"file":"HttpLink.js","sourceRoot":"","sources":["../../../src/link/http/HttpLink.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,mBAAmB,EAAE,MAAM,sCAAsC,CAAC;AAG3E,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAsKjD,MAAM,OAAO,QAAS,SAAQ,UAAU;IACtC,YAAY,UAA0D,EAAE;QACtE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,MAAM,CAChD,IAAI,mBAAmB,CAAC,OAAO,CAAC,EAChC,IAAI,YAAY,CAAC,OAAO,CAAC,CAC1B,CAAC;QACF,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IACvC,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,cAA8D,EAAE,EAChE,EAAE,CAAC,IAAI,QAAQ,CAAC,WAAW,CAAC,CAAC","sourcesContent":["import type { ASTNode } from \"graphql\";\n\nimport type { Operation } from \"@apollo/client/link\";\nimport { ApolloLink } from \"@apollo/client/link\";\nimport { ClientAwarenessLink } from \"@apollo/client/link/client-awareness\";\nimport type { print } from \"@apollo/client/utilities\";\n\nimport { BaseHttpLink } from \"./BaseHttpLink.js\";\n\nexport declare namespace HttpLink {\n  /**\n   * Options passed to `HttpLink` through request context.\n   */\n  interface ContextOptions {\n    /**\n     * The URL of the GraphQL endpoint to send requests to. Can also be a\n     * function that accepts an `Operation` object and returns the string URL to\n     * use for that operation.\n     */\n    uri?: string | UriFunction;\n\n    /**\n     * An object representing headers to include in the HTTP request, such as\n     * `{Authorization: 'Bearer abc123'}`.\n     */\n    headers?: Record<string, string>;\n\n    /**\n     * The credentials policy to use for this fetch call. Can be `omit`, `include`,\n     * or `same-origin`.\n     */\n    credentials?: RequestCredentials;\n\n    /**\n     * An object containing options to use for this call to `fetch`. If a\n     * particular option is not included in this object, the default value of\n     * that option is used.\n     *\n     * Note that if you set `fetchOptions.method` to `GET`, `HttpLink` follows\n     * [standard GraphQL HTTP GET encoding](http://graphql.org/learn/serving-over-http/#get-request).\n     */\n    fetchOptions?: RequestInit;\n\n    /**\n     * An object that configures advanced `HttpLink` functionality, such as\n     * support for persisted queries.\n     */\n    http?: HttpLink.HttpOptions;\n  }\n\n  /**\n   * Options passed to `HttpLink` through the `http` constructor option\n   * or the `http` property of a request context.\n   */\n  export interface HttpOptions {\n    /**\n     * If `true`, includes the `extensions` field in operations sent to your\n     * GraphQL endpoint.\n     *\n     * @defaultValue true\n     */\n    includeExtensions?: boolean;\n\n    /**\n     * If `false`, the GraphQL query string is not included in the request. Set\n     * this option if you're sending a request that uses a [persisted query](https://www.apollographql.com/docs/react/api/link/persisted-queries/).\n     *\n     * @defaultValue true\n     */\n    includeQuery?: boolean;\n\n    /**\n     * If set to true, header names won't be automatically normalized to\n     * lowercase. This allows for non-http-spec-compliant servers that might\n     * expect capitalized header names.\n     *\n     * @defaultValue false\n     */\n    preserveHeaderCase?: boolean;\n\n    /**\n     * A list of additional `accept` headers to include in the request,\n     * as defined in\n     * https://datatracker.ietf.org/doc/html/rfc7231#section-5.3.2\n     *\n     * @example\n     * ```javascript\n     * [\"application/custom+json;q=1.0\"]\n     * ```\n     */\n    accept?: string[];\n  }\n\n  /**\n   * Options for the `HttpLink` constructor.\n   */\n  export interface Options {\n    /**\n     * The URI to use when fetching operations.\n     *\n     * Defaults to '/graphql'.\n     */\n    uri?: string | UriFunction;\n\n    /**\n     * Passes the extensions field to your graphql server.\n     *\n     * Defaults to true.\n     */\n    includeExtensions?: boolean;\n\n    /**\n     * A `fetch`-compatible API to use when making requests.\n     */\n    fetch?: typeof fetch;\n\n    /**\n     * An object representing values to be sent as headers on the request.\n     */\n    headers?: Record<string, string>;\n\n    /**\n     * If set to true, header names won't be automatically normalized to\n     * lowercase. This allows for non-http-spec-compliant servers that might\n     * expect capitalized header names.\n     */\n    preserveHeaderCase?: boolean;\n\n    /**\n     * The credentials policy you want to use for the fetch call.\n     */\n    credentials?: string;\n\n    /**\n     * Any overrides of the fetch options argument to pass to the fetch call.\n     */\n    fetchOptions?: any;\n\n    /**\n     * If set to true, use the HTTP GET method for query operations. Mutations\n     * will still use the method specified in fetchOptions.method (which defaults\n     * to POST).\n     */\n    useGETForQueries?: boolean;\n\n    /**\n     * If set to true, the default behavior of stripping unused variables\n     * from the request will be disabled.\n     *\n     * Unused variables are likely to trigger server-side validation errors,\n     * per https://spec.graphql.org/draft/#sec-All-Variables-Used, but this\n     * includeUnusedVariables option can be useful if your server deviates\n     * from the GraphQL specification by not strictly enforcing that rule.\n     */\n    includeUnusedVariables?: boolean;\n    /**\n     * A function to substitute for the default query print function. Can be\n     * used to apply changes to the results of the print function.\n     */\n    print?: Printer;\n  }\n\n  interface Body {\n    query?: string;\n    operationName?: string;\n    variables?: Record<string, any>;\n    extensions?: Record<string, any>;\n  }\n\n  type Printer = (node: ASTNode, originalPrint: typeof print) => string;\n  type UriFunction = (operation: Operation) => string;\n}\n\nexport class HttpLink extends ApolloLink {\n  constructor(options: HttpLink.Options & ClientAwarenessLink.Options = {}) {\n    const { left, right, request } = ApolloLink.concat(\n      new ClientAwarenessLink(options),\n      new BaseHttpLink(options)\n    );\n    super(request);\n    Object.assign(this, { left, right });\n  }\n}\n\n/**\n * @deprecated\n * Use `HttpLink` from `@apollo/client/link/http` instead.\n */\nexport const createHttpLink = (\n  linkOptions: HttpLink.Options & ClientAwarenessLink.Options = {}\n) => new HttpLink(linkOptions);\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apollo/client",
-  "version": "4.0.0-rc.4",
+  "version": "4.0.0-rc.5",
   "description": "A fully-featured caching GraphQL client.",
   "private": false,
   "keywords": [

package/react/hooks/useBackgroundQuery.d.ts

@@ -113,6 +113,10 @@ export declare namespace useBackgroundQuery {
         /**
         * Update the variables of this observable query, and fetch the new results. This method should be preferred over `setVariables` in most use cases.
         * 
+        * Returns a `ResultPromise` with an additional `.retain()` method. Calling `.retain()` keeps the network operation running even if the `ObservableQuery` no longer requires the result.
+        * 
+        * Note: `refetch()` guarantees that a value will be emitted from the observable, even if the result is deep equal to the previous value.
+        * 
         * @param variables - The new set of variables. If there are missing variables, the previous values of those variables will be used.
         */
         refetch: RefetchFunction<TData, TVariables>;

package/react/hooks/useFragment.js

@@ -38,7 +38,7 @@ function useFragment_(options) {
             ...stableOptions,
             returnPartialData: true,
             id: from,
-            query: cache["getFragmentDoc"](fragment, fragmentName),
+            query: cache["getFragmentDoc"](client["transform"](fragment), fragmentName),
             optimistic,
         });
         return {
@@ -62,17 +62,12 @@ function useFragment_(options) {
             null
             : client.watchFragment(stableOptions).subscribe({
                 next: (result) => {
-                    // Since `next` is called async by zen-observable, we want to avoid
-                    // unnecessarily rerendering this hook for the initial result
+                    // Avoid unnecessarily rerendering this hook for the initial result
                     // emitted from watchFragment which should be equal to
                     // `diff.result`.
-                    const resultWithDataState = {
-                        ...result,
-                        dataState: result.complete ? "complete" : "partial",
-                    };
-                    if (equal(resultWithDataState, diff.result))
+                    if (equal(result, diff.result))
                         return;
-                    diff.result = resultWithDataState;
+                    diff.result = result;
                     // If we get another update before we've re-rendered, bail out of
                     // the update and try again. This ensures that the relative timing
                     // between useQuery and useFragment stays roughly the same as

package/react/hooks/useFragment.js.map

@@ -1 +1 @@
-{"version":3,"file":"useFragment.js","sourceRoot":"","sources":["../../../src/react/hooks/useFragment.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,eAAe,CAAC;AAClC,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAkB/B,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAgEjE,MAAM,UAAU,WAAW,CAGzB,OAA+C;IAC/C,aAAa,CAAC;IACd,OAAO,QAAQ,CACb,aAAa;IACb,yDAAyD;IACzD,YAAY,EACZ,eAAe,CAAC,OAAO,CAAC,MAAM,CAAC,CAChC,CAAC,OAAO,CAAC,CAAC;AACb,CAAC;AAED,SAAS,YAAY,CACnB,OAA+C;IAE/C,MAAM,MAAM,GAAG,eAAe,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC/C,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC;IACzB,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC;IAElC,6EAA6E;IAC7E,kEAAkE;IAClE,0EAA0E;IAC1E,8EAA8E;IAC9E,MAAM,EAAE,GAAG,KAAK,CAAC,OAAO,CACtB,GAAG,EAAE,CACH,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI;QAC/B,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI;YACtB,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,EACxB,CAAC,KAAK,EAAE,IAAI,CAAC,CACd,CAAC;IAEF,MAAM,aAAa,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,EAAG,EAAE,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;IAE9E,qDAAqD;IACrD,gEAAgE;IAChE,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE;QAC9B,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,UAAU,GAAG,IAAI,EAAE,GAAG,aAAa,CAAC;QAE1E,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YAClB,OAAO;gBACL,MAAM,EAAE,YAAY,CAAC;oBACnB,MAAM,EAAE,EAAE;oBACV,QAAQ,EAAE,KAAK;iBACW,CAAC;aAC9B,CAAC;QACJ,CAAC;QAED,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC;QACzB,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAoB;YACzC,GAAG,aAAa;YAChB,iBAAiB,EAAE,IAAI;YACvB,EAAE,EAAE,IAAI;YACR,KAAK,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAAC,QAAQ,EAAE,YAAY,CAAC;YACtD,UAAU;SACX,CAAC,CAAC;QAEH,OAAO;YACL,MAAM,EAAE,YAAY,CAAQ;gBAC1B,GAAG,IAAI;gBACP,MAAM,EAAE,MAAM,CAAC,cAAc,CAAC,CAAC,YAAY,CAAC;oBAC1C,QAAQ;oBACR,YAAY;oBACZ,sEAAsE;oBACtE,qBAAqB;oBACrB,IAAI,EAAE,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM;iBAC9C,CAAQ;aACV,CAAC;SACH,CAAC;IACJ,CAAC,EAAE,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC;IAE5B,kDAAkD;IAClD,MAAM,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;IAEjE,OAAO,oBAAoB,CACzB,KAAK,CAAC,WAAW,CACf,CAAC,WAAW,EAAE,EAAE;QACd,IAAI,WAAW,GAAG,CAAC,CAAC;QAEpB,MAAM,YAAY,GAChB,aAAa,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;YAC3B,IAAI;YACN,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC,SAAS,CAAC;gBAC5C,IAAI,EAAE,CAAC,MAAM,EAAE,EAAE;oBACf,mEAAmE;oBACnE,6DAA6D;oBAC7D,sDAAsD;oBACtD,iBAAiB;oBACjB,MAAM,mBAAmB,GAAG;wBAC1B,GAAG,MAAM;wBACT,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS;qBACvB,CAAC;oBAC/B,IAAI,KAAK,CAAC,mBAAmB,EAAE,IAAI,CAAC,MAAM,CAAC;wBAAE,OAAO;oBACpD,IAAI,CAAC,MAAM,GAAG,mBAAmB,CAAC;oBAClC,iEAAiE;oBACjE,kEAAkE;oBAClE,6DAA6D;oBAC7D,qEAAqE;oBACrE,YAAY,CAAC,WAAW,CAAC,CAAC;oBAC1B,WAAW,GAAG,UAAU,CAAC,WAAW,CAAQ,CAAC;gBAC/C,CAAC;aACF,CAAC,CAAC;QACP,OAAO,GAAG,EAAE;YACV,YAAY,EAAE,WAAW,EAAE,CAAC;YAC5B,YAAY,CAAC,WAAW,CAAC,CAAC;QAC5B,CAAC,CAAC;IACJ,CAAC,EACD,CAAC,MAAM,EAAE,aAAa,EAAE,IAAI,CAAC,CAC9B,EACD,WAAW,EACX,WAAW,CACZ,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CACnB,IAA6B;IAE7B,MAAM,MAAM,GAAG;QACb,IAAI,EAAE,IAAI,CAAC,MAAM;QACjB,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ;QACzB,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS;KACrB,CAAC,CAAC,uDAAuD;IAEvF,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;QACjB,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;IACxC,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC","sourcesContent":["import equal from \"@wry/equality\";\nimport * as React from \"react\";\n\nimport type {\n  ApolloClient,\n  DocumentNode,\n  GetDataState,\n  OperationVariables,\n  TypedDocumentNode,\n} from \"@apollo/client\";\nimport type {\n  Cache,\n  MissingTree,\n  Reference,\n  StoreObject,\n} from \"@apollo/client/cache\";\nimport type { FragmentType, MaybeMasked } from \"@apollo/client/masking\";\nimport type { NoInfer } from \"@apollo/client/utilities/internal\";\n\nimport { useDeepMemo, wrapHook } from \"./internal/index.js\";\nimport { useApolloClient } from \"./useApolloClient.js\";\nimport { useSyncExternalStore } from \"./useSyncExternalStore.js\";\n\nexport declare namespace useFragment {\n  export interface Options<TData, TVariables> {\n    /**\n     * A GraphQL document created using the `gql` template string tag from\n     * `graphql-tag` with one or more fragments which will be used to determine\n     * the shape of data to read. If you provide more than one fragment in this\n     * document then you must also specify `fragmentName` to select a single.\n     */\n    fragment: DocumentNode | TypedDocumentNode<TData, TVariables>;\n\n    /**\n     * The name of the fragment in your GraphQL document to be used. If you do\n     * not provide a `fragmentName` and there is only one fragment in your\n     * `fragment` document then that fragment will be used.\n     */\n    fragmentName?: string;\n\n    /**\n     * Any variables that the GraphQL query may depend on.\n     */\n    variables?: NoInfer<TVariables>;\n\n    from:\n      | StoreObject\n      | Reference\n      | FragmentType<NoInfer<TData>>\n      | string\n      | null;\n\n    /**\n     * Whether to read from optimistic or non-optimistic cache data. If\n     * this named option is provided, the optimistic parameter of the\n     * readQuery method can be omitted.\n     *\n     * @defaultValue true\n     */\n    optimistic?: boolean;\n\n    /**\n     * The instance of `ApolloClient` to use to look up the fragment.\n     *\n     * By default, the instance that's passed down via context is used, but you\n     * can provide a different instance here.\n     *\n     * @docGroup 1. Operation options\n     */\n    client?: ApolloClient;\n  }\n\n  // TODO: Update this to return `null` when there is no data returned from the\n  // fragment.\n  export type Result<TData> =\n    | ({\n        complete: true;\n        missing?: never;\n      } & GetDataState<MaybeMasked<TData>, \"complete\">)\n    | ({\n        complete: false;\n        missing?: MissingTree;\n      } & GetDataState<MaybeMasked<TData>, \"partial\">);\n}\n\nexport function useFragment<\n  TData = unknown,\n  TVariables extends OperationVariables = OperationVariables,\n>(options: useFragment.Options<TData, TVariables>): useFragment.Result<TData> {\n  \"use no memo\";\n  return wrapHook(\n    \"useFragment\",\n    // eslint-disable-next-line react-compiler/react-compiler\n    useFragment_,\n    useApolloClient(options.client)\n  )(options);\n}\n\nfunction useFragment_<TData, TVariables extends OperationVariables>(\n  options: useFragment.Options<TData, TVariables>\n): useFragment.Result<TData> {\n  const client = useApolloClient(options.client);\n  const { cache } = client;\n  const { from, ...rest } = options;\n\n  // We calculate the cache id seperately from `stableOptions` because we don't\n  // want changes to non key fields in the `from` property to affect\n  // `stableOptions` and retrigger our subscription. If the cache identifier\n  // stays the same between renders, we want to reuse the existing subscription.\n  const id = React.useMemo(\n    () =>\n      typeof from === \"string\" ? from\n      : from === null ? null\n      : cache.identify(from),\n    [cache, from]\n  );\n\n  const stableOptions = useDeepMemo(() => ({ ...rest, from: id! }), [rest, id]);\n\n  // Since .next is async, we need to make sure that we\n  // get the correct diff on the next render given new diffOptions\n  const diff = React.useMemo(() => {\n    const { fragment, fragmentName, from, optimistic = true } = stableOptions;\n\n    if (from === null) {\n      return {\n        result: diffToResult({\n          result: {},\n          complete: false,\n        } as Cache.DiffResult<TData>),\n      };\n    }\n\n    const { cache } = client;\n    const diff = cache.diff<TData, TVariables>({\n      ...stableOptions,\n      returnPartialData: true,\n      id: from,\n      query: cache[\"getFragmentDoc\"](fragment, fragmentName),\n      optimistic,\n    });\n\n    return {\n      result: diffToResult<TData>({\n        ...diff,\n        result: client[\"queryManager\"].maskFragment({\n          fragment,\n          fragmentName,\n          // TODO: Revert to `diff.result` once `useFragment` supports `null` as\n          // valid return value\n          data: diff.result === null ? {} : diff.result,\n        }) as any,\n      }),\n    };\n  }, [client, stableOptions]);\n\n  // Used for both getSnapshot and getServerSnapshot\n  const getSnapshot = React.useCallback(() => diff.result, [diff]);\n\n  return useSyncExternalStore(\n    React.useCallback(\n      (forceUpdate) => {\n        let lastTimeout = 0;\n\n        const subscription =\n          stableOptions.from === null ?\n            null\n          : client.watchFragment(stableOptions).subscribe({\n              next: (result) => {\n                // Since `next` is called async by zen-observable, we want to avoid\n                // unnecessarily rerendering this hook for the initial result\n                // emitted from watchFragment which should be equal to\n                // `diff.result`.\n                const resultWithDataState = {\n                  ...result,\n                  dataState: result.complete ? \"complete\" : \"partial\",\n                } as useFragment.Result<TData>;\n                if (equal(resultWithDataState, diff.result)) return;\n                diff.result = resultWithDataState;\n                // If we get another update before we've re-rendered, bail out of\n                // the update and try again. This ensures that the relative timing\n                // between useQuery and useFragment stays roughly the same as\n                // fixed in https://github.com/apollographql/apollo-client/pull/11083\n                clearTimeout(lastTimeout);\n                lastTimeout = setTimeout(forceUpdate) as any;\n              },\n            });\n        return () => {\n          subscription?.unsubscribe();\n          clearTimeout(lastTimeout);\n        };\n      },\n      [client, stableOptions, diff]\n    ),\n    getSnapshot,\n    getSnapshot\n  );\n}\n\nfunction diffToResult<TData>(\n  diff: Cache.DiffResult<TData>\n): useFragment.Result<TData> {\n  const result = {\n    data: diff.result,\n    complete: !!diff.complete,\n    dataState: diff.complete ? \"complete\" : \"partial\",\n  } as useFragment.Result<TData>; // TODO: Remove assertion once useFragment returns null\n\n  if (diff.missing) {\n    result.missing = diff.missing.missing;\n  }\n\n  return result;\n}\n"]}
+{"version":3,"file":"useFragment.js","sourceRoot":"","sources":["../../../src/react/hooks/useFragment.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,eAAe,CAAC;AAClC,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAkB/B,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAgEjE,MAAM,UAAU,WAAW,CAGzB,OAA+C;IAC/C,aAAa,CAAC;IACd,OAAO,QAAQ,CACb,aAAa;IACb,yDAAyD;IACzD,YAAY,EACZ,eAAe,CAAC,OAAO,CAAC,MAAM,CAAC,CAChC,CAAC,OAAO,CAAC,CAAC;AACb,CAAC;AAED,SAAS,YAAY,CACnB,OAA+C;IAE/C,MAAM,MAAM,GAAG,eAAe,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC/C,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC;IACzB,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC;IAElC,6EAA6E;IAC7E,kEAAkE;IAClE,0EAA0E;IAC1E,8EAA8E;IAC9E,MAAM,EAAE,GAAG,KAAK,CAAC,OAAO,CACtB,GAAG,EAAE,CACH,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI;QAC/B,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI;YACtB,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,EACxB,CAAC,KAAK,EAAE,IAAI,CAAC,CACd,CAAC;IAEF,MAAM,aAAa,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,EAAG,EAAE,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;IAE9E,qDAAqD;IACrD,gEAAgE;IAChE,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE;QAC9B,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,EAAE,UAAU,GAAG,IAAI,EAAE,GAAG,aAAa,CAAC;QAE1E,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YAClB,OAAO;gBACL,MAAM,EAAE,YAAY,CAAC;oBACnB,MAAM,EAAE,EAAE;oBACV,QAAQ,EAAE,KAAK;iBACW,CAAC;aAC9B,CAAC;QACJ,CAAC;QAED,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC;QACzB,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAoB;YACzC,GAAG,aAAa;YAChB,iBAAiB,EAAE,IAAI;YACvB,EAAE,EAAE,IAAI;YACR,KAAK,EAAE,KAAK,CAAC,gBAAgB,CAAC,CAC5B,MAAM,CAAC,WAAW,CAAC,CAAC,QAAQ,CAAC,EAC7B,YAAY,CACb;YACD,UAAU;SACX,CAAC,CAAC;QAEH,OAAO;YACL,MAAM,EAAE,YAAY,CAAQ;gBAC1B,GAAG,IAAI;gBACP,MAAM,EAAE,MAAM,CAAC,cAAc,CAAC,CAAC,YAAY,CAAC;oBAC1C,QAAQ;oBACR,YAAY;oBACZ,sEAAsE;oBACtE,qBAAqB;oBACrB,IAAI,EAAE,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM;iBAC9C,CAAQ;aACV,CAAC;SACH,CAAC;IACJ,CAAC,EAAE,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC;IAE5B,kDAAkD;IAClD,MAAM,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;IAEjE,OAAO,oBAAoB,CACzB,KAAK,CAAC,WAAW,CACf,CAAC,WAAW,EAAE,EAAE;QACd,IAAI,WAAW,GAAG,CAAC,CAAC;QAEpB,MAAM,YAAY,GAChB,aAAa,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;YAC3B,IAAI;YACN,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC,SAAS,CAAC;gBAC5C,IAAI,EAAE,CAAC,MAAM,EAAE,EAAE;oBACf,mEAAmE;oBACnE,sDAAsD;oBACtD,iBAAiB;oBACjB,IAAI,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC;wBAAE,OAAO;oBACvC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;oBACrB,iEAAiE;oBACjE,kEAAkE;oBAClE,6DAA6D;oBAC7D,qEAAqE;oBACrE,YAAY,CAAC,WAAW,CAAC,CAAC;oBAC1B,WAAW,GAAG,UAAU,CAAC,WAAW,CAAQ,CAAC;gBAC/C,CAAC;aACF,CAAC,CAAC;QACP,OAAO,GAAG,EAAE;YACV,YAAY,EAAE,WAAW,EAAE,CAAC;YAC5B,YAAY,CAAC,WAAW,CAAC,CAAC;QAC5B,CAAC,CAAC;IACJ,CAAC,EACD,CAAC,MAAM,EAAE,aAAa,EAAE,IAAI,CAAC,CAC9B,EACD,WAAW,EACX,WAAW,CACZ,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CACnB,IAA6B;IAE7B,MAAM,MAAM,GAAG;QACb,IAAI,EAAE,IAAI,CAAC,MAAM;QACjB,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ;QACzB,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS;KACrB,CAAC,CAAC,uDAAuD;IAEvF,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;QACjB,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;IACxC,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC","sourcesContent":["import equal from \"@wry/equality\";\nimport * as React from \"react\";\n\nimport type {\n  ApolloClient,\n  DocumentNode,\n  GetDataState,\n  OperationVariables,\n  TypedDocumentNode,\n} from \"@apollo/client\";\nimport type {\n  Cache,\n  MissingTree,\n  Reference,\n  StoreObject,\n} from \"@apollo/client/cache\";\nimport type { FragmentType, MaybeMasked } from \"@apollo/client/masking\";\nimport type { NoInfer } from \"@apollo/client/utilities/internal\";\n\nimport { useDeepMemo, wrapHook } from \"./internal/index.js\";\nimport { useApolloClient } from \"./useApolloClient.js\";\nimport { useSyncExternalStore } from \"./useSyncExternalStore.js\";\n\nexport declare namespace useFragment {\n  export interface Options<TData, TVariables> {\n    /**\n     * A GraphQL document created using the `gql` template string tag from\n     * `graphql-tag` with one or more fragments which will be used to determine\n     * the shape of data to read. If you provide more than one fragment in this\n     * document then you must also specify `fragmentName` to select a single.\n     */\n    fragment: DocumentNode | TypedDocumentNode<TData, TVariables>;\n\n    /**\n     * The name of the fragment in your GraphQL document to be used. If you do\n     * not provide a `fragmentName` and there is only one fragment in your\n     * `fragment` document then that fragment will be used.\n     */\n    fragmentName?: string;\n\n    /**\n     * Any variables that the GraphQL query may depend on.\n     */\n    variables?: NoInfer<TVariables>;\n\n    from:\n      | StoreObject\n      | Reference\n      | FragmentType<NoInfer<TData>>\n      | string\n      | null;\n\n    /**\n     * Whether to read from optimistic or non-optimistic cache data. If\n     * this named option is provided, the optimistic parameter of the\n     * readQuery method can be omitted.\n     *\n     * @defaultValue true\n     */\n    optimistic?: boolean;\n\n    /**\n     * The instance of `ApolloClient` to use to look up the fragment.\n     *\n     * By default, the instance that's passed down via context is used, but you\n     * can provide a different instance here.\n     *\n     * @docGroup 1. Operation options\n     */\n    client?: ApolloClient;\n  }\n\n  // TODO: Update this to return `null` when there is no data returned from the\n  // fragment.\n  export type Result<TData> =\n    | ({\n        complete: true;\n        missing?: never;\n      } & GetDataState<MaybeMasked<TData>, \"complete\">)\n    | ({\n        complete: false;\n        missing?: MissingTree;\n      } & GetDataState<MaybeMasked<TData>, \"partial\">);\n}\n\nexport function useFragment<\n  TData = unknown,\n  TVariables extends OperationVariables = OperationVariables,\n>(options: useFragment.Options<TData, TVariables>): useFragment.Result<TData> {\n  \"use no memo\";\n  return wrapHook(\n    \"useFragment\",\n    // eslint-disable-next-line react-compiler/react-compiler\n    useFragment_,\n    useApolloClient(options.client)\n  )(options);\n}\n\nfunction useFragment_<TData, TVariables extends OperationVariables>(\n  options: useFragment.Options<TData, TVariables>\n): useFragment.Result<TData> {\n  const client = useApolloClient(options.client);\n  const { cache } = client;\n  const { from, ...rest } = options;\n\n  // We calculate the cache id seperately from `stableOptions` because we don't\n  // want changes to non key fields in the `from` property to affect\n  // `stableOptions` and retrigger our subscription. If the cache identifier\n  // stays the same between renders, we want to reuse the existing subscription.\n  const id = React.useMemo(\n    () =>\n      typeof from === \"string\" ? from\n      : from === null ? null\n      : cache.identify(from),\n    [cache, from]\n  );\n\n  const stableOptions = useDeepMemo(() => ({ ...rest, from: id! }), [rest, id]);\n\n  // Since .next is async, we need to make sure that we\n  // get the correct diff on the next render given new diffOptions\n  const diff = React.useMemo(() => {\n    const { fragment, fragmentName, from, optimistic = true } = stableOptions;\n\n    if (from === null) {\n      return {\n        result: diffToResult({\n          result: {},\n          complete: false,\n        } as Cache.DiffResult<TData>),\n      };\n    }\n\n    const { cache } = client;\n    const diff = cache.diff<TData, TVariables>({\n      ...stableOptions,\n      returnPartialData: true,\n      id: from,\n      query: cache[\"getFragmentDoc\"](\n        client[\"transform\"](fragment),\n        fragmentName\n      ),\n      optimistic,\n    });\n\n    return {\n      result: diffToResult<TData>({\n        ...diff,\n        result: client[\"queryManager\"].maskFragment({\n          fragment,\n          fragmentName,\n          // TODO: Revert to `diff.result` once `useFragment` supports `null` as\n          // valid return value\n          data: diff.result === null ? {} : diff.result,\n        }) as any,\n      }),\n    };\n  }, [client, stableOptions]);\n\n  // Used for both getSnapshot and getServerSnapshot\n  const getSnapshot = React.useCallback(() => diff.result, [diff]);\n\n  return useSyncExternalStore(\n    React.useCallback(\n      (forceUpdate) => {\n        let lastTimeout = 0;\n\n        const subscription =\n          stableOptions.from === null ?\n            null\n          : client.watchFragment(stableOptions).subscribe({\n              next: (result) => {\n                // Avoid unnecessarily rerendering this hook for the initial result\n                // emitted from watchFragment which should be equal to\n                // `diff.result`.\n                if (equal(result, diff.result)) return;\n                diff.result = result;\n                // If we get another update before we've re-rendered, bail out of\n                // the update and try again. This ensures that the relative timing\n                // between useQuery and useFragment stays roughly the same as\n                // fixed in https://github.com/apollographql/apollo-client/pull/11083\n                clearTimeout(lastTimeout);\n                lastTimeout = setTimeout(forceUpdate) as any;\n              },\n            });\n        return () => {\n          subscription?.unsubscribe();\n          clearTimeout(lastTimeout);\n        };\n      },\n      [client, stableOptions, diff]\n    ),\n    getSnapshot,\n    getSnapshot\n  );\n}\n\nfunction diffToResult<TData>(\n  diff: Cache.DiffResult<TData>\n): useFragment.Result<TData> {\n  const result = {\n    data: diff.result,\n    complete: !!diff.complete,\n    dataState: diff.complete ? \"complete\" : \"partial\",\n  } as useFragment.Result<TData>; // TODO: Remove assertion once useFragment returns null\n\n  if (diff.missing) {\n    result.missing = diff.missing.missing;\n  }\n\n  return result;\n}\n"]}

package/react/hooks/useLazyQuery.d.ts

@@ -180,7 +180,7 @@ export declare namespace useLazyQuery {
         */
         previousData?: MaybeMasked<TData>;
         /**
-        * If the query produces one or more errors, this object contains either an array of `graphQLErrors` or a single `networkError`. Otherwise, this value is `undefined`.
+        * A single ErrorLike object describing the error that occured during the latest query execution.
         * 
         * For more information, see [Handling operation errors](https://www.apollographql.com/docs/react/data/error-handling/).
         * 
@@ -249,6 +249,10 @@ export declare namespace useLazyQuery {
         data: undefined;
         /**
         * Describes the completeness of `data`. - `empty`: No data could be fulfilled from the cache or the result is incomplete. `data` is `undefined`. - `partial`: Some data could be fulfilled from the cache but `data` is incomplete. This is only possible when `returnPartialData` is `true`. - `streaming`: `data` is incomplete as a result of a deferred query and the result is still streaming in. - `complete`: `data` is a fully satisfied query result fulfilled either from the cache or network.
+        * 
+        * @docGroup
+        * 
+        * 1. Operation data
         */
         dataState: "empty";
     });