Repository navigation
docs: fix misleading Rokt SDK README integration guides - #295
Conversation
There was a problem hiding this comment.
Claude Code Review
This repository is configured for manual code reviews. Comment @claude review for a one-time review, or @claude review always to subscribe this PR to a review on every future push.
Tip: disable this comment in your organization's Code Review settings.
🔒 Security Scan Complete✅ No security issues detected Scanned files against 91 rules. · Reviewed commit: 📜 Scan history (2 scans)
ℹ️ About PR Security AgentThis scan was performed by PR Security Agent, an automated security review tool for pull requests. See the User Guide for details on severity levels, feedback reactions, and scan configuration. Reply |
🛣️ ROKT Data Platform Paved Roads Scan Complete✅ No paved-road issues detected Scanned files against 2 rules. · Reviewed commit: 📜 Scan history (2 scans)
ℹ️ About ROKT Data Platform Paved Roads AgentThis scan was performed by the ROKT Data Platform Paved Roads Agent, an automated paved-road standards review tool for pull requests. See the User Guide for details on severity levels, feedback reactions, and scan configuration. Reply |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 605b1fc543
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
- Clarify purchaseFinalized: it closes the loop on a Rokt in-placement instant purchase (Shoppable Ads), NOT a checkout/order-confirmation hook. Rewrote the README section + API table and added JSDoc so the warning surfaces on IDE hover at the call site. - Rewrite Rokt.Widget/README.md (the npm-published README): drop the removed execute() API, the fabricated Ruby 2.7.6 requirement, and the dead M1 arm64 workaround; link to the canonical repo guide + official RN/CocoaPods docs. - Rename payment extension RoktStripePaymentExtension -> RoktPaymentExtension across README, MIGRATING.md, and the iOS sample (AppDelegate + Podfile). Every claim verified against SDK source, native iOS/Android SDKs, sample apps, and CI (versions, API surface, packaging). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
605b1fc to
01b27bc
Compare
Background
Rokt.purchaseFinalized(...)on their order-confirmation page, assuming it reports a normal checkout. It does not — it closes the loop on a Rokt in-placement instant purchase (Shoppable Ads). The docs made that easy to misread, and several other claims across the two README files were outdated, wrong, or misleading (the removedexecute()API, a fabricated Ruby version, a dead M1 workaround, a renamed payment-extension class).What Has Changed
README.md(canonical guide): rewrote the Purchase Finalized section and API-table row so it clearly states it is for Rokt in-placement instant purchases only — called from theCartItemInstantPurchaseevent handler using that event'splacementId/catalogItemId— with an explicit "not for normal checkout / order-confirmation" warning. Renamed the payment extension toRoktPaymentExtension; replacedpk_live_...with a placeholder. Corrected "Rokt SDK 5.0" → "5.x".Rokt.Widget/src/Rokt.tsx: added JSDoc topurchaseFinalized,initialize, andselectPlacementsso the guidance/warning surfaces on IDE hover and in the shipped.d.ts(root cause: the method had no JSDoc, so the partner's editor showed nothing).Rokt.Widget/README.md(the npm-published README): full rewrite to a concise, correct package README — removed theexecute()API (removed in v5), the fabricatedRuby 2.7.6requirement, and the dead M1brew uninstall/EXCLUDED_ARCHS=arm64block; links to the canonical repo guide plus the official React Native and CocoaPods setup docs.MIGRATING.md+ iOS sample (AppDelegate.swift,Podfile): renamedRoktStripePaymentExtension→RoktPaymentExtension.RNRoktWidgetModuleImpl.kt), so the statement is correct for the RN SDK.Screenshots/Video
Checklist
Additional Notes
munich-v2) and Android (sydney) SDKs, the sample apps, and CI config — not assumed.RoktSampleApp/README.md"Node.js (v14+)" (real min ≥18, CI 20); iOS pod major (5.x) vs Androidcom.rokt:roktsdk:6.0.2mismatch.Reference Issue
🤖 Generated with Claude Code