@teardown/react-native 2.0.28 → 2.0.30

package/README.md

@@ -112,7 +112,7 @@ import { useTeardown, useForceUpdate, useSession } from '@teardown/react-native'
 function YourComponent() {
   const { core } = useTeardown();
   const session = useSession();
-  const { status, isUpdateRequired } = useForceUpdate();
+  const { versionStatus, isUpdateRequired } = useForceUpdate();
 
   const handleLogin = async () => {
     await core.identity.identify({
@@ -129,14 +129,18 @@ function YourComponent() {
 
 ```tsx
 new TeardownCore({
-  org_id: string,           // Your organization ID
-  project_id: string,       // Your project ID
-  api_key: string,          // Your API key
-  storageAdapter: adapter,  // Storage implementation
-  deviceAdapter: adapter,   // Device info source
-  forceUpdate: {
-    throttleMs: 30_000,     // Min time between checks (default: 30s)
-    checkCooldownMs: 10_000 // Cooldown after check (default: 10s)
+  org_id: string,               // Your organization ID
+  project_id: string,           // Your project ID
+  api_key: string,              // Your API key
+  environment_slug?: string,    // Environment slug (default: "production")
+  ingestUrl?: string,           // Custom ingest API URL (optional)
+  storageAdapter: adapter,      // Storage implementation
+  deviceAdapter: adapter,       // Device info source
+  notificationAdapter?: adapter, // Push notification adapter (optional)
+  forceUpdate?: {
+    checkIntervalMs?: number,   // Min time between checks (default: 300000ms/5min)
+    checkOnForeground?: boolean, // Check on app foreground (default: true)
+    identifyAnonymousDevice?: boolean, // Check even when not identified (default: false)
   },
 });
 ```
@@ -156,16 +160,15 @@ For detailed guides, visit **[teardown.dev/docs](https://teardown.dev/docs)**
 
 Local documentation is also available in the [docs](./docs) folder:
 
-- [Getting Started](./docs/01-getting-started.mdx)
-- [Core Concepts](./docs/02-core-concepts.mdx)
-- [Identity & Authentication](./docs/03-identity.mdx)
-- [Force Updates](./docs/04-force-updates.mdx)
-- [Device Information](./docs/05-device-info.mdx)
-- [Storage](./docs/06-storage.mdx)
-- [Logging](./docs/07-logging.mdx)
-- [API Reference](./docs/08-api-reference.mdx)
-- [Hooks Reference](./docs/09-hooks-reference.mdx)
-- [Advanced Usage](./docs/10-advanced.mdx)
+- [Getting Started](./docs/getting-started.mdx)
+- [Core Concepts](./docs/core-concepts.mdx)
+- [Identity & Authentication](./docs/identity.mdx)
+- [Force Updates](./docs/force-updates.mdx)
+- [Logging](./docs/logging.mdx)
+- [API Reference](./docs/api-reference.mdx)
+- [Hooks Reference](./docs/hooks-reference.mdx)
+- [Advanced Usage](./docs/advanced.mdx)
+- [Adapters](./docs/adapters/index.mdx)
 
 ## License
 

package/docs/adapters/device/basic.mdx

@@ -33,17 +33,17 @@ The BasicAdapter returns static or minimal information:
 
 ### Application Info
 - `version` - Static value or from app.json
-- `buildNumber` - Static value
-- `bundleId` - Static value or from app.json
+- `build_number` - Static value (as number)
 
 ### Hardware Info
-- `deviceName` - "Unknown Device"
-- `brand` - "Unknown"
-- `deviceType` - "unknown"
+- `device_name` - "Unknown Device"
+- `device_brand` - "Unknown"
+- `device_type` - "unknown"
 
 ### OS Info
-- `osName` - From React Native Platform API
-- `osVersion` - From React Native Platform API
+- `platform` - From React Native `Platform.OS` mapped to `DevicePlatformEnum`
+- `name` - From React Native Platform API
+- `version` - From React Native Platform API
 
 ## When to Use
 

package/docs/adapters/device/device-info.mdx

@@ -44,17 +44,17 @@ import { DeviceInfoAdapter } from '@teardown/react-native/adapters/device-info';
 
 ### Application Info
 - `version` - From `getVersion()`
-- `buildNumber` - From `getBuildNumber()`
-- `bundleId` - From `getBundleId()`
+- `build_number` - From `getBuildNumber()` (as number)
 
 ### Hardware Info
-- `deviceName` - From `getDeviceName()`
-- `brand` - From `getBrand()`
-- `deviceType` - From `getDeviceType()` (phone, tablet, desktop, tv, unknown)
+- `device_name` - From `getDeviceName()`
+- `device_brand` - From `getBrand()`
+- `device_type` - From `getDeviceType()` (phone, tablet, desktop, tv, unknown)
 
 ### OS Info
-- `osName` - From `getSystemName()`
-- `osVersion` - From `getSystemVersion()`
+- `platform` - Mapped from React Native `Platform.OS` to `DevicePlatformEnum`
+- `name` - From `getSystemName()`
+- `version` - From `getSystemVersion()`
 
 ## When to Use
 
@@ -64,7 +64,7 @@ import { DeviceInfoAdapter } from '@teardown/react-native/adapters/device-info';
 
 ## Requirements
 
-- `react-native-device-info` >= 10.0.0
+- `react-native-device-info` >= 15.0.0
 - React Native >= 0.60 (autolinking)
 
 ## Platform Notes

package/docs/adapters/device/expo.mdx

@@ -37,25 +37,25 @@ import { ExpoDeviceAdapter } from '@teardown/react-native/adapters/expo';
 
 ### Application Info
 - `version` - From `expo-application` `nativeApplicationVersion`
-- `buildNumber` - From `expo-application` `nativeBuildVersion`
-- `bundleId` - From `expo-application` `applicationId`
+- `build_number` - From `expo-application` `nativeBuildVersion` (as number)
 
 ### Hardware Info
-- `deviceName` - From `expo-device` `deviceName`
-- `brand` - From `expo-device` `brand`
-- `deviceType` - From `expo-device` `deviceType` (phone, tablet, desktop, tv, unknown)
+- `device_name` - From `expo-device` `deviceName`
+- `device_brand` - From `expo-device` `brand`
+- `device_type` - From `expo-device` `deviceType` (phone, tablet, desktop, tv, unknown)
 
 ### OS Info
-- `osName` - From `expo-device` `osName`
-- `osVersion` - From `expo-device` `osVersion`
+- `platform` - Mapped from React Native `Platform.OS` to `DevicePlatformEnum`
+- `name` - From `expo-device` `osName`
+- `version` - From `expo-device` `osVersion`
 
 ## When to Use
 
 - Expo managed workflow projects
 - Expo bare workflow projects using Expo modules
-- Projects using Expo SDK 44+
+- Projects using Expo SDK 50+
 
 ## Requirements
 
-- `expo-device` >= 4.0.0
-- `expo-application` >= 4.0.0
+- `expo-device` >= 8.0.0
+- `expo-application` >= 7.0.0

package/docs/adapters/device/index.mdx

@@ -22,9 +22,8 @@ All device adapters provide:
 
 ```typescript
 interface ApplicationInfo {
-  version: string;      // App version (e.g., "1.2.3")
-  buildNumber: string;  // Build number (e.g., "45")
-  bundleId: string;     // Bundle identifier (e.g., "com.example.app")
+  version: string;       // App version (e.g., "1.2.3")
+  build_number: number;  // Build number (e.g., 45)
 }
 ```
 
@@ -32,9 +31,9 @@ interface ApplicationInfo {
 
 ```typescript
 interface HardwareInfo {
-  deviceName: string;   // Device name (e.g., "iPhone 14 Pro")
-  brand: string;        // Manufacturer (e.g., "Apple")
-  deviceType: string;   // Device type (e.g., "phone", "tablet")
+  device_name: string;   // Device name (e.g., "iPhone 14 Pro")
+  device_brand: string;  // Manufacturer (e.g., "Apple")
+  device_type: string;   // Device type (e.g., "phone", "tablet")
 }
 ```
 
@@ -42,8 +41,23 @@ interface HardwareInfo {
 
 ```typescript
 interface OSInfo {
-  osName: string;       // OS name (e.g., "iOS", "Android")
-  osVersion: string;    // OS version (e.g., "17.0")
+  platform: DevicePlatformEnum;  // Platform enum (IOS, ANDROID, etc.)
+  name: string;                   // OS name (e.g., "iOS", "Android")
+  version: string;                // OS version (e.g., "17.0")
+}
+```
+
+### DevicePlatformEnum
+
+```typescript
+enum DevicePlatformEnum {
+  IOS = "IOS",
+  ANDROID = "ANDROID",
+  WEB = "WEB",
+  WINDOWS = "WINDOWS",
+  MACOS = "MACOS",
+  LINUX = "LINUX",
+  UNKNOWN = "UNKNOWN",
 }
 ```
 
@@ -52,10 +66,14 @@ interface OSInfo {
 ```typescript
 import { TeardownCore } from '@teardown/react-native';
 import { ExpoDeviceAdapter } from '@teardown/react-native/adapters/expo';
+import { MMKVStorageAdapter } from '@teardown/react-native/adapters/mmkv';
 
 const teardown = new TeardownCore({
+  org_id: 'your-org-id',
+  project_id: 'your-project-id',
+  api_key: 'your-api-key',
+  storageAdapter: new MMKVStorageAdapter(),
   deviceAdapter: new ExpoDeviceAdapter(),
-  // ... other options
 });
 ```
 
@@ -68,34 +86,47 @@ const deviceId = await core.device.getDeviceId();
 // Returns a UUID that persists in storage
 ```
 
+To reset the device ID (device will appear as new install):
+
+```typescript
+core.device.reset();
+// Next getDeviceId() call will generate a new ID
+```
+
 ## Custom Adapter
 
-Implement the `DeviceInfoAdapter` interface:
+Extend the `DeviceInfoAdapter` abstract class:
 
 ```typescript
-import type { DeviceInfoAdapter, ApplicationInfo, HardwareInfo, OSInfo } from '@teardown/react-native';
-
-class CustomDeviceAdapter implements DeviceInfoAdapter {
+import {
+  DeviceInfoAdapter,
+  DevicePlatformEnum,
+  type ApplicationInfo,
+  type HardwareInfo,
+  type OSInfo,
+} from '@teardown/react-native';
+
+class CustomDeviceAdapter extends DeviceInfoAdapter {
   get applicationInfo(): ApplicationInfo {
     return {
       version: '1.0.0',
-      buildNumber: '1',
-      bundleId: 'com.example.app',
+      build_number: 1,
     };
   }
 
   get hardwareInfo(): HardwareInfo {
     return {
-      deviceName: 'Custom Device',
-      brand: 'Custom',
-      deviceType: 'phone',
+      device_name: 'Custom Device',
+      device_brand: 'Custom',
+      device_type: 'phone',
     };
   }
 
   get osInfo(): OSInfo {
     return {
-      osName: 'iOS',
-      osVersion: '17.0',
+      platform: DevicePlatformEnum.IOS,
+      name: 'iOS',
+      version: '17.0',
     };
   }
 }

package/docs/adapters/notifications/expo.mdx

@@ -14,74 +14,104 @@ npx expo install expo-notifications expo-device expo-constants
 ## Usage
 
 ```typescript
-import { ExpoNotificationsAdapter } from '@teardown/react-native/expo-notifications';
-
-const notifications = new ExpoNotificationsAdapter();
-
-// Request permissions
-const granted = await notifications.requestPermissions();
+import { TeardownCore } from '@teardown/react-native';
+import { ExpoNotificationsAdapter } from '@teardown/react-native/expo';
+import { ExpoDeviceAdapter } from '@teardown/react-native/adapters/expo';
+import { MMKVStorageAdapter } from '@teardown/react-native/adapters/mmkv';
+
+const teardown = new TeardownCore({
+  org_id: 'your-org-id',
+  project_id: 'your-project-id',
+  api_key: 'your-api-key',
+  storageAdapter: new MMKVStorageAdapter(),
+  deviceAdapter: new ExpoDeviceAdapter(),
+  notificationAdapter: new ExpoNotificationsAdapter(),
+});
 
-if (granted) {
-  // Get push token
-  const token = await notifications.getToken();
-  console.log('Push token:', token);
+// Access via NotificationsClient
+if (teardown.notifications) {
+  const status = await teardown.notifications.requestPermissions();
+  if (status.granted) {
+    const token = await teardown.notifications.getToken();
+    console.log('Expo push token:', token);
+  }
 }
 ```
 
 ## Import Path
 
 ```typescript
-import { ExpoNotificationsAdapter } from '@teardown/react-native/expo-notifications';
+import { ExpoNotificationsAdapter } from '@teardown/react-native/expo';
 ```
 
 ## API
 
+All methods are accessed via `NotificationsClient`, not directly on the adapter.
+
+### requestPermissions()
+
+Request notification permissions:
+
+```typescript
+const status = await teardown.notifications.requestPermissions();
+// Returns: { granted: boolean, canAskAgain: boolean }
+```
+
 ### getToken()
 
 Get the Expo push token:
 
 ```typescript
-const token = await notifications.getToken();
+const token = await teardown.notifications.getToken();
 // Returns: "ExponentPushToken[xxxxxx]" or null
 ```
 
-### requestPermissions()
+### onNotificationReceived()
 
-Request notification permissions:
+Subscribe to foreground notifications:
 
 ```typescript
-const granted = await notifications.requestPermissions();
-// Returns: true if granted, false otherwise
+const unsubscribe = teardown.notifications.onNotificationReceived((notification) => {
+  console.log('Received:', notification.title);
+});
+
+// Cleanup
+unsubscribe();
 ```
 
-### isEnabled()
+### onNotificationOpened()
 
-Check if notifications are enabled:
+Subscribe to notification taps:
 
 ```typescript
-const enabled = await notifications.isEnabled();
+const unsubscribe = teardown.notifications.onNotificationOpened((notification) => {
+  console.log('User tapped:', notification.title);
+});
+
+// Cleanup
+unsubscribe();
 ```
 
-### onNotification()
+### onTokenRefresh()
 
-Subscribe to incoming notifications while app is foregrounded:
+Subscribe to token changes:
 
 ```typescript
-const unsubscribe = notifications.onNotification((notification) => {
-  console.log('Received:', notification.title);
+const unsubscribe = teardown.notifications.onTokenChange((token) => {
+  console.log('New token:', token);
 });
 
 // Cleanup
 unsubscribe();
 ```
 
-### onNotificationResponse()
+### onDataMessage()
 
-Subscribe to notification responses (user taps):
+Subscribe to data-only/silent messages:
 
 ```typescript
-const unsubscribe = notifications.onNotificationResponse((response) => {
-  console.log('User tapped notification:', response.notification.title);
+const unsubscribe = teardown.notifications.onDataMessage((message) => {
+  console.log('Data message:', message.data);
 });
 
 // Cleanup
@@ -119,9 +149,13 @@ Push notifications require:
 - Push notification capability
 - APNs certificate or key
 
+## Platform
+
+Returns `NotificationPlatformEnum.EXPO`
+
 ## Requirements
 
-- `expo-notifications` >= 0.17.0
-- `expo-device` >= 4.0.0
-- `expo-constants` >= 13.0.0
+- `expo-notifications` >= 0.32
+- `expo-device` >= 8.0.0
+- `expo-constants` >= 17.0.0
 - EAS Build or dev client (not Expo Go)

package/docs/adapters/notifications/firebase.mdx

@@ -21,74 +21,104 @@ cd ios && pod install
 ## Usage
 
 ```typescript
-import { FirebaseMessagingAdapter } from '@teardown/react-native/firebase-messaging';
-
-const notifications = new FirebaseMessagingAdapter();
-
-// Request permissions (iOS)
-const granted = await notifications.requestPermissions();
+import { TeardownCore } from '@teardown/react-native';
+import { FirebaseMessagingAdapter } from '@teardown/react-native/firebase';
+import { DeviceInfoAdapter } from '@teardown/react-native/adapters/device-info';
+import { AsyncStorageAdapter } from '@teardown/react-native/adapters/async-storage';
+
+const teardown = new TeardownCore({
+  org_id: 'your-org-id',
+  project_id: 'your-project-id',
+  api_key: 'your-api-key',
+  storageAdapter: new AsyncStorageAdapter(),
+  deviceAdapter: new DeviceInfoAdapter(),
+  notificationAdapter: new FirebaseMessagingAdapter(),
+});
 
-if (granted) {
-  // Get FCM token
-  const token = await notifications.getToken();
-  console.log('FCM token:', token);
+// Access via NotificationsClient
+if (teardown.notifications) {
+  const status = await teardown.notifications.requestPermissions();
+  if (status.granted) {
+    const token = await teardown.notifications.getToken();
+    console.log('FCM token:', token);
+  }
 }
 ```
 
 ## Import Path
 
 ```typescript
-import { FirebaseMessagingAdapter } from '@teardown/react-native/firebase-messaging';
+import { FirebaseMessagingAdapter } from '@teardown/react-native/firebase';
 ```
 
 ## API
 
+All methods are accessed via `NotificationsClient`, not directly on the adapter.
+
+### requestPermissions()
+
+Request notification permissions (required on iOS):
+
+```typescript
+const status = await teardown.notifications.requestPermissions();
+// Returns: { granted: boolean, canAskAgain: boolean }
+```
+
 ### getToken()
 
 Get the FCM registration token:
 
 ```typescript
-const token = await notifications.getToken();
+const token = await teardown.notifications.getToken();
 // Returns: FCM token string or null
 ```
 
-### requestPermissions()
+### onNotificationReceived()
 
-Request notification permissions (required on iOS):
+Subscribe to foreground notifications:
 
 ```typescript
-const granted = await notifications.requestPermissions();
-// Returns: true if granted, false otherwise
+const unsubscribe = teardown.notifications.onNotificationReceived((notification) => {
+  console.log('Received:', notification.title);
+});
+
+// Cleanup
+unsubscribe();
 ```
 
-### isEnabled()
+### onNotificationOpened()
 
-Check if notifications are enabled:
+Subscribe to notification taps:
 
 ```typescript
-const enabled = await notifications.isEnabled();
+const unsubscribe = teardown.notifications.onNotificationOpened((notification) => {
+  console.log('User tapped:', notification.title);
+});
+
+// Cleanup
+unsubscribe();
 ```
 
-### onNotification()
+### onTokenRefresh()
 
-Subscribe to incoming notifications:
+Subscribe to token changes:
 
 ```typescript
-const unsubscribe = notifications.onNotification((notification) => {
-  console.log('Received:', notification.title);
+const unsubscribe = teardown.notifications.onTokenChange((token) => {
+  console.log('New FCM token:', token);
 });
 
 // Cleanup
 unsubscribe();
 ```
 
-### onNotificationResponse()
+### onDataMessage()
 
-Subscribe to notification opens:
+Subscribe to data-only messages (silent push):
 
 ```typescript
-const unsubscribe = notifications.onNotificationResponse((response) => {
-  console.log('User tapped:', response.notification.title);
+const unsubscribe = teardown.notifications.onDataMessage((message) => {
+  console.log('Data message:', message.data);
 });
 
 // Cleanup
@@ -135,6 +165,10 @@ messaging().setBackgroundMessageHandler(async (remoteMessage) => {
 });
 ```
 
+## Platform
+
+Returns `NotificationPlatformEnum.FCM`
+
 ## Requirements
 
 - `@react-native-firebase/app` >= 18.0.0