@envelop/execute-subscription-event 3.0.0-alpha-d0d0776.0 → 3.0.0-alpha-ccec0fc.0

package/README.md

@@ -7,35 +7,35 @@ Utilities for hooking into the [ExecuteSubscriptionEvent](<https://spec.graphql.
 Create a new context object per `ExecuteSubscriptionEvent` phase, allowing to bypass common issues with context objects such as [`DataLoader`](https://github.com/n1ru4l/envelop/issues/80) [caching](https://github.com/graphql/graphql-js/issues/894) [issues](https://github.com/apollographql/subscriptions-transport-ws/issues/330).
 
 ```ts
-import { envelop } from '@envelop/core';
-import { useContextValuePerExecuteSubscriptionEvent } from '@envelop/execute-subscription-event';
-import { createContext, createDataLoaders } from './context';
+import { envelop } from '@envelop/core'
+import { useContextValuePerExecuteSubscriptionEvent } from '@envelop/execute-subscription-event'
+import { createContext, createDataLoaders } from './context'
 
 const getEnveloped = envelop({
   plugins: [
-    useContext(() => createContext())
+    useContext(() => createContext()),
     useContextValuePerExecuteSubscriptionEvent(() => ({
       // Existing context is merged with this context partial
       // By recreating the DataLoader we ensure no DataLoader caches from the previous event/initial field subscribe call are are hit
       contextPartial: {
         dataLoaders: createDataLoaders()
-      },
-    })),
+      }
+    }))
     // ... other plugins ...
-  ],
-});
+  ]
+})
 ```
 
 Alternatively, you can also provide a callback that is invoked after each [`ExecuteSubscriptionEvent`](<https://spec.graphql.org/draft/#ExecuteSubscriptionEvent()>) phase.
 
 ```ts
-import { envelop } from '@envelop/core';
-import { useContextValuePerExecuteSubscriptionEvent } from '@envelop/execute-subscription-event';
-import { createContext, createDataLoaders } from './context';
+import { envelop } from '@envelop/core'
+import { useContextValuePerExecuteSubscriptionEvent } from '@envelop/execute-subscription-event'
+import { createContext, createDataLoaders } from './context'
 
 const getEnveloped = envelop({
   plugins: [
-    useContext(() => createContext())
+    useContext(() => createContext()),
     useContextValuePerExecuteSubscriptionEvent(({ args }) => ({
       onEnd: () => {
         // Note that onEnd is invoked only after each ExecuteSubscriptionEvent phase
@@ -44,8 +44,8 @@ const getEnveloped = envelop({
         args.contextValue.dataLoaders.users.clearAll()
         args.contextValue.dataLoaders.posts.clearAll()
       }
-    })),
+    }))
     // ... other plugins ...
-  ],
-});
+  ]
+})
 ```

package/cjs/index.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useExtendContextValuePerExecuteSubscriptionEvent = void 0;
+const graphql_1 = require("@graphql-tools/graphql");
+const core_1 = require("@envelop/core");
+const subscribe_js_1 = require("./subscribe.js");
+const useExtendContextValuePerExecuteSubscriptionEvent = (createContext) => {
+    return {
+        onSubscribe({ args, setSubscribeFn }) {
+            const executeNew = (0, core_1.makeExecute)(async (executionArgs) => {
+                var _a;
+                const context = await createContext({ args });
+                try {
+                    return await (0, graphql_1.execute)({
+                        ...executionArgs,
+                        // GraphQL.js 16 changed the type of contextValue to unknown
+                        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+                        // @ts-ignore
+                        contextValue: { ...executionArgs.contextValue, ...context === null || context === void 0 ? void 0 : context.contextPartial },
+                    });
+                }
+                finally {
+                    (_a = context === null || context === void 0 ? void 0 : context.onEnd) === null || _a === void 0 ? void 0 : _a.call(context);
+                }
+            });
+            setSubscribeFn((0, subscribe_js_1.subscribe)(executeNew));
+        },
+    };
+};
+exports.useExtendContextValuePerExecuteSubscriptionEvent = useExtendContextValuePerExecuteSubscriptionEvent;

package/cjs/package.json

@@ -0,0 +1 @@
+{"type":"commonjs"}

package/cjs/subscribe.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.subscribe = void 0;
+const graphql_1 = require("@graphql-tools/graphql");
+const core_1 = require("@envelop/core");
+/**
+ * This is a almost identical port from graphql-js subscribe.
+ * The only difference is that a custom `execute` function can be injected for customizing the behavior.
+ */
+const subscribe = (execute) => (0, core_1.makeSubscribe)(async (args) => {
+    const { schema, document, rootValue, contextValue, variableValues, operationName, fieldResolver, subscribeFieldResolver, } = args;
+    const resultOrStream = await (0, graphql_1.createSourceEventStream)({
+        schema,
+        document,
+        rootValue,
+        contextValue,
+        variableValues: variableValues !== null && variableValues !== void 0 ? variableValues : undefined,
+        operationName,
+        subscribeFieldResolver,
+    });
+    if (!(0, core_1.isAsyncIterable)(resultOrStream)) {
+        return resultOrStream;
+    }
+    // For each payload yielded from a subscription, map it over the normal
+    // GraphQL `execute` function, with `payload` as the rootValue.
+    // This implements the "MapSourceToResponseEvent" algorithm described in
+    // the GraphQL specification. The `execute` function provides the
+    // "ExecuteSubscriptionEvent" algorithm, as it is nearly identical to the
+    // "ExecuteQuery" algorithm, for which `execute` is also used.
+    const mapSourceToResponse = (payload) => execute({
+        schema,
+        document,
+        rootValue: payload,
+        contextValue,
+        variableValues,
+        operationName,
+        fieldResolver,
+    });
+    // Map every source value to a ExecutionResult value as described above.
+    return (0, core_1.mapAsyncIterator)(resultOrStream, mapSourceToResponse);
+});
+exports.subscribe = subscribe;

package/esm/index.js

@@ -0,0 +1,26 @@
+import { execute } from '@graphql-tools/graphql';
+import { makeExecute } from '@envelop/core';
+import { subscribe } from './subscribe.js';
+export const useExtendContextValuePerExecuteSubscriptionEvent = (createContext) => {
+    return {
+        onSubscribe({ args, setSubscribeFn }) {
+            const executeNew = makeExecute(async (executionArgs) => {
+                var _a;
+                const context = await createContext({ args });
+                try {
+                    return await execute({
+                        ...executionArgs,
+                        // GraphQL.js 16 changed the type of contextValue to unknown
+                        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+                        // @ts-ignore
+                        contextValue: { ...executionArgs.contextValue, ...context === null || context === void 0 ? void 0 : context.contextPartial },
+                    });
+                }
+                finally {
+                    (_a = context === null || context === void 0 ? void 0 : context.onEnd) === null || _a === void 0 ? void 0 : _a.call(context);
+                }
+            });
+            setSubscribeFn(subscribe(executeNew));
+        },
+    };
+};

package/esm/subscribe.js

@@ -0,0 +1,38 @@
+import { createSourceEventStream } from '@graphql-tools/graphql';
+import { makeSubscribe, mapAsyncIterator, isAsyncIterable } from '@envelop/core';
+/**
+ * This is a almost identical port from graphql-js subscribe.
+ * The only difference is that a custom `execute` function can be injected for customizing the behavior.
+ */
+export const subscribe = (execute) => makeSubscribe(async (args) => {
+    const { schema, document, rootValue, contextValue, variableValues, operationName, fieldResolver, subscribeFieldResolver, } = args;
+    const resultOrStream = await createSourceEventStream({
+        schema,
+        document,
+        rootValue,
+        contextValue,
+        variableValues: variableValues !== null && variableValues !== void 0 ? variableValues : undefined,
+        operationName,
+        subscribeFieldResolver,
+    });
+    if (!isAsyncIterable(resultOrStream)) {
+        return resultOrStream;
+    }
+    // For each payload yielded from a subscription, map it over the normal
+    // GraphQL `execute` function, with `payload` as the rootValue.
+    // This implements the "MapSourceToResponseEvent" algorithm described in
+    // the GraphQL specification. The `execute` function provides the
+    // "ExecuteSubscriptionEvent" algorithm, as it is nearly identical to the
+    // "ExecuteQuery" algorithm, for which `execute` is also used.
+    const mapSourceToResponse = (payload) => execute({
+        schema,
+        document,
+        rootValue: payload,
+        contextValue,
+        variableValues,
+        operationName,
+        fieldResolver,
+    });
+    // Map every source value to a ExecutionResult value as described above.
+    return mapAsyncIterator(resultOrStream, mapSourceToResponse);
+});

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@envelop/execute-subscription-event",
-  "version": "3.0.0-alpha-d0d0776.0",
+  "version": "3.0.0-alpha-ccec0fc.0",
   "sideEffects": false,
   "peerDependencies": {
-    "@envelop/core": "3.0.0-alpha-d0d0776.0",
-    "graphql": "^14.0.0 || ^15.0.0 || ^16.0.0"
+    "@envelop/core": "3.0.0-alpha-ccec0fc.0",
+    "@graphql-tools/graphql": "0.1.0-alpha-e7752ba5.0"
   },
+  "dependencies": {},
   "repository": {
     "type": "git",
     "url": "https://github.com/n1ru4l/envelop.git",
@@ -13,33 +14,42 @@
   },
   "author": "Laurin Quast <laurinquast@googlemail.com>",
   "license": "MIT",
-  "main": "index.js",
-  "module": "index.mjs",
-  "typings": "index.d.ts",
+  "main": "cjs/index.js",
+  "module": "esm/index.js",
+  "typings": "typings/index.d.ts",
   "typescript": {
-    "definition": "index.d.ts"
+    "definition": "typings/index.d.ts"
   },
+  "type": "module",
   "exports": {
     ".": {
       "require": {
-        "default": "./index.js",
-        "types": "./index.d.ts"
+        "types": "./typings/index.d.ts",
+        "default": "./cjs/index.js"
       },
       "import": {
-        "default": "./index.mjs",
-        "types": "./index.d.ts"
+        "types": "./typings/index.d.ts",
+        "default": "./esm/index.js"
+      },
+      "default": {
+        "types": "./typings/index.d.ts",
+        "default": "./esm/index.js"
       }
     },
     "./*": {
       "require": {
-        "default": "./*.js",
-        "types": "./*.d.ts"
+        "types": "./typings/*.d.ts",
+        "default": "./cjs/*.js"
       },
       "import": {
-        "default": "./*.mjs",
-        "types": "./*.d.ts"
+        "types": "./typings/*.d.ts",
+        "default": "./esm/*.js"
+      },
+      "default": {
+        "types": "./typings/*.d.ts",
+        "default": "./esm/*.js"
       }
     },
     "./package.json": "./package.json"
   }
-}
+}

package/{index.d.ts → typings/index.d.ts}

@@ -1,4 +1,4 @@
-import { SubscriptionArgs } from 'graphql';
+import { SubscriptionArgs } from '@graphql-tools/graphql';
 import { Plugin, PromiseOrValue, DefaultContext } from '@envelop/core';
 export declare type ContextFactoryOptions = {
     /** The arguments with which the subscription was set up. */

package/index.js

@@ -1,60 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-const graphql = require('graphql');
-const core = require('@envelop/core');
-
-/**
- * This is a almost identical port from graphql-js subscribe.
- * The only difference is that a custom `execute` function can be injected for customizing the behavior.
- */
-const subscribe = (execute) => core.makeSubscribe(async (args) => {
-    const { schema, document, rootValue, contextValue, variableValues, operationName, fieldResolver, subscribeFieldResolver } = args;
-    const resultOrStream = await graphql.createSourceEventStream(schema, document, rootValue, contextValue, variableValues ?? undefined, operationName, subscribeFieldResolver);
-    if (!core.isAsyncIterable(resultOrStream)) {
-        return resultOrStream;
-    }
-    // For each payload yielded from a subscription, map it over the normal
-    // GraphQL `execute` function, with `payload` as the rootValue.
-    // This implements the "MapSourceToResponseEvent" algorithm described in
-    // the GraphQL specification. The `execute` function provides the
-    // "ExecuteSubscriptionEvent" algorithm, as it is nearly identical to the
-    // "ExecuteQuery" algorithm, for which `execute` is also used.
-    const mapSourceToResponse = (payload) => execute({
-        schema,
-        document,
-        rootValue: payload,
-        contextValue,
-        variableValues,
-        operationName,
-        fieldResolver,
-    });
-    // Map every source value to a ExecutionResult value as described above.
-    return core.mapAsyncIterator(resultOrStream, mapSourceToResponse);
-});
-
-const useExtendContextValuePerExecuteSubscriptionEvent = (createContext) => {
-    return {
-        onSubscribe({ args, setSubscribeFn }) {
-            const executeNew = core.makeExecute(async (executionArgs) => {
-                const context = await createContext({ args });
-                try {
-                    return await graphql.execute({
-                        ...executionArgs,
-                        // GraphQL.js 16 changed the type of contextValue to unknown
-                        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-                        // @ts-ignore
-                        contextValue: { ...executionArgs.contextValue, ...context?.contextPartial },
-                    });
-                }
-                finally {
-                    context?.onEnd?.();
-                }
-            });
-            setSubscribeFn(subscribe(executeNew));
-        },
-    };
-};
-
-exports.useExtendContextValuePerExecuteSubscriptionEvent = useExtendContextValuePerExecuteSubscriptionEvent;

package/index.mjs

@@ -1,56 +0,0 @@
-import { createSourceEventStream, execute } from 'graphql';
-import { makeSubscribe, isAsyncIterable, mapAsyncIterator, makeExecute } from '@envelop/core';
-
-/**
- * This is a almost identical port from graphql-js subscribe.
- * The only difference is that a custom `execute` function can be injected for customizing the behavior.
- */
-const subscribe = (execute) => makeSubscribe(async (args) => {
-    const { schema, document, rootValue, contextValue, variableValues, operationName, fieldResolver, subscribeFieldResolver } = args;
-    const resultOrStream = await createSourceEventStream(schema, document, rootValue, contextValue, variableValues ?? undefined, operationName, subscribeFieldResolver);
-    if (!isAsyncIterable(resultOrStream)) {
-        return resultOrStream;
-    }
-    // For each payload yielded from a subscription, map it over the normal
-    // GraphQL `execute` function, with `payload` as the rootValue.
-    // This implements the "MapSourceToResponseEvent" algorithm described in
-    // the GraphQL specification. The `execute` function provides the
-    // "ExecuteSubscriptionEvent" algorithm, as it is nearly identical to the
-    // "ExecuteQuery" algorithm, for which `execute` is also used.
-    const mapSourceToResponse = (payload) => execute({
-        schema,
-        document,
-        rootValue: payload,
-        contextValue,
-        variableValues,
-        operationName,
-        fieldResolver,
-    });
-    // Map every source value to a ExecutionResult value as described above.
-    return mapAsyncIterator(resultOrStream, mapSourceToResponse);
-});
-
-const useExtendContextValuePerExecuteSubscriptionEvent = (createContext) => {
-    return {
-        onSubscribe({ args, setSubscribeFn }) {
-            const executeNew = makeExecute(async (executionArgs) => {
-                const context = await createContext({ args });
-                try {
-                    return await execute({
-                        ...executionArgs,
-                        // GraphQL.js 16 changed the type of contextValue to unknown
-                        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-                        // @ts-ignore
-                        contextValue: { ...executionArgs.contextValue, ...context?.contextPartial },
-                    });
-                }
-                finally {
-                    context?.onEnd?.();
-                }
-            });
-            setSubscribeFn(subscribe(executeNew));
-        },
-    };
-};
-
-export { useExtendContextValuePerExecuteSubscriptionEvent };