@screeb/react-native 0.4.0

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+Copyright (c) 2021 Screeb
+
+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,124 @@
+# @screeb/react-native
+
+A react-native module to integrate Screeb mobile sdk for Android and/or iOS.
+
+## Installation
+
+```sh
+npm install @screeb/react-native
+```
+
+## iOS specific configuration
+You should set IOS target build configuration `BUILD_LIBRARY_FOR_DISTRIBUTION` to `YES` in your `Podfile` to avoid runtime crash:
+```ruby
+post_install do |installer|
+  ...
+  installer.pods_project.targets.each do |target|
+    ...
+
+    target.build_configurations.each do |config|
+      ...
+      config.build_settings['BUILD_LIBRARY_FOR_DISTRIBUTION'] = 'YES'
+    end
+  end
+end
+```
+
+## Android specific configuration
+
+First, you should use MultidexApplication if not yet to avoid compilation issues.
+
+```
+defaultConfig {
+    (...)
+    multiDexEnabled true
+}
+(...)
+dependencies {
+   (...)
+   implementation 'androidx.multidex:multidex:2.0.1'
+}
+```
+
+Then, the Android sdk needs to be notified of activities lifecycle changes to be correctly started.
+
+It is mandatory to pass the Application context to the module in your custom Application class
+in the `onCreate` function :
+
+```kotlin
+override fun onCreate() {
+    super.onCreate()
+    ScreebModuleModule.setAppContext(this)
+}
+```
+
+## Usage
+
+```js
+import { initSdk, trackScreen, trackEvent, setProperties, setIdentity } from "@screeb/react-native";
+
+// Init the sdk at app start (useEffect hook used here, but componentDidMount is fine)
+React.useEffect(() => {
+   initSdk(
+      "<android-channel-id>",
+      "<ios-channel-id>",
+      "<user-identity>",
+      {
+         'example-prop1': false,
+         'example-prop2': 29,
+         'example-prop3' : 'iPhone 13',
+      }
+   );
+}, []);
+
+(...)
+
+// SetIdentity command :
+setIdentity(
+    '<user-identity>',
+    {
+        'example-prop1': false,
+        'example-prop2': 29,
+        'example-prop3' : 'iPhone 13',
+    }
+);
+
+(...)
+
+// trackEvent command :
+trackEvent(
+    '<event-name>',
+    {
+        'example-prop1': false,
+        'example-prop2': 29,
+        'example-prop3' : 'iPhone 13',
+    }
+);
+
+(...)
+
+// trackScreen command :
+trackScreen(
+    '<screen-name>',
+    {
+        'example-prop1': false,
+        'example-prop2': 29,
+        'example-prop3' : 'iPhone 13',
+    }
+);
+
+(...)
+
+// setProperties command :
+setProperties(
+    {
+        'example-prop1': false,
+        'example-prop2': 29,
+        'example-prop3' : 'iPhone 13',
+    }
+);
+```
+
+## License
+
+MIT

package/android/build.gradle

@@ -0,0 +1,129 @@
+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['ScreebModule_kotlinVersion']
+
+  repositories {
+    google()
+    mavenCentral()
+  }
+
+  dependencies {
+    classpath 'com.android.tools.build:gradle:3.2.1'
+    // noinspection DifferentKotlinGradleVersion
+    classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
+  }
+}
+
+apply plugin: 'com.android.library'
+apply plugin: 'kotlin-android'
+
+def getExtOrDefault(name) {
+  return rootProject.ext.has(name) ? rootProject.ext.get(name) : project.properties['ScreebModule_' + name]
+}
+
+def getExtOrIntegerDefault(name) {
+  return rootProject.ext.has(name) ? rootProject.ext.get(name) : (project.properties['ScreebModule_' + name]).toInteger()
+}
+
+android {
+  compileSdkVersion getExtOrIntegerDefault('compileSdkVersion')
+  defaultConfig {
+    minSdkVersion 16
+    targetSdkVersion getExtOrIntegerDefault('targetSdkVersion')
+    versionCode 1
+    versionName "0.2.0"
+
+  }
+
+  buildTypes {
+    release {
+      minifyEnabled false
+    }
+  }
+  lintOptions {
+    disable 'GradleCompatible'
+  }
+  compileOptions {
+    sourceCompatibility JavaVersion.VERSION_1_8
+    targetCompatibility JavaVersion.VERSION_1_8
+  }
+}
+
+repositories {
+  mavenCentral()
+  google()
+
+  def found = false
+  def defaultDir = null
+  def androidSourcesName = 'React Native sources'
+
+  if (rootProject.ext.has('reactNativeAndroidRoot')) {
+    defaultDir = rootProject.ext.get('reactNativeAndroidRoot')
+  } else {
+    defaultDir = new File(
+            projectDir,
+            '/../../../node_modules/react-native/android'
+    )
+  }
+
+  if (defaultDir.exists()) {
+    maven {
+      url defaultDir.toString()
+      name androidSourcesName
+    }
+
+    logger.info(":${project.name}:reactNativeAndroidRoot ${defaultDir.canonicalPath}")
+    found = true
+  } else {
+    def parentDir = rootProject.projectDir
+
+    1.upto(5, {
+      if (found) return true
+      parentDir = parentDir.parentFile
+
+      def androidSourcesDir = new File(
+              parentDir,
+              'node_modules/react-native'
+      )
+
+      def androidPrebuiltBinaryDir = new File(
+              parentDir,
+              'node_modules/react-native/android'
+      )
+
+      if (androidPrebuiltBinaryDir.exists()) {
+        maven {
+          url androidPrebuiltBinaryDir.toString()
+          name androidSourcesName
+        }
+
+        logger.info(":${project.name}:reactNativeAndroidRoot ${androidPrebuiltBinaryDir.canonicalPath}")
+        found = true
+      } else if (androidSourcesDir.exists()) {
+        maven {
+          url androidSourcesDir.toString()
+          name androidSourcesName
+        }
+
+        logger.info(":${project.name}:reactNativeAndroidRoot ${androidSourcesDir.canonicalPath}")
+        found = true
+      }
+    })
+  }
+
+  if (!found) {
+    throw new GradleException(
+            "${project.name}: unable to locate React Native android sources. " +
+                    "Ensure you have you installed React Native as a dependency in your project and try again."
+    )
+  }
+}
+
+def kotlin_version = getExtOrDefault('kotlinVersion')
+
+dependencies {
+  // noinspection GradleDynamicVersion
+  api 'com.facebook.react:react-native:+'
+  implementation "app.screeb.sdk:survey:1.6.0"
+  implementation "org.jetbrains.kotlin:kotlin-stdlib:1.6.10"
+}

package/android/gradle.properties

@@ -0,0 +1,3 @@
+ScreebModule_kotlinVersion=1.6.0
+ScreebModule_compileSdkVersion=29
+ScreebModule_targetSdkVersion=29

package/android/src/main/AndroidManifest.xml

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

package/android/src/main/java/com/screebmodule/ScreebModuleModule.kt

@@ -0,0 +1,82 @@
+package com.screebmodule
+
+import com.facebook.react.bridge.ReactApplicationContext
+import com.facebook.react.bridge.ReactContextBaseJavaModule
+import com.facebook.react.bridge.ReactMethod
+import com.facebook.react.bridge.Promise
+import com.facebook.react.bridge.ReadableMap
+import java.util.HashMap
+import androidx.annotation.NonNull
+import android.content.Context
+import android.util.Log
+import app.screeb.sdk.Screeb
+
+class ScreebModuleModule(reactContext: ReactApplicationContext) :
+  ReactContextBaseJavaModule(reactContext) {
+
+  override fun getName(): String {
+    return "ScreebModule"
+  }
+
+  @ReactMethod
+  fun initSdk(channelId: String, userId: String?, properties: ReadableMap?) {
+    Log.d("ScreebModule", "Called setIdentity : $userId")
+    var map: HashMap<String, Any?>? = null
+    if (properties != null) {
+      map = properties.toHashMap()
+    }
+    screeb?.pluginInit(channelId, userId, map)
+  }
+
+  @ReactMethod
+  fun setIdentity(userId: String, properties: ReadableMap?) {
+    Log.d("ScreebModule", "Called setIdentity : $userId")
+    var map: HashMap<String, Any?>? = null
+    if (properties != null) {
+      map = properties.toHashMap()
+    }
+    screeb?.setIdentity(userId, map)
+  }
+
+  @ReactMethod
+  fun trackEvent(eventId: String, properties: ReadableMap?) {
+    Log.d("ScreebModule", "Called trackEvent : $eventId")
+    var map: HashMap<String, Any?>? = null
+    if (properties != null) {
+      map = properties.toHashMap()
+    }
+    screeb?.trackEvent(eventId, map)
+  }
+
+  @ReactMethod
+  fun trackScreen(screen: String, properties: ReadableMap?) {
+    Log.d("ScreebModule", "Called trackScreen : $screen")
+    var map: HashMap<String, Any?>? = null
+    if (properties != null) {
+      map = properties.toHashMap()
+    }
+    screeb?.trackScreen(screen, map)
+  }
+
+  @ReactMethod
+  fun setProperties(properties: ReadableMap) {
+    Log.d(
+      "ScreebModule",
+      "Called setVisitorProperties with " + properties.toHashMap().size + " properties"
+    )
+    screeb?.setVisitorProperties(properties.toHashMap())
+  }
+
+  companion object {
+    var screeb: Screeb? = null
+
+    @JvmStatic
+    fun setAppContext(context: Context){
+      screeb = Screeb.Builder()
+        .withContext(context)
+        .withPluginMode(true)
+        .build()
+    }
+
+  }
+}

package/android/src/main/java/com/screebmodule/ScreebModulePackage.kt

@@ -0,0 +1,17 @@
+package com.screebmodule
+
+import com.facebook.react.ReactPackage
+import com.facebook.react.bridge.NativeModule
+import com.facebook.react.bridge.ReactApplicationContext
+import com.facebook.react.uimanager.ViewManager
+
+
+class ScreebModulePackage : ReactPackage {
+    override fun createNativeModules(reactContext: ReactApplicationContext): List<NativeModule> {
+        return listOf(ScreebModuleModule(reactContext))
+    }
+
+    override fun createViewManagers(reactContext: ReactApplicationContext): List<ViewManager<*, *>> {
+        return emptyList()
+    }
+}

package/ios/ScreebModule-Bridging-Header.h

@@ -0,0 +1,2 @@
+#import <React/RCTBridgeModule.h>
+#import <React/RCTViewManager.h>

package/ios/ScreebModule.m

@@ -0,0 +1,14 @@
+#import <React/RCTBridgeModule.h>
+
+@interface RCT_EXTERN_MODULE(ScreebModule, NSObject)
+
+RCT_EXTERN_METHOD(initSdk:(NSString *)channelId userId:(NSString *)userId_  properties:(NSDictionary<NSString *, id> *)properties_)
+RCT_EXTERN_METHOD(setIdentity:(NSString *)userId properties:(NSDictionary<NSString *, id> *)properties_)
+RCT_EXTERN_METHOD(trackEvent:(NSString *)eventId properties:(NSDictionary<NSString *, id> *)properties_)
+RCT_EXTERN_METHOD(trackScreen:(NSString *)screen properties:(NSDictionary<NSString *, id> *)properties_)
+RCT_EXTERN_METHOD(setProperties:(NSDictionary<NSString *, id> *)properties)
++ (BOOL)requiresMainQueueSetup
+{
+  return YES;
+}
+@end

package/ios/ScreebModule.swift

@@ -0,0 +1,70 @@
+import Screeb
+import UIKit
+
+@objc(ScreebModule)
+class ScreebModule: NSObject {
+
+  @objc(initSdk:userId:properties:)
+  func initSdk(
+      _ channelId: String,
+      userId userId_: String?,
+      properties properties_: [String: Any]?) {
+    var map: [String: AnyEncodable?] = [:]
+    if (properties_ != nil) {
+        map = self.mapToAnyEncodable(map: properties_!)
+    }
+    if let controller = UIApplication.shared.keyWindow?.rootViewController {
+        Screeb.initSdk(context: controller, channelId: channelId, identity: userId_, visitorProperty: map)
+    } else {
+        print("Screeb : error init, could not find rootViewController")
+    }
+  }
+
+  @objc func setIdentity(_ userId: String, properties properties_: [String: Any]?) {
+    var map: [String: AnyEncodable?] = [:]
+    if (properties_ != nil) {
+        map = self.mapToAnyEncodable(map: properties_!)
+    }
+    Screeb.setIdentity(uniqueVisitorId: userId, visitorProperty: map)
+  }
+
+  @objc func trackEvent(_ eventId: String, properties properties_: [String: Any]?) {
+    var map: [String: AnyEncodable?] = [:]
+    if (properties_ != nil) {
+        map = self.mapToAnyEncodable(map: properties_!)
+    }
+    Screeb.trackEvent(name: eventId, trackingEventProperties: map)
+  }
+
+  @objc func trackScreen(_ screen: String, properties properties_: [String: Any]?) {
+    var map: [String: AnyEncodable?] = [:]
+    if (properties_ != nil) {
+        map = self.mapToAnyEncodable(map: properties_!)
+    }
+    Screeb.trackScreen(name: screen, trackingEventProperties: map)
+  }
+
+  @objc(setProperties:)
+  func setVisitorPropertiesImpl(_ properties: [String: Any]) {
+    let map = self.mapToAnyEncodable(map: properties)
+    Screeb.visitorProperty(visitorProperty: map)
+  }
+
+  private func mapToAnyEncodable(map: [String: Any]) -> [String: AnyEncodable?] {
+      return map.mapValues{
+          value in
+          switch value {
+          case is String:
+              return AnyEncodable(value as! String)
+          case is Bool:
+              return AnyEncodable(value as! Bool)
+          case is Float:
+              return AnyEncodable(value as! Float)
+          case is Int:
+              return AnyEncodable(value as! Int)
+          default: break
+          }
+          return nil
+      }
+  }
+}