capacitor-gleap-plugin 17.0.0 → 18.0.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.0.0'
   s.swift_version = '5.1'
 end

package/README.md

@@ -23,11 +23,33 @@ 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.
+
 ## 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)
@@ -104,6 +126,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

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.0.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

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; }>",

package/dist/esm/definitions.d.ts

@@ -17,6 +17,78 @@ export interface GleapPlugin {
         initialized: boolean;
     }>;
     /**
+    * 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.
+    *
+    * @since 18.0.0
+    */
+    setRegion(options: {
+        region: 'eu' | 'us';
+    }): Promise<{
+        region: string;
+    }>;
+    /**
+    * Set a custom API url. Must be called before initialize.
+    *
+    * @since 18.0.0
+    */
+    setApiUrl(options: {
+        url: string;
+    }): Promise<{
+        url: string;
+    }>;
+    /**
+    * Set a custom websocket API url. Must be called before initialize.
+    *
+    * @since 18.0.0
+    */
+    setWSApiUrl(options: {
+        url: string;
+    }): Promise<{
+        url: string;
+    }>;
+    /**
+    * Set a custom realtime host (hostname only, without protocol or path). Must be called before initialize.
+    *
+    * @since 18.0.0
+    */
+    setRealtimeHost(options: {
+        host: string;
+    }): Promise<{
+        host: string;
+    }>;
+    /**
+    * Set a custom widget frame url. Must be called before initialize.
+    *
+    * @since 18.0.0
+    */
+    setFrameUrl(options: {
+        url: string;
+    }): Promise<{
+        url: string;
+    }>;
+    /**
+    * Set a custom banner url. Must be called before initialize.
+    *
+    * @since 18.0.0
+    */
+    setBannerUrl(options: {
+        url: string;
+    }): Promise<{
+        url: string;
+    }>;
+    /**
+    * Set a custom modal url. Must be called before initialize.
+    *
+    * @since 18.0.0
+    */
+    setModalUrl(options: {
+        url: string;
+    }): Promise<{
+        url: string;
+    }>;
+    /**
     * Set user identity
     *
     * @since 7.0.0

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["import type { PluginListenerHandle } from '@capacitor/core';\n\nexport type CallbackID = string;\n\nexport interface GleapEventMessage {\n  name: string,\n  data?: any,\n}\n\nexport type GleapEventCallback = (message: GleapEventMessage | null, err?: any) => void;\n\nexport interface GleapPlugin {\n  /**\n  * Initialize Gleap with an API key\n  *\n  * @since 7.0.0\n  */\n  initialize(options: {\n    API_KEY: string;\n  }): Promise<{\n    initialized: boolean;\n  }>;\n\n  /**\n  * Set user identity\n  *\n  * @since 7.0.0\n  */\n  identify(options: {\n    userId: string;\n    userHash?: string;\n    name?: string;\n    email?: string;\n    phone?: string;\n    companyId?: string;\n    companyName?: string;\n    avatar?: string;\n    sla?: number;\n    plan?: string;\n    value?: number;\n    customData?: Object;\n  }): Promise<{\n    identify: boolean;\n  }>;\n\n  /**\n  * Update user properties\n  *\n  * @since 13.2.1\n  */\n  updateContact(options: {\n    name?: string;\n    email?: string;\n    phone?: string;\n    companyId?: string;\n    companyName?: string;\n    avatar?: string;\n    sla?: number;\n    plan?: string;\n    value?: number;\n    customData?: Object;\n  }): Promise<{\n    identify: boolean;\n  }>;\n\n  /**\n  * Clear user identity\n  *\n  * @since 7.0.0\n  */\n  clearIdentity(): Promise<{\n    clearIdentity: boolean;\n  }>;\n\n  /**\n  * Get the current user identity\n  *\n  * @since 8.1.0\n  */\n  getIdentity(): Promise<{\n    identity: {\n      userId: string;\n      name?: string;\n      email?: string;\n      phone?: string;\n      value?: number;\n    };\n  }>;\n\n  /**\n  * User identified status.\n  *\n  * @since 8.1.0\n  */\n  isUserIdentified(): Promise<{\n    isUserIdentified: boolean;\n  }>;\n\n  /**\n  * Submit a custom log message with the given level\n  *\n  * @since 7.0.0\n  */\n  log(options: {\n    message: string;\n    logLevel?: \"ERROR\" | \"WARNING\" | \"INFO\";\n  }): Promise<{\n    logged: boolean;\n  }>;\n\n  /**\n  * Manually show a survey.\n  *\n  * @since 8.5.1\n  */\n  showSurvey(options: {\n    surveyId: string;\n    format?: \"survey\" | \"survey_full\";\n  }): Promise<{\n    opened: boolean;\n  }>;\n\n  /**\n  * Add custom data\n  *\n  * @since 7.0.0\n  */\n  attachCustomData(options: {\n    data: any;\n  }): Promise<{\n    attachedCustomData: boolean;\n  }>;\n\n  /**\n  * Set tags\n  *\n  * @since 8.6.0\n  */\n  setTags(options: {\n    tags: string[];\n  }): Promise<{\n    tagsSet: boolean;\n  }>;\n\n  /**\n  * Set network logs blacklist\n  *\n  * @since 13.2.1\n  */\n  setNetworkLogsBlacklist(options: {\n    blacklist: string[];\n  }): Promise<{\n    blacklistSet: boolean;\n  }>;\n\n  /**\n  * Set network logs props to ignore\n  *\n  * @since 13.2.1\n  */\n  setNetworkLogPropsToIgnore(options: {\n    propsToIgnore: string[];\n  }): Promise<{\n    propsToIgnoreSet: boolean;\n  }>;\n\n  /**\n  * Registers a Frontend tool defined on your AI agent in the Gleap dashboard.\n  * Prefer the `registerAgentTool(name, handler)` helper exported by this\n  * package — it wires the agentToolExecution event and result round-trip for\n  * you.\n  *\n  * @since 15.0.0\n  */\n  registerAgentTool(options: {\n    name: string;\n  }): Promise<void>;\n\n  /**\n  * Resolves a pending agent tool execution with the handler's result.\n  * Used by the `registerAgentTool(name, handler)` helper.\n  *\n  * @since 15.0.0\n  */\n  sendAgentToolResult(options: {\n    executionId: string;\n    result: string;\n  }): Promise<void>;\n\n  /**\n  * Called when a registered agent tool should execute.\n  *\n  * @since 15.0.0\n  */\n  addListener(\n    eventName: 'agentToolExecution',\n    listenerFunc: (data: {\n      executionId: string;\n      name: string;\n      params: any;\n    }) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n  * Sets the value of a ticket attribute\n  *\n  * @since 13.5.0\n  */\n  setTicketAttribute(options: {\n    key: string;\n    value: string;\n  }): Promise<{\n    setTicketAttribute: boolean;\n  }>;\n\n  /**\n  * Unset a ticket attribute\n  *\n  * @since 14.1.0\n  */\n  unsetTicketAttribute(options: {\n    key: string;\n  }): Promise<{\n    unsetTicketAttribute: boolean;\n  }>;\n\n  /**\n  * Clear all ticket attributes\n  *\n  * @since 14.1.0\n  */\n  clearTicketAttributes(): Promise<{\n    clearTicketAttributes: boolean;\n  }>;\n\n  /**\n  * Set custom data\n  *\n  * @since 7.0.0\n  */\n  setCustomData(options: {\n    key: string;\n    value: string;\n  }): Promise<{\n    setCustomData: boolean;\n  }>;\n\n  /**\n  * Remove custom data by key\n  *\n  * @since 7.0.0\n  */\n  removeCustomData(options: {\n    key: string;\n  }): Promise<{\n    removedCustomData: boolean;\n  }>;\n\n  /**\n  * Clear custom data\n  *\n  * @since 7.0.0\n  */\n  clearCustomData(): Promise<{\n    clearedCustomData: boolean;\n  }>;\n\n  /**\n  * Log event to Gleap\n  *\n  * @since 8.0.0\n  */\n  trackEvent(options: {\n    name: string;\n    data?: any;\n  }): Promise<{\n    loggedEvent: boolean;\n  }>;\n\n  /**\n  * Track a page view\n  *\n  * @since 8.4.1\n  */\n  trackPage(options: {\n    pageName: string;\n  }): Promise<{\n    trackedPage: boolean;\n  }>;\n\n  /**\n   * \n   *\n   * @since 7.0.0\n   */\n  setEventCallback(\n    callback: GleapEventCallback,\n  ): Promise<CallbackID>;\n\n  /**\n * Log event to Gleap\n *\n * @since 7.0.0\n */\n  sendSilentCrashReport(options: {\n    description: string,\n    severity?: \"LOW\" | \"MEDIUM\" | \"HIGH\";\n    dataExclusion?: {\n      customData: Boolean;\n      metaData: Boolean;\n      attachments: Boolean;\n      consoleLog: Boolean;\n      networkLogs: Boolean;\n      customEventLog: Boolean;\n      screenshot: Boolean;\n      replays: Boolean;\n    };\n  }): Promise<{\n    sentSilentBugReport: boolean;\n  }>;\n\n  /**\n  * Prefills the widget's form data\n  *\n  * @since 7.0.0\n  */\n  preFillForm(options: {\n    data: any;\n  }): Promise<{\n    preFilledForm: boolean;\n  }>;\n\n  /**\n  * Add attachment as bas64 string\n  *\n  * @since 7.0.0\n  */\n  addAttachment(options: {\n    base64data: string;\n    name: string;\n  }): Promise<{\n    attachmentAdded: boolean;\n  }>;\n\n  /**\n  * All attachments removed\n  *\n  * @since 7.0.0\n  */\n  removeAllAttachments(): Promise<{\n    allAttachmentsRemoved: boolean;\n  }>;\n\n  /**\n  * Open widget\n  *\n  * @since 7.0.0\n  */\n  open(): Promise<{\n    openedWidget: boolean;\n  }>;\n\n  /**\n  * Open news\n  *\n  * @since 8.4.0\n  */\n  openNews(options: {\n    showBackButton?: boolean;\n  }): Promise<{\n    openedNews: boolean;\n  }>;\n\n  /**\n  * Open news article\n  *\n  * @since 8.4.0\n  */\n  openNewsArticle(options: {\n    articleId: string;\n    showBackButton?: boolean;\n  }): Promise<{\n    opened: boolean;\n  }>;\n\n  /**\n  * Open help center\n  *\n  * @since 8.4.0\n  */\n  openHelpCenter(options: {\n    showBackButton?: boolean;\n  }): Promise<{\n    opened: boolean;\n  }>;\n\n  /**\n  * Open help center article\n  *\n  * @since 8.4.0\n  */\n  openHelpCenterArticle(options: {\n    articleId: string;\n    showBackButton?: boolean;\n  }): Promise<{\n    opened: boolean;\n  }>;\n\n  /**\n  * Ask the AI a question\n  *\n  * @since 15.0.0\n  */\n  askAI(options: {\n    question: string;\n    showBackButton?: boolean;\n  }): Promise<{\n    opened: boolean;\n  }>;\n\n  /**\n  * Open help center collection\n  *\n  * @since 8.4.0\n  */\n  openHelpCenterCollection(options: {\n    collectionId: string;\n    showBackButton?: boolean;\n  }): Promise<{\n    opened: boolean;\n  }>;\n\n  /**\n  * Search help center\n  *\n  * @since 8.4.0\n  */\n  searchHelpCenter(options: {\n    term: string;\n    showBackButton?: boolean;\n  }): Promise<{\n    opened: boolean;\n  }>;\n\n  /**\n  * Open feature requests\n  *\n  * @since 8.4.0\n  */\n  openFeatureRequests(options: {\n    showBackButton?: boolean;\n  }): Promise<{\n    openedFeatureRequests: boolean;\n  }>;\n\n  /**\n  * Close widget\n  *\n  * @since 7.0.0\n  */\n  close(): Promise<{\n    closedWidget: boolean;\n  }>;\n\n  /**\n  * Check widget status code\n  *\n  * @since 7.0.0\n  */\n  isOpened(): Promise<{\n    isOpened: boolean;\n  }>;\n\n  /**\n * Start feedback flow\n *\n * @since 7.0.0\n */\n  startFeedbackFlow(options: {\n    feedbackFlow?: string;\n    showBackButton?: boolean;\n  }): Promise<{\n    startedFeedbackFlow: boolean;\n  }>;\n\n  /**\n * Start a classic form\n *\n * @since 13.1.0\n */\n  startClassicForm(options: {\n    formId?: string;\n    showBackButton?: boolean;\n  }): Promise<{\n    classicFormStarted: boolean;\n  }>;\n\n  /**\n * Start a new conversation\n *\n * @since 13.1.0\n */\n  startConversation(options: {\n    showBackButton?: boolean;\n  }): Promise<{\n    conversationStarted: boolean;\n  }>;\n\n  /**\n * Opens the conversations tab.\n *\n * @since 13.9.0\n */\n  openConversation(options: {\n    showBackButton?: boolean;\n  }): Promise<{\n    conversationsOpened: boolean;\n  }>;\n\n  /**\n * Start bot\n *\n * @since 10.0.3\n */\n  startBot(options: {\n    botId?: string;\n    showBackButton?: boolean;\n  }): Promise<{\n    startedBot: boolean;\n  }>;\n\n  /**\n * Show or hide the feedback button.\n *\n * @since 8.0.0\n */\n  showFeedbackButton(options: {\n    show?: boolean;\n  }): Promise<{\n    feedbackButtonShown: boolean;\n  }>;\n\n  /**\n* Disable in app notifications.\n*\n* @since 8.6.1\n*/\n  setDisableInAppNotifications(options: {\n    disableInAppNotifications?: boolean;\n  }): Promise<{\n    inAppNotificationsDisabled: boolean;\n  }>;\n\n  /**\n * Set Language\n *\n * @since 7.0.0\n */\n  setLanguage(options: {\n    languageCode: string;\n  }): Promise<{\n    setLanguage: string;\n  }>;\n\n  /**\n * Disable console log overwrite\n *\n * @since 7.0.0\n */\n  disableConsoleLogOverwrite(): Promise<{\n    consoleLogDisabled: boolean;\n  }>;\n\n  /**\n * Enable debug console log\n *\n * @since 7.0.0\n */\n  enableDebugConsoleLog(): Promise<{\n    debugConsoleLogEnabled: boolean;\n  }>;\n\n  /**\n * Set the notification container offset\n *\n * @since 15.2.0\n */\n  setNotificationContainerOffset(options: {\n    x: number;\n    y: number;\n  }): Promise<{\n    notificationContainerOffsetSet: boolean;\n  }>;\n\n}"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["import type { PluginListenerHandle } from '@capacitor/core';\n\nexport type CallbackID = string;\n\nexport interface GleapEventMessage {\n  name: string,\n  data?: any,\n}\n\nexport type GleapEventCallback = (message: GleapEventMessage | null, err?: any) => void;\n\nexport interface GleapPlugin {\n  /**\n  * Initialize Gleap with an API key\n  *\n  * @since 7.0.0\n  */\n  initialize(options: {\n    API_KEY: string;\n  }): Promise<{\n    initialized: boolean;\n  }>;\n\n  /**\n  * Set the data region of your Gleap project (\"eu\" is the default).\n  * Sets the API, websocket and realtime hosts at once. Must be called before initialize.\n  * A manual setter (setApiUrl, setWSApiUrl, setRealtimeHost) called afterwards overrides that single host.\n  *\n  * @since 18.0.0\n  */\n  setRegion(options: {\n    region: 'eu' | 'us';\n  }): Promise<{\n    region: string;\n  }>;\n\n  /**\n  * Set a custom API url. Must be called before initialize.\n  *\n  * @since 18.0.0\n  */\n  setApiUrl(options: {\n    url: string;\n  }): Promise<{\n    url: string;\n  }>;\n\n  /**\n  * Set a custom websocket API url. Must be called before initialize.\n  *\n  * @since 18.0.0\n  */\n  setWSApiUrl(options: {\n    url: string;\n  }): Promise<{\n    url: string;\n  }>;\n\n  /**\n  * Set a custom realtime host (hostname only, without protocol or path). Must be called before initialize.\n  *\n  * @since 18.0.0\n  */\n  setRealtimeHost(options: {\n    host: string;\n  }): Promise<{\n    host: string;\n  }>;\n\n  /**\n  * Set a custom widget frame url. Must be called before initialize.\n  *\n  * @since 18.0.0\n  */\n  setFrameUrl(options: {\n    url: string;\n  }): Promise<{\n    url: string;\n  }>;\n\n  /**\n  * Set a custom banner url. Must be called before initialize.\n  *\n  * @since 18.0.0\n  */\n  setBannerUrl(options: {\n    url: string;\n  }): Promise<{\n    url: string;\n  }>;\n\n  /**\n  * Set a custom modal url. Must be called before initialize.\n  *\n  * @since 18.0.0\n  */\n  setModalUrl(options: {\n    url: string;\n  }): Promise<{\n    url: string;\n  }>;\n\n  /**\n  * Set user identity\n  *\n  * @since 7.0.0\n  */\n  identify(options: {\n    userId: string;\n    userHash?: string;\n    name?: string;\n    email?: string;\n    phone?: string;\n    companyId?: string;\n    companyName?: string;\n    avatar?: string;\n    sla?: number;\n    plan?: string;\n    value?: number;\n    customData?: Object;\n  }): Promise<{\n    identify: boolean;\n  }>;\n\n  /**\n  * Update user properties\n  *\n  * @since 13.2.1\n  */\n  updateContact(options: {\n    name?: string;\n    email?: string;\n    phone?: string;\n    companyId?: string;\n    companyName?: string;\n    avatar?: string;\n    sla?: number;\n    plan?: string;\n    value?: number;\n    customData?: Object;\n  }): Promise<{\n    identify: boolean;\n  }>;\n\n  /**\n  * Clear user identity\n  *\n  * @since 7.0.0\n  */\n  clearIdentity(): Promise<{\n    clearIdentity: boolean;\n  }>;\n\n  /**\n  * Get the current user identity\n  *\n  * @since 8.1.0\n  */\n  getIdentity(): Promise<{\n    identity: {\n      userId: string;\n      name?: string;\n      email?: string;\n      phone?: string;\n      value?: number;\n    };\n  }>;\n\n  /**\n  * User identified status.\n  *\n  * @since 8.1.0\n  */\n  isUserIdentified(): Promise<{\n    isUserIdentified: boolean;\n  }>;\n\n  /**\n  * Submit a custom log message with the given level\n  *\n  * @since 7.0.0\n  */\n  log(options: {\n    message: string;\n    logLevel?: \"ERROR\" | \"WARNING\" | \"INFO\";\n  }): Promise<{\n    logged: boolean;\n  }>;\n\n  /**\n  * Manually show a survey.\n  *\n  * @since 8.5.1\n  */\n  showSurvey(options: {\n    surveyId: string;\n    format?: \"survey\" | \"survey_full\";\n  }): Promise<{\n    opened: boolean;\n  }>;\n\n  /**\n  * Add custom data\n  *\n  * @since 7.0.0\n  */\n  attachCustomData(options: {\n    data: any;\n  }): Promise<{\n    attachedCustomData: boolean;\n  }>;\n\n  /**\n  * Set tags\n  *\n  * @since 8.6.0\n  */\n  setTags(options: {\n    tags: string[];\n  }): Promise<{\n    tagsSet: boolean;\n  }>;\n\n  /**\n  * Set network logs blacklist\n  *\n  * @since 13.2.1\n  */\n  setNetworkLogsBlacklist(options: {\n    blacklist: string[];\n  }): Promise<{\n    blacklistSet: boolean;\n  }>;\n\n  /**\n  * Set network logs props to ignore\n  *\n  * @since 13.2.1\n  */\n  setNetworkLogPropsToIgnore(options: {\n    propsToIgnore: string[];\n  }): Promise<{\n    propsToIgnoreSet: boolean;\n  }>;\n\n  /**\n  * Registers a Frontend tool defined on your AI agent in the Gleap dashboard.\n  * Prefer the `registerAgentTool(name, handler)` helper exported by this\n  * package — it wires the agentToolExecution event and result round-trip for\n  * you.\n  *\n  * @since 15.0.0\n  */\n  registerAgentTool(options: {\n    name: string;\n  }): Promise<void>;\n\n  /**\n  * Resolves a pending agent tool execution with the handler's result.\n  * Used by the `registerAgentTool(name, handler)` helper.\n  *\n  * @since 15.0.0\n  */\n  sendAgentToolResult(options: {\n    executionId: string;\n    result: string;\n  }): Promise<void>;\n\n  /**\n  * Called when a registered agent tool should execute.\n  *\n  * @since 15.0.0\n  */\n  addListener(\n    eventName: 'agentToolExecution',\n    listenerFunc: (data: {\n      executionId: string;\n      name: string;\n      params: any;\n    }) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n  * Sets the value of a ticket attribute\n  *\n  * @since 13.5.0\n  */\n  setTicketAttribute(options: {\n    key: string;\n    value: string;\n  }): Promise<{\n    setTicketAttribute: boolean;\n  }>;\n\n  /**\n  * Unset a ticket attribute\n  *\n  * @since 14.1.0\n  */\n  unsetTicketAttribute(options: {\n    key: string;\n  }): Promise<{\n    unsetTicketAttribute: boolean;\n  }>;\n\n  /**\n  * Clear all ticket attributes\n  *\n  * @since 14.1.0\n  */\n  clearTicketAttributes(): Promise<{\n    clearTicketAttributes: boolean;\n  }>;\n\n  /**\n  * Set custom data\n  *\n  * @since 7.0.0\n  */\n  setCustomData(options: {\n    key: string;\n    value: string;\n  }): Promise<{\n    setCustomData: boolean;\n  }>;\n\n  /**\n  * Remove custom data by key\n  *\n  * @since 7.0.0\n  */\n  removeCustomData(options: {\n    key: string;\n  }): Promise<{\n    removedCustomData: boolean;\n  }>;\n\n  /**\n  * Clear custom data\n  *\n  * @since 7.0.0\n  */\n  clearCustomData(): Promise<{\n    clearedCustomData: boolean;\n  }>;\n\n  /**\n  * Log event to Gleap\n  *\n  * @since 8.0.0\n  */\n  trackEvent(options: {\n    name: string;\n    data?: any;\n  }): Promise<{\n    loggedEvent: boolean;\n  }>;\n\n  /**\n  * Track a page view\n  *\n  * @since 8.4.1\n  */\n  trackPage(options: {\n    pageName: string;\n  }): Promise<{\n    trackedPage: boolean;\n  }>;\n\n  /**\n   * \n   *\n   * @since 7.0.0\n   */\n  setEventCallback(\n    callback: GleapEventCallback,\n  ): Promise<CallbackID>;\n\n  /**\n * Log event to Gleap\n *\n * @since 7.0.0\n */\n  sendSilentCrashReport(options: {\n    description: string,\n    severity?: \"LOW\" | \"MEDIUM\" | \"HIGH\";\n    dataExclusion?: {\n      customData: Boolean;\n      metaData: Boolean;\n      attachments: Boolean;\n      consoleLog: Boolean;\n      networkLogs: Boolean;\n      customEventLog: Boolean;\n      screenshot: Boolean;\n      replays: Boolean;\n    };\n  }): Promise<{\n    sentSilentBugReport: boolean;\n  }>;\n\n  /**\n  * Prefills the widget's form data\n  *\n  * @since 7.0.0\n  */\n  preFillForm(options: {\n    data: any;\n  }): Promise<{\n    preFilledForm: boolean;\n  }>;\n\n  /**\n  * Add attachment as bas64 string\n  *\n  * @since 7.0.0\n  */\n  addAttachment(options: {\n    base64data: string;\n    name: string;\n  }): Promise<{\n    attachmentAdded: boolean;\n  }>;\n\n  /**\n  * All attachments removed\n  *\n  * @since 7.0.0\n  */\n  removeAllAttachments(): Promise<{\n    allAttachmentsRemoved: boolean;\n  }>;\n\n  /**\n  * Open widget\n  *\n  * @since 7.0.0\n  */\n  open(): Promise<{\n    openedWidget: boolean;\n  }>;\n\n  /**\n  * Open news\n  *\n  * @since 8.4.0\n  */\n  openNews(options: {\n    showBackButton?: boolean;\n  }): Promise<{\n    openedNews: boolean;\n  }>;\n\n  /**\n  * Open news article\n  *\n  * @since 8.4.0\n  */\n  openNewsArticle(options: {\n    articleId: string;\n    showBackButton?: boolean;\n  }): Promise<{\n    opened: boolean;\n  }>;\n\n  /**\n  * Open help center\n  *\n  * @since 8.4.0\n  */\n  openHelpCenter(options: {\n    showBackButton?: boolean;\n  }): Promise<{\n    opened: boolean;\n  }>;\n\n  /**\n  * Open help center article\n  *\n  * @since 8.4.0\n  */\n  openHelpCenterArticle(options: {\n    articleId: string;\n    showBackButton?: boolean;\n  }): Promise<{\n    opened: boolean;\n  }>;\n\n  /**\n  * Ask the AI a question\n  *\n  * @since 15.0.0\n  */\n  askAI(options: {\n    question: string;\n    showBackButton?: boolean;\n  }): Promise<{\n    opened: boolean;\n  }>;\n\n  /**\n  * Open help center collection\n  *\n  * @since 8.4.0\n  */\n  openHelpCenterCollection(options: {\n    collectionId: string;\n    showBackButton?: boolean;\n  }): Promise<{\n    opened: boolean;\n  }>;\n\n  /**\n  * Search help center\n  *\n  * @since 8.4.0\n  */\n  searchHelpCenter(options: {\n    term: string;\n    showBackButton?: boolean;\n  }): Promise<{\n    opened: boolean;\n  }>;\n\n  /**\n  * Open feature requests\n  *\n  * @since 8.4.0\n  */\n  openFeatureRequests(options: {\n    showBackButton?: boolean;\n  }): Promise<{\n    openedFeatureRequests: boolean;\n  }>;\n\n  /**\n  * Close widget\n  *\n  * @since 7.0.0\n  */\n  close(): Promise<{\n    closedWidget: boolean;\n  }>;\n\n  /**\n  * Check widget status code\n  *\n  * @since 7.0.0\n  */\n  isOpened(): Promise<{\n    isOpened: boolean;\n  }>;\n\n  /**\n * Start feedback flow\n *\n * @since 7.0.0\n */\n  startFeedbackFlow(options: {\n    feedbackFlow?: string;\n    showBackButton?: boolean;\n  }): Promise<{\n    startedFeedbackFlow: boolean;\n  }>;\n\n  /**\n * Start a classic form\n *\n * @since 13.1.0\n */\n  startClassicForm(options: {\n    formId?: string;\n    showBackButton?: boolean;\n  }): Promise<{\n    classicFormStarted: boolean;\n  }>;\n\n  /**\n * Start a new conversation\n *\n * @since 13.1.0\n */\n  startConversation(options: {\n    showBackButton?: boolean;\n  }): Promise<{\n    conversationStarted: boolean;\n  }>;\n\n  /**\n * Opens the conversations tab.\n *\n * @since 13.9.0\n */\n  openConversation(options: {\n    showBackButton?: boolean;\n  }): Promise<{\n    conversationsOpened: boolean;\n  }>;\n\n  /**\n * Start bot\n *\n * @since 10.0.3\n */\n  startBot(options: {\n    botId?: string;\n    showBackButton?: boolean;\n  }): Promise<{\n    startedBot: boolean;\n  }>;\n\n  /**\n * Show or hide the feedback button.\n *\n * @since 8.0.0\n */\n  showFeedbackButton(options: {\n    show?: boolean;\n  }): Promise<{\n    feedbackButtonShown: boolean;\n  }>;\n\n  /**\n* Disable in app notifications.\n*\n* @since 8.6.1\n*/\n  setDisableInAppNotifications(options: {\n    disableInAppNotifications?: boolean;\n  }): Promise<{\n    inAppNotificationsDisabled: boolean;\n  }>;\n\n  /**\n * Set Language\n *\n * @since 7.0.0\n */\n  setLanguage(options: {\n    languageCode: string;\n  }): Promise<{\n    setLanguage: string;\n  }>;\n\n  /**\n * Disable console log overwrite\n *\n * @since 7.0.0\n */\n  disableConsoleLogOverwrite(): Promise<{\n    consoleLogDisabled: boolean;\n  }>;\n\n  /**\n * Enable debug console log\n *\n * @since 7.0.0\n */\n  enableDebugConsoleLog(): Promise<{\n    debugConsoleLogEnabled: boolean;\n  }>;\n\n  /**\n * Set the notification container offset\n *\n * @since 15.2.0\n */\n  setNotificationContainerOffset(options: {\n    x: number;\n    y: number;\n  }): Promise<{\n    notificationContainerOffsetSet: boolean;\n  }>;\n\n}"]}

package/dist/esm/web.d.ts

@@ -12,6 +12,41 @@ export declare class GleapWeb extends WebPlugin implements GleapPlugin {
     }): Promise<{
         initialized: boolean;
     }>;
+    setRegion(options: {
+        region: 'eu' | 'us';
+    }): Promise<{
+        region: string;
+    }>;
+    setApiUrl(options: {
+        url: string;
+    }): Promise<{
+        url: string;
+    }>;
+    setWSApiUrl(options: {
+        url: string;
+    }): Promise<{
+        url: string;
+    }>;
+    setRealtimeHost(options: {
+        host: string;
+    }): Promise<{
+        host: string;
+    }>;
+    setFrameUrl(options: {
+        url: string;
+    }): Promise<{
+        url: string;
+    }>;
+    setBannerUrl(options: {
+        url: string;
+    }): Promise<{
+        url: string;
+    }>;
+    setModalUrl(options: {
+        url: string;
+    }): Promise<{
+        url: string;
+    }>;
     registerCallbackListeners(): void;
     registerAgentTool(options: {
         name: string;