@sonamu-kit/tasks 0.0.1

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.
Files changed (280) hide show
  1. package/.swcrc +17 -0
  2. package/README.md +7 -0
  3. package/dist/backend.d.ts +107 -0
  4. package/dist/backend.d.ts.map +1 -0
  5. package/dist/backend.js +3 -0
  6. package/dist/backend.js.map +1 -0
  7. package/dist/chaos.test.d.ts +2 -0
  8. package/dist/chaos.test.d.ts.map +1 -0
  9. package/dist/chaos.test.js +92 -0
  10. package/dist/chaos.test.js.map +1 -0
  11. package/dist/client.d.ts +178 -0
  12. package/dist/client.d.ts.map +1 -0
  13. package/dist/client.js +223 -0
  14. package/dist/client.js.map +1 -0
  15. package/dist/client.test.d.ts +2 -0
  16. package/dist/client.test.d.ts.map +1 -0
  17. package/dist/client.test.js +339 -0
  18. package/dist/client.test.js.map +1 -0
  19. package/dist/config.d.ts +22 -0
  20. package/dist/config.d.ts.map +1 -0
  21. package/dist/config.js +23 -0
  22. package/dist/config.js.map +1 -0
  23. package/dist/config.test.d.ts +2 -0
  24. package/dist/config.test.d.ts.map +1 -0
  25. package/dist/config.test.js +24 -0
  26. package/dist/config.test.js.map +1 -0
  27. package/dist/core/duration.d.ts +22 -0
  28. package/dist/core/duration.d.ts.map +1 -0
  29. package/dist/core/duration.js +64 -0
  30. package/dist/core/duration.js.map +1 -0
  31. package/dist/core/duration.test.d.ts +2 -0
  32. package/dist/core/duration.test.d.ts.map +1 -0
  33. package/dist/core/duration.test.js +265 -0
  34. package/dist/core/duration.test.js.map +1 -0
  35. package/dist/core/error.d.ts +15 -0
  36. package/dist/core/error.d.ts.map +1 -0
  37. package/dist/core/error.js +25 -0
  38. package/dist/core/error.js.map +1 -0
  39. package/dist/core/error.test.d.ts +2 -0
  40. package/dist/core/error.test.d.ts.map +1 -0
  41. package/dist/core/error.test.js +63 -0
  42. package/dist/core/error.test.js.map +1 -0
  43. package/dist/core/json.d.ts +5 -0
  44. package/dist/core/json.d.ts.map +1 -0
  45. package/dist/core/json.js +3 -0
  46. package/dist/core/json.js.map +1 -0
  47. package/dist/core/result.d.ts +22 -0
  48. package/dist/core/result.d.ts.map +1 -0
  49. package/dist/core/result.js +22 -0
  50. package/dist/core/result.js.map +1 -0
  51. package/dist/core/result.test.d.ts +2 -0
  52. package/dist/core/result.test.d.ts.map +1 -0
  53. package/dist/core/result.test.js +19 -0
  54. package/dist/core/result.test.js.map +1 -0
  55. package/dist/core/retry.d.ts +21 -0
  56. package/dist/core/retry.d.ts.map +1 -0
  57. package/dist/core/retry.js +25 -0
  58. package/dist/core/retry.js.map +1 -0
  59. package/dist/core/retry.test.d.ts +2 -0
  60. package/dist/core/retry.test.d.ts.map +1 -0
  61. package/dist/core/retry.test.js +37 -0
  62. package/dist/core/retry.test.js.map +1 -0
  63. package/dist/core/schema.d.ts +57 -0
  64. package/dist/core/schema.d.ts.map +1 -0
  65. package/dist/core/schema.js +4 -0
  66. package/dist/core/schema.js.map +1 -0
  67. package/dist/core/step.d.ts +96 -0
  68. package/dist/core/step.d.ts.map +1 -0
  69. package/dist/core/step.js +78 -0
  70. package/dist/core/step.js.map +1 -0
  71. package/dist/core/step.test.d.ts +2 -0
  72. package/dist/core/step.test.d.ts.map +1 -0
  73. package/dist/core/step.test.js +356 -0
  74. package/dist/core/step.test.js.map +1 -0
  75. package/dist/core/workflow.d.ts +78 -0
  76. package/dist/core/workflow.d.ts.map +1 -0
  77. package/dist/core/workflow.js +46 -0
  78. package/dist/core/workflow.js.map +1 -0
  79. package/dist/core/workflow.test.d.ts +2 -0
  80. package/dist/core/workflow.test.d.ts.map +1 -0
  81. package/dist/core/workflow.test.js +172 -0
  82. package/dist/core/workflow.test.js.map +1 -0
  83. package/dist/database/backend.d.ts +60 -0
  84. package/dist/database/backend.d.ts.map +1 -0
  85. package/dist/database/backend.js +387 -0
  86. package/dist/database/backend.js.map +1 -0
  87. package/dist/database/backend.test.d.ts +2 -0
  88. package/dist/database/backend.test.d.ts.map +1 -0
  89. package/dist/database/backend.test.js +17 -0
  90. package/dist/database/backend.test.js.map +1 -0
  91. package/dist/database/backend.testsuite.d.ts +20 -0
  92. package/dist/database/backend.testsuite.d.ts.map +1 -0
  93. package/dist/database/backend.testsuite.js +1174 -0
  94. package/dist/database/backend.testsuite.js.map +1 -0
  95. package/dist/database/base.d.ts +12 -0
  96. package/dist/database/base.d.ts.map +1 -0
  97. package/dist/database/base.js +19 -0
  98. package/dist/database/base.js.map +1 -0
  99. package/dist/database/migrations/20251212000000_0_init.js +9 -0
  100. package/dist/database/migrations/20251212000000_0_init.js.map +1 -0
  101. package/dist/database/migrations/20251212000000_1_tables.js +88 -0
  102. package/dist/database/migrations/20251212000000_1_tables.js.map +1 -0
  103. package/dist/database/migrations/20251212000000_2_fk.js +48 -0
  104. package/dist/database/migrations/20251212000000_2_fk.js.map +1 -0
  105. package/dist/database/migrations/20251212000000_3_indexes.js +107 -0
  106. package/dist/database/migrations/20251212000000_3_indexes.js.map +1 -0
  107. package/dist/database/pubsub.d.ts +17 -0
  108. package/dist/database/pubsub.d.ts.map +1 -0
  109. package/dist/database/pubsub.js +70 -0
  110. package/dist/database/pubsub.js.map +1 -0
  111. package/dist/database/pubsub.test.d.ts +2 -0
  112. package/dist/database/pubsub.test.d.ts.map +1 -0
  113. package/dist/database/pubsub.test.js +86 -0
  114. package/dist/database/pubsub.test.js.map +1 -0
  115. package/dist/errors.d.ts +8 -0
  116. package/dist/errors.d.ts.map +1 -0
  117. package/dist/errors.js +21 -0
  118. package/dist/errors.js.map +1 -0
  119. package/dist/execution.d.ts +82 -0
  120. package/dist/execution.d.ts.map +1 -0
  121. package/dist/execution.js +182 -0
  122. package/dist/execution.js.map +1 -0
  123. package/dist/execution.test.d.ts +2 -0
  124. package/dist/execution.test.d.ts.map +1 -0
  125. package/dist/execution.test.js +556 -0
  126. package/dist/execution.test.js.map +1 -0
  127. package/dist/index.d.ts +8 -0
  128. package/dist/index.d.ts.map +1 -0
  129. package/dist/index.js +6 -0
  130. package/dist/index.js.map +1 -0
  131. package/dist/internal.d.ts +12 -0
  132. package/dist/internal.d.ts.map +1 -0
  133. package/dist/internal.js +5 -0
  134. package/dist/internal.js.map +1 -0
  135. package/dist/practices/01-remote-workflow.d.ts +2 -0
  136. package/dist/practices/01-remote-workflow.d.ts.map +1 -0
  137. package/dist/practices/01-remote-workflow.js +69 -0
  138. package/dist/practices/01-remote-workflow.js.map +1 -0
  139. package/dist/practices/01-remote.d.ts +2 -0
  140. package/dist/practices/01-remote.d.ts.map +1 -0
  141. package/dist/practices/01-remote.js +87 -0
  142. package/dist/practices/01-remote.js.map +1 -0
  143. package/dist/practices/02-local.d.ts +2 -0
  144. package/dist/practices/02-local.d.ts.map +1 -0
  145. package/dist/practices/02-local.js +84 -0
  146. package/dist/practices/02-local.js.map +1 -0
  147. package/dist/practices/03-local-retry.d.ts +2 -0
  148. package/dist/practices/03-local-retry.d.ts.map +1 -0
  149. package/dist/practices/03-local-retry.js +85 -0
  150. package/dist/practices/03-local-retry.js.map +1 -0
  151. package/dist/practices/04-scheduler-dispose.d.ts +2 -0
  152. package/dist/practices/04-scheduler-dispose.d.ts.map +1 -0
  153. package/dist/practices/04-scheduler-dispose.js +65 -0
  154. package/dist/practices/04-scheduler-dispose.js.map +1 -0
  155. package/dist/practices/05-router.d.ts +2 -0
  156. package/dist/practices/05-router.d.ts.map +1 -0
  157. package/dist/practices/05-router.js +80 -0
  158. package/dist/practices/05-router.js.map +1 -0
  159. package/dist/registry.d.ts +33 -0
  160. package/dist/registry.d.ts.map +1 -0
  161. package/dist/registry.js +54 -0
  162. package/dist/registry.js.map +1 -0
  163. package/dist/registry.test.d.ts +2 -0
  164. package/dist/registry.test.d.ts.map +1 -0
  165. package/dist/registry.test.js +95 -0
  166. package/dist/registry.test.js.map +1 -0
  167. package/dist/scheduler.d.ts +22 -0
  168. package/dist/scheduler.d.ts.map +1 -0
  169. package/dist/scheduler.js +117 -0
  170. package/dist/scheduler.js.map +1 -0
  171. package/dist/tasks/index.d.ts +4 -0
  172. package/dist/tasks/index.d.ts.map +1 -0
  173. package/dist/tasks/index.js +5 -0
  174. package/dist/tasks/index.js.map +1 -0
  175. package/dist/tasks/local-task.d.ts +6 -0
  176. package/dist/tasks/local-task.d.ts.map +1 -0
  177. package/dist/tasks/local-task.js +95 -0
  178. package/dist/tasks/local-task.js.map +1 -0
  179. package/dist/tasks/remote-task.d.ts +11 -0
  180. package/dist/tasks/remote-task.d.ts.map +1 -0
  181. package/dist/tasks/remote-task.js +213 -0
  182. package/dist/tasks/remote-task.js.map +1 -0
  183. package/dist/tasks/shared.d.ts +8 -0
  184. package/dist/tasks/shared.d.ts.map +1 -0
  185. package/dist/tasks/shared.js +41 -0
  186. package/dist/tasks/shared.js.map +1 -0
  187. package/dist/testing/connection.d.ts +7 -0
  188. package/dist/testing/connection.d.ts.map +1 -0
  189. package/dist/testing/connection.js +38 -0
  190. package/dist/testing/connection.js.map +1 -0
  191. package/dist/types/config.d.ts +44 -0
  192. package/dist/types/config.d.ts.map +1 -0
  193. package/dist/types/config.js +3 -0
  194. package/dist/types/config.js.map +1 -0
  195. package/dist/types/context.d.ts +18 -0
  196. package/dist/types/context.d.ts.map +1 -0
  197. package/dist/types/context.js +4 -0
  198. package/dist/types/context.js.map +1 -0
  199. package/dist/types/events.d.ts +43 -0
  200. package/dist/types/events.d.ts.map +1 -0
  201. package/dist/types/events.js +3 -0
  202. package/dist/types/events.js.map +1 -0
  203. package/dist/types/index.d.ts +6 -0
  204. package/dist/types/index.d.ts.map +1 -0
  205. package/dist/types/index.js +3 -0
  206. package/dist/types/index.js.map +1 -0
  207. package/dist/types/task-items.d.ts +12 -0
  208. package/dist/types/task-items.d.ts.map +1 -0
  209. package/dist/types/task-items.js +3 -0
  210. package/dist/types/task-items.js.map +1 -0
  211. package/dist/types/utils.d.ts +4 -0
  212. package/dist/types/utils.d.ts.map +1 -0
  213. package/dist/types/utils.js +8 -0
  214. package/dist/types/utils.js.map +1 -0
  215. package/dist/worker.d.ts +61 -0
  216. package/dist/worker.d.ts.map +1 -0
  217. package/dist/worker.js +206 -0
  218. package/dist/worker.js.map +1 -0
  219. package/dist/worker.test.d.ts +2 -0
  220. package/dist/worker.test.d.ts.map +1 -0
  221. package/dist/worker.test.js +1163 -0
  222. package/dist/worker.test.js.map +1 -0
  223. package/dist/workflow.d.ts +44 -0
  224. package/dist/workflow.d.ts.map +1 -0
  225. package/dist/workflow.js +21 -0
  226. package/dist/workflow.js.map +1 -0
  227. package/dist/workflow.test.d.ts +2 -0
  228. package/dist/workflow.test.d.ts.map +1 -0
  229. package/dist/workflow.test.js +73 -0
  230. package/dist/workflow.test.js.map +1 -0
  231. package/nodemon.json +6 -0
  232. package/package.json +63 -0
  233. package/scripts/migrate.ts +11 -0
  234. package/src/backend.ts +133 -0
  235. package/src/chaos.test.ts +108 -0
  236. package/src/client.test.ts +297 -0
  237. package/src/client.ts +331 -0
  238. package/src/config.test.ts +23 -0
  239. package/src/config.ts +35 -0
  240. package/src/core/duration.test.ts +326 -0
  241. package/src/core/duration.ts +86 -0
  242. package/src/core/error.test.ts +77 -0
  243. package/src/core/error.ts +30 -0
  244. package/src/core/json.ts +2 -0
  245. package/src/core/result.test.ts +13 -0
  246. package/src/core/result.ts +29 -0
  247. package/src/core/retry.test.ts +41 -0
  248. package/src/core/retry.ts +29 -0
  249. package/src/core/schema.ts +74 -0
  250. package/src/core/step.test.ts +362 -0
  251. package/src/core/step.ts +152 -0
  252. package/src/core/workflow.test.ts +184 -0
  253. package/src/core/workflow.ts +127 -0
  254. package/src/database/backend.test.ts +16 -0
  255. package/src/database/backend.testsuite.ts +1376 -0
  256. package/src/database/backend.ts +655 -0
  257. package/src/database/base.ts +23 -0
  258. package/src/database/migrations/20251212000000_0_init.ts +10 -0
  259. package/src/database/migrations/20251212000000_1_tables.ts +54 -0
  260. package/src/database/migrations/20251212000000_2_fk.ts +46 -0
  261. package/src/database/migrations/20251212000000_3_indexes.ts +82 -0
  262. package/src/database/pubsub.test.ts +92 -0
  263. package/src/database/pubsub.ts +92 -0
  264. package/src/execution.test.ts +508 -0
  265. package/src/execution.ts +291 -0
  266. package/src/index.ts +7 -0
  267. package/src/internal.ts +11 -0
  268. package/src/practices/01-remote-workflow.ts +61 -0
  269. package/src/registry.test.ts +122 -0
  270. package/src/registry.ts +65 -0
  271. package/src/testing/connection.ts +44 -0
  272. package/src/worker.test.ts +1138 -0
  273. package/src/worker.ts +281 -0
  274. package/src/workflow.test.ts +68 -0
  275. package/src/workflow.ts +84 -0
  276. package/table_ddl.sql +60 -0
  277. package/templates/openworkflow.config.ts +22 -0
  278. package/tsconfig.json +40 -0
  279. package/tsconfig.test.json +4 -0
  280. package/vite.config.ts +13 -0
package/dist/client.js ADDED
@@ -0,0 +1,223 @@
1
+ import { validateInput } from "./core/workflow.js";
2
+ import { WorkflowRegistry } from "./registry.js";
3
+ import { Worker } from "./worker.js";
4
+ import { defineWorkflow, defineWorkflowSpec } from "./workflow.js";
5
+ const DEFAULT_RESULT_POLL_INTERVAL_MS = 1000; // 1s
6
+ const DEFAULT_RESULT_TIMEOUT_MS = 5 * 60 * 1000; // 5m
7
+ /**
8
+ * Client used to register workflows and start runs.
9
+ */ export class OpenWorkflow {
10
+ backend;
11
+ registry = new WorkflowRegistry();
12
+ constructor(options){
13
+ this.backend = options.backend;
14
+ }
15
+ /**
16
+ * Create a new Worker with this client's backend and workflows.
17
+ * @param options - Worker options
18
+ * @param options.concurrency - Max concurrent workflow runs
19
+ * @returns Worker instance
20
+ */ newWorker(options) {
21
+ return new Worker({
22
+ backend: this.backend,
23
+ registry: this.registry,
24
+ concurrency: options?.concurrency,
25
+ usePubSub: options?.usePubSub,
26
+ listenDelay: options?.listenDelay
27
+ });
28
+ }
29
+ /**
30
+ * Provide the implementation for a declared workflow. This links the workflow
31
+ * specification to its execution logic and registers it with this
32
+ * OpenWorkflow instance for worker execution.
33
+ * @param spec - Workflow spec
34
+ * @param fn - Workflow implementation
35
+ */ implementWorkflow(spec, fn) {
36
+ const workflow = {
37
+ spec,
38
+ fn
39
+ };
40
+ this.registry.register(workflow);
41
+ }
42
+ /**
43
+ * Run a workflow from its specification. This is the primary way to schedule
44
+ * a workflow using only its WorkflowSpec.
45
+ * @param spec - Workflow spec
46
+ * @param input - Workflow input
47
+ * @param options - Run options
48
+ * @returns Handle for awaiting the result
49
+ * @example
50
+ * ```ts
51
+ * const handle = await ow.runWorkflow(emailWorkflow, { to: 'user@example.com' });
52
+ * const result = await handle.result();
53
+ * ```
54
+ */ async runWorkflow(spec, input, options) {
55
+ const validationResult = await validateInput(spec.schema, input);
56
+ if (!validationResult.success) {
57
+ throw new Error(validationResult.error);
58
+ }
59
+ const parsedInput = validationResult.value;
60
+ const workflowRun = await this.backend.createWorkflowRun({
61
+ workflowName: spec.name,
62
+ version: spec.version ?? null,
63
+ idempotencyKey: null,
64
+ config: {},
65
+ context: null,
66
+ input: parsedInput ?? null,
67
+ availableAt: null,
68
+ deadlineAt: options?.deadlineAt ?? null
69
+ });
70
+ if (options?.publishToChannel) {
71
+ await this.backend.publish(workflowRun.id);
72
+ }
73
+ return new WorkflowRunHandle({
74
+ backend: this.backend,
75
+ workflowRun: workflowRun,
76
+ resultPollIntervalMs: DEFAULT_RESULT_POLL_INTERVAL_MS,
77
+ resultTimeoutMs: DEFAULT_RESULT_TIMEOUT_MS
78
+ });
79
+ }
80
+ /**
81
+ * Define and register a new workflow.
82
+ *
83
+ * This is a convenience method that combines `declareWorkflow` and
84
+ * `implementWorkflow` into a single call. For better code splitting and to
85
+ * separate declaration from implementation, consider using those methods
86
+ * separately.
87
+ * @param config - Workflow config
88
+ * @param fn - Workflow implementation
89
+ * @returns Runnable workflow
90
+ * @example
91
+ * ```ts
92
+ * const workflow = ow.defineWorkflow(
93
+ * { name: 'my-workflow' },
94
+ * async ({ input, step }) => {
95
+ * // workflow implementation
96
+ * },
97
+ * );
98
+ * ```
99
+ */ defineWorkflow(spec, fn) {
100
+ const workflow = defineWorkflow(spec, fn);
101
+ this.registry.register(workflow);
102
+ return new RunnableWorkflow(this, workflow);
103
+ }
104
+ /**
105
+ * Unregister a workflow from the registry.
106
+ * @param name - The workflow name
107
+ * @param version - The workflow version (null for unversioned)
108
+ * @example
109
+ * ```ts
110
+ * ow.unregisterWorkflow("my-workflow", "v1");
111
+ * ```
112
+ */ unregisterWorkflow(name, version) {
113
+ this.registry.remove(name, version);
114
+ }
115
+ /**
116
+ * Check if a workflow is registered in the registry.
117
+ * @param name - The workflow name
118
+ * @param version - The workflow version (null for unversioned)
119
+ * @returns True if the workflow is registered, false otherwise
120
+ * @example
121
+ * ```ts
122
+ * ow.isWorkflowRegistered("my-workflow", "v1");
123
+ * ```
124
+ */ isWorkflowRegistered(name, version) {
125
+ return this.registry.has(name, version);
126
+ }
127
+ }
128
+ /**
129
+ * Declare a workflow without providing its implementation (which is provided
130
+ * separately via `implementWorkflow`). Returns a lightweight WorkflowSpec
131
+ * that can be used to schedule workflow runs.
132
+ * @param config - Workflow config
133
+ * @param spec - Workflow spec
134
+ * @returns Workflow spec
135
+ * @example
136
+ * ```ts
137
+ * export const emailWorkflow = declareWorkflow({
138
+ * name: 'send-email',
139
+ * schema: z.object({ to: z.string().email() }),
140
+ * });
141
+ * ```
142
+ */ // kept for backwards compatibility, to be deprecated
143
+ // eslint-disable-next-line unicorn/prefer-export-from
144
+ export const declareWorkflow = defineWorkflowSpec;
145
+ //
146
+ // --- Workflow Definition
147
+ //
148
+ /**
149
+ * A fully defined workflow with its implementation. This class is returned by
150
+ * `defineWorkflow` and provides the `.run()` method for scheduling workflow
151
+ * runs.
152
+ */ export class RunnableWorkflow {
153
+ ow;
154
+ workflow;
155
+ constructor(ow, workflow){
156
+ this.ow = ow;
157
+ this.workflow = workflow;
158
+ }
159
+ /**
160
+ * Starts a new workflow run.
161
+ * @param input - Workflow input
162
+ * @param options - Run options
163
+ * @returns Workflow run handle
164
+ */ async run(input, options) {
165
+ return this.ow.runWorkflow(this.workflow.spec, input, options);
166
+ }
167
+ }
168
+ /**
169
+ * Represents a started workflow run and provides methods to await its result.
170
+ * Returned from `workflowDef.run()`.
171
+ */ export class WorkflowRunHandle {
172
+ backend;
173
+ workflowRun;
174
+ resultPollIntervalMs;
175
+ resultTimeoutMs;
176
+ constructor(options){
177
+ this.backend = options.backend;
178
+ this.workflowRun = options.workflowRun;
179
+ this.resultPollIntervalMs = options.resultPollIntervalMs;
180
+ this.resultTimeoutMs = options.resultTimeoutMs;
181
+ }
182
+ /**
183
+ * Waits for the workflow run to complete and returns the result.
184
+ * @returns Workflow output
185
+ */ async result() {
186
+ const start = Date.now();
187
+ // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
188
+ while(true){
189
+ const latest = await this.backend.getWorkflowRun({
190
+ workflowRunId: this.workflowRun.id
191
+ });
192
+ if (!latest) {
193
+ throw new Error(`Workflow run ${this.workflowRun.id} no longer exists`);
194
+ }
195
+ // 'succeeded' status is deprecated
196
+ if (latest.status === "succeeded" || latest.status === "completed") {
197
+ return latest.output;
198
+ }
199
+ if (latest.status === "failed") {
200
+ throw new Error(`Workflow ${this.workflowRun.workflowName} failed: ${JSON.stringify(latest.error)}`);
201
+ }
202
+ if (latest.status === "canceled") {
203
+ throw new Error(`Workflow ${this.workflowRun.workflowName} was canceled`);
204
+ }
205
+ if (Date.now() - start > this.resultTimeoutMs) {
206
+ throw new Error(`Timed out waiting for workflow run ${this.workflowRun.id} to finish`);
207
+ }
208
+ await new Promise((resolve)=>{
209
+ setTimeout(resolve, this.resultPollIntervalMs);
210
+ });
211
+ }
212
+ }
213
+ /**
214
+ * Cancels the workflow run. Only workflows in pending, running, or sleeping
215
+ * status can be canceled.
216
+ */ async cancel() {
217
+ await this.backend.cancelWorkflowRun({
218
+ workflowRunId: this.workflowRun.id
219
+ });
220
+ }
221
+ }
222
+
223
+ //# sourceMappingURL=client.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/client.ts"],"sourcesContent":["import type { Backend } from \"./backend\";\nimport type { StandardSchemaV1 } from \"./core/schema\";\nimport type { SchemaInput, SchemaOutput, WorkflowRun } from \"./core/workflow\";\nimport { validateInput } from \"./core/workflow\";\nimport type { WorkflowFunction } from \"./execution\";\nimport { WorkflowRegistry } from \"./registry\";\nimport { Worker, type WorkerOptions } from \"./worker\";\nimport { defineWorkflow, defineWorkflowSpec, type Workflow, type WorkflowSpec } from \"./workflow\";\n\nconst DEFAULT_RESULT_POLL_INTERVAL_MS = 1000; // 1s\nconst DEFAULT_RESULT_TIMEOUT_MS = 5 * 60 * 1000; // 5m\n\n/* The data the worker function receives (after transformation). */\ntype WorkflowHandlerInput<TSchema, Input> = SchemaOutput<TSchema, Input>;\n\n/* The data the client sends (before transformation) */\ntype WorkflowRunInput<TSchema, Input> = SchemaInput<TSchema, Input>;\n\n/**\n * Options for the OpenWorkflow client.\n */\nexport interface OpenWorkflowOptions {\n backend: Backend;\n}\n\n/**\n * Client used to register workflows and start runs.\n */\nexport class OpenWorkflow {\n private backend: Backend;\n private registry = new WorkflowRegistry();\n\n constructor(options: OpenWorkflowOptions) {\n this.backend = options.backend;\n }\n\n /**\n * Create a new Worker with this client's backend and workflows.\n * @param options - Worker options\n * @param options.concurrency - Max concurrent workflow runs\n * @returns Worker instance\n */\n newWorker(options?: {\n concurrency?: number | undefined;\n usePubSub?: boolean;\n listenDelay?: number;\n }): Worker {\n return new Worker({\n backend: this.backend,\n registry: this.registry,\n concurrency: options?.concurrency,\n usePubSub: options?.usePubSub,\n listenDelay: options?.listenDelay,\n } satisfies WorkerOptions);\n }\n\n /**\n * Provide the implementation for a declared workflow. This links the workflow\n * specification to its execution logic and registers it with this\n * OpenWorkflow instance for worker execution.\n * @param spec - Workflow spec\n * @param fn - Workflow implementation\n */\n implementWorkflow<Input, Output, RunInput = Input>(\n spec: WorkflowSpec<Input, Output, RunInput>,\n fn: WorkflowFunction<Input, Output>,\n ): void {\n const workflow: Workflow<Input, Output, RunInput> = { spec, fn };\n this.registry.register(workflow as Workflow<unknown, unknown, unknown>);\n }\n\n /**\n * Run a workflow from its specification. This is the primary way to schedule\n * a workflow using only its WorkflowSpec.\n * @param spec - Workflow spec\n * @param input - Workflow input\n * @param options - Run options\n * @returns Handle for awaiting the result\n * @example\n * ```ts\n * const handle = await ow.runWorkflow(emailWorkflow, { to: 'user@example.com' });\n * const result = await handle.result();\n * ```\n */\n async runWorkflow<Input, Output, RunInput = Input>(\n spec: WorkflowSpec<Input, Output, RunInput>,\n input?: RunInput,\n options?: WorkflowRunOptions,\n ): Promise<WorkflowRunHandle<Output>> {\n const validationResult = await validateInput(spec.schema, input);\n if (!validationResult.success) {\n throw new Error(validationResult.error);\n }\n const parsedInput = validationResult.value;\n const workflowRun = await this.backend.createWorkflowRun({\n workflowName: spec.name,\n version: spec.version ?? null,\n idempotencyKey: null,\n config: {},\n context: null,\n input: parsedInput ?? null,\n availableAt: null,\n deadlineAt: options?.deadlineAt ?? null,\n });\n\n if (options?.publishToChannel) {\n await this.backend.publish(workflowRun.id);\n }\n\n return new WorkflowRunHandle<Output>({\n backend: this.backend,\n workflowRun: workflowRun,\n resultPollIntervalMs: DEFAULT_RESULT_POLL_INTERVAL_MS,\n resultTimeoutMs: DEFAULT_RESULT_TIMEOUT_MS,\n });\n }\n\n /**\n * Define and register a new workflow.\n *\n * This is a convenience method that combines `declareWorkflow` and\n * `implementWorkflow` into a single call. For better code splitting and to\n * separate declaration from implementation, consider using those methods\n * separately.\n * @param config - Workflow config\n * @param fn - Workflow implementation\n * @returns Runnable workflow\n * @example\n * ```ts\n * const workflow = ow.defineWorkflow(\n * { name: 'my-workflow' },\n * async ({ input, step }) => {\n * // workflow implementation\n * },\n * );\n * ```\n */\n defineWorkflow<Input, Output, TSchema extends StandardSchemaV1 | undefined = undefined>(\n spec: WorkflowSpec<\n WorkflowHandlerInput<TSchema, Input>,\n Output,\n WorkflowRunInput<TSchema, Input>\n >,\n fn: WorkflowFunction<WorkflowHandlerInput<TSchema, Input>, Output>,\n ): RunnableWorkflow<\n WorkflowHandlerInput<TSchema, Input>,\n Output,\n WorkflowRunInput<TSchema, Input>\n > {\n const workflow = defineWorkflow(spec, fn);\n this.registry.register(workflow as Workflow<unknown, unknown, unknown>);\n return new RunnableWorkflow(this, workflow);\n }\n\n /**\n * Unregister a workflow from the registry.\n * @param name - The workflow name\n * @param version - The workflow version (null for unversioned)\n * @example\n * ```ts\n * ow.unregisterWorkflow(\"my-workflow\", \"v1\");\n * ```\n */\n unregisterWorkflow(name: string, version: string | null): void {\n this.registry.remove(name, version);\n }\n\n /**\n * Check if a workflow is registered in the registry.\n * @param name - The workflow name\n * @param version - The workflow version (null for unversioned)\n * @returns True if the workflow is registered, false otherwise\n * @example\n * ```ts\n * ow.isWorkflowRegistered(\"my-workflow\", \"v1\");\n * ```\n */\n isWorkflowRegistered(name: string, version: string | null): boolean {\n return this.registry.has(name, version);\n }\n}\n\n/**\n * Declare a workflow without providing its implementation (which is provided\n * separately via `implementWorkflow`). Returns a lightweight WorkflowSpec\n * that can be used to schedule workflow runs.\n * @param config - Workflow config\n * @param spec - Workflow spec\n * @returns Workflow spec\n * @example\n * ```ts\n * export const emailWorkflow = declareWorkflow({\n * name: 'send-email',\n * schema: z.object({ to: z.string().email() }),\n * });\n * ```\n */\n// kept for backwards compatibility, to be deprecated\n// eslint-disable-next-line unicorn/prefer-export-from\nexport const declareWorkflow = defineWorkflowSpec;\n\n//\n// --- Workflow Definition\n//\n\n/**\n * A fully defined workflow with its implementation. This class is returned by\n * `defineWorkflow` and provides the `.run()` method for scheduling workflow\n * runs.\n */\nexport class RunnableWorkflow<Input, Output, RunInput = Input> {\n private readonly ow: OpenWorkflow;\n readonly workflow: Workflow<Input, Output, RunInput>;\n\n constructor(ow: OpenWorkflow, workflow: Workflow<Input, Output, RunInput>) {\n this.ow = ow;\n this.workflow = workflow;\n }\n\n /**\n * Starts a new workflow run.\n * @param input - Workflow input\n * @param options - Run options\n * @returns Workflow run handle\n */\n async run(input?: RunInput, options?: WorkflowRunOptions): Promise<WorkflowRunHandle<Output>> {\n return this.ow.runWorkflow(this.workflow.spec, input, options);\n }\n}\n\n//\n// --- Workflow Run\n//\n\n/**\n * Options for creating a new workflow run from a runnable workflow when calling\n * `workflow.run()`.\n */\nexport interface WorkflowRunOptions {\n /**\n * Set a deadline for the workflow run. If the workflow exceeds this deadline,\n * it will be marked as failed.\n */\n deadlineAt?: Date;\n\n /**\n * Publish when the workflow run is created to the channel.\n * Default: true\n */\n publishToChannel?: boolean;\n}\n\n/**\n * Options for WorkflowHandle.\n */\nexport interface WorkflowHandleOptions {\n backend: Backend;\n workflowRun: WorkflowRun;\n resultPollIntervalMs: number;\n resultTimeoutMs: number;\n}\n\n/**\n * Represents a started workflow run and provides methods to await its result.\n * Returned from `workflowDef.run()`.\n */\nexport class WorkflowRunHandle<Output> {\n private backend: Backend;\n readonly workflowRun: WorkflowRun;\n private resultPollIntervalMs: number;\n private resultTimeoutMs: number;\n\n constructor(options: WorkflowHandleOptions) {\n this.backend = options.backend;\n this.workflowRun = options.workflowRun;\n this.resultPollIntervalMs = options.resultPollIntervalMs;\n this.resultTimeoutMs = options.resultTimeoutMs;\n }\n\n /**\n * Waits for the workflow run to complete and returns the result.\n * @returns Workflow output\n */\n async result(): Promise<Output> {\n const start = Date.now();\n\n // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition\n while (true) {\n const latest = await this.backend.getWorkflowRun({\n workflowRunId: this.workflowRun.id,\n });\n\n if (!latest) {\n throw new Error(`Workflow run ${this.workflowRun.id} no longer exists`);\n }\n\n // 'succeeded' status is deprecated\n if (latest.status === \"succeeded\" || latest.status === \"completed\") {\n return latest.output as Output;\n }\n\n if (latest.status === \"failed\") {\n throw new Error(\n `Workflow ${this.workflowRun.workflowName} failed: ${JSON.stringify(latest.error)}`,\n );\n }\n\n if (latest.status === \"canceled\") {\n throw new Error(`Workflow ${this.workflowRun.workflowName} was canceled`);\n }\n\n if (Date.now() - start > this.resultTimeoutMs) {\n throw new Error(`Timed out waiting for workflow run ${this.workflowRun.id} to finish`);\n }\n\n await new Promise((resolve) => {\n setTimeout(resolve, this.resultPollIntervalMs);\n });\n }\n }\n\n /**\n * Cancels the workflow run. Only workflows in pending, running, or sleeping\n * status can be canceled.\n */\n async cancel(): Promise<void> {\n await this.backend.cancelWorkflowRun({\n workflowRunId: this.workflowRun.id,\n });\n }\n}\n"],"names":["validateInput","WorkflowRegistry","Worker","defineWorkflow","defineWorkflowSpec","DEFAULT_RESULT_POLL_INTERVAL_MS","DEFAULT_RESULT_TIMEOUT_MS","OpenWorkflow","backend","registry","options","newWorker","concurrency","usePubSub","listenDelay","implementWorkflow","spec","fn","workflow","register","runWorkflow","input","validationResult","schema","success","Error","error","parsedInput","value","workflowRun","createWorkflowRun","workflowName","name","version","idempotencyKey","config","context","availableAt","deadlineAt","publishToChannel","publish","id","WorkflowRunHandle","resultPollIntervalMs","resultTimeoutMs","RunnableWorkflow","unregisterWorkflow","remove","isWorkflowRegistered","has","declareWorkflow","ow","run","result","start","Date","now","latest","getWorkflowRun","workflowRunId","status","output","JSON","stringify","Promise","resolve","setTimeout","cancel","cancelWorkflowRun"],"mappings":"AAGA,SAASA,aAAa,QAAQ,qBAAkB;AAEhD,SAASC,gBAAgB,QAAQ,gBAAa;AAC9C,SAASC,MAAM,QAA4B,cAAW;AACtD,SAASC,cAAc,EAAEC,kBAAkB,QAA0C,gBAAa;AAElG,MAAMC,kCAAkC,MAAM,KAAK;AACnD,MAAMC,4BAA4B,IAAI,KAAK,MAAM,KAAK;AAetD;;CAEC,GACD,OAAO,MAAMC;IACHC,QAAiB;IACjBC,WAAW,IAAIR,mBAAmB;IAE1C,YAAYS,OAA4B,CAAE;QACxC,IAAI,CAACF,OAAO,GAAGE,QAAQF,OAAO;IAChC;IAEA;;;;;GAKC,GACDG,UAAUD,OAIT,EAAU;QACT,OAAO,IAAIR,OAAO;YAChBM,SAAS,IAAI,CAACA,OAAO;YACrBC,UAAU,IAAI,CAACA,QAAQ;YACvBG,aAAaF,SAASE;YACtBC,WAAWH,SAASG;YACpBC,aAAaJ,SAASI;QACxB;IACF;IAEA;;;;;;GAMC,GACDC,kBACEC,IAA2C,EAC3CC,EAAmC,EAC7B;QACN,MAAMC,WAA8C;YAAEF;YAAMC;QAAG;QAC/D,IAAI,CAACR,QAAQ,CAACU,QAAQ,CAACD;IACzB;IAEA;;;;;;;;;;;;GAYC,GACD,MAAME,YACJJ,IAA2C,EAC3CK,KAAgB,EAChBX,OAA4B,EACQ;QACpC,MAAMY,mBAAmB,MAAMtB,cAAcgB,KAAKO,MAAM,EAAEF;QAC1D,IAAI,CAACC,iBAAiBE,OAAO,EAAE;YAC7B,MAAM,IAAIC,MAAMH,iBAAiBI,KAAK;QACxC;QACA,MAAMC,cAAcL,iBAAiBM,KAAK;QAC1C,MAAMC,cAAc,MAAM,IAAI,CAACrB,OAAO,CAACsB,iBAAiB,CAAC;YACvDC,cAAcf,KAAKgB,IAAI;YACvBC,SAASjB,KAAKiB,OAAO,IAAI;YACzBC,gBAAgB;YAChBC,QAAQ,CAAC;YACTC,SAAS;YACTf,OAAOM,eAAe;YACtBU,aAAa;YACbC,YAAY5B,SAAS4B,cAAc;QACrC;QAEA,IAAI5B,SAAS6B,kBAAkB;YAC7B,MAAM,IAAI,CAAC/B,OAAO,CAACgC,OAAO,CAACX,YAAYY,EAAE;QAC3C;QAEA,OAAO,IAAIC,kBAA0B;YACnClC,SAAS,IAAI,CAACA,OAAO;YACrBqB,aAAaA;YACbc,sBAAsBtC;YACtBuC,iBAAiBtC;QACnB;IACF;IAEA;;;;;;;;;;;;;;;;;;;GAmBC,GACDH,eACEa,IAIC,EACDC,EAAkE,EAKlE;QACA,MAAMC,WAAWf,eAAea,MAAMC;QACtC,IAAI,CAACR,QAAQ,CAACU,QAAQ,CAACD;QACvB,OAAO,IAAI2B,iBAAiB,IAAI,EAAE3B;IACpC;IAEA;;;;;;;;GAQC,GACD4B,mBAAmBd,IAAY,EAAEC,OAAsB,EAAQ;QAC7D,IAAI,CAACxB,QAAQ,CAACsC,MAAM,CAACf,MAAMC;IAC7B;IAEA;;;;;;;;;GASC,GACDe,qBAAqBhB,IAAY,EAAEC,OAAsB,EAAW;QAClE,OAAO,IAAI,CAACxB,QAAQ,CAACwC,GAAG,CAACjB,MAAMC;IACjC;AACF;AAEA;;;;;;;;;;;;;;CAcC,GACD,qDAAqD;AACrD,sDAAsD;AACtD,OAAO,MAAMiB,kBAAkB9C,mBAAmB;AAElD,EAAE;AACF,0BAA0B;AAC1B,EAAE;AAEF;;;;CAIC,GACD,OAAO,MAAMyC;IACMM,GAAiB;IACzBjC,SAA4C;IAErD,YAAYiC,EAAgB,EAAEjC,QAA2C,CAAE;QACzE,IAAI,CAACiC,EAAE,GAAGA;QACV,IAAI,CAACjC,QAAQ,GAAGA;IAClB;IAEA;;;;;GAKC,GACD,MAAMkC,IAAI/B,KAAgB,EAAEX,OAA4B,EAAsC;QAC5F,OAAO,IAAI,CAACyC,EAAE,CAAC/B,WAAW,CAAC,IAAI,CAACF,QAAQ,CAACF,IAAI,EAAEK,OAAOX;IACxD;AACF;AAkCA;;;CAGC,GACD,OAAO,MAAMgC;IACHlC,QAAiB;IAChBqB,YAAyB;IAC1Bc,qBAA6B;IAC7BC,gBAAwB;IAEhC,YAAYlC,OAA8B,CAAE;QAC1C,IAAI,CAACF,OAAO,GAAGE,QAAQF,OAAO;QAC9B,IAAI,CAACqB,WAAW,GAAGnB,QAAQmB,WAAW;QACtC,IAAI,CAACc,oBAAoB,GAAGjC,QAAQiC,oBAAoB;QACxD,IAAI,CAACC,eAAe,GAAGlC,QAAQkC,eAAe;IAChD;IAEA;;;GAGC,GACD,MAAMS,SAA0B;QAC9B,MAAMC,QAAQC,KAAKC,GAAG;QAEtB,uEAAuE;QACvE,MAAO,KAAM;YACX,MAAMC,SAAS,MAAM,IAAI,CAACjD,OAAO,CAACkD,cAAc,CAAC;gBAC/CC,eAAe,IAAI,CAAC9B,WAAW,CAACY,EAAE;YACpC;YAEA,IAAI,CAACgB,QAAQ;gBACX,MAAM,IAAIhC,MAAM,CAAC,aAAa,EAAE,IAAI,CAACI,WAAW,CAACY,EAAE,CAAC,iBAAiB,CAAC;YACxE;YAEA,mCAAmC;YACnC,IAAIgB,OAAOG,MAAM,KAAK,eAAeH,OAAOG,MAAM,KAAK,aAAa;gBAClE,OAAOH,OAAOI,MAAM;YACtB;YAEA,IAAIJ,OAAOG,MAAM,KAAK,UAAU;gBAC9B,MAAM,IAAInC,MACR,CAAC,SAAS,EAAE,IAAI,CAACI,WAAW,CAACE,YAAY,CAAC,SAAS,EAAE+B,KAAKC,SAAS,CAACN,OAAO/B,KAAK,GAAG;YAEvF;YAEA,IAAI+B,OAAOG,MAAM,KAAK,YAAY;gBAChC,MAAM,IAAInC,MAAM,CAAC,SAAS,EAAE,IAAI,CAACI,WAAW,CAACE,YAAY,CAAC,aAAa,CAAC;YAC1E;YAEA,IAAIwB,KAAKC,GAAG,KAAKF,QAAQ,IAAI,CAACV,eAAe,EAAE;gBAC7C,MAAM,IAAInB,MAAM,CAAC,mCAAmC,EAAE,IAAI,CAACI,WAAW,CAACY,EAAE,CAAC,UAAU,CAAC;YACvF;YAEA,MAAM,IAAIuB,QAAQ,CAACC;gBACjBC,WAAWD,SAAS,IAAI,CAACtB,oBAAoB;YAC/C;QACF;IACF;IAEA;;;GAGC,GACD,MAAMwB,SAAwB;QAC5B,MAAM,IAAI,CAAC3D,OAAO,CAAC4D,iBAAiB,CAAC;YACnCT,eAAe,IAAI,CAAC9B,WAAW,CAACY,EAAE;QACpC;IACF;AACF"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=client.test.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"client.test.d.ts","sourceRoot":"","sources":["../src/client.test.ts"],"names":[],"mappings":""}
@@ -0,0 +1,339 @@
1
+ import { randomUUID } from "node:crypto";
2
+ import { afterEach, beforeEach, describe, expect, test } from "vitest";
3
+ import { z } from "zod";
4
+ import { BackendPostgres } from "./index.js";
5
+ import { declareWorkflow, OpenWorkflow } from "./client.js";
6
+ import { KNEX_GLOBAL_CONFIG } from "./testing/connection.js";
7
+ describe("OpenWorkflow", ()=>{
8
+ let backend;
9
+ beforeEach(async ()=>{
10
+ backend = await BackendPostgres.connect(KNEX_GLOBAL_CONFIG, {
11
+ namespaceId: randomUUID(),
12
+ runMigrations: false
13
+ });
14
+ });
15
+ afterEach(async ()=>{
16
+ await backend.stop();
17
+ });
18
+ test("enqueues workflow runs via backend", async ()=>{
19
+ const client = new OpenWorkflow({
20
+ backend
21
+ });
22
+ const workflow = client.defineWorkflow({
23
+ name: "enqueue-test"
24
+ }, noopFn);
25
+ await workflow.run({
26
+ docUrl: "https://example.com"
27
+ });
28
+ const workerId = "enqueue-worker";
29
+ const claimed = await backend.claimWorkflowRun({
30
+ workerId,
31
+ leaseDurationMs: 1000
32
+ });
33
+ expect(claimed?.workflowName).toBe("enqueue-test");
34
+ expect(claimed?.workerId).toBe(workerId);
35
+ expect(claimed?.input).toEqual({
36
+ docUrl: "https://example.com"
37
+ });
38
+ });
39
+ describe("schema validation", ()=>{
40
+ describe("Zod schema", ()=>{
41
+ const schema = z.object({
42
+ userId: z.uuid(),
43
+ count: z.number().int().positive()
44
+ });
45
+ test("accepts valid input", async ()=>{
46
+ const client = new OpenWorkflow({
47
+ backend
48
+ });
49
+ const workflow = client.defineWorkflow({
50
+ name: "schema-zod-valid",
51
+ schema
52
+ }, noopFn);
53
+ const handle = await workflow.run({
54
+ userId: randomUUID(),
55
+ count: 3
56
+ });
57
+ await handle.cancel();
58
+ });
59
+ test("rejects invalid input", async ()=>{
60
+ const client = new OpenWorkflow({
61
+ backend
62
+ });
63
+ const workflow = client.defineWorkflow({
64
+ name: "schema-zod-invalid",
65
+ schema
66
+ }, noopFn);
67
+ await expect(workflow.run({
68
+ userId: "not-a-uuid",
69
+ count: 0
70
+ })).rejects.toThrow();
71
+ });
72
+ });
73
+ });
74
+ test("result resolves when workflow succeeds", async ()=>{
75
+ const client = new OpenWorkflow({
76
+ backend
77
+ });
78
+ const workflow = client.defineWorkflow({
79
+ name: "result-success"
80
+ }, noopFn);
81
+ const handle = await workflow.run({
82
+ value: 1
83
+ });
84
+ const workerId = "test-worker";
85
+ const claimed = await backend.claimWorkflowRun({
86
+ workerId,
87
+ leaseDurationMs: 1000
88
+ });
89
+ expect(claimed).not.toBeNull();
90
+ if (!claimed) throw new Error("workflow run was not claimed");
91
+ await backend.completeWorkflowRun({
92
+ workflowRunId: claimed.id,
93
+ workerId,
94
+ output: {
95
+ ok: true
96
+ }
97
+ });
98
+ // eslint-disable-next-line @typescript-eslint/no-confusing-void-expression
99
+ const result = await handle.result();
100
+ expect(result).toEqual({
101
+ ok: true
102
+ });
103
+ });
104
+ test("result rejects when workflow fails", async ()=>{
105
+ const client = new OpenWorkflow({
106
+ backend
107
+ });
108
+ const workflow = client.defineWorkflow({
109
+ name: "result-failure"
110
+ }, noopFn);
111
+ await workflow.run({
112
+ value: 1
113
+ });
114
+ const workerId = "test-worker";
115
+ const claimed = await backend.claimWorkflowRun({
116
+ workerId,
117
+ leaseDurationMs: 1000
118
+ });
119
+ expect(claimed).not.toBeNull();
120
+ if (!claimed) throw new Error("workflow run was not claimed");
121
+ // mark as failed (should reschedule))
122
+ await backend.failWorkflowRun({
123
+ workflowRunId: claimed.id,
124
+ workerId,
125
+ error: {
126
+ message: "boom"
127
+ }
128
+ });
129
+ const rescheduled = await backend.getWorkflowRun({
130
+ workflowRunId: claimed.id
131
+ });
132
+ expect(rescheduled?.status).toBe("pending");
133
+ expect(rescheduled?.error).toEqual({
134
+ message: "boom"
135
+ });
136
+ });
137
+ test("creates workflow run with deadline", async ()=>{
138
+ const client = new OpenWorkflow({
139
+ backend
140
+ });
141
+ const workflow = client.defineWorkflow({
142
+ name: "deadline-test"
143
+ }, noopFn);
144
+ const deadline = new Date(Date.now() + 60_000); // in 1 minute
145
+ const handle = await workflow.run({
146
+ value: 1
147
+ }, {
148
+ deadlineAt: deadline
149
+ });
150
+ expect(handle.workflowRun.deadlineAt).not.toBeNull();
151
+ expect(handle.workflowRun.deadlineAt?.getTime()).toBe(deadline.getTime());
152
+ });
153
+ test("creates workflow run with version", async ()=>{
154
+ const client = new OpenWorkflow({
155
+ backend
156
+ });
157
+ const workflow = client.defineWorkflow({
158
+ name: "versioned-test",
159
+ version: "v2.0"
160
+ }, noopFn);
161
+ const handle = await workflow.run({
162
+ value: 1
163
+ });
164
+ expect(handle.workflowRun.version).toBe("v2.0");
165
+ });
166
+ test("creates workflow run without version", async ()=>{
167
+ const client = new OpenWorkflow({
168
+ backend
169
+ });
170
+ const workflow = client.defineWorkflow({
171
+ name: "unversioned-test"
172
+ }, noopFn);
173
+ const handle = await workflow.run({
174
+ value: 1
175
+ });
176
+ expect(handle.workflowRun.version).toBeNull();
177
+ });
178
+ test("cancels workflow run via handle", async ()=>{
179
+ const client = new OpenWorkflow({
180
+ backend
181
+ });
182
+ const workflow = client.defineWorkflow({
183
+ name: "cancel-test"
184
+ }, noopFn);
185
+ const handle = await workflow.run({
186
+ value: 1
187
+ });
188
+ await handle.cancel();
189
+ const workflowRun = await backend.getWorkflowRun({
190
+ workflowRunId: handle.workflowRun.id
191
+ });
192
+ expect(workflowRun?.status).toBe("canceled");
193
+ expect(workflowRun?.finishedAt).not.toBeNull();
194
+ });
195
+ describe("declareWorkflow / implementWorkflow API", ()=>{
196
+ test("declareWorkflow returns a spec that can be used to schedule runs", async ()=>{
197
+ const client = new OpenWorkflow({
198
+ backend
199
+ });
200
+ const spec = declareWorkflow({
201
+ name: "declare-test"
202
+ });
203
+ const handle = await client.runWorkflow(spec, {
204
+ message: "hello"
205
+ });
206
+ expect(handle.workflowRun.workflowName).toBe("declare-test");
207
+ await handle.cancel();
208
+ });
209
+ test("implementWorkflow registers the workflow for worker execution", async ()=>{
210
+ const client = new OpenWorkflow({
211
+ backend
212
+ });
213
+ const spec = declareWorkflow({
214
+ name: "implement-test"
215
+ });
216
+ client.implementWorkflow(spec, ({ input })=>{
217
+ return {
218
+ received: input
219
+ };
220
+ });
221
+ const handle = await client.runWorkflow(spec, {
222
+ data: 42
223
+ });
224
+ const worker = client.newWorker();
225
+ await worker.tick();
226
+ await sleep(100); // wait for background execution
227
+ const result = await handle.result();
228
+ expect(result).toEqual({
229
+ received: {
230
+ data: 42
231
+ }
232
+ });
233
+ });
234
+ test("implementWorkflow throws when workflow is already registered", async ()=>{
235
+ const client = new OpenWorkflow({
236
+ backend
237
+ });
238
+ const spec = declareWorkflow({
239
+ name: "duplicate-test"
240
+ });
241
+ client.implementWorkflow(spec, noopFn);
242
+ expect(()=>{
243
+ client.implementWorkflow(spec, noopFn);
244
+ }).toThrow('Workflow "duplicate-test" is already registered');
245
+ });
246
+ test("implementWorkflow allows registering different versions of the same workflow", async ()=>{
247
+ const client = new OpenWorkflow({
248
+ backend
249
+ });
250
+ const specV1 = declareWorkflow({
251
+ name: "multi-version",
252
+ version: "v1"
253
+ });
254
+ const specV2 = declareWorkflow({
255
+ name: "multi-version",
256
+ version: "v2"
257
+ });
258
+ // no throwing...
259
+ client.implementWorkflow(specV1, noopFn);
260
+ client.implementWorkflow(specV2, noopFn);
261
+ });
262
+ test("implementWorkflow throws for same name+version combination", async ()=>{
263
+ const client = new OpenWorkflow({
264
+ backend
265
+ });
266
+ const spec1 = declareWorkflow({
267
+ name: "version-duplicate",
268
+ version: "v1"
269
+ });
270
+ const spec2 = declareWorkflow({
271
+ name: "version-duplicate",
272
+ version: "v1"
273
+ });
274
+ client.implementWorkflow(spec1, noopFn);
275
+ expect(()=>{
276
+ client.implementWorkflow(spec2, noopFn);
277
+ }).toThrow('Workflow "version-duplicate" (version: v1) is already registered');
278
+ });
279
+ test("declareWorkflow with schema validates input on runWorkflow", async ()=>{
280
+ const client = new OpenWorkflow({
281
+ backend
282
+ });
283
+ const schema = z.object({
284
+ email: z.email()
285
+ });
286
+ const spec = declareWorkflow({
287
+ name: "declare-schema-test",
288
+ schema
289
+ });
290
+ const handle = await client.runWorkflow(spec, {
291
+ email: "test@example.com"
292
+ });
293
+ await handle.cancel();
294
+ await expect(client.runWorkflow(spec, {
295
+ email: "not-an-email"
296
+ })).rejects.toThrow();
297
+ });
298
+ test("declareWorkflow with version sets version on workflow run", async ()=>{
299
+ const client = new OpenWorkflow({
300
+ backend
301
+ });
302
+ const spec = declareWorkflow({
303
+ name: "declare-version-test",
304
+ version: "v1.2.3"
305
+ });
306
+ const handle = await client.runWorkflow(spec);
307
+ expect(handle.workflowRun.version).toBe("v1.2.3");
308
+ await handle.cancel();
309
+ });
310
+ test("defineWorkflow wraps declareWorkflow and implementWorkflow", async ()=>{
311
+ const client = new OpenWorkflow({
312
+ backend
313
+ });
314
+ const workflow = client.defineWorkflow({
315
+ name: "define-wrap-test"
316
+ }, ({ input })=>({
317
+ doubled: input.n * 2
318
+ }));
319
+ const handle = await workflow.run({
320
+ n: 21
321
+ });
322
+ const worker = client.newWorker();
323
+ await worker.tick();
324
+ await sleep(100); // wait for background execution
325
+ const result = await handle.result();
326
+ expect(result).toEqual({
327
+ doubled: 42
328
+ });
329
+ });
330
+ });
331
+ });
332
+ function sleep(ms) {
333
+ return new Promise((resolve)=>setTimeout(resolve, ms));
334
+ }
335
+ async function noopFn() {
336
+ // no-op
337
+ }
338
+
339
+ //# sourceMappingURL=client.test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/client.test.ts"],"sourcesContent":["import { randomUUID } from \"node:crypto\";\nimport { afterEach, beforeEach, describe, expect, test } from \"vitest\";\nimport { z } from \"zod\";\nimport { BackendPostgres } from \".\";\nimport { declareWorkflow, OpenWorkflow } from \"./client\";\nimport { KNEX_GLOBAL_CONFIG } from \"./testing/connection\";\n\ndescribe(\"OpenWorkflow\", () => {\n let backend: BackendPostgres;\n\n beforeEach(async () => {\n backend = await BackendPostgres.connect(KNEX_GLOBAL_CONFIG, {\n namespaceId: randomUUID(),\n runMigrations: false,\n });\n });\n\n afterEach(async () => {\n await backend.stop();\n });\n\n test(\"enqueues workflow runs via backend\", async () => {\n const client = new OpenWorkflow({ backend });\n\n const workflow = client.defineWorkflow({ name: \"enqueue-test\" }, noopFn);\n await workflow.run({ docUrl: \"https://example.com\" });\n\n const workerId = \"enqueue-worker\";\n const claimed = await backend.claimWorkflowRun({\n workerId,\n leaseDurationMs: 1000,\n });\n\n expect(claimed?.workflowName).toBe(\"enqueue-test\");\n expect(claimed?.workerId).toBe(workerId);\n expect(claimed?.input).toEqual({ docUrl: \"https://example.com\" });\n });\n\n describe(\"schema validation\", () => {\n describe(\"Zod schema\", () => {\n const schema = z.object({\n userId: z.uuid(),\n count: z.number().int().positive(),\n });\n\n test(\"accepts valid input\", async () => {\n const client = new OpenWorkflow({ backend });\n const workflow = client.defineWorkflow({ name: \"schema-zod-valid\", schema }, noopFn);\n\n const handle = await workflow.run({\n userId: randomUUID(),\n count: 3,\n });\n\n await handle.cancel();\n });\n\n test(\"rejects invalid input\", async () => {\n const client = new OpenWorkflow({ backend });\n const workflow = client.defineWorkflow({ name: \"schema-zod-invalid\", schema }, noopFn);\n\n await expect(workflow.run({ userId: \"not-a-uuid\", count: 0 } as never)).rejects.toThrow();\n });\n });\n });\n\n test(\"result resolves when workflow succeeds\", async () => {\n const client = new OpenWorkflow({ backend });\n\n const workflow = client.defineWorkflow({ name: \"result-success\" }, noopFn);\n const handle = await workflow.run({ value: 1 });\n\n const workerId = \"test-worker\";\n const claimed = await backend.claimWorkflowRun({\n workerId,\n leaseDurationMs: 1000,\n });\n expect(claimed).not.toBeNull();\n if (!claimed) throw new Error(\"workflow run was not claimed\");\n\n await backend.completeWorkflowRun({\n workflowRunId: claimed.id,\n workerId,\n output: { ok: true },\n });\n\n // eslint-disable-next-line @typescript-eslint/no-confusing-void-expression\n const result = await handle.result();\n expect(result).toEqual({ ok: true });\n });\n\n test(\"result rejects when workflow fails\", async () => {\n const client = new OpenWorkflow({ backend });\n\n const workflow = client.defineWorkflow({ name: \"result-failure\" }, noopFn);\n await workflow.run({ value: 1 });\n\n const workerId = \"test-worker\";\n const claimed = await backend.claimWorkflowRun({\n workerId,\n leaseDurationMs: 1000,\n });\n expect(claimed).not.toBeNull();\n if (!claimed) throw new Error(\"workflow run was not claimed\");\n\n // mark as failed (should reschedule))\n await backend.failWorkflowRun({\n workflowRunId: claimed.id,\n workerId,\n error: { message: \"boom\" },\n });\n\n const rescheduled = await backend.getWorkflowRun({\n workflowRunId: claimed.id,\n });\n expect(rescheduled?.status).toBe(\"pending\");\n expect(rescheduled?.error).toEqual({ message: \"boom\" });\n });\n\n test(\"creates workflow run with deadline\", async () => {\n const client = new OpenWorkflow({ backend });\n\n const workflow = client.defineWorkflow({ name: \"deadline-test\" }, noopFn);\n const deadline = new Date(Date.now() + 60_000); // in 1 minute\n const handle = await workflow.run({ value: 1 }, { deadlineAt: deadline });\n\n expect(handle.workflowRun.deadlineAt).not.toBeNull();\n expect(handle.workflowRun.deadlineAt?.getTime()).toBe(deadline.getTime());\n });\n\n test(\"creates workflow run with version\", async () => {\n const client = new OpenWorkflow({ backend });\n\n const workflow = client.defineWorkflow({ name: \"versioned-test\", version: \"v2.0\" }, noopFn);\n const handle = await workflow.run({ value: 1 });\n\n expect(handle.workflowRun.version).toBe(\"v2.0\");\n });\n\n test(\"creates workflow run without version\", async () => {\n const client = new OpenWorkflow({ backend });\n\n const workflow = client.defineWorkflow({ name: \"unversioned-test\" }, noopFn);\n const handle = await workflow.run({ value: 1 });\n\n expect(handle.workflowRun.version).toBeNull();\n });\n\n test(\"cancels workflow run via handle\", async () => {\n const client = new OpenWorkflow({ backend });\n\n const workflow = client.defineWorkflow({ name: \"cancel-test\" }, noopFn);\n const handle = await workflow.run({ value: 1 });\n\n await handle.cancel();\n\n const workflowRun = await backend.getWorkflowRun({\n workflowRunId: handle.workflowRun.id,\n });\n expect(workflowRun?.status).toBe(\"canceled\");\n expect(workflowRun?.finishedAt).not.toBeNull();\n });\n\n describe(\"declareWorkflow / implementWorkflow API\", () => {\n test(\"declareWorkflow returns a spec that can be used to schedule runs\", async () => {\n const client = new OpenWorkflow({ backend });\n\n const spec = declareWorkflow({ name: \"declare-test\" });\n\n const handle = await client.runWorkflow(spec, { message: \"hello\" });\n expect(handle.workflowRun.workflowName).toBe(\"declare-test\");\n\n await handle.cancel();\n });\n\n test(\"implementWorkflow registers the workflow for worker execution\", async () => {\n const client = new OpenWorkflow({ backend });\n\n const spec = declareWorkflow({ name: \"implement-test\" });\n client.implementWorkflow(spec, ({ input }) => {\n return { received: input };\n });\n\n const handle = await client.runWorkflow(spec, { data: 42 });\n const worker = client.newWorker();\n await worker.tick();\n await sleep(100); // wait for background execution\n\n const result = await handle.result();\n expect(result).toEqual({ received: { data: 42 } });\n });\n\n test(\"implementWorkflow throws when workflow is already registered\", async () => {\n const client = new OpenWorkflow({ backend });\n\n const spec = declareWorkflow({ name: \"duplicate-test\" });\n client.implementWorkflow(spec, noopFn);\n\n expect(() => {\n client.implementWorkflow(spec, noopFn);\n }).toThrow('Workflow \"duplicate-test\" is already registered');\n });\n\n test(\"implementWorkflow allows registering different versions of the same workflow\", async () => {\n const client = new OpenWorkflow({ backend });\n\n const specV1 = declareWorkflow({\n name: \"multi-version\",\n version: \"v1\",\n });\n const specV2 = declareWorkflow({\n name: \"multi-version\",\n version: \"v2\",\n });\n\n // no throwing...\n client.implementWorkflow(specV1, noopFn);\n client.implementWorkflow(specV2, noopFn);\n });\n\n test(\"implementWorkflow throws for same name+version combination\", async () => {\n const client = new OpenWorkflow({ backend });\n\n const spec1 = declareWorkflow({\n name: \"version-duplicate\",\n version: \"v1\",\n });\n const spec2 = declareWorkflow({\n name: \"version-duplicate\",\n version: \"v1\",\n });\n\n client.implementWorkflow(spec1, noopFn);\n\n expect(() => {\n client.implementWorkflow(spec2, noopFn);\n }).toThrow('Workflow \"version-duplicate\" (version: v1) is already registered');\n });\n\n test(\"declareWorkflow with schema validates input on runWorkflow\", async () => {\n const client = new OpenWorkflow({ backend });\n\n const schema = z.object({\n email: z.email(),\n });\n const spec = declareWorkflow({\n name: \"declare-schema-test\",\n schema,\n });\n\n const handle = await client.runWorkflow(spec, {\n email: \"test@example.com\",\n });\n await handle.cancel();\n\n await expect(client.runWorkflow(spec, { email: \"not-an-email\" })).rejects.toThrow();\n });\n\n test(\"declareWorkflow with version sets version on workflow run\", async () => {\n const client = new OpenWorkflow({ backend });\n\n const spec = declareWorkflow({\n name: \"declare-version-test\",\n version: \"v1.2.3\",\n });\n\n const handle = await client.runWorkflow(spec);\n expect(handle.workflowRun.version).toBe(\"v1.2.3\");\n\n await handle.cancel();\n });\n\n test(\"defineWorkflow wraps declareWorkflow and implementWorkflow\", async () => {\n const client = new OpenWorkflow({ backend });\n\n const workflow = client.defineWorkflow({ name: \"define-wrap-test\" }, ({ input }) => ({\n doubled: (input as { n: number }).n * 2,\n }));\n\n const handle = await workflow.run({ n: 21 });\n const worker = client.newWorker();\n await worker.tick();\n await sleep(100); // wait for background execution\n\n const result = await handle.result();\n expect(result).toEqual({ doubled: 42 });\n });\n });\n});\n\nfunction sleep(ms: number): Promise<void> {\n return new Promise((resolve) => setTimeout(resolve, ms));\n}\n\nasync function noopFn() {\n // no-op\n}\n"],"names":["randomUUID","afterEach","beforeEach","describe","expect","test","z","BackendPostgres","declareWorkflow","OpenWorkflow","KNEX_GLOBAL_CONFIG","backend","connect","namespaceId","runMigrations","stop","client","workflow","defineWorkflow","name","noopFn","run","docUrl","workerId","claimed","claimWorkflowRun","leaseDurationMs","workflowName","toBe","input","toEqual","schema","object","userId","uuid","count","number","int","positive","handle","cancel","rejects","toThrow","value","not","toBeNull","Error","completeWorkflowRun","workflowRunId","id","output","ok","result","failWorkflowRun","error","message","rescheduled","getWorkflowRun","status","deadline","Date","now","deadlineAt","workflowRun","getTime","version","finishedAt","spec","runWorkflow","implementWorkflow","received","data","worker","newWorker","tick","sleep","specV1","specV2","spec1","spec2","email","doubled","n","ms","Promise","resolve","setTimeout"],"mappings":"AAAA,SAASA,UAAU,QAAQ,cAAc;AACzC,SAASC,SAAS,EAAEC,UAAU,EAAEC,QAAQ,EAAEC,MAAM,EAAEC,IAAI,QAAQ,SAAS;AACvE,SAASC,CAAC,QAAQ,MAAM;AACxB,SAASC,eAAe,QAAQ,aAAI;AACpC,SAASC,eAAe,EAAEC,YAAY,QAAQ,cAAW;AACzD,SAASC,kBAAkB,QAAQ,0BAAuB;AAE1DP,SAAS,gBAAgB;IACvB,IAAIQ;IAEJT,WAAW;QACTS,UAAU,MAAMJ,gBAAgBK,OAAO,CAACF,oBAAoB;YAC1DG,aAAab;YACbc,eAAe;QACjB;IACF;IAEAb,UAAU;QACR,MAAMU,QAAQI,IAAI;IACpB;IAEAV,KAAK,sCAAsC;QACzC,MAAMW,SAAS,IAAIP,aAAa;YAAEE;QAAQ;QAE1C,MAAMM,WAAWD,OAAOE,cAAc,CAAC;YAAEC,MAAM;QAAe,GAAGC;QACjE,MAAMH,SAASI,GAAG,CAAC;YAAEC,QAAQ;QAAsB;QAEnD,MAAMC,WAAW;QACjB,MAAMC,UAAU,MAAMb,QAAQc,gBAAgB,CAAC;YAC7CF;YACAG,iBAAiB;QACnB;QAEAtB,OAAOoB,SAASG,cAAcC,IAAI,CAAC;QACnCxB,OAAOoB,SAASD,UAAUK,IAAI,CAACL;QAC/BnB,OAAOoB,SAASK,OAAOC,OAAO,CAAC;YAAER,QAAQ;QAAsB;IACjE;IAEAnB,SAAS,qBAAqB;QAC5BA,SAAS,cAAc;YACrB,MAAM4B,SAASzB,EAAE0B,MAAM,CAAC;gBACtBC,QAAQ3B,EAAE4B,IAAI;gBACdC,OAAO7B,EAAE8B,MAAM,GAAGC,GAAG,GAAGC,QAAQ;YAClC;YAEAjC,KAAK,uBAAuB;gBAC1B,MAAMW,SAAS,IAAIP,aAAa;oBAAEE;gBAAQ;gBAC1C,MAAMM,WAAWD,OAAOE,cAAc,CAAC;oBAAEC,MAAM;oBAAoBY;gBAAO,GAAGX;gBAE7E,MAAMmB,SAAS,MAAMtB,SAASI,GAAG,CAAC;oBAChCY,QAAQjC;oBACRmC,OAAO;gBACT;gBAEA,MAAMI,OAAOC,MAAM;YACrB;YAEAnC,KAAK,yBAAyB;gBAC5B,MAAMW,SAAS,IAAIP,aAAa;oBAAEE;gBAAQ;gBAC1C,MAAMM,WAAWD,OAAOE,cAAc,CAAC;oBAAEC,MAAM;oBAAsBY;gBAAO,GAAGX;gBAE/E,MAAMhB,OAAOa,SAASI,GAAG,CAAC;oBAAEY,QAAQ;oBAAcE,OAAO;gBAAE,IAAaM,OAAO,CAACC,OAAO;YACzF;QACF;IACF;IAEArC,KAAK,0CAA0C;QAC7C,MAAMW,SAAS,IAAIP,aAAa;YAAEE;QAAQ;QAE1C,MAAMM,WAAWD,OAAOE,cAAc,CAAC;YAAEC,MAAM;QAAiB,GAAGC;QACnE,MAAMmB,SAAS,MAAMtB,SAASI,GAAG,CAAC;YAAEsB,OAAO;QAAE;QAE7C,MAAMpB,WAAW;QACjB,MAAMC,UAAU,MAAMb,QAAQc,gBAAgB,CAAC;YAC7CF;YACAG,iBAAiB;QACnB;QACAtB,OAAOoB,SAASoB,GAAG,CAACC,QAAQ;QAC5B,IAAI,CAACrB,SAAS,MAAM,IAAIsB,MAAM;QAE9B,MAAMnC,QAAQoC,mBAAmB,CAAC;YAChCC,eAAexB,QAAQyB,EAAE;YACzB1B;YACA2B,QAAQ;gBAAEC,IAAI;YAAK;QACrB;QAEA,2EAA2E;QAC3E,MAAMC,SAAS,MAAMb,OAAOa,MAAM;QAClChD,OAAOgD,QAAQtB,OAAO,CAAC;YAAEqB,IAAI;QAAK;IACpC;IAEA9C,KAAK,sCAAsC;QACzC,MAAMW,SAAS,IAAIP,aAAa;YAAEE;QAAQ;QAE1C,MAAMM,WAAWD,OAAOE,cAAc,CAAC;YAAEC,MAAM;QAAiB,GAAGC;QACnE,MAAMH,SAASI,GAAG,CAAC;YAAEsB,OAAO;QAAE;QAE9B,MAAMpB,WAAW;QACjB,MAAMC,UAAU,MAAMb,QAAQc,gBAAgB,CAAC;YAC7CF;YACAG,iBAAiB;QACnB;QACAtB,OAAOoB,SAASoB,GAAG,CAACC,QAAQ;QAC5B,IAAI,CAACrB,SAAS,MAAM,IAAIsB,MAAM;QAE9B,sCAAsC;QACtC,MAAMnC,QAAQ0C,eAAe,CAAC;YAC5BL,eAAexB,QAAQyB,EAAE;YACzB1B;YACA+B,OAAO;gBAAEC,SAAS;YAAO;QAC3B;QAEA,MAAMC,cAAc,MAAM7C,QAAQ8C,cAAc,CAAC;YAC/CT,eAAexB,QAAQyB,EAAE;QAC3B;QACA7C,OAAOoD,aAAaE,QAAQ9B,IAAI,CAAC;QACjCxB,OAAOoD,aAAaF,OAAOxB,OAAO,CAAC;YAAEyB,SAAS;QAAO;IACvD;IAEAlD,KAAK,sCAAsC;QACzC,MAAMW,SAAS,IAAIP,aAAa;YAAEE;QAAQ;QAE1C,MAAMM,WAAWD,OAAOE,cAAc,CAAC;YAAEC,MAAM;QAAgB,GAAGC;QAClE,MAAMuC,WAAW,IAAIC,KAAKA,KAAKC,GAAG,KAAK,SAAS,cAAc;QAC9D,MAAMtB,SAAS,MAAMtB,SAASI,GAAG,CAAC;YAAEsB,OAAO;QAAE,GAAG;YAAEmB,YAAYH;QAAS;QAEvEvD,OAAOmC,OAAOwB,WAAW,CAACD,UAAU,EAAElB,GAAG,CAACC,QAAQ;QAClDzC,OAAOmC,OAAOwB,WAAW,CAACD,UAAU,EAAEE,WAAWpC,IAAI,CAAC+B,SAASK,OAAO;IACxE;IAEA3D,KAAK,qCAAqC;QACxC,MAAMW,SAAS,IAAIP,aAAa;YAAEE;QAAQ;QAE1C,MAAMM,WAAWD,OAAOE,cAAc,CAAC;YAAEC,MAAM;YAAkB8C,SAAS;QAAO,GAAG7C;QACpF,MAAMmB,SAAS,MAAMtB,SAASI,GAAG,CAAC;YAAEsB,OAAO;QAAE;QAE7CvC,OAAOmC,OAAOwB,WAAW,CAACE,OAAO,EAAErC,IAAI,CAAC;IAC1C;IAEAvB,KAAK,wCAAwC;QAC3C,MAAMW,SAAS,IAAIP,aAAa;YAAEE;QAAQ;QAE1C,MAAMM,WAAWD,OAAOE,cAAc,CAAC;YAAEC,MAAM;QAAmB,GAAGC;QACrE,MAAMmB,SAAS,MAAMtB,SAASI,GAAG,CAAC;YAAEsB,OAAO;QAAE;QAE7CvC,OAAOmC,OAAOwB,WAAW,CAACE,OAAO,EAAEpB,QAAQ;IAC7C;IAEAxC,KAAK,mCAAmC;QACtC,MAAMW,SAAS,IAAIP,aAAa;YAAEE;QAAQ;QAE1C,MAAMM,WAAWD,OAAOE,cAAc,CAAC;YAAEC,MAAM;QAAc,GAAGC;QAChE,MAAMmB,SAAS,MAAMtB,SAASI,GAAG,CAAC;YAAEsB,OAAO;QAAE;QAE7C,MAAMJ,OAAOC,MAAM;QAEnB,MAAMuB,cAAc,MAAMpD,QAAQ8C,cAAc,CAAC;YAC/CT,eAAeT,OAAOwB,WAAW,CAACd,EAAE;QACtC;QACA7C,OAAO2D,aAAaL,QAAQ9B,IAAI,CAAC;QACjCxB,OAAO2D,aAAaG,YAAYtB,GAAG,CAACC,QAAQ;IAC9C;IAEA1C,SAAS,2CAA2C;QAClDE,KAAK,oEAAoE;YACvE,MAAMW,SAAS,IAAIP,aAAa;gBAAEE;YAAQ;YAE1C,MAAMwD,OAAO3D,gBAAgB;gBAAEW,MAAM;YAAe;YAEpD,MAAMoB,SAAS,MAAMvB,OAAOoD,WAAW,CAACD,MAAM;gBAAEZ,SAAS;YAAQ;YACjEnD,OAAOmC,OAAOwB,WAAW,CAACpC,YAAY,EAAEC,IAAI,CAAC;YAE7C,MAAMW,OAAOC,MAAM;QACrB;QAEAnC,KAAK,iEAAiE;YACpE,MAAMW,SAAS,IAAIP,aAAa;gBAAEE;YAAQ;YAE1C,MAAMwD,OAAO3D,gBAAgB;gBAAEW,MAAM;YAAiB;YACtDH,OAAOqD,iBAAiB,CAACF,MAAM,CAAC,EAAEtC,KAAK,EAAE;gBACvC,OAAO;oBAAEyC,UAAUzC;gBAAM;YAC3B;YAEA,MAAMU,SAAS,MAAMvB,OAAOoD,WAAW,CAACD,MAAM;gBAAEI,MAAM;YAAG;YACzD,MAAMC,SAASxD,OAAOyD,SAAS;YAC/B,MAAMD,OAAOE,IAAI;YACjB,MAAMC,MAAM,MAAM,gCAAgC;YAElD,MAAMvB,SAAS,MAAMb,OAAOa,MAAM;YAClChD,OAAOgD,QAAQtB,OAAO,CAAC;gBAAEwC,UAAU;oBAAEC,MAAM;gBAAG;YAAE;QAClD;QAEAlE,KAAK,gEAAgE;YACnE,MAAMW,SAAS,IAAIP,aAAa;gBAAEE;YAAQ;YAE1C,MAAMwD,OAAO3D,gBAAgB;gBAAEW,MAAM;YAAiB;YACtDH,OAAOqD,iBAAiB,CAACF,MAAM/C;YAE/BhB,OAAO;gBACLY,OAAOqD,iBAAiB,CAACF,MAAM/C;YACjC,GAAGsB,OAAO,CAAC;QACb;QAEArC,KAAK,gFAAgF;YACnF,MAAMW,SAAS,IAAIP,aAAa;gBAAEE;YAAQ;YAE1C,MAAMiE,SAASpE,gBAAgB;gBAC7BW,MAAM;gBACN8C,SAAS;YACX;YACA,MAAMY,SAASrE,gBAAgB;gBAC7BW,MAAM;gBACN8C,SAAS;YACX;YAEA,iBAAiB;YACjBjD,OAAOqD,iBAAiB,CAACO,QAAQxD;YACjCJ,OAAOqD,iBAAiB,CAACQ,QAAQzD;QACnC;QAEAf,KAAK,8DAA8D;YACjE,MAAMW,SAAS,IAAIP,aAAa;gBAAEE;YAAQ;YAE1C,MAAMmE,QAAQtE,gBAAgB;gBAC5BW,MAAM;gBACN8C,SAAS;YACX;YACA,MAAMc,QAAQvE,gBAAgB;gBAC5BW,MAAM;gBACN8C,SAAS;YACX;YAEAjD,OAAOqD,iBAAiB,CAACS,OAAO1D;YAEhChB,OAAO;gBACLY,OAAOqD,iBAAiB,CAACU,OAAO3D;YAClC,GAAGsB,OAAO,CAAC;QACb;QAEArC,KAAK,8DAA8D;YACjE,MAAMW,SAAS,IAAIP,aAAa;gBAAEE;YAAQ;YAE1C,MAAMoB,SAASzB,EAAE0B,MAAM,CAAC;gBACtBgD,OAAO1E,EAAE0E,KAAK;YAChB;YACA,MAAMb,OAAO3D,gBAAgB;gBAC3BW,MAAM;gBACNY;YACF;YAEA,MAAMQ,SAAS,MAAMvB,OAAOoD,WAAW,CAACD,MAAM;gBAC5Ca,OAAO;YACT;YACA,MAAMzC,OAAOC,MAAM;YAEnB,MAAMpC,OAAOY,OAAOoD,WAAW,CAACD,MAAM;gBAAEa,OAAO;YAAe,IAAIvC,OAAO,CAACC,OAAO;QACnF;QAEArC,KAAK,6DAA6D;YAChE,MAAMW,SAAS,IAAIP,aAAa;gBAAEE;YAAQ;YAE1C,MAAMwD,OAAO3D,gBAAgB;gBAC3BW,MAAM;gBACN8C,SAAS;YACX;YAEA,MAAM1B,SAAS,MAAMvB,OAAOoD,WAAW,CAACD;YACxC/D,OAAOmC,OAAOwB,WAAW,CAACE,OAAO,EAAErC,IAAI,CAAC;YAExC,MAAMW,OAAOC,MAAM;QACrB;QAEAnC,KAAK,8DAA8D;YACjE,MAAMW,SAAS,IAAIP,aAAa;gBAAEE;YAAQ;YAE1C,MAAMM,WAAWD,OAAOE,cAAc,CAAC;gBAAEC,MAAM;YAAmB,GAAG,CAAC,EAAEU,KAAK,EAAE,GAAM,CAAA;oBACnFoD,SAAS,AAACpD,MAAwBqD,CAAC,GAAG;gBACxC,CAAA;YAEA,MAAM3C,SAAS,MAAMtB,SAASI,GAAG,CAAC;gBAAE6D,GAAG;YAAG;YAC1C,MAAMV,SAASxD,OAAOyD,SAAS;YAC/B,MAAMD,OAAOE,IAAI;YACjB,MAAMC,MAAM,MAAM,gCAAgC;YAElD,MAAMvB,SAAS,MAAMb,OAAOa,MAAM;YAClChD,OAAOgD,QAAQtB,OAAO,CAAC;gBAAEmD,SAAS;YAAG;QACvC;IACF;AACF;AAEA,SAASN,MAAMQ,EAAU;IACvB,OAAO,IAAIC,QAAQ,CAACC,UAAYC,WAAWD,SAASF;AACtD;AAEA,eAAe/D;AACb,QAAQ;AACV"}
@@ -0,0 +1,22 @@
1
+ import type { Backend } from "./backend";
2
+ import type { WorkerOptions } from "./worker";
3
+ export interface OpenWorkflowConfig {
4
+ backend: Backend;
5
+ worker?: WorkerConfig;
6
+ }
7
+ export type WorkerConfig = Pick<WorkerOptions, "concurrency">;
8
+ /**
9
+ * Create a typed OpenWorkflow configuration.
10
+ * @param config - the config
11
+ * @returns the config
12
+ */
13
+ export declare function defineConfig(config: OpenWorkflowConfig): OpenWorkflowConfig;
14
+ /**
15
+ * Load the OpenWorkflow config at openworkflow.config.ts (or other extension;
16
+ * see https://github.com/unjs/c12)
17
+ * @param rootDir - Optional root directory to search from (defaults to
18
+ * process.cwd())
19
+ * @returns The loaded configuration and metadata
20
+ */
21
+ export declare function loadConfig(rootDir?: string): Promise<import("c12").ResolvedConfig<OpenWorkflowConfig, import("c12").ConfigLayerMeta>>;
22
+ //# sourceMappingURL=config.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAE9C,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,CAAC,EAAE,YAAY,CAAC;CACvB;AAED,MAAM,MAAM,YAAY,GAAG,IAAI,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC;AAE9D;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,kBAAkB,GAAG,kBAAkB,CAE3E;AAED;;;;;;GAMG;AACH,wBAAsB,UAAU,CAAC,OAAO,CAAC,EAAE,MAAM,4FAOhD"}