Feature/sdks and docs #239
Merged
Conversation
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
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
|
Caution Review failedThe pull request is closed. WalkthroughThe PR implements a Proxy-based window.op initialization pattern across multiple SDKs, adds comprehensive tracking and onboarding documentation, bumps SDK versions, consolidates TypeScript configurations to a unified SDK schema, and refines the web SDK's type system with new API shapes and validation tests. Changes
Sequence Diagram(s)sequenceDiagram
participant App as App/Page
participant Proxy as window.op<br/>(Proxy Handler)
participant Queue as Internal Queue<br/>(Array)
App->>Proxy: window.op('track', 'click')
activate Proxy
Proxy->>Queue: Push ['track', 'click']
deactivate Proxy
App->>Proxy: window.op.q
activate Proxy
Note over Proxy: get trap: "q" property
Proxy-->>App: Return Queue array
deactivate Proxy
App->>Proxy: window.op.identify({ id: '123' })
activate Proxy
Note over Proxy: get trap: retrieve bound function
Proxy->>Queue: Push ['identify', { id: '123' }]
deactivate Proxy
sequenceDiagram
participant SDK as Framework SDK<br/>(Next.js/Astro)
participant getInitSnippet as getInitSnippet()<br/>Function
participant Script as Script Output
SDK->>getInitSnippet: Call getInitSnippet()
activate getInitSnippet
getInitSnippet-->>SDK: Return minified Proxy init code
deactivate getInitSnippet
SDK->>Script: Prepend snippet + method bindings
activate Script
Note over Script: Combine init snippet with<br/>SDK-specific method setup
Script-->>SDK: Complete inline script
deactivate Script
Estimated code review effort🎯 4 (Complex) | ⏱️ ~50 minutes
Possibly related PRs
Poem
✨ Finishing touches
🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (36)
Tip 📝 Customizable high-level summaries are now available in beta!You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.
Example instruction:
Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later. 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. Comment |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 by CodeRabbit
New Features
Documentation
Chores
✏️ Tip: You can customize this high-level summary in your review settings.