graphql-http 1.9.0 → 1.11.0

package/README.md

@@ -141,6 +141,21 @@ fastify.listen({ port: 4000 });
 console.log('Listening to port 4000');
 ```
 
+##### With [`Koa`](https://koajs.com/)
+
+```js
+import Koa from 'koa'; // yarn add koa
+import mount from 'koa-mount'; // yarn add koa-mount
+import { createHandler } from 'graphql-http/lib/use/koa';
+import { schema } from './previous-step';
+
+const app = new Koa();
+app.use(mount('/graphql', createHandler({ schema })));
+
+app.listen({ port: 4000 });
+console.log('Listening to port 4000');
+```
+
 ##### With [`Deno`](https://deno.land/)
 
 ```ts
@@ -733,6 +748,7 @@ If you want a feature-full server with bleeding edge technologies, you're recomm
 | ------------------------------------------------------------------ | -------------------------------------------------------- |
 | [graphql-yoga](https://www.the-guild.dev/graphql/yoga-server)      | [✅ Compliant](/implementations/graphql-yoga/README.md)  |
 | [hotchocolate](https://chillicream.com/docs/hotchocolate)          | [✅ Compliant](/implementations/hotchocolate/README.md)  |
+| [pioneer](https://pioneer.dexclaimation.com/)                      | [✅ Compliant](/implementations/pioneer/README.md)       |
 | [postgraphile](https://www.graphile.org/postgraphile/)             | [✅ Compliant](/implementations/postgraphile/README.md)  |
 | [apollo-server](https://www.apollographql.com/docs/apollo-server/) | [✅ Compliant](/implementations/apollo-server/README.md) |
 

package/lib/audits/common.d.mts

@@ -8,13 +8,13 @@
  *
  * @category Audits
  */
-export declare type AuditRequirement = 'MUST' | 'SHOULD' | 'MAY';
+export type AuditRequirement = 'MUST' | 'SHOULD' | 'MAY';
 /**
  * Audit name starting with the audit requirement level.
  *
  * @category Audits
  */
-export declare type AuditName = `${AuditRequirement} ${string}`;
+export type AuditName = `${AuditRequirement} ${string}`;
 /**
  * Actual audit test returning an result.
  *
@@ -55,4 +55,4 @@ export interface AuditFail {
  *
  * @category Audits
  */
-export declare type AuditResult = AuditOk | AuditFail;
+export type AuditResult = AuditOk | AuditFail;

package/lib/audits/common.d.ts

@@ -8,13 +8,13 @@
  *
  * @category Audits
  */
-export declare type AuditRequirement = 'MUST' | 'SHOULD' | 'MAY';
+export type AuditRequirement = 'MUST' | 'SHOULD' | 'MAY';
 /**
  * Audit name starting with the audit requirement level.
  *
  * @category Audits
  */
-export declare type AuditName = `${AuditRequirement} ${string}`;
+export type AuditName = `${AuditRequirement} ${string}`;
 /**
  * Actual audit test returning an result.
  *
@@ -55,4 +55,4 @@ export interface AuditFail {
  *
  * @category Audits
  */
-export declare type AuditResult = AuditOk | AuditFail;
+export type AuditResult = AuditOk | AuditFail;

package/lib/handler.d.mts

@@ -10,7 +10,7 @@ import { RequestParams } from './common';
  *
  * @category Server
  */
-export declare type RequestHeaders = {
+export type RequestHeaders = {
     /**
      * Always an array in Node. Duplicates are added to it.
      * Not necessarily true for other environments.
@@ -54,7 +54,7 @@ export interface Request<Raw, Context> {
  *
  * @category Server
  */
-export declare type ResponseHeaders = {
+export type ResponseHeaders = {
     accept?: string;
     allow?: string;
     'content-type'?: string;
@@ -65,7 +65,7 @@ export declare type ResponseHeaders = {
  *
  * @category Server
  */
-export declare type ResponseBody = string;
+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.
@@ -83,7 +83,7 @@ export interface ResponseInit {
  *
  * @category Server
  */
-export declare type Response = readonly [body: ResponseBody | null, init: ResponseInit];
+export type Response = readonly [body: ResponseBody | null, init: ResponseInit];
 /**
  * Checks whether the passed value is the `graphql-http` server agnostic response.
  *
@@ -100,9 +100,9 @@ export declare function isResponse(val: unknown): val is Response;
  *
  * @category Server
  */
-export declare type OperationContext = Record<PropertyKey, unknown> | symbol | number | string | boolean | undefined | null;
+export type OperationContext = Record<PropertyKey, unknown> | symbol | number | string | boolean | undefined | null;
 /** @category Server */
-export declare type OperationArgs<Context extends OperationContext = undefined> = ExecutionArgs & {
+export type OperationArgs<Context extends OperationContext = undefined> = ExecutionArgs & {
     contextValue?: Context;
 };
 /** @category Server */
@@ -150,6 +150,15 @@ export interface HandlerOptions<RequestRaw = unknown, RequestContext = unknown,
      * GraphQL operation AST getter used for detecting the operation type.
      */
     getOperationAST?: typeof graphqlGetOperationAST;
+    /**
+     * The GraphQL root value or resolvers to go alongside the execution.
+     * Learn more about them here: https://graphql.org/learn/execution/#root-fields-resolvers.
+     *
+     * If you return from `onSubscribe`, and the returned value is
+     * missing the `rootValue` field, the relevant operation root
+     * will be used instead.
+     */
+    rootValue?: unknown;
     /**
      * The subscribe callback executed right after processing the request
      * before proceeding with the GraphQL operation execution.
@@ -204,7 +213,7 @@ export interface HandlerOptions<RequestRaw = unknown, RequestContext = unknown,
  *
  * @category Server
  */
-export declare type Handler<RequestRaw = unknown, RequestContext = unknown> = (req: Request<RequestRaw, RequestContext>) => Promise<Response>;
+export type Handler<RequestRaw = unknown, RequestContext = unknown> = (req: Request<RequestRaw, RequestContext>) => Promise<Response>;
 /**
  * Makes a GraphQL over HTTP Protocol compliant server handler. The handler can
  * be used with your favourite server library.
@@ -266,7 +275,7 @@ export declare function createHandler<RequestRaw = unknown, RequestContext = unk
  *
  * @category Server
  */
-export declare type AcceptableMediaType = 'application/graphql-response+json' | 'application/json';
+export type AcceptableMediaType = 'application/graphql-response+json' | 'application/json';
 /**
  * Inspects the request and detects the appropriate/acceptable Media-Type
  * looking at the `Accept` header while complying with the GraphQL over HTTP Protocol.

package/lib/handler.d.ts

@@ -10,7 +10,7 @@ import { RequestParams } from './common';
  *
  * @category Server
  */
-export declare type RequestHeaders = {
+export type RequestHeaders = {
     /**
      * Always an array in Node. Duplicates are added to it.
      * Not necessarily true for other environments.
@@ -54,7 +54,7 @@ export interface Request<Raw, Context> {
  *
  * @category Server
  */
-export declare type ResponseHeaders = {
+export type ResponseHeaders = {
     accept?: string;
     allow?: string;
     'content-type'?: string;
@@ -65,7 +65,7 @@ export declare type ResponseHeaders = {
  *
  * @category Server
  */
-export declare type ResponseBody = string;
+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.
@@ -83,7 +83,7 @@ export interface ResponseInit {
  *
  * @category Server
  */
-export declare type Response = readonly [body: ResponseBody | null, init: ResponseInit];
+export type Response = readonly [body: ResponseBody | null, init: ResponseInit];
 /**
  * Checks whether the passed value is the `graphql-http` server agnostic response.
  *
@@ -100,9 +100,9 @@ export declare function isResponse(val: unknown): val is Response;
  *
  * @category Server
  */
-export declare type OperationContext = Record<PropertyKey, unknown> | symbol | number | string | boolean | undefined | null;
+export type OperationContext = Record<PropertyKey, unknown> | symbol | number | string | boolean | undefined | null;
 /** @category Server */
-export declare type OperationArgs<Context extends OperationContext = undefined> = ExecutionArgs & {
+export type OperationArgs<Context extends OperationContext = undefined> = ExecutionArgs & {
     contextValue?: Context;
 };
 /** @category Server */
@@ -150,6 +150,15 @@ export interface HandlerOptions<RequestRaw = unknown, RequestContext = unknown,
      * GraphQL operation AST getter used for detecting the operation type.
      */
     getOperationAST?: typeof graphqlGetOperationAST;
+    /**
+     * The GraphQL root value or resolvers to go alongside the execution.
+     * Learn more about them here: https://graphql.org/learn/execution/#root-fields-resolvers.
+     *
+     * If you return from `onSubscribe`, and the returned value is
+     * missing the `rootValue` field, the relevant operation root
+     * will be used instead.
+     */
+    rootValue?: unknown;
     /**
      * The subscribe callback executed right after processing the request
      * before proceeding with the GraphQL operation execution.
@@ -204,7 +213,7 @@ export interface HandlerOptions<RequestRaw = unknown, RequestContext = unknown,
  *
  * @category Server
  */
-export declare type Handler<RequestRaw = unknown, RequestContext = unknown> = (req: Request<RequestRaw, RequestContext>) => Promise<Response>;
+export type Handler<RequestRaw = unknown, RequestContext = unknown> = (req: Request<RequestRaw, RequestContext>) => Promise<Response>;
 /**
  * Makes a GraphQL over HTTP Protocol compliant server handler. The handler can
  * be used with your favourite server library.
@@ -266,7 +275,7 @@ export declare function createHandler<RequestRaw = unknown, RequestContext = unk
  *
  * @category Server
  */
-export declare type AcceptableMediaType = 'application/graphql-response+json' | 'application/json';
+export type AcceptableMediaType = 'application/graphql-response+json' | 'application/json';
 /**
  * Inspects the request and detects the appropriate/acceptable Media-Type
  * looking at the `Accept` header while complying with the GraphQL over HTTP Protocol.

package/lib/handler.js

@@ -76,7 +76,7 @@ exports.isResponse = isResponse;
  * @category Server
  */
 function createHandler(options) {
-    const { schema, context, validate = graphql_1.validate, execute = graphql_1.execute, parse = graphql_1.parse, getOperationAST = graphql_1.getOperationAST, onSubscribe, onOperation, } = options;
+    const { schema, context, validate = graphql_1.validate, execute = graphql_1.execute, parse = graphql_1.parse, getOperationAST = graphql_1.getOperationAST, rootValue, onSubscribe, onOperation, } = options;
     return async function handler(req) {
         var _a, _b;
         const method = req.method;
@@ -260,6 +260,9 @@ function createHandler(options) {
                 },
             ];
         }
+        if (!('rootValue' in args)) {
+            args.rootValue = rootValue;
+        }
         if (!('contextValue' in args)) {
             const resOrContext = typeof context === 'function' ? await context(req, params) : context;
             if (isResponse(resOrContext))

package/lib/handler.mjs

@@ -72,7 +72,7 @@ export function isResponse(val) {
  * @category Server
  */
 export function createHandler(options) {
-    const { schema, context, validate = graphqlValidate, execute = graphqlExecute, parse = graphqlParse, getOperationAST = graphqlGetOperationAST, onSubscribe, onOperation, } = options;
+    const { schema, context, validate = graphqlValidate, execute = graphqlExecute, parse = graphqlParse, getOperationAST = graphqlGetOperationAST, rootValue, onSubscribe, onOperation, } = options;
     return async function handler(req) {
         var _a, _b;
         const method = req.method;
@@ -256,6 +256,9 @@ export function createHandler(options) {
                 },
             ];
         }
+        if (!('rootValue' in args)) {
+            args.rootValue = rootValue;
+        }
         if (!('contextValue' in args)) {
             const resOrContext = typeof context === 'function' ? await context(req, params) : context;
             if (isResponse(resOrContext))

package/lib/use/koa.d.mts

@@ -0,0 +1,24 @@
+/// <reference types="node" />
+import type { Middleware } from 'koa';
+import type { IncomingMessage } from 'http';
+import { HandlerOptions, OperationContext } from '../handler';
+/**
+ * Create a GraphQL over HTTP Protocol compliant request handler for
+ * the Koa framework.
+ *
+ * ```js
+ * import Koa from 'koa'; // yarn add koa
+ * import mount from 'koa-mount'; // yarn add koa-mount
+ * import { createHandler } from 'graphql-http/lib/use/koa';
+ * import { schema } from './my-graphql-schema';
+ *
+ * const app = new Koa();
+ * app.use(mount('/', createHandler({ schema })));
+ *
+ * app.listen({ port: 4000 });
+ * console.log('Listening to port 4000');
+ * ```
+ *
+ * @category Server/koa
+ */
+export declare function createHandler<Context extends OperationContext = undefined>(options: HandlerOptions<IncomingMessage, undefined, Context>): Middleware;

package/lib/use/koa.d.ts

@@ -0,0 +1,24 @@
+/// <reference types="node" />
+import type { Middleware } from 'koa';
+import type { IncomingMessage } from 'http';
+import { HandlerOptions, OperationContext } from '../handler';
+/**
+ * Create a GraphQL over HTTP Protocol compliant request handler for
+ * the Koa framework.
+ *
+ * ```js
+ * import Koa from 'koa'; // yarn add koa
+ * import mount from 'koa-mount'; // yarn add koa-mount
+ * import { createHandler } from 'graphql-http/lib/use/koa';
+ * import { schema } from './my-graphql-schema';
+ *
+ * const app = new Koa();
+ * app.use(mount('/', createHandler({ schema })));
+ *
+ * app.listen({ port: 4000 });
+ * console.log('Listening to port 4000');
+ * ```
+ *
+ * @category Server/koa
+ */
+export declare function createHandler<Context extends OperationContext = undefined>(options: HandlerOptions<IncomingMessage, undefined, Context>): Middleware;

package/lib/use/koa.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createHandler = void 0;
+const handler_1 = require("../handler");
+/**
+ * Create a GraphQL over HTTP Protocol compliant request handler for
+ * the Koa framework.
+ *
+ * ```js
+ * import Koa from 'koa'; // yarn add koa
+ * import mount from 'koa-mount'; // yarn add koa-mount
+ * import { createHandler } from 'graphql-http/lib/use/koa';
+ * import { schema } from './my-graphql-schema';
+ *
+ * const app = new Koa();
+ * app.use(mount('/', createHandler({ schema })));
+ *
+ * app.listen({ port: 4000 });
+ * console.log('Listening to port 4000');
+ * ```
+ *
+ * @category Server/koa
+ */
+function createHandler(options) {
+    const isProd = process.env.NODE_ENV === 'production';
+    const handle = (0, handler_1.createHandler)(options);
+    return async function requestListener(ctx) {
+        try {
+            const [body, init] = await handle({
+                url: ctx.url,
+                method: ctx.method,
+                headers: ctx.headers,
+                body: () => {
+                    if (ctx.body) {
+                        // in case koa has a body parser
+                        return ctx.body;
+                    }
+                    return new Promise((resolve) => {
+                        let body = '';
+                        ctx.req.on('data', (chunk) => (body += chunk));
+                        ctx.req.on('end', () => resolve(body));
+                    });
+                },
+                raw: ctx.req,
+                context: undefined,
+            });
+            ctx.body = body;
+            ctx.response.status = init.status;
+            ctx.response.message = init.statusText;
+            if (init.headers) {
+                for (const [name, value] of Object.entries(init.headers)) {
+                    ctx.response.set(name, value);
+                }
+            }
+        }
+        catch (err) {
+            // The handler shouldnt throw errors.
+            // If you wish to handle them differently, consider implementing your own request handler.
+            console.error('Internal error occurred during request handling. ' +
+                'Please check your implementation.', err);
+            ctx.response.status = 500;
+            if (!isProd) {
+                ctx.response.set('content-type', 'application/json; charset=utf-8');
+                ctx.body = {
+                    errors: [
+                        err instanceof Error
+                            ? {
+                                message: err.message,
+                                stack: err.stack,
+                            }
+                            : err,
+                    ],
+                };
+            }
+        }
+    };
+}
+exports.createHandler = createHandler;

package/lib/use/koa.mjs

@@ -0,0 +1,74 @@
+import { createHandler as createRawHandler, } from '../handler.mjs';
+/**
+ * Create a GraphQL over HTTP Protocol compliant request handler for
+ * the Koa framework.
+ *
+ * ```js
+ * import Koa from 'koa'; // yarn add koa
+ * import mount from 'koa-mount'; // yarn add koa-mount
+ * import { createHandler } from 'graphql-http/lib/use/koa';
+ * import { schema } from './my-graphql-schema/index.mjs';
+ *
+ * const app = new Koa();
+ * app.use(mount('/', createHandler({ schema })));
+ *
+ * app.listen({ port: 4000 });
+ * console.log('Listening to port 4000');
+ * ```
+ *
+ * @category Server/koa
+ */
+export function createHandler(options) {
+    const isProd = process.env.NODE_ENV === 'production';
+    const handle = createRawHandler(options);
+    return async function requestListener(ctx) {
+        try {
+            const [body, init] = await handle({
+                url: ctx.url,
+                method: ctx.method,
+                headers: ctx.headers,
+                body: () => {
+                    if (ctx.body) {
+                        // in case koa has a body parser
+                        return ctx.body;
+                    }
+                    return new Promise((resolve) => {
+                        let body = '';
+                        ctx.req.on('data', (chunk) => (body += chunk));
+                        ctx.req.on('end', () => resolve(body));
+                    });
+                },
+                raw: ctx.req,
+                context: undefined,
+            });
+            ctx.body = body;
+            ctx.response.status = init.status;
+            ctx.response.message = init.statusText;
+            if (init.headers) {
+                for (const [name, value] of Object.entries(init.headers)) {
+                    ctx.response.set(name, value);
+                }
+            }
+        }
+        catch (err) {
+            // The handler shouldnt throw errors.
+            // If you wish to handle them differently, consider implementing your own request handler.
+            console.error('Internal error occurred during request handling. ' +
+                'Please check your implementation.', err);
+            ctx.response.status = 500;
+            if (!isProd) {
+                ctx.response.set('content-type', 'application/json; charset=utf-8');
+                ctx.body = {
+                    errors: [
+                        err instanceof Error
+                            ? {
+                                message: err.message,
+                                stack: err.stack,
+                            }
+                            : err,
+                    ],
+                };
+            }
+        }
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graphql-http",
-  "version": "1.9.0",
+  "version": "1.11.0",
   "description": "Simple, pluggable, zero-dependency, GraphQL over HTTP Protocol compliant server and client",
   "keywords": [
     "graphql",
@@ -24,7 +24,7 @@
   "engines": {
     "node": ">=12"
   },
-  "packageManager": "yarn@3.2.4",
+  "packageManager": "yarn@3.3.1",
   "main": "lib/index.js",
   "module": "lib/index.mjs",
   "browser": "umd/graphql-http.js",
@@ -55,6 +55,11 @@
       "require": "./lib/use/fastify.js",
       "import": "./lib/use/fastify.mjs"
     },
+    "./lib/use/koa": {
+      "types": "./lib/use/koa.d.ts",
+      "require": "./lib/use/koa.js",
+      "import": "./lib/use/koa.mjs"
+    },
     "./package.json": "./package.json"
   },
   "types": "lib/index.d.ts",
@@ -72,12 +77,14 @@
   },
   "scripts": {
     "gendocs": "typedoc --options typedoc.js src/",
-    "lint": "eslint 'src'",
+    "lint:eslint": "eslint 'src'",
+    "lint:prettier": "prettier -c .",
+    "lint": "yarn lint:eslint && yarn lint:prettier",
     "type-check": "tsc --noEmit",
     "test": "NODE_OPTIONS=--experimental-vm-modules jest",
     "build:esm": "tsc -b tsconfig.esm.json && node scripts/esm-post-process.mjs",
     "build:cjs": "tsc -b tsconfig.cjs.json",
-    "build:umd": "rollup -c && gzip umd/graphql-http.min.js -c > umd/graphql-http.min.js.gz",
+    "build:umd": "rollup --bundleConfigAsCjs --config rollup.config.ts --configPlugin typescript && gzip umd/graphql-http.min.js -c > umd/graphql-http.min.js.gz",
     "build": "yarn build:esm && yarn build:cjs && yarn build:umd",
     "release": "semantic-release"
   },
@@ -88,39 +95,44 @@
     "graphql": ">=0.11 <=16"
   },
   "devDependencies": {
-    "@babel/core": "^7.20.2",
+    "@babel/core": "^7.20.7",
     "@babel/plugin-proposal-class-properties": "^7.18.6",
     "@babel/plugin-proposal-nullish-coalescing-operator": "^7.18.6",
-    "@babel/plugin-proposal-object-rest-spread": "^7.20.2",
-    "@babel/plugin-proposal-optional-chaining": "^7.18.9",
+    "@babel/plugin-proposal-object-rest-spread": "^7.20.7",
+    "@babel/plugin-proposal-optional-chaining": "^7.20.7",
     "@babel/preset-env": "^7.20.2",
     "@babel/preset-typescript": "^7.18.6",
-    "@rollup/plugin-typescript": "^9.0.2",
-    "@semantic-release/changelog": "^6.0.1",
+    "@rollup/plugin-terser": "^0.2.1",
+    "@rollup/plugin-typescript": "^10.0.1",
+    "@semantic-release/changelog": "^6.0.2",
     "@semantic-release/git": "^10.0.1",
-    "@types/express": "^4.17.14",
-    "@types/jest": "^29.2.2",
-    "@typescript-eslint/eslint-plugin": "^5.42.1",
-    "@typescript-eslint/parser": "^5.42.1",
-    "@whatwg-node/fetch": "^0.5.1",
-    "babel-jest": "^29.3.0",
-    "eslint": "^8.27.0",
+    "@types/eslint": "^8.4.10",
+    "@types/express": "^4.17.15",
+    "@types/glob": "^8.0.0",
+    "@types/jest": "^29.2.4",
+    "@types/koa": "^2.13.5",
+    "@types/koa-mount": "^4.0.2",
+    "@typescript-eslint/eslint-plugin": "^5.47.0",
+    "@typescript-eslint/parser": "^5.47.0",
+    "@whatwg-node/fetch": "^0.5.3",
+    "babel-jest": "^29.3.1",
+    "eslint": "^8.30.0",
     "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-prettier": "^4.2.1",
     "express": "^4.18.2",
-    "fastify": "^4.9.2",
+    "fastify": "^4.10.2",
     "graphql": "^16.6.0",
-    "jest": "^29.3.0",
-    "jest-jasmine2": "^29.3.0",
-    "node-fetch": "^3.2.10",
-    "prettier": "^2.7.1",
-    "rollup": "^3.2.5",
-    "rollup-plugin-terser": "^7.0.2",
+    "jest": "^29.3.1",
+    "jest-jasmine2": "^29.3.1",
+    "koa": "^2.14.1",
+    "koa-mount": "^4.0.0",
+    "node-fetch": "^3.3.0",
+    "prettier": "^2.8.1",
+    "rollup": "^3.8.1",
     "semantic-release": "^19.0.5",
     "tslib": "^2.4.1",
-    "typedoc": "^0.23.20",
-    "typedoc-plugin-markdown": "^3.13.6",
-    "typescript": "^4.8.4"
+    "typedoc": "^0.23.23",
+    "typedoc-plugin-markdown": "^3.14.0",
+    "typescript": "^4.9.4"
   },
   "resolutions": {
     "npm/libnpmversion": "^3.0.6"