@openpanel/react-native 1.0.4 → 1.0.5

package/README.md

@@ -0,0 +1,115 @@
+# React Native
+
+> 📖 **Full documentation:** [https://openpanel.dev/docs/sdks/react-native](https://openpanel.dev/docs/sdks/react-native)
+
+---
+
+Looking for a step-by-step tutorial? Check out the [React Native analytics guide](https://openpanel.dev/guides/react-native-analytics).
+
+## Installation
+
+### Install dependencies
+
+We're dependent on `expo-application` for `buildNumber`, `versionNumber` (and `referrer` on android) and `expo-constants` to get the `user-agent`.
+
+```npm
+npm install @openpanel/react-native
+npx expo install expo-application expo-constants
+```
+
+### Initialize
+
+On native we use a clientSecret to authenticate the app.
+
+```typescript
+const op = new Openpanel({
+  clientId: '{YOUR_CLIENT_ID}',
+  clientSecret: '{YOUR_CLIENT_SECRET}',
+});
+```
+
+#### Options
+
+##### Common options
+
+- `apiUrl` - The url of the openpanel API or your self-hosted instance
+- `clientId` - The client id of your application
+- `clientSecret` - The client secret of your application (**only required for server-side events**)
+- `filter` - A function that will be called before sending an event. If it returns false, the event will not be sent
+- `disabled` - If true, the library will not send any events
+
+## Usage
+
+### Track event
+
+```typescript
+op.track('my_event', { foo: 'bar' });
+```
+
+### Navigation / Screen views
+
+  
+#### expo-router
+
+```typescript
+    import { usePathname, useSegments } from 'expo-router';
+
+    const op = new Openpanel({ /* ... */ })
+
+    function RootLayout() {
+      // ...
+      const pathname = usePathname()
+      // Segments is optional but can be nice to have if you
+      // want to group routes together
+      // pathname = /posts/123
+      // segements = ['posts', '[id]']
+      const segments = useSegments()
+
+      useEffect(() => {
+        // Simple
+        op.screenView(pathname)
+
+        // With extra data
+        op.screenView(pathname, {
+          // segments is optional but nice to have
+          segments: segments.join('/'),
+          // other optional data you want to send with the screen view
+        })
+      }, [pathname,segments])
+      // ...
+    }
+    ```
+
+  
+#### react-navigation (simple)
+
+```tsx
+      import { createNavigationContainerRef } from '@react-navigation/native'
+      import { Openpanel } from '@openpanel/react-native'
+
+      const op = new Openpanel({ /* ... */ })
+      const navigationRef = createNavigationContainerRef()
+
+      export function NavigationRoot() {
+        const handleNavigationStateChange = () => {
+          const current = navigationRef.getCurrentRoute()
+          if (current) {
+            op.screenView(current.name, {
+              params: current.params,
+            })
+          }
+        }
+
+        return (
+          <NavigationContainer
+            ref={navigationRef}
+            onReady={handleNavigationStateChange}
+            onStateChange={handleNavigationStateChange}
+          >
+            <Stack.Navigator />
+          </NavigationContainer>
+        )
+      }
+    ```
+
+For more information on how to use the SDK, check out the [Javascript SDK](https://openpanel.dev/docs/sdks/javascript#usage).

package/dist/index.cjs

@@ -1 +1 @@
-"use strict";var A=Object.create;var c=Object.defineProperty;var _=Object.getOwnPropertyDescriptor;var v=Object.getOwnPropertyNames;var P=Object.getPrototypeOf,O=Object.prototype.hasOwnProperty;var V=(e,t)=>{for(var r in t)c(e,r,{get:t[r],enumerable:!0})},o=(e,t,r,n)=>{if(t&&typeof t=="object"||typeof t=="function")for(let a of v(t))!O.call(e,a)&&a!==r&&c(e,a,{get:()=>t[a],enumerable:!(n=_(t,a))||n.enumerable});return e},s=(e,t,r)=>(o(e,t,"default"),r&&o(r,t,"default")),f=(e,t,r)=>(r=e!=null?A(P(e)):{},o(t||!e||!e.__esModule?c(r,"default",{value:e,enumerable:!0}):r,e)),b=e=>o(c({},"__esModule",{value:!0}),e);var i={};V(i,{OpenPanel:()=>d});module.exports=b(i);var p=f(require("expo-application"),1),m=f(require("expo-constants"),1),l=require("react-native"),u=require("@openpanel/sdk");s(i,require("@openpanel/sdk"),module.exports);var d=class extends u.OpenPanel{constructor(r){super({...r,sdk:"react-native",sdkVersion:"1.0.4"});this.options=r;this.api.addHeader("User-Agent",m.default.getWebViewUserAgentAsync()),l.AppState.addEventListener("change",n=>{n==="active"&&this.setDefaultProperties()}),this.setDefaultProperties()}async setDefaultProperties(){this.setGlobalProperties({__version:p.nativeApplicationVersion,__buildNumber:p.nativeBuildVersion,__referrer:l.Platform.OS==="android"?await p.getInstallReferrerAsync():void 0})}screenView(r,n){super.track("screen_view",{...n,__path:r})}};0&&(module.exports={OpenPanel,...require("@openpanel/sdk")});
+"use strict";var A=Object.create;var c=Object.defineProperty;var _=Object.getOwnPropertyDescriptor;var v=Object.getOwnPropertyNames;var P=Object.getPrototypeOf,O=Object.prototype.hasOwnProperty;var V=(e,t)=>{for(var r in t)c(e,r,{get:t[r],enumerable:!0})},o=(e,t,r,n)=>{if(t&&typeof t=="object"||typeof t=="function")for(let a of v(t))!O.call(e,a)&&a!==r&&c(e,a,{get:()=>t[a],enumerable:!(n=_(t,a))||n.enumerable});return e},s=(e,t,r)=>(o(e,t,"default"),r&&o(r,t,"default")),f=(e,t,r)=>(r=e!=null?A(P(e)):{},o(t||!e||!e.__esModule?c(r,"default",{value:e,enumerable:!0}):r,e)),b=e=>o(c({},"__esModule",{value:!0}),e);var i={};V(i,{OpenPanel:()=>d});module.exports=b(i);var p=f(require("expo-application"),1),m=f(require("expo-constants"),1),l=require("react-native"),u=require("@openpanel/sdk");s(i,require("@openpanel/sdk"),module.exports);var d=class extends u.OpenPanel{constructor(r){super({...r,sdk:"react-native",sdkVersion:"1.0.5"});this.options=r;this.api.addHeader("User-Agent",m.default.getWebViewUserAgentAsync()),l.AppState.addEventListener("change",n=>{n==="active"&&this.setDefaultProperties()}),this.setDefaultProperties()}async setDefaultProperties(){this.setGlobalProperties({__version:p.nativeApplicationVersion,__buildNumber:p.nativeBuildVersion,__referrer:l.Platform.OS==="android"?await p.getInstallReferrerAsync():void 0})}screenView(r,n){super.track("screen_view",{...n,__path:r})}};0&&(module.exports={OpenPanel,...require("@openpanel/sdk")});

package/dist/index.js

@@ -1 +1 @@
-import*as e from"expo-application";import s from"expo-constants";import{AppState as n,Platform as p}from"react-native";import{OpenPanel as a}from"@openpanel/sdk";export*from"@openpanel/sdk";var i=class extends a{constructor(t){super({...t,sdk:"react-native",sdkVersion:"1.0.4"});this.options=t;this.api.addHeader("User-Agent",s.getWebViewUserAgentAsync()),n.addEventListener("change",r=>{r==="active"&&this.setDefaultProperties()}),this.setDefaultProperties()}async setDefaultProperties(){this.setGlobalProperties({__version:e.nativeApplicationVersion,__buildNumber:e.nativeBuildVersion,__referrer:p.OS==="android"?await e.getInstallReferrerAsync():void 0})}screenView(t,r){super.track("screen_view",{...r,__path:t})}};export{i as OpenPanel};
+import*as e from"expo-application";import s from"expo-constants";import{AppState as n,Platform as p}from"react-native";import{OpenPanel as a}from"@openpanel/sdk";export*from"@openpanel/sdk";var i=class extends a{constructor(t){super({...t,sdk:"react-native",sdkVersion:"1.0.5"});this.options=t;this.api.addHeader("User-Agent",s.getWebViewUserAgentAsync()),n.addEventListener("change",r=>{r==="active"&&this.setDefaultProperties()}),this.setDefaultProperties()}async setDefaultProperties(){this.setGlobalProperties({__version:e.nativeApplicationVersion,__buildNumber:e.nativeBuildVersion,__referrer:p.OS==="android"?await e.getInstallReferrerAsync():void 0})}screenView(t,r){super.track("screen_view",{...r,__path:t})}};export{i as OpenPanel};

package/package.json

@@ -1,13 +1,16 @@
 {
   "name": "@openpanel/react-native",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "module": "./dist/index.js",
+  "config": {
+    "docPath": "apps/public/content/docs/(tracking)/sdks/react-native.mdx"
+  },
   "scripts": {
     "build": "rm -rf dist && tsup",
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@openpanel/sdk": "1.0.3"
+    "@openpanel/sdk": "1.0.4"
   },
   "devDependencies": {
     "@openpanel/tsconfig": "workspace:*",
@@ -24,7 +27,7 @@
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
-  "files": ["dist"],
+  "files": ["dist", "README.md"],
   "exports": {
     ".": {
       "import": "./dist/index.js",