@envelop/on-resolve 4.0.0 → 4.1.0-alpha-20231017135127-dcc5719a

package/cjs/index.js

@@ -7,7 +7,7 @@ const graphql_1 = require("graphql");
  *
  * Use the `onResolve` argument to manipulate the resolver and its results/errors.
  */
-function useOnResolve(onResolve) {
+function useOnResolve(onResolve, opts = { skipIntrospection: true }) {
     const hasWrappedResolveSymbol = Symbol('hasWrappedResolve');
     return {
         onSchemaChange({ schema: _schema }) {
@@ -15,7 +15,7 @@ function useOnResolve(onResolve) {
             if (!schema)
                 return; // nothing to do if schema is missing
             for (const type of Object.values(schema.getTypeMap())) {
-                if (!(0, graphql_1.isIntrospectionType)(type) && (0, graphql_1.isObjectType)(type)) {
+                if ((!opts.skipIntrospection || !(0, graphql_1.isIntrospectionType)(type)) && (0, graphql_1.isObjectType)(type)) {
                     for (const field of Object.values(type.getFields())) {
                         if (field[hasWrappedResolveSymbol])
                             continue;

package/esm/index.js

@@ -4,7 +4,7 @@ import { defaultFieldResolver, isIntrospectionType, isObjectType, } from 'graphq
  *
  * Use the `onResolve` argument to manipulate the resolver and its results/errors.
  */
-export function useOnResolve(onResolve) {
+export function useOnResolve(onResolve, opts = { skipIntrospection: true }) {
     const hasWrappedResolveSymbol = Symbol('hasWrappedResolve');
     return {
         onSchemaChange({ schema: _schema }) {
@@ -12,7 +12,7 @@ export function useOnResolve(onResolve) {
             if (!schema)
                 return; // nothing to do if schema is missing
             for (const type of Object.values(schema.getTypeMap())) {
-                if (!isIntrospectionType(type) && isObjectType(type)) {
+                if ((!opts.skipIntrospection || !isIntrospectionType(type)) && isObjectType(type)) {
                     for (const field of Object.values(type.getFields())) {
                         if (field[hasWrappedResolveSymbol])
                             continue;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@envelop/on-resolve",
-  "version": "4.0.0",
+  "version": "4.1.0-alpha-20231017135127-dcc5719a",
   "sideEffects": false,
   "peerDependencies": {
     "@envelop/core": "^5.0.0",

package/typings/index.d.cts

@@ -14,9 +14,17 @@ export interface OnResolveOptions<PluginContext extends Record<string, any> = {}
     replaceResolver: (newResolver: Resolver<PluginContext>) => void;
 }
 export type OnResolve<PluginContext extends Record<string, any> = {}> = (options: OnResolveOptions<PluginContext>) => PromiseOrValue<AfterResolver | void>;
+export type UseOnResolveOptions = {
+    /**
+     * Skip executing the `onResolve` hook on introspection queries.
+     *
+     * @default true
+     */
+    skipIntrospection?: boolean;
+};
 /**
  * Wraps the provided schema by hooking into the resolvers of every field.
  *
  * Use the `onResolve` argument to manipulate the resolver and its results/errors.
  */
-export declare function useOnResolve<PluginContext extends Record<string, any> = {}>(onResolve: OnResolve<PluginContext>): Plugin<PluginContext>;
+export declare function useOnResolve<PluginContext extends Record<string, any> = {}>(onResolve: OnResolve<PluginContext>, opts?: UseOnResolveOptions): Plugin<PluginContext>;

package/typings/index.d.ts

@@ -14,9 +14,17 @@ export interface OnResolveOptions<PluginContext extends Record<string, any> = {}
     replaceResolver: (newResolver: Resolver<PluginContext>) => void;
 }
 export type OnResolve<PluginContext extends Record<string, any> = {}> = (options: OnResolveOptions<PluginContext>) => PromiseOrValue<AfterResolver | void>;
+export type UseOnResolveOptions = {
+    /**
+     * Skip executing the `onResolve` hook on introspection queries.
+     *
+     * @default true
+     */
+    skipIntrospection?: boolean;
+};
 /**
  * Wraps the provided schema by hooking into the resolvers of every field.
  *
  * Use the `onResolve` argument to manipulate the resolver and its results/errors.
  */
-export declare function useOnResolve<PluginContext extends Record<string, any> = {}>(onResolve: OnResolve<PluginContext>): Plugin<PluginContext>;
+export declare function useOnResolve<PluginContext extends Record<string, any> = {}>(onResolve: OnResolve<PluginContext>, opts?: UseOnResolveOptions): Plugin<PluginContext>;