@screeb/react-native 0.8.4 → 0.8.6

package/README.md

@@ -9,137 +9,9 @@
 
 A react-native module to integrate Screeb mobile sdk for Android and/or iOS.
 
-## Installation
+## How to install the React-Native SDK in your app ?
 
-```sh
-npm install @screeb/react-native
-```
-
-## iOS specific configuration
-
-Your Podfile needs the instruction **use_frameworks!** to correctly import Screeb dependencies.
-Then you should set IOS target build configuration `BUILD_LIBRARY_FOR_DISTRIBUTION` to `YES` in your `Podfile` to avoid runtime crash:
-```ruby
-use_frameworks!
-...
-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
-```
-
-When upgrading a Screeb sdk-reactnative version, it can be useful to run in /ios directory :
-```sh
-pod update Screeb
-```
-
-## 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)
-}
-```
-
-NB : Your android app needs to use AGP minimum 7.1.3
-
-```groovy
-classpath("com.android.tools.build:gradle:7.1.3")
-```
-
-## 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',
-    }
-);
-```
+[See here.](https://github.com/ScreebApp/developers/wiki/React-Native-SDK-install)
 
 ## Run example
 

package/android/build.gradle

@@ -124,6 +124,6 @@ def kotlin_version = getExtOrDefault('kotlinVersion')
 dependencies {
   // noinspection GradleDynamicVersion
   api 'com.facebook.react:react-native:+'
-  implementation "app.screeb.sdk:survey:1.9.2"
+  implementation "app.screeb.sdk:survey:1.10.1"
   implementation "org.jetbrains.kotlin:kotlin-stdlib:1.7.0"
 }

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

@@ -28,7 +28,7 @@ class ScreebModuleModule(reactContext: ReactApplicationContext) :
       map = properties.toHashMap()
     }
     Handler(Looper.getMainLooper()).post {
-      screeb?.pluginInit(channelId, userId, map)
+      Screeb?.pluginInit(channelId, userId, map)
     }
   }
 
@@ -40,7 +40,7 @@ class ScreebModuleModule(reactContext: ReactApplicationContext) :
       map = properties.toHashMap()
     }
     Handler(Looper.getMainLooper()).post {
-      screeb?.setIdentity(userId, map)
+      Screeb?.setIdentity(userId, map)
     }
   }
 
@@ -52,7 +52,7 @@ class ScreebModuleModule(reactContext: ReactApplicationContext) :
       map = properties.toHashMap()
     }
     Handler(Looper.getMainLooper()).post {
-      screeb?.trackEvent(eventId, map)
+      Screeb?.trackEvent(eventId, map)
     }
   }
 
@@ -64,7 +64,7 @@ class ScreebModuleModule(reactContext: ReactApplicationContext) :
       map = properties.toHashMap()
     }
     Handler(Looper.getMainLooper()).post {
-      screeb?.trackScreen(screen, map)
+      Screeb?.trackScreen(screen, map)
     }
   }
 
@@ -75,19 +75,41 @@ class ScreebModuleModule(reactContext: ReactApplicationContext) :
       "Called setVisitorProperties with " + properties.toHashMap().size + " properties"
     )
     Handler(Looper.getMainLooper()).post {
-      screeb?.setVisitorProperties(properties.toHashMap())
+      Screeb?.setVisitorProperties(properties.toHashMap())
+    }
+  }
+
+  @ReactMethod
+  fun startSurvey(surveyId: String, allowMultipleResponses: Boolean, hiddenFields: ReadableMap? = null) {
+    Log.e("ScreebModule", "Called startSurvey : $surveyId")
+    var map: HashMap<String, Any>? = null
+    if (hiddenFields != null) {
+      map = hiddenFields.toHashMap()
+    }
+    Handler(Looper.getMainLooper()).post {
+      Screeb?.startSurvey(surveyId, allowMultipleResponses, map)
+    }
+  }
+
+  @ReactMethod
+  fun assignGroup(type: String? = null, name: String, properties: ReadableMap? = null) {
+    Log.d("ScreebModule", "Called assignGroup : $name")
+    var map: HashMap<String, Any>? = null
+    if (properties != null) {
+      map = properties.toHashMap()
+    }
+    Handler(Looper.getMainLooper()).post {
+      Screeb?.assignGroup(type, name, map)
     }
   }
 
   companion object {
-    var screeb: Screeb? = null
 
     @JvmStatic
     fun setAppContext(context: Context){
-      screeb = Screeb.Builder()
-        .withContext(context)
-        .withPluginMode(true)
-        .build()
+      Screeb.initSdkWithContextOnly(
+        context
+      )
     }
 
   }

package/ios/ScreebModule.m

@@ -7,6 +7,8 @@ RCT_EXTERN_METHOD(setIdentity:(NSString *)userId properties:(NSDictionary<NSStri
 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)
+RCT_EXTERN_METHOD(startSurvey:(NSString *)surveyId allowMultipleResponses:(BOOL)allowMultipleResponses_ hiddenFields:(NSDictionary<NSString *, id> *)hiddenFields_)
+RCT_EXTERN_METHOD(assignGroup:(NSString *)type name:(NSString *)name_ properties:(NSDictionary<NSString *, id> *)properties_)
 + (BOOL)requiresMainQueueSetup
 {
   return YES;

package/ios/ScreebModule.swift

@@ -61,6 +61,26 @@ class ScreebModule: NSObject {
     }
   }
 
+  @objc func startSurvey(_ surveyId: String, allowMultipleResponses allowMultipleResponses_: Bool, hiddenFields hiddenFields_: [String: Any]?) {
+    var map: [String: AnyEncodable] = [:]
+    if (hiddenFields_ != nil) {
+        map = self.mapToAnyEncodable(map: hiddenFields_!).filter({ $0.value != nil }).mapValues({ $0! })
+    }
+    DispatchQueue.main.async {
+      Screeb.startSurvey(surveyId: surveyId, allowMultipleResponses: allowMultipleResponses_, hiddenFields: map)
+    }
+  }
+
+  @objc func assignGroup(_ type: String?, name name_: String, properties properties_: [String: Any]?) {
+    var map: [String: AnyEncodable] = [:]
+    if (properties_ != nil) {
+        map = self.mapToAnyEncodable(map: properties_!).filter({ $0.value != nil }).mapValues({ $0! })
+    }
+    DispatchQueue.main.async {
+      Screeb.assignGroup(type: type, name: name_, properties: map)
+    }
+  }
+
   private func mapToAnyEncodable(map: [String: Any]) -> [String: AnyEncodable?] {
       return map.mapValues{
           value in

package/lib/commonjs/index.js

@@ -0,0 +1,48 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.initSdk = initSdk;
+exports.setIdentity = setIdentity;
+exports.setProperties = setProperties;
+exports.trackEvent = trackEvent;
+exports.trackScreen = trackScreen;
+
+var _reactNative = require("react-native");
+
+const LINKING_ERROR = `The package '@screeb/react-native' doesn't seem to be linked. Make sure: \n\n` + _reactNative.Platform.select({
+  ios: "- You have run 'pod install'\n",
+  default: ''
+}) + '- You rebuilt the app after installing the package\n' + '- You are not using Expo managed workflow\n';
+const ScreebModule = _reactNative.NativeModules.ScreebModule ? _reactNative.NativeModules.ScreebModule : new Proxy({}, {
+  get() {
+    throw new Error(LINKING_ERROR);
+  }
+
+});
+
+function initSdk(androidChannelId, iosChannelId, userId, properties) {
+  if (_reactNative.Platform.OS === 'ios') {
+    return ScreebModule.initSdk(iosChannelId, userId, properties);
+  } else {
+    return ScreebModule.initSdk(androidChannelId, userId, properties);
+  }
+}
+
+function setIdentity(userId, properties) {
+  return ScreebModule.setIdentity(userId, properties);
+}
+
+function trackEvent(name, properties) {
+  return ScreebModule.trackEvent(name, properties);
+}
+
+function trackScreen(name, properties) {
+  return ScreebModule.trackScreen(name, properties);
+}
+
+function setProperties(properties) {
+  return ScreebModule.setProperties(properties);
+}
+//# sourceMappingURL=index.js.map

package/lib/commonjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["index.tsx"],"names":["LINKING_ERROR","Platform","select","ios","default","ScreebModule","NativeModules","Proxy","get","Error","initSdk","androidChannelId","iosChannelId","userId","properties","OS","setIdentity","trackEvent","name","trackScreen","setProperties"],"mappings":";;;;;;;;;;;AAAA;;AAEA,MAAMA,aAAa,GAChB,+EAAD,GACAC,sBAASC,MAAT,CAAgB;AAAEC,EAAAA,GAAG,EAAE,gCAAP;AAAyCC,EAAAA,OAAO,EAAE;AAAlD,CAAhB,CADA,GAEA,sDAFA,GAGA,6CAJF;AAMA,MAAMC,YAAY,GAAGC,2BAAcD,YAAd,GACjBC,2BAAcD,YADG,GAEjB,IAAIE,KAAJ,CACE,EADF,EAEE;AACEC,EAAAA,GAAG,GAAG;AACJ,UAAM,IAAIC,KAAJ,CAAUT,aAAV,CAAN;AACD;;AAHH,CAFF,CAFJ;;AAWO,SAASU,OAAT,CACHC,gBADG,EAEHC,YAFG,EAGHC,MAHG,EAIHC,UAJG,EAI4B;AACjC,MAAIb,sBAASc,EAAT,KAAgB,KAApB,EAA2B;AACzB,WAAOV,YAAY,CAACK,OAAb,CAAqBE,YAArB,EAAmCC,MAAnC,EAA2CC,UAA3C,CAAP;AACD,GAFD,MAEO;AACL,WAAOT,YAAY,CAACK,OAAb,CAAqBC,gBAArB,EAAuCE,MAAvC,EAA+CC,UAA/C,CAAP;AACD;AACF;;AACM,SAASE,WAAT,CAAqBH,MAArB,EAAqCC,UAArC,EAAoE;AACzE,SAAOT,YAAY,CAACW,WAAb,CAAyBH,MAAzB,EAAiCC,UAAjC,CAAP;AACD;;AACM,SAASG,UAAT,CAAoBC,IAApB,EAAkCJ,UAAlC,EAAiE;AACtE,SAAOT,YAAY,CAACY,UAAb,CAAwBC,IAAxB,EAA8BJ,UAA9B,CAAP;AACD;;AACM,SAASK,WAAT,CAAqBD,IAArB,EAAmCJ,UAAnC,EAAkE;AACvE,SAAOT,YAAY,CAACc,WAAb,CAAyBD,IAAzB,EAA+BJ,UAA/B,CAAP;AACD;;AACM,SAASM,aAAT,CAAuBN,UAAvB,EAAsD;AAC3D,SAAOT,YAAY,CAACe,aAAb,CAA2BN,UAA3B,CAAP;AACD","sourcesContent":["import { NativeModules, Platform } from 'react-native';\n\nconst LINKING_ERROR =\n  `The package '@screeb/react-native' doesn't seem to be linked. Make sure: \\n\\n` +\n  Platform.select({ ios: \"- You have run 'pod install'\\n\", default: '' }) +\n  '- You rebuilt the app after installing the package\\n' +\n  '- You are not using Expo managed workflow\\n';\n\nconst ScreebModule = NativeModules.ScreebModule\n  ? NativeModules.ScreebModule\n  : new Proxy(\n      {},\n      {\n        get() {\n          throw new Error(LINKING_ERROR);\n        },\n      }\n    );\n\nexport function initSdk(\n    androidChannelId: string,\n    iosChannelId: string,\n    userId?: string,\n    properties?: Map<string, any>) {\n  if (Platform.OS === 'ios') {\n    return ScreebModule.initSdk(iosChannelId, userId, properties);\n  } else {\n    return ScreebModule.initSdk(androidChannelId, userId, properties);\n  }\n}\nexport function setIdentity(userId: string, properties?: Map<string, any>) {\n  return ScreebModule.setIdentity(userId, properties);\n}\nexport function trackEvent(name: string, properties?: Map<string, any>) {\n  return ScreebModule.trackEvent(name, properties);\n}\nexport function trackScreen(name: string, properties?: Map<string, any>) {\n  return ScreebModule.trackScreen(name, properties);\n}\nexport function setProperties(properties?: Map<string, any>) {\n  return ScreebModule.setProperties(properties);\n}\n"]}

package/lib/module/index.js

@@ -0,0 +1,31 @@
+import { NativeModules, Platform } from 'react-native';
+const LINKING_ERROR = `The package '@screeb/react-native' doesn't seem to be linked. Make sure: \n\n` + Platform.select({
+  ios: "- You have run 'pod install'\n",
+  default: ''
+}) + '- You rebuilt the app after installing the package\n' + '- You are not using Expo managed workflow\n';
+const ScreebModule = NativeModules.ScreebModule ? NativeModules.ScreebModule : new Proxy({}, {
+  get() {
+    throw new Error(LINKING_ERROR);
+  }
+
+});
+export function initSdk(androidChannelId, iosChannelId, userId, properties) {
+  if (Platform.OS === 'ios') {
+    return ScreebModule.initSdk(iosChannelId, userId, properties);
+  } else {
+    return ScreebModule.initSdk(androidChannelId, userId, properties);
+  }
+}
+export function setIdentity(userId, properties) {
+  return ScreebModule.setIdentity(userId, properties);
+}
+export function trackEvent(name, properties) {
+  return ScreebModule.trackEvent(name, properties);
+}
+export function trackScreen(name, properties) {
+  return ScreebModule.trackScreen(name, properties);
+}
+export function setProperties(properties) {
+  return ScreebModule.setProperties(properties);
+}
+//# sourceMappingURL=index.js.map

package/lib/module/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["index.tsx"],"names":["NativeModules","Platform","LINKING_ERROR","select","ios","default","ScreebModule","Proxy","get","Error","initSdk","androidChannelId","iosChannelId","userId","properties","OS","setIdentity","trackEvent","name","trackScreen","setProperties"],"mappings":"AAAA,SAASA,aAAT,EAAwBC,QAAxB,QAAwC,cAAxC;AAEA,MAAMC,aAAa,GAChB,+EAAD,GACAD,QAAQ,CAACE,MAAT,CAAgB;AAAEC,EAAAA,GAAG,EAAE,gCAAP;AAAyCC,EAAAA,OAAO,EAAE;AAAlD,CAAhB,CADA,GAEA,sDAFA,GAGA,6CAJF;AAMA,MAAMC,YAAY,GAAGN,aAAa,CAACM,YAAd,GACjBN,aAAa,CAACM,YADG,GAEjB,IAAIC,KAAJ,CACE,EADF,EAEE;AACEC,EAAAA,GAAG,GAAG;AACJ,UAAM,IAAIC,KAAJ,CAAUP,aAAV,CAAN;AACD;;AAHH,CAFF,CAFJ;AAWA,OAAO,SAASQ,OAAT,CACHC,gBADG,EAEHC,YAFG,EAGHC,MAHG,EAIHC,UAJG,EAI4B;AACjC,MAAIb,QAAQ,CAACc,EAAT,KAAgB,KAApB,EAA2B;AACzB,WAAOT,YAAY,CAACI,OAAb,CAAqBE,YAArB,EAAmCC,MAAnC,EAA2CC,UAA3C,CAAP;AACD,GAFD,MAEO;AACL,WAAOR,YAAY,CAACI,OAAb,CAAqBC,gBAArB,EAAuCE,MAAvC,EAA+CC,UAA/C,CAAP;AACD;AACF;AACD,OAAO,SAASE,WAAT,CAAqBH,MAArB,EAAqCC,UAArC,EAAoE;AACzE,SAAOR,YAAY,CAACU,WAAb,CAAyBH,MAAzB,EAAiCC,UAAjC,CAAP;AACD;AACD,OAAO,SAASG,UAAT,CAAoBC,IAApB,EAAkCJ,UAAlC,EAAiE;AACtE,SAAOR,YAAY,CAACW,UAAb,CAAwBC,IAAxB,EAA8BJ,UAA9B,CAAP;AACD;AACD,OAAO,SAASK,WAAT,CAAqBD,IAArB,EAAmCJ,UAAnC,EAAkE;AACvE,SAAOR,YAAY,CAACa,WAAb,CAAyBD,IAAzB,EAA+BJ,UAA/B,CAAP;AACD;AACD,OAAO,SAASM,aAAT,CAAuBN,UAAvB,EAAsD;AAC3D,SAAOR,YAAY,CAACc,aAAb,CAA2BN,UAA3B,CAAP;AACD","sourcesContent":["import { NativeModules, Platform } from 'react-native';\n\nconst LINKING_ERROR =\n  `The package '@screeb/react-native' doesn't seem to be linked. Make sure: \\n\\n` +\n  Platform.select({ ios: \"- You have run 'pod install'\\n\", default: '' }) +\n  '- You rebuilt the app after installing the package\\n' +\n  '- You are not using Expo managed workflow\\n';\n\nconst ScreebModule = NativeModules.ScreebModule\n  ? NativeModules.ScreebModule\n  : new Proxy(\n      {},\n      {\n        get() {\n          throw new Error(LINKING_ERROR);\n        },\n      }\n    );\n\nexport function initSdk(\n    androidChannelId: string,\n    iosChannelId: string,\n    userId?: string,\n    properties?: Map<string, any>) {\n  if (Platform.OS === 'ios') {\n    return ScreebModule.initSdk(iosChannelId, userId, properties);\n  } else {\n    return ScreebModule.initSdk(androidChannelId, userId, properties);\n  }\n}\nexport function setIdentity(userId: string, properties?: Map<string, any>) {\n  return ScreebModule.setIdentity(userId, properties);\n}\nexport function trackEvent(name: string, properties?: Map<string, any>) {\n  return ScreebModule.trackEvent(name, properties);\n}\nexport function trackScreen(name: string, properties?: Map<string, any>) {\n  return ScreebModule.trackScreen(name, properties);\n}\nexport function setProperties(properties?: Map<string, any>) {\n  return ScreebModule.setProperties(properties);\n}\n"]}

package/lib/typescript/index.d.ts

@@ -0,0 +1,5 @@
+export declare function initSdk(androidChannelId: string, iosChannelId: string, userId?: string, properties?: Map<string, any>): any;
+export declare function setIdentity(userId: string, properties?: Map<string, any>): any;
+export declare function trackEvent(name: string, properties?: Map<string, any>): any;
+export declare function trackScreen(name: string, properties?: Map<string, any>): any;
+export declare function setProperties(properties?: Map<string, any>): any;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@screeb/react-native",
-  "version": "0.8.4",
+  "version": "0.8.6",
   "description": "A react-native module to integrate Screeb mobile sdk for Android and/or iOS.",
   "scripts": {
     "lint": "eslint \"**/*.{js,ts,tsx}\"",
@@ -51,4 +51,4 @@
     "react": "*",
     "react-native": "*"
   }
-}
+}

package/screeb-module.podspec

@@ -16,5 +16,5 @@ Pod::Spec.new do |s|
   s.source_files = "ios/**/*.{h,m,mm,swift}"
 
   s.dependency "React-Core"
-  s.dependency "Screeb", '~> 1.8.2'
+  s.dependency "Screeb", '~> 1.10.0'
 end

package/src/index.tsx

@@ -9,19 +9,19 @@ const LINKING_ERROR =
 const ScreebModule = NativeModules.ScreebModule
   ? NativeModules.ScreebModule
   : new Proxy(
-      {},
-      {
-        get() {
-          throw new Error(LINKING_ERROR);
-        },
-      }
-    );
+    {},
+    {
+      get() {
+        throw new Error(LINKING_ERROR);
+      },
+    }
+  );
 
 export function initSdk(
-    androidChannelId: string,
-    iosChannelId: string,
-    userId?: string,
-    properties?: Map<string, any>) {
+  androidChannelId: string,
+  iosChannelId: string,
+  userId?: string,
+  properties?: Map<string, any>) {
   if (Platform.OS === 'ios') {
     return ScreebModule.initSdk(iosChannelId, userId, properties);
   } else {
@@ -40,3 +40,9 @@ export function trackScreen(name: string, properties?: Map<string, any>) {
 export function setProperties(properties?: Map<string, any>) {
   return ScreebModule.setProperties(properties);
 }
+export function startSurvey(surveyId: string, allowMultipleResponses?: boolean, hiddenFields?: Map<string, any>) {
+  return ScreebModule.startSurvey(surveyId, allowMultipleResponses ?? true, hiddenFields);
+}
+export function assignGroup(type: string | null, name: string, properties?: Map<string, any>) {
+  return ScreebModule.assignGroup(name, type, properties);
+}