graphql-http 1.10.0 → 1.12.0

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/lib/utils.d.mts

@@ -3,7 +3,8 @@
  * utils
  *
  */
-import type { ExecutionResult, GraphQLError } from 'graphql';
+import type { ExecutionResult } from 'graphql';
+import { GraphQLError } from 'graphql';
 /** @private */
 export declare function extendedTypeof(val: unknown): 'string' | 'number' | 'bigint' | 'boolean' | 'symbol' | 'undefined' | 'object' | 'function' | 'array' | 'null';
 /** @private */
@@ -11,6 +12,8 @@ export declare function isObject(val: unknown): val is Record<PropertyKey, any>;
 /** @private */
 export declare function areGraphQLErrors(obj: unknown): obj is readonly GraphQLError[];
 /** @private */
+export declare function isGraphQLError(obj: unknown): obj is GraphQLError;
+/** @private */
 export declare function isExecutionResult(val: unknown): val is ExecutionResult;
 /** @private */
 export declare function isAsyncIterable<T = unknown>(val: unknown): val is AsyncIterable<T>;

package/lib/utils.d.ts

@@ -3,7 +3,8 @@
  * utils
  *
  */
-import type { ExecutionResult, GraphQLError } from 'graphql';
+import type { ExecutionResult } from 'graphql';
+import { GraphQLError } from 'graphql';
 /** @private */
 export declare function extendedTypeof(val: unknown): 'string' | 'number' | 'bigint' | 'boolean' | 'symbol' | 'undefined' | 'object' | 'function' | 'array' | 'null';
 /** @private */
@@ -11,6 +12,8 @@ export declare function isObject(val: unknown): val is Record<PropertyKey, any>;
 /** @private */
 export declare function areGraphQLErrors(obj: unknown): obj is readonly GraphQLError[];
 /** @private */
+export declare function isGraphQLError(obj: unknown): obj is GraphQLError;
+/** @private */
 export declare function isExecutionResult(val: unknown): val is ExecutionResult;
 /** @private */
 export declare function isAsyncIterable<T = unknown>(val: unknown): val is AsyncIterable<T>;

package/lib/utils.js

@@ -5,7 +5,8 @@
  *
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isAsyncIterable = exports.isExecutionResult = exports.areGraphQLErrors = exports.isObject = exports.extendedTypeof = void 0;
+exports.isAsyncIterable = exports.isExecutionResult = exports.isGraphQLError = exports.areGraphQLErrors = exports.isObject = exports.extendedTypeof = void 0;
+const graphql_1 = require("graphql");
 /** @private */
 function extendedTypeof(val) {
     if (val === null) {
@@ -25,13 +26,17 @@ exports.isObject = isObject;
 /** @private */
 function areGraphQLErrors(obj) {
     return (Array.isArray(obj) &&
-        // must be at least one error
         obj.length > 0 &&
-        // error has at least a message
-        obj.every((ob) => 'message' in ob));
+        // if one item in the array is a GraphQLError, we're good
+        obj.some(isGraphQLError));
 }
 exports.areGraphQLErrors = areGraphQLErrors;
 /** @private */
+function isGraphQLError(obj) {
+    return obj instanceof graphql_1.GraphQLError;
+}
+exports.isGraphQLError = isGraphQLError;
+/** @private */
 function isExecutionResult(val) {
     return (isObject(val) &&
         ('data' in val || ('data' in val && val.data == null && 'errors' in val)));

package/lib/utils.mjs

@@ -3,6 +3,7 @@
  * utils
  *
  */
+import { GraphQLError } from 'graphql';
 /** @private */
 export function extendedTypeof(val) {
     if (val === null) {
@@ -20,10 +21,13 @@ export function isObject(val) {
 /** @private */
 export function areGraphQLErrors(obj) {
     return (Array.isArray(obj) &&
-        // must be at least one error
         obj.length > 0 &&
-        // error has at least a message
-        obj.every((ob) => 'message' in ob));
+        // if one item in the array is a GraphQLError, we're good
+        obj.some(isGraphQLError));
+}
+/** @private */
+export function isGraphQLError(obj) {
+    return obj instanceof GraphQLError;
 }
 /** @private */
 export function isExecutionResult(val) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graphql-http",
-  "version": "1.10.0",
+  "version": "1.12.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",
@@ -90,38 +95,42 @@
     "graphql": ">=0.11 <=16"
   },
   "devDependencies": {
-    "@babel/core": "^7.20.7",
+    "@babel/core": "^7.20.12",
     "@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.7",
     "@babel/plugin-proposal-optional-chaining": "^7.20.7",
     "@babel/preset-env": "^7.20.2",
     "@babel/preset-typescript": "^7.18.6",
-    "@rollup/plugin-terser": "^0.2.1",
-    "@rollup/plugin-typescript": "^10.0.1",
+    "@rollup/plugin-terser": "^0.3.0",
+    "@rollup/plugin-typescript": "^11.0.0",
     "@semantic-release/changelog": "^6.0.2",
     "@semantic-release/git": "^10.0.1",
     "@types/eslint": "^8.4.10",
     "@types/express": "^4.17.15",
-    "@types/glob": "^8.0.0",
-    "@types/jest": "^29.2.4",
-    "@typescript-eslint/eslint-plugin": "^5.47.0",
-    "@typescript-eslint/parser": "^5.47.0",
-    "@whatwg-node/fetch": "^0.5.3",
+    "@types/glob": "^8.0.1",
+    "@types/jest": "^29.2.6",
+    "@types/koa": "^2.13.5",
+    "@types/koa-mount": "^4.0.2",
+    "@typescript-eslint/eslint-plugin": "^5.48.2",
+    "@typescript-eslint/parser": "^5.48.2",
+    "@whatwg-node/fetch": "^0.6.2",
     "babel-jest": "^29.3.1",
-    "eslint": "^8.30.0",
-    "eslint-config-prettier": "^8.5.0",
+    "eslint": "^8.32.0",
+    "eslint-config-prettier": "^8.6.0",
     "express": "^4.18.2",
-    "fastify": "^4.10.2",
+    "fastify": "^4.11.0",
     "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",
-    "semantic-release": "^19.0.5",
+    "prettier": "^2.8.3",
+    "rollup": "^3.10.0",
+    "semantic-release": "^20.0.2",
     "tslib": "^2.4.1",
-    "typedoc": "^0.23.23",
+    "typedoc": "^0.23.24",
     "typedoc-plugin-markdown": "^3.14.0",
     "typescript": "^4.9.4"
   },

package/umd/graphql-http.js

@@ -1,6 +1,6 @@
 (function (global, factory) {
-    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports) :
-    typeof define === 'function' && define.amd ? define(['exports'], factory) :
+    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('graphql')) :
+    typeof define === 'function' && define.amd ? define(['exports', 'graphql'], factory) :
     (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.graphqlHttp = {}));
 })(this, (function (exports) { 'use strict';
 

package/umd/graphql-http.min.js

@@ -1 +1 @@
-!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports):"function"==typeof define&&define.amd?define(["exports"],t):t((e="undefined"!=typeof globalThis?globalThis:e||self).graphqlHttp={})}(this,(function(e){"use strict";class t extends Error{constructor(e){let t,r;var o;(function(e){return"object"==typeof e&&null!==e})(o=e)&&"boolean"==typeof o.ok&&"number"==typeof o.status&&"string"==typeof o.statusText?(r=e,t="Server responded with "+e.status+": "+e.statusText):t=e instanceof Error?e.message:String(e),super(t),this.name=this.constructor.name,this.response=r}}e.NetworkError=t,e.createClient=function(e){const{credentials:r="same-origin",referrer:o,referrerPolicy:n,shouldRetry:s=(()=>!1)}=e,i=e.fetchFn||fetch,a=e.abortControllerImpl||AbortController,c=(()=>{let e=!1;const t=[];return{get disposed(){return e},onDispose:r=>e?(setTimeout((()=>r()),0),()=>{}):(t.push(r),()=>{t.splice(t.indexOf(r),1)}),dispose(){if(!e){e=!0;for(const e of[...t])e()}}}})();return{subscribe(p,l){if(c.disposed)throw new Error("Client has been disposed");const f=new a,u=c.onDispose((()=>{u(),f.abort()}));return(async()=>{var a;let c=null,u=0;for(;;){if(c){const e=await s(c,u);if(f.signal.aborted)return;if(!e)throw c;u++}try{const s="function"==typeof e.url?await e.url(p):e.url;if(f.signal.aborted)return;const c="function"==typeof e.headers?await e.headers():null!==(a=e.headers)&&void 0!==a?a:{};if(f.signal.aborted)return;let u;try{u=await i(s,{signal:f.signal,method:"POST",headers:Object.assign(Object.assign({},c),{"content-type":"application/json; charset=utf-8",accept:"application/graphql-response+json, application/json"}),credentials:r,referrer:o,referrerPolicy:n,body:JSON.stringify(p)})}catch(e){throw new t(e)}if(!u.ok)throw new t(u);if(!u.body)throw new Error("Missing response body");const d=u.headers.get("content-type");if(!d)throw new Error("Missing response content-type");if(!d.includes("application/graphql-response+json")&&!d.includes("application/json"))throw new Error(`Unsupported response content-type ${d}`);const h=await u.json();return l.next(h),f.abort()}catch(e){if(f.signal.aborted)return;if(!(e instanceof t))throw e;c=e}}})().then((()=>l.complete())).catch((e=>l.error(e))),()=>f.abort()},dispose(){c.dispose()}}}}));
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports,require("graphql")):"function"==typeof define&&define.amd?define(["exports","graphql"],t):t((e="undefined"!=typeof globalThis?globalThis:e||self).graphqlHttp={})}(this,(function(e){"use strict";class t extends Error{constructor(e){let t,r;var o;(function(e){return"object"==typeof e&&null!==e})(o=e)&&"boolean"==typeof o.ok&&"number"==typeof o.status&&"string"==typeof o.statusText?(r=e,t="Server responded with "+e.status+": "+e.statusText):t=e instanceof Error?e.message:String(e),super(t),this.name=this.constructor.name,this.response=r}}e.NetworkError=t,e.createClient=function(e){const{credentials:r="same-origin",referrer:o,referrerPolicy:n,shouldRetry:s=(()=>!1)}=e,i=e.fetchFn||fetch,a=e.abortControllerImpl||AbortController,c=(()=>{let e=!1;const t=[];return{get disposed(){return e},onDispose:r=>e?(setTimeout((()=>r()),0),()=>{}):(t.push(r),()=>{t.splice(t.indexOf(r),1)}),dispose(){if(!e){e=!0;for(const e of[...t])e()}}}})();return{subscribe(p,l){if(c.disposed)throw new Error("Client has been disposed");const f=new a,u=c.onDispose((()=>{u(),f.abort()}));return(async()=>{var a;let c=null,u=0;for(;;){if(c){const e=await s(c,u);if(f.signal.aborted)return;if(!e)throw c;u++}try{const s="function"==typeof e.url?await e.url(p):e.url;if(f.signal.aborted)return;const c="function"==typeof e.headers?await e.headers():null!==(a=e.headers)&&void 0!==a?a:{};if(f.signal.aborted)return;let u;try{u=await i(s,{signal:f.signal,method:"POST",headers:Object.assign(Object.assign({},c),{"content-type":"application/json; charset=utf-8",accept:"application/graphql-response+json, application/json"}),credentials:r,referrer:o,referrerPolicy:n,body:JSON.stringify(p)})}catch(e){throw new t(e)}if(!u.ok)throw new t(u);if(!u.body)throw new Error("Missing response body");const d=u.headers.get("content-type");if(!d)throw new Error("Missing response content-type");if(!d.includes("application/graphql-response+json")&&!d.includes("application/json"))throw new Error(`Unsupported response content-type ${d}`);const h=await u.json();return l.next(h),f.abort()}catch(e){if(f.signal.aborted)return;if(!(e instanceof t))throw e;c=e}}})().then((()=>l.complete())).catch((e=>l.error(e))),()=>f.abort()},dispose(){c.dispose()}}}}));