Skip to content

docs(readme): reconcile SDK surface to grounded SSOT (currency rewrite) - #50

Merged
yakimoto merged 1 commit into
mainfrom
ce/sdk-currency
Jul 25, 2026
Merged

docs(readme): reconcile SDK surface to grounded SSOT (currency rewrite)#50
yakimoto merged 1 commit into
mainfrom
ce/sdk-currency

Conversation

@yakimoto

@yakimoto yakimoto commented Jul 25, 2026

Copy link
Copy Markdown
Contributor

Summary

Reconciles the WAVE SDK's .wave/repo.json (and regenerated README.md) to the actual, grounded state of the codebase. This supersedes/corrects the over-claims introduced in #49.

What was demoted (14 → 6 shipped, 8 demoted to planned)

studio, prism, fleet, ghost, mesh, pulse, vault, creator are SDK TypeScript source only — no live fleet backend today. Demoted from lib to planned and annotated as SDK-surface-only in their does text. Nothing was dropped; all still have source in src/.

What was fixed

  • voice: no longer claims "voice cloning." The real wave-voice product is TTS-only (wave.voice.synthesize()); the SDK's cloneVoice() client methods exist but are not backed by the product. Added a grounding claim (voice-tts-not-cloning) pointing at src/voice.ts's synthesize() symbol.
  • phone / podcast: added as planned (previously unlisted/implicitly shipped) — their core features are planned in the fleet SSOT.

What was added

  • wave-dispatch (ga): agent routing (route/pool) + OpenAI-compatible proxy at the WAVE gateway — shipped, reachable today via the SDK's base WaveClient generic request() method (no dedicated wrapper module yet).
  • gateway-agent-payments (ga): x402 + MPP card-rail agent payments with scope-gate/settlement-guard at the WAVE gateway — shipped, same generic-client reachability.
  • Added a grounding claim base-client-generic-request pointing at src/client.ts's protected async request method, since these two capabilities have no dedicated SDK module and would otherwise have no real resolver.

Module count reconciled

Purpose/claims previously said "34 API modules" (package.json's stale description string) vs. capabilities declaring 33 vs. package.json's actual 43 exports entries. Actual count: 42 module subpaths under exports (plus the package root ., for 43 total export entries). Purpose and the module-count claim now both say 42, with the claim's grep resolver pointing at a real, present export key ("./realtime":) rather than the stale package.json description string.

Verification

  • facts parse clean against RepoFacts (wave-context/schema/facts.schema.ts), run via npx tsx in wave-context.
  • README.md regenerated via wave-context/scripts/render.ts's generateReadme() against the edited facts object (not the CLI, which only reads committed facts).

Only .wave/repo.json and README.md changed. Not merged — public outbound is the owner's gate.


Note

Low Risk
Documentation and SSOT metadata only; no runtime SDK or API behavior changes.

Overview
Realigns .wave/repo.json and the regenerated README.md with the grounded SSOT so public docs no longer over-claim shipped backend coverage.

Capability statuses demote eight areas (studio, prism, fleet, ghost, mesh, pulse, vault, creator) from lib to planned, with explicit “SDK TypeScript surface only; no fleet backend yet” wording. voice no longer advertises cloning—TTS via synthesize() is documented, with clone client methods noted as unbacked. phone and podcast are added as planned. wave-dispatch and gateway-agent-payments are added as ga gateway capabilities reachable through the base WaveClient request() path (no dedicated SDK module).

Claims and counts update module coverage from the stale “34 modules” story to 42 subpath exports (resolver anchored on a real export key). New grounding claims cover generic request() and voice TTS vs clone.

README is replaced with the SSOT-driven template: capabilities table, receipts table, shortened quickstart (pipeline + TTS instead of prism/pulse examples), and removal of the long manual API catalog and product examples.

Reviewed by Cursor Bugbot for commit cbeb627. Configure here.


View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need. Autofix is disabled.


Summary by cubic

Aligns @wave-av/sdk docs and facts with the grounded Single Source of Truth. Demotes unshipped modules, adds gateway capabilities that are live today, fixes voice claims, and corrects the module export count to 42.

  • New Features

    • Added wave-dispatch (agent routing + OpenAI-compatible proxy) as GA, reachable via the base client request() (no wrapper yet).
    • Added gateway-agent-payments (x402 + MPP) as GA, reachable via the base client request().
  • Refactors

    • Demoted studio, prism, fleet, ghost, mesh, pulse, vault, creator to planned (SDK TypeScript surface only).
    • Added phone and podcast as planned.
    • Updated voice to TTS-only; removed cloning claim.
    • Fixed module count to 42 subpath exports (+ root) and updated the resolver to grep "./realtime":.
    • Added grounding claims base-client-generic-request and voice-tts-not-cloning.
    • Regenerated README.md; Quick Start now shows voice.synthesize(). Only .wave/repo.json and README.md changed.

Written for commit cbeb627. Summary will update on new commits.

Review in cubic

@changeset-bot

changeset-bot Bot commented Jul 25, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: cbeb627

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

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

@cursor

cursor Bot commented Jul 25, 2026

Copy link
Copy Markdown

Bugbot couldn't run - usage limit reached

Bugbot is counted against Cursor usage for this user or team, and this run hit a usage or spend limit.

A user or team admin can review and increase usage limits in the Cursor dashboard.

(requestId: serverGenReqId_ff353004-00dc-4e8a-bafd-4bf552c29fdb)

@coderabbitai

coderabbitai Bot commented Jul 25, 2026

Copy link
Copy Markdown

Warning

Review limit reached

You’ve reached a temporary PR review limit under our Fair Usage Limits Policy.

Your recent review volume is higher than typical usage, so adaptive limits are currently applied.

Next review available in: 32 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 23055dcf-9053-4b01-aa69-387629e14e6f

📥 Commits

Reviewing files that changed from the base of the PR and between d807aac and cbeb627.

📒 Files selected for processing (2)
  • .wave/repo.json
  • README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch ce/sdk-currency
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch ce/sdk-currency

Comment @coderabbitai help to get the list of available commands.

@yakimoto
yakimoto enabled auto-merge July 25, 2026 04:10

@wave-av-reviewbot wave-av-reviewbot Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Approved by wave-av-reviewbot: non-author review. Content independently audited — README + .wave/repo.json only, claims resolver-grounded against real src/, planned/preview correctly staged, no off-brand or non-WAVE URLs, all CI green.

@yakimoto
yakimoto merged commit e3864a7 into main Jul 25, 2026
16 checks passed
@yakimoto
yakimoto deleted the ce/sdk-currency branch July 25, 2026 04:11
yakimoto added a commit that referenced this pull request Jul 28, 2026
Both sides regenerated .wave/repo.json and README.md from d807aac, so every line conflicts.
Resolved NOT by hand-merging text but by rebuilding the SSOT from main and re-rendering the
README through the content engine — a hand-resolved generated file is a file no generator
would ever produce.

main (PR #50, the currency rewrite) is authoritative for grounded facts and is preserved
VERBATIM: every top-level key except the new `sections` is byte-identical to origin/main.
This branch contributes only the enrichment, filtered for currency. See the following commit
message for what was dropped and why.
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.

1 participant