@apollo/client 4.0.0-rc.1 → 4.0.0-rc.10

package/link/utils/index.d.ts

@@ -1,5 +1,3 @@
-export { validateOperation } from "./validateOperation.js";
 export { createOperation } from "./createOperation.js";
-export { transformOperation } from "./transformOperation.js";
 export { filterOperationVariables } from "./filterOperationVariables.js";
-//# sourceMappingURL=index.d.ts.map
+//# sourceMappingURL=index.d.ts.map

package/link/utils/index.js

@@ -1,5 +1,3 @@
-export { validateOperation } from "./validateOperation.js";
 export { createOperation } from "./createOperation.js";
-export { transformOperation } from "./transformOperation.js";
 export { filterOperationVariables } from "./filterOperationVariables.js";
-//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/link/utils/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../../../src/link/utils/index.ts"],"sourcesContent":["export { validateOperation } from \"./validateOperation.js\";\nexport { createOperation } from \"./createOperation.js\";\nexport { transformOperation } from \"./transformOperation.js\";\nexport { filterOperationVariables } from \"./filterOperationVariables.js\";\n"],"names":[],"mappings":"AAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EAAE,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,EAAkC,CAAlC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA0D;AAC1D,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EAAE,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,EAAgC,CAAhC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAsD;AACtD,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EAAE,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,EAAmC,CAAnC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA4D;AAC5D,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAS,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,EAAyC,CAAzC,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;"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/link/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC","sourcesContent":["export { createOperation } from \"./createOperation.js\";\nexport { filterOperationVariables } from \"./filterOperationVariables.js\";\n"]}

package/link/ws/index.d.ts

@@ -1,31 +1,88 @@
 import type { Observable } from "rxjs";
 import type { ClientOptions } from "subscriptions-transport-ws";
 import { SubscriptionClient } from "subscriptions-transport-ws";
-import type { FetchResult, Operation } from "@apollo/client/link";
 import { ApolloLink } from "@apollo/client/link";
 export declare namespace WebSocketLink {
     /**
-     * Configuration to use when constructing the subscription client (subscriptions-transport-ws).
+     * Configuration options for creating a `WebSocketLink` instance.
+     *
+     * @remarks
+     *
+     * These configuration options are used when creating a `WebSocketLink` without
+     * providing an existing `SubscriptionClient` instance. The options are passed
+     * directly to the `SubscriptionClient` constructor from the `subscriptions-transport-ws`
+     * library.
      */
     interface Configuration {
         /**
-         * The endpoint to connect to.
+         * The WebSocket endpoint URI to connect to.
+         *
+         * This should be a valid WebSocket URI (starting with `ws://` or `wss://`)
+         * that points to your GraphQL subscription endpoint.
+         *
+         * @example "ws://localhost:4000/subscriptions"
+         * @example "wss://api.example.com/graphql"
          */
         uri: string;
         /**
-         * Options to pass when constructing the subscription client.
+         * Configuration options passed to the underlying `SubscriptionClient`.
+         *
+         * These options configure the WebSocket connection behavior, including
+         * reconnection settings, connection parameters, and event handlers.
+         *
+         * For a complete list of available options, see the
+         * [supported `subscriptions-transport-ws` options](https://github.com/apollographql/subscriptions-transport-ws/blob/master/src/client.ts#L61-L71).
          */
         options?: ClientOptions;
         /**
-         * A custom WebSocket implementation to use.
+         * A custom WebSocket implementation to use for the connection.
+         *
+         * This is useful in environments that don't have native WebSocket support.
+         * You can provide a WebSocket polyfill or implementation that conforms to
+         * the W3C WebSocket API.
+         *
+         * @example
+         *
+         * ```ts
+         * import WebSocket from "ws";
+         *
+         * const wsLink = new WebSocketLink({
+         *   uri: "ws://localhost:4000/subscriptions",
+         *   webSocketImpl: WebSocket,
+         * });
+         * ```
          */
         webSocketImpl?: any;
     }
 }
-export import WebSocketParams = WebSocketLink.Configuration;
+/**
+ * `WebSocketLink` is a terminating link that executes GraphQL operations over
+ * WebSocket connections using the `subscriptions-transport-ws` library. It's
+ * primarily used for GraphQL subscriptions but can also handle queries and
+ * mutations.
+ *
+ * @example
+ *
+ * ```ts
+ * import { WebSocketLink } from "@apollo/client/link/ws";
+ * import { SubscriptionClient } from "subscriptions-transport-ws";
+ *
+ * const wsLink = new WebSocketLink(
+ *   new SubscriptionClient("ws://localhost:4000/subscriptions", {
+ *     reconnect: true,
+ *   })
+ * );
+ * ```
+ *
+ * @deprecated `WebSocketLink` uses the deprecated and unmaintained
+ * `subscriptions-transport-ws` library. This link is no longer maintained and
+ * will be removed in a future major version of Apollo Client. We recommend
+ * switching to `GraphQLWsLink`, which uses the [`graphql-ws` library](https://the-guild.dev/graphql/ws) to
+ * send GraphQL operations through WebSocket connections.
+ */
 export declare class WebSocketLink extends ApolloLink {
     private subscriptionClient;
     constructor(paramsOrClient: WebSocketLink.Configuration | SubscriptionClient);
-    request(operation: Operation): Observable<FetchResult> | null;
+    request(operation: ApolloLink.Operation): Observable<ApolloLink.Result>;
 }
-//# sourceMappingURL=index.d.ts.map
+//# sourceMappingURL=index.d.ts.map

package/link/ws/index.js

@@ -1,9 +1,39 @@
 import { SubscriptionClient } from "subscriptions-transport-ws";
 import { ApolloLink } from "@apollo/client/link";
+import { __DEV__ } from "@apollo/client/utilities/environment";
+import { invariant } from "@apollo/client/utilities/invariant";
+/**
+ * `WebSocketLink` is a terminating link that executes GraphQL operations over
+ * WebSocket connections using the `subscriptions-transport-ws` library. It's
+ * primarily used for GraphQL subscriptions but can also handle queries and
+ * mutations.
+ *
+ * @example
+ *
+ * ```ts
+ * import { WebSocketLink } from "@apollo/client/link/ws";
+ * import { SubscriptionClient } from "subscriptions-transport-ws";
+ *
+ * const wsLink = new WebSocketLink(
+ *   new SubscriptionClient("ws://localhost:4000/subscriptions", {
+ *     reconnect: true,
+ *   })
+ * );
+ * ```
+ *
+ * @deprecated `WebSocketLink` uses the deprecated and unmaintained
+ * `subscriptions-transport-ws` library. This link is no longer maintained and
+ * will be removed in a future major version of Apollo Client. We recommend
+ * switching to `GraphQLWsLink`, which uses the [`graphql-ws` library](https://the-guild.dev/graphql/ws) to
+ * send GraphQL operations through WebSocket connections.
+ */
 export class WebSocketLink extends ApolloLink {
     subscriptionClient;
     constructor(paramsOrClient) {
         super();
+        if (__DEV__) {
+            __DEV__ && invariant.warn(56);
+        }
         if (paramsOrClient instanceof SubscriptionClient) {
             this.subscriptionClient = paramsOrClient;
         }

package/link/ws/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../../../src/link/ws/index.ts"],"sourcesContent":["import type { Observable } from \"rxjs\";\nimport type { ClientOptions } from \"subscriptions-transport-ws\";\nimport { SubscriptionClient } from \"subscriptions-transport-ws\";\n\nimport type { FetchResult, Operation } from \"@apollo/client/link\";\nimport { ApolloLink } from \"@apollo/client/link\";\n\nexport namespace WebSocketLink {\n  /**\n   * Configuration to use when constructing the subscription client (subscriptions-transport-ws).\n   */\n  export interface Configuration {\n    /**\n     * The endpoint to connect to.\n     */\n    uri: string;\n\n    /**\n     * Options to pass when constructing the subscription client.\n     */\n    options?: ClientOptions;\n\n    /**\n     * A custom WebSocket implementation to use.\n     */\n    webSocketImpl?: any;\n  }\n}\n\n// For backwards compatibility.\nexport import WebSocketParams = WebSocketLink.Configuration;\n\nexport class WebSocketLink extends ApolloLink {\n  private subscriptionClient: SubscriptionClient;\n\n  constructor(\n    paramsOrClient: WebSocketLink.Configuration | SubscriptionClient\n  ) {\n    super();\n\n    if (paramsOrClient instanceof SubscriptionClient) {\n      this.subscriptionClient = paramsOrClient;\n    } else {\n      this.subscriptionClient = new SubscriptionClient(\n        paramsOrClient.uri,\n        paramsOrClient.options,\n        paramsOrClient.webSocketImpl\n      );\n    }\n  }\n\n  public request(operation: Operation): Observable<FetchResult> | null {\n    return this.subscriptionClient.request(\n      operation\n    ) as Observable<FetchResult>;\n  }\n}\n"],"names":[],"mappings":"AAEA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EAAE,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,EAAmC,CAAnC,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,CAA+D;AAG/D,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EAAE,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,EAA2B,CAA3B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAgD;AA2BhD,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,EAAa,CAAb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAmC,CAAnC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA;IACU,CAAV,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA4B;IAE1B,CAAF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACI,CADJ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACoE,EADpE;QAGI,CAAJ,CAAA,CAAA,CAAA,CAAS,CAAT,CAAW;QAEP,CAAJ,EAAA,CAAQ,CAAR,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAkC,CAAlC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoD,EAAE;YAChD,CAAN,CAAA,CAAA,CAAU,CAAC,CAAX,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAgC,CAAhC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA8C;QAC1C;QAAJ,CAAA,CAAA,CAAA,EAAW;YACL,CAAN,CAAA,CAAA,CAAU,CAAC,CAAX,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAgC,CAAhC,CAAA,EAAoC,CAApC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAsD,CAC9C,CADR,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACsB,CAAC,CADvB,CAAA,CAC0B,EAClB,CAFR,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAEsB,CAAC,CAFvB,CAAA,CAAA,CAAA,CAAA,CAAA,CAE8B,EACtB,CAHR,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAGsB,CAAC,CAHvB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAGoC,CAC7B;QACH;IACF;IAEO,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAgB,CAAC,CAAjB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAqC,EAArC;QACI,CAAJ,CAAA,CAAA,CAAA,CAAA,EAAW,CAAX,CAAA,CAAA,CAAe,CAAC,CAAhB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAkC,CAAC,CAAnC,CAAA,CAAA,CAAA,CAAA,CAAA,CAA0C,CACpC,CADN,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACe,CACiB;IAC9B;AACF;"}
+{"version":3,"file":"index.js","sources":["../../../src/link/ws/index.ts"],"sourcesContent":["import type { Observable } from \"rxjs\";\nimport type { ClientOptions } from \"subscriptions-transport-ws\";\nimport { SubscriptionClient } from \"subscriptions-transport-ws\";\n\nimport { ApolloLink } from \"@apollo/client/link\";\nimport { __DEV__ } from \"@apollo/client/utilities/environment\";\nimport { invariant } from \"@apollo/client/utilities/invariant\";\n\nexport declare namespace WebSocketLink {\n  /**\n   * Configuration options for creating a `WebSocketLink` instance.\n   *\n   * @remarks\n   *\n   * These configuration options are used when creating a `WebSocketLink` without\n   * providing an existing `SubscriptionClient` instance. The options are passed\n   * directly to the `SubscriptionClient` constructor from the `subscriptions-transport-ws`\n   * library.\n   */\n  export interface Configuration {\n    /**\n     * The WebSocket endpoint URI to connect to.\n     *\n     * This should be a valid WebSocket URI (starting with `ws://` or `wss://`)\n     * that points to your GraphQL subscription endpoint.\n     *\n     * @example \"ws://localhost:4000/subscriptions\"\n     * @example \"wss://api.example.com/graphql\"\n     */\n    uri: string;\n\n    /**\n     * Configuration options passed to the underlying `SubscriptionClient`.\n     *\n     * These options configure the WebSocket connection behavior, including\n     * reconnection settings, connection parameters, and event handlers.\n     *\n     * For a complete list of available options, see the\n     * [supported `subscriptions-transport-ws` options](https://github.com/apollographql/subscriptions-transport-ws/blob/master/src/client.ts#L61-L71).\n     */\n    options?: ClientOptions;\n\n    /**\n     * A custom WebSocket implementation to use for the connection.\n     *\n     * This is useful in environments that don't have native WebSocket support.\n     * You can provide a WebSocket polyfill or implementation that conforms to\n     * the W3C WebSocket API.\n     *\n     * @example\n     *\n     * ```ts\n     * import WebSocket from \"ws\";\n     *\n     * const wsLink = new WebSocketLink({\n     *   uri: \"ws://localhost:4000/subscriptions\",\n     *   webSocketImpl: WebSocket,\n     * });\n     * ```\n     */\n    webSocketImpl?: any;\n  }\n}\n\n/**\n * `WebSocketLink` is a terminating link that executes GraphQL operations over\n * WebSocket connections using the `subscriptions-transport-ws` library. It's\n * primarily used for GraphQL subscriptions but can also handle queries and\n * mutations.\n *\n * @example\n *\n * ```ts\n * import { WebSocketLink } from \"@apollo/client/link/ws\";\n * import { SubscriptionClient } from \"subscriptions-transport-ws\";\n *\n * const wsLink = new WebSocketLink(\n *   new SubscriptionClient(\"ws://localhost:4000/subscriptions\", {\n *     reconnect: true,\n *   })\n * );\n * ```\n *\n * @deprecated `WebSocketLink` uses the deprecated and unmaintained\n * `subscriptions-transport-ws` library. This link is no longer maintained and\n * will be removed in a future major version of Apollo Client. We recommend\n * switching to `GraphQLWsLink`, which uses the [`graphql-ws` library](https://the-guild.dev/graphql/ws) to\n * send GraphQL operations through WebSocket connections.\n */\nexport class WebSocketLink extends ApolloLink {\n  private subscriptionClient: SubscriptionClient;\n\n  constructor(\n    paramsOrClient: WebSocketLink.Configuration | SubscriptionClient\n  ) {\n    super();\n\n    if (__DEV__) {\n      invariant.warn(\n        \"`WebSocketLink` uses the deprecated and unmaintained `subscriptions-transport-ws` library. This link is no longer maintained and will be removed in a future major version of Apollo Client. We recommend switching to `GraphQLWsLink` which uses the `graphql-ws` library to send GraphQL operations through WebSocket connections (https://the-guild.dev/graphql/ws).\"\n      );\n    }\n\n    if (paramsOrClient instanceof SubscriptionClient) {\n      this.subscriptionClient = paramsOrClient;\n    } else {\n      this.subscriptionClient = new SubscriptionClient(\n        paramsOrClient.uri,\n        paramsOrClient.options,\n        paramsOrClient.webSocketImpl\n      );\n    }\n  }\n\n  public request(\n    operation: ApolloLink.Operation\n  ): Observable<ApolloLink.Result> {\n    return this.subscriptionClient.request(\n      operation\n    ) as Observable<ApolloLink.Result>;\n  }\n}\n"],"names":[],"mappings":"AAEA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EAAE,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,EAAmC,CAAnC,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,CAA+D;AAE/D,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EAAE,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,EAA2B,CAA3B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAgD;AAChD,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EAAE,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,EAAwB,CAAxB,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,CAAA,CAAA,CAA8D;AAC9D,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;AA0D9D,CAAA,CAAA;;;;;;;;;;;;;;;;;;;;;;;;CAwBA,CAAA;AACA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,EAAa,CAAb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAmC,CAAnC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA;IACU,CAAV,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA4B;IAE1B,CAAF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACI,CADJ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACoE,EADpE;QAGI,CAAJ,CAAA,CAAA,CAAA,CAAS,CAAT,CAAW;QAEP,CAAJ,EAAA,CAAQ,CAAR,CAAA,CAAA,CAAA,CAAA,CAAA,CAAe,EAAE;uBACX,CAAN,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAe,CAAC,CAAhB,CAAA,CAAA,KAEO;QACH;QAEA,CAAJ,EAAA,CAAQ,CAAR,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAkC,CAAlC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoD,EAAE;YAChD,CAAN,CAAA,CAAA,CAAU,CAAC,CAAX,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAgC,CAAhC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA8C;QAC1C;QAAJ,CAAA,CAAA,CAAA,EAAW;YACL,CAAN,CAAA,CAAA,CAAU,CAAC,CAAX,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAgC,CAAhC,CAAA,EAAoC,CAApC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAsD,CAC9C,CADR,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACsB,CAAC,CADvB,CAAA,CAC0B,EAClB,CAFR,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAEsB,CAAC,CAFvB,CAAA,CAAA,CAAA,CAAA,CAAA,CAE8B,EACtB,CAHR,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAGsB,CAAC,CAHvB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAGoC,CAC7B;QACH;IACF;IAEO,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAgB,CACZ,CADJ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACmC,EADnC;QAGI,CAAJ,CAAA,CAAA,CAAA,CAAA,EAAW,CAAX,CAAA,CAAA,CAAe,CAAC,CAAhB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAkC,CAAC,CAAnC,CAAA,CAAA,CAAA,CAAA,CAAA,CAA0C,CACpC,CADN,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACe,CACuB;IACpC;AACF;"}

package/local-state/LocalState.d.ts

@@ -10,6 +10,12 @@ type MaybeRequireContextFunction<TContext> = {} extends RemoveIndexSignature<TCo
     context: LocalState.ContextFunction<TContext>;
 };
 export declare namespace LocalState {
+    /**
+     * Configuration options for LocalState.
+     *
+     * @template TResolvers - The type of resolvers map to use for type checking
+     * @template TContext - The type of context value returned by the context function. Defaults to `DefaultContext` when not provided.
+     */
     type Options<TResolvers extends Resolvers = Resolvers, TContext = DefaultContext> = {
         context?: ContextFunction<TContext>;
         /**
@@ -33,11 +39,53 @@ export declare namespace LocalState {
         requestContext: DefaultContext;
     }
     type RootValueFunction<TRootValue> = (context: RootValueFunctionContext) => TRootValue;
+    /**
+     * A map of GraphQL types to their field resolvers.
+     *
+     * @example
+     *
+     * ```ts
+     * const resolvers: Resolvers = {
+     *   Query: {
+     *     isLoggedIn: () => !!localStorage.getItem("token"),
+     *   },
+     *   Mutation: {
+     *     login: (_, { token }) => {
+     *       localStorage.setItem("token", token);
+     *       return true;
+     *     },
+     *   },
+     * };
+     * ```
+     */
     interface Resolvers<TContext = any> {
         [typename: string]: {
             [field: string]: Resolver<any, any, TContext, any>;
         };
     }
+    /**
+     * A function that resolves the value for a single GraphQL field marked with `@client`.
+     *
+     * Resolver functions receive four parameters:
+     *
+     * - `rootValue`: The parent object containing the result from the resolver on the parent field
+     * - `args`: Arguments passed to the field
+     * - `context`: Contains `requestContext`, `client`, and `phase` properties
+     * - `info`: Information about the field being resolved
+     *
+     * @template TResult - The type of value returned by the resolver
+     * @template TParent - The type of the parent object
+     * @template TContext - The type of the request context
+     * @template TArgs - The type of the field arguments
+     *
+     * @example
+     *
+     * ```ts
+     * const isLoggedInResolver: Resolver<boolean> = () => {
+     *   return !!localStorage.getItem("token");
+     * };
+     * ```
+     */
     type Resolver<TResult = unknown, TParent = unknown, TContext = DefaultContext, TArgs = Record<string, unknown>> = (rootValue: TParent, args: TArgs, context: {
         requestContext: TContext;
         client: ApolloClient;
@@ -49,6 +97,35 @@ export declare namespace LocalState {
     }) => TResult | Promise<TResult>;
     type Path = Array<string | number>;
 }
+/**
+ * LocalState enables the use of `@client` fields in GraphQL operations.
+ *
+ * `@client` fields are resolved locally using resolver functions rather than
+ * being sent to the GraphQL server. This allows you to mix local and remote
+ * data in a single query.
+ *
+ * @example
+ *
+ * ```ts
+ * import { LocalState } from "@apollo/client/local-state";
+ *
+ * const localState = new LocalState({
+ *   resolvers: {
+ *     Query: {
+ *       isLoggedIn: () => !!localStorage.getItem("token"),
+ *     },
+ *   },
+ * });
+ *
+ * const client = new ApolloClient({
+ *   cache: new InMemoryCache(),
+ *   localState,
+ * });
+ * ```
+ *
+ * @template TResolvers - The type of resolvers map for type checking
+ * @template TContext - The type of context value for resolvers
+ */
 export declare class LocalState<TResolvers extends LocalState.Resolvers = LocalState.Resolvers<DefaultContext>, TContext = InferContextValueFromResolvers<TResolvers>> {
     private context?;
     private resolvers;
@@ -60,6 +137,23 @@ export declare class LocalState<TResolvers extends LocalState.Resolvers = LocalS
             resolvers: TResolvers;
         }
     ]);
+    /**
+     * Add resolvers to the local state. New resolvers will be merged with
+     * existing ones, with new resolvers taking precedence over existing ones
+     * for the same field.
+     *
+     * @param resolvers - The resolvers to add
+     *
+     * @example
+     *
+     * ```ts
+     * localState.addResolvers({
+     *   Query: {
+     *     newField: () => "Hello World",
+     *   },
+     * });
+     * ```
+     */
     addResolvers(resolvers: TResolvers): void;
     execute<TData = unknown, TVariables extends OperationVariables = OperationVariables>({ document, client, context, remoteResult, variables, onlyRunForcedResolvers, returnPartialData, }: {
         document: DocumentNode | TypedDocumentNode<TData, TVariables>;
@@ -85,4 +179,4 @@ export declare class LocalState<TResolvers extends LocalState.Resolvers = LocalS
     private collectQueryDetail;
 }
 export {};
-//# sourceMappingURL=LocalState.d.ts.map
+//# sourceMappingURL=LocalState.d.ts.map

package/local-state/LocalState.js

@@ -5,6 +5,35 @@ import { stripTypename } from "@apollo/client/utilities";
 import { __DEV__ } from "@apollo/client/utilities/environment";
 import { argumentsObjectFromField, createFragmentMap, dealias, getFragmentDefinitions, getMainDefinition, hasDirectives, mergeDeep, mergeDeepArray, resultKeyNameFromField, shouldInclude, } from "@apollo/client/utilities/internal";
 import { invariant, newInvariantError, } from "@apollo/client/utilities/invariant";
+/**
+ * LocalState enables the use of `@client` fields in GraphQL operations.
+ *
+ * `@client` fields are resolved locally using resolver functions rather than
+ * being sent to the GraphQL server. This allows you to mix local and remote
+ * data in a single query.
+ *
+ * @example
+ *
+ * ```ts
+ * import { LocalState } from "@apollo/client/local-state";
+ *
+ * const localState = new LocalState({
+ *   resolvers: {
+ *     Query: {
+ *       isLoggedIn: () => !!localStorage.getItem("token"),
+ *     },
+ *   },
+ * });
+ *
+ * const client = new ApolloClient({
+ *   cache: new InMemoryCache(),
+ *   localState,
+ * });
+ * ```
+ *
+ * @template TResolvers - The type of resolvers map for type checking
+ * @template TContext - The type of context value for resolvers
+ */
 export class LocalState {
     context;
     resolvers = {};
@@ -15,12 +44,29 @@ export class LocalState {
             this.addResolvers(options.resolvers);
         }
     }
+    /**
+     * Add resolvers to the local state. New resolvers will be merged with
+     * existing ones, with new resolvers taking precedence over existing ones
+     * for the same field.
+     *
+     * @param resolvers - The resolvers to add
+     *
+     * @example
+     *
+     * ```ts
+     * localState.addResolvers({
+     *   Query: {
+     *     newField: () => "Hello World",
+     *   },
+     * });
+     * ```
+     */
     addResolvers(resolvers) {
         this.resolvers = mergeDeep(this.resolvers, resolvers);
     }
     async execute({ document, client, context, remoteResult, variables = {}, onlyRunForcedResolvers = false, returnPartialData = false, }) {
         if (__DEV__) {
-            invariant(hasDirectives(["client"], document), 48);
+            invariant(hasDirectives(["client"], document), 47);
             validateCacheImplementation(client.cache);
         }
         // note: if `remoteResult` is `undefined`, we will execute resolvers since
@@ -73,7 +119,7 @@ export class LocalState {
     }
     async getExportedVariables({ document, client, context, variables, }) {
         if (__DEV__) {
-            invariant(hasDirectives(["client"], document), 49);
+            invariant(hasDirectives(["client"], document), 48);
             validateCacheImplementation(client.cache);
         }
         const { exportsToResolve, exportedVariableDefs, fragmentMap, operationDefinition, } = this.collectQueryDetail(document);
@@ -155,7 +201,7 @@ export class LocalState {
             }
             if (selection.kind === Kind.FRAGMENT_SPREAD) {
                 const fragment = fragmentMap[selection.name.value];
-                invariant(fragment, 50, selection.name.value);
+                invariant(fragment, 49, selection.name.value);
                 const typename = rootValue?.__typename;
                 const typeCondition = fragment.typeCondition.name.value;
                 const matches = typename === typeCondition ||
@@ -283,13 +329,13 @@ export class LocalState {
         if (result === undefined && !returnPartialData) {
             if (__DEV__ && phase === "resolve") {
                 if (resolver && !onlyRunForcedResolvers) {
-                    __DEV__ && invariant.warn(51, resolverName);
+                    __DEV__ && invariant.warn(50, resolverName);
                 }
                 else if (onlyRunForcedResolvers) {
-                    __DEV__ && invariant.warn(52, resolverName);
+                    __DEV__ && invariant.warn(51, resolverName);
                 }
                 else {
-                    __DEV__ && invariant.warn(53, fieldName, rootValue);
+                    __DEV__ && invariant.warn(52, fieldName, rootValue);
                 }
             }
             result = null;
@@ -301,7 +347,7 @@ export class LocalState {
             return this.resolveSubSelectedArray(field, true, result, execContext, path);
         }
         if (phase === "resolve" && !result.__typename) {
-            this.addError(newInvariantError(54, result, resolverName), path, execContext, { resolver: resolverName });
+            this.addError(newInvariantError(53, result, resolverName), path, execContext, { resolver: resolverName });
             return null;
         }
         return this.resolveSelectionSet(field.selectionSet, true, result, execContext, path);
@@ -412,7 +458,7 @@ export class LocalState {
                 },
                 FragmentSpread(spread, _, __, ___, ancestors) {
                     const fragment = fragmentMap[spread.name.value];
-                    invariant(fragment, 55, spread.name.value);
+                    invariant(fragment, 54, spread.name.value);
                     const { selectionsToResolve: fragmentSelections } = traverse(fragment);
                     if (fragmentSelections.size > 0) {
                         // Fragment for this spread contains @client directive (either directly or transitively)
@@ -471,7 +517,7 @@ function getExportedVariableName(directive) {
     }
 }
 function validateCacheImplementation(cache) {
-    invariant(cache.fragmentMatches, 56);
+    invariant(cache.fragmentMatches, 55);
 }
 function getCacheResultAtPath(diff, path) {
     if (diff.result === null) {