Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Unify InputValueConfig in schema definition #3067

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

Unify InputValueConfig in schema definition #3067

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
418cf34
Unify InputValueConfig in schema definition
leebyron May 7, 2021
a44b1cf
Also add isRequiredInput()
leebyron May 7, 2021
452e3e0
Revert DirectiveArgument
leebyron May 10, 2021
9830fda
Update other duplicated callsites in extendSchema and lexicographicSo…
leebyron May 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 3 additions & 2 deletions src/index.d.ts
View file
Open in desktop
Expand Up @@ -94,6 +94,7 @@ export {
isWrappingType,
isNullableType,
isNamedType,
isRequiredInput,
isRequiredArgument,
isRequiredInputField,
isSpecifiedScalarType,
Expand Down Expand Up @@ -148,6 +149,8 @@ export {
GraphQLArgument,
GraphQLArgumentConfig,
GraphQLArgumentExtensions,
GraphQLInputValue,
GraphQLInputValueConfig,
GraphQLEnumTypeConfig,
GraphQLEnumTypeExtensions,
GraphQLEnumValue,
Expand All @@ -157,14 +160,12 @@ export {
GraphQLField,
GraphQLFieldConfig,
GraphQLFieldExtensions,
GraphQLFieldConfigArgumentMap,
GraphQLFieldConfigMap,
GraphQLFieldMap,
GraphQLFieldResolver,
GraphQLInputField,
GraphQLInputFieldConfig,
GraphQLInputFieldExtensions,
GraphQLInputFieldConfigMap,
GraphQLInputFieldMap,
GraphQLInputObjectTypeConfig,
GraphQLInputObjectTypeExtensions,
Expand Down
5 changes: 3 additions & 2 deletions src/index.js
View file
Open in desktop
Expand Up @@ -93,6 +93,7 @@ export {
isWrappingType,
isNullableType,
isNamedType,
isRequiredInput,
isRequiredArgument,
isRequiredInputField,
isSpecifiedScalarType,
Expand Down Expand Up @@ -144,19 +145,19 @@ export type {
GraphQLDirectiveConfig,
GraphQLArgument,
GraphQLArgumentConfig,
GraphQLInputValue,
GraphQLInputValueConfig,
GraphQLEnumTypeConfig,
GraphQLEnumValue,
GraphQLEnumValueConfig,
GraphQLEnumValueConfigMap,
GraphQLField,
GraphQLFieldConfig,
GraphQLFieldConfigArgumentMap,
GraphQLFieldConfigMap,
GraphQLFieldMap,
GraphQLFieldResolver,
GraphQLInputField,
GraphQLInputFieldConfig,
GraphQLInputFieldConfigMap,
GraphQLInputFieldMap,
GraphQLInputObjectTypeConfig,
GraphQLInterfaceTypeConfig,
Expand Down
27 changes: 12 additions & 15 deletions src/type/__tests__/predicate-test.js
View file
Open in desktop
Expand Up @@ -49,8 +49,7 @@ import {
isWrappingType,
isNullableType,
isNamedType,
isRequiredArgument,
isRequiredInputField,
isRequiredInput,
assertType,
assertScalarType,
assertObjectType,
Expand Down Expand Up @@ -562,7 +561,7 @@ describe('Type predicates', () => {
});
});

describe('isRequiredArgument', () => {
describe('isRequiredInput', () => {
function buildArg(config: {|
type: GraphQLInputType,
defaultValue?: mixed,
Expand All @@ -582,35 +581,33 @@ describe('Type predicates', () => {
const requiredArg = buildArg({
type: new GraphQLNonNull(GraphQLString),
});
expect(isRequiredArgument(requiredArg)).to.equal(true);
expect(isRequiredInput(requiredArg)).to.equal(true);
});

it('returns false for optional arguments', () => {
const optArg1 = buildArg({
type: GraphQLString,
});
expect(isRequiredArgument(optArg1)).to.equal(false);
expect(isRequiredInput(optArg1)).to.equal(false);

const optArg2 = buildArg({
type: GraphQLString,
defaultValue: null,
});
expect(isRequiredArgument(optArg2)).to.equal(false);
expect(isRequiredInput(optArg2)).to.equal(false);

const optArg3 = buildArg({
type: new GraphQLList(new GraphQLNonNull(GraphQLString)),
});
expect(isRequiredArgument(optArg3)).to.equal(false);
expect(isRequiredInput(optArg3)).to.equal(false);

const optArg4 = buildArg({
type: new GraphQLNonNull(GraphQLString),
defaultValue: 'default',
});
expect(isRequiredArgument(optArg4)).to.equal(false);
expect(isRequiredInput(optArg4)).to.equal(false);
});
});

describe('isRequiredInputField', () => {
function buildInputField(config: {|
type: GraphQLInputType,
defaultValue?: mixed,
Expand All @@ -630,31 +627,31 @@ describe('Type predicates', () => {
const requiredField = buildInputField({
type: new GraphQLNonNull(GraphQLString),
});
expect(isRequiredInputField(requiredField)).to.equal(true);
expect(isRequiredInput(requiredField)).to.equal(true);
});

it('returns false for optional input field', () => {
const optField1 = buildInputField({
type: GraphQLString,
});
expect(isRequiredInputField(optField1)).to.equal(false);
expect(isRequiredInput(optField1)).to.equal(false);

const optField2 = buildInputField({
type: GraphQLString,
defaultValue: null,
});
expect(isRequiredInputField(optField2)).to.equal(false);
expect(isRequiredInput(optField2)).to.equal(false);

const optField3 = buildInputField({
type: new GraphQLList(new GraphQLNonNull(GraphQLString)),
});
expect(isRequiredInputField(optField3)).to.equal(false);
expect(isRequiredInput(optField3)).to.equal(false);

const optField4 = buildInputField({
type: new GraphQLNonNull(GraphQLString),
defaultValue: 'default',
});
expect(isRequiredInputField(optField4)).to.equal(false);
expect(isRequiredInput(optField4)).to.equal(false);
});
});
});
Expand Down
69 changes: 26 additions & 43 deletions src/type/definition.d.ts
View file
Open in desktop
Expand Up @@ -441,10 +441,6 @@ export class GraphQLObjectType<TSource = any, TContext = any> {
get [Symbol.toStringTag](): string;
}

export function argsToArgsConfig(
args: ReadonlyArray<GraphQLArgument>,
): GraphQLFieldConfigArgumentMap;

export interface GraphQLObjectTypeConfig<TSource, TContext> {
name: string;
description?: Maybe<string>;
Expand Down Expand Up @@ -520,7 +516,7 @@ export interface GraphQLFieldConfig<
> {
description?: Maybe<string>;
type: GraphQLOutputType;
args?: GraphQLFieldConfigArgumentMap;
args?: ObjMap<GraphQLArgumentConfig>;
resolve?: GraphQLFieldResolver<TSource, TContext, TArgs>;
subscribe?: GraphQLFieldResolver<TSource, TContext, TArgs>;
deprecationReason?: Maybe<string>;
Expand All @@ -530,8 +526,6 @@ export interface GraphQLFieldConfig<
astNode?: Maybe<FieldDefinitionNode>;
}

export type GraphQLFieldConfigArgumentMap = ObjMap<GraphQLArgumentConfig>;

/**
* Custom extensions
*
Expand All @@ -545,14 +539,7 @@ export interface GraphQLArgumentExtensions {
[attributeName: string]: unknown;
}

export interface GraphQLArgumentConfig {
description?: Maybe<string>;
type: GraphQLInputType;
defaultValue?: unknown;
deprecationReason?: Maybe<string>;
extensions?: Maybe<Readonly<GraphQLArgumentExtensions>>;
astNode?: Maybe<InputValueDefinitionNode>;
}
export type GraphQLArgumentConfig = GraphQLInputValueConfig<GraphQLArgumentExtensions>;

export type GraphQLFieldConfigMap<TSource, TContext> = ObjMap<
GraphQLFieldConfig<TSource, TContext>
Expand All @@ -574,21 +561,34 @@ export interface GraphQLField<
astNode?: Maybe<FieldDefinitionNode>;
}

export interface GraphQLArgument {
export type GraphQLArgument = GraphQLInputValue<GraphQLArgumentExtensions>;

export function isRequiredArgument(arg: GraphQLArgument): boolean;

export type GraphQLFieldMap<TSource, TContext> = ObjMap<
GraphQLField<TSource, TContext>
>;

export function isRequiredInput(input: GraphQLInputValue<any>): boolean;

export interface GraphQLInputValue<Extensions> {
name: string;
description: Maybe<string>;
type: GraphQLInputType;
defaultValue: unknown;
deprecationReason: Maybe<string>;
extensions: Maybe<Readonly<GraphQLArgumentExtensions>>;
extensions: Maybe<Readonly<Extensions>>;
astNode: Maybe<InputValueDefinitionNode>;
}

export function isRequiredArgument(arg: GraphQLArgument): boolean;

export type GraphQLFieldMap<TSource, TContext> = ObjMap<
GraphQLField<TSource, TContext>
>;
export interface GraphQLInputValueConfig<Extensions> {
description?: Maybe<string>;
type: GraphQLInputType;
defaultValue?: unknown;
deprecationReason?: Maybe<string>;
extensions?: Maybe<Readonly<Extensions>>;
astNode?: Maybe<InputValueDefinitionNode>;
}

/**
* Custom extensions
Expand Down Expand Up @@ -883,7 +883,7 @@ export class GraphQLInputObjectType {
getFields(): GraphQLInputFieldMap;

toConfig(): GraphQLInputObjectTypeConfig & {
fields: GraphQLInputFieldConfigMap;
fields: ObjMap<GraphQLInputFieldConfig>;
extensions: Maybe<Readonly<GraphQLInputObjectTypeExtensions>>;
extensionASTNodes: ReadonlyArray<InputObjectTypeExtensionNode>;
};
Expand Down Expand Up @@ -913,29 +913,12 @@ export interface GraphQLInputObjectTypeConfig {
* an object which can contain all the values you need.
*/
export interface GraphQLInputFieldExtensions {
[attributeName: string]: any;
}

export interface GraphQLInputFieldConfig {
description?: Maybe<string>;
type: GraphQLInputType;
defaultValue?: unknown;
deprecationReason?: Maybe<string>;
extensions?: Maybe<Readonly<GraphQLInputFieldExtensions>>;
astNode?: Maybe<InputValueDefinitionNode>;
[attributeName: string]: unknown;
}

export type GraphQLInputFieldConfigMap = ObjMap<GraphQLInputFieldConfig>;
export type GraphQLInputFieldConfig = GraphQLInputValueConfig<GraphQLInputFieldExtensions>;

export interface GraphQLInputField {
name: string;
description?: Maybe<string>;
type: GraphQLInputType;
defaultValue?: unknown;
deprecationReason: Maybe<string>;
extensions: Maybe<Readonly<GraphQLInputFieldExtensions>>;
astNode?: Maybe<InputValueDefinitionNode>;
}
export type GraphQLInputField = GraphQLInputValue<GraphQLInputFieldExtensions>;

export function isRequiredInputField(field: GraphQLInputField): boolean;

Expand Down