Refactor TS declaration files

Author: danielrearden

.eslintrc.yml

@@ -481,7 +481,7 @@ overrides:
   - files: '**/*.ts'
     parser: '@typescript-eslint/parser'
     parserOptions:
-      tsconfigRootDir: './types/'
+      tsconfigRootDir: './'
       project: ['tsconfig.json']
     plugins:
       - '@typescript-eslint'

.gitignore

@@ -7,5 +7,6 @@
 npm-debug.log
 
 dist
+tmp
 node_modules
 coverage

package.json

@@ -32,11 +32,11 @@
     "test:ci": "yarn check --integrity && npm run prettier:check && npm run lint && npm run check && npm run check:ts && npm run testonly:cover && npm run build",
     "testonly": "mocha src/**/__tests__/**/*.js",
     "testonly:cover": "nyc npm run testonly",
-    "lint": "eslint src types resources",
+    "lint": "eslint src resources",
     "prettier": "prettier --ignore-path .gitignore --write --list-different '**/*.{js,ts,md,json,yml}'",
     "prettier:check": "prettier --ignore-path .gitignore --check '**/*.{js,ts,md,json,yml}'",
     "check": "flow check",
-    "check:ts": "dtslint types",
+    "check:ts": "node resources/check-ts.js",
     "build": "node resources/build.js",
     "changelog": "node resources/gen-changelog.js",
     "preversion": ". ./resources/checkgit.sh",

resources/build.js

@@ -25,10 +25,11 @@ if (require.main === module) {
 
       const cjs = babelBuild(srcPath, { envName: 'cjs' });
       fs.writeFileSync(destPath, cjs);
+    } else if (filepath.endsWith('d.ts')) {
+      fs.copyFileSync(srcPath, destPath);
     }
   }
 
-  fs.copyFileSync('./types/index.d.ts', './dist/index.d.ts');
   fs.copyFileSync('./LICENSE', './dist/LICENSE');
   fs.copyFileSync('./README.md', './dist/README.md');
 

resources/check-ts.js

@@ -0,0 +1,30 @@
+// @noflow
+
+'use strict';
+
+const fs = require('fs');
+const path = require('path');
+
+const { exec, rmdirRecursive, readdirRecursive } = require('./utils');
+
+rmdirRecursive('./tmp');
+fs.mkdirSync('./tmp');
+fs.mkdirSync('./tmp/__tests__');
+
+const srcFiles = readdirRecursive('./src');
+for (const filepath of srcFiles) {
+  const srcPath = path.join('./src', filepath);
+  const destPath = path.join('./tmp', filepath);
+
+  if (filepath.endsWith('.ts')) {
+    fs.copyFileSync(srcPath, destPath);
+  }
+}
+
+fs.copyFileSync('tsconfig.json', path.join('./tmp', 'tsconfig.json'));
+
+try {
+  exec('dtslint tmp', { stdio: 'inherit' });
+} finally {
+  rmdirRecursive('./tmp');
+}

types/test.ts renamed to src/__tests__/test.ts

@@ -16,11 +16,16 @@ import {
   GraphQLTypeResolver,
 } from 'graphql';
 
+import { GraphiQLOptions } from './renderGraphiQL';
+
 export {};
 
 type Request = IncomingMessage;
+
 type Response = ServerResponse & { json?: (data: unknown) => void };
 
+type Middleware = (request: Request, response: Response) => Promise<void>;
+
 /**
  * Used to configure the graphqlHTTP middleware by providing a schema
  * and other configuration options.
@@ -37,15 +42,6 @@ export type Options =
   | OptionsResult;
 type OptionsResult = OptionsData | Promise<OptionsData>;
 
-export interface GraphiQLOptions {
-  /**
-   * An optional GraphQL string to use when no query is provided and no stored
-   * query exists from a previous session.  If undefined is provided, GraphiQL
-   * will use its own default query.
-   */
-  defaultQuery?: string;
-}
-
 export interface OptionsData {
   /**
    * A GraphQL schema from graphql-js.
@@ -173,7 +169,11 @@ export interface RequestInfo {
   context?: unknown;
 }
 
-type Middleware = (request: Request, response: Response) => Promise<void>;
+/**
+ * Middleware for express; takes an options object or function as input to
+ * configure behavior, and returns an express middleware.
+ */
+export function graphqlHTTP(options: Options): Middleware;
 
 export interface GraphQLParams {
   query: string | null;
@@ -182,8 +182,4 @@ export interface GraphQLParams {
   raw: boolean;
 }
 
-/**
- * Middleware for express; takes an options object or function as input to
- * configure behavior, and returns an express middleware.
- */
-export function graphqlHTTP(options: Options): Middleware;
+export function getGraphQLParams(request: Request): Promise<GraphQLParams>;

types/index.d.ts renamed to src/index.d.ts

@@ -0,0 +1,7 @@
+import { IncomingMessage } from 'http';
+
+export {};
+
+type Request = IncomingMessage & { body?: unknown };
+
+export function parseBody(req: Request): Promise<{ [param: string]: unknown }>;

src/parseBody.d.ts

@@ -0,0 +1,29 @@
+import { ExecutionResult } from 'graphql';
+
+export interface GraphiQLData {
+  query?: string | null;
+  variables?: { readonly [name: string]: unknown } | null;
+  operationName?: string | null;
+  result?: ExecutionResult;
+}
+
+export interface GraphiQLOptions {
+  /**
+   * An optional GraphQL string to use when no query is provided and no stored
+   * query exists from a previous session.  If undefined is provided, GraphiQL
+   * will use its own default query.
+   */
+  defaultQuery?: string;
+}
+
+/**
+ * When express-graphql receives a request which does not Accept JSON, but does
+ * Accept HTML, it may present GraphiQL, the in-browser GraphQL explorer IDE.
+ *
+ * When shown, it will be pre-populated with the result of having executed the
+ * requested query.
+ */
+export function renderGraphiQL(
+  data: GraphiQLData,
+  options?: GraphiQLOptions,
+): string;

src/renderGraphiQL.d.ts

@@ -1,13 +1,16 @@
 {
   "compilerOptions": {
     "module": "commonjs",
-    "lib": ["es6", "esnext.asynciterable"],
+    "target": "es2018",
+    "moduleResolution": "node",
+    "lib": ["es2018", "esnext.asynciterable"],
     "noImplicitAny": true,
     "noImplicitThis": true,
     "strictNullChecks": true,
     "strictFunctionTypes": true,
+    "baseUrl": "./",
     "noEmit": true,
-    "baseUrl": ".",
+    "forceConsistentCasingInFileNames": true,
     "paths": { "express-graphql": ["."] }
   }
 }