graphql-http 1.16.0 → 1.17.0

package/README.md

@@ -736,6 +736,36 @@ for (const audit of serverAudits({
 
 </details>
 
+<details id="audit-deno">
+<summary><a href="#audit-deno">🔗</a> Audit for servers usage in <a href="https://deno.land">Deno</a> environment</summary>
+
+```ts
+import { serverAudits } from 'npm:graphql-http';
+
+for (const audit of serverAudits({
+  url: 'http://localhost:4000/graphql',
+  fetchFn: fetch,
+})) {
+  Deno.test(audit.name, async () => {
+    const result = await audit.fn();
+    if (result.status === 'error') {
+      throw result.reason;
+    }
+    if (result.status === 'warn') {
+      console.warn(result.reason); // or throw if you want full compliance (warnings are not requirements)
+    }
+    // Avoid leaking resources
+    if ('body' in result && result.body instanceof ReadableStream) {
+      await result.body.cancel();
+    }
+  });
+}
+```
+
+Put the above contents in a file and run it with `deno test --allow-net`.
+
+</details>
+
 ## Only [GraphQL over HTTP](https://graphql.github.io/graphql-over-http/)
 
 This is the official [GraphQL over HTTP spec](https://graphql.github.io/graphql-over-http/) reference implementation and as such follows the specification strictly without any additional features (like file uploads, @stream/@defer directives and subscriptions).
@@ -744,7 +774,9 @@ Having said this, graphql-http is mostly aimed for library authors and simple se
 
 ## [Servers](/implementations)
 
-If you want a feature-full server with bleeding edge technologies, you're recommended to use one of the following.
+If you want a feature-full server with bleeding edge technologies, you're recommended to use one of the following servers.
+
+Their compliance with the [GraphQL over HTTP spec](https://graphql.github.io/graphql-over-http) is checked automatically and updated regularly.
 
 <!-- <ServersTable> -->
 <!-- prettier-ignore-start -->
@@ -768,16 +800,11 @@ Check the [docs folder](docs/) out for [TypeDoc](https://typedoc.org) generated
 
 ## [Audits](implementations/)
 
-Inspect audits of other implementations in the [implementations folder](implementations/). Adding your implementation is very welcome!
+Inspect audits of other implementations in the [implementations folder](implementations).
+Adding your implementation is very welcome, [see how](CONTRIBUTING.md#adding-implementations)!
 
 ## Want to help?
 
-File a bug, contribute with code, or improve documentation? Read up on our guidelines below and drive development with `yarn test --watch` away!
-
-This repository is managed by EasyCLA. Project participants must sign the free [GraphQL Specification Membership agreement](https://preview-spec-membership.graphql.org) before making a contribution. You only need to do this one time, and it can be signed by [individual contributors](http://individual-spec-membership.graphql.org/) or their [employers](http://corporate-spec-membership.graphql.org/).
-
-To initiate the signature process please open a PR against this repo. The EasyCLA bot will block the merge if we still need a membership agreement from you.
-
-You can find [detailed information here](https://github.com/graphql/graphql-wg/tree/main/membership). If you have issues, please email [operations@graphql.org](mailto:operations@graphql.org).
+File a bug, contribute with code, or improve documentation? [Read more in CONTRIBUTING.md](CONTRIBUTING.md).
 
 If your company benefits from GraphQL and you would like to provide essential financial support for the systems and people that power our community, please also consider membership in the [GraphQL Foundation](https://foundation.graphql.org/join).

package/lib/use/express.d.mts

@@ -1,11 +1,19 @@
-import type { Request, Handler } from 'express';
+import type { Request, Response, Handler } from 'express';
 import { HandlerOptions as RawHandlerOptions, OperationContext } from '../handler';
+/**
+ * The context in the request for the handler.
+ *
+ * @category Server/express
+ */
+export interface RequestContext {
+    res: Response;
+}
 /**
  * Handler options when using the express adapter.
  *
  * @category Server/express
  */
-export type HandlerOptions<Context extends OperationContext = undefined> = RawHandlerOptions<Request, undefined, Context>;
+export type HandlerOptions<Context extends OperationContext = undefined> = RawHandlerOptions<Request, RequestContext, Context>;
 /**
  * Create a GraphQL over HTTP spec compliant request handler for
  * the express framework.

package/lib/use/express.d.ts

@@ -1,11 +1,19 @@
-import type { Request, Handler } from 'express';
+import type { Request, Response, Handler } from 'express';
 import { HandlerOptions as RawHandlerOptions, OperationContext } from '../handler';
+/**
+ * The context in the request for the handler.
+ *
+ * @category Server/express
+ */
+export interface RequestContext {
+    res: Response;
+}
 /**
  * Handler options when using the express adapter.
  *
  * @category Server/express
  */
-export type HandlerOptions<Context extends OperationContext = undefined> = RawHandlerOptions<Request, undefined, Context>;
+export type HandlerOptions<Context extends OperationContext = undefined> = RawHandlerOptions<Request, RequestContext, Context>;
 /**
  * Create a GraphQL over HTTP spec compliant request handler for
  * the express framework.

package/lib/use/express.js

@@ -41,7 +41,7 @@ function createHandler(options) {
                     });
                 },
                 raw: req,
-                context: undefined,
+                context: { res },
             });
             res.writeHead(init.status, init.statusText, init.headers).end(body);
         }

package/lib/use/express.mjs

@@ -38,7 +38,7 @@ export function createHandler(options) {
                     });
                 },
                 raw: req,
-                context: undefined,
+                context: { res },
             });
             res.writeHead(init.status, init.statusText, init.headers).end(body);
         }

package/lib/use/fastify.d.mts

@@ -1,11 +1,19 @@
-import type { FastifyRequest, RouteHandler } from 'fastify';
+import type { FastifyRequest, FastifyReply, RouteHandler } from 'fastify';
 import { HandlerOptions as RawHandlerOptions, OperationContext } from '../handler';
+/**
+ * The context in the request for the handler.
+ *
+ * @category Server/fastify
+ */
+export interface RequestContext {
+    reply: FastifyReply;
+}
 /**
  * Handler options when using the fastify adapter.
  *
  * @category Server/fastify
  */
-export type HandlerOptions<Context extends OperationContext = undefined> = RawHandlerOptions<FastifyRequest, undefined, Context>;
+export type HandlerOptions<Context extends OperationContext = undefined> = RawHandlerOptions<FastifyRequest, RequestContext, Context>;
 /**
  * Create a GraphQL over HTTP spec compliant request handler for
  * the fastify framework.

package/lib/use/fastify.d.ts

@@ -1,11 +1,19 @@
-import type { FastifyRequest, RouteHandler } from 'fastify';
+import type { FastifyRequest, FastifyReply, RouteHandler } from 'fastify';
 import { HandlerOptions as RawHandlerOptions, OperationContext } from '../handler';
+/**
+ * The context in the request for the handler.
+ *
+ * @category Server/fastify
+ */
+export interface RequestContext {
+    reply: FastifyReply;
+}
 /**
  * Handler options when using the fastify adapter.
  *
  * @category Server/fastify
  */
-export type HandlerOptions<Context extends OperationContext = undefined> = RawHandlerOptions<FastifyRequest, undefined, Context>;
+export type HandlerOptions<Context extends OperationContext = undefined> = RawHandlerOptions<FastifyRequest, RequestContext, Context>;
 /**
  * Create a GraphQL over HTTP spec compliant request handler for
  * the fastify framework.

package/lib/use/fastify.js

@@ -32,7 +32,7 @@ function createHandler(options) {
                 // eslint-disable-next-line @typescript-eslint/no-explicit-any
                 body: req.body,
                 raw: req,
-                context: undefined,
+                context: { reply },
             });
             reply
                 .status(init.status)

package/lib/use/fastify.mjs

@@ -29,7 +29,7 @@ export function createHandler(options) {
                 // eslint-disable-next-line @typescript-eslint/no-explicit-any
                 body: req.body,
                 raw: req,
-                context: undefined,
+                context: { reply },
             });
             reply
                 .status(init.status)

package/lib/use/http.d.mts

@@ -1,12 +1,20 @@
 /// <reference types="node" />
 import type { IncomingMessage, ServerResponse } from 'http';
 import { HandlerOptions as RawHandlerOptions, OperationContext } from '../handler';
+/**
+ * The context in the request for the handler.
+ *
+ * @category Server/http
+ */
+export interface RequestContext {
+    res: ServerResponse;
+}
 /**
  * Handler options when using the http adapter.
  *
  * @category Server/http
  */
-export type HandlerOptions<Context extends OperationContext = undefined> = RawHandlerOptions<IncomingMessage, undefined, Context>;
+export type HandlerOptions<Context extends OperationContext = undefined> = RawHandlerOptions<IncomingMessage, RequestContext, Context>;
 /**
  * Create a GraphQL over HTTP spec compliant request handler for
  * the Node environment http module.

package/lib/use/http.d.ts

@@ -1,12 +1,20 @@
 /// <reference types="node" />
 import type { IncomingMessage, ServerResponse } from 'http';
 import { HandlerOptions as RawHandlerOptions, OperationContext } from '../handler';
+/**
+ * The context in the request for the handler.
+ *
+ * @category Server/http
+ */
+export interface RequestContext {
+    res: ServerResponse;
+}
 /**
  * Handler options when using the http adapter.
  *
  * @category Server/http
  */
-export type HandlerOptions<Context extends OperationContext = undefined> = RawHandlerOptions<IncomingMessage, undefined, Context>;
+export type HandlerOptions<Context extends OperationContext = undefined> = RawHandlerOptions<IncomingMessage, RequestContext, Context>;
 /**
  * Create a GraphQL over HTTP spec compliant request handler for
  * the Node environment http module.

package/lib/use/http.js

@@ -40,7 +40,7 @@ function createHandler(options) {
                     req.on('end', () => resolve(body));
                 }),
                 raw: req,
-                context: undefined,
+                context: { res },
             });
             res.writeHead(init.status, init.statusText, init.headers).end(body);
         }

package/lib/use/http.mjs

@@ -37,7 +37,7 @@ export function createHandler(options) {
                     req.on('end', () => resolve(body));
                 }),
                 raw: req,
-                context: undefined,
+                context: { res },
             });
             res.writeHead(init.status, init.statusText, init.headers).end(body);
         }

package/lib/use/http2.d.mts

@@ -1,12 +1,20 @@
 /// <reference types="node" />
 import type { Http2ServerRequest, Http2ServerResponse } from 'http2';
 import { HandlerOptions as RawHandlerOptions, OperationContext } from '../handler';
+/**
+ * The context in the request for the handler.
+ *
+ * @category Server/http2
+ */
+export interface RequestContext {
+    res: Http2ServerResponse;
+}
 /**
  * Handler options when using the http adapter.
  *
  * @category Server/http2
  */
-export type HandlerOptions<Context extends OperationContext = undefined> = RawHandlerOptions<Http2ServerRequest, undefined, Context>;
+export type HandlerOptions<Context extends OperationContext = undefined> = RawHandlerOptions<Http2ServerRequest, RequestContext, Context>;
 /**
  * Create a GraphQL over HTTP spec compliant request handler for
  * the Node environment http2 module.

package/lib/use/http2.d.ts

@@ -1,12 +1,20 @@
 /// <reference types="node" />
 import type { Http2ServerRequest, Http2ServerResponse } from 'http2';
 import { HandlerOptions as RawHandlerOptions, OperationContext } from '../handler';
+/**
+ * The context in the request for the handler.
+ *
+ * @category Server/http2
+ */
+export interface RequestContext {
+    res: Http2ServerResponse;
+}
 /**
  * Handler options when using the http adapter.
  *
  * @category Server/http2
  */
-export type HandlerOptions<Context extends OperationContext = undefined> = RawHandlerOptions<Http2ServerRequest, undefined, Context>;
+export type HandlerOptions<Context extends OperationContext = undefined> = RawHandlerOptions<Http2ServerRequest, RequestContext, Context>;
 /**
  * Create a GraphQL over HTTP spec compliant request handler for
  * the Node environment http2 module.

package/lib/use/http2.js

@@ -52,7 +52,7 @@ function createHandler(options) {
                     req.on('end', () => resolve(body));
                 }),
                 raw: req,
-                context: undefined,
+                context: { res },
             });
             res.writeHead(init.status, init.statusText, init.headers);
             if (body) {

package/lib/use/http2.mjs

@@ -49,7 +49,7 @@ export function createHandler(options) {
                     req.on('end', () => resolve(body));
                 }),
                 raw: req,
-                context: undefined,
+                context: { res },
             });
             res.writeHead(init.status, init.statusText, init.headers);
             if (body) {

package/lib/use/koa.d.mts

@@ -1,13 +1,21 @@
 /// <reference types="node" />
-import type { Middleware } from 'koa';
+import type { Middleware, Response } from 'koa';
 import type { IncomingMessage } from 'http';
 import { HandlerOptions as RawHandlerOptions, OperationContext } from '../handler';
+/**
+ * The context in the request for the handler.
+ *
+ * @category Server/koa
+ */
+export interface RequestContext {
+    res: Response;
+}
 /**
  * Handler options when using the koa adapter.
  *
  * @category Server/koa
  */
-export type HandlerOptions<Context extends OperationContext = undefined> = RawHandlerOptions<IncomingMessage, undefined, Context>;
+export type HandlerOptions<Context extends OperationContext = undefined> = RawHandlerOptions<IncomingMessage, RequestContext, Context>;
 /**
  * Create a GraphQL over HTTP spec compliant request handler for
  * the Koa framework.

package/lib/use/koa.d.ts

@@ -1,13 +1,21 @@
 /// <reference types="node" />
-import type { Middleware } from 'koa';
+import type { Middleware, Response } from 'koa';
 import type { IncomingMessage } from 'http';
 import { HandlerOptions as RawHandlerOptions, OperationContext } from '../handler';
+/**
+ * The context in the request for the handler.
+ *
+ * @category Server/koa
+ */
+export interface RequestContext {
+    res: Response;
+}
 /**
  * Handler options when using the koa adapter.
  *
  * @category Server/koa
  */
-export type HandlerOptions<Context extends OperationContext = undefined> = RawHandlerOptions<IncomingMessage, undefined, Context>;
+export type HandlerOptions<Context extends OperationContext = undefined> = RawHandlerOptions<IncomingMessage, RequestContext, Context>;
 /**
  * Create a GraphQL over HTTP spec compliant request handler for
  * the Koa framework.

package/lib/use/koa.js

@@ -42,7 +42,7 @@ function createHandler(options) {
                     });
                 },
                 raw: ctx.req,
-                context: undefined,
+                context: { res: ctx.response },
             });
             ctx.body = body;
             ctx.response.status = init.status;

package/lib/use/koa.mjs

@@ -39,7 +39,7 @@ export function createHandler(options) {
                     });
                 },
                 raw: ctx.req,
-                context: undefined,
+                context: { res: ctx.response },
             });
             ctx.body = body;
             ctx.response.status = init.status;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graphql-http",
-  "version": "1.16.0",
+  "version": "1.17.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.4.1",
+  "packageManager": "yarn@3.5.0",
   "main": "lib/index.js",
   "module": "lib/index.mjs",
   "browser": "umd/graphql-http.js",
@@ -88,7 +88,8 @@
   "scripts": {
     "gendocs": "typedoc --options typedoc.js src/",
     "lint:eslint": "eslint 'src'",
-    "lint:prettier": "prettier -c .",
+    "lint:prettier": "prettier --check .",
+    "lint:fix": "yarn lint:eslint --fix && yarn lint:prettier --write",
     "lint": "yarn lint:eslint && yarn lint:prettier",
     "type-check": "tsc --noEmit",
     "test": "NODE_OPTIONS=--experimental-vm-modules NODE_NO_WARNINGS=1 jest",
@@ -105,47 +106,47 @@
     "graphql": ">=0.11 <=16"
   },
   "devDependencies": {
-    "@babel/core": "^7.20.12",
+    "@babel/core": "^7.21.3",
     "@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/plugin-proposal-optional-chaining": "^7.21.0",
     "@babel/preset-env": "^7.20.2",
-    "@babel/preset-typescript": "^7.18.6",
+    "@babel/preset-typescript": "^7.21.0",
     "@rollup/plugin-terser": "^0.4.0",
     "@rollup/plugin-typescript": "^11.0.0",
-    "@semantic-release/changelog": "^6.0.2",
+    "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
-    "@types/eslint": "^8.21.0",
+    "@types/eslint": "^8.21.3",
     "@types/express": "^4.17.17",
-    "@types/glob": "^8.0.1",
+    "@types/glob": "^8.1.0",
     "@types/html-validator": "^5.0.3",
-    "@types/jest": "^29.4.0",
-    "@types/koa": "^2.13.5",
+    "@types/jest": "^29.5.0",
+    "@types/koa": "^2.13.6",
     "@types/koa-mount": "^4.0.2",
-    "@typescript-eslint/eslint-plugin": "^5.51.0",
-    "@typescript-eslint/parser": "^5.51.0",
-    "@whatwg-node/fetch": "^0.8.1",
-    "babel-jest": "^29.4.2",
-    "eslint": "^8.34.0",
-    "eslint-config-prettier": "^8.6.0",
+    "@typescript-eslint/eslint-plugin": "^5.57.0",
+    "@typescript-eslint/parser": "^5.57.0",
+    "@whatwg-node/fetch": "^0.8.4",
+    "babel-jest": "^29.5.0",
+    "eslint": "^8.36.0",
+    "eslint-config-prettier": "^8.8.0",
     "express": "^4.18.2",
-    "fastify": "^4.13.0",
+    "fastify": "^4.15.0",
     "graphql": "^16.6.0",
     "html-validator": "^6.0.1",
-    "jest": "^29.4.2",
-    "jest-jasmine2": "^29.4.2",
+    "jest": "^29.5.0",
+    "jest-jasmine2": "^29.5.0",
     "koa": "^2.14.1",
     "koa-mount": "^4.0.0",
-    "node-fetch": "^3.3.0",
-    "prettier": "^2.8.4",
-    "rollup": "^3.15.0",
+    "node-fetch": "^3.3.1",
+    "prettier": "^2.8.7",
+    "rollup": "^3.20.2",
     "rollup-plugin-gzip": "^3.1.0",
-    "semantic-release": "^20.1.0",
+    "semantic-release": "^21.0.0",
     "tslib": "^2.5.0",
-    "typedoc": "^0.23.25",
+    "typedoc": "^0.23.28",
     "typedoc-plugin-markdown": "^3.14.0",
-    "typescript": "^4.9.5"
+    "typescript": "^5.0.2"
   },
   "resolutions": {
     "npm/libnpmversion": "^3.0.6"