@aikirun/types 0.6.0 → 0.8.0

package/README.md

@@ -22,6 +22,8 @@ npm install @aikirun/types
 - `/duration` - Duration types
 - `/retry` - Retry strategy types
 - `/error` - Serializable error types
+- `/sleep` - Sleep definition types
+- `/event` - Event definition types
 
 ## Usage
 

package/dist/client.d.ts

@@ -2,11 +2,11 @@ import { WorkflowMeta } from './workflow.js';
 import { WorkflowRun, WorkflowRunId } from './workflow-run.js';
 import { WorkflowRunApi } from './workflow-run-api.js';
 import { INTERNAL } from './symbols.js';
-import './error.js';
 import './event.js';
 import './duration.js';
 import './utils.js';
 import './retry.js';
+import './serializable.js';
 import './sleep.js';
 import './task.js';
 import './trigger.js';

package/dist/duration.d.ts

@@ -1,4 +1,4 @@
-import { RequireAtLeastOneOf } from './utils.js';
+import { RequireAtLeastOneProp } from './utils.js';
 
 interface DurationFields {
     days?: number;
@@ -7,7 +7,7 @@ interface DurationFields {
     seconds?: number;
     milliseconds?: number;
 }
-type DurationObject = RequireAtLeastOneOf<DurationFields, keyof DurationFields>;
+type DurationObject = RequireAtLeastOneProp<DurationFields>;
 type DurationMs = number;
 type Duration = DurationMs | DurationObject;
 

package/dist/event.d.ts

@@ -1,8 +1,8 @@
 import { DurationObject } from './duration.js';
 import './utils.js';
 
-type EventId = string & {
-    _brand: "event_id";
+type EventName = string & {
+    _brand: "event_name";
 };
 type EventStatus = "received" | "timeout";
 interface EventStateBase {
@@ -12,18 +12,18 @@ interface EventStateReceived<Data> extends EventStateBase {
     status: "received";
     data: Data;
     receivedAt: number;
-    idempotencyKey?: string;
+    reference?: EventReferenceOptions;
 }
-interface EventStateTimedOut extends EventStateBase {
+interface EventStateTimeout extends EventStateBase {
     status: "timeout";
     timedOutAt: number;
 }
-type EventState<Data> = EventStateReceived<Data> | EventStateTimedOut;
+type EventState<Data> = EventStateReceived<Data> | EventStateTimeout;
 interface EventQueue<Data> {
     events: EventState<Data>[];
 }
-interface EventWaitOptions<Timeout extends DurationObject | undefined> {
-    timeout?: Timeout;
+interface EventWaitOptions<Timed extends boolean> {
+    timeout?: Timed extends true ? DurationObject : never;
 }
 type EventWaitState<Data, Timed extends boolean> = Timed extends false ? {
     data: Data;
@@ -34,7 +34,10 @@ type EventWaitState<Data, Timed extends boolean> = Timed extends false ? {
     timeout: true;
 };
 interface EventSendOptions {
-    idempotencyKey?: string;
+    reference?: EventReferenceOptions;
+}
+interface EventReferenceOptions {
+    id: string;
 }
 
-export type { EventId, EventQueue, EventSendOptions, EventState, EventStateReceived, EventStateTimedOut, EventStatus, EventWaitOptions, EventWaitState };
+export type { EventName, EventQueue, EventReferenceOptions, EventSendOptions, EventState, EventStateReceived, EventStateTimeout, EventStatus, EventWaitOptions, EventWaitState };

package/dist/serializable.d.ts

@@ -0,0 +1,11 @@
+type Serializable = void | null | string | number | boolean | {
+    [key: string]: Serializable;
+} | Serializable[];
+interface SerializableError {
+    message: string;
+    name: string;
+    stack?: string;
+    cause?: SerializableError;
+}
+
+export type { Serializable, SerializableError };

package/dist/sleep.d.ts

@@ -1,37 +1,29 @@
-import { DurationObject } from './duration.js';
-import './utils.js';
-
-type SleepId = string & {
-    _brand: "sleep_id";
-};
-type SleepPath = string & {
-    _brand: "sleep_path";
+type SleepName = string & {
+    _brand: "sleep_name";
 };
-type SleepStatus = "none" | "sleeping" | "completed" | "cancelled";
+type SleepStatus = "sleeping" | "completed" | "cancelled";
 interface SleepStateBase {
     status: SleepStatus;
 }
-interface SleepStateNone extends SleepStateBase {
-    status: "none";
-}
 interface SleepStateSleeping extends SleepStateBase {
     status: "sleeping";
     awakeAt: number;
 }
 interface SleepStateCompleted extends SleepStateBase {
     status: "completed";
+    durationMs: number;
     completedAt: number;
 }
 interface SleepStateCancelled extends SleepStateBase {
     status: "cancelled";
     cancelledAt: number;
 }
-type SleepState = SleepStateNone | SleepStateSleeping | SleepStateCompleted | SleepStateCancelled;
-type SleepParams = {
-    id: string;
-} & DurationObject;
+type SleepState = SleepStateSleeping | SleepStateCompleted | SleepStateCancelled;
+interface SleepQueue {
+    sleeps: SleepState[];
+}
 interface SleepResult {
     cancelled: boolean;
 }
 
-export type { SleepId, SleepParams, SleepPath, SleepResult, SleepState, SleepStateCancelled, SleepStateCompleted, SleepStateNone, SleepStateSleeping, SleepStatus };
+export type { SleepName, SleepQueue, SleepResult, SleepState, SleepStateCancelled, SleepStateCompleted, SleepStateSleeping, SleepStatus };

package/dist/task.d.ts

@@ -1,21 +1,31 @@
-import { SerializableError } from './error.js';
+import { RetryStrategy } from './retry.js';
+import { SerializableError } from './serializable.js';
 
 type TaskId = string & {
     _brand: "task_id";
 };
+type TaskName = string & {
+    _brand: "task_name";
+};
 type TaskPath = string & {
     _brand: "task_path";
 };
-type TaskStatus = "none" | "running" | "awaiting_retry" | "completed" | "failed";
+type TaskStatus = "running" | "awaiting_retry" | "completed" | "failed";
+interface TaskOptions {
+    retry?: RetryStrategy;
+    reference?: TaskReferenceOptions;
+}
+interface TaskReferenceOptions {
+    id: string;
+    onConflict?: "error" | "return_existing";
+}
 interface TaskStateBase {
     status: TaskStatus;
 }
-interface TaskStateNone extends TaskStateBase {
-    status: "none";
-}
-interface TaskStateRunning extends TaskStateBase {
+interface TaskStateRunning<Input> extends TaskStateBase {
     status: "running";
     attempts: number;
+    input: Input;
 }
 interface TaskStateAwaitingRetry extends TaskStateBase {
     status: "awaiting_retry";
@@ -25,6 +35,7 @@ interface TaskStateAwaitingRetry extends TaskStateBase {
 }
 interface TaskStateCompleted<Output> extends TaskStateBase {
     status: "completed";
+    attempts: number;
     output: Output;
 }
 interface TaskStateFailed extends TaskStateBase {
@@ -32,12 +43,49 @@ interface TaskStateFailed extends TaskStateBase {
     attempts: number;
     error: SerializableError;
 }
-type TaskState<Output = unknown> = TaskStateNone | TaskStateRunning | TaskStateAwaitingRetry | TaskStateCompleted<Output> | TaskStateFailed;
+type TaskState<Input = unknown, Output = unknown> = TaskStateRunning<Input> | TaskStateAwaitingRetry | TaskStateCompleted<Output> | TaskStateFailed;
+interface TaskInfo {
+    id: string;
+    name: string;
+    state: TaskState;
+    inputHash: string;
+}
+interface TransitionTaskStateBase {
+    id: string;
+    expectedRevision: number;
+}
+interface TransitionTaskStateToRunningCreate extends TransitionTaskStateBase {
+    type: "create";
+    taskName: string;
+    options?: TaskOptions;
+    taskState: TaskStateRunning<unknown>;
+}
+interface TransitionTaskStateToRunningRetry extends TransitionTaskStateBase {
+    type: "retry";
+    taskId: string;
+    options?: TaskOptions;
+    taskState: TaskStateRunning<unknown>;
+}
+interface TransitionTaskStateToCompleted extends TransitionTaskStateBase {
+    taskId: string;
+    taskState: TaskStateCompleted<unknown>;
+}
+interface TransitionTaskStateToFailed extends TransitionTaskStateBase {
+    taskId: string;
+    taskState: TaskStateFailed;
+}
+interface TransitionTaskStateToAwaitingRetry extends TransitionTaskStateBase {
+    taskId: string;
+    taskState: TaskStateAwaitingRetryRequest;
+}
+type TaskStateAwaitingRetryRequest = Omit<TaskStateAwaitingRetry, "nextAttemptAt"> & {
+    nextAttemptInMs: number;
+};
 declare class TaskFailedError extends Error {
-    readonly taskPath: TaskPath;
+    readonly taskId: TaskId;
     readonly attempts: number;
     readonly reason: string;
-    constructor(taskPath: TaskPath, attempts: number, reason: string);
+    constructor(taskId: TaskId, attempts: number, reason: string);
 }
 
-export { TaskFailedError, type TaskId, type TaskPath, type TaskState, type TaskStateAwaitingRetry, type TaskStateCompleted, type TaskStateFailed, type TaskStateNone, type TaskStateRunning, type TaskStatus };
+export { TaskFailedError, type TaskId, type TaskInfo, type TaskName, type TaskOptions, type TaskPath, type TaskReferenceOptions, type TaskState, type TaskStateAwaitingRetry, type TaskStateAwaitingRetryRequest, type TaskStateCompleted, type TaskStateFailed, type TaskStateRunning, type TaskStatus, type TransitionTaskStateBase, type TransitionTaskStateToAwaitingRetry, type TransitionTaskStateToCompleted, type TransitionTaskStateToFailed, type TransitionTaskStateToRunningCreate, type TransitionTaskStateToRunningRetry };

package/dist/task.js

@@ -1,8 +1,8 @@
 // task.ts
 var TaskFailedError = class extends Error {
-  constructor(taskPath, attempts, reason) {
-    super(`Task ${taskPath} failed after ${attempts} attempts. Reason: ${reason}`);
-    this.taskPath = taskPath;
+  constructor(taskId, attempts, reason) {
+    super(`Task ${taskId} failed after ${attempts} attempts. Reason: ${reason}`);
+    this.taskId = taskId;
     this.attempts = attempts;
     this.reason = reason;
     this.name = "TaskFailedError";

package/dist/utils.d.ts

@@ -1,6 +1,6 @@
-type RequireAtLeastOneOf<T, Keys extends keyof T> = {
+type RequireAtLeastOneProp<T, Keys extends keyof T = keyof T> = {
     [K in Keys]-?: Required<Pick<T, K>> & Omit<T, K>;
 }[Keys];
 type DistributiveOmit<T, K extends keyof T> = T extends T ? Omit<T, K> : never;
 
-export type { DistributiveOmit, RequireAtLeastOneOf };
+export type { DistributiveOmit, RequireAtLeastOneProp };

package/dist/validator.d.ts

@@ -0,0 +1,5 @@
+interface Schema<Data> {
+    parse: (data: unknown) => Awaited<Data>;
+}
+
+export type { Schema };

package/dist/worker.d.ts

@@ -0,0 +1,8 @@
+type WorkerName = string & {
+    _brand: "worker_name";
+};
+type WorkerId = string & {
+    _brand: "worker_id";
+};
+
+export type { WorkerId, WorkerName };

package/dist/workflow-run-api.d.ts

@@ -1,22 +1,24 @@
 import { EventSendOptions } from './event.js';
-import { TaskState, TaskStateAwaitingRetry } from './task.js';
+import { TransitionTaskStateToRunningCreate, TransitionTaskStateToRunningRetry, TransitionTaskStateToCompleted, TransitionTaskStateToFailed, TransitionTaskStateToAwaitingRetry, TaskStateCompleted, TaskStateFailed } from './task.js';
 import { DistributiveOmit } from './utils.js';
-import { WorkflowRunStatus, WorkflowRun, WorkflowRunState, WorkflowOptions, WorkflowRunStateScheduled, WorkflowRunStateAwaitingEvent, WorkflowRunStateAwaitingRetry, WorkflowRunStatePaused, WorkflowRunStateCancelled, WorkflowRunTransition } from './workflow-run.js';
+import { WorkflowRunStatus, WorkflowRun, WorkflowRunState, WorkflowOptions, WorkflowRunStateScheduled, WorkflowRunStateAwaitingEvent, WorkflowRunStateAwaitingRetry, WorkflowRunStateAwaitingChildWorkflow, WorkflowRunStatePaused, WorkflowRunStateCancelled, WorkflowRunTransition } from './workflow-run.js';
 import './duration.js';
-import './error.js';
 import './retry.js';
+import './serializable.js';
 import './sleep.js';
 import './trigger.js';
 
 interface WorkflowRunApi {
-    listV1: (input: WorkflowRunListRequestV1) => Promise<WorkflowRunListResponseV1>;
-    getByIdV1: (input: WorkflowRunGetByIdRequestV1) => Promise<WorkflowRunGetByIdResponseV1>;
-    getStateV1: (input: WorkflowRunGetStateRequestV1) => Promise<WorkflowRunGetStateResponseV1>;
-    createV1: (input: WorkflowRunCreateRequestV1) => Promise<WorkflowRunCreateResponseV1>;
-    transitionStateV1: (input: WorkflowRunTransitionStateRequestV1) => Promise<WorkflowRunTransitionStateResponseV1>;
-    transitionTaskStateV1: (input: WorkflowRunTransitionTaskStateRequestV1) => Promise<WorkflowRunTransitionTaskStateResponseV1>;
-    listTransitionsV1: (input: WorkflowRunListTransitionsRequestV1) => Promise<WorkflowRunListTransitionsResponseV1>;
-    sendEventV1: (input: WorkflowRunSendEventRequestV1) => Promise<WorkflowRunSendEventResponseV1>;
+    listV1: (_: WorkflowRunListRequestV1) => Promise<WorkflowRunListResponseV1>;
+    getByIdV1: (_: WorkflowRunGetByIdRequestV1) => Promise<WorkflowRunGetByIdResponseV1>;
+    getStateV1: (_: WorkflowRunGetStateRequestV1) => Promise<WorkflowRunGetStateResponseV1>;
+    createV1: (_: WorkflowRunCreateRequestV1) => Promise<WorkflowRunCreateResponseV1>;
+    transitionStateV1: (_: WorkflowRunTransitionStateRequestV1) => Promise<WorkflowRunTransitionStateResponseV1>;
+    transitionTaskStateV1: (_: WorkflowRunTransitionTaskStateRequestV1) => Promise<WorkflowRunTransitionTaskStateResponseV1>;
+    setTaskStateV1: (_: WorkflowRunSetTaskStateRequestV1) => Promise<WorkflowRunSetTaskStateResponseV1>;
+    listTransitionsV1: (_: WorkflowRunListTransitionsRequestV1) => Promise<WorkflowRunListTransitionsResponseV1>;
+    sendEventV1: (_: WorkflowRunSendEventRequestV1) => Promise<WorkflowRunSendEventResponseV1>;
+    multicastEventV1: (_: WorkflowRunMulticastEventRequestV1) => Promise<void>;
 }
 interface WorkflowRunListRequestV1 {
     limit?: number;
@@ -35,8 +37,8 @@ interface WorkflowRunListRequestV1 {
 }
 interface WorkflowRunListItem {
     id: string;
-    workflowId: string;
-    workflowVersionId: string;
+    name: string;
+    versionId: string;
     createdAt: number;
     status: WorkflowRunStatus;
 }
@@ -57,9 +59,10 @@ interface WorkflowRunGetStateResponseV1 {
     state: WorkflowRunState;
 }
 interface WorkflowRunCreateRequestV1 {
-    workflowId: string;
-    workflowVersionId: string;
+    name: string;
+    versionId: string;
     input: unknown;
+    parentWorkflowRunId?: string;
     options?: WorkflowOptions;
 }
 interface WorkflowRunCreateResponseV1 {
@@ -74,16 +77,19 @@ type WorkflowRunStateAwaitingEventRequest = DistributiveOmit<WorkflowRunStateAwa
 type WorkflowRunStateAwaitingRetryRequest = DistributiveOmit<WorkflowRunStateAwaitingRetry, "nextAttemptAt"> & {
     nextAttemptInMs: number;
 };
+type WorkflowRunStateAwaitingChildWorkflowRequest = DistributiveOmit<WorkflowRunStateAwaitingChildWorkflow, "timeoutAt"> & {
+    timeoutInMs?: number;
+};
 type WorkflowRunStateRequest = Exclude<WorkflowRunState, {
-    status: "scheduled" | "awaiting_event" | "awaiting_retry";
-}> | WorkflowRunStateScheduledRequest | WorkflowRunStateAwaitingEventRequest | WorkflowRunStateAwaitingRetryRequest;
+    status: "scheduled" | "awaiting_event" | "awaiting_retry" | "awaiting_child_workflow";
+}> | WorkflowRunStateScheduledRequest | WorkflowRunStateAwaitingEventRequest | WorkflowRunStateAwaitingRetryRequest | WorkflowRunStateAwaitingChildWorkflowRequest;
 interface WorkflowRunTransitionStateRequestBase {
     type: "optimistic" | "pessimistic";
     id: string;
     state: WorkflowRunStateRequest;
 }
-type WorkflowRunStateScheduledRequestOptimistic = Exclude<WorkflowRunStateScheduledRequest, {
-    reason: "new" | "resume";
+type WorkflowRunStateScheduledRequestOptimistic = Extract<WorkflowRunStateScheduledRequest, {
+    reason: "retry" | "task_retry" | "awake" | "event" | "child_workflow";
 }>;
 type WorkflowRunStateScheduledRequestPessimistic = Exclude<WorkflowRunStateScheduledRequest, WorkflowRunStateScheduledRequestOptimistic>;
 interface WorkflowRunTransitionStateRequestOptimistic extends WorkflowRunTransitionStateRequestBase {
@@ -101,19 +107,30 @@ type WorkflowRunTransitionStateRequestV1 = WorkflowRunTransitionStateRequestOpti
 interface WorkflowRunTransitionStateResponseV1 {
     run: WorkflowRun;
 }
-type TaskStateAwaitingRetryRequest = DistributiveOmit<TaskStateAwaitingRetry, "nextAttemptAt"> & {
-    nextAttemptInMs: number;
-};
-type TaskStateRequest = Exclude<TaskState, {
-    status: "awaiting_retry";
-}> | TaskStateAwaitingRetryRequest;
-interface WorkflowRunTransitionTaskStateRequestV1 {
+type TransitionTaskStateToRunning = TransitionTaskStateToRunningCreate | TransitionTaskStateToRunningRetry;
+type WorkflowRunTransitionTaskStateRequestV1 = TransitionTaskStateToRunning | TransitionTaskStateToCompleted | TransitionTaskStateToFailed | TransitionTaskStateToAwaitingRetry;
+interface WorkflowRunTransitionTaskStateResponseV1 {
+    run: WorkflowRun;
+    taskId: string;
+}
+interface WorkflowRunSetTaskStateRequestNew {
+    type: "new";
     id: string;
-    taskPath: string;
-    taskState: TaskStateRequest;
-    expectedRevision: number;
+    taskName: string;
+    input: unknown;
+    reference?: {
+        id: string;
+    };
+    state: DistributiveOmit<TaskStateCompleted<unknown> | TaskStateFailed, "attempts">;
 }
-interface WorkflowRunTransitionTaskStateResponseV1 {
+interface WorkflowRunSetTaskStateRequestExisting {
+    type: "existing";
+    id: string;
+    taskId: string;
+    state: DistributiveOmit<TaskStateCompleted<unknown> | TaskStateFailed, "attempts">;
+}
+type WorkflowRunSetTaskStateRequestV1 = WorkflowRunSetTaskStateRequestNew | WorkflowRunSetTaskStateRequestExisting;
+interface WorkflowRunSetTaskStateResponseV1 {
     run: WorkflowRun;
 }
 interface WorkflowRunListTransitionsRequestV1 {
@@ -131,12 +148,18 @@ interface WorkflowRunListTransitionsResponseV1 {
 }
 interface WorkflowRunSendEventRequestV1 {
     id: string;
-    eventId: string;
+    eventName: string;
     data: unknown;
     options?: EventSendOptions;
 }
 interface WorkflowRunSendEventResponseV1 {
     run: WorkflowRun;
 }
+interface WorkflowRunMulticastEventRequestV1 {
+    ids: string[];
+    eventName: string;
+    data: unknown;
+    options?: EventSendOptions;
+}
 
-export type { TaskStateAwaitingRetryRequest, TaskStateRequest, WorkflowRunApi, WorkflowRunCreateRequestV1, WorkflowRunCreateResponseV1, WorkflowRunGetByIdRequestV1, WorkflowRunGetByIdResponseV1, WorkflowRunGetStateRequestV1, WorkflowRunGetStateResponseV1, WorkflowRunListItem, WorkflowRunListRequestV1, WorkflowRunListResponseV1, WorkflowRunListTransitionsRequestV1, WorkflowRunListTransitionsResponseV1, WorkflowRunSendEventRequestV1, WorkflowRunSendEventResponseV1, WorkflowRunStateAwaitingEventRequest, WorkflowRunStateAwaitingRetryRequest, WorkflowRunStateRequest, WorkflowRunStateScheduledRequest, WorkflowRunStateScheduledRequestOptimistic, WorkflowRunStateScheduledRequestPessimistic, WorkflowRunTransitionStateRequestOptimistic, WorkflowRunTransitionStateRequestPessimistic, WorkflowRunTransitionStateRequestV1, WorkflowRunTransitionStateResponseV1, WorkflowRunTransitionTaskStateRequestV1, WorkflowRunTransitionTaskStateResponseV1 };
+export type { TransitionTaskStateToRunning, WorkflowRunApi, WorkflowRunCreateRequestV1, WorkflowRunCreateResponseV1, WorkflowRunGetByIdRequestV1, WorkflowRunGetByIdResponseV1, WorkflowRunGetStateRequestV1, WorkflowRunGetStateResponseV1, WorkflowRunListItem, WorkflowRunListRequestV1, WorkflowRunListResponseV1, WorkflowRunListTransitionsRequestV1, WorkflowRunListTransitionsResponseV1, WorkflowRunMulticastEventRequestV1, WorkflowRunSendEventRequestV1, WorkflowRunSendEventResponseV1, WorkflowRunSetTaskStateRequestExisting, WorkflowRunSetTaskStateRequestNew, WorkflowRunSetTaskStateRequestV1, WorkflowRunSetTaskStateResponseV1, WorkflowRunStateAwaitingChildWorkflowRequest, WorkflowRunStateAwaitingEventRequest, WorkflowRunStateAwaitingRetryRequest, WorkflowRunStateRequest, WorkflowRunStateScheduledRequest, WorkflowRunStateScheduledRequestOptimistic, WorkflowRunStateScheduledRequestPessimistic, WorkflowRunTransitionStateRequestOptimistic, WorkflowRunTransitionStateRequestPessimistic, WorkflowRunTransitionStateRequestV1, WorkflowRunTransitionStateResponseV1, WorkflowRunTransitionTaskStateRequestV1, WorkflowRunTransitionTaskStateResponseV1 };

package/dist/workflow-run.d.ts

@@ -1,8 +1,8 @@
-import { SerializableError } from './error.js';
 import { EventQueue } from './event.js';
 import { RetryStrategy } from './retry.js';
-import { SleepState } from './sleep.js';
-import { TaskState } from './task.js';
+import { SerializableError } from './serializable.js';
+import { SleepQueue } from './sleep.js';
+import { TaskInfo, TaskState } from './task.js';
 import { TriggerStrategy } from './trigger.js';
 import './duration.js';
 import './utils.js';
@@ -10,19 +10,28 @@ import './utils.js';
 type WorkflowRunId = string & {
     _brand: "workflow_run_id";
 };
+type WorkflowRunPath = string & {
+    _brand: "workflow_run_path";
+};
 type WorkflowRunStatus = "scheduled" | "queued" | "running" | "paused" | "sleeping" | "awaiting_event" | "awaiting_retry" | "awaiting_child_workflow" | "cancelled" | "completed" | "failed";
-type TerminalWorkflowRunStatus = "cancelled" | "completed" | "failed";
+declare const terminalWorkflowRunStatuses: readonly ["cancelled", "completed", "failed"];
+type TerminalWorkflowRunStatus = (typeof terminalWorkflowRunStatuses)[number];
 type NonTerminalWorkflowRunStatus = Exclude<WorkflowRunStatus, TerminalWorkflowRunStatus>;
+declare function isTerminalWorkflowRunStatus(status: WorkflowRunStatus): status is TerminalWorkflowRunStatus;
+interface WorkflowReferenceOptions {
+    id: string;
+    onConflict?: "error" | "return_existing";
+}
 interface WorkflowOptions {
     retry?: RetryStrategy;
-    idempotencyKey?: string;
+    reference?: WorkflowReferenceOptions;
     trigger?: TriggerStrategy;
-    shardKey?: string;
+    shard?: string;
 }
 interface WorkflowRunStateBase {
     status: WorkflowRunStatus;
 }
-type WorkflowRunScheduledReason = "new" | "retry" | "task_retry" | "awake" | "resume" | "event";
+type WorkflowRunScheduledReason = "new" | "retry" | "task_retry" | "awake" | "awake_early" | "resume" | "event" | "child_workflow";
 interface WorkflowRunStateScheduledBase extends WorkflowRunStateBase {
     status: "scheduled";
     scheduledAt: number;
@@ -40,13 +49,19 @@ interface WorkflowRunStateScheduledByTaskRetry extends WorkflowRunStateScheduled
 interface WorkflowRunStateScheduledByAwake extends WorkflowRunStateScheduledBase {
     reason: "awake";
 }
+interface WorkflowRunStateScheduledByAwakeEarly extends WorkflowRunStateScheduledBase {
+    reason: "awake_early";
+}
 interface WorkflowRunStateScheduledByResume extends WorkflowRunStateScheduledBase {
     reason: "resume";
 }
 interface WorkflowRunStateScheduledByEvent extends WorkflowRunStateScheduledBase {
     reason: "event";
 }
-type WorkflowRunStateScheduled = WorkflowRunStateScheduledByNew | WorkflowRunStateScheduledByRetry | WorkflowRunStateScheduledByTaskRetry | WorkflowRunStateScheduledByAwake | WorkflowRunStateScheduledByResume | WorkflowRunStateScheduledByEvent;
+interface WorkflowRunStateScheduledByChildWorkflow extends WorkflowRunStateScheduledBase {
+    reason: "child_workflow";
+}
+type WorkflowRunStateScheduled = WorkflowRunStateScheduledByNew | WorkflowRunStateScheduledByRetry | WorkflowRunStateScheduledByTaskRetry | WorkflowRunStateScheduledByAwake | WorkflowRunStateScheduledByAwakeEarly | WorkflowRunStateScheduledByResume | WorkflowRunStateScheduledByEvent | WorkflowRunStateScheduledByChildWorkflow;
 interface WorkflowRunStateQueued extends WorkflowRunStateBase {
     status: "queued";
     reason: WorkflowRunScheduledReason;
@@ -59,12 +74,12 @@ interface WorkflowRunStatePaused extends WorkflowRunStateBase {
 }
 interface WorkflowRunStateSleeping extends WorkflowRunStateBase {
     status: "sleeping";
-    sleepPath: string;
+    sleepName: string;
     durationMs: number;
 }
 interface WorkflowRunStateAwaitingEvent extends WorkflowRunStateBase {
     status: "awaiting_event";
-    eventId: string;
+    eventName: string;
     timeoutAt?: number;
 }
 type WorkflowFailureCause = "task" | "child_workflow" | "self";
@@ -75,7 +90,7 @@ interface WorkflowRunStateAwaitingRetryBase extends WorkflowRunStateBase {
 }
 interface WorkflowRunStateAwaitingRetryCausedByTask extends WorkflowRunStateAwaitingRetryBase {
     cause: "task";
-    taskPath: string;
+    taskId: string;
 }
 interface WorkflowRunStateAwaitingRetryCausedByChildWorkflow extends WorkflowRunStateAwaitingRetryBase {
     cause: "child_workflow";
@@ -88,6 +103,9 @@ interface WorkflowRunStateAwaitingRetryCausedBySelf extends WorkflowRunStateAwai
 type WorkflowRunStateAwaitingRetry = WorkflowRunStateAwaitingRetryCausedByTask | WorkflowRunStateAwaitingRetryCausedByChildWorkflow | WorkflowRunStateAwaitingRetryCausedBySelf;
 interface WorkflowRunStateAwaitingChildWorkflow extends WorkflowRunStateBase {
     status: "awaiting_child_workflow";
+    childWorkflowRunId: string;
+    childWorkflowRunStatus: WorkflowRunStatus;
+    timeoutAt?: number;
 }
 interface WorkflowRunStateCancelled extends WorkflowRunStateBase {
     status: "cancelled";
@@ -103,7 +121,7 @@ interface WorkflowRunStateFailedBase extends WorkflowRunStateBase {
 }
 interface WorkflowRunStateFailedByTask extends WorkflowRunStateFailedBase {
     cause: "task";
-    taskPath: string;
+    taskId: string;
 }
 interface WorkflowRunStateFailedByChildWorkflow extends WorkflowRunStateFailedBase {
     cause: "child_workflow";
@@ -118,20 +136,38 @@ type WorkflowRunStateInComplete = WorkflowRunStateScheduled | WorkflowRunStateQu
 type WorkflowRunState<Output = unknown> = WorkflowRunStateInComplete | WorkflowRunStateCompleted<Output>;
 interface WorkflowRun<Input = unknown, Output = unknown> {
     id: string;
-    workflowId: string;
-    workflowVersionId: string;
+    name: string;
+    versionId: string;
     createdAt: number;
     revision: number;
     input: Input;
+    path: string;
     options: WorkflowOptions;
     attempts: number;
     state: WorkflowRunState<Output>;
-    tasksState: Record<string, TaskState>;
-    sleepsState: Record<string, SleepState>;
+    tasks: Record<string, TaskInfo>;
+    sleepsQueue: Record<string, SleepQueue>;
     eventsQueue: Record<string, EventQueue<unknown>>;
-    childWorkflowsRunState: Record<string, WorkflowRunState>;
+    childWorkflowRuns: Record<string, ChildWorkflowRunInfo>;
+    parentWorkflowRunId?: string;
+}
+interface ChildWorkflowRunInfo {
+    id: string;
+    inputHash: string;
+    statusWaitResults: ChildWorkflowWaitResult[];
+}
+type ChildWorkflowWaitResult = ChildWorkflowWaitResultCompleted | ChildWorkflowWaitResultTimeout;
+interface ChildWorkflowWaitResultCompleted {
+    status: "completed";
+    completedAt: number;
+    childWorkflowRunState: WorkflowRunState;
+}
+interface ChildWorkflowWaitResultTimeout {
+    status: "timeout";
+    timedOutAt: number;
 }
 interface WorkflowRunTransitionBase {
+    id: string;
     createdAt: number;
     type: "state" | "task_state";
 }
@@ -141,7 +177,7 @@ interface WorkflowRunStateTransition extends WorkflowRunTransitionBase {
 }
 interface WorkflowRunTaskStateTransition extends WorkflowRunTransitionBase {
     type: "task_state";
-    taskPath: string;
+    taskId: string;
     taskState: TaskState;
 }
 type WorkflowRunTransition = WorkflowRunStateTransition | WorkflowRunTaskStateTransition;
@@ -157,7 +193,12 @@ declare class WorkflowRunSuspendedError extends Error {
 declare class WorkflowRunFailedError extends Error {
     readonly id: WorkflowRunId;
     readonly attempts: number;
-    constructor(id: WorkflowRunId, attempts: number);
+    readonly reason?: string | undefined;
+    constructor(id: WorkflowRunId, attempts: number, reason?: string | undefined);
+}
+declare class WorkflowRunConflictError extends Error {
+    readonly id: WorkflowRunId;
+    constructor(id: WorkflowRunId);
 }
 
-export { type NonTerminalWorkflowRunStatus, type TerminalWorkflowRunStatus, type WorkflowFailureCause, type WorkflowOptions, type WorkflowRun, WorkflowRunFailedError, type WorkflowRunId, WorkflowRunNotExecutableError, type WorkflowRunScheduledReason, type WorkflowRunState, type WorkflowRunStateAwaitingChildWorkflow, type WorkflowRunStateAwaitingEvent, type WorkflowRunStateAwaitingRetry, type WorkflowRunStateAwaitingRetryBase, type WorkflowRunStateAwaitingRetryCausedByChildWorkflow, type WorkflowRunStateAwaitingRetryCausedBySelf, type WorkflowRunStateAwaitingRetryCausedByTask, type WorkflowRunStateCancelled, type WorkflowRunStateCompleted, type WorkflowRunStateFailed, type WorkflowRunStateFailedByChildWorkflow, type WorkflowRunStateFailedBySelf, type WorkflowRunStateFailedByTask, type WorkflowRunStateInComplete, type WorkflowRunStatePaused, type WorkflowRunStateQueued, type WorkflowRunStateRunning, type WorkflowRunStateScheduled, type WorkflowRunStateScheduledByAwake, type WorkflowRunStateScheduledByEvent, type WorkflowRunStateScheduledByNew, type WorkflowRunStateScheduledByResume, type WorkflowRunStateScheduledByRetry, type WorkflowRunStateScheduledByTaskRetry, type WorkflowRunStateSleeping, type WorkflowRunStateTransition, type WorkflowRunStatus, WorkflowRunSuspendedError, type WorkflowRunTaskStateTransition, type WorkflowRunTransition, type WorkflowRunTransitionBase };
+export { type ChildWorkflowRunInfo, type ChildWorkflowWaitResult, type ChildWorkflowWaitResultCompleted, type ChildWorkflowWaitResultTimeout, type NonTerminalWorkflowRunStatus, type TerminalWorkflowRunStatus, type WorkflowFailureCause, type WorkflowOptions, type WorkflowReferenceOptions, type WorkflowRun, WorkflowRunConflictError, WorkflowRunFailedError, type WorkflowRunId, WorkflowRunNotExecutableError, type WorkflowRunPath, type WorkflowRunScheduledReason, type WorkflowRunState, type WorkflowRunStateAwaitingChildWorkflow, type WorkflowRunStateAwaitingEvent, type WorkflowRunStateAwaitingRetry, type WorkflowRunStateAwaitingRetryBase, type WorkflowRunStateAwaitingRetryCausedByChildWorkflow, type WorkflowRunStateAwaitingRetryCausedBySelf, type WorkflowRunStateAwaitingRetryCausedByTask, type WorkflowRunStateCancelled, type WorkflowRunStateCompleted, type WorkflowRunStateFailed, type WorkflowRunStateFailedByChildWorkflow, type WorkflowRunStateFailedBySelf, type WorkflowRunStateFailedByTask, type WorkflowRunStateInComplete, type WorkflowRunStatePaused, type WorkflowRunStateQueued, type WorkflowRunStateRunning, type WorkflowRunStateScheduled, type WorkflowRunStateScheduledByAwake, type WorkflowRunStateScheduledByAwakeEarly, type WorkflowRunStateScheduledByChildWorkflow, type WorkflowRunStateScheduledByEvent, type WorkflowRunStateScheduledByNew, type WorkflowRunStateScheduledByResume, type WorkflowRunStateScheduledByRetry, type WorkflowRunStateScheduledByTaskRetry, type WorkflowRunStateSleeping, type WorkflowRunStateTransition, type WorkflowRunStatus, WorkflowRunSuspendedError, type WorkflowRunTaskStateTransition, type WorkflowRunTransition, type WorkflowRunTransitionBase, isTerminalWorkflowRunStatus };

package/dist/workflow-run.js

@@ -1,4 +1,13 @@
 // workflow-run.ts
+var terminalWorkflowRunStatuses = ["cancelled", "completed", "failed"];
+function isTerminalWorkflowRunStatus(status) {
+  for (const terminalStatus of terminalWorkflowRunStatuses) {
+    if (status === terminalStatus) {
+      return true;
+    }
+  }
+  return false;
+}
 var WorkflowRunNotExecutableError = class extends Error {
   constructor(id, status) {
     super(`Workflow ${id} is not executable while ${status}`);
@@ -15,15 +24,33 @@ var WorkflowRunSuspendedError = class extends Error {
   }
 };
 var WorkflowRunFailedError = class extends Error {
-  constructor(id, attempts) {
-    super(`Workflow ${id} failed after ${attempts} attempt(s)`);
-    this.id = id;
-    this.attempts = attempts;
+  constructor(id, attempts, reason) {
+    var __super = (...args) => {
+      super(...args);
+      this.id = id;
+      this.attempts = attempts;
+      this.reason = reason;
+      return this;
+    };
+    if (reason) {
+      __super(`Workflow ${id} failed after ${attempts} attempt(s): ${reason}`);
+    } else {
+      __super(`Workflow ${id} failed after ${attempts} attempt(s)`);
+    }
     this.name = "WorkflowRunFailedError";
   }
 };
+var WorkflowRunConflictError = class extends Error {
+  constructor(id) {
+    super(`Conflict while trying to update Workflow run ${id}`);
+    this.id = id;
+    this.name = "WorkflowRunConflictError";
+  }
+};
 export {
+  WorkflowRunConflictError,
   WorkflowRunFailedError,
   WorkflowRunNotExecutableError,
-  WorkflowRunSuspendedError
+  WorkflowRunSuspendedError,
+  isTerminalWorkflowRunStatus
 };

package/dist/workflow.d.ts

@@ -1,12 +1,12 @@
-type WorkflowId = string & {
-    _brand: "workflow_id";
+type WorkflowName = string & {
+    _brand: "workflow_name";
 };
 type WorkflowVersionId = string & {
     _brand: "workflow_version_id";
 };
 interface WorkflowMeta {
-    id: WorkflowId;
+    name: WorkflowName;
     versionId: WorkflowVersionId;
 }
 
-export type { WorkflowId, WorkflowMeta, WorkflowVersionId };
+export type { WorkflowMeta, WorkflowName, WorkflowVersionId };

package/package.json

@@ -1,37 +1,57 @@
 {
 	"name": "@aikirun/types",
-	"version": "0.6.0",
+	"version": "0.8.0",
 	"description": "Core type definitions for Aiki - including workflow, task, client, and trigger types",
 	"type": "module",
 	"exports": {
-		"./utils": {
-			"types": "./dist/utils.d.ts",
-			"import": "./dist/utils.js"
-		},
-		"./symbols": {
-			"types": "./dist/symbols.d.ts",
-			"import": "./dist/symbols.js"
+		"./client": {
+			"types": "./dist/client.d.ts",
+			"import": "./dist/client.js"
 		},
 		"./duration": {
 			"types": "./dist/duration.d.ts",
 			"import": "./dist/duration.js"
 		},
+		"./event": {
+			"types": "./dist/event.d.ts",
+			"import": "./dist/event.js"
+		},
 		"./retry": {
 			"types": "./dist/retry.d.ts",
 			"import": "./dist/retry.js"
 		},
-		"./error": {
-			"types": "./dist/error.d.ts",
-			"import": "./dist/error.js"
+		"./serializable": {
+			"types": "./dist/serializable.d.ts",
+			"import": "./dist/serializable.js"
 		},
-		"./client": {
-			"types": "./dist/client.d.ts",
-			"import": "./dist/client.js"
+		"./sleep": {
+			"types": "./dist/sleep.d.ts",
+			"import": "./dist/sleep.js"
+		},
+		"./symbols": {
+			"types": "./dist/symbols.d.ts",
+			"import": "./dist/symbols.js"
+		},
+		"./task": {
+			"types": "./dist/task.d.ts",
+			"import": "./dist/task.js"
 		},
 		"./trigger": {
 			"types": "./dist/trigger.d.ts",
 			"import": "./dist/trigger.js"
 		},
+		"./utils": {
+			"types": "./dist/utils.d.ts",
+			"import": "./dist/utils.js"
+		},
+		"./validator": {
+			"types": "./dist/validator.d.ts",
+			"import": "./dist/validator.js"
+		},
+		"./worker": {
+			"types": "./dist/worker.d.ts",
+			"import": "./dist/worker.js"
+		},
 		"./workflow": {
 			"types": "./dist/workflow.d.ts",
 			"import": "./dist/workflow.js"
@@ -43,18 +63,6 @@
 		"./workflow-run-api": {
 			"types": "./dist/workflow-run-api.d.ts",
 			"import": "./dist/workflow-run-api.js"
-		},
-		"./task": {
-			"types": "./dist/task.d.ts",
-			"import": "./dist/task.js"
-		},
-		"./sleep": {
-			"types": "./dist/sleep.d.ts",
-			"import": "./dist/sleep.js"
-		},
-		"./event": {
-			"types": "./dist/event.d.ts",
-			"import": "./dist/event.js"
 		}
 	},
 	"files": [

package/dist/error.d.ts

@@ -1,11 +0,0 @@
-type SerializableInput = null | string | number | boolean | {
-    [key: string]: SerializableInput;
-} | SerializableInput[];
-interface SerializableError {
-    message: string;
-    name: string;
-    stack?: string;
-    cause?: SerializableError;
-}
-
-export type { SerializableError, SerializableInput };