insert-affiliate-react-native-sdk 1.4.0 → 1.4.2

package/dist/DeepLinkIapProvider.d.ts

@@ -10,6 +10,8 @@ type T_DEEPLINK_IAP_CONTEXT = {
     userId: string;
     returnInsertAffiliateIdentifier: () => Promise<string | null>;
     validatePurchaseWithIapticAPI: (jsonIapPurchase: CustomPurchase, iapticAppId: string, iapticAppName: string, iapticPublicKey: string) => Promise<boolean>;
+    returnUserAccountTokenAndStoreExpectedTransaction: () => Promise<string | null>;
+    storeExpectedStoreTransaction: (purchaseToken: string) => Promise<void>;
     trackEvent: (eventName: string) => Promise<void>;
     setShortCode: (shortCode: string) => Promise<void>;
     setInsertAffiliateIdentifier: (referringLink: string) => Promise<void | string>;

package/dist/DeepLinkIapProvider.js

@@ -15,23 +15,13 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -55,6 +45,7 @@ const ASYNC_KEYS = {
     USER_PURCHASE: '@app_user_purchase',
     USER_ID: '@app_user_id',
     COMPANY_CODE: '@app_company_code',
+    USER_ACCOUNT_TOKEN: '@app_user_account_token',
 };
 // STARTING CONTEXT IMPLEMENTATION
 exports.DeepLinkIapContext = (0, react_1.createContext)({
@@ -62,6 +53,8 @@ exports.DeepLinkIapContext = (0, react_1.createContext)({
     userId: '',
     returnInsertAffiliateIdentifier: () => __awaiter(void 0, void 0, void 0, function* () { return ''; }),
     validatePurchaseWithIapticAPI: (jsonIapPurchase, iapticAppId, iapticAppName, iapticPublicKey) => __awaiter(void 0, void 0, void 0, function* () { return false; }),
+    returnUserAccountTokenAndStoreExpectedTransaction: () => __awaiter(void 0, void 0, void 0, function* () { return ''; }),
+    storeExpectedStoreTransaction: (purchaseToken) => __awaiter(void 0, void 0, void 0, function* () { }),
     trackEvent: (eventName) => __awaiter(void 0, void 0, void 0, function* () { }),
     setShortCode: (shortCode) => __awaiter(void 0, void 0, void 0, function* () { }),
     setInsertAffiliateIdentifier: (referringLink) => __awaiter(void 0, void 0, void 0, function* () { }),
@@ -178,6 +171,41 @@ const DeepLinkIapProvider = ({ children, }) => {
             yield storeInsertAffiliateIdentifier({ link: capitalisedShortCode });
         });
     }
+    function getOrCreateUserAccountToken() {
+        return __awaiter(this, void 0, void 0, function* () {
+            let userAccountToken = yield getValueFromAsync(ASYNC_KEYS.USER_ACCOUNT_TOKEN);
+            if (!userAccountToken) {
+                userAccountToken = UUID();
+                yield saveValueInAsync(ASYNC_KEYS.USER_ACCOUNT_TOKEN, userAccountToken);
+            }
+            return userAccountToken;
+        });
+    }
+    ;
+    const returnUserAccountTokenAndStoreExpectedTransaction = () => __awaiter(void 0, void 0, void 0, function* () {
+        try {
+            const shortCode = yield returnInsertAffiliateIdentifier();
+            if (!shortCode) {
+                console.log('[Insert Affiliate] No affiliate stored - not saving expected transaction.');
+                return null;
+            }
+            const userAccountToken = yield getOrCreateUserAccountToken();
+            console.log('[Insert Affiliate] User account token:', userAccountToken);
+            if (!userAccountToken) {
+                console.error('[Insert Affiliate] Failed to generate user account token.');
+                return null;
+            }
+            else {
+                yield storeExpectedStoreTransaction(userAccountToken);
+                return userAccountToken;
+            }
+        }
+        catch (error) {
+            console.error('[Insert Affiliate] Error in returnUserAccountTokenAndStoreExpectedTransaction:', error);
+            return null;
+        }
+        ;
+    });
     // MARK: Return Insert Affiliate Identifier
     const returnInsertAffiliateIdentifier = () => __awaiter(void 0, void 0, void 0, function* () {
         try {
@@ -321,6 +349,44 @@ const DeepLinkIapProvider = ({ children, }) => {
             return false;
         }
     });
+    const storeExpectedStoreTransaction = (purchaseToken) => __awaiter(void 0, void 0, void 0, function* () {
+        if (!companyCode || (companyCode.trim() === '' && companyCode !== null)) {
+            console.error("[Insert Affiliate] Company code is not set. Please initialize the SDK with a valid company code.");
+            return;
+        }
+        const shortCode = yield returnInsertAffiliateIdentifier();
+        if (!shortCode) {
+            console.error("[Insert Affiliate] No affiliate identifier found. Please set one before tracking events.");
+            return;
+        }
+        // Build JSON payload
+        const payload = {
+            UUID: purchaseToken,
+            companyCode,
+            shortCode,
+            storedDate: new Date().toISOString(), // ISO8601 format
+        };
+        console.log("[Insert Affiliate] Storing expected transaction: ", payload);
+        try {
+            const response = yield fetch("https://api.insertaffiliate.com/v1/api/app-store-webhook/create-expected-transaction", {
+                method: "POST",
+                headers: {
+                    "Content-Type": "application/json",
+                },
+                body: JSON.stringify(payload),
+            });
+            if (response.ok) {
+                console.info("[Insert Affiliate] Expected transaction stored successfully.");
+            }
+            else {
+                const errorText = yield response.text();
+                console.error(`[Insert Affiliate] Failed to store expected transaction with status code: ${response.status}. Response: ${errorText}`);
+            }
+        }
+        catch (error) {
+            console.error(`[Insert Affiliate] Error storing expected transaction: ${error}`);
+        }
+    });
     // MARK: Track Event
     const trackEvent = (eventName) => __awaiter(void 0, void 0, void 0, function* () {
         try {
@@ -352,6 +418,8 @@ const DeepLinkIapProvider = ({ children, }) => {
             userId,
             setShortCode,
             returnInsertAffiliateIdentifier,
+            storeExpectedStoreTransaction,
+            returnUserAccountTokenAndStoreExpectedTransaction,
             validatePurchaseWithIapticAPI,
             trackEvent,
             setInsertAffiliateIdentifier,
@@ -360,3 +428,10 @@ const DeepLinkIapProvider = ({ children, }) => {
         } }, children));
 };
 exports.default = DeepLinkIapProvider;
+function UUID() {
+    // Generate a random UUID (version 4)
+    return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function (c) {
+        const r = (Math.random() * 16) | 0, v = c === 'x' ? r : (r & 0x3) | 0x8;
+        return v.toString(16);
+    });
+}

package/dist/useDeepLinkIapProvider.d.ts

@@ -4,6 +4,8 @@ declare const useDeepLinkIapProvider: () => {
     validatePurchaseWithIapticAPI: (jsonIapPurchase: {
         [key: string]: any;
     }, iapticAppId: string, iapticAppName: string, iapticPublicKey: string) => Promise<boolean>;
+    storeExpectedStoreTransaction: (purchaseToken: string) => Promise<void>;
+    returnUserAccountTokenAndStoreExpectedTransaction: () => Promise<string | null>;
     returnInsertAffiliateIdentifier: () => Promise<string | null>;
     trackEvent: (eventName: string) => Promise<void>;
     setShortCode: (shortCode: string) => Promise<void>;

package/dist/useDeepLinkIapProvider.js

@@ -3,11 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const react_1 = require("react");
 const DeepLinkIapProvider_1 = require("./DeepLinkIapProvider");
 const useDeepLinkIapProvider = () => {
-    const { referrerLink, userId, validatePurchaseWithIapticAPI, 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 } = (0, react_1.useContext)(DeepLinkIapProvider_1.DeepLinkIapContext);
     return {
         referrerLink,
         userId,
         validatePurchaseWithIapticAPI,
+        storeExpectedStoreTransaction,
+        returnUserAccountTokenAndStoreExpectedTransaction,
         returnInsertAffiliateIdentifier,
         trackEvent,
         setShortCode,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "insert-affiliate-react-native-sdk",
-  "version": "1.4.0",
+  "version": "1.4.2",
   "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

@@ -71,6 +71,8 @@ const App = () => {
 Insert Affiliate requires a Receipt Verification platform to validate in-app purchases. You must choose **one** of our supported partners:
 - [RevenueCat](https://www.revenuecat.com/)
 - [Iaptic](https://www.iaptic.com/account)
+- [App Store Direct Integration](#app-store-direct-integration)
+- [Google Play Store Direct Integration](#google-play-store-direct-integration)
 
 ### Option 1: RevenueCat Integration
 #### Step 1. Code Setup
@@ -156,7 +158,7 @@ const Child = () => {
     // ***...***
     // Fetch & Load your subscription/purchases and handling the IAP purchase here as per the Iaptic Documentation...
     // ***...***
-    
+
     // Initialize the Insert Affiliate SDK at the earliest possible moment
     useEffect(() => {
         if (!isInitialized) {
@@ -164,7 +166,6 @@ const Child = () => {
         }
     }, [initialize, isInitialized]);
 
-
     // Validate the purchase with Iaptic through Insert Affiliate's SDK for Affiliate Tracking
     useEffect(() => {
         if (currentPurchase) {
@@ -211,18 +212,114 @@ export default App;
 - Replace `{{ your_iaptic_public_key }}` with your **Iaptic Public Key**. You can find this [here](https://www.iaptic.com/settings).
 - Replace `{{ your_company_code }}` with the unique company code associated with your Insert Affiliate account. You can find this code in your dashboard under [Settings](http://app.insertaffiliate.com/settings).
 
+### Option 3: App Store Direct Integration
+
+Our direct App Store integration is currently in beta and currently supports subscriptions only. **Consumables and one-off purchases are not yet supported** due to App Store server-to-server notification limitations.
+
+We plan to release support for consumables and one-off purchases soon. In the meantime, you can use a receipt verification platform from the other integration options.
+
+#### Apple App Store Notification Setup
+To proceed, visit [our docs](https://docs.insertaffiliate.com/direct-store-purchase-integration#1-apple-app-store-server-notifications) and complete the required setup steps to set up App Store Server to Server Notifications.
+
+#### Implementing Purchases
+
+##### 1. Import Required Modules  
+
+Ensure you import the necessary dependencies, including `Platform` and `useDeepLinkIapProvider` from the SDK.  
+
+```javascript
+import { Platform } from 'react-native';
+import { DeepLinkIapProvider, useDeepLinkIapProvider } from 'insert-affiliate-react-native-sdk';
+import { requestSubscription } from 'react-native-iap';
+
+const { returnUserAccountTokenAndStoreExpectedTransaction } = useDeepLinkIapProvider();
+```
+
+
+##### 2. Handle the Purchase
+When a user initiates a subscription, retrieve the appAccountToken and pass it to the requestSubscription call:
+
+```javascript
+const handleBuySubscription = async (product: SubscriptionAndroid | Subscription) => {
+    try {
+        let appAccountToken = null;
+
+        // Step 1: Retrieve the appAccountToken for iOS
+        if (Platform.OS === 'ios') {
+            appAccountToken = await returnUserAccountTokenAndStoreExpectedTransaction();
+        }
+
+        // Step 2: Request the subscription and pass the token for tracking
+        await requestSubscription({
+            sku: product?.productId,
+            ...(appAccountToken ? { applicationUsername: appAccountToken } : {}),
+        });
+
+    } catch (error) {
+        console.error("Error processing subscription:", error);
+    }
+};
+
+```
+
+
+### Option 4: Google Play Store Direct Integration
+Our direct Google Play Store integration is currently in beta.
+
+#### Real Time Developer Notifications (RTDN) Setup
+
+Visit [our docs](https://docs.insertaffiliate.com/direct-google-play-store-purchase-integration) and complete the required set up steps for Google Play's Real Time Developer Notifications.
+
+#### Implementing Purchases
+
+##### 1. Import Required Modules  
+
+Ensure you import the necessary dependencies, including `Platform` and `useDeepLinkIapProvider` from the SDK.  
+
+```javascript
+import React, {useEffect, useState} from 'react';
+import { Platform } from 'react-native';
+import { DeepLinkIapProvider, useDeepLinkIapProvider } from 'insert-affiliate-react-native-sdk';
+import { currentPurchase, requestSubscription } from 'react-native-iap';
+
+const { storeExpectedStoreTransaction } = useDeepLinkIapProvider();
+
+useEffect(() => {
+    if (currentPurchase) {
+        if (Platform.OS === 'android' && currentPurchase.purchaseToken) {
+            // Step 1: Store the expected transaction for Google Play purchases
+            storeExpectedStoreTransaction(
+              currentPurchase.purchaseToken
+            );
+        }
+    }
+}, [currentPurchase, storeExpectedStoreTransaction]);
+```
+
+
+
 ## Deep Link Setup [Required]
 
-### Step 1: Add the Deep Linking Platform Dependency
+Insert Affiliate requires a Deep Linking platform to create links for your affiliates. Our platform works with **any** deep linking provider, and you only need to follow these steps:
+1. **Create a deep link** in your chosen third-party platform and pass it to our dashboard when an affiliate signs up. 
+2. **Handle deep link clicks** in your app by passing the clicked link:
+   ```javascript
+   await setInsertAffiliateIdentifier(referringLink)
+   ```
+3. **Integrate with a Receipt Verification platform** by using the result from `setInsertAffiliateIdentifier` to log in or set your application’s username. Examples below include [**Iaptic**](https://github.com/Insert-Affiliate/InsertAffiliateReactNativeSDK?tab=readme-ov-file#example-with-iaptic) and [**RevenueCat**](https://github.com/Insert-Affiliate/InsertAffiliateReactNativeSDK?tab=readme-ov-file#example-with-revenuecat)
 
-In this example, the deep linking functionality is implemented using [Branch.io](https://dashboard.branch.io/).
+### Deep Linking with Branch.io
+To set up deep linking with Branch.io, follow these steps:
 
-Any alternative deep linking platform can be used by passing the referring link to ```InsertAffiliateSwift.setInsertAffiliateIdentifier(referringLink: "{{ link }}")``` as in the below Branch.io example
+1. Create a deep link in Branch and pass it to our dashboard when an affiliate signs up.
+  - Example: [Create Affiliate](https://docs.insertaffiliate.com/create-affiliate).
+2. Modify Your Deep Link Handling in `App.tsx`
+    - After setting up your Branch integration, add the following code to initialise our SDK in your app:
 
-After setting up your Branch integration, add the following code to your ```App.tsx```
 
 #### Example with RevenueCat
 ```javascript
+import { DeepLinkIapProvider, useDeepLinkIapProvider } from 'insert-affiliate-react-native-sdk';
 import { useDeepLinkIapProvider } from 'insert-affiliate-react-native-sdk';
 
 //...
@@ -265,10 +362,11 @@ import { useDeepLinkIapProvider } from 'insert-affiliate-react-native-sdk';
 //...
 ```
 
-#### Example with Iaptic
+#### Example with Iaptic / App Store Direct Integration / Google Play Direct Integration
 ```javascript
 import branch from 'react-native-branch';
 import { DeepLinkIapProvider, useDeepLinkIapProvider } from 'insert-affiliate-react-native-sdk';
+const {setInsertAffiliateIdentifier} = useDeepLinkIapProvider();
 
 branch.subscribe(async ({ error, params }) => {
     if (error) {

package/src/DeepLinkIapProvider.tsx

@@ -22,6 +22,10 @@ type T_DEEPLINK_IAP_CONTEXT = {
     iapticAppName: string,
     iapticPublicKey: string
   ) => Promise<boolean>;
+  returnUserAccountTokenAndStoreExpectedTransaction: () => Promise<string | null>;
+  storeExpectedStoreTransaction: (
+    purchaseToken: string
+  ) => Promise<void>;
   trackEvent: (eventName: string) => Promise<void>;
   setShortCode: (shortCode: string) => Promise<void>;
   setInsertAffiliateIdentifier: (
@@ -52,6 +56,7 @@ const ASYNC_KEYS = {
   USER_PURCHASE: '@app_user_purchase',
   USER_ID: '@app_user_id',
   COMPANY_CODE: '@app_company_code',
+  USER_ACCOUNT_TOKEN: '@app_user_account_token',
 };
 
 // STARTING CONTEXT IMPLEMENTATION
@@ -65,6 +70,8 @@ export const DeepLinkIapContext = createContext<T_DEEPLINK_IAP_CONTEXT>({
     iapticAppName: string,
     iapticPublicKey: string
   ) => false,
+  returnUserAccountTokenAndStoreExpectedTransaction: async () => '',
+  storeExpectedStoreTransaction: async (purchaseToken: string) => {},
   trackEvent: async (eventName: string) => {},
   setShortCode: async (shortCode: string) => {},
   setInsertAffiliateIdentifier: async (referringLink: string) => {},
@@ -200,10 +207,44 @@ const DeepLinkIapProvider: React.FC<T_DEEPLINK_IAP_PROVIDER> = ({
     await storeInsertAffiliateIdentifier({ link: capitalisedShortCode });
   }
 
+  async function getOrCreateUserAccountToken(): Promise<string> {
+    let userAccountToken = await getValueFromAsync(ASYNC_KEYS.USER_ACCOUNT_TOKEN);
+
+    if (!userAccountToken) {
+      userAccountToken = UUID();
+      await saveValueInAsync(ASYNC_KEYS.USER_ACCOUNT_TOKEN, userAccountToken);
+    }
+
+    return userAccountToken;
+  };
+
+  const returnUserAccountTokenAndStoreExpectedTransaction = async (): Promise<string | null> => {
+    try {
+      const shortCode = await returnInsertAffiliateIdentifier();
+      if (!shortCode) {
+        console.log('[Insert Affiliate] No affiliate stored - not saving expected transaction.');
+        return null;
+      }
+
+      const userAccountToken = await getOrCreateUserAccountToken();
+      console.log('[Insert Affiliate] User account token:', userAccountToken);
+
+      if (!userAccountToken) {
+        console.error('[Insert Affiliate] Failed to generate user account token.');
+        return null;
+      } else {
+        await storeExpectedStoreTransaction(userAccountToken);
+        return userAccountToken;
+      }
+    } catch (error) {
+      console.error('[Insert Affiliate] Error in returnUserAccountTokenAndStoreExpectedTransaction:', error);
+      return null;
+    };
+  };
+
   // MARK: Return Insert Affiliate Identifier
   const returnInsertAffiliateIdentifier = async (): Promise<string | null> => {
     try {
-      
       return `${referrerLink}-${userId}`;
     } catch (error) {
       errorLog(`ERROR ~ returnInsertAffiliateIdentifier: ${error}`);
@@ -377,6 +418,48 @@ const DeepLinkIapProvider: React.FC<T_DEEPLINK_IAP_PROVIDER> = ({
     }
   };
 
+  const storeExpectedStoreTransaction = async (purchaseToken: string): Promise<void> => {
+    if (!companyCode || (companyCode.trim() === '' && companyCode !== null)) {
+      console.error("[Insert Affiliate] Company code is not set. Please initialize the SDK with a valid company code.");
+      return;
+    }
+
+    const shortCode = await returnInsertAffiliateIdentifier();
+    if (!shortCode) {
+      console.error("[Insert Affiliate] No affiliate identifier found. Please set one before tracking events.");
+      return;
+    }
+
+    // Build JSON payload
+    const payload = {
+      UUID: purchaseToken,
+      companyCode,
+      shortCode,
+      storedDate: new Date().toISOString(), // ISO8601 format
+    };
+
+    console.log("[Insert Affiliate] Storing expected transaction: ", payload);
+
+    try {
+      const response = await fetch("https://api.insertaffiliate.com/v1/api/app-store-webhook/create-expected-transaction", {
+        method: "POST",
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: JSON.stringify(payload),
+      });
+
+      if (response.ok) {
+        console.info("[Insert Affiliate] Expected transaction stored successfully.");
+      } else {
+        const errorText = await response.text();
+        console.error(`[Insert Affiliate] Failed to store expected transaction with status code: ${response.status}. Response: ${errorText}`);
+      }
+    } catch (error) {
+      console.error(`[Insert Affiliate] Error storing expected transaction: ${error}`);
+    }
+  };
+
   // MARK: Track Event
   const trackEvent = async (eventName: string): Promise<void> => {
     try {
@@ -420,6 +503,8 @@ const DeepLinkIapProvider: React.FC<T_DEEPLINK_IAP_PROVIDER> = ({
         userId,
         setShortCode,
         returnInsertAffiliateIdentifier,
+        storeExpectedStoreTransaction,
+        returnUserAccountTokenAndStoreExpectedTransaction,
         validatePurchaseWithIapticAPI,
         trackEvent,
         setInsertAffiliateIdentifier,
@@ -433,3 +518,12 @@ const DeepLinkIapProvider: React.FC<T_DEEPLINK_IAP_PROVIDER> = ({
 };
 
 export default DeepLinkIapProvider;
+  function UUID(): string {
+    // Generate a random UUID (version 4)
+    return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function (c) {
+      const r = (Math.random() * 16) | 0,
+        v = c === 'x' ? r : (r & 0x3) | 0x8;
+      return v.toString(16);
+    });
+  }
+

package/src/useDeepLinkIapProvider.tsx

@@ -6,6 +6,8 @@ const useDeepLinkIapProvider = () => {
     referrerLink,
     userId,
     validatePurchaseWithIapticAPI,
+    storeExpectedStoreTransaction,
+    returnUserAccountTokenAndStoreExpectedTransaction,
     returnInsertAffiliateIdentifier,
     trackEvent,
     setShortCode,
@@ -18,6 +20,8 @@ const useDeepLinkIapProvider = () => {
     referrerLink,
     userId,
     validatePurchaseWithIapticAPI,
+    storeExpectedStoreTransaction,
+    returnUserAccountTokenAndStoreExpectedTransaction,
     returnInsertAffiliateIdentifier,
     trackEvent,
     setShortCode,