@envelop/core 2.2.0-alpha-0de750a.0 → 2.2.0

package/index.js

@@ -1182,7 +1182,7 @@ const useMaskedErrors = (opts) => {
     const isDev = (_b = opts === null || opts === void 0 ? void 0 : opts.isDev) !== null && _b !== void 0 ? _b : (typeof process !== 'undefined' ? process.env['NODE_ENV'] === 'development' : false);
     const handleResult = makeHandleResult$2(format, message, isDev);
     return {
-        onParse: (opts === null || opts === void 0 ? void 0 : opts.onParse) === true
+        onParse: (opts === null || opts === void 0 ? void 0 : opts.handleParseErrors) === true
             ? function onParse() {
                 return function onParseEnd({ result, replaceParseResult }) {
                     if (result instanceof Error) {
@@ -1191,7 +1191,7 @@ const useMaskedErrors = (opts) => {
                 };
             }
             : undefined,
-        onValidate: (opts === null || opts === void 0 ? void 0 : opts.onValidate) === true
+        onValidate: (opts === null || opts === void 0 ? void 0 : opts.handleValidationErrors) === true
             ? function onValidate() {
                 return function onValidateEnd({ valid, result, setResult }) {
                     if (valid === false) {
@@ -1225,12 +1225,15 @@ const useMaskedErrors = (opts) => {
     };
 };
 
-const OnNonIntrospectionFieldReachedValidationRule = (onNonIntrospectionField) => () => {
+const OnNonIntrospectionFieldReachedValidationRule = (onNonIntrospectionField) => ctx => {
+    const rootQueryType = ctx.getSchema().getQueryType();
     return {
         Field(field) {
-            if (!field.name.value.startsWith('__')) {
+            if (ctx.getParentType() === rootQueryType && !field.name.value.startsWith('__')) {
                 onNonIntrospectionField();
+                return graphql.BREAK;
             }
+            return undefined;
         },
     };
 };

package/index.mjs

@@ -1178,7 +1178,7 @@ const useMaskedErrors = (opts) => {
     const isDev = (_b = opts === null || opts === void 0 ? void 0 : opts.isDev) !== null && _b !== void 0 ? _b : (typeof process !== 'undefined' ? process.env['NODE_ENV'] === 'development' : false);
     const handleResult = makeHandleResult$2(format, message, isDev);
     return {
-        onParse: (opts === null || opts === void 0 ? void 0 : opts.onParse) === true
+        onParse: (opts === null || opts === void 0 ? void 0 : opts.handleParseErrors) === true
             ? function onParse() {
                 return function onParseEnd({ result, replaceParseResult }) {
                     if (result instanceof Error) {
@@ -1187,7 +1187,7 @@ const useMaskedErrors = (opts) => {
                 };
             }
             : undefined,
-        onValidate: (opts === null || opts === void 0 ? void 0 : opts.onValidate) === true
+        onValidate: (opts === null || opts === void 0 ? void 0 : opts.handleValidationErrors) === true
             ? function onValidate() {
                 return function onValidateEnd({ valid, result, setResult }) {
                     if (valid === false) {
@@ -1221,12 +1221,15 @@ const useMaskedErrors = (opts) => {
     };
 };
 
-const OnNonIntrospectionFieldReachedValidationRule = (onNonIntrospectionField) => () => {
+const OnNonIntrospectionFieldReachedValidationRule = (onNonIntrospectionField) => ctx => {
+    const rootQueryType = ctx.getSchema().getQueryType();
     return {
         Field(field) {
-            if (!field.name.value.startsWith('__')) {
+            if (ctx.getParentType() === rootQueryType && !field.name.value.startsWith('__')) {
                 onNonIntrospectionField();
+                return BREAK;
             }
+            return undefined;
         },
     };
 };

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@envelop/core",
-  "version": "2.2.0-alpha-0de750a.0",
+  "version": "2.2.0",
   "sideEffects": false,
   "peerDependencies": {
     "graphql": "^14.0.0 || ^15.0.0 || ^16.0.0"
   },
   "dependencies": {
-    "@envelop/types": "2.1.0-alpha-0de750a.0"
+    "@envelop/types": "2.1.0"
   },
   "repository": {
     "type": "git",

package/plugins/use-masked-errors.d.ts

@@ -17,14 +17,23 @@ export declare type UseMaskedErrorsOpts = {
      */
     isDev?: boolean;
     /**
-     * Whether parse errors should be masked.
+     * Whether parse errors should be processed by this plugin.
+     * In general it is not recommend to set this flag to `true`
+     * as a `parse` error contains useful information for debugging a GraphQL operation.
+     * A `parse` error never contains any sensitive information.
      * @default false
      */
-    onParse?: boolean;
+    handleParseErrors?: boolean;
     /**
-     * Whether validation errors should be masked.
+     * Whether validation errors should processed by this plugin.
+     * In general we recommend against setting this flag to `true`
+     * as a `validate` error contains useful information for debugging a GraphQL operation.
+     * A `validate` error contains "did you mean x" suggestions that make it easier
+     * to reverse-introspect a GraphQL schema whose introspection capabilities got disabled.
+     * Instead of disabling introspection and masking validation errors, using persisted operations
+     * is a safer solution for avoiding the execution of unwanted/arbitrary operations.
      * @default false
      */
-    onValidate?: boolean;
+    handleValidationErrors?: boolean;
 };
 export declare const useMaskedErrors: (opts?: UseMaskedErrorsOpts | undefined) => Plugin;