@voyant-travel/workflow-runs 0.107.10
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/LICENSE +201 -0
- package/README.md +175 -0
- package/dist/index.d.ts +25 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +24 -0
- package/dist/recorder.d.ts +77 -0
- package/dist/recorder.d.ts.map +1 -0
- package/dist/recorder.js +242 -0
- package/dist/routes.d.ts +43 -0
- package/dist/routes.d.ts.map +1 -0
- package/dist/routes.js +311 -0
- package/dist/runner.d.ts +121 -0
- package/dist/runner.d.ts.map +1 -0
- package/dist/runner.js +45 -0
- package/dist/schema.d.ts +515 -0
- package/dist/schema.d.ts.map +1 -0
- package/dist/schema.js +97 -0
- package/dist/service.d.ts +32 -0
- package/dist/service.d.ts.map +1 -0
- package/dist/service.js +55 -0
- package/dist/workflows.d.ts +38 -0
- package/dist/workflows.d.ts.map +1 -0
- package/dist/workflows.js +154 -0
- package/package.json +80 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for describing the origin of the Work and
|
|
141
|
+
reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may accept and charge a
|
|
167
|
+
fee for, the acceptance of support, warranty, indemnity, or
|
|
168
|
+
other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2026 PixelMakers Studio SRL
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,175 @@
|
|
|
1
|
+
# @voyant-travel/workflow-runs
|
|
2
|
+
|
|
3
|
+
Workflow run recording, admin routes, and rerun/resume dispatch primitives for Voyant operator apps.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
pnpm add @voyant-travel/workflow-runs
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
The package is independently published with the rest of the workflows release cohort.
|
|
12
|
+
|
|
13
|
+
For the matching importable React admin surface, install
|
|
14
|
+
`@voyant-travel/workflows-react/ui` and point its API client at the routes mounted by
|
|
15
|
+
this package:
|
|
16
|
+
|
|
17
|
+
```tsx
|
|
18
|
+
import {
|
|
19
|
+
createWorkflowRunsApiClient,
|
|
20
|
+
WorkflowRunsPage,
|
|
21
|
+
} from "@voyant-travel/workflows-react/ui"
|
|
22
|
+
|
|
23
|
+
const workflowRunsApi = createWorkflowRunsApiClient({ apiBase: "/api" })
|
|
24
|
+
|
|
25
|
+
export function WorkflowsRoute() {
|
|
26
|
+
return <WorkflowRunsPage api={workflowRunsApi} />
|
|
27
|
+
}
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## Mount the admin routes
|
|
31
|
+
|
|
32
|
+
`mountWorkflowRunsAdminRoutes` adds the workflow-run list, detail, rerun, and resume endpoints under `/v1/admin/workflow-runs`, plus an explicit trigger endpoint at `POST /v1/admin/workflows/:name/runs`.
|
|
33
|
+
|
|
34
|
+
```ts
|
|
35
|
+
import { mountWorkflowRunsAdminRoutes, WorkflowRunnerRegistry } from "@voyant-travel/workflow-runs"
|
|
36
|
+
import { createNodeSelfHostWorkflowClient } from "@voyant-travel/workflows-orchestrator-node"
|
|
37
|
+
|
|
38
|
+
const workflowRunnerRegistry = new WorkflowRunnerRegistry()
|
|
39
|
+
const workflowServer = createNodeSelfHostWorkflowClient({
|
|
40
|
+
baseUrl: process.env.WORKFLOW_SERVER_URL!,
|
|
41
|
+
})
|
|
42
|
+
|
|
43
|
+
workflowRunnerRegistry.register({
|
|
44
|
+
name: "checkout-finalize",
|
|
45
|
+
idempotency: "unsafe",
|
|
46
|
+
description:
|
|
47
|
+
"Confirms the booking and issues the final invoice. Use Resume to retry from a failed step.",
|
|
48
|
+
trigger: async (input, ctx) => {
|
|
49
|
+
const saved = await workflowServer.trigger({
|
|
50
|
+
workflowId: "checkout-finalize",
|
|
51
|
+
input,
|
|
52
|
+
tags: ctx.tags,
|
|
53
|
+
triggeredByUserId: ctx.triggeredByUserId,
|
|
54
|
+
})
|
|
55
|
+
return { runId: saved.id }
|
|
56
|
+
},
|
|
57
|
+
rerun: async (input, ctx) => {
|
|
58
|
+
const saved = await workflowServer.trigger({
|
|
59
|
+
workflowId: "checkout-finalize",
|
|
60
|
+
input,
|
|
61
|
+
tags: [...ctx.tags, "rerun:true"],
|
|
62
|
+
})
|
|
63
|
+
return { runId: saved.id }
|
|
64
|
+
},
|
|
65
|
+
resume: async (input, ctx) => {
|
|
66
|
+
const { saved } = await workflowServer.resume(ctx.parentRunId, {
|
|
67
|
+
workflowId: "checkout-finalize",
|
|
68
|
+
input,
|
|
69
|
+
resumeFromStep: ctx.resumeFromStep,
|
|
70
|
+
seedResults: ctx.seedResults,
|
|
71
|
+
tags: [...ctx.tags, "resume:true"],
|
|
72
|
+
triggeredByUserId: ctx.triggeredByUserId,
|
|
73
|
+
})
|
|
74
|
+
return { runId: saved.id }
|
|
75
|
+
},
|
|
76
|
+
})
|
|
77
|
+
|
|
78
|
+
mountWorkflowRunsAdminRoutes(hono, {
|
|
79
|
+
runners: workflowRunnerRegistry,
|
|
80
|
+
adminSurface: process.env.VOYANT_WORKFLOW_ADMIN_SURFACE as
|
|
81
|
+
| "tenant"
|
|
82
|
+
| "cloud"
|
|
83
|
+
| "disabled"
|
|
84
|
+
| undefined,
|
|
85
|
+
})
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
`adminSurface` controls tenant-admin workflow management actions:
|
|
89
|
+
|
|
90
|
+
- `tenant` keeps local/self-host trigger, rerun, and resume routes available.
|
|
91
|
+
- `cloud` keeps read routes available but rejects tenant-admin trigger, rerun,
|
|
92
|
+
and resume routes because the Voyant Cloud dashboard is the workflow control
|
|
93
|
+
plane for managed deployments.
|
|
94
|
+
- `disabled` keeps read routes available and disables tenant-admin management
|
|
95
|
+
actions completely.
|
|
96
|
+
|
|
97
|
+
When omitted, the package reads `VOYANT_WORKFLOW_ADMIN_SURFACE`. If that is
|
|
98
|
+
unset but managed Cloud workflow env is present, the default is `cloud`;
|
|
99
|
+
otherwise the default is `tenant` for local/self-host compatibility.
|
|
100
|
+
|
|
101
|
+
Triggerable workflows must opt in by implementing `trigger(...)` on their registered runner. This keeps rerun/resume-only workflows closed to arbitrary admin dispatch while still allowing operators, cron jobs, queues, and API keys with `workflows:trigger` permission to call:
|
|
102
|
+
|
|
103
|
+
```http
|
|
104
|
+
POST /v1/admin/workflows/checkout-finalize/runs
|
|
105
|
+
Content-Type: application/json
|
|
106
|
+
|
|
107
|
+
{
|
|
108
|
+
"input": { "bookingId": "bk_123" },
|
|
109
|
+
"idempotencyKey": "checkout-finalize:bk_123",
|
|
110
|
+
"correlationId": "bk_123",
|
|
111
|
+
"tags": ["source:admin"]
|
|
112
|
+
}
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
The route returns `202 Accepted` with the queued run id:
|
|
116
|
+
|
|
117
|
+
```json
|
|
118
|
+
{
|
|
119
|
+
"data": {
|
|
120
|
+
"runId": "wfrn_...",
|
|
121
|
+
"workflowName": "checkout-finalize",
|
|
122
|
+
"status": "queued"
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
For self-hosted workflow services, keep runner registration close to the code that mounts the workflow service. The registry should dispatch to your external workflow server instead of importing worker-only runtime code into the admin API process. The resume path sends `ctx.resumeFromStep` plus `ctx.seedResults`; the self-host server starts a new run, pre-populates the journal with the seeded step outputs, and executes from the failed step onward.
|
|
128
|
+
|
|
129
|
+
## Record `@voyant-travel/workflows` executions
|
|
130
|
+
|
|
131
|
+
Use `recordedWorkflow` as a drop-in replacement for `workflow(...)` when a
|
|
132
|
+
workflow should appear in the workflow runs admin UI. The helper records start,
|
|
133
|
+
success, and failure rows in `workflow_runs` without repeating recorder
|
|
134
|
+
boilerplate in every workflow body.
|
|
135
|
+
|
|
136
|
+
```ts
|
|
137
|
+
import { recordedWorkflow } from "@voyant-travel/workflow-runs"
|
|
138
|
+
|
|
139
|
+
export const generatePdfWorkflow = recordedWorkflow({
|
|
140
|
+
id: "products.generate-pdf",
|
|
141
|
+
tags: ["products"],
|
|
142
|
+
async run(input, ctx) {
|
|
143
|
+
const renderer = ctx.services.resolve("products:pdf-renderer")
|
|
144
|
+
return renderer.generate(input)
|
|
145
|
+
},
|
|
146
|
+
})
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
By default, `recordedWorkflow` resolves a Drizzle database from
|
|
150
|
+
`ctx.services.resolve("db")`. It records the workflow id, trigger, run id as the
|
|
151
|
+
correlation id, configured/runtime tags, input, result, parent run id for child
|
|
152
|
+
workflow triggers, and errors. Recording is best-effort: database or serializer
|
|
153
|
+
failures do not fail the workflow execution.
|
|
154
|
+
|
|
155
|
+
You can customize the database service key or payload serializers:
|
|
156
|
+
|
|
157
|
+
```ts
|
|
158
|
+
export const syncCatalogWorkflow = recordedWorkflow(
|
|
159
|
+
{
|
|
160
|
+
id: "catalog.sync",
|
|
161
|
+
async run(input, ctx) {
|
|
162
|
+
return ctx.services.resolve("catalog:sync").run(input)
|
|
163
|
+
},
|
|
164
|
+
},
|
|
165
|
+
{
|
|
166
|
+
dbServiceName: "postgres",
|
|
167
|
+
input: ({ input }) => ({ catalogId: input.catalogId }),
|
|
168
|
+
result: ({ output }) => ({ changed: output.changed }),
|
|
169
|
+
},
|
|
170
|
+
)
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
This helper only records observability data. Trigger, rerun, and resume support
|
|
174
|
+
still uses `WorkflowRunnerRegistry` registration so apps can choose which
|
|
175
|
+
workflows are safe to dispatch from the admin UI.
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* `@voyant-travel/workflow-runs` — passive observability for in-process
|
|
3
|
+
* workflows.
|
|
4
|
+
*
|
|
5
|
+
* The package gives templates two things:
|
|
6
|
+
*
|
|
7
|
+
* 1. A `recordWorkflowRun` / recorder API that writes lifecycle
|
|
8
|
+
* rows into `workflow_runs` + `workflow_run_steps` as a
|
|
9
|
+
* workflow runs. Edge-compatible — postgres-js or neon-http.
|
|
10
|
+
* 2. A read-only Hono router (`createWorkflowRunsAdminRoutes`)
|
|
11
|
+
* that serves `/v1/admin/workflow-runs[/:id]` for the standalone
|
|
12
|
+
* dashboard SPA in `apps/workflow-runs-dashboard/` to consume.
|
|
13
|
+
*
|
|
14
|
+
* Distinct from the durable `@voyant-travel/workflows` SDK — that one is
|
|
15
|
+
* the Cloud-orchestrated runtime; this one is the lightweight
|
|
16
|
+
* "what just happened?" log every template can ship without a
|
|
17
|
+
* separate worker process.
|
|
18
|
+
*/
|
|
19
|
+
export { type BeginWorkflowRunInput, beginWorkflowRun, type WorkflowRunRecorder, } from "./recorder.js";
|
|
20
|
+
export { mountWorkflowRunsAdminRoutes, resolveWorkflowAdminSurface, type WorkflowAdminSurface, } from "./routes.js";
|
|
21
|
+
export { type WorkflowIdempotency, type WorkflowRerunContext, type WorkflowResumeContext, type WorkflowRunner, WorkflowRunnerRegistry, type WorkflowTriggerContext, } from "./runner.js";
|
|
22
|
+
export { type NewWorkflowRun, type NewWorkflowRunStep, type WorkflowRun, type WorkflowRunErrorPayload, type WorkflowRunStep, workflowRunStatusEnum, workflowRunStepStatusEnum, workflowRunSteps, workflowRuns, } from "./schema.js";
|
|
23
|
+
export { type ListWorkflowRunsQuery, type ListWorkflowRunsResult, workflowRunsService, } from "./service.js";
|
|
24
|
+
export { type RecordedWorkflowOptions, type RecordedWorkflowResultContext, type RecordedWorkflowRunContext, recordedWorkflow, } from "./workflows.js";
|
|
25
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,EACL,KAAK,qBAAqB,EAC1B,gBAAgB,EAChB,KAAK,mBAAmB,GACzB,MAAM,eAAe,CAAA;AACtB,OAAO,EACL,4BAA4B,EAC5B,2BAA2B,EAC3B,KAAK,oBAAoB,GAC1B,MAAM,aAAa,CAAA;AACpB,OAAO,EACL,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,EAC1B,KAAK,cAAc,EACnB,sBAAsB,EACtB,KAAK,sBAAsB,GAC5B,MAAM,aAAa,CAAA;AACpB,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,kBAAkB,EACvB,KAAK,WAAW,EAChB,KAAK,uBAAuB,EAC5B,KAAK,eAAe,EACpB,qBAAqB,EACrB,yBAAyB,EACzB,gBAAgB,EAChB,YAAY,GACb,MAAM,aAAa,CAAA;AACpB,OAAO,EACL,KAAK,qBAAqB,EAC1B,KAAK,sBAAsB,EAC3B,mBAAmB,GACpB,MAAM,cAAc,CAAA;AACrB,OAAO,EACL,KAAK,uBAAuB,EAC5B,KAAK,6BAA6B,EAClC,KAAK,0BAA0B,EAC/B,gBAAgB,GACjB,MAAM,gBAAgB,CAAA"}
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* `@voyant-travel/workflow-runs` — passive observability for in-process
|
|
3
|
+
* workflows.
|
|
4
|
+
*
|
|
5
|
+
* The package gives templates two things:
|
|
6
|
+
*
|
|
7
|
+
* 1. A `recordWorkflowRun` / recorder API that writes lifecycle
|
|
8
|
+
* rows into `workflow_runs` + `workflow_run_steps` as a
|
|
9
|
+
* workflow runs. Edge-compatible — postgres-js or neon-http.
|
|
10
|
+
* 2. A read-only Hono router (`createWorkflowRunsAdminRoutes`)
|
|
11
|
+
* that serves `/v1/admin/workflow-runs[/:id]` for the standalone
|
|
12
|
+
* dashboard SPA in `apps/workflow-runs-dashboard/` to consume.
|
|
13
|
+
*
|
|
14
|
+
* Distinct from the durable `@voyant-travel/workflows` SDK — that one is
|
|
15
|
+
* the Cloud-orchestrated runtime; this one is the lightweight
|
|
16
|
+
* "what just happened?" log every template can ship without a
|
|
17
|
+
* separate worker process.
|
|
18
|
+
*/
|
|
19
|
+
export { beginWorkflowRun, } from "./recorder.js";
|
|
20
|
+
export { mountWorkflowRunsAdminRoutes, resolveWorkflowAdminSurface, } from "./routes.js";
|
|
21
|
+
export { WorkflowRunnerRegistry, } from "./runner.js";
|
|
22
|
+
export { workflowRunStatusEnum, workflowRunStepStatusEnum, workflowRunSteps, workflowRuns, } from "./schema.js";
|
|
23
|
+
export { workflowRunsService, } from "./service.js";
|
|
24
|
+
export { recordedWorkflow, } from "./workflows.js";
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Recorder API — wraps an in-process workflow run with start / step
|
|
3
|
+
* lifecycle / finish writes against the `workflow_runs` +
|
|
4
|
+
* `workflow_run_steps` tables.
|
|
5
|
+
*
|
|
6
|
+
* Designed for the `@voyant-travel/core/workflows` saga primitive:
|
|
7
|
+
* callers do
|
|
8
|
+
*
|
|
9
|
+
* const recorder = await beginWorkflowRun(db, { workflowName, ... })
|
|
10
|
+
* try {
|
|
11
|
+
* const result = await runFn(recorder)
|
|
12
|
+
* await recorder.complete(result)
|
|
13
|
+
* } catch (err) {
|
|
14
|
+
* await recorder.fail(err)
|
|
15
|
+
* throw err
|
|
16
|
+
* }
|
|
17
|
+
*
|
|
18
|
+
* — and inside `runFn` the caller (or, more naturally, an
|
|
19
|
+
* instrumented version of `runCheckoutFinalize`) calls
|
|
20
|
+
* `recorder.startStep(name)` / `recorder.completeStep(name, output)` /
|
|
21
|
+
* `recorder.failStep(name, error)` per step.
|
|
22
|
+
*
|
|
23
|
+
* The recorder is fire-and-forget around the actual run — it logs
|
|
24
|
+
* persistence failures rather than rethrowing, so observability
|
|
25
|
+
* outages never break the underlying business operation.
|
|
26
|
+
*/
|
|
27
|
+
import type { PostgresJsDatabase } from "drizzle-orm/postgres-js";
|
|
28
|
+
export interface BeginWorkflowRunInput {
|
|
29
|
+
workflowName: string;
|
|
30
|
+
trigger?: string;
|
|
31
|
+
correlationId?: string | null;
|
|
32
|
+
tags?: ReadonlyArray<string>;
|
|
33
|
+
input?: Record<string, unknown> | null;
|
|
34
|
+
/** Set when this run is a rerun/resume of a prior run. */
|
|
35
|
+
parentRunId?: string | null;
|
|
36
|
+
/** User who triggered this run via the dashboard. */
|
|
37
|
+
triggeredByUserId?: string | null;
|
|
38
|
+
/**
|
|
39
|
+
* For resume runs — the step name from which to resume. The
|
|
40
|
+
* executor seeds ctx.results with prior step outputs and skips
|
|
41
|
+
* everything before this step.
|
|
42
|
+
*/
|
|
43
|
+
resumeFromStep?: string | null;
|
|
44
|
+
}
|
|
45
|
+
export interface WorkflowRunRecorder {
|
|
46
|
+
readonly runId: string;
|
|
47
|
+
startStep(name: string): Promise<{
|
|
48
|
+
stepId: string | null;
|
|
49
|
+
}>;
|
|
50
|
+
completeStep(name: string, output?: Record<string, unknown> | null): Promise<void>;
|
|
51
|
+
failStep(name: string, error: unknown): Promise<void>;
|
|
52
|
+
/**
|
|
53
|
+
* Record a step that was skipped by a resume run. Writes a row
|
|
54
|
+
* with `status: "skipped"` and the supplied output (the value the
|
|
55
|
+
* parent run produced). Used by the resume orchestrator so the UI
|
|
56
|
+
* shows the full step list with the source of each output.
|
|
57
|
+
*/
|
|
58
|
+
recordSkippedStep(name: string, output?: Record<string, unknown> | null): Promise<void>;
|
|
59
|
+
complete(result?: Record<string, unknown> | null): Promise<void>;
|
|
60
|
+
fail(error: unknown, opts?: {
|
|
61
|
+
stepName?: string;
|
|
62
|
+
}): Promise<void>;
|
|
63
|
+
cancel(reason?: string): Promise<void>;
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* Start a run and return a recorder bound to its id. The row is
|
|
67
|
+
* inserted with `status: "running"` and a `startedAt` of "now".
|
|
68
|
+
*
|
|
69
|
+
* Persistence errors are caught — if the table doesn't exist or the
|
|
70
|
+
* DB is unreachable, returns a no-op recorder so the caller's
|
|
71
|
+
* workflow keeps running. The whole point of this layer is
|
|
72
|
+
* observability, not durability.
|
|
73
|
+
*/
|
|
74
|
+
export declare function beginWorkflowRun(db: PostgresJsDatabase, input: BeginWorkflowRunInput, options?: {
|
|
75
|
+
reuseRunningRun?: boolean;
|
|
76
|
+
}): Promise<WorkflowRunRecorder>;
|
|
77
|
+
//# sourceMappingURL=recorder.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"recorder.d.ts","sourceRoot":"","sources":["../src/recorder.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAGH,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AAUjE,MAAM,WAAW,qBAAqB;IACpC,YAAY,EAAE,MAAM,CAAA;IACpB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,IAAI,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACtC,0DAA0D;IAC1D,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,qDAAqD;IACrD,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC/B;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,CAAC,CAAA;IAC3D,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAClF,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACrD;;;;;OAKG;IACH,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACvF,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAChE,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACjE,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACvC;AAED;;;;;;;;GAQG;AACH,wBAAsB,gBAAgB,CACpC,EAAE,EAAE,kBAAkB,EACtB,KAAK,EAAE,qBAAqB,EAC5B,OAAO,GAAE;IAAE,eAAe,CAAC,EAAE,OAAO,CAAA;CAAO,GAC1C,OAAO,CAAC,mBAAmB,CAAC,CAgC9B"}
|