docs(readme): reconcile SDK surface to grounded SSOT (currency rewrite) - #50
Conversation
|
Bugbot couldn't run - usage limit reachedBugbot 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) |
|
Warning Review limit reachedYou’ve reached a temporary PR review limit under our Fair Usage Limits Policy. Next review available in: 32 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the 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 configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
Comment |
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.
Summary
Reconciles the WAVE SDK's
.wave/repo.json(and regeneratedREADME.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,creatorare SDK TypeScript source only — no live fleet backend today. Demoted fromlibtoplannedand annotated as SDK-surface-only in theirdoestext. Nothing was dropped; all still have source insrc/.What was fixed
voice: no longer claims "voice cloning." The real wave-voice product is TTS-only (wave.voice.synthesize()); the SDK'scloneVoice()client methods exist but are not backed by the product. Added a grounding claim (voice-tts-not-cloning) pointing atsrc/voice.ts'ssynthesize()symbol.phone/podcast: added asplanned(previously unlisted/implicitly shipped) — their core features areplannedin 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 baseWaveClientgenericrequest()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.base-client-generic-requestpointing atsrc/client.ts'sprotected async requestmethod, 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
exportsentries. Actual count: 42 module subpaths underexports(plus the package root., for 43 total export entries). Purpose and themodule-countclaim now both say 42, with the claim's grep resolver pointing at a real, present export key ("./realtime":) rather than the stalepackage.jsondescription string.Verification
factsparse clean againstRepoFacts(wave-context/schema/facts.schema.ts), run vianpx tsxinwave-context.README.mdregenerated viawave-context/scripts/render.ts'sgenerateReadme()against the edited facts object (not the CLI, which only reads committed facts).Only
.wave/repo.jsonandREADME.mdchanged. 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.jsonand the regeneratedREADME.mdwith 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) fromlibtoplanned, with explicit “SDK TypeScript surface only; no fleet backend yet” wording.voiceno longer advertises cloning—TTS viasynthesize()is documented, with clone client methods noted as unbacked.phoneandpodcastare added asplanned.wave-dispatchandgateway-agent-paymentsare added asgagateway capabilities reachable through the baseWaveClientrequest()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.
Need help on this PR? Tag
@codesmith-botwith what you need. Autofix is disabled.Summary by cubic
Aligns
@wave-av/sdkdocs 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
wave-dispatch(agent routing + OpenAI-compatible proxy) as GA, reachable via the base clientrequest()(no wrapper yet).gateway-agent-payments(x402 + MPP) as GA, reachable via the base clientrequest().Refactors
studio,prism,fleet,ghost,mesh,pulse,vault,creatortoplanned(SDK TypeScript surface only).phoneandpodcastasplanned.voiceto TTS-only; removed cloning claim."./realtime":.base-client-generic-requestandvoice-tts-not-cloning.README.md; Quick Start now showsvoice.synthesize(). Only.wave/repo.jsonandREADME.mdchanged.Written for commit cbeb627. Summary will update on new commits.