@aikirun/types 0.14.0 → 0.16.0

package/dist/client.d.ts

@@ -1,7 +1,9 @@
+import { ScheduleApi } from './schedule-api.js';
 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 './schedule.js';
 import './event.js';
 import './duration.js';
 import './utils.js';
@@ -39,6 +41,7 @@ interface Logger {
 }
 interface ApiClient {
     workflowRun: WorkflowRunApi;
+    schedule: ScheduleApi;
 }
 interface RedisClient {
     xclaim(...args: unknown[]): Promise<unknown>;

package/dist/schedule-api.d.ts

@@ -0,0 +1,68 @@
+import { ScheduleSpec, ScheduleActivateOptions, Schedule, ScheduleStatus } from './schedule.js';
+
+interface ScheduleApi {
+    activateV1: (_: ScheduleActivateRequestV1) => Promise<ScheduleActivateResponseV1>;
+    getByIdV1: (_: ScheduleGetByIdRequestV1) => Promise<ScheduleGetByIdResponseV1>;
+    getByReferenceIdV1: (_: ScheduleGetByReferenceIdRequestV1) => Promise<ScheduleGetByReferenceIdResponseV1>;
+    listV1: (_: ScheduleListRequestV1) => Promise<ScheduleListResponseV1>;
+    pauseV1: (_: SchedulePauseRequestV1) => Promise<SchedulePauseResponseV1>;
+    resumeV1: (_: ScheduleResumeRequestV1) => Promise<ScheduleResumeResponseV1>;
+    deleteV1: (_: ScheduleDeleteRequestV1) => Promise<void>;
+}
+interface ScheduleActivateRequestV1 {
+    workflowName: string;
+    workflowVersionId: string;
+    input?: unknown;
+    spec: ScheduleSpec;
+    options?: ScheduleActivateOptions;
+}
+interface ScheduleActivateResponseV1 {
+    schedule: Schedule;
+}
+interface ScheduleGetByIdRequestV1 {
+    id: string;
+}
+interface ScheduleGetByIdResponseV1 {
+    schedule: Schedule;
+}
+interface ScheduleGetByReferenceIdRequestV1 {
+    referenceId: string;
+}
+interface ScheduleGetByReferenceIdResponseV1 {
+    schedule: Schedule;
+}
+interface ScheduleWorkflowFilter {
+    name?: string;
+    versionId?: string;
+}
+interface ScheduleListRequestV1 {
+    limit?: number;
+    offset?: number;
+    filters?: {
+        status?: ScheduleStatus[];
+        id?: string;
+        referenceId?: string;
+        workflows?: ScheduleWorkflowFilter[];
+    };
+}
+interface ScheduleListResponseV1 {
+    schedules: Schedule[];
+    total: number;
+}
+interface SchedulePauseRequestV1 {
+    id: string;
+}
+interface SchedulePauseResponseV1 {
+    schedule: Schedule;
+}
+interface ScheduleResumeRequestV1 {
+    id: string;
+}
+interface ScheduleResumeResponseV1 {
+    schedule: Schedule;
+}
+interface ScheduleDeleteRequestV1 {
+    id: string;
+}
+
+export type { ScheduleActivateRequestV1, ScheduleActivateResponseV1, ScheduleApi, ScheduleDeleteRequestV1, ScheduleGetByIdRequestV1, ScheduleGetByIdResponseV1, ScheduleGetByReferenceIdRequestV1, ScheduleGetByReferenceIdResponseV1, ScheduleListRequestV1, ScheduleListResponseV1, SchedulePauseRequestV1, SchedulePauseResponseV1, ScheduleResumeRequestV1, ScheduleResumeResponseV1, ScheduleWorkflowFilter };

package/dist/schedule.d.ts

@@ -0,0 +1,40 @@
+type ScheduleId = string & {
+    _brand: "schedule_id";
+};
+type OverlapPolicy = "allow" | "skip" | "cancel_previous";
+interface ScheduleReferenceOptions {
+    id: string;
+    conflictPolicy?: "upsert" | "error";
+}
+interface ScheduleActivateOptions {
+    reference?: ScheduleReferenceOptions;
+}
+interface CronScheduleSpec {
+    type: "cron";
+    expression: string;
+    timezone?: string;
+    overlapPolicy?: OverlapPolicy;
+}
+interface IntervalScheduleSpec {
+    type: "interval";
+    everyMs: number;
+    overlapPolicy?: OverlapPolicy;
+}
+type ScheduleSpec = CronScheduleSpec | IntervalScheduleSpec;
+type ScheduleStatus = "active" | "paused" | "deleted";
+interface Schedule {
+    id: string;
+    workflowName: string;
+    workflowVersionId: string;
+    input?: unknown;
+    spec: ScheduleSpec;
+    status: ScheduleStatus;
+    options?: ScheduleActivateOptions;
+    createdAt: number;
+    updatedAt: number;
+    lastOccurrence?: number;
+    nextRunAt: number;
+    runCount: number;
+}
+
+export type { CronScheduleSpec, IntervalScheduleSpec, OverlapPolicy, Schedule, ScheduleActivateOptions, ScheduleId, ScheduleReferenceOptions, ScheduleSpec, ScheduleStatus };

package/dist/task.d.ts

@@ -8,17 +8,19 @@ type TaskId = string & {
 type TaskName = string & {
     _brand: "task_name";
 };
-type TaskPath = string & {
-    _brand: "task_path";
+type TaskAddress = string & {
+    _brand: "task_address";
 };
 type TaskStatus = "running" | "awaiting_retry" | "completed" | "failed";
-interface TaskOptions {
+interface TaskDefinitionOptions {
     retry?: RetryStrategy;
+}
+interface TaskStartOptions extends TaskDefinitionOptions {
     reference?: TaskReferenceOptions;
 }
 interface TaskReferenceOptions {
     id: string;
-    onConflict?: "error" | "return_existing";
+    conflictPolicy?: "error" | "return_existing";
 }
 interface TaskStateBase {
     status: TaskStatus;
@@ -58,13 +60,13 @@ interface TransitionTaskStateBase {
 interface TransitionTaskStateToRunningCreate extends TransitionTaskStateBase {
     type: "create";
     taskName: string;
-    options?: TaskOptions;
+    options?: TaskStartOptions;
     taskState: TaskStateRunningRequest;
 }
 interface TransitionTaskStateToRunningRetry extends TransitionTaskStateBase {
     type: "retry";
     taskId: string;
-    options?: TaskOptions;
+    options?: TaskStartOptions;
     taskState: TaskStateRunningRequest;
 }
 type TaskStateRunningRequest = OptionalProp<TaskStateRunning<unknown>, "input">;
@@ -91,4 +93,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 TaskStateCompletedRequest, type TaskStateFailed, type TaskStateRunning, type TaskStateRunningRequest, type TaskStatus, type TransitionTaskStateBase, type TransitionTaskStateToAwaitingRetry, type TransitionTaskStateToCompleted, type TransitionTaskStateToFailed, type TransitionTaskStateToRunningCreate, type TransitionTaskStateToRunningRetry };
+export { type TaskAddress, type TaskDefinitionOptions, TaskFailedError, type TaskId, type TaskInfo, type TaskName, type TaskReferenceOptions, type TaskStartOptions, 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/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, OptionalProp } from './utils.js';
-import { WorkflowRunStatus, WorkflowRun, WorkflowRunState, WorkflowOptions, WorkflowRunStateScheduled, WorkflowRunStateAwaitingEvent, WorkflowRunStateAwaitingRetry, WorkflowRunStateAwaitingChildWorkflow, WorkflowRunStateCompleted, WorkflowRunStatePaused, WorkflowRunStateCancelled, WorkflowRunTransition } from './workflow-run.js';
+import { WorkflowRunStatus, WorkflowRun, WorkflowRunState, WorkflowStartOptions, WorkflowRunStateScheduled, WorkflowRunStateAwaitingEvent, WorkflowRunStateAwaitingRetry, WorkflowRunStateAwaitingChildWorkflow, WorkflowRunStateCompleted, WorkflowRunStatePaused, WorkflowRunStateCancelled, WorkflowRunTransition } from './workflow-run.js';
 import './duration.js';
 import './retry.js';
 import './serializable.js';
@@ -76,7 +76,7 @@ interface WorkflowRunCreateRequestV1 {
     versionId: string;
     input?: unknown;
     parentWorkflowRunId?: string;
-    options?: WorkflowOptions;
+    options?: WorkflowStartOptions;
 }
 interface WorkflowRunCreateResponseV1 {
     run: WorkflowRun;

package/dist/workflow-run.d.ts

@@ -10,8 +10,8 @@ import './utils.js';
 type WorkflowRunId = string & {
     _brand: "workflow_run_id";
 };
-type WorkflowRunPath = string & {
-    _brand: "workflow_run_path";
+type WorkflowRunAddress = string & {
+    _brand: "workflow_run_address";
 };
 type WorkflowRunStatus = "scheduled" | "queued" | "running" | "paused" | "sleeping" | "awaiting_event" | "awaiting_retry" | "awaiting_child_workflow" | "cancelled" | "completed" | "failed";
 declare const terminalWorkflowRunStatuses: readonly ["cancelled", "completed", "failed"];
@@ -20,12 +20,14 @@ type NonTerminalWorkflowRunStatus = Exclude<WorkflowRunStatus, TerminalWorkflowR
 declare function isTerminalWorkflowRunStatus(status: WorkflowRunStatus): status is TerminalWorkflowRunStatus;
 interface WorkflowReferenceOptions {
     id: string;
-    onConflict?: "error" | "return_existing";
+    conflictPolicy?: "error" | "return_existing";
 }
-interface WorkflowOptions {
+interface WorkflowDefinitionOptions {
     retry?: RetryStrategy;
-    reference?: WorkflowReferenceOptions;
     trigger?: TriggerStrategy;
+}
+interface WorkflowStartOptions extends WorkflowDefinitionOptions {
+    reference?: WorkflowReferenceOptions;
     shard?: string;
 }
 interface WorkflowRunStateBase {
@@ -141,8 +143,9 @@ interface WorkflowRun<Input = unknown, Output = unknown> {
     createdAt: number;
     revision: number;
     input?: Input;
-    path: string;
-    options: WorkflowOptions;
+    inputHash: string;
+    address: string;
+    options: WorkflowStartOptions;
     attempts: number;
     state: WorkflowRunState<Output>;
     tasks: Record<string, TaskInfo>;
@@ -198,9 +201,9 @@ declare class WorkflowRunFailedError extends Error {
     readonly reason?: string;
     constructor(id: WorkflowRunId, attempts: number, reason?: string);
 }
-declare class WorkflowRunConflictError extends Error {
+declare class WorkflowRunRevisionConflictError 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 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 };
+export { type ChildWorkflowRunInfo, type ChildWorkflowWaitResult, type ChildWorkflowWaitResultCompleted, type ChildWorkflowWaitResultTimeout, type NonTerminalWorkflowRunStatus, type TerminalWorkflowRunStatus, type WorkflowDefinitionOptions, type WorkflowFailureCause, type WorkflowReferenceOptions, type WorkflowRun, type WorkflowRunAddress, WorkflowRunFailedError, type WorkflowRunId, WorkflowRunNotExecutableError, WorkflowRunRevisionConflictError, 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, type WorkflowStartOptions, isTerminalWorkflowRunStatus };

package/dist/workflow-run.js

@@ -39,18 +39,18 @@ var WorkflowRunFailedError = class extends Error {
     this.reason = reason;
   }
 };
-var WorkflowRunConflictError = class extends Error {
+var WorkflowRunRevisionConflictError = class extends Error {
   id;
   constructor(id) {
     super(`Conflict while trying to update Workflow run ${id}`);
-    this.name = "WorkflowRunConflictError";
+    this.name = "WorkflowRunRevisionConflictError";
     this.id = id;
   }
 };
 export {
-  WorkflowRunConflictError,
   WorkflowRunFailedError,
   WorkflowRunNotExecutableError,
+  WorkflowRunRevisionConflictError,
   WorkflowRunSuspendedError,
   isTerminalWorkflowRunStatus
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@aikirun/types",
-	"version": "0.14.0",
+	"version": "0.16.0",
 	"description": "Core type definitions for Aiki - including workflow, task, client, and trigger types",
 	"type": "module",
 	"exports": {
@@ -20,6 +20,14 @@
 			"types": "./dist/retry.d.ts",
 			"import": "./dist/retry.js"
 		},
+		"./schedule": {
+			"types": "./dist/schedule.d.ts",
+			"import": "./dist/schedule.js"
+		},
+		"./schedule-api": {
+			"types": "./dist/schedule-api.d.ts",
+			"import": "./dist/schedule-api.js"
+		},
 		"./serializable": {
 			"types": "./dist/serializable.d.ts",
 			"import": "./dist/serializable.js"