@envelop/core 1.1.0 → 1.4.0-alpha-e8998c9.0

package/create.d.ts

@@ -1,5 +1,6 @@
 import { GetEnvelopedFn, ComposeContext, Plugin } from '@envelop/types';
+import { PluginOrDisabledPlugin } from './enable-if';
 export declare function envelop<PluginsType extends Plugin<any>[]>(options: {
-    plugins: PluginsType;
+    plugins: Array<PluginOrDisabledPlugin>;
     enableInternalTracing?: boolean;
 }): GetEnvelopedFn<ComposeContext<PluginsType>>;

package/enable-if.d.ts

@@ -0,0 +1,14 @@
+import { Plugin } from '@envelop/types';
+/**
+ * This enum is used only internally in order to create nominal type for the disabled plugin
+ */
+declare enum EnableIfBranded {
+    DisabledPlugin = 0
+}
+export declare type PluginOrDisabledPlugin = Plugin<any> | EnableIfBranded.DisabledPlugin;
+export declare function isPluginEnabled(t: PluginOrDisabledPlugin): t is Plugin;
+/**
+ * Utility function to enable a plugin.
+ */
+export declare function enableIf(condition: boolean, plugin: Plugin): PluginOrDisabledPlugin;
+export {};

package/index.d.ts

@@ -9,3 +9,4 @@ export * from './plugins/use-error-handler';
 export * from './plugins/use-extend-context';
 export * from './plugins/use-payload-formatter';
 export * from './plugins/use-masked-errors';
+export * from './enable-if';

package/index.js

@@ -5,6 +5,23 @@ Object.defineProperty(exports, '__esModule', { value: true });
 const types = require('@envelop/types');
 const graphql = require('graphql');
 
+/**
+ * This enum is used only internally in order to create nominal type for the disabled plugin
+ */
+var EnableIfBranded;
+(function (EnableIfBranded) {
+    EnableIfBranded[EnableIfBranded["DisabledPlugin"] = 0] = "DisabledPlugin";
+})(EnableIfBranded || (EnableIfBranded = {}));
+function isPluginEnabled(t) {
+    return t !== EnableIfBranded.DisabledPlugin && t !== null;
+}
+/**
+ * Utility function to enable a plugin.
+ */
+function enableIf(condition, plugin) {
+    return condition ? plugin : EnableIfBranded.DisabledPlugin;
+}
+
 const trackedSchemaSymbol = Symbol('TRACKED_SCHEMA');
 const resolversHooksSymbol = Symbol('RESOLVERS_HOOKS');
 function prepareTracedSchema(schema) {
@@ -400,11 +417,14 @@ function createEnvelopOrchestrator(plugins) {
         let result = await subscribeFn({
             ...args,
             contextValue: context,
+            // Casted for GraphQL.js 15 compatibility
+            // Can be removed once we drop support for GraphQL.js 15
         });
         const onNextHandler = [];
         const onEndHandler = [];
         for (const afterCb of afterCalls) {
             const hookResult = afterCb({
+                args: args,
                 result,
                 setResult: newResult => {
                     result = newResult;
@@ -422,7 +442,11 @@ function createEnvelopOrchestrator(plugins) {
         if (onNextHandler.length && types.isAsyncIterable(result)) {
             result = mapAsyncIterator(result, async (result) => {
                 for (const onNext of onNextHandler) {
-                    await onNext({ result, setResult: newResult => (result = newResult) });
+                    await onNext({
+                        args: args,
+                        result,
+                        setResult: newResult => (result = newResult),
+                    });
                 }
                 return result;
             });
@@ -504,6 +528,7 @@ function createEnvelopOrchestrator(plugins) {
             const onEndHandler = [];
             for (const afterCb of afterCalls) {
                 const hookResult = afterCb({
+                    args: args,
                     result,
                     setResult: newResult => {
                         result = newResult;
@@ -521,7 +546,11 @@ function createEnvelopOrchestrator(plugins) {
             if (onNextHandler.length && types.isAsyncIterable(result)) {
                 result = mapAsyncIterator(result, async (result) => {
                     for (const onNext of onNextHandler) {
-                        await onNext({ result, setResult: newResult => (result = newResult) });
+                        await onNext({
+                            args: args,
+                            result,
+                            setResult: newResult => (result = newResult),
+                        });
                     }
                     return result;
                 });
@@ -627,12 +656,16 @@ function traceOrchestrator(orchestrator) {
                     typeResolver,
                 }
                 : argsOrSchema;
+            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+            // @ts-ignore GraphQL.js types contextValue as unknown
             const done = createTracer('execute', args.contextValue || {});
             try {
                 const result = await orchestrator.execute(args);
                 done();
                 if (!types.isAsyncIterable(result)) {
                     result.extensions = result.extensions || {};
+                    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+                    // @ts-ignore GraphQL.js types contextValue as unknown
                     result.extensions.envelopTracing = args.contextValue._envelopTracing;
                 }
                 else {
@@ -659,6 +692,8 @@ function traceOrchestrator(orchestrator) {
                     subscribeFieldResolver,
                 }
                 : argsOrSchema;
+            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+            // @ts-ignore GraphQL.js types contextValue as unknown
             const done = createTracer('subscribe', args.contextValue || {});
             try {
                 return await orchestrator.subscribe(args);
@@ -683,7 +718,8 @@ function traceOrchestrator(orchestrator) {
 }
 
 function envelop(options) {
-    let orchestrator = createEnvelopOrchestrator(options.plugins);
+    const plugins = options.plugins.filter(isPluginEnabled);
+    let orchestrator = createEnvelopOrchestrator(plugins);
     if (options.enableInternalTracing) {
         orchestrator = traceOrchestrator(orchestrator);
     }
@@ -699,7 +735,7 @@ function envelop(options) {
             schema: typedOrchestrator.getCurrentSchema(),
         };
     };
-    getEnveloped._plugins = options.plugins;
+    getEnveloped._plugins = plugins;
     return getEnveloped;
 }
 
@@ -911,10 +947,10 @@ const useAsyncSchema = (schemaPromise) => {
     };
 };
 
-const makeHandleResult = (errorHandler) => ({ result }) => {
+const makeHandleResult = (errorHandler) => ({ result, args }) => {
     var _a;
     if ((_a = result.errors) === null || _a === void 0 ? void 0 : _a.length) {
-        errorHandler(result.errors);
+        errorHandler(result.errors, args);
     }
 };
 const useErrorHandler = (errorHandler) => ({
@@ -951,33 +987,35 @@ const usePayloadFormatter = (formatter) => ({
     },
 });
 
+const DEFAULT_ERROR_MESSAGE = 'Unexpected error.';
 class EnvelopError extends graphql.GraphQLError {
     constructor(message, extensions) {
         super(message, undefined, undefined, undefined, undefined, undefined, extensions);
     }
 }
-const formatError = err => {
+const formatError = (err, message) => {
     if (err instanceof graphql.GraphQLError) {
         if (err.originalError && err.originalError instanceof EnvelopError === false) {
-            return new graphql.GraphQLError('Unexpected error.', err.nodes, err.source, err.positions, err.path, undefined);
+            return new graphql.GraphQLError(message, err.nodes, err.source, err.positions, err.path, undefined);
         }
         return err;
     }
-    return new graphql.GraphQLError('Unexpected error.');
+    return new graphql.GraphQLError(message);
 };
-const makeHandleResult$2 = (format) => ({ result, setResult }) => {
+const makeHandleResult$2 = (format, message) => ({ result, setResult }) => {
     if (result.errors != null) {
-        setResult({ ...result, errors: result.errors.map(error => format(error)) });
+        setResult({ ...result, errors: result.errors.map(error => format(error, message)) });
     }
 };
 const useMaskedErrors = (opts) => {
     var _a;
     const format = (_a = opts === null || opts === void 0 ? void 0 : opts.formatError) !== null && _a !== void 0 ? _a : formatError;
-    const handleResult = makeHandleResult$2(format);
+    const message = (opts === null || opts === void 0 ? void 0 : opts.errorMessage) || DEFAULT_ERROR_MESSAGE;
+    const handleResult = makeHandleResult$2(format, message);
     return {
         onPluginInit(context) {
             context.registerContextErrorHandler(({ error, setError }) => {
-                setError(formatError(error));
+                setError(formatError(error, message));
             });
         },
         onExecute() {
@@ -993,7 +1031,7 @@ const useMaskedErrors = (opts) => {
                     return types.handleStreamOrSingleExecutionResult(payload, handleResult);
                 },
                 onSubscribeError({ error, setError }) {
-                    setError(formatError(error));
+                    setError(formatError(error, message));
                 },
             };
         },
@@ -1008,7 +1046,9 @@ Object.keys(types).forEach(function (k) {
         }
     });
 });
+exports.DEFAULT_ERROR_MESSAGE = DEFAULT_ERROR_MESSAGE;
 exports.EnvelopError = EnvelopError;
+exports.enableIf = enableIf;
 exports.envelop = envelop;
 exports.envelopIsIntrospectionSymbol = envelopIsIntrospectionSymbol;
 exports.errorAsyncIterator = errorAsyncIterator;
@@ -1018,6 +1058,7 @@ exports.isIntrospectionDocument = isIntrospectionDocument;
 exports.isIntrospectionOperation = isIntrospectionOperation;
 exports.isIntrospectionOperationString = isIntrospectionOperationString;
 exports.isOperationDefinition = isOperationDefinition;
+exports.isPluginEnabled = isPluginEnabled;
 exports.makeExecute = makeExecute;
 exports.makeSubscribe = makeSubscribe;
 exports.mapAsyncIterator = mapAsyncIterator;

package/index.mjs

@@ -2,6 +2,23 @@ import { isAsyncIterable, handleStreamOrSingleExecutionResult } from '@envelop/t
 export * from '@envelop/types';
 import { isIntrospectionType, isObjectType, defaultFieldResolver, Kind, visit, BREAK, parse, specifiedRules, validate, execute, subscribe, GraphQLSchema, getOperationAST, GraphQLError } from 'graphql';
 
+/**
+ * This enum is used only internally in order to create nominal type for the disabled plugin
+ */
+var EnableIfBranded;
+(function (EnableIfBranded) {
+    EnableIfBranded[EnableIfBranded["DisabledPlugin"] = 0] = "DisabledPlugin";
+})(EnableIfBranded || (EnableIfBranded = {}));
+function isPluginEnabled(t) {
+    return t !== EnableIfBranded.DisabledPlugin && t !== null;
+}
+/**
+ * Utility function to enable a plugin.
+ */
+function enableIf(condition, plugin) {
+    return condition ? plugin : EnableIfBranded.DisabledPlugin;
+}
+
 const trackedSchemaSymbol = Symbol('TRACKED_SCHEMA');
 const resolversHooksSymbol = Symbol('RESOLVERS_HOOKS');
 function prepareTracedSchema(schema) {
@@ -397,11 +414,14 @@ function createEnvelopOrchestrator(plugins) {
         let result = await subscribeFn({
             ...args,
             contextValue: context,
+            // Casted for GraphQL.js 15 compatibility
+            // Can be removed once we drop support for GraphQL.js 15
         });
         const onNextHandler = [];
         const onEndHandler = [];
         for (const afterCb of afterCalls) {
             const hookResult = afterCb({
+                args: args,
                 result,
                 setResult: newResult => {
                     result = newResult;
@@ -419,7 +439,11 @@ function createEnvelopOrchestrator(plugins) {
         if (onNextHandler.length && isAsyncIterable(result)) {
             result = mapAsyncIterator(result, async (result) => {
                 for (const onNext of onNextHandler) {
-                    await onNext({ result, setResult: newResult => (result = newResult) });
+                    await onNext({
+                        args: args,
+                        result,
+                        setResult: newResult => (result = newResult),
+                    });
                 }
                 return result;
             });
@@ -501,6 +525,7 @@ function createEnvelopOrchestrator(plugins) {
             const onEndHandler = [];
             for (const afterCb of afterCalls) {
                 const hookResult = afterCb({
+                    args: args,
                     result,
                     setResult: newResult => {
                         result = newResult;
@@ -518,7 +543,11 @@ function createEnvelopOrchestrator(plugins) {
             if (onNextHandler.length && isAsyncIterable(result)) {
                 result = mapAsyncIterator(result, async (result) => {
                     for (const onNext of onNextHandler) {
-                        await onNext({ result, setResult: newResult => (result = newResult) });
+                        await onNext({
+                            args: args,
+                            result,
+                            setResult: newResult => (result = newResult),
+                        });
                     }
                     return result;
                 });
@@ -624,12 +653,16 @@ function traceOrchestrator(orchestrator) {
                     typeResolver,
                 }
                 : argsOrSchema;
+            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+            // @ts-ignore GraphQL.js types contextValue as unknown
             const done = createTracer('execute', args.contextValue || {});
             try {
                 const result = await orchestrator.execute(args);
                 done();
                 if (!isAsyncIterable(result)) {
                     result.extensions = result.extensions || {};
+                    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+                    // @ts-ignore GraphQL.js types contextValue as unknown
                     result.extensions.envelopTracing = args.contextValue._envelopTracing;
                 }
                 else {
@@ -656,6 +689,8 @@ function traceOrchestrator(orchestrator) {
                     subscribeFieldResolver,
                 }
                 : argsOrSchema;
+            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+            // @ts-ignore GraphQL.js types contextValue as unknown
             const done = createTracer('subscribe', args.contextValue || {});
             try {
                 return await orchestrator.subscribe(args);
@@ -680,7 +715,8 @@ function traceOrchestrator(orchestrator) {
 }
 
 function envelop(options) {
-    let orchestrator = createEnvelopOrchestrator(options.plugins);
+    const plugins = options.plugins.filter(isPluginEnabled);
+    let orchestrator = createEnvelopOrchestrator(plugins);
     if (options.enableInternalTracing) {
         orchestrator = traceOrchestrator(orchestrator);
     }
@@ -696,7 +732,7 @@ function envelop(options) {
             schema: typedOrchestrator.getCurrentSchema(),
         };
     };
-    getEnveloped._plugins = options.plugins;
+    getEnveloped._plugins = plugins;
     return getEnveloped;
 }
 
@@ -908,10 +944,10 @@ const useAsyncSchema = (schemaPromise) => {
     };
 };
 
-const makeHandleResult = (errorHandler) => ({ result }) => {
+const makeHandleResult = (errorHandler) => ({ result, args }) => {
     var _a;
     if ((_a = result.errors) === null || _a === void 0 ? void 0 : _a.length) {
-        errorHandler(result.errors);
+        errorHandler(result.errors, args);
     }
 };
 const useErrorHandler = (errorHandler) => ({
@@ -948,33 +984,35 @@ const usePayloadFormatter = (formatter) => ({
     },
 });
 
+const DEFAULT_ERROR_MESSAGE = 'Unexpected error.';
 class EnvelopError extends GraphQLError {
     constructor(message, extensions) {
         super(message, undefined, undefined, undefined, undefined, undefined, extensions);
     }
 }
-const formatError = err => {
+const formatError = (err, message) => {
     if (err instanceof GraphQLError) {
         if (err.originalError && err.originalError instanceof EnvelopError === false) {
-            return new GraphQLError('Unexpected error.', err.nodes, err.source, err.positions, err.path, undefined);
+            return new GraphQLError(message, err.nodes, err.source, err.positions, err.path, undefined);
         }
         return err;
     }
-    return new GraphQLError('Unexpected error.');
+    return new GraphQLError(message);
 };
-const makeHandleResult$2 = (format) => ({ result, setResult }) => {
+const makeHandleResult$2 = (format, message) => ({ result, setResult }) => {
     if (result.errors != null) {
-        setResult({ ...result, errors: result.errors.map(error => format(error)) });
+        setResult({ ...result, errors: result.errors.map(error => format(error, message)) });
     }
 };
 const useMaskedErrors = (opts) => {
     var _a;
     const format = (_a = opts === null || opts === void 0 ? void 0 : opts.formatError) !== null && _a !== void 0 ? _a : formatError;
-    const handleResult = makeHandleResult$2(format);
+    const message = (opts === null || opts === void 0 ? void 0 : opts.errorMessage) || DEFAULT_ERROR_MESSAGE;
+    const handleResult = makeHandleResult$2(format, message);
     return {
         onPluginInit(context) {
             context.registerContextErrorHandler(({ error, setError }) => {
-                setError(formatError(error));
+                setError(formatError(error, message));
             });
         },
         onExecute() {
@@ -990,11 +1028,11 @@ const useMaskedErrors = (opts) => {
                     return handleStreamOrSingleExecutionResult(payload, handleResult);
                 },
                 onSubscribeError({ error, setError }) {
-                    setError(formatError(error));
+                    setError(formatError(error, message));
                 },
             };
         },
     };
 };
 
-export { EnvelopError, envelop, envelopIsIntrospectionSymbol, errorAsyncIterator, finalAsyncIterator, formatError, isIntrospectionDocument, isIntrospectionOperation, isIntrospectionOperationString, isOperationDefinition, makeExecute, makeSubscribe, mapAsyncIterator, useAsyncSchema, useEnvelop, useErrorHandler, useExtendContext, useLazyLoadedSchema, useLogger, useMaskedErrors, usePayloadFormatter, useSchema, useTiming };
+export { DEFAULT_ERROR_MESSAGE, EnvelopError, enableIf, envelop, envelopIsIntrospectionSymbol, errorAsyncIterator, finalAsyncIterator, formatError, isIntrospectionDocument, isIntrospectionOperation, isIntrospectionOperationString, isOperationDefinition, isPluginEnabled, makeExecute, makeSubscribe, mapAsyncIterator, useAsyncSchema, useEnvelop, useErrorHandler, useExtendContext, useLazyLoadedSchema, useLogger, useMaskedErrors, usePayloadFormatter, useSchema, useTiming };

package/orchestrator.d.ts

@@ -1,4 +1,4 @@
-import { ArbitraryObject, EnvelopContextFnWrapper, GetEnvelopedFn, Plugin } from '@envelop/types';
+import { ArbitraryObject, EnvelopContextFnWrapper, GetEnvelopedFn, Plugin, DefaultContext } from '@envelop/types';
 import { GraphQLSchema } from 'graphql';
 import { Maybe } from 'graphql/jsutils/Maybe';
 export declare type EnvelopOrchestrator<InitialContext extends ArbitraryObject = ArbitraryObject, PluginsContext extends ArbitraryObject = ArbitraryObject> = {
@@ -10,4 +10,4 @@ export declare type EnvelopOrchestrator<InitialContext extends ArbitraryObject =
     contextFactory: EnvelopContextFnWrapper<ReturnType<GetEnvelopedFn<PluginsContext>>['contextFactory'], PluginsContext>;
     getCurrentSchema: () => Maybe<GraphQLSchema>;
 };
-export declare function createEnvelopOrchestrator<PluginsContext = any>(plugins: Plugin[]): EnvelopOrchestrator<any, PluginsContext>;
+export declare function createEnvelopOrchestrator<PluginsContext extends DefaultContext>(plugins: Plugin[]): EnvelopOrchestrator<any, PluginsContext>;

package/package.json

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

package/plugins/use-error-handler.d.ts

@@ -1,4 +1,4 @@
-import { Plugin } from '@envelop/types';
+import { Plugin, DefaultContext } from '@envelop/types';
 import { GraphQLError } from 'graphql';
-export declare type ErrorHandler = (errors: readonly GraphQLError[]) => void;
-export declare const useErrorHandler: (errorHandler: ErrorHandler) => Plugin;
+export declare type ErrorHandler = (errors: readonly GraphQLError[], context: Readonly<DefaultContext>) => void;
+export declare const useErrorHandler: <ContextType>(errorHandler: ErrorHandler) => Plugin<ContextType>;

package/plugins/use-logger.d.ts

@@ -1,5 +1,5 @@
 import { Plugin } from '@envelop/types';
-import { envelopIsIntrospectionSymbol } from '..';
+import { envelopIsIntrospectionSymbol } from '../utils';
 declare type LoggerPluginOptions = {
     logFn: typeof console.log;
     skipIntrospection?: boolean;

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

@@ -1,11 +1,13 @@
 import { Plugin } from '@envelop/types';
 import { GraphQLError } from 'graphql';
+export declare const DEFAULT_ERROR_MESSAGE = "Unexpected error.";
 export declare class EnvelopError extends GraphQLError {
     constructor(message: string, extensions?: Record<string, any>);
 }
-export declare type FormatErrorHandler = (error: GraphQLError | unknown) => GraphQLError;
+export declare type FormatErrorHandler = (error: GraphQLError | unknown, message: string) => GraphQLError;
 export declare const formatError: FormatErrorHandler;
 export declare type UseMaskedErrorsOpts = {
     formatError?: FormatErrorHandler;
+    errorMessage?: string;
 };
 export declare const useMaskedErrors: (opts?: UseMaskedErrorsOpts | undefined) => Plugin;

package/plugins/use-timing.d.ts

@@ -1,6 +1,6 @@
 import { Plugin } from '@envelop/types';
 import { DocumentNode, ExecutionArgs, GraphQLResolveInfo, Source, SubscriptionArgs } from 'graphql';
-import { envelopIsIntrospectionSymbol } from '..';
+import { envelopIsIntrospectionSymbol } from '../utils';
 export declare type ResultTiming = {
     ms: number;
     ns: number;

package/utils.d.ts

@@ -9,11 +9,11 @@ export declare function isIntrospectionOperationString(operation: string | Sourc
 /**
  * Utility function for making a subscribe function that handles polymorphic arguments.
  */
-export declare const makeSubscribe: (subscribeFn: (args: SubscriptionArgs) => PromiseOrValue<AsyncIterableIterator<ExecutionResult> | ExecutionResult>) => SubscribeFunction;
-export declare function mapAsyncIterator<TInput, TOutput = TInput>(asyncIterable: AsyncIterableIterator<TInput>, map: (input: TInput) => Promise<TOutput> | TOutput): AsyncIterableIterator<TOutput>;
+export declare const makeSubscribe: (subscribeFn: (args: SubscriptionArgs) => PromiseOrValue<AsyncIterableIterator<ExecutionResult>>) => SubscribeFunction;
+export declare function mapAsyncIterator<TInput, TOutput = TInput>(asyncIterable: AsyncIterable<TInput>, map: (input: TInput) => Promise<TOutput> | TOutput): AsyncIterableIterator<TOutput>;
 /**
  * Utility function for making a execute function that handles polymorphic arguments.
  */
 export declare const makeExecute: (executeFn: (args: ExecutionArgs) => PromiseOrValue<AsyncIterableIteratorOrValue<ExecutionResult>>) => ExecuteFunction;
-export declare function finalAsyncIterator<TInput>(asyncIterable: AsyncIterableIterator<TInput>, onFinal: () => void): AsyncIterableIterator<TInput>;
-export declare function errorAsyncIterator<TInput>(asyncIterable: AsyncIterableIterator<TInput>, onError: (err: unknown) => void): AsyncIterableIterator<TInput>;
+export declare function finalAsyncIterator<TInput>(asyncIterable: AsyncIterable<TInput>, onFinal: () => void): AsyncIterableIterator<TInput>;
+export declare function errorAsyncIterator<TInput>(asyncIterable: AsyncIterable<TInput>, onError: (err: unknown) => void): AsyncIterableIterator<TInput>;