gomarketme-react-native 4.0.1 → 5.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) GoMarketMe
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,96 +1,134 @@
 <div align="center">
-	<img src="https://static.gomarketme.net/assets/gmm-icon.png" alt="GoMarketMe"/>
-	<br>
-    <h1>gomarketme-react-native</h1>
-	<p>Affiliate marketing for React Native apps on iOS and Android.</p>
+  <img src="https://static.gomarketme.net/assets/gmm-icon.png" alt="GoMarketMe" />
+  <br />
+  <h1>GoMarketMe React Native SDK</h1>
+  <p>Affiliate marketing for React Native apps on iOS and Android.</p>
 </div>
 
 ## Installation
 
-### Using npm
+### npm
 
 ```bash
-npm install gomarketme-react-native@4.0.1
+npm install gomarketme-react-native@5.0.0
 ```
 
-### Using yarn
+### Yarn
 
 ```bash
-yarn add gomarketme-react-native@4.0.1
+yarn add gomarketme-react-native@5.0.0
 ```
 
-### Using pnpm
+### pnpm
 
 ```bash
-pnpm add gomarketme-react-native@4.0.1
-```
-##
-
-GoMarketMe is built on top of react-native-iap, so you may also need to install the following packages: 
-```bash
-npm install react-native-iap react-native-nitro-modules
-(or yarn add react-native-iap react-native-nitro-modules)
-(or pnpm add react-native-iap react-native-nitro-modules)
+pnpm add gomarketme-react-native@5.0.0
 ```
 
 ## Usage
 
-⚙️ Basic Integration
+GoMarketMe takes only a few lines to set up.
 
-To initialize GoMarketMe, import the `gomarketme` package and initialize the SDK with your API key:
+### Step 1/3: Initialize
+
+Import `gomarketme-react-native` and initialize the SDK with your GoMarketMe API key.
 
 ```tsx
+import { useEffect } from 'react';
 import GoMarketMe from 'gomarketme-react-native';
 
 useEffect(() => {
-  
-  GoMarketMe.initialize('API_KEY'); // Initialize with your API key
+  const initializeGoMarketMe = async () => {
+    await GoMarketMe.initialize('API_KEY');
+  };
 
+  initializeGoMarketMe();
 }, []);
 ```
 
-No further steps needed. The SDK automatically attributes and reports your affiliate sales in real time.
+Replace `API_KEY` with your actual GoMarketMe API key. You can find it on the product onboarding page and under **Profile > API Key**.
 
-⚙️ OR - Advanced Integration
+### Step 2/3: Sync after purchase
 
-Use this approach for more advanced scenarios, such as:
-- Affiliate-aware paywalls: Offer exclusive pricing or promotions to users acquired through affiliate campaigns.
-- Personalized onboarding: For example, a social or fitness app can automatically make new users follow the influencer who referred them, strengthening engagement and maximizing the affiliate’s impact.
+After your app completes a purchase through `react-native-iap`, `expo-iap`, RevenueCat, Adapty, or another in-app purchase provider, call:
 
 ```tsx
-import GoMarketMe from 'gomarketme-react-native';
-  
-const goMarketMeSDK = GoMarketMe;
-const [affiliateData, setAffiliateData] = useState<GoMarketMeAffiliateMarketingData | null>(null);
+await GoMarketMe.syncAllTransactions();
+```
+
+If your purchase library lets you decide when to finish, acknowledge, consume, or complete the transaction, call `syncAllTransactions()` first.
+
+```tsx
+purchaseUpdateSub = purchaseUpdatedListener(async purchase => {
+  await GoMarketMe.syncAllTransactions();
+
+  await finishTransaction({ purchase, isConsumable: true });
+});
+```
+
+### Step 3/3: iOS consumables only
+
+If your iOS app sells consumable in-app purchases, add this key to your app's `Info.plist`:
+
+```xml
+<key>SKIncludeConsumableInAppPurchaseHistory</key>
+<true/>
+```
+
+That's it. GoMarketMe automatically attributes and reports affiliate sales.
+
+## Alternative Step 1: Advanced integration
+
+For advanced use cases, you can also read GoMarketMe affiliate marketing data after initialization. This is useful for Programmatic Affiliate Marketing, such as affiliate-aware paywalls, personalized onboarding, promotions, or custom in-app experiences.
+
+Common use cases include:
+
+- Affiliate-aware paywalls and promotions.
+- Personalized onboarding.
+- Automatically connecting new users with the influencer who referred them.
+
+Learn more about [Programmatic Affiliate Marketing](https://gomarketme.co/programmatic-affiliate-marketing/).
+
+```tsx
+import { useEffect, useState } from 'react';
+import GoMarketMe, {
+  GoMarketMeAffiliateMarketingData,
+} from 'gomarketme-react-native';
+
+const [affiliateData, setAffiliateData] =
+  useState<GoMarketMeAffiliateMarketingData | null>(null);
 
 useEffect(() => {
-  
-  const initGoMarketMe = async () => {
-    
-    await goMarketMeSDK.initialize('API_KEY'); // Initialize with your API key
-    const data = goMarketMeSDK.affiliateMarketingData;
-
-    if (data) { // user acquired through affiliate campaign
-      
-      console.log('Affiliate ID:', data.affiliate?.id);                         // maps to GoMarketMe > Affiliates > Export > id column
-      console.log('Affiliate %:', data.saleDistribution?.affiliatePercentage);  // maps to GoMarketMe > Campaigns > [Name] > Affiliate's Revenue Split (%)
-      console.log('Campaign ID:', data.campaign?.id);                           // maps to GoMarketMe > Campaigns > [Name] > id in the URL
-
-      setAffiliateData(data);
+  const initializeGoMarketMe = async () => {
+    await GoMarketMe.initialize('API_KEY');
+
+    const data = GoMarketMe.affiliateMarketingData;
+
+    if (!data) {
+      return;
     }
 
+    // Maps to GoMarketMe > Affiliates > Export > id column.
+    console.log('Affiliate ID:', data.affiliate?.id);
+
+    // Maps to GoMarketMe > Campaigns > [Name] > Affiliate's Revenue Split (%).
+    console.log('Affiliate %:', data.saleDistribution?.affiliatePercentage);
+
+    // Maps to GoMarketMe > Campaigns > [Name] > id in the URL.
+    console.log('Campaign ID:', data.campaign?.id);
+
+    // Use this data to customize onboarding, paywalls, promotions, or in-app experiences.
+    setAffiliateData(data);
   };
 
-  initGoMarketMe();
+  initializeGoMarketMe();
 }, []);
 ```
 
-Make sure to replace `API_KEY` with your actual GoMarketMe API key. You can find it on the product onboarding page and under **Profile > API Key**.
-
-For Expo, go to [https://www.npmjs.com/package/gomarketme-react-native-expo](https://www.npmjs.com/package/gomarketme-react-native-expo).
-
 ## Support
 
-Check out our sample React Native app at [https://github.com/GoMarketMe/gomarketme-react-native-sample-app](https://github.com/GoMarketMe/gomarketme-react-native-sample-app).
+Check out the sample React Native app:
+
+[https://github.com/GoMarketMe/gomarketme-react-native-sample-app](https://github.com/GoMarketMe/gomarketme-react-native-sample-app)
 
-If you run into any issues, please reach out to us at [integrations@gomarketme.co](mailto:integrations@gomarketme.co) or visit [https://gomarketme.co](https://gomarketme.co).
+For integration support, contact [integrations@gomarketme.co](mailto:integrations@gomarketme.co) or visit [https://gomarketme.co](https://gomarketme.co).

package/android/build.gradle

@@ -0,0 +1,46 @@
+buildscript {
+  ext.kotlin_version = '2.1.0'
+
+  repositories {
+    google()
+    mavenCentral()
+  }
+
+  dependencies {
+    classpath 'com.android.tools.build:gradle:8.7.3'
+    classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
+  }
+}
+
+apply plugin: 'com.android.library'
+apply plugin: 'org.jetbrains.kotlin.android'
+
+android {
+  namespace 'co.gomarketme.reactnative'
+  compileSdk 35
+
+  defaultConfig {
+    minSdk 23
+  }
+
+  compileOptions {
+    sourceCompatibility JavaVersion.VERSION_17
+    targetCompatibility JavaVersion.VERSION_17
+  }
+
+  kotlinOptions {
+    jvmTarget = '17'
+  }
+}
+
+repositories {
+  google()
+  mavenCentral()
+}
+
+dependencies {
+  implementation files('libs/core-5.0.0.jar')
+  implementation 'com.android.billingclient:billing:8.3.0'
+  implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.9.0'
+  compileOnly 'com.facebook.react:react-android:+'
+}

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,3 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+    <uses-permission android:name="com.android.vending.BILLING" />
+</manifest>

package/android/src/main/java/co/gomarketme/reactnative/GoMarketMeReactNativeModule.kt

@@ -0,0 +1,184 @@
+package co.gomarketme.reactnative
+
+import android.util.Log
+import co.gomarketme.core.GoMarketMeGoogleCore
+import co.gomarketme.core.GoMarketMeGoogleCoreConfiguration
+import com.facebook.react.bridge.Arguments
+import com.facebook.react.bridge.Promise
+import com.facebook.react.bridge.ReactApplicationContext
+import com.facebook.react.bridge.ReactContextBaseJavaModule
+import com.facebook.react.bridge.ReactMethod
+import com.facebook.react.bridge.WritableArray
+import com.facebook.react.bridge.WritableMap
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.SupervisorJob
+import kotlinx.coroutines.launch
+
+class GoMarketMeReactNativeModule(
+    private val reactContext: ReactApplicationContext
+) : ReactContextBaseJavaModule(reactContext) {
+    private var core: GoMarketMeGoogleCore? = null
+    private val scope = CoroutineScope(SupervisorJob() + Dispatchers.Main.immediate)
+
+    override fun getName(): String = MODULE_NAME
+
+    @ReactMethod
+    fun initialize(
+        apiKey: String,
+        sdkType: String,
+        sdkVersion: String,
+        isProduction: Boolean,
+        promise: Promise
+    ) {
+        val trimmedApiKey = apiKey.trim()
+
+        if (trimmedApiKey.isEmpty()) {
+            promise.reject("invalid_arguments", "apiKey is required")
+            return
+        }
+
+        val initialConfiguration = GoMarketMeGoogleCoreConfiguration(
+            apiKey = trimmedApiKey,
+            sdkType = sdkType.ifBlank { "ReactNative" },
+            sdkVersion = sdkVersion.takeIf { it.isNotBlank() },
+            isProduction = isProduction
+        )
+
+        val googleCore = core ?: GoMarketMeGoogleCore(reactContext.applicationContext)
+
+        if (IS_DEBUG_LOGGING_ENABLED) {
+            googleCore.onPurchase = { event ->
+                Log.d(TAG, "purchase observed by core: ${event.toMap()}")
+            }
+
+            googleCore.onError = { throwable ->
+                Log.e(TAG, "core error", throwable)
+            }
+        } else {
+            googleCore.onPurchase = null
+            googleCore.onError = null
+        }
+
+        scope.launch {
+            try {
+                val prepared = googleCore.prepareAttribution(initialConfiguration)
+                val config = prepared.first
+                val affiliateMarketingData = prepared.second
+
+                googleCore.configure(config)
+                googleCore.start()
+                core = googleCore
+
+                val response = Arguments.createMap().apply {
+                    putBoolean("initialized", true)
+                    putString("platform", "android")
+                    putString("source", config.sourceName)
+                    putMap("affiliateMarketingData", affiliateMarketingData.toWritableMap())
+                }
+
+                promise.resolve(response)
+            } catch (throwable: Throwable) {
+                promise.reject("initialize_failed", throwable.message, throwable)
+            }
+        }
+    }
+
+    @ReactMethod
+    fun syncAllTransactions(promise: Promise) {
+        val googleCore = core
+
+        if (googleCore == null) {
+            promise.reject("not_initialized", "GoMarketMe SDK must be initialized before syncing transactions")
+            return
+        }
+
+        scope.launch {
+            try {
+                val result = googleCore.sendCurrentPurchasesWithResult()
+
+                val response = Arguments.createMap().apply {
+                    putInt("fetchedCount", result.fetchedCount)
+                    putInt("sentCount", result.sentCount)
+                    putInt("failedCount", result.failedCount)
+                    putBoolean("success", result.success)
+                }
+
+                promise.resolve(response)
+            } catch (throwable: Throwable) {
+                promise.reject("sync_all_transactions_failed", throwable.message, throwable)
+            }
+        }
+    }
+
+    @ReactMethod
+    fun stop() {
+        core?.stop()
+        core = null
+    }
+
+    override fun invalidate() {
+        stop()
+        super.invalidate()
+    }
+
+    private fun Map<String, Any?>.toWritableMap(): WritableMap {
+        val writableMap = Arguments.createMap()
+
+        forEach { (key, value) ->
+            writableMap.putAny(key, value)
+        }
+
+        return writableMap
+    }
+
+    private fun WritableMap.putAny(key: String, value: Any?) {
+        when (value) {
+            null -> putNull(key)
+            is Boolean -> putBoolean(key, value)
+            is Int -> putInt(key, value)
+            is Long -> putDouble(key, value.toDouble())
+            is Float -> putDouble(key, value.toDouble())
+            is Double -> putDouble(key, value)
+            is Number -> putDouble(key, value.toDouble())
+            is String -> putString(key, value)
+            is Map<*, *> -> putMap(key, value.toStringKeyMap().toWritableMap())
+            is Iterable<*> -> putArray(key, value.toWritableArray())
+            is Array<*> -> putArray(key, value.asIterable().toWritableArray())
+            else -> putString(key, value.toString())
+        }
+    }
+
+    private fun Iterable<*>.toWritableArray(): WritableArray {
+        val writableArray = Arguments.createArray()
+
+        forEach { value ->
+            when (value) {
+                null -> writableArray.pushNull()
+                is Boolean -> writableArray.pushBoolean(value)
+                is Int -> writableArray.pushInt(value)
+                is Long -> writableArray.pushDouble(value.toDouble())
+                is Float -> writableArray.pushDouble(value.toDouble())
+                is Double -> writableArray.pushDouble(value)
+                is Number -> writableArray.pushDouble(value.toDouble())
+                is String -> writableArray.pushString(value)
+                is Map<*, *> -> writableArray.pushMap(value.toStringKeyMap().toWritableMap())
+                is Iterable<*> -> writableArray.pushArray(value.toWritableArray())
+                is Array<*> -> writableArray.pushArray(value.asIterable().toWritableArray())
+                else -> writableArray.pushString(value.toString())
+            }
+        }
+
+        return writableArray
+    }
+
+    private fun Map<*, *>.toStringKeyMap(): Map<String, Any?> = entries.associate { (key, value) ->
+        key.toString() to value
+    }
+
+    private companion object {
+        const val MODULE_NAME = "GoMarketMeReactNative"
+        const val TAG = "GoMarketMeReactNative"
+        const val IS_DEBUG_LOGGING_ENABLED = false
+    }
+}

package/android/src/main/java/co/gomarketme/reactnative/GoMarketMeReactNativePackage.kt

@@ -0,0 +1,16 @@
+package co.gomarketme.reactnative
+
+import com.facebook.react.ReactPackage
+import com.facebook.react.bridge.NativeModule
+import com.facebook.react.bridge.ReactApplicationContext
+import com.facebook.react.uimanager.ViewManager
+
+class GoMarketMeReactNativePackage : ReactPackage {
+    override fun createNativeModules(reactContext: ReactApplicationContext): List<NativeModule> {
+        return listOf(GoMarketMeReactNativeModule(reactContext))
+    }
+
+    override fun createViewManagers(reactContext: ReactApplicationContext): List<ViewManager<*, *>> {
+        return emptyList()
+    }
+}

package/gomarketme-react-native.podspec

@@ -0,0 +1,18 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name         = 'gomarketme-react-native'
+  s.version      = package['version']
+  s.summary      = package['description']
+  s.homepage     = package['homepage']
+  s.license      = package['license']
+  s.author       = package['author']
+  s.source       = { :git => package['repository']['url'], :tag => s.version.to_s }
+  s.platforms    = { :ios => '15.0' }
+  s.source_files = 'ios/**/*.{h,m,mm,swift}'
+  s.vendored_frameworks = 'ios/Frameworks/GoMarketMeAppleCoreKit.xcframework'
+  s.dependency 'React-Core'
+  s.swift_version = '5.9'
+end

package/ios/Frameworks/GoMarketMeAppleCoreKit.xcframework/Info.plist

@@ -0,0 +1,44 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>AvailableLibraries</key>
+	<array>
+		<dict>
+			<key>BinaryPath</key>
+			<string>GoMarketMeAppleCoreKit.framework/GoMarketMeAppleCoreKit</string>
+			<key>LibraryIdentifier</key>
+			<string>ios-arm64_x86_64-simulator</string>
+			<key>LibraryPath</key>
+			<string>GoMarketMeAppleCoreKit.framework</string>
+			<key>SupportedArchitectures</key>
+			<array>
+				<string>arm64</string>
+				<string>x86_64</string>
+			</array>
+			<key>SupportedPlatform</key>
+			<string>ios</string>
+			<key>SupportedPlatformVariant</key>
+			<string>simulator</string>
+		</dict>
+		<dict>
+			<key>BinaryPath</key>
+			<string>GoMarketMeAppleCoreKit.framework/GoMarketMeAppleCoreKit</string>
+			<key>LibraryIdentifier</key>
+			<string>ios-arm64</string>
+			<key>LibraryPath</key>
+			<string>GoMarketMeAppleCoreKit.framework</string>
+			<key>SupportedArchitectures</key>
+			<array>
+				<string>arm64</string>
+			</array>
+			<key>SupportedPlatform</key>
+			<string>ios</string>
+		</dict>
+	</array>
+	<key>CFBundlePackageType</key>
+	<string>XFWK</string>
+	<key>XCFrameworkFormatVersion</key>
+	<string>1.0</string>
+</dict>
+</plist>