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

package/link/batch-http/batchHttpLink.js

@@ -1,16 +1,29 @@
-import { Observable, throwError } from "rxjs";
 import { ApolloLink } from "@apollo/client/link";
-import { BatchLink } from "@apollo/client/link/batch";
 import { ClientAwarenessLink } from "@apollo/client/link/client-awareness";
-import { checkFetcher, defaultPrinter, fallbackHttpConfig, parseAndCheckHttpResponse, selectHttpOptionsAndBodyInternal, selectURI, serializeFetchParameter, } from "@apollo/client/link/http";
-import { filterOperationVariables } from "@apollo/client/link/utils";
-import { __DEV__ } from "@apollo/client/utilities/environment";
-import { compact } from "@apollo/client/utilities/internal";
-import { maybe } from "@apollo/client/utilities/internal/globals";
-const backupFetch = maybe(() => fetch);
+import { BaseBatchHttpLink } from "./BaseBatchHttpLink.js";
 /**
- * Transforms Operation for into HTTP results.
- * context can include the headers property, which will be passed to the fetch function
+ * `BatchHttpLink` is a terminating link that batches array of individual
+ * GraphQL operations into a single HTTP request that's sent to a single GraphQL
+ * endpoint. It combines the functionality of `BaseBatchHttpLink` and
+ * `ClientAwarenessLink` into a single link.
+ *
+ * @remarks
+ *
+ * If you use `BatchHttpLink` instead of `HttpLink` as your terminating link,
+ * Apollo Client automatically batches executed GraphQL operations and transmits
+ * them to your server according to the batching options you provide.
+ *
+ * @example
+ *
+ * ```ts
+ * import { BatchHttpLink } from "@apollo/client/link/batch-http";
+ *
+ * const link = new BatchHttpLink({
+ *   uri: "http://localhost:4000/graphql",
+ *   batchMax: 5, // No more than 5 operations per batch
+ *   batchInterval: 20, // Wait no more than 20ms after first batched operation
+ * });
+ * ```
  */
 export class BatchHttpLink extends ApolloLink {
     constructor(options = {}) {
@@ -22,121 +35,4 @@ export class BatchHttpLink extends ApolloLink {
         Object.assign(this, { left, right });
     }
 }
-export class BaseBatchHttpLink extends ApolloLink {
-    batchDebounce;
-    batchInterval;
-    batchMax;
-    batcher;
-    constructor(fetchParams) {
-        super();
-        let { uri = "/graphql", 
-        // use default global fetch if nothing is passed in
-        fetch: preferredFetch, print = defaultPrinter, includeExtensions, preserveHeaderCase, batchInterval, batchDebounce, batchMax, batchKey, includeUnusedVariables = false, ...requestOptions } = fetchParams || {};
-        if (__DEV__) {
-            // Make sure at least one of preferredFetch, window.fetch, or backupFetch
-            // is defined, so requests won't fail at runtime.
-            checkFetcher(preferredFetch || backupFetch);
-        }
-        const linkConfig = {
-            http: compact({ includeExtensions, preserveHeaderCase }),
-            options: requestOptions.fetchOptions,
-            credentials: requestOptions.credentials,
-            headers: requestOptions.headers,
-        };
-        this.batchDebounce = batchDebounce;
-        this.batchInterval = batchInterval || 10;
-        this.batchMax = batchMax || 10;
-        const batchHandler = (operations) => {
-            const chosenURI = selectURI(operations[0], uri);
-            const context = operations[0].getContext();
-            const contextConfig = {
-                http: context.http,
-                options: context.fetchOptions,
-                credentials: context.credentials,
-                headers: context.headers,
-            };
-            //uses fallback, link, and then context to build options
-            const optsAndBody = operations.map((operation) => {
-                const result = selectHttpOptionsAndBodyInternal(operation, print, fallbackHttpConfig, linkConfig, contextConfig);
-                if (result.body.variables && !includeUnusedVariables) {
-                    result.body.variables = filterOperationVariables(result.body.variables, operation.query);
-                }
-                return result;
-            });
-            const loadedBody = optsAndBody.map(({ body }) => body);
-            const options = optsAndBody[0].options;
-            // There's no spec for using GET with batches.
-            if (options.method === "GET") {
-                return throwError(() => new Error("apollo-link-batch-http does not support GET requests"));
-            }
-            try {
-                options.body = serializeFetchParameter(loadedBody, "Payload");
-            }
-            catch (parseError) {
-                return throwError(() => parseError);
-            }
-            let controller;
-            if (!options.signal && typeof AbortController !== "undefined") {
-                controller = new AbortController();
-                options.signal = controller.signal;
-            }
-            return new Observable((observer) => {
-                // Prefer BatchHttpLink.Options.fetch (preferredFetch) if provided, and
-                // otherwise fall back to the *current* global window.fetch function
-                // (see issue #7832), or (if all else fails) the backupFetch function we
-                // saved when this module was first evaluated. This last option protects
-                // against the removal of window.fetch, which is unlikely but not
-                // impossible.
-                const currentFetch = preferredFetch || maybe(() => fetch) || backupFetch;
-                currentFetch(chosenURI, options)
-                    .then((response) => {
-                    // Make the raw response available in the context.
-                    operations.forEach((operation) => operation.setContext({ response }));
-                    return response;
-                })
-                    .then(parseAndCheckHttpResponse(operations))
-                    .then((result) => {
-                    controller = undefined;
-                    // we have data and can send it to back up the link chain
-                    observer.next(result);
-                    observer.complete();
-                    return result;
-                })
-                    .catch((err) => {
-                    controller = undefined;
-                    observer.error(err);
-                });
-                return () => {
-                    // XXX support canceling this request
-                    // https://developers.google.com/web/updates/2017/09/abortable-fetch
-                    if (controller)
-                        controller.abort();
-                };
-            });
-        };
-        batchKey =
-            batchKey ||
-                ((operation) => {
-                    const context = operation.getContext();
-                    const contextConfig = {
-                        http: context.http,
-                        options: context.fetchOptions,
-                        credentials: context.credentials,
-                        headers: context.headers,
-                    };
-                    //may throw error if config not serializable
-                    return selectURI(operation, uri) + JSON.stringify(contextConfig);
-                });
-        this.batcher = new BatchLink({
-            batchDebounce: this.batchDebounce,
-            batchInterval: this.batchInterval,
-            batchMax: this.batchMax,
-            batchKey,
-            batchHandler,
-        });
-    }
-    request(operation, forward) {
-        return this.batcher.request(operation, forward);
-    }
-}
 //# sourceMappingURL=batchHttpLink.js.map

package/link/batch-http/batchHttpLink.js.map

@@ -1 +1 @@
-{"version":3,"file":"batchHttpLink.js","sourceRoot":"","sources":["../../../src/link/batch-http/batchHttpLink.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAE9C,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjD,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,OAAO,EAAE,mBAAmB,EAAE,MAAM,sCAAsC,CAAC;AAE3E,OAAO,EACL,YAAY,EACZ,cAAc,EACd,kBAAkB,EAClB,yBAAyB,EACzB,gCAAgC,EAChC,SAAS,EACT,uBAAuB,GACxB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAC;AACrE,OAAO,EAAE,OAAO,EAAE,MAAM,sCAAsC,CAAC;AAC/D,OAAO,EAAE,OAAO,EAAE,MAAM,mCAAmC,CAAC;AAC5D,OAAO,EAAE,KAAK,EAAE,MAAM,2CAA2C,CAAC;AAYlE,MAAM,WAAW,GAAG,KAAK,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;AAEvC;;;GAGG;AACH,MAAM,OAAO,aAAc,SAAQ,UAAU;IAC3C,YACE,UAA+D,EAAE;QAEjE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,IAAI,CAAC;YAC/C,IAAI,mBAAmB,CAAC,OAAO,CAAC;YAChC,IAAI,iBAAiB,CAAC,OAAO,CAAC;SAC/B,CAAC,CAAC;QACH,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IACvC,CAAC;CACF;AACD,MAAM,OAAO,iBAAkB,SAAQ,UAAU;IACvC,aAAa,CAAW;IACxB,aAAa,CAAS;IACtB,QAAQ,CAAS;IACjB,OAAO,CAAa;IAE5B,YAAY,WAAmC;QAC7C,KAAK,EAAE,CAAC;QAER,IAAI,EACF,GAAG,GAAG,UAAU;QAChB,mDAAmD;QACnD,KAAK,EAAE,cAAc,EACrB,KAAK,GAAG,cAAc,EACtB,iBAAiB,EACjB,kBAAkB,EAClB,aAAa,EACb,aAAa,EACb,QAAQ,EACR,QAAQ,EACR,sBAAsB,GAAG,KAAK,EAC9B,GAAG,cAAc,EAClB,GAAG,WAAW,IAAK,EAA4B,CAAC;QAEjD,IAAI,OAAO,EAAE,CAAC;YACZ,yEAAyE;YACzE,iDAAiD;YACjD,YAAY,CAAC,cAAc,IAAI,WAAW,CAAC,CAAC;QAC9C,CAAC;QAED,MAAM,UAAU,GAAG;YACjB,IAAI,EAAE,OAAO,CAAC,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,CAAC;YACxD,OAAO,EAAE,cAAc,CAAC,YAAY;YACpC,WAAW,EAAE,cAAc,CAAC,WAAW;YACvC,OAAO,EAAE,cAAc,CAAC,OAAO;SAChC,CAAC;QAEF,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,aAAa,GAAG,aAAa,IAAI,EAAE,CAAC;QACzC,IAAI,CAAC,QAAQ,GAAG,QAAQ,IAAI,EAAE,CAAC;QAE/B,MAAM,YAAY,GAAiB,CAAC,UAAU,EAAE,EAAE;YAChD,MAAM,SAAS,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;YAEhD,MAAM,OAAO,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC;YAE3C,MAAM,aAAa,GAAG;gBACpB,IAAI,EAAE,OAAO,CAAC,IAAI;gBAClB,OAAO,EAAE,OAAO,CAAC,YAAY;gBAC7B,WAAW,EAAE,OAAO,CAAC,WAAW;gBAChC,OAAO,EAAE,OAAO,CAAC,OAAO;aACzB,CAAC;YAEF,wDAAwD;YACxD,MAAM,WAAW,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE;gBAC/C,MAAM,MAAM,GAAG,gCAAgC,CAC7C,SAAS,EACT,KAAK,EACL,kBAAkB,EAClB,UAAU,EACV,aAAa,CACd,CAAC;gBAEF,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,sBAAsB,EAAE,CAAC;oBACrD,MAAM,CAAC,IAAI,CAAC,SAAS,GAAG,wBAAwB,CAC9C,MAAM,CAAC,IAAI,CAAC,SAAS,EACrB,SAAS,CAAC,KAAK,CAChB,CAAC;gBACJ,CAAC;gBAED,OAAO,MAAM,CAAC;YAChB,CAAC,CAAC,CAAC;YAEH,MAAM,UAAU,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;YACvD,MAAM,OAAO,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;YAEvC,8CAA8C;YAC9C,IAAI,OAAO,CAAC,MAAM,KAAK,KAAK,EAAE,CAAC;gBAC7B,OAAO,UAAU,CACf,GAAG,EAAE,CACH,IAAI,KAAK,CAAC,sDAAsD,CAAC,CACpE,CAAC;YACJ,CAAC;YAED,IAAI,CAAC;gBACF,OAAe,CAAC,IAAI,GAAG,uBAAuB,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;YACzE,CAAC;YAAC,OAAO,UAAU,EAAE,CAAC;gBACpB,OAAO,UAAU,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,CAAC;YACtC,CAAC;YAED,IAAI,UAAuC,CAAC;YAC5C,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,OAAO,eAAe,KAAK,WAAW,EAAE,CAAC;gBAC9D,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;gBACnC,OAAO,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC;YACrC,CAAC;YAED,OAAO,IAAI,UAAU,CAAC,CAAC,QAAQ,EAAE,EAAE;gBACjC,uEAAuE;gBACvE,oEAAoE;gBACpE,wEAAwE;gBACxE,wEAAwE;gBACxE,iEAAiE;gBACjE,cAAc;gBACd,MAAM,YAAY,GAChB,cAAc,IAAI,KAAK,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,IAAI,WAAW,CAAC;gBAEtD,YAAa,CAAC,SAAS,EAAE,OAAO,CAAC;qBAC9B,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;oBACjB,kDAAkD;oBAClD,UAAU,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE,CAC/B,SAAS,CAAC,UAAU,CAAC,EAAE,QAAQ,EAAE,CAAC,CACnC,CAAC;oBACF,OAAO,QAAQ,CAAC;gBAClB,CAAC,CAAC;qBACD,IAAI,CAAC,yBAAyB,CAAC,UAAU,CAAC,CAAC;qBAC3C,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;oBACf,UAAU,GAAG,SAAS,CAAC;oBACvB,yDAAyD;oBACzD,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;oBACtB,QAAQ,CAAC,QAAQ,EAAE,CAAC;oBACpB,OAAO,MAAM,CAAC;gBAChB,CAAC,CAAC;qBACD,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;oBACb,UAAU,GAAG,SAAS,CAAC;oBACvB,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACtB,CAAC,CAAC,CAAC;gBAEL,OAAO,GAAG,EAAE;oBACV,qCAAqC;oBACrC,oEAAoE;oBACpE,IAAI,UAAU;wBAAE,UAAU,CAAC,KAAK,EAAE,CAAC;gBACrC,CAAC,CAAC;YACJ,CAAC,CAAC,CAAC;QACL,CAAC,CAAC;QAEF,QAAQ;YACN,QAAQ;gBACR,CAAC,CAAC,SAA+B,EAAE,EAAE;oBACnC,MAAM,OAAO,GAAG,SAAS,CAAC,UAAU,EAAE,CAAC;oBAEvC,MAAM,aAAa,GAAG;wBACpB,IAAI,EAAE,OAAO,CAAC,IAAI;wBAClB,OAAO,EAAE,OAAO,CAAC,YAAY;wBAC7B,WAAW,EAAE,OAAO,CAAC,WAAW;wBAChC,OAAO,EAAE,OAAO,CAAC,OAAO;qBACzB,CAAC;oBAEF,4CAA4C;oBAC5C,OAAO,SAAS,CAAC,SAAS,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;gBACnE,CAAC,CAAC,CAAC;QAEL,IAAI,CAAC,OAAO,GAAG,IAAI,SAAS,CAAC;YAC3B,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,QAAQ;YACR,YAAY;SACb,CAAC,CAAC;IACL,CAAC;IAEM,OAAO,CACZ,SAA+B,EAC/B,OAAmC;QAEnC,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAClD,CAAC;CACF","sourcesContent":["import { Observable, throwError } from \"rxjs\";\n\nimport { ApolloLink } from \"@apollo/client/link\";\nimport type { BatchHandler } from \"@apollo/client/link/batch\";\nimport { BatchLink } from \"@apollo/client/link/batch\";\nimport { ClientAwarenessLink } from \"@apollo/client/link/client-awareness\";\nimport type { HttpLink } from \"@apollo/client/link/http\";\nimport {\n  checkFetcher,\n  defaultPrinter,\n  fallbackHttpConfig,\n  parseAndCheckHttpResponse,\n  selectHttpOptionsAndBodyInternal,\n  selectURI,\n  serializeFetchParameter,\n} from \"@apollo/client/link/http\";\nimport { filterOperationVariables } from \"@apollo/client/link/utils\";\nimport { __DEV__ } from \"@apollo/client/utilities/environment\";\nimport { compact } from \"@apollo/client/utilities/internal\";\nimport { maybe } from \"@apollo/client/utilities/internal/globals\";\n\nexport declare namespace BatchHttpLink {\n  export type Options = Pick<\n    BatchLink.Options,\n    \"batchMax\" | \"batchDebounce\" | \"batchInterval\" | \"batchKey\"\n  > &\n    Omit<HttpLink.Options, \"useGETForQueries\">;\n\n  export type ContextOptions = HttpLink.ContextOptions;\n}\n\nconst backupFetch = maybe(() => fetch);\n\n/**\n * Transforms Operation for into HTTP results.\n * context can include the headers property, which will be passed to the fetch function\n */\nexport class BatchHttpLink extends ApolloLink {\n  constructor(\n    options: BatchHttpLink.Options & ClientAwarenessLink.Options = {}\n  ) {\n    const { left, right, request } = ApolloLink.from([\n      new ClientAwarenessLink(options),\n      new BaseBatchHttpLink(options),\n    ]);\n    super(request);\n    Object.assign(this, { left, right });\n  }\n}\nexport class BaseBatchHttpLink extends ApolloLink {\n  private batchDebounce?: boolean;\n  private batchInterval: number;\n  private batchMax: number;\n  private batcher: ApolloLink;\n\n  constructor(fetchParams?: BatchHttpLink.Options) {\n    super();\n\n    let {\n      uri = \"/graphql\",\n      // use default global fetch if nothing is passed in\n      fetch: preferredFetch,\n      print = defaultPrinter,\n      includeExtensions,\n      preserveHeaderCase,\n      batchInterval,\n      batchDebounce,\n      batchMax,\n      batchKey,\n      includeUnusedVariables = false,\n      ...requestOptions\n    } = fetchParams || ({} as BatchHttpLink.Options);\n\n    if (__DEV__) {\n      // Make sure at least one of preferredFetch, window.fetch, or backupFetch\n      // is defined, so requests won't fail at runtime.\n      checkFetcher(preferredFetch || backupFetch);\n    }\n\n    const linkConfig = {\n      http: compact({ includeExtensions, preserveHeaderCase }),\n      options: requestOptions.fetchOptions,\n      credentials: requestOptions.credentials,\n      headers: requestOptions.headers,\n    };\n\n    this.batchDebounce = batchDebounce;\n    this.batchInterval = batchInterval || 10;\n    this.batchMax = batchMax || 10;\n\n    const batchHandler: BatchHandler = (operations) => {\n      const chosenURI = selectURI(operations[0], uri);\n\n      const context = operations[0].getContext();\n\n      const contextConfig = {\n        http: context.http,\n        options: context.fetchOptions,\n        credentials: context.credentials,\n        headers: context.headers,\n      };\n\n      //uses fallback, link, and then context to build options\n      const optsAndBody = operations.map((operation) => {\n        const result = selectHttpOptionsAndBodyInternal(\n          operation,\n          print,\n          fallbackHttpConfig,\n          linkConfig,\n          contextConfig\n        );\n\n        if (result.body.variables && !includeUnusedVariables) {\n          result.body.variables = filterOperationVariables(\n            result.body.variables,\n            operation.query\n          );\n        }\n\n        return result;\n      });\n\n      const loadedBody = optsAndBody.map(({ body }) => body);\n      const options = optsAndBody[0].options;\n\n      // There's no spec for using GET with batches.\n      if (options.method === \"GET\") {\n        return throwError(\n          () =>\n            new Error(\"apollo-link-batch-http does not support GET requests\")\n        );\n      }\n\n      try {\n        (options as any).body = serializeFetchParameter(loadedBody, \"Payload\");\n      } catch (parseError) {\n        return throwError(() => parseError);\n      }\n\n      let controller: AbortController | undefined;\n      if (!options.signal && typeof AbortController !== \"undefined\") {\n        controller = new AbortController();\n        options.signal = controller.signal;\n      }\n\n      return new Observable((observer) => {\n        // Prefer BatchHttpLink.Options.fetch (preferredFetch) if provided, and\n        // otherwise fall back to the *current* global window.fetch function\n        // (see issue #7832), or (if all else fails) the backupFetch function we\n        // saved when this module was first evaluated. This last option protects\n        // against the removal of window.fetch, which is unlikely but not\n        // impossible.\n        const currentFetch =\n          preferredFetch || maybe(() => fetch) || backupFetch;\n\n        currentFetch!(chosenURI, options)\n          .then((response) => {\n            // Make the raw response available in the context.\n            operations.forEach((operation) =>\n              operation.setContext({ response })\n            );\n            return response;\n          })\n          .then(parseAndCheckHttpResponse(operations))\n          .then((result) => {\n            controller = undefined;\n            // we have data and can send it to back up the link chain\n            observer.next(result);\n            observer.complete();\n            return result;\n          })\n          .catch((err) => {\n            controller = undefined;\n            observer.error(err);\n          });\n\n        return () => {\n          // XXX support canceling this request\n          // https://developers.google.com/web/updates/2017/09/abortable-fetch\n          if (controller) controller.abort();\n        };\n      });\n    };\n\n    batchKey =\n      batchKey ||\n      ((operation: ApolloLink.Operation) => {\n        const context = operation.getContext();\n\n        const contextConfig = {\n          http: context.http,\n          options: context.fetchOptions,\n          credentials: context.credentials,\n          headers: context.headers,\n        };\n\n        //may throw error if config not serializable\n        return selectURI(operation, uri) + JSON.stringify(contextConfig);\n      });\n\n    this.batcher = new BatchLink({\n      batchDebounce: this.batchDebounce,\n      batchInterval: this.batchInterval,\n      batchMax: this.batchMax,\n      batchKey,\n      batchHandler,\n    });\n  }\n\n  public request(\n    operation: ApolloLink.Operation,\n    forward: ApolloLink.ForwardFunction\n  ): Observable<ApolloLink.Result> {\n    return this.batcher.request(operation, forward);\n  }\n}\n"]}
+{"version":3,"file":"batchHttpLink.js","sourceRoot":"","sources":["../../../src/link/batch-http/batchHttpLink.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,mBAAmB,EAAE,MAAM,sCAAsC,CAAC;AAG3E,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAwB3D;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,OAAO,aAAc,SAAQ,UAAU;IAC3C,YAAY,UAAiC,EAAE;QAC7C,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,IAAI,CAAC;YAC/C,IAAI,mBAAmB,CAAC,OAAO,CAAC;YAChC,IAAI,iBAAiB,CAAC,OAAO,CAAC;SAC/B,CAAC,CAAC;QACH,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IACvC,CAAC;CACF","sourcesContent":["import { ApolloLink } from \"@apollo/client/link\";\nimport { ClientAwarenessLink } from \"@apollo/client/link/client-awareness\";\nimport { __DEV__ } from \"@apollo/client/utilities/environment\";\n\nimport { BaseBatchHttpLink } from \"./BaseBatchHttpLink.js\";\n\nexport declare namespace BatchHttpLink {\n  /**\n   * Options provided to the `BatchHttpLink` constructor.\n   */\n  export interface Options\n    extends BaseBatchHttpLink.Options,\n      ClientAwarenessLink.Options {}\n\n  /**\n   * Options passed to `BatchHttpLink` through [request context](https://apollographql.com/docs/react/api/link/introduction#managing-context). Previous\n   * non-terminating links in the link chain also can set these values to\n   * customize the behavior of `BatchHttpLink` for each operation.\n   *\n   * > [!NOTE]\n   * > Some of these values can also be provided to the `BatchHttpLink` constructor.\n   * > If a value is provided to both, the value in `context` takes precedence.\n   */\n  export interface ContextOptions\n    extends BaseBatchHttpLink.ContextOptions,\n      ClientAwarenessLink.ContextOptions {}\n}\n\n/**\n * `BatchHttpLink` is a terminating link that batches array of individual\n * GraphQL operations into a single HTTP request that's sent to a single GraphQL\n * endpoint. It combines the functionality of `BaseBatchHttpLink` and\n * `ClientAwarenessLink` into a single link.\n *\n * @remarks\n *\n * If you use `BatchHttpLink` instead of `HttpLink` as your terminating link,\n * Apollo Client automatically batches executed GraphQL operations and transmits\n * them to your server according to the batching options you provide.\n *\n * @example\n *\n * ```ts\n * import { BatchHttpLink } from \"@apollo/client/link/batch-http\";\n *\n * const link = new BatchHttpLink({\n *   uri: \"http://localhost:4000/graphql\",\n *   batchMax: 5, // No more than 5 operations per batch\n *   batchInterval: 20, // Wait no more than 20ms after first batched operation\n * });\n * ```\n */\nexport class BatchHttpLink extends ApolloLink {\n  constructor(options: BatchHttpLink.Options = {}) {\n    const { left, right, request } = ApolloLink.from([\n      new ClientAwarenessLink(options),\n      new BaseBatchHttpLink(options),\n    ]);\n    super(request);\n    Object.assign(this, { left, right });\n  }\n}\n"]}

package/link/batch-http/index.d.ts

@@ -1,2 +1,3 @@
-export { BaseBatchHttpLink, BatchHttpLink } from "./batchHttpLink.js";
+export { BaseBatchHttpLink } from "./BaseBatchHttpLink.js";
+export { BatchHttpLink } from "./batchHttpLink.js";
 //# sourceMappingURL=index.d.ts.map

package/link/batch-http/index.js

@@ -1,2 +1,3 @@
-export { BaseBatchHttpLink, BatchHttpLink } from "./batchHttpLink.js";
+export { BaseBatchHttpLink } from "./BaseBatchHttpLink.js";
+export { BatchHttpLink } from "./batchHttpLink.js";
 //# sourceMappingURL=index.js.map

package/link/batch-http/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/link/batch-http/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC","sourcesContent":["export { BaseBatchHttpLink, BatchHttpLink } from \"./batchHttpLink.js\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/link/batch-http/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC","sourcesContent":["export { BaseBatchHttpLink } from \"./BaseBatchHttpLink.js\";\nexport { BatchHttpLink } from \"./batchHttpLink.js\";\n"]}

package/link/client-awareness/ClientAwarenessLink.d.ts

@@ -1,5 +1,24 @@
 import { ApolloLink } from "@apollo/client/link";
 export declare namespace ClientAwarenessLink {
+    /**
+     * Options passed to `ClientAwarenessLink` through [request context](https://apollographql.com/docs/react/api/link/introduction#managing-context). Previous
+     * non-terminating links in the link chain also can set these values to
+     * customize the behavior of `ClientAwarenessLink` for each operation.
+     *
+     * > [!NOTE]
+     * > Some of these values can also be provided to the `ClientAwarenessLink`
+     * > constructor. If a value is provided to both, the value in `context` takes
+     * > precedence.
+     */
+    interface ContextOptions {
+        /**
+        * Configures the "client awareness" feature.
+        * This feature allows you to identify distinct applications in Apollo Studio
+        * and Apollo Server logs (and other monitoring or analytics tools) by adding
+        * information about the your application to outgoing requests.
+        */
+        clientAwareness?: ClientAwarenessLink.ClientAwarenessOptions;
+    }
     interface ClientAwarenessOptions {
         /**
          * A custom name (e.g., `iOS`) that identifies this particular client among your set of clients. Apollo Server and Apollo Studio use this property as part of the [client awareness](https://www.apollographql.com/docs/apollo-server/monitoring/metrics#identifying-distinct-clients) feature.
@@ -46,17 +65,50 @@ export declare namespace ClientAwarenessLink {
          * and Apollo Server logs (and other monitoring or analytics tools) by adding
          * information about the your application to outgoing requests.
          */
-        clientAwareness?: ClientAwarenessOptions;
+        clientAwareness?: ClientAwarenessLink.ClientAwarenessOptions;
         /**
          * Configures the "enhanced client awareness" feature.
          * This feature allows you to identify the version of the Apollo Client library
          * used in your application in Apollo Studio (and other monitoring or analytics tools)
          * by adding information about the Apollo Client library to outgoing requests.
          */
-        enhancedClientAwareness?: EnhancedClientAwarenessOptions;
+        enhancedClientAwareness?: ClientAwarenessLink.EnhancedClientAwarenessOptions;
     }
 }
+/**
+ * `ClientAwarenessLink` provides support for providing client awareness
+ * features.
+ *
+ * @remarks
+ *
+ * Client awareness adds identifying information about the client to HTTP
+ * requests for use with metrics reporting tools, such as [Apollo GraphOS](https://apollographql.com/docs/graphos/platform).
+ * It is included in the functionality of [`HttpLink`](https://apollographql.com/docs/react/api/link/apollo-link-http) by default.
+ *
+ * Client awareness distinguishes between user-provided client awareness
+ * (provided by the `clientAwareness` option) and enhanced client awareness
+ * (provided by the `enhancedClientAwareness` option). User-provided client
+ * awareness enables you to set a customized client name and version for
+ * identification in metrics reporting tools. Enhanced client awareness enables
+ * the identification of the Apollo Client package name and version.
+ *
+ * @example
+ *
+ * ```ts
+ * import { ClientAwarenessLink } from "@apollo/client/link/client-awareness";
+ *
+ * const link = new ClientAwarenessLink({
+ *   clientAwareness: {
+ *     name: "My Client",
+ *     version: "1",
+ *   },
+ *   enhancedClientAwareness: {
+ *     transport: "extensions",
+ *   },
+ * });
+ * ```
+ */
 export declare class ClientAwarenessLink extends ApolloLink {
-    constructor(constructorOptions?: ClientAwarenessLink.Options);
+    constructor(options?: ClientAwarenessLink.Options);
 }
-//# sourceMappingURL=ClientAwarenessLink.d.ts.map
+//# sourceMappingURL=ClientAwarenessLink.d.ts.map

package/link/client-awareness/ClientAwarenessLink.js

@@ -1,13 +1,46 @@
 import { ApolloLink } from "@apollo/client/link";
 import { compact } from "@apollo/client/utilities/internal";
+/**
+ * `ClientAwarenessLink` provides support for providing client awareness
+ * features.
+ *
+ * @remarks
+ *
+ * Client awareness adds identifying information about the client to HTTP
+ * requests for use with metrics reporting tools, such as [Apollo GraphOS](https://apollographql.com/docs/graphos/platform).
+ * It is included in the functionality of [`HttpLink`](https://apollographql.com/docs/react/api/link/apollo-link-http) by default.
+ *
+ * Client awareness distinguishes between user-provided client awareness
+ * (provided by the `clientAwareness` option) and enhanced client awareness
+ * (provided by the `enhancedClientAwareness` option). User-provided client
+ * awareness enables you to set a customized client name and version for
+ * identification in metrics reporting tools. Enhanced client awareness enables
+ * the identification of the Apollo Client package name and version.
+ *
+ * @example
+ *
+ * ```ts
+ * import { ClientAwarenessLink } from "@apollo/client/link/client-awareness";
+ *
+ * const link = new ClientAwarenessLink({
+ *   clientAwareness: {
+ *     name: "My Client",
+ *     version: "1",
+ *   },
+ *   enhancedClientAwareness: {
+ *     transport: "extensions",
+ *   },
+ * });
+ * ```
+ */
 export class ClientAwarenessLink extends ApolloLink {
-    constructor(constructorOptions = {}) {
+    constructor(options = {}) {
         super((operation, forward) => {
             const client = operation.client;
             const clientOptions = client["queryManager"].clientOptions;
             const context = operation.getContext();
             {
-                const { name, version, transport = "headers", } = compact({}, clientOptions.clientAwareness, constructorOptions.clientAwareness, context.clientAwareness);
+                const { name, version, transport = "headers", } = compact({}, clientOptions.clientAwareness, options.clientAwareness, context.clientAwareness);
                 if (transport === "headers") {
                     operation.setContext(({ headers, extensions }) => {
                         return {
@@ -22,7 +55,7 @@ export class ClientAwarenessLink extends ApolloLink {
                 }
             }
             {
-                const { transport = "extensions" } = compact({}, clientOptions.enhancedClientAwareness, constructorOptions.enhancedClientAwareness);
+                const { transport = "extensions" } = compact({}, clientOptions.enhancedClientAwareness, options.enhancedClientAwareness);
                 if (transport === "extensions") {
                     operation.extensions = compact(
                     // setting these first so that it can be overridden by user-provided extensions

package/link/client-awareness/ClientAwarenessLink.js.map

@@ -1 +1 @@
-{"version":3,"file":"ClientAwarenessLink.js","sourceRoot":"","sources":["../../../src/link/client-awareness/ClientAwarenessLink.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,OAAO,EAAE,MAAM,mCAAmC,CAAC;AA6D5D,MAAM,OAAO,mBAAoB,SAAQ,UAAU;IACjD,YAAY,qBAAkD,EAAE;QAC9D,KAAK,CAAC,CAAC,SAAS,EAAE,OAAO,EAAE,EAAE;YAC3B,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC;YAEhC,MAAM,aAAa,GAAG,MAAM,CAAC,cAAc,CAAC,CAAC,aAAa,CAAC;YAC3D,MAAM,OAAO,GAAG,SAAS,CAAC,UAAU,EAAE,CAAC;YACvC,CAAC;gBACC,MAAM,EACJ,IAAI,EACJ,OAAO,EACP,SAAS,GAAG,SAAS,GACtB,GAAG,OAAO,CACT,EAAE,EACF,aAAa,CAAC,eAAe,EAC7B,kBAAkB,CAAC,eAAe,EAClC,OAAO,CAAC,eAAe,CACxB,CAAC;gBAEF,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;oBAC5B,SAAS,CAAC,UAAU,CAAC,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,EAAE,EAAE;wBAC/C,OAAO;4BACL,OAAO,EAAE,OAAO;4BACd,8EAA8E;4BAC9E;gCACE,2BAA2B,EAAE,IAAI;gCACjC,8BAA8B,EAAE,OAAO;6BACxC,EACD,OAAO,CACR;yBACF,CAAC;oBACJ,CAAC,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;YACD,CAAC;gBACC,MAAM,EAAE,SAAS,GAAG,YAAY,EAAE,GAAG,OAAO,CAC1C,EAAE,EACF,aAAa,CAAC,uBAAuB,EACrC,kBAAkB,CAAC,uBAAuB,CAC3C,CAAC;gBACF,IAAI,SAAS,KAAK,YAAY,EAAE,CAAC;oBAC/B,SAAS,CAAC,UAAU,GAAG,OAAO;oBAC5B,+EAA+E;oBAC/E;wBACE,aAAa,EAAE;4BACb,IAAI,EAAE,gBAAgB;4BACtB,OAAO,EAAE,MAAM,CAAC,OAAO;yBACxB;qBACF,EACD,SAAS,CAAC,UAAU,CACrB,CAAC;gBACJ,CAAC;YACH,CAAC;YAED,OAAO,OAAO,CAAC,SAAS,CAAC,CAAC;QAC5B,CAAC,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["import { ApolloLink } from \"@apollo/client/link\";\nimport { compact } from \"@apollo/client/utilities/internal\";\n\nexport declare namespace ClientAwarenessLink {\n  export interface ClientAwarenessOptions {\n    /**\n     * A custom name (e.g., `iOS`) that identifies this particular client among your set of clients. Apollo Server and Apollo Studio use this property as part of the [client awareness](https://www.apollographql.com/docs/apollo-server/monitoring/metrics#identifying-distinct-clients) feature.\n     *\n     * This option can either be set as part of the Apollo Client constructor call or when manually constructing a `HttpLink`, `BatchHttpLink` or `ClientAwarenessLink`.\n     */\n    name?: string;\n    /**\n     * A custom version that identifies the current version of this particular client (e.g., `1.2`). Apollo Server and Apollo Studio use this property as part of the [client awareness](https://www.apollographql.com/docs/apollo-server/monitoring/metrics#identifying-distinct-clients) feature.\n     *\n     * This is **not** the version of Apollo Client that you are using, but rather any version string that helps you differentiate between versions of your client.\n     *\n     * This option can either be set as part of the Apollo Client constructor call or when manually constructing a `HttpLink`, `BatchHttpLink` or `ClientAwarenessLink`.\n     */\n    version?: string;\n    /**\n     * Determines how `name` and `version` are sent in outgoing requests.\n     *\n     * If `name` and `version` are not provided, this option will be ignored.\n     * (These options can either be set as part of the Apollo Client constructor call or when manually constructing a `HttpLink`, `BatchHttpLink` or `ClientAwarenessLink`.)\n     *\n     * - If set to `\"headers\"`, `name` and `version` will be sent in the request headers as `apollographql-client-name` and `apollographql-client-version`, respectively.\n     * - If set to `false`, `name` and `version` will not be included in outgoing requests.\n     *\n     * @defaultValue \"headers\"\n     */\n    transport?: \"headers\" | false;\n  }\n  export interface EnhancedClientAwarenessOptions {\n    /**\n     * Determines how the the version information of Apollo Client is sent in outgoing requests.\n     *\n     * - If set to `\"extensions\"`, library `name` and `version` will be sent in an object in the request extensions as `clientLibrary`.\n     * - If set to `false`, library name and version will not be included in outgoing requests.\n     *\n     * @defaultValue \"extensions\"\n     */\n    transport?: \"extensions\" | false;\n  }\n\n  export interface Options {\n    /**\n     * Configures the \"client awareness\" feature.\n     * This feature allows you to identify distinct applications in Apollo Studio\n     * and Apollo Server logs (and other monitoring or analytics tools) by adding\n     * information about the your application to outgoing requests.\n     */\n    clientAwareness?: ClientAwarenessOptions;\n    /**\n     * Configures the \"enhanced client awareness\" feature.\n     * This feature allows you to identify the version of the Apollo Client library\n     * used in your application in Apollo Studio (and other monitoring or analytics tools)\n     * by adding information about the Apollo Client library to outgoing requests.\n     */\n    enhancedClientAwareness?: EnhancedClientAwarenessOptions;\n  }\n}\n\nexport class ClientAwarenessLink extends ApolloLink {\n  constructor(constructorOptions: ClientAwarenessLink.Options = {}) {\n    super((operation, forward) => {\n      const client = operation.client;\n\n      const clientOptions = client[\"queryManager\"].clientOptions;\n      const context = operation.getContext();\n      {\n        const {\n          name,\n          version,\n          transport = \"headers\",\n        } = compact(\n          {},\n          clientOptions.clientAwareness,\n          constructorOptions.clientAwareness,\n          context.clientAwareness\n        );\n\n        if (transport === \"headers\") {\n          operation.setContext(({ headers, extensions }) => {\n            return {\n              headers: compact(\n                // setting these first so that they can be overridden by user-provided headers\n                {\n                  \"apollographql-client-name\": name,\n                  \"apollographql-client-version\": version,\n                },\n                headers\n              ),\n            };\n          });\n        }\n      }\n      {\n        const { transport = \"extensions\" } = compact(\n          {},\n          clientOptions.enhancedClientAwareness,\n          constructorOptions.enhancedClientAwareness\n        );\n        if (transport === \"extensions\") {\n          operation.extensions = compact(\n            // setting these first so that it can be overridden by user-provided extensions\n            {\n              clientLibrary: {\n                name: \"@apollo/client\",\n                version: client.version,\n              },\n            },\n            operation.extensions\n          );\n        }\n      }\n\n      return forward(operation);\n    });\n  }\n}\n"]}
+{"version":3,"file":"ClientAwarenessLink.js","sourceRoot":"","sources":["../../../src/link/client-awareness/ClientAwarenessLink.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,OAAO,EAAE,MAAM,mCAAmC,CAAC;AA4E5D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,OAAO,mBAAoB,SAAQ,UAAU;IACjD,YAAY,UAAuC,EAAE;QACnD,KAAK,CAAC,CAAC,SAAS,EAAE,OAAO,EAAE,EAAE;YAC3B,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC;YAEhC,MAAM,aAAa,GAAG,MAAM,CAAC,cAAc,CAAC,CAAC,aAAa,CAAC;YAC3D,MAAM,OAAO,GAAG,SAAS,CAAC,UAAU,EAAE,CAAC;YACvC,CAAC;gBACC,MAAM,EACJ,IAAI,EACJ,OAAO,EACP,SAAS,GAAG,SAAS,GACtB,GAAG,OAAO,CACT,EAAE,EACF,aAAa,CAAC,eAAe,EAC7B,OAAO,CAAC,eAAe,EACvB,OAAO,CAAC,eAAe,CACxB,CAAC;gBAEF,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;oBAC5B,SAAS,CAAC,UAAU,CAAC,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,EAAE,EAAE;wBAC/C,OAAO;4BACL,OAAO,EAAE,OAAO;4BACd,8EAA8E;4BAC9E;gCACE,2BAA2B,EAAE,IAAI;gCACjC,8BAA8B,EAAE,OAAO;6BACxC,EACD,OAAO,CACR;yBACF,CAAC;oBACJ,CAAC,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;YACD,CAAC;gBACC,MAAM,EAAE,SAAS,GAAG,YAAY,EAAE,GAAG,OAAO,CAC1C,EAAE,EACF,aAAa,CAAC,uBAAuB,EACrC,OAAO,CAAC,uBAAuB,CAChC,CAAC;gBACF,IAAI,SAAS,KAAK,YAAY,EAAE,CAAC;oBAC/B,SAAS,CAAC,UAAU,GAAG,OAAO;oBAC5B,+EAA+E;oBAC/E;wBACE,aAAa,EAAE;4BACb,IAAI,EAAE,gBAAgB;4BACtB,OAAO,EAAE,MAAM,CAAC,OAAO;yBACxB;qBACF,EACD,SAAS,CAAC,UAAU,CACrB,CAAC;gBACJ,CAAC;YACH,CAAC;YAED,OAAO,OAAO,CAAC,SAAS,CAAC,CAAC;QAC5B,CAAC,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["import { ApolloLink } from \"@apollo/client/link\";\nimport { compact } from \"@apollo/client/utilities/internal\";\n\nexport declare namespace ClientAwarenessLink {\n  /**\n   * Options passed to `ClientAwarenessLink` through [request context](https://apollographql.com/docs/react/api/link/introduction#managing-context). Previous\n   * non-terminating links in the link chain also can set these values to\n   * customize the behavior of `ClientAwarenessLink` for each operation.\n   *\n   * > [!NOTE]\n   * > Some of these values can also be provided to the `ClientAwarenessLink`\n   * > constructor. If a value is provided to both, the value in `context` takes\n   * > precedence.\n   */\n  export interface ContextOptions {\n    /** {@inheritDoc @apollo/client/link/client-awareness!ClientAwarenessLink.Options#clientAwareness:member} */\n    clientAwareness?: ClientAwarenessLink.ClientAwarenessOptions;\n  }\n\n  export interface ClientAwarenessOptions {\n    /**\n     * A custom name (e.g., `iOS`) that identifies this particular client among your set of clients. Apollo Server and Apollo Studio use this property as part of the [client awareness](https://www.apollographql.com/docs/apollo-server/monitoring/metrics#identifying-distinct-clients) feature.\n     *\n     * This option can either be set as part of the Apollo Client constructor call or when manually constructing a `HttpLink`, `BatchHttpLink` or `ClientAwarenessLink`.\n     */\n    name?: string;\n    /**\n     * A custom version that identifies the current version of this particular client (e.g., `1.2`). Apollo Server and Apollo Studio use this property as part of the [client awareness](https://www.apollographql.com/docs/apollo-server/monitoring/metrics#identifying-distinct-clients) feature.\n     *\n     * This is **not** the version of Apollo Client that you are using, but rather any version string that helps you differentiate between versions of your client.\n     *\n     * This option can either be set as part of the Apollo Client constructor call or when manually constructing a `HttpLink`, `BatchHttpLink` or `ClientAwarenessLink`.\n     */\n    version?: string;\n    /**\n     * Determines how `name` and `version` are sent in outgoing requests.\n     *\n     * If `name` and `version` are not provided, this option will be ignored.\n     * (These options can either be set as part of the Apollo Client constructor call or when manually constructing a `HttpLink`, `BatchHttpLink` or `ClientAwarenessLink`.)\n     *\n     * - If set to `\"headers\"`, `name` and `version` will be sent in the request headers as `apollographql-client-name` and `apollographql-client-version`, respectively.\n     * - If set to `false`, `name` and `version` will not be included in outgoing requests.\n     *\n     * @defaultValue \"headers\"\n     */\n    transport?: \"headers\" | false;\n  }\n  export interface EnhancedClientAwarenessOptions {\n    /**\n     * Determines how the the version information of Apollo Client is sent in outgoing requests.\n     *\n     * - If set to `\"extensions\"`, library `name` and `version` will be sent in an object in the request extensions as `clientLibrary`.\n     * - If set to `false`, library name and version will not be included in outgoing requests.\n     *\n     * @defaultValue \"extensions\"\n     */\n    transport?: \"extensions\" | false;\n  }\n\n  export interface Options {\n    /**\n     * Configures the \"client awareness\" feature.\n     * This feature allows you to identify distinct applications in Apollo Studio\n     * and Apollo Server logs (and other monitoring or analytics tools) by adding\n     * information about the your application to outgoing requests.\n     */\n    clientAwareness?: ClientAwarenessLink.ClientAwarenessOptions;\n    /**\n     * Configures the \"enhanced client awareness\" feature.\n     * This feature allows you to identify the version of the Apollo Client library\n     * used in your application in Apollo Studio (and other monitoring or analytics tools)\n     * by adding information about the Apollo Client library to outgoing requests.\n     */\n    enhancedClientAwareness?: ClientAwarenessLink.EnhancedClientAwarenessOptions;\n  }\n}\n\n/**\n * `ClientAwarenessLink` provides support for providing client awareness\n * features.\n *\n * @remarks\n *\n * Client awareness adds identifying information about the client to HTTP\n * requests for use with metrics reporting tools, such as [Apollo GraphOS](https://apollographql.com/docs/graphos/platform).\n * It is included in the functionality of [`HttpLink`](https://apollographql.com/docs/react/api/link/apollo-link-http) by default.\n *\n * Client awareness distinguishes between user-provided client awareness\n * (provided by the `clientAwareness` option) and enhanced client awareness\n * (provided by the `enhancedClientAwareness` option). User-provided client\n * awareness enables you to set a customized client name and version for\n * identification in metrics reporting tools. Enhanced client awareness enables\n * the identification of the Apollo Client package name and version.\n *\n * @example\n *\n * ```ts\n * import { ClientAwarenessLink } from \"@apollo/client/link/client-awareness\";\n *\n * const link = new ClientAwarenessLink({\n *   clientAwareness: {\n *     name: \"My Client\",\n *     version: \"1\",\n *   },\n *   enhancedClientAwareness: {\n *     transport: \"extensions\",\n *   },\n * });\n * ```\n */\nexport class ClientAwarenessLink extends ApolloLink {\n  constructor(options: ClientAwarenessLink.Options = {}) {\n    super((operation, forward) => {\n      const client = operation.client;\n\n      const clientOptions = client[\"queryManager\"].clientOptions;\n      const context = operation.getContext();\n      {\n        const {\n          name,\n          version,\n          transport = \"headers\",\n        } = compact(\n          {},\n          clientOptions.clientAwareness,\n          options.clientAwareness,\n          context.clientAwareness\n        );\n\n        if (transport === \"headers\") {\n          operation.setContext(({ headers, extensions }) => {\n            return {\n              headers: compact(\n                // setting these first so that they can be overridden by user-provided headers\n                {\n                  \"apollographql-client-name\": name,\n                  \"apollographql-client-version\": version,\n                },\n                headers\n              ),\n            };\n          });\n        }\n      }\n      {\n        const { transport = \"extensions\" } = compact(\n          {},\n          clientOptions.enhancedClientAwareness,\n          options.enhancedClientAwareness\n        );\n        if (transport === \"extensions\") {\n          operation.extensions = compact(\n            // setting these first so that it can be overridden by user-provided extensions\n            {\n              clientLibrary: {\n                name: \"@apollo/client\",\n                version: client.version,\n              },\n            },\n            operation.extensions\n          );\n        }\n      }\n\n      return forward(operation);\n    });\n  }\n}\n"]}

package/link/context/index.d.ts

@@ -1,7 +1,50 @@
 import { ApolloLink } from "@apollo/client/link";
 export declare namespace SetContextLink {
-    type ContextSetter = (prevContext: ApolloLink.OperationContext, operation: SetContextOperation) => Promise<Partial<ApolloLink.OperationContext>> | Partial<ApolloLink.OperationContext>;
-    type LegacyContextSetter = (operation: SetContextOperation, prevContext: ApolloLink.OperationContext) => Promise<Partial<ApolloLink.OperationContext>> | Partial<ApolloLink.OperationContext>;
+    namespace SetContextLinkDocumentationTypes {
+        /**
+         * A function that returns an updated context object for an Apollo Link
+         * operation.
+         *
+         * The context setter function is called for each operation and allows you to
+         * modify the operation's context before it's passed to the next link in the
+         * chain. The returned context object is shallowly merged with the previous
+         * context object.
+         *
+         * @param prevContext - The previous context of the operation (e.g. the value
+         * of `operation.getContext()`)
+         * @param operation - The GraphQL operation being executed, without the
+         * `getContext` and `setContext` methods
+         * @returns A partial context object or a promise that resolves to a partial context object
+         */
+        function ContextSetter(prevContext: Readonly<ApolloLink.OperationContext>, operation: SetContextLink.SetContextOperation): Promise<Partial<ApolloLink.OperationContext>> | Partial<ApolloLink.OperationContext>;
+    }
+    /**
+    * A function that returns an updated context object for an Apollo Link
+    * operation.
+    * 
+    * The context setter function is called for each operation and allows you to
+    * modify the operation's context before it's passed to the next link in the
+    * chain. The returned context object is shallowly merged with the previous
+    * context object.
+    * 
+    * @param prevContext - The previous context of the operation (e.g. the value
+    * of `operation.getContext()`)
+    * @param operation - The GraphQL operation being executed, without the
+    * `getContext` and `setContext` methods
+    * @returns A partial context object or a promise that resolves to a partial context object
+    */
+    type ContextSetter = (prevContext: Readonly<ApolloLink.OperationContext>, operation: SetContextLink.SetContextOperation) => Promise<Partial<ApolloLink.OperationContext>> | Partial<ApolloLink.OperationContext>;
+    /**
+     * @deprecated
+     * Use `ContextSetter` instead. This type is used by the deprecated
+     * `setContext` function.
+     */
+    type LegacyContextSetter = (operation: SetContextLink.SetContextOperation, prevContext: Readonly<ApolloLink.OperationContext>) => Promise<Partial<ApolloLink.OperationContext>> | Partial<ApolloLink.OperationContext>;
+    /**
+     * An `ApolloLink.Operation` object without the `getContext` and `setContext`
+     * methods. This prevents context setters from directly manipulating the
+     * context during the setter function execution.
+     */
     type SetContextOperation = Omit<ApolloLink.Operation, "getContext" | "setContext">;
 }
 /**
@@ -17,7 +60,26 @@ export declare namespace SetContextLink {
  * ```
  */
 export declare function setContext(setter: SetContextLink.LegacyContextSetter): SetContextLink;
+/**
+ * `SetContextLink` is a non-terminating link that allows you to modify the
+ * context of GraphQL operations before they're passed to the next link in the
+ * chain. This is commonly used for authentication, adding headers, and other
+ * request-time configuration.
+ *
+ * @example
+ *
+ * ```ts
+ * import { SetContextLink } from "@apollo/client/link/context";
+ *
+ * const link = new SetContextLink((prevContext, operation) => {
+ *   return {
+ *     credentials: "include",
+ *     // ...
+ *   };
+ * });
+ * ```
+ */
 export declare class SetContextLink extends ApolloLink {
     constructor(setter: SetContextLink.ContextSetter);
 }
-//# sourceMappingURL=index.d.ts.map
+//# sourceMappingURL=index.d.ts.map

package/link/context/index.js

@@ -15,6 +15,25 @@ import { ApolloLink } from "@apollo/client/link";
 export function setContext(setter) {
     return new SetContextLink((prevContext, operation) => setter(operation, prevContext));
 }
+/**
+ * `SetContextLink` is a non-terminating link that allows you to modify the
+ * context of GraphQL operations before they're passed to the next link in the
+ * chain. This is commonly used for authentication, adding headers, and other
+ * request-time configuration.
+ *
+ * @example
+ *
+ * ```ts
+ * import { SetContextLink } from "@apollo/client/link/context";
+ *
+ * const link = new SetContextLink((prevContext, operation) => {
+ *   return {
+ *     credentials: "include",
+ *     // ...
+ *   };
+ * });
+ * ```
+ */
 export class SetContextLink extends ApolloLink {
     constructor(setter) {
         super((operation, forward) => {

package/link/context/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/link/context/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAElC,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAuBjD;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,UAAU,CAAC,MAA0C;IACnE,OAAO,IAAI,cAAc,CAAC,CAAC,WAAW,EAAE,SAAS,EAAE,EAAE,CACnD,MAAM,CAAC,SAAS,EAAE,WAAW,CAAC,CAC/B,CAAC;AACJ,CAAC;AACD,MAAM,OAAO,cAAe,SAAQ,UAAU;IAC5C,YAAY,MAAoC;QAC9C,KAAK,CAAC,CAAC,SAAS,EAAE,OAAO,EAAE,EAAE;YAC3B,MAAM,EAAE,GAAG,OAAO,EAAE,GAAG,SAA+C,CAAC;YAEvE,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,QAAQ,EAAE;gBACvC,UAAU,EAAE,KAAK;gBACjB,KAAK,EAAE,SAAS,CAAC,MAAM;aACxB,CAAC,CAAC;YAEH,OAAO,IAAI,UAAU,CAAC,CAAC,QAAQ,EAAE,EAAE;gBACjC,IAAI,MAAM,GAAG,KAAK,CAAC;gBACnB,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC;qBACrB,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,UAAU,EAAE,EAAE,GAAG,CAAC,CAAC;qBAClD,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC;qBAC1B,IAAI,CAAC,GAAG,EAAE;oBACT,IAAI,CAAC,MAAM,EAAE,CAAC;wBACZ,OAAO,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;oBACzC,CAAC;gBACH,CAAC,CAAC;qBACD,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;gBAExC,OAAO,GAAG,EAAE;oBACV,MAAM,GAAG,IAAI,CAAC;gBAChB,CAAC,CAAC;YACJ,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["import { Observable } from \"rxjs\";\n\nimport { ApolloLink } from \"@apollo/client/link\";\n\nexport declare namespace SetContextLink {\n  export type ContextSetter = (\n    prevContext: ApolloLink.OperationContext,\n    operation: SetContextOperation\n  ) =>\n    | Promise<Partial<ApolloLink.OperationContext>>\n    | Partial<ApolloLink.OperationContext>;\n\n  export type LegacyContextSetter = (\n    operation: SetContextOperation,\n    prevContext: ApolloLink.OperationContext\n  ) =>\n    | Promise<Partial<ApolloLink.OperationContext>>\n    | Partial<ApolloLink.OperationContext>;\n\n  export type SetContextOperation = Omit<\n    ApolloLink.Operation,\n    \"getContext\" | \"setContext\"\n  >;\n}\n\n/**\n * @deprecated\n * Use `SetContextLink` from `@apollo/client/link/context` instead. Note you\n * will need to flip the arguments when using `SetContextLink` as `prevContext`\n * is the first argument.\n *\n * ```ts\n * new SetContextLink((prevContext, operation) => {\n *   // ...\n * });\n * ```\n */\nexport function setContext(setter: SetContextLink.LegacyContextSetter) {\n  return new SetContextLink((prevContext, operation) =>\n    setter(operation, prevContext)\n  );\n}\nexport class SetContextLink extends ApolloLink {\n  constructor(setter: SetContextLink.ContextSetter) {\n    super((operation, forward) => {\n      const { ...request } = operation as SetContextLink.SetContextOperation;\n\n      Object.defineProperty(request, \"client\", {\n        enumerable: false,\n        value: operation.client,\n      });\n\n      return new Observable((observer) => {\n        let closed = false;\n        Promise.resolve(request)\n          .then((req) => setter(operation.getContext(), req))\n          .then(operation.setContext)\n          .then(() => {\n            if (!closed) {\n              forward(operation).subscribe(observer);\n            }\n          })\n          .catch(observer.error.bind(observer));\n\n        return () => {\n          closed = true;\n        };\n      });\n    });\n  }\n}\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/link/context/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAElC,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AA0DjD;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,UAAU,CAAC,MAA0C;IACnE,OAAO,IAAI,cAAc,CAAC,CAAC,WAAW,EAAE,SAAS,EAAE,EAAE,CACnD,MAAM,CAAC,SAAS,EAAE,WAAW,CAAC,CAC/B,CAAC;AACJ,CAAC;AACD;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,OAAO,cAAe,SAAQ,UAAU;IAC5C,YAAY,MAAoC;QAC9C,KAAK,CAAC,CAAC,SAAS,EAAE,OAAO,EAAE,EAAE;YAC3B,MAAM,EAAE,GAAG,OAAO,EAAE,GAAG,SAA+C,CAAC;YAEvE,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,QAAQ,EAAE;gBACvC,UAAU,EAAE,KAAK;gBACjB,KAAK,EAAE,SAAS,CAAC,MAAM;aACxB,CAAC,CAAC;YAEH,OAAO,IAAI,UAAU,CAAC,CAAC,QAAQ,EAAE,EAAE;gBACjC,IAAI,MAAM,GAAG,KAAK,CAAC;gBACnB,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC;qBACrB,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,UAAU,EAAE,EAAE,GAAG,CAAC,CAAC;qBAClD,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC;qBAC1B,IAAI,CAAC,GAAG,EAAE;oBACT,IAAI,CAAC,MAAM,EAAE,CAAC;wBACZ,OAAO,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;oBACzC,CAAC;gBACH,CAAC,CAAC;qBACD,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;gBAExC,OAAO,GAAG,EAAE;oBACV,MAAM,GAAG,IAAI,CAAC;gBAChB,CAAC,CAAC;YACJ,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["import { Observable } from \"rxjs\";\n\nimport { ApolloLink } from \"@apollo/client/link\";\n\nexport declare namespace SetContextLink {\n  namespace SetContextLinkDocumentationTypes {\n    /**\n     * A function that returns an updated context object for an Apollo Link\n     * operation.\n     *\n     * The context setter function is called for each operation and allows you to\n     * modify the operation's context before it's passed to the next link in the\n     * chain. The returned context object is shallowly merged with the previous\n     * context object.\n     *\n     * @param prevContext - The previous context of the operation (e.g. the value\n     * of `operation.getContext()`)\n     * @param operation - The GraphQL operation being executed, without the\n     * `getContext` and `setContext` methods\n     * @returns A partial context object or a promise that resolves to a partial context object\n     */\n    export function ContextSetter(\n      prevContext: Readonly<ApolloLink.OperationContext>,\n      operation: SetContextLink.SetContextOperation\n    ):\n      | Promise<Partial<ApolloLink.OperationContext>>\n      | Partial<ApolloLink.OperationContext>;\n  }\n\n  /** {@inheritDoc @apollo/client/link/context!SetContextLink.SetContextLinkDocumentationTypes.ContextSetter:function(1)} */\n  export type ContextSetter = (\n    prevContext: Readonly<ApolloLink.OperationContext>,\n    operation: SetContextLink.SetContextOperation\n  ) =>\n    | Promise<Partial<ApolloLink.OperationContext>>\n    | Partial<ApolloLink.OperationContext>;\n\n  /**\n   * @deprecated\n   * Use `ContextSetter` instead. This type is used by the deprecated\n   * `setContext` function.\n   */\n  export type LegacyContextSetter = (\n    operation: SetContextLink.SetContextOperation,\n    prevContext: Readonly<ApolloLink.OperationContext>\n  ) =>\n    | Promise<Partial<ApolloLink.OperationContext>>\n    | Partial<ApolloLink.OperationContext>;\n\n  /**\n   * An `ApolloLink.Operation` object without the `getContext` and `setContext`\n   * methods. This prevents context setters from directly manipulating the\n   * context during the setter function execution.\n   */\n  export type SetContextOperation = Omit<\n    ApolloLink.Operation,\n    \"getContext\" | \"setContext\"\n  >;\n}\n\n/**\n * @deprecated\n * Use `SetContextLink` from `@apollo/client/link/context` instead. Note you\n * will need to flip the arguments when using `SetContextLink` as `prevContext`\n * is the first argument.\n *\n * ```ts\n * new SetContextLink((prevContext, operation) => {\n *   // ...\n * });\n * ```\n */\nexport function setContext(setter: SetContextLink.LegacyContextSetter) {\n  return new SetContextLink((prevContext, operation) =>\n    setter(operation, prevContext)\n  );\n}\n/**\n * `SetContextLink` is a non-terminating link that allows you to modify the\n * context of GraphQL operations before they're passed to the next link in the\n * chain. This is commonly used for authentication, adding headers, and other\n * request-time configuration.\n *\n * @example\n *\n * ```ts\n * import { SetContextLink } from \"@apollo/client/link/context\";\n *\n * const link = new SetContextLink((prevContext, operation) => {\n *   return {\n *     credentials: \"include\",\n *     // ...\n *   };\n * });\n * ```\n */\nexport class SetContextLink extends ApolloLink {\n  constructor(setter: SetContextLink.ContextSetter) {\n    super((operation, forward) => {\n      const { ...request } = operation as SetContextLink.SetContextOperation;\n\n      Object.defineProperty(request, \"client\", {\n        enumerable: false,\n        value: operation.client,\n      });\n\n      return new Observable((observer) => {\n        let closed = false;\n        Promise.resolve(request)\n          .then((req) => setter(operation.getContext(), req))\n          .then(operation.setContext)\n          .then(() => {\n            if (!closed) {\n              forward(operation).subscribe(observer);\n            }\n          })\n          .catch(observer.error.bind(observer));\n\n        return () => {\n          closed = true;\n        };\n      });\n    });\n  }\n}\n"]}

package/link/error/index.d.ts

@@ -2,12 +2,29 @@ import { Observable } from "rxjs";
 import type { ErrorLike } from "@apollo/client";
 import { ApolloLink } from "@apollo/client/link";
 export declare namespace ErrorLink {
+    namespace ErrorLinkDocumentationTypes {
+        /**
+         * Callback that is called by `ErrorLink` when an error occurs from a
+         * downstream link in link chain.
+         *
+         * @param options - The options object provided by `ErrorLink` to the error
+         * handler when an error occurs.
+         */
+        function ErrorHandler(options: ErrorHandlerOptions): Observable<ApolloLink.Result> | void;
+    }
     /**
-     * Callback to be triggered when an error occurs within the link stack.
-     */
+    * Callback that is called by `ErrorLink` when an error occurs from a
+    * downstream link in link chain.
+    * 
+    * @param options - The options object provided by `ErrorLink` to the error
+    * handler when an error occurs.
+    */
     interface ErrorHandler {
         (options: ErrorHandlerOptions): Observable<ApolloLink.Result> | void;
     }
+    /**
+     * The object provided to the `ErrorHandler` callback function.
+     */
     interface ErrorHandlerOptions {
         /**
          * The error that occurred during the operation execution. This can be a
@@ -33,13 +50,56 @@ export declare namespace ErrorLink {
         forward: ApolloLink.ForwardFunction;
     }
 }
-export import ErrorHandler = ErrorLink.ErrorHandler;
 /**
  * @deprecated
  * Use `ErrorLink` from `@apollo/client/link/error` instead.
  */
-export declare function onError(errorHandler: ErrorHandler): ErrorLink;
+export declare function onError(errorHandler: ErrorLink.ErrorHandler): ErrorLink;
+/**
+ * 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}`);
+ *   }
+ * });
+ * ```
+ */
 export declare class ErrorLink extends ApolloLink {
     constructor(errorHandler: ErrorLink.ErrorHandler);
 }
-//# sourceMappingURL=index.d.ts.map
+//# sourceMappingURL=index.d.ts.map