workflow 4.2.1 → 5.0.0-beta.1

package/dist/api-workflow.d.ts

@@ -1,7 +1,5 @@
 export type { Event, StartOptions, StopSleepOptions, StopSleepResult, WorkflowReadableStreamOptions, WorkflowRun, } from '@workflow/core/runtime';
-export declare class Run {
-    constructor();
-}
+export { Run } from '@workflow/core/runtime/run';
 export declare const getRun: () => never;
 export declare const getHookByToken: () => never;
 export declare const resumeHook: () => never;

package/dist/api-workflow.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api-workflow.d.ts","sourceRoot":"","sources":["../src/api-workflow.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,KAAK,EACL,YAAY,EACZ,gBAAgB,EAChB,eAAe,EACf,6BAA6B,EAC7B,WAAW,GACZ,MAAM,wBAAwB,CAAC;AAQhC,qBAAa,GAAG;;CAIf;AACD,eAAO,MAAM,MAAM,aAA+B,CAAC;AACnD,eAAO,MAAM,cAAc,aAAuC,CAAC;AACnE,eAAO,MAAM,UAAU,aAAmC,CAAC;AAC3D,eAAO,MAAM,aAAa,aAAsC,CAAC;AACjE,eAAO,MAAM,OAAO,aAAgC,CAAC;AACrD,eAAO,MAAM,KAAK,aAA8B,CAAC"}
+{"version":3,"file":"api-workflow.d.ts","sourceRoot":"","sources":["../src/api-workflow.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,KAAK,EACL,YAAY,EACZ,gBAAgB,EAChB,eAAe,EACf,6BAA6B,EAC7B,WAAW,GACZ,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAE,GAAG,EAAE,MAAM,4BAA4B,CAAC;AAQjD,eAAO,MAAM,MAAM,aAA+B,CAAC;AACnD,eAAO,MAAM,cAAc,aAAuC,CAAC;AACnE,eAAO,MAAM,UAAU,aAAmC,CAAC;AAC3D,eAAO,MAAM,aAAa,aAAsC,CAAC;AACjE,eAAO,MAAM,OAAO,aAAgC,CAAC;AACrD,eAAO,MAAM,KAAK,aAA8B,CAAC"}

package/dist/api-workflow.js

@@ -1,15 +1,11 @@
+export { Run } from '@workflow/core/runtime/run';
 const workflowStub = (item) => {
     throw new Error(`The workflow environment doesn't allow this runtime usage of ${item}. Move this call to a step function ("use step") or call it outside the workflow context.`);
 };
-export class Run {
-    constructor() {
-        workflowStub('Run');
-    }
-}
 export const getRun = () => workflowStub('getRun');
 export const getHookByToken = () => workflowStub('getHookByToken');
 export const resumeHook = () => workflowStub('resumeHook');
 export const resumeWebhook = () => workflowStub('resumeWebhook');
 export const runStep = () => workflowStub('runStep');
 export const start = () => workflowStub('start');
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXBpLXdvcmtmbG93LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2FwaS13b3JrZmxvdy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFTQSxNQUFNLFlBQVksR0FBRyxDQUFDLElBQVksRUFBRSxFQUFFO0lBQ3BDLE1BQU0sSUFBSSxLQUFLLENBQ2IsZ0VBQWdFLElBQUksMkZBQTJGLENBQ2hLLENBQUM7QUFDSixDQUFDLENBQUM7QUFFRixNQUFNLE9BQU8sR0FBRztJQUNkO1FBQ0UsWUFBWSxDQUFDLEtBQUssQ0FBQyxDQUFDO0lBQ3RCLENBQUM7Q0FDRjtBQUNELE1BQU0sQ0FBQyxNQUFNLE1BQU0sR0FBRyxHQUFHLEVBQUUsQ0FBQyxZQUFZLENBQUMsUUFBUSxDQUFDLENBQUM7QUFDbkQsTUFBTSxDQUFDLE1BQU0sY0FBYyxHQUFHLEdBQUcsRUFBRSxDQUFDLFlBQVksQ0FBQyxnQkFBZ0IsQ0FBQyxDQUFDO0FBQ25FLE1BQU0sQ0FBQyxNQUFNLFVBQVUsR0FBRyxHQUFHLEVBQUUsQ0FBQyxZQUFZLENBQUMsWUFBWSxDQUFDLENBQUM7QUFDM0QsTUFBTSxDQUFDLE1BQU0sYUFBYSxHQUFHLEdBQUcsRUFBRSxDQUFDLFlBQVksQ0FBQyxlQUFlLENBQUMsQ0FBQztBQUNqRSxNQUFNLENBQUMsTUFBTSxPQUFPLEdBQUcsR0FBRyxFQUFFLENBQUMsWUFBWSxDQUFDLFNBQVMsQ0FBQyxDQUFDO0FBQ3JELE1BQU0sQ0FBQyxNQUFNLEtBQUssR0FBRyxHQUFHLEVBQUUsQ0FBQyxZQUFZLENBQUMsT0FBTyxDQUFDLENBQUMifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXBpLXdvcmtmbG93LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2FwaS13b3JrZmxvdy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFTQSxPQUFPLEVBQUUsR0FBRyxFQUFFLE1BQU0sNEJBQTRCLENBQUM7QUFFakQsTUFBTSxZQUFZLEdBQUcsQ0FBQyxJQUFZLEVBQUUsRUFBRTtJQUNwQyxNQUFNLElBQUksS0FBSyxDQUNiLGdFQUFnRSxJQUFJLDJGQUEyRixDQUNoSyxDQUFDO0FBQ0osQ0FBQyxDQUFDO0FBRUYsTUFBTSxDQUFDLE1BQU0sTUFBTSxHQUFHLEdBQUcsRUFBRSxDQUFDLFlBQVksQ0FBQyxRQUFRLENBQUMsQ0FBQztBQUNuRCxNQUFNLENBQUMsTUFBTSxjQUFjLEdBQUcsR0FBRyxFQUFFLENBQUMsWUFBWSxDQUFDLGdCQUFnQixDQUFDLENBQUM7QUFDbkUsTUFBTSxDQUFDLE1BQU0sVUFBVSxHQUFHLEdBQUcsRUFBRSxDQUFDLFlBQVksQ0FBQyxZQUFZLENBQUMsQ0FBQztBQUMzRCxNQUFNLENBQUMsTUFBTSxhQUFhLEdBQUcsR0FBRyxFQUFFLENBQUMsWUFBWSxDQUFDLGVBQWUsQ0FBQyxDQUFDO0FBQ2pFLE1BQU0sQ0FBQyxNQUFNLE9BQU8sR0FBRyxHQUFHLEVBQUUsQ0FBQyxZQUFZLENBQUMsU0FBUyxDQUFDLENBQUM7QUFDckQsTUFBTSxDQUFDLE1BQU0sS0FBSyxHQUFHLEdBQUcsRUFBRSxDQUFDLFlBQVksQ0FBQyxPQUFPLENBQUMsQ0FBQyJ9

package/dist/observability.d.ts

@@ -9,7 +9,7 @@
  * import { getWorld } from 'workflow/api';
  * import { hydrateResourceIO, observabilityRevivers } from 'workflow/observability';
  *
- * const world = getWorld();
+ * const world = await getWorld();
  * const step = await world.steps.get(runId, stepId, { resolveData: 'all' });
  * const hydrated = hydrateResourceIO(step, observabilityRevivers);
  * // hydrated.input and hydrated.output are now plain JS objects

package/dist/observability.js

@@ -9,7 +9,7 @@
  * import { getWorld } from 'workflow/api';
  * import { hydrateResourceIO, observabilityRevivers } from 'workflow/observability';
  *
- * const world = getWorld();
+ * const world = await getWorld();
  * const step = await world.steps.get(runId, stepId, { resolveData: 'all' });
  * const hydrated = hydrateResourceIO(step, observabilityRevivers);
  * // hydrated.input and hydrated.output are now plain JS objects

package/docs/api-reference/workflow/get-workflow-metadata.mdx

@@ -13,6 +13,7 @@ You may want to use this function when you need to:
 
 * Log workflow run IDs
 * Access timing information of a workflow
+* Detect whether encryption is enabled for the current run
 
 <Callout>
 If you need to access step context, take a look at [`getStepMetadata`](/docs/api-reference/workflow/get-step-metadata).
@@ -29,6 +30,32 @@ async function testWorkflow() {
 }
 ```
 
+### Detecting Encryption
+
+The `features` object indicates which capabilities are active for the current run. Library authors can use `features.encryption` to control whether sensitive data is included in step return values, which are serialized to the event log:
+
+```typescript lineNumbers
+import { getWorkflowMetadata } from "workflow"
+
+declare function getUserProfile(userId: string): Promise<{ name: string; ssn: string }>; // @setup
+
+async function fetchUserProfile(userId: string) {
+    "use step"
+
+    const { features } = getWorkflowMetadata() // [!code highlight]
+    const profile = await getUserProfile(userId)
+
+    if (!features.encryption) { // [!code highlight]
+        // Omit sensitive fields from the return value,
+        // since it will be stored unencrypted in the event log
+        const { ssn, ...safe } = profile
+        return safe
+    }
+
+    return profile
+}
+```
+
 ## API Signature
 
 ### Parameters

package/docs/api-reference/workflow-api/get-world.mdx

@@ -1,20 +1,20 @@
 ---
 title: getWorld
-description: Access the World instance for low-level storage, queuing, and streaming operations.
+description: Async function that resolves the World instance for low-level storage, queuing, and streaming operations.
 type: reference
-summary: Use getWorld to access low-level workflow storage, queuing, and streaming backends directly.
+summary: Async function that resolves the World instance for low-level workflow storage, queuing, and streaming backends.
 prerequisites:
   - /docs/deploying
 ---
 
-Retrieves the World instance for direct access to workflow storage, queuing, and streaming backends. This function returns a `World` which provides low-level access to manage workflow runs, steps, events, and hooks.
+Retrieves the World instance for direct access to workflow storage, queuing, and streaming backends. This async function returns a `Promise<World>` which provides low-level access to manage workflow runs, steps, events, and hooks.
 
 Use this function when you need direct access to the underlying workflow infrastructure, such as listing all runs, querying events, or implementing custom workflow management logic.
 
 ```typescript lineNumbers
 import { getWorld } from "workflow/runtime";
 
-const world = getWorld(); // [!code highlight]
+const world = await getWorld(); // [!code highlight]
 ```
 
 ## API Signature
@@ -25,7 +25,7 @@ This function does not accept any parameters.
 
 ### Returns
 
-Returns a `World` object:
+Returns a `Promise<World>` object:
 
 <TSDoc
 definition={`
@@ -79,7 +79,7 @@ export async function GET(req: Request) {
   const cursor = url.searchParams.get("cursor") ?? undefined;
 
   try {
-    const world = getWorld(); // [!code highlight]
+    const world = await getWorld(); // [!code highlight]
     const runs = await world.runs.list({
       pagination: { cursor },
       resolveData: "none",

package/docs/api-reference/workflow-api/index.mdx

@@ -28,7 +28,7 @@ The API package is for access and introspection of workflow data to inspect runs
         Get workflow run status and metadata without waiting for completion.
     </Card>
     <Card href="/docs/api-reference/workflow-api/get-world" title="getWorld()">
-        Get direct access to workflow storage, queuing, and streaming backends.
+        Async: resolve the World instance for storage, queuing, and streaming backends.
     </Card>
     <Card href="/docs/api-reference/workflow-api/world" title="World SDK">
         Low-level API for inspecting runs, steps, events, hooks, streams, and queues.

package/docs/api-reference/workflow-api/world/index.mdx

@@ -2,7 +2,7 @@
 title: World SDK
 description: Low-level API for inspecting and managing workflow runs, steps, events, hooks, streams, and queues.
 type: overview
-summary: Access workflow infrastructure directly via getWorld() for building observability dashboards, admin tools, and custom integrations.
+summary: Access workflow infrastructure via await getWorld() for building observability dashboards, admin tools, and custom integrations.
 prerequisites:
   - /docs/api-reference/workflow-api/get-world
 keywords:
@@ -19,7 +19,7 @@ The World SDK provides direct access to workflow infrastructure — runs, steps,
 ```typescript lineNumbers
 import { getWorld } from "workflow/runtime";
 
-const world = getWorld(); // [!code highlight]
+const world = await getWorld(); // [!code highlight]
 ```
 
 ## Interfaces

package/docs/api-reference/workflow-api/world/observability.mdx

@@ -147,7 +147,7 @@ const hydrated = hydrateResourceIOWithKey(step, key); // [!code highlight]
 import { getWorld } from "workflow/runtime";
 import { parseStepName, parseWorkflowName } from "workflow/observability"; // [!code highlight]
 
-const world = getWorld();
+const world = await getWorld();
 const run = await world.runs.get(runId, { resolveData: "none" });
 console.log("Workflow:", parseWorkflowName(run.workflowName)?.shortName); // [!code highlight]
 

package/docs/api-reference/workflow-api/world/queue.mdx

@@ -28,7 +28,7 @@ Queue methods live directly on the `world` object (not nested). They dispatch in
 ```typescript lineNumbers
 import { getWorld } from "workflow/runtime";
 
-const world = getWorld(); // [!code highlight]
+const world = await getWorld(); // [!code highlight]
 // Queue methods are called directly on world — e.g. world.queue()
 ```
 

package/docs/api-reference/workflow-api/world/storage.mdx

@@ -37,7 +37,7 @@ The World storage interface exposes four sub-interfaces for querying workflow da
 ```typescript lineNumbers
 import { getWorld } from "workflow/runtime";
 
-const world = getWorld(); // [!code highlight]
+const world = await getWorld(); // [!code highlight]
 ```
 
 ---
@@ -304,7 +304,7 @@ const result = await world.hooks.list({ // [!code highlight]
 ```typescript lineNumbers
 import { getWorld } from "workflow/runtime";
 
-const world = getWorld();
+const world = await getWorld();
 let cursor: string | undefined;
 
 const runs = await world.runs.list({ // [!code highlight]
@@ -319,7 +319,7 @@ cursor = runs.cursor; // pass to next call for pagination
 ```typescript lineNumbers
 import { getWorld } from "workflow/runtime";
 
-const world = getWorld();
+const world = await getWorld();
 
 // Full data (default) — includes serialized input/output
 const run = await world.runs.get(runId); // [!code highlight]
@@ -336,7 +336,7 @@ const lightweight = await world.runs.get(runId, { // [!code highlight]
 import { getWorld } from "workflow/runtime";
 import { parseStepName } from "workflow/observability"; // [!code highlight]
 
-const world = getWorld();
+const world = await getWorld();
 const steps = await world.steps.list({ // [!code highlight]
   runId,
   resolveData: "none",
@@ -358,7 +358,7 @@ const progress = steps.data.map((step) => {
 import { getWorld } from "workflow/runtime";
 import { hydrateResourceIO, observabilityRevivers } from "workflow/observability"; // [!code highlight]
 
-const world = getWorld();
+const world = await getWorld();
 const step = await world.steps.get(runId, stepId); // [!code highlight]
 const hydrated = hydrateResourceIO(step, observabilityRevivers); // [!code highlight]
 console.log(hydrated.input, hydrated.output);
@@ -369,7 +369,7 @@ console.log(hydrated.input, hydrated.output);
 ```typescript lineNumbers
 import { getWorld } from "workflow/runtime";
 
-const world = getWorld();
+const world = await getWorld();
 await world.events.create(runId, { // [!code highlight]
   eventType: "run_cancelled", // [!code highlight]
 }); // [!code highlight]
@@ -380,7 +380,7 @@ await world.events.create(runId, { // [!code highlight]
 ```typescript lineNumbers
 import { getWorld } from "workflow/runtime";
 
-const world = getWorld();
+const world = await getWorld();
 const hook = await world.hooks.getByToken(token); // [!code highlight]
 console.log(hook.runId, hook.metadata); // [!code highlight]
 ```
@@ -390,7 +390,7 @@ console.log(hook.runId, hook.metadata); // [!code highlight]
 ```typescript lineNumbers
 import { getWorld } from "workflow/runtime";
 
-const world = getWorld();
+const world = await getWorld();
 const events = await world.events.list({ runId }); // [!code highlight]
 
 for (const event of events.data) {

package/docs/api-reference/workflow-api/world/streams.mdx

@@ -2,26 +2,26 @@
 title: Streams
 description: Read, write, and manage real-time data streams for workflow runs.
 type: reference
-summary: "Methods: writeToStream(), writeToStreamMulti(), readFromStream(), closeStream(), listStreamsByRunId(), getStreamChunks(), getStreamInfo(). Stream methods live directly on the world object."
+summary: "Methods: streams.write(), streams.writeMulti(), streams.get(), streams.close(), streams.list(), streams.getChunks(), streams.getInfo(). Stream methods live on world.streams."
 prerequisites:
   - /docs/api-reference/workflow-api/get-world
 related:
   - /docs/foundations/streaming
   - /docs/api-reference/workflow/get-writable
 keywords:
-  - writeToStream
-  - writeToStreamMulti
-  - readFromStream
-  - closeStream
-  - listStreamsByRunId
-  - getStreamChunks
-  - getStreamInfo
+  - streams.write
+  - streams.writeMulti
+  - streams.get
+  - streams.close
+  - streams.list
+  - streams.getChunks
+  - streams.getInfo
   - Streamer interface
   - real-time streaming
   - stream lifecycle
 ---
 
-Stream methods live directly on the `world` object returned by `getWorld()`. Use them to write chunks, read streams, and manage stream lifecycle outside of the standard `getWritable()` pattern.
+Stream methods live on `world.streams` (the `streams` sub-object of the `World` instance returned by `await getWorld()`). Use them to write chunks, read streams, and manage stream lifecycle outside of the standard `getWritable()` pattern.
 
 <Callout type="info">
   For most streaming use cases, use [`getWritable()`](/docs/api-reference/workflow/get-writable) inside steps. Direct stream methods are for advanced scenarios like building custom stream consumers or managing streams from outside a workflow.
@@ -32,82 +32,83 @@ Stream methods live directly on the `world` object returned by `getWorld()`. Use
 ```typescript lineNumbers
 import { getWorld } from "workflow/runtime";
 
-const world = getWorld(); // [!code highlight]
-// Stream methods are called directly on world — e.g. world.writeToStream()
+const world = await getWorld(); // [!code highlight]
+// Stream methods are called on world.streams — e.g. world.streams.write()
 ```
 
 ## Methods
 
-### writeToStream()
+### write()
 
 Write a data chunk to a named stream.
 
 ```typescript lineNumbers
-await world.writeToStream("default", runId, chunk); // [!code highlight]
+await world.streams.write(runId, "default", chunk); // [!code highlight]
 ```
 
 **Parameters:**
 
 | Parameter | Type | Description |
 |-----------|------|-------------|
-| `name` | `string` | The stream name |
 | `runId` | `string` | The workflow run ID |
+| `name` | `string` | The stream name |
 | `chunk` | `string \| Uint8Array` | Data to write |
 
-### writeToStreamMulti()
+### writeMulti()
 
-Write multiple chunks in a single operation. Optional optimization — not all World implementations support it. Falls back to sequential `writeToStream()` calls if unavailable.
+Write multiple chunks in a single operation. Optional optimization — not all World implementations support it. Falls back to sequential `write()` calls if unavailable.
 
 ```typescript lineNumbers
-await world.writeToStreamMulti?.("default", runId, [chunk1, chunk2]); // [!code highlight]
+await world.streams.writeMulti?.(runId, "default", [chunk1, chunk2]); // [!code highlight]
 ```
 
 **Parameters:**
 
 | Parameter | Type | Description |
 |-----------|------|-------------|
-| `name` | `string` | The stream name |
 | `runId` | `string` | The workflow run ID |
+| `name` | `string` | The stream name |
 | `chunks` | `(string \| Uint8Array)[]` | Chunks to write, in order |
 
-### readFromStream()
+### get()
 
 Read data from a named stream as a live `ReadableStream` that waits for new chunks in real time.
 
 ```typescript lineNumbers
-const readable = await world.readFromStream("default"); // [!code highlight]
+const readable = await world.streams.get(runId, "default"); // [!code highlight]
 ```
 
 **Parameters:**
 
 | Parameter | Type | Description |
 |-----------|------|-------------|
+| `runId` | `string` | The workflow run ID |
 | `name` | `string` | The stream name |
 | `startIndex` | `number` | Optional. Positive values skip chunks from the start (0-based). Negative values read from the tail (e.g. `-3` starts 3 chunks from the end). Clamped to 0. |
 
 **Returns:** `ReadableStream<Uint8Array>`
 
-### closeStream()
+### close()
 
 Close a stream when done writing.
 
 ```typescript lineNumbers
-await world.closeStream("default", runId); // [!code highlight]
+await world.streams.close(runId, "default"); // [!code highlight]
 ```
 
 **Parameters:**
 
 | Parameter | Type | Description |
 |-----------|------|-------------|
-| `name` | `string` | The stream name |
 | `runId` | `string` | The workflow run ID |
+| `name` | `string` | The stream name |
 
-### listStreamsByRunId()
+### list()
 
 List all stream names associated with a workflow run.
 
 ```typescript lineNumbers
-const streamNames = await world.listStreamsByRunId(runId); // [!code highlight]
+const streamNames = await world.streams.list(runId); // [!code highlight]
 ```
 
 **Parameters:**
@@ -118,12 +119,12 @@ const streamNames = await world.listStreamsByRunId(runId); // [!code highlight]
 
 **Returns:** `string[]`
 
-### getStreamChunks()
+### getChunks()
 
-Fetch stream chunks with cursor-based pagination. Unlike `readFromStream()` (which returns a live `ReadableStream`), this returns a snapshot of currently available chunks.
+Fetch stream chunks with cursor-based pagination. Unlike `get()` (which returns a live `ReadableStream`), this returns a snapshot of currently available chunks.
 
 ```typescript lineNumbers
-const result = await world.getStreamChunks("default", runId, { // [!code highlight]
+const result = await world.streams.getChunks(runId, "default", { // [!code highlight]
   limit: 50,
 }); // [!code highlight]
 // result.data: StreamChunk[], result.cursor, result.hasMore, result.done
@@ -133,8 +134,8 @@ const result = await world.getStreamChunks("default", runId, { // [!code highlig
 
 | Parameter | Type | Description |
 |-----------|------|-------------|
-| `name` | `string` | The stream name |
 | `runId` | `string` | The workflow run ID |
+| `name` | `string` | The stream name |
 | `options.limit` | `number` | Max chunks per page (default: 100, max: 1000) |
 | `options.cursor` | `string` | Cursor from a previous response |
 
@@ -147,12 +148,12 @@ const result = await world.getStreamChunks("default", runId, { // [!code highlig
 | `hasMore` | `boolean` | Whether more pages of already-written chunks exist |
 | `done` | `boolean` | Whether the stream is fully closed. When `false`, new chunks may appear in future requests even after `hasMore` is `false`. |
 
-### getStreamInfo()
+### getInfo()
 
 Retrieve lightweight metadata about a stream without fetching chunks.
 
 ```typescript lineNumbers
-const info = await world.getStreamInfo("default", runId); // [!code highlight]
+const info = await world.streams.getInfo(runId, "default"); // [!code highlight]
 // info.tailIndex: last chunk index (-1 if empty), info.done: whether stream is closed
 ```
 
@@ -160,8 +161,8 @@ const info = await world.getStreamInfo("default", runId); // [!code highlight]
 
 | Parameter | Type | Description |
 |-----------|------|-------------|
-| `name` | `string` | The stream name |
 | `runId` | `string` | The workflow run ID |
+| `name` | `string` | The stream name |
 
 **Returns:** `StreamInfoResponse`
 
@@ -181,8 +182,9 @@ import { getWorld } from "workflow/runtime";
 export async function GET(req: Request) {
   const url = new URL(req.url);
   const streamName = url.searchParams.get("name") ?? "default";
-  const world = getWorld();
-  const readable = await world.readFromStream(streamName); // [!code highlight]
+  const runId = url.searchParams.get("runId")!;
+  const world = await getWorld();
+  const readable = await world.streams.get(runId, streamName); // [!code highlight]
 
   return new Response(readable, {
     headers: { "Content-Type": "application/octet-stream" },
@@ -195,11 +197,11 @@ export async function GET(req: Request) {
 ```typescript lineNumbers
 import { getWorld } from "workflow/runtime";
 
-const world = getWorld();
+const world = await getWorld();
 let cursor: string | undefined;
 
 do {
-  const result = await world.getStreamChunks("default", runId, { cursor }); // [!code highlight]
+  const result = await world.streams.getChunks(runId, "default", { cursor }); // [!code highlight]
   for (const chunk of result.data) {
     console.log(`Chunk ${chunk.index}:`, chunk.data);
   }

package/docs/deploying/building-a-world.mdx

@@ -166,54 +166,56 @@ The Streamer interface enables real-time data streaming:
 {/* @skip-typecheck - interface definition, not runnable code */}
 ```typescript
 interface Streamer {
-  writeToStream(
-    name: string,
-    runId: string,
-    chunk: string | Uint8Array
-  ): Promise<void>;
-
-  writeToStreamMulti?(
-    name: string,
-    runId: string,
-    chunks: (string | Uint8Array)[]
-  ): Promise<void>;
-
-  closeStream(
-    name: string,
-    runId: string
-  ): Promise<void>;
-
-  readFromStream(
-    name: string,
-    startIndex?: number
-  ): Promise<ReadableStream<Uint8Array>>;
-
-  listStreamsByRunId(runId: string): Promise<string[]>;
-
-  /** Paginated snapshot of stream chunks. */
-  getStreamChunks(
-    name: string,
-    runId: string,
-    options?: { limit?: number; cursor?: string }
-  ): Promise<{
-    data: { index: number; data: Uint8Array }[];
-    cursor: string | null;
-    hasMore: boolean;
-    done: boolean;
-  }>;
-
-  /** Lightweight metadata: tail index and completion flag. */
-  getStreamInfo(
-    name: string,
-    runId: string
-  ): Promise<{ tailIndex: number; done: boolean }>;
+  streamFlushIntervalMs?: number;
+
+  streams: {
+    write(
+      runId: string,
+      name: string,
+      chunk: string | Uint8Array
+    ): Promise<void>;
+
+    writeMulti?(
+      runId: string,
+      name: string,
+      chunks: (string | Uint8Array)[]
+    ): Promise<void>;
+
+    close(runId: string, name: string): Promise<void>;
+
+    get(
+      runId: string,
+      name: string,
+      startIndex?: number
+    ): Promise<ReadableStream<Uint8Array>>;
+
+    list(runId: string): Promise<string[]>;
+
+    /** Paginated snapshot of stream chunks. */
+    getChunks(
+      runId: string,
+      name: string,
+      options?: { limit?: number; cursor?: string }
+    ): Promise<{
+      data: { index: number; data: Uint8Array }[];
+      cursor: string | null;
+      hasMore: boolean;
+      done: boolean;
+    }>;
+
+    /** Lightweight metadata: tail index and completion flag. */
+    getInfo(
+      runId: string,
+      name: string
+    ): Promise<{ tailIndex: number; done: boolean }>;
+  };
 }
 ```
 
 Streams are identified by a combination of `runId` and `name`. Each workflow run can have multiple named streams.
-`writeToStreamMulti()` is an optional optimization for batching multiple writes.
+`writeMulti()` is an optional optimization for batching multiple writes.
 
-`getStreamChunks` returns a paginated snapshot of currently available chunks (unlike `readFromStream` which returns a live `ReadableStream` that waits for new chunks). `getStreamInfo` returns the tail index (last chunk index, 0-based, or `-1` when empty) and whether the stream is complete — useful for resolving negative `startIndex` values into absolute positions.
+`getChunks` returns a paginated snapshot of currently available chunks (unlike `get` which returns a live `ReadableStream` that waits for new chunks). `getInfo` returns the tail index (last chunk index, 0-based, or `-1` when empty) and whether the stream is complete — useful for resolving negative `startIndex` values into absolute positions.
 
 ## Reference Implementations
 

package/docs/deploying/world/postgres-world.mdx

@@ -53,7 +53,8 @@ Create an `instrumentation.ts` file in your project root:
 export async function register() {
   if (process.env.NEXT_RUNTIME !== "edge") {
     const { getWorld } = await import("workflow/runtime");
-    await getWorld().start?.();
+    const world = await getWorld();
+    await world.start?.();
   }
 }
 ```
@@ -73,7 +74,8 @@ import type { ServerInit } from "@sveltejs/kit";
 
 export const init: ServerInit = async () => {
   const { getWorld } = await import("workflow/runtime");
-  await getWorld().start?.();
+  const world = await getWorld();
+  await world.start?.();
 };
 ```
 
@@ -92,7 +94,8 @@ import { defineNitroPlugin } from "nitro/~internal/runtime/plugin";
 
 export default defineNitroPlugin(async () => {
   const { getWorld } = await import("workflow/runtime");
-  await getWorld().start?.();
+  const world = await getWorld();
+  await world.start?.();
 });
 ```
 
@@ -168,7 +171,8 @@ For higher worker concurrency, Graphile Worker recommends setting `maxPoolSize`
 
 ### Programmatic configuration
 
-{/* @skip-typecheck: incomplete code sample */}
+{/*@skip-typecheck: incomplete code sample*/}
+
 ```typescript title="workflow.config.ts" lineNumbers
 import { createWorld } from "@workflow/world-postgres";
 
@@ -200,6 +204,7 @@ Deploy your application to any cloud that supports long-running servers:
 - Platform-as-a-Service providers (Railway, Render, Fly.io, etc.)
 
 Ensure your deployment has:
+
 1. Network access to your PostgreSQL database
 2. Environment variables configured correctly
 3. The `start()` function called on server initialization

package/docs/getting-started/next.mdx

@@ -275,12 +275,36 @@ Build error occurred
 Error: Cannot find module 'next/dist/lib/server-external-packages.json'
 ```
 
-Upgrade to `workflow@4.2.0` or later:
+Upgrade to `workflow@4.0.1-beta.26` or later:
 
 ```package-install
 workflow@latest
 ```
 
+### Turborepo caching
+
+If you're using [Turborepo](https://turbo.build/repo) in a monorepo, you need to include the generated Workflow routes in your cache outputs. The Workflow SDK generates route handlers at `app/.well-known/workflow/` (or `src/app/.well-known/workflow/` if your project uses the `src` directory) during the build process, and these files must be cached alongside your Next.js build output.
+
+Add the following to your `turbo.json`:
+
+```jsonc title="turbo.json"
+{
+  "tasks": {
+    "build": {
+      "outputs": [
+        ".next/**",
+        "!.next/cache/**",
+        // Include whichever path matches your project layout
+        "app/.well-known/workflow/**",
+        "src/app/.well-known/workflow/**"
+      ]
+    }
+  }
+}
+```
+
+Without this configuration, you may experience intermittent issues where workflows fail to register properly on cache hits, while working correctly on cache misses.
+
 ### `start()` says it received an invalid workflow function
 
 If you see this error:

package/docs/how-it-works/code-transform.mdx

@@ -89,20 +89,21 @@ export async function createUser(email: string) {
 
 {/* @skip-typecheck: incomplete code sample */}
 ```typescript
-import { registerStepFunction } from "workflow/internal/private"; // [!code highlight]
-
 export async function createUser(email: string) {
   return { id: crypto.randomUUID(), email };
 }
-
-registerStepFunction("step//workflows/user.js//createUser", createUser); // [!code highlight]
+(function(__wf_fn, __wf_id) { // [!code highlight]
+    var __wf_sym = Symbol.for("@workflow/core//registeredSteps"), __wf_reg = globalThis[__wf_sym] || (globalThis[__wf_sym] = new Map()); // [!code highlight]
+    __wf_reg.set(__wf_id, __wf_fn); // [!code highlight]
+    __wf_fn.stepId = __wf_id; // [!code highlight]
+})(createUser, "step//workflows/user.js//createUser"); // [!code highlight]
 ```
 
 **What happens:**
 
 - The `"use step"` directive is removed
 - The function body is kept completely intact (no transformation)
-- The function is registered with the runtime using `registerStepFunction()`
+- The function is registered with the runtime via an inline IIFE (no imports needed)
 - Step functions run with full Node.js/Deno/Bun access
 
 **Why no transformation?** Step functions execute in your main runtime with full access to Node.js APIs, file system, databases, etc. They don't need any special handling—they just run normally.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "workflow",
-  "version": "4.2.1",
+  "version": "5.0.0-beta.1",
   "description": "Workflow SDK - Build durable, resilient, and observable workflows",
   "main": "dist/typescript-plugin.cjs",
   "type": "module",
@@ -40,7 +40,6 @@
     "./errors": "./dist/internal/errors.js",
     "./internal/errors": "./dist/internal/errors.js",
     "./internal/builtins": "./dist/internal/builtins.js",
-    "./internal/private": "./dist/internal/private.js",
     "./internal/class-serialization": "./dist/internal/class-serialization.js",
     "./next": "./dist/next.cjs",
     "./nitro": "./dist/nitro.js",
@@ -57,23 +56,23 @@
   },
   "dependencies": {
     "ms": "2.1.3",
-    "@workflow/astro": "4.0.1",
-    "@workflow/cli": "4.2.1",
-    "@workflow/core": "4.2.1",
-    "@workflow/errors": "4.1.0",
-    "@workflow/typescript-plugin": "4.0.1",
-    "@workflow/utils": "4.1.0",
-    "@workflow/next": "4.0.2",
-    "@workflow/nest": "0.0.1",
-    "@workflow/nitro": "4.0.2",
-    "@workflow/nuxt": "4.0.2",
-    "@workflow/sveltekit": "4.0.1",
-    "@workflow/rollup": "4.0.1"
+    "@workflow/astro": "5.0.0-beta.1",
+    "@workflow/cli": "5.0.0-beta.1",
+    "@workflow/core": "5.0.0-beta.1",
+    "@workflow/errors": "5.0.0-beta.0",
+    "@workflow/typescript-plugin": "5.0.0-beta.1",
+    "@workflow/utils": "5.0.0-beta.0",
+    "@workflow/next": "5.0.0-beta.1",
+    "@workflow/nest": "5.0.0-beta.1",
+    "@workflow/nitro": "5.0.0-beta.1",
+    "@workflow/nuxt": "5.0.0-beta.1",
+    "@workflow/sveltekit": "5.0.0-beta.1",
+    "@workflow/rollup": "5.0.0-beta.1"
   },
   "devDependencies": {
     "@types/ms": "2.1.0",
     "@types/node": "22.19.0",
-    "@workflow/tsconfig": "4.0.1"
+    "@workflow/tsconfig": "5.0.0-beta.0"
   },
   "peerDependencies": {
     "@opentelemetry/api": "1"

package/dist/internal/private.d.ts

@@ -1,6 +0,0 @@
-/**
- * This is the "private" API of the workflow runtime that referenced by the compiler's output
- * but not meant to be document and used directly in user code.
- */
-export * from '@workflow/core/private';
-//# sourceMappingURL=private.d.ts.map

package/dist/internal/private.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"private.d.ts","sourceRoot":"","sources":["../../src/internal/private.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,wBAAwB,CAAC"}

package/dist/internal/private.js

@@ -1,6 +0,0 @@
-/**
- * This is the "private" API of the workflow runtime that referenced by the compiler's output
- * but not meant to be document and used directly in user code.
- */
-export * from '@workflow/core/private';
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHJpdmF0ZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9pbnRlcm5hbC9wcml2YXRlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOzs7R0FHRztBQUVILGNBQWMsd0JBQXdCLENBQUMifQ==