graphbrainz/src/types/alias.js

A GraphQL schema, Express server, and middleware for querying the MusicBrainz.

import GraphQL from 'graphql';
import { Locale } from './scalars.js';
import { name, sortName, fieldWithID } from './helpers.js';
import { createSubqueryResolver } from '../resolvers.js';

const { GraphQLObjectType, GraphQLBoolean, GraphQLList } = GraphQL;

export const Alias = new GraphQLObjectType({
  name: 'Alias',
  description: `[Aliases](https://musicbrainz.org/doc/Aliases) are variant names
that are mostly used as search help: if a search matches an entity’s alias, the
entity will be given as a result – even if the actual name wouldn’t be.`,
  fields: () => ({
    name: {
      ...name,
      description: 'The aliased name of the entity.',
    },
    sortName,
    locale: {
      type: Locale,
      description: `The locale (language and/or country) in which the alias is
used.`,
    },
    primary: {
      type: GraphQLBoolean,
      description: `Whether this is the main alias for the entity in the
specified locale (this could mean the most recent or the most common).`,
    },
    ...fieldWithID('type', {
      description: `The type or purpose of the alias – whether it is a variant,
search hint, etc.`,
    }),
  }),
});

export const aliases = {
  type: new GraphQLList(Alias),
  description: `[Aliases](https://musicbrainz.org/doc/Aliases) are used to store
alternate names or misspellings.`,
  resolve: createSubqueryResolver(),
};