insert-affiliate-react-native-sdk 1.5.1 → 1.6.1

package/.claude/settings.local.json

@@ -0,0 +1,8 @@
+{
+  "permissions": {
+    "allow": [
+      "WebFetch(domain:github.com)"
+    ],
+    "deny": []
+  }
+}

package/dist/DeepLinkIapProvider.d.ts

@@ -16,6 +16,7 @@ type T_DEEPLINK_IAP_CONTEXT = {
     setShortCode: (shortCode: string) => Promise<void>;
     setInsertAffiliateIdentifier: (referringLink: string) => Promise<void | string>;
     initialize: (code: string | null, verboseLogging?: boolean) => Promise<void>;
+    fetchAndConditionallyOpenUrl: (affiliateIdentifier: string, offerCodeUrlId: string) => Promise<boolean>;
     isInitialized: boolean;
 };
 export declare const DeepLinkIapContext: React.Context<T_DEEPLINK_IAP_CONTEXT>;

package/dist/DeepLinkIapProvider.js

@@ -59,6 +59,7 @@ exports.DeepLinkIapContext = (0, react_1.createContext)({
     setShortCode: (shortCode) => __awaiter(void 0, void 0, void 0, function* () { }),
     setInsertAffiliateIdentifier: (referringLink) => __awaiter(void 0, void 0, void 0, function* () { }),
     initialize: (code, verboseLogging) => __awaiter(void 0, void 0, void 0, function* () { }),
+    fetchAndConditionallyOpenUrl: (affiliateIdentifier, offerCodeUrlId) => __awaiter(void 0, void 0, void 0, function* () { return false; }),
     isInitialized: false,
 });
 const DeepLinkIapProvider = ({ children, }) => {
@@ -529,6 +530,87 @@ const DeepLinkIapProvider = ({ children, }) => {
             return Promise.reject(error);
         }
     });
+    const fetchAndConditionallyOpenUrl = (affiliateIdentifier, offerCodeUrlId) => __awaiter(void 0, void 0, void 0, function* () {
+        try {
+            verboseLog(`Attempting to fetch and conditionally open URL for affiliate: ${affiliateIdentifier}, offerCodeUrlId: ${offerCodeUrlId}`);
+            if (react_native_1.Platform.OS !== 'ios') {
+                console.warn("[Insert Affiliate] Offer codes are only supported on iOS");
+                verboseLog("Offer codes are only supported on iOS");
+                return false;
+            }
+            const offerCode = yield fetchOfferCode(affiliateIdentifier);
+            if (offerCode && offerCode.length > 0) {
+                yield openRedeemURL(offerCode, offerCodeUrlId);
+                return true;
+            }
+            else {
+                verboseLog("No valid offer code found");
+                return false;
+            }
+        }
+        catch (error) {
+            console.error('[Insert Affiliate] Error fetching and opening offer code URL:', error);
+            verboseLog(`Error fetching and opening offer code URL: ${error}`);
+            return false;
+        }
+    });
+    const fetchOfferCode = (affiliateLink) => __awaiter(void 0, void 0, void 0, function* () {
+        try {
+            const encodedAffiliateLink = encodeURIComponent(affiliateLink);
+            const url = `https://api.insertaffiliate.com/v1/affiliateReturnOfferCode/${encodedAffiliateLink}`;
+            verboseLog(`Fetching offer code from: ${url}`);
+            const response = yield axios_1.default.get(url);
+            if (response.status === 200) {
+                const offerCode = response.data;
+                // Check for specific error strings from API
+                if (typeof offerCode === 'string' && (offerCode.includes("errorofferCodeNotFound") ||
+                    offerCode.includes("errorAffiliateoffercodenotfoundinanycompany") ||
+                    offerCode.includes("errorAffiliateoffercodenotfoundinanycompanyAffiliatelinkwas") ||
+                    offerCode.includes("Routenotfound"))) {
+                    console.warn(`[Insert Affiliate] Offer code not found or invalid: ${offerCode}`);
+                    verboseLog(`Offer code not found or invalid: ${offerCode}`);
+                    return null;
+                }
+                const cleanedOfferCode = cleanOfferCode(offerCode);
+                verboseLog(`Successfully fetched and cleaned offer code: ${cleanedOfferCode}`);
+                return cleanedOfferCode;
+            }
+            else {
+                console.error(`[Insert Affiliate] Failed to fetch offer code. Status code: ${response.status}, Response: ${JSON.stringify(response.data)}`);
+                verboseLog(`Failed to fetch offer code. Status code: ${response.status}, Response: ${JSON.stringify(response.data)}`);
+                return null;
+            }
+        }
+        catch (error) {
+            console.error('[Insert Affiliate] Error fetching offer code:', error);
+            verboseLog(`Error fetching offer code: ${error}`);
+            return null;
+        }
+    });
+    const openRedeemURL = (offerCode, offerCodeUrlId) => __awaiter(void 0, void 0, void 0, function* () {
+        try {
+            const redeemUrl = `https://apps.apple.com/redeem?ctx=offercodes&id=${offerCodeUrlId}&code=${offerCode}`;
+            verboseLog(`Opening redeem URL: ${redeemUrl}`);
+            const canOpen = yield react_native_1.Linking.canOpenURL(redeemUrl);
+            if (canOpen) {
+                yield react_native_1.Linking.openURL(redeemUrl);
+                console.log('[Insert Affiliate] Successfully opened redeem URL');
+                verboseLog('Successfully opened redeem URL');
+            }
+            else {
+                console.error(`[Insert Affiliate] Could not launch redeem URL: ${redeemUrl}`);
+                verboseLog(`Could not launch redeem URL: ${redeemUrl}`);
+            }
+        }
+        catch (error) {
+            console.error('[Insert Affiliate] Error opening redeem URL:', error);
+            verboseLog(`Error opening redeem URL: ${error}`);
+        }
+    });
+    const cleanOfferCode = (offerCode) => {
+        // Remove special characters, keep only alphanumeric
+        return offerCode.replace(/[^a-zA-Z0-9]/g, '');
+    };
     return (react_1.default.createElement(exports.DeepLinkIapContext.Provider, { value: {
             referrerLink,
             userId,
@@ -541,6 +623,7 @@ const DeepLinkIapProvider = ({ children, }) => {
             setInsertAffiliateIdentifier,
             initialize,
             isInitialized,
+            fetchAndConditionallyOpenUrl,
         } }, children));
 };
 exports.default = DeepLinkIapProvider;

package/dist/useDeepLinkIapProvider.d.ts

@@ -12,5 +12,6 @@ declare const useDeepLinkIapProvider: () => {
     setInsertAffiliateIdentifier: (referringLink: string) => Promise<void | string>;
     initialize: (code: string | null, verboseLogging?: boolean) => Promise<void>;
     isInitialized: boolean;
+    fetchAndConditionallyOpenUrl: (affiliateIdentifier: string, offerCodeUrlId: string) => Promise<boolean>;
 };
 export default useDeepLinkIapProvider;

package/dist/useDeepLinkIapProvider.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const react_1 = require("react");
 const DeepLinkIapProvider_1 = require("./DeepLinkIapProvider");
 const useDeepLinkIapProvider = () => {
-    const { referrerLink, userId, validatePurchaseWithIapticAPI, storeExpectedStoreTransaction, returnUserAccountTokenAndStoreExpectedTransaction, returnInsertAffiliateIdentifier, trackEvent, setShortCode, setInsertAffiliateIdentifier, initialize, isInitialized } = (0, react_1.useContext)(DeepLinkIapProvider_1.DeepLinkIapContext);
+    const { referrerLink, userId, validatePurchaseWithIapticAPI, storeExpectedStoreTransaction, returnUserAccountTokenAndStoreExpectedTransaction, returnInsertAffiliateIdentifier, trackEvent, setShortCode, setInsertAffiliateIdentifier, initialize, isInitialized, fetchAndConditionallyOpenUrl } = (0, react_1.useContext)(DeepLinkIapProvider_1.DeepLinkIapContext);
     return {
         referrerLink,
         userId,
@@ -15,7 +15,8 @@ const useDeepLinkIapProvider = () => {
         setShortCode,
         setInsertAffiliateIdentifier,
         initialize,
-        isInitialized
+        isInitialized,
+        fetchAndConditionallyOpenUrl
     };
 };
 exports.default = useDeepLinkIapProvider;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "insert-affiliate-react-native-sdk",
-  "version": "1.5.1",
+  "version": "1.6.1",
   "description": "A package for connecting with the Insert Affiliate Platform to add app based affiliate marketing.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/readme.md

@@ -498,7 +498,7 @@ At this stage, we cannot guarantee that this feature is fully resistant to tampe
 
 #### Using `trackEvent`
 
-To track an event, use the `trackEvent` function. Make sure to set an affiliate identifier first; otherwise, event tracking won’t work. Here’s an example:
+To track an event, use the `trackEvent` function. Make sure to set an affiliate identifier first; otherwise, event tracking won't work. Here's an example:
 
 ```javascript
 const {
@@ -520,7 +520,127 @@ const {
 />
 ```
 
-### 2. Short Codes (Beta)
+### 2. Offer Codes
+
+Offer Codes allow you to automatically present a discount to users who access an affiliate's link or enter a short code. This provides affiliates with a compelling incentive to promote your app, as discounts are automatically applied during the redemption flow [(learn more)](https://docs.insertaffiliate.com/offer-codes). 
+
+**Note: Offer Codes are currently only supported on iOS.**
+
+You'll need your Offer Code URL ID, which can be created and retrieved from App Store Connect. Instructions to retrieve your Offer Code URL ID are available [here](https://docs.insertaffiliate.com/offer-codes#create-the-codes-within-app-store-connect).
+
+To fetch an Offer Code and conditionally redirect the user to redeem it, pass the affiliate identifier (deep link or short code) to:
+
+```javascript
+const { fetchAndConditionallyOpenUrl } = useDeepLinkIapProvider();
+
+await fetchAndConditionallyOpenUrl("your_affiliate_identifier", "your_offer_code_url_id");
+```
+
+#### Branch.io Example
+
+```javascript
+import React, { useEffect } from 'react';
+import branch from 'react-native-branch';
+import { useDeepLinkIapProvider } from 'insert-affiliate-react-native-sdk';
+
+const DeepLinkHandler = () => {
+  const { fetchAndConditionallyOpenUrl } = useDeepLinkIapProvider();
+  
+  useEffect(() => {
+    const branchSubscription = branch.subscribe(async ({ error, params }) => {
+      if (error) {
+        console.error('Error from Branch:', error);
+        return;
+      }
+
+      if (params['+clicked_branch_link']) {
+        const referringLink = params['~referring_link'];
+        if (referringLink) {
+          try {
+            await fetchAndConditionallyOpenUrl(
+              referringLink,
+              "{{ your_offer_code_url_id }}"
+            );
+
+            // Other code required for Insert Affiliate in the other listed steps...
+          } catch (err) {
+            console.error('Error with offer code:', err);
+          }
+        }
+      }
+    });
+
+    return () => branchSubscription();
+  }, [fetchAndConditionallyOpenUrl]);
+
+  return <App />;
+};
+```
+
+#### Short Code Example
+
+```javascript
+import React, { useState } from 'react';
+import { View, TextInput, Button, StyleSheet } from 'react-native';
+import { useDeepLinkIapProvider } from 'insert-affiliate-react-native-sdk';
+
+const ShortCodeInputWidget = () => {
+  const [shortCode, setShortCode] = useState('');
+  const { setShortCode: setInsertAffiliateShortCode, fetchAndConditionallyOpenUrl } = useDeepLinkIapProvider();
+
+  const handleShortCodeSubmission = async () => {
+    const trimmedCode = shortCode.trim();
+    
+    if (trimmedCode.length > 0) {
+      try {
+        // Set the short code for affiliate tracking
+        await setInsertAffiliateShortCode(trimmedCode);
+        
+        // Fetch and conditionally open offer code URL
+        await fetchAndConditionallyOpenUrl(
+          trimmedCode, 
+          "{{ your_offer_code_url_id }}"
+        );
+      } catch (error) {
+        console.error('Error handling short code:', error);
+      }
+    }
+  };
+
+  return (
+    <View style={styles.container}>
+      <TextInput
+        style={styles.input}
+        value={shortCode}
+        onChangeText={setShortCode}
+        placeholder="Enter your code"
+        placeholderTextColor="#ABC123"
+      />
+      <Button
+        title="Apply Code"
+        onPress={handleShortCodeSubmission}
+      />
+    </View>
+  );
+};
+
+const styles = StyleSheet.create({
+  container: {
+    padding: 20,
+  },
+  input: {
+    borderWidth: 1,
+    borderColor: '#ddd',
+    padding: 10,
+    marginBottom: 10,
+    borderRadius: 5,
+  },
+});
+
+export default ShortCodeInputWidget;
+```
+
+### 3. Short Codes (Beta)
 
 #### What are Short Codes?
 

package/src/DeepLinkIapProvider.tsx

@@ -1,5 +1,5 @@
 import React, { createContext, useEffect, useState } from 'react';
-import { Platform } from 'react-native';
+import { Platform, Linking } from 'react-native';
 import axios from 'axios';
 import AsyncStorage from '@react-native-async-storage/async-storage';
 
@@ -32,6 +32,10 @@ type T_DEEPLINK_IAP_CONTEXT = {
     referringLink: string
   ) => Promise<void | string>;
   initialize: (code: string | null, verboseLogging?: boolean) => Promise<void>;
+  fetchAndConditionallyOpenUrl: (
+    affiliateIdentifier: string,
+    offerCodeUrlId: string
+  ) => Promise<boolean>;
   isInitialized: boolean;
 };
 
@@ -76,6 +80,10 @@ export const DeepLinkIapContext = createContext<T_DEEPLINK_IAP_CONTEXT>({
   setShortCode: async (shortCode: string) => {},
   setInsertAffiliateIdentifier: async (referringLink: string) => {},
   initialize: async (code: string | null, verboseLogging?: boolean) => {},
+  fetchAndConditionallyOpenUrl: async (
+    affiliateIdentifier: string,
+    offerCodeUrlId: string
+  ) => false,
   isInitialized: false,
 });
 
@@ -638,6 +646,101 @@ const DeepLinkIapProvider: React.FC<T_DEEPLINK_IAP_PROVIDER> = ({
     }
   };
 
+  const fetchAndConditionallyOpenUrl = async (
+    affiliateIdentifier: string,
+    offerCodeUrlId: string
+  ): Promise<boolean> => {
+    try {
+      verboseLog(`Attempting to fetch and conditionally open URL for affiliate: ${affiliateIdentifier}, offerCodeUrlId: ${offerCodeUrlId}`);
+
+      if (Platform.OS !== 'ios') {
+        console.warn("[Insert Affiliate] Offer codes are only supported on iOS");
+        verboseLog("Offer codes are only supported on iOS");
+        return false;
+      }
+
+      const offerCode = await fetchOfferCode(affiliateIdentifier);
+      
+      if (offerCode && offerCode.length > 0) {
+        await openRedeemURL(offerCode, offerCodeUrlId);
+        return true;
+      } else {
+        verboseLog("No valid offer code found");
+        return false;
+      }
+    } catch (error) {
+      console.error('[Insert Affiliate] Error fetching and opening offer code URL:', error);
+      verboseLog(`Error fetching and opening offer code URL: ${error}`);
+      return false;
+    }
+  };
+
+  const fetchOfferCode = async (affiliateLink: string): Promise<string | null> => {
+    try {
+
+
+      const encodedAffiliateLink = encodeURIComponent(affiliateLink);
+      const url = `https://api.insertaffiliate.com/v1/affiliateReturnOfferCode/${encodedAffiliateLink}`;
+      
+      verboseLog(`Fetching offer code from: ${url}`);
+      
+      const response = await axios.get(url);
+      
+      if (response.status === 200) {
+        const offerCode = response.data;
+        
+        // Check for specific error strings from API
+        if (typeof offerCode === 'string' && (
+          offerCode.includes("errorofferCodeNotFound") ||
+          offerCode.includes("errorAffiliateoffercodenotfoundinanycompany") ||
+          offerCode.includes("errorAffiliateoffercodenotfoundinanycompanyAffiliatelinkwas") ||
+          offerCode.includes("Routenotfound")
+        )) {
+          console.warn(`[Insert Affiliate] Offer code not found or invalid: ${offerCode}`);
+          verboseLog(`Offer code not found or invalid: ${offerCode}`);
+          return null;
+        }
+        
+        const cleanedOfferCode = cleanOfferCode(offerCode);
+        verboseLog(`Successfully fetched and cleaned offer code: ${cleanedOfferCode}`);
+        return cleanedOfferCode;
+      } else {
+        console.error(`[Insert Affiliate] Failed to fetch offer code. Status code: ${response.status}, Response: ${JSON.stringify(response.data)}`);
+        verboseLog(`Failed to fetch offer code. Status code: ${response.status}, Response: ${JSON.stringify(response.data)}`);
+        return null;
+      }
+    } catch (error) {
+      console.error('[Insert Affiliate] Error fetching offer code:', error);
+      verboseLog(`Error fetching offer code: ${error}`);
+      return null;
+    }
+  };
+
+  const openRedeemURL = async (offerCode: string, offerCodeUrlId: string): Promise<void> => {
+    try {
+      const redeemUrl = `https://apps.apple.com/redeem?ctx=offercodes&id=${offerCodeUrlId}&code=${offerCode}`;
+      verboseLog(`Opening redeem URL: ${redeemUrl}`);
+      
+      const canOpen = await Linking.canOpenURL(redeemUrl);
+      if (canOpen) {
+        await Linking.openURL(redeemUrl);
+        console.log('[Insert Affiliate] Successfully opened redeem URL');
+        verboseLog('Successfully opened redeem URL');
+      } else {
+        console.error(`[Insert Affiliate] Could not launch redeem URL: ${redeemUrl}`);
+        verboseLog(`Could not launch redeem URL: ${redeemUrl}`);
+      }
+    } catch (error) {
+      console.error('[Insert Affiliate] Error opening redeem URL:', error);
+      verboseLog(`Error opening redeem URL: ${error}`);
+    }
+  };
+
+  const cleanOfferCode = (offerCode: string): string => {
+    // Remove special characters, keep only alphanumeric
+    return offerCode.replace(/[^a-zA-Z0-9]/g, '');
+  };
+
   return (
     <DeepLinkIapContext.Provider
       value={{
@@ -652,6 +755,7 @@ const DeepLinkIapProvider: React.FC<T_DEEPLINK_IAP_PROVIDER> = ({
         setInsertAffiliateIdentifier,
         initialize,
         isInitialized,
+        fetchAndConditionallyOpenUrl,
       }}
     >
       {children}

package/src/useDeepLinkIapProvider.tsx

@@ -13,7 +13,8 @@ const useDeepLinkIapProvider = () => {
     setShortCode,
     setInsertAffiliateIdentifier,
     initialize,
-    isInitialized
+    isInitialized,
+    fetchAndConditionallyOpenUrl
   } = useContext(DeepLinkIapContext);
 
   return {
@@ -27,7 +28,8 @@ const useDeepLinkIapProvider = () => {
     setShortCode,
     setInsertAffiliateIdentifier,
     initialize,
-    isInitialized
+    isInitialized,
+    fetchAndConditionallyOpenUrl
   };
 };