@graphql-tools/graphql/esm/type/directives.js

Fork of GraphQL.js

var _a;
import { inspect } from '../jsutils/inspect.js';
import { toObjMap } from '../jsutils/toObjMap.js';
import { DirectiveLocation } from '../language/directiveLocation.js';
import { assertName } from './assertName.js';
import { argsToArgsConfig, defineArguments, GraphQLNonNull } from './definition.js';
import { GraphQLBoolean, GraphQLString } from './scalars.js';
const isGraphQLDirectiveSymbol = Symbol.for('GraphQLDirective');
/**
 * Test if the given value is a GraphQL directive.
 */
export function isDirective(directive) {
    return typeof directive === 'object' && directive != null && isGraphQLDirectiveSymbol in directive;
}
export function assertDirective(directive) {
    if (!isDirective(directive)) {
        throw new Error(`Expected ${inspect(directive)} to be a GraphQL directive.`);
    }
    return directive;
}
/**
 * Directives are used by the GraphQL runtime as a way of modifying execution
 * behavior. Type system creators will usually not create these directly.
 */
export class GraphQLDirective {
    constructor(config) {
        var _b, _c;
        this[_a] = true;
        this.name = assertName(config.name);
        this.description = config.description;
        this.locations = config.locations;
        this.isRepeatable = (_b = config.isRepeatable) !== null && _b !== void 0 ? _b : false;
        this.extensions = toObjMap(config.extensions);
        this.astNode = config.astNode;
        const args = (_c = config.args) !== null && _c !== void 0 ? _c : {};
        this.args = defineArguments(args);
    }
    get [(_a = isGraphQLDirectiveSymbol, Symbol.toStringTag)]() {
        return 'GraphQLDirective';
    }
    toConfig() {
        return {
            name: this.name,
            description: this.description,
            locations: this.locations,
            args: argsToArgsConfig(this.args),
            isRepeatable: this.isRepeatable,
            extensions: this.extensions,
            astNode: this.astNode,
        };
    }
    toString() {
        return '@' + this.name;
    }
    toJSON() {
        return this.toString();
    }
}
/**
 * Used to conditionally include fields or fragments.
 */
export const GraphQLIncludeDirective = new GraphQLDirective({
    name: 'include',
    description: 'Directs the executor to include this field or fragment only when the `if` argument is true.',
    locations: [DirectiveLocation.FIELD, DirectiveLocation.FRAGMENT_SPREAD, DirectiveLocation.INLINE_FRAGMENT],
    args: {
        if: {
            type: new GraphQLNonNull(GraphQLBoolean),
            description: 'Included when true.',
        },
    },
});
/**
 * Used to conditionally skip (exclude) fields or fragments.
 */
export const GraphQLSkipDirective = new GraphQLDirective({
    name: 'skip',
    description: 'Directs the executor to skip this field or fragment when the `if` argument is true.',
    locations: [DirectiveLocation.FIELD, DirectiveLocation.FRAGMENT_SPREAD, DirectiveLocation.INLINE_FRAGMENT],
    args: {
        if: {
            type: new GraphQLNonNull(GraphQLBoolean),
            description: 'Skipped when true.',
        },
    },
});
/**
 * Constant string used for default reason for a deprecation.
 */
export const DEFAULT_DEPRECATION_REASON = 'No longer supported';
/**
 * Used to declare element of a GraphQL schema as deprecated.
 */
export const GraphQLDeprecatedDirective = new GraphQLDirective({
    name: 'deprecated',
    description: 'Marks an element of a GraphQL schema as no longer supported.',
    locations: [
        DirectiveLocation.FIELD_DEFINITION,
        DirectiveLocation.ARGUMENT_DEFINITION,
        DirectiveLocation.INPUT_FIELD_DEFINITION,
        DirectiveLocation.ENUM_VALUE,
    ],
    args: {
        reason: {
            type: GraphQLString,
            description: 'Explains why this element was deprecated, usually also including a suggestion for how to access supported similar data. Formatted using the Markdown syntax, as specified by [CommonMark](https://commonmark.org/).',
            defaultValue: DEFAULT_DEPRECATION_REASON,
        },
    },
});
/**
 * Used to provide a URL for specifying the behavior of custom scalar definitions.
 */
export const GraphQLSpecifiedByDirective = new GraphQLDirective({
    name: 'specifiedBy',
    description: 'Exposes a URL that specifies the behavior of this scalar.',
    locations: [DirectiveLocation.SCALAR],
    args: {
        url: {
            type: new GraphQLNonNull(GraphQLString),
            description: 'The URL that specifies the behavior of this scalar.',
        },
    },
});
/**
 * The full list of specified directives.
 */
export const specifiedDirectives = Object.freeze([
    GraphQLIncludeDirective,
    GraphQLSkipDirective,
    GraphQLDeprecatedDirective,
    GraphQLSpecifiedByDirective,
]);
export function isSpecifiedDirective(directive) {
    return specifiedDirectives.some(({ name }) => name === directive.name);
}