Block a user
worldtree-sdk (1.0.0)
Published 2026-07-18 13:34:01 -07:00 by vh
Installation
registry=https://gitea.phasefinal.com/api/packages/vh/npm/npm install worldtree-sdk@1.0.0"worldtree-sdk": "1.0.0"About this package
worldtree-sdk
Official consumer SDK for the Worldtree Conversation API. TypeScript v0 (this repo, first); Python spine next milestone — same behavioral spec, same fixture corpus, co-designed surfaces.
Status: pre-implementation. Contract is review-clean
(docs/contracts/worldtree-sdk-v0.contract.md, rev 1.1); implementation
proceeds by TDD against the contract's tracer tests, with the fixture
corpus as the conformance gate.
What governs what
| Artifact | Role |
|---|---|
docs/behavioral-spec.md |
The protocol rulebook (B-/D- rules) both spines implement |
docs/surface-design.md |
Ratified public-surface decisions (D1–D4) |
docs/parity-matrix.md |
Consumer migration gate (warts W-1..W-8, typed-error floor) |
docs/codegen-spike.md |
Codegen verdict: types-only via openapi-typescript |
docs/contracts/worldtree-sdk-v0.contract.md |
The v0 implementation contract (SDK-INV-001..009) |
fixtures/ |
68 golden fixtures — the executable conformance floor; validate_corpus.py lints |
capture/ |
Live wire-capture harness (redacted transcripts → fixtures/captured/) |
vendor/ |
Frozen Worldtree API artifacts + SPEC-PIN.md (regen + bump procedure) |
Layout
src/generated/ openapi-typescript output (internal; regen via `npm run generate`)
src/shapes/ hand-authored response shapes (internal)
src/wire/ SSE spine: parser + resume orchestration (internal)
src/client/ the public facade — the ONLY public import surface
conformance/ corpus runner (gates publish)
Publishing
Internal Gitea npm registry only (publishConfig in package.json).
Zero runtime dependencies; Node ≥ 20 and evergreen browsers via native
fetch/ReadableStream.
Origin: Worldtree issue #371. The docs/fixtures family migrated from
Worldtree docs/sdk/ on 2026-07-18; Worldtree keeps a pointer.
Dependencies
Development Dependencies
| ID | Version |
|---|---|
| openapi-typescript | 7.13.0 |
| typescript | ^5.9.2 |
| vitest | ^3.2.0 |