@graphql-tools/utils 10.10.1 → 10.11.0-alpha-20251110221147-3e773b194d7b3e752eb121d0bec4e49919d9f1f9

package/cjs/errors.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.isGraphQLErrorLike = isGraphQLErrorLike;
 exports.createGraphQLError = createGraphQLError;
+exports.getSchemaCoordinate = getSchemaCoordinate;
+exports.locatedError = locatedError;
 exports.relocatedError = relocatedError;
 const graphql_1 = require("graphql");
 const possibleGraphQLErrorProperties = [
@@ -26,12 +29,35 @@ 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);
+    let error;
+    if (graphql_1.versionInfo.major >= 16) {
+        error = new graphql_1.GraphQLError(message, options);
     }
-    return new graphql_1.GraphQLError(message, options?.nodes, options?.source, options?.positions, options?.path, options?.originalError, options?.extensions);
+    else {
+        error = new graphql_1.GraphQLError(message, options?.nodes, options?.source, options?.positions, options?.path, options?.originalError, options?.extensions);
+    }
+    if (options?.coordinate != null && !error.coordinate) {
+        Object.defineProperty(error, 'coordinate', {
+            value: options.coordinate,
+            enumerable: true,
+            configurable: true,
+        });
+    }
+    return error;
+}
+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 error;
 }
-function relocatedError(originalError, path) {
+function relocatedError(originalError, path, info) {
     return createGraphQLError(originalError.message, {
         nodes: originalError.nodes,
         source: originalError.source,
@@ -39,5 +65,6 @@ function relocatedError(originalError, path) {
         path: path == null ? originalError.path : path,
         originalError,
         extensions: originalError.extensions,
+        coordinate: info ? `${info.parentType.name}.${info.fieldName}` : undefined,
     });
 }

package/esm/errors.js

@@ -1,4 +1,4 @@
-import { GraphQLError, versionInfo } from 'graphql';
+import { locatedError as _locatedError, GraphQLError, versionInfo, } from 'graphql';
 const possibleGraphQLErrorProperties = [
     'message',
     'locations',
@@ -11,7 +11,7 @@ const possibleGraphQLErrorProperties = [
     'stack',
     'extensions',
 ];
-function isGraphQLErrorLike(error) {
+export function isGraphQLErrorLike(error) {
     return (error != null &&
         typeof error === 'object' &&
         Object.keys(error).every(key => possibleGraphQLErrorProperties.includes(key)));
@@ -22,12 +22,35 @@ export function createGraphQLError(message, options) {
         isGraphQLErrorLike(options.originalError)) {
         options.originalError = createGraphQLError(options.originalError.message, options.originalError);
     }
-    if (versionInfo.major >= 17) {
-        return new GraphQLError(message, options);
+    let error;
+    if (versionInfo.major >= 16) {
+        error = new GraphQLError(message, options);
     }
-    return new GraphQLError(message, options?.nodes, options?.source, options?.positions, options?.path, options?.originalError, options?.extensions);
+    else {
+        error = new GraphQLError(message, options?.nodes, options?.source, options?.positions, options?.path, options?.originalError, options?.extensions);
+    }
+    if (options?.coordinate != null && !error.coordinate) {
+        Object.defineProperty(error, 'coordinate', {
+            value: options.coordinate,
+            enumerable: true,
+            configurable: true,
+        });
+    }
+    return error;
+}
+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) {
+export function relocatedError(originalError, path, info) {
     return createGraphQLError(originalError.message, {
         nodes: originalError.nodes,
         source: originalError.source,
@@ -35,5 +58,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-tools/utils",
-  "version": "10.10.1",
+  "version": "10.11.0-alpha-20251110221147-3e773b194d7b3e752eb121d0bec4e49919d9f1f9",
   "description": "Common package containing utils and types for GraphQL tools",
   "sideEffects": false,
   "peerDependencies": {

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

@@ -9,7 +9,25 @@ interface GraphQLErrorOptions {
         readonly extensions?: unknown;
     }>;
     extensions?: any;
+    coordinate?: string;
+}
+export declare function isGraphQLErrorLike(error: any): boolean;
+declare module 'graphql' {
+    interface GraphQLError {
+        /**
+         * An optional schema coordinate (e.g. "MyType.myField") associated with this error.
+         */
+        readonly coordinate?: string;
+    }
 }
 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

@@ -9,7 +9,25 @@ interface GraphQLErrorOptions {
         readonly extensions?: unknown;
     }>;
     extensions?: any;
+    coordinate?: string;
+}
+export declare function isGraphQLErrorLike(error: any): boolean;
+declare module 'graphql' {
+    interface GraphQLError {
+        /**
+         * An optional schema coordinate (e.g. "MyType.myField") associated with this error.
+         */
+        readonly coordinate?: string;
+    }
 }
 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 {};