@workflow/core 4.1.0-beta.51 → 4.1.0-beta.53
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/class-serialization.d.ts +5 -4
- package/dist/class-serialization.d.ts.map +1 -1
- package/dist/class-serialization.js +7 -16
- package/dist/events-consumer.d.ts.map +1 -1
- package/dist/events-consumer.js +1 -9
- package/dist/logger.d.ts.map +1 -1
- package/dist/logger.js +10 -1
- package/dist/observability.d.ts.map +1 -1
- package/dist/observability.js +6 -5
- package/dist/runtime/helpers.d.ts +7 -1
- package/dist/runtime/helpers.d.ts.map +1 -1
- package/dist/runtime/helpers.js +60 -23
- package/dist/runtime/resume-hook.d.ts.map +1 -1
- package/dist/runtime/resume-hook.js +4 -3
- package/dist/runtime/run.d.ts +100 -0
- package/dist/runtime/run.d.ts.map +1 -0
- package/dist/runtime/run.js +132 -0
- package/dist/runtime/runs.d.ts +49 -0
- package/dist/runtime/runs.d.ts.map +1 -0
- package/dist/runtime/runs.js +156 -0
- package/dist/runtime/start.d.ts +1 -1
- package/dist/runtime/start.d.ts.map +1 -1
- package/dist/runtime/start.js +5 -4
- package/dist/runtime/step-handler.d.ts.map +1 -1
- package/dist/runtime/step-handler.js +230 -119
- package/dist/runtime/suspension-handler.d.ts.map +1 -1
- package/dist/runtime/suspension-handler.js +39 -5
- package/dist/runtime.d.ts +3 -99
- package/dist/runtime.d.ts.map +1 -1
- package/dist/runtime.js +155 -257
- package/dist/serialization.d.ts.map +1 -1
- package/dist/serialization.js +82 -14
- package/dist/telemetry/semantic-conventions.d.ts +81 -5
- package/dist/telemetry/semantic-conventions.d.ts.map +1 -1
- package/dist/telemetry/semantic-conventions.js +56 -8
- package/dist/telemetry.d.ts +25 -0
- package/dist/telemetry.d.ts.map +1 -1
- package/dist/telemetry.js +48 -2
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/dist/workflow.js +3 -3
- package/docs/api-reference/create-hook.mdx +1 -0
- package/docs/api-reference/create-webhook.mdx +1 -0
- package/docs/api-reference/define-hook.mdx +1 -0
- package/docs/api-reference/fatal-error.mdx +1 -0
- package/docs/api-reference/fetch.mdx +1 -0
- package/docs/api-reference/get-step-metadata.mdx +1 -0
- package/docs/api-reference/get-workflow-metadata.mdx +1 -0
- package/docs/api-reference/index.mdx +1 -0
- package/docs/api-reference/retryable-error.mdx +1 -0
- package/docs/api-reference/sleep.mdx +1 -0
- package/docs/foundations/common-patterns.mdx +1 -0
- package/docs/foundations/errors-and-retries.mdx +1 -0
- package/docs/foundations/hooks.mdx +1 -0
- package/docs/foundations/idempotency.mdx +1 -0
- package/docs/foundations/index.mdx +1 -0
- package/docs/foundations/serialization.mdx +1 -0
- package/docs/foundations/starting-workflows.mdx +1 -0
- package/docs/foundations/streaming.mdx +1 -0
- package/docs/foundations/workflows-and-steps.mdx +1 -0
- package/docs/how-it-works/code-transform.mdx +1 -0
- package/docs/how-it-works/event-sourcing.mdx +1 -0
- package/docs/how-it-works/framework-integrations.mdx +1 -0
- package/docs/how-it-works/understanding-directives.mdx +1 -0
- package/package.json +40 -11
- package/runtime.d.ts +1 -0
- package/runtime.js +1 -0
|
@@ -1,10 +1,25 @@
|
|
|
1
1
|
import { waitUntil } from '@vercel/functions';
|
|
2
2
|
import { WorkflowAPIError } from '@workflow/errors';
|
|
3
3
|
import { SPEC_VERSION_CURRENT, } from '@workflow/world';
|
|
4
|
+
import { runtimeLogger } from '../logger.js';
|
|
4
5
|
import { dehydrateStepArguments } from '../serialization.js';
|
|
5
6
|
import * as Attribute from '../telemetry/semantic-conventions.js';
|
|
6
7
|
import { serializeTraceCarrier } from '../telemetry.js';
|
|
7
8
|
import { queueMessage } from './helpers.js';
|
|
9
|
+
/**
|
|
10
|
+
* Extracts W3C trace context headers from a trace carrier for HTTP propagation.
|
|
11
|
+
* Returns an object with `traceparent` and optionally `tracestate` headers.
|
|
12
|
+
*/
|
|
13
|
+
function extractTraceHeaders(traceCarrier) {
|
|
14
|
+
const headers = {};
|
|
15
|
+
if (traceCarrier.traceparent) {
|
|
16
|
+
headers.traceparent = traceCarrier.traceparent;
|
|
17
|
+
}
|
|
18
|
+
if (traceCarrier.tracestate) {
|
|
19
|
+
headers.tracestate = traceCarrier.tracestate;
|
|
20
|
+
}
|
|
21
|
+
return headers;
|
|
22
|
+
}
|
|
8
23
|
/**
|
|
9
24
|
* Handles a workflow suspension by processing all pending operations (hooks, steps, waits).
|
|
10
25
|
* Uses an event-sourced architecture where entities (steps, hooks) are created atomically
|
|
@@ -53,7 +68,10 @@ export async function handleSuspension({ suspension, world, runId, workflowName,
|
|
|
53
68
|
catch (err) {
|
|
54
69
|
if (WorkflowAPIError.is(err)) {
|
|
55
70
|
if (err.status === 410) {
|
|
56
|
-
|
|
71
|
+
runtimeLogger.info('Workflow run already completed, skipping hook', {
|
|
72
|
+
workflowRunId: runId,
|
|
73
|
+
message: err.message,
|
|
74
|
+
});
|
|
57
75
|
}
|
|
58
76
|
else {
|
|
59
77
|
throw err;
|
|
@@ -97,7 +115,11 @@ export async function handleSuspension({ suspension, world, runId, workflowName,
|
|
|
97
115
|
}
|
|
98
116
|
catch (err) {
|
|
99
117
|
if (WorkflowAPIError.is(err) && err.status === 409) {
|
|
100
|
-
|
|
118
|
+
runtimeLogger.info('Step already exists, continuing', {
|
|
119
|
+
workflowRunId: runId,
|
|
120
|
+
correlationId: queueItem.correlationId,
|
|
121
|
+
message: err.message,
|
|
122
|
+
});
|
|
101
123
|
}
|
|
102
124
|
else {
|
|
103
125
|
throw err;
|
|
@@ -105,15 +127,23 @@ export async function handleSuspension({ suspension, world, runId, workflowName,
|
|
|
105
127
|
}
|
|
106
128
|
}
|
|
107
129
|
// Queue step execution message
|
|
130
|
+
// Serialize trace context once and include in both payload and headers
|
|
131
|
+
// Payload: for manual context restoration in step handler
|
|
132
|
+
// Headers: for automatic trace propagation by Vercel's infrastructure
|
|
133
|
+
const traceCarrier = await serializeTraceCarrier();
|
|
108
134
|
await queueMessage(world, `__wkf_step_${queueItem.stepName}`, {
|
|
109
135
|
workflowName,
|
|
110
136
|
workflowRunId: runId,
|
|
111
137
|
workflowStartedAt,
|
|
112
138
|
stepId: queueItem.correlationId,
|
|
113
|
-
traceCarrier
|
|
139
|
+
traceCarrier,
|
|
114
140
|
requestedAt: new Date(),
|
|
115
141
|
}, {
|
|
116
142
|
idempotencyKey: queueItem.correlationId,
|
|
143
|
+
headers: {
|
|
144
|
+
'x-workflow-run-id': runId,
|
|
145
|
+
...extractTraceHeaders(traceCarrier),
|
|
146
|
+
},
|
|
117
147
|
});
|
|
118
148
|
})());
|
|
119
149
|
}
|
|
@@ -134,7 +164,11 @@ export async function handleSuspension({ suspension, world, runId, workflowName,
|
|
|
134
164
|
}
|
|
135
165
|
catch (err) {
|
|
136
166
|
if (WorkflowAPIError.is(err) && err.status === 409) {
|
|
137
|
-
|
|
167
|
+
runtimeLogger.info('Wait already exists, continuing', {
|
|
168
|
+
workflowRunId: runId,
|
|
169
|
+
correlationId: queueItem.correlationId,
|
|
170
|
+
message: err.message,
|
|
171
|
+
});
|
|
138
172
|
}
|
|
139
173
|
else {
|
|
140
174
|
throw err;
|
|
@@ -179,4 +213,4 @@ export async function handleSuspension({ suspension, world, runId, workflowName,
|
|
|
179
213
|
}
|
|
180
214
|
return {};
|
|
181
215
|
}
|
|
182
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
216
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"suspension-handler.js","sourceRoot":"","sources":["../../src/runtime/suspension-handler.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,EAGL,oBAAoB,GAErB,MAAM,iBAAiB,CAAC;AAOzB,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC7C,OAAO,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,KAAK,SAAS,MAAM,sCAAsC,CAAC;AAClE,OAAO,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAE5C;;;GAGG;AACH,SAAS,mBAAmB,CAC1B,YAAoC;IAEpC,MAAM,OAAO,GAA2B,EAAE,CAAC;IAC3C,IAAI,YAAY,CAAC,WAAW,EAAE,CAAC;QAC7B,OAAO,CAAC,WAAW,GAAG,YAAY,CAAC,WAAW,CAAC;IACjD,CAAC;IACD,IAAI,YAAY,CAAC,UAAU,EAAE,CAAC;QAC5B,OAAO,CAAC,UAAU,GAAG,YAAY,CAAC,UAAU,CAAC;IAC/C,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAeD;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,EACrC,UAAU,EACV,KAAK,EACL,KAAK,EACL,YAAY,EACZ,iBAAiB,EACjB,IAAI,GACoB;IACxB,+BAA+B;IAC/B,MAAM,SAAS,GAAG,UAAU,CAAC,KAAK,CAAC,MAAM,CACvC,CAAC,IAAI,EAAmC,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,MAAM,CAChE,CAAC;IACF,MAAM,SAAS,GAAG,UAAU,CAAC,KAAK,CAAC,MAAM,CACvC,CAAC,IAAI,EAAmC,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,MAAM,CAChE,CAAC;IACF,MAAM,SAAS,GAAG,UAAU,CAAC,KAAK,CAAC,MAAM,CACvC,CAAC,IAAI,EAAmC,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,MAAM,CAChE,CAAC;IAEF,yEAAyE;IACzE,MAAM,UAAU,GAAyB,SAAS,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE;QACnE,MAAM,YAAY,GAChB,OAAO,SAAS,CAAC,QAAQ,KAAK,WAAW;YACvC,CAAC,CAAC,SAAS;YACX,CAAC,CAAE,sBAAsB,CACrB,SAAS,CAAC,QAAQ,EAClB,UAAU,CAAC,UAAU,CACH,CAAC;QAC3B,OAAO;YACL,SAAS,EAAE,cAAuB;YAClC,WAAW,EAAE,oBAAoB;YACjC,aAAa,EAAE,SAAS,CAAC,aAAa;YACtC,SAAS,EAAE;gBACT,KAAK,EAAE,SAAS,CAAC,KAAK;gBACtB,QAAQ,EAAE,YAAY;aACvB;SACF,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,wEAAwE;IACxE,qCAAqC;IACrC,4FAA4F;IAC5F,IAAI,eAAe,GAAG,KAAK,CAAC;IAE5B,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1B,MAAM,OAAO,CAAC,GAAG,CACf,UAAU,CAAC,GAAG,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE;YACjC,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;gBAC3D,4EAA4E;gBAC5E,0EAA0E;gBAC1E,wEAAwE;gBACxE,qFAAqF;gBACrF,IAAI,MAAM,CAAC,KAAM,CAAC,SAAS,KAAK,eAAe,EAAE,CAAC;oBAChD,eAAe,GAAG,IAAI,CAAC;gBACzB,CAAC;YACH,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,IAAI,gBAAgB,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;oBAC7B,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;wBACvB,aAAa,CAAC,IAAI,CAChB,+CAA+C,EAC/C;4BACE,aAAa,EAAE,KAAK;4BACpB,OAAO,EAAE,GAAG,CAAC,OAAO;yBACrB,CACF,CAAC;oBACJ,CAAC;yBAAM,CAAC;wBACN,MAAM,GAAG,CAAC;oBACZ,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,MAAM,GAAG,CAAC;gBACZ,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CACH,CAAC;IACJ,CAAC;IAED,mEAAmE;IACnE,MAAM,oBAAoB,GAAG,IAAI,GAAG,CAClC,SAAS;SACN,MAAM,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,eAAe,CAAC;SACjD,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,aAAa,CAAC,CAC/C,CAAC;IAEF,sCAAsC;IACtC,uDAAuD;IACvD,sCAAsC;IACtC,MAAM,GAAG,GAAoB,EAAE,CAAC;IAEhC,0DAA0D;IAC1D,KAAK,MAAM,SAAS,IAAI,SAAS,EAAE,CAAC;QAClC,GAAG,CAAC,IAAI,CACN,CAAC,KAAK,IAAI,EAAE;YACV,2CAA2C;YAC3C,IAAI,oBAAoB,CAAC,GAAG,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,CAAC;gBACtD,MAAM,eAAe,GAAG,sBAAsB,CAC5C;oBACE,IAAI,EAAE,SAAS,CAAC,IAAI;oBACpB,WAAW,EAAE,SAAS,CAAC,WAAW;oBAClC,OAAO,EAAE,SAAS,CAAC,OAAO;iBAC3B,EACD,UAAU,CAAC,UAAU,CACtB,CAAC;gBACF,MAAM,SAAS,GAAuB;oBACpC,SAAS,EAAE,cAAuB;oBAClC,WAAW,EAAE,oBAAoB;oBACjC,aAAa,EAAE,SAAS,CAAC,aAAa;oBACtC,SAAS,EAAE;wBACT,QAAQ,EAAE,SAAS,CAAC,QAAQ;wBAC5B,KAAK,EAAE,eAAiC;qBACzC;iBACF,CAAC;gBACF,IAAI,CAAC;oBACH,MAAM,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;gBAC9C,CAAC;gBAAC,OAAO,GAAG,EAAE,CAAC;oBACb,IAAI,gBAAgB,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;wBACnD,aAAa,CAAC,IAAI,CAAC,iCAAiC,EAAE;4BACpD,aAAa,EAAE,KAAK;4BACpB,aAAa,EAAE,SAAS,CAAC,aAAa;4BACtC,OAAO,EAAE,GAAG,CAAC,OAAO;yBACrB,CAAC,CAAC;oBACL,CAAC;yBAAM,CAAC;wBACN,MAAM,GAAG,CAAC;oBACZ,CAAC;gBACH,CAAC;YACH,CAAC;YAED,+BAA+B;YAC/B,uEAAuE;YACvE,0DAA0D;YAC1D,sEAAsE;YACtE,MAAM,YAAY,GAAG,MAAM,qBAAqB,EAAE,CAAC;YACnD,MAAM,YAAY,CAChB,KAAK,EACL,cAAc,SAAS,CAAC,QAAQ,EAAE,EAClC;gBACE,YAAY;gBACZ,aAAa,EAAE,KAAK;gBACpB,iBAAiB;gBACjB,MAAM,EAAE,SAAS,CAAC,aAAa;gBAC/B,YAAY;gBACZ,WAAW,EAAE,IAAI,IAAI,EAAE;aACxB,EACD;gBACE,cAAc,EAAE,SAAS,CAAC,aAAa;gBACvC,OAAO,EAAE;oBACP,mBAAmB,EAAE,KAAK;oBAC1B,GAAG,mBAAmB,CAAC,YAAY,CAAC;iBACrC;aACF,CACF,CAAC;QACJ,CAAC,CAAC,EAAE,CACL,CAAC;IACJ,CAAC;IAED,kEAAkE;IAClE,KAAK,MAAM,SAAS,IAAI,SAAS,EAAE,CAAC;QAClC,IAAI,CAAC,SAAS,CAAC,eAAe,EAAE,CAAC;YAC/B,GAAG,CAAC,IAAI,CACN,CAAC,KAAK,IAAI,EAAE;gBACV,MAAM,SAAS,GAAuB;oBACpC,SAAS,EAAE,cAAuB;oBAClC,WAAW,EAAE,oBAAoB;oBACjC,aAAa,EAAE,SAAS,CAAC,aAAa;oBACtC,SAAS,EAAE;wBACT,QAAQ,EAAE,SAAS,CAAC,QAAQ;qBAC7B;iBACF,CAAC;gBACF,IAAI,CAAC;oBACH,MAAM,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;gBAC9C,CAAC;gBAAC,OAAO,GAAG,EAAE,CAAC;oBACb,IAAI,gBAAgB,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;wBACnD,aAAa,CAAC,IAAI,CAAC,iCAAiC,EAAE;4BACpD,aAAa,EAAE,KAAK;4BACpB,aAAa,EAAE,SAAS,CAAC,aAAa;4BACtC,OAAO,EAAE,GAAG,CAAC,OAAO;yBACrB,CAAC,CAAC;oBACL,CAAC;yBAAM,CAAC;wBACN,MAAM,GAAG,CAAC;oBACZ,CAAC;gBACH,CAAC;YACH,CAAC,CAAC,EAAE,CACL,CAAC;QACJ,CAAC;IACH,CAAC;IAED,oDAAoD;IACpD,SAAS,CACP,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;QAC/B,MAAM,YAAY,GAChB,KAAK,EAAE,IAAI,KAAK,YAAY,IAAI,KAAK,EAAE,IAAI,KAAK,iBAAiB,CAAC;QACpE,IAAI,CAAC,YAAY;YAAE,MAAM,KAAK,CAAC;IACjC,CAAC,CAAC,CACH,CAAC;IACF,MAAM,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAEvB,uCAAuC;IACvC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IACvB,MAAM,iBAAiB,GAAG,SAAS,CAAC,MAAM,CACxC,CAAC,GAAG,EAAE,SAAS,EAAE,EAAE;QACjB,MAAM,UAAU,GAAG,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;QAChD,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,UAAU,GAAG,GAAG,CAAC,CAAC;QACjD,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;QACjD,IAAI,GAAG,KAAK,IAAI;YAAE,OAAO,cAAc,CAAC;QACxC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;IACvC,CAAC,EACD,IAAI,CACL,CAAC;IAEF,IAAI,EAAE,aAAa,CAAC;QAClB,GAAG,SAAS,CAAC,iBAAiB,CAAC,oBAAoB,CAAC;QACpD,GAAG,SAAS,CAAC,oBAAoB,CAAC,SAAS,CAAC,MAAM,CAAC;QACnD,GAAG,SAAS,CAAC,oBAAoB,CAAC,SAAS,CAAC,MAAM,CAAC;QACnD,GAAG,SAAS,CAAC,oBAAoB,CAAC,SAAS,CAAC,MAAM,CAAC;KACpD,CAAC,CAAC;IAEH,sEAAsE;IACtE,4EAA4E;IAC5E,qDAAqD;IACrD,4EAA4E;IAC5E,6DAA6D;IAC7D,IAAI,eAAe,EAAE,CAAC;QACpB,OAAO,EAAE,cAAc,EAAE,CAAC,EAAE,CAAC;IAC/B,CAAC;IAED,IAAI,iBAAiB,KAAK,IAAI,EAAE,CAAC;QAC/B,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,CAAC;IAC/C,CAAC;IAED,OAAO,EAAE,CAAC;AACZ,CAAC"}
|
package/dist/runtime.d.ts
CHANGED
|
@@ -1,109 +1,13 @@
|
|
|
1
|
-
import { type Event, type WorkflowRun
|
|
1
|
+
import { type Event, type WorkflowRun } from '@workflow/world';
|
|
2
2
|
export type { Event, WorkflowRun };
|
|
3
3
|
export { WorkflowSuspension } from './global.js';
|
|
4
4
|
export { type HealthCheckEndpoint, type HealthCheckOptions, type HealthCheckResult, healthCheck, } from './runtime/helpers.js';
|
|
5
5
|
export { getHookByToken, resumeHook, resumeWebhook, } from './runtime/resume-hook.js';
|
|
6
|
+
export { getRun, Run, type WorkflowReadableStreamOptions, } from './runtime/run.js';
|
|
7
|
+
export { cancelRun, listStreams, readStream, recreateRunFromExisting, reenqueueRun, type ReadStreamOptions, type RecreateRunOptions, type StopSleepOptions, type StopSleepResult, wakeUpRun, } from './runtime/runs.js';
|
|
6
8
|
export { type StartOptions, start } from './runtime/start.js';
|
|
7
9
|
export { stepEntrypoint } from './runtime/step-handler.js';
|
|
8
10
|
export { createWorld, getWorld, getWorldHandlers, setWorld, } from './runtime/world.js';
|
|
9
|
-
/**
|
|
10
|
-
* Options for configuring a workflow's readable stream.
|
|
11
|
-
*/
|
|
12
|
-
export interface WorkflowReadableStreamOptions {
|
|
13
|
-
/**
|
|
14
|
-
* An optional namespace to distinguish between multiple streams associated
|
|
15
|
-
* with the same workflow run.
|
|
16
|
-
*/
|
|
17
|
-
namespace?: string;
|
|
18
|
-
/**
|
|
19
|
-
* The index number of the starting chunk to begin reading the stream from.
|
|
20
|
-
*/
|
|
21
|
-
startIndex?: number;
|
|
22
|
-
/**
|
|
23
|
-
* Any asynchronous operations that need to be performed before the execution
|
|
24
|
-
* environment is paused / terminated
|
|
25
|
-
* (i.e. using [`waitUntil()`](https://developer.mozilla.org/docs/Web/API/ExtendableEvent/waitUntil) or similar).
|
|
26
|
-
*/
|
|
27
|
-
ops?: Promise<any>[];
|
|
28
|
-
/**
|
|
29
|
-
* The global object to use for hydrating types from the global scope.
|
|
30
|
-
*
|
|
31
|
-
* Defaults to {@link [`globalThis`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/globalThis)}.
|
|
32
|
-
*/
|
|
33
|
-
global?: Record<string, any>;
|
|
34
|
-
}
|
|
35
|
-
/**
|
|
36
|
-
* A handler class for a workflow run.
|
|
37
|
-
*/
|
|
38
|
-
export declare class Run<TResult> {
|
|
39
|
-
/**
|
|
40
|
-
* The ID of the workflow run.
|
|
41
|
-
*/
|
|
42
|
-
runId: string;
|
|
43
|
-
/**
|
|
44
|
-
* The world object.
|
|
45
|
-
* @internal
|
|
46
|
-
*/
|
|
47
|
-
private world;
|
|
48
|
-
constructor(runId: string);
|
|
49
|
-
/**
|
|
50
|
-
* Cancels the workflow run.
|
|
51
|
-
*/
|
|
52
|
-
cancel(): Promise<void>;
|
|
53
|
-
/**
|
|
54
|
-
* The status of the workflow run.
|
|
55
|
-
*/
|
|
56
|
-
get status(): Promise<WorkflowRunStatus>;
|
|
57
|
-
/**
|
|
58
|
-
* The return value of the workflow run.
|
|
59
|
-
* Polls the workflow return value until it is completed.
|
|
60
|
-
*/
|
|
61
|
-
get returnValue(): Promise<TResult>;
|
|
62
|
-
/**
|
|
63
|
-
* The name of the workflow.
|
|
64
|
-
*/
|
|
65
|
-
get workflowName(): Promise<string>;
|
|
66
|
-
/**
|
|
67
|
-
* The timestamp when the workflow run was created.
|
|
68
|
-
*/
|
|
69
|
-
get createdAt(): Promise<Date>;
|
|
70
|
-
/**
|
|
71
|
-
* The timestamp when the workflow run started execution.
|
|
72
|
-
* Returns undefined if the workflow has not started yet.
|
|
73
|
-
*/
|
|
74
|
-
get startedAt(): Promise<Date | undefined>;
|
|
75
|
-
/**
|
|
76
|
-
* The timestamp when the workflow run completed.
|
|
77
|
-
* Returns undefined if the workflow has not completed yet.
|
|
78
|
-
*/
|
|
79
|
-
get completedAt(): Promise<Date | undefined>;
|
|
80
|
-
/**
|
|
81
|
-
* The readable stream of the workflow run.
|
|
82
|
-
*/
|
|
83
|
-
get readable(): ReadableStream;
|
|
84
|
-
/**
|
|
85
|
-
* Retrieves the workflow run's default readable stream, which reads chunks
|
|
86
|
-
* written to the corresponding writable stream {@link getWritable}.
|
|
87
|
-
*
|
|
88
|
-
* @param options - The options for the readable stream.
|
|
89
|
-
* @returns The `ReadableStream` for the workflow run.
|
|
90
|
-
*/
|
|
91
|
-
getReadable<R = any>(options?: WorkflowReadableStreamOptions): ReadableStream<R>;
|
|
92
|
-
/**
|
|
93
|
-
* Polls the workflow return value every 1 second until it is completed.
|
|
94
|
-
* @internal
|
|
95
|
-
* @returns The workflow return value.
|
|
96
|
-
*/
|
|
97
|
-
private pollReturnValue;
|
|
98
|
-
}
|
|
99
|
-
/**
|
|
100
|
-
* Retrieves a `Run` object for a given run ID.
|
|
101
|
-
*
|
|
102
|
-
* @param runId - The workflow run ID obtained from {@link start}.
|
|
103
|
-
* @returns A `Run` object.
|
|
104
|
-
* @throws WorkflowRunNotFoundError if the run ID is not found.
|
|
105
|
-
*/
|
|
106
|
-
export declare function getRun<TResult>(runId: string): Run<TResult>;
|
|
107
11
|
/**
|
|
108
12
|
* Function that creates a single route which handles any workflow execution
|
|
109
13
|
* request and routes to the appropriate workflow function.
|
package/dist/runtime.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"runtime.d.ts","sourceRoot":"","sources":["../src/runtime.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"runtime.d.ts","sourceRoot":"","sources":["../src/runtime.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,KAAK,KAAK,EAGV,KAAK,WAAW,EACjB,MAAM,iBAAiB,CAAC;AAwBzB,YAAY,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC;AACnC,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EACL,KAAK,mBAAmB,EACxB,KAAK,kBAAkB,EACvB,KAAK,iBAAiB,EACtB,WAAW,GACZ,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,cAAc,EACd,UAAU,EACV,aAAa,GACd,MAAM,0BAA0B,CAAC;AAClC,OAAO,EACL,MAAM,EACN,GAAG,EACH,KAAK,6BAA6B,GACnC,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACL,SAAS,EACT,WAAW,EACX,UAAU,EACV,uBAAuB,EACvB,YAAY,EACZ,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,SAAS,GACV,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EACL,WAAW,EACX,QAAQ,EACR,gBAAgB,EAChB,QAAQ,GACT,MAAM,oBAAoB,CAAC;AAE5B;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAChC,YAAY,EAAE,MAAM,GACnB,CAAC,GAAG,EAAE,OAAO,KAAK,OAAO,CAAC,QAAQ,CAAC,CA+PrC;AAID,wBAAgB,OAAO,SAAK"}
|