@depup/apollo__client 4.1.6-depup.0

package/dev/index.d.ts

@@ -0,0 +1,6 @@
+export { loadDevMessages } from "./loadDevMessages.js";
+export { loadErrorMessageHandler } from "./loadErrorMessageHandler.js";
+export { loadErrorMessages } from "./loadErrorMessages.js";
+export { setErrorMessageHandler } from "./setErrorMessageHandler.js";
+export type { ErrorMessageHandler } from "./setErrorMessageHandler.js";
+//# sourceMappingURL=index.d.ts.map

package/dev/index.js

@@ -0,0 +1,5 @@
+export { loadDevMessages } from "./loadDevMessages.js";
+export { loadErrorMessageHandler } from "./loadErrorMessageHandler.js";
+export { loadErrorMessages } from "./loadErrorMessages.js";
+export { setErrorMessageHandler } from "./setErrorMessageHandler.js";
+//# sourceMappingURL=index.js.map

package/dev/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/dev/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC","sourcesContent":["export { loadDevMessages } from \"./loadDevMessages.js\";\nexport { loadErrorMessageHandler } from \"./loadErrorMessageHandler.js\";\nexport { loadErrorMessages } from \"./loadErrorMessages.js\";\nexport { setErrorMessageHandler } from \"./setErrorMessageHandler.js\";\nexport type { ErrorMessageHandler } from \"./setErrorMessageHandler.js\";\n"]}

package/dev/loadDevMessages.d.ts

@@ -0,0 +1,2 @@
+export declare function loadDevMessages(): void;
+//# sourceMappingURL=loadDevMessages.d.ts.map

package/dev/loadDevMessages.js

@@ -0,0 +1,6 @@
+import { devDebug, devError, devLog, devWarn } from "../invariantErrorCodes.js";
+import { loadErrorMessageHandler } from "./loadErrorMessageHandler.js";
+export function loadDevMessages() {
+    loadErrorMessageHandler(devDebug, devError, devLog, devWarn);
+}
+//# sourceMappingURL=loadDevMessages.js.map

package/dev/loadDevMessages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loadDevMessages.js","sourceRoot":"","sources":["../../src/dev/loadDevMessages.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AAEhF,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAEvE,MAAM,UAAU,eAAe;IAC7B,uBAAuB,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;AAC/D,CAAC","sourcesContent":["import { devDebug, devError, devLog, devWarn } from \"../invariantErrorCodes.js\";\n\nimport { loadErrorMessageHandler } from \"./loadErrorMessageHandler.js\";\n\nexport function loadDevMessages() {\n  loadErrorMessageHandler(devDebug, devError, devLog, devWarn);\n}\n"]}

package/dev/loadErrorMessageHandler.d.ts

@@ -0,0 +1,8 @@
+import type { ErrorCodes } from "../invariantErrorCodes.js";
+import type { ErrorMessageHandler } from "./setErrorMessageHandler.js";
+/**
+ * Injects Apollo Client's default error message handler into the application and
+ * also loads the error codes that are passed in as arguments.
+ */
+export declare function loadErrorMessageHandler(...errorCodes: ErrorCodes[]): ErrorMessageHandler & ErrorCodes;
+//# sourceMappingURL=loadErrorMessageHandler.d.ts.map

package/dev/loadErrorMessageHandler.js

@@ -0,0 +1,24 @@
+import { global } from "@apollo/client/utilities/internal/globals";
+import { setErrorMessageHandler } from "./setErrorMessageHandler.js";
+import { ApolloErrorMessageHandler } from "./symbol.js";
+/**
+ * Injects Apollo Client's default error message handler into the application and
+ * also loads the error codes that are passed in as arguments.
+ */
+export function loadErrorMessageHandler(...errorCodes) {
+    setErrorMessageHandler(handler);
+    for (const codes of errorCodes) {
+        Object.assign(handler, codes);
+    }
+    return handler;
+}
+const handler = ((message, args) => {
+    if (typeof message === "number") {
+        const definition = global[ApolloErrorMessageHandler][message];
+        if (!message || !definition?.message)
+            return;
+        message = definition.message;
+    }
+    return args.reduce((msg, arg) => msg.replace(/%[sdfo]/, String(arg)), String(message));
+});
+//# sourceMappingURL=loadErrorMessageHandler.js.map

package/dev/loadErrorMessageHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loadErrorMessageHandler.js","sourceRoot":"","sources":["../../src/dev/loadErrorMessageHandler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,2CAA2C,CAAC;AAKnE,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAC;AAExD;;;GAGG;AACH,MAAM,UAAU,uBAAuB,CAAC,GAAG,UAAwB;IACjE,sBAAsB,CAAC,OAAsC,CAAC,CAAC;IAE/D,KAAK,MAAM,KAAK,IAAI,UAAU,EAAE,CAAC;QAC/B,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAChC,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,MAAM,OAAO,GAAG,CAAC,CAAC,OAAwB,EAAE,IAAe,EAAE,EAAE;IAC7D,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAChC,MAAM,UAAU,GAAG,MAAM,CAAC,yBAAyB,CAAE,CAAC,OAAO,CAAC,CAAC;QAC/D,IAAI,CAAC,OAAO,IAAI,CAAC,UAAU,EAAE,OAAO;YAAE,OAAO;QAC7C,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC;IAC/B,CAAC;IACD,OAAO,IAAI,CAAC,MAAM,CAChB,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,EACjD,MAAM,CAAC,OAAO,CAAC,CAChB,CAAC;AACJ,CAAC,CAAqC,CAAC","sourcesContent":["import { global } from \"@apollo/client/utilities/internal/globals\";\n\nimport type { ErrorCodes } from \"../invariantErrorCodes.js\";\n\nimport type { ErrorMessageHandler } from \"./setErrorMessageHandler.js\";\nimport { setErrorMessageHandler } from \"./setErrorMessageHandler.js\";\nimport { ApolloErrorMessageHandler } from \"./symbol.js\";\n\n/**\n * Injects Apollo Client's default error message handler into the application and\n * also loads the error codes that are passed in as arguments.\n */\nexport function loadErrorMessageHandler(...errorCodes: ErrorCodes[]) {\n  setErrorMessageHandler(handler as typeof handler & ErrorCodes);\n\n  for (const codes of errorCodes) {\n    Object.assign(handler, codes);\n  }\n\n  return handler;\n}\n\nconst handler = ((message: string | number, args: unknown[]) => {\n  if (typeof message === \"number\") {\n    const definition = global[ApolloErrorMessageHandler]![message];\n    if (!message || !definition?.message) return;\n    message = definition.message;\n  }\n  return args.reduce<string>(\n    (msg, arg) => msg.replace(/%[sdfo]/, String(arg)),\n    String(message)\n  );\n}) as ErrorMessageHandler & ErrorCodes;\n"]}

package/dev/loadErrorMessages.d.ts

@@ -0,0 +1,2 @@
+export declare function loadErrorMessages(): void;
+//# sourceMappingURL=loadErrorMessages.d.ts.map

package/dev/loadErrorMessages.js

@@ -0,0 +1,6 @@
+import { errorCodes } from "../invariantErrorCodes.js";
+import { loadErrorMessageHandler } from "./loadErrorMessageHandler.js";
+export function loadErrorMessages() {
+    loadErrorMessageHandler(errorCodes);
+}
+//# sourceMappingURL=loadErrorMessages.js.map

package/dev/loadErrorMessages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loadErrorMessages.js","sourceRoot":"","sources":["../../src/dev/loadErrorMessages.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AAEvD,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAEvE,MAAM,UAAU,iBAAiB;IAC/B,uBAAuB,CAAC,UAAU,CAAC,CAAC;AACtC,CAAC","sourcesContent":["import { errorCodes } from \"../invariantErrorCodes.js\";\n\nimport { loadErrorMessageHandler } from \"./loadErrorMessageHandler.js\";\n\nexport function loadErrorMessages() {\n  loadErrorMessageHandler(errorCodes);\n}\n"]}

package/dev/setErrorMessageHandler.d.ts

@@ -0,0 +1,34 @@
+/**
+ * The error message handler is a function that is called when a message is
+ * logged or an error is thrown to determine the contents of the error message
+ * to be logged or thrown.
+ */
+export type ErrorMessageHandler = {
+    /**
+     * @param message - Usually the error message number (as defined in
+     * `@apollo/client/invariantErrorCodes.js`).
+     * In some edge cases, this can already be a string, that can be passed through
+     * as an error message.
+     *
+     * @param args - The placeholders that can be passed into the error message (pre-stringified).
+     * These relate with the `%s` and `%d` [substitution strings](https://developer.mozilla.org/en-US/docs/Web/API/console#using_string_substitutions)
+     * in the error message defined in `@apollo/client/invariantErrorCodes.js`.
+     *
+     * ⚠️ Note that arguments will only be passed in for error messages.
+     * For normal log messages, you will get an empty array here and they will directly
+     * be passed to `console.log` instead, to have the string substitution done by the
+     * engine, as that allows for nicer (and in the case of a browser, interactive)
+     * output.
+     *
+     * @returns The error message to be logged or thrown. If it returns `undefined`,
+     * the mechanism will fall back to the default:
+     * A link to https://go.apollo.dev/c/err with Apollo Client version,
+     * the error message number, and the error message arguments encoded into
+     * the URL hash.
+     */ (message: string | number, args: string[]): string | undefined;
+};
+/**
+ * Overrides the global "Error Message Handler" with a custom implementation.
+ */
+export declare function setErrorMessageHandler(handler: ErrorMessageHandler): void;
+//# sourceMappingURL=setErrorMessageHandler.d.ts.map

package/dev/setErrorMessageHandler.js

@@ -0,0 +1,9 @@
+import { global } from "@apollo/client/utilities/internal/globals";
+import { ApolloErrorMessageHandler } from "./symbol.js";
+/**
+ * Overrides the global "Error Message Handler" with a custom implementation.
+ */
+export function setErrorMessageHandler(handler) {
+    global[ApolloErrorMessageHandler] = handler;
+}
+//# sourceMappingURL=setErrorMessageHandler.js.map

package/dev/setErrorMessageHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"setErrorMessageHandler.js","sourceRoot":"","sources":["../../src/dev/setErrorMessageHandler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,2CAA2C,CAAC;AAInE,OAAO,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAC;AAgCxD;;GAEG;AACH,MAAM,UAAU,sBAAsB,CAAC,OAA4B;IACjE,MAAM,CAAC,yBAAyB,CAAC,GAAG,OAAsC,CAAC;AAC7E,CAAC","sourcesContent":["import { global } from \"@apollo/client/utilities/internal/globals\";\n\nimport type { ErrorCodes } from \"../invariantErrorCodes.js\";\n\nimport { ApolloErrorMessageHandler } from \"./symbol.js\";\n\n/**\n * The error message handler is a function that is called when a message is\n * logged or an error is thrown to determine the contents of the error message\n * to be logged or thrown.\n */\nexport type ErrorMessageHandler = {\n  /**\n   * @param message - Usually the error message number (as defined in\n   * `@apollo/client/invariantErrorCodes.js`).\n   * In some edge cases, this can already be a string, that can be passed through\n   * as an error message.\n   *\n   * @param args - The placeholders that can be passed into the error message (pre-stringified).\n   * These relate with the `%s` and `%d` [substitution strings](https://developer.mozilla.org/en-US/docs/Web/API/console#using_string_substitutions)\n   * in the error message defined in `@apollo/client/invariantErrorCodes.js`.\n   *\n   * ⚠️ Note that arguments will only be passed in for error messages.\n   * For normal log messages, you will get an empty array here and they will directly\n   * be passed to `console.log` instead, to have the string substitution done by the\n   * engine, as that allows for nicer (and in the case of a browser, interactive)\n   * output.\n   *\n   * @returns The error message to be logged or thrown. If it returns `undefined`,\n   * the mechanism will fall back to the default:\n   * A link to https://go.apollo.dev/c/err with Apollo Client version,\n   * the error message number, and the error message arguments encoded into\n   * the URL hash.\n   */ (message: string | number, args: string[]): string | undefined;\n};\n\n/**\n * Overrides the global \"Error Message Handler\" with a custom implementation.\n */\nexport function setErrorMessageHandler(handler: ErrorMessageHandler) {\n  global[ApolloErrorMessageHandler] = handler as typeof handler & ErrorCodes;\n}\n"]}

package/dev/symbol.d.ts

@@ -0,0 +1,10 @@
+import type { ErrorCodes } from "../invariantErrorCodes.js";
+export declare const ApolloErrorMessageHandler: unique symbol;
+declare global {
+    interface Window {
+        [ApolloErrorMessageHandler]?: {
+            (message: string | number, args: string[]): string | undefined;
+        } & ErrorCodes;
+    }
+}
+//# sourceMappingURL=symbol.d.ts.map

package/dev/symbol.js

@@ -0,0 +1,4 @@
+import { version } from "../version.js";
+// This is duplicated between `@apollo/client/dev` and `@apollo/client/utilities/invariant` to prevent circular references.
+export const ApolloErrorMessageHandler = Symbol.for("ApolloErrorMessageHandler_" + version);
+//# sourceMappingURL=symbol.js.map

package/dev/symbol.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"symbol.js","sourceRoot":"","sources":["../../src/dev/symbol.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAExC,2HAA2H;AAC3H,MAAM,CAAC,MAAM,yBAAyB,GAAG,MAAM,CAAC,GAAG,CACjD,4BAA4B,GAAG,OAAO,CACvC,CAAC","sourcesContent":["import type { ErrorCodes } from \"../invariantErrorCodes.js\";\nimport { version } from \"../version.js\";\n\n// This is duplicated between `@apollo/client/dev` and `@apollo/client/utilities/invariant` to prevent circular references.\nexport const ApolloErrorMessageHandler = Symbol.for(\n  \"ApolloErrorMessageHandler_\" + version\n);\ndeclare global {\n  interface Window {\n    [ApolloErrorMessageHandler]?: {\n      (message: string | number, args: string[]): string | undefined;\n    } & ErrorCodes;\n  }\n}\n"]}

package/errors/CombinedGraphQLErrors.d.ts

@@ -0,0 +1,191 @@
+import type { FormattedExecutionResult, GraphQLFormattedError } from "graphql";
+import type { ApolloLink } from "@apollo/client/link";
+export declare namespace CombinedGraphQLErrors {
+    interface MessageFormatterOptions {
+        /**
+         * The raw result returned from the server.
+         */
+        result: ApolloLink.Result<unknown>;
+        /**
+         * The default message formatter. Call this to get a string with the default
+         * formatted message.
+         *
+         * @remarks
+         * To format part of the message using the default message formatter, call
+         * the `defaultFormatMessage` function provided to the `options` argument of
+         * your message formatter.
+         *
+         * @example
+         *
+         * The following example prepends a string to the message and uses the
+         * default message formatter to format the error messages.
+         *
+         * ```ts
+         * CombinedGraphQLErrors.formatMessage = (errors, { defaultFormatMessage }) => {
+         *   return `[GraphQL errors]: ${defaultFormatMessage(errors)}`;
+         * };
+         * ```
+         */
+        defaultFormatMessage: (errors: ReadonlyArray<GraphQLFormattedError>) => string;
+    }
+    /**
+     * By default, `CombinedGraphQLErrors` formats the `message` property by
+     * joining each error's `message` field with a newline. To customize the
+     * format of the `message`, such as changing the delimiter or adding a message
+     * prefix, override the static `formatMessage` method.
+     *
+     * @example
+     *
+     * The following example demonstrates how to format the error message by
+     * joining each error with a comma.
+     *
+     * ```ts
+     * import { CombinedGraphQLErrors } from "@apollo/client/errors";
+     *
+     * CombinedGraphQLErrors.formatMessage = (errors) => {
+     *   return errors.map((error) => error.message).join(", ");
+     * };
+     * ```
+     *
+     * @remarks
+     *
+     * See the [`formatMessage`](https://www.apollographql.com/docs/react/api/errors/CombinedGraphQLErrors#formatmessage) docs for details about the parameters provided to the `formatMessage` function.
+     *
+     * > [!NOTE]
+     * > The message formatter needs to be configured before any operation is executed by Apollo Client, otherwise the default message formatter is used. We recommend configuring the message formatter before initializing your `ApolloClient` instance.
+     *
+     * @param errors - The array of GraphQL errors returned from the server in the
+     * `errors` field of the response.
+     * @param options - Additional context that could be useful when formatting
+     * the message.
+     */
+    type MessageFormatter = (errors: ReadonlyArray<GraphQLFormattedError>, options: MessageFormatterOptions) => string;
+    namespace DocumentationTypes {
+        /**
+         * A function that formats the error message used for the error's `message`
+         * property. Override this method to provide your own formatting.
+         *
+         * @remarks
+         *
+         * The `formatMessage` function is called by the `CombinedGraphQLErrors`
+         * constructor to provide a formatted message as the `message` property of the
+         * `CombinedGraphQLErrors` object. Follow the ["Providing a custom message
+         * formatter"](https://www.apollographql.com/docs/react/api/errors/CombinedGraphQLErrors#providing-a-custom-message-formatter) guide to learn how to modify the message format.
+         *
+         * @param errors - The array of GraphQL errors returned from the server in
+         * the `errors` field of the response.
+         * @param options - Additional context that could be useful when formatting
+         * the message.
+         */
+        function formatMessage(errors: ReadonlyArray<GraphQLFormattedError>, options: MessageFormatterOptions): string;
+        interface InstanceProperties {
+            /**
+             * The raw list of GraphQL errors returned by the `errors` field in the GraphQL response.
+             */
+            readonly errors: ReadonlyArray<GraphQLFormattedError>;
+            /**
+             * Partial data returned in the `data` field of the GraphQL response.
+             */
+            readonly data: Record<string, unknown> | null | undefined;
+            /**
+             * Extensions returned by the `extensions` field in the GraphQL response.
+             */
+            readonly extensions: Record<string, unknown> | undefined;
+        }
+        /**
+         * A method that determines whether an error is a `{{errorClass}}`
+         * object. This method enables TypeScript to narrow the error type.
+         *
+         * @example
+         *
+         * ```ts
+         * if ({{errorClass}}.is(error)) {
+         *   // TypeScript now knows `error` is a `{{errorClass}}` object
+         *   console.log(error.errors);
+         * }
+         * ```
+         */
+        function is(error: unknown): boolean;
+    }
+}
+/**
+ * Represents the combined list of GraphQL errors returned from the server in a
+ * GraphQL response. This error type is used when your GraphQL operation returns
+ * errors in the `errors` field of the response.
+ *
+ * @remarks
+ *
+ * When your GraphQL operation encounters errors on the server side (such as
+ * resolver errors, validation errors, or syntax errors), the server returns
+ * these errors in the `errors` array of the GraphQL response. Apollo Client
+ * wraps these errors in a `CombinedGraphQLErrors` object, which provides access
+ * to the individual errors while maintaining additional context about the
+ * response.
+ *
+ * @example
+ *
+ * ```ts
+ * import { CombinedGraphQLErrors } from "@apollo/client/errors";
+ *
+ * // Check if an error is a CombinedGraphQLErrors object
+ * if (CombinedGraphQLErrors.is(error)) {
+ *   // Access individual GraphQL errors
+ *   error.errors.forEach((graphQLError) => {
+ *     console.log(graphQLError.message);
+ *     console.log(graphQLError.path);
+ *     console.log(graphQLError.locations);
+ *   });
+ *
+ *   // Access the original GraphQL result
+ *   console.log(error.result);
+ * }
+ * ```
+ */
+export declare class CombinedGraphQLErrors extends Error {
+    /**
+    * A method that determines whether an error is a `CombinedGraphQLErrors`
+    * object. This method enables TypeScript to narrow the error type.
+    * 
+    * @example
+    * 
+    * ```ts
+    * if (CombinedGraphQLErrors.is(error)) {
+    *   // TypeScript now knows `error` is a `CombinedGraphQLErrors` object
+    *   console.log(error.errors);
+    * }
+    * ```
+    */
+    static is(error: unknown): error is CombinedGraphQLErrors;
+    /**
+    * A function that formats the error message used for the error's `message`
+    * property. Override this method to provide your own formatting.
+    * 
+    * @remarks
+    * 
+    * The `formatMessage` function is called by the `CombinedGraphQLErrors`
+    * constructor to provide a formatted message as the `message` property of the
+    * `CombinedGraphQLErrors` object. Follow the ["Providing a custom message
+    * formatter"](https://www.apollographql.com/docs/react/api/errors/CombinedGraphQLErrors#providing-a-custom-message-formatter) guide to learn how to modify the message format.
+    * 
+    * @param errors - The array of GraphQL errors returned from the server in
+    * the `errors` field of the response.
+    * @param options - Additional context that could be useful when formatting
+    * the message.
+    */
+    static formatMessage: CombinedGraphQLErrors.MessageFormatter;
+    /**
+    * The raw list of GraphQL errors returned by the `errors` field in the GraphQL response.
+    */
+    readonly errors: ReadonlyArray<GraphQLFormattedError>;
+    /**
+    * Partial data returned in the `data` field of the GraphQL response.
+    */
+    readonly data: Record<string, unknown> | null | undefined;
+    /**
+    * Extensions returned by the `extensions` field in the GraphQL response.
+    */
+    readonly extensions: Record<string, unknown> | undefined;
+    constructor(result: FormattedExecutionResult<any>);
+    constructor(result: ApolloLink.Result<any>, errors: ReadonlyArray<GraphQLFormattedError>);
+}
+//# sourceMappingURL=CombinedGraphQLErrors.d.ts.map

package/errors/CombinedGraphQLErrors.js

@@ -0,0 +1,101 @@
+import { brand, isBranded } from "./utils.js";
+function defaultFormatMessage(errors) {
+    return (errors
+        // Handle non-spec-compliant servers: See #1185
+        .filter((e) => e)
+        .map((e) => e.message || "Error message not found.")
+        .join("\n"));
+}
+/**
+ * Represents the combined list of GraphQL errors returned from the server in a
+ * GraphQL response. This error type is used when your GraphQL operation returns
+ * errors in the `errors` field of the response.
+ *
+ * @remarks
+ *
+ * When your GraphQL operation encounters errors on the server side (such as
+ * resolver errors, validation errors, or syntax errors), the server returns
+ * these errors in the `errors` array of the GraphQL response. Apollo Client
+ * wraps these errors in a `CombinedGraphQLErrors` object, which provides access
+ * to the individual errors while maintaining additional context about the
+ * response.
+ *
+ * @example
+ *
+ * ```ts
+ * import { CombinedGraphQLErrors } from "@apollo/client/errors";
+ *
+ * // Check if an error is a CombinedGraphQLErrors object
+ * if (CombinedGraphQLErrors.is(error)) {
+ *   // Access individual GraphQL errors
+ *   error.errors.forEach((graphQLError) => {
+ *     console.log(graphQLError.message);
+ *     console.log(graphQLError.path);
+ *     console.log(graphQLError.locations);
+ *   });
+ *
+ *   // Access the original GraphQL result
+ *   console.log(error.result);
+ * }
+ * ```
+ */
+export class CombinedGraphQLErrors extends Error {
+    /**
+    * A method that determines whether an error is a `CombinedGraphQLErrors`
+    * object. This method enables TypeScript to narrow the error type.
+    * 
+    * @example
+    * 
+    * ```ts
+    * if (CombinedGraphQLErrors.is(error)) {
+    *   // TypeScript now knows `error` is a `CombinedGraphQLErrors` object
+    *   console.log(error.errors);
+    * }
+    * ```
+    */
+    static is(error) {
+        return isBranded(error, "CombinedGraphQLErrors");
+    }
+    /**
+    * A function that formats the error message used for the error's `message`
+    * property. Override this method to provide your own formatting.
+    * 
+    * @remarks
+    * 
+    * The `formatMessage` function is called by the `CombinedGraphQLErrors`
+    * constructor to provide a formatted message as the `message` property of the
+    * `CombinedGraphQLErrors` object. Follow the ["Providing a custom message
+    * formatter"](https://www.apollographql.com/docs/react/api/errors/CombinedGraphQLErrors#providing-a-custom-message-formatter) guide to learn how to modify the message format.
+    * 
+    * @param errors - The array of GraphQL errors returned from the server in
+    * the `errors` field of the response.
+    * @param options - Additional context that could be useful when formatting
+    * the message.
+    */
+    static formatMessage = defaultFormatMessage;
+    /**
+    * The raw list of GraphQL errors returned by the `errors` field in the GraphQL response.
+    */
+    errors;
+    /**
+    * Partial data returned in the `data` field of the GraphQL response.
+    */
+    data;
+    /**
+    * Extensions returned by the `extensions` field in the GraphQL response.
+    */
+    extensions;
+    constructor(result, errors = result.errors || []) {
+        super(CombinedGraphQLErrors.formatMessage(errors, {
+            result,
+            defaultFormatMessage,
+        }));
+        this.errors = errors;
+        this.data = result.data;
+        this.extensions = result.extensions;
+        this.name = "CombinedGraphQLErrors";
+        brand(this);
+        Object.setPrototypeOf(this, CombinedGraphQLErrors.prototype);
+    }
+}
+//# sourceMappingURL=CombinedGraphQLErrors.js.map

package/errors/CombinedGraphQLErrors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CombinedGraphQLErrors.js","sources":["../../src/errors/CombinedGraphQLErrors.ts"],"sourcesContent":["import type { FormattedExecutionResult, GraphQLFormattedError } from \"graphql\";\n\nimport type { ApolloLink } from \"@apollo/client/link\";\n\nimport { brand, isBranded } from \"./utils.js\";\n\nexport declare namespace CombinedGraphQLErrors {\n  export interface MessageFormatterOptions {\n    /**\n     * The raw result returned from the server.\n     */\n    result: ApolloLink.Result<unknown>;\n\n    /**\n     * The default message formatter. Call this to get a string with the default\n     * formatted message.\n     *\n     * @remarks\n     * To format part of the message using the default message formatter, call\n     * the `defaultFormatMessage` function provided to the `options` argument of\n     * your message formatter.\n     *\n     * @example\n     *\n     * The following example prepends a string to the message and uses the\n     * default message formatter to format the error messages.\n     *\n     * ```ts\n     * CombinedGraphQLErrors.formatMessage = (errors, { defaultFormatMessage }) => {\n     *   return `[GraphQL errors]: ${defaultFormatMessage(errors)}`;\n     * };\n     * ```\n     */\n    defaultFormatMessage: (\n      errors: ReadonlyArray<GraphQLFormattedError>\n    ) => string;\n  }\n\n  /**\n   * By default, `CombinedGraphQLErrors` formats the `message` property by\n   * joining each error's `message` field with a newline. To customize the\n   * format of the `message`, such as changing the delimiter or adding a message\n   * prefix, override the static `formatMessage` method.\n   *\n   * @example\n   *\n   * The following example demonstrates how to format the error message by\n   * joining each error with a comma.\n   *\n   * ```ts\n   * import { CombinedGraphQLErrors } from \"@apollo/client/errors\";\n   *\n   * CombinedGraphQLErrors.formatMessage = (errors) => {\n   *   return errors.map((error) => error.message).join(\", \");\n   * };\n   * ```\n   *\n   * @remarks\n   *\n   * See the [`formatMessage`](https://www.apollographql.com/docs/react/api/errors/CombinedGraphQLErrors#formatmessage) docs for details about the parameters provided to the `formatMessage` function.\n   *\n   * > [!NOTE]\n   * > The message formatter needs to be configured before any operation is executed by Apollo Client, otherwise the default message formatter is used. We recommend configuring the message formatter before initializing your `ApolloClient` instance.\n   *\n   * @param errors - The array of GraphQL errors returned from the server in the\n   * `errors` field of the response.\n   * @param options - Additional context that could be useful when formatting\n   * the message.\n   */\n  export type MessageFormatter = (\n    errors: ReadonlyArray<GraphQLFormattedError>,\n    options: MessageFormatterOptions\n  ) => string;\n\n  namespace DocumentationTypes {\n    /**\n     * A function that formats the error message used for the error's `message`\n     * property. Override this method to provide your own formatting.\n     *\n     * @remarks\n     *\n     * The `formatMessage` function is called by the `CombinedGraphQLErrors`\n     * constructor to provide a formatted message as the `message` property of the\n     * `CombinedGraphQLErrors` object. Follow the [\"Providing a custom message\n     * formatter\"](https://www.apollographql.com/docs/react/api/errors/CombinedGraphQLErrors#providing-a-custom-message-formatter) guide to learn how to modify the message format.\n     *\n     * @param errors - The array of GraphQL errors returned from the server in\n     * the `errors` field of the response.\n     * @param options - Additional context that could be useful when formatting\n     * the message.\n     */\n    function formatMessage(\n      errors: ReadonlyArray<GraphQLFormattedError>,\n      options: MessageFormatterOptions\n    ): string;\n\n    interface InstanceProperties {\n      /**\n       * The raw list of GraphQL errors returned by the `errors` field in the GraphQL response.\n       */\n      readonly errors: ReadonlyArray<GraphQLFormattedError>;\n\n      /**\n       * Partial data returned in the `data` field of the GraphQL response.\n       */\n      readonly data: Record<string, unknown> | null | undefined;\n\n      /**\n       * Extensions returned by the `extensions` field in the GraphQL response.\n       */\n      readonly extensions: Record<string, unknown> | undefined;\n    }\n\n    /**\n     * A method that determines whether an error is a `{{errorClass}}`\n     * object. This method enables TypeScript to narrow the error type.\n     *\n     * @example\n     *\n     * ```ts\n     * if ({{errorClass}}.is(error)) {\n     *   // TypeScript now knows `error` is a `{{errorClass}}` object\n     *   console.log(error.errors);\n     * }\n     * ```\n     */\n    function is(error: unknown): boolean;\n  }\n}\n\nfunction defaultFormatMessage(errors: ReadonlyArray<GraphQLFormattedError>) {\n  return (\n    errors\n      // Handle non-spec-compliant servers: See #1185\n      .filter((e) => e)\n      .map((e) => e.message || \"Error message not found.\")\n      .join(\"\\n\")\n  );\n}\n\n/**\n * Represents the combined list of GraphQL errors returned from the server in a\n * GraphQL response. This error type is used when your GraphQL operation returns\n * errors in the `errors` field of the response.\n *\n * @remarks\n *\n * When your GraphQL operation encounters errors on the server side (such as\n * resolver errors, validation errors, or syntax errors), the server returns\n * these errors in the `errors` array of the GraphQL response. Apollo Client\n * wraps these errors in a `CombinedGraphQLErrors` object, which provides access\n * to the individual errors while maintaining additional context about the\n * response.\n *\n * @example\n *\n * ```ts\n * import { CombinedGraphQLErrors } from \"@apollo/client/errors\";\n *\n * // Check if an error is a CombinedGraphQLErrors object\n * if (CombinedGraphQLErrors.is(error)) {\n *   // Access individual GraphQL errors\n *   error.errors.forEach((graphQLError) => {\n *     console.log(graphQLError.message);\n *     console.log(graphQLError.path);\n *     console.log(graphQLError.locations);\n *   });\n *\n *   // Access the original GraphQL result\n *   console.log(error.result);\n * }\n * ```\n */\nexport class CombinedGraphQLErrors extends Error {\n  /**\n   * {@inheritDoc @apollo/client!CombinedGraphQLErrors.DocumentationTypes.is:function(1) {\"errorClass\":\"CombinedGraphQLErrors\"}}\n   */\n  static is(error: unknown): error is CombinedGraphQLErrors {\n    return isBranded(error, \"CombinedGraphQLErrors\");\n  }\n\n  /** {@inheritDoc @apollo/client!CombinedGraphQLErrors.DocumentationTypes.formatMessage:function(1)} */\n  static formatMessage: CombinedGraphQLErrors.MessageFormatter =\n    defaultFormatMessage;\n\n  /** {@inheritDoc @apollo/client!CombinedGraphQLErrors.DocumentationTypes.InstanceProperties#errors:member} */\n  readonly errors: ReadonlyArray<GraphQLFormattedError>;\n\n  /** {@inheritDoc @apollo/client!CombinedGraphQLErrors.DocumentationTypes.InstanceProperties#data:member} */\n  readonly data: Record<string, unknown> | null | undefined;\n\n  /** {@inheritDoc @apollo/client!CombinedGraphQLErrors.DocumentationTypes.InstanceProperties#extensions:member} */\n  readonly extensions: Record<string, unknown> | undefined;\n\n  constructor(result: FormattedExecutionResult<any>);\n  constructor(\n    result: ApolloLink.Result<any>,\n    errors: ReadonlyArray<GraphQLFormattedError>\n  );\n\n  constructor(\n    result: ApolloLink.Result<any> | FormattedExecutionResult<any>,\n    errors = (result as FormattedExecutionResult<any>).errors || []\n  ) {\n    super(\n      CombinedGraphQLErrors.formatMessage(errors, {\n        result,\n        defaultFormatMessage,\n      })\n    );\n    this.errors = errors;\n    this.data = (result as Partial<FormattedExecutionResult>).data;\n    this.extensions = (result as Partial<FormattedExecutionResult>).extensions;\n    this.name = \"CombinedGraphQLErrors\";\n\n    brand(this);\n    Object.setPrototypeOf(this, CombinedGraphQLErrors.prototype);\n  }\n}\n"],"names":[],"mappings":"AAIA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAO,EAAE,CAAT,CAAA,CAAA,CAAA,CAAc,EAAE,CAAhB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAA,CAAA,CAAA,CAAA,EAAiC,CAAjC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA6C;AA8H7C,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAS,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA6B,CAAC,CAA9B,CAAA,CAAA,CAAA,CAAA,CAA0E,EAA1E;IACE,CAAF,CAAA,CAAA,CAAA,CAAA,EAAS,CACL,CADJ,CAAA,CAAA,CAAA,CAAA;QAEM,CAAN,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA;QACA,CAAO,CAAP,CAAA,CAAA,CAAA,CAAA,CAAa,CAAC,CAAC,CAAC,EAAE,CAAlB,EAAqB,CAAC;QACtB,CAAO,CAAP,CAAA,CAAU,CAAC,CAAC,CAAC,EAAE,CAAf,EAAkB,CAAC,CAAC,CAApB,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,EAA+B,CAA/B,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAyD;QACzD,CAAO,CAAP,CAAA,CAAA,CAAW,CAAC,CAAZ,CAAA,CAAA,CAAgB,CAAC,CACd;AACH;AAEA,CAAA,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAgCA,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,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAA2C,CAA3C,CAAA,CAAA,CAAA,EAAA;;;;;;;;;;;;;;IAIE,CAAF,CAAA,CAAA,CAAA,CAAA,EAAS,CAAT,CAAW,CAAC,CAAZ,CAAA,CAAA,CAAA,CAA0B,EAA1B;QACI,CAAJ,CAAA,CAAA,CAAA,CAAA,EAAW,CAAX,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAoB,CAAC,CAArB,CAAA,CAAA,CAAA,CAA0B,EAAE,CAA5B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAmD,CAAC;IAClD;;;;;;;;;;;;;;;;;IAGA,CAAF,CAAA,CAAA,CAAA,CAAA,EAAS,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EACI,CADJ,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACwB;;;;IAGb,CAAX,CAAA,CAAA,CAAA,CAAA,CAAiB;;;;IAGN,CAAX,CAAA,CAAA,CAAe;;;;IAGJ,CAAX,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAqB;IAQnB,CAAF,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACI,CADJ,CAAA,CAAA,CAAA,CAAA,CACkE,EAC9D,CAFJ,CAAA,CAAA,CAAA,CAAA,EAAA,EAEc,CAFd,CAAA,CAAA,CAAA,CAAA,CAEsD,CAAC,CAFvD,CAAA,CAAA,CAAA,CAAA,EAAA,CAAA,EAEiE,CAFjE,CAEmE,EAFnE;QAII,CAAJ,CAAA,CAAA,CAAA,CAAS,CACH,CADN,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAC2B,CAAC,CAD5B,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CACyC,CAAC,CAD1C,CAAA,CAAA,CAAA,CAAA,CACgD,EAAE;YAC1C,CAAR,CAAA,CAAA,CAAA,CAAA,CAAc;YACN,CAAR,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA4B;QAC5B,CAAO,CAAC,CACH;QACD,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,CAAA,CAAA,EAAA,EAAkB,CAAlB,CAAA,CAAA,CAAA,CAAA,CAAwB;QACpB,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,EAAA,EAAiB,CAAjB,CAAA,CAAA,CAAA,CAAA,CAA6D,CAAC,CAA9D,CAAA,CAAA,CAAkE;QAC9D,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,EAAA,EAAuB,CAAvB,CAAA,CAAA,CAAA,CAAA,CAAmE,CAAC,CAApE,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA8E;QAC1E,CAAJ,CAAA,CAAA,CAAQ,CAAC,CAAT,CAAA,CAAA,EAAA,EAAgB,CAAhB,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAuC;QAEnC,CAAJ,CAAA,CAAA,CAAA,CAAS,CAAC,CAAV,CAAA,CAAA,CAAc,CAAC;QACX,CAAJ,CAAA,CAAA,CAAA,CAAA,CAAU,CAAC,CAAX,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAyB,CAAC,CAA1B,CAAA,CAAA,CAA8B,EAAE,CAAhC,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAqD,CAAC,CAAtD,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAAA,CAA+D,CAAC;IAC9D;;"}

package/errors/CombinedProtocolErrors.d.ts

@@ -0,0 +1,150 @@
+import type { GraphQLFormattedError } from "graphql";
+export declare namespace CombinedProtocolErrors {
+    interface MessageFormatterOptions {
+        /**
+         * The default message formatter. Call this to get a string with the default
+         * formatted message.
+         *
+         * @remarks
+         * To format part of the message using the default message formatter, call
+         * the `defaultFormatMessage` function provided to the `options` argument of
+         * your message formatter.
+         *
+         * @example
+         *
+         * The following example prepends a string to the message and uses the
+         * default message formatter to format the error messages.
+         *
+         * ```ts
+         * CombinedProtocolErrors.formatMessage = (errors, { defaultFormatMessage }) => {
+         *   return `[Protocol errors]: ${defaultFormatMessage(errors)}`;
+         * };
+         * ```
+         */
+        defaultFormatMessage: (errors: ReadonlyArray<GraphQLFormattedError>) => string;
+    }
+    /**
+     * By default, `CombinedProtocolErrors` formats the `message` property by
+     * joining each error's `message` field with a newline. To customize the
+     * format of the `message`, such as changing the delimiter or adding a message
+     * prefix, override the static `formatMessage` method.
+     *
+     * @remarks
+     *
+     * See the [`formatMessage`](https://www.apollographql.com/docs/react/api/errors/CombinedProtocolErrors) section for details about the parameters provided to the `formatMessage` function.
+     *
+     * > [!NOTE]
+     * > The message formatter needs to be configured before any operation is executed by Apollo Client, otherwise the default message formatter is used. We recommend configuring the message formatter before initializing your `ApolloClient` instance.
+     *
+     * @example
+     *
+     * The following example demonstrates how to format the error message by
+     * joining each error with a comma.
+     *
+     * ```ts
+     * import { CombinedProtocolErrors } from "@apollo/client/errors";
+     *
+     * CombinedProtocolErrors.formatMessage = (errors) => {
+     *   return errors.map((error) => error.message).join(", ");
+     * };
+     * ```
+     *
+     * @param errors - The array of GraphQL errors returned from the server in the
+     * `errors` field of the response.
+     * @param options - Additional context that could be useful when formatting
+     * the message.
+     */
+    type MessageFormatter = (errors: ReadonlyArray<GraphQLFormattedError>, options: MessageFormatterOptions) => string;
+    namespace DocumentationTypes {
+        /**
+         * A function that formats the error message used for the error's `message`
+         * property. Override this method to provide your own formatting.
+         *
+         * @remarks
+         *
+         * The `formatMessage` function is called by the `CombinedProtocolErrors`
+         * constructor to provide a formatted message as the `message` property of the
+         * `CombinedProtocolErrors` object. Follow the ["Providing a custom message
+         * formatter"](https://www.apollographql.com/docs/react/api/errors/CombinedProtocolErrors#providing-a-custom-message-formatter) guide to learn how to modify the message format.
+         *
+         * @param errors - The array of GraphQL errors returned from the server in the
+         * `errors` field of the response.
+         * @param options - Additional context that could be useful when formatting
+         * the message.
+         */
+        function formatMessage(errors: ReadonlyArray<GraphQLFormattedError>, options: MessageFormatterOptions): string;
+        interface InstanceProperties {
+            /**
+             * The raw list of errors returned by the top-level `errors` field in the
+             * multipart HTTP subscription response.
+             */
+            readonly errors: ReadonlyArray<GraphQLFormattedError>;
+        }
+    }
+}
+/**
+ * Fatal transport-level errors returned when executing a subscription using the
+ * multipart HTTP subscription protocol. See the documentation on the
+ * [multipart HTTP protocol for GraphQL Subscriptions](https://www.apollographql.com/docs/graphos/routing/operations/subscriptions/multipart-protocol) for more information on these errors.
+ *
+ * @remarks
+ *
+ * These errors indicate issues with the subscription transport itself, rather
+ * than GraphQL-level errors. They typically occur when there are problems
+ * communicating with subgraphs from the Apollo Router.
+ *
+ * @example
+ *
+ * ```ts
+ * import { CombinedProtocolErrors } from "@apollo/client/errors";
+ *
+ * // Check if an error is a CombinedProtocolErrors instance
+ * if (CombinedProtocolErrors.is(error)) {
+ *   // Access individual protocol errors
+ *   error.errors.forEach((protocolError) => {
+ *     console.log(protocolError.message);
+ *     console.log(protocolError.extensions);
+ *   });
+ * }
+ * ```
+ */
+export declare class CombinedProtocolErrors extends Error {
+    /**
+     * A method that determines whether an error is a `CombinedProtocolErrors`
+     * object. This method enables TypeScript to narrow the error type.
+     *
+     * @example
+     *
+     * ```ts
+     * if (CombinedProtocolErrors.is(error)) {
+     *   // TypeScript now knows `error` is a CombinedProtocolErrors object
+     *   console.log(error.errors);
+     * }
+     * ```
+     */
+    static is(error: unknown): error is CombinedProtocolErrors;
+    /**
+    * A function that formats the error message used for the error's `message`
+    * property. Override this method to provide your own formatting.
+    * 
+    * @remarks
+    * 
+    * The `formatMessage` function is called by the `CombinedProtocolErrors`
+    * constructor to provide a formatted message as the `message` property of the
+    * `CombinedProtocolErrors` object. Follow the ["Providing a custom message
+    * formatter"](https://www.apollographql.com/docs/react/api/errors/CombinedProtocolErrors#providing-a-custom-message-formatter) guide to learn how to modify the message format.
+    * 
+    * @param errors - The array of GraphQL errors returned from the server in the
+    * `errors` field of the response.
+    * @param options - Additional context that could be useful when formatting
+    * the message.
+    */
+    static formatMessage: CombinedProtocolErrors.MessageFormatter;
+    /**
+    * The raw list of errors returned by the top-level `errors` field in the
+    * multipart HTTP subscription response.
+    */
+    readonly errors: ReadonlyArray<GraphQLFormattedError>;
+    constructor(protocolErrors: Array<GraphQLFormattedError> | ReadonlyArray<GraphQLFormattedError>);
+}
+//# sourceMappingURL=CombinedProtocolErrors.d.ts.map