rn-prodeeplinks 0.0.2 → 0.0.4

package/README.md

@@ -4,7 +4,7 @@
 
 > ⚠️ **License Required**: This package requires a valid license key purchased from our portal. Without a license key, the package will not function.
 
-> ℹ️ **Versioning**: Current version is 0.0.1 (in-progress). It will move to 1.x after stable.
+> ℹ️ **Versioning**: Current version is 0.0.4 (in-progress). It will move to 1.x after stable.
 
 ## Features
 
@@ -137,12 +137,14 @@ This SDK can optionally send deep link analytics events to our tracking service.
 - When a deep link is opened via React Native `Linking.getInitialURL()`, the SDK:
   - Resolves the URL
   - Collects device fingerprint data
-  - Sends an internal tracking event named `pro_track` with the resolved short URL and fingerprint
+  - Sends an internal analytics event with the resolved short URL and fingerprint
 - When a deep link is resolved via the fingerprint API, the SDK:
   - Resolves the URL from the server
-  - Sends the same `pro_track` event with the short URL and fingerprint
+  - Sends the same internal analytics event with the short URL and fingerprint
 
-You can also send custom tracking events manually:
+These internal events are handled by the SDK and are not part of the public API.
+
+You can also send custom tracking events manually after calling `init`:
 
 ```typescript
 import {
@@ -151,20 +153,22 @@ import {
 } from 'rn-prodeeplinks';
 
 const event: CustomDeepLinkAnalyticsEvent = {
-  licenseKey: 'your-license-key',
   eventType: 'deeplink',
-  eventName: 'pro_track',
+  eventName: 'my_custom_event',
   category: 'custom',
   action: 'open',
   label: 'My custom event',
   properties: {
     shortUrl: 'https://your-short-url',
+    foo: 'bar',
   },
 };
 
 await trackAnalyticsEvent(event);
 ```
 
+The license key provided to `init` is automatically included in the request headers. You do not need to include the license key in the analytics event payload.
+
 ## API Reference
 
 ### Functions
@@ -217,6 +221,26 @@ getDeepLink((url) => {
 });
 ```
 
+#### `trackAnalyticsEvent(event: CustomDeepLinkAnalyticsEvent): Promise<any>`
+
+Sends a custom analytics event to the tracking service.
+
+`init()` must be called successfully first; the stored license key from `init` is sent in the request headers.
+
+**Parameters:**
+- `event` (CustomDeepLinkAnalyticsEvent, required): Event describing what happened. You can use any `eventName` and add any custom properties.
+
+**Example:**
+```typescript
+await trackAnalyticsEvent({
+  eventType: 'deeplink',
+  eventName: 'button_click',
+  properties: {
+    buttonId: 'cta_start',
+  },
+});
+```
+
 #### `isReady(): boolean`
 
 Checks if the package has been initialized with a license key.

package/lib/api.js

@@ -26,7 +26,7 @@ async function fetchDeepLinkUrl(licenseKey, fingerprint, apiEndpoint, timeout =
             };
         }
         const PACKAGE_NAME = 'react-native-pro-deeplink';
-        const PACKAGE_VERSION = '0.0.2';
+        const PACKAGE_VERSION = '0.0.4';
         const payload = {
             licenseKey,
             fingerprint: fingerprint,
@@ -39,7 +39,7 @@ async function fetchDeepLinkUrl(licenseKey, fingerprint, apiEndpoint, timeout =
         const timeoutId = setTimeout(() => controller.abort(), timeout);
         try {
             const PACKAGE_NAME = 'react-native-pro-deeplink';
-            const PACKAGE_VERSION = '0.0.2';
+            const PACKAGE_VERSION = '0.0.4';
             const response = await fetch(endpoint, {
                 method: 'POST',
                 headers: {
@@ -60,12 +60,22 @@ async function fetchDeepLinkUrl(licenseKey, fingerprint, apiEndpoint, timeout =
                 };
             }
             const data = await response.json();
-            if (data.success && data.url) {
-                return {
-                    success: true,
-                    url: data.url,
-                    message: data.message,
-                };
+            if (data.success) {
+                if (data.url) {
+                    return {
+                        success: true,
+                        url: data.url,
+                        message: data.message,
+                    };
+                }
+                else {
+                    // Success true but no URL means no match found - this is not an error
+                    return {
+                        success: true,
+                        url: null,
+                        message: data.message || 'No deep link available',
+                    };
+                }
             }
             else {
                 return {

package/lib/fingerprint.js

@@ -26,8 +26,10 @@ async function generateDeviceFingerprint() {
         const isRooted = react_native_1.Platform.OS === 'android'
             ? (await (react_native_device_info_1.default.isDeviceRooted?.() ?? false))
             : false;
-        // Get locale info
-        const locale = react_native_device_info_1.default.getDeviceLocale?.() || Intl.DateTimeFormat().resolvedOptions().locale;
+        const deviceLocales = react_native_device_info_1.default.getDeviceLocales?.();
+        const primaryLocale = Array.isArray(deviceLocales) && deviceLocales.length > 0 ? deviceLocales[0] : undefined;
+        const legacyLocale = react_native_device_info_1.default.getDeviceLocale?.();
+        const locale = (primaryLocale || legacyLocale || Intl.DateTimeFormat().resolvedOptions().locale) || 'en';
         const language = (locale || '').split('-')[0] || 'en';
         const timezone = Intl.DateTimeFormat().resolvedOptions().timeZone;
         // Get network info

package/lib/index.js

@@ -142,7 +142,8 @@ async function getDeepLink(callback) {
             callback(result.url);
         }
         // If API didn't return a usable URL, return null as per requirements
-        if (!result.success || !result.url) {
+        // But if success is false, propagate the error
+        if (result.success && !result.url) {
             return { success: true, url: null, message: 'No deep link available' };
         }
         return result;
@@ -170,8 +171,14 @@ function reset() {
     isInitialized = false;
 }
 async function trackAnalyticsEvent(event) {
-    const licenseKey = storedLicenseKey;
-    return (0, api_1.trackCustomDeepLinkEvent)(event, licenseKey || undefined);
+    if (!isInitialized || !storedLicenseKey) {
+        return {
+            success: false,
+            error: 'Please call init() first with your license key',
+        };
+    }
+    const { licenseKey: _ignored, ...payload } = event;
+    return (0, api_1.trackCustomDeepLinkEvent)(payload, storedLicenseKey);
 }
 // Keep backward compatibility - export class for advanced users (optional)
 class ProDeepLink {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rn-prodeeplinks",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "Secure deep linking package with license key validation and device fingerprinting for React Native",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",