leap-capacitor 1.0.0

package/LeapCapacitor.podspec

@@ -0,0 +1,19 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name = 'LeapCapacitor'
+  s.version = package['version']
+  s.summary = package['description']
+  s.license = package['license']
+  s.homepage = package['repository']['url']
+  s.author = package['author']
+  s.source = { :git => package['repository']['url'], :tag => s.version.to_s }
+  s.source_files = 'ios/Plugin/**/*.{swift,h,m,c,cc,mm,cpp}'
+  s.ios.deployment_target  = '12.0'
+  s.dependency 'Capacitor'
+  s.swift_version = '5.1'
+
+  s.dependency "LeapSDK"
+end

package/README.md

@@ -0,0 +1,234 @@
+# leap-capacitor
+
+Plugin for Leap
+
+## Install
+
+```bash
+npm install leap-capacitor
+npx cap sync
+```
+
+## API
+
+<docgen-index>
+
+* [`start(...)`](#start)
+* [`startWithProperties(...)`](#startwithproperties)
+* [`flushProperties(...)`](#flushproperties)
+* [`setUniqueUserId(...)`](#setuniqueuserid)
+* [`startProject(...)`](#startproject)
+* [`embedProject(...)`](#embedproject)
+* [`offlineSync(...)`](#offlinesync)
+* [`disable()`](#disable)
+* [`addListener('leapCallbacks', ...)`](#addlistenerleapcallbacks)
+* [`addListener('leapElementActionCallbacks', ...)`](#addlistenerleapelementactioncallbacks)
+* [Interfaces](#interfaces)
+
+</docgen-index>
+
+<docgen-api>
+<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+
+### start(...)
+
+```typescript
+start(options: { apiKey: string; }) => Promise<void>
+```
+
+| Param         | Type                             |
+| ------------- | -------------------------------- |
+| **`options`** | <code>{ apiKey: string; }</code> |
+
+--------------------
+
+
+### startWithProperties(...)
+
+```typescript
+startWithProperties(options: { apiKey: string; properties: UserProperty; }) => Promise<void>
+```
+
+| Param         | Type                                                                                   |
+| ------------- | -------------------------------------------------------------------------------------- |
+| **`options`** | <code>{ apiKey: string; properties: <a href="#userproperty">UserProperty</a>; }</code> |
+
+--------------------
+
+
+### flushProperties(...)
+
+```typescript
+flushProperties(options: { properties: UserProperty; }) => Promise<void>
+```
+
+| Param         | Type                                                                   |
+| ------------- | ---------------------------------------------------------------------- |
+| **`options`** | <code>{ properties: <a href="#userproperty">UserProperty</a>; }</code> |
+
+--------------------
+
+
+### setUniqueUserId(...)
+
+```typescript
+setUniqueUserId(options: { uniqueUserId: string; }) => Promise<void>
+```
+
+| Param         | Type                                   |
+| ------------- | -------------------------------------- |
+| **`options`** | <code>{ uniqueUserId: string; }</code> |
+
+--------------------
+
+
+### startProject(...)
+
+```typescript
+startProject(options: { projectId: string; resetProject?: boolean; }) => Promise<void>
+```
+
+| Param         | Type                                                        |
+| ------------- | ----------------------------------------------------------- |
+| **`options`** | <code>{ projectId: string; resetProject?: boolean; }</code> |
+
+--------------------
+
+
+### embedProject(...)
+
+```typescript
+embedProject(options: { projectId: string; }) => Promise<void>
+```
+
+| Param         | Type                                |
+| ------------- | ----------------------------------- |
+| **`options`** | <code>{ projectId: string; }</code> |
+
+--------------------
+
+
+### offlineSync(...)
+
+```typescript
+offlineSync(options: { projectIds: Array<string>; }) => Promise<void>
+```
+
+| Param         | Type                                   |
+| ------------- | -------------------------------------- |
+| **`options`** | <code>{ projectIds: string[]; }</code> |
+
+--------------------
+
+
+### disable()
+
+```typescript
+disable() => Promise<void>
+```
+
+--------------------
+
+
+### addListener('leapCallbacks', ...)
+
+```typescript
+addListener(eventName: 'leapCallbacks', listenerFunc: (event: LeapCallbacks) => void) => Promise<PluginListenerHandle> & PluginListenerHandle
+```
+
+| Param              | Type                                                                        |
+| ------------------ | --------------------------------------------------------------------------- |
+| **`eventName`**    | <code>'leapCallbacks'</code>                                                |
+| **`listenerFunc`** | <code>(event: <a href="#leapcallbacks">LeapCallbacks</a>) =&gt; void</code> |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt; & <a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
+
+--------------------
+
+
+### addListener('leapElementActionCallbacks', ...)
+
+```typescript
+addListener(eventName: 'leapElementActionCallbacks', listenerFunc: (event: LeapElementActionCallbacks) => void) => Promise<PluginListenerHandle> & PluginListenerHandle
+```
+
+| Param              | Type                                                                                                  |
+| ------------------ | ----------------------------------------------------------------------------------------------------- |
+| **`eventName`**    | <code>'leapElementActionCallbacks'</code>                                                             |
+| **`listenerFunc`** | <code>(event: <a href="#leapelementactioncallbacks">LeapElementActionCallbacks</a>) =&gt; void</code> |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt; & <a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
+
+--------------------
+
+
+### Interfaces
+
+
+#### UserProperty
+
+
+#### Array
+
+| Prop         | Type                | Description                                                                                            |
+| ------------ | ------------------- | ------------------------------------------------------------------------------------------------------ |
+| **`length`** | <code>number</code> | Gets or sets the length of the array. This is a number one higher than the highest index in the array. |
+
+| Method             | Signature                                                                                                                     | Description                                                                                                                                                                                                                                 |
+| ------------------ | ----------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **toString**       | () =&gt; string                                                                                                               | Returns a string representation of an array.                                                                                                                                                                                                |
+| **toLocaleString** | () =&gt; string                                                                                                               | Returns a string representation of an array. The elements are converted to string using their toLocalString methods.                                                                                                                        |
+| **pop**            | () =&gt; T \| undefined                                                                                                       | Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.                                                                                                          |
+| **push**           | (...items: T[]) =&gt; number                                                                                                  | Appends new elements to the end of an array, and returns the new length of the array.                                                                                                                                                       |
+| **concat**         | (...items: <a href="#concatarray">ConcatArray</a>&lt;T&gt;[]) =&gt; T[]                                                       | Combines two or more arrays. This method returns a new array without modifying any existing arrays.                                                                                                                                         |
+| **concat**         | (...items: (T \| <a href="#concatarray">ConcatArray</a>&lt;T&gt;)[]) =&gt; T[]                                                | Combines two or more arrays. This method returns a new array without modifying any existing arrays.                                                                                                                                         |
+| **join**           | (separator?: string \| undefined) =&gt; string                                                                                | Adds all the elements of an array into a string, separated by the specified separator string.                                                                                                                                               |
+| **reverse**        | () =&gt; T[]                                                                                                                  | Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array.                                                                                                                        |
+| **shift**          | () =&gt; T \| undefined                                                                                                       | Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.                                                                                                         |
+| **slice**          | (start?: number \| undefined, end?: number \| undefined) =&gt; T[]                                                            | Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.                           |
+| **sort**           | (compareFn?: ((a: T, b: T) =&gt; number) \| undefined) =&gt; this                                                             | Sorts an array in place. This method mutates the array and returns a reference to the same array.                                                                                                                                           |
+| **splice**         | (start: number, deleteCount?: number \| undefined) =&gt; T[]                                                                  | Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.                                                                                                                      |
+| **splice**         | (start: number, deleteCount: number, ...items: T[]) =&gt; T[]                                                                 | Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.                                                                                                                      |
+| **unshift**        | (...items: T[]) =&gt; number                                                                                                  | Inserts new elements at the start of an array, and returns the new length of the array.                                                                                                                                                     |
+| **indexOf**        | (searchElement: T, fromIndex?: number \| undefined) =&gt; number                                                              | Returns the index of the first occurrence of a value in an array, or -1 if it is not present.                                                                                                                                               |
+| **lastIndexOf**    | (searchElement: T, fromIndex?: number \| undefined) =&gt; number                                                              | Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.                                                                                                                                      |
+| **every**          | &lt;S extends T&gt;(predicate: (value: T, index: number, array: T[]) =&gt; value is S, thisArg?: any) =&gt; this is S[]       | Determines whether all the members of an array satisfy the specified test.                                                                                                                                                                  |
+| **every**          | (predicate: (value: T, index: number, array: T[]) =&gt; unknown, thisArg?: any) =&gt; boolean                                 | Determines whether all the members of an array satisfy the specified test.                                                                                                                                                                  |
+| **some**           | (predicate: (value: T, index: number, array: T[]) =&gt; unknown, thisArg?: any) =&gt; boolean                                 | Determines whether the specified callback function returns true for any element of an array.                                                                                                                                                |
+| **forEach**        | (callbackfn: (value: T, index: number, array: T[]) =&gt; void, thisArg?: any) =&gt; void                                      | Performs the specified action for each element in an array.                                                                                                                                                                                 |
+| **map**            | &lt;U&gt;(callbackfn: (value: T, index: number, array: T[]) =&gt; U, thisArg?: any) =&gt; U[]                                 | Calls a defined callback function on each element of an array, and returns an array that contains the results.                                                                                                                              |
+| **filter**         | &lt;S extends T&gt;(predicate: (value: T, index: number, array: T[]) =&gt; value is S, thisArg?: any) =&gt; S[]               | Returns the elements of an array that meet the condition specified in a callback function.                                                                                                                                                  |
+| **filter**         | (predicate: (value: T, index: number, array: T[]) =&gt; unknown, thisArg?: any) =&gt; T[]                                     | Returns the elements of an array that meet the condition specified in a callback function.                                                                                                                                                  |
+| **reduce**         | (callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) =&gt; T) =&gt; T                           | Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.                      |
+| **reduce**         | (callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) =&gt; T, initialValue: T) =&gt; T          |                                                                                                                                                                                                                                             |
+| **reduce**         | &lt;U&gt;(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: T[]) =&gt; U, initialValue: U) =&gt; U | Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.                      |
+| **reduceRight**    | (callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) =&gt; T) =&gt; T                           | Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. |
+| **reduceRight**    | (callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) =&gt; T, initialValue: T) =&gt; T          |                                                                                                                                                                                                                                             |
+| **reduceRight**    | &lt;U&gt;(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: T[]) =&gt; U, initialValue: U) =&gt; U | Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. |
+
+
+#### ConcatArray
+
+| Prop         | Type                |
+| ------------ | ------------------- |
+| **`length`** | <code>number</code> |
+
+| Method    | Signature                                                          |
+| --------- | ------------------------------------------------------------------ |
+| **join**  | (separator?: string \| undefined) =&gt; string                     |
+| **slice** | (start?: number \| undefined, end?: number \| undefined) =&gt; T[] |
+
+
+#### PluginListenerHandle
+
+| Prop         | Type                                      |
+| ------------ | ----------------------------------------- |
+| **`remove`** | <code>() =&gt; Promise&lt;void&gt;</code> |
+
+
+#### LeapCallbacks
+
+
+#### LeapElementActionCallbacks
+
+</docgen-api>

package/android/build.gradle

@@ -0,0 +1,59 @@
+ext {
+    junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.1'
+    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.2.0'
+    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.1.2'
+    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.3.0'
+}
+
+buildscript {
+    repositories {
+        google()
+        jcenter()
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:4.2.1'
+    }
+}
+
+apply plugin: 'com.android.library'
+
+android {
+    compileSdkVersion project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 30
+    defaultConfig {
+        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 21
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 30
+        versionCode 1
+        versionName "1.0"
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+    }
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
+    }
+    lintOptions {
+        abortOnError false
+    }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_1_8
+        targetCompatibility JavaVersion.VERSION_1_8
+    }
+}
+
+repositories {
+    google()
+    mavenCentral()
+    jcenter()
+}
+
+
+dependencies {
+    implementation fileTree(dir: 'libs', include: ['*.jar'])
+    implementation project(':capacitor-android')
+    implementation 'is.leap.android:sdk:1.5.2'
+    implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
+    testImplementation "junit:junit:$junitVersion"
+    androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
+    androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"
+}

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,3 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="is.leap.capacitor">
+</manifest>

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

@@ -0,0 +1,239 @@
+package is.leap.capacitor;
+
+import android.Manifest;
+
+import com.getcapacitor.JSArray;
+import com.getcapacitor.JSObject;
+import com.getcapacitor.Plugin;
+import com.getcapacitor.PluginCall;
+import com.getcapacitor.PluginMethod;
+import com.getcapacitor.annotation.CapacitorPlugin;
+import com.getcapacitor.annotation.Permission;
+
+import org.json.JSONException;
+import org.json.JSONObject;
+
+import java.text.ParseException;
+import java.text.SimpleDateFormat;
+import java.util.ArrayList;
+import java.util.Date;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Locale;
+import java.util.Map;
+import java.util.TimeZone;
+
+import is.leap.android.LeapEventCallbacks;
+import is.leap.android.aui.Leap;
+import is.leap.android.core.LeapElementActionCallbacks;
+
+@CapacitorPlugin(
+        name = LeapPlugin.PLUGIN_NAME,
+        permissions = {
+                @Permission(
+                        alias = LeapPlugin.INTERNET_PERMISSION_ALIAS,
+                        strings = {Manifest.permission.INTERNET}
+                ),
+                @Permission(
+                        alias = LeapPlugin.NETWORK_STATE_PERMISSION_ALIAS,
+                        strings = {Manifest.permission.ACCESS_NETWORK_STATE}
+                )
+        }
+)
+public class LeapPlugin extends Plugin {
+
+    public static final String API_KEY = "apiKey";
+    public static final String PROPERTIES = "properties";
+    public static final String DATE_TYPE_PREFIX = "Date:";
+    public static final String PROJECT_IDS = "projectIds";
+    public static final String UNIQUE_USER_ID = "uniqueUserId";
+    public static final String PROJECT_ID = "projectId";
+    public static final String RESET_PROJECT = "resetProject";
+    public static final String LEAP_CALLBACKS = "leapCallbacks";
+    public static final String LEAP_ELEMENT_ACTION_CALLBACKS = "leapElementActionCallbacks";
+    public static final String PLUGIN_NAME = "LeapPlugin";
+    public static final String INTERNET_PERMISSION_ALIAS = "Internet";
+    public static final String NETWORK_STATE_PERMISSION_ALIAS = "Network State";
+
+    private static final String FORMAT_SDF = "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'";
+    private static final String TIMEZONE_GMT = "GMT";
+
+    public LeapPlugin() {
+        setLeapEventEmitter();
+        setLeapAUIActionEventEmitter();
+    }
+
+    @PluginMethod
+    public void start(PluginCall call) {
+        String apiKey = call.getString(API_KEY);
+        Leap.start(apiKey);
+        call.resolve();
+    }
+
+    @PluginMethod
+    public void startWithProperties(PluginCall call) {
+        String apiKey = call.getString(API_KEY);
+        JSObject propsObj = call.getObject(PROPERTIES);
+        if(propsObj == null) {
+            Leap.start(apiKey);
+            call.resolve();
+            return;
+        }
+        Leap.Builder leapBuilder = Leap.withBuilder(apiKey);
+        Iterator<String> iterator = propsObj.keys();
+
+        while (iterator.hasNext()) {
+            String key = iterator.next();
+            Object propValue = null;
+            try {
+                propValue = propsObj.get(key);
+            } catch (JSONException e) {
+
+            }
+            if(propValue instanceof  String) {
+                String valueStr = (String) propValue;
+                if (valueStr.startsWith(DATE_TYPE_PREFIX)) {
+                    String dateValue = valueStr.split(DATE_TYPE_PREFIX)[1];
+                    Date date = getDate(dateValue);
+                    leapBuilder.addProperty(key, date);
+                    break;
+                }
+                leapBuilder.addProperty(key, String.valueOf(propValue));
+            } else if (propValue instanceof Number) {
+                leapBuilder.addProperty(key, (long) propValue);
+            }
+
+        }
+        leapBuilder.start();
+        call.resolve();
+    }
+
+    @PluginMethod
+    public void flushProperties(PluginCall call) {
+        JSObject propsObj = call.getObject(PROPERTIES);
+        Leap.PropertyBuilder leapPropertyBuilder = Leap.withPropertyBuilder();
+        Iterator<String> iterator = propsObj.keys();
+
+        while (iterator.hasNext()) {
+            String key = iterator.next();
+            Object propValue = null;
+            try {
+                propValue = propsObj.get(key);
+            } catch (JSONException e) {
+
+            }
+            if(propValue instanceof  String) {
+                String valueStr = (String) propValue;
+                if (valueStr.startsWith(DATE_TYPE_PREFIX)) {
+                    String dateValue = valueStr.split(DATE_TYPE_PREFIX)[1];
+                    Date date = getDate(dateValue);
+                    leapPropertyBuilder.addProperty(key, date);
+                    break;
+                }
+                leapPropertyBuilder.addProperty(key, String.valueOf(propValue));
+            } else if (propValue instanceof Number) {
+                leapPropertyBuilder.addProperty(key, (long) propValue);
+            }
+
+        }
+        leapPropertyBuilder.flush();
+        call.resolve();
+    }
+
+    @PluginMethod
+    public static void setUniqueUserId(PluginCall call) {
+        String uniqueUserId = call.getString(UNIQUE_USER_ID);
+        Leap.setUniqueUserId(uniqueUserId);
+        call.resolve();
+    }
+
+    @PluginMethod
+    public static void startProject(PluginCall call) {
+        String projectID = call.getString(PROJECT_ID);
+        boolean resetProject = false;
+        if(call.hasOption(RESET_PROJECT)) {
+            resetProject = call.getBoolean(RESET_PROJECT, false);
+        }
+        Leap.startProject(projectID, resetProject);
+        call.resolve();
+    }
+
+    @PluginMethod
+    public static void embedProject(PluginCall call) {
+        String projectID = call.getString(PROJECT_ID);
+        Leap.embedProject(projectID);
+        call.resolve();
+    }
+
+    @PluginMethod
+    public void offlineSync(PluginCall call) {
+        JSArray array = call.getArray(PROJECT_IDS);
+        List<String> offlineProjList = new ArrayList<>();
+        if (array == null || array.length() == 0) {
+            //In this case we will delete the previous projects
+            Leap.offlineSync(offlineProjList);
+            return;
+        }
+        for (int i = 0; i < array.length(); i++) {
+            if (array.isNull(i)) continue;
+            String offlineProjId = null;
+            try {
+                offlineProjId = array.getString(i);
+            } catch (JSONException e) {
+            }
+            if(offlineProjId != null)
+            offlineProjList.add(offlineProjId);
+        }
+        Leap.offlineSync(offlineProjList);
+        call.resolve();
+    }
+
+    @PluginMethod
+    public void disable() {
+        Leap.disable();
+    }
+
+    public static Date getDate(String dateValue) {
+        SimpleDateFormat sdf = new SimpleDateFormat(FORMAT_SDF, Locale.ENGLISH);
+        sdf.setTimeZone(TimeZone.getTimeZone(TIMEZONE_GMT));
+        try {
+            return sdf.parse(dateValue);
+        } catch (ParseException ignored) {
+            return null;
+        }
+    }
+
+    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);
+
+            }
+        };
+        Leap.setLeapEventCallbacks(leapEventListener);
+    }
+
+    private void setLeapAUIActionEventEmitter() {
+        LeapElementActionCallbacks eventActionListener = new LeapElementActionCallbacks() {
+            @Override
+            public void onEventAction(String actionName, Object value) {
+                JSObject jsObject = new JSObject();
+                jsObject.put(actionName, value);
+                notifyListeners(LEAP_ELEMENT_ACTION_CALLBACKS, jsObject);
+            }
+        };
+        Leap.addLeapElementActionCallbacks(eventActionListener);
+    }
+
+}