@graphql-tools/utils 10.10.0-alpha-20251027010606-226b580f6448e27f51c6c50b3035c631e1902460 → 10.10.0-alpha-20251027100557-9a80d88e5b0ded866058fced28dcd30be6728693

package/cjs/errors.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ERROR_EXTENSION_SCHEMA_COORDINATE = void 0;
 exports.createGraphQLError = createGraphQLError;
+exports.locatedError = locatedError;
 exports.relocatedError = relocatedError;
 const graphql_1 = require("graphql");
 const possibleGraphQLErrorProperties = [
@@ -31,13 +33,34 @@ function createGraphQLError(message, options) {
     }
     return new graphql_1.GraphQLError(message, options?.nodes, options?.source, options?.positions, options?.path, options?.originalError, options?.extensions);
 }
-function relocatedError(originalError, path) {
-    return createGraphQLError(originalError.message, {
+exports.ERROR_EXTENSION_SCHEMA_COORDINATE = Symbol.for('graphql.error.schemaCoordinate');
+function addSchemaCoordinateToError(error, info) {
+    // @ts-expect-error extensions can't be Symbol in official GraphQL Error type
+    error.extensions[exports.ERROR_EXTENSION_SCHEMA_COORDINATE] = `${info.parentType.name}.${info.fieldName}`;
+}
+function locatedError(rawError, nodes, path, info) {
+    const error = (0, graphql_1.locatedError)(rawError, nodes, path);
+    if (info) {
+        addSchemaCoordinateToError(error, info);
+    }
+    return error;
+}
+function relocatedError(originalError, path, info) {
+    const error = createGraphQLError(originalError.message, {
         nodes: originalError.nodes,
         source: originalError.source,
         positions: originalError.positions,
         path: path == null ? originalError.path : path,
         originalError,
-        extensions: originalError.extensions,
+        extensions: info
+            ? {
+                ...originalError.extensions,
+                schemaCoordinates: `${info.parentType.name}.${info.fieldName}`,
+            }
+            : originalError.extensions,
     });
+    if (info) {
+        addSchemaCoordinateToError(error, info);
+    }
+    return error;
 }

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',
@@ -27,13 +27,34 @@ export function createGraphQLError(message, options) {
     }
     return new GraphQLError(message, options?.nodes, options?.source, options?.positions, options?.path, options?.originalError, options?.extensions);
 }
-export function relocatedError(originalError, path) {
-    return createGraphQLError(originalError.message, {
+export const ERROR_EXTENSION_SCHEMA_COORDINATE = Symbol.for('graphql.error.schemaCoordinate');
+function addSchemaCoordinateToError(error, info) {
+    // @ts-expect-error extensions can't be Symbol in official GraphQL Error type
+    error.extensions[ERROR_EXTENSION_SCHEMA_COORDINATE] = `${info.parentType.name}.${info.fieldName}`;
+}
+export function locatedError(rawError, nodes, path, info) {
+    const error = _locatedError(rawError, nodes, path);
+    if (info) {
+        addSchemaCoordinateToError(error, info);
+    }
+    return error;
+}
+export function relocatedError(originalError, path, info) {
+    const error = createGraphQLError(originalError.message, {
         nodes: originalError.nodes,
         source: originalError.source,
         positions: originalError.positions,
         path: path == null ? originalError.path : path,
         originalError,
-        extensions: originalError.extensions,
+        extensions: info
+            ? {
+                ...originalError.extensions,
+                schemaCoordinates: `${info.parentType.name}.${info.fieldName}`,
+            }
+            : originalError.extensions,
     });
+    if (info) {
+        addSchemaCoordinateToError(error, info);
+    }
+    return error;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-tools/utils",
-  "version": "10.10.0-alpha-20251027010606-226b580f6448e27f51c6c50b3035c631e1902460",
+  "version": "10.10.0-alpha-20251027100557-9a80d88e5b0ded866058fced28dcd30be6728693",
   "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

@@ -11,5 +11,13 @@ interface GraphQLErrorOptions {
     extensions?: any;
 }
 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 const ERROR_EXTENSION_SCHEMA_COORDINATE: unique symbol;
+export declare function locatedError(rawError: unknown, nodes: ASTNode | ReadonlyArray<ASTNode> | null | 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

@@ -11,5 +11,13 @@ interface GraphQLErrorOptions {
     extensions?: any;
 }
 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 const ERROR_EXTENSION_SCHEMA_COORDINATE: unique symbol;
+export declare function locatedError(rawError: unknown, nodes: ASTNode | ReadonlyArray<ASTNode> | null | 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 {};