@aikirun/types 0.5.3 → 0.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client.d.ts +5 -4
- package/dist/event.d.ts +40 -0
- package/dist/event.js +0 -0
- package/dist/task.d.ts +10 -7
- package/dist/utils.d.ts +2 -1
- package/dist/workflow-run-api.d.ts +43 -12
- package/dist/workflow-run.d.ts +22 -32
- package/dist/workflow-run.js +6 -32
- package/package.json +5 -1
package/dist/client.d.ts
CHANGED
|
@@ -3,20 +3,21 @@ import { WorkflowRun, WorkflowRunId } from './workflow-run.js';
|
|
|
3
3
|
import { WorkflowRunApi } from './workflow-run-api.js';
|
|
4
4
|
import { INTERNAL } from './symbols.js';
|
|
5
5
|
import './error.js';
|
|
6
|
-
import './
|
|
7
|
-
import './sleep.js';
|
|
6
|
+
import './event.js';
|
|
8
7
|
import './duration.js';
|
|
9
8
|
import './utils.js';
|
|
9
|
+
import './retry.js';
|
|
10
|
+
import './sleep.js';
|
|
10
11
|
import './task.js';
|
|
11
12
|
import './trigger.js';
|
|
12
13
|
|
|
13
|
-
interface ClientParams<AppContext> {
|
|
14
|
+
interface ClientParams<AppContext = unknown> {
|
|
14
15
|
url: string;
|
|
15
16
|
redis: RedisConfig;
|
|
16
17
|
logger?: Logger;
|
|
17
18
|
contextFactory?: (run: Readonly<WorkflowRun>) => AppContext | Promise<AppContext>;
|
|
18
19
|
}
|
|
19
|
-
interface Client<AppContext> {
|
|
20
|
+
interface Client<AppContext = unknown> {
|
|
20
21
|
api: ApiClient;
|
|
21
22
|
logger: Logger;
|
|
22
23
|
close: () => Promise<void>;
|
package/dist/event.d.ts
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import { DurationObject } from './duration.js';
|
|
2
|
+
import './utils.js';
|
|
3
|
+
|
|
4
|
+
type EventId = string & {
|
|
5
|
+
_brand: "event_id";
|
|
6
|
+
};
|
|
7
|
+
type EventStatus = "received" | "timeout";
|
|
8
|
+
interface EventStateBase {
|
|
9
|
+
status: EventStatus;
|
|
10
|
+
}
|
|
11
|
+
interface EventStateReceived<Data> extends EventStateBase {
|
|
12
|
+
status: "received";
|
|
13
|
+
data: Data;
|
|
14
|
+
receivedAt: number;
|
|
15
|
+
idempotencyKey?: string;
|
|
16
|
+
}
|
|
17
|
+
interface EventStateTimedOut extends EventStateBase {
|
|
18
|
+
status: "timeout";
|
|
19
|
+
timedOutAt: number;
|
|
20
|
+
}
|
|
21
|
+
type EventState<Data> = EventStateReceived<Data> | EventStateTimedOut;
|
|
22
|
+
interface EventQueue<Data> {
|
|
23
|
+
events: EventState<Data>[];
|
|
24
|
+
}
|
|
25
|
+
interface EventWaitOptions<Timeout extends DurationObject | undefined> {
|
|
26
|
+
timeout?: Timeout;
|
|
27
|
+
}
|
|
28
|
+
type EventWaitState<Data, Timed extends boolean> = Timed extends false ? {
|
|
29
|
+
data: Data;
|
|
30
|
+
} : {
|
|
31
|
+
timeout: false;
|
|
32
|
+
data: Data;
|
|
33
|
+
} | {
|
|
34
|
+
timeout: true;
|
|
35
|
+
};
|
|
36
|
+
interface EventSendOptions {
|
|
37
|
+
idempotencyKey?: string;
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
export type { EventId, EventQueue, EventSendOptions, EventState, EventStateReceived, EventStateTimedOut, EventStatus, EventWaitOptions, EventWaitState };
|
package/dist/event.js
ADDED
|
File without changes
|
package/dist/task.d.ts
CHANGED
|
@@ -6,7 +6,7 @@ type TaskId = string & {
|
|
|
6
6
|
type TaskPath = string & {
|
|
7
7
|
_brand: "task_path";
|
|
8
8
|
};
|
|
9
|
-
type TaskStatus = "none" | "running" | "completed" | "failed";
|
|
9
|
+
type TaskStatus = "none" | "running" | "awaiting_retry" | "completed" | "failed";
|
|
10
10
|
interface TaskStateBase {
|
|
11
11
|
status: TaskStatus;
|
|
12
12
|
}
|
|
@@ -17,19 +17,22 @@ interface TaskStateRunning extends TaskStateBase {
|
|
|
17
17
|
status: "running";
|
|
18
18
|
attempts: number;
|
|
19
19
|
}
|
|
20
|
+
interface TaskStateAwaitingRetry extends TaskStateBase {
|
|
21
|
+
status: "awaiting_retry";
|
|
22
|
+
attempts: number;
|
|
23
|
+
error: SerializableError;
|
|
24
|
+
nextAttemptAt: number;
|
|
25
|
+
}
|
|
20
26
|
interface TaskStateCompleted<Output> extends TaskStateBase {
|
|
21
27
|
status: "completed";
|
|
22
28
|
output: Output;
|
|
23
29
|
}
|
|
24
30
|
interface TaskStateFailed extends TaskStateBase {
|
|
25
31
|
status: "failed";
|
|
26
|
-
reason: string;
|
|
27
32
|
attempts: number;
|
|
28
|
-
|
|
29
|
-
nextAttemptAt?: number;
|
|
30
|
-
error?: SerializableError;
|
|
33
|
+
error: SerializableError;
|
|
31
34
|
}
|
|
32
|
-
type TaskState<Output> = TaskStateNone | TaskStateRunning | TaskStateCompleted<Output> | TaskStateFailed;
|
|
35
|
+
type TaskState<Output = unknown> = TaskStateNone | TaskStateRunning | TaskStateAwaitingRetry | TaskStateCompleted<Output> | TaskStateFailed;
|
|
33
36
|
declare class TaskFailedError extends Error {
|
|
34
37
|
readonly taskPath: TaskPath;
|
|
35
38
|
readonly attempts: number;
|
|
@@ -37,4 +40,4 @@ declare class TaskFailedError extends Error {
|
|
|
37
40
|
constructor(taskPath: TaskPath, attempts: number, reason: string);
|
|
38
41
|
}
|
|
39
42
|
|
|
40
|
-
export { TaskFailedError, type TaskId, type TaskPath, type TaskState, type TaskStateCompleted, type TaskStateFailed, type TaskStateNone, type TaskStateRunning, type TaskStatus };
|
|
43
|
+
export { TaskFailedError, type TaskId, type TaskPath, type TaskState, type TaskStateAwaitingRetry, type TaskStateCompleted, type TaskStateFailed, type TaskStateNone, type TaskStateRunning, type TaskStatus };
|
package/dist/utils.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
type RequireAtLeastOneOf<T, Keys extends keyof T> = {
|
|
2
2
|
[K in Keys]-?: Required<Pick<T, K>> & Omit<T, K>;
|
|
3
3
|
}[Keys];
|
|
4
|
+
type DistributiveOmit<T, K extends keyof T> = T extends T ? Omit<T, K> : never;
|
|
4
5
|
|
|
5
|
-
export type { RequireAtLeastOneOf };
|
|
6
|
+
export type { DistributiveOmit, RequireAtLeastOneOf };
|
|
@@ -1,10 +1,11 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
1
|
+
import { EventSendOptions } from './event.js';
|
|
2
|
+
import { TaskState, TaskStateAwaitingRetry } from './task.js';
|
|
3
|
+
import { DistributiveOmit } from './utils.js';
|
|
4
|
+
import { WorkflowRunStatus, WorkflowRun, WorkflowRunState, WorkflowOptions, WorkflowRunStateScheduled, WorkflowRunStateAwaitingEvent, WorkflowRunStateAwaitingRetry, WorkflowRunStatePaused, WorkflowRunStateCancelled, WorkflowRunTransition } from './workflow-run.js';
|
|
5
|
+
import './duration.js';
|
|
3
6
|
import './error.js';
|
|
4
7
|
import './retry.js';
|
|
5
8
|
import './sleep.js';
|
|
6
|
-
import './duration.js';
|
|
7
|
-
import './utils.js';
|
|
8
9
|
import './trigger.js';
|
|
9
10
|
|
|
10
11
|
interface WorkflowRunApi {
|
|
@@ -15,6 +16,7 @@ interface WorkflowRunApi {
|
|
|
15
16
|
transitionStateV1: (input: WorkflowRunTransitionStateRequestV1) => Promise<WorkflowRunTransitionStateResponseV1>;
|
|
16
17
|
transitionTaskStateV1: (input: WorkflowRunTransitionTaskStateRequestV1) => Promise<WorkflowRunTransitionTaskStateResponseV1>;
|
|
17
18
|
listTransitionsV1: (input: WorkflowRunListTransitionsRequestV1) => Promise<WorkflowRunListTransitionsResponseV1>;
|
|
19
|
+
sendEventV1: (input: WorkflowRunSendEventRequestV1) => Promise<WorkflowRunSendEventResponseV1>;
|
|
18
20
|
}
|
|
19
21
|
interface WorkflowRunListRequestV1 {
|
|
20
22
|
limit?: number;
|
|
@@ -52,7 +54,7 @@ interface WorkflowRunGetStateRequestV1 {
|
|
|
52
54
|
id: string;
|
|
53
55
|
}
|
|
54
56
|
interface WorkflowRunGetStateResponseV1 {
|
|
55
|
-
state: WorkflowRunState
|
|
57
|
+
state: WorkflowRunState;
|
|
56
58
|
}
|
|
57
59
|
interface WorkflowRunCreateRequestV1 {
|
|
58
60
|
workflowId: string;
|
|
@@ -63,32 +65,52 @@ interface WorkflowRunCreateRequestV1 {
|
|
|
63
65
|
interface WorkflowRunCreateResponseV1 {
|
|
64
66
|
run: WorkflowRun;
|
|
65
67
|
}
|
|
68
|
+
type WorkflowRunStateScheduledRequest = DistributiveOmit<WorkflowRunStateScheduled, "scheduledAt"> & {
|
|
69
|
+
scheduledInMs: number;
|
|
70
|
+
};
|
|
71
|
+
type WorkflowRunStateAwaitingEventRequest = DistributiveOmit<WorkflowRunStateAwaitingEvent, "timeoutAt"> & {
|
|
72
|
+
timeoutInMs?: number;
|
|
73
|
+
};
|
|
74
|
+
type WorkflowRunStateAwaitingRetryRequest = DistributiveOmit<WorkflowRunStateAwaitingRetry, "nextAttemptAt"> & {
|
|
75
|
+
nextAttemptInMs: number;
|
|
76
|
+
};
|
|
77
|
+
type WorkflowRunStateRequest = Exclude<WorkflowRunState, {
|
|
78
|
+
status: "scheduled" | "awaiting_event" | "awaiting_retry";
|
|
79
|
+
}> | WorkflowRunStateScheduledRequest | WorkflowRunStateAwaitingEventRequest | WorkflowRunStateAwaitingRetryRequest;
|
|
66
80
|
interface WorkflowRunTransitionStateRequestBase {
|
|
67
81
|
type: "optimistic" | "pessimistic";
|
|
68
82
|
id: string;
|
|
69
|
-
state:
|
|
83
|
+
state: WorkflowRunStateRequest;
|
|
70
84
|
}
|
|
85
|
+
type WorkflowRunStateScheduledRequestOptimistic = Exclude<WorkflowRunStateScheduledRequest, {
|
|
86
|
+
reason: "new" | "resume";
|
|
87
|
+
}>;
|
|
88
|
+
type WorkflowRunStateScheduledRequestPessimistic = Exclude<WorkflowRunStateScheduledRequest, WorkflowRunStateScheduledRequestOptimistic>;
|
|
71
89
|
interface WorkflowRunTransitionStateRequestOptimistic extends WorkflowRunTransitionStateRequestBase {
|
|
72
90
|
type: "optimistic";
|
|
73
|
-
state: Exclude<
|
|
91
|
+
state: WorkflowRunStateScheduledRequestOptimistic | Exclude<WorkflowRunStateRequest, {
|
|
74
92
|
status: "scheduled" | "paused" | "cancelled";
|
|
75
|
-
}> | Exclude<WorkflowRunStateScheduled, {
|
|
76
|
-
reason: "new" | "resume";
|
|
77
93
|
}>;
|
|
78
94
|
expectedRevision: number;
|
|
79
95
|
}
|
|
80
96
|
interface WorkflowRunTransitionStateRequestPessimistic extends WorkflowRunTransitionStateRequestBase {
|
|
81
97
|
type: "pessimistic";
|
|
82
|
-
state:
|
|
98
|
+
state: WorkflowRunStateScheduledRequestPessimistic | WorkflowRunStatePaused | WorkflowRunStateCancelled;
|
|
83
99
|
}
|
|
84
100
|
type WorkflowRunTransitionStateRequestV1 = WorkflowRunTransitionStateRequestOptimistic | WorkflowRunTransitionStateRequestPessimistic;
|
|
85
101
|
interface WorkflowRunTransitionStateResponseV1 {
|
|
86
102
|
run: WorkflowRun;
|
|
87
103
|
}
|
|
104
|
+
type TaskStateAwaitingRetryRequest = DistributiveOmit<TaskStateAwaitingRetry, "nextAttemptAt"> & {
|
|
105
|
+
nextAttemptInMs: number;
|
|
106
|
+
};
|
|
107
|
+
type TaskStateRequest = Exclude<TaskState, {
|
|
108
|
+
status: "awaiting_retry";
|
|
109
|
+
}> | TaskStateAwaitingRetryRequest;
|
|
88
110
|
interface WorkflowRunTransitionTaskStateRequestV1 {
|
|
89
111
|
id: string;
|
|
90
112
|
taskPath: string;
|
|
91
|
-
taskState:
|
|
113
|
+
taskState: TaskStateRequest;
|
|
92
114
|
expectedRevision: number;
|
|
93
115
|
}
|
|
94
116
|
interface WorkflowRunTransitionTaskStateResponseV1 {
|
|
@@ -107,5 +129,14 @@ interface WorkflowRunListTransitionsResponseV1 {
|
|
|
107
129
|
transitions: WorkflowRunTransition[];
|
|
108
130
|
total: number;
|
|
109
131
|
}
|
|
132
|
+
interface WorkflowRunSendEventRequestV1 {
|
|
133
|
+
id: string;
|
|
134
|
+
eventId: string;
|
|
135
|
+
data: unknown;
|
|
136
|
+
options?: EventSendOptions;
|
|
137
|
+
}
|
|
138
|
+
interface WorkflowRunSendEventResponseV1 {
|
|
139
|
+
run: WorkflowRun;
|
|
140
|
+
}
|
|
110
141
|
|
|
111
|
-
export type { WorkflowRunApi, WorkflowRunCreateRequestV1, WorkflowRunCreateResponseV1, WorkflowRunGetByIdRequestV1, WorkflowRunGetByIdResponseV1, WorkflowRunGetStateRequestV1, WorkflowRunGetStateResponseV1, WorkflowRunListItem, WorkflowRunListRequestV1, WorkflowRunListResponseV1, WorkflowRunListTransitionsRequestV1, WorkflowRunListTransitionsResponseV1, WorkflowRunTransitionStateRequestV1, WorkflowRunTransitionStateResponseV1, WorkflowRunTransitionTaskStateRequestV1, WorkflowRunTransitionTaskStateResponseV1 };
|
|
142
|
+
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 };
|
package/dist/workflow-run.d.ts
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { SerializableError } from './error.js';
|
|
2
|
+
import { EventQueue } from './event.js';
|
|
2
3
|
import { RetryStrategy } from './retry.js';
|
|
3
4
|
import { SleepState } from './sleep.js';
|
|
4
5
|
import { TaskState } from './task.js';
|
|
@@ -21,7 +22,7 @@ interface WorkflowOptions {
|
|
|
21
22
|
interface WorkflowRunStateBase {
|
|
22
23
|
status: WorkflowRunStatus;
|
|
23
24
|
}
|
|
24
|
-
type WorkflowRunScheduledReason = "new" | "retry" | "awake" | "resume" | "event";
|
|
25
|
+
type WorkflowRunScheduledReason = "new" | "retry" | "task_retry" | "awake" | "resume" | "event";
|
|
25
26
|
interface WorkflowRunStateScheduledBase extends WorkflowRunStateBase {
|
|
26
27
|
status: "scheduled";
|
|
27
28
|
scheduledAt: number;
|
|
@@ -33,6 +34,9 @@ interface WorkflowRunStateScheduledByNew extends WorkflowRunStateScheduledBase {
|
|
|
33
34
|
interface WorkflowRunStateScheduledByRetry extends WorkflowRunStateScheduledBase {
|
|
34
35
|
reason: "retry";
|
|
35
36
|
}
|
|
37
|
+
interface WorkflowRunStateScheduledByTaskRetry extends WorkflowRunStateScheduledBase {
|
|
38
|
+
reason: "task_retry";
|
|
39
|
+
}
|
|
36
40
|
interface WorkflowRunStateScheduledByAwake extends WorkflowRunStateScheduledBase {
|
|
37
41
|
reason: "awake";
|
|
38
42
|
}
|
|
@@ -42,7 +46,7 @@ interface WorkflowRunStateScheduledByResume extends WorkflowRunStateScheduledBas
|
|
|
42
46
|
interface WorkflowRunStateScheduledByEvent extends WorkflowRunStateScheduledBase {
|
|
43
47
|
reason: "event";
|
|
44
48
|
}
|
|
45
|
-
type WorkflowRunStateScheduled = WorkflowRunStateScheduledByNew | WorkflowRunStateScheduledByRetry | WorkflowRunStateScheduledByAwake | WorkflowRunStateScheduledByResume | WorkflowRunStateScheduledByEvent;
|
|
49
|
+
type WorkflowRunStateScheduled = WorkflowRunStateScheduledByNew | WorkflowRunStateScheduledByRetry | WorkflowRunStateScheduledByTaskRetry | WorkflowRunStateScheduledByAwake | WorkflowRunStateScheduledByResume | WorkflowRunStateScheduledByEvent;
|
|
46
50
|
interface WorkflowRunStateQueued extends WorkflowRunStateBase {
|
|
47
51
|
status: "queued";
|
|
48
52
|
reason: WorkflowRunScheduledReason;
|
|
@@ -52,7 +56,6 @@ interface WorkflowRunStateRunning extends WorkflowRunStateBase {
|
|
|
52
56
|
}
|
|
53
57
|
interface WorkflowRunStatePaused extends WorkflowRunStateBase {
|
|
54
58
|
status: "paused";
|
|
55
|
-
pausedAt: number;
|
|
56
59
|
}
|
|
57
60
|
interface WorkflowRunStateSleeping extends WorkflowRunStateBase {
|
|
58
61
|
status: "sleeping";
|
|
@@ -61,23 +64,24 @@ interface WorkflowRunStateSleeping extends WorkflowRunStateBase {
|
|
|
61
64
|
}
|
|
62
65
|
interface WorkflowRunStateAwaitingEvent extends WorkflowRunStateBase {
|
|
63
66
|
status: "awaiting_event";
|
|
67
|
+
eventId: string;
|
|
68
|
+
timeoutAt?: number;
|
|
64
69
|
}
|
|
65
70
|
type WorkflowFailureCause = "task" | "child_workflow" | "self";
|
|
66
|
-
interface
|
|
71
|
+
interface WorkflowRunStateAwaitingRetryBase extends WorkflowRunStateBase {
|
|
67
72
|
status: "awaiting_retry";
|
|
68
73
|
cause: WorkflowFailureCause;
|
|
69
|
-
reason: string;
|
|
70
74
|
nextAttemptAt: number;
|
|
71
75
|
}
|
|
72
|
-
interface WorkflowRunStateAwaitingRetryCausedByTask extends
|
|
76
|
+
interface WorkflowRunStateAwaitingRetryCausedByTask extends WorkflowRunStateAwaitingRetryBase {
|
|
73
77
|
cause: "task";
|
|
74
78
|
taskPath: string;
|
|
75
79
|
}
|
|
76
|
-
interface WorkflowRunStateAwaitingRetryCausedByChildWorkflow extends
|
|
80
|
+
interface WorkflowRunStateAwaitingRetryCausedByChildWorkflow extends WorkflowRunStateAwaitingRetryBase {
|
|
77
81
|
cause: "child_workflow";
|
|
78
82
|
childWorkflowRunId: string;
|
|
79
83
|
}
|
|
80
|
-
interface WorkflowRunStateAwaitingRetryCausedBySelf extends
|
|
84
|
+
interface WorkflowRunStateAwaitingRetryCausedBySelf extends WorkflowRunStateAwaitingRetryBase {
|
|
81
85
|
cause: "self";
|
|
82
86
|
error: SerializableError;
|
|
83
87
|
}
|
|
@@ -96,7 +100,6 @@ interface WorkflowRunStateCompleted<Output> extends WorkflowRunStateBase {
|
|
|
96
100
|
interface WorkflowRunStateFailedBase extends WorkflowRunStateBase {
|
|
97
101
|
status: "failed";
|
|
98
102
|
cause: WorkflowFailureCause;
|
|
99
|
-
reason: string;
|
|
100
103
|
}
|
|
101
104
|
interface WorkflowRunStateFailedByTask extends WorkflowRunStateFailedBase {
|
|
102
105
|
cause: "task";
|
|
@@ -112,7 +115,7 @@ interface WorkflowRunStateFailedBySelf extends WorkflowRunStateFailedBase {
|
|
|
112
115
|
}
|
|
113
116
|
type WorkflowRunStateFailed = WorkflowRunStateFailedByTask | WorkflowRunStateFailedByChildWorkflow | WorkflowRunStateFailedBySelf;
|
|
114
117
|
type WorkflowRunStateInComplete = WorkflowRunStateScheduled | WorkflowRunStateQueued | WorkflowRunStateRunning | WorkflowRunStatePaused | WorkflowRunStateSleeping | WorkflowRunStateAwaitingEvent | WorkflowRunStateAwaitingRetry | WorkflowRunStateAwaitingChildWorkflow | WorkflowRunStateCancelled | WorkflowRunStateFailed;
|
|
115
|
-
type WorkflowRunState<Output> = WorkflowRunStateInComplete | WorkflowRunStateCompleted<Output>;
|
|
118
|
+
type WorkflowRunState<Output = unknown> = WorkflowRunStateInComplete | WorkflowRunStateCompleted<Output>;
|
|
116
119
|
interface WorkflowRun<Input = unknown, Output = unknown> {
|
|
117
120
|
id: string;
|
|
118
121
|
workflowId: string;
|
|
@@ -123,9 +126,10 @@ interface WorkflowRun<Input = unknown, Output = unknown> {
|
|
|
123
126
|
options: WorkflowOptions;
|
|
124
127
|
attempts: number;
|
|
125
128
|
state: WorkflowRunState<Output>;
|
|
126
|
-
tasksState: Record<string, TaskState
|
|
129
|
+
tasksState: Record<string, TaskState>;
|
|
127
130
|
sleepsState: Record<string, SleepState>;
|
|
128
|
-
|
|
131
|
+
eventsQueue: Record<string, EventQueue<unknown>>;
|
|
132
|
+
childWorkflowsRunState: Record<string, WorkflowRunState>;
|
|
129
133
|
}
|
|
130
134
|
interface WorkflowRunTransitionBase {
|
|
131
135
|
createdAt: number;
|
|
@@ -133,41 +137,27 @@ interface WorkflowRunTransitionBase {
|
|
|
133
137
|
}
|
|
134
138
|
interface WorkflowRunStateTransition extends WorkflowRunTransitionBase {
|
|
135
139
|
type: "state";
|
|
136
|
-
state: WorkflowRunState
|
|
140
|
+
state: WorkflowRunState;
|
|
137
141
|
}
|
|
138
142
|
interface WorkflowRunTaskStateTransition extends WorkflowRunTransitionBase {
|
|
139
143
|
type: "task_state";
|
|
140
144
|
taskPath: string;
|
|
141
|
-
taskState: TaskState
|
|
145
|
+
taskState: TaskState;
|
|
142
146
|
}
|
|
143
147
|
type WorkflowRunTransition = WorkflowRunStateTransition | WorkflowRunTaskStateTransition;
|
|
144
|
-
declare class WorkflowRunConflictError extends Error {
|
|
145
|
-
readonly id: WorkflowRunId;
|
|
146
|
-
readonly operation: string;
|
|
147
|
-
readonly attempts: number;
|
|
148
|
-
constructor(id: WorkflowRunId, operation: string, attempts: number);
|
|
149
|
-
}
|
|
150
148
|
declare class WorkflowRunNotExecutableError extends Error {
|
|
151
149
|
readonly id: WorkflowRunId;
|
|
152
150
|
readonly status: WorkflowRunStatus;
|
|
153
151
|
constructor(id: WorkflowRunId, status: WorkflowRunStatus);
|
|
154
152
|
}
|
|
155
|
-
declare class
|
|
156
|
-
|
|
157
|
-
}
|
|
158
|
-
declare class WorkflowRunCancelledError extends Error {
|
|
153
|
+
declare class WorkflowRunSuspendedError extends Error {
|
|
154
|
+
readonly id: WorkflowRunId;
|
|
159
155
|
constructor(id: WorkflowRunId);
|
|
160
156
|
}
|
|
161
157
|
declare class WorkflowRunFailedError extends Error {
|
|
162
158
|
readonly id: WorkflowRunId;
|
|
163
159
|
readonly attempts: number;
|
|
164
|
-
|
|
165
|
-
readonly failureCause?: WorkflowFailureCause | undefined;
|
|
166
|
-
constructor(id: WorkflowRunId, attempts: number, reason: string, failureCause?: WorkflowFailureCause | undefined);
|
|
167
|
-
}
|
|
168
|
-
declare class WorkflowRunSuspendedError extends Error {
|
|
169
|
-
readonly id: WorkflowRunId;
|
|
170
|
-
constructor(id: WorkflowRunId);
|
|
160
|
+
constructor(id: WorkflowRunId, attempts: number);
|
|
171
161
|
}
|
|
172
162
|
|
|
173
|
-
export { type NonTerminalWorkflowRunStatus, type TerminalWorkflowRunStatus, type WorkflowFailureCause, type WorkflowOptions, type WorkflowRun,
|
|
163
|
+
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 };
|
package/dist/workflow-run.js
CHANGED
|
@@ -1,13 +1,4 @@
|
|
|
1
1
|
// workflow-run.ts
|
|
2
|
-
var WorkflowRunConflictError = class extends Error {
|
|
3
|
-
constructor(id, operation, attempts) {
|
|
4
|
-
super(`Conflict while performing ${operation} on workflow ${id} after ${attempts} attempts`);
|
|
5
|
-
this.id = id;
|
|
6
|
-
this.operation = operation;
|
|
7
|
-
this.attempts = attempts;
|
|
8
|
-
this.name = "WorkflowRunConflictError";
|
|
9
|
-
}
|
|
10
|
-
};
|
|
11
2
|
var WorkflowRunNotExecutableError = class extends Error {
|
|
12
3
|
constructor(id, status) {
|
|
13
4
|
super(`Workflow ${id} is not executable while ${status}`);
|
|
@@ -16,40 +7,23 @@ var WorkflowRunNotExecutableError = class extends Error {
|
|
|
16
7
|
this.name = "WorkflowRunNotExecutableError";
|
|
17
8
|
}
|
|
18
9
|
};
|
|
19
|
-
var
|
|
20
|
-
constructor(id) {
|
|
21
|
-
super(`Workflow ${id} paused`);
|
|
22
|
-
this.name = "WorkflowRunPausedError";
|
|
23
|
-
}
|
|
24
|
-
};
|
|
25
|
-
var WorkflowRunCancelledError = class extends Error {
|
|
10
|
+
var WorkflowRunSuspendedError = class extends Error {
|
|
26
11
|
constructor(id) {
|
|
27
|
-
super(`Workflow ${id}
|
|
28
|
-
this.
|
|
12
|
+
super(`Workflow ${id} is suspended`);
|
|
13
|
+
this.id = id;
|
|
14
|
+
this.name = "WorkflowRunSuspendedError";
|
|
29
15
|
}
|
|
30
16
|
};
|
|
31
17
|
var WorkflowRunFailedError = class extends Error {
|
|
32
|
-
constructor(id, attempts
|
|
33
|
-
super(`Workflow ${id} failed after ${attempts} attempt(s)
|
|
18
|
+
constructor(id, attempts) {
|
|
19
|
+
super(`Workflow ${id} failed after ${attempts} attempt(s)`);
|
|
34
20
|
this.id = id;
|
|
35
21
|
this.attempts = attempts;
|
|
36
|
-
this.reason = reason;
|
|
37
|
-
this.failureCause = failureCause;
|
|
38
22
|
this.name = "WorkflowRunFailedError";
|
|
39
23
|
}
|
|
40
24
|
};
|
|
41
|
-
var WorkflowRunSuspendedError = class extends Error {
|
|
42
|
-
constructor(id) {
|
|
43
|
-
super(`Workflow ${id} is suspended`);
|
|
44
|
-
this.id = id;
|
|
45
|
-
this.name = "WorkflowRunSuspendedError";
|
|
46
|
-
}
|
|
47
|
-
};
|
|
48
25
|
export {
|
|
49
|
-
WorkflowRunCancelledError,
|
|
50
|
-
WorkflowRunConflictError,
|
|
51
26
|
WorkflowRunFailedError,
|
|
52
27
|
WorkflowRunNotExecutableError,
|
|
53
|
-
WorkflowRunPausedError,
|
|
54
28
|
WorkflowRunSuspendedError
|
|
55
29
|
};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aikirun/types",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.6.0",
|
|
4
4
|
"description": "Core type definitions for Aiki - including workflow, task, client, and trigger types",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"exports": {
|
|
@@ -51,6 +51,10 @@
|
|
|
51
51
|
"./sleep": {
|
|
52
52
|
"types": "./dist/sleep.d.ts",
|
|
53
53
|
"import": "./dist/sleep.js"
|
|
54
|
+
},
|
|
55
|
+
"./event": {
|
|
56
|
+
"types": "./dist/event.d.ts",
|
|
57
|
+
"import": "./dist/event.js"
|
|
54
58
|
}
|
|
55
59
|
},
|
|
56
60
|
"files": [
|