@envelop/core 2.2.0 → 2.3.2-alpha-e3ced2d.0

package/index.js

@@ -299,6 +299,10 @@ function errorAsyncIterator(source, onError) {
     };
     return stream;
 }
+// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
+function isPromise(obj) {
+    return obj != null && obj.then;
+}
 
 function createEnvelopOrchestrator(plugins) {
     let schema = null;
@@ -486,8 +490,9 @@ function createEnvelopOrchestrator(plugins) {
     const customContextFactory = beforeCallbacks.context.length
         ? initialContext => async (orchestratorCtx) => {
             const afterCalls = [];
+            // In order to have access to the "last working" context object we keep this outside of the try block:
+            let context = orchestratorCtx ? { ...initialContext, ...orchestratorCtx } : initialContext;
             try {
-                let context = orchestratorCtx ? { ...initialContext, ...orchestratorCtx } : initialContext;
                 let isBreakingContextBuilding = false;
                 for (const onContext of beforeCallbacks.context) {
                     const afterHookResult = await onContext({
@@ -520,6 +525,7 @@ function createEnvelopOrchestrator(plugins) {
                 let error = err;
                 for (const errorCb of contextErrorHandlers) {
                     errorCb({
+                        context,
                         error,
                         setError: err => {
                             error = err;
@@ -1086,18 +1092,47 @@ const useSchema = (schema) => {
     };
 };
 const useLazyLoadedSchema = (schemaLoader) => {
+    let schemaSet$;
     return {
         onEnveloped({ setSchema, context }) {
-            setSchema(schemaLoader(context));
+            const schema$ = schemaLoader(context);
+            if (isPromise(schema$)) {
+                schemaSet$ = schema$.then(schemaObj => {
+                    setSchema(schemaObj);
+                });
+            }
+            else {
+                setSchema(schema$);
+            }
+        },
+        onExecute() {
+            if (schemaSet$) {
+                return schemaSet$;
+            }
+            return undefined;
         },
     };
 };
-const useAsyncSchema = (schemaPromise) => {
+const useAsyncSchema = (schema$) => {
+    let schemaSet$;
     return {
         onPluginInit({ setSchema }) {
-            schemaPromise.then(schemaObj => {
-                setSchema(schemaObj);
-            });
+            if (isPromise(schema$)) {
+                schemaSet$ = schema$.then(schemaObj => {
+                    setSchema(schemaObj);
+                });
+            }
+            else {
+                setSchema(schema$);
+            }
+        },
+        onContextBuilding() {
+            return () => {
+                if (schemaSet$) {
+                    return schemaSet$;
+                }
+                return undefined;
+            };
         },
     };
 };
@@ -1227,9 +1262,15 @@ const useMaskedErrors = (opts) => {
 
 const OnNonIntrospectionFieldReachedValidationRule = (onNonIntrospectionField) => ctx => {
     const rootQueryType = ctx.getSchema().getQueryType();
+    const rootMutationType = ctx.getSchema().getMutationType();
+    const rootSubscriptionType = ctx.getSchema().getSubscriptionType();
     return {
         Field(field) {
-            if (ctx.getParentType() === rootQueryType && !field.name.value.startsWith('__')) {
+            const parentType = ctx.getParentType();
+            const isQuery = parentType === rootQueryType;
+            const isMutation = parentType === rootMutationType;
+            const isSubscription = parentType === rootSubscriptionType;
+            if ((isQuery && !field.name.value.startsWith('__')) || isMutation || isSubscription) {
                 onNonIntrospectionField();
                 return graphql.BREAK;
             }
@@ -1288,6 +1329,7 @@ exports.isIntrospectionOperation = isIntrospectionOperation;
 exports.isIntrospectionOperationString = isIntrospectionOperationString;
 exports.isOperationDefinition = isOperationDefinition;
 exports.isPluginEnabled = isPluginEnabled;
+exports.isPromise = isPromise;
 exports.makeExecute = makeExecute;
 exports.makeSubscribe = makeSubscribe;
 exports.mapAsyncIterator = mapAsyncIterator;

package/index.mjs

@@ -295,6 +295,10 @@ function errorAsyncIterator(source, onError) {
     };
     return stream;
 }
+// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
+function isPromise(obj) {
+    return obj != null && obj.then;
+}
 
 function createEnvelopOrchestrator(plugins) {
     let schema = null;
@@ -482,8 +486,9 @@ function createEnvelopOrchestrator(plugins) {
     const customContextFactory = beforeCallbacks.context.length
         ? initialContext => async (orchestratorCtx) => {
             const afterCalls = [];
+            // In order to have access to the "last working" context object we keep this outside of the try block:
+            let context = orchestratorCtx ? { ...initialContext, ...orchestratorCtx } : initialContext;
             try {
-                let context = orchestratorCtx ? { ...initialContext, ...orchestratorCtx } : initialContext;
                 let isBreakingContextBuilding = false;
                 for (const onContext of beforeCallbacks.context) {
                     const afterHookResult = await onContext({
@@ -516,6 +521,7 @@ function createEnvelopOrchestrator(plugins) {
                 let error = err;
                 for (const errorCb of contextErrorHandlers) {
                     errorCb({
+                        context,
                         error,
                         setError: err => {
                             error = err;
@@ -1082,18 +1088,47 @@ const useSchema = (schema) => {
     };
 };
 const useLazyLoadedSchema = (schemaLoader) => {
+    let schemaSet$;
     return {
         onEnveloped({ setSchema, context }) {
-            setSchema(schemaLoader(context));
+            const schema$ = schemaLoader(context);
+            if (isPromise(schema$)) {
+                schemaSet$ = schema$.then(schemaObj => {
+                    setSchema(schemaObj);
+                });
+            }
+            else {
+                setSchema(schema$);
+            }
+        },
+        onExecute() {
+            if (schemaSet$) {
+                return schemaSet$;
+            }
+            return undefined;
         },
     };
 };
-const useAsyncSchema = (schemaPromise) => {
+const useAsyncSchema = (schema$) => {
+    let schemaSet$;
     return {
         onPluginInit({ setSchema }) {
-            schemaPromise.then(schemaObj => {
-                setSchema(schemaObj);
-            });
+            if (isPromise(schema$)) {
+                schemaSet$ = schema$.then(schemaObj => {
+                    setSchema(schemaObj);
+                });
+            }
+            else {
+                setSchema(schema$);
+            }
+        },
+        onContextBuilding() {
+            return () => {
+                if (schemaSet$) {
+                    return schemaSet$;
+                }
+                return undefined;
+            };
         },
     };
 };
@@ -1223,9 +1258,15 @@ const useMaskedErrors = (opts) => {
 
 const OnNonIntrospectionFieldReachedValidationRule = (onNonIntrospectionField) => ctx => {
     const rootQueryType = ctx.getSchema().getQueryType();
+    const rootMutationType = ctx.getSchema().getMutationType();
+    const rootSubscriptionType = ctx.getSchema().getSubscriptionType();
     return {
         Field(field) {
-            if (ctx.getParentType() === rootQueryType && !field.name.value.startsWith('__')) {
+            const parentType = ctx.getParentType();
+            const isQuery = parentType === rootQueryType;
+            const isMutation = parentType === rootMutationType;
+            const isSubscription = parentType === rootSubscriptionType;
+            if ((isQuery && !field.name.value.startsWith('__')) || isMutation || isSubscription) {
                 onNonIntrospectionField();
                 return BREAK;
             }
@@ -1261,4 +1302,4 @@ const useImmediateIntrospection = () => {
     };
 };
 
-export { DEFAULT_ERROR_MESSAGE, EnvelopError, enableIf, envelop, envelopIsIntrospectionSymbol, errorAsyncIterator, finalAsyncIterator, formatError, handleStreamOrSingleExecutionResult, isAsyncIterable, isIntrospectionDocument, isIntrospectionOperation, isIntrospectionOperationString, isOperationDefinition, isPluginEnabled, makeExecute, makeSubscribe, mapAsyncIterator, useAsyncSchema, useEnvelop, useErrorHandler, useExtendContext, useImmediateIntrospection, useLazyLoadedSchema, useLogger, useMaskedErrors, usePayloadFormatter, useSchema, useTiming };
+export { DEFAULT_ERROR_MESSAGE, EnvelopError, enableIf, envelop, envelopIsIntrospectionSymbol, errorAsyncIterator, finalAsyncIterator, formatError, handleStreamOrSingleExecutionResult, isAsyncIterable, isIntrospectionDocument, isIntrospectionOperation, isIntrospectionOperationString, isOperationDefinition, isPluginEnabled, isPromise, makeExecute, makeSubscribe, mapAsyncIterator, useAsyncSchema, useEnvelop, useErrorHandler, useExtendContext, useImmediateIntrospection, useLazyLoadedSchema, useLogger, useMaskedErrors, usePayloadFormatter, useSchema, useTiming };

package/package.json

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

package/plugins/use-schema.d.ts

@@ -1,5 +1,5 @@
 import { GraphQLSchema } from 'graphql';
-import { DefaultContext, Maybe, Plugin } from '@envelop/types';
+import { DefaultContext, Maybe, Plugin, PromiseOrValue } from '@envelop/types';
 export declare const useSchema: (schema: GraphQLSchema) => Plugin;
-export declare const useLazyLoadedSchema: (schemaLoader: (context: Maybe<DefaultContext>) => GraphQLSchema) => Plugin;
-export declare const useAsyncSchema: (schemaPromise: Promise<GraphQLSchema>) => Plugin;
+export declare const useLazyLoadedSchema: (schemaLoader: (context: Maybe<DefaultContext>) => PromiseOrValue<GraphQLSchema>) => Plugin;
+export declare const useAsyncSchema: (schema$: PromiseOrValue<GraphQLSchema>) => Plugin;

package/utils.d.ts

@@ -31,3 +31,4 @@ export declare function isAsyncIterable<TType>(maybeAsyncIterable: unknown): may
 export declare function handleStreamOrSingleExecutionResult<ContextType = DefaultContext>(payload: OnExecuteDoneEventPayload<ContextType>, fn: OnExecuteDoneHookResultOnNextHook<ContextType>): void | OnExecuteDoneHookResult<ContextType>;
 export declare function finalAsyncIterator<TInput>(source: AsyncIterable<TInput>, onFinal: () => void): AsyncGenerator<TInput>;
 export declare function errorAsyncIterator<TInput>(source: AsyncIterable<TInput>, onError: (err: unknown) => void): AsyncGenerator<TInput>;
+export declare function isPromise<T>(obj: any): obj is Promise<T>;