@graphql-tools/utils 10.0.11 → 10.0.12

package/cjs/descriptionFromObject.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDescriptionNode = void 0;
+const graphql_1 = require("graphql");
+function getDescriptionNode(obj) {
+    if (obj.astNode?.description) {
+        return {
+            ...obj.astNode.description,
+            block: true,
+        };
+    }
+    if (obj.description) {
+        return {
+            kind: graphql_1.Kind.STRING,
+            value: obj.description,
+            block: true,
+        };
+    }
+}
+exports.getDescriptionNode = getDescriptionNode;

package/cjs/print-schema-with-directives.js

@@ -5,6 +5,7 @@ const graphql_1 = require("graphql");
 const astFromType_js_1 = require("./astFromType.js");
 const astFromValue_js_1 = require("./astFromValue.js");
 const astFromValueUntyped_js_1 = require("./astFromValueUntyped.js");
+const descriptionFromObject_js_1 = require("./descriptionFromObject.js");
 const get_directives_js_1 = require("./get-directives.js");
 const helpers_js_1 = require("./helpers.js");
 const rootTypes_js_1 = require("./rootTypes.js");
@@ -112,30 +113,17 @@ function astFromSchema(schema, pathToDirectivesInExtensions) {
         // ConstXNode has been introduced in v16 but it is not compatible with XNode so we do `as any` for backwards compatibility
         directives: directives,
     };
-    // This code is so weird because it needs to support GraphQL.js 14
-    // In GraphQL.js 14 there is no `description` value on schemaNode
-    schemaNode.description =
-        (schema.astNode?.description ??
-            schema.description != null)
-            ? {
-                kind: graphql_1.Kind.STRING,
-                value: schema.description,
-                block: true,
-            }
-            : undefined;
+    const descriptionNode = (0, descriptionFromObject_js_1.getDescriptionNode)(schema);
+    if (descriptionNode) {
+        schemaNode.description = descriptionNode;
+    }
     return schemaNode;
 }
 exports.astFromSchema = astFromSchema;
 function astFromDirective(directive, schema, pathToDirectivesInExtensions) {
     return {
         kind: graphql_1.Kind.DIRECTIVE_DEFINITION,
-        description: directive.astNode?.description ??
-            (directive.description
-                ? {
-                    kind: graphql_1.Kind.STRING,
-                    value: directive.description,
-                }
-                : undefined),
+        description: (0, descriptionFromObject_js_1.getDescriptionNode)(directive),
         name: {
             kind: graphql_1.Kind.NAME,
             value: directive.name,
@@ -202,14 +190,7 @@ exports.getDeprecatableDirectiveNodes = getDeprecatableDirectiveNodes;
 function astFromArg(arg, schema, pathToDirectivesInExtensions) {
     return {
         kind: graphql_1.Kind.INPUT_VALUE_DEFINITION,
-        description: arg.astNode?.description ??
-            (arg.description
-                ? {
-                    kind: graphql_1.Kind.STRING,
-                    value: arg.description,
-                    block: true,
-                }
-                : undefined),
+        description: (0, descriptionFromObject_js_1.getDescriptionNode)(arg),
         name: {
             kind: graphql_1.Kind.NAME,
             value: arg.name,
@@ -226,14 +207,7 @@ exports.astFromArg = astFromArg;
 function astFromObjectType(type, schema, pathToDirectivesInExtensions) {
     return {
         kind: graphql_1.Kind.OBJECT_TYPE_DEFINITION,
-        description: type.astNode?.description ??
-            (type.description
-                ? {
-                    kind: graphql_1.Kind.STRING,
-                    value: type.description,
-                    block: true,
-                }
-                : undefined),
+        description: (0, descriptionFromObject_js_1.getDescriptionNode)(type),
         name: {
             kind: graphql_1.Kind.NAME,
             value: type.name,
@@ -247,14 +221,7 @@ exports.astFromObjectType = astFromObjectType;
 function astFromInterfaceType(type, schema, pathToDirectivesInExtensions) {
     const node = {
         kind: graphql_1.Kind.INTERFACE_TYPE_DEFINITION,
-        description: type.astNode?.description ??
-            (type.description
-                ? {
-                    kind: graphql_1.Kind.STRING,
-                    value: type.description,
-                    block: true,
-                }
-                : undefined),
+        description: (0, descriptionFromObject_js_1.getDescriptionNode)(type),
         name: {
             kind: graphql_1.Kind.NAME,
             value: type.name,
@@ -271,14 +238,7 @@ exports.astFromInterfaceType = astFromInterfaceType;
 function astFromUnionType(type, schema, pathToDirectivesInExtensions) {
     return {
         kind: graphql_1.Kind.UNION_TYPE_DEFINITION,
-        description: type.astNode?.description ??
-            (type.description
-                ? {
-                    kind: graphql_1.Kind.STRING,
-                    value: type.description,
-                    block: true,
-                }
-                : undefined),
+        description: (0, descriptionFromObject_js_1.getDescriptionNode)(type),
         name: {
             kind: graphql_1.Kind.NAME,
             value: type.name,
@@ -292,14 +252,7 @@ exports.astFromUnionType = astFromUnionType;
 function astFromInputObjectType(type, schema, pathToDirectivesInExtensions) {
     return {
         kind: graphql_1.Kind.INPUT_OBJECT_TYPE_DEFINITION,
-        description: type.astNode?.description ??
-            (type.description
-                ? {
-                    kind: graphql_1.Kind.STRING,
-                    value: type.description,
-                    block: true,
-                }
-                : undefined),
+        description: (0, descriptionFromObject_js_1.getDescriptionNode)(type),
         name: {
             kind: graphql_1.Kind.NAME,
             value: type.name,
@@ -313,14 +266,7 @@ exports.astFromInputObjectType = astFromInputObjectType;
 function astFromEnumType(type, schema, pathToDirectivesInExtensions) {
     return {
         kind: graphql_1.Kind.ENUM_TYPE_DEFINITION,
-        description: type.astNode?.description ??
-            (type.description
-                ? {
-                    kind: graphql_1.Kind.STRING,
-                    value: type.description,
-                    block: true,
-                }
-                : undefined),
+        description: (0, descriptionFromObject_js_1.getDescriptionNode)(type),
         name: {
             kind: graphql_1.Kind.NAME,
             value: type.name,
@@ -347,14 +293,7 @@ function astFromScalarType(type, schema, pathToDirectivesInExtensions) {
     }
     return {
         kind: graphql_1.Kind.SCALAR_TYPE_DEFINITION,
-        description: type.astNode?.description ??
-            (type.description
-                ? {
-                    kind: graphql_1.Kind.STRING,
-                    value: type.description,
-                    block: true,
-                }
-                : undefined),
+        description: (0, descriptionFromObject_js_1.getDescriptionNode)(type),
         name: {
             kind: graphql_1.Kind.NAME,
             value: type.name,
@@ -367,14 +306,7 @@ exports.astFromScalarType = astFromScalarType;
 function astFromField(field, schema, pathToDirectivesInExtensions) {
     return {
         kind: graphql_1.Kind.FIELD_DEFINITION,
-        description: field.astNode?.description ??
-            (field.description
-                ? {
-                    kind: graphql_1.Kind.STRING,
-                    value: field.description,
-                    block: true,
-                }
-                : undefined),
+        description: (0, descriptionFromObject_js_1.getDescriptionNode)(field),
         name: {
             kind: graphql_1.Kind.NAME,
             value: field.name,
@@ -389,14 +321,7 @@ exports.astFromField = astFromField;
 function astFromInputField(field, schema, pathToDirectivesInExtensions) {
     return {
         kind: graphql_1.Kind.INPUT_VALUE_DEFINITION,
-        description: field.astNode?.description ??
-            (field.description
-                ? {
-                    kind: graphql_1.Kind.STRING,
-                    value: field.description,
-                    block: true,
-                }
-                : undefined),
+        description: (0, descriptionFromObject_js_1.getDescriptionNode)(field),
         name: {
             kind: graphql_1.Kind.NAME,
             value: field.name,
@@ -411,14 +336,7 @@ exports.astFromInputField = astFromInputField;
 function astFromEnumValue(value, schema, pathToDirectivesInExtensions) {
     return {
         kind: graphql_1.Kind.ENUM_VALUE_DEFINITION,
-        description: value.astNode?.description ??
-            (value.description
-                ? {
-                    kind: graphql_1.Kind.STRING,
-                    value: value.description,
-                    block: true,
-                }
-                : undefined),
+        description: (0, descriptionFromObject_js_1.getDescriptionNode)(value),
         name: {
             kind: graphql_1.Kind.NAME,
             value: value.name,

package/esm/descriptionFromObject.js

@@ -0,0 +1,16 @@
+import { Kind } from 'graphql';
+export function getDescriptionNode(obj) {
+    if (obj.astNode?.description) {
+        return {
+            ...obj.astNode.description,
+            block: true,
+        };
+    }
+    if (obj.description) {
+        return {
+            kind: Kind.STRING,
+            value: obj.description,
+            block: true,
+        };
+    }
+}

package/esm/print-schema-with-directives.js

@@ -2,6 +2,7 @@ import { GraphQLDeprecatedDirective, isEnumType, isInputObjectType, isInterfaceT
 import { astFromType } from './astFromType.js';
 import { astFromValue } from './astFromValue.js';
 import { astFromValueUntyped } from './astFromValueUntyped.js';
+import { getDescriptionNode } from './descriptionFromObject.js';
 import { getDirectivesInExtensions } from './get-directives.js';
 import { isSome } from './helpers.js';
 import { getRootTypeMap } from './rootTypes.js';
@@ -107,29 +108,16 @@ export function astFromSchema(schema, pathToDirectivesInExtensions) {
         // ConstXNode has been introduced in v16 but it is not compatible with XNode so we do `as any` for backwards compatibility
         directives: directives,
     };
-    // This code is so weird because it needs to support GraphQL.js 14
-    // In GraphQL.js 14 there is no `description` value on schemaNode
-    schemaNode.description =
-        (schema.astNode?.description ??
-            schema.description != null)
-            ? {
-                kind: Kind.STRING,
-                value: schema.description,
-                block: true,
-            }
-            : undefined;
+    const descriptionNode = getDescriptionNode(schema);
+    if (descriptionNode) {
+        schemaNode.description = descriptionNode;
+    }
     return schemaNode;
 }
 export function astFromDirective(directive, schema, pathToDirectivesInExtensions) {
     return {
         kind: Kind.DIRECTIVE_DEFINITION,
-        description: directive.astNode?.description ??
-            (directive.description
-                ? {
-                    kind: Kind.STRING,
-                    value: directive.description,
-                }
-                : undefined),
+        description: getDescriptionNode(directive),
         name: {
             kind: Kind.NAME,
             value: directive.name,
@@ -193,14 +181,7 @@ export function getDeprecatableDirectiveNodes(entity, schema, pathToDirectivesIn
 export function astFromArg(arg, schema, pathToDirectivesInExtensions) {
     return {
         kind: Kind.INPUT_VALUE_DEFINITION,
-        description: arg.astNode?.description ??
-            (arg.description
-                ? {
-                    kind: Kind.STRING,
-                    value: arg.description,
-                    block: true,
-                }
-                : undefined),
+        description: getDescriptionNode(arg),
         name: {
             kind: Kind.NAME,
             value: arg.name,
@@ -216,14 +197,7 @@ export function astFromArg(arg, schema, pathToDirectivesInExtensions) {
 export function astFromObjectType(type, schema, pathToDirectivesInExtensions) {
     return {
         kind: Kind.OBJECT_TYPE_DEFINITION,
-        description: type.astNode?.description ??
-            (type.description
-                ? {
-                    kind: Kind.STRING,
-                    value: type.description,
-                    block: true,
-                }
-                : undefined),
+        description: getDescriptionNode(type),
         name: {
             kind: Kind.NAME,
             value: type.name,
@@ -236,14 +210,7 @@ export function astFromObjectType(type, schema, pathToDirectivesInExtensions) {
 export function astFromInterfaceType(type, schema, pathToDirectivesInExtensions) {
     const node = {
         kind: Kind.INTERFACE_TYPE_DEFINITION,
-        description: type.astNode?.description ??
-            (type.description
-                ? {
-                    kind: Kind.STRING,
-                    value: type.description,
-                    block: true,
-                }
-                : undefined),
+        description: getDescriptionNode(type),
         name: {
             kind: Kind.NAME,
             value: type.name,
@@ -259,14 +226,7 @@ export function astFromInterfaceType(type, schema, pathToDirectivesInExtensions)
 export function astFromUnionType(type, schema, pathToDirectivesInExtensions) {
     return {
         kind: Kind.UNION_TYPE_DEFINITION,
-        description: type.astNode?.description ??
-            (type.description
-                ? {
-                    kind: Kind.STRING,
-                    value: type.description,
-                    block: true,
-                }
-                : undefined),
+        description: getDescriptionNode(type),
         name: {
             kind: Kind.NAME,
             value: type.name,
@@ -279,14 +239,7 @@ export function astFromUnionType(type, schema, pathToDirectivesInExtensions) {
 export function astFromInputObjectType(type, schema, pathToDirectivesInExtensions) {
     return {
         kind: Kind.INPUT_OBJECT_TYPE_DEFINITION,
-        description: type.astNode?.description ??
-            (type.description
-                ? {
-                    kind: Kind.STRING,
-                    value: type.description,
-                    block: true,
-                }
-                : undefined),
+        description: getDescriptionNode(type),
         name: {
             kind: Kind.NAME,
             value: type.name,
@@ -299,14 +252,7 @@ export function astFromInputObjectType(type, schema, pathToDirectivesInExtension
 export function astFromEnumType(type, schema, pathToDirectivesInExtensions) {
     return {
         kind: Kind.ENUM_TYPE_DEFINITION,
-        description: type.astNode?.description ??
-            (type.description
-                ? {
-                    kind: Kind.STRING,
-                    value: type.description,
-                    block: true,
-                }
-                : undefined),
+        description: getDescriptionNode(type),
         name: {
             kind: Kind.NAME,
             value: type.name,
@@ -332,14 +278,7 @@ export function astFromScalarType(type, schema, pathToDirectivesInExtensions) {
     }
     return {
         kind: Kind.SCALAR_TYPE_DEFINITION,
-        description: type.astNode?.description ??
-            (type.description
-                ? {
-                    kind: Kind.STRING,
-                    value: type.description,
-                    block: true,
-                }
-                : undefined),
+        description: getDescriptionNode(type),
         name: {
             kind: Kind.NAME,
             value: type.name,
@@ -351,14 +290,7 @@ export function astFromScalarType(type, schema, pathToDirectivesInExtensions) {
 export function astFromField(field, schema, pathToDirectivesInExtensions) {
     return {
         kind: Kind.FIELD_DEFINITION,
-        description: field.astNode?.description ??
-            (field.description
-                ? {
-                    kind: Kind.STRING,
-                    value: field.description,
-                    block: true,
-                }
-                : undefined),
+        description: getDescriptionNode(field),
         name: {
             kind: Kind.NAME,
             value: field.name,
@@ -372,14 +304,7 @@ export function astFromField(field, schema, pathToDirectivesInExtensions) {
 export function astFromInputField(field, schema, pathToDirectivesInExtensions) {
     return {
         kind: Kind.INPUT_VALUE_DEFINITION,
-        description: field.astNode?.description ??
-            (field.description
-                ? {
-                    kind: Kind.STRING,
-                    value: field.description,
-                    block: true,
-                }
-                : undefined),
+        description: getDescriptionNode(field),
         name: {
             kind: Kind.NAME,
             value: field.name,
@@ -393,14 +318,7 @@ export function astFromInputField(field, schema, pathToDirectivesInExtensions) {
 export function astFromEnumValue(value, schema, pathToDirectivesInExtensions) {
     return {
         kind: Kind.ENUM_VALUE_DEFINITION,
-        description: value.astNode?.description ??
-            (value.description
-                ? {
-                    kind: Kind.STRING,
-                    value: value.description,
-                    block: true,
-                }
-                : undefined),
+        description: getDescriptionNode(value),
         name: {
             kind: Kind.NAME,
             value: value.name,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-tools/utils",
-  "version": "10.0.11",
+  "version": "10.0.12",
   "description": "Common package containing utils and types for GraphQL tools",
   "sideEffects": false,
   "peerDependencies": {

package/typings/descriptionFromObject.d.cts

@@ -0,0 +1,9 @@
+import { type StringValueNode } from 'graphql';
+interface ObjectWithDescription {
+    astNode?: {
+        description?: StringValueNode | null;
+    } | null;
+    description?: string | null;
+}
+export declare function getDescriptionNode(obj: ObjectWithDescription): StringValueNode | undefined;
+export {};

package/typings/descriptionFromObject.d.ts

@@ -0,0 +1,9 @@
+import { type StringValueNode } from 'graphql';
+interface ObjectWithDescription {
+    astNode?: {
+        description?: StringValueNode | null;
+    } | null;
+    description?: string | null;
+}
+export declare function getDescriptionNode(obj: ObjectWithDescription): StringValueNode | undefined;
+export {};