Repository navigation
docs(integrations): add Svelte, Vue, and Solid guides - #207
Merged
truthixify merged 1 commit intoOct 19, 2026
Merged
truthixify merged 1 commit into
truthixify merged 1 commit into
Conversation
Add first-party receive/scan guides for Svelte (SvelteKit + runes), Vue 3, and Solid/SolidStart. Each guide wraps the framework-agnostic @wraith-protocol/sdk in the framework's own reactivity, polling scanPayments() on an interval with a guard-based AbortController for cancellation, teardown that stops the interval and discards in-flight results, and SSR/hydration notes. Add scripts/check-integration-guides.ts, which strict type-checks the SDK-facing fences of the three guides against the installed package. CI installs the published @wraith-protocol/sdk tarball before running it, so API drift fails the build instead of shipping. Wire it into `npm test` and the Snippet checks workflow.
|
@Pythagoras-x Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
truthixify
approved these changes
Oct 19, 2026
truthixify
left a comment
truthixify
left a comment
Contributor
There was a problem hiding this comment.
Reviewed exact head 8269beb. The three framework guides compile their SDK-facing TypeScript fences, the full docs suite passes, navigation coverage is complete, workflow changes are limited to the new checker, and all required checks are green.
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
2 participants
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.
Summary
Adds first-party integration guides for Svelte, Vue, and Solid, each covering the same concise receive/scan flow: connect a
WraithAgent, pollscanPayments()on an interval, and render the returnedPayment[].Closes #194
Pages
guides/integrations/svelte.mdx— Svelte 5 runes + SvelteKit, teardown via$effectreturn,browserguard from$app/environmentguides/integrations/vue.mdx— Vue 3 composable,onMounted/onUnmounted,import.meta.clientSSR guardguides/integrations/solid.mdx— Solid signals,onMount/onCleanup,isServerSSR guardEach guide shares a framework-agnostic
PaymentReceiverthat:Registered in
docs.jsonandguides/integrations/_meta.json.Testing
Adds
scripts/check-integration-guides.ts(pnpm run check:integration-guides), which strict type-checks the SDK-facing TypeScript fences of the three guides against the installed@wraith-protocol/sdk. The existing snippet checker wraps every fence in// @ts-nocheck, so it only catches syntax errors; this closes that gap for the guides that document the receive/scan calls, so SDK signature drift fails the build instead of shipping.The Snippet checks workflow installs the published
@wraith-protocol/sdktarball before running it, so the guides are validated against the exact package developers install. Verified the check fails on drift and maps errors back to the MXD source line.Wired into
npm testand the Snippet checks workflow.Notes
@wraith-protocol/sdkis framework-agnostic and is the only published@wraith-protocolpackage, so the guides wrap it directly rather than introducing framework-specific companion packages..github/workflows/snippets.yml(CODEOWNERS-gated); needs a maintainer review on that file.