leap-capacitor 1.0.0 → 1.2.0

package/README.md

@@ -15,12 +15,15 @@ npx cap sync
 
 * [`start(...)`](#start)
 * [`startWithProperties(...)`](#startwithproperties)
+* [`startWithSelfHostedURL(...)`](#startwithselfhostedurl)
+* [`startWithSelfHostedURLAndProperties(...)`](#startwithselfhostedurlandproperties)
 * [`flushProperties(...)`](#flushproperties)
 * [`setUniqueUserId(...)`](#setuniqueuserid)
 * [`startProject(...)`](#startproject)
 * [`embedProject(...)`](#embedproject)
 * [`offlineSync(...)`](#offlinesync)
 * [`disable()`](#disable)
+* [`setAppLocale(...)`](#setapplocale)
 * [`addListener('leapCallbacks', ...)`](#addlistenerleapcallbacks)
 * [`addListener('leapElementActionCallbacks', ...)`](#addlistenerleapelementactioncallbacks)
 * [Interfaces](#interfaces)
@@ -56,6 +59,32 @@ startWithProperties(options: { apiKey: string; properties: UserProperty; }) => P
 --------------------
 
 
+### startWithSelfHostedURL(...)
+
+```typescript
+startWithSelfHostedURL(options: { baseURL: string; }) => Promise<void>
+```
+
+| Param         | Type                              |
+| ------------- | --------------------------------- |
+| **`options`** | <code>{ baseURL: string; }</code> |
+
+--------------------
+
+
+### startWithSelfHostedURLAndProperties(...)
+
+```typescript
+startWithSelfHostedURLAndProperties(options: { baseURL: string; properties: UserProperty; }) => Promise<void>
+```
+
+| Param         | Type                                                                                    |
+| ------------- | --------------------------------------------------------------------------------------- |
+| **`options`** | <code>{ baseURL: string; properties: <a href="#userproperty">UserProperty</a>; }</code> |
+
+--------------------
+
+
 ### flushProperties(...)
 
 ```typescript
@@ -130,6 +159,19 @@ disable() => Promise<void>
 --------------------
 
 
+### setAppLocale(...)
+
+```typescript
+setAppLocale(options: { localeCode: string; }) => Promise<void>
+```
+
+| Param         | Type                                 |
+| ------------- | ------------------------------------ |
+| **`options`** | <code>{ localeCode: string; }</code> |
+
+--------------------
+
+
 ### addListener('leapCallbacks', ...)
 
 ```typescript

package/android/build.gradle

@@ -11,7 +11,7 @@ buildscript {
         jcenter()
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:4.2.1'
+        classpath 'com.android.tools.build:gradle:4.2.2'
     }
 }
 
@@ -51,7 +51,7 @@ repositories {
 dependencies {
     implementation fileTree(dir: 'libs', include: ['*.jar'])
     implementation project(':capacitor-android')
-    implementation 'is.leap.android:sdk:1.5.2'
+    implementation 'is.leap.android:sdk:1.7.0'
     implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
     testImplementation "junit:junit:$junitVersion"
     androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"

package/android/src/main/java/is/leap/capacitor/LeapPlugin.java

@@ -43,6 +43,7 @@ import is.leap.android.core.LeapElementActionCallbacks;
 public class LeapPlugin extends Plugin {
 
     public static final String API_KEY = "apiKey";
+    public static final String SELF_HOSTING_BASE_URL = "baseURL";
     public static final String PROPERTIES = "properties";
     public static final String DATE_TYPE_PREFIX = "Date:";
     public static final String PROJECT_IDS = "projectIds";
@@ -57,6 +58,8 @@ public class LeapPlugin extends Plugin {
 
     private static final String FORMAT_SDF = "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'";
     private static final String TIMEZONE_GMT = "GMT";
+    public static final String LOCALE_CODE = "localeCode";
+    public static final String WFX_CLIENT_UNIQUE_ID = "wfx_user_id";
 
     public LeapPlugin() {
         setLeapEventEmitter();
@@ -70,6 +73,34 @@ public class LeapPlugin extends Plugin {
         call.resolve();
     }
 
+    @PluginMethod
+    public void startWithSelfHostedURL(PluginCall call) {
+        String baseURL = call.getString(SELF_HOSTING_BASE_URL);
+        Leap.withSelfHostedBuilder()
+                .setBaseUrl(baseURL)
+                .start();
+        call.resolve();
+    }
+
+    @PluginMethod
+    public void startWithSelfHostedURLAndProperties(PluginCall call) {
+        String baseURL = call.getString(SELF_HOSTING_BASE_URL);
+        JSObject propsObj = call.getObject(PROPERTIES);
+        Leap.Builder builder = Leap.withSelfHostedBuilder()
+                .setBaseUrl(baseURL);
+
+        if(propsObj == null) {
+            builder.start();
+            call.resolve();
+            return;
+        }
+
+        startWithProperties(propsObj, builder);
+        call.resolve();
+    }
+
+
+
     @PluginMethod
     public void startWithProperties(PluginCall call) {
         String apiKey = call.getString(API_KEY);
@@ -80,10 +111,20 @@ public class LeapPlugin extends Plugin {
             return;
         }
         Leap.Builder leapBuilder = Leap.withBuilder(apiKey);
+        startWithProperties(propsObj, leapBuilder);
+        call.resolve();
+    }
+
+    private void startWithProperties(JSObject propsObj, Leap.Builder leapBuilder) {
         Iterator<String> iterator = propsObj.keys();
 
         while (iterator.hasNext()) {
             String key = iterator.next();
+            if(WFX_CLIENT_UNIQUE_ID.equals(key)) {
+                String uniqueId = propsObj.getString(key);
+                leapBuilder.addUniqueId(uniqueId);
+                continue;
+            }
             Object propValue = null;
             try {
                 propValue = propsObj.get(key);
@@ -105,7 +146,6 @@ public class LeapPlugin extends Plugin {
 
         }
         leapBuilder.start();
-        call.resolve();
     }
 
     @PluginMethod
@@ -193,6 +233,13 @@ public class LeapPlugin extends Plugin {
         Leap.disable();
     }
 
+    @PluginMethod
+    public void setAppLocale(PluginCall call) {
+        String localeCode = call.getString(LOCALE_CODE);
+        Leap.setAppLocale(localeCode);
+        call.resolve();
+    }
+
     public static Date getDate(String dateValue) {
         SimpleDateFormat sdf = new SimpleDateFormat(FORMAT_SDF, Locale.ENGLISH);
         sdf.setTimeZone(TimeZone.getTimeZone(TIMEZONE_GMT));
@@ -204,22 +251,19 @@ public class LeapPlugin extends Plugin {
     }
 
     private void setLeapEventEmitter() {
-        LeapEventCallbacks leapEventListener = new LeapEventCallbacks() {
-            @Override
-            public void onEvent(Map<String, String> eventValue) {
-                if (eventValue == null)
-                    return;
-                JSONObject ret = new JSONObject(eventValue);
-                JSObject jsObject = null;
-                try {
-                    jsObject = new JSObject(ret.toString());
-                } catch (JSONException e) {
-
-                }
-                if(jsObject == null) return;
-                notifyListeners(LEAP_CALLBACKS, jsObject);
+        LeapEventCallbacks leapEventListener = eventValue -> {
+            if (eventValue == null)
+                return;
+            JSONObject ret = new JSONObject(eventValue);
+            JSObject jsObject = null;
+            try {
+                jsObject = new JSObject(ret.toString());
+            } catch (JSONException ignored) {
 
             }
+            if(jsObject == null) return;
+            notifyListeners(LEAP_CALLBACKS, jsObject);
+
         };
         Leap.setLeapEventCallbacks(leapEventListener);
     }

package/dist/docs.json

@@ -39,6 +39,40 @@
         ],
         "slug": "startwithproperties"
       },
+      {
+        "name": "startWithSelfHostedURL",
+        "signature": "(options: { baseURL: string; }) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ baseURL: string; }"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [],
+        "slug": "startwithselfhostedurl"
+      },
+      {
+        "name": "startWithSelfHostedURLAndProperties",
+        "signature": "(options: { baseURL: string; properties: UserProperty; }) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ baseURL: string; properties: UserProperty; }"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "UserProperty"
+        ],
+        "slug": "startwithselfhostedurlandproperties"
+      },
       {
         "name": "flushProperties",
         "signature": "(options: { properties: UserProperty; }) => Promise<void>",
@@ -133,6 +167,22 @@
         "complexTypes": [],
         "slug": "disable"
       },
+      {
+        "name": "setAppLocale",
+        "signature": "(options: { localeCode: string; }) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ localeCode: string; }"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [],
+        "slug": "setapplocale"
+      },
       {
         "name": "addListener",
         "signature": "(eventName: 'leapCallbacks', listenerFunc: (event: LeapCallbacks) => void) => Promise<PluginListenerHandle> & PluginListenerHandle",

package/dist/esm/definitions.d.ts

@@ -16,6 +16,13 @@ export interface LeapPluginInterface {
         apiKey: string;
         properties: UserProperty;
     }): Promise<void>;
+    startWithSelfHostedURL(options: {
+        baseURL: string;
+    }): Promise<void>;
+    startWithSelfHostedURLAndProperties(options: {
+        baseURL: string;
+        properties: UserProperty;
+    }): Promise<void>;
     flushProperties(options: {
         properties: UserProperty;
     }): Promise<void>;
@@ -33,6 +40,9 @@ export interface LeapPluginInterface {
         projectIds: Array<string>;
     }): Promise<void>;
     disable(): Promise<void>;
+    setAppLocale(options: {
+        localeCode: string;
+    }): Promise<void>;
     addListener(eventName: 'leapCallbacks', listenerFunc: (event: LeapCallbacks) => void): Promise<PluginListenerHandle> & PluginListenerHandle;
     addListener(eventName: 'leapElementActionCallbacks', listenerFunc: (event: LeapElementActionCallbacks) => void): Promise<PluginListenerHandle> & PluginListenerHandle;
 }

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["\nimport type { PluginListenerHandle } from '@capacitor/core';\n\nexport interface UserProperty {\n  [key: string]: string | number\n}\n\nexport interface LeapCallbacks {\n  [key: string]: string\n}\n\nexport interface LeapElementActionCallbacks {\n  [key: string]: any\n}\n\nexport interface LeapPluginInterface {\n  start(options: { apiKey: string }): Promise<void>;\n  startWithProperties(options: { apiKey: string, properties: UserProperty }): Promise<void>;\n  flushProperties(options: { properties: UserProperty }): Promise<void>;\n  setUniqueUserId(options: { uniqueUserId: string }): Promise<void>;\n  startProject(options: { projectId: string, resetProject?: boolean }): Promise<void>;\n  embedProject(options: { projectId: string }): Promise<void>;\n  offlineSync(options: { projectIds: Array<string> }): Promise<void>;\n  disable(): Promise<void>;\n\n  addListener(\n    eventName: 'leapCallbacks',\n    listenerFunc: (event: LeapCallbacks) => void,\n  ): Promise<PluginListenerHandle> & PluginListenerHandle\n\n  addListener(\n    eventName: 'leapElementActionCallbacks',\n    listenerFunc: (event: LeapElementActionCallbacks) => void,\n  ): Promise<PluginListenerHandle> & PluginListenerHandle\n\n\n}\n"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["\nimport type { PluginListenerHandle } from '@capacitor/core';\n\nexport interface UserProperty {\n  [key: string]: string | number\n}\n\nexport interface LeapCallbacks {\n  [key: string]: string\n}\n\nexport interface LeapElementActionCallbacks {\n  [key: string]: any\n}\n\nexport interface LeapPluginInterface {\n  start(options: { apiKey: string }): Promise<void>;\n  startWithProperties(options: { apiKey: string, properties: UserProperty }): Promise<void>;\n  startWithSelfHostedURL(options:{baseURL: string}):Promise<void>;\n  startWithSelfHostedURLAndProperties(options:{baseURL:string, properties: UserProperty}):Promise<void>;\n  flushProperties(options: { properties: UserProperty }): Promise<void>;\n  setUniqueUserId(options: { uniqueUserId: string }): Promise<void>;\n  startProject(options: { projectId: string, resetProject?: boolean }): Promise<void>;\n  embedProject(options: { projectId: string }): Promise<void>;\n  offlineSync(options: { projectIds: Array<string> }): Promise<void>;\n  disable(): Promise<void>;\n  setAppLocale(options: {localeCode: string}): Promise<void>;\n\n  addListener(\n    eventName: 'leapCallbacks',\n    listenerFunc: (event: LeapCallbacks) => void,\n  ): Promise<PluginListenerHandle> & PluginListenerHandle\n\n  addListener(\n    eventName: 'leapElementActionCallbacks',\n    listenerFunc: (event: LeapElementActionCallbacks) => void,\n  ): Promise<PluginListenerHandle> & PluginListenerHandle\n\n\n}\n"]}

package/ios/Plugin/LeapPlugin.m

@@ -6,10 +6,13 @@
 CAP_PLUGIN(LeapPlugin, "LeapPlugin",
            CAP_PLUGIN_METHOD(start, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(startWithProperties, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(startWithSelfHostedURL, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(startWithSelfHostedURLAndProperties, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(flushProperties, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(startProject, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(embedProject, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(setUniqueUserId, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(setAppLocale, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(offlineSync, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(disable, CAPPluginReturnPromise);
 )

package/ios/Plugin/LeapPlugin.swift

@@ -2,6 +2,20 @@ import Foundation
 import Capacitor
 import LeapSDK
 
+let API_KEY         = "apiKey"
+let PROPERTIES      = "properties"
+let DATE_PREFIX     = "Date:"
+let BASE_URL        = "baseURL"
+let UNIQUE_USER_ID  = "uniqueUserId"
+let LOCALE_CODE     = "localeCode"
+let PROJECT_ID      = "projectId"
+let RESET_PROJECT   = "resetProject"
+let PROJECT_IDS     = "projectIds"
+let DATE_FORMAT     = "yyyy-MM-dd'T'HH:mm:ss.SSSZ"
+let DATE_LOCALE     = "en_US_POSIX"
+let LEAP_CALLBACKS  = "leapCallbacks"
+let WFX_UNIQUE_ID   = "wfx_user_id"
+
 /**
  * Please read the Capacitor iOS Plugin Development Guide
  * here: https://capacitorjs.com/docs/plugins/ios
@@ -11,7 +25,7 @@ import LeapSDK
 public class LeapPlugin: CAPPlugin {
     
     @objc public func start(_ call: CAPPluginCall) {
-        let apiKey = call.getString("apiKey") ?? ""
+        let apiKey = call.getString(API_KEY) ?? ""
         DispatchQueue.main.async {
             Leap.shared.start(apiKey)
             Leap.shared.callback = self
@@ -20,63 +34,68 @@ public class LeapPlugin: CAPPlugin {
     }
     
     @objc public func startWithProperties(_ call: CAPPluginCall) {
-        let apiKey = call.getString("apiKey") ?? ""
-        let properties:[String:AnyHashable] = call.getObject("properties") as? [String:AnyHashable] ?? [:]
-        DispatchQueue.main.async {
+        let apiKey = call.getString(API_KEY) ?? ""
+        let properties:[String:AnyHashable] = call.getObject(PROPERTIES) as? [String:AnyHashable] ?? [:]
+        DispatchQueue.main.async {[weak self] in
             let leapShared = Leap.shared.withBuilder(apiKey)
-            properties.forEach { key, value in
-                if let stringValue = value as? String {
-                    if stringValue.hasPrefix("Date:") {
-                        let dateValue = stringValue.components(separatedBy: "Date:").last ?? ""
-                        if let date = self.getDateFromISOString(dateString: dateValue) {
-                            leapShared?.addProperty(key, dateValue: date)
-                        }
-                    } else {
-                        leapShared?.addProperty(key, stringValue: stringValue)
-                    }
-                } else if let intValue = value as? Int {
-                    leapShared?.addProperty(key, intValue: intValue)
-                }
-            }
+            if let wfxId = properties[WFX_UNIQUE_ID] as? String { Leap.shared.addUniqueUserId(wfxId) }
+            self?.addProperties(properties: properties)
             leapShared?.start()
         }
         call.resolve()
     }
     
+    @objc public func startWithSelfHostedURL(_ call:CAPPluginCall) {
+        if let baseUrl = call.getString(BASE_URL) {
+            DispatchQueue.main.async {
+                Leap.shared.withSelfHostedBuilder()?.setBaseUrl(baseUrl)?.start()
+            }
+        }
+        call.resolve()
+    }
+    
+    @objc public func startWithSelfHostedURLAndProperties(_ call:CAPPluginCall) {
+        if let baseUrl = call.getString(BASE_URL) {
+            let properties = call.getObject(PROPERTIES) as? [String:AnyHashable] ?? [:]
+            DispatchQueue.main.async {[weak self] in
+                Leap.shared.withSelfHostedBuilder()?.setBaseUrl(baseUrl)
+                if let wfxId = properties[WFX_UNIQUE_ID] as? String { Leap.shared.addUniqueUserId(wfxId) }
+                self?.addProperties(properties: properties)
+                Leap.shared.start()
+            }
+        }
+        call.resolve()
+    }
+    
     @objc public func flushProperties(_ call: CAPPluginCall) {
-        let properties:[String:AnyHashable] = call.getObject("properties") as? [String:AnyHashable] ?? [:]
-        DispatchQueue.main.async {
+        let properties:[String:AnyHashable] = call.getObject(PROPERTIES) as? [String:AnyHashable] ?? [:]
+        DispatchQueue.main.async {[weak self] in
             let leapShared = Leap.shared
-            properties.forEach { key, value in
-                if let stringValue = value as? String {
-                    if stringValue.hasPrefix("Date:") {
-                        let dateValue = stringValue.components(separatedBy: "Date:").last ?? ""
-                        if let date = self.getDateFromISOString(dateString: dateValue) {
-                            leapShared.addProperty(key, dateValue: date)
-                        }
-                    } else {
-                        leapShared.addProperty(key, stringValue: stringValue)
-                    }
-                } else if let intValue = value as? Int {
-                    leapShared.addProperty(key, intValue: intValue)
-                }
-            }
+            self?.addProperties(properties: properties)
             leapShared.flush()
         }
         call.resolve()
     }
     
     @objc public func setUniqueUserId(_ call: CAPPluginCall) {
-        let uniqueUserId = call.getString("uniqueUserId") ?? ""
+        let uniqueUserId = call.getString(UNIQUE_USER_ID) ?? ""
         DispatchQueue.main.async {
             Leap.shared.setUniqueUserId(uniqueUserId)
         }
         call.resolve()
     }
     
+    @objc public func setAppLocale(_ call: CAPPluginCall) {
+        let localeCode = call.getString(LOCALE_CODE) ?? ""
+        DispatchQueue.main.async {
+            Leap.shared.setAppLocale(localeCode)
+        }
+        call.resolve()
+    }
+    
     @objc public func startProject(_ call: CAPPluginCall) {
-        let projectId = call.getString("projectId") ?? ""
-        let resetProject = call.getBool("resetProject") ?? false
+        let projectId = call.getString(PROJECT_ID) ?? ""
+        let resetProject = call.getBool(RESET_PROJECT) ?? false
         DispatchQueue.main.async {
             Leap.shared.startProject(projectId, resetProject: resetProject)
         }
@@ -84,7 +103,7 @@ public class LeapPlugin: CAPPlugin {
     }
     
     @objc public func embedProject(_ call: CAPPluginCall) {
-        let projectId = call.getString("projectId") ?? ""
+        let projectId = call.getString(PROJECT_ID) ?? ""
         DispatchQueue.main.async {
             Leap.shared.embedProject(projectId)
         }
@@ -92,7 +111,7 @@ public class LeapPlugin: CAPPlugin {
     }
     
     @objc public func offlineSync(_ call: CAPPluginCall) {
-        let projectIds = call.getArray("projectIds")?.capacitor.replacingNullValues() as? [String] ?? []
+        let projectIds = call.getArray(PROJECT_IDS)?.capacitor.replacingNullValues() as? [String] ?? []
         DispatchQueue.main.async {
             Leap.shared.offlineSync(projectIds)
         }
@@ -106,10 +125,29 @@ public class LeapPlugin: CAPPlugin {
         call.resolve()
     }
     
+    func addProperties(properties:[String:AnyHashable]) {
+        properties.forEach { key, value in
+            if key != WFX_UNIQUE_ID {
+                if let stringValue = value as? String {
+                    if stringValue.hasPrefix(DATE_PREFIX) {
+                        let dateValue = stringValue.components(separatedBy: DATE_PREFIX).last ?? ""
+                        if let date = self.getDateFromISOString(dateString: dateValue) {
+                            Leap.shared.addProperty(key, dateValue: date)
+                        }
+                    } else {
+                        Leap.shared.addProperty(key, stringValue: stringValue)
+                    }
+                } else if let intValue = value as? Int {
+                    Leap.shared.addProperty(key, intValue: intValue)
+                }
+            }
+        }
+    }
+    
     func getDateFromISOString(dateString:String) -> Date? {
         let formatter = DateFormatter()
-        formatter.dateFormat = "yyyy-MM-dd'T'HH:mm:ss.SSSZ"
-        let posix:Locale = Locale(identifier: "en_US_POSIX")
+        formatter.dateFormat = DATE_FORMAT
+        let posix:Locale = Locale(identifier: DATE_LOCALE)
         formatter.locale = posix
         let date = formatter.date(from: dateString)
         return date
@@ -120,7 +158,7 @@ extension LeapPlugin: LeapCallback {
     
     public func eventNotification(eventInfo: Dictionary<String, Any>) {
         DispatchQueue.main.async { [weak self] in
-            self?.notifyListeners("leapCallbacks", data: eventInfo)
+            self?.notifyListeners(LEAP_CALLBACKS, data: eventInfo)
         }
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "leap-capacitor",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "description": "Plugin for Leap",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",