@temelj/workflow 0.0.0-alpha.1

package/dist/types/summary.d.mts

@@ -0,0 +1,318 @@
+import { RunId } from "./run-id.mjs";
+import { StepId } from "./step-id.mjs";
+import { ScheduleId } from "./schedule.mjs";
+import { WorkflowListRunsOptions } from "./run-list.mjs";
+import { WorkflowRunRetryReason, WorkflowRunStatus, WorkflowRunTransitionReason, WorkflowTerminalRunStatus } from "./run.mjs";
+//#region src/types/summary.d.ts
+type WorkflowSummaryIdArray = readonly string[];
+/** Options for workflow run summary. */
+type WorkflowRunSummaryOptions = WorkflowListRunsOptions;
+/** Options for workflow recovery summary. */
+type WorkflowRecoverySummaryOptions = WorkflowListRunsOptions;
+/** Counts grouped by run status. */
+type WorkflowRunStatusCounts = Readonly<Record<WorkflowRunStatus, number>>;
+/** Run IDs grouped by run status. */
+type WorkflowRunStatusRunIds = Readonly<Record<WorkflowRunStatus, WorkflowSummaryIdArray>>;
+/** Counts grouped by run transition reason. */
+type WorkflowRunTransitionReasonCounts = Readonly<Record<WorkflowRunTransitionReason, number>>;
+/** Run IDs grouped by run transition reason. */
+type WorkflowRunTransitionReasonRunIds = Readonly<Record<WorkflowRunTransitionReason, WorkflowSummaryIdArray>>;
+/** Counts grouped by run retry reason. */
+type WorkflowRunRetryReasonCounts = Readonly<Record<WorkflowRunRetryReason, number>>;
+/** Counts grouped by terminal run status. */
+type WorkflowTerminalRunStatusCounts = Readonly<Record<WorkflowTerminalRunStatus, number>>;
+/** Run IDs grouped by terminal run status. */
+type WorkflowTerminalRunStatusRunIds = Readonly<Record<WorkflowTerminalRunStatus, WorkflowSummaryIdArray>>;
+/** Summary data for workflow recovery due. */
+interface WorkflowRecoveryDueSummary {
+  readonly total: number;
+  readonly runIds: WorkflowSummaryIdArray;
+  readonly pendingRunIds: WorkflowSummaryIdArray;
+  readonly waitingRunIds: WorkflowSummaryIdArray;
+  readonly invalidScheduleRunIds: WorkflowSummaryIdArray;
+  readonly nextAvailableAt?: Temporal.Instant;
+  readonly nextAvailableRunId?: RunId;
+}
+/** Summary data for workflow recovery lease. */
+interface WorkflowRecoveryLeaseSummary {
+  readonly total: number;
+  readonly stale: number;
+  readonly runIds: WorkflowSummaryIdArray;
+  readonly staleRunIds: WorkflowSummaryIdArray;
+  readonly ownerlessRunIds: WorkflowSummaryIdArray;
+  readonly missingExpiresAtRunIds: WorkflowSummaryIdArray;
+  readonly invalidExpiresAtRunIds: WorkflowSummaryIdArray;
+  readonly expiredRunIds: WorkflowSummaryIdArray;
+  readonly workerIds: WorkflowSummaryIdArray;
+  readonly nextExpiresAt?: Temporal.Instant;
+  readonly nextExpiringRunId?: RunId;
+  readonly oldestStaleAt?: Temporal.Instant;
+}
+/** Summary data for workflow recovery retry. */
+interface WorkflowRecoveryRetrySummary {
+  readonly total: number;
+  readonly due: number;
+  readonly runIds: WorkflowSummaryIdArray;
+  readonly dueRunIds: WorkflowSummaryIdArray;
+  readonly nextRetryAt?: Temporal.Instant;
+  readonly nextRetryRunId?: RunId;
+}
+/** Summary data for workflow recovery missing implementation. */
+type WorkflowRecoveryMissingImplementationSummary = WorkflowRecoveryRetrySummary;
+/** Summary data for workflow recovery failed. */
+interface WorkflowRecoveryFailedSummary {
+  readonly total: number;
+  readonly runIds: WorkflowSummaryIdArray;
+  readonly latestFailedAt?: Temporal.Instant;
+}
+/** Summary data for workflow recovery schedule. */
+interface WorkflowRecoveryScheduleSummary {
+  readonly total: number;
+  readonly due: number;
+  readonly scheduleIds: WorkflowSummaryIdArray;
+  readonly dueScheduleIds: WorkflowSummaryIdArray;
+  readonly invalidNextFireScheduleIds: WorkflowSummaryIdArray;
+  readonly nextFireAt?: Temporal.Instant;
+  readonly nextFireScheduleId?: ScheduleId;
+}
+/** Summary data for workflow recovery lock. */
+interface WorkflowRecoveryLockSummary {
+  readonly total: number;
+  readonly stale: number;
+  readonly keys: WorkflowSummaryIdArray;
+  readonly staleKeys: WorkflowSummaryIdArray;
+  readonly holderIds: WorkflowSummaryIdArray;
+  readonly waitingRunIds: WorkflowSummaryIdArray;
+  readonly dueWaitingRunIds: WorkflowSummaryIdArray;
+  readonly waitingStepIds: WorkflowSummaryIdArray;
+  readonly waitingKeys: WorkflowSummaryIdArray;
+  readonly nextExpiresAt?: Temporal.Instant;
+  readonly nextExpiringKey?: string;
+  readonly oldestStaleAt?: Temporal.Instant;
+  readonly nextWaitDeadlineAt?: Temporal.Instant;
+  readonly nextWaitDeadlineRunId?: RunId;
+}
+/** Summary data for workflow recovery sleep wait. */
+interface WorkflowRecoverySleepWaitSummary {
+  readonly active: number;
+  readonly due: number;
+  readonly runIds: WorkflowSummaryIdArray;
+  readonly dueRunIds: WorkflowSummaryIdArray;
+  readonly dueStepIds: WorkflowSummaryIdArray;
+  readonly invalidUntilRunIds: WorkflowSummaryIdArray;
+  readonly nextWakeAt?: Temporal.Instant;
+  readonly nextWakeRunId?: RunId;
+}
+/** Summary data for workflow recovery message wait. */
+interface WorkflowRecoveryMessageWaitSummary {
+  readonly active: number;
+  readonly ready: number;
+  readonly timedOut: number;
+  readonly runIds: WorkflowSummaryIdArray;
+  readonly readyRunIds: WorkflowSummaryIdArray;
+  readonly timedOutRunIds: WorkflowSummaryIdArray;
+  readonly readyStepIds: WorkflowSummaryIdArray;
+  readonly timedOutStepIds: WorkflowSummaryIdArray;
+  readonly messages: WorkflowSummaryIdArray;
+  readonly nextTimeoutAt?: Temporal.Instant;
+  readonly nextTimeoutRunId?: RunId;
+}
+/** Summary data for workflow recovery child workflow wait. */
+interface WorkflowRecoveryChildWorkflowWaitSummary {
+  readonly active: number;
+  readonly terminal: number;
+  readonly missing: number;
+  readonly timedOut: number;
+  readonly runIds: WorkflowSummaryIdArray;
+  readonly terminalRunIds: WorkflowSummaryIdArray;
+  readonly missingRunIds: WorkflowSummaryIdArray;
+  readonly timedOutRunIds: WorkflowSummaryIdArray;
+  readonly terminalStepIds: WorkflowSummaryIdArray;
+  readonly missingStepIds: WorkflowSummaryIdArray;
+  readonly timedOutStepIds: WorkflowSummaryIdArray;
+  readonly childRunIds: WorkflowSummaryIdArray;
+  readonly completedChildRunIds: WorkflowSummaryIdArray;
+  readonly failedChildRunIds: WorkflowSummaryIdArray;
+  readonly canceledChildRunIds: WorkflowSummaryIdArray;
+  readonly nextTimeoutAt?: Temporal.Instant;
+  readonly nextTimeoutRunId?: RunId;
+}
+/** Summary data for workflow recovery wait. */
+interface WorkflowRecoveryWaitSummary {
+  readonly sleep: WorkflowRecoverySleepWaitSummary;
+  readonly message: WorkflowRecoveryMessageWaitSummary;
+  readonly childWorkflow: WorkflowRecoveryChildWorkflowWaitSummary;
+}
+/** Summary data for workflow recovery. */
+interface WorkflowRecoverySummary {
+  readonly total: number;
+  readonly recoverableRunIds: WorkflowSummaryIdArray;
+  readonly due: WorkflowRecoveryDueSummary;
+  readonly lease: WorkflowRecoveryLeaseSummary;
+  readonly retry: WorkflowRecoveryRetrySummary;
+  readonly missingImplementation: WorkflowRecoveryMissingImplementationSummary;
+  readonly failed: WorkflowRecoveryFailedSummary;
+  readonly schedule: WorkflowRecoveryScheduleSummary;
+  readonly lock: WorkflowRecoveryLockSummary;
+  readonly wait: WorkflowRecoveryWaitSummary;
+  readonly nextRecoveryAt?: Temporal.Instant;
+}
+/** Describes the workflow run workflow count contract. */
+interface WorkflowRunWorkflowCount {
+  readonly name: string;
+  readonly version?: string;
+  readonly count: number;
+  readonly runIds: WorkflowSummaryIdArray;
+}
+/** Summary data for workflow run workflow. */
+interface WorkflowRunWorkflowSummary {
+  readonly total: number;
+  readonly workflows: readonly WorkflowRunWorkflowCount[];
+}
+/** Summary data for workflow run transition. */
+interface WorkflowRunTransitionSummary {
+  readonly latestTransitionAt?: Temporal.Instant;
+  readonly reason: WorkflowRunTransitionReasonCounts;
+  readonly runIds: WorkflowRunTransitionReasonRunIds;
+}
+/** Summary data for workflow run retry. */
+interface WorkflowRunRetrySummary {
+  readonly total: number;
+  readonly retryRunIds: WorkflowSummaryIdArray;
+  readonly retryStepIds: WorkflowSummaryIdArray;
+  readonly retryStepNames: WorkflowSummaryIdArray;
+  readonly nextRetryAt?: Temporal.Instant;
+  readonly nextRetryRunId?: RunId;
+  readonly highestAttempt?: number;
+  readonly reason: WorkflowRunRetryReasonCounts;
+}
+/** Summary data for workflow run failure error. */
+interface WorkflowRunFailureErrorSummary {
+  readonly name: string;
+  readonly count: number;
+  readonly failedRunIds: WorkflowSummaryIdArray;
+  readonly latestFailedAt?: Temporal.Instant;
+}
+/** Summary data for workflow run failure. */
+interface WorkflowRunFailureSummary {
+  readonly total: number;
+  readonly failedRunIds: WorkflowSummaryIdArray;
+  readonly errors: readonly WorkflowRunFailureErrorSummary[];
+  readonly latestFailedAt?: Temporal.Instant;
+}
+/** Summary data for workflow run lease. */
+interface WorkflowRunLeaseSummary {
+  readonly total: number;
+  readonly expired: number;
+  readonly runIds: WorkflowSummaryIdArray;
+  readonly expiredRunIds: WorkflowSummaryIdArray;
+  readonly workerIds: WorkflowSummaryIdArray;
+  readonly nextExpiresAt?: Temporal.Instant;
+  readonly nextExpiringRunId?: RunId;
+  readonly oldestExpiredAt?: Temporal.Instant;
+}
+/** Summary data for workflow run cleanup. */
+interface WorkflowRunCleanupSummary {
+  readonly eligibleRuns: number;
+  readonly status: WorkflowTerminalRunStatusCounts;
+  readonly statusRunIds: WorkflowTerminalRunStatusRunIds;
+  readonly oldestFinishedAt?: Temporal.Instant;
+  readonly newestFinishedAt?: Temporal.Instant;
+}
+/** Summary data for workflow run stream. */
+interface WorkflowRunStreamSummary {
+  readonly activeStreams: number;
+  readonly activeStreamRuns: number;
+  readonly streamRunIds: WorkflowSummaryIdArray;
+  readonly streamStepIds: WorkflowSummaryIdArray;
+  readonly streamIds: WorkflowSummaryIdArray;
+  readonly streamNames: WorkflowSummaryIdArray;
+  readonly chunkCount: number;
+  readonly oldestStartedAt?: Temporal.Instant;
+}
+/** Summary data for workflow run hook. */
+interface WorkflowRunHookSummary {
+  readonly activeHooks: number;
+  readonly activeWebhooks: number;
+  readonly activeHookRuns: number;
+  readonly hookRunIds: WorkflowSummaryIdArray;
+  readonly hookStepIds: WorkflowSummaryIdArray;
+  readonly hookNames: WorkflowSummaryIdArray;
+  readonly webhookNames: WorkflowSummaryIdArray;
+  readonly messages: WorkflowSummaryIdArray;
+  readonly oldestStartedAt?: Temporal.Instant;
+  readonly nextTimeoutAt?: Temporal.Instant;
+  readonly nextTimeoutRunId?: RunId;
+  readonly nextTimeoutStepId?: StepId;
+}
+/** Summary data for workflow run sleep. */
+interface WorkflowRunSleepSummary {
+  readonly activeSleeps: number;
+  readonly activeSleepRuns: number;
+  readonly sleepRunIds: WorkflowSummaryIdArray;
+  readonly sleepStepIds: WorkflowSummaryIdArray;
+  readonly sleepAttemptKeys: WorkflowSummaryIdArray;
+  readonly oldestStartedAt?: Temporal.Instant;
+  readonly nextWakeAt?: Temporal.Instant;
+  readonly nextWakingRunId?: RunId;
+  readonly nextWakingStepId?: StepId;
+  readonly nextWakingAttemptKey?: string;
+  readonly nextWakingDuration?: Temporal.Duration;
+}
+/** Summary data for workflow run messageId. */
+interface WorkflowRunMessageSummary {
+  readonly activeWaits: number;
+  readonly activeWaitRuns: number;
+  readonly waitRunIds: WorkflowSummaryIdArray;
+  readonly waitStepIds: WorkflowSummaryIdArray;
+  readonly waitAttemptKeys: WorkflowSummaryIdArray;
+  readonly messages: WorkflowSummaryIdArray;
+  readonly oldestWaitStartedAt?: Temporal.Instant;
+  readonly nextWaitTimeoutAt?: Temporal.Instant;
+  readonly nextWaitTimeoutRunId?: RunId;
+  readonly nextWaitTimeoutStepId?: StepId;
+  readonly nextWaitTimeoutAttemptKey?: string;
+}
+/** Summary data for workflow run child workflow. */
+interface WorkflowRunChildWorkflowSummary {
+  readonly activeWaits: number;
+  readonly activeWaitRuns: number;
+  readonly waitRunIds: WorkflowSummaryIdArray;
+  readonly waitStepIds: WorkflowSummaryIdArray;
+  readonly waitAttemptKeys: WorkflowSummaryIdArray;
+  readonly childRunIds: WorkflowSummaryIdArray;
+  readonly retryChildRunIds?: WorkflowSummaryIdArray;
+  readonly failedChildRunIds?: WorkflowSummaryIdArray;
+  readonly canceledChildRunIds?: WorkflowSummaryIdArray;
+  readonly workflows: WorkflowSummaryIdArray;
+  readonly childStatus: WorkflowRunStatusCounts;
+  readonly childRetry?: WorkflowRunRetrySummary;
+  readonly childFailure?: WorkflowRunFailureSummary;
+  readonly oldestWaitStartedAt?: Temporal.Instant;
+  readonly nextWaitTimeoutAt?: Temporal.Instant;
+  readonly nextWaitTimeoutRunId?: RunId;
+  readonly nextWaitTimeoutStepId?: StepId;
+  readonly nextWaitTimeoutAttemptKey?: string;
+}
+/** Summary data for workflow run. */
+interface WorkflowRunSummary {
+  readonly total: number;
+  readonly status: WorkflowRunStatusCounts;
+  readonly statusRunIds: WorkflowRunStatusRunIds;
+  readonly workflow: WorkflowRunWorkflowSummary;
+  readonly transition: WorkflowRunTransitionSummary;
+  readonly retry: WorkflowRunRetrySummary;
+  readonly failure?: WorkflowRunFailureSummary;
+  readonly lease: WorkflowRunLeaseSummary;
+  readonly cleanup?: WorkflowRunCleanupSummary;
+  readonly stream?: WorkflowRunStreamSummary;
+  readonly hook?: WorkflowRunHookSummary;
+  readonly sleep?: WorkflowRunSleepSummary;
+  readonly childWorkflow?: WorkflowRunChildWorkflowSummary;
+  readonly messageId?: WorkflowRunMessageSummary;
+  readonly nextAvailableAt?: Temporal.Instant;
+  readonly oldestPendingAt?: Temporal.Instant;
+  readonly oldestRunningAt?: Temporal.Instant;
+}
+//#endregion
+export { WorkflowRecoveryChildWorkflowWaitSummary, WorkflowRecoveryDueSummary, WorkflowRecoveryFailedSummary, WorkflowRecoveryLeaseSummary, WorkflowRecoveryLockSummary, WorkflowRecoveryMessageWaitSummary, WorkflowRecoveryMissingImplementationSummary, WorkflowRecoveryRetrySummary, WorkflowRecoveryScheduleSummary, WorkflowRecoverySleepWaitSummary, WorkflowRecoverySummary, WorkflowRecoverySummaryOptions, WorkflowRecoveryWaitSummary, WorkflowRunChildWorkflowSummary, WorkflowRunCleanupSummary, WorkflowRunFailureErrorSummary, WorkflowRunFailureSummary, WorkflowRunHookSummary, WorkflowRunLeaseSummary, WorkflowRunMessageSummary, WorkflowRunRetryReasonCounts, WorkflowRunRetrySummary, WorkflowRunSleepSummary, WorkflowRunStatusCounts, WorkflowRunStatusRunIds, WorkflowRunStreamSummary, WorkflowRunSummary, WorkflowRunSummaryOptions, WorkflowRunTransitionReasonCounts, WorkflowRunTransitionReasonRunIds, WorkflowRunTransitionSummary, WorkflowRunWorkflowCount, WorkflowRunWorkflowSummary, WorkflowTerminalRunStatusCounts, WorkflowTerminalRunStatusRunIds };

package/dist/types/summary.mjs

@@ -0,0 +1 @@
+export {};

package/dist/types/telemetry.d.mts

@@ -0,0 +1,74 @@
+import { WorkflowResolvedStepRetryConfig } from "./retry.mjs";
+import { WorkflowStepMetadata } from "./step.mjs";
+import { WorkflowRunSummary, WorkflowRunSummaryOptions } from "./summary.mjs";
+import { ObservationEventMap } from "./observation.mjs";
+import { ExecutionResult } from "./result.mjs";
+import { WorkflowRunRecord } from "./run.mjs";
+import { z } from "zod";
+//#region src/types/telemetry.d.ts
+declare const workflowTelemetryContextSchema: z.ZodObject<{
+  traceparent: z.ZodOptional<z.ZodString>;
+  tracestate: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/** Persisted W3C trace context captured when a workflow run is created. */
+interface TelemetryContext {
+  readonly traceparent?: string;
+  readonly tracestate?: string;
+}
+/** Context passed to telemetry adapters around workflow run execution. */
+interface RunTelemetryContext {
+  readonly run: WorkflowRunRecord;
+  readonly traceContext?: TelemetryContext;
+}
+/** Context passed to telemetry adapters after workflow run execution finishes. */
+interface RunTelemetryResultContext<TOutput = unknown> extends RunTelemetryContext {
+  readonly result?: ExecutionResult<TOutput>;
+  readonly error?: unknown;
+}
+/** Context passed to telemetry adapters around durable task callback execution. */
+interface StepTelemetryContext {
+  readonly run: WorkflowRunRecord;
+  readonly step: WorkflowStepMetadata;
+  readonly attempt: number;
+  readonly retry: WorkflowResolvedStepRetryConfig;
+  readonly timeoutAt?: Temporal.Instant;
+}
+/** Context passed to telemetry adapters after durable task callback execution finishes. */
+interface StepTelemetryResultContext extends StepTelemetryContext {
+  readonly error?: unknown;
+}
+/** Storage/backend operation names observed by the default workflow store. */
+type StorageTelemetryOperation = "get" | "tryGet" | "set" | "trySet" | "compareAndSet" | "tryCompareAndSet" | "compareAndSetMany" | "tryCompareAndSetMany" | "has" | "tryHas" | "delete" | "tryDelete" | "getMany" | "tryGetMany" | "setMany" | "trySetMany" | "deleteMany" | "tryDeleteMany" | "keys" | "tryKeys" | "entries" | "tryEntries" | "clear" | "tryClear" | "watch" | "unwatch" | "dispose" | "tryDispose";
+/** Context passed to telemetry adapters around workflow storage/backend operations. */
+interface StorageTelemetryContext {
+  readonly operation: StorageTelemetryOperation;
+  readonly backend: string;
+}
+/** Minimal engine read model exposed to telemetry adapters after engine creation. */
+interface TelemetryEngine {
+  /** Returns aggregate run metrics for runs matching optional filters. */
+  getRunSummary(options?: WorkflowRunSummaryOptions): Promise<WorkflowRunSummary>;
+}
+/** Optional telemetry hooks used to observe running workflow behavior. */
+interface Telemetry {
+  /** Captures ambient trace context for a newly-created workflow run. */
+  captureContext?(): TelemetryContext | undefined;
+  /** Runs a workflow execution callback with telemetry context. */
+  withRunExecution?<T>(context: RunTelemetryContext, callback: () => Promise<T>): Promise<T>;
+  /** Runs a durable task callback with telemetry context. */
+  withStepExecution?<T>(context: StepTelemetryContext, callback: () => Promise<T>): Promise<T>;
+  /** Runs a workflow storage/backend operation callback with telemetry context. */
+  withStorageOperation?<T>(context: StorageTelemetryContext, callback: () => Promise<T>): Promise<T>;
+  /** Observes the final outcome of a workflow execution callback. */
+  recordRunExecution?<TOutput>(context: RunTelemetryResultContext<TOutput>): void;
+  /** Observes the final outcome of a durable task callback. */
+  recordStepExecution?(context: StepTelemetryResultContext): void;
+  /** Observes committed workflow observation events. */
+  observe?<Key extends keyof ObservationEventMap>(name: Key, payload: ObservationEventMap[Key]): void;
+  /** Binds the telemetry adapter to an engine after engine creation. */
+  bindEngine?(engine: TelemetryEngine): void;
+  /** Releases telemetry resources owned by the adapter. */
+  shutdown?(): Promise<void> | void;
+}
+//#endregion
+export { RunTelemetryContext, RunTelemetryResultContext, StepTelemetryContext, StepTelemetryResultContext, StorageTelemetryContext, StorageTelemetryOperation, Telemetry, TelemetryContext, TelemetryEngine, workflowTelemetryContextSchema };

package/dist/types/telemetry.mjs

@@ -0,0 +1,9 @@
+import { nonBlankStringSchema } from "./common.mjs";
+import { z } from "zod";
+//#region src/types/telemetry.ts
+const workflowTelemetryContextSchema = z.object({
+	traceparent: nonBlankStringSchema.optional(),
+	tracestate: nonBlankStringSchema.optional()
+});
+//#endregion
+export { workflowTelemetryContextSchema };

package/dist/types/timeline.d.mts

@@ -0,0 +1,237 @@
+import { MessageId } from "./message-id.mjs";
+import { RunId } from "./run-id.mjs";
+import { StepId } from "./step-id.mjs";
+import { StreamId } from "./stream-id.mjs";
+import { WorkflowAttributePatch, WorkflowRunRecord } from "./run.mjs";
+import { WorkflowErrorRecord } from "./error.mjs";
+import { AttributesSetEvent, ChildWorkflowCompletedEvent, ChildWorkflowFailedEvent, ChildWorkflowStartedEvent, DeterministicValueRecordedEvent, EventRecord, MessageSendCompletedEvent, MessageSendFailedEvent, MessageSendStartedEvent, MessageSentEvent, MessageWaitCompletedEvent, MessageWaitFailedEvent, MessageWaitStartedEvent, MetadataSetEvent, SleepCompletedEvent, SleepStartedEvent, StreamChunkEvent, StreamClosedEvent, StreamFailedEvent, StreamStartedEvent, WorkflowStepCompletedEvent, WorkflowStepFailedEvent, WorkflowStepStartedEvent } from "./events.mjs";
+import { StorageValue } from "@temelj/storage";
+//#region src/types/timeline.d.ts
+type WorkflowStartedEvent = Extract<EventRecord, {
+  readonly kind: "workflow_started";
+}>;
+type WorkflowCompletedEvent = Extract<EventRecord, {
+  readonly kind: "workflow_completed";
+}>;
+type WorkflowFailedEvent = Extract<EventRecord, {
+  readonly kind: "workflow_failed";
+}>;
+/** Describes the workflow timeline contract. */
+interface Timeline {
+  readonly run: WorkflowRunRecord;
+  readonly entries: readonly TimelineEntryRecord[];
+}
+/** Kind values for workflow timeline entries. */
+type TimelineEntryKind = "workflow" | "step" | "sleep" | "child_workflow" | "message" | "stream" | "deterministic" | "metadata" | "attributes";
+/** Status values for workflow-level timeline entries. */
+type TimelineWorkflowStatus = "started" | "completed" | "failed";
+/** Status values for durable task timeline entries. */
+type TimelineStepStatus = "started" | "completed" | "failed";
+/** Status values for sleep timeline entries. */
+type TimelineSleepStatus = "started" | "completed";
+/** Status values for child workflow timeline entries. */
+type TimelineChildWorkflowStatus = "started" | "completed" | "failed";
+/** Status values for messageId timeline entries. */
+type TimelineMessageStatus = "send_started" | "send_completed" | "send_failed" | "sent" | "waiting" | "received" | "failed";
+/** Status values for stream timeline entries. */
+type TimelineStreamStatus = "started" | "chunk" | "closed" | "failed";
+/** Status value for metadata and attribute timeline entries. */
+type TimelineSetStatus = "set";
+/** Status value for deterministic-value timeline entries. */
+type TimelineRecordedStatus = "recorded";
+/** Base contract for workflow timeline entries. */
+interface TimelineEntry {
+  readonly kind: TimelineEntryKind;
+}
+type WorkflowTimelineStepFields = {
+  readonly timestamp: Temporal.Instant;
+  readonly stepId: StepId;
+  readonly stepName: string;
+};
+type WorkflowTimelineCountField = {
+  readonly count?: number;
+};
+type WorkflowTimelineOptionalMessageFields = {
+  readonly stepId?: StepId;
+  readonly stepName?: string;
+  readonly count?: number;
+  readonly targetRunId?: RunId;
+  readonly timeoutAt?: Temporal.Instant;
+  readonly payload?: StorageValue;
+  readonly error?: WorkflowErrorRecord;
+  readonly messageTimestamp?: Temporal.Instant;
+  readonly waiterStepIds?: readonly string[];
+};
+/** Describes the workflow timeline workflow entry contract. */
+type TimelineWorkflowEntry = {
+  readonly kind: "workflow";
+  readonly status: "started";
+  readonly timestamp: Temporal.Instant;
+  readonly event: WorkflowStartedEvent;
+} | {
+  readonly kind: "workflow";
+  readonly status: "completed";
+  readonly timestamp: Temporal.Instant;
+  readonly event: WorkflowCompletedEvent;
+} | {
+  readonly kind: "workflow";
+  readonly status: "failed";
+  readonly timestamp: Temporal.Instant;
+  readonly event: WorkflowFailedEvent;
+};
+/** Describes the workflow timeline step entry contract. */
+type TimelineStepEntry = (WorkflowTimelineStepFields & WorkflowTimelineCountField & {
+  readonly kind: "step";
+  readonly status: "started";
+  readonly attempt: number;
+  readonly event: WorkflowStepStartedEvent;
+}) | (WorkflowTimelineStepFields & {
+  readonly kind: "step";
+  readonly status: "completed";
+  readonly attempt: number;
+  readonly result?: StorageValue;
+  readonly event: WorkflowStepCompletedEvent;
+}) | (WorkflowTimelineStepFields & {
+  readonly kind: "step";
+  readonly status: "failed";
+  readonly attempt: number;
+  readonly error?: WorkflowErrorRecord;
+  readonly event: WorkflowStepFailedEvent;
+});
+/** Describes the workflow timeline sleep entry contract. */
+type TimelineSleepEntry = (WorkflowTimelineStepFields & WorkflowTimelineCountField & {
+  readonly kind: "sleep";
+  readonly status: "started";
+  readonly until?: Temporal.Instant;
+  readonly duration?: Temporal.Duration;
+  readonly event: SleepStartedEvent;
+}) | (WorkflowTimelineStepFields & {
+  readonly kind: "sleep";
+  readonly status: "completed";
+  readonly event: SleepCompletedEvent;
+});
+/** Describes the workflow timeline child workflow entry contract. */
+type TimelineChildWorkflowEntry = (WorkflowTimelineStepFields & WorkflowTimelineCountField & {
+  readonly kind: "child_workflow";
+  readonly status: "started";
+  readonly childRunId: RunId;
+  readonly workflowName?: string;
+  readonly workflowVersion?: string;
+  readonly input?: StorageValue;
+  readonly timeoutAt?: Temporal.Instant;
+  readonly event: ChildWorkflowStartedEvent;
+}) | (WorkflowTimelineStepFields & {
+  readonly kind: "child_workflow";
+  readonly status: "completed";
+  readonly childRunId: RunId;
+  readonly result?: StorageValue;
+  readonly event: ChildWorkflowCompletedEvent;
+}) | (WorkflowTimelineStepFields & {
+  readonly kind: "child_workflow";
+  readonly status: "failed";
+  readonly childRunId: RunId;
+  readonly error?: WorkflowErrorRecord;
+  readonly event: ChildWorkflowFailedEvent;
+});
+/** Describes the workflow timeline messageId entry contract. */
+type TimelineMessageEntry = (WorkflowTimelineOptionalMessageFields & WorkflowTimelineStepFields & WorkflowTimelineCountField & {
+  readonly kind: "message";
+  readonly status: "send_started";
+  readonly targetRunId: RunId;
+  readonly messageId: MessageId;
+  readonly event: MessageSendStartedEvent;
+}) | (WorkflowTimelineOptionalMessageFields & WorkflowTimelineStepFields & {
+  readonly kind: "message";
+  readonly status: "send_completed";
+  readonly targetRunId: RunId;
+  readonly messageId: MessageId;
+  readonly event: MessageSendCompletedEvent;
+}) | (WorkflowTimelineOptionalMessageFields & WorkflowTimelineStepFields & {
+  readonly kind: "message";
+  readonly status: "send_failed";
+  readonly targetRunId: RunId;
+  readonly messageId: MessageId;
+  readonly error?: WorkflowErrorRecord;
+  readonly event: MessageSendFailedEvent;
+}) | (WorkflowTimelineOptionalMessageFields & {
+  readonly kind: "message";
+  readonly status: "sent";
+  readonly timestamp: Temporal.Instant;
+  readonly messageId: MessageId;
+  readonly payload?: StorageValue;
+  readonly event: MessageSentEvent;
+}) | (WorkflowTimelineOptionalMessageFields & WorkflowTimelineStepFields & WorkflowTimelineCountField & {
+  readonly kind: "message";
+  readonly status: "waiting";
+  readonly messageId: MessageId;
+  readonly timeoutAt?: Temporal.Instant;
+  readonly event: MessageWaitStartedEvent;
+}) | (WorkflowTimelineOptionalMessageFields & WorkflowTimelineStepFields & {
+  readonly kind: "message";
+  readonly status: "received";
+  readonly messageId: MessageId;
+  readonly payload?: StorageValue;
+  readonly messageTimestamp?: Temporal.Instant;
+  readonly event: MessageWaitCompletedEvent;
+}) | (WorkflowTimelineOptionalMessageFields & WorkflowTimelineStepFields & {
+  readonly kind: "message";
+  readonly status: "failed";
+  readonly messageId: MessageId;
+  readonly error?: WorkflowErrorRecord;
+  readonly event: MessageWaitFailedEvent;
+});
+/** Describes the workflow timeline metadata entry contract. */
+type TimelineMetadataEntry = WorkflowTimelineStepFields & {
+  readonly kind: "metadata";
+  readonly status: TimelineSetStatus;
+  readonly count: number;
+  readonly metadata: StorageValue;
+  readonly event: MetadataSetEvent;
+};
+/** Describes the workflow timeline attributes entry contract. */
+type TimelineAttributesEntry = WorkflowTimelineStepFields & {
+  readonly kind: "attributes";
+  readonly status: TimelineSetStatus;
+  readonly count: number;
+  readonly attributes: WorkflowAttributePatch;
+  readonly event: AttributesSetEvent;
+};
+/** Describes the workflow timeline stream entry contract. */
+type TimelineStreamEntry = (WorkflowTimelineStepFields & WorkflowTimelineCountField & {
+  readonly kind: "stream";
+  readonly status: "started";
+  readonly streamId: StreamId;
+  readonly contentType?: string;
+  readonly metadata?: StorageValue;
+  readonly event: StreamStartedEvent;
+}) | (WorkflowTimelineStepFields & {
+  readonly kind: "stream";
+  readonly status: "chunk";
+  readonly streamId: StreamId;
+  readonly index: number;
+  readonly chunk?: StorageValue;
+  readonly event: StreamChunkEvent;
+}) | (WorkflowTimelineStepFields & {
+  readonly kind: "stream";
+  readonly status: "closed";
+  readonly streamId: StreamId;
+  readonly event: StreamClosedEvent;
+}) | (WorkflowTimelineStepFields & {
+  readonly kind: "stream";
+  readonly status: "failed";
+  readonly streamId: StreamId;
+  readonly error?: WorkflowErrorRecord;
+  readonly event: StreamFailedEvent;
+});
+/** Describes the workflow timeline deterministic entry contract. */
+type TimelineDeterministicEntry = WorkflowTimelineStepFields & {
+  readonly kind: "deterministic";
+  readonly status: TimelineRecordedStatus;
+  readonly count: number;
+  readonly value: StorageValue;
+  readonly event: DeterministicValueRecordedEvent;
+};
+/** Type used for workflow timeline entry values. */
+type TimelineEntryRecord = TimelineWorkflowEntry | TimelineStepEntry | TimelineSleepEntry | TimelineChildWorkflowEntry | TimelineMessageEntry | TimelineStreamEntry | TimelineDeterministicEntry | TimelineMetadataEntry | TimelineAttributesEntry;
+//#endregion
+export { Timeline, TimelineAttributesEntry, TimelineChildWorkflowEntry, TimelineChildWorkflowStatus, TimelineDeterministicEntry, TimelineEntry, TimelineEntryKind, TimelineEntryRecord, TimelineMessageEntry, TimelineMessageStatus, TimelineMetadataEntry, TimelineRecordedStatus, TimelineSetStatus, TimelineSleepEntry, TimelineSleepStatus, TimelineStepEntry, TimelineStepStatus, TimelineStreamEntry, TimelineStreamStatus, TimelineWorkflowEntry, TimelineWorkflowStatus };

package/dist/types/timeline.mjs

@@ -0,0 +1 @@
+export {};