graphql 16.13.2 → 16.14.1

package/type/introspection.mjs

@@ -1,3 +1,4 @@
+/** @category Introspection */
 import { inspect } from '../jsutils/inspect.mjs';
 import { invariant } from '../jsutils/invariant.mjs';
 import { DirectiveLocation } from '../language/directiveLocation.mjs';
@@ -19,6 +20,8 @@ import {
   isUnionType,
 } from './definition.mjs';
 import { GraphQLBoolean, GraphQLString } from './scalars.mjs';
+
+/** The introspection type describing a GraphQL schema. */
 export const __Schema = new GraphQLObjectType({
   name: '__Schema',
   description:
@@ -58,10 +61,23 @@ export const __Schema = new GraphQLObjectType({
       type: new GraphQLNonNull(
         new GraphQLList(new GraphQLNonNull(__Directive)),
       ),
-      resolve: (schema) => schema.getDirectives(),
+      args: {
+        includeDeprecated: {
+          type: new GraphQLNonNull(GraphQLBoolean),
+          defaultValue: false,
+        },
+      },
+      resolve: (schema, { includeDeprecated }) =>
+        includeDeprecated
+          ? schema.getDirectives()
+          : schema
+              .getDirectives()
+              .filter((directive) => directive.deprecationReason == null),
     },
   }),
 });
+/** The introspection type describing a GraphQL directive. */
+
 export const __Directive = new GraphQLObjectType({
   name: '__Directive',
   description:
@@ -102,8 +118,18 @@ export const __Directive = new GraphQLObjectType({
           : field.args.filter((arg) => arg.deprecationReason == null);
       },
     },
+    isDeprecated: {
+      type: new GraphQLNonNull(GraphQLBoolean),
+      resolve: (directive) => directive.deprecationReason != null,
+    },
+    deprecationReason: {
+      type: GraphQLString,
+      resolve: (directive) => directive.deprecationReason,
+    },
   }),
 });
+/** The introspection enum describing directive locations. */
+
 export const __DirectiveLocation = new GraphQLEnumType({
   name: '__DirectiveLocation',
   description:
@@ -185,8 +211,14 @@ export const __DirectiveLocation = new GraphQLEnumType({
       value: DirectiveLocation.INPUT_FIELD_DEFINITION,
       description: 'Location adjacent to an input object field definition.',
     },
+    DIRECTIVE_DEFINITION: {
+      value: DirectiveLocation.DIRECTIVE_DEFINITION,
+      description: 'Location adjacent to a directive definition.',
+    },
   },
 });
+/** The introspection type describing GraphQL types. */
+
 export const __Type = new GraphQLObjectType({
   name: '__Type',
   description:
@@ -336,6 +368,8 @@ export const __Type = new GraphQLObjectType({
     },
   }),
 });
+/** The introspection type describing object and interface fields. */
+
 export const __Field = new GraphQLObjectType({
   name: '__Field',
   description:
@@ -380,6 +414,8 @@ export const __Field = new GraphQLObjectType({
     },
   }),
 });
+/** The introspection type describing arguments and input fields. */
+
 export const __InputValue = new GraphQLObjectType({
   name: '__InputValue',
   description:
@@ -418,6 +454,8 @@ export const __InputValue = new GraphQLObjectType({
     },
   }),
 });
+/** The introspection type describing enum values. */
+
 export const __EnumValue = new GraphQLObjectType({
   name: '__EnumValue',
   description:
@@ -441,6 +479,11 @@ export const __EnumValue = new GraphQLObjectType({
     },
   }),
 });
+/**
+ * The introspection enum describing the different kinds of GraphQL types.
+ * @category Introspection
+ */
+
 var TypeKind;
 
 (function (TypeKind) {
@@ -455,6 +498,8 @@ var TypeKind;
 })(TypeKind || (TypeKind = {}));
 
 export { TypeKind };
+/** The introspection enum describing GraphQL type kinds. */
+
 export const __TypeKind = new GraphQLEnumType({
   name: '__TypeKind',
   description: 'An enum describing what kind of type a given `__Type` is.',
@@ -514,6 +559,8 @@ export const SchemaMetaFieldDef = {
   extensions: Object.create(null),
   astNode: undefined,
 };
+/** The `__type` meta field definition used by introspection. */
+
 export const TypeMetaFieldDef = {
   name: '__type',
   type: __Type,
@@ -534,6 +581,8 @@ export const TypeMetaFieldDef = {
   extensions: Object.create(null),
   astNode: undefined,
 };
+/** The `__typename` meta field definition used by execution and introspection. */
+
 export const TypeNameMetaFieldDef = {
   name: '__typename',
   type: new GraphQLNonNull(GraphQLString),
@@ -544,6 +593,8 @@ export const TypeNameMetaFieldDef = {
   extensions: Object.create(null),
   astNode: undefined,
 };
+/** All introspection types defined by the GraphQL specification. */
+
 export const introspectionTypes = Object.freeze([
   __Schema,
   __Directive,
@@ -554,6 +605,19 @@ export const introspectionTypes = Object.freeze([
   __EnumValue,
   __TypeKind,
 ]);
+/**
+ * Returns true when the type is one of the built-in introspection types.
+ * @param type - The GraphQL type to inspect.
+ * @returns True when the type is one of the built-in introspection types.
+ * @example
+ * ```ts
+ * import { GraphQLString, isIntrospectionType, __Type } from 'graphql/type';
+ *
+ * isIntrospectionType(__Type); // => true
+ * isIntrospectionType(GraphQLString); // => false
+ * ```
+ */
+
 export function isIntrospectionType(type) {
   return introspectionTypes.some(({ name }) => type.name === name);
 }

package/type/scalars.d.ts

@@ -1,19 +1,46 @@
+/** @category Scalars */
 import type { GraphQLNamedType } from './definition';
 import { GraphQLScalarType } from './definition';
 /**
  * Maximum possible Int value as per GraphQL Spec (32-bit signed integer).
  * n.b. This differs from JavaScript's numbers that are IEEE 754 doubles safe up-to 2^53 - 1
- * */
+ */
 export declare const GRAPHQL_MAX_INT = 2147483647;
 /**
  * Minimum possible Int value as per GraphQL Spec (32-bit signed integer).
  * n.b. This differs from JavaScript's numbers that are IEEE 754 doubles safe starting at -(2^53 - 1)
- * */
+ */
 export declare const GRAPHQL_MIN_INT = -2147483648;
+/** The built-in `Int` scalar type. */
 export declare const GraphQLInt: GraphQLScalarType<number, number>;
+/** The built-in `Float` scalar type. */
 export declare const GraphQLFloat: GraphQLScalarType<number, number>;
+/** The built-in `String` scalar type. */
 export declare const GraphQLString: GraphQLScalarType<string, string>;
+/** The built-in `Boolean` scalar type. */
 export declare const GraphQLBoolean: GraphQLScalarType<boolean, boolean>;
+/** The built-in `ID` scalar type. */
 export declare const GraphQLID: GraphQLScalarType<string, string>;
+/** All built-in scalar types defined by the GraphQL specification. */
 export declare const specifiedScalarTypes: ReadonlyArray<GraphQLScalarType>;
+/**
+ * Returns true when the scalar type is one of the scalars specified by GraphQL.
+ * @param type - The GraphQL type to inspect.
+ * @returns True when the scalar type is one of the scalars specified by GraphQL.
+ * @example
+ * ```ts
+ * import {
+ *   GraphQLScalarType,
+ *   GraphQLString,
+ *   isSpecifiedScalarType,
+ * } from 'graphql/type';
+ *
+ * const DateTime = new GraphQLScalarType({
+ *   name: 'DateTime',
+ * });
+ *
+ * isSpecifiedScalarType(GraphQLString); // => true
+ * isSpecifiedScalarType(DateTime); // => false
+ * ```
+ */
 export declare function isSpecifiedScalarType(type: GraphQLNamedType): boolean;

package/type/scalars.js

@@ -26,18 +26,22 @@ var _printer = require('../language/printer.js');
 
 var _definition = require('./definition.js');
 
+/** @category Scalars */
+
 /**
  * Maximum possible Int value as per GraphQL Spec (32-bit signed integer).
  * n.b. This differs from JavaScript's numbers that are IEEE 754 doubles safe up-to 2^53 - 1
- * */
+ */
 const GRAPHQL_MAX_INT = 2147483647;
 /**
  * Minimum possible Int value as per GraphQL Spec (32-bit signed integer).
  * n.b. This differs from JavaScript's numbers that are IEEE 754 doubles safe starting at -(2^53 - 1)
- * */
+ */
 
 exports.GRAPHQL_MAX_INT = GRAPHQL_MAX_INT;
 const GRAPHQL_MIN_INT = -2147483648;
+/** The built-in `Int` scalar type. */
+
 exports.GRAPHQL_MIN_INT = GRAPHQL_MIN_INT;
 const GraphQLInt = new _definition.GraphQLScalarType({
   name: 'Int',
@@ -119,6 +123,8 @@ const GraphQLInt = new _definition.GraphQLScalarType({
     return num;
   },
 });
+/** The built-in `Float` scalar type. */
+
 exports.GraphQLInt = GraphQLInt;
 const GraphQLFloat = new _definition.GraphQLScalarType({
   name: 'Float',
@@ -177,6 +183,8 @@ const GraphQLFloat = new _definition.GraphQLScalarType({
     return parseFloat(valueNode.value);
   },
 });
+/** The built-in `String` scalar type. */
+
 exports.GraphQLFloat = GraphQLFloat;
 const GraphQLString = new _definition.GraphQLScalarType({
   name: 'String',
@@ -231,6 +239,8 @@ const GraphQLString = new _definition.GraphQLScalarType({
     return valueNode.value;
   },
 });
+/** The built-in `Boolean` scalar type. */
+
 exports.GraphQLString = GraphQLString;
 const GraphQLBoolean = new _definition.GraphQLScalarType({
   name: 'Boolean',
@@ -281,6 +291,8 @@ const GraphQLBoolean = new _definition.GraphQLScalarType({
     return valueNode.value;
   },
 });
+/** The built-in `ID` scalar type. */
+
 exports.GraphQLBoolean = GraphQLBoolean;
 const GraphQLID = new _definition.GraphQLScalarType({
   name: 'ID',
@@ -334,6 +346,8 @@ const GraphQLID = new _definition.GraphQLScalarType({
     return valueNode.value;
   },
 });
+/** All built-in scalar types defined by the GraphQL specification. */
+
 exports.GraphQLID = GraphQLID;
 const specifiedScalarTypes = Object.freeze([
   GraphQLString,
@@ -342,6 +356,27 @@ const specifiedScalarTypes = Object.freeze([
   GraphQLBoolean,
   GraphQLID,
 ]);
+/**
+ * Returns true when the scalar type is one of the scalars specified by GraphQL.
+ * @param type - The GraphQL type to inspect.
+ * @returns True when the scalar type is one of the scalars specified by GraphQL.
+ * @example
+ * ```ts
+ * import {
+ *   GraphQLScalarType,
+ *   GraphQLString,
+ *   isSpecifiedScalarType,
+ * } from 'graphql/type';
+ *
+ * const DateTime = new GraphQLScalarType({
+ *   name: 'DateTime',
+ * });
+ *
+ * isSpecifiedScalarType(GraphQLString); // => true
+ * isSpecifiedScalarType(DateTime); // => false
+ * ```
+ */
+
 exports.specifiedScalarTypes = specifiedScalarTypes;
 
 function isSpecifiedScalarType(type) {

package/type/scalars.mjs

@@ -1,3 +1,4 @@
+/** @category Scalars */
 import { inspect } from '../jsutils/inspect.mjs';
 import { isObjectLike } from '../jsutils/isObjectLike.mjs';
 import { GraphQLError } from '../error/GraphQLError.mjs';
@@ -7,15 +8,17 @@ import { GraphQLScalarType } from './definition.mjs';
 /**
  * Maximum possible Int value as per GraphQL Spec (32-bit signed integer).
  * n.b. This differs from JavaScript's numbers that are IEEE 754 doubles safe up-to 2^53 - 1
- * */
+ */
 
 export const GRAPHQL_MAX_INT = 2147483647;
 /**
  * Minimum possible Int value as per GraphQL Spec (32-bit signed integer).
  * n.b. This differs from JavaScript's numbers that are IEEE 754 doubles safe starting at -(2^53 - 1)
- * */
+ */
 
 export const GRAPHQL_MIN_INT = -2147483648;
+/** The built-in `Int` scalar type. */
+
 export const GraphQLInt = new GraphQLScalarType({
   name: 'Int',
   description:
@@ -90,6 +93,8 @@ export const GraphQLInt = new GraphQLScalarType({
     return num;
   },
 });
+/** The built-in `Float` scalar type. */
+
 export const GraphQLFloat = new GraphQLScalarType({
   name: 'Float',
   description:
@@ -138,6 +143,8 @@ export const GraphQLFloat = new GraphQLScalarType({
     return parseFloat(valueNode.value);
   },
 });
+/** The built-in `String` scalar type. */
+
 export const GraphQLString = new GraphQLScalarType({
   name: 'String',
   description:
@@ -187,6 +194,8 @@ export const GraphQLString = new GraphQLScalarType({
     return valueNode.value;
   },
 });
+/** The built-in `Boolean` scalar type. */
+
 export const GraphQLBoolean = new GraphQLScalarType({
   name: 'Boolean',
   description: 'The `Boolean` scalar type represents `true` or `false`.',
@@ -230,6 +239,8 @@ export const GraphQLBoolean = new GraphQLScalarType({
     return valueNode.value;
   },
 });
+/** The built-in `ID` scalar type. */
+
 export const GraphQLID = new GraphQLScalarType({
   name: 'ID',
   description:
@@ -277,6 +288,8 @@ export const GraphQLID = new GraphQLScalarType({
     return valueNode.value;
   },
 });
+/** All built-in scalar types defined by the GraphQL specification. */
+
 export const specifiedScalarTypes = Object.freeze([
   GraphQLString,
   GraphQLInt,
@@ -284,6 +297,27 @@ export const specifiedScalarTypes = Object.freeze([
   GraphQLBoolean,
   GraphQLID,
 ]);
+/**
+ * Returns true when the scalar type is one of the scalars specified by GraphQL.
+ * @param type - The GraphQL type to inspect.
+ * @returns True when the scalar type is one of the scalars specified by GraphQL.
+ * @example
+ * ```ts
+ * import {
+ *   GraphQLScalarType,
+ *   GraphQLString,
+ *   isSpecifiedScalarType,
+ * } from 'graphql/type';
+ *
+ * const DateTime = new GraphQLScalarType({
+ *   name: 'DateTime',
+ * });
+ *
+ * isSpecifiedScalarType(GraphQLString); // => true
+ * isSpecifiedScalarType(DateTime); // => false
+ * ```
+ */
+
 export function isSpecifiedScalarType(type) {
   return specifiedScalarTypes.some(({ name }) => type.name === name);
 } // Support serializing objects with custom valueOf() or toJSON() functions -