@apollo/client 4.0.0-rc.2 → 4.0.0-rc.3

package/react/hooks-compiled/internal/useRenderGuard.js

@@ -0,0 +1,42 @@
+import * as React from "react";
+let Ctx;
+function noop() { }
+export function useRenderGuard() {
+    if (!Ctx) {
+        // we want the intialization to be lazy because `createContext` would error on import in a RSC
+        Ctx = React.createContext(null);
+    }
+    return React.useCallback(
+    /**
+     * @returns true if the hook was called during render
+     */ () => {
+        const orig = console.error;
+        try {
+            console.error = noop;
+            /**
+             * `useContext` can be called conditionally during render, so this is safe.
+             * (Also, during render we would want to throw as a reaction to this anyways, so it
+             * wouldn't even matter if we got the order of hooks mixed up...)
+             *
+             * They cannot however be called outside of Render, and that's what we're testing here.
+             *
+             * Different versions of React have different behaviour on an invalid hook call:
+             *
+             * React 16.8 - 17: throws an error
+             * https://github.com/facebook/react/blob/2b93d686e359c7afa299e2ec5cf63160a32a1155/packages/react/src/ReactHooks.js#L18-L26
+             *
+             * React 18 & 19: `console.error` in development, then `resolveDispatcher` returns `null` and a member access on `null` throws.
+             * https://github.com/facebook/react/blob/58e8304483ebfadd02a295339b5e9a989ac98c6e/packages/react/src/ReactHooks.js#L28-L35
+             */
+            React["useContext" /* hide this from the linter */](Ctx);
+            return true;
+        }
+        catch (e) {
+            return false;
+        }
+        finally {
+            console.error = orig;
+        }
+    }, []);
+}
+//# sourceMappingURL=useRenderGuard.js.map

package/react/hooks-compiled/internal/useRenderGuard.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useRenderGuard.js","sourceRoot":"","sources":["../../../../src/react/hooks/internal/useRenderGuard.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,IAAI,GAAwB,CAAC;AAE7B,SAAS,IAAI,KAAI,CAAC;AAClB,MAAM,UAAU,cAAc;IAC5B,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,8FAA8F;QAC9F,GAAG,GAAG,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IAClC,CAAC;IAED,OAAO,KAAK,CAAC,WAAW;IACtB;;OAEG,CAAC,GAAG,EAAE;QACP,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC;QAC3B,IAAI,CAAC;YACH,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;YAErB;;;;;;;;;;;;;;eAcG;YACH,KAAK,CAAC,YAAY,CAAC,+BAA+B,CAAC,CAAC,GAAG,CAAC,CAAC;YACzD,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,KAAK,CAAC;QACf,CAAC;gBAAS,CAAC;YACT,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;QACvB,CAAC;IACH,CAAC,EACD,EAAE,CACH,CAAC;AACJ,CAAC","sourcesContent":["import * as React from \"react\";\n\nlet Ctx: React.Context<null>;\n\nfunction noop() {}\nexport function useRenderGuard() {\n  if (!Ctx) {\n    // we want the intialization to be lazy because `createContext` would error on import in a RSC\n    Ctx = React.createContext(null);\n  }\n\n  return React.useCallback(\n    /**\n     * @returns true if the hook was called during render\n     */ () => {\n      const orig = console.error;\n      try {\n        console.error = noop;\n\n        /**\n         * `useContext` can be called conditionally during render, so this is safe.\n         * (Also, during render we would want to throw as a reaction to this anyways, so it\n         * wouldn't even matter if we got the order of hooks mixed up...)\n         *\n         * They cannot however be called outside of Render, and that's what we're testing here.\n         *\n         * Different versions of React have different behaviour on an invalid hook call:\n         *\n         * React 16.8 - 17: throws an error\n         * https://github.com/facebook/react/blob/2b93d686e359c7afa299e2ec5cf63160a32a1155/packages/react/src/ReactHooks.js#L18-L26\n         *\n         * React 18 & 19: `console.error` in development, then `resolveDispatcher` returns `null` and a member access on `null` throws.\n         * https://github.com/facebook/react/blob/58e8304483ebfadd02a295339b5e9a989ac98c6e/packages/react/src/ReactHooks.js#L28-L35\n         */\n        React[\"useContext\" /* hide this from the linter */](Ctx);\n        return true;\n      } catch (e) {\n        return false;\n      } finally {\n        console.error = orig;\n      }\n    },\n    []\n  );\n}\n"]}

package/react/hooks-compiled/internal/validateSuspenseHookOptions.d.ts

@@ -0,0 +1,3 @@
+import type { OperationVariables, WatchQueryOptions } from "@apollo/client";
+export declare function validateSuspenseHookOptions<TData, TVariables extends OperationVariables>(options: WatchQueryOptions<TVariables, TData>): void;
+//# sourceMappingURL=validateSuspenseHookOptions.d.ts.map

package/react/hooks-compiled/internal/validateSuspenseHookOptions.js

@@ -0,0 +1,22 @@
+import { __DEV__ } from "@apollo/client/utilities/environment";
+import { invariant } from "@apollo/client/utilities/invariant";
+export function validateSuspenseHookOptions(options) {
+    const { fetchPolicy, returnPartialData } = options;
+    validateFetchPolicy(fetchPolicy);
+    validatePartialDataReturn(fetchPolicy, returnPartialData);
+}
+function validateFetchPolicy(fetchPolicy = "cache-first") {
+    const supportedFetchPolicies = [
+        "cache-first",
+        "network-only",
+        "no-cache",
+        "cache-and-network",
+    ];
+    invariant(supportedFetchPolicies.includes(fetchPolicy), 35, fetchPolicy);
+}
+function validatePartialDataReturn(fetchPolicy, returnPartialData) {
+    if (fetchPolicy === "no-cache" && returnPartialData) {
+        __DEV__ && invariant.warn(36);
+    }
+}
+//# sourceMappingURL=validateSuspenseHookOptions.js.map

package/react/hooks-compiled/internal/validateSuspenseHookOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validateSuspenseHookOptions.js","sources":["../../../../src/react/hooks/internal/validateSuspenseHookOptions.ts"],"sourcesContent":["import type {\n  OperationVariables,\n  WatchQueryFetchPolicy,\n  WatchQueryOptions,\n} from \"@apollo/client\";\nimport { invariant } from \"@apollo/client/utilities/invariant\";\n\nexport function validateSuspenseHookOptions<\n  TData,\n  TVariables extends OperationVariables,\n>(options: WatchQueryOptions<TVariables, TData>) {\n  const { fetchPolicy, returnPartialData } = options;\n\n  validateFetchPolicy(fetchPolicy);\n  validatePartialDataReturn(fetchPolicy, returnPartialData);\n}\n\nfunction validateFetchPolicy(\n  fetchPolicy: WatchQueryFetchPolicy = \"cache-first\"\n) {\n  const supportedFetchPolicies: WatchQueryFetchPolicy[] = [\n    \"cache-first\",\n    \"network-only\",\n    \"no-cache\",\n    \"cache-and-network\",\n  ];\n\n  invariant(\n    supportedFetchPolicies.includes(fetchPolicy),\n    `The fetch policy \\`%s\\` is not supported with suspense.`,\n    fetchPolicy\n  );\n}\n\nfunction validatePartialDataReturn(\n  fetchPolicy: WatchQueryFetchPolicy | undefined,\n  returnPartialData: boolean | undefined\n) {\n  if (fetchPolicy === \"no-cache\" && returnPartialData) {\n    invariant.warn(\n      \"Using `returnPartialData` with a `no-cache` fetch policy has no effect. To read partial data from the cache, consider using an alternate fetch policy.\"\n    );\n  }\n}\n"],"names":[],"mappings":";AAKA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EAAE,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,EAA0B,CAA1B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA8D;AAE9D,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAgB,CAAhB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA2C,CAGzC,CAHF,CAAA,CAAA,CAAA,CAAA,CAAA,CAG+C,EAH/C;IAIE,CAAF,CAAA,CAAA,CAAA,EAAQ,EAAE,CAAV,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAqB,EAAE,CAAvB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,EAA6C,CAA7C,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoD;IAElD,CAAF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAqB,CAAC,CAAtB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAiC,CAAC;IAChC,CAAF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA2B,CAAC,CAA5B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAuC,EAAE,CAAzC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA0D,CAAC;AAC3D;AAEA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAS,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA4B,CAC1B,CADF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EACuC,CADvC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACoD,EADpD;IAGE,CAAF,CAAA,CAAA,CAAA,EAAQ,CAAR,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAA0D;QACtD,CAAJ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAiB;QACb,CAAJ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAkB;QACd,CAAJ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAc;QACV,CAAJ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAuB;IACvB,CAAG;IAED,CAAF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EACI,CADJ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAC0B,CAAC,CAD3B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACmC,CAAC,CADpC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAC+C,OAE3C,CAHJ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAIG;AACH;AAEA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAS,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAkC,CAChC,CADF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACgD,EAC9C,CAFF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAEwC,EAFxC;IAIE,CAAF,EAAA,CAAM,CAAN,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAAsB,CAAtB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,EAAoC,CAApC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAqD,EAAE;mBACnD,CAAJ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAa,CAAC,CAAd,CAAA,CAAA,KAEK;IACH;AACF;"}

package/react/hooks-compiled/internal/wrapHook.d.ts

@@ -0,0 +1,66 @@
+import type { ApolloClient } from "@apollo/client";
+import type { ObservableQuery } from "@apollo/client";
+import type { createQueryPreloader } from "@apollo/client/react";
+import type { useBackgroundQuery, useFragment, useQuery, useQueryRefHandlers, useReadQuery, useSuspenseFragment, useSuspenseQuery } from "@apollo/client/react";
+export declare const wrapperSymbol: unique symbol;
+type FunctionSignature<T> = T extends (...args: infer A) => infer R ? (...args: A) => R : never;
+interface WrappableHooks {
+    createQueryPreloader: typeof createQueryPreloader;
+    useQuery: FunctionSignature<typeof useQuery>;
+    useSuspenseQuery: typeof useSuspenseQuery;
+    useSuspenseFragment: typeof useSuspenseFragment;
+    useBackgroundQuery: typeof useBackgroundQuery;
+    useReadQuery: typeof useReadQuery;
+    useFragment: typeof useFragment;
+    useQueryRefHandlers: typeof useQueryRefHandlers;
+}
+/**
+* @internal
+* Can be used to correctly type the [Symbol.for("apollo.hook.wrappers")] property of
+* `QueryManager`, to override/wrap hook functionality.
+* 
+* @deprecated This is an internal API and should not be used directly. This can be removed or changed at any time.
+*/
+export type HookWrappers = {
+    [K in keyof WrappableHooks]?: (originalHook: WrappableHooks[K]) => WrappableHooks[K];
+};
+/**
+* @internal
+*
+* Makes an Apollo Client hook "wrappable".
+* That means that the Apollo Client instance can expose a "wrapper" that will be
+* used to wrap the original hook implementation with additional logic.
+* @example
+* ```tsx
+* // this is already done in `@apollo/client` for all wrappable hooks (see `WrappableHooks`)
+* // following this pattern
+* function useQuery() {
+*   return wrapHook('useQuery', _useQuery, options.client)(query, options);
+* }
+* function _useQuery(query, options) {
+*   // original implementation
+* }
+*
+* // this is what a library like `@apollo/client-react-streaming` would do
+* class ApolloClientWithStreaming extends ApolloClient {
+*   constructor(options) {
+*     super(options);
+*     this.queryManager[Symbol.for("apollo.hook.wrappers")] = {
+*       useQuery: (original) => (query, options) => {
+*         console.log("useQuery was called with options", options);
+*         return original(query, options);
+*       }
+*     }
+*   }
+* }
+*
+* // this will now log the options and then call the original `useQuery`
+* const client = new ApolloClientWithStreaming({ ... });
+* useQuery(query, { client });
+* ```
+* 
+* @deprecated This is an internal API and should not be used directly. This can be removed or changed at any time.
+*/
+export declare function wrapHook<Hook extends (...args: any[]) => any>(hookName: keyof WrappableHooks, useHook: Hook, clientOrObsQuery: ObservableQuery<any> | ApolloClient): Hook;
+export {};
+//# sourceMappingURL=wrapHook.d.ts.map

package/react/hooks-compiled/internal/wrapHook.js

@@ -0,0 +1,64 @@
+import * as React from "react";
+// direct import to avoid circular dependency
+import { getApolloContext } from "../../context/ApolloContext.js";
+export const wrapperSymbol = Symbol.for("apollo.hook.wrappers");
+/**
+* @internal
+*
+* Makes an Apollo Client hook "wrappable".
+* That means that the Apollo Client instance can expose a "wrapper" that will be
+* used to wrap the original hook implementation with additional logic.
+* @example
+* ```tsx
+* // this is already done in `@apollo/client` for all wrappable hooks (see `WrappableHooks`)
+* // following this pattern
+* function useQuery() {
+*   return wrapHook('useQuery', _useQuery, options.client)(query, options);
+* }
+* function _useQuery(query, options) {
+*   // original implementation
+* }
+*
+* // this is what a library like `@apollo/client-react-streaming` would do
+* class ApolloClientWithStreaming extends ApolloClient {
+*   constructor(options) {
+*     super(options);
+*     this.queryManager[Symbol.for("apollo.hook.wrappers")] = {
+*       useQuery: (original) => (query, options) => {
+*         console.log("useQuery was called with options", options);
+*         return original(query, options);
+*       }
+*     }
+*   }
+* }
+*
+* // this will now log the options and then call the original `useQuery`
+* const client = new ApolloClientWithStreaming({ ... });
+* useQuery(query, { client });
+* ```
+* 
+* @deprecated This is an internal API and should not be used directly. This can be removed or changed at any time.
+*/
+export function wrapHook(hookName, useHook, clientOrObsQuery) {
+    // Priority-wise, the later entries in this array wrap
+    // previous entries and could prevent them (and in the end,
+    // even the original hook) from running
+    const wrapperSources = [
+        clientOrObsQuery["queryManager"],
+        // if we are a hook (not `preloadQuery`), we are guaranteed to be inside of
+        // a React render and can use context
+        hookName.startsWith("use") ?
+            // eslint-disable-next-line react-hooks/rules-of-hooks
+            React.useContext(getApolloContext())
+            : undefined,
+    ];
+    let wrapped = useHook;
+    for (const source of wrapperSources) {
+        const wrapper = source?.[wrapperSymbol]?.[hookName];
+        if (wrapper) {
+            wrapped = wrapper(wrapped);
+        }
+    }
+    return wrapped;
+}
+//# sourceMappingURL=wrapHook.js.map

package/react/hooks-compiled/internal/wrapHook.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wrapHook.js","sources":["../../../../src/react/hooks/internal/wrapHook.ts"],"sourcesContent":["import * as React from \"react\";\n\nimport type { ApolloClient } from \"@apollo/client\";\nimport type { ObservableQuery } from \"@apollo/client\";\nimport type { createQueryPreloader } from \"@apollo/client/react\";\nimport type {\n  useBackgroundQuery,\n  useFragment,\n  useQuery,\n  useQueryRefHandlers,\n  useReadQuery,\n  useSuspenseFragment,\n  useSuspenseQuery,\n} from \"@apollo/client/react\";\n\nimport type { QueryManager } from \"../../../core/QueryManager.js\";\n// direct import to avoid circular dependency\nimport { getApolloContext } from \"../../context/ApolloContext.js\";\n\nexport const wrapperSymbol = Symbol.for(\"apollo.hook.wrappers\");\n\ntype FunctionSignature<T> =\n  T extends (...args: infer A) => infer R ? (...args: A) => R : never;\n\ninterface WrappableHooks {\n  createQueryPreloader: typeof createQueryPreloader;\n  useQuery: FunctionSignature<typeof useQuery>;\n  useSuspenseQuery: typeof useSuspenseQuery;\n  useSuspenseFragment: typeof useSuspenseFragment;\n  useBackgroundQuery: typeof useBackgroundQuery;\n  useReadQuery: typeof useReadQuery;\n  useFragment: typeof useFragment;\n  useQueryRefHandlers: typeof useQueryRefHandlers;\n}\n\n/**\n * @internal\n * Can be used to correctly type the [Symbol.for(\"apollo.hook.wrappers\")] property of\n * `QueryManager`, to override/wrap hook functionality.\n */\nexport type HookWrappers = {\n  [K in keyof WrappableHooks]?: (\n    originalHook: WrappableHooks[K]\n  ) => WrappableHooks[K];\n};\n\ninterface QueryManagerWithWrappers extends QueryManager {\n  [wrapperSymbol]?: HookWrappers;\n}\n\n/**\n * @internal\n *\n * Makes an Apollo Client hook \"wrappable\".\n * That means that the Apollo Client instance can expose a \"wrapper\" that will be\n * used to wrap the original hook implementation with additional logic.\n * @example\n * ```tsx\n * // this is already done in `@apollo/client` for all wrappable hooks (see `WrappableHooks`)\n * // following this pattern\n * function useQuery() {\n *   return wrapHook('useQuery', _useQuery, options.client)(query, options);\n * }\n * function _useQuery(query, options) {\n *   // original implementation\n * }\n *\n * // this is what a library like `@apollo/client-react-streaming` would do\n * class ApolloClientWithStreaming extends ApolloClient {\n *   constructor(options) {\n *     super(options);\n *     this.queryManager[Symbol.for(\"apollo.hook.wrappers\")] = {\n *       useQuery: (original) => (query, options) => {\n *         console.log(\"useQuery was called with options\", options);\n *         return original(query, options);\n *       }\n *     }\n *   }\n * }\n *\n * // this will now log the options and then call the original `useQuery`\n * const client = new ApolloClientWithStreaming({ ... });\n * useQuery(query, { client });\n * ```\n */\nexport function wrapHook<Hook extends (...args: any[]) => any>(\n  hookName: keyof WrappableHooks,\n  useHook: Hook,\n  clientOrObsQuery: ObservableQuery<any> | ApolloClient\n): Hook {\n  // Priority-wise, the later entries in this array wrap\n  // previous entries and could prevent them (and in the end,\n  // even the original hook) from running\n  const wrapperSources = [\n    (\n      clientOrObsQuery as unknown as {\n        // both `ApolloClient` and `ObservableQuery` have a `queryManager` property\n        // but they're both `private`, so we have to cast around for a bit here.\n        queryManager: QueryManagerWithWrappers;\n      }\n    )[\"queryManager\"],\n    // if we are a hook (not `preloadQuery`), we are guaranteed to be inside of\n    // a React render and can use context\n    hookName.startsWith(\"use\") ?\n      // eslint-disable-next-line react-hooks/rules-of-hooks\n      React.useContext(getApolloContext())\n    : undefined,\n  ];\n\n  let wrapped = useHook;\n  for (const source of wrapperSources) {\n    const wrapper = source?.[wrapperSymbol]?.[hookName];\n    if (wrapper) {\n      wrapped = wrapper(wrapped) as Hook;\n    }\n  }\n\n  return wrapped;\n}\n"],"names":[],"mappings":"AAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EAAP,CAAA,EAAY,CAAZ,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,EAAuB,CAAvB,CAAA,CAAA,CAAA,CAAA,CAAA,CAA8B;AAgB9B,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;AACA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EAAE,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,EAAiC,CAAjC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAiE;AAEjE,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,CAAP,CAAA,CAAA,CAAA,EAAa,CAAb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAA6B,CAA7B,CAAA,CAAA,CAAA,CAAA,CAAmC,CAAC,CAApC,CAAA,CAAuC,CAAC,CAAxC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA8D,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkE/D,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAgB,CAAhB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAwB,CACtB,CADF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACgC,EAC9B,CAFF,CAAA,CAAA,CAAA,CAAA,CAAA,CAEe,EACb,CAHF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAGuD,EAHvD;IAKE,CAAF,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,EAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA;IACE,CAAF,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,EAAA,CAAA,EAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA;IACE,CAAF,EAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;IACE,CAAF,CAAA,CAAA,CAAA,EAAQ,CAAR,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAyB;QAEnB,CAAN,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAKK,CAAC,CALN,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAKoB,CAAC;QACjB,CAAJ,EAAA,CAAA,EAAA,CAAA,EAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,EAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,EAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA;QACI,CAAJ,EAAA,EAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;QACI,CAAJ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAY,CAAC,CAAb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAuB,CAAC,CAAxB,CAAA,CAAA,CAAA,CAA6B,EAAE;YACzB,CAAN,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA;YACM,CAAN,CAAA,CAAA,CAAA,CAAW,CAAC,CAAZ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAsB,CAAC,CAAvB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAuC,CAAvC,CAAyC;YACrC,EAAE,CAAN,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAe;IACf,CAAG;IAED,CAAF,CAAA,EAAM,CAAN,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAgB,CAAhB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAuB;IACrB,CAAF,CAAA,EAAA,CAAO,CAAP,CAAA,CAAA,CAAA,EAAa,CAAb,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,EAAuB,CAAvB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAqC,EAAE;QACnC,CAAJ,CAAA,CAAA,CAAA,EAAU,CAAV,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAoB,CAApB,CAAA,CAAA,CAAA,CAAA,CAA0B,CAA1B,CAA4B,CAAC,CAA7B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA0C,CAAC,CAA3C,CAA6C,CAAC,CAA9C,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAsD,CAAC;QACnD,CAAJ,EAAA,CAAQ,CAAR,CAAA,CAAA,CAAA,CAAA,CAAA,CAAe,EAAE;YACX,CAAN,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAgB,CAAhB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAuB,CAAC,CAAxB,CAAA,CAAA,CAAA,CAAA,CAAA,CAA+B,CAAS;QACpC;IACF;IAEA,CAAF,CAAA,CAAA,CAAA,CAAA,EAAS,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAgB;AAChB;"}

package/react/hooks-compiled/useApolloClient.d.ts

@@ -0,0 +1,18 @@
+import type { ApolloClient } from "@apollo/client";
+/**
+ * @example
+ * ```jsx
+ * import { useApolloClient } from '@apollo/client';
+ *
+ * function SomeComponent() {
+ *   const client = useApolloClient();
+ *   // `client` is now set to the `ApolloClient` instance being used by the
+ *   // application (that was configured using something like `ApolloProvider`)
+ * }
+ * ```
+ *
+ * @since 3.0.0
+ * @returns The `ApolloClient` instance being used by the application.
+ */
+export declare function useApolloClient(override?: ApolloClient): ApolloClient;
+//# sourceMappingURL=useApolloClient.d.ts.map

package/react/hooks-compiled/useApolloClient.js

@@ -0,0 +1,36 @@
+import { c as _c } from "@apollo/client/react/internal/compiler-runtime";
+import * as React from "react";
+import { invariant } from "@apollo/client/utilities/invariant";
+import { getApolloContext } from "../context/ApolloContext.js";
+/**
+ * @example
+ * ```jsx
+ * import { useApolloClient } from '@apollo/client';
+ *
+ * function SomeComponent() {
+ *   const client = useApolloClient();
+ *   // `client` is now set to the `ApolloClient` instance being used by the
+ *   // application (that was configured using something like `ApolloProvider`)
+ * }
+ * ```
+ *
+ * @since 3.0.0
+ * @returns The `ApolloClient` instance being used by the application.
+ */
+export function useApolloClient(override) {
+ const $ = _c(1);
+ let t0;
+
+ if ($[0] === Symbol.for("react.memo_cache_sentinel")) {
+  t0 = getApolloContext();
+  $[0] = t0;
+ } else {
+  t0 = $[0];
+ }
+
+ const context = React.useContext(t0);
+ const client = override || context.client;
+ invariant(!!client, 28);
+ return client;
+}
+//# sourceMappingURL=useApolloClient.js.map

package/react/hooks-compiled/useApolloClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useApolloClient.js","sources":["../../../src/react/hooks/useApolloClient.ts"],"sourcesContent":["import * as React from \"react\";\n\nimport type { ApolloClient } from \"@apollo/client\";\nimport { invariant } from \"@apollo/client/utilities/invariant\";\n\nimport { getApolloContext } from \"../context/ApolloContext.js\";\n\n/**\n * @example\n * ```jsx\n * import { useApolloClient } from '@apollo/client';\n *\n * function SomeComponent() {\n *   const client = useApolloClient();\n *   // `client` is now set to the `ApolloClient` instance being used by the\n *   // application (that was configured using something like `ApolloProvider`)\n * }\n * ```\n *\n * @since 3.0.0\n * @returns The `ApolloClient` instance being used by the application.\n */\nexport function useApolloClient(override?: ApolloClient): ApolloClient {\n  const context = React.useContext(getApolloContext());\n  const client = override || context.client;\n  invariant(\n    !!client,\n    'Could not find \"client\" in the context or passed in as an option. ' +\n      \"Wrap the root component in an <ApolloProvider>, or pass an ApolloClient \" +\n      \"instance in via options.\"\n  );\n\n  return client;\n}\n"],"names":[],"mappings":";AAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EAAP,CAAA,EAAY,CAAZ,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,EAAuB,CAAvB,CAAA,CAAA,CAAA,CAAA,CAAA,CAA8B;AAG9B,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EAAE,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,EAA0B,CAA1B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA8D;AAE9D,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EAAE,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,EAAiC,CAAjC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA8D;AAE9D,CAAA,CAAA;;;;;;;;;;;;;;CAcA,CAAA;;;;;;;;;;;;;;;;;"}

package/react/hooks-compiled/useBackgroundQuery.d.ts

@@ -0,0 +1,210 @@
+import type { ApolloClient, DefaultContext, DocumentNode, ErrorPolicy, OperationVariables, RefetchWritePolicy, TypedDocumentNode, WatchQueryFetchPolicy } from "@apollo/client";
+import type { SubscribeToMoreFunction } from "@apollo/client";
+import type { FetchMoreFunction, QueryRef, RefetchFunction } from "@apollo/client/react/internal";
+import type { NoInfer, VariablesOption } from "@apollo/client/utilities/internal";
+import type { SkipToken } from "./constants.js";
+export declare namespace useBackgroundQuery {
+    type FetchPolicy = Extract<WatchQueryFetchPolicy, "cache-first" | "network-only" | "no-cache" | "cache-and-network">;
+    type Options<TVariables extends OperationVariables = OperationVariables> = {
+        /**
+        * The instance of `ApolloClient` to use to execute the query.
+        * 
+        * By default, the instance that's passed down via context is used, but you can provide a different instance here.
+        * 
+        * @docGroup
+        * 
+        * 1. Operation options
+        */
+        client?: ApolloClient;
+        /**
+        * Specifies whether a `NetworkStatus.refetch` operation should merge incoming field data with existing data, or overwrite the existing data. Overwriting is probably preferable, but merging is currently the default behavior, for backwards compatibility with Apollo Client 3.x.
+        * 
+        * @docGroup
+        * 
+        * 3. Caching options
+        */
+        refetchWritePolicy?: RefetchWritePolicy;
+        /**
+        * Specifies how the query handles a response that returns both GraphQL errors and partial results.
+        * 
+        * For details, see [GraphQL error policies](https://www.apollographql.com/docs/react/data/error-handling/#graphql-error-policies).
+        * 
+        * The default value is `none`, meaning that the query result includes error details but not partial results.
+        * 
+        * @docGroup
+        * 
+        * 1. Operation options
+        */
+        errorPolicy?: ErrorPolicy;
+        /**
+        * If you're using [Apollo Link](https://www.apollographql.com/docs/react/api/link/introduction/), this object is the initial value of the `context` object that's passed along your link chain.
+        * 
+        * @docGroup
+        * 
+        * 2. Networking options
+        */
+        context?: DefaultContext;
+        /**
+        * If `true`, the query can return partial results from the cache if the cache doesn't contain results for all queried fields.
+        * 
+        * The default value is `false`.
+        * 
+        * @docGroup
+        * 
+        * 3. Caching options
+        */
+        returnPartialData?: boolean;
+        /**
+        * Specifies how the query interacts with the Apollo Client cache during execution (for example, whether it checks the cache for results before sending a request to the server).
+        * 
+        * For details, see [Setting a fetch policy](https://www.apollographql.com/docs/react/data/queries/#setting-a-fetch-policy).
+        * 
+        * The default value is `cache-first`.
+        * 
+        * @docGroup
+        * 
+        * 3. Caching options
+        */
+        fetchPolicy?: FetchPolicy;
+        /**
+        * A unique identifier for the query. Each item in the array must be a stable identifier to prevent infinite fetches.
+        * 
+        * This is useful when using the same query and variables combination in more than one component, otherwise the components may clobber each other. This can also be used to force the query to re-evaluate fresh.
+        * 
+        * @docGroup
+        * 
+        * 1. Operation options
+        */
+        queryKey?: string | number | any[];
+        /**
+        * If `true`, the query is not executed. The default value is `false`.
+        * 
+        * @deprecated
+        * 
+        * We recommend using `skipToken` in place of the `skip` option as it is more type-safe.
+        * 
+        * This option is deprecated and only supported to ease the migration from useQuery. It will be removed in a future release.
+        * 
+        * @docGroup
+        * 
+        * 1. Operation options
+        * 
+        *
+        * @example Recommended usage of `skipToken`:
+        * ```ts
+        * import { skipToken, useBackgroundQuery } from '@apollo/client';
+        *
+        * const [queryRef] = useBackgroundQuery(query, id ? { variables: { id } } : skipToken);
+        * ```
+        */
+        skip?: boolean;
+    } & VariablesOption<TVariables>;
+    type Result<TData = unknown, TVariables extends OperationVariables = OperationVariables> = {
+        /**
+        * A function that enables you to execute a [subscription](https://www.apollographql.com/docs/react/data/subscriptions/), usually to subscribe to specific fields that were included in the query.
+        * 
+        * This function returns _another_ function that you can call to terminate the subscription.
+        */
+        subscribeToMore: SubscribeToMoreFunction<TData, TVariables>;
+        /**
+        * A function that helps you fetch the next set of results for a [paginated list field](https://www.apollographql.com/docs/react/pagination/core-api/).
+        */
+        fetchMore: FetchMoreFunction<TData, TVariables>;
+        /**
+        * Update the variables of this observable query, and fetch the new results. This method should be preferred over `setVariables` in most use cases.
+        * 
+        * @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>;
+    };
+}
+export declare function useBackgroundQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(query: DocumentNode | TypedDocumentNode<TData, TVariables>, options: useBackgroundQuery.Options<NoInfer<TVariables>> & {
+    /** @deprecated `returnPartialData` has no effect on `no-cache` queries */
+    returnPartialData: boolean;
+    fetchPolicy: "no-cache";
+}): [
+    QueryRef<TData, TVariables, "complete" | "streaming">,
+    useBackgroundQuery.Result<TData, TVariables>
+];
+export declare function useBackgroundQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(query: DocumentNode | TypedDocumentNode<TData, TVariables>, options: useBackgroundQuery.Options<NoInfer<TVariables>> & {
+    returnPartialData: false;
+    errorPolicy: "ignore" | "all";
+}): [
+    QueryRef<TData, TVariables, "complete" | "streaming" | "empty">,
+    useBackgroundQuery.Result<TData, TVariables>
+];
+export declare function useBackgroundQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(query: DocumentNode | TypedDocumentNode<TData, TVariables>, options: useBackgroundQuery.Options<NoInfer<TVariables>> & {
+    returnPartialData: boolean;
+    errorPolicy: "ignore" | "all";
+}): [
+    QueryRef<TData, TVariables, "complete" | "streaming" | "partial" | "empty">,
+    useBackgroundQuery.Result<TData, TVariables>
+];
+export declare function useBackgroundQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(query: DocumentNode | TypedDocumentNode<TData, TVariables>, options: useBackgroundQuery.Options<NoInfer<TVariables>> & {
+    errorPolicy: "ignore" | "all";
+}): [
+    QueryRef<TData, TVariables, "complete" | "streaming" | "empty">,
+    useBackgroundQuery.Result<TData, TVariables>
+];
+export declare function useBackgroundQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(query: DocumentNode | TypedDocumentNode<TData, TVariables>, options: useBackgroundQuery.Options<NoInfer<TVariables>> & {
+    skip: boolean;
+    returnPartialData: false;
+}): [
+    QueryRef<TData, TVariables, "complete" | "streaming"> | undefined,
+    useBackgroundQuery.Result<TData, TVariables>
+];
+export declare function useBackgroundQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(query: DocumentNode | TypedDocumentNode<TData, TVariables>, options: useBackgroundQuery.Options<NoInfer<TVariables>> & {
+    skip: boolean;
+    returnPartialData: boolean;
+}): [
+    QueryRef<TData, TVariables, "complete" | "streaming" | "partial"> | undefined,
+    useBackgroundQuery.Result<TData, TVariables>
+];
+export declare function useBackgroundQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(query: DocumentNode | TypedDocumentNode<TData, TVariables>, options: useBackgroundQuery.Options<NoInfer<TVariables>> & {
+    returnPartialData: false;
+}): [
+    QueryRef<TData, TVariables, "complete" | "streaming">,
+    useBackgroundQuery.Result<TData, TVariables>
+];
+export declare function useBackgroundQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(query: DocumentNode | TypedDocumentNode<TData, TVariables>, options: useBackgroundQuery.Options<NoInfer<TVariables>> & {
+    returnPartialData: boolean;
+}): [
+    QueryRef<TData, TVariables, "complete" | "streaming" | "partial">,
+    useBackgroundQuery.Result<TData, TVariables>
+];
+export declare function useBackgroundQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(query: DocumentNode | TypedDocumentNode<TData, TVariables>, options: useBackgroundQuery.Options<NoInfer<TVariables>> & {
+    skip: boolean;
+}): [
+    QueryRef<TData, TVariables, "complete" | "streaming"> | undefined,
+    useBackgroundQuery.Result<TData, TVariables>
+];
+export declare function useBackgroundQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(query: DocumentNode | TypedDocumentNode<TData, TVariables>, options: SkipToken): [undefined, useBackgroundQuery.Result<TData, TVariables>];
+export declare function useBackgroundQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(query: DocumentNode | TypedDocumentNode<TData, TVariables>, options: SkipToken | (useBackgroundQuery.Options<NoInfer<TVariables>> & {
+    returnPartialData: false;
+})): [
+    QueryRef<TData, TVariables, "complete" | "streaming"> | undefined,
+    useBackgroundQuery.Result<TData, TVariables>
+];
+export declare function useBackgroundQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(query: DocumentNode | TypedDocumentNode<TData, TVariables>, options: SkipToken | (useBackgroundQuery.Options<NoInfer<TVariables>> & {
+    returnPartialData: boolean;
+})): [
+    QueryRef<TData, TVariables, "complete" | "streaming" | "partial"> | undefined,
+    useBackgroundQuery.Result<TData, TVariables>
+];
+export declare function useBackgroundQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(query: DocumentNode | TypedDocumentNode<TData, TVariables>, ...[options]: {} extends TVariables ? [
+    options?: useBackgroundQuery.Options<NoInfer<TVariables>>
+] : [options: useBackgroundQuery.Options<NoInfer<TVariables>>]): [
+    QueryRef<TData, TVariables, "complete" | "streaming">,
+    useBackgroundQuery.Result<TData, TVariables>
+];
+export declare function useBackgroundQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(query: DocumentNode | TypedDocumentNode<TData, TVariables>, ...[options]: {} extends TVariables ? [
+    options?: SkipToken | useBackgroundQuery.Options<NoInfer<TVariables>>
+] : [options: SkipToken | useBackgroundQuery.Options<NoInfer<TVariables>>]): [
+    QueryRef<TData, TVariables, "complete" | "streaming"> | undefined,
+    useBackgroundQuery.Result<TData, TVariables>
+];
+export declare function useBackgroundQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(query: DocumentNode | TypedDocumentNode<TData, TVariables>, options: SkipToken | useBackgroundQuery.Options<NoInfer<TVariables>>): [
+    QueryRef<TData, TVariables, "complete" | "streaming"> | undefined,
+    useBackgroundQuery.Result<TData, TVariables>
+];
+//# sourceMappingURL=useBackgroundQuery.d.ts.map

package/react/hooks-compiled/useBackgroundQuery.js

@@ -0,0 +1,80 @@
+import * as React from "react";
+import { canonicalStringify } from "@apollo/client/cache";
+import { getSuspenseCache, unwrapQueryRef, updateWrappedQueryRef, wrapQueryRef, } from "@apollo/client/react/internal";
+import { wrapHook } from "./internal/index.js";
+import { useApolloClient } from "./useApolloClient.js";
+import { useWatchQueryOptions } from "./useSuspenseQuery.js";
+export function useBackgroundQuery(query, options) {
+    "use no memo";
+    return wrapHook("useBackgroundQuery", 
+    // eslint-disable-next-line react-compiler/react-compiler
+    useBackgroundQuery_, useApolloClient(typeof options === "object" ? options.client : undefined))(query, options ?? {});
+}
+function useBackgroundQuery_(query, options) {
+    const client = useApolloClient(options.client);
+    const suspenseCache = getSuspenseCache(client);
+    const watchQueryOptions = useWatchQueryOptions({ client, query, options });
+    const { fetchPolicy, variables } = watchQueryOptions;
+    const { queryKey = [] } = options;
+    // This ref tracks the first time query execution is enabled to determine
+    // whether to return a query ref or `undefined`. When initialized
+    // in a skipped state (either via `skip: true` or `skipToken`) we return
+    // `undefined` for the `queryRef` until the query has been enabled. Once
+    // enabled, a query ref is always returned regardless of whether the query is
+    // skipped again later.
+    const didFetchResult = React.useRef(fetchPolicy !== "standby");
+    didFetchResult.current ||= fetchPolicy !== "standby";
+    const cacheKey = [
+        query,
+        canonicalStringify(variables),
+        ...[].concat(queryKey),
+    ];
+    const queryRef = suspenseCache.getQueryRef(cacheKey, () => client.watchQuery(watchQueryOptions));
+    const [wrappedQueryRef, setWrappedQueryRef] = React.useState(wrapQueryRef(queryRef));
+    if (unwrapQueryRef(wrappedQueryRef) !== queryRef) {
+        setWrappedQueryRef(wrapQueryRef(queryRef));
+    }
+    if (queryRef.didChangeOptions(watchQueryOptions)) {
+        const promise = queryRef.applyOptions(watchQueryOptions);
+        updateWrappedQueryRef(wrappedQueryRef, promise);
+    }
+    // This prevents issues where rerendering useBackgroundQuery after the
+    // queryRef has been disposed would cause the hook to return a new queryRef
+    // instance since disposal also removes it from the suspense cache. We add
+    // the queryRef back in the suspense cache so that the next render will reuse
+    // this queryRef rather than initializing a new instance.
+    React.useEffect(() => {
+        // Since the queryRef is disposed async via `setTimeout`, we have to wait a
+        // tick before checking it and adding back to the suspense cache.
+        const id = setTimeout(() => {
+            if (queryRef.disposed) {
+                suspenseCache.add(cacheKey, queryRef);
+            }
+        });
+        return () => clearTimeout(id);
+        // Omitting the deps is intentional. This avoids stale closures and the
+        // conditional ensures we aren't running the logic on each render.
+    });
+    const fetchMore = React.useCallback((options_0) => {
+        const promise_0 = queryRef.fetchMore(options_0);
+        setWrappedQueryRef(wrapQueryRef(queryRef));
+        return promise_0;
+    }, [queryRef]);
+    const refetch = React.useCallback((variables_0) => {
+        const promise_1 = queryRef.refetch(variables_0);
+        setWrappedQueryRef(wrapQueryRef(queryRef));
+        return promise_1;
+    }, [queryRef]);
+    React.useEffect(() => queryRef.softRetain(), [queryRef]);
+    return [
+        didFetchResult.current ? wrappedQueryRef : void 0,
+        {
+            fetchMore,
+            refetch,
+            // TODO: The internalQueryRef doesn't have TVariables' type information so we have to cast it here
+            subscribeToMore: queryRef.observable
+                .subscribeToMore,
+        },
+    ];
+}
+//# sourceMappingURL=useBackgroundQuery.js.map