@graphql-tools/utils 10.10.1 → 10.11.0-alpha-20251110164254-8e0d1d1788c04c5a5183d93cfd465379d26a6765

package/cjs/errors.js

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.GraphQLError = void 0;
+exports.isGraphQLErrorLike = isGraphQLErrorLike;
 exports.createGraphQLError = createGraphQLError;
+exports.getSchemaCoordinate = getSchemaCoordinate;
+exports.locatedError = locatedError;
 exports.relocatedError = relocatedError;
 const graphql_1 = require("graphql");
 const possibleGraphQLErrorProperties = [
@@ -14,7 +18,31 @@ const possibleGraphQLErrorProperties = [
     'name',
     'stack',
     'extensions',
+    'coordinate',
 ];
+function toNormalizedOptions(args) {
+    const firstArg = args[0];
+    if (firstArg == null || 'kind' in firstArg || 'length' in firstArg) {
+        return {
+            nodes: firstArg,
+            source: args[1],
+            positions: args[2],
+            path: args[3],
+            originalError: args[4],
+            extensions: args[5],
+        };
+    }
+    return firstArg;
+}
+class GraphQLError extends graphql_1.GraphQLError {
+    coordinate;
+    constructor(message, ...args) {
+        const options = toNormalizedOptions(args);
+        super(message, ...args);
+        this.coordinate = options.coordinate;
+    }
+}
+exports.GraphQLError = GraphQLError;
 function isGraphQLErrorLike(error) {
     return (error != null &&
         typeof error === 'object' &&
@@ -26,12 +54,24 @@ function createGraphQLError(message, options) {
         isGraphQLErrorLike(options.originalError)) {
         options.originalError = createGraphQLError(options.originalError.message, options.originalError);
     }
-    if (graphql_1.versionInfo.major >= 17) {
-        return new graphql_1.GraphQLError(message, options);
+    if (graphql_1.versionInfo.major >= 16) {
+        return new GraphQLError(message, options);
+    }
+    return new GraphQLError(message, options?.nodes, options?.source, options?.positions, options?.path, options?.originalError, options?.extensions);
+}
+function getSchemaCoordinate(error) {
+    return error.coordinate;
+}
+function locatedError(rawError, nodes, path, info) {
+    const error = (0, graphql_1.locatedError)(rawError, nodes, path);
+    // `graphql` locatedError is only changing path and nodes if it is not already defined
+    if (!error.coordinate && info) {
+        // @ts-expect-error coordinate is readonly, but we don't want to recreate it just to add coordinate
+        error.coordinate = `${info.parentType.name}.${info.fieldName}`;
     }
-    return new graphql_1.GraphQLError(message, options?.nodes, options?.source, options?.positions, options?.path, options?.originalError, options?.extensions);
+    return error;
 }
-function relocatedError(originalError, path) {
+function relocatedError(originalError, path, info) {
     return createGraphQLError(originalError.message, {
         nodes: originalError.nodes,
         source: originalError.source,
@@ -39,5 +79,6 @@ function relocatedError(originalError, path) {
         path: path == null ? originalError.path : path,
         originalError,
         extensions: originalError.extensions,
+        coordinate: info ? `${info.parentType.name}.${info.fieldName}` : undefined,
     });
 }

package/cjs/mergeIncrementalResult.js

@@ -1,25 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.mergeIncrementalResult = mergeIncrementalResult;
-const mergeDeep_js_1 = require("./mergeDeep.js");
+const merge_1 = require("dset/merge");
 function mergeIncrementalResult({ incrementalResult, executionResult, }) {
     const path = ['data', ...(incrementalResult.path ?? [])];
     if (incrementalResult.items) {
         for (const item of incrementalResult.items) {
-            setObjectKeyPath(executionResult, path, item);
+            (0, merge_1.dset)(executionResult, path, item);
             // Increment the last path segment (the array index) to merge the next item at the next index
             path[path.length - 1]++;
         }
     }
     if (incrementalResult.data) {
-        setObjectKeyPath(executionResult, path, incrementalResult.data);
+        (0, merge_1.dset)(executionResult, path, incrementalResult.data);
     }
     if (incrementalResult.errors) {
         executionResult.errors = executionResult.errors || [];
         executionResult.errors.push(...incrementalResult.errors);
     }
     if (incrementalResult.extensions) {
-        setObjectKeyPath(executionResult, ['extensions'], incrementalResult.extensions);
+        (0, merge_1.dset)(executionResult, 'extensions', incrementalResult.extensions);
     }
     if (incrementalResult.incremental) {
         incrementalResult.incremental.forEach(incrementalSubResult => {
@@ -30,24 +30,3 @@ function mergeIncrementalResult({ incrementalResult, executionResult, }) {
         });
     }
 }
-function setObjectKeyPath(obj, keyPath, value) {
-    let current = obj;
-    let i;
-    for (i = 0; i < keyPath.length - 1; i++) {
-        const key = keyPath[i];
-        if (key === '__proto__' || key === 'constructor' || key === 'prototype') {
-            return;
-        }
-        if (current[key] == null) {
-            // Determine if the next key is a number to create an array, otherwise create an object
-            current[key] = typeof keyPath[i + 1] === 'number' ? [] : {};
-        }
-        current = current[key];
-    }
-    const finalKey = keyPath[i];
-    if (finalKey === '__proto__' || finalKey === 'constructor' || finalKey === 'prototype') {
-        return;
-    }
-    const existingValue = current[finalKey];
-    current[finalKey] = existingValue != null ? (0, mergeDeep_js_1.mergeDeep)([existingValue, value]) : value;
-}

package/esm/errors.js

@@ -1,4 +1,4 @@
-import { GraphQLError, versionInfo } from 'graphql';
+import { GraphQLError as _GraphQLError, locatedError as _locatedError, versionInfo, } from 'graphql';
 const possibleGraphQLErrorProperties = [
     'message',
     'locations',
@@ -10,8 +10,31 @@ const possibleGraphQLErrorProperties = [
     'name',
     'stack',
     'extensions',
+    'coordinate',
 ];
-function isGraphQLErrorLike(error) {
+function toNormalizedOptions(args) {
+    const firstArg = args[0];
+    if (firstArg == null || 'kind' in firstArg || 'length' in firstArg) {
+        return {
+            nodes: firstArg,
+            source: args[1],
+            positions: args[2],
+            path: args[3],
+            originalError: args[4],
+            extensions: args[5],
+        };
+    }
+    return firstArg;
+}
+export class GraphQLError extends _GraphQLError {
+    coordinate;
+    constructor(message, ...args) {
+        const options = toNormalizedOptions(args);
+        super(message, ...args);
+        this.coordinate = options.coordinate;
+    }
+}
+export function isGraphQLErrorLike(error) {
     return (error != null &&
         typeof error === 'object' &&
         Object.keys(error).every(key => possibleGraphQLErrorProperties.includes(key)));
@@ -22,12 +45,24 @@ export function createGraphQLError(message, options) {
         isGraphQLErrorLike(options.originalError)) {
         options.originalError = createGraphQLError(options.originalError.message, options.originalError);
     }
-    if (versionInfo.major >= 17) {
+    if (versionInfo.major >= 16) {
         return new GraphQLError(message, options);
     }
     return new GraphQLError(message, options?.nodes, options?.source, options?.positions, options?.path, options?.originalError, options?.extensions);
 }
-export function relocatedError(originalError, path) {
+export function getSchemaCoordinate(error) {
+    return error.coordinate;
+}
+export function locatedError(rawError, nodes, path, info) {
+    const error = _locatedError(rawError, nodes, path);
+    // `graphql` locatedError is only changing path and nodes if it is not already defined
+    if (!error.coordinate && info) {
+        // @ts-expect-error coordinate is readonly, but we don't want to recreate it just to add coordinate
+        error.coordinate = `${info.parentType.name}.${info.fieldName}`;
+    }
+    return error;
+}
+export function relocatedError(originalError, path, info) {
     return createGraphQLError(originalError.message, {
         nodes: originalError.nodes,
         source: originalError.source,
@@ -35,5 +70,6 @@ export function relocatedError(originalError, path) {
         path: path == null ? originalError.path : path,
         originalError,
         extensions: originalError.extensions,
+        coordinate: info ? `${info.parentType.name}.${info.fieldName}` : undefined,
     });
 }

package/esm/mergeIncrementalResult.js

@@ -1,22 +1,22 @@
-import { mergeDeep } from './mergeDeep.js';
+import { dset } from 'dset/merge';
 export function mergeIncrementalResult({ incrementalResult, executionResult, }) {
     const path = ['data', ...(incrementalResult.path ?? [])];
     if (incrementalResult.items) {
         for (const item of incrementalResult.items) {
-            setObjectKeyPath(executionResult, path, item);
+            dset(executionResult, path, item);
             // Increment the last path segment (the array index) to merge the next item at the next index
             path[path.length - 1]++;
         }
     }
     if (incrementalResult.data) {
-        setObjectKeyPath(executionResult, path, incrementalResult.data);
+        dset(executionResult, path, incrementalResult.data);
     }
     if (incrementalResult.errors) {
         executionResult.errors = executionResult.errors || [];
         executionResult.errors.push(...incrementalResult.errors);
     }
     if (incrementalResult.extensions) {
-        setObjectKeyPath(executionResult, ['extensions'], incrementalResult.extensions);
+        dset(executionResult, 'extensions', incrementalResult.extensions);
     }
     if (incrementalResult.incremental) {
         incrementalResult.incremental.forEach(incrementalSubResult => {
@@ -27,24 +27,3 @@ export function mergeIncrementalResult({ incrementalResult, executionResult, })
         });
     }
 }
-function setObjectKeyPath(obj, keyPath, value) {
-    let current = obj;
-    let i;
-    for (i = 0; i < keyPath.length - 1; i++) {
-        const key = keyPath[i];
-        if (key === '__proto__' || key === 'constructor' || key === 'prototype') {
-            return;
-        }
-        if (current[key] == null) {
-            // Determine if the next key is a number to create an array, otherwise create an object
-            current[key] = typeof keyPath[i + 1] === 'number' ? [] : {};
-        }
-        current = current[key];
-    }
-    const finalKey = keyPath[i];
-    if (finalKey === '__proto__' || finalKey === 'constructor' || finalKey === 'prototype') {
-        return;
-    }
-    const existingValue = current[finalKey];
-    current[finalKey] = existingValue != null ? mergeDeep([existingValue, value]) : value;
-}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-tools/utils",
-  "version": "10.10.1",
+  "version": "10.11.0-alpha-20251110164254-8e0d1d1788c04c5a5183d93cfd465379d26a6765",
   "description": "Common package containing utils and types for GraphQL tools",
   "sideEffects": false,
   "peerDependencies": {
@@ -10,6 +10,7 @@
     "@graphql-typed-document-node/core": "^3.1.1",
     "@whatwg-node/promise-helpers": "^1.0.0",
     "cross-inspect": "1.0.1",
+    "dset": "^3.1.4",
     "tslib": "^2.4.0"
   },
   "repository": {

package/typings/Interfaces.d.cts

@@ -32,6 +32,13 @@ export interface ExecutionRequest<TVariables extends Record<string, any> = any,
     subgraphName?: string;
     info?: GraphQLResolveInfo;
     signal?: AbortSignal;
+    /**
+     * Enable/Disable the addition of field schema coordinate in GraphQL Errors extension
+     *
+     * Note: Schema Coordinate are exposed using Symbol.for('schemaCoordinate') so that it's not
+     *       serialized. Exposing schema coordinate can ease the discovery of private schemas.
+     */
+    schemaCoordinateInErrors?: boolean;
 }
 export interface GraphQLParseOptions {
     noLocation?: boolean;

package/typings/Interfaces.d.ts

@@ -32,6 +32,13 @@ export interface ExecutionRequest<TVariables extends Record<string, any> = any,
     subgraphName?: string;
     info?: GraphQLResolveInfo;
     signal?: AbortSignal;
+    /**
+     * Enable/Disable the addition of field schema coordinate in GraphQL Errors extension
+     *
+     * Note: Schema Coordinate are exposed using Symbol.for('schemaCoordinate') so that it's not
+     *       serialized. Exposing schema coordinate can ease the discovery of private schemas.
+     */
+    schemaCoordinateInErrors?: boolean;
 }
 export interface GraphQLParseOptions {
     noLocation?: boolean;

package/typings/errors.d.cts

@@ -1,4 +1,4 @@
-import { ASTNode, GraphQLError, Source } from 'graphql';
+import { GraphQLError as _GraphQLError, ASTNode, GraphQLErrorExtensions, Source } from 'graphql';
 import { Maybe } from './types.cjs';
 interface GraphQLErrorOptions {
     nodes?: ReadonlyArray<ASTNode> | ASTNode | null;
@@ -9,7 +9,27 @@ interface GraphQLErrorOptions {
         readonly extensions?: unknown;
     }>;
     extensions?: any;
+    coordinate?: string;
 }
+export declare class GraphQLError extends _GraphQLError {
+    readonly coordinate?: string;
+    constructor(message: string, options?: Maybe<GraphQLErrorOptions>);
+    /**
+     * @deprecated Please use the `GraphQLErrorOptions` constructor overload instead.
+     */
+    constructor(message: string, nodes?: ReadonlyArray<ASTNode> | ASTNode | null, source?: Maybe<Source>, positions?: Maybe<ReadonlyArray<number>>, path?: Maybe<ReadonlyArray<string | number>>, originalError?: Maybe<Error & {
+        readonly extensions?: unknown;
+    }>, extensions?: Maybe<GraphQLErrorExtensions>);
+}
+export declare function isGraphQLErrorLike(error: any): boolean;
 export declare function createGraphQLError(message: string, options?: GraphQLErrorOptions): GraphQLError;
-export declare function relocatedError(originalError: GraphQLError, path?: ReadonlyArray<string | number>): GraphQLError;
+type SchemaCoordinateInfo = {
+    fieldName: string;
+    parentType: {
+        name: string;
+    };
+};
+export declare function getSchemaCoordinate(error: GraphQLError): string | undefined;
+export declare function locatedError(rawError: unknown, nodes: ASTNode | ReadonlyArray<ASTNode> | undefined, path: Maybe<ReadonlyArray<string | number>>, info: SchemaCoordinateInfo | false | null | undefined): GraphQLError;
+export declare function relocatedError(originalError: GraphQLError, path?: ReadonlyArray<string | number>, info?: SchemaCoordinateInfo | false | null | undefined): GraphQLError;
 export {};

package/typings/errors.d.ts

@@ -1,4 +1,4 @@
-import { ASTNode, GraphQLError, Source } from 'graphql';
+import { GraphQLError as _GraphQLError, ASTNode, GraphQLErrorExtensions, Source } from 'graphql';
 import { Maybe } from './types.js';
 interface GraphQLErrorOptions {
     nodes?: ReadonlyArray<ASTNode> | ASTNode | null;
@@ -9,7 +9,27 @@ interface GraphQLErrorOptions {
         readonly extensions?: unknown;
     }>;
     extensions?: any;
+    coordinate?: string;
 }
+export declare class GraphQLError extends _GraphQLError {
+    readonly coordinate?: string;
+    constructor(message: string, options?: Maybe<GraphQLErrorOptions>);
+    /**
+     * @deprecated Please use the `GraphQLErrorOptions` constructor overload instead.
+     */
+    constructor(message: string, nodes?: ReadonlyArray<ASTNode> | ASTNode | null, source?: Maybe<Source>, positions?: Maybe<ReadonlyArray<number>>, path?: Maybe<ReadonlyArray<string | number>>, originalError?: Maybe<Error & {
+        readonly extensions?: unknown;
+    }>, extensions?: Maybe<GraphQLErrorExtensions>);
+}
+export declare function isGraphQLErrorLike(error: any): boolean;
 export declare function createGraphQLError(message: string, options?: GraphQLErrorOptions): GraphQLError;
-export declare function relocatedError(originalError: GraphQLError, path?: ReadonlyArray<string | number>): GraphQLError;
+type SchemaCoordinateInfo = {
+    fieldName: string;
+    parentType: {
+        name: string;
+    };
+};
+export declare function getSchemaCoordinate(error: GraphQLError): string | undefined;
+export declare function locatedError(rawError: unknown, nodes: ASTNode | ReadonlyArray<ASTNode> | undefined, path: Maybe<ReadonlyArray<string | number>>, info: SchemaCoordinateInfo | false | null | undefined): GraphQLError;
+export declare function relocatedError(originalError: GraphQLError, path?: ReadonlyArray<string | number>, info?: SchemaCoordinateInfo | false | null | undefined): GraphQLError;
 export {};