graphql-http 1.21.0 → 1.22.0

package/lib/use/fetch.d.ts

@@ -1,4 +1,5 @@
 import { HandlerOptions as RawHandlerOptions, OperationContext } from '../handler';
+import { RequestParams } from '../common';
 /**
  * The necessary API from the fetch environment for the handler.
  *
@@ -9,6 +10,55 @@ export interface FetchAPI {
     ReadableStream: typeof ReadableStream;
     TextEncoder: typeof TextEncoder;
 }
+/**
+ * The GraphQL over HTTP spec compliant request parser for an incoming GraphQL request.
+ *
+ * It is important to pass in the `abortedRef` so that the parser does not perform any
+ * operations on a disposed request (see example).
+ *
+ * If the HTTP request _is not_ a [well-formatted GraphQL over HTTP request](https://graphql.github.io/graphql-over-http/draft/#sec-Request), the function will return a `Response`.
+ *
+ * If the HTTP request _is_ a [well-formatted GraphQL over HTTP request](https://graphql.github.io/graphql-over-http/draft/#sec-Request), but is invalid or malformed,
+ * the function will throw an error and it is up to the user to handle and respond as they see fit.
+ *
+ * ```js
+ * import http from 'http';
+ * import { createServerAdapter } from '@whatwg-node/server'; // yarn add @whatwg-node/server
+ * import { parseRequestParams } from 'graphql-http/lib/use/fetch';
+ *
+ * // Use this adapter in _any_ environment.
+ * const adapter = createServerAdapter({
+ *   handleRequest: async (req) => {
+ *     try {
+ *       const paramsOrResponse = await parseRequestParams(req);
+ *       if (paramsOrResponse instanceof Response) {
+ *         // not a well-formatted GraphQL over HTTP request,
+ *         // parser created a response object to use
+ *         return paramsOrResponse;
+ *       }
+ *
+ *       // well-formatted GraphQL over HTTP request,
+ *       // with valid parameters
+ *       return new Response(JSON.stringify(paramsOrResponse, null, '  '), {
+ *         status: 200,
+ *       });
+ *     } catch (err) {
+ *       // well-formatted GraphQL over HTTP request,
+ *       // but with invalid parameters
+ *       return new Response(err.message, { status: 400 });
+ *     }
+ *   },
+ * });
+ *
+ * const server = http.createServer(adapter);
+ *
+ * server.listen(4000);
+ * console.log('Listening to port 4000');
+ * ```
+ *
+ * @category Server/fetch
+ */
+export declare function parseRequestParams(req: Request, api?: Partial<FetchAPI>): Promise<RequestParams | Response>;
 /**
  * Handler options when using the fetch adapter.
  *

package/lib/use/fetch.js

@@ -1,7 +1,65 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createHandler = void 0;
+exports.createHandler = exports.parseRequestParams = void 0;
 const handler_1 = require("../handler");
+/**
+ * The GraphQL over HTTP spec compliant request parser for an incoming GraphQL request.
+ *
+ * It is important to pass in the `abortedRef` so that the parser does not perform any
+ * operations on a disposed request (see example).
+ *
+ * If the HTTP request _is not_ a [well-formatted GraphQL over HTTP request](https://graphql.github.io/graphql-over-http/draft/#sec-Request), the function will return a `Response`.
+ *
+ * If the HTTP request _is_ a [well-formatted GraphQL over HTTP request](https://graphql.github.io/graphql-over-http/draft/#sec-Request), but is invalid or malformed,
+ * the function will throw an error and it is up to the user to handle and respond as they see fit.
+ *
+ * ```js
+ * import http from 'http';
+ * import { createServerAdapter } from '@whatwg-node/server'; // yarn add @whatwg-node/server
+ * import { parseRequestParams } from 'graphql-http/lib/use/fetch';
+ *
+ * // Use this adapter in _any_ environment.
+ * const adapter = createServerAdapter({
+ *   handleRequest: async (req) => {
+ *     try {
+ *       const paramsOrResponse = await parseRequestParams(req);
+ *       if (paramsOrResponse instanceof Response) {
+ *         // not a well-formatted GraphQL over HTTP request,
+ *         // parser created a response object to use
+ *         return paramsOrResponse;
+ *       }
+ *
+ *       // well-formatted GraphQL over HTTP request,
+ *       // with valid parameters
+ *       return new Response(JSON.stringify(paramsOrResponse, null, '  '), {
+ *         status: 200,
+ *       });
+ *     } catch (err) {
+ *       // well-formatted GraphQL over HTTP request,
+ *       // but with invalid parameters
+ *       return new Response(err.message, { status: 400 });
+ *     }
+ *   },
+ * });
+ *
+ * const server = http.createServer(adapter);
+ *
+ * server.listen(4000);
+ * console.log('Listening to port 4000');
+ * ```
+ *
+ * @category Server/fetch
+ */
+async function parseRequestParams(req, api = {}) {
+    const rawReq = toRequest(req, api);
+    const paramsOrRes = await (0, handler_1.parseRequestParams)(rawReq);
+    if (!('query' in paramsOrRes)) {
+        const [body, init] = paramsOrRes;
+        return new (api.Response || Response)(body, init);
+    }
+    return paramsOrRes;
+}
+exports.parseRequestParams = parseRequestParams;
 /**
  * Create a GraphQL over HTTP spec compliant request handler for
  * a fetch environment like Deno, Bun, CloudFlare Workers, Lambdas, etc.
@@ -39,14 +97,7 @@ function createHandler(options, reqCtx = {}) {
     const handler = (0, handler_1.createHandler)(options);
     return async function handleRequest(req) {
         try {
-            const [body, init] = await handler({
-                method: req.method,
-                url: req.url,
-                headers: req.headers,
-                body: () => req.text(),
-                raw: req,
-                context: api,
-            });
+            const [body, init] = await handler(toRequest(req, api));
             return new api.Response(body, init);
         }
         catch (err) {
@@ -59,3 +110,17 @@ function createHandler(options, reqCtx = {}) {
     };
 }
 exports.createHandler = createHandler;
+function toRequest(req, api = {}) {
+    return {
+        method: req.method,
+        url: req.url,
+        headers: req.headers,
+        body: () => req.text(),
+        raw: req,
+        context: {
+            Response: api.Response || Response,
+            TextEncoder: api.TextEncoder || TextEncoder,
+            ReadableStream: api.ReadableStream || ReadableStream,
+        },
+    };
+}

package/lib/use/fetch.mjs

@@ -1,4 +1,61 @@
-import { createHandler as createRawHandler, } from '../handler.mjs';
+import { createHandler as createRawHandler, parseRequestParams as rawParseRequestParams, } from '../handler.mjs';
+/**
+ * The GraphQL over HTTP spec compliant request parser for an incoming GraphQL request.
+ *
+ * It is important to pass in the `abortedRef` so that the parser does not perform any
+ * operations on a disposed request (see example).
+ *
+ * If the HTTP request _is not_ a [well-formatted GraphQL over HTTP request](https://graphql.github.io/graphql-over-http/draft/#sec-Request), the function will return a `Response`.
+ *
+ * If the HTTP request _is_ a [well-formatted GraphQL over HTTP request](https://graphql.github.io/graphql-over-http/draft/#sec-Request), but is invalid or malformed,
+ * the function will throw an error and it is up to the user to handle and respond as they see fit.
+ *
+ * ```js
+ * import http from 'http';
+ * import { createServerAdapter } from '@whatwg-node/server'; // yarn add @whatwg-node/server
+ * import { parseRequestParams } from 'graphql-http/lib/use/fetch';
+ *
+ * // Use this adapter in _any_ environment.
+ * const adapter = createServerAdapter({
+ *   handleRequest: async (req) => {
+ *     try {
+ *       const paramsOrResponse = await parseRequestParams(req);
+ *       if (paramsOrResponse instanceof Response) {
+ *         // not a well-formatted GraphQL over HTTP request,
+ *         // parser created a response object to use
+ *         return paramsOrResponse;
+ *       }
+ *
+ *       // well-formatted GraphQL over HTTP request,
+ *       // with valid parameters
+ *       return new Response(JSON.stringify(paramsOrResponse, null, '  '), {
+ *         status: 200,
+ *       });
+ *     } catch (err) {
+ *       // well-formatted GraphQL over HTTP request,
+ *       // but with invalid parameters
+ *       return new Response(err.message, { status: 400 });
+ *     }
+ *   },
+ * });
+ *
+ * const server = http.createServer(adapter);
+ *
+ * server.listen(4000);
+ * console.log('Listening to port 4000');
+ * ```
+ *
+ * @category Server/fetch
+ */
+export async function parseRequestParams(req, api = {}) {
+    const rawReq = toRequest(req, api);
+    const paramsOrRes = await rawParseRequestParams(rawReq);
+    if (!('query' in paramsOrRes)) {
+        const [body, init] = paramsOrRes;
+        return new (api.Response || Response)(body, init);
+    }
+    return paramsOrRes;
+}
 /**
  * Create a GraphQL over HTTP spec compliant request handler for
  * a fetch environment like Deno, Bun, CloudFlare Workers, Lambdas, etc.
@@ -36,14 +93,7 @@ export function createHandler(options, reqCtx = {}) {
     const handler = createRawHandler(options);
     return async function handleRequest(req) {
         try {
-            const [body, init] = await handler({
-                method: req.method,
-                url: req.url,
-                headers: req.headers,
-                body: () => req.text(),
-                raw: req,
-                context: api,
-            });
+            const [body, init] = await handler(toRequest(req, api));
             return new api.Response(body, init);
         }
         catch (err) {
@@ -55,3 +105,17 @@ export function createHandler(options, reqCtx = {}) {
         }
     };
 }
+function toRequest(req, api = {}) {
+    return {
+        method: req.method,
+        url: req.url,
+        headers: req.headers,
+        body: () => req.text(),
+        raw: req,
+        context: {
+            Response: api.Response || Response,
+            TextEncoder: api.TextEncoder || TextEncoder,
+            ReadableStream: api.ReadableStream || ReadableStream,
+        },
+    };
+}

package/lib/use/http.d.mts

@@ -1,6 +1,7 @@
 /// <reference types="node" />
 import type { IncomingMessage, ServerResponse } from 'http';
 import { HandlerOptions as RawHandlerOptions, OperationContext } from '../handler.mjs';
+import { RequestParams } from '../common.mjs';
 /**
  * The context in the request for the handler.
  *
@@ -9,6 +10,49 @@ import { HandlerOptions as RawHandlerOptions, OperationContext } from '../handle
 export interface RequestContext {
     res: ServerResponse;
 }
+/**
+ * The GraphQL over HTTP spec compliant request parser for an incoming GraphQL request.
+ *
+ * If the HTTP request _is not_ a [well-formatted GraphQL over HTTP request](https://graphql.github.io/graphql-over-http/draft/#sec-Request), the function will respond
+ * on the `ServerResponse` argument and return `null`.
+ *
+ * If the HTTP request _is_ a [well-formatted GraphQL over HTTP request](https://graphql.github.io/graphql-over-http/draft/#sec-Request), but is invalid or malformed,
+ * the function will throw an error and it is up to the user to handle and respond as they see fit.
+ *
+ * ```js
+ * import http from 'http';
+ * import { parseRequestParams } from 'graphql-http/lib/use/http';
+ *
+ * const server = http.createServer(async (req, res) => {
+ *   if (req.url.startsWith('/graphql')) {
+ *     try {
+ *       const maybeParams = await parseRequestParams(req, res);
+ *       if (!maybeParams) {
+ *         // not a well-formatted GraphQL over HTTP request,
+ *         // parser responded and there's nothing else to do
+ *         return;
+ *       }
+ *
+ *       // well-formatted GraphQL over HTTP request,
+ *       // with valid parameters
+ *       res.writeHead(200).end(JSON.stringify(maybeParams, null, '  '));
+ *     } catch (err) {
+ *       // well-formatted GraphQL over HTTP request,
+ *       // but with invalid parameters
+ *       res.writeHead(400).end(err.message);
+ *     }
+ *   } else {
+ *     res.writeHead(404).end();
+ *   }
+ * });
+ *
+ * server.listen(4000);
+ * console.log('Listening to port 4000');
+ * ```
+ *
+ * @category Server/http
+ */
+export declare function parseRequestParams(req: IncomingMessage, res: ServerResponse): Promise<RequestParams | null>;
 /**
  * Handler options when using the http adapter.
  *

package/lib/use/http.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="node" />
 import type { IncomingMessage, ServerResponse } from 'http';
 import { HandlerOptions as RawHandlerOptions, OperationContext } from '../handler';
+import { RequestParams } from '../common';
 /**
  * The context in the request for the handler.
  *
@@ -9,6 +10,49 @@ import { HandlerOptions as RawHandlerOptions, OperationContext } from '../handle
 export interface RequestContext {
     res: ServerResponse;
 }
+/**
+ * The GraphQL over HTTP spec compliant request parser for an incoming GraphQL request.
+ *
+ * If the HTTP request _is not_ a [well-formatted GraphQL over HTTP request](https://graphql.github.io/graphql-over-http/draft/#sec-Request), the function will respond
+ * on the `ServerResponse` argument and return `null`.
+ *
+ * If the HTTP request _is_ a [well-formatted GraphQL over HTTP request](https://graphql.github.io/graphql-over-http/draft/#sec-Request), but is invalid or malformed,
+ * the function will throw an error and it is up to the user to handle and respond as they see fit.
+ *
+ * ```js
+ * import http from 'http';
+ * import { parseRequestParams } from 'graphql-http/lib/use/http';
+ *
+ * const server = http.createServer(async (req, res) => {
+ *   if (req.url.startsWith('/graphql')) {
+ *     try {
+ *       const maybeParams = await parseRequestParams(req, res);
+ *       if (!maybeParams) {
+ *         // not a well-formatted GraphQL over HTTP request,
+ *         // parser responded and there's nothing else to do
+ *         return;
+ *       }
+ *
+ *       // well-formatted GraphQL over HTTP request,
+ *       // with valid parameters
+ *       res.writeHead(200).end(JSON.stringify(maybeParams, null, '  '));
+ *     } catch (err) {
+ *       // well-formatted GraphQL over HTTP request,
+ *       // but with invalid parameters
+ *       res.writeHead(400).end(err.message);
+ *     }
+ *   } else {
+ *     res.writeHead(404).end();
+ *   }
+ * });
+ *
+ * server.listen(4000);
+ * console.log('Listening to port 4000');
+ * ```
+ *
+ * @category Server/http
+ */
+export declare function parseRequestParams(req: IncomingMessage, res: ServerResponse): Promise<RequestParams | null>;
 /**
  * Handler options when using the http adapter.
  *

package/lib/use/http.js

@@ -1,7 +1,60 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createHandler = void 0;
+exports.createHandler = exports.parseRequestParams = void 0;
 const handler_1 = require("../handler");
+/**
+ * The GraphQL over HTTP spec compliant request parser for an incoming GraphQL request.
+ *
+ * If the HTTP request _is not_ a [well-formatted GraphQL over HTTP request](https://graphql.github.io/graphql-over-http/draft/#sec-Request), the function will respond
+ * on the `ServerResponse` argument and return `null`.
+ *
+ * If the HTTP request _is_ a [well-formatted GraphQL over HTTP request](https://graphql.github.io/graphql-over-http/draft/#sec-Request), but is invalid or malformed,
+ * the function will throw an error and it is up to the user to handle and respond as they see fit.
+ *
+ * ```js
+ * import http from 'http';
+ * import { parseRequestParams } from 'graphql-http/lib/use/http';
+ *
+ * const server = http.createServer(async (req, res) => {
+ *   if (req.url.startsWith('/graphql')) {
+ *     try {
+ *       const maybeParams = await parseRequestParams(req, res);
+ *       if (!maybeParams) {
+ *         // not a well-formatted GraphQL over HTTP request,
+ *         // parser responded and there's nothing else to do
+ *         return;
+ *       }
+ *
+ *       // well-formatted GraphQL over HTTP request,
+ *       // with valid parameters
+ *       res.writeHead(200).end(JSON.stringify(maybeParams, null, '  '));
+ *     } catch (err) {
+ *       // well-formatted GraphQL over HTTP request,
+ *       // but with invalid parameters
+ *       res.writeHead(400).end(err.message);
+ *     }
+ *   } else {
+ *     res.writeHead(404).end();
+ *   }
+ * });
+ *
+ * server.listen(4000);
+ * console.log('Listening to port 4000');
+ * ```
+ *
+ * @category Server/http
+ */
+async function parseRequestParams(req, res) {
+    const rawReq = toRequest(req, res);
+    const paramsOrRes = await (0, handler_1.parseRequestParams)(rawReq);
+    if (!('query' in paramsOrRes)) {
+        const [body, init] = paramsOrRes;
+        res.writeHead(init.status, init.statusText, init.headers).end(body);
+        return null;
+    }
+    return paramsOrRes;
+}
+exports.parseRequestParams = parseRequestParams;
 /**
  * Create a GraphQL over HTTP spec compliant request handler for
  * the Node environment http module.
@@ -29,18 +82,7 @@ function createHandler(options) {
             if (!req.method) {
                 throw new Error('Missing request method');
             }
-            const [body, init] = await handle({
-                url: req.url,
-                method: req.method,
-                headers: req.headers,
-                body: () => new Promise((resolve) => {
-                    let body = '';
-                    req.on('data', (chunk) => (body += chunk));
-                    req.on('end', () => resolve(body));
-                }),
-                raw: req,
-                context: { res },
-            });
+            const [body, init] = await handle(toRequest(req, res));
             res.writeHead(init.status, init.statusText, init.headers).end(body);
         }
         catch (err) {
@@ -53,3 +95,23 @@ function createHandler(options) {
     };
 }
 exports.createHandler = createHandler;
+function toRequest(req, res) {
+    if (!req.url) {
+        throw new Error('Missing request URL');
+    }
+    if (!req.method) {
+        throw new Error('Missing request method');
+    }
+    return {
+        url: req.url,
+        method: req.method,
+        headers: req.headers,
+        body: () => new Promise((resolve) => {
+            let body = '';
+            req.on('data', (chunk) => (body += chunk));
+            req.on('end', () => resolve(body));
+        }),
+        raw: req,
+        context: { res },
+    };
+}

package/lib/use/http.mjs

@@ -1,4 +1,56 @@
-import { createHandler as createRawHandler, } from '../handler.mjs';
+import { createHandler as createRawHandler, parseRequestParams as rawParseRequestParams, } from '../handler.mjs';
+/**
+ * The GraphQL over HTTP spec compliant request parser for an incoming GraphQL request.
+ *
+ * If the HTTP request _is not_ a [well-formatted GraphQL over HTTP request](https://graphql.github.io/graphql-over-http/draft/#sec-Request), the function will respond
+ * on the `ServerResponse` argument and return `null`.
+ *
+ * If the HTTP request _is_ a [well-formatted GraphQL over HTTP request](https://graphql.github.io/graphql-over-http/draft/#sec-Request), but is invalid or malformed,
+ * the function will throw an error and it is up to the user to handle and respond as they see fit.
+ *
+ * ```js
+ * import http from 'http';
+ * import { parseRequestParams } from 'graphql-http/lib/use/http';
+ *
+ * const server = http.createServer(async (req, res) => {
+ *   if (req.url.startsWith('/graphql')) {
+ *     try {
+ *       const maybeParams = await parseRequestParams(req, res);
+ *       if (!maybeParams) {
+ *         // not a well-formatted GraphQL over HTTP request,
+ *         // parser responded and there's nothing else to do
+ *         return;
+ *       }
+ *
+ *       // well-formatted GraphQL over HTTP request,
+ *       // with valid parameters
+ *       res.writeHead(200).end(JSON.stringify(maybeParams, null, '  '));
+ *     } catch (err) {
+ *       // well-formatted GraphQL over HTTP request,
+ *       // but with invalid parameters
+ *       res.writeHead(400).end(err.message);
+ *     }
+ *   } else {
+ *     res.writeHead(404).end();
+ *   }
+ * });
+ *
+ * server.listen(4000);
+ * console.log('Listening to port 4000');
+ * ```
+ *
+ * @category Server/http
+ */
+export async function parseRequestParams(req, res) {
+    const rawReq = toRequest(req, res);
+    const paramsOrRes = await rawParseRequestParams(rawReq);
+    if (!('query' in paramsOrRes)) {
+        const [body, init] = paramsOrRes;
+        res.writeHead(init.status, init.statusText, init.headers).end(body);
+        return null;
+    }
+    return paramsOrRes;
+}
 /**
  * Create a GraphQL over HTTP spec compliant request handler for
  * the Node environment http module.
@@ -26,18 +78,7 @@ export function createHandler(options) {
             if (!req.method) {
                 throw new Error('Missing request method');
             }
-            const [body, init] = await handle({
-                url: req.url,
-                method: req.method,
-                headers: req.headers,
-                body: () => new Promise((resolve) => {
-                    let body = '';
-                    req.on('data', (chunk) => (body += chunk));
-                    req.on('end', () => resolve(body));
-                }),
-                raw: req,
-                context: { res },
-            });
+            const [body, init] = await handle(toRequest(req, res));
             res.writeHead(init.status, init.statusText, init.headers).end(body);
         }
         catch (err) {
@@ -49,3 +90,23 @@ export function createHandler(options) {
         }
     };
 }
+function toRequest(req, res) {
+    if (!req.url) {
+        throw new Error('Missing request URL');
+    }
+    if (!req.method) {
+        throw new Error('Missing request method');
+    }
+    return {
+        url: req.url,
+        method: req.method,
+        headers: req.headers,
+        body: () => new Promise((resolve) => {
+            let body = '';
+            req.on('data', (chunk) => (body += chunk));
+            req.on('end', () => resolve(body));
+        }),
+        raw: req,
+        context: { res },
+    };
+}

package/lib/use/http2.d.mts

@@ -1,6 +1,7 @@
 /// <reference types="node" />
 import type { Http2ServerRequest, Http2ServerResponse } from 'http2';
 import { HandlerOptions as RawHandlerOptions, OperationContext } from '../handler.mjs';
+import { RequestParams } from '../common.mjs';
 /**
  * The context in the request for the handler.
  *
@@ -9,6 +10,61 @@ import { HandlerOptions as RawHandlerOptions, OperationContext } from '../handle
 export interface RequestContext {
     res: Http2ServerResponse;
 }
+/**
+ * The GraphQL over HTTP spec compliant request parser for an incoming GraphQL request.
+ *
+ * If the HTTP request _is not_ a [well-formatted GraphQL over HTTP request](https://graphql.github.io/graphql-over-http/draft/#sec-Request), the function will respond
+ * on the `Http2ServerResponse` argument and return `null`.
+ *
+ * If the HTTP request _is_ a [well-formatted GraphQL over HTTP request](https://graphql.github.io/graphql-over-http/draft/#sec-Request), but is invalid or malformed,
+ * the function will throw an error and it is up to the user to handle and respond as they see fit.
+ *
+ *  ```shell
+ * $ openssl req -x509 -newkey rsa:2048 -nodes -sha256 -subj '/CN=localhost' \
+ *   -keyout localhost-privkey.pem -out localhost-cert.pem
+ * ```
+ *
+ * ```js
+ * import fs from 'fs';
+ * import http2 from 'http2';
+ * import { parseRequestParams } from 'graphql-http/lib/use/http2';
+ *
+ * const server = http2.createSecureServer(
+ *   {
+ *     key: fs.readFileSync('localhost-privkey.pem'),
+ *     cert: fs.readFileSync('localhost-cert.pem'),
+ *   },
+ *   async (req, res) => {
+ *     if (req.url.startsWith('/graphql')) {
+ *       try {
+ *         const maybeParams = await parseRequestParams(req, res);
+ *         if (!maybeParams) {
+ *           // not a well-formatted GraphQL over HTTP request,
+ *           // parser responded and there's nothing else to do
+ *           return;
+ *         }
+ *
+ *         // well-formatted GraphQL over HTTP request,
+ *         // with valid parameters
+ *         res.writeHead(200).end(JSON.stringify(maybeParams, null, '  '));
+ *       } catch (err) {
+ *         // well-formatted GraphQL over HTTP request,
+ *         // but with invalid parameters
+ *         res.writeHead(400).end(err.message);
+ *       }
+ *     } else {
+ *       res.writeHead(404).end();
+ *     }
+ *   },
+ * );
+ *
+ * server.listen(4000);
+ * console.log('Listening to port 4000');
+ * ```
+ *
+ * @category Server/http2
+ */
+export declare function parseRequestParams(req: Http2ServerRequest, res: Http2ServerResponse): Promise<RequestParams | null>;
 /**
  * Handler options when using the http adapter.
  *