capacitor-gleap-plugin 17.0.0 → 18.1.0

package/CapacitorGleapPlugin.podspec

@@ -11,8 +11,8 @@ Pod::Spec.new do |s|
   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 = '14.0'
+  s.ios.deployment_target = '15.0'
   s.dependency 'Capacitor'
-  s.dependency 'Gleap', '17.0.0'
+  s.dependency 'Gleap', '18.1.0'
   s.swift_version = '5.1'
 end

package/README.md

@@ -1,8 +1,12 @@
-# Capacitor Gleap Plugin
+# Gleap Capacitor and Ionic SDK
 
-Gleap SDK for Capacitor is the easiest way to integrate Gleap into your Ionic apps! Achieve better app quality with comprehensive in-app bug reporting & customer feedback for your web-apps and websites. Many thanks to Stephan Nagel (congrapp) for his work on the Gleap capacitor plugin.
+Add AI-native customer support, live chat, in-app bug reporting, a help center and surveys to your Capacitor and Ionic apps with [Gleap](https://www.gleap.ai). Gleap is an Intercom alternative for software teams that connects customer conversations and feedback with product development.
 
-This plugin supports capacitor 7. See the instructions below for earlier capacitor versions.
+This plugin supports Capacitor 7. See the instructions below for earlier Capacitor versions.
+
+Thanks to Stephan Nagel (congrapp) for his work on the Gleap Capacitor plugin.
+
+[SDK documentation](https://docs.gleap.ai/documentation/ioniccapacitor/README) · [Website](https://www.gleap.ai) · [Plans and pricing](https://www.gleap.ai/pricing)
 
 ## Install
 
@@ -23,11 +27,44 @@ Please install the plugin version from our capacitor-v5 brunch with `npm install
 
 Please install the plugin version from our capacitor-v4 brunch with `npm install GleapSDK/Capacitor-SDK#capacitor-v4 --save` if you are using capacitor 4 or earlier.
 
+## Data regions
+
+Gleap projects live in a data region. The SDK talks to the EU region by default. If your project is hosted in the US region, set the region **before** calling `initialize`:
+
+```typescript
+import { Gleap } from "capacitor-gleap-plugin";
+
+await Gleap.setRegion({ region: "us" });
+await Gleap.initialize({ API_KEY: "YOUR_API_KEY" });
+```
+
+`setRegion` sets the API, websocket and realtime hosts at once (supported regions: `"eu"` and `"us"`). The static widget hosts (frame, banner, modal) are global and are not changed by the region.
+
+For self-hosted or custom setups you can override single hosts with `setApiUrl({ url })`, `setWSApiUrl({ url })`, `setRealtimeHost({ host })`, `setFrameUrl({ url })`, `setBannerUrl({ url })` and `setModalUrl({ url })`. All of them must be called before `initialize`; a manual setter called after `setRegion` overrides that single host.
+
+## Env data
+
+With every ticket the SDK sends env data (device, OS, screen size, locale, URL, …), shown under the **Env data** tab in Gleap. Leave out individual keys or stop collecting env data entirely:
+
+```typescript
+await Gleap.setEnvDataPropsToIgnore({ propsToIgnore: ["deviceName", "batteryLevel"] });
+await Gleap.setDisableEnvData({ disableEnvData: true });
+```
+
+Both can be called at any time and apply to the next ticket. Each `setEnvDataPropsToIgnore` call replaces the previous list, an empty array resets it. `setDisableEnvData({ disableEnvData: false })` turns the collection back on.
+
 ## API
 
 <docgen-index>
 
 * [`initialize(...)`](#initialize)
+* [`setRegion(...)`](#setregion)
+* [`setApiUrl(...)`](#setapiurl)
+* [`setWSApiUrl(...)`](#setwsapiurl)
+* [`setRealtimeHost(...)`](#setrealtimehost)
+* [`setFrameUrl(...)`](#setframeurl)
+* [`setBannerUrl(...)`](#setbannerurl)
+* [`setModalUrl(...)`](#setmodalurl)
 * [`identify(...)`](#identify)
 * [`updateContact(...)`](#updatecontact)
 * [`clearIdentity()`](#clearidentity)
@@ -39,6 +76,7 @@ Please install the plugin version from our capacitor-v4 brunch with `npm install
 * [`setTags(...)`](#settags)
 * [`setNetworkLogsBlacklist(...)`](#setnetworklogsblacklist)
 * [`setNetworkLogPropsToIgnore(...)`](#setnetworklogpropstoignore)
+* [`setEnvDataPropsToIgnore(...)`](#setenvdatapropstoignore)
 * [`registerAgentTool(...)`](#registeragenttool)
 * [`sendAgentToolResult(...)`](#sendagenttoolresult)
 * [`addListener('agentToolExecution', ...)`](#addlisteneragenttoolexecution-)
@@ -73,6 +111,7 @@ Please install the plugin version from our capacitor-v4 brunch with `npm install
 * [`startBot(...)`](#startbot)
 * [`showFeedbackButton(...)`](#showfeedbackbutton)
 * [`setDisableInAppNotifications(...)`](#setdisableinappnotifications)
+* [`setDisableEnvData(...)`](#setdisableenvdata)
 * [`setLanguage(...)`](#setlanguage)
 * [`disableConsoleLogOverwrite()`](#disableconsolelogoverwrite)
 * [`enableDebugConsoleLog()`](#enabledebugconsolelog)
@@ -104,6 +143,141 @@ Initialize Gleap with an API key
 --------------------
 
 
+### setRegion(...)
+
+```typescript
+setRegion(options: { region: 'eu' | 'us'; }) => Promise<{ region: string; }>
+```
+
+Set the data region of your Gleap project ("eu" is the default).
+Sets the API, websocket and realtime hosts at once. Must be called before initialize.
+A manual setter (setApiUrl, setWSApiUrl, setRealtimeHost) called afterwards overrides that single host.
+
+| Param         | Type                                   |
+| ------------- | -------------------------------------- |
+| **`options`** | <code>{ region: 'eu' \| 'us'; }</code> |
+
+**Returns:** <code>Promise&lt;{ region: string; }&gt;</code>
+
+**Since:** 18.0.0
+
+--------------------
+
+
+### setApiUrl(...)
+
+```typescript
+setApiUrl(options: { url: string; }) => Promise<{ url: string; }>
+```
+
+Set a custom API url. Must be called before initialize.
+
+| Param         | Type                          |
+| ------------- | ----------------------------- |
+| **`options`** | <code>{ url: string; }</code> |
+
+**Returns:** <code>Promise&lt;{ url: string; }&gt;</code>
+
+**Since:** 18.0.0
+
+--------------------
+
+
+### setWSApiUrl(...)
+
+```typescript
+setWSApiUrl(options: { url: string; }) => Promise<{ url: string; }>
+```
+
+Set a custom websocket API url. Must be called before initialize.
+
+| Param         | Type                          |
+| ------------- | ----------------------------- |
+| **`options`** | <code>{ url: string; }</code> |
+
+**Returns:** <code>Promise&lt;{ url: string; }&gt;</code>
+
+**Since:** 18.0.0
+
+--------------------
+
+
+### setRealtimeHost(...)
+
+```typescript
+setRealtimeHost(options: { host: string; }) => Promise<{ host: string; }>
+```
+
+Set a custom realtime host (hostname only, without protocol or path). Must be called before initialize.
+
+| Param         | Type                           |
+| ------------- | ------------------------------ |
+| **`options`** | <code>{ host: string; }</code> |
+
+**Returns:** <code>Promise&lt;{ host: string; }&gt;</code>
+
+**Since:** 18.0.0
+
+--------------------
+
+
+### setFrameUrl(...)
+
+```typescript
+setFrameUrl(options: { url: string; }) => Promise<{ url: string; }>
+```
+
+Set a custom widget frame url. Must be called before initialize.
+
+| Param         | Type                          |
+| ------------- | ----------------------------- |
+| **`options`** | <code>{ url: string; }</code> |
+
+**Returns:** <code>Promise&lt;{ url: string; }&gt;</code>
+
+**Since:** 18.0.0
+
+--------------------
+
+
+### setBannerUrl(...)
+
+```typescript
+setBannerUrl(options: { url: string; }) => Promise<{ url: string; }>
+```
+
+Set a custom banner url. Must be called before initialize.
+
+| Param         | Type                          |
+| ------------- | ----------------------------- |
+| **`options`** | <code>{ url: string; }</code> |
+
+**Returns:** <code>Promise&lt;{ url: string; }&gt;</code>
+
+**Since:** 18.0.0
+
+--------------------
+
+
+### setModalUrl(...)
+
+```typescript
+setModalUrl(options: { url: string; }) => Promise<{ url: string; }>
+```
+
+Set a custom modal url. Must be called before initialize.
+
+| Param         | Type                          |
+| ------------- | ----------------------------- |
+| **`options`** | <code>{ url: string; }</code> |
+
+**Returns:** <code>Promise&lt;{ url: string; }&gt;</code>
+
+**Since:** 18.0.0
+
+--------------------
+
+
 ### identify(...)
 
 ```typescript
@@ -301,6 +475,27 @@ Set network logs props to ignore
 --------------------
 
 
+### setEnvDataPropsToIgnore(...)
+
+```typescript
+setEnvDataPropsToIgnore(options: { propsToIgnore: string[]; }) => Promise<{ envDataPropsToIgnoreSet: boolean; }>
+```
+
+Set env data props to ignore. The given env data keys (exact and case-sensitive, e.g. "deviceName" or "currentUrl")
+are removed before a ticket or conversation is sent. Each call replaces the previous list, an empty list resets it.
+Can be called before or after initialize.
+
+| Param         | Type                                      |
+| ------------- | ----------------------------------------- |
+| **`options`** | <code>{ propsToIgnore: string[]; }</code> |
+
+**Returns:** <code>Promise&lt;{ envDataPropsToIgnoreSet: boolean; }&gt;</code>
+
+**Since:** 18.1.0
+
+--------------------
+
+
 ### registerAgentTool(...)
 
 ```typescript
@@ -922,6 +1117,26 @@ Disable in app notifications.
 --------------------
 
 
+### setDisableEnvData(...)
+
+```typescript
+setDisableEnvData(options: { disableEnvData: boolean; }) => Promise<{ envDataDisabled: boolean; }>
+```
+
+Disable env data. While disabled (true), no env data (device, OS, screen size, locale, URL, ...) is collected
+and tickets are sent without it. Pass false to collect env data again. Can be called before or after initialize.
+
+| Param         | Type                                      |
+| ------------- | ----------------------------------------- |
+| **`options`** | <code>{ disableEnvData: boolean; }</code> |
+
+**Returns:** <code>Promise&lt;{ envDataDisabled: boolean; }&gt;</code>
+
+**Since:** 18.1.0
+
+--------------------
+
+
 ### setLanguage(...)
 
 ```typescript

package/android/build.gradle

@@ -55,5 +55,5 @@ dependencies {
     testImplementation "junit:junit:$junitVersion"
     androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
     androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"
-    implementation group: 'io.gleap', name: 'gleap-android-sdk', version: '17.0.0'
+    implementation group: 'io.gleap', name: 'gleap-android-sdk', version: '18.1.0'
 }

package/android/src/main/java/io/gleapplugins/capacitor/GleapPlugin.java

@@ -86,6 +86,119 @@ public class GleapPlugin extends Plugin {
         call.resolve(ret);
     }
 
+    // Data region & host overrides. All of them must be called before initialize.
+    @PluginMethod
+    public void setRegion(PluginCall call) {
+        if (!call.getData().has("region")) {
+            call.reject("No region provided");
+            return;
+        }
+
+        String region = call.getString("region");
+        implementation.setRegion(region);
+
+        // Build Json object and resolve success
+        JSObject ret = new JSObject();
+        ret.put("region", region);
+        call.resolve(ret);
+    }
+
+    @PluginMethod
+    public void setApiUrl(PluginCall call) {
+        if (!call.getData().has("url")) {
+            call.reject("No url provided");
+            return;
+        }
+
+        String url = call.getString("url");
+        implementation.setApiUrl(url);
+
+        // Build Json object and resolve success
+        JSObject ret = new JSObject();
+        ret.put("url", url);
+        call.resolve(ret);
+    }
+
+    @PluginMethod
+    public void setWSApiUrl(PluginCall call) {
+        if (!call.getData().has("url")) {
+            call.reject("No url provided");
+            return;
+        }
+
+        String url = call.getString("url");
+        implementation.setWSApiUrl(url);
+
+        // Build Json object and resolve success
+        JSObject ret = new JSObject();
+        ret.put("url", url);
+        call.resolve(ret);
+    }
+
+    @PluginMethod
+    public void setRealtimeHost(PluginCall call) {
+        if (!call.getData().has("host")) {
+            call.reject("No host provided");
+            return;
+        }
+
+        String host = call.getString("host");
+        implementation.setRealtimeHost(host);
+
+        // Build Json object and resolve success
+        JSObject ret = new JSObject();
+        ret.put("host", host);
+        call.resolve(ret);
+    }
+
+    @PluginMethod
+    public void setFrameUrl(PluginCall call) {
+        if (!call.getData().has("url")) {
+            call.reject("No url provided");
+            return;
+        }
+
+        String url = call.getString("url");
+        implementation.setFrameUrl(url);
+
+        // Build Json object and resolve success
+        JSObject ret = new JSObject();
+        ret.put("url", url);
+        call.resolve(ret);
+    }
+
+    @PluginMethod
+    public void setBannerUrl(PluginCall call) {
+        if (!call.getData().has("url")) {
+            call.reject("No url provided");
+            return;
+        }
+
+        String url = call.getString("url");
+        implementation.setBannerUrl(url);
+
+        // Build Json object and resolve success
+        JSObject ret = new JSObject();
+        ret.put("url", url);
+        call.resolve(ret);
+    }
+
+    @PluginMethod
+    public void setModalUrl(PluginCall call) {
+        if (!call.getData().has("url")) {
+            call.reject("No url provided");
+            return;
+        }
+
+        String url = call.getString("url");
+        implementation.setModalUrl(url);
+
+        // Build Json object and resolve success
+        JSObject ret = new JSObject();
+        ret.put("url", url);
+        call.resolve(ret);
+    }
+
     @PluginMethod
     public void identify(PluginCall call) {
         // If userId is empty, then pass back error
@@ -400,6 +513,38 @@ public class GleapPlugin extends Plugin {
         call.resolve(ret);
     }
 
+    /**
+     * Sets env data properties to be removed before a ticket is sent.
+     *
+     * @since 18.1.0
+     */
+    @PluginMethod
+    public void setEnvDataPropsToIgnore(PluginCall call) {
+        // Check if 'propsToIgnore' key is provided, return error if not
+        if (!call.getData().has("propsToIgnore")) {
+            call.reject("Must provide a propsToIgnore array");
+            return;
+        }
+
+        try {
+            // Retrieve and set the env data properties to be ignored
+            JSArray jsonPropsToIgnore = call.getArray("propsToIgnore");
+            String[] propsToIgnore = new String[jsonPropsToIgnore.length()];
+            for (int i = 0; i < jsonPropsToIgnore.length(); i++) {
+                propsToIgnore[i] = jsonPropsToIgnore.getString(i);
+            }
+
+            implementation.setEnvDataPropsToIgnore(propsToIgnore);
+        } catch (Exception ex) {
+            // Handle exceptions if necessary
+        }
+
+        // Confirm successful setting of env data properties to ignore
+        JSObject ret = new JSObject();
+        ret.put("envDataPropsToIgnoreSet", true);
+        call.resolve(ret);
+    }
+
     @PluginMethod
     public void attachCustomData(PluginCall call) {
         // If key is empty, then pass back error
@@ -639,6 +784,18 @@ public class GleapPlugin extends Plugin {
         call.resolve(ret);
     }
 
+    @PluginMethod
+    public void setDisableEnvData(PluginCall call) {
+        boolean disableEnvData = call.getBoolean("disableEnvData", false);
+
+        implementation.setDisableEnvData(disableEnvData);
+
+        // Build Json object and resolve success
+        JSObject ret = new JSObject();
+        ret.put("envDataDisabled", true);
+        call.resolve(ret);
+    }
+
     @PluginMethod
     public void showFeedbackButton(PluginCall call) {
         boolean show = call.getBoolean("show");

package/dist/docs.json

@@ -26,6 +26,153 @@
         "complexTypes": [],
         "slug": "initialize"
       },
+      {
+        "name": "setRegion",
+        "signature": "(options: { region: 'eu' | 'us'; }) => Promise<{ region: string; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ region: 'eu' | 'us'; }"
+          }
+        ],
+        "returns": "Promise<{ region: string; }>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "18.0.0"
+          }
+        ],
+        "docs": "Set the data region of your Gleap project (\"eu\" is the default).\nSets the API, websocket and realtime hosts at once. Must be called before initialize.\nA manual setter (setApiUrl, setWSApiUrl, setRealtimeHost) called afterwards overrides that single host.",
+        "complexTypes": [],
+        "slug": "setregion"
+      },
+      {
+        "name": "setApiUrl",
+        "signature": "(options: { url: string; }) => Promise<{ url: string; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ url: string; }"
+          }
+        ],
+        "returns": "Promise<{ url: string; }>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "18.0.0"
+          }
+        ],
+        "docs": "Set a custom API url. Must be called before initialize.",
+        "complexTypes": [],
+        "slug": "setapiurl"
+      },
+      {
+        "name": "setWSApiUrl",
+        "signature": "(options: { url: string; }) => Promise<{ url: string; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ url: string; }"
+          }
+        ],
+        "returns": "Promise<{ url: string; }>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "18.0.0"
+          }
+        ],
+        "docs": "Set a custom websocket API url. Must be called before initialize.",
+        "complexTypes": [],
+        "slug": "setwsapiurl"
+      },
+      {
+        "name": "setRealtimeHost",
+        "signature": "(options: { host: string; }) => Promise<{ host: string; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ host: string; }"
+          }
+        ],
+        "returns": "Promise<{ host: string; }>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "18.0.0"
+          }
+        ],
+        "docs": "Set a custom realtime host (hostname only, without protocol or path). Must be called before initialize.",
+        "complexTypes": [],
+        "slug": "setrealtimehost"
+      },
+      {
+        "name": "setFrameUrl",
+        "signature": "(options: { url: string; }) => Promise<{ url: string; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ url: string; }"
+          }
+        ],
+        "returns": "Promise<{ url: string; }>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "18.0.0"
+          }
+        ],
+        "docs": "Set a custom widget frame url. Must be called before initialize.",
+        "complexTypes": [],
+        "slug": "setframeurl"
+      },
+      {
+        "name": "setBannerUrl",
+        "signature": "(options: { url: string; }) => Promise<{ url: string; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ url: string; }"
+          }
+        ],
+        "returns": "Promise<{ url: string; }>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "18.0.0"
+          }
+        ],
+        "docs": "Set a custom banner url. Must be called before initialize.",
+        "complexTypes": [],
+        "slug": "setbannerurl"
+      },
+      {
+        "name": "setModalUrl",
+        "signature": "(options: { url: string; }) => Promise<{ url: string; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ url: string; }"
+          }
+        ],
+        "returns": "Promise<{ url: string; }>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "18.0.0"
+          }
+        ],
+        "docs": "Set a custom modal url. Must be called before initialize.",
+        "complexTypes": [],
+        "slug": "setmodalurl"
+      },
       {
         "name": "identify",
         "signature": "(options: { userId: string; userHash?: string; name?: string; email?: string; phone?: string; companyId?: string; companyName?: string; avatar?: string; sla?: number; plan?: string; value?: number; customData?: Object; }) => Promise<{ identify: boolean; }>",
@@ -243,6 +390,27 @@
         "complexTypes": [],
         "slug": "setnetworklogpropstoignore"
       },
+      {
+        "name": "setEnvDataPropsToIgnore",
+        "signature": "(options: { propsToIgnore: string[]; }) => Promise<{ envDataPropsToIgnoreSet: boolean; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ propsToIgnore: string[]; }"
+          }
+        ],
+        "returns": "Promise<{ envDataPropsToIgnoreSet: boolean; }>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "18.1.0"
+          }
+        ],
+        "docs": "Set env data props to ignore. The given env data keys (exact and case-sensitive, e.g. \"deviceName\" or \"currentUrl\")\nare removed before a ticket or conversation is sent. Each call replaces the previous list, an empty list resets it.\nCan be called before or after initialize.",
+        "complexTypes": [],
+        "slug": "setenvdatapropstoignore"
+      },
       {
         "name": "registerAgentTool",
         "signature": "(options: { name: string; }) => Promise<void>",
@@ -933,6 +1101,27 @@
         "complexTypes": [],
         "slug": "setdisableinappnotifications"
       },
+      {
+        "name": "setDisableEnvData",
+        "signature": "(options: { disableEnvData: boolean; }) => Promise<{ envDataDisabled: boolean; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ disableEnvData: boolean; }"
+          }
+        ],
+        "returns": "Promise<{ envDataDisabled: boolean; }>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "18.1.0"
+          }
+        ],
+        "docs": "Disable env data. While disabled (true), no env data (device, OS, screen size, locale, URL, ...) is collected\nand tickets are sent without it. Pass false to collect env data again. Can be called before or after initialize.",
+        "complexTypes": [],
+        "slug": "setdisableenvdata"
+      },
       {
         "name": "setLanguage",
         "signature": "(options: { languageCode: string; }) => Promise<{ setLanguage: string; }>",