@graphql-tools/utils 10.0.0 → 10.0.1

package/cjs/Interfaces.js

@@ -28,4 +28,4 @@ var MapperKind;
     MapperKind["INPUT_OBJECT_FIELD"] = "MapperKind.INPUT_OBJECT_FIELD";
     MapperKind["ARGUMENT"] = "MapperKind.ARGUMENT";
     MapperKind["ENUM_VALUE"] = "MapperKind.ENUM_VALUE";
-})(MapperKind = exports.MapperKind || (exports.MapperKind = {}));
+})(MapperKind || (exports.MapperKind = MapperKind = {}));

package/cjs/astFromValue.js

@@ -0,0 +1,107 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.astFromValue = void 0;
+const graphql_1 = require("graphql");
+const jsutils_js_1 = require("./jsutils.js");
+const inspect_js_1 = require("./inspect.js");
+const astFromValueUntyped_js_1 = require("./astFromValueUntyped.js");
+/**
+ * Produces a GraphQL Value AST given a JavaScript object.
+ * Function will match JavaScript/JSON values to GraphQL AST schema format
+ * by using suggested GraphQLInputType. For example:
+ *
+ *     astFromValue("value", GraphQLString)
+ *
+ * A GraphQL type must be provided, which will be used to interpret different
+ * JavaScript values.
+ *
+ * | JSON Value    | GraphQL Value        |
+ * | ------------- | -------------------- |
+ * | Object        | Input Object         |
+ * | Array         | List                 |
+ * | Boolean       | Boolean              |
+ * | String        | String / Enum Value  |
+ * | Number        | Int / Float          |
+ * | BigInt        | Int                  |
+ * | Unknown       | Enum Value           |
+ * | null          | NullValue            |
+ *
+ */
+function astFromValue(value, type) {
+    if ((0, graphql_1.isNonNullType)(type)) {
+        const astValue = astFromValue(value, type.ofType);
+        if (astValue?.kind === graphql_1.Kind.NULL) {
+            return null;
+        }
+        return astValue;
+    }
+    // only explicit null, not undefined, NaN
+    if (value === null) {
+        return { kind: graphql_1.Kind.NULL };
+    }
+    // undefined
+    if (value === undefined) {
+        return null;
+    }
+    // Convert JavaScript array to GraphQL list. If the GraphQLType is a list, but
+    // the value is not an array, convert the value using the list's item type.
+    if ((0, graphql_1.isListType)(type)) {
+        const itemType = type.ofType;
+        if ((0, jsutils_js_1.isIterableObject)(value)) {
+            const valuesNodes = [];
+            for (const item of value) {
+                const itemNode = astFromValue(item, itemType);
+                if (itemNode != null) {
+                    valuesNodes.push(itemNode);
+                }
+            }
+            return { kind: graphql_1.Kind.LIST, values: valuesNodes };
+        }
+        return astFromValue(value, itemType);
+    }
+    // Populate the fields of the input object by creating ASTs from each value
+    // in the JavaScript object according to the fields in the input type.
+    if ((0, graphql_1.isInputObjectType)(type)) {
+        if (!(0, jsutils_js_1.isObjectLike)(value)) {
+            return null;
+        }
+        const fieldNodes = [];
+        for (const field of Object.values(type.getFields())) {
+            const fieldValue = astFromValue(value[field.name], field.type);
+            if (fieldValue) {
+                fieldNodes.push({
+                    kind: graphql_1.Kind.OBJECT_FIELD,
+                    name: { kind: graphql_1.Kind.NAME, value: field.name },
+                    value: fieldValue,
+                });
+            }
+        }
+        return { kind: graphql_1.Kind.OBJECT, fields: fieldNodes };
+    }
+    if ((0, graphql_1.isLeafType)(type)) {
+        // Since value is an internally represented value, it must be serialized
+        // to an externally represented value before converting into an AST.
+        const serialized = type.serialize(value);
+        if (serialized == null) {
+            return null;
+        }
+        if ((0, graphql_1.isEnumType)(type)) {
+            return { kind: graphql_1.Kind.ENUM, value: serialized };
+        }
+        // ID types can use Int literals.
+        if (type.name === 'ID' && typeof serialized === 'string' && integerStringRegExp.test(serialized)) {
+            return { kind: graphql_1.Kind.INT, value: serialized };
+        }
+        return (0, astFromValueUntyped_js_1.astFromValueUntyped)(serialized);
+    }
+    /* c8 ignore next 3 */
+    // Not reachable, all possible types have been considered.
+    console.assert(false, 'Unexpected input type: ' + (0, inspect_js_1.inspect)(type));
+}
+exports.astFromValue = astFromValue;
+/**
+ * IntValue:
+ *   - NegativeSign? 0
+ *   - NegativeSign? NonZeroDigit ( Digit+ )?
+ */
+const integerStringRegExp = /^-?(?:0|[1-9][0-9]*)$/;

package/cjs/astFromValueUntyped.js

@@ -14,6 +14,7 @@ const graphql_1 = require("graphql");
  * | Boolean       | Boolean              |
  * | String        | String               |
  * | Number        | Int / Float          |
+ * | BigInt        | Int                  |
  * | null          | NullValue            |
  *
  */
@@ -57,6 +58,9 @@ function astFromValueUntyped(value) {
     if (typeof value === 'boolean') {
         return { kind: graphql_1.Kind.BOOLEAN, value };
     }
+    if (typeof value === 'bigint') {
+        return { kind: graphql_1.Kind.INT, value: String(value) };
+    }
     // JavaScript numbers can be Int or Float values.
     if (typeof value === 'number' && isFinite(value)) {
         const stringNum = String(value);

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

@@ -7,6 +7,7 @@ const get_directives_js_1 = require("./get-directives.js");
 const astFromValueUntyped_js_1 = require("./astFromValueUntyped.js");
 const helpers_js_1 = require("./helpers.js");
 const rootTypes_js_1 = require("./rootTypes.js");
+const astFromValue_js_1 = require("./astFromValue.js");
 function getDocumentNodeFromSchema(schema, options = {}) {
     const pathToDirectivesInExtensions = options.pathToDirectivesInExtensions;
     const typesMap = schema.getTypeMap();
@@ -215,7 +216,7 @@ function astFromArg(arg, schema, pathToDirectivesInExtensions) {
         },
         type: (0, astFromType_js_1.astFromType)(arg.type),
         // ConstXNode has been introduced in v16 but it is not compatible with XNode so we do `as any` for backwards compatibility
-        defaultValue: arg.defaultValue !== undefined ? (0, graphql_1.astFromValue)(arg.defaultValue, arg.type) ?? undefined : undefined,
+        defaultValue: arg.defaultValue !== undefined ? (0, astFromValue_js_1.astFromValue)(arg.defaultValue, arg.type) ?? undefined : undefined,
         directives: getDeprecatableDirectiveNodes(arg, schema, pathToDirectivesInExtensions),
     };
 }
@@ -399,7 +400,7 @@ function astFromInputField(field, schema, pathToDirectivesInExtensions) {
         type: (0, astFromType_js_1.astFromType)(field.type),
         // ConstXNode has been introduced in v16 but it is not compatible with XNode so we do `as any` for backwards compatibility
         directives: getDeprecatableDirectiveNodes(field, schema, pathToDirectivesInExtensions),
-        defaultValue: (0, graphql_1.astFromValue)(field.defaultValue, field.type) ?? undefined,
+        defaultValue: (0, astFromValue_js_1.astFromValue)(field.defaultValue, field.type) ?? undefined,
     };
 }
 exports.astFromInputField = astFromInputField;
@@ -434,7 +435,7 @@ function makeDirectiveNode(name, args, directive) {
             const argName = arg.name;
             const argValue = args[argName];
             if (argValue !== undefined) {
-                const value = (0, graphql_1.astFromValue)(argValue, arg.type);
+                const value = (0, astFromValue_js_1.astFromValue)(argValue, arg.type);
                 if (value) {
                     directiveArguments.push({
                         kind: graphql_1.Kind.ARGUMENT,

package/cjs/types.js

@@ -24,4 +24,4 @@ var DirectiveLocation;
     DirectiveLocation["ENUM_VALUE"] = "ENUM_VALUE";
     DirectiveLocation["INPUT_OBJECT"] = "INPUT_OBJECT";
     DirectiveLocation["INPUT_FIELD_DEFINITION"] = "INPUT_FIELD_DEFINITION";
-})(DirectiveLocation = exports.DirectiveLocation || (exports.DirectiveLocation = {}));
+})(DirectiveLocation || (exports.DirectiveLocation = DirectiveLocation = {}));

package/esm/astFromValue.js

@@ -0,0 +1,103 @@
+import { Kind, isEnumType, isInputObjectType, isLeafType, isListType, isNonNullType, } from 'graphql';
+import { isIterableObject, isObjectLike } from './jsutils.js';
+import { inspect } from './inspect.js';
+import { astFromValueUntyped } from './astFromValueUntyped.js';
+/**
+ * Produces a GraphQL Value AST given a JavaScript object.
+ * Function will match JavaScript/JSON values to GraphQL AST schema format
+ * by using suggested GraphQLInputType. For example:
+ *
+ *     astFromValue("value", GraphQLString)
+ *
+ * A GraphQL type must be provided, which will be used to interpret different
+ * JavaScript values.
+ *
+ * | JSON Value    | GraphQL Value        |
+ * | ------------- | -------------------- |
+ * | Object        | Input Object         |
+ * | Array         | List                 |
+ * | Boolean       | Boolean              |
+ * | String        | String / Enum Value  |
+ * | Number        | Int / Float          |
+ * | BigInt        | Int                  |
+ * | Unknown       | Enum Value           |
+ * | null          | NullValue            |
+ *
+ */
+export function astFromValue(value, type) {
+    if (isNonNullType(type)) {
+        const astValue = astFromValue(value, type.ofType);
+        if (astValue?.kind === Kind.NULL) {
+            return null;
+        }
+        return astValue;
+    }
+    // only explicit null, not undefined, NaN
+    if (value === null) {
+        return { kind: Kind.NULL };
+    }
+    // undefined
+    if (value === undefined) {
+        return null;
+    }
+    // Convert JavaScript array to GraphQL list. If the GraphQLType is a list, but
+    // the value is not an array, convert the value using the list's item type.
+    if (isListType(type)) {
+        const itemType = type.ofType;
+        if (isIterableObject(value)) {
+            const valuesNodes = [];
+            for (const item of value) {
+                const itemNode = astFromValue(item, itemType);
+                if (itemNode != null) {
+                    valuesNodes.push(itemNode);
+                }
+            }
+            return { kind: Kind.LIST, values: valuesNodes };
+        }
+        return astFromValue(value, itemType);
+    }
+    // Populate the fields of the input object by creating ASTs from each value
+    // in the JavaScript object according to the fields in the input type.
+    if (isInputObjectType(type)) {
+        if (!isObjectLike(value)) {
+            return null;
+        }
+        const fieldNodes = [];
+        for (const field of Object.values(type.getFields())) {
+            const fieldValue = astFromValue(value[field.name], field.type);
+            if (fieldValue) {
+                fieldNodes.push({
+                    kind: Kind.OBJECT_FIELD,
+                    name: { kind: Kind.NAME, value: field.name },
+                    value: fieldValue,
+                });
+            }
+        }
+        return { kind: Kind.OBJECT, fields: fieldNodes };
+    }
+    if (isLeafType(type)) {
+        // Since value is an internally represented value, it must be serialized
+        // to an externally represented value before converting into an AST.
+        const serialized = type.serialize(value);
+        if (serialized == null) {
+            return null;
+        }
+        if (isEnumType(type)) {
+            return { kind: Kind.ENUM, value: serialized };
+        }
+        // ID types can use Int literals.
+        if (type.name === 'ID' && typeof serialized === 'string' && integerStringRegExp.test(serialized)) {
+            return { kind: Kind.INT, value: serialized };
+        }
+        return astFromValueUntyped(serialized);
+    }
+    /* c8 ignore next 3 */
+    // Not reachable, all possible types have been considered.
+    console.assert(false, 'Unexpected input type: ' + inspect(type));
+}
+/**
+ * IntValue:
+ *   - NegativeSign? 0
+ *   - NegativeSign? NonZeroDigit ( Digit+ )?
+ */
+const integerStringRegExp = /^-?(?:0|[1-9][0-9]*)$/;

package/esm/astFromValueUntyped.js

@@ -11,6 +11,7 @@ import { Kind } from 'graphql';
  * | Boolean       | Boolean              |
  * | String        | String               |
  * | Number        | Int / Float          |
+ * | BigInt        | Int                  |
  * | null          | NullValue            |
  *
  */
@@ -54,6 +55,9 @@ export function astFromValueUntyped(value) {
     if (typeof value === 'boolean') {
         return { kind: Kind.BOOLEAN, value };
     }
+    if (typeof value === 'bigint') {
+        return { kind: Kind.INT, value: String(value) };
+    }
     // JavaScript numbers can be Int or Float values.
     if (typeof value === 'number' && isFinite(value)) {
         const stringNum = String(value);

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

@@ -1,9 +1,10 @@
-import { print, Kind, isSpecifiedScalarType, isIntrospectionType, isSpecifiedDirective, astFromValue, GraphQLDeprecatedDirective, isObjectType, isInterfaceType, isUnionType, isInputObjectType, isEnumType, isScalarType, } from 'graphql';
+import { print, Kind, isSpecifiedScalarType, isIntrospectionType, isSpecifiedDirective, GraphQLDeprecatedDirective, isObjectType, isInterfaceType, isUnionType, isInputObjectType, isEnumType, isScalarType, } from 'graphql';
 import { astFromType } from './astFromType.js';
 import { getDirectivesInExtensions } from './get-directives.js';
 import { astFromValueUntyped } from './astFromValueUntyped.js';
 import { isSome } from './helpers.js';
 import { getRootTypeMap } from './rootTypes.js';
+import { astFromValue } from './astFromValue.js';
 export function getDocumentNodeFromSchema(schema, options = {}) {
     const pathToDirectivesInExtensions = options.pathToDirectivesInExtensions;
     const typesMap = schema.getTypeMap();

package/package.json

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

package/typings/astFromValue.d.cts

@@ -0,0 +1,25 @@
+import { GraphQLInputType, ValueNode } from 'graphql';
+import { Maybe } from './types.cjs';
+/**
+ * Produces a GraphQL Value AST given a JavaScript object.
+ * Function will match JavaScript/JSON values to GraphQL AST schema format
+ * by using suggested GraphQLInputType. For example:
+ *
+ *     astFromValue("value", GraphQLString)
+ *
+ * A GraphQL type must be provided, which will be used to interpret different
+ * JavaScript values.
+ *
+ * | JSON Value    | GraphQL Value        |
+ * | ------------- | -------------------- |
+ * | Object        | Input Object         |
+ * | Array         | List                 |
+ * | Boolean       | Boolean              |
+ * | String        | String / Enum Value  |
+ * | Number        | Int / Float          |
+ * | BigInt        | Int                  |
+ * | Unknown       | Enum Value           |
+ * | null          | NullValue            |
+ *
+ */
+export declare function astFromValue(value: unknown, type: GraphQLInputType): Maybe<ValueNode>;

package/typings/astFromValue.d.ts

@@ -0,0 +1,25 @@
+import { GraphQLInputType, ValueNode } from 'graphql';
+import { Maybe } from './types.js';
+/**
+ * Produces a GraphQL Value AST given a JavaScript object.
+ * Function will match JavaScript/JSON values to GraphQL AST schema format
+ * by using suggested GraphQLInputType. For example:
+ *
+ *     astFromValue("value", GraphQLString)
+ *
+ * A GraphQL type must be provided, which will be used to interpret different
+ * JavaScript values.
+ *
+ * | JSON Value    | GraphQL Value        |
+ * | ------------- | -------------------- |
+ * | Object        | Input Object         |
+ * | Array         | List                 |
+ * | Boolean       | Boolean              |
+ * | String        | String / Enum Value  |
+ * | Number        | Int / Float          |
+ * | BigInt        | Int                  |
+ * | Unknown       | Enum Value           |
+ * | null          | NullValue            |
+ *
+ */
+export declare function astFromValue(value: unknown, type: GraphQLInputType): Maybe<ValueNode>;

package/typings/astFromValueUntyped.d.cts

@@ -11,6 +11,7 @@ import { ValueNode } from 'graphql';
  * | Boolean       | Boolean              |
  * | String        | String               |
  * | Number        | Int / Float          |
+ * | BigInt        | Int                  |
  * | null          | NullValue            |
  *
  */

package/typings/astFromValueUntyped.d.ts

@@ -11,6 +11,7 @@ import { ValueNode } from 'graphql';
  * | Boolean       | Boolean              |
  * | String        | String               |
  * | Number        | Int / Float          |
+ * | BigInt        | Int                  |
  * | null          | NullValue            |
  *
  */