Skip to content

Conversation

@devyanshyadav
Copy link

Description

This PR resolves an inconsistency where the documented method for managing workflows (import { getWorld } from "workflow/api") was missing from the SDK's public exports, causing Module '"workflow/api"' has no exported member 'getWorld'.ts(2305) errors.

Key Changes

  • SDK: Exported getWorld, healthCheck, and the World type from workflow/api and workflow/api-workflow.
  • Documentation: Updated the getWorld API reference and the Postgres World deployment guides to use the correct unified import.
  • Example Migration: Updated all workbench/ projects to follow the new standard, ensuring a consistent developer experience across the repository.
  • Versioning: Included a changeset to trigger the appropriate package updates.

Verification

  • Verified that getWorld and the World type are correctly resolvable and typed via the workflow/api entry point.
  • Audited all workspace documentation to ensure synchronization with the code changes.

@changeset-bot
Copy link

changeset-bot bot commented Jan 18, 2026

🦋 Changeset detected

Latest commit: c3c9619

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 13 packages
Name Type
workflow Patch
@workflow/core Patch
@workflow/ai Patch
@workflow/docs-typecheck Patch
@workflow/world-testing Patch
@workflow/builders Patch
@workflow/cli Patch
@workflow/next Patch
@workflow/nitro Patch
@workflow/web-shared Patch
@workflow/astro Patch
@workflow/sveltekit Patch
@workflow/nuxt Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@vercel
Copy link
Contributor

vercel bot commented Jan 18, 2026

@devyanshyadav is attempting to deploy a commit to the Vercel Labs Team on Vercel.

A member of the Team first needs to authorize it.

export {
type Event,
getHookByToken,
getWorld,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing exports for stepEntrypoint and workflowEntrypoint in workflow/api.ts causes build failures when base-builder.ts tries to import them

Fix on Vercel

TooTallNate added a commit that referenced this pull request Jan 21, 2026
@pranaygp
Copy link
Collaborator

We actually need to fix up the examples and export some higher level "API" functions from 'workflow/api'

for now gonna fix the docs in #826 and then add some higher level exports to api

ideally you should seldom have to use getWorld unless you need explicit access to the world ( #621 will make things clearer)

VaguelySerious pushed a commit that referenced this pull request Jan 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants