@aikirun/types 0.18.0 → 0.20.0

package/dist/client.d.ts

@@ -17,7 +17,7 @@ import './state-transition.js';
 interface ClientParams<AppContext = unknown> {
     url: string;
     apiKey?: string;
-    redis: RedisConfig;
+    redis?: RedisConfig;
     logger?: Logger;
     createContext?: (run: Readonly<WorkflowRun>) => AppContext | Promise<AppContext>;
 }
@@ -66,16 +66,10 @@ interface RedisConnection {
     getConnection: () => RedisClient;
     closeConnection: () => Promise<void>;
 }
-interface SubscriberMessageMeta {
-    stream: string;
-    messageId: string;
-    consumerGroup: string;
-}
 interface WorkflowRunBatch {
     data: {
         workflowRunId: WorkflowRunId;
     };
-    meta?: SubscriberMessageMeta;
 }
 type SubscriberDelayParams = {
     type: "polled";
@@ -92,34 +86,25 @@ interface ResolvedSubscriberStrategy {
     type: string;
     getNextDelay: (context: SubscriberDelayParams) => number;
     getNextBatch: (size: number) => Promise<WorkflowRunBatch[]>;
-    heartbeat?: (workflowRunId: WorkflowRunId, meta: SubscriberMessageMeta) => Promise<void>;
-    acknowledge?: (workerId: string, workflowRunId: WorkflowRunId, meta: SubscriberMessageMeta) => Promise<void>;
+    heartbeat?: (workflowRunId: WorkflowRunId) => Promise<void>;
+    acknowledge?: (workflowRunId: WorkflowRunId) => Promise<void>;
 }
-interface PollingSubscriberStrategy {
-    type: "polling";
+interface RedisStreamsSubscriberStrategy {
+    type: "redis";
     intervalMs?: number;
     maxRetryIntervalMs?: number;
     atCapacityIntervalMs?: number;
+    blockTimeMs?: number;
+    claimMinIdleTimeMs?: number;
 }
-interface AdaptivePollingSubscriberStrategy {
-    type: "adaptive_polling";
-    minPollIntervalMs?: number;
-    maxPollIntervalMs?: number;
-    backoffMultiplier?: number;
-    emptyPollThreshold?: number;
-    jitterFactor?: number;
-    successResetThreshold?: number;
-    atCapacityIntervalMs?: number;
-}
-interface RedisStreamsSubscriberStrategy {
-    type: "redis";
+interface DbSubscriberStrategy {
+    type: "db";
     intervalMs?: number;
     maxRetryIntervalMs?: number;
     atCapacityIntervalMs?: number;
-    blockTimeMs?: number;
     claimMinIdleTimeMs?: number;
 }
-type SubscriberStrategy = RedisStreamsSubscriberStrategy;
+type SubscriberStrategy = RedisStreamsSubscriberStrategy | DbSubscriberStrategy;
 interface SubscriberStrategyBuilder {
     init: (workerId: string, callbacks: StrategyCallbacks) => Promise<ResolvedSubscriberStrategy>;
 }
@@ -128,4 +113,4 @@ interface StrategyCallbacks {
     onStop?: () => Promise<void>;
 }
 
-export type { AdaptivePollingSubscriberStrategy, ApiClient, Client, ClientParams, Logger, PollingSubscriberStrategy, RedisClient, RedisConfig, RedisConnection, RedisStreamsSubscriberStrategy, ResolvedSubscriberStrategy, StrategyCallbacks, SubscriberDelayParams, SubscriberMessageMeta, SubscriberStrategy, SubscriberStrategyBuilder, WorkflowRunBatch };
+export type { ApiClient, Client, ClientParams, DbSubscriberStrategy, Logger, RedisClient, RedisConfig, RedisConnection, RedisStreamsSubscriberStrategy, ResolvedSubscriberStrategy, StrategyCallbacks, SubscriberDelayParams, SubscriberStrategy, SubscriberStrategyBuilder, WorkflowRunBatch };

package/dist/workflow-api.d.ts

@@ -18,6 +18,7 @@ interface WorkflowListRequestV1 {
     source: WorkflowSource;
     limit?: number;
     offset?: number;
+    namePrefix?: string;
     sort?: {
         field: "name" | "runCount" | "lastRunAt";
         order: "asc" | "desc";

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

@@ -1,6 +1,6 @@
 import { EventSendOptions } from './event.js';
 import { StateTransition } from './state-transition.js';
-import { TransitionTaskStateToRunningCreate, TransitionTaskStateToRunningRetry, TransitionTaskStateToCompleted, TransitionTaskStateToFailed, TransitionTaskStateToAwaitingRetry, TaskInfo, TaskStateCompleted, TaskStateFailed } from './task.js';
+import { TaskStatus, TransitionTaskStateToRunningCreate, TransitionTaskStateToRunningRetry, TransitionTaskStateToCompleted, TransitionTaskStateToFailed, TransitionTaskStateToAwaitingRetry, TaskInfo, TaskStateCompleted, TaskStateFailed } from './task.js';
 import { DistributiveOmit, OptionalProp } from './utils.js';
 import { WorkflowSource } from './workflow.js';
 import { WorkflowRunStatus, WorkflowRun, WorkflowRunState, WorkflowStartOptions, WorkflowRunStateScheduled, WorkflowRunStateSleeping, WorkflowRunStateAwaitingEvent, WorkflowRunStateAwaitingRetry, WorkflowRunStateAwaitingChildWorkflow, WorkflowRunStateCompleted, WorkflowRunStatePaused, WorkflowRunStateCancelled } from './workflow-run.js';
@@ -25,12 +25,15 @@ interface WorkflowRunApi {
     multicastEventByReferenceV1: (_: WorkflowRunMulticastEventByReferenceRequestV1) => Promise<void>;
     listChildRunsV1: (_: WorkflowRunListChildRunsRequestV1) => Promise<WorkflowRunListChildRunsResponseV1>;
     cancelByIdsV1: (_: WorkflowRunCancelByIdsRequestV1) => Promise<WorkflowRunCancelByIdsResponseV1>;
+    claimReadyV1: (_: WorkflowRunClaimReadyRequestV1) => Promise<WorkflowRunClaimReadyResponseV1>;
+    heartbeatV1: (_: WorkflowRunHeartbeatRequestV1) => Promise<void>;
 }
 interface WorkflowRunListRequestV1 {
     limit?: number;
     offset?: number;
     filters?: {
         id?: string;
+        scheduleId?: string;
         status?: WorkflowRunStatus[];
         workflow?: WorkflowFilter;
     };
@@ -58,6 +61,7 @@ interface WorkflowRunListItem {
     createdAt: number;
     status: WorkflowRunStatus;
     referenceId?: string;
+    taskCounts?: Record<TaskStatus, number>;
 }
 interface WorkflowRunListResponseV1 {
     runs: WorkflowRunListItem[];
@@ -208,5 +212,23 @@ interface WorkflowRunCancelByIdsRequestV1 {
 interface WorkflowRunCancelByIdsResponseV1 {
     cancelledIds: string[];
 }
+interface WorkflowRunClaimReadyRequestV1 {
+    workerId: string;
+    workflows: Array<{
+        name: string;
+        versionId: string;
+        shard?: string;
+    }>;
+    limit: number;
+    claimMinIdleTimeMs: number;
+}
+interface WorkflowRunClaimReadyResponseV1 {
+    runs: Array<{
+        id: string;
+    }>;
+}
+interface WorkflowRunHeartbeatRequestV1 {
+    id: string;
+}
 
-export type { TransitionTaskStateToRunning, WorkflowFilter, WorkflowRunApi, WorkflowRunCancelByIdsRequestV1, WorkflowRunCancelByIdsResponseV1, WorkflowRunCreateRequestV1, WorkflowRunCreateResponseV1, WorkflowRunGetByIdRequestV1, WorkflowRunGetByIdResponseV1, WorkflowRunGetByReferenceIdRequestV1, WorkflowRunGetByReferenceIdResponseV1, WorkflowRunGetStateRequestV1, WorkflowRunGetStateResponseV1, WorkflowRunListChildRunsRequestV1, WorkflowRunListChildRunsResponseV1, WorkflowRunListItem, WorkflowRunListRequestV1, WorkflowRunListResponseV1, WorkflowRunListTransitionsRequestV1, WorkflowRunListTransitionsResponseV1, WorkflowRunMulticastEventByReferenceRequestV1, WorkflowRunMulticastEventRequestV1, WorkflowRunReference, WorkflowRunSendEventRequestV1, WorkflowRunSetTaskStateRequestExisting, WorkflowRunSetTaskStateRequestNew, WorkflowRunSetTaskStateRequestV1, WorkflowRunStateAwaitingChildWorkflowRequest, WorkflowRunStateAwaitingEventRequest, WorkflowRunStateAwaitingRetryRequest, WorkflowRunStateCompletedRequest, WorkflowRunStateRequest, WorkflowRunStateScheduledRequest, WorkflowRunStateScheduledRequestOptimistic, WorkflowRunStateScheduledRequestPessimistic, WorkflowRunStateSleepingRequest, WorkflowRunTransitionStateRequestOptimistic, WorkflowRunTransitionStateRequestPessimistic, WorkflowRunTransitionStateRequestV1, WorkflowRunTransitionStateResponseV1, WorkflowRunTransitionTaskStateRequestV1, WorkflowRunTransitionTaskStateResponseV1 };
+export type { TransitionTaskStateToRunning, WorkflowFilter, WorkflowRunApi, WorkflowRunCancelByIdsRequestV1, WorkflowRunCancelByIdsResponseV1, WorkflowRunClaimReadyRequestV1, WorkflowRunClaimReadyResponseV1, WorkflowRunCreateRequestV1, WorkflowRunCreateResponseV1, WorkflowRunGetByIdRequestV1, WorkflowRunGetByIdResponseV1, WorkflowRunGetByReferenceIdRequestV1, WorkflowRunGetByReferenceIdResponseV1, WorkflowRunGetStateRequestV1, WorkflowRunGetStateResponseV1, WorkflowRunHeartbeatRequestV1, WorkflowRunListChildRunsRequestV1, WorkflowRunListChildRunsResponseV1, WorkflowRunListItem, WorkflowRunListRequestV1, WorkflowRunListResponseV1, WorkflowRunListTransitionsRequestV1, WorkflowRunListTransitionsResponseV1, WorkflowRunMulticastEventByReferenceRequestV1, WorkflowRunMulticastEventRequestV1, WorkflowRunReference, WorkflowRunSendEventRequestV1, WorkflowRunSetTaskStateRequestExisting, WorkflowRunSetTaskStateRequestNew, WorkflowRunSetTaskStateRequestV1, WorkflowRunStateAwaitingChildWorkflowRequest, WorkflowRunStateAwaitingEventRequest, WorkflowRunStateAwaitingRetryRequest, WorkflowRunStateCompletedRequest, WorkflowRunStateRequest, WorkflowRunStateScheduledRequest, WorkflowRunStateScheduledRequestOptimistic, WorkflowRunStateScheduledRequestPessimistic, WorkflowRunStateSleepingRequest, WorkflowRunTransitionStateRequestOptimistic, WorkflowRunTransitionStateRequestPessimistic, WorkflowRunTransitionStateRequestV1, WorkflowRunTransitionStateResponseV1, WorkflowRunTransitionTaskStateRequestV1, WorkflowRunTransitionTaskStateResponseV1 };

package/package.json

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