capacitor-gleap-plugin 19.0.1 → 19.1.0

package/CapacitorGleapPlugin.podspec

@@ -18,6 +18,6 @@ Pod::Spec.new do |s|
   s.source_files = 'ios/Sources/**/*.{swift,h,m,c,cc,mm,cpp}'
   s.ios.deployment_target = '15.0'
   s.dependency 'Capacitor'
-  s.dependency 'Gleap', '19.0.0'
+  s.dependency 'Gleap', '19.1.0'
   s.swift_version = '5.1'
 end

package/Package.swift

@@ -16,7 +16,7 @@ let package = Package(
         // Capacitor rewrites this to the app's Capacitor major version during `npx cap sync`.
         .package(url: "https://github.com/ionic-team/capacitor-swift-pm.git", from: "7.0.0"),
         // Native Gleap iOS SDK, released together with this plugin (same version).
-        .package(url: "https://github.com/GleapSDK/Gleap-iOS-SDK.git", from: "19.0.0")
+        .package(url: "https://github.com/GleapSDK/Gleap-iOS-SDK.git", from: "19.1.0")
     ],
     targets: [
         .target(

package/README.md

@@ -27,7 +27,7 @@ The plugin needs Capacitor 7 or later and an iOS deployment target of **15.0** o
 target 'App' do
   capacitor_pods
   # Add your Pods here
-  pod 'Gleap', :git => 'https://github.com/GleapSDK/Gleap-iOS-SDK.git', :tag => '19.0.0'
+  pod 'Gleap', :git => 'https://github.com/GleapSDK/Gleap-iOS-SDK.git', :tag => '19.1.0'
 end
 ```
 
@@ -131,11 +131,13 @@ App.addListener("appUrlOpen", ({ url }) => {
 * [`setNetworkLogPropsToIgnore(...)`](#setnetworklogpropstoignore)
 * [`attachNetworkLogs(...)`](#attachnetworklogs)
 * [`attachConsoleLogs(...)`](#attachconsolelogs)
+* [`logsFlushed(...)`](#logsflushed)
 * [`setEnvDataPropsToIgnore(...)`](#setenvdatapropstoignore)
 * [`registerAgentTool(...)`](#registeragenttool)
 * [`sendAgentToolResult(...)`](#sendagenttoolresult)
 * [`addListener('agentToolExecution', ...)`](#addlisteneragenttoolexecution-)
 * [`addListener('logConfigLoaded', ...)`](#addlistenerlogconfigloaded-)
+* [`addListener('flushLogs', ...)`](#addlistenerflushlogs-)
 * [`setTicketAttribute(...)`](#setticketattribute)
 * [`unsetTicketAttribute(...)`](#unsetticketattribute)
 * [`clearTicketAttributes()`](#clearticketattributes)
@@ -174,6 +176,8 @@ App.addListener("appUrlOpen", ({ url }) => {
 * [`setDisableInAppNotifications(...)`](#setdisableinappnotifications)
 * [`setDisableEnvData(...)`](#setdisableenvdata)
 * [`setColorScheme(...)`](#setcolorscheme)
+* [`setCaptureEnabled(...)`](#setcaptureenabled)
+* [`setRemoteLogCollectionEnabled(...)`](#setremotelogcollectionenabled)
 * [`setLanguage(...)`](#setlanguage)
 * [`disableConsoleLogOverwrite()`](#disableconsolelogoverwrite)
 * [`enableDebugConsoleLog()`](#enabledebugconsolelog)
@@ -580,6 +584,25 @@ No-op on web, where the JavaScript SDK records the console itself.
 --------------------
 
 
+### logsFlushed(...)
+
+```typescript
+logsFlushed(options: { flushId: string; }) => Promise<void>
+```
+
+Answers a `flushLogs` event once the WebView console and network logs the plugin buffers were handed to the native
+SDK, so it collects the logs for a capture request with them. The plugin calls this for you on iOS and Android.
+No-op on web.
+
+| Param         | Type                              |
+| ------------- | --------------------------------- |
+| **`options`** | <code>{ flushId: string; }</code> |
+
+**Since:** 19.1.0
+
+--------------------
+
+
 ### setEnvDataPropsToIgnore(...)
 
 ```typescript
@@ -680,6 +703,28 @@ WebView log capture needs (network logs are only recorded when they are enabled
 --------------------
 
 
+### addListener('flushLogs', ...)
+
+```typescript
+addListener(eventName: 'flushLogs', listenerFunc: (data: { flushId: string; }) => void) => Promise<PluginListenerHandle>
+```
+
+Called on iOS and Android right before the native SDK collects the logs for a capture request: the plugin's
+WebView log capture hands over what it buffers (it pushes at most every 500 ms otherwise) and answers with
+`logsFlushed`. The native SDK waits at most 500 ms for the answer. The plugin listens for you.
+
+| Param              | Type                                                 |
+| ------------------ | ---------------------------------------------------- |
+| **`eventName`**    | <code>'flushLogs'</code>                             |
+| **`listenerFunc`** | <code>(data: { flushId: string; }) =&gt; void</code> |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
+
+**Since:** 19.1.0
+
+--------------------
+
+
 ### setTicketAttribute(...)
 
 ```typescript
@@ -1392,6 +1437,53 @@ Can be called before or after initialize and applies live.
 --------------------
 
 
+### setCaptureEnabled(...)
+
+```typescript
+setCaptureEnabled(options: { enabled: boolean; }) => Promise<{ captureEnabled: boolean; }>
+```
+
+Enable or disable screenshots and screen recordings for capture requests: when a workflow, an AI agent or a
+teammate asks the user in the widget to show the issue, the widget steps aside, a small bar lets the user go to
+the right screen, and the SDK captures the app once they tap Capture (or records it between Start and Stop).
+Nothing is captured without that tap. While disabled, the widget only offers to upload a file.
+Enabled by default. Works on iOS, Android and web and can be called before or after initialize.
+
+| Param         | Type                               |
+| ------------- | ---------------------------------- |
+| **`options`** | <code>{ enabled: boolean; }</code> |
+
+**Returns:** <code>Promise&lt;{ captureEnabled: boolean; }&gt;</code>
+
+**Since:** 19.1.0
+
+--------------------
+
+
+### setRemoteLogCollectionEnabled(...)
+
+```typescript
+setRemoteLogCollectionEnabled(options: { enabled: boolean; }) => Promise<{ remoteLogCollectionEnabled: boolean; }>
+```
+
+Enable or disable sending the app's logs for capture requests: a workflow or an AI agent can ask for the logs
+while the app runs (no user action), and screenshots and recordings can bring the logs around them. The logs are
+what a bug report carries (console and network logs, custom data, env data, custom events; the replay only when
+it is asked for and enabled in the dashboard), and the existing settings still apply (e.g. setDisableEnvData).
+While disabled, log requests are answered as not supported and captures are sent without logs.
+Enabled by default. Works on iOS, Android and web and can be called before or after initialize.
+
+| Param         | Type                               |
+| ------------- | ---------------------------------- |
+| **`options`** | <code>{ enabled: boolean; }</code> |
+
+**Returns:** <code>Promise&lt;{ remoteLogCollectionEnabled: boolean; }&gt;</code>
+
+**Since:** 19.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: '19.0.0'
+    implementation group: 'io.gleap', name: 'gleap-android-sdk', version: '19.1.0'
 }

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

@@ -2,6 +2,8 @@ package io.gleapplugins.capacitor;
 
 import android.Manifest;
 import android.os.Build;
+import android.os.Handler;
+import android.os.Looper;
 
 import com.getcapacitor.JSArray;
 import com.getcapacitor.JSObject;
@@ -12,6 +14,7 @@ import com.getcapacitor.annotation.CapacitorPlugin;
 import com.getcapacitor.annotation.Permission;
 import io.gleap.APPLICATIONTYPE;
 import io.gleap.Gleap;
+import io.gleap.GleapLogFlushHandler;
 import io.gleap.GleapLogLevel;
 import io.gleap.GleapNotInitialisedException;
 import io.gleap.GleapSessionProperties;
@@ -62,6 +65,12 @@ public class GleapPlugin extends Plugin {
     private volatile JSObject lastLogConfig;
     // Set by disableConsoleLogOverwrite: WebView console logs are no longer attached.
     private volatile boolean webViewConsoleLogsDisabled = false;
+    // Capture requests: log flushes the native SDK waits for (at most 500 ms) until the WebView log capture handed
+    // over what it buffers, by flush id.
+    private final Map<String, Runnable> pendingLogFlushes = new ConcurrentHashMap<>();
+    private final Handler mainHandler = new Handler(Looper.getMainLooper());
+    // An unanswered flush (e.g. the page reloaded) is forgotten after this; the SDK stopped waiting long before.
+    private static final long LOG_FLUSH_FORGET_MS = 1000;
 
     @Override
     public void load() {
@@ -119,6 +128,8 @@ public class GleapPlugin extends Plugin {
         // Set the application type
         Gleap.getInstance().setApplicationType(APPLICATIONTYPE.CAPACITOR);
 
+        registerLogFlushHandler();
+
         // A reloaded WebView calls initialize again: hand it the config that was already loaded.
         JSObject logConfig = lastLogConfig;
         if (logConfig != null) {
@@ -131,6 +142,76 @@ public class GleapPlugin extends Plugin {
         call.resolve(ret);
     }
 
+    /**
+     * Capture requests: before the native SDK collects the logs for a request, the WebView log capture hands over
+     * what it buffers (pushed at most every 500 ms otherwise). The SDK calls this on the main thread and waits at
+     * most 500 ms for done; without a flushLogs listener it does not wait.
+     */
+    private void registerLogFlushHandler() {
+        try {
+            implementation.setLogFlushHandler(
+                new GleapLogFlushHandler() {
+                    @Override
+                    public void onFlushRequested(Runnable done) {
+                        requestLogFlush(done);
+                    }
+                }
+            );
+        } catch (Exception | LinkageError ex) {
+            System.out.println(ex);
+        }
+    }
+
+    private void requestLogFlush(Runnable done) {
+        if (done == null) {
+            return;
+        }
+        if (!hasListeners("flushLogs")) {
+            done.run();
+            return;
+        }
+        final String flushId = UUID.randomUUID().toString();
+        pendingLogFlushes.put(flushId, done);
+        try {
+            JSObject data = new JSObject();
+            data.put("flushId", flushId);
+            notifyListeners("flushLogs", data);
+        } catch (Exception ex) {
+            finishLogFlush(flushId);
+            return;
+        }
+        mainHandler.postDelayed(
+            new Runnable() {
+                @Override
+                public void run() {
+                    pendingLogFlushes.remove(flushId);
+                }
+            },
+            LOG_FLUSH_FORGET_MS
+        );
+    }
+
+    private void finishLogFlush(String flushId) {
+        if (flushId == null) {
+            return;
+        }
+        Runnable done = pendingLogFlushes.remove(flushId);
+        if (done != null) {
+            try {
+                done.run();
+            } catch (Exception ignore) {}
+        }
+    }
+
+    /**
+     * The WebView log capture handed over what it buffered for the flush with this id.
+     */
+    @PluginMethod
+    public void logsFlushed(PluginCall call) {
+        finishLogFlush(call.getString("flushId"));
+        call.resolve();
+    }
+
     // Data region & host overrides. All of them must be called before initialize.
     @PluginMethod
     public void setRegion(PluginCall call) {
@@ -906,6 +987,50 @@ public class GleapPlugin extends Plugin {
         call.resolve(ret);
     }
 
+    /**
+     * Enables or disables screenshots and screen recordings for capture requests.
+     */
+    @PluginMethod
+    public void setCaptureEnabled(PluginCall call) {
+        Boolean enabled = call.getBoolean("enabled");
+        if (enabled == null) {
+            call.reject("No enabled value provided");
+            return;
+        }
+
+        try {
+            implementation.setCaptureEnabled(enabled);
+        } catch (Exception | LinkageError ex) {
+            System.out.println(ex);
+        }
+
+        JSObject ret = new JSObject();
+        ret.put("captureEnabled", enabled);
+        call.resolve(ret);
+    }
+
+    /**
+     * Enables or disables sending the app's logs for capture requests.
+     */
+    @PluginMethod
+    public void setRemoteLogCollectionEnabled(PluginCall call) {
+        Boolean enabled = call.getBoolean("enabled");
+        if (enabled == null) {
+            call.reject("No enabled value provided");
+            return;
+        }
+
+        try {
+            implementation.setRemoteLogCollectionEnabled(enabled);
+        } catch (Exception | LinkageError ex) {
+            System.out.println(ex);
+        }
+
+        JSObject ret = new JSObject();
+        ret.put("remoteLogCollectionEnabled", enabled);
+        call.resolve(ret);
+    }
+
     @PluginMethod
     public void showFeedbackButton(PluginCall call) {
         boolean show = call.getBoolean("show", false);

package/dist/docs.json

@@ -436,6 +436,27 @@
         ],
         "slug": "attachconsolelogs"
       },
+      {
+        "name": "logsFlushed",
+        "signature": "(options: { flushId: string; }) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ flushId: string; }"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "19.1.0"
+          }
+        ],
+        "docs": "Answers a `flushLogs` event once the WebView console and network logs the plugin buffers were handed to the native\nSDK, so it collects the logs for a capture request with them. The plugin calls this for you on iOS and Android.\nNo-op on web.",
+        "complexTypes": [],
+        "slug": "logsflushed"
+      },
       {
         "name": "setEnvDataPropsToIgnore",
         "signature": "(options: { propsToIgnore: string[]; }) => Promise<{ envDataPropsToIgnoreSet: boolean; }>",
@@ -556,6 +577,34 @@
         ],
         "slug": "addlistenerlogconfigloaded-"
       },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'flushLogs', listenerFunc: (data: { flushId: string; }) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'flushLogs'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(data: { flushId: string; }) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "19.1.0"
+          }
+        ],
+        "docs": "Called on iOS and Android right before the native SDK collects the logs for a capture request: the plugin's\nWebView log capture hands over what it buffers (it pushes at most every 500 ms otherwise) and answers with\n`logsFlushed`. The native SDK waits at most 500 ms for the answer. The plugin listens for you.",
+        "complexTypes": [
+          "PluginListenerHandle"
+        ],
+        "slug": "addlistenerflushlogs-"
+      },
       {
         "name": "setTicketAttribute",
         "signature": "(options: { key: string; value: string; }) => Promise<{ setTicketAttribute: boolean; }>",
@@ -1323,6 +1372,48 @@
         "complexTypes": [],
         "slug": "setcolorscheme"
       },
+      {
+        "name": "setCaptureEnabled",
+        "signature": "(options: { enabled: boolean; }) => Promise<{ captureEnabled: boolean; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ enabled: boolean; }"
+          }
+        ],
+        "returns": "Promise<{ captureEnabled: boolean; }>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "19.1.0"
+          }
+        ],
+        "docs": "Enable or disable screenshots and screen recordings for capture requests: when a workflow, an AI agent or a\nteammate asks the user in the widget to show the issue, the widget steps aside, a small bar lets the user go to\nthe right screen, and the SDK captures the app once they tap Capture (or records it between Start and Stop).\nNothing is captured without that tap. While disabled, the widget only offers to upload a file.\nEnabled by default. Works on iOS, Android and web and can be called before or after initialize.",
+        "complexTypes": [],
+        "slug": "setcaptureenabled"
+      },
+      {
+        "name": "setRemoteLogCollectionEnabled",
+        "signature": "(options: { enabled: boolean; }) => Promise<{ remoteLogCollectionEnabled: boolean; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ enabled: boolean; }"
+          }
+        ],
+        "returns": "Promise<{ remoteLogCollectionEnabled: boolean; }>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "19.1.0"
+          }
+        ],
+        "docs": "Enable or disable sending the app's logs for capture requests: a workflow or an AI agent can ask for the logs\nwhile the app runs (no user action), and screenshots and recordings can bring the logs around them. The logs are\nwhat a bug report carries (console and network logs, custom data, env data, custom events; the replay only when\nit is asked for and enabled in the dashboard), and the existing settings still apply (e.g. setDisableEnvData).\nWhile disabled, log requests are answered as not supported and captures are sent without logs.\nEnabled by default. Works on iOS, Android and web and can be called before or after initialize.",
+        "complexTypes": [],
+        "slug": "setremotelogcollectionenabled"
+      },
       {
         "name": "setLanguage",
         "signature": "(options: { languageCode: string; }) => Promise<{ setLanguage: string; }>",

package/dist/esm/definitions.d.ts

@@ -293,6 +293,16 @@ export interface GleapPlugin {
         consoleLogsAttached: boolean;
     }>;
     /**
+    * Answers a `flushLogs` event once the WebView console and network logs the plugin buffers were handed to the native
+    * SDK, so it collects the logs for a capture request with them. The plugin calls this for you on iOS and Android.
+    * No-op on web.
+    *
+    * @since 19.1.0
+    */
+    logsFlushed(options: {
+        flushId: string;
+    }): Promise<void>;
+    /**
     * 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.
@@ -343,6 +353,16 @@ export interface GleapPlugin {
     */
     addListener(eventName: 'logConfigLoaded', listenerFunc: (config: GleapLogConfig) => void): Promise<PluginListenerHandle>;
     /**
+    * Called on iOS and Android right before the native SDK collects the logs for a capture request: the plugin's
+    * WebView log capture hands over what it buffers (it pushes at most every 500 ms otherwise) and answers with
+    * `logsFlushed`. The native SDK waits at most 500 ms for the answer. The plugin listens for you.
+    *
+    * @since 19.1.0
+    */
+    addListener(eventName: 'flushLogs', listenerFunc: (data: {
+        flushId: string;
+    }) => void): Promise<PluginListenerHandle>;
+    /**
     * Sets the value of a ticket attribute
     *
     * @since 13.5.0
@@ -750,6 +770,35 @@ export interface GleapPlugin {
         colorScheme: string;
     }>;
     /**
+    * Enable or disable screenshots and screen recordings for capture requests: when a workflow, an AI agent or a
+    * teammate asks the user in the widget to show the issue, the widget steps aside, a small bar lets the user go to
+    * the right screen, and the SDK captures the app once they tap Capture (or records it between Start and Stop).
+    * Nothing is captured without that tap. While disabled, the widget only offers to upload a file.
+    * Enabled by default. Works on iOS, Android and web and can be called before or after initialize.
+    *
+    * @since 19.1.0
+    */
+    setCaptureEnabled(options: {
+        enabled: boolean;
+    }): Promise<{
+        captureEnabled: boolean;
+    }>;
+    /**
+    * Enable or disable sending the app's logs for capture requests: a workflow or an AI agent can ask for the logs
+    * while the app runs (no user action), and screenshots and recordings can bring the logs around them. The logs are
+    * what a bug report carries (console and network logs, custom data, env data, custom events; the replay only when
+    * it is asked for and enabled in the dashboard), and the existing settings still apply (e.g. setDisableEnvData).
+    * While disabled, log requests are answered as not supported and captures are sent without logs.
+    * Enabled by default. Works on iOS, Android and web and can be called before or after initialize.
+    *
+    * @since 19.1.0
+    */
+    setRemoteLogCollectionEnabled(options: {
+        enabled: boolean;
+    }): Promise<{
+        remoteLogCollectionEnabled: boolean;
+    }>;
+    /**
    * Set Language
    *
    * @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\n/**\n * A console log entry as the plugin hands it to the native SDK.\n */\nexport interface GleapConsoleLogEntry {\n  /** ISO-8601 UTC timestamp with milliseconds. */\n  date: string;\n  priority: 'ERROR' | 'WARNING' | 'INFO';\n  log: string;\n}\n\n/**\n * A network log entry (fetch / XMLHttpRequest) as the plugin hands it to the native SDK.\n */\nexport interface GleapNetworkLogEntry {\n  /** ISO-8601 UTC timestamp of the request start. */\n  date: string;\n  /** HTTP method, uppercase. */\n  type: string;\n  url: string;\n  /** Milliseconds from the request start to the response headers (or the failure). */\n  duration?: number;\n  /** true when an HTTP response arrived (any status), false on a transport error, abort or timeout. */\n  success?: boolean;\n  request?: {\n    headers?: { [name: string]: string };\n    payload?: string;\n  };\n  response?: {\n    status?: number;\n    statusText?: string;\n    headers?: { [name: string]: string };\n    responseText?: string;\n    /** Set instead of status and body when the request failed. */\n    errorText?: string;\n  };\n}\n\n/**\n * The network log settings of your Gleap project, sent by the native SDK once its config is loaded.\n */\nexport interface GleapLogConfig {\n  enableNetworkLogs: boolean;\n  networkLogPropsToIgnore: string[];\n  networkLogBlacklist: string[];\n}\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?: Record<string, any>;\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?: Record<string, any>;\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  * Hands the network requests made inside the app's WebView (fetch and XMLHttpRequest) to the native SDK, so they\n  * show up in the network logs of tickets. The plugin calls this for you on iOS and Android; each call replaces\n  * the previously attached WebView network logs. No-op on web, where the JavaScript SDK records requests itself.\n  *\n  * @since 19.0.0\n  */\n  attachNetworkLogs(options: {\n    logs: GleapNetworkLogEntry[];\n  }): Promise<{\n    networkLogsAttached: boolean;\n  }>;\n\n  /**\n  * Hands the console output of the app's WebView (console.log/info/warn/error/debug, uncaught errors and\n  * unhandled promise rejections) to the native SDK, so it shows up in the console logs of tickets. The plugin\n  * calls this for you on iOS and Android; each call replaces the previously attached WebView console logs.\n  * No-op on web, where the JavaScript SDK records the console itself.\n  *\n  * @since 19.0.0\n  */\n  attachConsoleLogs(options: {\n    logs: GleapConsoleLogEntry[];\n  }): Promise<{\n    consoleLogsAttached: boolean;\n  }>;\n\n  /**\n  * Set env data props to ignore. The given env data keys (exact and case-sensitive, e.g. \"deviceName\" or \"currentUrl\")\n  * are removed before a ticket or conversation is sent. Each call replaces the previous list, an empty list resets it.\n  * Can be called before or after initialize.\n  *\n  * @since 18.1.0\n  */\n  setEnvDataPropsToIgnore(options: {\n    propsToIgnore: string[];\n  }): Promise<{\n    envDataPropsToIgnoreSet: 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  * Called on iOS and Android when the project config is loaded, with the network log settings the plugin's\n  * WebView log capture needs (network logs are only recorded when they are enabled for your project).\n  *\n  * @since 19.0.0\n  */\n  addListener(\n    eventName: 'logConfigLoaded',\n    listenerFunc: (config: GleapLogConfig) => 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 checklists\n  *\n  * @since 19.0.0\n  */\n  openChecklists(options: {\n    showBackButton?: boolean;\n  }): Promise<{\n    opened: boolean;\n  }>;\n\n  /**\n  * Open checklist\n  *\n  * @since 19.0.0\n  */\n  openChecklist(options: {\n    checklistId: string;\n    showBackButton?: boolean;\n  }): Promise<{\n    opened: boolean;\n  }>;\n\n  /**\n  * Start checklist\n  *\n  * @since 19.0.0\n  */\n  startChecklist(options: {\n    outboundId: string;\n    showBackButton?: boolean;\n  }): Promise<{\n    opened: 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 * Opens the conversations tab (same as openConversation).\n *\n * @since 19.0.0\n */\n  openConversations(options: {\n    showBackButton?: boolean;\n  }): Promise<{\n    conversationsOpened: boolean;\n  }>;\n\n  /**\n  * Open the conversation of a protected file from an emailed link.\n  * With \"Require authenticated file access\" enabled, email replies link attachments to your customer\n  * application URL with a `gleapFile` query parameter. If that URL opens your app (for example as a\n  * universal link / App Link), pass it here, e.g. from `App.addListener('appUrlOpen')` or\n  * `App.getLaunchUrl()` of `@capacitor/app`. `opened` is true when the URL carries a Gleap file reference.\n  * The conversation opens once the customer is identified with a user hash (`identify` with `userHash`);\n  * the link alone grants nothing. On web the JavaScript SDK handles `?gleapFile=` automatically on page load,\n  * so this resolves `{ opened: false }` there.\n  *\n  * @since 19.0.1\n  */\n  openProtectedFileFromUrl(options: {\n    url: string;\n  }): Promise<{\n    opened: 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  * Disable env data. While disabled (true), no env data (device, OS, screen size, locale, URL, ...) is collected\n  * and tickets are sent without it. Pass false to collect env data again. Can be called before or after initialize.\n  *\n  * @since 18.1.0\n  */\n  setDisableEnvData(options: {\n    disableEnvData: boolean;\n  }): Promise<{\n    envDataDisabled: boolean;\n  }>;\n\n  /**\n  * Set the color scheme of the widget. Overrides the color scheme configured in the Gleap dashboard.\n  * Only takes effect when \"Adapt to dark / light mode\" is enabled in the dashboard; otherwise the widget\n  * always keeps its normal colors. Before the first call the dashboard setting applies.\n  * \"auto\" follows the device appearance (dark/light mode) on iOS and Android, and the page theme on web.\n  * Apps with their own in-app theme toggle should pass \"light\" / \"dark\" explicitly and call it again whenever\n  * the theme changes.\n  * In dark mode the widget uses the dark mode colors, logo, header image and composer glow set in the Gleap dashboard;\n  * without dark colors it keeps its normal colors. lightBackgroundColor / darkBackgroundColor override the background.\n  * Can be called before or after initialize and applies live.\n  *\n  * @since 19.0.0\n  */\n  setColorScheme(options: {\n    colorScheme: 'auto' | 'light' | 'dark';\n    lightBackgroundColor?: string;\n    darkBackgroundColor?: string;\n  }): Promise<{\n    colorScheme: string;\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: stops recording the console output of the app's WebView\n * (console methods are restored) and drops the WebView console logs recorded so far.\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\n/**\n * A console log entry as the plugin hands it to the native SDK.\n */\nexport interface GleapConsoleLogEntry {\n  /** ISO-8601 UTC timestamp with milliseconds. */\n  date: string;\n  priority: 'ERROR' | 'WARNING' | 'INFO';\n  log: string;\n}\n\n/**\n * A network log entry (fetch / XMLHttpRequest) as the plugin hands it to the native SDK.\n */\nexport interface GleapNetworkLogEntry {\n  /** ISO-8601 UTC timestamp of the request start. */\n  date: string;\n  /** HTTP method, uppercase. */\n  type: string;\n  url: string;\n  /** Milliseconds from the request start to the response headers (or the failure). */\n  duration?: number;\n  /** true when an HTTP response arrived (any status), false on a transport error, abort or timeout. */\n  success?: boolean;\n  request?: {\n    headers?: { [name: string]: string };\n    payload?: string;\n  };\n  response?: {\n    status?: number;\n    statusText?: string;\n    headers?: { [name: string]: string };\n    responseText?: string;\n    /** Set instead of status and body when the request failed. */\n    errorText?: string;\n  };\n}\n\n/**\n * The network log settings of your Gleap project, sent by the native SDK once its config is loaded.\n */\nexport interface GleapLogConfig {\n  enableNetworkLogs: boolean;\n  networkLogPropsToIgnore: string[];\n  networkLogBlacklist: string[];\n}\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?: Record<string, any>;\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?: Record<string, any>;\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  * Hands the network requests made inside the app's WebView (fetch and XMLHttpRequest) to the native SDK, so they\n  * show up in the network logs of tickets. The plugin calls this for you on iOS and Android; each call replaces\n  * the previously attached WebView network logs. No-op on web, where the JavaScript SDK records requests itself.\n  *\n  * @since 19.0.0\n  */\n  attachNetworkLogs(options: {\n    logs: GleapNetworkLogEntry[];\n  }): Promise<{\n    networkLogsAttached: boolean;\n  }>;\n\n  /**\n  * Hands the console output of the app's WebView (console.log/info/warn/error/debug, uncaught errors and\n  * unhandled promise rejections) to the native SDK, so it shows up in the console logs of tickets. The plugin\n  * calls this for you on iOS and Android; each call replaces the previously attached WebView console logs.\n  * No-op on web, where the JavaScript SDK records the console itself.\n  *\n  * @since 19.0.0\n  */\n  attachConsoleLogs(options: {\n    logs: GleapConsoleLogEntry[];\n  }): Promise<{\n    consoleLogsAttached: boolean;\n  }>;\n\n  /**\n  * Answers a `flushLogs` event once the WebView console and network logs the plugin buffers were handed to the native\n  * SDK, so it collects the logs for a capture request with them. The plugin calls this for you on iOS and Android.\n  * No-op on web.\n  *\n  * @since 19.1.0\n  */\n  logsFlushed(options: {\n    flushId: string;\n  }): Promise<void>;\n\n  /**\n  * Set env data props to ignore. The given env data keys (exact and case-sensitive, e.g. \"deviceName\" or \"currentUrl\")\n  * are removed before a ticket or conversation is sent. Each call replaces the previous list, an empty list resets it.\n  * Can be called before or after initialize.\n  *\n  * @since 18.1.0\n  */\n  setEnvDataPropsToIgnore(options: {\n    propsToIgnore: string[];\n  }): Promise<{\n    envDataPropsToIgnoreSet: 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  * Called on iOS and Android when the project config is loaded, with the network log settings the plugin's\n  * WebView log capture needs (network logs are only recorded when they are enabled for your project).\n  *\n  * @since 19.0.0\n  */\n  addListener(\n    eventName: 'logConfigLoaded',\n    listenerFunc: (config: GleapLogConfig) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n  * Called on iOS and Android right before the native SDK collects the logs for a capture request: the plugin's\n  * WebView log capture hands over what it buffers (it pushes at most every 500 ms otherwise) and answers with\n  * `logsFlushed`. The native SDK waits at most 500 ms for the answer. The plugin listens for you.\n  *\n  * @since 19.1.0\n  */\n  addListener(\n    eventName: 'flushLogs',\n    listenerFunc: (data: { flushId: string }) => 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 checklists\n  *\n  * @since 19.0.0\n  */\n  openChecklists(options: {\n    showBackButton?: boolean;\n  }): Promise<{\n    opened: boolean;\n  }>;\n\n  /**\n  * Open checklist\n  *\n  * @since 19.0.0\n  */\n  openChecklist(options: {\n    checklistId: string;\n    showBackButton?: boolean;\n  }): Promise<{\n    opened: boolean;\n  }>;\n\n  /**\n  * Start checklist\n  *\n  * @since 19.0.0\n  */\n  startChecklist(options: {\n    outboundId: string;\n    showBackButton?: boolean;\n  }): Promise<{\n    opened: 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 * Opens the conversations tab (same as openConversation).\n *\n * @since 19.0.0\n */\n  openConversations(options: {\n    showBackButton?: boolean;\n  }): Promise<{\n    conversationsOpened: boolean;\n  }>;\n\n  /**\n  * Open the conversation of a protected file from an emailed link.\n  * With \"Require authenticated file access\" enabled, email replies link attachments to your customer\n  * application URL with a `gleapFile` query parameter. If that URL opens your app (for example as a\n  * universal link / App Link), pass it here, e.g. from `App.addListener('appUrlOpen')` or\n  * `App.getLaunchUrl()` of `@capacitor/app`. `opened` is true when the URL carries a Gleap file reference.\n  * The conversation opens once the customer is identified with a user hash (`identify` with `userHash`);\n  * the link alone grants nothing. On web the JavaScript SDK handles `?gleapFile=` automatically on page load,\n  * so this resolves `{ opened: false }` there.\n  *\n  * @since 19.0.1\n  */\n  openProtectedFileFromUrl(options: {\n    url: string;\n  }): Promise<{\n    opened: 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  * Disable env data. While disabled (true), no env data (device, OS, screen size, locale, URL, ...) is collected\n  * and tickets are sent without it. Pass false to collect env data again. Can be called before or after initialize.\n  *\n  * @since 18.1.0\n  */\n  setDisableEnvData(options: {\n    disableEnvData: boolean;\n  }): Promise<{\n    envDataDisabled: boolean;\n  }>;\n\n  /**\n  * Set the color scheme of the widget. Overrides the color scheme configured in the Gleap dashboard.\n  * Only takes effect when \"Adapt to dark / light mode\" is enabled in the dashboard; otherwise the widget\n  * always keeps its normal colors. Before the first call the dashboard setting applies.\n  * \"auto\" follows the device appearance (dark/light mode) on iOS and Android, and the page theme on web.\n  * Apps with their own in-app theme toggle should pass \"light\" / \"dark\" explicitly and call it again whenever\n  * the theme changes.\n  * In dark mode the widget uses the dark mode colors, logo, header image and composer glow set in the Gleap dashboard;\n  * without dark colors it keeps its normal colors. lightBackgroundColor / darkBackgroundColor override the background.\n  * Can be called before or after initialize and applies live.\n  *\n  * @since 19.0.0\n  */\n  setColorScheme(options: {\n    colorScheme: 'auto' | 'light' | 'dark';\n    lightBackgroundColor?: string;\n    darkBackgroundColor?: string;\n  }): Promise<{\n    colorScheme: string;\n  }>;\n\n  /**\n  * Enable or disable screenshots and screen recordings for capture requests: when a workflow, an AI agent or a\n  * teammate asks the user in the widget to show the issue, the widget steps aside, a small bar lets the user go to\n  * the right screen, and the SDK captures the app once they tap Capture (or records it between Start and Stop).\n  * Nothing is captured without that tap. While disabled, the widget only offers to upload a file.\n  * Enabled by default. Works on iOS, Android and web and can be called before or after initialize.\n  *\n  * @since 19.1.0\n  */\n  setCaptureEnabled(options: {\n    enabled: boolean;\n  }): Promise<{\n    captureEnabled: boolean;\n  }>;\n\n  /**\n  * Enable or disable sending the app's logs for capture requests: a workflow or an AI agent can ask for the logs\n  * while the app runs (no user action), and screenshots and recordings can bring the logs around them. The logs are\n  * what a bug report carries (console and network logs, custom data, env data, custom events; the replay only when\n  * it is asked for and enabled in the dashboard), and the existing settings still apply (e.g. setDisableEnvData).\n  * While disabled, log requests are answered as not supported and captures are sent without logs.\n  * Enabled by default. Works on iOS, Android and web and can be called before or after initialize.\n  *\n  * @since 19.1.0\n  */\n  setRemoteLogCollectionEnabled(options: {\n    enabled: boolean;\n  }): Promise<{\n    remoteLogCollectionEnabled: 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: stops recording the console output of the app's WebView\n * (console methods are restored) and drops the WebView console logs recorded so far.\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/logs/webViewLogs.d.ts

@@ -8,7 +8,13 @@ export interface LogTarget {
     attachNetworkLogs(options: {
         logs: GleapNetworkLogEntry[];
     }): Promise<unknown>;
+    logsFlushed(options: {
+        flushId: string;
+    }): Promise<unknown>;
     addListener(eventName: 'logConfigLoaded', listenerFunc: (config: GleapLogConfig) => void): Promise<unknown>;
+    addListener(eventName: 'flushLogs', listenerFunc: (data: {
+        flushId: string;
+    }) => void): Promise<unknown>;
 }
 /**
  * Captures console output and fetch/XHR traffic inside the WebView of a native (iOS / Android) app
@@ -42,17 +48,27 @@ export declare class WebViewLogCapture {
      */
     private nativeLogsConsole;
     private listenForConfig;
+    /**
+     * Capture requests: right before the native SDK collects the logs for a request, it asks for what is still
+     * buffered here (pushed at most every PUSH_DELAY_MS otherwise) and waits up to 500 ms for the answer.
+     */
+    private listenForFlush;
+    private answerFlush;
     applyRemoteConfig(config: GleapLogConfig | null | undefined): void;
     setLocalPropsToIgnore(props: unknown): void;
     setLocalBlacklist(blacklist: unknown): void;
     /** disableConsoleLogOverwrite(): restore the console and drop what was recorded (also natively). */
     disableConsole(): void;
     onInitialize(): void;
-    /** Pushes pending changes now (before a plugin call that can produce a report). */
-    flushNow(): void;
+    /**
+     * Pushes pending changes now (before a plugin call that can produce a report, or when the native SDK collects the
+     * logs for a capture request). Resolves once the native side took them; never rejects.
+     */
+    flushNow(): Promise<void>;
     private updateRules;
     private canPush;
     private markDirty;
+    /** Resolves once the push it started (if any) was answered; never rejects. */
     private flushChannel;
     private onPushFailed;
     /** Redacted copies of the buffered entries; unchanged entries reuse their previous copy. */