@envelop/execute-subscription-event 2.4.1 → 2.4.3-alpha-62b6e087.0

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@envelop/execute-subscription-event",
-  "version": "2.4.1",
+  "version": "2.4.3-alpha-62b6e087.0",
   "sideEffects": false,
   "peerDependencies": {
-    "@envelop/core": "^2.4.1",
+    "@envelop/core": "2.4.3-alpha-62b6e087.0",
     "graphql": "^14.0.0 || ^15.0.0 || ^16.0.0"
   },
   "dependencies": {},
@@ -24,7 +24,7 @@
   "exports": {
     ".": {
       "require": {
-        "types": "./typings/index.d.ts",
+        "types": "./typings/index.d.cts",
         "default": "./cjs/index.js"
       },
       "import": {
@@ -38,7 +38,7 @@
     },
     "./*": {
       "require": {
-        "types": "./typings/*.d.ts",
+        "types": "./typings/*.d.cts",
         "default": "./cjs/*.js"
       },
       "import": {

package/typings/index.d.cts

@@ -0,0 +1,14 @@
+import { SubscriptionArgs } from 'graphql';
+import { Plugin, PromiseOrValue, DefaultContext } from '@envelop/core';
+export declare type ContextFactoryOptions = {
+    /** The arguments with which the subscription was set up. */
+    args: SubscriptionArgs;
+};
+export declare type ContextFactoryHook<TContextValue> = {
+    /** Context that will be used for the "ExecuteSubscriptionEvent" phase. */
+    contextPartial: Partial<TContextValue>;
+    /** Optional callback that is invoked once the "ExecuteSubscriptionEvent" phase has ended. Useful for cleanup, such as tearing down database connections. */
+    onEnd?: () => void;
+};
+export declare type ContextFactoryType<TContextValue = DefaultContext> = (options: ContextFactoryOptions) => PromiseOrValue<ContextFactoryHook<TContextValue> | void>;
+export declare const useExtendContextValuePerExecuteSubscriptionEvent: <TContextValue = unknown>(createContext: ContextFactoryType<TContextValue>) => Plugin<TContextValue>;

package/typings/subscribe.d.cts

@@ -0,0 +1,6 @@
+import { ExecuteFunction, SubscribeFunction } 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 declare const subscribe: (execute: ExecuteFunction) => SubscribeFunction;