@temporalio/workflow 1.0.0-rc.0 → 1.0.0-rc.1

package/lib/errors.js

@@ -1,9 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isCancellation = exports.DeterminismViolationError = exports.WorkflowError = exports.WorkflowExecutionAlreadyStartedError = void 0;
-const common_1 = require("@temporalio/common");
-var common_2 = require("@temporalio/common");
-Object.defineProperty(exports, "WorkflowExecutionAlreadyStartedError", { enumerable: true, get: function () { return common_2.WorkflowExecutionAlreadyStartedError; } });
+var common_1 = require("@temporalio/common");
+Object.defineProperty(exports, "WorkflowExecutionAlreadyStartedError", { enumerable: true, get: function () { return common_1.WorkflowExecutionAlreadyStartedError; } });
 /**
  * Base class for all workflow errors
  */
@@ -24,12 +23,17 @@ class DeterminismViolationError extends WorkflowError {
     }
 }
 exports.DeterminismViolationError = DeterminismViolationError;
+function looksLikeError(err) {
+    return typeof err === 'object' && err != null && Object.prototype.hasOwnProperty.call(err, 'name');
+}
 /**
  * Returns whether provided `err` is caused by cancellation
  */
 function isCancellation(err) {
-    return (err instanceof common_1.CancelledFailure ||
-        ((err instanceof common_1.ActivityFailure || err instanceof common_1.ChildWorkflowFailure) && isCancellation(err.cause)));
+    if (!looksLikeError(err))
+        return false;
+    return (err.name === 'CancelledFailure' ||
+        ((err.name === 'ActivityFailure' || err.name === 'ChildWorkflowFailure') && isCancellation(err.cause)));
 }
 exports.isCancellation = isCancellation;
 //# sourceMappingURL=errors.js.map

package/lib/errors.js.map

@@ -1 +1 @@
-{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":";;;AAAA,+CAA6F;AAC7F,6CAA0E;AAAjE,8HAAA,oCAAoC,OAAA;AAE7C;;GAEG;AACH,MAAa,aAAc,SAAQ,KAAK;IAAxC;;QACkB,SAAI,GAAW,eAAe,CAAC;IACjD,CAAC;CAAA;AAFD,sCAEC;AAED;;GAEG;AACH,MAAa,yBAA0B,SAAQ,aAAa;IAA5D;;QACkB,SAAI,GAAW,2BAA2B,CAAC;IAC7D,CAAC;CAAA;AAFD,8DAEC;AAED;;GAEG;AACH,SAAgB,cAAc,CAAC,GAAY;IACzC,OAAO,CACL,GAAG,YAAY,yBAAgB;QAC/B,CAAC,CAAC,GAAG,YAAY,wBAAe,IAAI,GAAG,YAAY,6BAAoB,CAAC,IAAI,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CACvG,CAAC;AACJ,CAAC;AALD,wCAKC"}
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":";;;AAAA,6CAA0E;AAAjE,8HAAA,oCAAoC,OAAA;AAE7C;;GAEG;AACH,MAAa,aAAc,SAAQ,KAAK;IAAxC;;QACkB,SAAI,GAAW,eAAe,CAAC;IACjD,CAAC;CAAA;AAFD,sCAEC;AAED;;GAEG;AACH,MAAa,yBAA0B,SAAQ,aAAa;IAA5D;;QACkB,SAAI,GAAW,2BAA2B,CAAC;IAC7D,CAAC;CAAA;AAFD,8DAEC;AAED,SAAS,cAAc,CAAC,GAAY;IAClC,OAAO,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,IAAI,IAAI,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;AACrG,CAAC;AAED;;GAEG;AACH,SAAgB,cAAc,CAAC,GAAY;IACzC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC;QAAE,OAAO,KAAK,CAAC;IACvC,OAAO,CACL,GAAG,CAAC,IAAI,KAAK,kBAAkB;QAC/B,CAAC,CAAC,GAAG,CAAC,IAAI,KAAK,iBAAiB,IAAI,GAAG,CAAC,IAAI,KAAK,sBAAsB,CAAC,IAAI,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CACvG,CAAC;AACJ,CAAC;AAND,wCAMC"}

package/lib/index.d.ts

@@ -2,12 +2,13 @@
  * This library provides tools required for authoring workflows.
  *
  * ## Usage
- * See the [tutorial](https://docs.temporal.io/typescript/hello-world#workflows) for writing your first workflow.
+ * See the {@link https://docs.temporal.io/typescript/hello-world#workflows | tutorial} 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/typescript/workflow-scopes-and-cancellation).
+ * 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 {@link https://docs.temporal.io/typescript/workflow-scopes-and-cancellation | cancellation scopes}.
  *
  * <!--SNIPSTART typescript-sleep-workflow-->
  * <!--SNIPEND-->
@@ -21,11 +22,12 @@
  *
  * ### Signals and Queries
  *
- * To add signal handlers to a Workflow, add a signals property to the exported `workflow` object.
- * Signal handlers can return either `void` or `Promise<void>`, you may schedule activities and timers from a signal handler.
+ * To add signal handlers to a Workflow, add a signals property to the exported `workflow` object. Signal handlers can
+ * return either `void` or `Promise<void>`, you may schedule activities and timers from a signal handler.
  *
- * To add query handlers to a Workflow, add a queries property to the exported `workflow` object.
- * Query handlers must **not** mutate any variables or generate any commands (like Activities or Timers), they run synchronously and thus **must** return a `Promise`.
+ * To add query handlers to a Workflow, add a queries property to the exported `workflow` object. Query handlers must
+ * **not** mutate any variables or generate any commands (like Activities or Timers), they run synchronously and thus
+ * **must** return a `Promise`.
  *
  * #### Implementation
  *
@@ -33,7 +35,8 @@
  * <!--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.
+ * 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/typescript/workflow-scopes-and-cancellation)
  * - {@link CancellationScope}
@@ -45,8 +48,11 @@
  * @module
  */
 export { ActivityFailure, ApplicationFailure, CancelledFailure, ChildWorkflowFailure, defaultPayloadConverter, PayloadConverter, rootCause, ServerFailure, TemporalFailure, TerminatedFailure, TimeoutFailure, } from '@temporalio/common';
-export { ActivityCancellationType, ActivityFunction, ActivityInterface, ActivityOptions, IllegalStateError, RetryPolicy, ValueError, } from '@temporalio/internal-workflow-common';
+export { ActivityCancellationType, ActivityFunction, ActivityInterface, // eslint-disable-line deprecation/deprecation
+ActivityOptions, RetryPolicy, UntypedActivities, } from '@temporalio/internal-workflow-common';
+export * from '@temporalio/internal-workflow-common/lib/errors';
 export * from '@temporalio/internal-workflow-common/lib/interfaces';
+export * from '@temporalio/internal-workflow-common/lib/workflow-handle';
 export * from '@temporalio/internal-workflow-common/lib/workflow-options';
 export { AsyncLocalStorage, CancellationScope, CancellationScopeOptions, ROOT_SCOPE } from './cancellation-scope';
 export * from './errors';

package/lib/index.js

@@ -3,12 +3,13 @@
  * This library provides tools required for authoring workflows.
  *
  * ## Usage
- * See the [tutorial](https://docs.temporal.io/typescript/hello-world#workflows) for writing your first workflow.
+ * See the {@link https://docs.temporal.io/typescript/hello-world#workflows | tutorial} 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/typescript/workflow-scopes-and-cancellation).
+ * 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 {@link https://docs.temporal.io/typescript/workflow-scopes-and-cancellation | cancellation scopes}.
  *
  * <!--SNIPSTART typescript-sleep-workflow-->
  * <!--SNIPEND-->
@@ -22,11 +23,12 @@
  *
  * ### Signals and Queries
  *
- * To add signal handlers to a Workflow, add a signals property to the exported `workflow` object.
- * Signal handlers can return either `void` or `Promise<void>`, you may schedule activities and timers from a signal handler.
+ * To add signal handlers to a Workflow, add a signals property to the exported `workflow` object. Signal handlers can
+ * return either `void` or `Promise<void>`, you may schedule activities and timers from a signal handler.
  *
- * To add query handlers to a Workflow, add a queries property to the exported `workflow` object.
- * Query handlers must **not** mutate any variables or generate any commands (like Activities or Timers), they run synchronously and thus **must** return a `Promise`.
+ * To add query handlers to a Workflow, add a queries property to the exported `workflow` object. Query handlers must
+ * **not** mutate any variables or generate any commands (like Activities or Timers), they run synchronously and thus
+ * **must** return a `Promise`.
  *
  * #### Implementation
  *
@@ -34,7 +36,8 @@
  * <!--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.
+ * 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/typescript/workflow-scopes-and-cancellation)
  * - {@link CancellationScope}
@@ -60,7 +63,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.Trigger = exports.ParentClosePolicy = exports.ContinueAsNew = exports.ChildWorkflowCancellationType = exports.ROOT_SCOPE = exports.CancellationScope = exports.AsyncLocalStorage = exports.ValueError = exports.IllegalStateError = exports.ActivityCancellationType = exports.TimeoutFailure = exports.TerminatedFailure = exports.TemporalFailure = exports.ServerFailure = exports.rootCause = exports.defaultPayloadConverter = exports.ChildWorkflowFailure = exports.CancelledFailure = exports.ApplicationFailure = exports.ActivityFailure = void 0;
+exports.Trigger = exports.ParentClosePolicy = exports.ContinueAsNew = exports.ChildWorkflowCancellationType = exports.ROOT_SCOPE = exports.CancellationScope = exports.AsyncLocalStorage = exports.ActivityCancellationType = exports.TimeoutFailure = exports.TerminatedFailure = exports.TemporalFailure = exports.ServerFailure = exports.rootCause = exports.defaultPayloadConverter = exports.ChildWorkflowFailure = exports.CancelledFailure = exports.ApplicationFailure = exports.ActivityFailure = void 0;
 var common_1 = require("@temporalio/common");
 Object.defineProperty(exports, "ActivityFailure", { enumerable: true, get: function () { return common_1.ActivityFailure; } });
 Object.defineProperty(exports, "ApplicationFailure", { enumerable: true, get: function () { return common_1.ApplicationFailure; } });
@@ -74,9 +77,9 @@ Object.defineProperty(exports, "TerminatedFailure", { enumerable: true, get: fun
 Object.defineProperty(exports, "TimeoutFailure", { enumerable: true, get: function () { return common_1.TimeoutFailure; } });
 var internal_workflow_common_1 = require("@temporalio/internal-workflow-common");
 Object.defineProperty(exports, "ActivityCancellationType", { enumerable: true, get: function () { return internal_workflow_common_1.ActivityCancellationType; } });
-Object.defineProperty(exports, "IllegalStateError", { enumerable: true, get: function () { return internal_workflow_common_1.IllegalStateError; } });
-Object.defineProperty(exports, "ValueError", { enumerable: true, get: function () { return internal_workflow_common_1.ValueError; } });
+__exportStar(require("@temporalio/internal-workflow-common/lib/errors"), exports);
 __exportStar(require("@temporalio/internal-workflow-common/lib/interfaces"), exports);
+__exportStar(require("@temporalio/internal-workflow-common/lib/workflow-handle"), exports);
 __exportStar(require("@temporalio/internal-workflow-common/lib/workflow-options"), exports);
 var cancellation_scope_1 = require("./cancellation-scope");
 Object.defineProperty(exports, "AsyncLocalStorage", { enumerable: true, get: function () { return cancellation_scope_1.AsyncLocalStorage; } });

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;;;;;;;;;;;;;;;;;AAEH,6CAY4B;AAX1B,yGAAA,eAAe,OAAA;AACf,4GAAA,kBAAkB,OAAA;AAClB,0GAAA,gBAAgB,OAAA;AAChB,8GAAA,oBAAoB,OAAA;AACpB,iHAAA,uBAAuB,OAAA;AAEvB,mGAAA,SAAS,OAAA;AACT,uGAAA,aAAa,OAAA;AACb,yGAAA,eAAe,OAAA;AACf,2GAAA,iBAAiB,OAAA;AACjB,wGAAA,cAAc,OAAA;AAEhB,iFAQ8C;AAP5C,oIAAA,wBAAwB,OAAA;AAIxB,6HAAA,iBAAiB,OAAA;AAEjB,sHAAA,UAAU,OAAA;AAEZ,sFAAoE;AACpE,4FAA0E;AAC1E,2DAAkH;AAAzG,uHAAA,iBAAiB,OAAA;AAAE,uHAAA,iBAAiB,OAAA;AAA4B,gHAAA,UAAU,OAAA;AACnF,2CAAyB;AACzB,iDAA+B;AAC/B,2CAQsB;AAPpB,2HAAA,6BAA6B,OAAA;AAE7B,2GAAA,aAAa,OAAA;AAEb,+GAAA,iBAAiB,OAAA;AAKnB,qCAAoC;AAA3B,kGAAA,OAAO,OAAA;AAChB,6CAA2B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;;;;;;;;;;;;;;;;;AAEH,6CAY4B;AAX1B,yGAAA,eAAe,OAAA;AACf,4GAAA,kBAAkB,OAAA;AAClB,0GAAA,gBAAgB,OAAA;AAChB,8GAAA,oBAAoB,OAAA;AACpB,iHAAA,uBAAuB,OAAA;AAEvB,mGAAA,SAAS,OAAA;AACT,uGAAA,aAAa,OAAA;AACb,yGAAA,eAAe,OAAA;AACf,2GAAA,iBAAiB,OAAA;AACjB,wGAAA,cAAc,OAAA;AAEhB,iFAO8C;AAN5C,oIAAA,wBAAwB,OAAA;AAO1B,kFAAgE;AAChE,sFAAoE;AACpE,2FAAyE;AACzE,4FAA0E;AAC1E,2DAAkH;AAAzG,uHAAA,iBAAiB,OAAA;AAAE,uHAAA,iBAAiB,OAAA;AAA4B,gHAAA,UAAU,OAAA;AACnF,2CAAyB;AACzB,iDAA+B;AAC/B,2CAQsB;AAPpB,2HAAA,6BAA6B,OAAA;AAE7B,2GAAA,aAAa,OAAA;AAEb,+GAAA,iBAAiB,OAAA;AAKnB,qCAAoC;AAA3B,kGAAA,OAAO,OAAA;AAChB,6CAA2B"}

package/lib/interfaces.d.ts

@@ -21,7 +21,7 @@ export interface WorkflowInfo {
     /**
      * Indexed information attached to the Workflow Execution
      */
-    searchAttributes?: SearchAttributes;
+    searchAttributes: SearchAttributes;
     /**
      * Non-indexed information attached to the Workflow Execution
      */
@@ -136,16 +136,60 @@ export interface ContinueAsNewOptions {
      */
     searchAttributes?: SearchAttributes;
 }
+/**
+ * Specifies:
+ * - whether cancellation requests are sent to the Child
+ * - whether and when a {@link CanceledFailure} is thrown from {@link executeChild} or
+ *   {@link ChildWorkflowHandle.result}
+ *
+ * @default {@link ChildWorkflowCancellationType.WAIT_CANCELLATION_COMPLETED}
+ */
 export declare enum ChildWorkflowCancellationType {
+    /**
+     * Don't send a cancellation request to the Child.
+     */
     ABANDON = 0,
+    /**
+     * Send a cancellation request to the Child. Immediately throw the error.
+     */
     TRY_CANCEL = 1,
+    /**
+     * Send a cancellation request to the Child. The Child may respect cancellation, in which case an error will be thrown
+     * when cancellation has completed, and {@link isCancellation}(error) will be true. On the other hand, the Child may
+     * ignore the cancellation request, in which case an error might be thrown with a different cause, or the Child may
+     * complete successfully.
+     *
+     * @default
+     */
     WAIT_CANCELLATION_COMPLETED = 2,
+    /**
+     * Send a cancellation request to the Child. Throw the error once the Server receives the Child cancellation request.
+     */
     WAIT_CANCELLATION_REQUESTED = 3
 }
+/**
+ * How a Child Workflow reacts to the Parent Workflow reaching a Closed state.
+ *
+ * @see {@link https://docs.temporal.io/concepts/what-is-a-parent-close-policy/ | Parent Close Policy}
+ */
 export declare enum ParentClosePolicy {
+    /**
+     * If a `ParentClosePolicy` is set to this, or is not set at all, the server default value will be used.
+     */
     PARENT_CLOSE_POLICY_UNSPECIFIED = 0,
+    /**
+     * When the Parent is Closed, the Child is Terminated.
+     *
+     * @default
+     */
     PARENT_CLOSE_POLICY_TERMINATE = 1,
+    /**
+     * When the Parent is Closed, nothing is done to the Child.
+     */
     PARENT_CLOSE_POLICY_ABANDON = 2,
+    /**
+     * When the Parent is Closed, the Child is Cancelled.
+     */
     PARENT_CLOSE_POLICY_REQUEST_CANCEL = 3
 }
 export interface ChildWorkflowOptions extends CommonWorkflowOptions {
@@ -161,13 +205,18 @@ export interface ChildWorkflowOptions extends CommonWorkflowOptions {
      */
     taskQueue?: string;
     /**
-     * In case of a child workflow cancellation it fails with a CanceledFailure.
-     * The type defines at which point the exception is thrown.
-     * @default ChildWorkflowCancellationType.WAIT_CANCELLATION_COMPLETED
+     * Specifies:
+     * - whether cancellation requests are sent to the Child
+     * - whether and when an error is thrown from {@link executeChild} or
+     *   {@link ChildWorkflowHandle.result}
+     *
+     * @default {@link ChildWorkflowCancellationType.WAIT_CANCELLATION_COMPLETED}
      */
     cancellationType?: ChildWorkflowCancellationType;
     /**
-     * Specifies how this workflow reacts to the death of the parent workflow.
+     * Specifies how the Child reacts to the Parent Workflow reaching a Closed state.
+     *
+     * @default {@link ParentClosePolicy.PARENT_CLOSE_POLICY_TERMINATE}
      */
     parentClosePolicy?: ParentClosePolicy;
 }

package/lib/interfaces.js

@@ -13,19 +13,63 @@ class ContinueAsNew extends Error {
     }
 }
 exports.ContinueAsNew = ContinueAsNew;
+/**
+ * Specifies:
+ * - whether cancellation requests are sent to the Child
+ * - whether and when a {@link CanceledFailure} is thrown from {@link executeChild} or
+ *   {@link ChildWorkflowHandle.result}
+ *
+ * @default {@link ChildWorkflowCancellationType.WAIT_CANCELLATION_COMPLETED}
+ */
 var ChildWorkflowCancellationType;
 (function (ChildWorkflowCancellationType) {
+    /**
+     * Don't send a cancellation request to the Child.
+     */
     ChildWorkflowCancellationType[ChildWorkflowCancellationType["ABANDON"] = 0] = "ABANDON";
+    /**
+     * Send a cancellation request to the Child. Immediately throw the error.
+     */
     ChildWorkflowCancellationType[ChildWorkflowCancellationType["TRY_CANCEL"] = 1] = "TRY_CANCEL";
+    /**
+     * Send a cancellation request to the Child. The Child may respect cancellation, in which case an error will be thrown
+     * when cancellation has completed, and {@link isCancellation}(error) will be true. On the other hand, the Child may
+     * ignore the cancellation request, in which case an error might be thrown with a different cause, or the Child may
+     * complete successfully.
+     *
+     * @default
+     */
     ChildWorkflowCancellationType[ChildWorkflowCancellationType["WAIT_CANCELLATION_COMPLETED"] = 2] = "WAIT_CANCELLATION_COMPLETED";
+    /**
+     * Send a cancellation request to the Child. Throw the error once the Server receives the Child cancellation request.
+     */
     ChildWorkflowCancellationType[ChildWorkflowCancellationType["WAIT_CANCELLATION_REQUESTED"] = 3] = "WAIT_CANCELLATION_REQUESTED";
 })(ChildWorkflowCancellationType = exports.ChildWorkflowCancellationType || (exports.ChildWorkflowCancellationType = {}));
 (0, internal_workflow_common_1.checkExtends)();
+/**
+ * How a Child Workflow reacts to the Parent Workflow reaching a Closed state.
+ *
+ * @see {@link https://docs.temporal.io/concepts/what-is-a-parent-close-policy/ | Parent Close Policy}
+ */
 var ParentClosePolicy;
 (function (ParentClosePolicy) {
+    /**
+     * If a `ParentClosePolicy` is set to this, or is not set at all, the server default value will be used.
+     */
     ParentClosePolicy[ParentClosePolicy["PARENT_CLOSE_POLICY_UNSPECIFIED"] = 0] = "PARENT_CLOSE_POLICY_UNSPECIFIED";
+    /**
+     * When the Parent is Closed, the Child is Terminated.
+     *
+     * @default
+     */
     ParentClosePolicy[ParentClosePolicy["PARENT_CLOSE_POLICY_TERMINATE"] = 1] = "PARENT_CLOSE_POLICY_TERMINATE";
+    /**
+     * When the Parent is Closed, nothing is done to the Child.
+     */
     ParentClosePolicy[ParentClosePolicy["PARENT_CLOSE_POLICY_ABANDON"] = 2] = "PARENT_CLOSE_POLICY_ABANDON";
+    /**
+     * When the Parent is Closed, the Child is Cancelled.
+     */
     ParentClosePolicy[ParentClosePolicy["PARENT_CLOSE_POLICY_REQUEST_CANCEL"] = 3] = "PARENT_CLOSE_POLICY_REQUEST_CANCEL";
 })(ParentClosePolicy = exports.ParentClosePolicy || (exports.ParentClosePolicy = {}));
 (0, internal_workflow_common_1.checkExtends)();

package/lib/interfaces.js.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":";;;AACA,mFAA6G;AA2H7G;;GAEG;AACH,MAAa,aAAc,SAAQ,KAAK;IAGtC,YAA4B,OAAkE;QAC5F,KAAK,CAAC,2BAA2B,CAAC,CAAC;QADT,YAAO,GAAP,OAAO,CAA2D;QAF9E,SAAI,GAAG,eAAe,CAAC;IAIvC,CAAC;CACF;AAND,sCAMC;AAkCD,IAAY,6BAKX;AALD,WAAY,6BAA6B;IACvC,uFAAW,CAAA;IACX,6FAAc,CAAA;IACd,+HAA+B,CAAA;IAC/B,+HAA+B,CAAA;AACjC,CAAC,EALW,6BAA6B,GAA7B,qCAA6B,KAA7B,qCAA6B,QAKxC;AAED,IAAA,uCAAY,GAAuF,CAAC;AAEpG,IAAY,iBAKX;AALD,WAAY,iBAAiB;IAC3B,+GAAmC,CAAA;IACnC,2GAAiC,CAAA;IACjC,uGAA+B,CAAA;IAC/B,qHAAsC,CAAA;AACxC,CAAC,EALW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAK5B;AAED,IAAA,uCAAY,GAA+D,CAAC"}
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":";;;AACA,mFAA6G;AA2H7G;;GAEG;AACH,MAAa,aAAc,SAAQ,KAAK;IAGtC,YAA4B,OAAkE;QAC5F,KAAK,CAAC,2BAA2B,CAAC,CAAC;QADT,YAAO,GAAP,OAAO,CAA2D;QAF9E,SAAI,GAAG,eAAe,CAAC;IAIvC,CAAC;CACF;AAND,sCAMC;AAkCD;;;;;;;GAOG;AACH,IAAY,6BAyBX;AAzBD,WAAY,6BAA6B;IACvC;;OAEG;IACH,uFAAW,CAAA;IAEX;;OAEG;IACH,6FAAc,CAAA;IAEd;;;;;;;OAOG;IACH,+HAA+B,CAAA;IAE/B;;OAEG;IACH,+HAA+B,CAAA;AACjC,CAAC,EAzBW,6BAA6B,GAA7B,qCAA6B,KAA7B,qCAA6B,QAyBxC;AAED,IAAA,uCAAY,GAAuF,CAAC;AAEpG;;;;GAIG;AACH,IAAY,iBAsBX;AAtBD,WAAY,iBAAiB;IAC3B;;OAEG;IACH,+GAAmC,CAAA;IAEnC;;;;OAIG;IACH,2GAAiC,CAAA;IAEjC;;OAEG;IACH,uGAA+B,CAAA;IAE/B;;OAEG;IACH,qHAAsC,CAAA;AACxC,CAAC,EAtBW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAsB5B;AAED,IAAA,uCAAY,GAA+D,CAAC"}

package/lib/sinks.d.ts

@@ -16,7 +16,8 @@
 /**
  * Any function signature can be used for Sink functions as long as the return type is `void`.
  *
- * When calling a Sink function, arguments are copied from the Workflow isolate to the Node.js environment using [postMessage](https://nodejs.org/api/worker_threads.html#worker_threads_port_postmessage_value_transferlist).
+ * When calling a Sink function, arguments are copied from the Workflow isolate to the Node.js environment using
+ * {@link https://nodejs.org/api/worker_threads.html#worker_threads_port_postmessage_value_transferlist | postMessage}.
 
  * This constrains the argument types to primitives (excluding Symbols).
  */

package/lib/workflow.d.ts

@@ -1,4 +1,4 @@
-import { ActivityFunction, ActivityInterface, ActivityOptions, LocalActivityOptions, QueryDefinition, SearchAttributes, SignalDefinition, WithWorkflowArgs, Workflow, WorkflowResultType, WorkflowReturnType } from '@temporalio/internal-workflow-common';
+import { ActivityFunction, ActivityOptions, LocalActivityOptions, QueryDefinition, SearchAttributes, SignalDefinition, UntypedActivities, WithWorkflowArgs, Workflow, WorkflowResultType, WorkflowReturnType } from '@temporalio/internal-workflow-common';
 import { ChildWorkflowOptions, ChildWorkflowOptionsWithDefaults, ContinueAsNewOptions, WorkflowInfo } from './interfaces';
 import { Sinks } from './sinks';
 import { ChildWorkflowHandle, ExternalWorkflowHandle } from './workflow-handle';
@@ -15,11 +15,6 @@ export declare function addDefaultWorkflowOptions<T extends Workflow>(opts: With
  * If given a negative number or 0, value will be set to 1.
  */
 export declare function sleep(ms: number | string): Promise<void>;
-export interface ActivityInfo {
-    name: string;
-    type: string;
-}
-export declare type InternalActivityFunction<P extends any[], R> = ActivityFunction<P, R> & ActivityInfo;
 /**
  * Schedule an activity and run outbound interceptors
  * @hidden
@@ -30,19 +25,52 @@ export declare function scheduleActivity<R>(activityType: string, args: any[], o
  * @hidden
  */
 export declare function scheduleLocalActivity<R>(activityType: string, args: any[], options: LocalActivityOptions): Promise<R>;
+/**
+ * Symbol used in the return type of proxy methods to mark that an attribute on the source type is not a method.
+ *
+ * @see {@link ActivityInterfaceFor}
+ * @see {@link proxyActivities}
+ * @see {@link proxyLocalActivities}
+ */
+export declare const NotAnActivityMethod: unique symbol;
+/**
+ * Type helper that takes a type `T` and transforms attributes that are not {@link ActivityFunction} to
+ * {@link NotAnActivityMethod}.
+ *
+ * @example
+ *
+ * Used by {@link proxyActivities} to get this compile-time error:
+ *
+ * ```ts
+ * interface MyActivities {
+ *   valid(input: number): Promise<number>;
+ *   invalid(input: number): number;
+ * }
+ *
+ * const act = proxyActivities<MyActivities>({ startToCloseTimeout: '5m' });
+ *
+ * await act.valid(true);
+ * await act.invalid();
+ * // ^ TS complains with:
+ * // (property) invalidDefinition: typeof NotAnActivityMethod
+ * // This expression is not callable.
+ * // Type 'Symbol' has no call signatures.(2349)
+ * ```
+ */
+export declare type ActivityInterfaceFor<T> = {
+    [K in keyof T]: T[K] extends ActivityFunction ? T[K] : typeof NotAnActivityMethod;
+};
 /**
  * Configure Activity functions with given {@link ActivityOptions}.
  *
  * This method may be called multiple times to setup Activities with different options.
  *
- * @return a [Proxy](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy)
- *         for which each attribute is a callable Activity function
- *
- * @typeparam A An {@link ActivityInterface} - mapping of name to function
+ * @return a {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy | Proxy} for
+ *         which each attribute is a callable Activity function
  *
  * @example
  * ```ts
- * import { proxyActivities, ActivityInterface } from '@temporalio/workflow';
+ * import { proxyActivities } from '@temporalio/workflow';
  * import * as activities from '../activities';
  *
  * // Setup Activities from module exports
@@ -51,7 +79,7 @@ export declare function scheduleLocalActivity<R>(activityType: string, args: any
  * });
  *
  * // Setup Activities from an explicit interface (e.g. when defined by another SDK)
- * interface JavaActivities extends ActivityInterface {
+ * interface JavaActivities {
  *   httpGetFromJava(url: string): Promise<string>
  *   someOtherJavaActivity(arg1: number, arg2: string): Promise<string>;
  * }
@@ -70,22 +98,20 @@ export declare function scheduleLocalActivity<R>(activityType: string, args: any
  * }
  * ```
  */
-export declare function proxyActivities<A extends ActivityInterface>(options: ActivityOptions): A;
+export declare function proxyActivities<A = UntypedActivities>(options: ActivityOptions): ActivityInterfaceFor<A>;
 /**
  * Configure Local Activity functions with given {@link LocalActivityOptions}.
  *
  * This method may be called multiple times to setup Activities with different options.
  *
- * @return a [Proxy](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy)
+ * @return a {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy | Proxy}
  *         for which each attribute is a callable Activity function
  *
- * @typeparam A An {@link ActivityInterface} - mapping of name to function
- *
  * @experimental
  *
- * See {@link proxyActivities} for examples
+ * @see {@link proxyActivities} for examples
  */
-export declare function proxyLocalActivities<A extends ActivityInterface>(options: LocalActivityOptions): A;
+export declare function proxyLocalActivities<A = UntypedActivities>(options: LocalActivityOptions): ActivityInterfaceFor<A>;
 /**
  * Returns a client-side handle that can be used to signal and cancel an existing Workflow execution.
  * It takes a Workflow ID and optional run ID.
@@ -178,7 +204,7 @@ export declare function executeChild<T extends () => WorkflowReturnType>(workflo
  *
  * @return The result of the child Workflow.
  */
-export declare function executeChild<T extends () => WorkflowReturnType>(workflowFunc: T): Promise<ChildWorkflowHandle<T>>;
+export declare function executeChild<T extends () => WorkflowReturnType>(workflowFunc: T): Promise<WorkflowResultType<T>>;
 /**
  * Get information about the current Workflow
  */
@@ -221,30 +247,27 @@ export declare function proxySinks<T extends Sinks>(): T;
 /**
  * Returns a function `f` that will cause the current Workflow to ContinueAsNew when called.
  *
- * `f` takes the same arguments as the Workflow execute function supplied to typeparam `F`.
+ * `f` takes the same arguments as the Workflow function supplied to typeparam `F`.
  *
- * Once `f` is called, Workflow execution immediately completes.
+ * Once `f` is called, Workflow Execution immediately completes.
  */
 export declare function makeContinueAsNewFunc<F extends Workflow>(options?: ContinueAsNewOptions): (...args: Parameters<F>) => Promise<never>;
 /**
- * Continues current Workflow execution as new with default options.
+ * {@link https://docs.temporal.io/concepts/what-is-continue-as-new/ | Continues-As-New} the current Workflow Execution
+ * with default options.
  *
- * Shorthand for `makeContinueAsNewFunc<F>()(...args)`.
+ * Shorthand for `makeContinueAsNewFunc<F>()(...args)`. (See: {@link makeContinueAsNewFunc}.)
  *
  * @example
  *
- * ```ts
- * import { continueAsNew } from '@temporalio/workflow';
+ *```ts
+ *import { continueAsNew } from '@temporalio/workflow';
  *
- * export function myWorkflow(n: number) {
- *   return {
- *     async execute() {
- *       // ... Workflow logic
- *       await continueAsNew<typeof myWorkflow>(n + 1);
- *     }
- *   };
- * }
- * ```
+ *export async function myWorkflow(n: number): Promise<void> {
+ *  // ... Workflow logic
+ *  await continueAsNew<typeof myWorkflow>(n + 1);
+ *}
+ *```
  */
 export declare function continueAsNew<F extends Workflow>(...args: Parameters<F>): Promise<never>;
 /**
@@ -257,7 +280,7 @@ export declare function uuid4(): string;
 /**
  * Patch or upgrade workflow code by checking or stating that this workflow has a certain patch.
  *
- * See [docs page](https://docs.temporal.io/typescript/versioning) for info.
+ * See {@link https://docs.temporal.io/typescript/versioning | docs page} for info.
  *
  * If the workflow is replaying an existing history, then this function returns true if that
  * history was produced by a worker which also had a `patched` call with the same `patchId`.
@@ -275,7 +298,7 @@ export declare function patched(patchId: string): boolean;
 /**
  * Indicate that a patch is being phased out.
  *
- * See [docs page](https://docs.temporal.io/typescript/versioning) for info.
+ * See {@link https://docs.temporal.io/typescript/versioning | docs page} for info.
  *
  * Workflows with this call may be deployed alongside workflows with a {@link patched} call, but
  * they must *not* be deployed while any workers still exist running old code without a