Sync TypeScript types with Flow types (#280)

src/connection/arrayconnection.d.ts

@@ -4,6 +4,7 @@ import type {
   ConnectionCursor,
 } from './connectiontypes';
 
+// TS_SPECIFIC: This type is only exported by TypeScript
 export interface ArraySliceMetaInfo {
   sliceStart: number;
   arrayLength: number;
@@ -15,7 +16,7 @@ export interface ArraySliceMetaInfo {
  * so pagination will only work if the array is static.
  */
 export function connectionFromArray<T>(
-  data: T[],
+  data: ReadonlyArray<T>,
   args: ConnectionArguments,
 ): Connection<T>;
 
@@ -24,7 +25,7 @@ export function connectionFromArray<T>(
  * promised connection.
  */
 export function connectionFromPromisedArray<T>(
-  dataPromise: Promise<T[]>,
+  dataPromise: Promise<ReadonlyArray<T>>,
   args: ConnectionArguments,
 ): Promise<Connection<T>>;
 
@@ -38,7 +39,7 @@ export function connectionFromPromisedArray<T>(
  * total result large enough to cover the range specified in `args`.
  */
 export function connectionFromArraySlice<T>(
-  arraySlice: T[],
+  arraySlice: ReadonlyArray<T>,
   args: ConnectionArguments,
   meta: ArraySliceMetaInfo,
 ): Connection<T>;
@@ -48,7 +49,7 @@ export function connectionFromArraySlice<T>(
  * and returns a promised connection.
  */
 export function connectionFromPromisedArraySlice<T>(
-  dataPromise: Promise<T[]>,
+  dataPromise: Promise<ReadonlyArray<T>>,
   args: ConnectionArguments,
   arrayInfo: ArraySliceMetaInfo,
 ): Promise<Connection<T>>;
@@ -67,9 +68,9 @@ export function cursorToOffset(cursor: ConnectionCursor): number;
  * Return the cursor associated with an object in an array.
  */
 export function cursorForObjectInConnection<T>(
-  data: T[],
+  data: ReadonlyArray<T>,
   object: T,
-): ConnectionCursor;
+): ConnectionCursor | null | undefined;
 
 /**
  * Given an optional cursor and a default offset, returns the offset
@@ -78,5 +79,5 @@ export function cursorForObjectInConnection<T>(
  */
 export function getOffsetWithDefault(
   cursor?: ConnectionCursor | null,
-  defaultOffset?: number | null,
+  defaultOffset: number,
 ): number;

src/connection/connection.d.ts

@@ -7,10 +7,7 @@ import type {
   Thunk,
 } from 'graphql';
 
-/**
- * Returns a GraphQLFieldConfigArgumentMap appropriate to include on a field
- * whose return type is a connection type with forward pagination.
- */
+// TS_SPECIFIC: This type is only exported by TypeScript. Flow uses the spread operator instead.
 export interface ForwardConnectionArgs {
   after: { type: GraphQLScalarType };
   first: { type: GraphQLScalarType };
@@ -23,10 +20,7 @@ export interface ForwardConnectionArgs {
 export const forwardConnectionArgs: GraphQLFieldConfigArgumentMap &
   ForwardConnectionArgs;
 
-/**
- * Returns a GraphQLFieldConfigArgumentMap appropriate to include on a field
- * whose return type is a connection type with backward pagination.
- */
+// TS_SPECIFIC: This type is only exported by TypeScript. Flow uses the spread operator instead.
 export interface BackwardConnectionArgs {
   before: { type: GraphQLScalarType };
   last: { type: GraphQLScalarType };
@@ -47,20 +41,9 @@ export const connectionArgs: GraphQLFieldConfigArgumentMap &
   ForwardConnectionArgs &
   BackwardConnectionArgs;
 
-export type ConnectionConfigNodeTypeNullable =
-  | GraphQLScalarType
-  | GraphQLObjectType
-  | GraphQLInterfaceType
-  | GraphQLUnionType
-  | GraphQLEnumType;
-
-export type ConnectionConfigNodeType =
-  | ConnectionConfigNodeTypeNullable
-  | GraphQLNonNull<ConnectionConfigNodeTypeNullable>;
-
 export interface ConnectionConfig {
   name?: string | null;
-  nodeType: ConnectionConfigNodeType;
+  nodeType: GraphQLObjectType;
   resolveNode?: GraphQLFieldResolver<any, any> | null;
   resolveCursor?: GraphQLFieldResolver<any, any> | null;
   edgeFields?: Thunk<GraphQLFieldConfigMap<any, any>> | null;

src/mutation/mutation.d.ts

@@ -6,12 +6,14 @@ import type {
   Thunk,
 } from 'graphql';
 
-export type mutationFn = (
+// TS_SPECIFIC: This type is only exported by TypeScript
+export type MutationFn = (
   object: any,
   ctx: any,
   info: GraphQLResolveInfo,
 ) => Promise<any> | any;
 
+// TS_SPECIFIC: This type is only exported by TypeScript
 /**
  * A description of a mutation consumable by mutationWithClientMutationId
  * to create a GraphQLFieldConfig for that mutation.
@@ -31,7 +33,7 @@ export interface MutationConfig {
   description?: string;
   inputFields: Thunk<GraphQLInputFieldConfigMap>;
   outputFields: Thunk<GraphQLFieldConfigMap<any, any>>;
-  mutateAndGetPayload: mutationFn;
+  mutateAndGetPayload: MutationFn;
   deprecationReason?: string;
 }
 

src/node/node.d.ts

@@ -4,10 +4,11 @@ import type {
   GraphQLTypeResolver,
 } from 'graphql';
 
-export interface GraphQLNodeDefinitions {
+// TS_SPECIFIC: This type is only exported by TypeScript
+export interface GraphQLNodeDefinitions<TContext> {
   nodeInterface: GraphQLInterfaceType;
-  nodeField: GraphQLFieldConfig<any, any>;
-  nodesField: GraphQLFieldConfig<any, any>;
+  nodeField: GraphQLFieldConfig<any, TContext>;
+  nodesField: GraphQLFieldConfig<any, TContext>;
 }
 
 /**
@@ -22,9 +23,10 @@ export interface GraphQLNodeDefinitions {
  */
 export function nodeDefinitions<TContext>(
   idFetcher: (id: string, context: TContext, info: GraphQLResolveInfo) => any,
-  typeResolver?: GraphQLTypeResolver<any, TContext>,
-): GraphQLNodeDefinitions;
+  typeResolver?: GraphQLTypeResolver<any, TContext> | null,
+): GraphQLNodeDefinitions<TContext>;
 
+// TS_SPECIFIC: This type is only exported by TypeScript
 export interface ResolvedGlobalId {
   type: string;
   id: string;
@@ -49,6 +51,6 @@ export function fromGlobalId(globalId: string): ResolvedGlobalId;
  * property on the object.
  */
 export function globalIdField(
-  typeName?: string,
+  typeName?: string | null,
   idFetcher?: (object: any, context: any, info: GraphQLResolveInfo) => string,
 ): GraphQLFieldConfig<any, any>;

src/node/plural.d.ts

@@ -5,11 +5,16 @@ import type {
   GraphQLResolveInfo,
 } from 'graphql';
 
+// TS_SPECIFIC: This type is only exported by TypeScript
 export interface PluralIdentifyingRootFieldConfig {
   argName: string;
   inputType: GraphQLInputType;
   outputType: GraphQLOutputType;
-  resolveSingleInput(input: any, context: any, info: GraphQLResolveInfo): any;
+  resolveSingleInput: (
+    input: any,
+    context: any,
+    info: GraphQLResolveInfo,
+  ) => any;
   description?: string;
 }