graphql-http 1.17.1 → 1.19.0

package/lib/use/node.d.ts

@@ -16,7 +16,7 @@ export type HandlerOptions<Context extends OperationContext = undefined> = HttpH
  * ```js
  * import http from 'http';
  * import { createHandler } from 'graphql-http/lib/use/node';
- * import { schema } from './my-graphql-step';
+ * import { schema } from './my-graphql-schema';
  *
  * const server = http.createServer(createHandler({ schema }));
  *

package/lib/use/node.js

@@ -9,7 +9,7 @@ const http_1 = require("./http");
  * ```js
  * import http from 'http';
  * import { createHandler } from 'graphql-http/lib/use/node';
- * import { schema } from './my-graphql-step';
+ * import { schema } from './my-graphql-schema';
  *
  * const server = http.createServer(createHandler({ schema }));
  *

package/lib/use/node.mjs

@@ -6,7 +6,7 @@ import { createHandler as httpCreateHandler, } from './http.mjs';
  * ```js
  * import http from 'http';
  * import { createHandler } from 'graphql-http/lib/use/node';
- * import { schema } from './my-graphql-step/index.mjs';
+ * import { schema } from './my-graphql-schema/index.mjs';
  *
  * const server = http.createServer(createHandler({ schema }));
  *

package/lib/use/uWebSockets.d.mts

@@ -0,0 +1,36 @@
+import type { HttpRequest, HttpResponse } from 'uWebSockets.js';
+import { HandlerOptions as RawHandlerOptions, OperationContext } from '../handler.mjs';
+/**
+ * The context in the request for the handler.
+ *
+ * @category Server/uWebSockets
+ */
+export interface RequestContext {
+    res: HttpResponse;
+}
+/**
+ * Handler options when using the http adapter.
+ *
+ * @category Server/uWebSockets
+ */
+export type HandlerOptions<Context extends OperationContext = undefined> = RawHandlerOptions<HttpRequest, RequestContext, Context>;
+/**
+ * Create a GraphQL over HTTP spec compliant request handler for
+ * the Node environment [uWebSockets.js module](https://github.com/uNetworking/uWebSockets.js/).
+ *
+ * ```js
+ * import uWS from 'uWebSockets.js'; // yarn add uWebSockets.js@uNetworking/uWebSockets.js#<version>
+ * import { createHandler } from 'graphql-http/lib/use/uWebSockets';
+ * import { schema } from './my-graphql-schema/index.mjs';
+ *
+ * uWS
+ *   .App()
+ *   .any('/graphql', createHandler({ schema }))
+ *   .listen(4000, () => {
+ *     console.log('Listening to port 4000');
+ *   });
+ * ```
+ *
+ * @category Server/uWebSockets
+ */
+export declare function createHandler<Context extends OperationContext = undefined>(options: HandlerOptions<Context>): (res: HttpResponse, req: HttpRequest) => Promise<void>;

package/lib/use/uWebSockets.d.ts

@@ -0,0 +1,36 @@
+import type { HttpRequest, HttpResponse } from 'uWebSockets.js';
+import { HandlerOptions as RawHandlerOptions, OperationContext } from '../handler';
+/**
+ * The context in the request for the handler.
+ *
+ * @category Server/uWebSockets
+ */
+export interface RequestContext {
+    res: HttpResponse;
+}
+/**
+ * Handler options when using the http adapter.
+ *
+ * @category Server/uWebSockets
+ */
+export type HandlerOptions<Context extends OperationContext = undefined> = RawHandlerOptions<HttpRequest, RequestContext, Context>;
+/**
+ * Create a GraphQL over HTTP spec compliant request handler for
+ * the Node environment [uWebSockets.js module](https://github.com/uNetworking/uWebSockets.js/).
+ *
+ * ```js
+ * import uWS from 'uWebSockets.js'; // yarn add uWebSockets.js@uNetworking/uWebSockets.js#<version>
+ * import { createHandler } from 'graphql-http/lib/use/uWebSockets';
+ * import { schema } from './my-graphql-schema';
+ *
+ * uWS
+ *   .App()
+ *   .any('/graphql', createHandler({ schema }))
+ *   .listen(4000, () => {
+ *     console.log('Listening to port 4000');
+ *   });
+ * ```
+ *
+ * @category Server/uWebSockets
+ */
+export declare function createHandler<Context extends OperationContext = undefined>(options: HandlerOptions<Context>): (res: HttpResponse, req: HttpRequest) => Promise<void>;

package/lib/use/uWebSockets.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createHandler = void 0;
+const handler_1 = require("../handler");
+/**
+ * Create a GraphQL over HTTP spec compliant request handler for
+ * the Node environment [uWebSockets.js module](https://github.com/uNetworking/uWebSockets.js/).
+ *
+ * ```js
+ * import uWS from 'uWebSockets.js'; // yarn add uWebSockets.js@uNetworking/uWebSockets.js#<version>
+ * import { createHandler } from 'graphql-http/lib/use/uWebSockets';
+ * import { schema } from './my-graphql-schema';
+ *
+ * uWS
+ *   .App()
+ *   .any('/graphql', createHandler({ schema }))
+ *   .listen(4000, () => {
+ *     console.log('Listening to port 4000');
+ *   });
+ * ```
+ *
+ * @category Server/uWebSockets
+ */
+function createHandler(options) {
+    const handle = (0, handler_1.createHandler)(options);
+    return async function requestListener(res, req) {
+        let aborted = false;
+        res.onAborted(() => (aborted = true));
+        try {
+            let url = req.getUrl();
+            const query = req.getQuery();
+            if (query) {
+                url += '?' + query;
+            }
+            const [body, init] = await handle({
+                url,
+                method: req.getMethod().toUpperCase(),
+                headers: { get: (key) => req.getHeader(key) },
+                body: () => new Promise((resolve) => {
+                    let body = '';
+                    if (aborted) {
+                        resolve(body);
+                    }
+                    else {
+                        res.onData((chunk, isLast) => {
+                            body += Buffer.from(chunk, 0, chunk.byteLength).toString();
+                            if (isLast) {
+                                resolve(body);
+                            }
+                        });
+                    }
+                }),
+                raw: req,
+                context: { res },
+            });
+            if (!aborted) {
+                res.cork(() => {
+                    res.writeStatus(`${init.status} ${init.statusText}`);
+                    for (const [key, val] of Object.entries(init.headers || {})) {
+                        res.writeHeader(key, val);
+                    }
+                    if (body) {
+                        res.end(body);
+                    }
+                    else {
+                        res.endWithoutBody();
+                    }
+                });
+            }
+        }
+        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);
+            if (!aborted) {
+                res.cork(() => {
+                    res.writeStatus('500 Internal Server Error').endWithoutBody();
+                });
+            }
+        }
+    };
+}
+exports.createHandler = createHandler;

package/lib/use/uWebSockets.mjs

@@ -0,0 +1,80 @@
+import { createHandler as createRawHandler, } from '../handler.mjs';
+/**
+ * Create a GraphQL over HTTP spec compliant request handler for
+ * the Node environment [uWebSockets.js module](https://github.com/uNetworking/uWebSockets.js/).
+ *
+ * ```js
+ * import uWS from 'uWebSockets.js'; // yarn add uWebSockets.js@uNetworking/uWebSockets.js#<version>
+ * import { createHandler } from 'graphql-http/lib/use/uWebSockets';
+ * import { schema } from './my-graphql-schema/index.mjs';
+ *
+ * uWS
+ *   .App()
+ *   .any('/graphql', createHandler({ schema }))
+ *   .listen(4000, () => {
+ *     console.log('Listening to port 4000');
+ *   });
+ * ```
+ *
+ * @category Server/uWebSockets
+ */
+export function createHandler(options) {
+    const handle = createRawHandler(options);
+    return async function requestListener(res, req) {
+        let aborted = false;
+        res.onAborted(() => (aborted = true));
+        try {
+            let url = req.getUrl();
+            const query = req.getQuery();
+            if (query) {
+                url += '?' + query;
+            }
+            const [body, init] = await handle({
+                url,
+                method: req.getMethod().toUpperCase(),
+                headers: { get: (key) => req.getHeader(key) },
+                body: () => new Promise((resolve) => {
+                    let body = '';
+                    if (aborted) {
+                        resolve(body);
+                    }
+                    else {
+                        res.onData((chunk, isLast) => {
+                            body += Buffer.from(chunk, 0, chunk.byteLength).toString();
+                            if (isLast) {
+                                resolve(body);
+                            }
+                        });
+                    }
+                }),
+                raw: req,
+                context: { res },
+            });
+            if (!aborted) {
+                res.cork(() => {
+                    res.writeStatus(`${init.status} ${init.statusText}`);
+                    for (const [key, val] of Object.entries(init.headers || {})) {
+                        res.writeHeader(key, val);
+                    }
+                    if (body) {
+                        res.end(body);
+                    }
+                    else {
+                        res.endWithoutBody();
+                    }
+                });
+            }
+        }
+        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);
+            if (!aborted) {
+                res.cork(() => {
+                    res.writeStatus('500 Internal Server Error').endWithoutBody();
+                });
+            }
+        }
+    };
+}

package/lib/utils.d.mts

@@ -17,3 +17,5 @@ export declare function isGraphQLError(obj: unknown): obj is GraphQLError;
 export declare function isExecutionResult(val: unknown): val is ExecutionResult;
 /** @private */
 export declare function isAsyncIterable<T = unknown>(val: unknown): val is AsyncIterable<T>;
+/** @private */
+export declare function jsonErrorReplacer(_key: string, val: any): any;

package/lib/utils.d.ts

@@ -17,3 +17,5 @@ export declare function isGraphQLError(obj: unknown): obj is GraphQLError;
 export declare function isExecutionResult(val: unknown): val is ExecutionResult;
 /** @private */
 export declare function isAsyncIterable<T = unknown>(val: unknown): val is AsyncIterable<T>;
+/** @private */
+export declare function jsonErrorReplacer(_key: string, val: any): any;

package/lib/utils.js

@@ -5,7 +5,7 @@
  *
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isAsyncIterable = exports.isExecutionResult = exports.isGraphQLError = exports.areGraphQLErrors = exports.isObject = exports.extendedTypeof = void 0;
+exports.jsonErrorReplacer = exports.isAsyncIterable = exports.isExecutionResult = exports.isGraphQLError = exports.areGraphQLErrors = exports.isObject = exports.extendedTypeof = void 0;
 const graphql_1 = require("graphql");
 /** @private */
 function extendedTypeof(val) {
@@ -47,3 +47,17 @@ function isAsyncIterable(val) {
     return typeof Object(val)[Symbol.asyncIterator] === 'function';
 }
 exports.isAsyncIterable = isAsyncIterable;
+/** @private */
+function jsonErrorReplacer(_key, val) {
+    if (val instanceof Error &&
+        // GraphQL errors implement their own stringer
+        !isGraphQLError(val)) {
+        return {
+            // name: val.name, name is included in message
+            message: val.message,
+            // stack: val.stack, can leak sensitive details
+        };
+    }
+    return val;
+}
+exports.jsonErrorReplacer = jsonErrorReplacer;

package/lib/utils.mjs

@@ -38,3 +38,16 @@ export function isExecutionResult(val) {
 export function isAsyncIterable(val) {
     return typeof Object(val)[Symbol.asyncIterator] === 'function';
 }
+/** @private */
+export function jsonErrorReplacer(_key, val) {
+    if (val instanceof Error &&
+        // GraphQL errors implement their own stringer
+        !isGraphQLError(val)) {
+        return {
+            // name: val.name, name is included in message
+            message: val.message,
+            // stack: val.stack, can leak sensitive details
+        };
+    }
+    return val;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graphql-http",
-  "version": "1.17.1",
+  "version": "1.19.0",
   "description": "Simple, pluggable, zero-dependency, GraphQL over HTTP spec compliant server, client and audit suite.",
   "keywords": [
     "graphql",
@@ -24,7 +24,7 @@
   "engines": {
     "node": ">=12"
   },
-  "packageManager": "yarn@3.5.0",
+  "packageManager": "yarn@3.6.0",
   "main": "lib/index.js",
   "module": "lib/index.mjs",
   "browser": "umd/graphql-http.js",
@@ -70,6 +70,11 @@
       "require": "./lib/use/koa.js",
       "import": "./lib/use/koa.mjs"
     },
+    "./lib/use/uWebSockets": {
+      "types": "./lib/use/uWebSockets.d.ts",
+      "require": "./lib/use/uWebSockets.js",
+      "import": "./lib/use/uWebSockets.mjs"
+    },
     "./package.json": "./package.json"
   },
   "types": "lib/index.d.ts",
@@ -106,49 +111,49 @@
     "graphql": ">=0.11 <=16"
   },
   "devDependencies": {
-    "@babel/core": "^7.21.4",
+    "@babel/core": "^7.22.1",
     "@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.21.0",
-    "@babel/preset-env": "^7.21.4",
-    "@babel/preset-typescript": "^7.21.4",
-    "@rollup/plugin-terser": "^0.4.0",
-    "@rollup/plugin-typescript": "^11.0.0",
+    "@babel/preset-env": "^7.22.4",
+    "@babel/preset-typescript": "^7.21.5",
+    "@rollup/plugin-terser": "^0.4.3",
+    "@rollup/plugin-typescript": "^11.1.1",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
-    "@types/eslint": "^8.37.0",
+    "@types/eslint": "^8.40.0",
     "@types/express": "^4.17.17",
     "@types/glob": "^8.1.0",
     "@types/html-validator": "^5.0.3",
-    "@types/jest": "^29.5.0",
+    "@types/jest": "^29.5.2",
+    "@types/k6": "^0.44.2",
     "@types/koa": "^2.13.6",
     "@types/koa-mount": "^4.0.2",
-    "@typescript-eslint/eslint-plugin": "^5.57.0",
-    "@typescript-eslint/parser": "^5.57.0",
-    "@whatwg-node/fetch": "^0.8.4",
+    "@typescript-eslint/eslint-plugin": "^5.59.8",
+    "@typescript-eslint/parser": "^5.59.8",
+    "@whatwg-node/fetch": "^0.9.2",
     "babel-jest": "^29.5.0",
-    "eslint": "^8.37.0",
+    "eslint": "^8.42.0",
     "eslint-config-prettier": "^8.8.0",
     "express": "^4.18.2",
-    "fastify": "^4.15.0",
+    "fastify": "^4.17.0",
+    "glob": "^10.2.6",
     "graphql": "^16.6.0",
     "html-validator": "^6.0.1",
     "jest": "^29.5.0",
     "jest-jasmine2": "^29.5.0",
-    "koa": "^2.14.1",
+    "koa": "^2.14.2",
     "koa-mount": "^4.0.0",
     "node-fetch": "^3.3.1",
-    "prettier": "^2.8.7",
-    "rollup": "^3.20.2",
+    "prettier": "^2.8.8",
+    "rollup": "^3.23.1",
     "rollup-plugin-gzip": "^3.1.0",
-    "semantic-release": "^21.0.0",
-    "tslib": "^2.5.0",
-    "typedoc": "^0.23.28",
-    "typedoc-plugin-markdown": "^3.14.0",
-    "typescript": "^5.0.3"
-  },
-  "resolutions": {
-    "npm/libnpmversion": "^3.0.6"
+    "semantic-release": "^21.0.3",
+    "tslib": "^2.5.3",
+    "typedoc": "^0.24.8",
+    "typedoc-plugin-markdown": "^3.15.3",
+    "typescript": "^5.1.3",
+    "uWebSockets.js": "uNetworking/uWebSockets.js#v20.30.0"
   }
 }