Update inapp module and add startVerificationFromUrl in frontend api … #4
Conversation
…(was always there in platform api)
WalkthroughThe updates raise the SDK and related dependency versions from 0.6.0 to 0.7.0 across all relevant files, update installation and migration documentation accordingly, and introduce a new asynchronous method, Changes
Sequence Diagram(s)sequenceDiagram
participant ClientApp
participant ReclaimVerification
participant PlatformModule
ClientApp->>ReclaimVerification: startVerificationFromUrl(requestUrl)
ReclaimVerification->>PlatformModule: startVerificationFromUrl(requestUrl)
PlatformModule-->>ReclaimVerification: Promise<Response>
ReclaimVerification-->>ClientApp: Promise<Response>
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI ⛔ Files ignored due to path filters (4)
📒 Files selected for processing (4)
🧰 Additional context used🧬 Code Graph Analysis (2)lib/typescript/commonjs/src/index.d.ts (3)
lib/typescript/module/src/index.d.ts (3)
🔇 Additional comments (4)
✨ Finishing Touches
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: 1
🧹 Nitpick comments (2)
documentation/migration.md (2)
3-9: Refine the 0.7.0 migration instructions.
The new section is on point, but we can improve readability and satisfy markdown lint rules by:
- Fixing the missing article (“the latest version” vs. “latest versions”).
- Converting bare URLs to named markdown links.
@@ -7,7 +7,8 @@ - Make sure if you are using the latest versions of `ReclaimInAppSdk` cocoapod if you have overriden this dependency in your `Podfile`. Latest version on [cocoapods.org is 0.7.0](https://cocoapods.org/pods/ReclaimInAppSdk). + Make sure you are using the latest version of the `ReclaimInAppSdk` CocoaPod if you have overridden this dependency in your `Podfile`. The latest version is [0.7.0 on CocoaPods](https://cocoapods.org/pods/ReclaimInAppSdk). - Run a `pod install --repo-update`. If this fails for reasons related to the `ReclaimInAppSdk`, try running `pod update ReclaimInAppSdk`. - Refer: https://github.com/reclaimprotocol/reclaim-inapp-reactnative-sdk/blob/main/README.md#ios-setup + - Run a `pod install --repo-update`. If that fails due to `ReclaimInAppSdk`, run `pod update ReclaimInAppSdk`. + - See the [iOS setup instructions](https://github.com/reclaimprotocol/reclaim-inapp-reactnative-sdk/blob/main/README.md#ios-setup).🧰 Tools
🪛 LanguageTool
[uncategorized] ~7-~7: A determiner appears to be missing. Consider inserting it.
Context: ...iden this dependency in yourPodfile. Latest version on [cocoapods.org is 0.7.0](htt...(AI_EN_LECTOR_MISSING_DETERMINER)
🪛 markdownlint-cli2 (0.17.2)
9-9: Bare URL used
null(MD034, no-bare-urls)
44-46: Apply same refinements to the 0.6.0 iOS migration.
The earlier version’s iOS section should also remove bare URLs, correct grammar (“overriden”→“overridden”), and use Markdown links.@@ -44,3 +44,4 @@ - Make sure if you are using the latest versions of `ReclaimInAppSdk` cocoapod if you have overriden this dependency in your `Podfile`. + Make sure you are using the latest version of the `ReclaimInAppSdk` CocoaPod if you have overridden this dependency in your `Podfile`. - Run a `pod install --repo-update`. If this fails for reasons related to the `ReclaimInAppSdk`, try running `pod update ReclaimInAppSdk`. - Refer: https://github.com/reclaimprotocol/reclaim-inapp-reactnative-sdk/blob/main/README.md#ios-setup + - Refer to the [iOS setup instructions](https://github.com/reclaimprotocol/reclaim-inapp-reactnative-sdk/blob/main/README.md#ios-setup).🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
46-46: Bare URL used
null(MD034, no-bare-urls)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (8)
CHANGELOG.md(1 hunks)InappRnSdk.podspec(1 hunks)README.md(3 hunks)android/build.gradle(1 hunks)documentation/migration.md(2 hunks)package.json(1 hunks)samples/example_new_arch/package.json(1 hunks)src/index.ts(1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
src/index.ts (2)
lib/module/index.js (1)
ReclaimVerification(12-39)src/specs/NativeInappRnSdk.ts (1)
Response(110-125)
🪛 LanguageTool
documentation/migration.md
[uncategorized] ~7-~7: A determiner appears to be missing. Consider inserting it.
Context: ...iden this dependency in your Podfile. Latest version on [cocoapods.org is 0.7.0](htt...
(AI_EN_LECTOR_MISSING_DETERMINER)
🪛 markdownlint-cli2 (0.17.2)
documentation/migration.md
9-9: Bare URL used
null
(MD034, no-bare-urls)
🔇 Additional comments (10)
android/build.gradle (1)
121-121: Version bump looks good.The dependency version for
org.reclaimprotocol:inapp_sdkhas been correctly updated from 0.6.0 to 0.7.0, which aligns with the overall SDK version update.samples/example_new_arch/package.json (1)
13-13: Version update is consistent.The dependency version for
@reclaimprotocol/inapp-rn-sdkhas been updated from ^0.6.0 to ^0.7.0, maintaining consistency with the version updates across the project.src/index.ts (2)
33-37: Implementation of startVerificationFromUrl method looks good.The new method has been properly implemented to expose the existing platform functionality to the frontend API. The function signature accepts a URL string and correctly delegates to the platform implementation.
362-384: Platform implementation for startVerificationFromUrl is well-structured.The implementation follows the same pattern as the existing
startVerificationmethod:
- Makes a call to the native module
- Transforms the response to include properly typed proofs
- Handles errors appropriately with detailed error information
Good error handling approach with comprehensive try/catch and proper error transformation.
package.json (1)
3-3: Version bump is consistent.The package version has been correctly updated from 0.6.0 to 0.7.0, which aligns with all other version updates in this PR.
InappRnSdk.podspec (1)
20-20: Align CocoaPod dependency version to 0.7.0.
The bump from~> 0.6.0to~> 0.7.0here correctly matches the coordinated version updates across platforms.README.md (4)
113-113: Update CocoaPods installation snippet for iOS.
This line correctly updates theReclaimInAppSdkpod to~> 0.7.0in the “From cocoapods” example.
119-119: Update CocoaPods git-tag installation example.
The:tag => '0.7.0'update is correct and aligns with the new release.
156-156: Sync example Podfile in the example app.
The embeddedpod 'ReclaimInAppSdk', '~> 0.7.0'is now consistent with the rest of the documentation.
295-295: Link to 0.7.0 migration instructions.
The new migration link for version 0.7.0 is valid and matches the docs.
| ## 0.7.0 | ||
|
|
||
| * Updates inapp module dependency to 0.7.0 | ||
|
|
There was a problem hiding this comment.
Document new functionality in the changelog.
You’ve added the 0.7.0 header and noted the module dependency bump, but the newly introduced startVerificationFromUrl method (added to the frontend API) isn’t mentioned. Please include a bullet under ## 0.7.0 describing this feature so that consumers know what’s new.
🤖 Prompt for AI Agents
In CHANGELOG.md lines 1 to 4, the changelog entry for version 0.7.0 only
mentions the inapp module dependency update but omits the new
startVerificationFromUrl method added to the frontend API. Add a bullet point
under the 0.7.0 header describing the startVerificationFromUrl method to
document this new functionality for consumers.
…(was always there in platform api)
Summary by CodeRabbit
New Features
Documentation
Chores