@temporalio/workflow - npm Package Compare versions

Comparing version 1.11.3 to 1.11.4

lib/alea.js

@@ -7,3 +7,4 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Mash = exports.alea = void 0;
+exports.Mash = void 0;
+exports.alea = alea;
 // Copyright (C) 2010 by Johannes Baagøe <[e-mail]>
@@ -61,3 +62,2 @@ //
 }
-exports.alea = alea;
 class Mash {
@@ -64,0 +64,0 @@ constructor() {

lib/cancellation-scope.d.ts

@@ -1,2 +0,1 @@
-/// <reference types="node" />
 import type { AsyncLocalStorage as ALS } from 'node:async_hooks';
@@ -3,0 +2,0 @@ import { Duration } from '@temporalio/common';

lib/cancellation-scope.js

@@ -15,3 +15,5 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.registerSleepImplementation = exports.RootCancellationScope = exports.disableStorage = exports.CancellationScope = exports.AsyncLocalStorage = void 0;
+exports.RootCancellationScope = exports.CancellationScope = exports.AsyncLocalStorage = void 0;
+exports.disableStorage = disableStorage;
+exports.registerSleepImplementation = registerSleepImplementation;
 const common_1 = require("@temporalio/common");
@@ -193,3 +195,2 @@ const time_1 = require("@temporalio/common/lib/time");
 }
-exports.disableStorage = disableStorage;
 class RootCancellationScope extends CancellationScope {
@@ -211,3 +212,2 @@ constructor() {
 }
-exports.registerSleepImplementation = registerSleepImplementation;
 //# sourceMappingURL=cancellation-scope.js.map

lib/errors.js

@@ -9,3 +9,4 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isCancellation = exports.LocalActivityDoBackoff = exports.DeterminismViolationError = exports.WorkflowError = void 0;
+exports.LocalActivityDoBackoff = exports.DeterminismViolationError = exports.WorkflowError = void 0;
+exports.isCancellation = isCancellation;
 const common_1 = require("@temporalio/common");
@@ -51,3 +52,2 @@ const type_helpers_1 = require("@temporalio/common/lib/type-helpers");
 }
-exports.isCancellation = isCancellation;
 //# sourceMappingURL=errors.js.map

lib/flags.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.assertValidFlag = exports.SdkFlags = void 0;
+exports.SdkFlags = void 0;
+exports.assertValidFlag = assertValidFlag;
 const flagsRegistry = new Map();
@@ -50,3 +51,2 @@ exports.SdkFlags = {
 }
-exports.assertValidFlag = assertValidFlag;
 function buildIdSdkVersionMatches(version) {
@@ -53,0 +53,0 @@ const regex = new RegExp(`^@temporalio/worker@(${version.source})[+]`);

lib/global-attributes.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getActivator = exports.assertInWorkflowContext = exports.maybeGetActivator = exports.setActivatorUntyped = exports.maybeGetActivatorUntyped = void 0;
+exports.maybeGetActivatorUntyped = maybeGetActivatorUntyped;
+exports.setActivatorUntyped = setActivatorUntyped;
+exports.maybeGetActivator = maybeGetActivator;
+exports.assertInWorkflowContext = assertInWorkflowContext;
+exports.getActivator = getActivator;
 const common_1 = require("@temporalio/common");
@@ -8,11 +12,8 @@ function maybeGetActivatorUntyped() {
 }
-exports.maybeGetActivatorUntyped = maybeGetActivatorUntyped;
 function setActivatorUntyped(activator) {
     globalThis.__TEMPORAL_ACTIVATOR__ = activator;
 }
-exports.setActivatorUntyped = setActivatorUntyped;
 function maybeGetActivator() {
     return maybeGetActivatorUntyped();
 }
-exports.maybeGetActivator = maybeGetActivator;
 function assertInWorkflowContext(message) {
@@ -24,3 +25,2 @@ const activator = maybeGetActivator();
 }
-exports.assertInWorkflowContext = assertInWorkflowContext;
 function getActivator() {
@@ -33,3 +33,2 @@ const activator = maybeGetActivator();
 }
-exports.getActivator = getActivator;
 //# sourceMappingURL=global-attributes.js.map

lib/global-overrides.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.overrideGlobals = void 0;
+exports.overrideGlobals = overrideGlobals;
 /**
@@ -96,3 +96,2 @@ * Overrides some global objects to make them deterministic.
 }
-exports.overrideGlobals = overrideGlobals;
 //# sourceMappingURL=global-overrides.js.map

lib/interfaces.d.ts

@@ -227,11 +227,12 @@ import type { RawSourceMap } from 'source-map';
  */
-export declare enum ChildWorkflowCancellationType {
+export type ChildWorkflowCancellationType = (typeof ChildWorkflowCancellationType)[keyof typeof ChildWorkflowCancellationType];
+export declare const ChildWorkflowCancellationType: {
     /**
      * Don't send a cancellation request to the Child.
      */
-    ABANDON = 0,
+    readonly ABANDON: "ABANDON";
     /**
      * Send a cancellation request to the Child. Immediately throw the error.
      */
-    TRY_CANCEL = 1,
+    readonly TRY_CANCEL: "TRY_CANCEL";
     /**
@@ -245,8 +246,9 @@ * Send a cancellation request to the Child. The Child may respect cancellation, in which case an error will be thrown
      */
-    WAIT_CANCELLATION_COMPLETED = 2,
+    readonly WAIT_CANCELLATION_COMPLETED: "WAIT_CANCELLATION_COMPLETED";
     /**
      * Send a cancellation request to the Child. Throw the error once the Server receives the Child cancellation request.
      */
-    WAIT_CANCELLATION_REQUESTED = 3
-}
+    readonly WAIT_CANCELLATION_REQUESTED: "WAIT_CANCELLATION_REQUESTED";
+};
+export declare const encodeChildWorkflowCancellationType: (input: coresdk.child_workflow.ChildWorkflowCancellationType | import("@temporalio/common/lib/type-helpers").RemovePrefix<"", "ABANDON" | "TRY_CANCEL" | "WAIT_CANCELLATION_COMPLETED" | "WAIT_CANCELLATION_REQUESTED"> | null | undefined) => coresdk.child_workflow.ChildWorkflowCancellationType | undefined, decodeChildWorkflowCancellationType: (input: coresdk.child_workflow.ChildWorkflowCancellationType | null | undefined) => import("@temporalio/common/lib/type-helpers").RemovePrefix<"", "ABANDON" | "TRY_CANCEL" | "WAIT_CANCELLATION_COMPLETED" | "WAIT_CANCELLATION_REQUESTED"> | undefined;
 /**
@@ -257,22 +259,44 @@ * How a Child Workflow reacts to the Parent Workflow reaching a Closed state.
  */
-export declare enum ParentClosePolicy {
+export type ParentClosePolicy = (typeof ParentClosePolicy)[keyof typeof ParentClosePolicy];
+export declare const ParentClosePolicy: {
     /**
+     * When the Parent is Closed, the Child is Terminated.
+     *
+     * @default
+     */
+    readonly TERMINATE: "TERMINATE";
+    /**
+     * When the Parent is Closed, nothing is done to the Child.
+     */
+    readonly ABANDON: "ABANDON";
+    /**
+     * When the Parent is Closed, the Child is Cancelled.
+     */
+    readonly REQUEST_CANCEL: "REQUEST_CANCEL";
+    /**
      * If a `ParentClosePolicy` is set to this, or is not set at all, the server default value will be used.
+     *
+     * @deprecated Either leave property `undefined`, or set an explicit policy instead.
      */
-    PARENT_CLOSE_POLICY_UNSPECIFIED = 0,
+    readonly PARENT_CLOSE_POLICY_UNSPECIFIED: undefined;
     /**
      * When the Parent is Closed, the Child is Terminated.
      *
-     * @default
+     * @deprecated Use {@link ParentClosePolicy.TERMINATE} instead.
      */
-    PARENT_CLOSE_POLICY_TERMINATE = 1,
+    readonly PARENT_CLOSE_POLICY_TERMINATE: "TERMINATE";
     /**
      * When the Parent is Closed, nothing is done to the Child.
+     *
+     * @deprecated Use {@link ParentClosePolicy.ABANDON} instead.
      */
-    PARENT_CLOSE_POLICY_ABANDON = 2,
+    readonly PARENT_CLOSE_POLICY_ABANDON: "ABANDON";
     /**
      * When the Parent is Closed, the Child is Cancelled.
+     *
+     * @deprecated Use {@link ParentClosePolicy.REQUEST_CANCEL} instead.
      */
-    PARENT_CLOSE_POLICY_REQUEST_CANCEL = 3
-}
+    readonly PARENT_CLOSE_POLICY_REQUEST_CANCEL: "REQUEST_CANCEL";
+};
+export declare const encodeParentClosePolicy: (input: "ABANDON" | "TERMINATE" | "REQUEST_CANCEL" | "PARENT_CLOSE_POLICY_TERMINATE" | "PARENT_CLOSE_POLICY_ABANDON" | "PARENT_CLOSE_POLICY_REQUEST_CANCEL" | coresdk.child_workflow.ParentClosePolicy | null | undefined) => coresdk.child_workflow.ParentClosePolicy | undefined, decodeParentClosePolicy: (input: coresdk.child_workflow.ParentClosePolicy | null | undefined) => "ABANDON" | "TERMINATE" | "REQUEST_CANCEL" | undefined;
 export interface ChildWorkflowOptions extends CommonWorkflowOptions {
@@ -288,2 +312,4 @@ /**
      * `Worker` that hosts the Workflow code.
+     *
+     * By default, a child is scheduled on the same Task Queue as the parent.
      */
@@ -290,0 +316,0 @@ taskQueue?: string;

lib/interfaces.js

@@ -8,5 +8,7 @@ "use strict";
 };
+var _a, _b;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ParentClosePolicy = exports.ChildWorkflowCancellationType = exports.ContinueAsNew = void 0;
+exports.decodeParentClosePolicy = exports.encodeParentClosePolicy = exports.ParentClosePolicy = exports.decodeChildWorkflowCancellationType = exports.encodeChildWorkflowCancellationType = exports.ChildWorkflowCancellationType = exports.ContinueAsNew = void 0;
 const type_helpers_1 = require("@temporalio/common/lib/type-helpers");
+const enums_helpers_1 = require("@temporalio/common/lib/internal-workflow/enums-helpers");
 /**
@@ -25,20 +27,11 @@ * Not an actual error, used by the Workflow runtime to abort execution when {@link continueAsNew} is called
 ], 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) {
+exports.ChildWorkflowCancellationType = {
     /**
      * Don't send a cancellation request to the Child.
      */
-    ChildWorkflowCancellationType[ChildWorkflowCancellationType["ABANDON"] = 0] = "ABANDON";
+    ABANDON: 'ABANDON',
     /**
      * Send a cancellation request to the Child. Immediately throw the error.
      */
-    ChildWorkflowCancellationType[ChildWorkflowCancellationType["TRY_CANCEL"] = 1] = "TRY_CANCEL";
+    TRY_CANCEL: 'TRY_CANCEL',
     /**
@@ -52,38 +45,63 @@ * Send a cancellation request to the Child. The Child may respect cancellation, in which case an error will be thrown
      */
-    ChildWorkflowCancellationType[ChildWorkflowCancellationType["WAIT_CANCELLATION_COMPLETED"] = 2] = "WAIT_CANCELLATION_COMPLETED";
+    WAIT_CANCELLATION_COMPLETED: '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 = ChildWorkflowCancellationType = {}));
-(0, type_helpers_1.checkExtends)();
-(0, type_helpers_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) {
+    WAIT_CANCELLATION_REQUESTED: 'WAIT_CANCELLATION_REQUESTED',
+};
+// ts-prune-ignore-next
+_a = (0, enums_helpers_1.makeProtoEnumConverters)({
+    [exports.ChildWorkflowCancellationType.ABANDON]: 0,
+    [exports.ChildWorkflowCancellationType.TRY_CANCEL]: 1,
+    [exports.ChildWorkflowCancellationType.WAIT_CANCELLATION_COMPLETED]: 2,
+    [exports.ChildWorkflowCancellationType.WAIT_CANCELLATION_REQUESTED]: 3,
+}, ''), exports.encodeChildWorkflowCancellationType = _a[0], exports.decodeChildWorkflowCancellationType = _a[1];
+exports.ParentClosePolicy = {
     /**
+     * When the Parent is Closed, the Child is Terminated.
+     *
+     * @default
+     */
+    TERMINATE: 'TERMINATE',
+    /**
+     * When the Parent is Closed, nothing is done to the Child.
+     */
+    ABANDON: 'ABANDON',
+    /**
+     * When the Parent is Closed, the Child is Cancelled.
+     */
+    REQUEST_CANCEL: 'REQUEST_CANCEL',
+    /// Anything below this line has been deprecated
+    /**
      * If a `ParentClosePolicy` is set to this, or is not set at all, the server default value will be used.
+     *
+     * @deprecated Either leave property `undefined`, or set an explicit policy instead.
      */
-    ParentClosePolicy[ParentClosePolicy["PARENT_CLOSE_POLICY_UNSPECIFIED"] = 0] = "PARENT_CLOSE_POLICY_UNSPECIFIED";
+    PARENT_CLOSE_POLICY_UNSPECIFIED: undefined, // eslint-disable-line deprecation/deprecation
     /**
      * When the Parent is Closed, the Child is Terminated.
      *
-     * @default
+     * @deprecated Use {@link ParentClosePolicy.TERMINATE} instead.
      */
-    ParentClosePolicy[ParentClosePolicy["PARENT_CLOSE_POLICY_TERMINATE"] = 1] = "PARENT_CLOSE_POLICY_TERMINATE";
+    PARENT_CLOSE_POLICY_TERMINATE: 'TERMINATE', // eslint-disable-line deprecation/deprecation
     /**
      * When the Parent is Closed, nothing is done to the Child.
+     *
+     * @deprecated Use {@link ParentClosePolicy.ABANDON} instead.
      */
-    ParentClosePolicy[ParentClosePolicy["PARENT_CLOSE_POLICY_ABANDON"] = 2] = "PARENT_CLOSE_POLICY_ABANDON";
+    PARENT_CLOSE_POLICY_ABANDON: 'ABANDON', // eslint-disable-line deprecation/deprecation
     /**
      * When the Parent is Closed, the Child is Cancelled.
+     *
+     * @deprecated Use {@link ParentClosePolicy.REQUEST_CANCEL} instead.
      */
-    ParentClosePolicy[ParentClosePolicy["PARENT_CLOSE_POLICY_REQUEST_CANCEL"] = 3] = "PARENT_CLOSE_POLICY_REQUEST_CANCEL";
-})(ParentClosePolicy || (exports.ParentClosePolicy = ParentClosePolicy = {}));
-(0, type_helpers_1.checkExtends)();
-(0, type_helpers_1.checkExtends)();
+    PARENT_CLOSE_POLICY_REQUEST_CANCEL: 'REQUEST_CANCEL', // eslint-disable-line deprecation/deprecation
+};
+// ts-prune-ignore-next
+_b = (0, enums_helpers_1.makeProtoEnumConverters)({
+    [exports.ParentClosePolicy.TERMINATE]: 1,
+    [exports.ParentClosePolicy.ABANDON]: 2,
+    [exports.ParentClosePolicy.REQUEST_CANCEL]: 3,
+    UNSPECIFIED: 0,
+}, 'PARENT_CLOSE_POLICY_'), exports.encodeParentClosePolicy = _b[0], exports.decodeParentClosePolicy = _b[1];
 //# sourceMappingURL=interfaces.js.map

lib/internals.js

@@ -9,3 +9,3 @@ "use strict";
 const interceptors_1 = require("@temporalio/common/lib/interceptors");
-const type_helpers_1 = require("@temporalio/common/lib/type-helpers");
+const internal_workflow_1 = require("@temporalio/common/lib/internal-workflow");
 const alea_1 = require("./alea");
@@ -20,9 +20,9 @@ const cancellation_scope_1 = require("./cancellation-scope");
 const logs_1 = require("./logs");
-var StartChildWorkflowExecutionFailedCause;
-(function (StartChildWorkflowExecutionFailedCause) {
-    StartChildWorkflowExecutionFailedCause[StartChildWorkflowExecutionFailedCause["START_CHILD_WORKFLOW_EXECUTION_FAILED_CAUSE_UNSPECIFIED"] = 0] = "START_CHILD_WORKFLOW_EXECUTION_FAILED_CAUSE_UNSPECIFIED";
-    StartChildWorkflowExecutionFailedCause[StartChildWorkflowExecutionFailedCause["START_CHILD_WORKFLOW_EXECUTION_FAILED_CAUSE_WORKFLOW_ALREADY_EXISTS"] = 1] = "START_CHILD_WORKFLOW_EXECUTION_FAILED_CAUSE_WORKFLOW_ALREADY_EXISTS";
-})(StartChildWorkflowExecutionFailedCause || (StartChildWorkflowExecutionFailedCause = {}));
-(0, type_helpers_1.checkExtends)();
-(0, type_helpers_1.checkExtends)();
+const StartChildWorkflowExecutionFailedCause = {
+    WORKFLOW_ALREADY_EXISTS: 'WORKFLOW_ALREADY_EXISTS',
+};
+const [_encodeStartChildWorkflowExecutionFailedCause, decodeStartChildWorkflowExecutionFailedCause] = (0, internal_workflow_1.makeProtoEnumConverters)({
+    [StartChildWorkflowExecutionFailedCause.WORKFLOW_ALREADY_EXISTS]: 1,
+    UNSPECIFIED: 0,
+}, 'START_CHILD_WORKFLOW_EXECUTION_FAILED_CAUSE_');
 /**
@@ -355,4 +355,3 @@ * Keeps all of the Workflow runtime state like pending completions for activities and timers.
         else if (activation.failed) {
-            if (activation.failed.cause !==
-                StartChildWorkflowExecutionFailedCause.START_CHILD_WORKFLOW_EXECUTION_FAILED_CAUSE_WORKFLOW_ALREADY_EXISTS) {
+            if (decodeStartChildWorkflowExecutionFailedCause(activation.failed.cause) !== 'WORKFLOW_ALREADY_EXISTS') {
                 throw new common_1.IllegalStateError('Got unknown StartChildWorkflowExecutionFailedCause');
@@ -359,0 +358,0 @@ }

lib/logs.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.workflowLogAttributes = exports.executeWithLifecycleLogging = exports.log = void 0;
+exports.log = void 0;
+exports.executeWithLifecycleLogging = executeWithLifecycleLogging;
+exports.workflowLogAttributes = workflowLogAttributes;
 const interceptors_1 = require("@temporalio/common/lib/interceptors");
@@ -78,3 +80,2 @@ const common_1 = require("@temporalio/common");
 }
-exports.executeWithLifecycleLogging = executeWithLifecycleLogging;
 /**
@@ -93,3 +94,2 @@ * Returns a map of attributes to be set _by default_ on log messages for a given Workflow.
 }
-exports.workflowLogAttributes = workflowLogAttributes;
 //# sourceMappingURL=logs.js.map

lib/sinks.js

@@ -18,3 +18,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.proxySinks = void 0;
+exports.proxySinks = proxySinks;
 const global_attributes_1 = require("./global-attributes");
@@ -75,3 +75,2 @@ /**
 }
-exports.proxySinks = proxySinks;
 //# sourceMappingURL=sinks.js.map

lib/stack-helpers.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.untrackPromise = void 0;
+exports.untrackPromise = untrackPromise;
 const global_attributes_1 = require("./global-attributes");
@@ -15,3 +15,2 @@ /**
 }
-exports.untrackPromise = untrackPromise;
 //# sourceMappingURL=stack-helpers.js.map

lib/update-scope.d.ts

@@ -1,2 +0,1 @@
-/// <reference types="node" />
 import type { AsyncLocalStorage as ALS } from 'node:async_hooks';
@@ -3,0 +2,0 @@ /**

lib/update-scope.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.disableUpdateStorage = exports.UpdateScope = exports.AsyncLocalStorage = void 0;
+exports.UpdateScope = exports.AsyncLocalStorage = void 0;
+exports.disableUpdateStorage = disableUpdateStorage;
 // AsyncLocalStorage is injected via vm module into global scope.
@@ -40,3 +41,2 @@ // In case Workflow code is imported in Node.js context, replace with an empty class.
 }
-exports.disableUpdateStorage = disableUpdateStorage;
 //# sourceMappingURL=update-scope.js.map

lib/worker-interface.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.dispose = exports.tryUnblockConditions = exports.concludeActivation = exports.activate = exports.initialize = exports.initRuntime = void 0;
+exports.initRuntime = initRuntime;
+exports.initialize = initialize;
+exports.activate = activate;
+exports.concludeActivation = concludeActivation;
+exports.tryUnblockConditions = tryUnblockConditions;
+exports.dispose = dispose;
 /**
@@ -35,3 +40,3 @@ * Exported functions for the Worker to interact with the Workflow isolate
     // webpack alias to payloadConverterPath
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    // eslint-disable-next-line @typescript-eslint/no-require-imports
     const customPayloadConverter = require('__temporal_custom_payload_converter').payloadConverter;
@@ -43,3 +48,3 @@ // The `payloadConverter` export is validated in the Worker
     // webpack alias to failureConverterPath
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    // eslint-disable-next-line @typescript-eslint/no-require-imports
     const customFailureConverter = require('__temporal_custom_failure_converter').failureConverter;
@@ -83,3 +88,2 @@ // The `failureConverter` export is validated in the Worker
 }
-exports.initRuntime = initRuntime;
 /**
@@ -111,3 +115,2 @@ * Objects transfered to the VM from outside have prototypes belonging to the
 }
-exports.initialize = initialize;
 /**
@@ -152,3 +155,2 @@ * Run a chunk of activation jobs
 }
-exports.activate = activate;
 /**
@@ -174,3 +176,2 @@ * Conclude a single activation.
 }
-exports.concludeActivation = concludeActivation;
 /**
@@ -199,3 +200,2 @@ * Loop through all blocked conditions, evaluate and unblock if possible.
 }
-exports.tryUnblockConditions = tryUnblockConditions;
 function dispose() {
@@ -208,3 +208,2 @@ const dispose = (0, interceptors_1.composeInterceptors)((0, global_attributes_1.getActivator)().interceptors.internals, 'dispose', async () => {
 }
-exports.dispose = dispose;
 //# sourceMappingURL=worker-interface.js.map

lib/workflow.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.workflowMetadataQuery = exports.enhancedStackTraceQuery = exports.stackTraceQuery = exports.allHandlersFinished = exports.upsertMemo = exports.upsertSearchAttributes = exports.setDefaultSignalHandler = exports.setHandler = exports.defineQuery = exports.defineSignal = exports.defineUpdate = exports.condition = exports.deprecatePatch = exports.patched = exports.uuid4 = exports.continueAsNew = exports.makeContinueAsNewFunc = exports.inWorkflowContext = exports.currentUpdateInfo = exports.workflowInfo = exports.executeChild = exports.startChild = exports.getExternalWorkflowHandle = exports.proxyLocalActivities = exports.proxyActivities = exports.NotAnActivityMethod = exports.scheduleLocalActivity = exports.scheduleActivity = exports.sleep = exports.addDefaultWorkflowOptions = void 0;
+exports.workflowMetadataQuery = exports.enhancedStackTraceQuery = exports.stackTraceQuery = exports.NotAnActivityMethod = void 0;
+exports.addDefaultWorkflowOptions = addDefaultWorkflowOptions;
+exports.sleep = sleep;
+exports.scheduleActivity = scheduleActivity;
+exports.scheduleLocalActivity = scheduleLocalActivity;
+exports.proxyActivities = proxyActivities;
+exports.proxyLocalActivities = proxyLocalActivities;
+exports.getExternalWorkflowHandle = getExternalWorkflowHandle;
+exports.startChild = startChild;
+exports.executeChild = executeChild;
+exports.workflowInfo = workflowInfo;
+exports.currentUpdateInfo = currentUpdateInfo;
+exports.inWorkflowContext = inWorkflowContext;
+exports.makeContinueAsNewFunc = makeContinueAsNewFunc;
+exports.continueAsNew = continueAsNew;
+exports.uuid4 = uuid4;
+exports.patched = patched;
+exports.deprecatePatch = deprecatePatch;
+exports.condition = condition;
+exports.defineUpdate = defineUpdate;
+exports.defineSignal = defineSignal;
+exports.defineQuery = defineQuery;
+exports.setHandler = setHandler;
+exports.setDefaultSignalHandler = setDefaultSignalHandler;
+exports.upsertSearchAttributes = upsertSearchAttributes;
+exports.upsertMemo = upsertMemo;
+exports.allHandlersFinished = allHandlersFinished;
 const common_1 = require("@temporalio/common");
@@ -28,3 +54,2 @@ const versioning_intent_enum_1 = require("@temporalio/common/lib/versioning-intent-enum");
 }
-exports.addDefaultWorkflowOptions = addDefaultWorkflowOptions;
 /**
@@ -84,3 +109,2 @@ * Push a startTimer command into state accumulator and register completion
 }
-exports.sleep = sleep;
 function validateActivityOptions(options) {
@@ -130,3 +154,3 @@ if (options.scheduleToCloseTimeout === undefined && options.startToCloseTimeout === undefined) {
                 headers,
-                cancellationType: options.cancellationType,
+                cancellationType: (0, common_1.encodeActivityCancellationType)(options.cancellationType),
                 doNotEagerlyExecute: !(options.allowEagerDispatch ?? true),
@@ -186,3 +210,3 @@ versioningIntent: (0, versioning_intent_enum_1.versioningIntentToProto)(options.versioningIntent),
                 headers,
-                cancellationType: options.cancellationType,
+                cancellationType: (0, common_1.encodeActivityCancellationType)(options.cancellationType),
             },
@@ -215,3 +239,2 @@ });
 }
-exports.scheduleActivity = scheduleActivity;
 /**
@@ -257,3 +280,2 @@ * Schedule an activity and run outbound interceptors
 }
-exports.scheduleLocalActivity = scheduleLocalActivity;
 function startChildWorkflowExecutionNextHandler({ options, headers, workflowType, seq, }) {
@@ -292,5 +314,5 @@ const activator = (0, global_attributes_1.getActivator)();
                 headers,
-                cancellationType: options.cancellationType,
-                workflowIdReusePolicy: options.workflowIdReusePolicy,
-                parentClosePolicy: options.parentClosePolicy,
+                cancellationType: (0, interfaces_1.encodeChildWorkflowCancellationType)(options.cancellationType),
+                workflowIdReusePolicy: (0, common_1.encodeWorkflowIdReusePolicy)(options.workflowIdReusePolicy),
+                parentClosePolicy: (0, interfaces_1.encodeParentClosePolicy)(options.parentClosePolicy),
                 cronSchedule: options.cronSchedule,
@@ -427,3 +449,2 @@ searchAttributes: options.searchAttributes
 }
-exports.proxyActivities = proxyActivities;
 /**
@@ -456,3 +477,2 @@ * Configure Local Activity functions with given {@link LocalActivityOptions}.
 }
-exports.proxyLocalActivities = proxyLocalActivities;
 // TODO: deprecate this patch after "enough" time has passed
@@ -522,3 +542,2 @@ const EXTERNAL_WF_CANCEL_PATCH = '__temporal_internal_connect_external_handle_cancel_to_scope';
 }
-exports.getExternalWorkflowHandle = getExternalWorkflowHandle;
 async function startChild(workflowTypeOrFunc, options) {
@@ -556,3 +575,2 @@ const activator = (0, global_attributes_1.assertInWorkflowContext)('Workflow.startChild(...) may only be used from a Workflow Execution. Consider using Client.workflow.start(...) instead.)');
 }
-exports.startChild = startChild;
 async function executeChild(workflowTypeOrFunc, options) {
@@ -574,3 +592,2 @@ const activator = (0, global_attributes_1.assertInWorkflowContext)('Workflow.executeChild(...) may only be used from a Workflow Execution. Consider using Client.workflow.execute(...) instead.');
 }
-exports.executeChild = executeChild;
 /**
@@ -610,3 +627,2 @@ * Get information about the current Workflow.
 }
-exports.workflowInfo = workflowInfo;
 /**
@@ -624,3 +640,2 @@ * Get information about the current update if any.
 }
-exports.currentUpdateInfo = currentUpdateInfo;
 /**
@@ -632,3 +647,2 @@ * Returns whether or not code is executing in workflow context
 }
-exports.inWorkflowContext = inWorkflowContext;
 /**
@@ -674,3 +688,2 @@ * Returns a function `f` that will cause the current Workflow to ContinueAsNew when called.
 }
-exports.makeContinueAsNewFunc = makeContinueAsNewFunc;
 /**
@@ -696,3 +709,2 @@ * {@link https://docs.temporal.io/concepts/what-is-continue-as-new/ | Continues-As-New} the current Workflow Execution
 }
-exports.continueAsNew = continueAsNew;
 /**
@@ -721,3 +733,2 @@ * Generate an RFC compliant V4 uuid.
 }
-exports.uuid4 = uuid4;
 /**
@@ -744,3 +755,2 @@ * Patch or upgrade workflow code by checking or stating that this workflow has a certain patch.
 }
-exports.patched = patched;
 /**
@@ -767,3 +777,2 @@ * Indicate that a patch is being phased out.
 }
-exports.deprecatePatch = deprecatePatch;
 async function condition(fn, timeout) {
@@ -787,3 +796,2 @@ (0, global_attributes_1.assertInWorkflowContext)('Workflow.condition(...) may only be used from a Workflow Execution.');
 }
-exports.condition = condition;
 function conditionInner(fn) {
@@ -824,3 +832,2 @@ const activator = (0, global_attributes_1.getActivator)();
 }
-exports.defineUpdate = defineUpdate;
 /**
@@ -838,3 +845,2 @@ * Define a signal method for a Workflow.
 }
-exports.defineSignal = defineSignal;
 /**
@@ -852,3 +858,2 @@ * Define a query method for a Workflow.
 }
-exports.defineQuery = defineQuery;
 // For Updates and Signals we want to make a public guarantee something like the
@@ -983,3 +988,2 @@ // following:
 }
-exports.setHandler = setHandler;
 /**
@@ -1007,3 +1011,2 @@ * Set a signal handler function that will handle signals calls for non-registered signal names.
 }
-exports.setDefaultSignalHandler = setDefaultSignalHandler;
 /**
@@ -1058,3 +1061,2 @@ * Updates this Workflow's Search Attributes by merging the provided `searchAttributes` with the existing Search
 }
-exports.upsertSearchAttributes = upsertSearchAttributes;
 /**
@@ -1120,3 +1122,2 @@ * Updates this Workflow's Memos by merging the provided `memo` with existing
 }
-exports.upsertMemo = upsertMemo;
 /**
@@ -1138,3 +1139,2 @@ * Whether update and signal handlers have finished executing.
 }
-exports.allHandlersFinished = allHandlersFinished;
 exports.stackTraceQuery = defineQuery('__stack_trace');
@@ -1141,0 +1141,0 @@ exports.enhancedStackTraceQuery = defineQuery('__enhanced_stack_trace');

package.json

 {
   "name": "@temporalio/workflow",
-  "version": "1.11.3",
+  "version": "1.11.4",
   "description": "Temporal.io SDK Workflow sub-package",
@@ -25,4 +25,4 @@ "keywords": [
   "dependencies": {
-    "@temporalio/common": "1.11.3",
-    "@temporalio/proto": "1.11.3"
+    "@temporalio/common": "^1.11.4",
+    "@temporalio/proto": "^1.11.4"
   },
@@ -39,3 +39,3 @@ "devDependencies": {
   ],
-  "gitHead": "4c90f9d844710abf7e085662373aac226ec09017"
+  "gitHead": "6a7e2d527c9f7078ee78abd9d59ca0d318bb70dd"
 }

src/interceptors.ts

@@ -209,3 +209,3 @@ /**
 /** Input for WorkflowInternalsInterceptor.dispose */
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
 export interface DisposeInput {}
@@ -212,0 +212,0 @@

src/interfaces.ts

@@ -14,3 +14,4 @@ import type { RawSourceMap } from 'source-map';
 } from '@temporalio/common';
-import { checkExtends, SymbolBasedInstanceOfError } from '@temporalio/common/lib/type-helpers';
+import { SymbolBasedInstanceOfError } from '@temporalio/common/lib/type-helpers';
+import { makeProtoEnumConverters } from '@temporalio/common/lib/internal-workflow/enums-helpers';
 import type { coresdk } from '@temporalio/proto';
@@ -277,7 +278,9 @@
  */
-export enum ChildWorkflowCancellationType {
+export type ChildWorkflowCancellationType =
+  (typeof ChildWorkflowCancellationType)[keyof typeof ChildWorkflowCancellationType];
+export const ChildWorkflowCancellationType = {
   /**
    * Don't send a cancellation request to the Child.
    */
-  ABANDON = 0,
+  ABANDON: 'ABANDON',
 
@@ -287,3 +290,3 @@ /**
    */
-  TRY_CANCEL = 1,
+  TRY_CANCEL: 'TRY_CANCEL',
 
@@ -298,3 +301,3 @@ /**
    */
-  WAIT_CANCELLATION_COMPLETED = 2,
+  WAIT_CANCELLATION_COMPLETED: 'WAIT_CANCELLATION_COMPLETED',
 
@@ -304,7 +307,21 @@ /**
    */
-  WAIT_CANCELLATION_REQUESTED = 3,
-}
+  WAIT_CANCELLATION_REQUESTED: 'WAIT_CANCELLATION_REQUESTED',
+} as const;
 
-checkExtends<coresdk.child_workflow.ChildWorkflowCancellationType, ChildWorkflowCancellationType>();
-checkExtends<ChildWorkflowCancellationType, coresdk.child_workflow.ChildWorkflowCancellationType>();
+// ts-prune-ignore-next
+export const [encodeChildWorkflowCancellationType, decodeChildWorkflowCancellationType] = makeProtoEnumConverters<
+  coresdk.child_workflow.ChildWorkflowCancellationType,
+  typeof coresdk.child_workflow.ChildWorkflowCancellationType,
+  keyof typeof coresdk.child_workflow.ChildWorkflowCancellationType,
+  typeof ChildWorkflowCancellationType,
+  ''
+>(
+  {
+    [ChildWorkflowCancellationType.ABANDON]: 0,
+    [ChildWorkflowCancellationType.TRY_CANCEL]: 1,
+    [ChildWorkflowCancellationType.WAIT_CANCELLATION_COMPLETED]: 2,
+    [ChildWorkflowCancellationType.WAIT_CANCELLATION_REQUESTED]: 3,
+  } as const,
+  ''
+);
 
@@ -316,7 +333,29 @@ /**
  */
-export enum ParentClosePolicy {
+export type ParentClosePolicy = (typeof ParentClosePolicy)[keyof typeof ParentClosePolicy];
+export const ParentClosePolicy = {
   /**
+   * When the Parent is Closed, the Child is Terminated.
+   *
+   * @default
+   */
+  TERMINATE: 'TERMINATE',
+
+  /**
+   * When the Parent is Closed, nothing is done to the Child.
+   */
+  ABANDON: 'ABANDON',
+
+  /**
+   * When the Parent is Closed, the Child is Cancelled.
+   */
+  REQUEST_CANCEL: 'REQUEST_CANCEL',
+
+  /// Anything below this line has been deprecated
+
+  /**
    * If a `ParentClosePolicy` is set to this, or is not set at all, the server default value will be used.
+   *
+   * @deprecated Either leave property `undefined`, or set an explicit policy instead.
    */
-  PARENT_CLOSE_POLICY_UNSPECIFIED = 0,
+  PARENT_CLOSE_POLICY_UNSPECIFIED: undefined, // eslint-disable-line deprecation/deprecation
 
@@ -326,19 +365,37 @@ /**
    *
-   * @default
+   * @deprecated Use {@link ParentClosePolicy.TERMINATE} instead.
    */
-  PARENT_CLOSE_POLICY_TERMINATE = 1,
+  PARENT_CLOSE_POLICY_TERMINATE: 'TERMINATE', // eslint-disable-line deprecation/deprecation
 
   /**
    * When the Parent is Closed, nothing is done to the Child.
+   *
+   * @deprecated Use {@link ParentClosePolicy.ABANDON} instead.
    */
-  PARENT_CLOSE_POLICY_ABANDON = 2,
+  PARENT_CLOSE_POLICY_ABANDON: 'ABANDON', // eslint-disable-line deprecation/deprecation
 
   /**
    * When the Parent is Closed, the Child is Cancelled.
+   *
+   * @deprecated Use {@link ParentClosePolicy.REQUEST_CANCEL} instead.
    */
-  PARENT_CLOSE_POLICY_REQUEST_CANCEL = 3,
-}
+  PARENT_CLOSE_POLICY_REQUEST_CANCEL: 'REQUEST_CANCEL', // eslint-disable-line deprecation/deprecation
+} as const;
 
-checkExtends<coresdk.child_workflow.ParentClosePolicy, ParentClosePolicy>();
-checkExtends<ParentClosePolicy, coresdk.child_workflow.ParentClosePolicy>();
+// ts-prune-ignore-next
+export const [encodeParentClosePolicy, decodeParentClosePolicy] = makeProtoEnumConverters<
+  coresdk.child_workflow.ParentClosePolicy,
+  typeof coresdk.child_workflow.ParentClosePolicy,
+  keyof typeof coresdk.child_workflow.ParentClosePolicy,
+  typeof ParentClosePolicy,
+  'PARENT_CLOSE_POLICY_'
+>(
+  {
+    [ParentClosePolicy.TERMINATE]: 1,
+    [ParentClosePolicy.ABANDON]: 2,
+    [ParentClosePolicy.REQUEST_CANCEL]: 3,
+    UNSPECIFIED: 0,
+  } as const,
+  'PARENT_CLOSE_POLICY_'
+);
 
@@ -356,2 +413,4 @@ export interface ChildWorkflowOptions extends CommonWorkflowOptions {
    * `Worker` that hosts the Workflow code.
+   *
+   * By default, a child is scheduled on the same Task Queue as the parent.
    */
@@ -358,0 +417,0 @@ taskQueue?: string;

src/internals.ts

@@ -27,3 +27,3 @@ import type { RawSourceMap } from 'source-map';
 import { composeInterceptors } from '@temporalio/common/lib/interceptors';
-import { checkExtends } from '@temporalio/common/lib/type-helpers';
+import { makeProtoEnumConverters } from '@temporalio/common/lib/internal-workflow';
 import type { coresdk, temporal } from '@temporalio/proto';
@@ -52,9 +52,22 @@ import { alea, RNG } from './alea';
 
-enum StartChildWorkflowExecutionFailedCause {
-  START_CHILD_WORKFLOW_EXECUTION_FAILED_CAUSE_UNSPECIFIED = 0,
-  START_CHILD_WORKFLOW_EXECUTION_FAILED_CAUSE_WORKFLOW_ALREADY_EXISTS = 1,
-}
+const StartChildWorkflowExecutionFailedCause = {
+  WORKFLOW_ALREADY_EXISTS: 'WORKFLOW_ALREADY_EXISTS',
+} as const;
+type StartChildWorkflowExecutionFailedCause =
+  (typeof StartChildWorkflowExecutionFailedCause)[keyof typeof StartChildWorkflowExecutionFailedCause];
 
-checkExtends<coresdk.child_workflow.StartChildWorkflowExecutionFailedCause, StartChildWorkflowExecutionFailedCause>();
-checkExtends<StartChildWorkflowExecutionFailedCause, coresdk.child_workflow.StartChildWorkflowExecutionFailedCause>();
+const [_encodeStartChildWorkflowExecutionFailedCause, decodeStartChildWorkflowExecutionFailedCause] =
+  makeProtoEnumConverters<
+    coresdk.child_workflow.StartChildWorkflowExecutionFailedCause,
+    typeof coresdk.child_workflow.StartChildWorkflowExecutionFailedCause,
+    keyof typeof coresdk.child_workflow.StartChildWorkflowExecutionFailedCause,
+    typeof StartChildWorkflowExecutionFailedCause,
+    'START_CHILD_WORKFLOW_EXECUTION_FAILED_CAUSE_'
+  >(
+    {
+      [StartChildWorkflowExecutionFailedCause.WORKFLOW_ALREADY_EXISTS]: 1,
+      UNSPECIFIED: 0,
+    } as const,
+    'START_CHILD_WORKFLOW_EXECUTION_FAILED_CAUSE_'
+  );
 
@@ -522,6 +535,3 @@ export interface Stack {
     } else if (activation.failed) {
-      if (
-        activation.failed.cause !==
-        StartChildWorkflowExecutionFailedCause.START_CHILD_WORKFLOW_EXECUTION_FAILED_CAUSE_WORKFLOW_ALREADY_EXISTS
-      ) {
+      if (decodeStartChildWorkflowExecutionFailedCause(activation.failed.cause) !== 'WORKFLOW_ALREADY_EXISTS') {
         throw new IllegalStateError('Got unknown StartChildWorkflowExecutionFailedCause');
@@ -528,0 +538,0 @@ }

src/worker-interface.ts

@@ -41,3 +41,3 @@ /**
   // webpack alias to payloadConverterPath
-  // eslint-disable-next-line @typescript-eslint/no-var-requires
+  // eslint-disable-next-line @typescript-eslint/no-require-imports
   const customPayloadConverter = require('__temporal_custom_payload_converter').payloadConverter;
@@ -49,3 +49,3 @@ // The `payloadConverter` export is validated in the Worker
   // webpack alias to failureConverterPath
-  // eslint-disable-next-line @typescript-eslint/no-var-requires
+  // eslint-disable-next-line @typescript-eslint/no-require-imports
   const customFailureConverter = require('__temporal_custom_failure_converter').failureConverter;
@@ -52,0 +52,0 @@ // The `failureConverter` export is validated in the Worker

src/workflow.ts

@@ -5,2 +5,4 @@ import {
   compileRetryPolicy,
+  encodeActivityCancellationType,
+  encodeWorkflowIdReusePolicy,
   extractWorkflowType,
@@ -50,2 +52,4 @@ HandlerUnfinishedPolicy,
   UpdateInfo,
+  encodeChildWorkflowCancellationType,
+  encodeParentClosePolicy,
 } from './interfaces';
@@ -184,3 +188,3 @@ import { LocalActivityDoBackoff } from './errors';
         headers,
-        cancellationType: options.cancellationType,
+        cancellationType: encodeActivityCancellationType(options.cancellationType),
         doNotEagerlyExecute: !(options.allowEagerDispatch ?? true),
@@ -252,3 +256,3 @@ versioningIntent: versioningIntentToProto(options.versioningIntent),
         headers,
-        cancellationType: options.cancellationType,
+        cancellationType: encodeActivityCancellationType(options.cancellationType),
       },
@@ -379,5 +383,5 @@ });
         headers,
-        cancellationType: options.cancellationType,
-        workflowIdReusePolicy: options.workflowIdReusePolicy,
-        parentClosePolicy: options.parentClosePolicy,
+        cancellationType: encodeChildWorkflowCancellationType(options.cancellationType),
+        workflowIdReusePolicy: encodeWorkflowIdReusePolicy(options.workflowIdReusePolicy),
+        parentClosePolicy: encodeParentClosePolicy(options.parentClosePolicy),
         cronSchedule: options.cronSchedule,
@@ -384,0 +388,0 @@ searchAttributes: options.searchAttributes

No alert changes

Improved metrics

Total package byte prevSize

471647

increased by1.05%

Lines of code

9530

increased by1.12%

Dependency changes

• + Added@temporalio/common@1.11.6(transitive)

• + Added@temporalio/proto@1.11.6(transitive)

• - Removed@temporalio/common@1.11.3(transitive)

• - Removed@temporalio/proto@1.11.3(transitive)

• Updated@temporalio/common@^1.11.4

• Updated@temporalio/proto@^1.11.4