@temporalio/workflow 0.8.0 → 0.12.0

package/LICENSE.md

@@ -1,4 +1,4 @@
-Temporal Node.js SDK
+Temporal TypeScript SDK
 
 MIT License
 

package/README.md

@@ -2,6 +2,8 @@
 
 [![NPM](https://img.shields.io/npm/v/@temporalio/workflow?style=for-the-badge)](https://www.npmjs.com/package/@temporalio/workflow)
 
-Part of the [Temporal](https://temporal.io) [Node.js SDK](https://www.npmjs.com/package/temporalio).
+Part of the [Temporal](https://temporal.io) [TypeScript SDK](https://www.npmjs.com/package/temporalio).
 
-See documentation on the [documentation site](https://docs.temporal.io/docs/node/introduction).
+- See API reference [here](https://typescript.temporal.io/api/namespaces/workflow)
+- See code samples [here](https://github.com/temporalio/samples-typescript)
+- See full introduction on the [docs site](https://docs.temporal.io/docs/typescript/introduction)

package/lib/cancellation-scope.d.ts

@@ -112,6 +112,6 @@ export declare class RootCancellationScope extends CancellationScope {
 /** There can only be one of these */
 export declare const ROOT_SCOPE: RootCancellationScope;
 /** This function is here to avoid a circular dependency between this module and workflow.ts */
-declare let sleep: (_: number) => Promise<void>;
+declare let sleep: (_: number | string) => Promise<void>;
 export declare function registerSleepImplementation(fn: typeof sleep): void;
 export {};

package/lib/cancellation-scope.js.map

@@ -1 +1 @@
-{"version":3,"file":"cancellation-scope.js","sourceRoot":"","sources":["../src/cancellation-scope.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,+CAAyE;AACzE,+DAA0D;AAE1D,8EAA8E;AAC9E,MAAM,SAAS,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;AAuBtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAa,iBAAiB;IA4B5B,YAAY,OAAkC;QAP9C,6CAAmB,KAAK,EAAC;QAQvB,IAAI,CAAC,OAAO,GAAG,OAAO,EAAE,OAAO,CAAC;QAChC,IAAI,CAAC,WAAW,GAAG,OAAO,EAAE,WAAW,IAAI,IAAI,CAAC;QAChD,IAAI,CAAC,eAAe,GAAG,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE;YAC/C,8EAA8E;YAC9E,6DAA6D;YAC7D,aAAa;YACb,IAAI,CAAC,MAAM,GAAG,CAAC,GAAG,EAAE,EAAE;gBACpB,uBAAA,IAAI,sCAAoB,IAAI,MAAA,CAAC;gBAC7B,MAAM,CAAC,GAAG,CAAC,CAAC;YACd,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,6BAA6B;QAC7B,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QAC5C,IAAI,OAAO,EAAE,MAAM,KAAK,SAAS,EAAE;YACjC,IAAI,CAAC,MAAM,GAAG,OAAO,EAAE,MAAM,IAAI,iBAAiB,CAAC,OAAO,EAAE,CAAC;YAC7D,uBAAA,IAAI,sCAAoB,uBAAA,IAAI,CAAC,MAAM,0CAAiB,MAAA,CAAC;YACrD,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;gBACxC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACnB,CAAC,CAAC,CAAC;SACJ;IACH,CAAC;IAED,IAAW,mBAAmB;QAC5B,OAAO,uBAAA,IAAI,0CAAiB,IAAI,IAAI,CAAC,WAAW,CAAC;IACnD,CAAC;IACD;;;;;;;OAOG;IACH,GAAG,CAAI,EAAoB;QACzB,OAAO,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,CAAqB,CAAC,CAAC;IACjF,CAAC;IAED;;;;OAIG;IACO,KAAK,CAAC,YAAY,CAAI,EAAoB;QAClD,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;SAC/C;QACD,OAAO,MAAM,EAAE,EAAE,CAAC;IACpB,CAAC;IAED;;OAEG;IACH,MAAM;QACJ,IAAI,CAAC,MAAM,CAAC,IAAI,yBAAgB,CAAC,8BAA8B,CAAC,CAAC,CAAC;IACpE,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,OAAO;QACZ,OAAO,OAAO,CAAC,QAAQ,EAAE,IAAI,kBAAU,CAAC;IAC1C,CAAC;IAED,sEAAsE;IACtE,MAAM,CAAC,WAAW,CAAI,EAAoB;QACxC,OAAO,IAAI,IAAI,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACjD,CAAC;IAED,uEAAuE;IACvE,MAAM,CAAC,cAAc,CAAI,EAAoB;QAC3C,OAAO,IAAI,IAAI,CAAC,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAClD,CAAC;IAED,+EAA+E;IAC/E,MAAM,CAAC,WAAW,CAAI,OAAe,EAAE,EAAoB;QACzD,OAAO,IAAI,IAAI,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC1D,CAAC;CACF;AA1GD,8CA0GC;;AAED,MAAM,OAAO,GAAG,IAAI,uCAAiB,EAAqB,CAAC;AAE3D,MAAa,qBAAsB,SAAQ,iBAAiB;IAC1D,MAAM;QACJ,IAAI,CAAC,MAAM,CAAC,IAAI,yBAAgB,CAAC,oBAAoB,CAAC,CAAC,CAAC;IAC1D,CAAC;CACF;AAJD,sDAIC;AAED,qCAAqC;AACxB,QAAA,UAAU,GAAG,IAAI,qBAAqB,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;AAE9F,+FAA+F;AAC/F,IAAI,KAAK,GAAG,CAAC,CAAS,EAAiB,EAAE;IACvC,MAAM,IAAI,0BAAiB,CAAC,4CAA4C,CAAC,CAAC;AAC5E,CAAC,CAAC;AAEF,SAAgB,2BAA2B,CAAC,EAAgB;IAC1D,KAAK,GAAG,EAAE,CAAC;AACb,CAAC;AAFD,kEAEC"}
+{"version":3,"file":"cancellation-scope.js","sourceRoot":"","sources":["../src/cancellation-scope.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,+CAAyE;AACzE,+DAA0D;AAE1D,8EAA8E;AAC9E,MAAM,SAAS,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;AAuBtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAa,iBAAiB;IA4B5B,YAAY,OAAkC;QAP9C,6CAAmB,KAAK,EAAC;QAQvB,IAAI,CAAC,OAAO,GAAG,OAAO,EAAE,OAAO,CAAC;QAChC,IAAI,CAAC,WAAW,GAAG,OAAO,EAAE,WAAW,IAAI,IAAI,CAAC;QAChD,IAAI,CAAC,eAAe,GAAG,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE;YAC/C,8EAA8E;YAC9E,6DAA6D;YAC7D,aAAa;YACb,IAAI,CAAC,MAAM,GAAG,CAAC,GAAG,EAAE,EAAE;gBACpB,uBAAA,IAAI,sCAAoB,IAAI,MAAA,CAAC;gBAC7B,MAAM,CAAC,GAAG,CAAC,CAAC;YACd,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,6BAA6B;QAC7B,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QAC5C,IAAI,OAAO,EAAE,MAAM,KAAK,SAAS,EAAE;YACjC,IAAI,CAAC,MAAM,GAAG,OAAO,EAAE,MAAM,IAAI,iBAAiB,CAAC,OAAO,EAAE,CAAC;YAC7D,uBAAA,IAAI,sCAAoB,uBAAA,IAAI,CAAC,MAAM,0CAAiB,MAAA,CAAC;YACrD,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;gBACxC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACnB,CAAC,CAAC,CAAC;SACJ;IACH,CAAC;IAED,IAAW,mBAAmB;QAC5B,OAAO,uBAAA,IAAI,0CAAiB,IAAI,IAAI,CAAC,WAAW,CAAC;IACnD,CAAC;IACD;;;;;;;OAOG;IACH,GAAG,CAAI,EAAoB;QACzB,OAAO,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,CAAqB,CAAC,CAAC;IACjF,CAAC;IAED;;;;OAIG;IACO,KAAK,CAAC,YAAY,CAAI,EAAoB;QAClD,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;SAC/C;QACD,OAAO,MAAM,EAAE,EAAE,CAAC;IACpB,CAAC;IAED;;OAEG;IACH,MAAM;QACJ,IAAI,CAAC,MAAM,CAAC,IAAI,yBAAgB,CAAC,8BAA8B,CAAC,CAAC,CAAC;IACpE,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,OAAO;QACZ,OAAO,OAAO,CAAC,QAAQ,EAAE,IAAI,kBAAU,CAAC;IAC1C,CAAC;IAED,sEAAsE;IACtE,MAAM,CAAC,WAAW,CAAI,EAAoB;QACxC,OAAO,IAAI,IAAI,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACjD,CAAC;IAED,uEAAuE;IACvE,MAAM,CAAC,cAAc,CAAI,EAAoB;QAC3C,OAAO,IAAI,IAAI,CAAC,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAClD,CAAC;IAED,+EAA+E;IAC/E,MAAM,CAAC,WAAW,CAAI,OAAe,EAAE,EAAoB;QACzD,OAAO,IAAI,IAAI,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC1D,CAAC;CACF;AA1GD,8CA0GC;;AAED,MAAM,OAAO,GAAG,IAAI,uCAAiB,EAAqB,CAAC;AAE3D,MAAa,qBAAsB,SAAQ,iBAAiB;IAC1D,MAAM;QACJ,IAAI,CAAC,MAAM,CAAC,IAAI,yBAAgB,CAAC,oBAAoB,CAAC,CAAC,CAAC;IAC1D,CAAC;CACF;AAJD,sDAIC;AAED,qCAAqC;AACxB,QAAA,UAAU,GAAG,IAAI,qBAAqB,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;AAE9F,+FAA+F;AAC/F,IAAI,KAAK,GAAG,CAAC,CAAkB,EAAiB,EAAE;IAChD,MAAM,IAAI,0BAAiB,CAAC,4CAA4C,CAAC,CAAC;AAC5E,CAAC,CAAC;AAEF,SAAgB,2BAA2B,CAAC,EAAgB;IAC1D,KAAK,GAAG,EAAE,CAAC;AACb,CAAC;AAFD,kEAEC"}

package/lib/dependencies.d.ts

@@ -2,21 +2,20 @@
  * Type definitions for the Workflow end of the external dependencies mechanism.
  *
  * External dependencies are functions injected into a Workflow isolate from the main Node.js isolate.
- * They are an advanced feature and should be used with care.
  *
- * @see proposal at https://github.com/temporalio/proposals/blob/master/node/logging-and-metrics-for-user-code.md
+ * Dependency functions may not return values to the Workflow in order to prevent breaking determinism.
+ *
+ * @experimental
  *
  * @module
  */
 /**
- * Any function signature can be used for dependency functions.
+ * Any function signature can be used for dependency functions as long as the return type is `void`.
  *
- * Depending on the implementation's and transfer options,
- * when calling a dependency function, arguments and return value are transferred between the Workflow isolate and the Node.js isolate.
- * - `SYNC*` {@link ApplyMode} variants allow configuring how those are transferred between isolates
- * - `ASYNC*` {@link ApplyMode} variants always copy the arguments and return value
+ * When calling a dependency function, arguments and return value are copied between the Workflow isolate and the Node.js.
+ * This constrains the argument types to primitives (excluding Symbols).
  */
-export declare type ExternalDependencyFunction = (...args: any[]) => any;
+export declare type ExternalDependencyFunction = (...args: any[]) => void;
 /** A mapping of name to function, defines a single external dependency (e.g. logger) */
 export declare type ExternalDependency = Record<string, ExternalDependencyFunction>;
 /**
@@ -24,57 +23,10 @@ export declare type ExternalDependency = Record<string, ExternalDependencyFuncti
  */
 export declare type ExternalDependencies = Record<string, ExternalDependency>;
 /**
- * Controls how an external dependency function is executed.
- * - `ASYNC*` variants run at the end of an activation and do **not** block the isolate.
- * - `SYNC*` variants run during Workflow activation and block the isolate,
- *   they're passed into the isolate using an {@link https://github.com/laverdet/isolated-vm#referenceapplyreceiver-arguments-options-promise | isolated-vm Reference}
- *
- * The Worker will log if an error occurs in one of ignored variants.
- *
- * **NOTE: External dependencies are an advanced feature and should be used with caution**
- * - Do not return anything that can break Workflow execution determinism
- * - Synchronous variants should be used as a last resort and their execution time should be kept short to free up the Workflow thread
- */
-export declare enum ApplyMode {
-    /**
-     * Injected function will be called at the end of an activation.
-     * Isolate enqueues function to be called during activation and registers a callback to await its completion.
-     * Use if exposing an async function to the isolate for which the result should be returned to the isolate.
-     */
-    ASYNC = "async",
-    /**
-     * Injected function will be called at the end of an activation.
-     * Isolate enqueues function to be called during activation and does **not** register a callback to await its completion.
-     * This is the safest async `ApplyMode` because it can not break Workflow code determinism.
-     * Can only be used when the injected function returns `void` and the implementation returns `void` or `Promise<void>`.
-     */
-    ASYNC_IGNORED = "asyncIgnored",
-    /**
-     * Injected function is called synchronously, implementation must be a synchronous function.
-     * Injection is done using an `isolated-vm` reference, function is called with `applySync`.
-     */
-    SYNC = "applySync",
-    /**
-     * Injected function is called synchronously, implementation must return a promise.
-     * Injection is done using an `isolated-vm` reference, function is called with `applySyncPromise`.
-     */
-    SYNC_PROMISE = "applySyncPromise",
-    /**
-     * Injected function is called in the background not blocking the isolate.
-     * Implementation can be either synchronous or asynchronous.
-     * Injection is done using an `isolated-vm` reference, function is called with `applyIgnored`.
-     *
-     * This is the safest sync `ApplyMode` because it can not break Workflow code determinism.
-     */
-    SYNC_IGNORED = "applyIgnored"
-}
-/**
- * Call information for async external dependencies
+ * Call information for external dependencies
  */
 export interface ExternalCall {
     ifaceName: string;
     fnName: string;
     args: any[];
-    /** Optional in case applyMode is ASYNC_IGNORED */
-    seq?: number;
 }

package/lib/dependencies.js

@@ -3,58 +3,12 @@
  * Type definitions for the Workflow end of the external dependencies mechanism.
  *
  * External dependencies are functions injected into a Workflow isolate from the main Node.js isolate.
- * They are an advanced feature and should be used with care.
  *
- * @see proposal at https://github.com/temporalio/proposals/blob/master/node/logging-and-metrics-for-user-code.md
+ * Dependency functions may not return values to the Workflow in order to prevent breaking determinism.
+ *
+ * @experimental
  *
  * @module
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApplyMode = void 0;
-/**
- * Controls how an external dependency function is executed.
- * - `ASYNC*` variants run at the end of an activation and do **not** block the isolate.
- * - `SYNC*` variants run during Workflow activation and block the isolate,
- *   they're passed into the isolate using an {@link https://github.com/laverdet/isolated-vm#referenceapplyreceiver-arguments-options-promise | isolated-vm Reference}
- *
- * The Worker will log if an error occurs in one of ignored variants.
- *
- * **NOTE: External dependencies are an advanced feature and should be used with caution**
- * - Do not return anything that can break Workflow execution determinism
- * - Synchronous variants should be used as a last resort and their execution time should be kept short to free up the Workflow thread
- */
-var ApplyMode;
-(function (ApplyMode) {
-    /**
-     * Injected function will be called at the end of an activation.
-     * Isolate enqueues function to be called during activation and registers a callback to await its completion.
-     * Use if exposing an async function to the isolate for which the result should be returned to the isolate.
-     */
-    ApplyMode["ASYNC"] = "async";
-    /**
-     * Injected function will be called at the end of an activation.
-     * Isolate enqueues function to be called during activation and does **not** register a callback to await its completion.
-     * This is the safest async `ApplyMode` because it can not break Workflow code determinism.
-     * Can only be used when the injected function returns `void` and the implementation returns `void` or `Promise<void>`.
-     */
-    ApplyMode["ASYNC_IGNORED"] = "asyncIgnored";
-    /**
-     * Injected function is called synchronously, implementation must be a synchronous function.
-     * Injection is done using an `isolated-vm` reference, function is called with `applySync`.
-     */
-    ApplyMode["SYNC"] = "applySync";
-    /**
-     * Injected function is called synchronously, implementation must return a promise.
-     * Injection is done using an `isolated-vm` reference, function is called with `applySyncPromise`.
-     */
-    ApplyMode["SYNC_PROMISE"] = "applySyncPromise";
-    /**
-     * Injected function is called in the background not blocking the isolate.
-     * Implementation can be either synchronous or asynchronous.
-     * Injection is done using an `isolated-vm` reference, function is called with `applyIgnored`.
-     *
-     * This is the safest sync `ApplyMode` because it can not break Workflow code determinism.
-     */
-    ApplyMode["SYNC_IGNORED"] = "applyIgnored";
-})(ApplyMode = exports.ApplyMode || (exports.ApplyMode = {}));
 //# sourceMappingURL=dependencies.js.map

package/lib/dependencies.js.map

@@ -1 +1 @@
-{"version":3,"file":"dependencies.js","sourceRoot":"","sources":["../src/dependencies.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG;;;AAkBH;;;;;;;;;;;GAWG;AACH,IAAY,SAgCX;AAhCD,WAAY,SAAS;IACnB;;;;OAIG;IACH,4BAAe,CAAA;IACf;;;;;OAKG;IACH,2CAA8B,CAAA;IAC9B;;;OAGG;IACH,+BAAkB,CAAA;IAClB;;;OAGG;IACH,8CAAiC,CAAA;IACjC;;;;;;OAMG;IACH,0CAA6B,CAAA;AAC/B,CAAC,EAhCW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAgCpB"}
+{"version":3,"file":"dependencies.js","sourceRoot":"","sources":["../src/dependencies.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;GAUG"}

package/lib/index.d.ts

@@ -2,21 +2,21 @@
  * This library provides tools required for authoring workflows.
  *
  * ## Usage
- * See the [tutorial](https://docs.temporal.io/docs/node/hello-world#workflows) for writing your first workflow.
+ * See the [tutorial](https://docs.temporal.io/docs/typescript/hello-world#workflows) for writing your first workflow.
  *
  * ### Timers
  *
  * The recommended way of scheduling timers is by using the {@link sleep} function.
- * We've replaced `setTimeout` and `clearTimeout` with deterministic versions so these are also usable but have a limitation that they don't play well with [cancellation scopes](https://docs.temporal.io/docs/node/workflow-scopes-and-cancellation).
+ * We've replaced `setTimeout` and `clearTimeout` with deterministic versions so these are also usable but have a limitation that they don't play well with [cancellation scopes](https://docs.temporal.io/docs/typescript/workflow-scopes-and-cancellation).
  *
- * <!--SNIPSTART nodejs-sleep-workflow-->
+ * <!--SNIPSTART typescript-sleep-workflow-->
  * <!--SNIPEND-->
  *
  * ### Activities
  *
  * To schedule Activities, use {@link createActivityHandle} to obtain an Activity function and call.
  *
- * <!--SNIPSTART nodejs-schedule-activity-workflow-->
+ * <!--SNIPSTART typescript-schedule-activity-workflow-->
  * <!--SNIPEND-->
  *
  * ### Signals and Queries
@@ -29,34 +29,34 @@
  *
  * #### Interface
  *
- * <!--SNIPSTART nodejs-workflow-signal-interface-->
+ * <!--SNIPSTART typescript-workflow-signal-interface-->
  * <!--SNIPEND-->
  *
  * #### Implementation
  *
- * <!--SNIPSTART nodejs-workflow-signal-implementation-->
+ * <!--SNIPSTART typescript-workflow-signal-implementation-->
  * <!--SNIPEND-->
  *
  * ### Deterministic built-ins
  * It is safe to call `Math.random()` and `Date()` in workflow code as they are replaced with deterministic versions. We also provide a deterministic {@link uuid4} function for convenience.
  *
- * ### [Cancellation and scopes](https://docs.temporal.io/docs/node/workflow-scopes-and-cancellation)
+ * ### [Cancellation and scopes](https://docs.temporal.io/docs/typescript/workflow-scopes-and-cancellation)
  * - {@link CancellationScope}
  * - {@link Trigger}
  *
- * ### [External dependencies](https://docs.temporal.io/docs/node/workflow-external-dependencies)
+ * ### [External dependencies](https://docs.temporal.io/docs/typescript/workflow-external-dependencies)
  * - {@link ExternalDependencies}
  * - {@link ApplyMode}
  *
  * @module
  */
-export { Workflow, WorkflowHandlers, WorkflowResultType, ActivityCancellationType, ActivityFunction, ActivityInterface, ActivityOptions, RetryOptions, rootCause, IllegalStateError, defaultDataConverter, DataConverter, WorkflowIdReusePolicy, ActivityFailure, ApplicationFailure, CancelledFailure, ChildWorkflowFailure, ServerFailure, TemporalFailure, TerminatedFailure, TimeoutFailure, } from '@temporalio/common';
-export { ChildWorkflowOptions, ChildWorkflowCancellationType, WorkflowInfo } from './interfaces';
+export { Workflow, WorkflowResultType, ActivityCancellationType, ActivityFunction, ActivityInterface, ActivityOptions, RetryOptions, rootCause, IllegalStateError, defaultDataConverter, DataConverter, WorkflowIdReusePolicy, ActivityFailure, ApplicationFailure, CancelledFailure, ChildWorkflowFailure, ServerFailure, TemporalFailure, TerminatedFailure, TimeoutFailure, ValueError, } from '@temporalio/common';
+export { ChildWorkflowOptions, ChildWorkflowCancellationType, ContinueAsNewOptions, ParentClosePolicy, WorkflowInfo, } from './interfaces';
 export * from './errors';
 export * from './workflow';
 export * from './interceptors';
-export { AsyncLocalStorage } from './async-local-storage';
 export { ROOT_SCOPE, CancellationScope, CancellationScopeOptions } from './cancellation-scope';
 export { Trigger } from './trigger';
-export { ApplyMode, ExternalCall, ExternalDependencyFunction, ExternalDependency, ExternalDependencies, } from './dependencies';
+export { ExternalDependencyFunction, ExternalDependency, ExternalDependencies, ExternalCall } from './dependencies';
 export { ChildWorkflowHandle, ExternalWorkflowHandle } from './workflow-handle';
+export { AsyncLocalStorage } from './async-local-storage';

package/lib/index.js

@@ -3,21 +3,21 @@
  * This library provides tools required for authoring workflows.
  *
  * ## Usage
- * See the [tutorial](https://docs.temporal.io/docs/node/hello-world#workflows) for writing your first workflow.
+ * See the [tutorial](https://docs.temporal.io/docs/typescript/hello-world#workflows) for writing your first workflow.
  *
  * ### Timers
  *
  * The recommended way of scheduling timers is by using the {@link sleep} function.
- * We've replaced `setTimeout` and `clearTimeout` with deterministic versions so these are also usable but have a limitation that they don't play well with [cancellation scopes](https://docs.temporal.io/docs/node/workflow-scopes-and-cancellation).
+ * We've replaced `setTimeout` and `clearTimeout` with deterministic versions so these are also usable but have a limitation that they don't play well with [cancellation scopes](https://docs.temporal.io/docs/typescript/workflow-scopes-and-cancellation).
  *
- * <!--SNIPSTART nodejs-sleep-workflow-->
+ * <!--SNIPSTART typescript-sleep-workflow-->
  * <!--SNIPEND-->
  *
  * ### Activities
  *
  * To schedule Activities, use {@link createActivityHandle} to obtain an Activity function and call.
  *
- * <!--SNIPSTART nodejs-schedule-activity-workflow-->
+ * <!--SNIPSTART typescript-schedule-activity-workflow-->
  * <!--SNIPEND-->
  *
  * ### Signals and Queries
@@ -30,22 +30,22 @@
  *
  * #### Interface
  *
- * <!--SNIPSTART nodejs-workflow-signal-interface-->
+ * <!--SNIPSTART typescript-workflow-signal-interface-->
  * <!--SNIPEND-->
  *
  * #### Implementation
  *
- * <!--SNIPSTART nodejs-workflow-signal-implementation-->
+ * <!--SNIPSTART typescript-workflow-signal-implementation-->
  * <!--SNIPEND-->
  *
  * ### Deterministic built-ins
  * It is safe to call `Math.random()` and `Date()` in workflow code as they are replaced with deterministic versions. We also provide a deterministic {@link uuid4} function for convenience.
  *
- * ### [Cancellation and scopes](https://docs.temporal.io/docs/node/workflow-scopes-and-cancellation)
+ * ### [Cancellation and scopes](https://docs.temporal.io/docs/typescript/workflow-scopes-and-cancellation)
  * - {@link CancellationScope}
  * - {@link Trigger}
  *
- * ### [External dependencies](https://docs.temporal.io/docs/node/workflow-external-dependencies)
+ * ### [External dependencies](https://docs.temporal.io/docs/typescript/workflow-external-dependencies)
  * - {@link ExternalDependencies}
  * - {@link ApplyMode}
  *
@@ -62,7 +62,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApplyMode = exports.Trigger = exports.CancellationScope = exports.ROOT_SCOPE = exports.AsyncLocalStorage = exports.ChildWorkflowCancellationType = exports.TimeoutFailure = exports.TerminatedFailure = exports.TemporalFailure = exports.ServerFailure = exports.ChildWorkflowFailure = exports.CancelledFailure = exports.ApplicationFailure = exports.ActivityFailure = exports.WorkflowIdReusePolicy = exports.defaultDataConverter = exports.IllegalStateError = exports.rootCause = exports.ActivityCancellationType = void 0;
+exports.AsyncLocalStorage = exports.Trigger = exports.CancellationScope = exports.ROOT_SCOPE = exports.ParentClosePolicy = exports.ChildWorkflowCancellationType = exports.ValueError = exports.TimeoutFailure = exports.TerminatedFailure = exports.TemporalFailure = exports.ServerFailure = exports.ChildWorkflowFailure = exports.CancelledFailure = exports.ApplicationFailure = exports.ActivityFailure = exports.WorkflowIdReusePolicy = exports.defaultDataConverter = exports.IllegalStateError = exports.rootCause = exports.ActivityCancellationType = void 0;
 var common_1 = require("@temporalio/common");
 Object.defineProperty(exports, "ActivityCancellationType", { enumerable: true, get: function () { return common_1.ActivityCancellationType; } });
 Object.defineProperty(exports, "rootCause", { enumerable: true, get: function () { return common_1.rootCause; } });
@@ -77,18 +77,18 @@ Object.defineProperty(exports, "ServerFailure", { enumerable: true, get: functio
 Object.defineProperty(exports, "TemporalFailure", { enumerable: true, get: function () { return common_1.TemporalFailure; } });
 Object.defineProperty(exports, "TerminatedFailure", { enumerable: true, get: function () { return common_1.TerminatedFailure; } });
 Object.defineProperty(exports, "TimeoutFailure", { enumerable: true, get: function () { return common_1.TimeoutFailure; } });
+Object.defineProperty(exports, "ValueError", { enumerable: true, get: function () { return common_1.ValueError; } });
 var interfaces_1 = require("./interfaces");
 Object.defineProperty(exports, "ChildWorkflowCancellationType", { enumerable: true, get: function () { return interfaces_1.ChildWorkflowCancellationType; } });
+Object.defineProperty(exports, "ParentClosePolicy", { enumerable: true, get: function () { return interfaces_1.ParentClosePolicy; } });
 __exportStar(require("./errors"), exports);
 __exportStar(require("./workflow"), exports);
 __exportStar(require("./interceptors"), exports);
-var async_local_storage_1 = require("./async-local-storage");
-Object.defineProperty(exports, "AsyncLocalStorage", { enumerable: true, get: function () { return async_local_storage_1.AsyncLocalStorage; } });
 var cancellation_scope_1 = require("./cancellation-scope");
 Object.defineProperty(exports, "ROOT_SCOPE", { enumerable: true, get: function () { return cancellation_scope_1.ROOT_SCOPE; } });
 Object.defineProperty(exports, "CancellationScope", { enumerable: true, get: function () { return cancellation_scope_1.CancellationScope; } });
 var trigger_1 = require("./trigger");
 Object.defineProperty(exports, "Trigger", { enumerable: true, get: function () { return trigger_1.Trigger; } });
-var dependencies_1 = require("./dependencies");
-Object.defineProperty(exports, "ApplyMode", { enumerable: true, get: function () { return dependencies_1.ApplyMode; } });
+var async_local_storage_1 = require("./async-local-storage");
+Object.defineProperty(exports, "AsyncLocalStorage", { enumerable: true, get: function () { return async_local_storage_1.AsyncLocalStorage; } });
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;;;;;;;;;;;;;AAEH,6CAsB4B;AAlB1B,kHAAA,wBAAwB,OAAA;AAKxB,mGAAA,SAAS,OAAA;AACT,2GAAA,iBAAiB,OAAA;AACjB,8GAAA,oBAAoB,OAAA;AAEpB,+GAAA,qBAAqB,OAAA;AACrB,yGAAA,eAAe,OAAA;AACf,4GAAA,kBAAkB,OAAA;AAClB,0GAAA,gBAAgB,OAAA;AAChB,8GAAA,oBAAoB,OAAA;AACpB,uGAAA,aAAa,OAAA;AACb,yGAAA,eAAe,OAAA;AACf,2GAAA,iBAAiB,OAAA;AACjB,wGAAA,cAAc,OAAA;AAEhB,2CAAiG;AAAlE,2HAAA,6BAA6B,OAAA;AAC5D,2CAAyB;AACzB,6CAA2B;AAC3B,iDAA+B;AAC/B,6DAA0D;AAAjD,wHAAA,iBAAiB,OAAA;AAC1B,2DAA+F;AAAtF,gHAAA,UAAU,OAAA;AAAE,uHAAA,iBAAiB,OAAA;AACtC,qCAAoC;AAA3B,kGAAA,OAAO,OAAA;AAChB,+CAMwB;AALtB,yGAAA,SAAS,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;;;;;;;;;;;;;AAEH,6CAsB4B;AAnB1B,kHAAA,wBAAwB,OAAA;AAKxB,mGAAA,SAAS,OAAA;AACT,2GAAA,iBAAiB,OAAA;AACjB,8GAAA,oBAAoB,OAAA;AAEpB,+GAAA,qBAAqB,OAAA;AACrB,yGAAA,eAAe,OAAA;AACf,4GAAA,kBAAkB,OAAA;AAClB,0GAAA,gBAAgB,OAAA;AAChB,8GAAA,oBAAoB,OAAA;AACpB,uGAAA,aAAa,OAAA;AACb,yGAAA,eAAe,OAAA;AACf,2GAAA,iBAAiB,OAAA;AACjB,wGAAA,cAAc,OAAA;AACd,oGAAA,UAAU,OAAA;AAEZ,2CAMsB;AAJpB,2HAAA,6BAA6B,OAAA;AAE7B,+GAAA,iBAAiB,OAAA;AAGnB,2CAAyB;AACzB,6CAA2B;AAC3B,iDAA+B;AAC/B,2DAA+F;AAAtF,gHAAA,UAAU,OAAA;AAAE,uHAAA,iBAAiB,OAAA;AACtC,qCAAoC;AAA3B,kGAAA,OAAO,OAAA;AAGhB,6DAA0D;AAAjD,wHAAA,iBAAiB,OAAA"}

package/lib/interceptors.d.ts

@@ -5,7 +5,7 @@
  *
  * @module
  */
-import { ActivityOptions, WorkflowExecution, Headers, Next, WorkflowHandlers } from '@temporalio/common';
+import { ActivityOptions, WorkflowExecution, Headers, Next } from '@temporalio/common';
 import { coresdk } from '@temporalio/proto/lib/coresdk';
 import { ChildWorkflowOptions, ContinueAsNewOptions } from './interfaces';
 export { Next, Headers };
@@ -34,12 +34,6 @@ export interface QueryInput {
  * Implement any of these methods to intercept Workflow inbound calls like execution, and signal and query handling.
  */
 export interface WorkflowInboundCallsInterceptor {
-    /**
-     * Called when Workflow is created from a factory function
-     *
-     * @return the Workflow handlers
-     */
-    create?: (input: WorkflowCreateInput, next: Next<this, 'create'>) => Promise<WorkflowHandlers>;
     /**
      * Called when Workflow execute method is called
      *

package/lib/interfaces.d.ts

@@ -85,5 +85,5 @@ export interface ChildWorkflowOptions extends WorkflowOptions {
      */
     parentClosePolicy?: ParentClosePolicy;
 }
-export declare type RequiredChildWorkflowOptions = Required<Pick<ChildWorkflowOptions, 'workflowId' | 'workflowIdReusePolicy' | 'cancellationType' | 'taskQueue'>>;
+export declare type RequiredChildWorkflowOptions = Required<Pick<ChildWorkflowOptions, 'workflowId' | 'cancellationType'>>;
 export declare type ChildWorkflowOptionsWithDefaults = ChildWorkflowOptions & RequiredChildWorkflowOptions;

package/lib/internals.d.ts

@@ -1,30 +1,35 @@
-import { WorkflowSignalType, DataConverter, WorkflowHandlers } from '@temporalio/common';
+import { WorkflowSignalType, DataConverter, Workflow, WorkflowQueryType } from '@temporalio/common';
 import { coresdk } from '@temporalio/proto/lib/coresdk';
 import { RNG } from './alea';
 import { WorkflowInfo } from './interfaces';
-import { QueryInput, SignalInput, WorkflowInterceptors } from './interceptors';
-import { ExternalCall, ExternalDependencies } from './dependencies';
+import { QueryInput, SignalInput, WorkflowExecuteInput, WorkflowInterceptors } from './interceptors';
+import { ExternalCall } from './dependencies';
 export declare type ResolveFunction<T = any> = (val: T) => any;
 export declare type RejectFunction<E = any> = (val: E) => any;
 export interface Completion {
     resolve: ResolveFunction;
     reject: RejectFunction;
 }
+export interface Condition {
+    fn(): boolean;
+    resolve(): void;
+}
 export declare type ActivationHandlerFunction<K extends keyof coresdk.workflow_activation.IWFActivationJob> = (activation: NonNullable<coresdk.workflow_activation.IWFActivationJob[K]>) => Promise<void> | void;
 export declare type ActivationHandler = {
     [P in keyof coresdk.workflow_activation.IWFActivationJob]: ActivationHandlerFunction<P>;
 };
 export declare class Activator implements ActivationHandler {
-    startWorkflowNextHandler(): Promise<any>;
+    workflowFunctionWasCalled: boolean;
+    startWorkflowNextHandler({ args }: WorkflowExecuteInput): Promise<any>;
     startWorkflow(activation: coresdk.workflow_activation.IStartWorkflow): void;
     cancelWorkflow(_activation: coresdk.workflow_activation.ICancelWorkflow): void;
     fireTimer(activation: coresdk.workflow_activation.IFireTimer): void;
     resolveActivity(activation: coresdk.workflow_activation.IResolveActivity): Promise<void>;
     resolveChildWorkflowExecutionStart(activation: coresdk.workflow_activation.IResolveChildWorkflowExecutionStart): Promise<void>;
     resolveChildWorkflowExecution(activation: coresdk.workflow_activation.IResolveChildWorkflowExecution): Promise<void>;
-    protected queryWorkflowNextHandler(input: QueryInput): Promise<unknown>;
+    protected queryWorkflowNextHandler({ queryName, args }: QueryInput): Promise<unknown>;
     queryWorkflow(activation: coresdk.workflow_activation.IQueryWorkflow): void;
-    signalWorkflowNextHandler(fn: WorkflowSignalType, input: SignalInput): Promise<void>;
+    signalWorkflowNextHandler({ signalName, args }: SignalInput): Promise<void>;
     signalWorkflow(activation: coresdk.workflow_activation.ISignalWorkflow): void;
     resolveSignalExternalWorkflow(activation: coresdk.workflow_activation.IResolveSignalExternalWorkflow): Promise<void>;
     resolveRequestCancelExternalWorkflow(activation: coresdk.workflow_activation.IResolveRequestCancelExternalWorkflow): Promise<void>;
@@ -55,6 +60,26 @@ export declare class State {
         signalWorkflow: Map<number, Completion>;
         cancelWorkflow: Map<number, Completion>;
     };
+    /**
+     * Holds buffered signal calls until a listener is registered
+     */
+    readonly bufferedSignals: Map<string, coresdk.workflow_activation.ISignalWorkflow[]>;
+    /**
+     * Holds buffered query calls until a listener is registered.
+     *
+     * **IMPORTANT** queries are only buffered until workflow is started.
+     * This is required because async interceptors might block workflow function invocation
+     * which delays query handler registration.
+     */
+    readonly bufferedQueries: coresdk.workflow_activation.IQueryWorkflow[];
+    /**
+     * Mapping of signal name to listener
+     */
+    readonly signalListeners: Map<string, WorkflowSignalType>;
+    /**
+     * Mapping of signal name to listener
+     */
+    readonly queryListeners: Map<string, WorkflowQueryType>;
     /**
      * Loaded in {@link initRuntime}
      */
@@ -64,9 +89,10 @@ export declare class State {
      */
     commands: coresdk.workflow_commands.IWorkflowCommand[];
     /**
-     * Buffer containing external dependency calls which have not yet been transferred out of the isolate
+    /**
+     * Stores all {@link condition}s that haven't been unblocked yet
      */
-    pendingExternalCalls: ExternalCall[];
+    blockedConditions: Map<number, Condition>;
     /**
      * Is this Workflow completed
      */
@@ -82,16 +108,16 @@ export declare class State {
         timer: number;
         activity: number;
         childWorkflow: number;
-        dependency: number;
         signalWorkflow: number;
         cancelWorkflow: number;
+        condition: number;
     };
     get now(): number;
     set now(value: number);
     /**
      * Reference to the current Workflow, initialized when a Workflow is started
      */
-    workflow?: WorkflowHandlers;
+    workflow?: Workflow;
     /**
      * Information about the current Workflow
      */
@@ -100,14 +126,12 @@ export declare class State {
      * A deterministic RNG, used by the isolate's overridden Math.random
      */
     random: RNG;
-    dependencies: ExternalDependencies;
-    getAndResetPendingExternalCalls(): ExternalCall[];
     /**
      * Used to require user code
      *
      * Injected on isolate startup
      */
-    require?: (path: string | undefined, workflowType: string) => any;
+    require?: (path: string | undefined) => Promise<Record<string, any>>;
     dataConverter: DataConverter;
     /**
      * Patches we know the status of for this workflow, as in {@link patched}
@@ -117,6 +141,8 @@ export declare class State {
      * Patches we sent to core {@link patched}
      */
     readonly sentPatches: Set<string>;
+    externalCalls: ExternalCall[];
+    getAndResetExternalCalls(): ExternalCall[];
     /**
      * Buffer a Workflow command to be collected at the end of the current activation.
      *