affise-attribution-lib 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Affise, Inc. | https://affise.com
+
+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

@@ -0,0 +1,549 @@
+# Affise Attribution React Native library
+
+- [Affise Attribution React Native library](#affise-attribution-react-native-library)
+- [Description](#description)
+  - [Quick start](#quick-start)
+  - [Integration](#integration)
+    - [Integrate npm package](#integrate-npm-package)
+    - [Initialize](#initialize)
+    - [Requirements](#requirements)
+      - [Android](#android)
+      - [iOS](#ios)
+- [Features](#features)
+    - [Device identifiers collection](#device-identifiers-collection)
+    - [Events tracking](#events-tracking)
+    - [Custom events tracking](#custom-events-tracking)
+    - [Predefined event parameters](#predefined-event-parameters)
+    - [Events buffering](#events-buffering)
+    - [Advertising Identifier (google) tracking](#advertising-identifier-google-tracking)
+    - [Open Advertising Identifier (huawei) tracking](#open-advertising-identifier-huawei-tracking)
+    - [Install referrer tracking](#install-referrer-tracking)
+    - [Push token tracking](#push-token-tracking)
+    - [Reinstall Uninstall tracking](#reinstall-uninstall-tracking)
+    - [APK preinstall tracking](#apk-preinstall-tracking)
+    - [Deeplinks](#deeplinks)
+      - [Android](#android-1)
+    - [Offline mode](#offline-mode)
+    - [Disable tracking](#disable-tracking)
+    - [Disable background tracking](#disable-background-tracking)
+    - [GDPR right to be forgotten](#gdpr-right-to-be-forgotten)
+    - [Get referrer](#get-referrer)
+
+# Description
+
+Affise SDK is a software you can use to collect app usage statistics, device identifiers, deeplink usage, track install
+referrer.
+
+## Quick start
+
+## Integration
+
+### Integrate npm package
+
+This is a [Node.js](https://nodejs.org/en/) module available through the
+[npm registry](https://www.npmjs.com/).
+
+Installation is done using the
+[`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):
+
+```console
+npm install affise-attribution-lib
+```
+
+
+### Initialize
+
+After dependency is added, and  project is sync with `npm install` and initialize.
+
+
+```typescript
+import {
+  Affise, 
+  AffiseInitProperties
+} from 'affise-attribution-lib';
+
+
+export default function App() {
+
+    React.useEffect(() => {
+        Affise.init(
+            new AffiseInitProperties(
+                'appId',
+                false,
+                'partParamName',
+                'partParamNameToken',
+                'appToken',
+                'secretId'
+            )
+        );
+    });
+
+    return (
+        <SafeAreaView>
+        </SafeAreaView>
+    );
+}
+```
+
+
+### Requirements
+
+#### Android
+Minimal Android SDK version is 21
+
+For a minimal working functionality your app needs to declare internet permission:
+
+```xml
+<manifest>
+    <uses-permission android:name="android.permission.INTERNET"/>
+</manifest>
+```
+
+OAID certificate in your project
+`example/android/app/src/main/assets/oaid.cert.pem`
+
+#### iOS
+
+Add key `NSUserTrackingUsageDescription` to `Info.plist` as in `example/ios/AffiseAttributionLibExample/Info.plist`
+
+```html
+<key>NSUserTrackingUsageDescription</key>
+<string>This identifier will be used for tracking.</string>
+```
+
+
+# Features
+
+### Device identifiers collection
+
+To match users with events and data library is sending, these identifiers are collected:
+
+- `AFFISE_APP_ID`
+- `AFFISE_PKG_APP_NAME`
+- `AFFISE_APP_NAME_DASHBOARD`
+- `APP_VERSION`
+- `APP_VERSION_RAW`
+- `STORE`
+- `TRACKER_TOKEN`
+- `TRACKER_NAME`
+- `FIRST_TRACKER_TOKEN`
+- `FIRST_TRACKER_NAME`
+- `LAST_TRACKER_TOKEN`
+- `LAST_TRACKER_NAME`
+- `OUTDATED_TRACKER_TOKEN`
+- `INSTALLED_TIME`
+- `FIRST_OPEN_TIME`
+- `INSTALLED_HOUR`
+- `FIRST_OPEN_HOUR`
+- `INSTALL_BEGIN_TIME`
+- `INSTALL_FINISH_TIME`
+- `REFERRAL_TIME`
+- `CREATED_TIME`
+- `CREATED_TIME_MILLI`
+- `CREATED_TIME_HOUR`
+- `UNINSTALL_TIME`
+- `REINSTALL_TIME`
+- `LAST_SESSION_TIME`
+- `CONNECTION_TYPE`
+- `CPU_TYPE`
+- `HARDWARE_NAME`
+- `NETWORK_TYPE`
+- `DEVICE_MANUFACTURER`
+- `PROXY_IP_ADDRESS`
+- `DEEPLINK_CLICK`
+- `DEVICE_ATLAS_ID`
+- `AFFISE_DEVICE_ID`
+- `AFFISE_ALT_DEVICE_ID`
+- `ADID`
+- `ANDROID_ID`
+- `ANDROID_ID_MD5`
+- `MAC_SHA1`
+- `MAC_MD5`
+- `GAID_ADID`
+- `GAID_ADID_MD5`
+- `OAID`
+- `OAID_MD5`
+- `REFTOKEN`
+- `REFTOKENS`
+- `REFERRER`
+- `USER_AGENT`
+- `MCCODE`
+- `MNCODE`
+- `ISP`
+- `REGION`
+- `COUNTRY`
+- `LANGUAGE`
+- `DEVICE_NAME`
+- `DEVICE_TYPE`
+- `OS_NAME`
+- `PLATFORM`
+- `API_LEVEL_OS`
+- `AFFISE_SDK_VERSION`
+- `OS_VERSION`
+- `RANDOM_USER_ID`
+- `AFFISE_SDK_POS`
+- `TIMEZONE_DEV`
+- `LAST_TIME_SESSION`
+- `TIME_SESSION`
+- `AFFISE_SESSION_COUNT`
+- `LIFETIME_SESSION_COUNT`
+- `AFFISE_DEEPLINK`
+- `AFFISE_PART_PARAM_NAME`
+- `AFFISE_PART_PARAM_NAME_TOKEN`
+- `AFFISE_APP_TOKEN`
+- `LABEL`
+- `AFFISE_SDK_SECRET_ID`
+- `UUID`
+- `AFFISE_APP_OPENED`
+- `PUSHTOKEN`
+- `EVENTS`
+- `AFFISE_EVENTS_COUNT`
+
+### Events tracking
+
+For example, we want to track what items usually user adds to shopping cart. To send event first create it with
+following code
+
+```typescript
+import {Affise, AddToCartEvent} from 'affise-attribution-lib';
+
+
+class Presenter {
+  onUserAddsItemsToCart(item: string) {
+    const items = {
+      items: "cookies, potato, milk",
+    };
+
+    Affise.sendEvent(
+      AddToCartEvent(
+        items,
+        Date.now(),
+        "groceries"
+      )
+    );
+  }
+}
+```
+
+With above example you can implement other events:
+
+- `AchieveLevelEvent`
+- `AddPaymentInfoEvent`
+- `AddToCartEvent`
+- `AddToWishlistEvent`
+- `ClickAdvEvent`
+- `CompleteRegistrationEvent`
+- `CompleteStreamEvent`
+- `CompleteTrialEvent`
+- `CompleteTutorialEvent`
+- `ContentItemsViewEvent`
+- `DeepLinkedEvent`
+- `InitiatePurchaseEvent`
+- `InitiateStreamEvent`
+- `InviteEvent`
+- `LastAttributedTouchEvent`
+- `ListViewEvent`
+- `LoginEvent`
+- `OpenedFromPushNotificationEvent`
+- `PurchaseEvent`
+- `RateEvent`
+- `ReEngageEvent`
+- `ReserveEvent`
+- `SearchEvent`
+- `ShareEvent`
+- `SpendCreditsEvent`
+- `StartRegistrationEvent`
+- `StartTrialEvent`
+- `StartTutorialEvent`
+- `SubscribeEvent`
+- `TravelBookingEvent`
+- `UnlockAchievementEvent`
+- `UnsubscribeEvent`
+- `UpdateEvent`
+- `ViewAdvEvent`
+- `ViewCartEvent`
+- `ViewItemEvent`
+- `ViewItemsEvent`
+
+### Custom events tracking
+
+Use any of custom events if default doesn't fit your scenario:
+
+- `CustomId01Event`
+- `CustomId02Event`
+- `CustomId03Event`
+- `CustomId04Event`
+- `CustomId05Event`
+- `CustomId06Event`
+- `CustomId07Event`
+- `CustomId08Event`
+- `CustomId09Event`
+- `CustomId10Event`
+
+### Predefined event parameters
+
+To enrich your event with another dimension, you can use predefined parameters for most common cases.
+Add it to any event:
+
+```typescript
+import {Affise, AddToCartEvent, PredefinedParameters} from 'affise-attribution-lib';
+
+class Presenter {
+  onUserAddsItemsToCart(item: string) {
+    const items = {
+      "items": "cookies, potato, milk",
+    };
+
+    const event = AddToCartEvent(
+      items,
+      Date.now(),
+    );
+
+    event.addPredefinedParameter(PredefinedParameters.DESCRIPTION, "best before 2029");
+
+    Affise.sendEvent(event);
+  }
+}
+```
+
+
+In examples above `PredefinedParameters.DESCRIPTION` is used, but many others is available:
+- `ADREV_AD_TYPE`
+- `CITY`
+- `COUNTRY`
+- `REGION`
+- `CLASS`
+- `CONTENT`
+- `CONTENT_ID`
+- `CONTENT_LIST`
+- `CONTENT_TYPE`
+- `CURRENCY`
+- `CUSTOMER_USER_ID`
+- `DATE_A`
+- `DATE_B`
+- `DEPARTING_ARRIVAL_DATE`
+- `DEPARTING_DEPARTURE_DATE`
+- `DESCRIPTION`
+- `DESTINATION_A`
+- `DESTINATION_B`
+- `DESTINATION_LIST`
+- `HOTEL_SCORE`
+- `LEVEL`
+- `MAX_RATING_VALUE`
+- `NUM_ADULTS`
+- `NUM_CHILDREN`
+- `NUM_INFANTS`
+- `ORDER_ID`
+- `PAYMENT_INFO_AVAILABLE`
+- `PREFERRED_NEIGHBORHOODS`
+- `PREFERRED_NUM_STOPS`
+- `PREFERRED_PRICE_RANGE`
+- `PREFERRED_STAR_RATINGS`
+- `PRICE`
+- `PURCHASE_CURRENCY`
+- `QUANTITY`
+- `RATING_VALUE`
+- `RECEIPT_ID`
+- `REGISTRATION_METHOD`
+- `RETURNING_ARRIVAL_DATE`
+- `RETURNING_DEPARTURE_DATE`
+- `REVENUE`
+- `SCORE`
+- `SEARCH_STRING`
+- `SUBSCRIPTION_ID`
+- `SUCCESS`
+- `SUGGESTED_DESTINATIONS`
+- `SUGGESTED_HOTELS`
+- `TRAVEL_START`
+- `TRAVEL_END`
+- `USER_SCORE`
+- `VALIDATED`
+- `ACHIEVEMENT_ID`
+- `COUPON_CODE`
+- `CUSTOMER_SEGMENT`
+- `DEEP_LINK`
+- `EVENT_START`
+- `EVENT_END`
+- `LAT`
+- `LONG`
+- `NEW_VERSION`
+- `OLD_VERSION`
+- `REVIEW_TEXT`
+- `TUTORIAL_ID`
+- `VIRTUAL_CURRENCY_NAME`
+- `PARAM_01`
+- `PARAM_02`
+- `PARAM_03`
+- `PARAM_04`
+- `PARAM_05`
+- `PARAM_06`
+- `PARAM_07`
+- `PARAM_08`
+- `PARAM_09`
+
+
+### Events buffering
+
+Affise library will send any pending events with first opportunity,
+but if there is no network connection or device is disabled, events are kept locally for 7 days before deletion.
+
+
+### Advertising Identifier (google) tracking
+
+Advertising Identifier (google) tracking is supported automatically, no actions needed
+
+### Open Advertising Identifier (huawei) tracking
+
+Open Advertising Identifier is supported automatically, no actions needed
+
+### Install referrer tracking
+
+Install referrer tracking is supported automatically, no actions needed
+
+### Push token tracking
+
+To let affise track push token you need to receive it from your push service provider, and pass to Affise library.
+First add firebase integration to your app completing theese steps: https://firebase.google.com/docs/cloud-messaging/android/client
+
+After you have done with firebase inegration, add to your cloud messaging service `onNewToken` method `Affise.addPushToken(token)`
+
+```typescript
+import {Affise} from 'affise-attribution-lib';
+import messaging from '@react-native-firebase/messaging';
+
+const getToken = async () => {
+    const token = await messaging().getToken();
+    if (token) {
+        Affise.addPushToken(token);
+    }
+}
+```
+
+### Reinstall Uninstall tracking
+
+Affise automatically track reinstall events by using silent-push technology, to make this feature work, pass push token when it is recreated by user and on you application starts up
+```typescript
+Affise.addPushToken(token);
+```
+
+### APK preinstall tracking
+
+SDK is also supports scenario when APK is installed not from one of application markets, such as google play, huawei appgallery or amazon appstore
+To use this feature, create file with name `partner_key` in your app assets directory, and write unique identifier inside, this key will be passed to our backend so you can track events by partner later in your Affise console.
+
+### Deeplinks
+
+- register applink callback right after Affise.init(..)
+
+```typescript
+Affise.registerDeeplinkCallback((uri) => {
+
+});
+
+```
+
+#### Android
+
+To integrate applink support in android you need:
+
+- add intent filter to one of your activities, replacing YOUR_AFFISE_APP_ID with id from your affise personal cabinet
+
+```xml
+<intent-filter android:autoVerify="true">
+  <action android:name="android.intent.action.VIEW" />
+  <category android:name="android.intent.category.DEFAULT" />
+  <category android:name="android.intent.category.BROWSABLE" />
+  <data android:scheme="https" />
+  <data android:host="YOUR_AFFISE_APP_ID.affattr.com" />
+</intent-filter>
+```
+
+
+### Offline mode
+
+In some scenarious you would want to limit Affise network usage, to pause that activity call anywhere in your application following code after Affise init:
+
+```typescript
+Affise.init(..);
+Affise.setOfflineModeEnabled(true); // to enable offline mode
+Affise.setOfflineModeEnabled(false); // to disable offline mode
+```
+While offline mode is enabled, your metrics and other events are kept locally, and will be delivered once offline mode is disabled.
+Offline mode is persistent as Application lifecycle, and will be disabled with process termination automaticly.
+To check current offline mode status call:
+
+```typescript
+Affise.isOfflineModeEnabled(); // returns true or false describing current tracking state
+```
+
+### Disable tracking
+
+To disable any tracking activity, storing events and gathering device identifiers and metrics call anywhere in your application following code after Affise init:
+
+```typescript
+Affise.init(..);
+Affise.setTrackingEnabled(true); // to enable tracking
+Affise.setTrackingEnabled(false); // to disable tracking
+```
+
+By default tracking is enabled.
+
+While tracking mode is disabled, metrics and other identifiers is not generated locally.
+Keep in mind that this flag is persistent until app reinstall, and don't forget to reactivate tracking when needed.
+To check current status of tracking call:
+
+```typescript
+Affise.isTrackingEnabled().then(enabled => {
+    // returns true or false describing current tracking state
+});
+```
+
+### Disable background tracking
+
+To disable any background tracking activity, storing events and gathering device identifiers and metrics call anywhere in your application following code after Affise init:
+
+```typescript
+Affise.init(..);
+Affise.setBackgroundTrackingEnabled(true); // to enable background tracking
+Affise.setBackgroundTrackingEnabled(false); // to disable background tracking
+```
+
+By default background tracking is enabled.
+
+While background tracking mode is disabled, metrics and other identifiers is not generated locally.
+Background tracking mode is persistent as Application lifecycle, and will be re-enabled with process termination automatically.
+To check current status of background tracking call:
+
+```typescript
+Affise.isBackgroundTrackingEnabled().then(enabled => {
+    // returns true or false describing current background tracking state
+});
+```
+
+### GDPR right to be forgotten
+
+Under the EU's General Data Protection Regulation (GDPR): An individual has the right to have their personal data erased.
+To provide this functionality to user, as the app developer, you can call
+
+```typescript
+Affise.init(..);
+Affise.forget(); // to forget users data
+```
+After processing such request our backend servers will delete all users data.
+To prevent library from generating new events, disable tracking just before calling Affise.forget:
+
+```typescript
+Affise.init(..);
+Affise.setTrackingEnabled(false);
+Affise.forget(); // to forget users data
+```
+
+### Get referrer
+
+Use the next public method of SDK
+
+```typescript
+Affise.getReferrer().then(referrer => {
+    // returns referrer
+});
+```

package/affise-attribution-native.podspec

@@ -0,0 +1,37 @@
+require "json"
+
+package = JSON.parse(File.read(File.join(__dir__, "package.json")))
+folly_compiler_flags = '-DFOLLY_NO_CONFIG -DFOLLY_MOBILE=1 -DFOLLY_USE_LIBCPP=1 -Wno-comma -Wno-shorten-64-to-32'
+
+Pod::Spec.new do |s|
+  s.name         = "affise-attribution-native"
+  s.version      = package["version"]
+  s.summary      = package["description"]
+  s.homepage     = package["homepage"]
+  s.license      = package["license"]
+  s.authors      = package["author"]
+
+  s.platforms    = { :ios => "11.0" }
+  s.source       = { :git => "https://github.com/affise/sdk-react.git", :tag => "#{s.version}" }
+
+  s.source_files = "ios/**/*.{h,m,mm,swift}"
+
+  s.dependency "React-Core"
+  s.dependency 'AffiseAttributionLib', '~> 1.0.4'
+
+  # Don't install the dependencies when we run `pod install` in the old architecture.
+  if ENV['RCT_NEW_ARCH_ENABLED'] == '1' then
+    s.compiler_flags = folly_compiler_flags + " -DRCT_NEW_ARCH_ENABLED=1"
+    s.pod_target_xcconfig    = {
+        "HEADER_SEARCH_PATHS" => "\"$(PODS_ROOT)/boost\"",
+        "OTHER_CPLUSPLUSFLAGS" => "-DFOLLY_NO_CONFIG -DFOLLY_MOBILE=1 -DFOLLY_USE_LIBCPP=1",
+        "CLANG_CXX_LANGUAGE_STANDARD" => "c++17"
+    }
+    s.dependency "React-Codegen"
+    s.dependency "RCT-Folly"
+    s.dependency "RCTRequired"
+    s.dependency "RCTTypeSafety"
+    s.dependency "ReactCommon/turbomodule/core"
+
+  end
+end

package/android/build.gradle

@@ -0,0 +1,87 @@
+buildscript {
+  // Buildscript is evaluated before everything else so we can't use getExtOrDefault
+  def kotlin_version = rootProject.ext.has("kotlinVersion") ? rootProject.ext.get("kotlinVersion") : project.properties["AffiseAttributionNative_kotlinVersion"]
+
+  repositories {
+    google()
+    mavenCentral()
+  }
+
+  dependencies {
+    classpath "com.android.tools.build:gradle:7.2.1"
+    // noinspection DifferentKotlinGradleVersion
+    classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
+  }
+}
+
+def isNewArchitectureEnabled() {
+  return rootProject.hasProperty("newArchEnabled") && rootProject.getProperty("newArchEnabled") == "true"
+}
+
+apply plugin: "com.android.library"
+apply plugin: "kotlin-android"
+
+if (isNewArchitectureEnabled()) {
+  apply plugin: "com.facebook.react"
+}
+
+def getExtOrDefault(name) {
+  return rootProject.ext.has(name) ? rootProject.ext.get(name) : project.properties["AffiseAttributionNative_" + name]
+}
+
+def getExtOrIntegerDefault(name) {
+  return rootProject.ext.has(name) ? rootProject.ext.get(name) : (project.properties["AffiseAttributionNative_" + name]).toInteger()
+}
+
+android {
+  compileSdkVersion getExtOrIntegerDefault("compileSdkVersion")
+
+  defaultConfig {
+    minSdkVersion getExtOrIntegerDefault("minSdkVersion")
+    targetSdkVersion getExtOrIntegerDefault("targetSdkVersion")
+    buildConfigField "boolean", "IS_NEW_ARCHITECTURE_ENABLED", isNewArchitectureEnabled().toString()
+  }
+  buildTypes {
+    release {
+      minifyEnabled false
+    }
+  }
+
+  lintOptions {
+    disable "GradleCompatible"
+  }
+
+  compileOptions {
+    sourceCompatibility JavaVersion.VERSION_1_8
+    targetCompatibility JavaVersion.VERSION_1_8
+  }
+
+}
+
+repositories {
+  mavenCentral()
+  google()
+}
+
+def kotlin_version = getExtOrDefault("kotlinVersion")
+
+dependencies {
+  // For < 0.71, this will be from the local maven repo
+  // For > 0.71, this will be replaced by `com.facebook.react:react-android:$version` by react gradle plugin
+  //noinspection GradleDynamicVersion
+  implementation "com.facebook.react:react-native"
+  implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
+
+  implementation "com.android.installreferrer:installreferrer:2.2"
+
+  implementation fileTree(dir: "libs", include: ["attribution-release.aar"])
+  implementation fileTree(dir: "libs", include: ["oaid_sdk_1.0.26.aar"])
+}
+
+if (isNewArchitectureEnabled()) {
+  react {
+    jsRootDir = file("../src/")
+    libraryName = "AffiseAttributionNative"
+    codegenJavaPackageName = "com.affise.attribution.react"
+  }
+}

package/android/gradle.properties

@@ -0,0 +1,5 @@
+AffiseAttributionNative_kotlinVersion=1.7.0
+AffiseAttributionNative_minSdkVersion=21
+AffiseAttributionNative_targetSdkVersion=31
+AffiseAttributionNative_compileSdkVersion=31
+AffiseAttributionNative_ndkversion=21.4.7075529

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,4 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+          package="com.affise.attribution.react">
+
+</manifest>