connectiontypes: inline types into 'connection.js' (#320)

Author: IvanGoncharov

src/connection/arrayconnection.d.ts

@@ -2,7 +2,7 @@ import type {
   Connection,
   ConnectionArguments,
   ConnectionCursor,
-} from './connectiontypes';
+} from './connection';
 
 // TS_SPECIFIC: This type is only exported by TypeScript
 export interface ArraySliceMetaInfo {

src/connection/arrayconnection.js

@@ -4,7 +4,7 @@ import type {
   Connection,
   ConnectionArguments,
   ConnectionCursor,
-} from './connectiontypes';
+} from './connection';
 
 type ArraySliceMetaInfo = {|
   sliceStart: number,

src/connection/connection.d.ts

@@ -41,6 +41,21 @@ export const connectionArgs: GraphQLFieldConfigArgumentMap &
   ForwardConnectionArgs &
   BackwardConnectionArgs;
 
+/**
+ * A type alias for cursors in this implementation.
+ */
+export type ConnectionCursor = string;
+
+/**
+ * A type describing the arguments a connection field receives in GraphQL.
+ */
+export interface ConnectionArguments {
+  before?: ConnectionCursor | null;
+  after?: ConnectionCursor | null;
+  first?: number | null;
+  last?: number | null;
+}
+
 export interface ConnectionConfig {
   name?: string;
   nodeType: GraphQLObjectType;
@@ -62,3 +77,29 @@ export interface GraphQLConnectionDefinitions {
 export function connectionDefinitions(
   config: ConnectionConfig,
 ): GraphQLConnectionDefinitions;
+
+/**
+ * A type designed to be exposed as a `Connection` over GraphQL.
+ */
+export interface Connection<T> {
+  edges: Array<Edge<T>>;
+  pageInfo: PageInfo;
+}
+
+/**
+ * A type designed to be exposed as a `Edge` over GraphQL.
+ */
+export interface Edge<T> {
+  node: T;
+  cursor: ConnectionCursor;
+}
+
+/**
+ * A type designed to be exposed as `PageInfo` over GraphQL.
+ */
+export interface PageInfo {
+  startCursor: ConnectionCursor | null;
+  endCursor: ConnectionCursor | null;
+  hasPreviousPage: boolean;
+  hasNextPage: boolean;
+}

src/connection/connection.js

@@ -49,6 +49,22 @@ export const connectionArgs: GraphQLFieldConfigArgumentMap = {
   ...backwardConnectionArgs,
 };
 
+/**
+ * A type alias for cursors in this implementation.
+ */
+export type ConnectionCursor = string;
+
+/**
+ * A type describing the arguments a connection field receives in GraphQL.
+ */
+export type ConnectionArguments = {
+  before?: ConnectionCursor | null,
+  after?: ConnectionCursor | null,
+  first?: number | null,
+  last?: number | null,
+  ...
+};
+
 type ConnectionConfig = {|
   name?: string,
   nodeType: GraphQLObjectType,
@@ -120,6 +136,22 @@ export function connectionDefinitions(
   return { edgeType, connectionType };
 }
 
+/**
+ * A type designed to be exposed as a `Connection` over GraphQL.
+ */
+export type Connection<T> = {|
+  edges: Array<Edge<T>>,
+  pageInfo: PageInfo,
+|};
+
+/**
+ * A type designed to be exposed as a `Edge` over GraphQL.
+ */
+export type Edge<T> = {|
+  node: T,
+  cursor: ConnectionCursor,
+|};
+
 /**
  * The common page info type used by all connections.
  */
@@ -145,3 +177,13 @@ const pageInfoType = new GraphQLObjectType({
     },
   }),
 });
+
+/**
+ * A type designed to be exposed as `PageInfo` over GraphQL.
+ */
+export type PageInfo = {|
+  startCursor: ConnectionCursor | null,
+  endCursor: ConnectionCursor | null,
+  hasPreviousPage: boolean,
+  hasNextPage: boolean,
+|};

src/connection/connectiontypes.d.ts

@@ -1,11 +1,11 @@
-// Flow types for creating connection types in the schema
+// Types for creating connection types in the schema
 export type {
   Connection,
   ConnectionArguments,
   ConnectionCursor,
   Edge,
   PageInfo,
-} from './connection/connectiontypes';
+} from './connection/connection';
 
 // Helpers for creating connection types in the schema
 export {

src/connection/connectiontypes.js

@@ -1,11 +1,11 @@
-// Flow types for creating connection types in the schema
+// Types for creating connection types in the schema
 export type {
   Connection,
   ConnectionArguments,
   ConnectionCursor,
   Edge,
   PageInfo,
-} from './connection/connectiontypes';
+} from './connection/connection';
 
 // Helpers for creating connection types in the schema
 export {