workflow 5.0.0-beta.5 → 5.0.0-beta.51
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/README.md +68 -23
- package/dist/api-workflow.d.ts +1 -1
- package/dist/api-workflow.d.ts.map +1 -1
- package/dist/api-workflow.js +1 -1
- package/dist/api.d.ts +3 -3
- package/dist/api.d.ts.map +1 -1
- package/dist/api.js +5 -7
- package/dist/index.d.ts +1 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +6 -1
- package/dist/internal/builtins.d.ts +20 -3
- package/dist/internal/builtins.d.ts.map +1 -1
- package/dist/internal/builtins.js +68 -4
- package/dist/internal/errors.d.ts +1 -1
- package/dist/internal/errors.d.ts.map +1 -1
- package/dist/internal/errors.js +2 -2
- package/dist/nest-builder.d.ts +2 -0
- package/dist/nest-builder.d.ts.map +1 -0
- package/dist/nest-builder.js +2 -0
- package/dist/nest-vercel-builder.d.ts +2 -0
- package/dist/nest-vercel-builder.d.ts.map +1 -0
- package/dist/nest-vercel-builder.js +2 -0
- package/dist/observability.d.ts +1 -1
- package/dist/observability.js +2 -2
- package/dist/runtime.d.ts +2 -1
- package/dist/runtime.d.ts.map +1 -1
- package/dist/runtime.js +4 -1
- package/docs/ai/chat-session-modeling.mdx +176 -422
- package/docs/ai/defining-tools.mdx +6 -7
- package/docs/ai/human-in-the-loop.mdx +11 -11
- package/docs/ai/index.mdx +71 -75
- package/docs/ai/message-queueing.mdx +71 -110
- package/docs/ai/meta.json +1 -0
- package/docs/ai/resumable-streams.mdx +40 -28
- package/docs/ai/sleep-and-delays.mdx +10 -10
- package/docs/ai/streaming-updates-from-tools.mdx +6 -6
- package/docs/api-reference/index.mdx +25 -1
- package/docs/api-reference/meta.json +8 -0
- package/docs/api-reference/vitest/index.mdx +9 -15
- package/docs/api-reference/workflow/create-hook.mdx +89 -10
- package/docs/api-reference/workflow/create-webhook.mdx +16 -15
- package/docs/api-reference/workflow/define-hook.mdx +35 -33
- package/docs/api-reference/workflow/fatal-error.mdx +30 -8
- package/docs/api-reference/workflow/fetch.mdx +14 -10
- package/docs/api-reference/workflow/get-step-metadata.mdx +2 -2
- package/docs/api-reference/workflow/get-workflow-metadata.mdx +3 -3
- package/docs/api-reference/workflow/get-writable.mdx +7 -7
- package/docs/api-reference/workflow/index.mdx +4 -1
- package/docs/api-reference/workflow/retryable-error.mdx +1 -1
- package/docs/api-reference/workflow/set-attributes.mdx +61 -0
- package/docs/api-reference/workflow/sleep.mdx +4 -4
- package/docs/api-reference/workflow-ai/durable-agent.mdx +63 -101
- package/docs/api-reference/workflow-ai/index.mdx +5 -5
- package/docs/api-reference/workflow-ai/workflow-chat-transport.mdx +67 -24
- package/docs/api-reference/workflow-api/get-hook-by-token.mdx +26 -12
- package/docs/api-reference/workflow-api/get-run.mdx +43 -8
- package/docs/api-reference/workflow-api/index.mdx +6 -10
- package/docs/api-reference/workflow-api/resume-hook.mdx +73 -12
- package/docs/api-reference/workflow-api/resume-webhook.mdx +11 -9
- package/docs/api-reference/workflow-api/start.mdx +60 -13
- package/docs/api-reference/workflow-astro/index.mdx +18 -0
- package/docs/api-reference/workflow-astro/meta.json +4 -0
- package/docs/api-reference/workflow-astro/workflow.mdx +45 -0
- package/docs/api-reference/workflow-errors/entity-conflict-error.mdx +4 -4
- package/docs/api-reference/workflow-errors/hook-conflict-error.mdx +60 -0
- package/docs/api-reference/workflow-errors/hook-not-found-error.mdx +8 -8
- package/docs/api-reference/workflow-errors/index.mdx +88 -0
- package/docs/api-reference/workflow-errors/meta.json +6 -0
- package/docs/api-reference/workflow-errors/precondition-failed-error.mdx +68 -0
- package/docs/api-reference/workflow-errors/run-expired-error.mdx +2 -2
- package/docs/api-reference/workflow-errors/run-not-supported-error.mdx +58 -0
- package/docs/api-reference/workflow-errors/step-not-registered-error.mdx +5 -5
- package/docs/api-reference/workflow-errors/throttle-error.mdx +2 -2
- package/docs/api-reference/workflow-errors/too-early-error.mdx +2 -2
- package/docs/api-reference/workflow-errors/workflow-error.mdx +52 -0
- package/docs/api-reference/workflow-errors/workflow-not-registered-error.mdx +5 -6
- package/docs/api-reference/workflow-errors/workflow-run-cancelled-error.mdx +6 -6
- package/docs/api-reference/workflow-errors/workflow-run-failed-error.mdx +5 -5
- package/docs/api-reference/workflow-errors/workflow-run-not-completed-error.mdx +58 -0
- package/docs/api-reference/workflow-errors/workflow-run-not-found-error.mdx +4 -4
- package/docs/api-reference/workflow-errors/workflow-runtime-error.mdx +58 -0
- package/docs/api-reference/workflow-errors/workflow-world-error.mdx +8 -8
- package/docs/api-reference/workflow-globals.mdx +14 -10
- package/docs/api-reference/workflow-nest/configure-workflow-controller.mdx +33 -0
- package/docs/api-reference/workflow-nest/index.mdx +31 -0
- package/docs/api-reference/workflow-nest/meta.json +9 -0
- package/docs/api-reference/workflow-nest/nest-local-builder.mdx +64 -0
- package/docs/api-reference/workflow-nest/workflow-controller.mdx +40 -0
- package/docs/api-reference/workflow-nest/workflow-module.mdx +74 -0
- package/docs/api-reference/workflow-next/with-workflow.mdx +39 -17
- package/docs/api-reference/workflow-nitro/index.mdx +60 -0
- package/docs/api-reference/workflow-nuxt/index.mdx +48 -0
- package/docs/api-reference/workflow-observability/hydrate-data.mdx +35 -0
- package/docs/api-reference/workflow-observability/hydrate-resource-io.mdx +62 -0
- package/docs/api-reference/workflow-observability/index.mdx +62 -0
- package/docs/api-reference/workflow-observability/meta.json +11 -0
- package/docs/api-reference/workflow-observability/observability-revivers.mdx +50 -0
- package/docs/api-reference/workflow-observability/parse-class-name.mdx +41 -0
- package/docs/api-reference/workflow-observability/parse-step-name.mdx +40 -0
- package/docs/api-reference/workflow-observability/parse-workflow-name.mdx +55 -0
- package/docs/api-reference/workflow-runtime/create-world.mdx +39 -0
- package/docs/api-reference/workflow-runtime/get-world-handlers.mdx +44 -0
- package/docs/api-reference/{workflow-api → workflow-runtime}/get-world.mdx +11 -14
- package/docs/api-reference/workflow-runtime/health-check.mdx +50 -0
- package/docs/api-reference/workflow-runtime/index.mdx +41 -0
- package/docs/api-reference/workflow-runtime/meta.json +12 -0
- package/docs/api-reference/workflow-runtime/set-world.mdx +51 -0
- package/docs/api-reference/workflow-runtime/workflow-entrypoint.mdx +43 -0
- package/docs/api-reference/workflow-runtime/world/analytics.mdx +315 -0
- package/docs/api-reference/workflow-runtime/world/index.mdx +60 -0
- package/docs/api-reference/workflow-runtime/world/meta.json +4 -0
- package/docs/api-reference/workflow-runtime/world/queue.mdx +88 -0
- package/docs/api-reference/{workflow-api → workflow-runtime}/world/storage.mdx +98 -34
- package/docs/api-reference/{workflow-api → workflow-runtime}/world/streams.mdx +8 -8
- package/docs/api-reference/workflow-serde/index.mdx +1 -2
- package/docs/api-reference/workflow-serde/workflow-deserialize.mdx +3 -4
- package/docs/api-reference/workflow-serde/workflow-serialize.mdx +8 -8
- package/docs/api-reference/workflow-sveltekit/index.mdx +18 -0
- package/docs/api-reference/workflow-sveltekit/meta.json +4 -0
- package/docs/api-reference/workflow-sveltekit/workflow-plugin.mdx +42 -0
- package/docs/api-reference/workflow-vite/index.mdx +18 -0
- package/docs/api-reference/workflow-vite/meta.json +4 -0
- package/docs/api-reference/workflow-vite/workflow.mdx +48 -0
- package/docs/changelog/attributes-mvp.mdx +380 -0
- package/docs/changelog/batched-event-writes.mdx +79 -0
- package/docs/changelog/eager-processing.mdx +110 -436
- package/docs/changelog/index.mdx +4 -2
- package/docs/changelog/lazy-event-creation.md +127 -0
- package/docs/changelog/lazy-hook-resume.mdx +78 -0
- package/docs/changelog/meta.json +11 -1
- package/docs/changelog/resilient-resume.mdx +32 -0
- package/docs/changelog/resilient-start.mdx +33 -285
- package/docs/changelog/step-message-ownership.mdx +360 -0
- package/docs/changelog/turbo-mode.md +87 -0
- package/docs/comparisons/index.mdx +66 -0
- package/docs/comparisons/meta.json +11 -0
- package/docs/comparisons/workflow-sdk-vs-aws-agentcore.mdx +55 -0
- package/docs/comparisons/workflow-sdk-vs-aws-step-functions.mdx +111 -0
- package/docs/comparisons/workflow-sdk-vs-cloudflare-workflows.mdx +71 -0
- package/docs/comparisons/workflow-sdk-vs-inngest.mdx +102 -0
- package/docs/comparisons/workflow-sdk-vs-temporal.mdx +123 -0
- package/docs/comparisons/workflow-sdk-vs-trigger-dev.mdx +104 -0
- package/docs/configuration/build-and-diagnostics.mdx +70 -0
- package/docs/configuration/cli-and-web-ui.mdx +241 -0
- package/docs/configuration/framework-options.mdx +165 -0
- package/docs/configuration/index.mdx +32 -0
- package/docs/configuration/meta.json +12 -0
- package/docs/configuration/runtime-tuning.mdx +381 -0
- package/docs/configuration/worlds.mdx +313 -0
- package/docs/cookbook/advanced/child-workflows.mdx +211 -264
- package/docs/cookbook/advanced/meta.json +6 -1
- package/docs/cookbook/advanced/publishing-libraries.mdx +65 -56
- package/docs/cookbook/advanced/serializable-steps.mdx +48 -68
- package/docs/cookbook/advanced/upgrading-workflows.mdx +199 -0
- package/docs/cookbook/agent-patterns/agent-cancellation.mdx +78 -60
- package/docs/cookbook/agent-patterns/durable-agent.mdx +23 -131
- package/docs/cookbook/agent-patterns/human-in-the-loop.mdx +180 -195
- package/docs/cookbook/common-patterns/batching.mdx +18 -14
- package/docs/cookbook/common-patterns/idempotency.mdx +41 -53
- package/docs/cookbook/common-patterns/rate-limiting.mdx +8 -4
- package/docs/cookbook/common-patterns/saga.mdx +23 -19
- package/docs/cookbook/common-patterns/scheduling.mdx +34 -22
- package/docs/cookbook/common-patterns/sequential-and-parallel.mdx +29 -25
- package/docs/cookbook/common-patterns/timeouts.mdx +26 -21
- package/docs/cookbook/common-patterns/webhooks.mdx +10 -6
- package/docs/cookbook/common-patterns/workflow-composition.mdx +30 -27
- package/docs/cookbook/index.mdx +22 -21
- package/docs/cookbook/integrations/ai-sdk.mdx +86 -48
- package/docs/cookbook/integrations/chat-sdk.mdx +50 -33
- package/docs/cookbook/integrations/sandbox.mdx +62 -45
- package/docs/deploying.mdx +95 -0
- package/docs/errors/abort-signal-timeout-in-workflow.mdx +16 -12
- package/docs/errors/corrupted-event-log.mdx +39 -18
- package/docs/errors/deployment-mismatch.mdx +71 -0
- package/docs/errors/fetch-in-workflow.mdx +15 -14
- package/docs/errors/hook-conflict.mdx +69 -13
- package/docs/errors/index.mdx +2 -36
- package/docs/errors/node-js-module-in-workflow.mdx +9 -5
- package/docs/errors/replay-divergence.mdx +27 -0
- package/docs/errors/run-expired.mdx +85 -0
- package/docs/errors/runtime-decryption-failed.mdx +77 -0
- package/docs/errors/serialization-failed.mdx +44 -12
- package/docs/errors/start-invalid-workflow-function.mdx +9 -5
- package/docs/errors/step-executed-multiple-times.mdx +23 -0
- package/docs/errors/step-not-registered.mdx +6 -6
- package/docs/errors/timeout-in-workflow.mdx +12 -8
- package/docs/errors/webhook-invalid-respond-with-value.mdx +18 -18
- package/docs/errors/webhook-response-not-sent.mdx +20 -16
- package/docs/errors/workflow-not-registered.mdx +5 -5
- package/docs/foundations/cancellation.mdx +31 -32
- package/docs/foundations/errors-and-retries.mdx +42 -11
- package/docs/foundations/hooks.mdx +64 -35
- package/docs/foundations/idempotency.mdx +244 -12
- package/docs/foundations/index.mdx +1 -23
- package/docs/foundations/meta.json +2 -1
- package/docs/foundations/serialization.mdx +21 -22
- package/docs/foundations/starting-workflows.mdx +106 -30
- package/docs/foundations/streaming.mdx +108 -60
- package/docs/foundations/versioning.mdx +263 -0
- package/docs/foundations/workflows-and-steps.mdx +9 -9
- package/docs/getting-started/astro.mdx +22 -18
- package/docs/getting-started/express.mdx +15 -11
- package/docs/getting-started/fastify.mdx +15 -11
- package/docs/getting-started/hono.mdx +15 -11
- package/docs/getting-started/index.mdx +10 -3
- package/docs/getting-started/meta.json +3 -1
- package/docs/getting-started/nestjs.mdx +87 -20
- package/docs/getting-started/next.mdx +22 -16
- package/docs/getting-started/nitro.mdx +22 -18
- package/docs/getting-started/nuxt.mdx +15 -11
- package/docs/getting-started/python.mdx +190 -41
- package/docs/getting-started/react-router/index.mdx +33 -0
- package/docs/getting-started/react-router/meta.json +5 -0
- package/docs/getting-started/react-router/v7.mdx +237 -0
- package/docs/getting-started/react-router/v8.mdx +232 -0
- package/docs/getting-started/sveltekit.mdx +20 -16
- package/docs/getting-started/tanstack-start.mdx +17 -13
- package/docs/getting-started/vite.mdx +15 -11
- package/docs/how-it-works/cancellation.mdx +63 -63
- package/docs/how-it-works/code-transform.mdx +83 -67
- package/docs/how-it-works/encryption.mdx +30 -26
- package/docs/how-it-works/event-sourcing.mdx +125 -34
- package/docs/how-it-works/framework-integrations.mdx +96 -337
- package/docs/how-it-works/understanding-directives.mdx +22 -22
- package/docs/internal/index.mdx +6 -4
- package/docs/internal/meta.json +6 -1
- package/docs/internal/nitro-native-build.mdx +38 -0
- package/docs/internal/nitro-web-ui.mdx +24 -0
- package/docs/internal/serializable-abort-controller.mdx +7 -7
- package/docs/meta.json +3 -2
- package/docs/observability/attributes.mdx +134 -0
- package/docs/observability/index.mdx +32 -10
- package/docs/observability/meta.json +1 -1
- package/docs/observability/retention.mdx +95 -0
- package/docs/observability/tracing.mdx +124 -0
- package/docs/testing/index.mdx +36 -36
- package/docs/testing/server-based.mdx +10 -10
- package/docs/whats-new.mdx +186 -0
- package/package.json +17 -14
- package/docs/api-reference/workflow-api/world/index.mdx +0 -58
- package/docs/api-reference/workflow-api/world/meta.json +0 -4
- package/docs/api-reference/workflow-api/world/observability.mdx +0 -164
- package/docs/api-reference/workflow-api/world/queue.mdx +0 -86
- package/docs/deploying/building-a-world.mdx +0 -251
- package/docs/deploying/index.mdx +0 -95
- package/docs/deploying/meta.json +0 -4
- package/docs/deploying/world/local-world.mdx +0 -84
- package/docs/deploying/world/meta.json +0 -4
- package/docs/deploying/world/postgres-world.mdx +0 -224
- package/docs/deploying/world/vercel-world.mdx +0 -179
- package/docs/migration-guides/index.mdx +0 -34
- package/docs/migration-guides/meta.json +0 -9
- package/docs/migration-guides/migrating-from-aws-step-functions.mdx +0 -363
- package/docs/migration-guides/migrating-from-inngest.mdx +0 -314
- package/docs/migration-guides/migrating-from-temporal.mdx +0 -318
- package/docs/migration-guides/migrating-from-trigger-dev.mdx +0 -337
|
@@ -2,16 +2,20 @@
|
|
|
2
2
|
title: Publishing Libraries
|
|
3
3
|
description: Structure and publish npm packages that export workflow functions for consumers to use with Workflow SDK.
|
|
4
4
|
type: guide
|
|
5
|
-
summary: Learn how to build, export, and test npm packages that ship workflow and step functions
|
|
5
|
+
summary: Learn how to build, export, and test npm packages that ship workflow and step functions, including package.json exports, re-exporting so the consumer's compiler discovers your workflows, keeping step I/O clean, and integration testing.
|
|
6
6
|
---
|
|
7
7
|
|
|
8
|
+
<CopyPrompt
|
|
9
|
+
text="Package these workflow functions as a publishable npm library. Give the package a dedicated workflows entry point (for example `exports["./workflows"]`) that ships the workflow and step source for the consumer's compiler to process. Keep every workflow and step input and output serializable, and read credentials from environment variables inside steps instead of accepting client instances. Document the consumer re-export requirement: consumers create a file in their `workflows/` directory containing `export * from "<pkg>/workflows"` so their build discovers and compiles the library's workflow and step files and replay can resolve them after cold starts. Add an integration test that runs a library workflow end to end from a consumer-style setup. Verify the build, that the library's workflows and steps show up as compiled entries, and replay safety."
|
|
10
|
+
/>
|
|
11
|
+
|
|
8
12
|
import { File, Folder, Files } from "fumadocs-ui/components/files";
|
|
9
13
|
|
|
10
14
|
<Callout>
|
|
11
15
|
This is an advanced guide for library authors who want to publish reusable workflow functions as npm packages. It assumes familiarity with `"use workflow"`, `"use step"`, and the workflow execution model.
|
|
12
16
|
</Callout>
|
|
13
17
|
|
|
14
|
-
## Package
|
|
18
|
+
## Package structure
|
|
15
19
|
|
|
16
20
|
A workflow library follows a standard TypeScript package layout with a dedicated `workflows/` directory. Each workflow file exports one or more workflow functions that consumers can import and pass to `start()`.
|
|
17
21
|
|
|
@@ -40,14 +44,14 @@ A workflow library follows a standard TypeScript package layout with a dedicated
|
|
|
40
44
|
|
|
41
45
|
Key files:
|
|
42
46
|
|
|
43
|
-
- **`src/index.ts
|
|
44
|
-
- **`src/types.ts
|
|
45
|
-
- **`src/workflows/index.ts
|
|
46
|
-
- **`src/workflows/*.ts
|
|
47
|
-
- **`src/lib
|
|
48
|
-
- **`test-server/workflows.ts
|
|
47
|
+
- **`src/index.ts`**: Package entry point that exports the public API.
|
|
48
|
+
- **`src/types.ts`**: Shared TypeScript types.
|
|
49
|
+
- **`src/workflows/index.ts`**: Re-exports every workflow so consumers can pull them in under one specifier (see [Entry points and exports](#entry-points-and-exports)).
|
|
50
|
+
- **`src/workflows/*.ts`**: One file per workflow function (for example, `transcode.ts` or `generate-thumbnails.ts`).
|
|
51
|
+
- **`src/lib/`**: Internal helpers with plain async code that is not marked with `"use workflow"` or `"use step"`.
|
|
52
|
+
- **`test-server/workflows.ts`**: Re-export file used by integration tests (see [Test workflow libraries](#test-workflow-libraries)).
|
|
49
53
|
|
|
50
|
-
### Entry
|
|
54
|
+
### Entry points and exports
|
|
51
55
|
|
|
52
56
|
Use the `exports` field in `package.json` to expose separate entry points for the main API and the raw workflow functions:
|
|
53
57
|
|
|
@@ -71,7 +75,7 @@ Use the `exports` field in `package.json` to expose separate entry points for th
|
|
|
71
75
|
|
|
72
76
|
The main entry point (`@acme/media`) exports types, utilities, and convenience wrappers. The `./workflows` entry point (`@acme/media/workflows`) exports the raw workflow functions that consumers need for the build system.
|
|
73
77
|
|
|
74
|
-
### Source
|
|
78
|
+
### Source files
|
|
75
79
|
|
|
76
80
|
The package entry re-exports workflows alongside any utilities:
|
|
77
81
|
|
|
@@ -89,7 +93,7 @@ export * from "./transcode";
|
|
|
89
93
|
export * from "./generate-thumbnails";
|
|
90
94
|
```
|
|
91
95
|
|
|
92
|
-
### Build
|
|
96
|
+
### Build configuration
|
|
93
97
|
|
|
94
98
|
Use a bundler like `tsup` with separate entry points for each export. Mark `workflow` as external so it's resolved from the consumer's project:
|
|
95
99
|
|
|
@@ -110,39 +114,43 @@ export default defineConfig({
|
|
|
110
114
|
});
|
|
111
115
|
```
|
|
112
116
|
|
|
113
|
-
## Re-
|
|
117
|
+
## Re-exporting for compiler discovery
|
|
114
118
|
|
|
115
|
-
|
|
119
|
+
The workflow compiler only transforms files it discovers, and discovery starts from the consumer's `workflows/` directory and follows imports out from there. A library's workflow functions are not on that graph by default, so nothing compiles them and the runtime has no definition to run.
|
|
116
120
|
|
|
117
|
-
The fix is a **re-export file**. The consumer creates a file in their `workflows/` directory that re-exports the library's workflows
|
|
121
|
+
The fix is a **re-export file**. The consumer creates a file in their `workflows/` directory that re-exports the library's workflows, which pulls the library's source onto the discovery graph and gives its entry point an address the runtime can resolve.
|
|
118
122
|
|
|
119
|
-
### Consumer
|
|
123
|
+
### Consumer setup
|
|
120
124
|
|
|
121
125
|
```typescript lineNumbers
|
|
122
126
|
// workflows/media.ts (in the consumer's project)
|
|
123
|
-
// Re-export library workflows so the
|
|
127
|
+
// Re-export library workflows so the compiler discovers and transforms them
|
|
124
128
|
export * from "@acme/media/workflows"; // [!code highlight]
|
|
125
129
|
```
|
|
126
130
|
|
|
127
|
-
This one-line file is all that's needed. The
|
|
131
|
+
This one-line file is all that's needed. The compiler follows the re-export into the package, transforms the workflow and step functions it finds, and registers them under IDs the runtime can resolve.
|
|
132
|
+
|
|
133
|
+
### Why this is necessary
|
|
134
|
+
|
|
135
|
+
Without re-exporting, the workflow runtime cannot match a running workflow to its function definition. When a run is replayed after a cold start, the runtime looks up functions by their compiler-assigned IDs. If those functions were never compiled, the IDs don't exist and replay fails.
|
|
128
136
|
|
|
129
|
-
|
|
137
|
+
Point the re-export at the package's dedicated workflows entry point rather than a deep path into `dist/`. Files reachable through the package's `exports` map get an ID of the form `name/subpath@version`; a deep, non-exported file falls back to a path-based ID instead.
|
|
130
138
|
|
|
131
|
-
|
|
139
|
+
<Callout type="info">
|
|
140
|
+
**IDs for code you ship embed your package version.** A step in `@acme/media` version `1.4.0` gets the ID `step//@acme/media/workflows@1.4.0//transcode`, so publishing `1.5.0` renames every workflow and step the package ships.
|
|
132
141
|
|
|
133
|
-
|
|
142
|
+
That is safe on worlds with deployment pinning, such as Vercel, because runs are pinned to the deployment that started them. A run records its deployment ID and every resume targets that same deployment, so after a consumer upgrades, new runs execute the new version while runs already in flight keep replaying against the old one. Consumers do not need to drain anything before upgrading.
|
|
134
143
|
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
3. **Version upgrades** — re-exported IDs remain stable as long as the consumer's file doesn't change
|
|
144
|
+
The re-export file does not change any of this. An ID is derived from where the file lives, not from how it was imported, so a package file keeps its `name@version` ID whether or not a consumer re-exports it.
|
|
145
|
+
</Callout>
|
|
138
146
|
|
|
139
|
-
## Keeping
|
|
147
|
+
## Keeping step I/O clean
|
|
140
148
|
|
|
141
149
|
When you publish a workflow library, every step function's inputs and outputs are recorded in the event log. This has two implications:
|
|
142
150
|
|
|
143
|
-
### 1. Everything
|
|
151
|
+
### 1. Everything must be serializable
|
|
144
152
|
|
|
145
|
-
Step inputs and outputs must be serializable. The workflow runtime supports a rich set of types beyond plain JSON
|
|
153
|
+
Step inputs and outputs must be serializable. The workflow runtime supports a rich set of types beyond plain JSON, including `Date`, `RegExp`, `Map`, `Set`, `BigInt`, `Uint8Array`, `URL`, `Error`, and class instances that implement [custom class serialization](/docs/foundations/serialization#custom-class-serialization). See the [serialization reference](/docs/foundations/serialization) for the full list of supported types. Do not pass or return:
|
|
146
154
|
|
|
147
155
|
- Functions or closures
|
|
148
156
|
- `WeakRef`, `WeakMap`, or `WeakSet`
|
|
@@ -161,7 +169,7 @@ async function callExternalApi(endpoint: string, params: Record<string, string>)
|
|
|
161
169
|
// Bad: pass a pre-constructed client object
|
|
162
170
|
async function callExternalApi(client: ApiClient, params: Record<string, string>) {
|
|
163
171
|
"use step";
|
|
164
|
-
// ApiClient is not serializable
|
|
172
|
+
// ApiClient is not serializable, so this will fail on replay
|
|
165
173
|
return await client.request(params);
|
|
166
174
|
}
|
|
167
175
|
```
|
|
@@ -191,13 +199,13 @@ async function fetchData(apiKey: string, query: string) {
|
|
|
191
199
|
|
|
192
200
|
The choice is a matter of library API design preference. Resolving from environment variables keeps the step signature simpler, while passing credentials explicitly makes dependencies visible and can be easier to test.
|
|
193
201
|
|
|
194
|
-
## Testing
|
|
202
|
+
## Testing workflow libraries
|
|
195
203
|
|
|
196
|
-
Library authors need integration tests that exercise workflows through the full Workflow SDK runtime
|
|
204
|
+
Library authors need integration tests that exercise workflows through the full Workflow SDK runtime, rather than only unit tests of individual functions.
|
|
197
205
|
|
|
198
|
-
### Test
|
|
206
|
+
### Test server pattern
|
|
199
207
|
|
|
200
|
-
Create a minimal test server that re-exports your library's workflows,
|
|
208
|
+
Create a minimal test server that re-exports your library's workflows, like a consumer would:
|
|
201
209
|
|
|
202
210
|
```typescript lineNumbers
|
|
203
211
|
// test-server/workflows.ts
|
|
@@ -206,7 +214,7 @@ export * from "@acme/media/workflows"; // [!code highlight]
|
|
|
206
214
|
|
|
207
215
|
This test server acts as a stand-in consumer app. Point your test runner at it to exercise the full workflow lifecycle: start, replay, and completion.
|
|
208
216
|
|
|
209
|
-
### Vitest
|
|
217
|
+
### Vitest configuration
|
|
210
218
|
|
|
211
219
|
Use a dedicated Vitest config for integration tests that run against the Workflow SDK runtime:
|
|
212
220
|
|
|
@@ -233,22 +241,22 @@ pnpm vitest run tests/unit
|
|
|
233
241
|
pnpm vitest run --config vitest.workflowsdk.config.ts
|
|
234
242
|
```
|
|
235
243
|
|
|
236
|
-
### What to
|
|
244
|
+
### What to test
|
|
237
245
|
|
|
238
|
-
- **Happy path**: workflow starts, all steps execute, and the final result is correct
|
|
239
|
-
- **Serialization round-trip**:
|
|
240
|
-
- **Replay**:
|
|
241
|
-
- **Error handling**:
|
|
246
|
+
- **Happy path**: The workflow starts, all steps execute, and the final result is correct.
|
|
247
|
+
- **Serialization round-trip**: Inputs and outputs survive the event log.
|
|
248
|
+
- **Replay**: Stop and restart a workflow during execution to verify deterministic replay.
|
|
249
|
+
- **Error handling**: Step failures produce the expected errors.
|
|
242
250
|
|
|
243
|
-
## Working
|
|
251
|
+
## Working with and without Workflow installed
|
|
244
252
|
|
|
245
|
-
Some libraries
|
|
253
|
+
Some libraries need to support consumers who *aren't* using Workflow SDK. The library gains durable behavior when a workflow runtime is present and falls back to plain async execution otherwise.
|
|
246
254
|
|
|
247
255
|
<Callout type="info">
|
|
248
256
|
Two rules for isomorphic packages:
|
|
249
257
|
|
|
250
|
-
1. **
|
|
251
|
-
2. **
|
|
258
|
+
1. **Load any runtime reference to the `workflow` package through dynamic `import("workflow")` inside a try/catch.** A static top-level import makes the module fail to load for consumers who haven't installed Workflow.
|
|
259
|
+
2. **Keep the `"use workflow"` and `"use step"` directives in your library source.** When a consumer compiles your code with the Workflow SDK toolchain (via the [re-export pattern](#re-export-for-compiler-discovery) above), the SWC plugin transforms the directives into durable-execution glue. When the directives aren't compiled (plain Node.js, plain tests, or a consumer without the runtime), they are string expression statements and run as no-ops.
|
|
252
260
|
</Callout>
|
|
253
261
|
|
|
254
262
|
### Optional peer dependency
|
|
@@ -270,14 +278,14 @@ Declare `workflow` as an **optional** peer so consumers without the runtime aren
|
|
|
270
278
|
|
|
271
279
|
### Runtime detection
|
|
272
280
|
|
|
273
|
-
Wrap a dynamic `import("workflow")` in try/catch. If either the module isn't installed *or* `
|
|
281
|
+
Wrap a dynamic `import("workflow")` in try/catch. If either the module isn't installed *or* `getStepMetadata()` throws (call site isn't inside a workflow step), fall through to the standalone path.
|
|
274
282
|
|
|
275
283
|
```typescript lineNumbers
|
|
276
|
-
async function
|
|
284
|
+
async function getWorkflowStepId(): Promise<string | null> { // [!code highlight]
|
|
277
285
|
try {
|
|
278
286
|
const wf = await import("workflow");
|
|
279
|
-
const {
|
|
280
|
-
return
|
|
287
|
+
const { stepId } = wf.getStepMetadata();
|
|
288
|
+
return stepId;
|
|
281
289
|
} catch {
|
|
282
290
|
return null;
|
|
283
291
|
}
|
|
@@ -286,13 +294,14 @@ async function getWorkflowRunId(): Promise<string | null> { // [!code highlight]
|
|
|
286
294
|
|
|
287
295
|
### A concrete use case: replay-safe idempotency keys
|
|
288
296
|
|
|
289
|
-
A payments utility
|
|
297
|
+
A payments utility can use the current workflow step ID as a Stripe idempotency key when available and a fresh universally unique identifier (UUID) otherwise:
|
|
290
298
|
|
|
291
|
-
{/* @skip-typecheck - depends on getWorkflowRunId defined in the previous block */}
|
|
292
299
|
```typescript lineNumbers
|
|
300
|
+
declare function getWorkflowStepId(): Promise<string | null>; // @setup (defined in the previous block)
|
|
301
|
+
|
|
293
302
|
export async function processPayment(amount: number, currency: string) {
|
|
294
|
-
const
|
|
295
|
-
const idempotencyKey =
|
|
303
|
+
const stepId = await getWorkflowStepId();
|
|
304
|
+
const idempotencyKey = stepId ? `payment:${stepId}` : crypto.randomUUID(); // [!code highlight]
|
|
296
305
|
|
|
297
306
|
const res = await fetch("https://api.stripe.com/v1/charges", {
|
|
298
307
|
method: "POST",
|
|
@@ -306,14 +315,14 @@ export async function processPayment(amount: number, currency: string) {
|
|
|
306
315
|
}
|
|
307
316
|
```
|
|
308
317
|
|
|
309
|
-
When called from inside a workflow
|
|
318
|
+
When called from inside a workflow step, the utility gets a stable idempotency key for that step across retries, so Stripe deduplicates retries. When called from a plain Node.js process, it behaves like any other function and generates a fresh UUID. For more patterns, see [Idempotency](/docs/foundations/idempotency).
|
|
310
319
|
|
|
311
320
|
### In production
|
|
312
321
|
|
|
313
322
|
Packages in the wild built on Workflow SDK:
|
|
314
323
|
|
|
315
|
-
- **[`@mux/ai`](https://github.com/muxinc/ai)
|
|
316
|
-
- **World ID
|
|
324
|
+
- **[`@mux/ai`](https://github.com/muxinc/ai)**: Reusable video AI workflows (summaries, chapters, content moderation, translation, embeddings) exported with `"use workflow"` / `"use step"` directives. In a standard Node environment the directives are no-ops and the SDK runs as a plain async library; in a Workflow SDK environment the consumer's compiler transforms them into durable, resumable steps with automatic retries and observability. Written up in detail in [*How Mux shipped durable video workflows with their @mux/ai SDK*](https://vercel.com/blog/how-mux-shipped-durable-video-workflows-with-their-mux-ai-sdk) on the Vercel blog.
|
|
325
|
+
- **World ID**: Human-in-the-loop "proof of human" primitive for agent workflows. Developers drop a World ID step into any workflow to require a zero-knowledge cryptographic proof that a real, unique human authorized a specific action (deploy approvals, large payments, sensitive data access, etc.). Because it runs as a workflow step, every verification is durable, replay-safe, and viewable inside the run's execution timeline, giving you a provable audit record of which human approved what. Available on npm and announced in [*World ID for agents: Browserbase, Exa, Okta, and Vercel*](https://world.org/blog/announcements/browserbase-exa-okta-world-id-for-agentic-web) on the World blog.
|
|
317
326
|
|
|
318
327
|
## Checklist
|
|
319
328
|
|
|
@@ -330,7 +339,7 @@ Before publishing a workflow library:
|
|
|
330
339
|
|
|
331
340
|
## Key APIs
|
|
332
341
|
|
|
333
|
-
- [`"use workflow"`](/docs/
|
|
334
|
-
- [`"use step"`](/docs/
|
|
335
|
-
- [`start`](/docs/api-reference/workflow/start)
|
|
336
|
-
- [`getWorkflowMetadata`](/docs/api-reference/workflow/get-workflow-metadata)
|
|
342
|
+
- [`"use workflow"`](/docs/foundations/workflows-and-steps#workflow-functions): Declares the orchestrator function.
|
|
343
|
+
- [`"use step"`](/docs/foundations/workflows-and-steps#step-functions): Marks functions for durable execution.
|
|
344
|
+
- [`start`](/docs/api-reference/workflow-api/start): Starts a workflow run.
|
|
345
|
+
- [`getWorkflowMetadata`](/docs/api-reference/workflow/get-workflow-metadata): Provides runtime detection and run ID access.
|
|
@@ -1,14 +1,18 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: Serializable Steps
|
|
3
|
-
description: Wrap non-serializable third-party objects
|
|
3
|
+
description: Wrap non-serializable third-party objects, including AI provider models and cloud clients, inside step factory functions.
|
|
4
4
|
type: guide
|
|
5
|
-
summary:
|
|
5
|
+
summary: Defer construction of non-owned AI provider models and cloud SDK clients until step execution so they remain usable in durable workflows.
|
|
6
6
|
related:
|
|
7
7
|
- /docs/foundations/serialization
|
|
8
8
|
- /docs/foundations/serialization#custom-class-serialization
|
|
9
|
-
- /docs/
|
|
9
|
+
- /docs/foundations/workflows-and-steps#step-functions
|
|
10
10
|
---
|
|
11
11
|
|
|
12
|
+
<CopyPrompt
|
|
13
|
+
text="Make this non-serializable dependency usable inside a durable workflow with the step-as-factory pattern. Instead of passing an AI provider model, cloud SDK client, or other class instance into the workflow, export a factory that returns an async callback marked with "use step". Capture only serializable constructor options, construct the provider or client inside the step, and keep the instance inside that step's execution. Verify the workflow builds, replays deterministically, and never serializes the live dependency."
|
|
14
|
+
/>
|
|
15
|
+
|
|
12
16
|
<Callout>
|
|
13
17
|
This is an advanced guide. It dives into workflow internals and is not required reading to use workflow.
|
|
14
18
|
</Callout>
|
|
@@ -17,94 +21,69 @@ This is an advanced guide. It dives into workflow internals and is not required
|
|
|
17
21
|
|
|
18
22
|
Workflow functions run inside a sandboxed VM where every value that crosses a function boundary must be serializable. There are two ways to get a non-serializable object across that boundary, depending on whether you own the class:
|
|
19
23
|
|
|
20
|
-
- **You own the class
|
|
21
|
-
- **You don't own the class
|
|
24
|
+
- **You own the class**: implement the [`WORKFLOW_SERIALIZE` / `WORKFLOW_DESERIALIZE` protocol](/docs/foundations/serialization#custom-class-serialization). The instance becomes a first-class serializable value: you can pass it as a workflow input, return it from a step, and call `"use step"` instance methods on it directly. This is the right tool when the class is yours to modify.
|
|
25
|
+
- **You don't own the class**: you can't add serialization methods to `openai("gpt-5.6-sol")` from `@ai-sdk/openai` or `new S3Client({...})` from `@aws-sdk/client-s3`. Instead, wrap construction and use in a `"use step"` factory function. That's what this page covers.
|
|
22
26
|
|
|
23
|
-
## The
|
|
27
|
+
## The problem
|
|
24
28
|
|
|
25
|
-
AI SDK
|
|
29
|
+
AI SDK provider models and cloud SDK clients often contain methods, closures, sockets, and internal state. Passing one across a workflow boundary causes a serialization error, and you can't add `WORKFLOW_SERIALIZE` to a class you don't own.
|
|
26
30
|
|
|
27
31
|
```typescript lineNumbers
|
|
28
|
-
import {
|
|
29
|
-
import { DurableAgent } from "@workflow/ai/agent";
|
|
30
|
-
import { getWritable } from "workflow";
|
|
31
|
-
import type { UIMessageChunk } from "ai";
|
|
32
|
+
import { S3Client } from "@aws-sdk/client-s3";
|
|
32
33
|
|
|
33
|
-
|
|
34
|
-
"use
|
|
34
|
+
async function uploadFile(client: S3Client, key: string) {
|
|
35
|
+
"use step";
|
|
36
|
+
// ... upload with client ...
|
|
37
|
+
}
|
|
35
38
|
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
// This fails — the model object is not serializable
|
|
39
|
-
model: openai("gpt-4o"),
|
|
40
|
-
});
|
|
39
|
+
export async function brokenUpload(region: string, key: string) {
|
|
40
|
+
"use workflow";
|
|
41
41
|
|
|
42
|
-
|
|
42
|
+
const client = new S3Client({ region });
|
|
43
|
+
await uploadFile(client, key); // Fails: S3Client is not serializable
|
|
43
44
|
}
|
|
44
45
|
```
|
|
45
46
|
|
|
46
|
-
## The
|
|
47
|
+
## The solution: step-as-factory
|
|
47
48
|
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
```typescript lineNumbers
|
|
51
|
-
import { openai as openaiProvider } from "@ai-sdk/openai";
|
|
52
|
-
|
|
53
|
-
// Returns a step function, not a model object
|
|
54
|
-
export function openai(...args: Parameters<typeof openaiProvider>) {
|
|
55
|
-
return async () => {
|
|
56
|
-
"use step";
|
|
57
|
-
return openaiProvider(...args); // [!code highlight]
|
|
58
|
-
};
|
|
59
|
-
}
|
|
60
|
-
```
|
|
49
|
+
Apply the same pattern to any non-serializable dependency. The key rule: **the outer function captures serializable arguments, and the inner `"use step"` function constructs the real object at runtime**.
|
|
61
50
|
|
|
62
|
-
|
|
51
|
+
<Callout type="info">
|
|
52
|
+
A plain Vercel AI Gateway model string such as `"spacexai/grok-4.6"` is already serializable and does not need a factory.
|
|
53
|
+
</Callout>
|
|
63
54
|
|
|
64
|
-
|
|
55
|
+
### AI provider example
|
|
65
56
|
|
|
66
|
-
|
|
57
|
+
When using an AI SDK provider package, construct and use its model inside the step. The outer factory captures only the serializable model ID:
|
|
67
58
|
|
|
68
59
|
```typescript lineNumbers
|
|
69
|
-
|
|
70
|
-
import {
|
|
60
|
+
import { openai } from "@ai-sdk/openai";
|
|
61
|
+
import { generateText } from "ai";
|
|
71
62
|
|
|
72
|
-
export function
|
|
73
|
-
return async () => {
|
|
63
|
+
export function createOpenAIGenerator(modelId: string) {
|
|
64
|
+
return async (prompt: string) => {
|
|
74
65
|
"use step";
|
|
75
|
-
|
|
66
|
+
const { text } = await generateText({ model: openai(modelId), prompt });
|
|
67
|
+
return text;
|
|
76
68
|
};
|
|
77
69
|
}
|
|
78
|
-
```
|
|
79
70
|
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
```typescript lineNumbers
|
|
83
|
-
import { anthropic } from "@workflow/ai/anthropic";
|
|
84
|
-
import { DurableAgent } from "@workflow/ai/agent";
|
|
85
|
-
import { getWritable } from "workflow";
|
|
86
|
-
import type { UIMessageChunk } from "ai";
|
|
87
|
-
|
|
88
|
-
export async function chatAgent(prompt: string) {
|
|
71
|
+
export async function summarize(prompt: string) {
|
|
89
72
|
"use workflow";
|
|
90
73
|
|
|
91
|
-
const
|
|
92
|
-
|
|
93
|
-
model: anthropic("claude-sonnet-4-20250514"), // [!code highlight]
|
|
94
|
-
});
|
|
95
|
-
|
|
96
|
-
await agent.stream({ messages: [{ role: "user", content: prompt }], writable });
|
|
74
|
+
const generate = createOpenAIGenerator("gpt-5.6-sol");
|
|
75
|
+
return generate(prompt);
|
|
97
76
|
}
|
|
98
77
|
```
|
|
99
78
|
|
|
100
|
-
|
|
79
|
+
The same structure works with provider packages such as `@ai-sdk/anthropic` and `@ai-sdk/google`: capture serializable configuration in the outer function and keep the provider object inside the step. For durable agent loops, continue to use `WorkflowAgent`; the factory pattern is for lower-level AI SDK calls and other third-party dependencies.
|
|
101
80
|
|
|
102
|
-
|
|
81
|
+
### Cloud client example
|
|
103
82
|
|
|
104
83
|
```typescript lineNumbers
|
|
105
84
|
import type { S3Client as S3ClientType } from "@aws-sdk/client-s3";
|
|
106
85
|
|
|
107
|
-
// The
|
|
86
|
+
// The region is a plain string, which is serializable
|
|
108
87
|
export function createS3Client(region: string) {
|
|
109
88
|
return async (): Promise<S3ClientType> => {
|
|
110
89
|
"use step";
|
|
@@ -133,15 +112,16 @@ async function uploadFile(
|
|
|
133
112
|
}
|
|
134
113
|
```
|
|
135
114
|
|
|
136
|
-
## Why
|
|
115
|
+
## Why this works
|
|
137
116
|
|
|
138
|
-
1. **Compiler transformation**: `"use step"` tells the SWC plugin to extract the function into a separate bundle. The workflow VM only sees a serializable reference (function ID
|
|
139
|
-
2. **Closure tracking**: The compiler tracks which variables the step function closes over.
|
|
140
|
-
3. **Deferred construction**: The
|
|
117
|
+
1. **Compiler transformation**: `"use step"` tells the SWC plugin to extract the function into a separate bundle. The workflow VM only sees a serializable reference (function ID and captured arguments).
|
|
118
|
+
2. **Closure tracking**: The compiler tracks which variables the step function closes over. The function can capture only serializable values, such as strings, numbers, and plain objects.
|
|
119
|
+
3. **Deferred construction**: The step constructs the provider or client only when it executes in the Node.js runtime, never in the sandboxed workflow VM.
|
|
141
120
|
|
|
142
121
|
## Key APIs
|
|
143
122
|
|
|
144
|
-
- [`"use step"`](/docs/
|
|
145
|
-
- [`"use workflow"`](/docs/
|
|
146
|
-
- [`
|
|
147
|
-
- [
|
|
123
|
+
- [`"use step"`](/docs/foundations/workflows-and-steps#step-functions): Marks a function for extraction and serialization.
|
|
124
|
+
- [`"use workflow"`](/docs/foundations/workflows-and-steps#workflow-functions): Declares the orchestrator function.
|
|
125
|
+
- [`WorkflowAgent`](https://ai-sdk.dev/v7/docs/agents/workflow-agent#workflowagent): Provides AI SDK's durable agent, resolves models through AI Gateway strings, and replaces `DurableAgent`.
|
|
126
|
+
- [AI SDK providers](https://ai-sdk.dev/providers/ai-sdk-providers): Lists direct provider packages and configuration.
|
|
127
|
+
- [Custom class serialization](/docs/foundations/serialization#custom-class-serialization): Provides the companion pattern for classes you own (`WORKFLOW_SERIALIZE` and `WORKFLOW_DESERIALIZE`).
|