@apollo/client 4.0.0-rc.6 → 4.0.0-rc.8

package/__cjs/link/core/ApolloLink.d.cts

@@ -1,15 +1,361 @@
+import type { DocumentNode, FormattedExecutionResult, OperationTypeNode } from "graphql";
 import type { Observable } from "rxjs";
-import type { ExecuteContext, FetchResult, GraphQLRequest, NextLink, Operation, RequestHandler } from "./types.cjs";
+import type { ApolloClient, DefaultContext, OperationVariables } from "@apollo/client";
+import type { AdditionalApolloLinkResultTypes } from "./types.cjs";
+export declare namespace ApolloLink {
+    /**
+     * Context provided for link execution, such as the client executing the
+     * request. It is separate from the request operation context.
+     */
+    interface ExecuteContext {
+        /**
+         * The Apollo Client instance that executed the GraphQL request.
+         */
+        client: ApolloClient;
+    }
+    /**
+    * A function that when called will execute the next link in the link chain.
+    * 
+    * @example
+    * 
+    * ```ts
+    * const link = new ApolloLink((operation, forward) => {
+    *   // process the request
+    * 
+    *   // Call `forward` to execute the next link in the chain
+    *   return forward(operation);
+    * });
+    * ```
+    * 
+    * @param operation - The current `ApolloLink.Operation` object for the
+    * request.
+    */
+    type ForwardFunction = (operation: ApolloLink.Operation) => Observable<ApolloLink.Result>;
+    /**
+     * The input object provided to `ApolloLink.execute` to send a GraphQL request through
+     * the link chain.
+     */
+    interface Request {
+        /**
+         * The parsed GraphQL document that will be sent with the GraphQL request to
+         * the server.
+         */
+        query: DocumentNode;
+        /**
+         * The variables provided for the query.
+         */
+        variables?: OperationVariables;
+        /**
+         * Context provided to the link chain. Context is not sent to the server and
+         * is used to communicate additional metadata from a request to individual
+         * links in the link chain.
+         */
+        context?: DefaultContext;
+        /**
+         * A map of extensions that will be sent with the GraphQL request to the
+         * server.
+         */
+        extensions?: Record<string, any>;
+    }
+    /**
+    * A request handler is responsible for performing some logic and executing the
+    * request, either by [forwarding](https://apollographql.com/docs/react/api/link/introduction#the-request-handler) the operation to the next link in the
+    * chain, or sending the operation to the destination that executes it, such as
+    * a GraphQL server.
+    * 
+    * @param operation - The `Operation` object that provides information about the
+    * currently executed GraphQL request.
+    * 
+    * @param forward - A function that is called to execute the next link in the
+    * chain.
+    */
+    type RequestHandler = (operation: ApolloLink.Operation, forward: ApolloLink.ForwardFunction) => Observable<ApolloLink.Result>;
+    type Result<TData = Record<string, any>, TExtensions = Record<string, any>> = FormattedExecutionResult<TData, TExtensions> | AdditionalApolloLinkResultTypes<TData, TExtensions>[keyof AdditionalApolloLinkResultTypes<TData, TExtensions>];
+    /**
+     * The currently executed operation object provided to an `ApolloLink.RequestHandler`
+     * for each link in the link chain.
+     */
+    interface Operation {
+        /**
+         * A `DocumentNode` that describes the operation taking place.
+         */
+        query: DocumentNode;
+        /**
+         * A map of GraphQL variables being sent with the operation.
+         */
+        variables: OperationVariables;
+        /**
+         * The string name of the GraphQL operation. If it is anonymous,
+         * `operationName` will be `undefined`.
+         */
+        operationName: string | undefined;
+        /**
+         * The type of the GraphQL operation, such as query or mutation.
+         */
+        operationType: OperationTypeNode;
+        /**
+         * A map that stores extensions data to be sent to the server.
+         */
+        extensions: Record<string, any>;
+        /**
+         * A function that takes either a new context object, or a function which
+         * takes in the previous context and returns a new one. See [managing
+         * context](https://apollographql.com/docs/react/api/link/introduction#managing-context).
+         */
+        setContext: {
+            (context: Partial<ApolloLink.OperationContext>): void;
+            (updateContext: (previousContext: Readonly<ApolloLink.OperationContext>) => Partial<ApolloLink.OperationContext>): void;
+        };
+        /**
+         * A function that gets the current context of the request. This can be used
+         * by links to determine which actions to perform. See [managing context](https://apollographql.com/docs/react/api/link/introduction#managing-context)
+         */
+        getContext: () => Readonly<ApolloLink.OperationContext>;
+        /**
+         * The Apollo Client instance executing the request.
+         */
+        readonly client: ApolloClient;
+    }
+    /**
+     * The `context` object that can be read and modified by links using the
+     * `operation.getContext()` and `operation.setContext()` methods.
+     */
+    interface OperationContext extends DefaultContext {
+    }
+    namespace DocumentationTypes {
+        /**
+         * A request handler is responsible for performing some logic and executing the
+         * request, either by [forwarding](https://apollographql.com/docs/react/api/link/introduction#the-request-handler) the operation to the next link in the
+         * chain, or sending the operation to the destination that executes it, such as
+         * a GraphQL server.
+         *
+         * @param operation - The `Operation` object that provides information about the
+         * currently executed GraphQL request.
+         *
+         * @param forward - A function that is called to execute the next link in the
+         * chain.
+         */
+        function RequestHandler(operation: ApolloLink.Operation, forward: ApolloLink.ForwardFunction): Observable<ApolloLink.Result>;
+        /**
+         * A function that when called will execute the next link in the link chain.
+         *
+         * @example
+         *
+         * ```ts
+         * const link = new ApolloLink((operation, forward) => {
+         *   // process the request
+         *
+         *   // Call `forward` to execute the next link in the chain
+         *   return forward(operation);
+         * });
+         * ```
+         *
+         * @param operation - The current `ApolloLink.Operation` object for the
+         * request.
+         */
+        function ForwardFunction(operation: ApolloLink.Operation): Observable<ApolloLink.Result>;
+    }
+}
+/**
+ * The base class for all links in Apollo Client. A link represents either a
+ * self-contained modification to a GraphQL operation or a side effect (such as
+ * logging).
+ *
+ * @remarks
+ *
+ * Links enable you to customize Apollo Client's request flow by composing
+ * together different pieces of functionality into a chain of links. Each
+ * link represents a specific capability, such as adding authentication headers,
+ * retrying failed requests, batching operations, or sending requests to a
+ * GraphQL server.
+ *
+ * Every link must define a request handler via its constructor or by extending
+ * this class and implementing the `request` method.
+ *
+ * @example
+ *
+ * ```ts
+ * import { ApolloLink } from "@apollo/client";
+ *
+ * const link = new ApolloLink((operation, forward) => {
+ *   console.log("Operation:", operation.operationName);
+ *   return forward(operation);
+ * });
+ * ```
+ */
 export declare class ApolloLink {
+    /**
+     * Creates a link that completes immediately and does not emit a result.
+     *
+     * @example
+     *
+     * ```ts
+     * const link = ApolloLink.empty();
+     * ```
+     */
     static empty(): ApolloLink;
-    static from(links: (ApolloLink | RequestHandler)[]): ApolloLink;
-    static split(test: (op: Operation) => boolean, left: ApolloLink | RequestHandler, right?: ApolloLink | RequestHandler): ApolloLink;
-    static execute(link: ApolloLink, operation: GraphQLRequest, context: ExecuteContext): Observable<FetchResult>;
-    static concat(first: ApolloLink | RequestHandler, second: ApolloLink | RequestHandler): ApolloLink;
-    constructor(request?: RequestHandler);
-    split(test: (op: Operation) => boolean, left: ApolloLink | RequestHandler, right?: ApolloLink | RequestHandler): ApolloLink;
-    concat(next: ApolloLink | RequestHandler): ApolloLink;
-    request(operation: Operation, forward?: NextLink): Observable<FetchResult> | null;
+    /**
+     * Composes multiple links into a single composed link that executes each
+     * provided link in serial order.
+     *
+     * @example
+     *
+     * ```ts
+     * import { from, HttpLink, ApolloLink } from "@apollo/client";
+     * import { RetryLink } from "@apollo/client/link/retry";
+     * import MyAuthLink from "../auth";
+     *
+     * const link = ApolloLink.from([
+     *   new RetryLink(),
+     *   new MyAuthLink(),
+     *   new HttpLink({ uri: "http://localhost:4000/graphql" }),
+     * ]);
+     * ```
+     *
+     * @param links - An array of `ApolloLink` instances or request handlers that
+     * are executed in serial order.
+     */
+    static from(links: ApolloLink[]): ApolloLink;
+    /**
+     * Creates a link that conditionally routes a request to different links.
+     *
+     * @example
+     *
+     * ```ts
+     * import { ApolloLink, HttpLink } from "@apollo/client";
+     *
+     * const link = ApolloLink.split(
+     *   (operation) => operation.getContext().version === 1,
+     *   new HttpLink({ uri: "http://localhost:4000/v1/graphql" }),
+     *   new HttpLink({ uri: "http://localhost:4000/v2/graphql" })
+     * );
+     * ```
+     *
+     * @param test - A predicate function that receives the current `operation`
+     * and returns a boolean indicating which link to execute. Returning `true`
+     * executes the `left` link. Returning `false` executes the `right` link.
+     *
+     * @param left - The link that executes when the `test` function returns
+     * `true`.
+     *
+     * @param right - The link that executes when the `test` function returns
+     * `false`. If the `right` link is not provided, the request is forwarded to
+     * the next link in the chain.
+     */
+    static split(test: (op: ApolloLink.Operation) => boolean, left: ApolloLink, right?: ApolloLink): ApolloLink;
+    /**
+     * Executes a GraphQL request against a link. The `execute` function begins
+     * the request by calling the request handler of the link.
+     *
+     * @example
+     *
+     * ```ts
+     * const observable = ApolloLink.execute(link, { query, variables }, { client });
+     *
+     * observable.subscribe({
+     *   next(value) {
+     *     console.log("Received", value);
+     *   },
+     *   error(error) {
+     *     console.error("Oops got error", error);
+     *   },
+     *   complete() {
+     *     console.log("Request complete");
+     *   },
+     * });
+     * ```
+     *
+     * @param link - The `ApolloLink` instance to execute the request.
+     *
+     * @param request - The GraphQL request details, such as the `query` and
+     * `variables`.
+     *
+     * @param context - The execution context for the request, such as the
+     * `client` making the request.
+     */
+    static execute(link: ApolloLink, request: ApolloLink.Request, context: ApolloLink.ExecuteContext): Observable<ApolloLink.Result>;
+    /**
+     * Combines multiple links into a single composed link.
+     *
+     * @example
+     *
+     * ```ts
+     * const link = ApolloLink.concat(firstLink, secondLink, thirdLink);
+     * ```
+     *
+     * @param links - The links to concatenate into a single link. Each link will
+     * execute in serial order.
+     *
+     * @deprecated Use `ApolloLink.from` instead. `ApolloLink.concat` will be
+     * removed in a future major version.
+     */
+    static concat(...links: ApolloLink[]): ApolloLink;
+    constructor(request?: ApolloLink.RequestHandler);
+    /**
+     * Concatenates a link that conditionally routes a request to different links.
+     *
+     * @example
+     *
+     * ```ts
+     * import { ApolloLink, HttpLink } from "@apollo/client";
+     *
+     * const previousLink = new ApolloLink((operation, forward) => {
+     *   // Handle the request
+     *
+     *   return forward(operation);
+     * });
+     *
+     * const link = previousLink.split(
+     *   (operation) => operation.getContext().version === 1,
+     *   new HttpLink({ uri: "http://localhost:4000/v1/graphql" }),
+     *   new HttpLink({ uri: "http://localhost:4000/v2/graphql" })
+     * );
+     * ```
+     *
+     * @param test - A predicate function that receives the current `operation`
+     * and returns a boolean indicating which link to execute. Returning `true`
+     * executes the `left` link. Returning `false` executes the `right` link.
+     *
+     * @param left - The link that executes when the `test` function returns
+     * `true`.
+     *
+     * @param right - The link that executes when the `test` function returns
+     * `false`. If the `right` link is not provided, the request is forwarded to
+     * the next link in the chain.
+     */
+    split(test: (op: ApolloLink.Operation) => boolean, left: ApolloLink, right?: ApolloLink): ApolloLink;
+    /**
+     * Combines the link with other links into a single composed link.
+     *
+     * @example
+     *
+     * ```ts
+     * import { ApolloLink, HttpLink } from "@apollo/client";
+     *
+     * const previousLink = new ApolloLink((operation, forward) => {
+     *   // Handle the request
+     *
+     *   return forward(operation);
+     * });
+     *
+     * const link = previousLink.concat(
+     *   link1,
+     *   link2,
+     *   new HttpLink({ uri: "http://localhost:4000/graphql" })
+     * );
+     * ```
+     */
+    concat(...links: ApolloLink[]): ApolloLink;
+    private combine;
+    /**
+     * Runs the request handler for the provided operation.
+     *
+     * > [!NOTE]
+     * > This is called by the `ApolloLink.execute` function for you and should
+     * > not be called directly. Prefer using `ApolloLink.execute` to make the
+     * > request instead.
+     */
+    request(operation: ApolloLink.Operation, forward: ApolloLink.ForwardFunction): Observable<ApolloLink.Result>;
     /**
     * @internal
     * Used to iterate through all links that are concatenations or `split` links.

package/__cjs/link/core/concat.cjs

@@ -2,5 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.concat = void 0;
 const ApolloLink_js_1 = require("./ApolloLink.cjs");
+/**
+ * @deprecated Use `ApolloLink.from` instead. `concat` will be removed in a
+ * future major version.
+ */
 exports.concat = ApolloLink_js_1.ApolloLink.concat;
 //# sourceMappingURL=concat.cjs.map

package/__cjs/link/core/concat.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"concat.cjs","sources":["../../../../src/link/core/concat.ts"],"sourcesContent":["import { ApolloLink } from \"./ApolloLink.js\";\n\nexport const concat = ApolloLink.concat;\n"],"names":[],"mappings":";;;AAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,mBAAA,CAAA;AAEa,CAAb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAa,CAAb,CAAA,CAAA,CAAA,CAAA,EAAA,EAAsB,CAAtB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAgC,CAAC,CAAjC,CAAA,CAAA,CAAA,CAAA,CAAuC;"}
+{"version":3,"file":"concat.cjs","sources":["../../../../src/link/core/concat.ts"],"sourcesContent":["import { ApolloLink } from \"./ApolloLink.js\";\n\n/**\n * @deprecated Use `ApolloLink.from` instead. `concat` will be removed in a\n * future major version.\n */\nexport const concat = ApolloLink.concat;\n"],"names":[],"mappings":";;;AAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,mBAAA,CAAA;AAEA,CAAA,CAAA;;;CAGA,CAAA;AACa,CAAb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAa,CAAb,CAAA,CAAA,CAAA,CAAA,EAAA,EAAsB,CAAtB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAgC,CAAC,CAAjC,CAAA,CAAA,CAAA,CAAA,CAAuC;"}

package/__cjs/link/core/concat.d.cts

@@ -1,3 +1,7 @@
 import { ApolloLink } from "./ApolloLink.cjs";
+/**
+ * @deprecated Use `ApolloLink.from` instead. `concat` will be removed in a
+ * future major version.
+ */
 export declare const concat: typeof ApolloLink.concat;
 //# sourceMappingURL=concat.d.cts.map

package/__cjs/link/core/deprecated.cjs

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=deprecated.cjs.map

package/__cjs/link/core/deprecated.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"deprecated.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;"}

package/__cjs/link/core/deprecated.d.cts

@@ -0,0 +1,10 @@
+import type { ApolloLink } from "./ApolloLink.cjs";
+/** @deprecated Use `ApolloLink.Request` instead */
+export type GraphQLRequest = ApolloLink.Request;
+/** @deprecated Use `ApolloLink.Operation` instead */
+export type Operation = ApolloLink.Operation;
+/** @deprecated Use `ApolloLink.RequestHandler` instead */
+export type RequestHandler = ApolloLink.RequestHandler;
+/** @deprecated Use `ApolloLink.Result` instead */
+export type FetchResult<TData = Record<string, any>, TExtensions = Record<string, any>> = ApolloLink.Result<TData, TExtensions>;
+//# sourceMappingURL=deprecated.d.cts.map

package/__cjs/link/core/empty.cjs

@@ -2,5 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.empty = void 0;
 const ApolloLink_js_1 = require("./ApolloLink.cjs");
+/**
+ * @deprecated Use `ApolloLink.empty` instead. `empty` will be removed in a
+ * future major version.
+ */
 exports.empty = ApolloLink_js_1.ApolloLink.empty;
 //# sourceMappingURL=empty.cjs.map

package/__cjs/link/core/empty.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"empty.cjs","sources":["../../../../src/link/core/empty.ts"],"sourcesContent":["import { ApolloLink } from \"./ApolloLink.js\";\n\nexport const empty = ApolloLink.empty;\n"],"names":[],"mappings":";;;AAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,mBAAA,CAAA;AAEa,CAAb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAa,CAAb,CAAA,CAAA,CAAA,EAAA,EAAqB,CAArB,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+B,CAAC,CAAhC,CAAA,CAAA,CAAA,CAAqC;"}
+{"version":3,"file":"empty.cjs","sources":["../../../../src/link/core/empty.ts"],"sourcesContent":["import { ApolloLink } from \"./ApolloLink.js\";\n\n/**\n * @deprecated Use `ApolloLink.empty` instead. `empty` will be removed in a\n * future major version.\n */\nexport const empty = ApolloLink.empty;\n"],"names":[],"mappings":";;;AAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,mBAAA,CAAA;AAEA,CAAA,CAAA;;;CAGA,CAAA;AACa,CAAb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAa,CAAb,CAAA,CAAA,CAAA,EAAA,EAAqB,CAArB,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+B,CAAC,CAAhC,CAAA,CAAA,CAAA,CAAqC;"}

package/__cjs/link/core/empty.d.cts

@@ -1,3 +1,7 @@
 import { ApolloLink } from "./ApolloLink.cjs";
+/**
+ * @deprecated Use `ApolloLink.empty` instead. `empty` will be removed in a
+ * future major version.
+ */
 export declare const empty: typeof ApolloLink.empty;
 //# sourceMappingURL=empty.d.cts.map

package/__cjs/link/core/from.cjs

@@ -2,5 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.from = void 0;
 const ApolloLink_js_1 = require("./ApolloLink.cjs");
+/**
+ * @deprecated Use `ApolloLink.from` instead. `from` will be removed in a
+ * future major version.
+ */
 exports.from = ApolloLink_js_1.ApolloLink.from;
 //# sourceMappingURL=from.cjs.map

package/__cjs/link/core/from.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"from.cjs","sources":["../../../../src/link/core/from.ts"],"sourcesContent":["import { ApolloLink } from \"./ApolloLink.js\";\n\nexport const from = ApolloLink.from;\n"],"names":[],"mappings":";;;AAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,mBAAA,CAAA;AAEa,CAAb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAa,CAAb,CAAA,CAAA,EAAA,EAAoB,CAApB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA8B,CAAC,CAA/B,CAAA,CAAA,CAAmC;"}
+{"version":3,"file":"from.cjs","sources":["../../../../src/link/core/from.ts"],"sourcesContent":["import { ApolloLink } from \"./ApolloLink.js\";\n\n/**\n * @deprecated Use `ApolloLink.from` instead. `from` will be removed in a\n * future major version.\n */\nexport const from = ApolloLink.from;\n"],"names":[],"mappings":";;;AAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,mBAAA,CAAA;AAEA,CAAA,CAAA;;;CAGA,CAAA;AACa,CAAb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAa,CAAb,CAAA,CAAA,EAAA,EAAoB,CAApB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA8B,CAAC,CAA/B,CAAA,CAAA,CAAmC;"}

package/__cjs/link/core/from.d.cts

@@ -1,3 +1,7 @@
 import { ApolloLink } from "./ApolloLink.cjs";
+/**
+ * @deprecated Use `ApolloLink.from` instead. `from` will be removed in a
+ * future major version.
+ */
 export declare const from: typeof ApolloLink.from;
 //# sourceMappingURL=from.d.cts.map

package/__cjs/link/core/split.cjs

@@ -2,5 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.split = void 0;
 const ApolloLink_js_1 = require("./ApolloLink.cjs");
+/**
+ * @deprecated Use `ApolloLink.split` instead. `split` will be removed in a
+ * future major version.
+ */
 exports.split = ApolloLink_js_1.ApolloLink.split;
 //# sourceMappingURL=split.cjs.map

package/__cjs/link/core/split.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"split.cjs","sources":["../../../../src/link/core/split.ts"],"sourcesContent":["import { ApolloLink } from \"./ApolloLink.js\";\n\nexport const split = ApolloLink.split;\n"],"names":[],"mappings":";;;AAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,mBAAA,CAAA;AAEa,CAAb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAa,CAAb,CAAA,CAAA,CAAA,EAAA,EAAqB,CAArB,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+B,CAAC,CAAhC,CAAA,CAAA,CAAA,CAAqC;"}
+{"version":3,"file":"split.cjs","sources":["../../../../src/link/core/split.ts"],"sourcesContent":["import { ApolloLink } from \"./ApolloLink.js\";\n\n/**\n * @deprecated Use `ApolloLink.split` instead. `split` will be removed in a\n * future major version.\n */\nexport const split = ApolloLink.split;\n"],"names":[],"mappings":";;;AAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,mBAAA,CAAA;AAEA,CAAA,CAAA;;;CAGA,CAAA;AACa,CAAb,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAa,CAAb,CAAA,CAAA,CAAA,EAAA,EAAqB,CAArB,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+B,CAAC,CAAhC,CAAA,CAAA,CAAA,CAAqC;"}

package/__cjs/link/core/split.d.cts

@@ -1,3 +1,7 @@
 import { ApolloLink } from "./ApolloLink.cjs";
+/**
+ * @deprecated Use `ApolloLink.split` instead. `split` will be removed in a
+ * future major version.
+ */
 export declare const split: typeof ApolloLink.split;
 //# sourceMappingURL=split.d.cts.map

package/__cjs/link/core/types.d.cts

@@ -1,41 +1,10 @@
-import type { FormattedExecutionResult, GraphQLFormattedError, OperationTypeNode } from "graphql";
+import type { FormattedExecutionResult, GraphQLFormattedError } from "graphql";
 import type { DocumentNode } from "graphql";
-import type { Observable } from "rxjs";
-import type { ApolloClient, DefaultContext, OperationVariables } from "@apollo/client";
 export type { DocumentNode };
 export interface ApolloPayloadResult<TData = Record<string, any>, TExtensions = Record<string, any>> {
     payload: FormattedExecutionResult<TData, TExtensions> | null;
     errors?: ReadonlyArray<GraphQLFormattedError>;
 }
-export interface GraphQLRequest<TVariables extends OperationVariables = Record<string, any>> {
-    query: DocumentNode;
-    variables?: TVariables;
-    operationName?: string;
-    operationType?: OperationTypeNode;
-    context?: DefaultContext;
-    extensions?: Record<string, any>;
+export interface AdditionalApolloLinkResultTypes<TData = Record<string, any>, TExtensions = Record<string, any>> {
 }
-export interface Operation {
-    query: DocumentNode;
-    variables: Record<string, any>;
-    operationName: string;
-    operationType: OperationTypeNode | undefined;
-    extensions: Record<string, any>;
-    setContext: {
-        (context: Partial<OperationContext>): void;
-        (updateContext: (previousContext: OperationContext) => Partial<OperationContext>): void;
-    };
-    getContext: () => OperationContext;
-    readonly client: ApolloClient;
-}
-export interface ExecuteContext {
-    client: ApolloClient;
-}
-export interface OperationContext extends DefaultContext {
-}
-export type FetchResult<TData = Record<string, any>, TExtensions = Record<string, any>> = FormattedExecutionResult<TData, TExtensions> | AdditionalFetchResultTypes<TData, TExtensions>[keyof AdditionalFetchResultTypes<TData, TExtensions>];
-export interface AdditionalFetchResultTypes<TData = Record<string, any>, TExtensions = Record<string, any>> {
-}
-export type NextLink = (operation: Operation) => Observable<FetchResult>;
-export type RequestHandler = (operation: Operation, forward: NextLink) => Observable<FetchResult> | null;
 //# sourceMappingURL=types.d.cts.map

package/__cjs/link/error/index.cjs

@@ -12,6 +12,50 @@ const link_1 = require("@apollo/client/link");
 function onError(errorHandler) {
     return new ErrorLink(errorHandler);
 }
+/**
+ * Use the `ErrorLink` to perform custom logic when a [GraphQL or network error](https://apollographql.com/docs/react/data/error-handling)
+ * occurs.
+ *
+ * @remarks
+ *
+ * This link is used after the GraphQL operation completes and execution is
+ * moving back up your [link chain](https://apollographql.com/docs/react/introduction#handling-a-response). The `errorHandler` function should
+ * not return a value unless you want to [retry the operation](https://apollographql.com/docs/react/data/error-handling#retrying-operations).
+ *
+ * For more information on the types of errors that might be encountered, see
+ * the guide on [error handling](https://apollographql.com/docs/react/data/error-handling).
+ *
+ * @example
+ *
+ * ```ts
+ * import { ErrorLink } from "@apollo/client/link/error";
+ * import {
+ *   CombinedGraphQLErrors,
+ *   CombinedProtocolErrors,
+ * } from "@apollo/client/errors";
+ *
+ * // Log any GraphQL errors, protocol errors, or network error that occurred
+ * const errorLink = new ErrorLink(({ error, operation }) => {
+ *   if (CombinedGraphQLErrors.is(error)) {
+ *     error.errors.forEach(({ message, locations, path }) =>
+ *       console.log(
+ *         `[GraphQL error]: Message: ${message}, Location: ${locations}, Path: ${path}`
+ *       )
+ *     );
+ *   } else if (CombinedProtocolErrors.is(error)) {
+ *     error.errors.forEach(({ message, extensions }) =>
+ *       console.log(
+ *         `[Protocol error]: Message: ${message}, Extensions: ${JSON.stringify(
+ *           extensions
+ *         )}`
+ *       )
+ *     );
+ *   } else {
+ *     console.error(`[Network error]: ${error}`);
+ *   }
+ * });
+ * ```
+ */
 class ErrorLink extends link_1.ApolloLink {
     constructor(errorHandler) {
         super((operation, forward) => {