refactor: ease up common file

Author: enisdenjo

src/__tests__/client.ts

@@ -1,5 +1,5 @@
 import fetch from 'node-fetch';
-import { RequestHeaders } from '../common';
+import { RequestHeaders } from '../handler';
 import { createClient, NetworkError } from '../client';
 import { startTServer } from './utils/tserver';
 import { texecute } from './utils/texecute';

src/__tests__/handler.ts

@@ -1,7 +1,7 @@
 import { jest } from '@jest/globals';
 import { GraphQLError } from 'graphql';
 import fetch from 'node-fetch';
-import { Request } from '../common';
+import { Request } from '../handler';
 import { startTServer } from './utils/tserver';
 
 it.each(['schema', 'context', 'onSubscribe', 'onOperation'])(

src/__tests__/utils/texecute.ts

@@ -1,6 +1,6 @@
 import { ExecutionResult } from 'graphql';
-import { Client } from '../../client';
 import { RequestParams } from '../../common';
+import { Client } from '../../client';
 
 export function texecute<D = unknown, E = unknown>(
   client: Client,

src/__tests__/utils/tserver.ts

@@ -1,5 +1,4 @@
-import { createHandler, HandlerOptions } from '../../handler';
-import { Request } from '../../common';
+import { Request, createHandler, HandlerOptions } from '../../handler';
 import http from 'http';
 import net from 'net';
 import { Response } from 'node-fetch';

src/common.ts

@@ -4,50 +4,6 @@
  *
  */
 
-import { isObject } from './utils';
-
-/**
- * The incoming request headers the implementing server should provide.
- *
- * @category Common
- */
-export interface RequestHeaders {
-  accept?: string | undefined;
-  allow?: string | undefined;
-  'content-type'?: string | undefined;
-  /**
-   * Always an array in Node. Duplicates are added to it.
-   * Not necessarily true for other environments, make sure
-   * to check the type during runtime.
-   */
-  'set-cookie'?: string | string[] | undefined;
-  [key: string]: string | string[] | undefined;
-}
-
-/**
- * Server agnostic request interface containing the raw request
- * which is server dependant.
- *
- * @category Common
- */
-export interface Request<RawRequest, Context> {
-  readonly method: string;
-  readonly url: string;
-  readonly headers: RequestHeaders;
-  readonly body: string | Record<string, unknown> | null;
-  /**
-   * The raw request itself from the implementing server.
-   *
-   * For example: `express.Request` when using Express, or maybe
-   * `http.IncomingMessage` when just using Node with `http.createServer`.
-   */
-  readonly raw: RawRequest;
-  /**
-   * Context value about the incoming request, you're free to pass any information here.
-   */
-  readonly context: Context;
-}
-
 /**
  * Parameters for GraphQL's request for execution.
  *
@@ -62,59 +18,6 @@ export interface RequestParams {
   extensions?: Record<string, unknown> | undefined;
 }
 
-/**
- * The response headers that get returned from graphql-http.
- *
- * @category Common
- */
-export type ResponseHeaders = {
-  accept?: string;
-  allow?: string;
-  'content-type'?: string;
-} & Record<string, string>;
-
-/**
- * Server agnostic response body returned from `graphql-http` needing
- * to be coerced to the server implementation in use.
- *
- * @category Common
- */
-export type ResponseBody = string;
-
-/**
- * Server agnostic response options (ex. status and headers) returned from
- * `graphql-http` needing to be coerced to the server implementation in use.
- *
- * @category Common
- */
-export interface ResponseInit {
-  readonly status: number;
-  readonly statusText: string;
-  readonly headers?: ResponseHeaders;
-}
-
-/**
- * Server agnostic response returned from `graphql-http` containing the
- * body and init options needing to be coerced to the server implementation in use.
- *
- * @category Common
- */
-export type Response = readonly [body: ResponseBody | null, init: ResponseInit];
-
-/**
- * Checks whether the passed value is the `graphql-http` server agnostic response.
- *
- * @category Common
- */
-export function isResponse(val: unknown): val is Response {
-  // TODO: make sure the contents of init match ResponseInit
-  return (
-    Array.isArray(val) &&
-    (typeof val[0] === 'string' || val[0] === null) &&
-    isObject(val[1])
-  );
-}
-
 /**
  * A representation of any set of values over any amount of time.
  *

src/handler.ts

@@ -16,14 +16,109 @@ import {
   OperationTypeNode,
   GraphQLError,
 } from 'graphql';
-import { isResponse, Request, RequestParams, Response } from './common';
+import { RequestParams } from './common';
 import {
   areGraphQLErrors,
   isAsyncIterable,
   isExecutionResult,
   isObject,
 } from './utils';
 
+/**
+ * The incoming request headers the implementing server should provide.
+ *
+ * @category Common
+ */
+export interface RequestHeaders {
+  accept?: string | undefined;
+  allow?: string | undefined;
+  'content-type'?: string | undefined;
+  /**
+   * Always an array in Node. Duplicates are added to it.
+   * Not necessarily true for other environments, make sure
+   * to check the type during runtime.
+   */
+  'set-cookie'?: string | string[] | undefined;
+  [key: string]: string | string[] | undefined;
+}
+
+/**
+ * Server agnostic request interface containing the raw request
+ * which is server dependant.
+ *
+ * @category Common
+ */
+export interface Request<RawRequest, Context> {
+  readonly method: string;
+  readonly url: string;
+  readonly headers: RequestHeaders;
+  readonly body: string | Record<string, unknown> | null;
+  /**
+   * The raw request itself from the implementing server.
+   *
+   * For example: `express.Request` when using Express, or maybe
+   * `http.IncomingMessage` when just using Node with `http.createServer`.
+   */
+  readonly raw: RawRequest;
+  /**
+   * Context value about the incoming request, you're free to pass any information here.
+   */
+  readonly context: Context;
+}
+
+/**
+ * The response headers that get returned from graphql-http.
+ *
+ * @category Common
+ */
+export type ResponseHeaders = {
+  accept?: string;
+  allow?: string;
+  'content-type'?: string;
+} & Record<string, string>;
+
+/**
+ * Server agnostic response body returned from `graphql-http` needing
+ * to be coerced to the server implementation in use.
+ *
+ * @category Common
+ */
+export type ResponseBody = string;
+
+/**
+ * Server agnostic response options (ex. status and headers) returned from
+ * `graphql-http` needing to be coerced to the server implementation in use.
+ *
+ * @category Common
+ */
+export interface ResponseInit {
+  readonly status: number;
+  readonly statusText: string;
+  readonly headers?: ResponseHeaders;
+}
+
+/**
+ * Server agnostic response returned from `graphql-http` containing the
+ * body and init options needing to be coerced to the server implementation in use.
+ *
+ * @category Common
+ */
+export type Response = readonly [body: ResponseBody | null, init: ResponseInit];
+
+/**
+ * Checks whether the passed value is the `graphql-http` server agnostic response.
+ *
+ * @category Common
+ */
+export function isResponse(val: unknown): val is Response {
+  // TODO: make sure the contents of init match ResponseInit
+  return (
+    Array.isArray(val) &&
+    (typeof val[0] === 'string' || val[0] === null) &&
+    isObject(val[1])
+  );
+}
+
 /**
  * A concrete GraphQL execution context value type.
  *