@aikirun/types 0.9.2 → 0.10.0

package/dist/client.d.ts

@@ -30,11 +30,11 @@ interface Client<AppContext = unknown> {
     };
 }
 interface Logger {
-    info(message: string, metadata?: Record<string, unknown>): void;
+    trace(message: string, metadata?: Record<string, unknown>): void;
     debug(message: string, metadata?: Record<string, unknown>): void;
+    info(message: string, metadata?: Record<string, unknown>): void;
     warn(message: string, metadata?: Record<string, unknown>): void;
     error(message: string, metadata?: Record<string, unknown>): void;
-    trace(message: string, metadata?: Record<string, unknown>): void;
     child(bindings: Record<string, unknown>): Logger;
 }
 interface ApiClient {
@@ -88,7 +88,7 @@ interface ResolvedSubscriberStrategy {
     getNextDelay: (context: SubscriberDelayParams) => number;
     getNextBatch: (size: number) => Promise<WorkflowRunBatch[]>;
     heartbeat?: (workflowRunId: WorkflowRunId, meta: SubscriberMessageMeta) => Promise<void>;
-    acknowledge?: (workflowRunId: WorkflowRunId, meta: SubscriberMessageMeta) => Promise<void>;
+    acknowledge?: (workerId: string, workflowRunId: WorkflowRunId, meta: SubscriberMessageMeta) => Promise<void>;
 }
 interface PollingSubscriberStrategy {
     type: "polling";

package/dist/event.d.ts

@@ -10,7 +10,7 @@ interface EventStateBase {
 }
 interface EventStateReceived<Data> extends EventStateBase {
     status: "received";
-    data: Data;
+    data?: Data;
     receivedAt: number;
     reference?: EventReferenceOptions;
 }

package/dist/task.d.ts

@@ -1,5 +1,6 @@
 import { RetryStrategy } from './retry.js';
 import { SerializableError } from './serializable.js';
+import { OptionalProp } from './utils.js';
 
 type TaskId = string & {
     _brand: "task_id";
@@ -58,18 +59,20 @@ interface TransitionTaskStateToRunningCreate extends TransitionTaskStateBase {
     type: "create";
     taskName: string;
     options?: TaskOptions;
-    taskState: TaskStateRunning<unknown>;
+    taskState: TaskStateRunningRequest;
 }
 interface TransitionTaskStateToRunningRetry extends TransitionTaskStateBase {
     type: "retry";
     taskId: string;
     options?: TaskOptions;
-    taskState: TaskStateRunning<unknown>;
+    taskState: TaskStateRunningRequest;
 }
+type TaskStateRunningRequest = OptionalProp<TaskStateRunning<unknown>, "input">;
 interface TransitionTaskStateToCompleted extends TransitionTaskStateBase {
     taskId: string;
-    taskState: TaskStateCompleted<unknown>;
+    taskState: TaskStateCompletedRequest;
 }
+type TaskStateCompletedRequest = OptionalProp<TaskStateCompleted<unknown>, "output">;
 interface TransitionTaskStateToFailed extends TransitionTaskStateBase {
     taskId: string;
     taskState: TaskStateFailed;
@@ -88,4 +91,4 @@ declare class TaskFailedError extends Error {
     constructor(taskId: TaskId, attempts: number, reason: string);
 }
 
-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 };
+export { TaskFailedError, type TaskId, type TaskInfo, type TaskName, type TaskOptions, type TaskPath, type TaskReferenceOptions, type TaskState, type TaskStateAwaitingRetry, type TaskStateAwaitingRetryRequest, type TaskStateCompleted, type TaskStateCompletedRequest, type TaskStateFailed, type TaskStateRunning, type TaskStateRunningRequest, type TaskStatus, type TransitionTaskStateBase, type TransitionTaskStateToAwaitingRetry, type TransitionTaskStateToCompleted, type TransitionTaskStateToFailed, type TransitionTaskStateToRunningCreate, type TransitionTaskStateToRunningRetry };

package/dist/task.js

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

package/dist/trigger.d.ts

@@ -9,9 +9,6 @@ type TriggerStrategy = {
 } | {
     type: "delayed";
     delay: DurationObject;
-} | {
-    type: "startAt";
-    startAt: number;
 };
 
 export type { TriggerStrategy };

package/dist/utils.d.ts

@@ -2,5 +2,8 @@ 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;
+type OptionalProp<T, K extends keyof T> = Omit<T, K> & {
+    [Key in K]?: T[Key];
+};
 
-export type { DistributiveOmit, RequireAtLeastOneProp };
+export type { DistributiveOmit, OptionalProp, RequireAtLeastOneProp };

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

@@ -1,7 +1,7 @@
 import { EventSendOptions } from './event.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, WorkflowRunStateAwaitingChildWorkflow, WorkflowRunStatePaused, WorkflowRunStateCancelled, WorkflowRunTransition } from './workflow-run.js';
+import { DistributiveOmit, OptionalProp } from './utils.js';
+import { WorkflowRunStatus, WorkflowRun, WorkflowRunState, WorkflowOptions, WorkflowRunStateScheduled, WorkflowRunStateAwaitingEvent, WorkflowRunStateAwaitingRetry, WorkflowRunStateAwaitingChildWorkflow, WorkflowRunStateCompleted, WorkflowRunStatePaused, WorkflowRunStateCancelled, WorkflowRunTransition } from './workflow-run.js';
 import './duration.js';
 import './retry.js';
 import './serializable.js';
@@ -61,7 +61,7 @@ interface WorkflowRunGetStateResponseV1 {
 interface WorkflowRunCreateRequestV1 {
     name: string;
     versionId: string;
-    input: unknown;
+    input?: unknown;
     parentWorkflowRunId?: string;
     options?: WorkflowOptions;
 }
@@ -80,9 +80,10 @@ type WorkflowRunStateAwaitingRetryRequest = DistributiveOmit<WorkflowRunStateAwa
 type WorkflowRunStateAwaitingChildWorkflowRequest = DistributiveOmit<WorkflowRunStateAwaitingChildWorkflow, "timeoutAt"> & {
     timeoutInMs?: number;
 };
+type WorkflowRunStateCompletedRequest = OptionalProp<WorkflowRunStateCompleted<unknown>, "output">;
 type WorkflowRunStateRequest = Exclude<WorkflowRunState, {
-    status: "scheduled" | "awaiting_event" | "awaiting_retry" | "awaiting_child_workflow";
-}> | WorkflowRunStateScheduledRequest | WorkflowRunStateAwaitingEventRequest | WorkflowRunStateAwaitingRetryRequest | WorkflowRunStateAwaitingChildWorkflowRequest;
+    status: "scheduled" | "awaiting_event" | "awaiting_retry" | "awaiting_child_workflow" | "completed";
+}> | WorkflowRunStateScheduledRequest | WorkflowRunStateAwaitingEventRequest | WorkflowRunStateAwaitingRetryRequest | WorkflowRunStateAwaitingChildWorkflowRequest | WorkflowRunStateCompletedRequest;
 interface WorkflowRunTransitionStateRequestBase {
     type: "optimistic" | "pessimistic";
     id: string;
@@ -91,7 +92,9 @@ interface WorkflowRunTransitionStateRequestBase {
 type WorkflowRunStateScheduledRequestOptimistic = Extract<WorkflowRunStateScheduledRequest, {
     reason: "retry" | "task_retry" | "awake" | "event" | "child_workflow";
 }>;
-type WorkflowRunStateScheduledRequestPessimistic = Exclude<WorkflowRunStateScheduledRequest, WorkflowRunStateScheduledRequestOptimistic>;
+type WorkflowRunStateScheduledRequestPessimistic = Extract<WorkflowRunStateScheduledRequest, {
+    reason: "new" | "awake_early" | "resume";
+}>;
 interface WorkflowRunTransitionStateRequestOptimistic extends WorkflowRunTransitionStateRequestBase {
     type: "optimistic";
     state: WorkflowRunStateScheduledRequestOptimistic | Exclude<WorkflowRunStateRequest, {
@@ -117,7 +120,7 @@ interface WorkflowRunSetTaskStateRequestNew {
     type: "new";
     id: string;
     taskName: string;
-    input: unknown;
+    input?: unknown;
     reference?: {
         id: string;
     };
@@ -149,7 +152,7 @@ interface WorkflowRunListTransitionsResponseV1 {
 interface WorkflowRunSendEventRequestV1 {
     id: string;
     eventName: string;
-    data: unknown;
+    data?: unknown;
     options?: EventSendOptions;
 }
 interface WorkflowRunSendEventResponseV1 {
@@ -158,8 +161,8 @@ interface WorkflowRunSendEventResponseV1 {
 interface WorkflowRunMulticastEventRequestV1 {
     ids: string[];
     eventName: string;
-    data: unknown;
+    data?: unknown;
     options?: EventSendOptions;
 }
 
-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 };
+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, WorkflowRunStateCompletedRequest, WorkflowRunStateRequest, WorkflowRunStateScheduledRequest, WorkflowRunStateScheduledRequestOptimistic, WorkflowRunStateScheduledRequestPessimistic, WorkflowRunTransitionStateRequestOptimistic, WorkflowRunTransitionStateRequestPessimistic, WorkflowRunTransitionStateRequestV1, WorkflowRunTransitionStateResponseV1, WorkflowRunTransitionTaskStateRequestV1, WorkflowRunTransitionTaskStateResponseV1 };

package/dist/workflow-run.d.ts

@@ -140,7 +140,7 @@ interface WorkflowRun<Input = unknown, Output = unknown> {
     versionId: string;
     createdAt: number;
     revision: number;
-    input: Input;
+    input?: Input;
     path: string;
     options: WorkflowOptions;
     attempts: number;
@@ -193,12 +193,12 @@ declare class WorkflowRunSuspendedError extends Error {
 declare class WorkflowRunFailedError extends Error {
     readonly id: WorkflowRunId;
     readonly attempts: number;
-    readonly reason?: string | undefined;
-    constructor(id: WorkflowRunId, attempts: number, reason?: string | undefined);
+    readonly reason?: string;
+    constructor(id: WorkflowRunId, attempts: number, reason?: string);
 }
 declare class WorkflowRunConflictError extends Error {
     readonly id: WorkflowRunId;
     constructor(id: WorkflowRunId);
 }
 
-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 };
+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 WorkflowRunStateScheduledBase, 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

@@ -9,42 +9,42 @@ function isTerminalWorkflowRunStatus(status) {
   return false;
 }
 var WorkflowRunNotExecutableError = class extends Error {
+  id;
+  status;
   constructor(id, status) {
     super(`Workflow ${id} is not executable while ${status}`);
+    this.name = "WorkflowRunNotExecutableError";
     this.id = id;
     this.status = status;
-    this.name = "WorkflowRunNotExecutableError";
   }
 };
 var WorkflowRunSuspendedError = class extends Error {
+  id;
   constructor(id) {
     super(`Workflow ${id} is suspended`);
-    this.id = id;
     this.name = "WorkflowRunSuspendedError";
+    this.id = id;
   }
 };
 var WorkflowRunFailedError = class extends Error {
+  id;
+  attempts;
+  reason;
   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)`);
-    }
+    const message = reason ? `Workflow ${id} failed after ${attempts} attempt(s): ${reason}` : `Workflow ${id} failed after ${attempts} attempt(s)`;
+    super(message);
     this.name = "WorkflowRunFailedError";
+    this.id = id;
+    this.attempts = attempts;
+    this.reason = reason;
   }
 };
 var WorkflowRunConflictError = class extends Error {
+  id;
   constructor(id) {
     super(`Conflict while trying to update Workflow run ${id}`);
-    this.id = id;
     this.name = "WorkflowRunConflictError";
+    this.id = id;
   }
 };
 export {

package/package.json

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