@voyant-travel/workflows 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/NOTICE +52 -0
- package/README.md +79 -0
- package/dist/auth/index.d.ts +125 -0
- package/dist/auth/index.d.ts.map +1 -0
- package/dist/auth/index.js +352 -0
- package/dist/bindings.d.ts +119 -0
- package/dist/bindings.d.ts.map +1 -0
- package/dist/bindings.js +19 -0
- package/dist/client.d.ts +135 -0
- package/dist/client.d.ts.map +1 -0
- package/dist/client.js +305 -0
- package/dist/conditions.d.ts +29 -0
- package/dist/conditions.d.ts.map +1 -0
- package/dist/conditions.js +5 -0
- package/dist/config.d.ts +93 -0
- package/dist/config.d.ts.map +1 -0
- package/dist/config.js +7 -0
- package/dist/driver.d.ts +237 -0
- package/dist/driver.d.ts.map +1 -0
- package/dist/driver.js +53 -0
- package/dist/errors.d.ts +58 -0
- package/dist/errors.d.ts.map +1 -0
- package/dist/errors.js +76 -0
- package/dist/events/compile.d.ts +34 -0
- package/dist/events/compile.d.ts.map +1 -0
- package/dist/events/compile.js +204 -0
- package/dist/events/index.d.ts +8 -0
- package/dist/events/index.d.ts.map +1 -0
- package/dist/events/index.js +11 -0
- package/dist/events/input-mapper.d.ts +24 -0
- package/dist/events/input-mapper.d.ts.map +1 -0
- package/dist/events/input-mapper.js +169 -0
- package/dist/events/manifest-builder.d.ts +42 -0
- package/dist/events/manifest-builder.d.ts.map +1 -0
- package/dist/events/manifest-builder.js +313 -0
- package/dist/events/payload-hash.d.ts +46 -0
- package/dist/events/payload-hash.d.ts.map +1 -0
- package/dist/events/payload-hash.js +98 -0
- package/dist/events/predicate.d.ts +77 -0
- package/dist/events/predicate.d.ts.map +1 -0
- package/dist/events/predicate.js +347 -0
- package/dist/events/registry.d.ts +37 -0
- package/dist/events/registry.d.ts.map +1 -0
- package/dist/events/registry.js +47 -0
- package/dist/handler/index.d.ts +114 -0
- package/dist/handler/index.d.ts.map +1 -0
- package/dist/handler/index.js +267 -0
- package/dist/handler/resume.d.ts +41 -0
- package/dist/handler/resume.d.ts.map +1 -0
- package/dist/handler/resume.js +44 -0
- package/dist/http-ingest.d.ts +54 -0
- package/dist/http-ingest.d.ts.map +1 -0
- package/dist/http-ingest.js +214 -0
- package/dist/index.d.ts +6 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +10 -0
- package/dist/protocol/index.d.ts +345 -0
- package/dist/protocol/index.d.ts.map +1 -0
- package/dist/protocol/index.js +110 -0
- package/dist/rate-limit/index.d.ts +40 -0
- package/dist/rate-limit/index.d.ts.map +1 -0
- package/dist/rate-limit/index.js +139 -0
- package/dist/runtime/ctx.d.ts +111 -0
- package/dist/runtime/ctx.d.ts.map +1 -0
- package/dist/runtime/ctx.js +624 -0
- package/dist/runtime/determinism.d.ts +19 -0
- package/dist/runtime/determinism.d.ts.map +1 -0
- package/dist/runtime/determinism.js +61 -0
- package/dist/runtime/errors.d.ts +21 -0
- package/dist/runtime/errors.d.ts.map +1 -0
- package/dist/runtime/errors.js +45 -0
- package/dist/runtime/executor.d.ts +166 -0
- package/dist/runtime/executor.d.ts.map +1 -0
- package/dist/runtime/executor.js +226 -0
- package/dist/runtime/journal.d.ts +56 -0
- package/dist/runtime/journal.d.ts.map +1 -0
- package/dist/runtime/journal.js +28 -0
- package/dist/testing/index.d.ts +117 -0
- package/dist/testing/index.d.ts.map +1 -0
- package/dist/testing/index.js +599 -0
- package/dist/trigger.d.ts +37 -0
- package/dist/trigger.d.ts.map +1 -0
- package/dist/trigger.js +11 -0
- package/dist/types.d.ts +63 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/types.js +3 -0
- package/dist/workflow.d.ts +222 -0
- package/dist/workflow.d.ts.map +1 -0
- package/dist/workflow.js +55 -0
- package/package.json +120 -0
- package/src/auth/index.ts +398 -0
- package/src/bindings.ts +135 -0
- package/src/client.ts +498 -0
- package/src/conditions.ts +43 -0
- package/src/config.ts +114 -0
- package/src/driver.ts +277 -0
- package/src/errors.ts +109 -0
- package/src/events/compile.ts +268 -0
- package/src/events/index.ts +42 -0
- package/src/events/input-mapper.ts +201 -0
- package/src/events/manifest-builder.ts +372 -0
- package/src/events/payload-hash.ts +110 -0
- package/src/events/predicate.ts +390 -0
- package/src/events/registry.ts +86 -0
- package/src/handler/index.ts +413 -0
- package/src/handler/resume.ts +100 -0
- package/src/http-ingest.ts +299 -0
- package/src/index.ts +18 -0
- package/src/protocol/index.ts +483 -0
- package/src/rate-limit/index.ts +181 -0
- package/src/runtime/ctx.ts +876 -0
- package/src/runtime/determinism.ts +75 -0
- package/src/runtime/errors.ts +58 -0
- package/src/runtime/executor.ts +442 -0
- package/src/runtime/journal.ts +80 -0
- package/src/testing/index.ts +796 -0
- package/src/trigger.ts +63 -0
- package/src/types.ts +80 -0
- package/src/workflow.ts +328 -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 choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or 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 Voyant Cloud
|
|
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/NOTICE
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
Voyant Workflows
|
|
2
|
+
Copyright 2026 Voyant Cloud
|
|
3
|
+
|
|
4
|
+
This product includes software developed at Voyant Cloud
|
|
5
|
+
(https://voyant.cloud).
|
|
6
|
+
|
|
7
|
+
Licensed under the Apache License, Version 2.0 (the "License").
|
|
8
|
+
See the LICENSE file in the root of this repository for details.
|
|
9
|
+
|
|
10
|
+
-------------------------------------------------------------------------------
|
|
11
|
+
Upstream attributions
|
|
12
|
+
-------------------------------------------------------------------------------
|
|
13
|
+
|
|
14
|
+
This project incorporates designs, patterns, and in some cases source
|
|
15
|
+
code adapted from the following upstream projects. Each retains the
|
|
16
|
+
copyright and license noted. Where specific files have been ported or
|
|
17
|
+
derived, individual file headers preserve the upstream copyright notice.
|
|
18
|
+
|
|
19
|
+
Vercel Workflow
|
|
20
|
+
https://github.com/vercel/workflow
|
|
21
|
+
Copyright (c) Vercel, Inc.
|
|
22
|
+
Apache License, Version 2.0
|
|
23
|
+
|
|
24
|
+
Derivation scope: determinism Proxies (Date / Math.random / crypto);
|
|
25
|
+
event-log-as-source-of-truth storage shape; capabilities/version
|
|
26
|
+
table; OTEL semantic conventions; consumer state machines for
|
|
27
|
+
sleep / hook / step primitives; error taxonomy.
|
|
28
|
+
|
|
29
|
+
Trigger.dev
|
|
30
|
+
https://github.com/triggerdotdev/trigger.dev
|
|
31
|
+
Copyright (c) Trigger.dev Inc.
|
|
32
|
+
Apache License, Version 2.0
|
|
33
|
+
|
|
34
|
+
Derivation scope: execution-snapshot model with snapshot-id-gated
|
|
35
|
+
mutations; run-status vs execution-status enum split; unified
|
|
36
|
+
waitpoint entity; reserve-concurrency pattern; metadata API shape;
|
|
37
|
+
trigger options vocabulary; single-dev-instance CLI lockfile.
|
|
38
|
+
|
|
39
|
+
Hatchet
|
|
40
|
+
https://github.com/hatchet-dev/hatchet
|
|
41
|
+
Copyright (c) Hatchet Inc.
|
|
42
|
+
MIT License
|
|
43
|
+
|
|
44
|
+
Derivation scope: concurrency strategy enum (queue / cancel-in-progress
|
|
45
|
+
/ cancel-newest / round-robin); match engine with OR groups; rate
|
|
46
|
+
limit token-bucket queries; waitFor / cancelIf / skipIf condition
|
|
47
|
+
actions; payload INLINE / EXTERNAL split; event filter scope model;
|
|
48
|
+
durable task eviction policy.
|
|
49
|
+
|
|
50
|
+
Files that are near-verbatim ports carry an explicit upstream copyright
|
|
51
|
+
header alongside Voyant Cloud's own. All other files are original to
|
|
52
|
+
this project.
|
package/README.md
ADDED
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
# @voyant-travel/workflows
|
|
2
|
+
|
|
3
|
+
Authoring SDK for [Voyant Workflows](https://voyant.cloud/workflows) —
|
|
4
|
+
durable, step-based orchestrations for Voyant Cloud.
|
|
5
|
+
|
|
6
|
+
```ts
|
|
7
|
+
import { workflow } from "@voyant-travel/workflows";
|
|
8
|
+
import { z } from "zod";
|
|
9
|
+
|
|
10
|
+
export const sendBookingReminders = workflow({
|
|
11
|
+
id: "send-booking-reminders",
|
|
12
|
+
input: z.object({ bookingId: z.string() }),
|
|
13
|
+
|
|
14
|
+
async run(input, ctx) {
|
|
15
|
+
const booking = await ctx.step("fetch", () => db.bookings.findById(input.bookingId));
|
|
16
|
+
|
|
17
|
+
await ctx.sleep("24h");
|
|
18
|
+
|
|
19
|
+
await ctx.step("send-reminder", async () => {
|
|
20
|
+
await email.send(booking.customerEmail, "Reminder...");
|
|
21
|
+
});
|
|
22
|
+
},
|
|
23
|
+
});
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Subpaths
|
|
27
|
+
|
|
28
|
+
- `@voyant-travel/workflows` — authoring API (`workflow`, `workflows`, `trigger`, conditions, errors).
|
|
29
|
+
- `@voyant-travel/workflows/client` — app/server-safe managed Cloud client and
|
|
30
|
+
Cloud-mode driver. Use this from app code that only needs
|
|
31
|
+
`workflows.trigger(...)` or event forwarding; it does not import workflow
|
|
32
|
+
definitions, runner code, or Node-only workflow dependencies.
|
|
33
|
+
- `@voyant-travel/workflows/testing` — in-process test harness
|
|
34
|
+
(`runWorkflowForTest`, `resumeWorkflowForTest`).
|
|
35
|
+
- `@voyant-travel/workflows/handler` — tenant-side step handler for the
|
|
36
|
+
v1 wire protocol. Mount at `POST /__voyant/workflow-step` in your
|
|
37
|
+
Worker: `export default { fetch: createStepHandler() }`.
|
|
38
|
+
- `@voyant-travel/workflows/auth` — paired HMAC signer + verifier for the
|
|
39
|
+
`X-Voyant-Dispatch-Auth` header. Wires into the orchestrator's
|
|
40
|
+
`sign` hook and the handler's `verifyRequest` hook with a shared
|
|
41
|
+
secret.
|
|
42
|
+
- `@voyant-travel/workflows/bindings` — runtime binding types and `env`
|
|
43
|
+
shim for workflow code that reads platform bindings.
|
|
44
|
+
- `@voyant-travel/workflows/config` — `defineConfig` and `voyant.config.ts`
|
|
45
|
+
types.
|
|
46
|
+
- `@voyant-travel/workflows/errors` — typed user/runtime errors
|
|
47
|
+
(`FatalError`, `RetryableError`, `TimeoutError`, and related classes).
|
|
48
|
+
- `@voyant-travel/workflows/protocol` — wire-protocol types shared with the
|
|
49
|
+
orchestrator.
|
|
50
|
+
|
|
51
|
+
## Managed Cloud runtime split
|
|
52
|
+
|
|
53
|
+
Managed Voyant Cloud runs workflow bundles in the hosted Cloud runtime. App
|
|
54
|
+
bundles should import only `@voyant-travel/workflows/client` and call
|
|
55
|
+
`workflows.trigger(...)`; workflow definition files keep importing
|
|
56
|
+
`workflow(...)`, `ctx.step(...)`, `ctx.sleep(...)`, and `trigger.on(...)` from
|
|
57
|
+
`@voyant-travel/workflows`.
|
|
58
|
+
|
|
59
|
+
Cloud deployments inject:
|
|
60
|
+
|
|
61
|
+
```txt
|
|
62
|
+
VOYANT_CLOUD_WORKFLOWS_URL
|
|
63
|
+
VOYANT_CLOUD_WORKFLOW_TRIGGER_TOKEN
|
|
64
|
+
VOYANT_CLOUD_APP_SLUG
|
|
65
|
+
VOYANT_CLOUD_ENVIRONMENT
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
The client posts trigger calls to the app-scoped Cloud API. The Cloud-mode
|
|
69
|
+
driver forwards event ingest to the same boundary, but workflow release
|
|
70
|
+
registration is disabled by default: Cloud creates releases from deployments,
|
|
71
|
+
artifacts, hashes, and environment snapshots. Existing self-host Node/Docker
|
|
72
|
+
and Cloudflare runtimes continue to use the driver/orchestrator packages
|
|
73
|
+
directly.
|
|
74
|
+
|
|
75
|
+
## Full contract
|
|
76
|
+
|
|
77
|
+
- [`docs/sdk-surface.md`](../../docs/sdk-surface.md) — locked API surface.
|
|
78
|
+
- [`docs/design.md`](../../docs/design.md) — architecture and rationale.
|
|
79
|
+
- [`docs/runtime-protocol.md`](../../docs/runtime-protocol.md) — wire protocol.
|
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
export declare const AUTH_HEADER: "x-voyant-dispatch-auth";
|
|
2
|
+
/**
|
|
3
|
+
* HMAC header carried on orchestrator → node-step-container dispatches
|
|
4
|
+
* (`POST /step`). Signed over the raw request body with the shared
|
|
5
|
+
* `VOYANT_WORKFLOW_STEP_AUTH_SECRET`. See `createCfContainerStepRunner`
|
|
6
|
+
* (signing side) and `apps/workflows-node-step-container` (verifying side).
|
|
7
|
+
*/
|
|
8
|
+
export declare const STEP_AUTH_HEADER: "x-voyant-step-auth";
|
|
9
|
+
/**
|
|
10
|
+
* HMAC header returned by the node-step-container on successful `/step`
|
|
11
|
+
* responses. Signed over the raw JSON response body with the same
|
|
12
|
+
* `VOYANT_WORKFLOW_STEP_AUTH_SECRET` so the orchestrator can reject
|
|
13
|
+
* forged step journal entries before committing run state.
|
|
14
|
+
*/
|
|
15
|
+
export declare const STEP_RESPONSE_AUTH_HEADER: "x-voyant-step-response-auth";
|
|
16
|
+
/** Parse a comma-separated token/origin list env var into trimmed, non-empty entries. */
|
|
17
|
+
export declare function parseTokenList(raw: string | null | undefined): string[];
|
|
18
|
+
/**
|
|
19
|
+
* Returns a verifier that accepts `Authorization: Bearer <token>`
|
|
20
|
+
* where `<token>` matches any of the `validTokens` (case-sensitive,
|
|
21
|
+
* constant-time compared). Usable as the `verifyRequest` dep on
|
|
22
|
+
* `handleWorkerRequest` / `createStepHandler` for the public-facing
|
|
23
|
+
* surface of an orchestrator or tenant Worker.
|
|
24
|
+
*
|
|
25
|
+
* Intended for dev + single-tenant deployments. Production should
|
|
26
|
+
* issue per-tenant, short-lived tokens from a control plane.
|
|
27
|
+
*/
|
|
28
|
+
export declare function createBearerVerifier(validTokens: readonly string[]): (req: Request) => void;
|
|
29
|
+
/**
|
|
30
|
+
* Error thrown by verifiers produced in this module. Carries an HTTP
|
|
31
|
+
* `status` + machine-readable `code` so HTTP surfaces
|
|
32
|
+
* (`handleWorkerRequest`, the node dashboard server, step handlers)
|
|
33
|
+
* can map auth failures to the right response instead of a blanket 401.
|
|
34
|
+
*/
|
|
35
|
+
export declare class RequestAuthError extends Error {
|
|
36
|
+
readonly status: number;
|
|
37
|
+
readonly code: string;
|
|
38
|
+
constructor(status: number, code: string, message: string);
|
|
39
|
+
}
|
|
40
|
+
export type BearerAuthDecision = {
|
|
41
|
+
ok: true;
|
|
42
|
+
} | {
|
|
43
|
+
ok: false;
|
|
44
|
+
status: number;
|
|
45
|
+
error: string;
|
|
46
|
+
message: string;
|
|
47
|
+
};
|
|
48
|
+
export interface BearerAuthOptions {
|
|
49
|
+
/** Accepted bearer tokens. Empty/undefined = no auth configured. */
|
|
50
|
+
tokens?: readonly string[];
|
|
51
|
+
/**
|
|
52
|
+
* Explicit local-dev opt-out. When `true` AND no tokens are
|
|
53
|
+
* configured, requests are allowed through with a loud warning.
|
|
54
|
+
* When `false`/unset and no tokens are configured, every request is
|
|
55
|
+
* rejected with 503 `auth_not_configured` (fail closed).
|
|
56
|
+
*/
|
|
57
|
+
allowUnauthenticated?: boolean;
|
|
58
|
+
/** Warning sink for the unauthenticated opt-out. Defaults to `console.warn`. */
|
|
59
|
+
warn?: (message: string) => void;
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* Build a transport-agnostic bearer authorizer from a raw
|
|
63
|
+
* `Authorization` header value. Fail-closed semantics:
|
|
64
|
+
*
|
|
65
|
+
* - tokens configured → exact (constant-time) Bearer match or 401
|
|
66
|
+
* - no tokens + opt-out → always allowed (warns loudly once, at creation)
|
|
67
|
+
* - no tokens, no opt-out → always 503 `auth_not_configured`
|
|
68
|
+
*/
|
|
69
|
+
export declare function createBearerAuthorizer(opts: BearerAuthOptions): (authorizationHeader: string | null | undefined) => BearerAuthDecision;
|
|
70
|
+
/**
|
|
71
|
+
* Resolve a `verifyRequest` hook (the dep consumed by
|
|
72
|
+
* `handleWorkerRequest` / `createStepHandler`) with fail-closed
|
|
73
|
+
* defaults — the missing-token case yields a verifier that rejects
|
|
74
|
+
* every request with a 503 `auth_not_configured` `RequestAuthError`
|
|
75
|
+
* instead of `undefined` (which would skip auth entirely).
|
|
76
|
+
*
|
|
77
|
+
* Returns `undefined` (auth skipped) ONLY when no tokens are
|
|
78
|
+
* configured AND `allowUnauthenticated` is explicitly set.
|
|
79
|
+
*/
|
|
80
|
+
export declare function resolveRequestVerifier(opts: BearerAuthOptions): ((req: Request) => void) | undefined;
|
|
81
|
+
/** Returns a signer: `(body: string) => Promise<string>` (base64 HMAC-SHA256). */
|
|
82
|
+
export declare function createHmacSigner(secret: string): Promise<(body: string) => Promise<string>>;
|
|
83
|
+
/**
|
|
84
|
+
* Returns a verifier: `(req: Request) => Promise<void>`. Throws if:
|
|
85
|
+
* - the header is missing,
|
|
86
|
+
* - the signature is malformed,
|
|
87
|
+
* - the signature does not match the current body.
|
|
88
|
+
*
|
|
89
|
+
* The verifier consumes `req.body` via `req.text()`. Callers that
|
|
90
|
+
* need the body downstream should pre-clone: `req.clone()` before
|
|
91
|
+
* passing in.
|
|
92
|
+
*/
|
|
93
|
+
export declare function createHmacVerifier(secret: string): Promise<(req: Request) => Promise<void>>;
|
|
94
|
+
/**
|
|
95
|
+
* Returns a verifier over a raw body string + detached base64 HMAC
|
|
96
|
+
* signature (the value of `STEP_AUTH_HEADER`). Suitable for servers
|
|
97
|
+
* that have already buffered the request body (e.g. the node step
|
|
98
|
+
* container). `crypto.subtle.verify` is constant-time; malformed
|
|
99
|
+
* base64 or a missing signature simply yields `false`.
|
|
100
|
+
*/
|
|
101
|
+
export declare function createHmacBodyVerifier(secret: string): Promise<(body: string, signatureBase64: string | null | undefined) => Promise<boolean>>;
|
|
102
|
+
export type BundleUrlDecision = {
|
|
103
|
+
ok: true;
|
|
104
|
+
} | {
|
|
105
|
+
ok: false;
|
|
106
|
+
message: string;
|
|
107
|
+
};
|
|
108
|
+
/**
|
|
109
|
+
* Build an origin allowlist check for caller-supplied `bundle.url`
|
|
110
|
+
* values (the node step container dynamically `import()`s the fetched
|
|
111
|
+
* bytes, so an unrestricted URL is remote-code-execution-adjacent —
|
|
112
|
+
* the SHA-256 hash pin is supplied by the same caller and is not a
|
|
113
|
+
* security control on its own).
|
|
114
|
+
*
|
|
115
|
+
* - `allowedOrigins` set (e.g. from `VOYANT_BUNDLE_ALLOWED_ORIGINS`):
|
|
116
|
+
* the URL's origin must match one of the entries exactly.
|
|
117
|
+
* Invalid entries throw at creation time (misconfiguration should
|
|
118
|
+
* fail loudly, not silently widen).
|
|
119
|
+
* - unset/empty: only HTTPS URLs on `*.r2.cloudflarestorage.com`
|
|
120
|
+
* are allowed — the production bundle source.
|
|
121
|
+
*/
|
|
122
|
+
export declare function createBundleUrlPolicy(opts?: {
|
|
123
|
+
allowedOrigins?: readonly string[];
|
|
124
|
+
}): (url: string) => BundleUrlDecision;
|
|
125
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/auth/index.ts"],"names":[],"mappings":"AAwBA,eAAO,MAAM,WAAW,EAAG,wBAAiC,CAAA;AAE5D;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,EAAG,oBAA6B,CAAA;AAE7D;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB,EAAG,6BAAsC,CAAA;AAE/E,yFAAyF;AACzF,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,EAAE,CAKvE;AAED;;;;;;;;;GASG;AACH,wBAAgB,oBAAoB,CAAC,WAAW,EAAE,SAAS,MAAM,EAAE,GAAG,CAAC,GAAG,EAAE,OAAO,KAAK,IAAI,CAiB3F;AAoBD;;;;;GAKG;AACH,qBAAa,gBAAiB,SAAQ,KAAK;IACzC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;gBAET,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;CAM1D;AAED,MAAM,MAAM,kBAAkB,GAC1B;IAAE,EAAE,EAAE,IAAI,CAAA;CAAE,GACZ;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAA;AAEjE,MAAM,WAAW,iBAAiB;IAChC,oEAAoE;IACpE,MAAM,CAAC,EAAE,SAAS,MAAM,EAAE,CAAA;IAC1B;;;;;OAKG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAA;IAC9B,gFAAgF;IAChF,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAA;CACjC;AAQD;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CACpC,IAAI,EAAE,iBAAiB,GACtB,CAAC,mBAAmB,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,KAAK,kBAAkB,CA8CxE;AAED;;;;;;;;;GASG;AACH,wBAAgB,sBAAsB,CACpC,IAAI,EAAE,iBAAiB,GACtB,CAAC,CAAC,GAAG,EAAE,OAAO,KAAK,IAAI,CAAC,GAAG,SAAS,CAatC;AAED,kFAAkF;AAClF,wBAAsB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC,CAMjG;AAED;;;;;;;;;GASG;AACH,wBAAsB,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC,CAmBjG;AAED;;;;;;GAMG;AACH,wBAAsB,sBAAsB,CAC1C,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC,CAYzF;AAID,MAAM,MAAM,iBAAiB,GAAG;IAAE,EAAE,EAAE,IAAI,CAAA;CAAE,GAAG;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAA;AAW7E;;;;;;;;;;;;;GAaG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,CAAC,EAAE;IAC3C,cAAc,CAAC,EAAE,SAAS,MAAM,EAAE,CAAA;CACnC,GAAG,CAAC,GAAG,EAAE,MAAM,KAAK,iBAAiB,CAsCrC"}
|