vercel__workflow/packages/world/CHANGELOG.md

@workflow/world

5.0.0-beta.11

Minor Changes

• #2394 5f0b845 Thanks @pranaygp! - Bump SPEC_VERSION_CURRENT to 5 (SPEC_VERSION_SUPPORTS_COMPRESSION): runs at spec 5+ may contain gzip-compressed payloads, and older SDKs reject them via requiresNewerWorld() instead of failing on individual payloads.

5.0.0-beta.10

Minor Changes

• #2385 628795a Thanks @pranaygp! - Add an allowReservedAttributes option to start() so framework-level callers can seed reserved $-prefixed run attributes at creation, matching the existing experimental_setAttributes option. The flag is carried through the resilient-start queue input so lazy run creation validates identically.

5.0.0-beta.9

Minor Changes

• #2226 ae8d6fe Thanks @pranaygp! - Allow passing initial run attributes through start(), and speed up workflow-level setAttribute calls by using native events for recording attributes.

5.0.0-beta.8

Minor Changes

• #2305 4670c4b Thanks @willsather! - Add an optional namespace parameter that scopes queue topic prefixes to __{namespace}_wkf_workflow_*. This allows configuring multiple frameworks in the same deployment without queue topic collision.

5.0.0-beta.7

Patch Changes

• #2212 2a3b11b Thanks @pranaygp! - Retry transient workflow replay divergence before classifying repeated divergence as a corrupted event log.

5.0.0-beta.6

Patch Changes

• #2191 8f68d35 Thanks @pranaygp! - Fix forwarded writable stream encryption when child workflows execute on a newer deployment than their parent.

5.0.0-beta.5

Patch Changes

• #2134 1e6b1fd Thanks @VaguelySerious! - Add experimental_setAttributes() workflow-level helper for attaching string key/value metadata to a workflow run, surfaced as run.attributes

• #1979 62ec537 Thanks @adamiBs! - Make run.input and step.input .optional() on the World snapshot schemas so consumers no longer fail validation when the service externalizes payloads as RemoteRef blobs.

• #1799 503a929 Thanks @TooTallNate! - Use inline sourcemaps for all workspace packages; published packages no longer ship external .js.map files.

5.0.0-beta.4

Patch Changes

• #2038 dc0be50 Thanks @pranaygp! - Refresh workflow events after completing elapsed waits so concurrent hook events preserve deterministic replay order.

• #2046 ad71b58 Thanks @pranaygp! - Report corrupted event logs with a distinct CorruptedEventLogError type and CORRUPTED_EVENT_LOG run error code.

• #2030 b124365 Thanks @pranaygp! - Validate step, wait, and hook lifecycle events against replay ownership metadata.

• #2013 2a446af Thanks @TooTallNate! - Exclude inline step execution from the workflow replay timeout. Long-running steps no longer hit REPLAY_TIMEOUT (fixes #2009). Adds a WORKFLOW_REPLAY_TIMEOUT_MS env var override and a new optional World.processExitTriggersQueueRedelivery capability used to gate the runtime's process.exit(1) failure path.

5.0.0-beta.3

Patch Changes

• #2012 9d2a926 Thanks @pranaygp! - Expose the active run ID on hook token conflict errors.

5.0.0-beta.2

Major Changes

• #1851 5f22832 Thanks @TooTallNate! - BREAKING CHANGE: Run and step errors are now serialized through the workflow serialization pipeline, preserving original class identity and cause chains on WorkflowRunFailedError.cause. Pre-upgrade failed runs in the world-postgres legacy error text column surface as error: undefined on read; the original payload is still readable directly from the errorJson column for manual inspection.

Patch Changes

• #1939 5374148 Thanks @TooTallNate! - Fix compatibility with Zod 4.4.x in WorkflowRunSchema by marking output, error, and completedAt as .optional() on non-final / cancelled / completed / failed run states.

• #1338 8ea1532 Thanks @VaguelySerious! - Merge flow and step routes into a single combined handler that executes steps inline when possible, reducing function invocations and queue overhead.

5.0.0-beta.1

Major Changes

• #1293 66d49c0 Thanks @VaguelySerious! - BREAKING CHANGE: Restructure stream methods on World interface to use world.streams.* namespace with runId as the first parameter. writeToStream(name, runId, chunk) → streams.write(runId, name, chunk), writeToStreamMulti → streams.writeMulti, closeStream → streams.close, readFromStream → streams.get(runId, name, startIndex?), listStreamsByRunId → streams.list(runId).

• #1293 66d49c0 Thanks @VaguelySerious! - Require runId argument for world.steps.get.

Patch Changes

• #1658 a5c90ce Thanks @VaguelySerious! - Fix community world E2E tests by adding specVersion to the World interface so start() uses the safe baseline (v2) for worlds that don't declare their supported version

5.0.0-beta.0

Major Changes

• #1642 c5cdfc0 Thanks @VaguelySerious! - Initial v5 beta release

4.1.0-beta.17

Patch Changes

• #1627 5f138f2 Thanks @VaguelySerious! - Bump specVersion to 3 and gate CBOR queue transport on spec version. Old deployments (specVersion < 3) receive JSON queue messages; new deployments receive CBOR. Handler uses dual transport to deserialize both formats. Fixes replay/reenqueue from dashboard to older deployments.

• #1533 7e70d18 Thanks @VaguelySerious! - Add streamFlushIntervalMs option to Streamer interface, optional for worlds to allow overwriting the default of 10ms in low-latency environments.

• #1537 c8dce52 Thanks @VaguelySerious! - Allow workflow invocation to create run if initial storage call in start did not succeed. Send run input through queue to enable this. Allow creating run_created and run_started events together in World, and skip first event list call by returning events directly.

4.1.0-beta.16

Patch Changes

• #1605 b30b0dc Thanks @VaguelySerious! - Use asymmetric ULID timestamp validation thresholds: 24h past, 5min future.

4.1.0-beta.15

Patch Changes

• #1569 a98f8de Thanks @VaguelySerious! - Combine initial run fetch, event fetch, and run_started event creation

• #1534 329cdb3 Thanks @VaguelySerious! - Re-enqueue active runs on world restart so inflight runs resume instead of getting stuck

4.1.0-beta.14

Patch Changes

• #1460 78f1b0e Thanks @VaguelySerious! - Support negative startIndex for streaming (e.g. -3 reads last 3 chunks)

• #1470 01bbe66 Thanks @VaguelySerious! - Add getStreamChunks() and getStreamInfo() to the Streamer interface, and getTailIndex() to the readable stream returned by run.getReadable(). WorkflowChatTransport now reads the x-workflow-stream-tail-index response header to resolve negative initialStartIndex values into absolute positions, fixing reconnection retries after a disconnect.

4.1.0-beta.13

Patch Changes

• #1396 2f0772d Thanks @karthikscale3! - Track Vercel request IDs (x-vercel-id) on all workflow events for correlating request logs with workflow executions

• #1364 94c14c7 Thanks @karthikscale3! - Strip only ref/payload fields from eventData when resolveData is 'none', preserving all other metadata

4.1.0-beta.12

Patch Changes

• #1317 825417a Thanks @TooTallNate! - Add optional resolveLatestDeploymentId() method to the World interface for resolving the most recent deployment ID for the current deployment's environment

4.1.0-beta.11

Patch Changes

• #1287 d8daa2a Thanks @VaguelySerious! - Add world.events.get(runId, eventId) to the Storage interface for fetching a single event by ID.

4.1.0-beta.10

Patch Changes

• #1273 11dcb64 Thanks @VaguelySerious! - Locally validate run ID to be ULID when passed by user

4.1.0-beta.9

Patch Changes

• #1270 adfe8b6 Thanks @pranaygp! - Prevent hooks from being resumed via the public webhook endpoint by default. Add isWebhook option to createHook() to opt-in to public resumption. createWebhook() always sets isWebhook: true.

4.1.0-beta.8

Patch Changes

• #1217 e55c636 Thanks @pranaygp! - Upgrade dependencies across all packages

4.1.0-beta.7

Patch Changes

• #1188 b06e491 Thanks @ctgowrie! - New vercel queue client

4.1.0-beta.6

Patch Changes

• #956 b65bb07 Thanks @TooTallNate! - Overload getEncryptionKeyForRun interface: accept WorkflowRun (preferred) or runId string with optional opaque world-specific context for start()

4.1.0-beta.5

Patch Changes

• #979 6e72b29 Thanks @TooTallNate! - Add World.getEncryptionKeyForRun() and thread encryption key through serialization layer

• #1057 5e06a7c Thanks @pranaygp! - Materialize waits as entities to prevent duplicate wait_completed events

  • @workflow/core: Handle 409 conflict gracefully when creating wait_completed events, preventing crashes when multiple concurrent invocations race to complete the same wait
  • @workflow/world: Add Wait type, WaitSchema, and WaitStatusSchema exports; add optional wait field to EventResult
  • @workflow/world-local: Materialize wait entities on wait_created/wait_completed with duplicate detection; clean up waits on terminal run states
  • @workflow/world-postgres: Add workflow_waits table with wait_status enum; materialize wait entities with conditional writes for duplicate prevention; clean up waits on terminal run states

• #1081 5487983 Thanks @TooTallNate! - Add optional close() method to the World interface for releasing resources held by a World implementation

4.1.0-beta.4

Patch Changes

• #966 56f2221 Thanks @VaguelySerious! - Add 429 throttle retry handling and 500 server error retry with exponential backoff to the workflow and step runtimes

4.1.0-beta.3

Patch Changes

• #954 d9e9859 Thanks @TooTallNate! - Generate runId client-side in start() and simplify runId types

  The runId is now generated client-side using ULID before serialization, rather than waiting for the server response. This simplifies the Streamer interface and WorkflowServerWritableStream to accept string instead of string | Promise<string> for runId.

4.1.0-beta.2

Patch Changes

• #922 0ce46b9 Thanks @pranaygp! - Add support for custom headers in queue messages

• #867 c54ba21 Thanks @TooTallNate! - Add optional writeToStreamMulti function to the World interface

4.1.0-beta.1

Minor Changes

• #621 4966b72 Thanks @pranaygp! - Add backwards compatibility for runs created with different spec versions

  • Add RunNotSupportedError for runs requiring newer world versions
  • Add semver-based version comparison utilities
  • Legacy runs (< 4.1): route to legacy handlers
  • run_cancelled: skip event storage, directly update run
  • wait_completed: store event only (no entity mutation)
  • Unknown legacy events: throw error

• #621 4966b72 Thanks @pranaygp! - BREAKING: Storage interface is now read-only; all mutations go through events.create()

  • Remove cancel, pause, resume from runs
  • Remove create, update from runs, steps, hooks
  • Add run lifecycle events: run_created, run_started, run_completed, run_failed, run_cancelled
  • Add step_created event type
  • Remove fatal field from step_failed (terminal failure is now implicit)
  • Add step_retrying event with error info for retriable failures

Patch Changes

• #621 4966b72 Thanks @pranaygp! - Add hook_conflict event type for duplicate token detection

  • World returns hook_conflict event when hook_created uses an existing token
  • Add HOOK_CONFLICT error slug

• #853 1060f9d Thanks @TooTallNate! - BREAKING CHANGE: Change user input/output to be binary data (Uint8Array) at the World interface

  This is part of specVersion 2 changes where serialization of workflow and step data uses binary format instead of JSON arrays. This allows the workflow client to be fully responsible for the data serialization format and enables future enhancements such as encryption and compression without the World implementation needing to care about the underlying data representation.

• #621 4966b72 Thanks @pranaygp! - Remove deprecated workflow_completed, workflow_failed, and workflow_started events in favor of run_completed, run_failed, and run_started events.

• #621 4966b72 Thanks @pranaygp! - Add specVersion property to World interface

  • All worlds expose @workflow/world package version for protocol compatibility
  • Stored in run_created event and WorkflowRun schema
  • Displayed in observability UI

4.0.1-beta.13

Patch Changes

• #743 61fdb41 Thanks @TooTallNate! - Add HealthCheckPayloadSchema

• #772 0aa835f Thanks @TooTallNate! - Add typedoc comments to Hook interface

4.0.1-beta.12

Patch Changes

• #751 dd3db13 Thanks @VaguelySerious! - Remove the unused paused/resumed run events and states
  • Remove run_paused and run_resumed event types
  • Remove paused status from WorkflowRunStatus
  • Remove PauseWorkflowRunParams and ResumeWorkflowRunParams types
  • Remove pauseWorkflowRun and resumeWorkflowRun functions from world-vercel

4.0.1-beta.11

Patch Changes

• #455 e3f0390 Thanks @karthikscale3! - Added Control Flow Graph extraction from Workflows and extended manifest.json's schema to incorporate the graph structure into it. Refactored manifest generation to pass manifest as a parameter instead of using instance state. Add e2e tests for manifest validation across all builders.

4.0.1-beta.10

Patch Changes

• #574 c82b467 Thanks @VaguelySerious! - Add listByRunId endpoint to Streamer interface

4.0.1-beta.9

Patch Changes

• 57a2c32: Add expiredAt attribute to Run

4.0.1-beta.8

Patch Changes

• 10c5b91: Export QueueOptions type
• bdde1bd: track queue overhead with opentelemetry

4.0.1-beta.7

Patch Changes

• fb9fd0f: Add support for closure scope vars in step functions

4.0.1-beta.6

Patch Changes

• 4b70739: Require specifying runId when writing to stream

4.0.1-beta.5

Patch Changes

• 00b0bb9: Add error stack propogation to steps and runs

4.0.1-beta.4

Patch Changes

• f973954: Update license to Apache 2.0

4.0.1-beta.3

Patch Changes

• 20d51f0: Add optional retryAfter property to Step interface
• 70be894: Implement sleep() natively into the workflow runtime

4.0.1-beta.2

Patch Changes

• d3a4ed3: Remove @types/json-schema dependency (not used)
• d3a4ed3: Remove @types/node from being a peerDependency
• 7868434: Remove AuthProvider interface from World and associated implementations

4.0.1-beta.1

Patch Changes

• 8422a32: Update Workflow naming convention
• e46294f: Add "license" and "repository" fields to package.json file

4.0.1-beta.0

Patch Changes

• fcf63d0: Initial publish