capacitor-gleap-plugin 18.0.0 → 19.0.0

package/dist/esm/definitions.d.ts

@@ -5,6 +5,53 @@ export interface GleapEventMessage {
     data?: any;
 }
 export declare type GleapEventCallback = (message: GleapEventMessage | null, err?: any) => void;
+/**
+ * A console log entry as the plugin hands it to the native SDK.
+ */
+export interface GleapConsoleLogEntry {
+    /** ISO-8601 UTC timestamp with milliseconds. */
+    date: string;
+    priority: 'ERROR' | 'WARNING' | 'INFO';
+    log: string;
+}
+/**
+ * A network log entry (fetch / XMLHttpRequest) as the plugin hands it to the native SDK.
+ */
+export interface GleapNetworkLogEntry {
+    /** ISO-8601 UTC timestamp of the request start. */
+    date: string;
+    /** HTTP method, uppercase. */
+    type: string;
+    url: string;
+    /** Milliseconds from the request start to the response headers (or the failure). */
+    duration?: number;
+    /** true when an HTTP response arrived (any status), false on a transport error, abort or timeout. */
+    success?: boolean;
+    request?: {
+        headers?: {
+            [name: string]: string;
+        };
+        payload?: string;
+    };
+    response?: {
+        status?: number;
+        statusText?: string;
+        headers?: {
+            [name: string]: string;
+        };
+        responseText?: string;
+        /** Set instead of status and body when the request failed. */
+        errorText?: string;
+    };
+}
+/**
+ * The network log settings of your Gleap project, sent by the native SDK once its config is loaded.
+ */
+export interface GleapLogConfig {
+    enableNetworkLogs: boolean;
+    networkLogPropsToIgnore: string[];
+    networkLogBlacklist: string[];
+}
 export interface GleapPlugin {
     /**
     * Initialize Gleap with an API key
@@ -105,7 +152,7 @@ export interface GleapPlugin {
         sla?: number;
         plan?: string;
         value?: number;
-        customData?: Object;
+        customData?: Record<string, any>;
     }): Promise<{
         identify: boolean;
     }>;
@@ -124,7 +171,7 @@ export interface GleapPlugin {
         sla?: number;
         plan?: string;
         value?: number;
-        customData?: Object;
+        customData?: Record<string, any>;
     }): Promise<{
         identify: boolean;
     }>;
@@ -221,6 +268,43 @@ export interface GleapPlugin {
         propsToIgnoreSet: boolean;
     }>;
     /**
+    * Hands the network requests made inside the app's WebView (fetch and XMLHttpRequest) to the native SDK, so they
+    * show up in the network logs of tickets. The plugin calls this for you on iOS and Android; each call replaces
+    * the previously attached WebView network logs. No-op on web, where the JavaScript SDK records requests itself.
+    *
+    * @since 19.0.0
+    */
+    attachNetworkLogs(options: {
+        logs: GleapNetworkLogEntry[];
+    }): Promise<{
+        networkLogsAttached: boolean;
+    }>;
+    /**
+    * Hands the console output of the app's WebView (console.log/info/warn/error/debug, uncaught errors and
+    * unhandled promise rejections) to the native SDK, so it shows up in the console logs of tickets. The plugin
+    * calls this for you on iOS and Android; each call replaces the previously attached WebView console logs.
+    * No-op on web, where the JavaScript SDK records the console itself.
+    *
+    * @since 19.0.0
+    */
+    attachConsoleLogs(options: {
+        logs: GleapConsoleLogEntry[];
+    }): Promise<{
+        consoleLogsAttached: boolean;
+    }>;
+    /**
+    * Set env data props to ignore. The given env data keys (exact and case-sensitive, e.g. "deviceName" or "currentUrl")
+    * are removed before a ticket or conversation is sent. Each call replaces the previous list, an empty list resets it.
+    * Can be called before or after initialize.
+    *
+    * @since 18.1.0
+    */
+    setEnvDataPropsToIgnore(options: {
+        propsToIgnore: string[];
+    }): Promise<{
+        envDataPropsToIgnoreSet: boolean;
+    }>;
+    /**
     * Registers a Frontend tool defined on your AI agent in the Gleap dashboard.
     * Prefer the `registerAgentTool(name, handler)` helper exported by this
     * package — it wires the agentToolExecution event and result round-trip for
@@ -252,6 +336,13 @@ export interface GleapPlugin {
         params: any;
     }) => void): Promise<PluginListenerHandle>;
     /**
+    * Called on iOS and Android when the project config is loaded, with the network log settings the plugin's
+    * WebView log capture needs (network logs are only recorded when they are enabled for your project).
+    *
+    * @since 19.0.0
+    */
+    addListener(eventName: 'logConfigLoaded', listenerFunc: (config: GleapLogConfig) => void): Promise<PluginListenerHandle>;
+    /**
     * Sets the value of a ticket attribute
     *
     * @since 13.5.0
@@ -395,6 +486,38 @@ export interface GleapPlugin {
         openedWidget: boolean;
     }>;
     /**
+    * Open checklists
+    *
+    * @since 19.0.0
+    */
+    openChecklists(options: {
+        showBackButton?: boolean;
+    }): Promise<{
+        opened: boolean;
+    }>;
+    /**
+    * Open checklist
+    *
+    * @since 19.0.0
+    */
+    openChecklist(options: {
+        checklistId: string;
+        showBackButton?: boolean;
+    }): Promise<{
+        opened: boolean;
+    }>;
+    /**
+    * Start checklist
+    *
+    * @since 19.0.0
+    */
+    startChecklist(options: {
+        outboundId: string;
+        showBackButton?: boolean;
+    }): Promise<{
+        opened: boolean;
+    }>;
+    /**
     * Open news
     *
     * @since 8.4.0
@@ -538,6 +661,16 @@ export interface GleapPlugin {
         conversationsOpened: boolean;
     }>;
     /**
+   * Opens the conversations tab (same as openConversation).
+   *
+   * @since 19.0.0
+   */
+    openConversations(options: {
+        showBackButton?: boolean;
+    }): Promise<{
+        conversationsOpened: boolean;
+    }>;
+    /**
    * Start bot
    *
    * @since 10.0.3
@@ -569,6 +702,37 @@ export interface GleapPlugin {
         inAppNotificationsDisabled: boolean;
     }>;
     /**
+    * Disable env data. While disabled (true), no env data (device, OS, screen size, locale, URL, ...) is collected
+    * and tickets are sent without it. Pass false to collect env data again. Can be called before or after initialize.
+    *
+    * @since 18.1.0
+    */
+    setDisableEnvData(options: {
+        disableEnvData: boolean;
+    }): Promise<{
+        envDataDisabled: boolean;
+    }>;
+    /**
+    * Set the color scheme of the widget. Overrides the color scheme configured in the Gleap dashboard.
+    * Only takes effect when "Adapt to dark / light mode" is enabled in the dashboard; otherwise the widget
+    * always keeps its normal colors. Before the first call the dashboard setting applies.
+    * "auto" follows the device appearance (dark/light mode) on iOS and Android, and the page theme on web.
+    * Apps with their own in-app theme toggle should pass "light" / "dark" explicitly and call it again whenever
+    * the theme changes.
+    * In dark mode the widget uses the dark mode colors, logo, header image and composer glow set in the Gleap dashboard;
+    * without dark colors it keeps its normal colors. lightBackgroundColor / darkBackgroundColor override the background.
+    * Can be called before or after initialize and applies live.
+    *
+    * @since 19.0.0
+    */
+    setColorScheme(options: {
+        colorScheme: 'auto' | 'light' | 'dark';
+        lightBackgroundColor?: string;
+        darkBackgroundColor?: string;
+    }): Promise<{
+        colorScheme: string;
+    }>;
+    /**
    * Set Language
    *
    * @since 7.0.0
@@ -579,7 +743,8 @@ export interface GleapPlugin {
         setLanguage: string;
     }>;
     /**
-   * Disable console log overwrite
+   * Disable console log overwrite: stops recording the console output of the app's WebView
+   * (console methods are restored) and drops the WebView console logs recorded so far.
    *
    * @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 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}"]}
+{"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 * 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}"]}

package/dist/esm/index.js

@@ -1,7 +1,15 @@
 import { registerPlugin } from '@capacitor/core';
-const Gleap = registerPlugin('Gleap', {
+import { installWebViewLogCapture, wrapPluginWithLogCapture, } from './logs/webViewLogs';
+const GleapNative = registerPlugin('Gleap', {
     web: () => import('./web').then(m => new m.GleapWeb()),
 });
+// On iOS and Android, record the WebView's console from the moment the plugin is imported (and its
+// fetch/XHR traffic once the project config enables network logs), and hand both to the native SDK,
+// which cannot see either on its own.
+const webViewLogCapture = installWebViewLogCapture(GleapNative);
+const Gleap = webViewLogCapture
+    ? wrapPluginWithLogCapture(GleapNative, webViewLogCapture)
+    : GleapNative;
 const registeredAgentTools = {};
 let agentToolListenerAttached = false;
 /**

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAIjD,MAAM,KAAK,GAAG,cAAc,CAAc,OAAO,EAAE;IACjD,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC;CACvD,CAAC,CAAC;AAEH,MAAM,oBAAoB,GAEtB,EAAE,CAAC;AACP,IAAI,yBAAyB,GAAG,KAAK,CAAC;AAEtC;;;;;GAKG;AACH,MAAM,iBAAiB,GAAG,KAAK,EAC7B,IAAY,EACZ,OAA4C,EAC7B,EAAE;IACjB,IAAI,CAAC,IAAI,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE;QAC1C,OAAO;KACR;IAED,oBAAoB,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC;IAErC,IAAI,CAAC,yBAAyB,EAAE;QAC9B,yBAAyB,GAAG,IAAI,CAAC;QAEjC,MAAM,KAAK,CAAC,WAAW,CAAC,oBAAoB,EAAE,KAAK,EAAC,IAAI,EAAC,EAAE;;YACzD,IAAI;gBACF,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAK,EAAU,CAAC;gBACpE,IAAI,CAAC,WAAW,IAAI,CAAC,QAAQ,EAAE;oBAC7B,OAAO;iBACR;gBAED,IAAI,MAAM,CAAC;gBACX,MAAM,WAAW,GAAG,oBAAoB,CAAC,QAAQ,CAAC,CAAC;gBACnD,IAAI,CAAC,WAAW,EAAE;oBAChB,MAAM,GAAG,mCAAmC,QAAQ,2DAA2D,QAAQ,cAAc,CAAC;iBACvI;qBAAM;oBACL,IAAI;wBACF,MAAM,aAAa,GAAG,MAAM,WAAW,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC,CAAC;wBACtD,MAAM;4BACJ,OAAO,aAAa,KAAK,QAAQ;gCAC/B,CAAC,CAAC,aAAa;gCACf,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,aAAa,aAAb,aAAa,cAAb,aAAa,GAAI,EAAE,CAAC,CAAC;wBAC1C,IAAI,CAAC,MAAM,EAAE;4BACX,MAAM,GAAG,kDAAkD,CAAC;yBAC7D;qBACF;oBAAC,OAAO,KAAU,EAAE;wBACnB,MAAM,GAAG,0BACP,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO,mCAAI,eACpB,EAAE,CAAC;qBACJ;iBACF;gBAED,MAAM,KAAK,CAAC,mBAAmB,CAAC,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC,CAAC;aAC1D;YAAC,OAAO,GAAG,EAAE;gBACZ,UAAU;aACX;QACH,CAAC,CAAC,CAAC;KACJ;IAED,MAAM,KAAK,CAAC,iBAAiB,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;AAC1C,CAAC,CAAC;AAEF,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,KAAK,EAAE,iBAAiB,EAAE,CAAC","sourcesContent":["import { registerPlugin } from '@capacitor/core';\n\nimport type { GleapPlugin } from './definitions';\n\nconst Gleap = registerPlugin<GleapPlugin>('Gleap', {\n  web: () => import('./web').then(m => new m.GleapWeb()),\n});\n\nconst registeredAgentTools: {\n  [name: string]: (params: any) => any | Promise<any>;\n} = {};\nlet agentToolListenerAttached = false;\n\n/**\n * Registers the handler for a Frontend tool defined on your AI agent in the\n * Gleap dashboard. The agent calls the handler with the configured parameters\n * and waits for the returned result (string or object, which gets\n * stringified).\n */\nconst registerAgentTool = async (\n  name: string,\n  handler: (params: any) => any | Promise<any>,\n): Promise<void> => {\n  if (!name || typeof handler !== 'function') {\n    return;\n  }\n\n  registeredAgentTools[name] = handler;\n\n  if (!agentToolListenerAttached) {\n    agentToolListenerAttached = true;\n\n    await Gleap.addListener('agentToolExecution', async data => {\n      try {\n        const { executionId, name: toolName, params } = data ?? ({} as any);\n        if (!executionId || !toolName) {\n          return;\n        }\n\n        let result;\n        const toolHandler = registeredAgentTools[toolName];\n        if (!toolHandler) {\n          result = `No handler registered for tool '${toolName}' in the app. Register one via Gleap.registerAgentTool('${toolName}', handler).`;\n        } else {\n          try {\n            const handlerResult = await toolHandler(params ?? {});\n            result =\n              typeof handlerResult === 'string'\n                ? handlerResult\n                : JSON.stringify(handlerResult ?? '');\n            if (!result) {\n              result = 'The action completed without returning a result.';\n            }\n          } catch (error: any) {\n            result = `Tool execution failed: ${\n              error?.message ?? 'unknown error'\n            }`;\n          }\n        }\n\n        await Gleap.sendAgentToolResult({ executionId, result });\n      } catch (exp) {\n        // Ignore.\n      }\n    });\n  }\n\n  await Gleap.registerAgentTool({ name });\n};\n\nexport * from './definitions';\nexport { Gleap, registerAgentTool };\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAGjD,OAAO,EACL,wBAAwB,EACxB,wBAAwB,GACzB,MAAM,oBAAoB,CAAC;AAE5B,MAAM,WAAW,GAAG,cAAc,CAAc,OAAO,EAAE;IACvD,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC;CACvD,CAAC,CAAC;AAEH,mGAAmG;AACnG,oGAAoG;AACpG,sCAAsC;AACtC,MAAM,iBAAiB,GAAG,wBAAwB,CAAC,WAAW,CAAC,CAAC;AAEhE,MAAM,KAAK,GAAgB,iBAAiB;IAC1C,CAAC,CAAC,wBAAwB,CAAC,WAAW,EAAE,iBAAiB,CAAC;IAC1D,CAAC,CAAC,WAAW,CAAC;AAEhB,MAAM,oBAAoB,GAEtB,EAAE,CAAC;AACP,IAAI,yBAAyB,GAAG,KAAK,CAAC;AAEtC;;;;;GAKG;AACH,MAAM,iBAAiB,GAAG,KAAK,EAC7B,IAAY,EACZ,OAA4C,EAC7B,EAAE;IACjB,IAAI,CAAC,IAAI,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE;QAC1C,OAAO;KACR;IAED,oBAAoB,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC;IAErC,IAAI,CAAC,yBAAyB,EAAE;QAC9B,yBAAyB,GAAG,IAAI,CAAC;QAEjC,MAAM,KAAK,CAAC,WAAW,CAAC,oBAAoB,EAAE,KAAK,EAAC,IAAI,EAAC,EAAE;;YACzD,IAAI;gBACF,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAK,EAAU,CAAC;gBACpE,IAAI,CAAC,WAAW,IAAI,CAAC,QAAQ,EAAE;oBAC7B,OAAO;iBACR;gBAED,IAAI,MAAM,CAAC;gBACX,MAAM,WAAW,GAAG,oBAAoB,CAAC,QAAQ,CAAC,CAAC;gBACnD,IAAI,CAAC,WAAW,EAAE;oBAChB,MAAM,GAAG,mCAAmC,QAAQ,2DAA2D,QAAQ,cAAc,CAAC;iBACvI;qBAAM;oBACL,IAAI;wBACF,MAAM,aAAa,GAAG,MAAM,WAAW,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC,CAAC;wBACtD,MAAM;4BACJ,OAAO,aAAa,KAAK,QAAQ;gCAC/B,CAAC,CAAC,aAAa;gCACf,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,aAAa,aAAb,aAAa,cAAb,aAAa,GAAI,EAAE,CAAC,CAAC;wBAC1C,IAAI,CAAC,MAAM,EAAE;4BACX,MAAM,GAAG,kDAAkD,CAAC;yBAC7D;qBACF;oBAAC,OAAO,KAAU,EAAE;wBACnB,MAAM,GAAG,0BACP,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO,mCAAI,eACpB,EAAE,CAAC;qBACJ;iBACF;gBAED,MAAM,KAAK,CAAC,mBAAmB,CAAC,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC,CAAC;aAC1D;YAAC,OAAO,GAAG,EAAE;gBACZ,UAAU;aACX;QACH,CAAC,CAAC,CAAC;KACJ;IAED,MAAM,KAAK,CAAC,iBAAiB,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;AAC1C,CAAC,CAAC;AAEF,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,KAAK,EAAE,iBAAiB,EAAE,CAAC","sourcesContent":["import { registerPlugin } from '@capacitor/core';\n\nimport type { GleapPlugin } from './definitions';\nimport {\n  installWebViewLogCapture,\n  wrapPluginWithLogCapture,\n} from './logs/webViewLogs';\n\nconst GleapNative = registerPlugin<GleapPlugin>('Gleap', {\n  web: () => import('./web').then(m => new m.GleapWeb()),\n});\n\n// On iOS and Android, record the WebView's console from the moment the plugin is imported (and its\n// fetch/XHR traffic once the project config enables network logs), and hand both to the native SDK,\n// which cannot see either on its own.\nconst webViewLogCapture = installWebViewLogCapture(GleapNative);\n\nconst Gleap: GleapPlugin = webViewLogCapture\n  ? wrapPluginWithLogCapture(GleapNative, webViewLogCapture)\n  : GleapNative;\n\nconst registeredAgentTools: {\n  [name: string]: (params: any) => any | Promise<any>;\n} = {};\nlet agentToolListenerAttached = false;\n\n/**\n * Registers the handler for a Frontend tool defined on your AI agent in the\n * Gleap dashboard. The agent calls the handler with the configured parameters\n * and waits for the returned result (string or object, which gets\n * stringified).\n */\nconst registerAgentTool = async (\n  name: string,\n  handler: (params: any) => any | Promise<any>,\n): Promise<void> => {\n  if (!name || typeof handler !== 'function') {\n    return;\n  }\n\n  registeredAgentTools[name] = handler;\n\n  if (!agentToolListenerAttached) {\n    agentToolListenerAttached = true;\n\n    await Gleap.addListener('agentToolExecution', async data => {\n      try {\n        const { executionId, name: toolName, params } = data ?? ({} as any);\n        if (!executionId || !toolName) {\n          return;\n        }\n\n        let result;\n        const toolHandler = registeredAgentTools[toolName];\n        if (!toolHandler) {\n          result = `No handler registered for tool '${toolName}' in the app. Register one via Gleap.registerAgentTool('${toolName}', handler).`;\n        } else {\n          try {\n            const handlerResult = await toolHandler(params ?? {});\n            result =\n              typeof handlerResult === 'string'\n                ? handlerResult\n                : JSON.stringify(handlerResult ?? '');\n            if (!result) {\n              result = 'The action completed without returning a result.';\n            }\n          } catch (error: any) {\n            result = `Tool execution failed: ${\n              error?.message ?? 'unknown error'\n            }`;\n          }\n        }\n\n        await Gleap.sendAgentToolResult({ executionId, result });\n      } catch (exp) {\n        // Ignore.\n      }\n    });\n  }\n\n  await Gleap.registerAgentTool({ name });\n};\n\nexport * from './definitions';\nexport { Gleap, registerAgentTool };\n"]}

package/dist/esm/logs/body.d.ts

@@ -0,0 +1,58 @@
+/** Maximum captured size per body (request payload or response text). */
+export declare const MAX_BODY_SIZE = 150000;
+export declare const BINARY_BODY_OMITTED = "[binary body omitted]";
+export declare const STREAMING_BODY_OMITTED = "[streaming body omitted]";
+export declare const BODY_NOT_CAPTURED = "[body not captured]";
+export declare const BODY_PENDING = "[body pending]";
+/**
+ * text: capture; unknown (no content type): capture when it decodes as UTF-8;
+ * streaming / binary: never read, only a marker.
+ */
+export declare type BodyKind = 'text' | 'unknown' | 'streaming' | 'binary';
+export declare function classifyContentType(contentType: unknown): BodyKind;
+export declare function markerForKind(kind: BodyKind): string | null;
+/** UTF-8 byte length without allocating an encoded copy. */
+export declare function utf8ByteLength(text: string): number;
+/** Cuts a string at max chars without splitting a surrogate pair. */
+export declare function sliceHead(text: string, max: number): string;
+export declare function truncationMarker(totalBytes: number | null): string;
+/** Caps a text body at MAX_BODY_SIZE chars: keeps the head and appends the truncation marker. */
+export declare function capBodyText(text: string): string;
+/**
+ * Decodes bytes as UTF-8. With fatal (unknown content type) invalid UTF-8 yields null, so the caller
+ * can mark the body as binary. A cut-off (incomplete) body keeps a split trailing character pending
+ * instead of failing on it.
+ */
+export declare function decodeUtf8(bytes: Uint8Array, fatal: boolean, complete: boolean): string | null;
+/**
+ * Turns (at most MAX_BODY_SIZE) bytes into the logged text: decoded, capped, marked as truncated
+ * when the body was longer, or the binary marker when it is not UTF-8 text.
+ */
+export declare function bytesToBodyText(bytes: Uint8Array, kind: BodyKind, complete: boolean, totalBytes: number | null): string;
+/**
+ * Reads at most MAX_BODY_SIZE bytes (plus the rest of the chunk that crossed it) and cancels the
+ * stream after that, so an endless or huge body is never read into memory.
+ */
+export declare function readStreamHead(stream: ReadableStream<Uint8Array>): Promise<{
+    bytes: Uint8Array;
+    complete: boolean;
+}>;
+/** Reads the head of a blob (never the whole blob) and turns it into the logged text. */
+export declare function readBlobHead(blob: Blob, kind: BodyKind): Promise<string>;
+export declare function isBlob(value: unknown): value is Blob;
+export declare function isFormData(value: unknown): boolean;
+export declare function isUrlSearchParams(value: unknown): value is URLSearchParams;
+export declare function isReadableStream(value: unknown): boolean;
+export declare function isDocument(value: unknown): boolean;
+/** Byte view of an ArrayBuffer or ArrayBufferView, or null for anything else. */
+export declare function toBytes(value: unknown): Uint8Array | null;
+/**
+ * The logged request payload for a fetch/XHR body. Strings and buffers are captured synchronously;
+ * blobs are read asynchronously (head only). Form data, streams and documents are not captured.
+ */
+export declare function captureRequestBody(body: unknown, kind: BodyKind): string | Promise<string>;
+/**
+ * JSON.stringify for a parsed JSON value (XHR responseType "json") that stops once the output
+ * exceeds MAX_BODY_SIZE, so a huge response is not serialised in full.
+ */
+export declare function stringifyJsonHead(value: unknown): string;