Repository navigation
Conversation
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Implement module-shaped TypeScript client declarations and an SDK factory, preserving the generated client API through a thin entry point. Retain legacy bindings and generation support without changing server syntax or ModuleDef.
This draft starts with the implementation outline; SDK, codegen, CLI, and integration changes will follow.
Validation: representative generated-output snapshots, consumer type tests, runtime integration, and legacy compatibility coverage are planned.
Completed implementation
spacetimedb/schemaand typedcreateClient, reusing existing builders and client runtime.--legacyretains the previous output.Validation results
This remains a draft for review.
Usage and compatibility
Generated bindings now use module declarations; the SDK builds the client API. Main-entry-point imports and calls stay the same. New bindings require the upgraded SDK; older SDKs can use
--legacy. Existing bindings continue working with the new SDK.The unrelated module-def source-validation fix and its regression test were moved to a separate PR.
The new legacy-flag parsing test was removed; legacy codegen compatibility coverage remains.
New-format generation keeps module-shaped
declarations.tsseparate from compatibility files. Existing table/reducer/procedure import paths,types.ts, type namespaces, and helper schemas are preserved using the same output as the legacy generator. Upgrading the SDK and regenerating requires no user-code changes.Future work: import resolution
spacetimedb/serverto the client declaration API.Deprecated table accessor aliases remain available, including in callback context types. Canonical database names and
--legacyoutput remain unchanged.Compatibility tests compile and run unchanged client programs against both formats and compare all existing direct-import files. Coverage includes named types, reducer/procedure schemas, deprecated aliases, constructors/builders, and typed callbacks. Existing alias assertions were restored; no test cases were removed.