@aikirun/types 0.6.0 → 0.7.0

package/dist/error.d.ts

@@ -1,6 +1,6 @@
-type SerializableInput = null | string | number | boolean | {
-    [key: string]: SerializableInput;
-} | SerializableInput[];
+type Serializable = null | string | number | boolean | {
+    [key: string]: Serializable;
+} | Serializable[];
 interface SerializableError {
     message: string;
     name: string;
@@ -8,4 +8,4 @@ interface SerializableError {
     cause?: SerializableError;
 }
 
-export type { SerializableError, SerializableInput };
+export type { Serializable, SerializableError };

package/dist/event.d.ts

@@ -14,16 +14,16 @@ interface EventStateReceived<Data> extends EventStateBase {
     receivedAt: number;
     idempotencyKey?: string;
 }
-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;
@@ -37,4 +37,4 @@ interface EventSendOptions {
     idempotencyKey?: string;
 }
 
-export type { EventId, EventQueue, EventSendOptions, EventState, EventStateReceived, EventStateTimedOut, EventStatus, EventWaitOptions, EventWaitState };
+export type { EventId, EventQueue, EventSendOptions, EventState, EventStateReceived, EventStateTimeout, EventStatus, EventWaitOptions, EventWaitState };

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

@@ -1,7 +1,7 @@
 import { EventSendOptions } from './event.js';
 import { TaskState, TaskStateAwaitingRetry } 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';
@@ -17,6 +17,7 @@ interface WorkflowRunApi {
     transitionTaskStateV1: (input: WorkflowRunTransitionTaskStateRequestV1) => Promise<WorkflowRunTransitionTaskStateResponseV1>;
     listTransitionsV1: (input: WorkflowRunListTransitionsRequestV1) => Promise<WorkflowRunListTransitionsResponseV1>;
     sendEventV1: (input: WorkflowRunSendEventRequestV1) => Promise<WorkflowRunSendEventResponseV1>;
+    multicastEventV1: (input: WorkflowRunMulticastEventRequestV1) => Promise<void>;
 }
 interface WorkflowRunListRequestV1 {
     limit?: number;
@@ -60,6 +61,8 @@ interface WorkflowRunCreateRequestV1 {
     workflowId: string;
     workflowVersionId: string;
     input: unknown;
+    path?: string;
+    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" | "event" | "child_workflow";
 }>;
 type WorkflowRunStateScheduledRequestPessimistic = Exclude<WorkflowRunStateScheduledRequest, WorkflowRunStateScheduledRequestOptimistic>;
 interface WorkflowRunTransitionStateRequestOptimistic extends WorkflowRunTransitionStateRequestBase {
@@ -138,5 +144,11 @@ interface WorkflowRunSendEventRequestV1 {
 interface WorkflowRunSendEventResponseV1 {
     run: WorkflowRun;
 }
+interface WorkflowRunMulticastEventRequestV1 {
+    ids: string[];
+    eventId: 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 { TaskStateAwaitingRetryRequest, TaskStateRequest, WorkflowRunApi, WorkflowRunCreateRequestV1, WorkflowRunCreateResponseV1, WorkflowRunGetByIdRequestV1, WorkflowRunGetByIdResponseV1, WorkflowRunGetStateRequestV1, WorkflowRunGetStateResponseV1, WorkflowRunListItem, WorkflowRunListRequestV1, WorkflowRunListResponseV1, WorkflowRunListTransitionsRequestV1, WorkflowRunListTransitionsResponseV1, WorkflowRunMulticastEventRequestV1, WorkflowRunSendEventRequestV1, WorkflowRunSendEventResponseV1, WorkflowRunStateAwaitingChildWorkflowRequest, WorkflowRunStateAwaitingEventRequest, WorkflowRunStateAwaitingRetryRequest, WorkflowRunStateRequest, WorkflowRunStateScheduledRequest, WorkflowRunStateScheduledRequestOptimistic, WorkflowRunStateScheduledRequestPessimistic, WorkflowRunTransitionStateRequestOptimistic, WorkflowRunTransitionStateRequestPessimistic, WorkflowRunTransitionStateRequestV1, WorkflowRunTransitionStateResponseV1, WorkflowRunTransitionTaskStateRequestV1, WorkflowRunTransitionTaskStateResponseV1 };

package/dist/workflow-run.d.ts

@@ -10,9 +10,14 @@ 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 WorkflowOptions {
     retry?: RetryStrategy;
     idempotencyKey?: string;
@@ -22,7 +27,7 @@ interface WorkflowOptions {
 interface WorkflowRunStateBase {
     status: WorkflowRunStatus;
 }
-type WorkflowRunScheduledReason = "new" | "retry" | "task_retry" | "awake" | "resume" | "event";
+type WorkflowRunScheduledReason = "new" | "retry" | "task_retry" | "awake" | "resume" | "event" | "child_workflow";
 interface WorkflowRunStateScheduledBase extends WorkflowRunStateBase {
     status: "scheduled";
     scheduledAt: number;
@@ -46,7 +51,10 @@ interface WorkflowRunStateScheduledByResume extends WorkflowRunStateScheduledBas
 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 | WorkflowRunStateScheduledByResume | WorkflowRunStateScheduledByEvent | WorkflowRunStateScheduledByChildWorkflow;
 interface WorkflowRunStateQueued extends WorkflowRunStateBase {
     status: "queued";
     reason: WorkflowRunScheduledReason;
@@ -88,6 +96,9 @@ interface WorkflowRunStateAwaitingRetryCausedBySelf extends WorkflowRunStateAwai
 type WorkflowRunStateAwaitingRetry = WorkflowRunStateAwaitingRetryCausedByTask | WorkflowRunStateAwaitingRetryCausedByChildWorkflow | WorkflowRunStateAwaitingRetryCausedBySelf;
 interface WorkflowRunStateAwaitingChildWorkflow extends WorkflowRunStateBase {
     status: "awaiting_child_workflow";
+    childWorkflowRunPath: string;
+    childWorkflowRunStatus: WorkflowRunStatus;
+    timeoutAt?: number;
 }
 interface WorkflowRunStateCancelled extends WorkflowRunStateBase {
     status: "cancelled";
@@ -123,13 +134,29 @@ interface WorkflowRun<Input = unknown, Output = unknown> {
     createdAt: number;
     revision: number;
     input: Input;
+    path?: string;
     options: WorkflowOptions;
     attempts: number;
     state: WorkflowRunState<Output>;
     tasksState: Record<string, TaskState>;
     sleepsState: Record<string, SleepState>;
     eventsQueue: Record<string, EventQueue<unknown>>;
-    childWorkflowsRunState: Record<string, WorkflowRunState>;
+    childWorkflowRuns: Record<string, ChildWorkflowRun>;
+    parentWorkflowRunId?: string;
+}
+interface ChildWorkflowRun {
+    id: string;
+    statusWaitResults: ChildWorkflowWaitResult[];
+}
+type ChildWorkflowWaitResult = ChildWorkflowWaitResultCompleted | ChildWorkflowWaitResultTimeout;
+interface ChildWorkflowWaitResultCompleted {
+    status: "completed";
+    completedAt: number;
+    childWorkflowRunState: WorkflowRunState;
+}
+interface ChildWorkflowWaitResultTimeout {
+    status: "timeout";
+    timedOutAt: number;
 }
 interface WorkflowRunTransitionBase {
     createdAt: number;
@@ -160,4 +187,4 @@ declare class WorkflowRunFailedError extends Error {
     constructor(id: WorkflowRunId, attempts: number);
 }
 
-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 ChildWorkflowRun, type ChildWorkflowWaitResult, type ChildWorkflowWaitResultCompleted, type ChildWorkflowWaitResultTimeout, type NonTerminalWorkflowRunStatus, type TerminalWorkflowRunStatus, type WorkflowFailureCause, type WorkflowOptions, type WorkflowRun, 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 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}`);
@@ -25,5 +34,6 @@ var WorkflowRunFailedError = class extends Error {
 export {
   WorkflowRunFailedError,
   WorkflowRunNotExecutableError,
-  WorkflowRunSuspendedError
+  WorkflowRunSuspendedError,
+  isTerminalWorkflowRunStatus
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@aikirun/types",
-	"version": "0.6.0",
+	"version": "0.7.0",
 	"description": "Core type definitions for Aiki - including workflow, task, client, and trigger types",
 	"type": "module",
 	"exports": {