graphql-http 1.8.0 → 1.10.0

package/README.md

@@ -735,7 +735,6 @@ If you want a feature-full server with bleeding edge technologies, you're recomm
 | [hotchocolate](https://chillicream.com/docs/hotchocolate)          | [✅ Compliant](/implementations/hotchocolate/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) |
-| [mercurius](https://mercurius.dev)                                 | [✅ Compliant](/implementations/mercurius/README.md)     |
 
 ## [Documentation](docs/)
 

package/lib/audits/common.d.mts

@@ -8,13 +8,13 @@
  *
  * @category Audits
  */
-export declare type AuditRequirement = 'MUST' | 'SHOULD' | 'MAY';
+export type AuditRequirement = 'MUST' | 'SHOULD' | 'MAY';
 /**
  * Audit name starting with the audit requirement level.
  *
  * @category Audits
  */
-export declare type AuditName = `${AuditRequirement} ${string}`;
+export type AuditName = `${AuditRequirement} ${string}`;
 /**
  * Actual audit test returning an result.
  *
@@ -55,4 +55,4 @@ export interface AuditFail {
  *
  * @category Audits
  */
-export declare type AuditResult = AuditOk | AuditFail;
+export type AuditResult = AuditOk | AuditFail;

package/lib/audits/common.d.ts

@@ -8,13 +8,13 @@
  *
  * @category Audits
  */
-export declare type AuditRequirement = 'MUST' | 'SHOULD' | 'MAY';
+export type AuditRequirement = 'MUST' | 'SHOULD' | 'MAY';
 /**
  * Audit name starting with the audit requirement level.
  *
  * @category Audits
  */
-export declare type AuditName = `${AuditRequirement} ${string}`;
+export type AuditName = `${AuditRequirement} ${string}`;
 /**
  * Actual audit test returning an result.
  *
@@ -55,4 +55,4 @@ export interface AuditFail {
  *
  * @category Audits
  */
-export declare type AuditResult = AuditOk | AuditFail;
+export type AuditResult = AuditOk | AuditFail;

package/lib/audits/server.d.mts

@@ -16,7 +16,7 @@ export interface ServerAuditOptions {
      * A function can be also supplied, in this case -
      * every audit will invoke the function to get the URL.
      */
-    url: string | (() => string | Promise<string>);
+    url: string | Promise<string> | (() => string | Promise<string>);
     /**
      * The Fetch function to use.
      *

package/lib/audits/server.d.ts

@@ -16,7 +16,7 @@ export interface ServerAuditOptions {
      * A function can be also supplied, in this case -
      * every audit will invoke the function to get the URL.
      */
-    url: string | (() => string | Promise<string>);
+    url: string | Promise<string> | (() => string | Promise<string>);
     /**
      * The Fetch function to use.
      *

package/lib/audits/server.js

@@ -313,6 +313,40 @@ function serverAudits(opts) {
             (0, utils_1.assert)('Status code', res.status).toBe(200);
             (0, utils_1.assert)('Execution result', await (0, utils_1.assertBodyAsExecutionResult)(res)).notToHaveProperty('errors');
         }),
+        ...['variables', 'operationName', 'extensions'].flatMap((parameter) => [
+            (0, utils_1.audit)(
+            // TODO: convert to MUST after watershed
+            `SHOULD allow null {${parameter}} parameter when accepting application/graphql-response+json`, async () => {
+                const res = await fetchFn(await getUrl(opts.url), {
+                    method: 'POST',
+                    headers: {
+                        'content-type': 'application/json',
+                        accept: 'application/graphql-response+json',
+                    },
+                    body: JSON.stringify({
+                        query: '{ __typename }',
+                        [parameter]: null,
+                    }),
+                });
+                (0, utils_1.assert)('Status code', res.status).toBe(200);
+                (0, utils_1.assert)('Execution result', await (0, utils_1.assertBodyAsExecutionResult)(res)).notToHaveProperty('errors');
+            }),
+            (0, utils_1.audit)(`MUST allow null {${parameter}} parameter when accepting application/json`, async () => {
+                const res = await fetchFn(await getUrl(opts.url), {
+                    method: 'POST',
+                    headers: {
+                        'content-type': 'application/json',
+                        accept: 'application/json',
+                    },
+                    body: JSON.stringify({
+                        query: '{ __typename }',
+                        [parameter]: null,
+                    }),
+                });
+                (0, utils_1.assert)('Status code', res.status).toBe(200);
+                (0, utils_1.assert)('Execution result', await (0, utils_1.assertBodyAsExecutionResult)(res)).notToHaveProperty('errors');
+            }),
+        ]),
         ...['string', 0, false, ['array']].map((invalid) => (0, utils_1.audit)(
         // TODO: convert to MUST after watershed
         `SHOULD use 400 status code on ${(0, utils_1.extendedTypeof)(invalid)} {variables} parameter when accepting application/graphql-response+json`, async () => {
@@ -694,8 +728,8 @@ async function auditServer(opts) {
 exports.auditServer = auditServer;
 /** @private */
 async function getUrl(url) {
-    if (typeof url === 'string') {
-        return url;
+    if (typeof url === 'function') {
+        return await url();
     }
-    return await url();
+    return url;
 }

package/lib/audits/server.mjs

@@ -310,6 +310,40 @@ export function serverAudits(opts) {
             assert('Status code', res.status).toBe(200);
             assert('Execution result', await assertBodyAsExecutionResult(res)).notToHaveProperty('errors');
         }),
+        ...['variables', 'operationName', 'extensions'].flatMap((parameter) => [
+            audit(
+            // TODO: convert to MUST after watershed
+            `SHOULD allow null {${parameter}} parameter when accepting application/graphql-response+json`, async () => {
+                const res = await fetchFn(await getUrl(opts.url), {
+                    method: 'POST',
+                    headers: {
+                        'content-type': 'application/json',
+                        accept: 'application/graphql-response+json',
+                    },
+                    body: JSON.stringify({
+                        query: '{ __typename }',
+                        [parameter]: null,
+                    }),
+                });
+                assert('Status code', res.status).toBe(200);
+                assert('Execution result', await assertBodyAsExecutionResult(res)).notToHaveProperty('errors');
+            }),
+            audit(`MUST allow null {${parameter}} parameter when accepting application/json`, async () => {
+                const res = await fetchFn(await getUrl(opts.url), {
+                    method: 'POST',
+                    headers: {
+                        'content-type': 'application/json',
+                        accept: 'application/json',
+                    },
+                    body: JSON.stringify({
+                        query: '{ __typename }',
+                        [parameter]: null,
+                    }),
+                });
+                assert('Status code', res.status).toBe(200);
+                assert('Execution result', await assertBodyAsExecutionResult(res)).notToHaveProperty('errors');
+            }),
+        ]),
         ...['string', 0, false, ['array']].map((invalid) => audit(
         // TODO: convert to MUST after watershed
         `SHOULD use 400 status code on ${extendedTypeof(invalid)} {variables} parameter when accepting application/graphql-response+json`, async () => {
@@ -689,8 +723,8 @@ export async function auditServer(opts) {
 }
 /** @private */
 async function getUrl(url) {
-    if (typeof url === 'string') {
-        return url;
+    if (typeof url === 'function') {
+        return await url();
     }
-    return await url();
+    return url;
 }

package/lib/handler.d.mts

@@ -10,7 +10,7 @@ import { RequestParams } from './common';
  *
  * @category Server
  */
-export declare type RequestHeaders = {
+export type RequestHeaders = {
     /**
      * Always an array in Node. Duplicates are added to it.
      * Not necessarily true for other environments.
@@ -54,7 +54,7 @@ export interface Request<Raw, Context> {
  *
  * @category Server
  */
-export declare type ResponseHeaders = {
+export type ResponseHeaders = {
     accept?: string;
     allow?: string;
     'content-type'?: string;
@@ -65,7 +65,7 @@ export declare type ResponseHeaders = {
  *
  * @category Server
  */
-export declare type ResponseBody = string;
+export type ResponseBody = string;
 /**
  * Server agnostic response options (ex. status and headers) returned from
  * `graphql-http` needing to be coerced to the server implementation in use.
@@ -83,7 +83,7 @@ export interface ResponseInit {
  *
  * @category Server
  */
-export declare type Response = readonly [body: ResponseBody | null, init: ResponseInit];
+export type Response = readonly [body: ResponseBody | null, init: ResponseInit];
 /**
  * Checks whether the passed value is the `graphql-http` server agnostic response.
  *
@@ -100,9 +100,9 @@ export declare function isResponse(val: unknown): val is Response;
  *
  * @category Server
  */
-export declare type OperationContext = Record<PropertyKey, unknown> | symbol | number | string | boolean | undefined | null;
+export type OperationContext = Record<PropertyKey, unknown> | symbol | number | string | boolean | undefined | null;
 /** @category Server */
-export declare type OperationArgs<Context extends OperationContext = undefined> = ExecutionArgs & {
+export type OperationArgs<Context extends OperationContext = undefined> = ExecutionArgs & {
     contextValue?: Context;
 };
 /** @category Server */
@@ -150,6 +150,15 @@ export interface HandlerOptions<RequestRaw = unknown, RequestContext = unknown,
      * GraphQL operation AST getter used for detecting the operation type.
      */
     getOperationAST?: typeof graphqlGetOperationAST;
+    /**
+     * The GraphQL root value or resolvers to go alongside the execution.
+     * Learn more about them here: https://graphql.org/learn/execution/#root-fields-resolvers.
+     *
+     * If you return from `onSubscribe`, and the returned value is
+     * missing the `rootValue` field, the relevant operation root
+     * will be used instead.
+     */
+    rootValue?: unknown;
     /**
      * The subscribe callback executed right after processing the request
      * before proceeding with the GraphQL operation execution.
@@ -204,7 +213,7 @@ export interface HandlerOptions<RequestRaw = unknown, RequestContext = unknown,
  *
  * @category Server
  */
-export declare type Handler<RequestRaw = unknown, RequestContext = unknown> = (req: Request<RequestRaw, RequestContext>) => Promise<Response>;
+export type Handler<RequestRaw = unknown, RequestContext = unknown> = (req: Request<RequestRaw, RequestContext>) => Promise<Response>;
 /**
  * Makes a GraphQL over HTTP Protocol compliant server handler. The handler can
  * be used with your favourite server library.
@@ -266,7 +275,7 @@ export declare function createHandler<RequestRaw = unknown, RequestContext = unk
  *
  * @category Server
  */
-export declare type AcceptableMediaType = 'application/graphql-response+json' | 'application/json';
+export type AcceptableMediaType = 'application/graphql-response+json' | 'application/json';
 /**
  * Inspects the request and detects the appropriate/acceptable Media-Type
  * looking at the `Accept` header while complying with the GraphQL over HTTP Protocol.

package/lib/handler.d.ts

@@ -10,7 +10,7 @@ import { RequestParams } from './common';
  *
  * @category Server
  */
-export declare type RequestHeaders = {
+export type RequestHeaders = {
     /**
      * Always an array in Node. Duplicates are added to it.
      * Not necessarily true for other environments.
@@ -54,7 +54,7 @@ export interface Request<Raw, Context> {
  *
  * @category Server
  */
-export declare type ResponseHeaders = {
+export type ResponseHeaders = {
     accept?: string;
     allow?: string;
     'content-type'?: string;
@@ -65,7 +65,7 @@ export declare type ResponseHeaders = {
  *
  * @category Server
  */
-export declare type ResponseBody = string;
+export type ResponseBody = string;
 /**
  * Server agnostic response options (ex. status and headers) returned from
  * `graphql-http` needing to be coerced to the server implementation in use.
@@ -83,7 +83,7 @@ export interface ResponseInit {
  *
  * @category Server
  */
-export declare type Response = readonly [body: ResponseBody | null, init: ResponseInit];
+export type Response = readonly [body: ResponseBody | null, init: ResponseInit];
 /**
  * Checks whether the passed value is the `graphql-http` server agnostic response.
  *
@@ -100,9 +100,9 @@ export declare function isResponse(val: unknown): val is Response;
  *
  * @category Server
  */
-export declare type OperationContext = Record<PropertyKey, unknown> | symbol | number | string | boolean | undefined | null;
+export type OperationContext = Record<PropertyKey, unknown> | symbol | number | string | boolean | undefined | null;
 /** @category Server */
-export declare type OperationArgs<Context extends OperationContext = undefined> = ExecutionArgs & {
+export type OperationArgs<Context extends OperationContext = undefined> = ExecutionArgs & {
     contextValue?: Context;
 };
 /** @category Server */
@@ -150,6 +150,15 @@ export interface HandlerOptions<RequestRaw = unknown, RequestContext = unknown,
      * GraphQL operation AST getter used for detecting the operation type.
      */
     getOperationAST?: typeof graphqlGetOperationAST;
+    /**
+     * The GraphQL root value or resolvers to go alongside the execution.
+     * Learn more about them here: https://graphql.org/learn/execution/#root-fields-resolvers.
+     *
+     * If you return from `onSubscribe`, and the returned value is
+     * missing the `rootValue` field, the relevant operation root
+     * will be used instead.
+     */
+    rootValue?: unknown;
     /**
      * The subscribe callback executed right after processing the request
      * before proceeding with the GraphQL operation execution.
@@ -204,7 +213,7 @@ export interface HandlerOptions<RequestRaw = unknown, RequestContext = unknown,
  *
  * @category Server
  */
-export declare type Handler<RequestRaw = unknown, RequestContext = unknown> = (req: Request<RequestRaw, RequestContext>) => Promise<Response>;
+export type Handler<RequestRaw = unknown, RequestContext = unknown> = (req: Request<RequestRaw, RequestContext>) => Promise<Response>;
 /**
  * Makes a GraphQL over HTTP Protocol compliant server handler. The handler can
  * be used with your favourite server library.
@@ -266,7 +275,7 @@ export declare function createHandler<RequestRaw = unknown, RequestContext = unk
  *
  * @category Server
  */
-export declare type AcceptableMediaType = 'application/graphql-response+json' | 'application/json';
+export type AcceptableMediaType = 'application/graphql-response+json' | 'application/json';
 /**
  * Inspects the request and detects the appropriate/acceptable Media-Type
  * looking at the `Accept` header while complying with the GraphQL over HTTP Protocol.

package/lib/handler.js

@@ -76,7 +76,7 @@ exports.isResponse = isResponse;
  * @category Server
  */
 function createHandler(options) {
-    const { schema, context, validate = graphql_1.validate, execute = graphql_1.execute, parse = graphql_1.parse, getOperationAST = graphql_1.getOperationAST, onSubscribe, onOperation, } = options;
+    const { schema, context, validate = graphql_1.validate, execute = graphql_1.execute, parse = graphql_1.parse, getOperationAST = graphql_1.getOperationAST, rootValue, onSubscribe, onOperation, } = options;
     return async function handler(req) {
         var _a, _b;
         const method = req.method;
@@ -260,6 +260,9 @@ function createHandler(options) {
                 },
             ];
         }
+        if (!('rootValue' in args)) {
+            args.rootValue = rootValue;
+        }
         if (!('contextValue' in args)) {
             const resOrContext = typeof context === 'function' ? await context(req, params) : context;
             if (isResponse(resOrContext))

package/lib/handler.mjs

@@ -72,7 +72,7 @@ export function isResponse(val) {
  * @category Server
  */
 export function createHandler(options) {
-    const { schema, context, validate = graphqlValidate, execute = graphqlExecute, parse = graphqlParse, getOperationAST = graphqlGetOperationAST, onSubscribe, onOperation, } = options;
+    const { schema, context, validate = graphqlValidate, execute = graphqlExecute, parse = graphqlParse, getOperationAST = graphqlGetOperationAST, rootValue, onSubscribe, onOperation, } = options;
     return async function handler(req) {
         var _a, _b;
         const method = req.method;
@@ -256,6 +256,9 @@ export function createHandler(options) {
                 },
             ];
         }
+        if (!('rootValue' in args)) {
+            args.rootValue = rootValue;
+        }
         if (!('contextValue' in args)) {
             const resOrContext = typeof context === 'function' ? await context(req, params) : context;
             if (isResponse(resOrContext))

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graphql-http",
-  "version": "1.8.0",
+  "version": "1.10.0",
   "description": "Simple, pluggable, zero-dependency, GraphQL over HTTP Protocol compliant server and client",
   "keywords": [
     "graphql",
@@ -24,7 +24,7 @@
   "engines": {
     "node": ">=12"
   },
-  "packageManager": "yarn@3.2.4",
+  "packageManager": "yarn@3.3.1",
   "main": "lib/index.js",
   "module": "lib/index.mjs",
   "browser": "umd/graphql-http.js",
@@ -72,12 +72,14 @@
   },
   "scripts": {
     "gendocs": "typedoc --options typedoc.js src/",
-    "lint": "eslint 'src'",
+    "lint:eslint": "eslint 'src'",
+    "lint:prettier": "prettier -c .",
+    "lint": "yarn lint:eslint && yarn lint:prettier",
     "type-check": "tsc --noEmit",
     "test": "NODE_OPTIONS=--experimental-vm-modules jest",
     "build:esm": "tsc -b tsconfig.esm.json && node scripts/esm-post-process.mjs",
     "build:cjs": "tsc -b tsconfig.cjs.json",
-    "build:umd": "rollup -c && gzip umd/graphql-http.min.js -c > umd/graphql-http.min.js.gz",
+    "build:umd": "rollup --bundleConfigAsCjs --config rollup.config.ts --configPlugin typescript && gzip umd/graphql-http.min.js -c > umd/graphql-http.min.js.gz",
     "build": "yarn build:esm && yarn build:cjs && yarn build:umd",
     "release": "semantic-release"
   },
@@ -88,39 +90,40 @@
     "graphql": ">=0.11 <=16"
   },
   "devDependencies": {
-    "@babel/core": "^7.20.2",
+    "@babel/core": "^7.20.7",
     "@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.2",
-    "@babel/plugin-proposal-optional-chaining": "^7.18.9",
+    "@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-typescript": "^9.0.2",
-    "@semantic-release/changelog": "^6.0.1",
+    "@rollup/plugin-terser": "^0.2.1",
+    "@rollup/plugin-typescript": "^10.0.1",
+    "@semantic-release/changelog": "^6.0.2",
     "@semantic-release/git": "^10.0.1",
-    "@types/express": "^4.17.14",
-    "@types/jest": "^29.2.2",
-    "@typescript-eslint/eslint-plugin": "^5.42.1",
-    "@typescript-eslint/parser": "^5.42.1",
-    "@whatwg-node/fetch": "^0.5.1",
-    "babel-jest": "^29.3.0",
-    "eslint": "^8.27.0",
+    "@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",
+    "babel-jest": "^29.3.1",
+    "eslint": "^8.30.0",
     "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-prettier": "^4.2.1",
     "express": "^4.18.2",
-    "fastify": "^4.9.2",
+    "fastify": "^4.10.2",
     "graphql": "^16.6.0",
-    "jest": "^29.3.0",
-    "jest-jasmine2": "^29.3.0",
-    "node-fetch": "^3.2.10",
-    "prettier": "^2.7.1",
-    "rollup": "^3.2.5",
-    "rollup-plugin-terser": "^7.0.2",
+    "jest": "^29.3.1",
+    "jest-jasmine2": "^29.3.1",
+    "node-fetch": "^3.3.0",
+    "prettier": "^2.8.1",
+    "rollup": "^3.8.1",
     "semantic-release": "^19.0.5",
     "tslib": "^2.4.1",
-    "typedoc": "^0.23.20",
-    "typedoc-plugin-markdown": "^3.13.6",
-    "typescript": "^4.8.4"
+    "typedoc": "^0.23.23",
+    "typedoc-plugin-markdown": "^3.14.0",
+    "typescript": "^4.9.4"
   },
   "resolutions": {
     "npm/libnpmversion": "^3.0.6"