Repository navigation
docs: document GuildPass SDK V2 public API and usage examples (closes #500) - #504
Merged
Lakes41 merged 1 commit intoSep 17, 2026
Conversation
Closes Adamantine-guild#500 - Add V2 quickstart, client initialization, Stellar account validation, access check evaluation, and typed error handling examples to README.md. - Create docs/api-reference.md providing detailed reference documentation for GuildPassClient, Stellar helpers, AccessResource, pagination, and error hierarchy. - Add examples/quickstart.ts demonstrating an end-to-end runnable integration. - Add tests/documentationExamples.test.ts to validate all documentation examples against the SDK runtime with 100% test pass guarantee.
7 tasks
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.
Description
This PR resolves #500 by documenting the GuildPass SDK V2 public API surface, providing practical usage guides, a comprehensive API reference, and a runnable quickstart script.
Changes
README.md:parseStellarAccountId,isStellarAccountId), community access control evaluation (client.access.check), and structured error handling.docs/api-reference.md:GuildPassClientconfiguration (baseUrl,timeoutMs,headers).parseStellarAccountId,isStellarAccountId,safeParseStellarAccountId).client.access.check) and domain types (AccessCheckRequest,AccessDecision).paginate,collectAll,createPaginatedApi).GuildPassError,HttpError,NetworkError,TimeoutError,ConfigurationError).redactSecret,fingerprintSecret).examples/quickstart.ts:tests/documentationExamples.test.ts:Verification
Executed full verification suite:
pnpm typecheck(tsc --noEmit): Passed cleanlypnpm build(tsup): ESM & DTS build successpnpm test(vitest): 24 test files passed, 685 tests passed, 0 failuresCloses #500