@ardatan/relay-compiler/core/SchemaUtils.js.flow

A compiler tool for building GraphQL-driven applications.

/**
 * Copyright (c) Facebook, Inc. and its affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 * @flow strict
 * @format
 */

// flowlint ambiguous-object-type:error

'use strict';

const {createCompilerError} = require('./CompilerError');

import type {ScalarField} from '../core/IR';
import type {CompositeTypeID, Schema, InputTypeID} from './Schema';
import type {ASTNode} from 'graphql';

const ID = 'id';

/**
 * @public
 *
 * Determine if an AST node contains a fragment/operation definition.
 */
function isExecutableDefinitionAST(ast: ASTNode): boolean %checks {
  return (
    ast.kind === 'FragmentDefinition' || ast.kind === 'OperationDefinition'
  );
}

/**
 * @public
 *
 * Determine if an AST node contains a schema definition.
 */
function isSchemaDefinitionAST(ast: ASTNode): boolean %checks {
  return (
    ast.kind === 'SchemaDefinition' ||
    ast.kind === 'ScalarTypeDefinition' ||
    ast.kind === 'ObjectTypeDefinition' ||
    ast.kind === 'InterfaceTypeDefinition' ||
    ast.kind === 'UnionTypeDefinition' ||
    ast.kind === 'EnumTypeDefinition' ||
    ast.kind === 'InputObjectTypeDefinition' ||
    ast.kind === 'DirectiveDefinition' ||
    ast.kind === 'ScalarTypeExtension' ||
    ast.kind === 'ObjectTypeExtension' ||
    ast.kind === 'InterfaceTypeExtension' ||
    ast.kind === 'UnionTypeExtension' ||
    ast.kind === 'EnumTypeExtension' ||
    ast.kind === 'InputObjectTypeExtension'
  );
}

/**
 * Generates an id field on the given type.
 */
function generateIDField(schema: Schema, type: CompositeTypeID): ScalarField {
  const idField = schema.getFieldByName(type, 'id');
  if (idField == null) {
    throw new createCompilerError(
      `Expected an 'id' field on type '${schema.getTypeString(type)}'.`,
    );
  }
  const idType = schema.assertScalarFieldType(schema.getFieldType(idField));
  return {
    kind: 'ScalarField',
    alias: ID,
    args: [],
    directives: [],
    handles: null,
    loc: {kind: 'Generated'},
    metadata: null,
    name: ID,
    type: idType,
  };
}

function getNullableBooleanInput(schema: Schema): InputTypeID {
  return schema.assertInputType(schema.expectBooleanType());
}

function getNonNullBooleanInput(schema: Schema): InputTypeID {
  return schema.assertInputType(
    schema.getNonNullType(schema.expectBooleanType()),
  );
}

function getNullableStringInput(schema: Schema): InputTypeID {
  return schema.assertInputType(schema.expectStringType());
}

function getNonNullStringInput(schema: Schema): InputTypeID {
  return schema.assertInputType(
    schema.getNonNullType(schema.expectStringType()),
  );
}

function getNullableIdInput(schema: Schema): InputTypeID {
  return schema.assertInputType(schema.expectIdType());
}

function getNonNullIdInput(schema: Schema): InputTypeID {
  return schema.assertInputType(schema.getNonNullType(schema.expectIdType()));
}

module.exports = {
  generateIDField,
  isExecutableDefinitionAST,
  isSchemaDefinitionAST,
  getNullableBooleanInput,
  getNonNullBooleanInput,
  getNullableStringInput,
  getNonNullStringInput,
  getNullableIdInput,
  getNonNullIdInput,
};