Fixed Broken Links and Advance Options for Web SDK#60
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughThis update restructures and expands the documentation for the Reclaim Protocol SDK, particularly focusing on the Web SDK. It introduces new and updated method documentation, reorganizes advanced usage sections, updates navigation links, and clarifies integration steps across multiple platforms. Several "Advanced Usage" sections were removed or replaced with targeted references to the new "Web SDK" guide. Changes
Sequence Diagram(s)sequenceDiagram
participant Dev as Developer
participant SDK as Reclaim Web SDK
participant Backend as Backend Service
participant User as End User
Dev->>SDK: Initialize SDK with init(), set options, etc.
Dev->>SDK: Optionally setAppCallbackUrl(), setRedirectUrl(), setParams(), etc.
Dev->>SDK: Start verification (triggerReclaimFlow() or getRequestUrl())
User->>SDK: Interacts via browser extension, QR code, or mobile app
SDK->>Backend: Sends proof to callback URL (if set)
Dev->>SDK: Export/import session config (toJsonString(), fromJsonString())
Dev->>SDK: Verify proof (verifyProof())
SDK->>Dev: Returns verification result
Possibly related PRs
Suggested labels
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (16)
content/docs/advance-options/meta.json (1)
3-3: Consistent comma spacing
Add a space after the comma between"overrides"and"verification-options"for readability:- "pages": ["attestor-auth", "verification", "overrides","verification-options", ...] + "pages": ["attestor-auth", "verification", "overrides", "verification-options", ...]content/docs/web/index.mdx (3)
3-3: Use "web app" and "JavaScript" for clarity
Consider updating to:description: Integrate Reclaim Protocol into your web app using our JavaScript and Python SDKs.
7-7: Add space in "Web SDKs"
Change## Understanding the WebSDKs workflowto## Understanding the Web SDKs workflowfor consistency.
18-18: Spell "Node.js" correctly
ReplaceNodeJS/PythonwithNode.js/Python(or better,Node.js and Python) to match official naming.🧰 Tools
🪛 LanguageTool
[uncategorized] ~18-~18: The official spelling of this programming framework is “Node.js”.
Context: ...process the verification securely using NodeJS/Python(NODE_JS)
content/docs/web/frontend/quickstart.mdx (2)
85-85: Add missing "the"
Change:This method generates a verification request URL that user needs to visit to start the session.to
This method generates a verification request URL that the user needs to visit to start the session.🧰 Tools
🪛 LanguageTool
[uncategorized] ~85-~85: You might be missing the article “the” here.
Context: ...nerates a verification request URL that user needs to visit to start the session. `...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
158-158: Consistent term "use case"
Replaceusecaseswithuse cases:- For production usecases, ... + For production use cases, ...content/docs/web/frontend/fullstack.mdx (5)
22-22: Improve clarity and punctuation
Rephrase to:For a detailed backend implementation using Node.js and Python, please refer to the [Backend guide](../backend).and remove the extra space before the comma.
30-30: Add colon after introductory sentence
For readability, consider:There are two ways to implement the Reclaim Protocol on your frontend:
32-33: Use a numbered list for parallel structure
Convert the bullet items to a numbered list to match other guides:-- Using ... -- Using ... +- 1. Using ... +- 2. Using ...
113-113: Add missing "the"
Update to:This method generates a verification request URL that the user needs to visit to start the session.🧰 Tools
🪛 LanguageTool
[uncategorized] ~113-~113: You might be missing the article “the” here.
Context: ...nerates a verification request URL that user needs to visit to start the session. `...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
183-183: Add terminal period
Append a period for consistency:- ...advanced options](../../advance-options/web-sdk) + ...advanced options](../../advance-options/web-sdk).content/docs/advance-options/web-sdk.mdx (5)
2-4: Refine frontmatter to match document scope
Thedescriptionstill refers to “advanced options”; consider updating it to explicitly mention the Web SDK for clarity (e.g. “This guide provides a detailed reference for the Reclaim Web SDK across multiple platforms”).
30-33: Grammar: rephrase and determiner usage
- Change “Only should be set to
truewhen…” to “Should only be set totruewhen…”- In the description for
useBrowserExtension, replace “fallback” (noun) with the verb phrase “fall back.”🧰 Tools
🪛 LanguageTool
[uncategorized] ~32-~32: You might be missing the article “an” here.
Context: ...owser extension for desktop users. When extension is not installed, the SDK will fallback...(AI_EN_LECTOR_MISSING_DETERMINER_AN)
[grammar] ~32-~32: The word “fallback” is a noun. The verb is spelled with a space.
Context: ...xtension is not installed, the SDK will fallback to QR code flow. -extensionID(D...(NOUN_VERB_CONFUSION)
117-118: Correct abbreviation in note
Change “Eg.” to lowercase “e.g.” with both periods (i.e., “e.g.”) for correct usage.🧰 Tools
🪛 LanguageTool
[uncategorized] ~117-~117: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...parse the proof object in the response. Eg. `express.text({ type: '/', limit: '50...(E_G)
330-373: ApproveaddContextexamples and context description
The code samples and callout clearly explain how to attach custom context. Optional: add a note reminding users to validate hex address format before invoking.
471-473: Add missing article in description
Change “usesetModalOptionsmethod” to “use thesetModalOptionsmethod” for grammatical correctness.🧰 Tools
🪛 LanguageTool
[uncategorized] ~473-~473: You might be missing the article “the” here.
Context: ...bs> ### setModalOptions() You can usesetModalOptionsmethod to customize the...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (15)
content/docs/advance-options/meta.json(1 hunks)content/docs/advance-options/web-sdk.mdx(9 hunks)content/docs/android-kotlin/usage.mdx(0 hunks)content/docs/expo/installation.mdx(1 hunks)content/docs/expo/usage.mdx(1 hunks)content/docs/ionic/usage.mdx(0 hunks)content/docs/ios-swift/usage.mdx(0 hunks)content/docs/react-native/usage.mdx(0 hunks)content/docs/web/backend/index.mdx(3 hunks)content/docs/web/backend/installation.mdx(3 hunks)content/docs/web/backend/usage.mdx(2 hunks)content/docs/web/frontend/fullstack.mdx(3 hunks)content/docs/web/frontend/index.mdx(1 hunks)content/docs/web/frontend/quickstart.mdx(4 hunks)content/docs/web/index.mdx(1 hunks)
💤 Files with no reviewable changes (4)
- content/docs/react-native/usage.mdx
- content/docs/ios-swift/usage.mdx
- content/docs/android-kotlin/usage.mdx
- content/docs/ionic/usage.mdx
🧰 Additional context used
🪛 LanguageTool
content/docs/web/index.mdx
[uncategorized] ~10-~10: Possible missing article found.
Context: ...d and displayed to the user to tap/scan QR code. 2. The user starts the session an...
(AI_HYDRA_LEO_MISSING_A)
[uncategorized] ~18-~18: The official spelling of this programming framework is “Node.js”.
Context: ...process the verification securely using NodeJS/Python
(NODE_JS)
content/docs/web/frontend/quickstart.mdx
[uncategorized] ~85-~85: You might be missing the article “the” here.
Context: ...nerates a verification request URL that user needs to visit to start the session. `...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
content/docs/web/frontend/fullstack.mdx
[uncategorized] ~113-~113: You might be missing the article “the” here.
Context: ...nerates a verification request URL that user needs to visit to start the session. `...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
content/docs/advance-options/web-sdk.mdx
[uncategorized] ~32-~32: You might be missing the article “an” here.
Context: ...owser extension for desktop users. When extension is not installed, the SDK will fallback...
(AI_EN_LECTOR_MISSING_DETERMINER_AN)
[grammar] ~32-~32: The word “fallback” is a noun. The verb is spelled with a space.
Context: ...xtension is not installed, the SDK will fallback to QR code flow. - extensionID (D...
(NOUN_VERB_CONFUSION)
[uncategorized] ~117-~117: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...parse the proof object in the response. Eg. `express.text({ type: '/', limit: '50...
(E_G)
[uncategorized] ~377-~377: Loose punctuation mark.
Context: ... ``` - contextId: Unique hex address identifier (string) ...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~473-~473: You might be missing the article “the” here.
Context: ...bs> ### setModalOptions() You can use setModalOptions method to customize the...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~474-~474: You might be missing the article “the” here.
Context: ...ed). This is applicable only when using triggerReclaimFlow method. <Tabs items...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
🔇 Additional comments (27)
content/docs/web/backend/installation.mdx (3)
3-3: Generalize introduction for all backend environments
This update removes Node.js–specific text and welcomes users of any backend platform. It aligns with multi-language support.
49-49: Install latest Python SDK by default
Switching from a fixed version to the latest release ensures users get up-to-date features.
70-72: Add "Integrate into your project" section
Good addition linking to the usage guide; verify thatcontent/docs/web/backend/usage.mdxexists at./usage.content/docs/expo/installation.mdx (1)
111-111: Update "Advance Options" link to Web SDK guide
Aligns with the restructured advanced options; please verify thatcontent/docs/advance-options/web-sdk.mdxexists at../advance-options/web-sdk.content/docs/expo/usage.mdx (1)
147-147: Point "Advance Usage" to Web SDK guide
Ensures consistent navigation to the new advanced options guide; verify the target path exists.content/docs/web/frontend/index.mdx (3)
2-2: Rename document title to reflect Frontend Integration
Clarifies the guide’s scope and matches directory structure.
10-10: Fix "Quickstart" link to include frontend subfolder
Aligns links with the new directory layout; please verify thatcontent/docs/web/frontend/frontend/quickstart.mdx(or the intended path) exists.
16-16: Fix "Fullstack" link to include frontend subfolder
Ensures navigation points to the correct fullstack guide; verify thatcontent/docs/web/frontend/frontend/fullstack.mdxexists.content/docs/web/backend/index.mdx (3)
2-2: Rename document title to "Backend Integration"
Improves clarity by focusing on integration rather than SDK listings.
17-17: Update link to frontend fullstack guide
Redirects to the reorganized frontend guide; verify thatcontent/docs/web/frontend/fullstack.mdxexists at../web/frontend/fullstack.
27-27: Update backend example link to usage guide
Points users directly to the new usage walkthrough; verify thatcontent/docs/web/backend/backend/usage.mdxexists at./backend/usage.content/docs/advance-options/meta.json (1)
1-4: Approve new metadata file
Thismeta.jsoncorrectly defines the Advanced Options section and its page order.content/docs/web/backend/usage.mdx (1)
185-185: Verify updatedProof Structurelink
Ensure the relative path../../advance-options/web-sdk#understanding-the-proof-structureresolves correctly and that the anchor exists in the Web SDK guide.content/docs/web/frontend/fullstack.mdx (2)
48-48: Approve component rename
RenamingReclaimDemotoStartReclaimVerificationclearly reflects its purpose.
108-108: Approve updated default export
Exporting the renamed component aligns with the new function name.content/docs/advance-options/web-sdk.mdx (12)
14-46: Enhanceinit()examples for all platforms
The PR summary states this guide is the central reference across JavaScript, Flutter, Python, and Rust, yet theinit()section only shows JS and Python. Please verify if Flutter and Rust initialization snippets should be added here.🧰 Tools
🪛 LanguageTool
[uncategorized] ~32-~32: You might be missing the article “an” here.
Context: ...owser extension for desktop users. When extension is not installed, the SDK will fallback...(AI_EN_LECTOR_MISSING_DETERMINER_AN)
[grammar] ~32-~32: The word “fallback” is a noun. The verb is spelled with a space.
Context: ...xtension is not installed, the SDK will fallback to QR code flow. -extensionID(D...(NOUN_VERB_CONFUSION)
51-66: Verify optional parameters in JS API docs
The JavaScript example shows onlysetAppCallbackUrl(url), but the parameter list mentions ajsonProofResponseflag. Please confirm whether the second argument is supported and, if so, include its usage in the code snippet.
101-115: Confirm Python method signature
The Python example usesset_app_callback_url(url)but doesn’t show any JSON flag. Verify if the Python SDK supports a secondjson_proof_responseparameter (as in JS) and update the snippet accordingly.
119-187: ConsolidatesetRedirectUrlexamples
The JavaScript, Flutter, and Python snippets all look consistent and clear. If other platforms (e.g., React Native) apply, consider adding them here or link out.
194-243: Approve export/import configuration snippets
The JS, Dart, and Python examples fortoJsonString/fromJsonStringare clear and demonstrate cross-platform session sharing effectively.
248-326: ApproveverifyProofmulti-language examples
The JavaScript, Dart, Python, and Rust snippets accurately illustrate the proof verification flow and include necessary install/config steps for Rust.
382-436: ApprovesetParamsmulti-language examples
The parameter-setting examples are accurate and well-formatted across JavaScript, Dart, and Python.
445-467: ApproveisBrowserExtensionAvailablesnippet
The single-language JS example correctly demonstrates detection logic and fallback behavior.
478-495: ApprovesetModalOptionsJavaScript example
The snippet shows all available modal customization options before callingtriggerReclaimFlow().
499-504: Approve modal options bullet list
The list clearly defines eachsetModalOptionsproperty, defaults, and expected types.
510-653: Approve session detail retrieval methods
The examples forgetRequestUrl(),getSessionId(),getStatusUrl(), andgetAppCallbackUrl()are thorough, consistent, and correctly use language-specific naming conventions.
660-672: Approve proof JSON structure example
The generic proof schema is well-structured, annotated, and helpful as a reference.
| ## Advanced Options | ||
| Reclaim SDKs provide a lot of flexibility to customize the verification process. | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Align section heading with guide title
The section heading ## Advanced Options no longer matches the document title “Web SDK.” Please rename it to something like ## Web SDK Overview to maintain consistency.
🤖 Prompt for AI Agents
In content/docs/advance-options/web-sdk.mdx around lines 7 to 9, the section
heading "## Advanced Options" does not match the document title "Web SDK."
Rename the heading to "## Web SDK Overview" to ensure consistency with the guide
title.
| ```dart | ||
| final reclaimProofRequest = await ReclaimProofRequest.init( | ||
| 'YOUR_RECLAIM_APP_ID', | ||
| 'YOUR_RECLAIM_APP_SECRET', | ||
| 'YOUR_PROVIDER_ID' | ||
| ); | ||
|
|
||
| // Make sure to set this before starting the verification session. | ||
| reclaimProofRequest.setAppCallbackUrl('https://your-api.com/receive-proofs') // your custom callback url here | ||
|
|
||
| ``` |
There was a problem hiding this comment.
Dart snippet: add missing semicolon
In the Dart example, the call to setAppCallbackUrl(...) is missing a trailing semicolon. Add ; at the end of that statement to avoid syntax errors.
🤖 Prompt for AI Agents
In content/docs/advance-options/web-sdk.mdx around lines 88 to 98, the Dart code
snippet is missing a semicolon at the end of the
reclaimProofRequest.setAppCallbackUrl(...) statement. Add a semicolon at the end
of this line to fix the syntax error.
3 participants
Description
Fixed Broken Links and Advance Options for Web SDK
Type of change
Checklist:
Summary by CodeRabbit