node_modules.graphql-config.node_modules.graphql.module.utilities.assertValidName.js.flow Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of apollo-client-maven-plugin Show documentation

Maven plugin for generating graphql clients

There is a newer version: 3.3.1

Show newest version

/**
 * Copyright (c) 2015-present, Facebook, Inc.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 * @flow
 */

import { GraphQLError } from '../error/GraphQLError';
import type { ASTNode } from '../language/ast';
import invariant from '../jsutils/invariant';

const NAME_RX = /^[_a-zA-Z][_a-zA-Z0-9]*$/;

/**
 * Upholds the spec rules about naming.
 */
export function assertValidName(name: string): string {
  const error = isValidNameError(name);
  if (error) {
    throw error;
  }
  return name;
}

/**
 * Returns an Error if a name is invalid.
 */
export function isValidNameError(
  name: string,
  node?: ASTNode | void,
): GraphQLError | void {
  invariant(typeof name === 'string', 'Expected string');
  if (
    name.length > 1 &&
    name[0] === '_' &&
    name[1] === '_' &&
    // Note: this special case is not part of the spec and exists only to
    // support legacy server configurations. Do not rely on this special case
    // as it may be removed at any time.
    name !== '__configs__'
  ) {
    return new GraphQLError(
      `Name "${name}" must not begin with "__", which is reserved by ` +
        'GraphQL introspection.',
      node,
    );
  }
  if (!NAME_RX.test(name)) {
    return new GraphQLError(
      `Names must match /^[_a-zA-Z][_a-zA-Z0-9]*$/ but "${name}" does not.`,
      node,
    );
  }
}