@capgo/capacitor-inappbrowser 8.6.34 → 8.7.0

package/dist/docs.json

@@ -118,6 +118,21 @@
         "complexTypes": [],
         "slug": "clearcache"
       },
+      {
+        "name": "clearAllBrowsingData",
+        "signature": "() => Promise<any>",
+        "parameters": [],
+        "returns": "Promise<any>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "8.6.36"
+          }
+        ],
+        "docs": "Clear all browsing data from the default store and any opened managed webviews.\n\nThis removes cookies, disk cache, memory cache, local storage, session storage, IndexedDB,\nWebSQL where supported, form data, and HTTP auth data where the platform exposes it.",
+        "complexTypes": [],
+        "slug": "clearallbrowsingdata"
+      },
       {
         "name": "getCookies",
         "signature": "(options: GetCookieOptions) => Promise<Record<string, string>>",
@@ -206,6 +221,58 @@
         "complexTypes": [],
         "slug": "show"
       },
+      {
+        "name": "sendToBack",
+        "signature": "(options?: LayerOptions | undefined) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "LayerOptions | undefined"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Moves the native browser behind the Capacitor host WebView.\nUse `dispatchInputEvent()` to forward overlay gestures to the browser while it is behind the app UI.",
+        "complexTypes": [
+          "LayerOptions"
+        ],
+        "slug": "sendtoback"
+      },
+      {
+        "name": "bringToFront",
+        "signature": "(options?: { id?: string | undefined; } | undefined) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ id?: string | undefined; } | undefined"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Moves a browser that was behind the host WebView back to the front.\nWhen `id` is omitted, targets the active webview.",
+        "complexTypes": [],
+        "slug": "bringtofront"
+      },
+      {
+        "name": "dispatchInputEvent",
+        "signature": "(options: DispatchInputEventOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "DispatchInputEventOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Dispatches a click, touch, or scroll event to a managed browser.\nCoordinates are relative to the browser viewport in CSS pixels.",
+        "complexTypes": [
+          "DispatchInputEventOptions"
+        ],
+        "slug": "dispatchinputevent"
+      },
       {
         "name": "openWebView",
         "signature": "(options: OpenWebViewOptions) => Promise<{ id: string; }>",
@@ -346,8 +413,13 @@
           }
         ],
         "returns": "Promise<PluginListenerHandle>",
-        "tags": [],
-        "docs": "",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Listen for buttonNearDone clicks.\n\nThe event payload contains the webview `id`.",
         "complexTypes": [
           "PluginListenerHandle",
           "ButtonNearListener"
@@ -1084,6 +1156,124 @@
         }
       ]
     },
+    {
+      "name": "LayerOptions",
+      "slug": "layeroptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "id",
+          "tags": [],
+          "docs": "Target webview id. If omitted, targets the active webview.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "transparentBackground",
+          "tags": [
+            {
+              "text": "true",
+              "name": "default"
+            }
+          ],
+          "docs": "Makes the Capacitor host WebView transparent while this native webview is behind it.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        }
+      ]
+    },
+    {
+      "name": "DispatchPointerInputEventOptions",
+      "slug": "dispatchpointerinputeventoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "id",
+          "tags": [],
+          "docs": "Target webview id. If omitted, targets the active webview.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "type",
+          "tags": [],
+          "docs": "Input event to dispatch to the webview.",
+          "complexTypes": [
+            "WebViewPointerInputEventType"
+          ],
+          "type": "WebViewPointerInputEventType"
+        },
+        {
+          "name": "x",
+          "tags": [],
+          "docs": "X coordinate in CSS pixels from the webview's left edge.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "y",
+          "tags": [],
+          "docs": "Y coordinate in CSS pixels from the webview's top edge.",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    },
+    {
+      "name": "DispatchScrollInputEventOptions",
+      "slug": "dispatchscrollinputeventoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "id",
+          "tags": [],
+          "docs": "Target webview id. If omitted, targets the active webview.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "type",
+          "tags": [],
+          "docs": "Input event to dispatch to the webview.",
+          "complexTypes": [],
+          "type": "'scroll'"
+        },
+        {
+          "name": "x",
+          "tags": [],
+          "docs": "X coordinate in CSS pixels from the webview's left edge.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "y",
+          "tags": [],
+          "docs": "Y coordinate in CSS pixels from the webview's top edge.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "deltaX",
+          "tags": [],
+          "docs": "Horizontal scroll delta in CSS pixels. Used when `type` is `scroll`.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "deltaY",
+          "tags": [],
+          "docs": "Vertical scroll delta in CSS pixels. Used when `type` is `scroll`.",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    },
     {
       "name": "OpenWebViewOptions",
       "slug": "openwebviewoptions",
@@ -1247,6 +1437,22 @@
           "complexTypes": [],
           "type": "boolean | undefined"
         },
+        {
+          "name": "persistWebViewData",
+          "tags": [
+            {
+              "text": "true",
+              "name": "default"
+            },
+            {
+              "text": "8.6.36",
+              "name": "since"
+            }
+          ],
+          "docs": "Controls whether the webview should persist website data such as cache, cookies, local storage,\nIndexedDB, and session data.\n\nWhen false, iOS uses a non-persistent `WKWebsiteDataStore`. Android disables per-view cache and\nDOM/database storage where the system WebView supports it. Android cookies use the shared\nWebView cookie store, so call `clearAllBrowsingData()` to remove cookies and other global data.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
         {
           "name": "handleDownloads",
           "tags": [
@@ -2033,6 +2239,30 @@
           "complexTypes": [],
           "type": "number | undefined"
         },
+        {
+          "name": "toBack",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            }
+          ],
+          "docs": "Places the native browser behind the Capacitor host WebView.\nMake the app background transparent to reveal it, or rely on `transparentBackground` to clear the host WebView.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "transparentBackground",
+          "tags": [
+            {
+              "text": "true",
+              "name": "default"
+            }
+          ],
+          "docs": "When `toBack` is true, makes the Capacitor host WebView transparent so the native browser can be seen behind Ionic content.\nIgnored when the browser is in front.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
         {
           "name": "disableOverscroll",
           "tags": [
@@ -2360,6 +2590,27 @@
         }
       ]
     },
+    {
+      "name": "ButtonNearDoneEvent",
+      "slug": "buttonneardoneevent",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "id",
+          "tags": [
+            {
+              "text": "8.6.36",
+              "name": "since"
+            }
+          ],
+          "docs": "Webview instance id.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
     {
       "name": "BtnEvent",
       "slug": "btnevent",
@@ -3126,6 +3377,52 @@
         }
       ]
     },
+    {
+      "name": "DispatchInputEventOptions",
+      "slug": "dispatchinputeventoptions",
+      "docs": "",
+      "types": [
+        {
+          "text": "DispatchPointerInputEventOptions",
+          "complexTypes": [
+            "DispatchPointerInputEventOptions"
+          ]
+        },
+        {
+          "text": "DispatchScrollInputEventOptions",
+          "complexTypes": [
+            "DispatchScrollInputEventOptions"
+          ]
+        }
+      ]
+    },
+    {
+      "name": "WebViewPointerInputEventType",
+      "slug": "webviewpointerinputeventtype",
+      "docs": "",
+      "types": [
+        {
+          "text": "'click'",
+          "complexTypes": []
+        },
+        {
+          "text": "'touchstart'",
+          "complexTypes": []
+        },
+        {
+          "text": "'touchmove'",
+          "complexTypes": []
+        },
+        {
+          "text": "'touchend'",
+          "complexTypes": []
+        },
+        {
+          "text": "'touchcancel'",
+          "complexTypes": []
+        }
+      ]
+    },
     {
       "name": "UrlChangeListener",
       "slug": "urlchangelistener",
@@ -3145,8 +3442,10 @@
       "docs": "",
       "types": [
         {
-          "text": "(state: object): void",
-          "complexTypes": []
+          "text": "(state: ButtonNearDoneEvent): void",
+          "complexTypes": [
+            "ButtonNearDoneEvent"
+          ]
         }
       ]
     },

package/dist/esm/definitions.d.ts

@@ -45,10 +45,20 @@ export interface BtnEvent {
      */
     url: string;
 }
+export interface ButtonNearDoneEvent {
+    /**
+     * Webview instance id.
+     *
+     * @since 8.6.36
+     */
+    id: string;
+}
 export type UrlChangeListener = (state: UrlEvent) => void;
 export type ConfirmBtnListener = (state: BtnEvent) => void;
-export type ButtonNearListener = (state: object) => void;
+export type ButtonNearListener = (state: ButtonNearDoneEvent) => void;
 export type CustomSchemeInterceptedListener = (state: CustomSchemeInterceptedEvent) => void;
+export type WebViewPointerInputEventType = 'click' | 'touchstart' | 'touchmove' | 'touchend' | 'touchcancel';
+export type WebViewInputEventType = WebViewPointerInputEventType | 'scroll';
 export declare enum BackgroundColor {
     WHITE = "white",
     BLACK = "black"
@@ -104,6 +114,63 @@ export interface Credentials {
     username: string;
     password: string;
 }
+export interface LayerOptions {
+    /**
+     * Target webview id. If omitted, targets the active webview.
+     */
+    id?: string;
+    /**
+     * Makes the Capacitor host WebView transparent while this native webview is behind it.
+     *
+     * @default true
+     */
+    transparentBackground?: boolean;
+}
+export interface DispatchPointerInputEventOptions {
+    /**
+     * Target webview id. If omitted, targets the active webview.
+     */
+    id?: string;
+    /**
+     * Input event to dispatch to the webview.
+     */
+    type: WebViewPointerInputEventType;
+    /**
+     * X coordinate in CSS pixels from the webview's left edge.
+     */
+    x: number;
+    /**
+     * Y coordinate in CSS pixels from the webview's top edge.
+     */
+    y: number;
+}
+export interface DispatchScrollInputEventOptions {
+    /**
+     * Target webview id. If omitted, targets the active webview.
+     */
+    id?: string;
+    /**
+     * Input event to dispatch to the webview.
+     */
+    type: 'scroll';
+    /**
+     * X coordinate in CSS pixels from the webview's left edge.
+     */
+    x: number;
+    /**
+     * Y coordinate in CSS pixels from the webview's top edge.
+     */
+    y: number;
+    /**
+     * Horizontal scroll delta in CSS pixels. Used when `type` is `scroll`.
+     */
+    deltaX: number;
+    /**
+     * Vertical scroll delta in CSS pixels. Used when `type` is `scroll`.
+     */
+    deltaY: number;
+}
+export type DispatchInputEventOptions = DispatchPointerInputEventOptions | DispatchScrollInputEventOptions;
 /**
  * Represents an intercepted HTTP request from the in-app browser webview.
  *
@@ -585,6 +652,18 @@ export interface OpenWebViewOptions {
      * @since 8.6.0
      */
     captureConsoleLogs?: boolean;
+    /**
+     * Controls whether the webview should persist website data such as cache, cookies, local storage,
+     * IndexedDB, and session data.
+     *
+     * When false, iOS uses a non-persistent `WKWebsiteDataStore`. Android disables per-view cache and
+     * DOM/database storage where the system WebView supports it. Android cookies use the shared
+     * WebView cookie store, so call `clearAllBrowsingData()` to remove cookies and other global data.
+     *
+     * @default true
+     * @since 8.6.36
+     */
+    persistWebViewData?: boolean;
     /**
      * Automatically handles downloads triggered inside the webview without requiring a custom JavaScript bridge.
      *
@@ -1048,6 +1127,20 @@ export interface OpenWebViewOptions {
      * y: 100
      */
     y?: number;
+    /**
+     * Places the native browser behind the Capacitor host WebView.
+     * Make the app background transparent to reveal it, or rely on `transparentBackground` to clear the host WebView.
+     *
+     * @default false
+     */
+    toBack?: boolean;
+    /**
+     * When `toBack` is true, makes the Capacitor host WebView transparent so the native browser can be seen behind Ionic content.
+     * Ignored when the browser is in front.
+     *
+     * @default true
+     */
+    transparentBackground?: boolean;
     /**
      * Disables the bounce (overscroll) effect on iOS WebView.
      * When enabled, prevents the rubber band scrolling effect when users scroll beyond content boundaries.
@@ -1148,6 +1241,15 @@ export interface InAppBrowserPlugin {
     clearCache(options?: {
         id?: string;
     }): Promise<any>;
+    /**
+     * Clear all browsing data from the default store and any opened managed webviews.
+     *
+     * This removes cookies, disk cache, memory cache, local storage, session storage, IndexedDB,
+     * WebSQL where supported, form data, and HTTP auth data where the platform exposes it.
+     *
+     * @since 8.6.36
+     */
+    clearAllBrowsingData(): Promise<any>;
     /**
      * Get cookies for a specific URL.
      * @param options The options, including the URL to get cookies for.
@@ -1178,6 +1280,23 @@ export interface InAppBrowserPlugin {
     show(options?: {
         id?: string;
     }): Promise<void>;
+    /**
+     * Moves the native browser behind the Capacitor host WebView.
+     * Use `dispatchInputEvent()` to forward overlay gestures to the browser while it is behind the app UI.
+     */
+    sendToBack(options?: LayerOptions): Promise<void>;
+    /**
+     * Moves a browser that was behind the host WebView back to the front.
+     * When `id` is omitted, targets the active webview.
+     */
+    bringToFront(options?: {
+        id?: string;
+    }): Promise<void>;
+    /**
+     * Dispatches a click, touch, or scroll event to a managed browser.
+     * Coordinates are relative to the browser viewport in CSS pixels.
+     */
+    dispatchInputEvent(options: DispatchInputEventOptions): Promise<void>;
     /**
      * Open url in a new webview with toolbars, and enhanced capabilities, like camera access, file access, listen events, inject javascript, bi directional communication, etc.
      *
@@ -1235,6 +1354,13 @@ export interface InAppBrowserPlugin {
      * @since 0.0.1
      */
     addListener(eventName: 'urlChangeEvent', listenerFunc: UrlChangeListener): Promise<PluginListenerHandle>;
+    /**
+     * Listen for buttonNearDone clicks.
+     *
+     * The event payload contains the webview `id`.
+     *
+     * @since 0.0.1
+     */
     addListener(eventName: 'buttonNearDoneClick', listenerFunc: ButtonNearListener): Promise<PluginListenerHandle>;
     /**
      * Listen for close click only for openWebView