Generated Node SDK contract markers and devdock example#422
Draft
kvz wants to merge 17 commits into
Draft
Conversation
This was referenced Jun 2, 2026
kvz
changed the title
The devdock Assembly lifecycle proof listed the first page of Assemblies and could miss the created one on a busy server. The contract models an assembly_id list filter (already used by the Go example), so expose it on ListAssembliesParams and use it in the example. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
resumeTusUpload() is generated from the API2 resumeUpload TUS protocol contract: it discovers the server offset with a HEAD request, PATCHes the remaining bytes from that offset, asserts the final offset matches the content length, and waits for the Assembly to finish. The new api2-devdock-tus-resume-upload example interrupts an upload after the first chunk like a dropped connection would, then resumes it through the public SDK method. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The API acknowledges Assembly creation before the list storage row is inserted (the SQL save is fire-and-forget at identification time), so an immediate list can miss the just-created Assembly. Devdock logs show the insert completing 126ms after the list query ran. Poll briefly so the lifecycle proof asserts list contents deterministically instead of racing the insert. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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
1 participant
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.
Experimental Status
Experimental work: this PR is part of the API2 contract/generated SDK effort and is intentionally kept as a Draft while the generated surface is validated.
Why
API2 now generates TypeScript SDK endpoint and feature methods from contract data. This companion PR gives that generator real Node SDK marker regions to rewrite and compare, plus a checked-in example that proves the generated surface works as consumer code against devdock.
What changed
createTusAssemblyinput from genericscenario.preparations[]instead of the removed API2 compatibility field.createTusAssembly()andwaitForAssembly()inpackages/node/src/Transloadit.ts.packages/node/src/Transloadit.ts.packages/node/examples/api2-devdock-tus-assembly/main.ts.packages/node/examples/api2-devdock-template-lifecycle/main.ts.Companion PRs
Validation
api2/bin/cli.ts contracts sdks --no-motd --target transloadit --platform typescript --sdk-root ../node-sdk --rewrite-sdk --compare-existingnode --check packages/node/examples/api2-devdock-template-lifecycle/main.tsyarn biome check packages/node/examples/api2-devdock-template-lifecycle/main.tscore/bin/devdock.ts exec tstrun system/sdk_examples/typescript-transloadit-examples.test.ts -vv --max-time-per-test 480yarn workspace @transloadit/node checkTransloadit Companion PRs