insert-affiliate-react-native-sdk 1.1.7 → 1.1.9

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "insert-affiliate-react-native-sdk",
-  "version": "1.1.7",
-  "description": "A package that will give context having implementation of react-native-branch and react-native-iap and iaptic validate api.",
+  "version": "1.1.9",
+  "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",
   "scripts": {

package/readme.md

@@ -10,18 +10,11 @@ The **InsertAffiliateReactNative SDK** is designed for React Native applications
 - **Affiliate Identifier Management**: Set and retrieve the affiliate identifier based on user-specific links.
 - **In-App Purchase (IAP) Initialisation**: Easily reinitialise in-app purchases with the option to validate using an affiliate identifier.
 
-## Peer Dependencies
-
-Before using this package, ensure you have the following dependencies installed:
-
-- [react-native-iap](https://www.npmjs.com/package/react-native-iap)
-- [axios](https://www.npmjs.com/package/axios)
-
 ## Getting Started
 
 To get started with the InsertAffiliateReactNative SDK:
 
-1. [Install the React Native Package](#installation)
+1. [Install the SDK](#installation)
 2. [Initialise the SDK in App.tsx](#basic-usage)
 3. [Set up in-app purchases (Required)](#in-app-purchase-setup-required)
 4. [Set up deep linking (Required)](#deep-link-setup-required)
@@ -37,7 +30,9 @@ npm install insert-affiliate-react-native-sdk
 
 ## Basic Usage
 
-### Initialisation in `App.tsx`
+Follow the steps below to install the SDK.
+
+#### Step 1: Initialisation in `App.tsx`
 
 First, wrap your with our provider and call the `initialise` method early in your app's lifecycle:
 
@@ -60,7 +55,6 @@ const Child = () => {
   }, [initialize, isInitialized]);
   
   // ...
-  
 }
 
 const App = () => {
@@ -71,20 +65,77 @@ const App = () => {
   );
 };
 ```
-- Replace `{{ your_iaptic_app_id }}` with your **Iaptic App ID**. You can find this [here](https://www.iaptic.com/account).
-- Replace `{{ your_iaptic_app_name }}` with your **Iaptic App Name**. You can find this [here](https://www.iaptic.com/account).
-- 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).
 
 ## In-App Purchase Setup [Required]
 Insert Affiliate requires a Receipt Verification platform to validate in-app purchases. You must choose **one** of our supported partners:
-- [Iaptic](https://www.iaptic.com/account)
 - [RevenueCat](https://www.revenuecat.com/)
+- [Iaptic](https://www.iaptic.com/account)
+
+### Option 1: RevenueCat Integration
+#### Step 1. Code Setup
+First, complete the [RevenueCat SDK installation](https://www.revenuecat.com/docs/getting-started/installation/reactnative). Then modify your `App.tsx`:
+
+```javascript
+import {
+  DeepLinkIapProvider,
+  useDeepLinkIapProvider,
+} from 'insert-affiliate-react-native-sdk';
+
+// ... //
+const {
+    initialize,
+    isInitialized,
+    returnInsertAffiliateIdentifier
+} = useDeepLinkIapProvider();
+
+React.useEffect(() => {
+    const handleAffiliateLogin = async () => {
+        try {
+            if (isInitialized) {
+                const affiliateIdentifier = await returnInsertAffiliateIdentifier();
+                
+                if (affiliateIdentifier) {
+                    console.log('Logging into RevenueCat...');
+                    const { customerInfo, created } = await Purchases.logIn(affiliateIdentifier);
+                    
+                    if (created) {
+                        console.log('New user created in RevenueCat:', customerInfo);
+                    }
+                }
+            }
+        } catch (error) {
+            console.error('Error during affiliate login flow:', error);
+        }
+    };
+
+    handleAffiliateLogin();
+}, [isInitialized, returnInsertAffiliateIdentifier]);
+// ... //
+```
+
+#### Step 2. Webhook Setup
+
+1. Go to RevenueCat and [create a new webhook](https://www.revenuecat.com/docs/integrations/webhooks)
+
+2. Configure the webhook with these settings:
+   - Webhook URL: `https://api.insertaffiliate.com/v1/api/revenuecat-webhook`
+   - Authorization header: Use the value from your Insert Affiliate dashboard (you'll get this in step 4)
+
+3. In your [Insert Affiliate dashboard settings](https://app.insertaffiliate.com/settings):
+   - Navigate to the verification settings
+   - Set the in-app purchase verification method to `RevenueCat`
+
+4. Back in your Insert Affiliate dashboard:
+   - Locate the `RevenueCat Webhook Authentication Header` value
+   - Copy this value
+   - Paste it as the Authorization header value in your RevenueCat webhook configuration
+
 
-### Option 1: Iaptic Integration
+### Option 2: Iaptic Integration
 First, complete the [Iaptic account setup](https://www.iaptic.com/signup) and code integration.
 
-Then after setting up the in app purchase (IAP) with Iaptic, call Insert Affiliate's handlePurchaseValidation on purchase.
+Then after setting up the in app purchase (IAP) with Iaptic, call Insert Affiliate's ```validatePurchaseWithIapticAPI``` on purchase.
 
 ```javascript
 import React from 'react';
@@ -96,7 +147,7 @@ const Child = () => {
     const {
         initialize,
         isInitialized,
-        handlePurchaseValidation,
+        validatePurchaseWithIapticAPI,
     } = useDeepLinkIapProvider();
 
     const [iapLoading, setIapLoading] = useState(false);
@@ -117,7 +168,12 @@ const Child = () => {
     // Validate the purchase with Iaptic through Insert Affiliate's SDK for Affiliate Tracking
     useEffect(() => {
         if (currentPurchase) {
-            handlePurchaseValidation(currentPurchase).then((isValid: boolean) => {
+            validatePurchaseWithIapticAPI(
+                currentPurchase,
+                '{{ your_iaptic_app_id }}',
+                '{{ your_iaptic_app_name }}',
+                '{{ your_iaptic_public_key }}',
+              ).then((isValid: boolean) => {
                 if (isValid) {
                   console.log("Purchase validated successfully.");
                 } else {
@@ -155,12 +211,6 @@ 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 2: RevenueCat Integration
-<!--#### 1. Code Setup-->
-<!--First, complete the [RevenueCat SDK installation](https://www.revenuecat.com/docs/getting-started/installation/ios). Then modify your `AppDelegate.swift`:-->
-   
-COMING SOON...
-
 ## Deep Link Setup [Required]
 
 ### Step 1: Add the Deep Linking Platform Dependency
@@ -171,31 +221,46 @@ Any alternative deep linking platform can be used by passing the referring link
 
 After setting up your Branch integration, add the following code to your ```index.js```
 
-<!--#### Example with RevenueCat-->
-<!--```swift-->
-<!--import SwiftUI-->
-<!--import BranchSDK-->
-<!--import InAppPurchaseLib-->
-<!--import InsertAffiliateSwift-->
-
-<!--class AppDelegate: UIResponder, UIApplicationDelegate {-->
-<!--  func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]? = nil) -> Bool {-->
-<!--    Branch.getInstance().initSession(launchOptions: launchOptions) { (params, error) in-->
-<!--      if let referringLink = params?["~referring_link"] as? String {-->
-<!--        InsertAffiliateSwift.setInsertAffiliateIdentifier(referringLink: referringLink) { result in-->
-<!--          guard let shortCode = result else {-->
-<!--            return-->
-<!--          }-->
-
-<!--          Purchases.shared.logIn(shortCode) { (customerInfo, created, error) in-->
-<!--            // customerInfo updated for my_app_user_id. If you are having issues, you can investigate here.-->
-<!--          }-->
-<!--      }-->
-<!--    }-->
-<!--    return true-->
-<!--  }-->
-<!--}-->
-<!--```-->
+#### Example with RevenueCat
+```javascript
+import { useDeepLinkIapProvider } from 'insert-affiliate-react-native-sdk';
+
+const RootComponent = () => {
+    const {setInsertAffiliateIdentifier, returnInsertAffiliateIdentifier} = useDeepLinkIapProvider();
+    
+    React.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 setInsertAffiliateIdentifier(referringLink);
+                        
+                        let insertAffiliateIdentifier = await returnInsertAffiliateIdentifier();
+                        if (insertAffiliateIdentifier) {
+                          const { customerInfo, created } = await Purchases.logIn(insertAffiliateIdentifier);
+                        }
+                    } catch (err) {
+                        console.error('Error setting affiliate identifier:', err);
+                    }
+                }
+            }
+        });
+
+        // Cleanup the subscription on component unmount
+        return () => {
+            branchSubscription();
+        };
+    }, [setInsertAffiliateIdentifier]);
+
+    return <App />;
+};
+```
 
 #### Example with Iaptic
 ```javascript

package/src/DeepLinkIapProvider.tsx

@@ -206,7 +206,6 @@ const DeepLinkIapProvider: React.FC<T_DEEPLINK_IAP_PROVIDER> = ({
   
 
   // MARK: Insert Affiliate Identifier
-
   const setInsertAffiliateIdentifier = async (
     referringLink: string,
     completion: (shortLink: string | null) => void