graphql-http 1.13.0 → 1.14.0

package/lib/handler.d.mts

@@ -3,7 +3,7 @@
  * handler
  *
  */
-import { ExecutionArgs, ExecutionResult, GraphQLSchema, validate as graphqlValidate, execute as graphqlExecute, parse as graphqlParse, getOperationAST as graphqlGetOperationAST, GraphQLError } from 'graphql';
+import { ExecutionArgs, ExecutionResult, GraphQLSchema, validate as graphqlValidate, ValidationRule, execute as graphqlExecute, parse as graphqlParse, getOperationAST as graphqlGetOperationAST, GraphQLError } from 'graphql';
 import { RequestParams } from './common';
 /**
  * The incoming request headers the implementing server should provide.
@@ -137,6 +137,19 @@ export interface HandlerOptions<RequestRaw = unknown, RequestContext = unknown,
      * Will not be used when implementing a custom `onSubscribe`.
      */
     validate?: typeof graphqlValidate;
+    /**
+     * The validation rules for running GraphQL validate.
+     *
+     * When providing an array, the rules will be APPENDED to the default
+     * `specifiedRules` array provided by the graphql-js module.
+     *
+     * Alternatively, providing a function instead will OVERWRITE the defaults
+     * and use exclusively the rules returned by the function. The third (last)
+     * argument of the function are the default `specifiedRules` array provided
+     * by the graphql-js module, you're free to prepend/append the defaults to
+     * your rule set, or omit them altogether.
+     */
+    validationRules?: readonly ValidationRule[] | ((req: Request<RequestRaw, RequestContext>, args: OperationArgs<Context>, specifiedRules: readonly ValidationRule[]) => Promise<readonly ValidationRule[]> | readonly ValidationRule[]);
     /**
      * Is the `execute` function from GraphQL which is
      * used to execute the query and mutation operations.

package/lib/handler.d.ts

@@ -3,7 +3,7 @@
  * handler
  *
  */
-import { ExecutionArgs, ExecutionResult, GraphQLSchema, validate as graphqlValidate, execute as graphqlExecute, parse as graphqlParse, getOperationAST as graphqlGetOperationAST, GraphQLError } from 'graphql';
+import { ExecutionArgs, ExecutionResult, GraphQLSchema, validate as graphqlValidate, ValidationRule, execute as graphqlExecute, parse as graphqlParse, getOperationAST as graphqlGetOperationAST, GraphQLError } from 'graphql';
 import { RequestParams } from './common';
 /**
  * The incoming request headers the implementing server should provide.
@@ -137,6 +137,19 @@ export interface HandlerOptions<RequestRaw = unknown, RequestContext = unknown,
      * Will not be used when implementing a custom `onSubscribe`.
      */
     validate?: typeof graphqlValidate;
+    /**
+     * The validation rules for running GraphQL validate.
+     *
+     * When providing an array, the rules will be APPENDED to the default
+     * `specifiedRules` array provided by the graphql-js module.
+     *
+     * Alternatively, providing a function instead will OVERWRITE the defaults
+     * and use exclusively the rules returned by the function. The third (last)
+     * argument of the function are the default `specifiedRules` array provided
+     * by the graphql-js module, you're free to prepend/append the defaults to
+     * your rule set, or omit them altogether.
+     */
+    validationRules?: readonly ValidationRule[] | ((req: Request<RequestRaw, RequestContext>, args: OperationArgs<Context>, specifiedRules: readonly ValidationRule[]) => Promise<readonly ValidationRule[]> | readonly ValidationRule[]);
     /**
      * Is the `execute` function from GraphQL which is
      * used to execute the query and mutation operations.

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, rootValue, onSubscribe, onOperation, } = options;
+    const { schema, context, validate = graphql_1.validate, validationRules = [], 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;
@@ -226,7 +226,14 @@ function createHandler(options) {
             else {
                 args = Object.assign(Object.assign({}, argsWithoutSchema), { schema });
             }
-            const validationErrs = validate(args.schema, args.document);
+            let rules = graphql_1.specifiedRules;
+            if (typeof validationRules === 'function') {
+                rules = await validationRules(req, args, graphql_1.specifiedRules);
+            }
+            else {
+                rules = [...rules, ...validationRules];
+            }
+            const validationErrs = validate(args.schema, args.document, rules);
             if (validationErrs.length) {
                 return makeResponse(validationErrs, acceptedMediaType);
             }

package/lib/handler.mjs

@@ -3,7 +3,7 @@
  * handler
  *
  */
-import { validate as graphqlValidate, execute as graphqlExecute, parse as graphqlParse, getOperationAST as graphqlGetOperationAST, GraphQLError, } from 'graphql';
+import { validate as graphqlValidate, specifiedRules, execute as graphqlExecute, parse as graphqlParse, getOperationAST as graphqlGetOperationAST, GraphQLError, } from 'graphql';
 import { areGraphQLErrors, isAsyncIterable, isExecutionResult, isGraphQLError, isObject, } from './utils.mjs';
 /**
  * Checks whether the passed value is the `graphql-http` server agnostic response.
@@ -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, rootValue, onSubscribe, onOperation, } = options;
+    const { schema, context, validate = graphqlValidate, validationRules = [], execute = graphqlExecute, parse = graphqlParse, getOperationAST = graphqlGetOperationAST, rootValue, onSubscribe, onOperation, } = options;
     return async function handler(req) {
         var _a, _b;
         const method = req.method;
@@ -222,7 +222,14 @@ export function createHandler(options) {
             else {
                 args = Object.assign(Object.assign({}, argsWithoutSchema), { schema });
             }
-            const validationErrs = validate(args.schema, args.document);
+            let rules = specifiedRules;
+            if (typeof validationRules === 'function') {
+                rules = await validationRules(req, args, specifiedRules);
+            }
+            else {
+                rules = [...rules, ...validationRules];
+            }
+            const validationErrs = validate(args.schema, args.document, rules);
             if (validationErrs.length) {
                 return makeResponse(validationErrs, acceptedMediaType);
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graphql-http",
-  "version": "1.13.0",
+  "version": "1.14.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.3.1",
+  "packageManager": "yarn@3.4.1",
   "main": "lib/index.js",
   "module": "lib/index.mjs",
   "browser": "umd/graphql-http.js",
@@ -106,33 +106,33 @@
     "@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.16",
+    "@types/eslint": "^8.21.0",
+    "@types/express": "^4.17.17",
     "@types/glob": "^8.0.1",
     "@types/jest": "^29.4.0",
     "@types/koa": "^2.13.5",
     "@types/koa-mount": "^4.0.2",
-    "@typescript-eslint/eslint-plugin": "^5.49.0",
-    "@typescript-eslint/parser": "^5.49.0",
-    "@whatwg-node/fetch": "^0.6.2",
-    "babel-jest": "^29.4.0",
-    "eslint": "^8.32.0",
+    "@typescript-eslint/eslint-plugin": "^5.51.0",
+    "@typescript-eslint/parser": "^5.51.0",
+    "@whatwg-node/fetch": "^0.7.0",
+    "babel-jest": "^29.4.2",
+    "eslint": "^8.33.0",
     "eslint-config-prettier": "^8.6.0",
     "express": "^4.18.2",
     "fastify": "^4.12.0",
     "graphql": "^16.6.0",
-    "jest": "^29.4.0",
-    "jest-jasmine2": "^29.4.0",
+    "jest": "^29.4.2",
+    "jest-jasmine2": "^29.4.2",
     "koa": "^2.14.1",
     "koa-mount": "^4.0.0",
     "node-fetch": "^3.3.0",
-    "prettier": "^2.8.3",
-    "rollup": "^3.11.0",
+    "prettier": "^2.8.4",
+    "rollup": "^3.14.0",
     "semantic-release": "^20.1.0",
-    "tslib": "^2.4.1",
+    "tslib": "^2.5.0",
     "typedoc": "^0.23.24",
     "typedoc-plugin-markdown": "^3.14.0",
-    "typescript": "^4.9.4"
+    "typescript": "^4.9.5"
   },
   "resolutions": {
     "npm/libnpmversion": "^3.0.6"