@apollo/client 4.0.0-rc.7 → 4.0.0-rc.9

package/link/schema/index.d.ts

@@ -2,28 +2,150 @@ import type { GraphQLSchema } from "graphql";
 import { Observable } from "rxjs";
 import { ApolloLink } from "@apollo/client/link";
 export declare namespace SchemaLink {
+    namespace SchemaLinkDocumentationTypes {
+        /**
+         * A function that returns the resolver context for a given operation.
+         *
+         * This function is called for each operation and allows you to create
+         * operation-specific context. This is useful when you need to include
+         * information from the operation (like headers, variables, etc.) in the
+         * resolver context.
+         *
+         * @param operation - The Apollo Link operation
+         * @returns The resolver context object or a promise that resolves to the context
+         *
+         * @example
+         *
+         * ```ts
+         * const link = new SchemaLink({
+         *   schema,
+         *   context: (operation) => {
+         *     return {
+         *       userId: operation.getContext().userId,
+         *       dataSources: {
+         *         userAPI: new UserAPI(),
+         *       },
+         *     };
+         *   },
+         * });
+         * ```
+         */
+        function ResolverContextFunction(operation: ApolloLink.Operation): SchemaLink.ResolverContext | PromiseLike<SchemaLink.ResolverContext>;
+    }
+    /**
+     * The resolver context object passed to GraphQL resolvers.
+     *
+     * This context object is passed as the third parameter to GraphQL resolvers
+     * and typically contains data-fetching connectors, authentication information,
+     * and other request-specific data.
+     */
     type ResolverContext = Record<string, any>;
-    type ResolverContextFunction = (operation: ApolloLink.Operation) => ResolverContext | PromiseLike<ResolverContext>;
+    /**
+    * A function that returns the resolver context for a given operation.
+    * 
+    * This function is called for each operation and allows you to create
+    * operation-specific context. This is useful when you need to include
+    * information from the operation (like headers, variables, etc.) in the
+    * resolver context.
+    * 
+    * @param operation - The Apollo Link operation
+    * @returns The resolver context object or a promise that resolves to the context
+    * 
+    * @example
+    * 
+    * ```ts
+    * const link = new SchemaLink({
+    *   schema,
+    *   context: (operation) => {
+    *     return {
+    *       userId: operation.getContext().userId,
+    *       dataSources: {
+    *         userAPI: new UserAPI(),
+    *       },
+    *     };
+    *   },
+    * });
+    * ```
+    */
+    type ResolverContextFunction = (operation: ApolloLink.Operation) => SchemaLink.ResolverContext | PromiseLike<SchemaLink.ResolverContext>;
+    /**
+     * Options for configuring the `SchemaLink`.
+     */
     interface Options {
         /**
-         * The schema to generate responses from.
+         * An executable GraphQL schema to use for operation execution.
+         *
+         * @remarks
+         *
+         * This should be a complete, executable GraphQL schema created using
+         * tools like `makeExecutableSchema` from `@graphql-tools/schema` or
+         * `buildSchema` from `graphql`.
+         *
+         * @example
+         *
+         * ```ts
+         * import { makeExecutableSchema } from "@graphql-tools/schema";
+         *
+         * const schema = makeExecutableSchema({
+         *   typeDefs,
+         *   resolvers,
+         * });
+         *
+         * const link = new SchemaLink({ schema });
+         * ```
          */
         schema: GraphQLSchema;
         /**
-         * The root value to use when generating responses.
+         * The root value passed to root-level resolvers. It's typically not used in
+         * most schemas but can be useful for certain advanced patterns.
          */
         rootValue?: any;
         /**
-         * A context to provide to resolvers declared within the schema.
+         * Context object or function that returns the context object to provide to
+         * resolvers. The context is passed as the third parameter to all GraphQL
+         * resolvers.
+         *
+         * - If a static object is provided, the same context will be used for all
+         *   operations
+         * - If a function is provided, the function is called for each operation to
+         *   generate operation-specific context
          */
-        context?: ResolverContext | ResolverContextFunction;
+        context?: SchemaLink.ResolverContext | SchemaLink.ResolverContextFunction;
         /**
-         * Validate incoming queries against the given schema, returning
-         * validation errors as a GraphQL server would.
+         * Whether to validate incoming queries against the schema before execution.
+         *
+         * When enabled, queries will be validated against the schema before execution,
+         * and validation errors will be returned in the result's `errors` array,
+         * just like a remote GraphQL server would.
+         *
+         * This is useful for testing and development to catch query errors early,
+         * but may add overhead in production environments.
+         *
+         * @defaultValue false
          */
         validate?: boolean;
     }
 }
+/**
+ * `SchemaLink` is a terminating link that executes GraphQL operations against
+ * a local GraphQL schema instead of making network requests. This is commonly
+ * used for server-side rendering (SSR) and mocking dataa.
+ *
+ * > [!NOTE]
+ * > While `SchemaLink` can provide GraphQL results on the client, the GraphQL
+ * > execution layer is [quite large](https://bundlephobia.com/result?p=graphql) for practical client-side use.
+ * > For client-side state management, consider Apollo Client's [local state management](https://apollographql.com/docs/react/local-state/local-state-management/)
+ * > functionality instead, which integrates with the Apollo Client cache.
+ *
+ * @example
+ *
+ * ```ts
+ * import { SchemaLink } from "@apollo/client/link/schema";
+ * import schema from "./path/to/your/schema";
+ *
+ * const link = new SchemaLink({ schema });
+ * ```
+ */
 export declare class SchemaLink extends ApolloLink {
     schema: SchemaLink.Options["schema"];
     rootValue: SchemaLink.Options["rootValue"];
@@ -32,4 +154,4 @@ export declare class SchemaLink extends ApolloLink {
     constructor(options: SchemaLink.Options);
     request(operation: ApolloLink.Operation): Observable<ApolloLink.Result>;
 }
-//# sourceMappingURL=index.d.ts.map
+//# sourceMappingURL=index.d.ts.map

package/link/schema/index.js

@@ -1,6 +1,26 @@
 import { execute, validate } from "graphql";
 import { Observable } from "rxjs";
 import { ApolloLink } from "@apollo/client/link";
+/**
+ * `SchemaLink` is a terminating link that executes GraphQL operations against
+ * a local GraphQL schema instead of making network requests. This is commonly
+ * used for server-side rendering (SSR) and mocking dataa.
+ *
+ * > [!NOTE]
+ * > While `SchemaLink` can provide GraphQL results on the client, the GraphQL
+ * > execution layer is [quite large](https://bundlephobia.com/result?p=graphql) for practical client-side use.
+ * > For client-side state management, consider Apollo Client's [local state management](https://apollographql.com/docs/react/local-state/local-state-management/)
+ * > functionality instead, which integrates with the Apollo Client cache.
+ *
+ * @example
+ *
+ * ```ts
+ * import { SchemaLink } from "@apollo/client/link/schema";
+ * import schema from "./path/to/your/schema";
+ *
+ * const link = new SchemaLink({ schema });
+ * ```
+ */
 export class SchemaLink extends ApolloLink {
     schema;
     rootValue;

package/link/schema/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/link/schema/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAElC,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAgCjD,MAAM,OAAO,UAAW,SAAQ,UAAU;IACjC,MAAM,CAA+B;IACrC,SAAS,CAAkC;IAC3C,OAAO,CAAgC;IACvC,QAAQ,CAAU;IAEzB,YAAY,OAA2B;QACrC,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;IACrC,CAAC;IAEM,OAAO,CACZ,SAA+B;QAE/B,OAAO,IAAI,UAAU,CAAoB,CAAC,QAAQ,EAAE,EAAE;YACpD,IAAI,OAAO,CAA6B,CAAC,OAAO,EAAE,EAAE,CAClD,OAAO,CACL,OAAO,IAAI,CAAC,OAAO,KAAK,UAAU,CAAC,CAAC;gBAClC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC;gBACzB,CAAC,CAAC,IAAI,CAAC,OAAO,CACf,CACF;iBACE,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;gBAChB,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;oBAClB,MAAM,gBAAgB,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC;oBAChE,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;wBAChC,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,CAAC;oBACtC,CAAC;gBACH,CAAC;gBAED,OAAO,OAAO,CAAC;oBACb,MAAM,EAAE,IAAI,CAAC,MAAM;oBACnB,QAAQ,EAAE,SAAS,CAAC,KAAK;oBACzB,SAAS,EAAE,IAAI,CAAC,SAAS;oBACzB,YAAY,EAAE,OAAO;oBACrB,cAAc,EAAE,SAAS,CAAC,SAAS;oBACnC,aAAa,EAAE,SAAS,CAAC,aAAa;iBACvC,CAAC,CAAC;YACL,CAAC,CAAC;iBACD,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;gBACb,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;oBACrB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;oBACpB,QAAQ,CAAC,QAAQ,EAAE,CAAC;gBACtB,CAAC;YACH,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBACf,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;oBACrB,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBACxB,CAAC;YACH,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["import type { GraphQLSchema } from \"graphql\";\nimport { execute, validate } from \"graphql\";\nimport { Observable } from \"rxjs\";\n\nimport { ApolloLink } from \"@apollo/client/link\";\n\nexport declare namespace SchemaLink {\n  export type ResolverContext = Record<string, any>;\n  export type ResolverContextFunction = (\n    operation: ApolloLink.Operation\n  ) => ResolverContext | PromiseLike<ResolverContext>;\n\n  export interface Options {\n    /**\n     * The schema to generate responses from.\n     */\n    schema: GraphQLSchema;\n\n    /**\n     * The root value to use when generating responses.\n     */\n    rootValue?: any;\n\n    /**\n     * A context to provide to resolvers declared within the schema.\n     */\n    context?: ResolverContext | ResolverContextFunction;\n\n    /**\n     * Validate incoming queries against the given schema, returning\n     * validation errors as a GraphQL server would.\n     */\n    validate?: boolean;\n  }\n}\n\nexport class SchemaLink extends ApolloLink {\n  public schema: SchemaLink.Options[\"schema\"];\n  public rootValue: SchemaLink.Options[\"rootValue\"];\n  public context: SchemaLink.Options[\"context\"];\n  public validate: boolean;\n\n  constructor(options: SchemaLink.Options) {\n    super();\n    this.schema = options.schema;\n    this.rootValue = options.rootValue;\n    this.context = options.context;\n    this.validate = !!options.validate;\n  }\n\n  public request(\n    operation: ApolloLink.Operation\n  ): Observable<ApolloLink.Result> {\n    return new Observable<ApolloLink.Result>((observer) => {\n      new Promise<SchemaLink.ResolverContext>((resolve) =>\n        resolve(\n          typeof this.context === \"function\" ?\n            this.context(operation)\n          : this.context\n        )\n      )\n        .then((context) => {\n          if (this.validate) {\n            const validationErrors = validate(this.schema, operation.query);\n            if (validationErrors.length > 0) {\n              return { errors: validationErrors };\n            }\n          }\n\n          return execute({\n            schema: this.schema,\n            document: operation.query,\n            rootValue: this.rootValue,\n            contextValue: context,\n            variableValues: operation.variables,\n            operationName: operation.operationName,\n          });\n        })\n        .then((data) => {\n          if (!observer.closed) {\n            observer.next(data);\n            observer.complete();\n          }\n        })\n        .catch((error) => {\n          if (!observer.closed) {\n            observer.error(error);\n          }\n        });\n    });\n  }\n}\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/link/schema/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAElC,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AA+GjD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,OAAO,UAAW,SAAQ,UAAU;IACjC,MAAM,CAA+B;IACrC,SAAS,CAAkC;IAC3C,OAAO,CAAgC;IACvC,QAAQ,CAAU;IAEzB,YAAY,OAA2B;QACrC,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;IACrC,CAAC;IAEM,OAAO,CACZ,SAA+B;QAE/B,OAAO,IAAI,UAAU,CAAoB,CAAC,QAAQ,EAAE,EAAE;YACpD,IAAI,OAAO,CAA6B,CAAC,OAAO,EAAE,EAAE,CAClD,OAAO,CACL,OAAO,IAAI,CAAC,OAAO,KAAK,UAAU,CAAC,CAAC;gBAClC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC;gBACzB,CAAC,CAAC,IAAI,CAAC,OAAO,CACf,CACF;iBACE,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;gBAChB,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;oBAClB,MAAM,gBAAgB,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC;oBAChE,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;wBAChC,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,CAAC;oBACtC,CAAC;gBACH,CAAC;gBAED,OAAO,OAAO,CAAC;oBACb,MAAM,EAAE,IAAI,CAAC,MAAM;oBACnB,QAAQ,EAAE,SAAS,CAAC,KAAK;oBACzB,SAAS,EAAE,IAAI,CAAC,SAAS;oBACzB,YAAY,EAAE,OAAO;oBACrB,cAAc,EAAE,SAAS,CAAC,SAAS;oBACnC,aAAa,EAAE,SAAS,CAAC,aAAa;iBACvC,CAAC,CAAC;YACL,CAAC,CAAC;iBACD,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;gBACb,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;oBACrB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;oBACpB,QAAQ,CAAC,QAAQ,EAAE,CAAC;gBACtB,CAAC;YACH,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBACf,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;oBACrB,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBACxB,CAAC;YACH,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["import type { GraphQLSchema } from \"graphql\";\nimport { execute, validate } from \"graphql\";\nimport { Observable } from \"rxjs\";\n\nimport { ApolloLink } from \"@apollo/client/link\";\n\nexport declare namespace SchemaLink {\n  export namespace SchemaLinkDocumentationTypes {\n    /**\n     * A function that returns the resolver context for a given operation.\n     *\n     * This function is called for each operation and allows you to create\n     * operation-specific context. This is useful when you need to include\n     * information from the operation (like headers, variables, etc.) in the\n     * resolver context.\n     *\n     * @param operation - The Apollo Link operation\n     * @returns The resolver context object or a promise that resolves to the context\n     *\n     * @example\n     *\n     * ```ts\n     * const link = new SchemaLink({\n     *   schema,\n     *   context: (operation) => {\n     *     return {\n     *       userId: operation.getContext().userId,\n     *       dataSources: {\n     *         userAPI: new UserAPI(),\n     *       },\n     *     };\n     *   },\n     * });\n     * ```\n     */\n    export function ResolverContextFunction(\n      operation: ApolloLink.Operation\n    ): SchemaLink.ResolverContext | PromiseLike<SchemaLink.ResolverContext>;\n  }\n  /**\n   * The resolver context object passed to GraphQL resolvers.\n   *\n   * This context object is passed as the third parameter to GraphQL resolvers\n   * and typically contains data-fetching connectors, authentication information,\n   * and other request-specific data.\n   */\n  export type ResolverContext = Record<string, any>;\n\n  /** {@inheritDoc @apollo/client/link/schema!SchemaLink.SchemaLinkDocumentationTypes.ResolverContextFunction:function(1)} */\n  export type ResolverContextFunction = (\n    operation: ApolloLink.Operation\n  ) => SchemaLink.ResolverContext | PromiseLike<SchemaLink.ResolverContext>;\n\n  /**\n   * Options for configuring the `SchemaLink`.\n   */\n  export interface Options {\n    /**\n     * An executable GraphQL schema to use for operation execution.\n     *\n     * @remarks\n     *\n     * This should be a complete, executable GraphQL schema created using\n     * tools like `makeExecutableSchema` from `@graphql-tools/schema` or\n     * `buildSchema` from `graphql`.\n     *\n     * @example\n     *\n     * ```ts\n     * import { makeExecutableSchema } from \"@graphql-tools/schema\";\n     *\n     * const schema = makeExecutableSchema({\n     *   typeDefs,\n     *   resolvers,\n     * });\n     *\n     * const link = new SchemaLink({ schema });\n     * ```\n     */\n    schema: GraphQLSchema;\n\n    /**\n     * The root value passed to root-level resolvers. It's typically not used in\n     * most schemas but can be useful for certain advanced patterns.\n     */\n    rootValue?: any;\n\n    /**\n     * Context object or function that returns the context object to provide to\n     * resolvers. The context is passed as the third parameter to all GraphQL\n     * resolvers.\n     *\n     * - If a static object is provided, the same context will be used for all\n     *   operations\n     * - If a function is provided, the function is called for each operation to\n     *   generate operation-specific context\n     */\n    context?: SchemaLink.ResolverContext | SchemaLink.ResolverContextFunction;\n\n    /**\n     * Whether to validate incoming queries against the schema before execution.\n     *\n     * When enabled, queries will be validated against the schema before execution,\n     * and validation errors will be returned in the result's `errors` array,\n     * just like a remote GraphQL server would.\n     *\n     * This is useful for testing and development to catch query errors early,\n     * but may add overhead in production environments.\n     *\n     * @defaultValue false\n     */\n    validate?: boolean;\n  }\n}\n\n/**\n * `SchemaLink` is a terminating link that executes GraphQL operations against\n * a local GraphQL schema instead of making network requests. This is commonly\n * used for server-side rendering (SSR) and mocking dataa.\n *\n * > [!NOTE]\n * > While `SchemaLink` can provide GraphQL results on the client, the GraphQL\n * > execution layer is [quite large](https://bundlephobia.com/result?p=graphql) for practical client-side use.\n * > For client-side state management, consider Apollo Client's [local state management](https://apollographql.com/docs/react/local-state/local-state-management/)\n * > functionality instead, which integrates with the Apollo Client cache.\n *\n * @example\n *\n * ```ts\n * import { SchemaLink } from \"@apollo/client/link/schema\";\n * import schema from \"./path/to/your/schema\";\n *\n * const link = new SchemaLink({ schema });\n * ```\n */\nexport class SchemaLink extends ApolloLink {\n  public schema: SchemaLink.Options[\"schema\"];\n  public rootValue: SchemaLink.Options[\"rootValue\"];\n  public context: SchemaLink.Options[\"context\"];\n  public validate: boolean;\n\n  constructor(options: SchemaLink.Options) {\n    super();\n    this.schema = options.schema;\n    this.rootValue = options.rootValue;\n    this.context = options.context;\n    this.validate = !!options.validate;\n  }\n\n  public request(\n    operation: ApolloLink.Operation\n  ): Observable<ApolloLink.Result> {\n    return new Observable<ApolloLink.Result>((observer) => {\n      new Promise<SchemaLink.ResolverContext>((resolve) =>\n        resolve(\n          typeof this.context === \"function\" ?\n            this.context(operation)\n          : this.context\n        )\n      )\n        .then((context) => {\n          if (this.validate) {\n            const validationErrors = validate(this.schema, operation.query);\n            if (validationErrors.length > 0) {\n              return { errors: validationErrors };\n            }\n          }\n\n          return execute({\n            schema: this.schema,\n            document: operation.query,\n            rootValue: this.rootValue,\n            contextValue: context,\n            variableValues: operation.variables,\n            operationName: operation.operationName,\n          });\n        })\n        .then((data) => {\n          if (!observer.closed) {\n            observer.next(data);\n            observer.complete();\n          }\n        })\n        .catch((error) => {\n          if (!observer.closed) {\n            observer.error(error);\n          }\n        });\n    });\n  }\n}\n"]}

package/link/subscriptions/index.d.ts

@@ -1,6 +1,29 @@
 import type { Client } from "graphql-ws";
 import { Observable } from "rxjs";
 import { ApolloLink } from "@apollo/client/link";
+/**
+ * The `GraphQLWsLink` is a terminating link sends GraphQL operations over a
+ * WebSocket connection using the [`graphql-ws`](https://www.npmjs.com/package/graphql-ws) library. It's used most
+ * commonly with GraphQL [subscriptions](https://apollographql.com/docs/react/data/subscriptions/),
+ *
+ * > [!NOTE]
+ * > This link works with the `graphql-ws` library. If your server uses
+ * > the deprecated `subscriptions-transport-ws` library, use the deprecated
+ * > [`WebSocketLink`](https://apollographql.com/docs/react/api/link/apollo-link-ws) link instead.
+ *
+ * @example
+ *
+ * ```ts
+ * import { GraphQLWsLink } from "@apollo/client/link/subscriptions";
+ * import { createClient } from "graphql-ws";
+ *
+ * const link = new GraphQLWsLink(
+ *   createClient({
+ *     url: "ws://localhost:3000/subscriptions",
+ *   })
+ * );
+ * ```
+ */
 export declare class GraphQLWsLink extends ApolloLink {
     readonly client: Client;
     constructor(client: Client);

package/link/subscriptions/index.js

@@ -40,6 +40,29 @@ function isLikeCloseEvent(val) {
 function isLikeErrorEvent(err) {
     return isNonNullObject(err) && err.target?.readyState === WebSocket.CLOSED;
 }
+/**
+ * The `GraphQLWsLink` is a terminating link sends GraphQL operations over a
+ * WebSocket connection using the [`graphql-ws`](https://www.npmjs.com/package/graphql-ws) library. It's used most
+ * commonly with GraphQL [subscriptions](https://apollographql.com/docs/react/data/subscriptions/),
+ *
+ * > [!NOTE]
+ * > This link works with the `graphql-ws` library. If your server uses
+ * > the deprecated `subscriptions-transport-ws` library, use the deprecated
+ * > [`WebSocketLink`](https://apollographql.com/docs/react/api/link/apollo-link-ws) link instead.
+ *
+ * @example
+ *
+ * ```ts
+ * import { GraphQLWsLink } from "@apollo/client/link/subscriptions";
+ * import { createClient } from "graphql-ws";
+ *
+ * const link = new GraphQLWsLink(
+ *   createClient({
+ *     url: "ws://localhost:3000/subscriptions",
+ *   })
+ * );
+ * ```
+ */
 export class GraphQLWsLink extends ApolloLink {
     client;
     constructor(client) {

package/link/subscriptions/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/link/subscriptions/index.ts"],"names":[],"mappings":"AAAA,wDAAwD;AACxD,0CAA0C;AAC1C,EAAE;AACF,+EAA+E;AAC/E,0CAA0C;AAC1C,EAAE;AACF,2CAA2C;AAC3C,EAAE;AACF,wBAAwB;AACxB,EAAE;AACF,yCAAyC;AACzC,EAAE;AACF,+EAA+E;AAC/E,gFAAgF;AAChF,+EAA+E;AAC/E,4EAA4E;AAC5E,wEAAwE;AACxE,2DAA2D;AAC3D,EAAE;AACF,6EAA6E;AAC7E,sDAAsD;AACtD,EAAE;AACF,6EAA6E;AAC7E,2EAA2E;AAC3E,8EAA8E;AAC9E,yEAAyE;AACzE,gFAAgF;AAChF,4EAA4E;AAC5E,gBAAgB;AAIhB,OAAO,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAElC,OAAO,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,KAAK,EAAE,MAAM,0BAA0B,CAAC;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAC;AAEpE,yEAAyE;AACzE,SAAS,gBAAgB,CAAC,GAAY;IACpC,OAAO,eAAe,CAAC,GAAG,CAAC,IAAI,MAAM,IAAI,GAAG,IAAI,QAAQ,IAAI,GAAG,CAAC;AAClE,CAAC;AAED,yEAAyE;AACzE,SAAS,gBAAgB,CAAC,GAAY;IACpC,OAAO,eAAe,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,MAAM,EAAE,UAAU,KAAK,SAAS,CAAC,MAAM,CAAC;AAC7E,CAAC;AAED,MAAM,OAAO,aAAc,SAAQ,UAAU;IACf;IAA5B,YAA4B,MAAc;QACxC,KAAK,EAAE,CAAC;QADkB,WAAM,GAAN,MAAM,CAAQ;IAE1C,CAAC;IAEM,OAAO,CACZ,SAA+B;QAE/B,OAAO,IAAI,UAAU,CAAC,CAAC,QAAQ,EAAE,EAAE;YACjC,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAC1B,EAAE,GAAG,SAAS,EAAE,KAAK,EAAE,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,EAC/C;gBACE,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC;gBAClC,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC;gBAC1C,KAAK,EAAE,CAAC,GAAG,EAAE,EAAE;oBACb,IAAI,GAAG,YAAY,KAAK,EAAE,CAAC;wBACzB,OAAO,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;oBAC7B,CAAC;oBACD,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC;oBACxC,IAAI,SAAS,IAAI,gBAAgB,CAAC,GAAG,CAAC,EAAE,CAAC;wBACvC,OAAO,QAAQ,CAAC,KAAK;wBACnB,2CAA2C;wBAC3C,IAAI,KAAK,CACP,gBAAgB,SAAS,CAAC,CAAC,CAAC,eAAe,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,GACxD,SAAS,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EACjC,EAAE,CACH,CACF,CAAC;oBACJ,CAAC;oBAED,OAAO,QAAQ,CAAC,KAAK,CACnB,IAAI,qBAAqB,CAAC;wBACxB,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;qBACzC,CAAC,CACH,CAAC;gBACJ,CAAC;gBACD,+FAA+F;aAChD,CAClD,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["// This file is adapted from the graphql-ws npm package:\n// https://github.com/enisdenjo/graphql-ws\n//\n// Most of the file comes from that package's README; some other parts (such as\n// isLikeCloseEvent) come from its source.\n//\n// Here's the license of the original code:\n//\n// The MIT License (MIT)\n//\n// Copyright (c) 2020-2021 Denis Badurina\n//\n// Permission is hereby granted, free of charge, to any person obtaining a copy\n// of this software and associated documentation files (the \"Software\"), to deal\n// in the Software without restriction, including without limitation the rights\n// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n// copies of the Software, and to permit persons to whom the Software is\n// furnished to do so, subject to the following conditions:\n//\n// The above copyright notice and this permission notice shall be included in\n// all copies or substantial portions of the Software.\n//\n// THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n// THE SOFTWARE.\n\nimport type { FormattedExecutionResult } from \"graphql\";\nimport type { Client, Sink } from \"graphql-ws\";\nimport { Observable } from \"rxjs\";\n\nimport { CombinedGraphQLErrors } from \"@apollo/client/errors\";\nimport { ApolloLink } from \"@apollo/client/link\";\nimport { print } from \"@apollo/client/utilities\";\nimport { isNonNullObject } from \"@apollo/client/utilities/internal\";\n\n// https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/close_event\nfunction isLikeCloseEvent(val: unknown): val is CloseEvent {\n  return isNonNullObject(val) && \"code\" in val && \"reason\" in val;\n}\n\n// https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/error_event\nfunction isLikeErrorEvent(err: unknown): err is Event {\n  return isNonNullObject(err) && err.target?.readyState === WebSocket.CLOSED;\n}\n\nexport class GraphQLWsLink extends ApolloLink {\n  constructor(public readonly client: Client) {\n    super();\n  }\n\n  public request(\n    operation: ApolloLink.Operation\n  ): Observable<ApolloLink.Result> {\n    return new Observable((observer) => {\n      return this.client.subscribe<ApolloLink.Result>(\n        { ...operation, query: print(operation.query) },\n        {\n          next: observer.next.bind(observer),\n          complete: observer.complete.bind(observer),\n          error: (err) => {\n            if (err instanceof Error) {\n              return observer.error(err);\n            }\n            const likeClose = isLikeCloseEvent(err);\n            if (likeClose || isLikeErrorEvent(err)) {\n              return observer.error(\n                // reason will be available on clean closes\n                new Error(\n                  `Socket closed${likeClose ? ` with event ${err.code}` : \"\"}${\n                    likeClose ? ` ${err.reason}` : \"\"\n                  }`\n                )\n              );\n            }\n\n            return observer.error(\n              new CombinedGraphQLErrors({\n                errors: Array.isArray(err) ? err : [err],\n              })\n            );\n          },\n          // casting around a wrong type in graphql-ws, which incorrectly expects `Sink<ExecutionResult>`\n        } satisfies Sink<FormattedExecutionResult> as any\n      );\n    });\n  }\n}\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/link/subscriptions/index.ts"],"names":[],"mappings":"AAAA,wDAAwD;AACxD,0CAA0C;AAC1C,EAAE;AACF,+EAA+E;AAC/E,0CAA0C;AAC1C,EAAE;AACF,2CAA2C;AAC3C,EAAE;AACF,wBAAwB;AACxB,EAAE;AACF,yCAAyC;AACzC,EAAE;AACF,+EAA+E;AAC/E,gFAAgF;AAChF,+EAA+E;AAC/E,4EAA4E;AAC5E,wEAAwE;AACxE,2DAA2D;AAC3D,EAAE;AACF,6EAA6E;AAC7E,sDAAsD;AACtD,EAAE;AACF,6EAA6E;AAC7E,2EAA2E;AAC3E,8EAA8E;AAC9E,yEAAyE;AACzE,gFAAgF;AAChF,4EAA4E;AAC5E,gBAAgB;AAIhB,OAAO,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAElC,OAAO,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,KAAK,EAAE,MAAM,0BAA0B,CAAC;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAC;AAEpE,yEAAyE;AACzE,SAAS,gBAAgB,CAAC,GAAY;IACpC,OAAO,eAAe,CAAC,GAAG,CAAC,IAAI,MAAM,IAAI,GAAG,IAAI,QAAQ,IAAI,GAAG,CAAC;AAClE,CAAC;AAED,yEAAyE;AACzE,SAAS,gBAAgB,CAAC,GAAY;IACpC,OAAO,eAAe,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,MAAM,EAAE,UAAU,KAAK,SAAS,CAAC,MAAM,CAAC;AAC7E,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,OAAO,aAAc,SAAQ,UAAU;IACf;IAA5B,YAA4B,MAAc;QACxC,KAAK,EAAE,CAAC;QADkB,WAAM,GAAN,MAAM,CAAQ;IAE1C,CAAC;IAEM,OAAO,CACZ,SAA+B;QAE/B,OAAO,IAAI,UAAU,CAAC,CAAC,QAAQ,EAAE,EAAE;YACjC,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAC1B,EAAE,GAAG,SAAS,EAAE,KAAK,EAAE,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,EAC/C;gBACE,IAAI,EAAE,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC;gBAClC,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC;gBAC1C,KAAK,EAAE,CAAC,GAAG,EAAE,EAAE;oBACb,IAAI,GAAG,YAAY,KAAK,EAAE,CAAC;wBACzB,OAAO,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;oBAC7B,CAAC;oBACD,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC;oBACxC,IAAI,SAAS,IAAI,gBAAgB,CAAC,GAAG,CAAC,EAAE,CAAC;wBACvC,OAAO,QAAQ,CAAC,KAAK;wBACnB,2CAA2C;wBAC3C,IAAI,KAAK,CACP,gBAAgB,SAAS,CAAC,CAAC,CAAC,eAAe,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,GACxD,SAAS,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EACjC,EAAE,CACH,CACF,CAAC;oBACJ,CAAC;oBAED,OAAO,QAAQ,CAAC,KAAK,CACnB,IAAI,qBAAqB,CAAC;wBACxB,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;qBACzC,CAAC,CACH,CAAC;gBACJ,CAAC;gBACD,+FAA+F;aAChD,CAClD,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["// This file is adapted from the graphql-ws npm package:\n// https://github.com/enisdenjo/graphql-ws\n//\n// Most of the file comes from that package's README; some other parts (such as\n// isLikeCloseEvent) come from its source.\n//\n// Here's the license of the original code:\n//\n// The MIT License (MIT)\n//\n// Copyright (c) 2020-2021 Denis Badurina\n//\n// Permission is hereby granted, free of charge, to any person obtaining a copy\n// of this software and associated documentation files (the \"Software\"), to deal\n// in the Software without restriction, including without limitation the rights\n// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n// copies of the Software, and to permit persons to whom the Software is\n// furnished to do so, subject to the following conditions:\n//\n// The above copyright notice and this permission notice shall be included in\n// all copies or substantial portions of the Software.\n//\n// THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n// THE SOFTWARE.\n\nimport type { FormattedExecutionResult } from \"graphql\";\nimport type { Client, Sink } from \"graphql-ws\";\nimport { Observable } from \"rxjs\";\n\nimport { CombinedGraphQLErrors } from \"@apollo/client/errors\";\nimport { ApolloLink } from \"@apollo/client/link\";\nimport { print } from \"@apollo/client/utilities\";\nimport { isNonNullObject } from \"@apollo/client/utilities/internal\";\n\n// https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/close_event\nfunction isLikeCloseEvent(val: unknown): val is CloseEvent {\n  return isNonNullObject(val) && \"code\" in val && \"reason\" in val;\n}\n\n// https://developer.mozilla.org/en-US/docs/Web/API/WebSocket/error_event\nfunction isLikeErrorEvent(err: unknown): err is Event {\n  return isNonNullObject(err) && err.target?.readyState === WebSocket.CLOSED;\n}\n\n/**\n * The `GraphQLWsLink` is a terminating link sends GraphQL operations over a\n * WebSocket connection using the [`graphql-ws`](https://www.npmjs.com/package/graphql-ws) library. It's used most\n * commonly with GraphQL [subscriptions](https://apollographql.com/docs/react/data/subscriptions/),\n *\n * > [!NOTE]\n * > This link works with the `graphql-ws` library. If your server uses\n * > the deprecated `subscriptions-transport-ws` library, use the deprecated\n * > [`WebSocketLink`](https://apollographql.com/docs/react/api/link/apollo-link-ws) link instead.\n *\n * @example\n *\n * ```ts\n * import { GraphQLWsLink } from \"@apollo/client/link/subscriptions\";\n * import { createClient } from \"graphql-ws\";\n *\n * const link = new GraphQLWsLink(\n *   createClient({\n *     url: \"ws://localhost:3000/subscriptions\",\n *   })\n * );\n * ```\n */\nexport class GraphQLWsLink extends ApolloLink {\n  constructor(public readonly client: Client) {\n    super();\n  }\n\n  public request(\n    operation: ApolloLink.Operation\n  ): Observable<ApolloLink.Result> {\n    return new Observable((observer) => {\n      return this.client.subscribe<ApolloLink.Result>(\n        { ...operation, query: print(operation.query) },\n        {\n          next: observer.next.bind(observer),\n          complete: observer.complete.bind(observer),\n          error: (err) => {\n            if (err instanceof Error) {\n              return observer.error(err);\n            }\n            const likeClose = isLikeCloseEvent(err);\n            if (likeClose || isLikeErrorEvent(err)) {\n              return observer.error(\n                // reason will be available on clean closes\n                new Error(\n                  `Socket closed${likeClose ? ` with event ${err.code}` : \"\"}${\n                    likeClose ? ` ${err.reason}` : \"\"\n                  }`\n                )\n              );\n            }\n\n            return observer.error(\n              new CombinedGraphQLErrors({\n                errors: Array.isArray(err) ? err : [err],\n              })\n            );\n          },\n          // casting around a wrong type in graphql-ws, which incorrectly expects `Sink<ExecutionResult>`\n        } satisfies Sink<FormattedExecutionResult> as any\n      );\n    });\n  }\n}\n"]}

package/link/ws/index.d.ts

@@ -4,24 +4,82 @@ import { SubscriptionClient } from "subscriptions-transport-ws";
 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);

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;
         }
@@ -15,4 +45,4 @@ export class WebSocketLink extends ApolloLink {
         return this.subscriptionClient.request(operation);
     }
 }
-//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/link/ws/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/link/ws/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAEhE,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AA2BjD,MAAM,OAAO,aAAc,SAAQ,UAAU;IACnC,kBAAkB,CAAqB;IAE/C,YACE,cAAgE;QAEhE,KAAK,EAAE,CAAC;QAER,IAAI,cAAc,YAAY,kBAAkB,EAAE,CAAC;YACjD,IAAI,CAAC,kBAAkB,GAAG,cAAc,CAAC;QAC3C,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,kBAAkB,GAAG,IAAI,kBAAkB,CAC9C,cAAc,CAAC,GAAG,EAClB,cAAc,CAAC,OAAO,EACtB,cAAc,CAAC,aAAa,CAC7B,CAAC;QACJ,CAAC;IACH,CAAC;IAEM,OAAO,CACZ,SAA+B;QAE/B,OAAO,IAAI,CAAC,kBAAkB,CAAC,OAAO,CACpC,SAAS,CACuB,CAAC;IACrC,CAAC;CACF","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\";\n\nexport declare 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(\n    operation: ApolloLink.Operation\n  ): Observable<ApolloLink.Result> {\n    return this.subscriptionClient.request(\n      operation\n    ) as Observable<ApolloLink.Result>;\n  }\n}\n"]}
+{"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/package.json

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

package/react/hooks/useSyncExternalStore.js

@@ -46,7 +46,7 @@ export const useSyncExternalStore = realHook ||
             value !== getSnapshot()) {
             didWarnUncachedGetSnapshot = true;
             // DEVIATION: Using invariant.error instead of console.error directly.
-            __DEV__ && invariant.error(34);
+            invariant.error(34);
         }
         // Because updates are synchronous, we don't queue them. Instead we force a
         // re-render whenever the subscribed state changes by updating an some