@temporalio/workflow 1.8.5 → 1.9.0-rc.0

package/lib/errors.d.ts

@@ -1,3 +1,4 @@
+import { coresdk } from '@temporalio/proto';
 /**
  * Base class for all workflow errors
  */
@@ -8,6 +9,13 @@ export declare class WorkflowError extends Error {
  */
 export declare class DeterminismViolationError extends WorkflowError {
 }
+/**
+ * A class that acts as a marker for this special result type
+ */
+export declare class LocalActivityDoBackoff extends Error {
+    readonly backoff: coresdk.activity_result.IDoBackoff;
+    constructor(backoff: coresdk.activity_result.IDoBackoff);
+}
 /**
  * Returns whether provided `err` is caused by cancellation
  */

package/lib/errors.js

@@ -6,7 +6,7 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isCancellation = exports.DeterminismViolationError = exports.WorkflowError = void 0;
+exports.isCancellation = exports.LocalActivityDoBackoff = exports.DeterminismViolationError = exports.WorkflowError = void 0;
 const common_1 = require("@temporalio/common");
 const type_helpers_1 = require("@temporalio/common/lib/type-helpers");
 /**
@@ -27,6 +27,19 @@ DeterminismViolationError = __decorate([
     (0, type_helpers_1.SymbolBasedInstanceOfError)('DeterminismViolationError')
 ], DeterminismViolationError);
 exports.DeterminismViolationError = DeterminismViolationError;
+/**
+ * A class that acts as a marker for this special result type
+ */
+let LocalActivityDoBackoff = class LocalActivityDoBackoff extends Error {
+    constructor(backoff) {
+        super();
+        this.backoff = backoff;
+    }
+};
+LocalActivityDoBackoff = __decorate([
+    (0, type_helpers_1.SymbolBasedInstanceOfError)('LocalActivityDoBackoff')
+], LocalActivityDoBackoff);
+exports.LocalActivityDoBackoff = LocalActivityDoBackoff;
 /**
  * Returns whether provided `err` is caused by cancellation
  */

package/lib/errors.js.map

@@ -1 +1 @@
-{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":";;;;;;;;;AAAA,+CAA6F;AAC7F,sEAAiF;AAEjF;;GAEG;AAEI,IAAM,aAAa,GAAnB,MAAM,aAAc,SAAQ,KAAK;CAAG,CAAA;AAA9B,aAAa;IADzB,IAAA,yCAA0B,EAAC,eAAe,CAAC;GAC/B,aAAa,CAAiB;AAA9B,sCAAa;AAE1B;;GAEG;AAEI,IAAM,yBAAyB,GAA/B,MAAM,yBAA0B,SAAQ,aAAa;CAAG,CAAA;AAAlD,yBAAyB;IADrC,IAAA,yCAA0B,EAAC,2BAA2B,CAAC;GAC3C,yBAAyB,CAAyB;AAAlD,8DAAyB;AAEtC;;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,GAAG,CAAC,KAAK,YAAY,yBAAgB,CAAC,CACnH,CAAC;AACJ,CAAC;AALD,wCAKC"}
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":";;;;;;;;;AAAA,+CAA6F;AAC7F,sEAAiF;AAGjF;;GAEG;AAEI,IAAM,aAAa,GAAnB,MAAM,aAAc,SAAQ,KAAK;CAAG,CAAA;AAA9B,aAAa;IADzB,IAAA,yCAA0B,EAAC,eAAe,CAAC;GAC/B,aAAa,CAAiB;AAA9B,sCAAa;AAE1B;;GAEG;AAEI,IAAM,yBAAyB,GAA/B,MAAM,yBAA0B,SAAQ,aAAa;CAAG,CAAA;AAAlD,yBAAyB;IADrC,IAAA,yCAA0B,EAAC,2BAA2B,CAAC;GAC3C,yBAAyB,CAAyB;AAAlD,8DAAyB;AAEtC;;GAEG;AAEI,IAAM,sBAAsB,GAA5B,MAAM,sBAAuB,SAAQ,KAAK;IAC/C,YAA4B,OAA2C;QACrE,KAAK,EAAE,CAAC;QADkB,YAAO,GAAP,OAAO,CAAoC;IAEvE,CAAC;CACF,CAAA;AAJY,sBAAsB;IADlC,IAAA,yCAA0B,EAAC,wBAAwB,CAAC;GACxC,sBAAsB,CAIlC;AAJY,wDAAsB;AAMnC;;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,GAAG,CAAC,KAAK,YAAY,yBAAgB,CAAC,CACnH,CAAC;AACJ,CAAC;AALD,wCAKC"}

package/lib/global-attributes.d.ts

@@ -1,2 +1,6 @@
+import { type Activator } from './internals';
 export declare function maybeGetActivatorUntyped(): unknown;
 export declare function setActivatorUntyped(activator: unknown): void;
+export declare function maybeGetActivator(): Activator | undefined;
+export declare function assertInWorkflowContext(message: string): Activator;
+export declare function getActivator(): Activator;

package/lib/global-attributes.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setActivatorUntyped = exports.maybeGetActivatorUntyped = void 0;
+exports.getActivator = exports.assertInWorkflowContext = exports.maybeGetActivator = exports.setActivatorUntyped = exports.maybeGetActivatorUntyped = void 0;
+const common_1 = require("@temporalio/common");
 function maybeGetActivatorUntyped() {
     return globalThis.__TEMPORAL_ACTIVATOR__;
 }
@@ -9,4 +10,23 @@ function setActivatorUntyped(activator) {
     globalThis.__TEMPORAL_ACTIVATOR__ = activator;
 }
 exports.setActivatorUntyped = setActivatorUntyped;
+function maybeGetActivator() {
+    return maybeGetActivatorUntyped();
+}
+exports.maybeGetActivator = maybeGetActivator;
+function assertInWorkflowContext(message) {
+    const activator = maybeGetActivator();
+    if (activator == null)
+        throw new common_1.IllegalStateError(message);
+    return activator;
+}
+exports.assertInWorkflowContext = assertInWorkflowContext;
+function getActivator() {
+    const activator = maybeGetActivator();
+    if (activator === undefined) {
+        throw new common_1.IllegalStateError('Workflow uninitialized');
+    }
+    return activator;
+}
+exports.getActivator = getActivator;
 //# sourceMappingURL=global-attributes.js.map

package/lib/global-attributes.js.map

@@ -1 +1 @@
-{"version":3,"file":"global-attributes.js","sourceRoot":"","sources":["../src/global-attributes.ts"],"names":[],"mappings":";;;AAAA,SAAgB,wBAAwB;IACtC,OAAQ,UAAkB,CAAC,sBAAsB,CAAC;AACpD,CAAC;AAFD,4DAEC;AAED,SAAgB,mBAAmB,CAAC,SAAkB;IACnD,UAAkB,CAAC,sBAAsB,GAAG,SAAS,CAAC;AACzD,CAAC;AAFD,kDAEC"}
+{"version":3,"file":"global-attributes.js","sourceRoot":"","sources":["../src/global-attributes.ts"],"names":[],"mappings":";;;AAAA,+CAAuD;AAGvD,SAAgB,wBAAwB;IACtC,OAAQ,UAAkB,CAAC,sBAAsB,CAAC;AACpD,CAAC;AAFD,4DAEC;AAED,SAAgB,mBAAmB,CAAC,SAAkB;IACnD,UAAkB,CAAC,sBAAsB,GAAG,SAAS,CAAC;AACzD,CAAC;AAFD,kDAEC;AAED,SAAgB,iBAAiB;IAC/B,OAAO,wBAAwB,EAA2B,CAAC;AAC7D,CAAC;AAFD,8CAEC;AAED,SAAgB,uBAAuB,CAAC,OAAe;IACrD,MAAM,SAAS,GAAG,iBAAiB,EAAE,CAAC;IACtC,IAAI,SAAS,IAAI,IAAI;QAAE,MAAM,IAAI,0BAAiB,CAAC,OAAO,CAAC,CAAC;IAC5D,OAAO,SAAS,CAAC;AACnB,CAAC;AAJD,0DAIC;AAED,SAAgB,YAAY;IAC1B,MAAM,SAAS,GAAG,iBAAiB,EAAE,CAAC;IACtC,IAAI,SAAS,KAAK,SAAS,EAAE;QAC3B,MAAM,IAAI,0BAAiB,CAAC,wBAAwB,CAAC,CAAC;KACvD;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAND,oCAMC"}

package/lib/index.d.ts

@@ -20,18 +20,21 @@
  * <!--SNIPSTART typescript-schedule-activity-workflow-->
  * <!--SNIPEND-->
  *
- * ### Signals and Queries
+ * ### Updates, 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.
+ * Use {@link setHandler} to set handlers for Updates, Signals, and Queries.
  *
- * 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`.
+ * Update and Signal handlers can be either async or non-async functions. Update handlers may return a value, but signal
+ * handlers may not (return `void` or `Promise<void>`). You may use Activities, Timers, child Workflows, etc in Update
+ * and Signal handlers, but this should be done cautiously: for example, note that if you await async operations such as
+ * these in an Update or Signal handler, then you are responsible for ensuring that the workflow does not complete first.
+ *
+ * Query handlers may **not** be async functions, and may **not** mutate any variables or use Activities, Timers,
+ * child Workflows, etc.
  *
  * #### Implementation
  *
- * <!--SNIPSTART typescript-workflow-signal-implementation-->
+ * <!--SNIPSTART typescript-workflow-update-signal-query-example-->
  * <!--SNIPEND-->
  *
  * ### More
@@ -55,7 +58,15 @@ export { AsyncLocalStorage, CancellationScope, CancellationScopeOptions } from '
 export * from './errors';
 export * from './interceptors';
 export { ChildWorkflowCancellationType, ChildWorkflowOptions, ContinueAsNew, ContinueAsNewOptions, EnhancedStackTrace, FileLocation, FileSlice, ParentClosePolicy, ParentWorkflowInfo, SDKInfo, StackTrace, UnsafeWorkflowInfo, WorkflowInfo, } from './interfaces';
-export { LoggerSinks, Sink, SinkCall, SinkFunction, Sinks } from './sinks';
+export { proxySinks, Sink, SinkCall, SinkFunction, Sinks } from './sinks';
+export { log } from './logs';
 export { Trigger } from './trigger';
 export * from './workflow';
 export { ChildWorkflowHandle, ExternalWorkflowHandle } from './workflow-handle';
+export { 
+/**
+ * @deprecated Do not use LoggerSinks directly. To log from Workflow code, use the `log` object
+ *             exported by the `@temporalio/workflow` package. To capture log messages emitted
+ *             by Workflow code, set the {@link Runtime.logger} property.
+ */
+LoggerSinksDeprecated as LoggerSinks, } from './logs';

package/lib/index.js

@@ -21,18 +21,21 @@
  * <!--SNIPSTART typescript-schedule-activity-workflow-->
  * <!--SNIPEND-->
  *
- * ### Signals and Queries
+ * ### Updates, 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.
+ * Use {@link setHandler} to set handlers for Updates, Signals, and Queries.
  *
- * 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`.
+ * Update and Signal handlers can be either async or non-async functions. Update handlers may return a value, but signal
+ * handlers may not (return `void` or `Promise<void>`). You may use Activities, Timers, child Workflows, etc in Update
+ * and Signal handlers, but this should be done cautiously: for example, note that if you await async operations such as
+ * these in an Update or Signal handler, then you are responsible for ensuring that the workflow does not complete first.
+ *
+ * Query handlers may **not** be async functions, and may **not** mutate any variables or use Activities, Timers,
+ * child Workflows, etc.
  *
  * #### Implementation
  *
- * <!--SNIPSTART typescript-workflow-signal-implementation-->
+ * <!--SNIPSTART typescript-workflow-update-signal-query-example-->
  * <!--SNIPEND-->
  *
  * ### More
@@ -61,7 +64,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.CancellationScope = exports.AsyncLocalStorage = exports.TimeoutFailure = exports.TerminatedFailure = exports.TemporalFailure = exports.ServerFailure = exports.rootCause = exports.defaultPayloadConverter = exports.ChildWorkflowFailure = exports.CancelledFailure = exports.ApplicationFailure = exports.ActivityFailure = exports.ActivityCancellationType = void 0;
+exports.Trigger = exports.log = exports.proxySinks = exports.ParentClosePolicy = exports.ContinueAsNew = exports.ChildWorkflowCancellationType = exports.CancellationScope = exports.AsyncLocalStorage = exports.TimeoutFailure = exports.TerminatedFailure = exports.TemporalFailure = exports.ServerFailure = exports.rootCause = exports.defaultPayloadConverter = exports.ChildWorkflowFailure = exports.CancelledFailure = exports.ApplicationFailure = exports.ActivityFailure = 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, "ActivityFailure", { enumerable: true, get: function () { return common_1.ActivityFailure; } });
@@ -86,6 +89,10 @@ var interfaces_1 = require("./interfaces");
 Object.defineProperty(exports, "ChildWorkflowCancellationType", { enumerable: true, get: function () { return interfaces_1.ChildWorkflowCancellationType; } });
 Object.defineProperty(exports, "ContinueAsNew", { enumerable: true, get: function () { return interfaces_1.ContinueAsNew; } });
 Object.defineProperty(exports, "ParentClosePolicy", { enumerable: true, get: function () { return interfaces_1.ParentClosePolicy; } });
+var sinks_1 = require("./sinks");
+Object.defineProperty(exports, "proxySinks", { enumerable: true, get: function () { return sinks_1.proxySinks; } });
+var logs_1 = require("./logs");
+Object.defineProperty(exports, "log", { enumerable: true, get: function () { return logs_1.log; } });
 var trigger_1 = require("./trigger");
 Object.defineProperty(exports, "Trigger", { enumerable: true, get: function () { return trigger_1.Trigger; } });
 __exportStar(require("./workflow"), exports);

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;;;;;;;;;;;;;;;;;AAEH,6CAe4B;AAd1B,kHAAA,wBAAwB,OAAA;AACxB,yGAAA,eAAe,OAAA;AAEf,4GAAA,kBAAkB,OAAA;AAClB,0GAAA,gBAAgB,OAAA;AAChB,8GAAA,oBAAoB,OAAA;AACpB,iHAAA,uBAAuB,OAAA;AAGvB,mGAAA,SAAS,OAAA;AACT,uGAAA,aAAa,OAAA;AACb,yGAAA,eAAe,OAAA;AACf,2GAAA,iBAAiB,OAAA;AACjB,wGAAA,cAAc,OAAA;AAEhB,gEAA8C;AAgB9C,yEAAuD;AACvD,0EAAwD;AACxD,2DAAsG;AAA7F,uHAAA,iBAAiB,OAAA;AAAE,uHAAA,iBAAiB,OAAA;AAC7C,2CAAyB;AACzB,iDAA+B;AAC/B,2CAcsB;AAbpB,2HAAA,6BAA6B,OAAA;AAE7B,2GAAA,aAAa,OAAA;AAKb,+GAAA,iBAAiB,OAAA;AAQnB,qCAAoC;AAA3B,kGAAA,OAAO,OAAA;AAChB,6CAA2B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;;;;;;;;;;;;;;;;;AAEH,6CAe4B;AAd1B,kHAAA,wBAAwB,OAAA;AACxB,yGAAA,eAAe,OAAA;AAEf,4GAAA,kBAAkB,OAAA;AAClB,0GAAA,gBAAgB,OAAA;AAChB,8GAAA,oBAAoB,OAAA;AACpB,iHAAA,uBAAuB,OAAA;AAGvB,mGAAA,SAAS,OAAA;AACT,uGAAA,aAAa,OAAA;AACb,yGAAA,eAAe,OAAA;AACf,2GAAA,iBAAiB,OAAA;AACjB,wGAAA,cAAc,OAAA;AAEhB,gEAA8C;AAgB9C,yEAAuD;AACvD,0EAAwD;AACxD,2DAAsG;AAA7F,uHAAA,iBAAiB,OAAA;AAAE,uHAAA,iBAAiB,OAAA;AAC7C,2CAAyB;AACzB,iDAA+B;AAC/B,2CAcsB;AAbpB,2HAAA,6BAA6B,OAAA;AAE7B,2GAAA,aAAa,OAAA;AAKb,+GAAA,iBAAiB,OAAA;AAOnB,iCAA0E;AAAjE,mGAAA,UAAU,OAAA;AACnB,+BAA6B;AAApB,2FAAA,GAAG,OAAA;AACZ,qCAAoC;AAA3B,kGAAA,OAAO,OAAA;AAChB,6CAA2B"}

package/lib/interceptors.d.ts

@@ -14,6 +14,14 @@ export interface WorkflowExecuteInput {
     readonly args: unknown[];
     readonly headers: Headers;
 }
+/** Input for WorkflowInboundCallsInterceptor.handleUpdate and
+ * WorkflowInboundCallsInterceptor.validateUpdate */
+export interface UpdateInput {
+    readonly updateId: string;
+    readonly name: string;
+    readonly args: unknown[];
+    readonly headers: Headers;
+}
 /** Input for WorkflowInboundCallsInterceptor.handleSignal */
 export interface SignalInput {
     readonly signalName: string;
@@ -37,6 +45,13 @@ export interface WorkflowInboundCallsInterceptor {
      * @return result of the Workflow execution
      */
     execute?: (input: WorkflowExecuteInput, next: Next<this, 'execute'>) => Promise<unknown>;
+    /** Called when Update handler is called
+     *
+     * @return result of the Update
+     */
+    handleUpdate?: (input: UpdateInput, next: Next<this, 'handleUpdate'>) => Promise<unknown>;
+    /** Called when update validator called */
+    validateUpdate?: (input: UpdateInput, next: Next<this, 'validateUpdate'>) => void;
     /** Called when signal is delivered to a Workflow execution */
     handleSignal?: (input: SignalInput, next: Next<this, 'handleSignal'>) => Promise<void>;
     /**

package/lib/interfaces.d.ts

@@ -1,5 +1,5 @@
 import type { RawSourceMap } from 'source-map';
-import { RetryPolicy, TemporalFailure, CommonWorkflowOptions, SearchAttributes, SignalDefinition, QueryDefinition, Duration, VersioningIntent } from '@temporalio/common';
+import { RetryPolicy, TemporalFailure, CommonWorkflowOptions, SearchAttributes, SignalDefinition, UpdateDefinition, QueryDefinition, Duration, VersioningIntent } from '@temporalio/common';
 import type { coresdk } from '@temporalio/proto';
 /**
  * Workflow Execution information
@@ -9,39 +9,39 @@ export interface WorkflowInfo {
      * ID of the Workflow, this can be set by the client during Workflow creation.
      * A single Workflow may run multiple times e.g. when scheduled with cron.
      */
-    workflowId: string;
+    readonly workflowId: string;
     /**
      * ID of a single Workflow run
      */
-    runId: string;
+    readonly runId: string;
     /**
      * Workflow function's name
      */
-    workflowType: string;
+    readonly workflowType: string;
     /**
      * Indexed information attached to the Workflow Execution
      *
      * This value may change during the lifetime of an Execution.
      */
-    searchAttributes: SearchAttributes;
+    readonly searchAttributes: SearchAttributes;
     /**
      * Non-indexed information attached to the Workflow Execution
      */
-    memo?: Record<string, unknown>;
+    readonly memo?: Record<string, unknown>;
     /**
      * Parent Workflow info (present if this is a Child Workflow)
      */
-    parent?: ParentWorkflowInfo;
+    readonly parent?: ParentWorkflowInfo;
     /**
      * Result from the previous Run (present if this is a Cron Workflow or was Continued As New).
      *
      * An array of values, since other SDKs may return multiple values from a Workflow.
      */
-    lastResult?: unknown;
+    readonly lastResult?: unknown;
     /**
      * Failure from the previous Run (present when this Run is a retry, or the last Run of a Cron Workflow failed)
      */
-    lastFailure?: TemporalFailure;
+    readonly lastFailure?: TemporalFailure;
     /**
      * Length of Workflow history up until the current Workflow Task.
      *
@@ -49,7 +49,7 @@ export interface WorkflowInfo {
      *
      * You may safely use this information to decide when to {@link continueAsNew}.
      */
-    historyLength: number;
+    readonly historyLength: number;
     /**
      * Size of Workflow history in bytes until the current Workflow Task.
      *
@@ -59,7 +59,7 @@ export interface WorkflowInfo {
      *
      * You may safely use this information to decide when to {@link continueAsNew}.
      */
-    historySize: number;
+    readonly historySize: number;
     /**
      * A hint provided by the current WorkflowTaskStarted event recommending whether to
      * {@link continueAsNew}.
@@ -68,64 +68,64 @@ export interface WorkflowInfo {
      *
      * Supported only on Temporal Server 1.20+, always `false` on older servers.
      */
-    continueAsNewSuggested: boolean;
+    readonly continueAsNewSuggested: boolean;
     /**
      * Task queue this Workflow is executing on
      */
-    taskQueue: string;
+    readonly taskQueue: string;
     /**
      * Namespace this Workflow is executing in
      */
-    namespace: string;
+    readonly namespace: string;
     /**
      * Run Id of the first Run in this Execution Chain
      */
-    firstExecutionRunId: string;
+    readonly firstExecutionRunId: string;
     /**
      * The last Run Id in this Execution Chain
      */
-    continuedFromExecutionRunId?: string;
+    readonly continuedFromExecutionRunId?: string;
     /**
      * Time at which this [Workflow Execution Chain](https://docs.temporal.io/workflows#workflow-execution-chain) was started
      */
-    startTime: Date;
+    readonly startTime: Date;
     /**
      * Time at which the current Workflow Run started
      */
-    runStartTime: Date;
+    readonly runStartTime: Date;
     /**
      * Milliseconds after which the Workflow Execution is automatically terminated by Temporal Server. Set via {@link WorkflowOptions.workflowExecutionTimeout}.
      */
-    executionTimeoutMs?: number;
+    readonly executionTimeoutMs?: number;
     /**
      * Time at which the Workflow Execution expires
      */
-    executionExpirationTime?: Date;
+    readonly executionExpirationTime?: Date;
     /**
      * Milliseconds after which the Workflow Run is automatically terminated by Temporal Server. Set via {@link WorkflowOptions.workflowRunTimeout}.
      */
-    runTimeoutMs?: number;
+    readonly runTimeoutMs?: number;
     /**
      * Maximum execution time of a Workflow Task in milliseconds. Set via {@link WorkflowOptions.workflowTaskTimeout}.
      */
-    taskTimeoutMs: number;
+    readonly taskTimeoutMs: number;
     /**
      * Retry Policy for this Execution. Set via {@link WorkflowOptions.retry}.
      */
-    retryPolicy?: RetryPolicy;
+    readonly retryPolicy?: RetryPolicy;
     /**
      * Starts at 1 and increments for every retry if there is a `retryPolicy`
      */
-    attempt: number;
+    readonly attempt: number;
     /**
      * Cron Schedule for this Execution. Set via {@link WorkflowOptions.cronSchedule}.
      */
-    cronSchedule?: string;
+    readonly cronSchedule?: string;
     /**
      * Milliseconds between Cron Runs
      */
-    cronScheduleToScheduleInterval?: number;
-    unsafe: UnsafeWorkflowInfo;
+    readonly cronScheduleToScheduleInterval?: number;
+    readonly unsafe: UnsafeWorkflowInfo;
 }
 /**
  * Unsafe information about the current Workflow Execution.
@@ -139,8 +139,8 @@ export interface UnsafeWorkflowInfo {
      * The safe version of time is `new Date()` and `Date.now()`, which are set on the first invocation of a Workflow
      * Task and stay constant for the duration of the Task and during replay.
      */
-    now(): number;
-    isReplaying: boolean;
+    readonly now: () => number;
+    readonly isReplaying: boolean;
 }
 export interface ParentWorkflowInfo {
     workflowId: string;
@@ -188,6 +188,8 @@ export interface ContinueAsNewOptions {
      * When using the Worker Versioning feature, specifies whether this Workflow should
      * Continue-as-New onto a worker with a compatible Build Id or not. See {@link VersioningIntent}.
      *
+     * @default 'COMPATIBLE'
+     *
      * @experimental
      */
     versioningIntent?: VersioningIntent;
@@ -279,6 +281,8 @@ export interface ChildWorkflowOptions extends CommonWorkflowOptions {
      * When using the Worker Versioning feature, specifies whether this Child Workflow should run on
      * a worker with a compatible Build Id or not. See {@link VersioningIntent}.
      *
+     * @default 'COMPATIBLE'
+     *
      * @experimental
      */
     versioningIntent?: VersioningIntent;
@@ -356,10 +360,14 @@ export interface WorkflowCreateOptionsInternal extends WorkflowCreateOptions {
     getTimeOfDay(): bigint;
 }
 /**
- * A handler function capable of accepting the arguments for a given SignalDefinition or QueryDefinition.
+ * A handler function capable of accepting the arguments for a given UpdateDefinition, SignalDefinition or QueryDefinition.
  */
-export type Handler<Ret, Args extends any[], T extends SignalDefinition<Args> | QueryDefinition<Ret, Args>> = T extends SignalDefinition<infer A> ? (...args: A) => void | Promise<void> : T extends QueryDefinition<infer R, infer A> ? (...args: A) => R : never;
+export type Handler<Ret, Args extends any[], T extends UpdateDefinition<Ret, Args> | SignalDefinition<Args> | QueryDefinition<Ret, Args>> = T extends UpdateDefinition<infer R, infer A> ? (...args: A) => R | Promise<R> : T extends SignalDefinition<infer A> ? (...args: A) => void | Promise<void> : T extends QueryDefinition<infer R, infer A> ? (...args: A) => R : never;
 /**
- * A handler function accepting signals calls for non-registered signal names.
+ * A handler function accepting signal calls for non-registered signal names.
  */
 export type DefaultSignalHandler = (signalName: string, ...args: unknown[]) => void | Promise<void>;
+/**
+ * A validation function capable of accepting the arguments for a given UpdateDefinition.
+ */
+export type UpdateValidator<Args extends any[]> = (...args: Args) => void;

package/lib/interfaces.js.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":";;;;;;;;;AAWA,sEAA+F;AAkL/F;;GAEG;AAEI,IAAM,aAAa,GAAnB,MAAM,aAAc,SAAQ,KAAK;IACtC,YAA4B,OAAkE;QAC5F,KAAK,CAAC,2BAA2B,CAAC,CAAC;QADT,YAAO,GAAP,OAAO,CAA2D;IAE9F,CAAC;CACF,CAAA;AAJY,aAAa;IADzB,IAAA,yCAA0B,EAAC,eAAe,CAAC;GAC/B,aAAa,CAIzB;AAJY,sCAAa;AA6C1B;;;;;;;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,2BAAY,GAAuF,CAAC;AACpG,IAAA,2BAAY,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,2BAAY,GAA+D,CAAC;AAC5E,IAAA,2BAAY,GAA+D,CAAC"}
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":";;;;;;;;;AAYA,sEAA+F;AAkL/F;;GAEG;AAEI,IAAM,aAAa,GAAnB,MAAM,aAAc,SAAQ,KAAK;IACtC,YAA4B,OAAkE;QAC5F,KAAK,CAAC,2BAA2B,CAAC,CAAC;QADT,YAAO,GAAP,OAAO,CAA2D;IAE9F,CAAC;CACF,CAAA;AAJY,aAAa;IADzB,IAAA,yCAA0B,EAAC,eAAe,CAAC;GAC/B,aAAa,CAIzB;AAJY,sCAAa;AA+C1B;;;;;;;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,2BAAY,GAAuF,CAAC;AACpG,IAAA,2BAAY,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,2BAAY,GAA+D,CAAC;AAC5E,IAAA,2BAAY,GAA+D,CAAC"}

package/lib/internals.d.ts

@@ -1,11 +1,11 @@
 import type { RawSourceMap } from 'source-map';
-import { FailureConverter, PayloadConverter, Workflow, WorkflowQueryType, WorkflowSignalType, ProtoFailure } from '@temporalio/common';
+import { FailureConverter, PayloadConverter, Workflow, WorkflowQueryType, WorkflowSignalType, WorkflowUpdateType, ProtoFailure, WorkflowUpdateValidatorType } from '@temporalio/common';
 import type { coresdk } from '@temporalio/proto';
 import { RNG } from './alea';
 import { RootCancellationScope } from './cancellation-scope';
-import { QueryInput, SignalInput, WorkflowExecuteInput, WorkflowInterceptors } from './interceptors';
+import { QueryInput, SignalInput, UpdateInput, WorkflowExecuteInput, WorkflowInterceptors } from './interceptors';
 import { DefaultSignalHandler, FileLocation, WorkflowInfo, WorkflowCreateOptionsInternal } from './interfaces';
-import { SinkCall } from './sinks';
+import { type SinkCall } from './sinks';
 export interface Stack {
     formatted: string;
     structured: FileLocation[];
@@ -25,13 +25,6 @@ export interface Condition {
     fn(): boolean;
     resolve(): void;
 }
-/**
- * A class that acts as a marker for this special result type
- */
-export declare class LocalActivityDoBackoff extends Error {
-    readonly backoff: coresdk.activity_result.IDoBackoff;
-    constructor(backoff: coresdk.activity_result.IDoBackoff);
-}
 export type ActivationHandlerFunction<K extends keyof coresdk.workflow_activation.IWorkflowActivationJob> = (activation: NonNullable<coresdk.workflow_activation.IWorkflowActivationJob[K]>) => void;
 /**
  * Verifies all activation job handling methods are implemented
@@ -60,6 +53,10 @@ export declare class Activator implements ActivationHandler {
         signalWorkflow: Map<number, Completion>;
         cancelWorkflow: Map<number, Completion>;
     };
+    /**
+     * Holds buffered Update calls until a handler is registered
+     */
+    readonly bufferedUpdates: coresdk.workflow_activation.IDoUpdate[];
     /**
      * Holds buffered signal calls until a handler is registered
      */
@@ -72,6 +69,13 @@ export declare class Activator implements ActivationHandler {
      * which delays query handler registration.
      */
     protected readonly bufferedQueries: coresdk.workflow_activation.IQueryWorkflow[];
+    /**
+     * Mapping of update name to handler and validator
+     */
+    readonly updateHandlers: Map<string, {
+        handler: WorkflowUpdateType;
+        validator?: WorkflowUpdateValidatorType | undefined;
+    }>;
     /**
      * Mapping of signal name to handler
      */
@@ -147,7 +151,7 @@ export declare class Activator implements ActivationHandler {
     /**
      * Information about the current Workflow
      */
-    readonly info: WorkflowInfo;
+    info: WorkflowInfo;
     /**
      * A deterministic RNG, used by the isolate's overridden Math.random
      */
@@ -172,6 +176,7 @@ export declare class Activator implements ActivationHandler {
     readonly getTimeOfDay: () => bigint;
     readonly registeredActivityNames: Set<string>;
     constructor({ info, now, showStackTraceSources, sourceMap, getTimeOfDay, randomnessSeed, patches, registeredActivityNames, }: WorkflowCreateOptionsInternal);
+    mutateWorkflowInfo(fn: (info: WorkflowInfo) => WorkflowInfo): void;
     protected getStackTraces(): Stack[];
     getAndResetSinkCalls(): SinkCall[];
     /**
@@ -190,6 +195,11 @@ export declare class Activator implements ActivationHandler {
     resolveChildWorkflowExecution(activation: coresdk.workflow_activation.IResolveChildWorkflowExecution): void;
     protected queryWorkflowNextHandler({ queryName, args }: QueryInput): Promise<unknown>;
     queryWorkflow(activation: coresdk.workflow_activation.IQueryWorkflow): void;
+    doUpdate(activation: coresdk.workflow_activation.IDoUpdate): void;
+    protected updateNextHandler({ name, args }: UpdateInput): Promise<unknown>;
+    protected validateUpdateNextHandler({ name, args }: UpdateInput): void;
+    dispatchBufferedUpdates(): void;
+    rejectBufferedUpdates(): void;
     signalWorkflowNextHandler({ signalName, args }: SignalInput): Promise<void>;
     signalWorkflow(activation: coresdk.workflow_activation.ISignalWorkflow): void;
     dispatchBufferedSignals(): void;
@@ -205,6 +215,9 @@ export declare class Activator implements ActivationHandler {
     handleWorkflowFailure(error: unknown): Promise<void>;
     private completeQuery;
     private failQuery;
+    private acceptUpdate;
+    private completeUpdate;
+    private rejectUpdate;
     /** Consume a completion if it exists in Workflow state */
     private maybeConsumeCompletion;
     /** Consume a completion if it exists in Workflow state, throws if it doesn't */
@@ -213,5 +226,3 @@ export declare class Activator implements ActivationHandler {
     errorToFailure(err: unknown): ProtoFailure;
     failureToError(failure: ProtoFailure): Error;
 }
-export declare function maybeGetActivator(): Activator | undefined;
-export declare function getActivator(): Activator;