graphql-http 1.10.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/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.10.0",
+  "version": "1.11.0",
   "description": "Simple, pluggable, zero-dependency, GraphQL over HTTP Protocol compliant server and client",
   "keywords": [
     "graphql",
@@ -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",
@@ -105,6 +110,8 @@
     "@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",
@@ -116,6 +123,8 @@
     "graphql": "^16.6.0",
     "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",