Skip to content

Change type of extensions from anonymous Record to named interfaces #2465

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

Merged
merged 16 commits into from
Jun 28, 2020
Merged

Change type of extensions from anonymous Record to named interfaces #2465

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
f3fb7b1
Change type of extensions from Record to extendable interfaces
benjie Feb 28, 2020
eaf61b0
Add index signature to extension types
benjie Mar 11, 2020
598c26d
Revert ESLint change
benjie Mar 11, 2020
28be6e9
unknown -> any
benjie Mar 11, 2020
7e2e0fb
Add named flow typings for extensions
benjie Jun 3, 2020
8791f1e
Also export in src/index.d.ts
benjie Jun 3, 2020
3efe792
Apply the changes to GraphQLSchema and GraphQLDirective
benjie Jun 3, 2020
17b7d6b
Mirror to flow
benjie Jun 3, 2020
c72abfb
Add a note not to conflict with other projects
benjie Jun 3, 2020
8bd6f83
Make Extensions types generic where appropriate
benjie Jun 20, 2020
c609839
Update comment.
benjie Jun 20, 2020
aa6ddc6
Why template arguments?
benjie Jun 20, 2020
2dbc5ca
Revert named extension types in Flow
benjie Jun 20, 2020
20d4f8d
Add extensions to typescript integration test
benjie Jun 20, 2020
04c837a
Allow testing certain code blocks on only specific TypeScript versions
benjie Jun 24, 2020
b33e65f
Revert "Allow testing certain code blocks on only specific TypeScript…
benjie Jun 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 42 additions & 1 deletion integrationTests/ts/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,58 @@ import { GraphQLString, GraphQLSchema, GraphQLObjectType } from 'graphql/type';
import { ExecutionResult } from 'graphql/execution';
import { graphqlSync } from 'graphql';

interface SomeExtension {
number: number;
string: string;
}

const example: SomeExtension = {
number: 42,
string: 'Meaning of life',
};

// FIXME: The following code block requires a version of TypeScript >= 3.2
/*

declare module 'graphql' {
interface GraphQLObjectTypeExtensions<TSource = any, TContext = any> {
someObjectExtension?: SomeExtension;
}
interface GraphQLFieldExtensions<
TSource,
TContext,
TArgs = { [argName: string]: any }
> {
someFieldExtension?: SomeExtension;
}
interface GraphQLArgumentExtensions {
someArgumentExtension?: SomeExtension;
}
}
*/
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know how best to selectively enable this for TypeScript 3.2 and above only.

Further, the types themselves are not concretely tested, pointing to an example in the GraphQL source where this takes place would be helpful.


const queryType: GraphQLObjectType = new GraphQLObjectType({
name: 'Query',
fields: {
sayHi: {
type: GraphQLString,
args: {
who: { type: GraphQLString },
who: {
type: GraphQLString,
extensions: {
someArgumentExtension: example,
},
},
},
resolve: (_root, args) => 'Hello ' + (args.who || 'World'),
extensions: {
someFieldExtension: example,
},
},
},
extensions: {
someObjectExtension: example,
},
});

const schema: GraphQLSchema = new GraphQLSchema({
Expand Down
12 changes: 12 additions & 0 deletions src/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,32 +139,44 @@ export {
GraphQLNamedType,
Thunk,
GraphQLSchemaConfig,
GraphQLSchemaExtensions,
GraphQLDirectiveConfig,
GraphQLDirectiveExtensions,
GraphQLArgument,
GraphQLArgumentConfig,
GraphQLArgumentExtensions,
GraphQLEnumTypeConfig,
GraphQLEnumTypeExtensions,
GraphQLEnumValue,
GraphQLEnumValueConfig,
GraphQLEnumValueExtensions,
GraphQLEnumValueConfigMap,
GraphQLField,
GraphQLFieldConfig,
GraphQLFieldExtensions,
GraphQLFieldConfigArgumentMap,
GraphQLFieldConfigMap,
GraphQLFieldMap,
GraphQLFieldResolver,
GraphQLInputField,
GraphQLInputFieldConfig,
GraphQLInputFieldExtensions,
GraphQLInputFieldConfigMap,
GraphQLInputFieldMap,
GraphQLInputObjectTypeConfig,
GraphQLInputObjectTypeExtensions,
GraphQLInterfaceTypeConfig,
GraphQLInterfaceTypeExtensions,
GraphQLIsTypeOfFn,
GraphQLObjectTypeConfig,
GraphQLObjectTypeExtensions,
GraphQLResolveInfo,
ResponsePath,
GraphQLScalarTypeConfig,
GraphQLScalarTypeExtensions,
GraphQLTypeResolver,
GraphQLUnionTypeConfig,
GraphQLUnionTypeExtensions,
GraphQLScalarSerializer,
GraphQLScalarValueParser,
GraphQLScalarLiteralParser,
Expand Down
Loading