@deeplinknow/react-native

React Native SDK for DeepLink Now - handle deferred deep linking in your React Native app.

Installation

1bun add @deeplinknow/react-native
2// or
3yarn add @deeplinknow/react-native
4// or
5npm install @deeplinknow/react-native

Usage

1import DeepLinkNow from "@deeplinknow/react-native";
2
3// Initialize the SDK
4DeepLinkNow.initialize("your-api-key");

API Reference

initialize(apiKey: string, config?: DeepLinkNowConfig)

Initializes the SDK with your API key and optional configuration.

1type DeepLinkNowConfig = {
2  enableLogs?: boolean; // Enable console logging for debugging
3  customDomain?: string; // Custom domain for API endpoints
4};
5
6// Example
7DeepLinkNow.initialize("your-api-key", {
8  enableLogs: true,
9});

findDeferredUser(): Promise<MatchResponse | null>

Attempts to find deferred deep link matches for the current user. Returns an array of matches sorted by confidence score.

1type MatchResponse = {
2  matches: Array<{
3    confidence_score: number;
4    match_details: {
5      ip_match: { matched: boolean; score: number };
6      device_match: {
7        matched: boolean;
8        score: number;
9        components: {
10          platform: boolean;
11          os_version: boolean;
12          device_model: boolean;
13          hardware_fingerprint: boolean;
14        };
15      };
16      time_proximity: {
17        score: number;
18        time_difference_minutes: number;
19      };
20      locale_match: {
21        matched: boolean;
22        score: number;
23        components: {
24          language: boolean;
25          timezone: boolean;
26        };
27      };
28    };
29    deeplink?: {
30      id: string;
31      target_url: string;
32      metadata: Record<string, any>;
33      campaign_id?: string;
34      matched_at: string;
35      expires_at: string;
36    };
37  }>;
38  ttl_seconds: number;
39};
40
41// Example
42const response = await DeepLinkNow.findDeferredUser();
43if (response?.matches.length > 0) {
44  const bestMatch = response.matches[0];
45  console.log("Confidence score:", bestMatch.confidence_score);
46  console.log("Target URL:", bestMatch.deeplink?.target_url);
47  console.log("Match details:", bestMatch.match_details);
48}

Confidence scores are categorized as:

• HIGH: 75+ (Strong match: Same IP, recent, matching device and locale)
• MEDIUM: 50-74 (Moderate match: Same IP, longer time gap or some mismatches)
• LOW: 25-49 (Weak match: Different IP but other factors match)

parseDeepLink(url: string): { path: string; parameters: Record<string, string> } | null

Parses a deep link URL if it's from a valid domain (deeplinknow.com or deeplink.now). Returns the path and parameters if valid, null otherwise.

1// Example
2const result = DeepLinkNow.parseDeepLink(
3  "https://deeplinknow.com/product/123?ref=email",
4);
5if (result) {
6  console.log("Path:", result.path); // "/product/123"
7  console.log("Parameters:", result.parameters); // { ref: "email" }
8}

Requirements

• React Native 0.60 or later

License

MIT