@capgo/inappbrowser 7.6.3 → 7.6.4

package/README.md

@@ -75,7 +75,7 @@ With this plugin you can send events from the main app to the inappbrowser and v
 
 > The data is sent as a JSON object, so no functions or other non-JSON-serializable types are allowed.
 
-#### Main app to inappbrowser
+#### Main app to inappbrowser, detail object is mendatory
 
 ```js
 InAppBrowser.postMessage({ detail: { message: "myMessage" } });
@@ -89,7 +89,7 @@ window.addEventListener("messageFromNative", (event) => {
 });
 ```
 
-#### Send event from inappbrowser to main app
+#### Send event from inappbrowser to main app, detail object is mendatory
 
 ```js
 window.mobileApp.postMessage({ detail: { message: "myMessage" } });
@@ -250,7 +250,7 @@ Open url in a new webview with toolbars, and enhanced capabilities, like camera
 JavaScript Interface:
 When you open a webview with this method, a JavaScript interface is automatically injected that provides:
 - `window.mobileApp.close()`: Closes the webview from JavaScript
-- `window.mobileApp.postMessage(obj)`: Sends a message from the webview to the app
+- `window.mobileApp.postMessage({detail: {message: 'myMessage'}})`: Sends a message from the webview to the app, detail object is the data you want to send to the webview
 
 | Param         | Type                                                              |
 | ------------- | ----------------------------------------------------------------- |

package/dist/docs.json

@@ -136,7 +136,7 @@
             "text": "0.1.0"
           }
         ],
-        "docs": "Open url in a new webview with toolbars, and enhanced capabilities, like camera access, file access, listen events, inject javascript, bi directional communication, etc.\n\nJavaScript Interface:\nWhen you open a webview with this method, a JavaScript interface is automatically injected that provides:\n- `window.mobileApp.close()`: Closes the webview from JavaScript\n- `window.mobileApp.postMessage(obj)`: Sends a message from the webview to the app",
+        "docs": "Open url in a new webview with toolbars, and enhanced capabilities, like camera access, file access, listen events, inject javascript, bi directional communication, etc.\n\nJavaScript Interface:\nWhen you open a webview with this method, a JavaScript interface is automatically injected that provides:\n- `window.mobileApp.close()`: Closes the webview from JavaScript\n- `window.mobileApp.postMessage({detail: {message: 'myMessage'}})`: Sends a message from the webview to the app, detail object is the data you want to send to the webview",
         "complexTypes": [
           "OpenWebViewOptions"
         ],

package/dist/esm/definitions.d.ts

@@ -446,7 +446,7 @@ export interface InAppBrowserPlugin {
      * JavaScript Interface:
      * When you open a webview with this method, a JavaScript interface is automatically injected that provides:
      * - `window.mobileApp.close()`: Closes the webview from JavaScript
-     * - `window.mobileApp.postMessage(obj)`: Sends a message from the webview to the app
+     * - `window.mobileApp.postMessage({detail: {message: 'myMessage'}})`: Sends a message from the webview to the app, detail object is the data you want to send to the webview
      *
      * @since 0.1.0
      */

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAuBA,MAAM,CAAN,IAAY,eAGX;AAHD,WAAY,eAAe;IACzB,kCAAe,CAAA;IACf,kCAAe,CAAA;AACjB,CAAC,EAHW,eAAe,KAAf,eAAe,QAG1B;AACD,MAAM,CAAN,IAAY,WAgBX;AAhBD,WAAY,WAAW;IACrB;;;OAGG;IACH,oCAAqB,CAAA;IACrB;;;OAGG;IACH,wCAAyB,CAAA;IACzB;;;OAGG;IACH,8BAAe,CAAA;AACjB,CAAC,EAhBW,WAAW,KAAX,WAAW,QAgBtB","sourcesContent":["import type { PluginListenerHandle } from \"@capacitor/core\";\n\nexport interface UrlEvent {\n  /**\n   * Emit when the url changes\n   *\n   * @since 0.0.1\n   */\n  url: string;\n}\nexport interface BtnEvent {\n  /**\n   * Emit when a button is clicked.\n   *\n   * @since 0.0.1\n   */\n  url: string;\n}\n\nexport type UrlChangeListener = (state: UrlEvent) => void;\nexport type ConfirmBtnListener = (state: BtnEvent) => void;\nexport type ButtonNearListener = (state: object) => void;\n\nexport enum BackgroundColor {\n  WHITE = \"white\",\n  BLACK = \"black\",\n}\nexport enum ToolBarType {\n  /**\n   * Shows a simple toolbar with just a close button and share button\n   * @since 0.1.0\n   */\n  ACTIVITY = \"activity\",\n  /**\n   * Shows a full navigation toolbar with back/forward buttons\n   * @since 0.1.0\n   */\n  NAVIGATION = \"navigation\",\n  /**\n   * Shows no toolbar\n   * @since 0.1.0\n   */\n  BLANK = \"blank\",\n}\n\nexport interface Headers {\n  [key: string]: string;\n}\n\nexport interface GetCookieOptions {\n  url: string;\n  includeHttpOnly?: boolean;\n}\n\nexport interface ClearCookieOptions {\n  url: string;\n}\n\nexport interface Credentials {\n  username: string;\n  password: string;\n}\n\nexport interface OpenOptions {\n  /**\n   * Target URL to load.\n   * @since 0.1.0\n   */\n  url: string;\n  /**\n   * Headers to send with the request.\n   * @since 0.1.0\n   */\n  headers?: Headers;\n  /**\n   * Credentials to send with the request and all subsequent requests for the same host.\n   * @since 6.1.0\n   */\n  credentials?: Credentials;\n  /**\n   * if true, the browser will be presented after the page is loaded, if false, the browser will be presented immediately.\n   * @since 0.1.0\n   */\n  isPresentAfterPageLoad?: boolean;\n  /**\n   * if true the deeplink will not be opened, if false the deeplink will be opened when clicked on the link\n   * @since 0.1.0\n   */\n  preventDeeplink?: boolean;\n}\n\nexport interface DisclaimerOptions {\n  /**\n   * Title of the disclaimer dialog\n   * @default \"Title\"\n   */\n  title: string;\n  /**\n   * Message shown in the disclaimer dialog\n   * @default \"Message\"\n   */\n  message: string;\n  /**\n   * Text for the confirm button\n   * @default \"Confirm\"\n   */\n  confirmBtn: string;\n  /**\n   * Text for the cancel button\n   * @default \"Cancel\"\n   */\n  cancelBtn: string;\n}\n\nexport interface OpenWebViewOptions {\n  /**\n   * Target URL to load.\n   * @since 0.1.0\n   * @example \"https://capgo.app\"\n   */\n  url: string;\n  /**\n   * Headers to send with the request.\n   * @since 0.1.0\n   * @example\n   * headers: {\n   *   'Custom-Header': 'test-value',\n   *   'Authorization': 'Bearer test-token'\n   * }\n   * Test URL: https://www.whatismybrowser.com/detect/what-http-headers-is-my-browser-sending/\n   */\n  headers?: Headers;\n  /**\n   * Credentials to send with the request and all subsequent requests for the same host.\n   * @since 6.1.0\n   * @example\n   * credentials: {\n   *   username: 'test-user',\n   *   password: 'test-pass'\n   * }\n   * Test URL: https://www.whatismybrowser.com/detect/what-http-headers-is-my-browser-sending/\n   */\n  credentials?: Credentials;\n  /**\n   * materialPicker: if true, uses Material Design theme for date and time pickers on Android.\n   * This improves the appearance of HTML date inputs to use modern Material Design UI instead of the old style pickers.\n   * @since 7.4.1\n   * @default false\n   * @example\n   * materialPicker: true\n   * Test URL: https://show-picker.glitch.me/demo.html\n   */\n  materialPicker?: boolean;\n  /**\n   * JavaScript Interface:\n   * The webview automatically injects a JavaScript interface providing:\n   * - `window.mobileApp.close()`: Closes the webview from JavaScript\n   * - `window.mobileApp.postMessage(obj)`: Sends a message to the app (listen via \"messageFromWebview\" event)\n   *\n   * @example\n   * // In your webpage loaded in the webview:\n   * document.getElementById('closeBtn').addEventListener('click', () => {\n   *   window.mobileApp.close();\n   * });\n   *\n   * // Send data to the app\n   * window.mobileApp.postMessage({ action: 'login', data: { user: 'test' }});\n   *\n   * @since 6.10.0\n   */\n  jsInterface?: never; // This property doesn't exist, it's just for documentation\n  /**\n   * Share options for the webview. When provided, shows a disclaimer dialog before sharing content.\n   * This is useful for:\n   * - Warning users about sharing sensitive information\n   * - Getting user consent before sharing\n   * - Explaining what will be shared\n   * - Complying with privacy regulations\n   *\n   * Note: shareSubject is required when using shareDisclaimer\n   * @since 0.1.0\n   * @example\n   * shareDisclaimer: {\n   *   title: 'Disclaimer',\n   *   message: 'This is a test disclaimer',\n   *   confirmBtn: 'Accept',\n   *   cancelBtn: 'Decline'\n   * }\n   * Test URL: https://capgo.app\n   */\n  shareDisclaimer?: DisclaimerOptions;\n  /**\n   * Toolbar type determines the appearance and behavior of the browser's toolbar\n   * - \"activity\": Shows a simple toolbar with just a close button and share button\n   * - \"navigation\": Shows a full navigation toolbar with back/forward buttons\n   * - \"blank\": Shows no toolbar\n   * - \"\": Default toolbar with close button\n   * @since 0.1.0\n   * @default ToolBarType.DEFAULT\n   * @example\n   * toolbarType: ToolBarType.ACTIVITY,\n   * title: 'Activity Toolbar Test'\n   * Test URL: https://capgo.app\n   */\n  toolbarType?: ToolBarType;\n  /**\n   * Subject text for sharing. Required when using shareDisclaimer.\n   * This text will be used as the subject line when sharing content.\n   * @since 0.1.0\n   * @example \"Share this page\"\n   */\n  shareSubject?: string;\n  /**\n   * Title of the browser\n   * @since 0.1.0\n   * @default 'New Window'\n   * @example \"Camera Test\"\n   */\n  title?: string;\n  /**\n   * Background color of the browser\n   * @since 0.1.0\n   * @default BackgroundColor.BLACK\n   */\n  backgroundColor?: BackgroundColor;\n  /**\n   * If true, active the native navigation within the webview, Android only\n   * @default false\n   * @example\n   * activeNativeNavigationForWebview: true,\n   * disableGoBackOnNativeApplication: true\n   * Test URL: https://capgo.app\n   */\n  activeNativeNavigationForWebview?: boolean;\n  /**\n   * Disable the possibility to go back on native application,\n   * useful to force user to stay on the webview, Android only\n   * @default false\n   * @example\n   * disableGoBackOnNativeApplication: true\n   * Test URL: https://capgo.app\n   */\n  disableGoBackOnNativeApplication?: boolean;\n  /**\n   * Open url in a new window fullscreen\n   * isPresentAfterPageLoad: if true, the browser will be presented after the page is loaded, if false, the browser will be presented immediately.\n   * @since 0.1.0\n   * @default false\n   * @example\n   * isPresentAfterPageLoad: true,\n   * preShowScript: \"await import('https://unpkg.com/darkreader@4.9.89/darkreader.js');\\nDarkReader.enable({ brightness: 100, contrast: 90, sepia: 10 });\"\n   * Test URL: https://capgo.app\n   */\n  isPresentAfterPageLoad?: boolean;\n  /**\n   * Whether the website in the webview is inspectable or not, ios only\n   * @default false\n   */\n  isInspectable?: boolean;\n  /**\n   * Whether the webview opening is animated or not, ios only\n   * @default true\n   */\n  isAnimated?: boolean;\n  /**\n   * Shows a reload button that reloads the web page\n   * @since 1.0.15\n   * @default false\n   * @example\n   * showReloadButton: true\n   * Test URL: https://capgo.app\n   */\n  showReloadButton?: boolean;\n  /**\n   * CloseModal: if true a confirm will be displayed when user clicks on close button, if false the browser will be closed immediately.\n   * @since 1.1.0\n   * @default false\n   * @example\n   * closeModal: true,\n   * closeModalTitle: 'Close Window',\n   * closeModalDescription: 'Are you sure you want to close?',\n   * closeModalOk: 'Yes, close',\n   * closeModalCancel: 'No, stay'\n   * Test URL: https://capgo.app\n   */\n  closeModal?: boolean;\n  /**\n   * CloseModalTitle: title of the confirm when user clicks on close button\n   * @since 1.1.0\n   * @default 'Close'\n   */\n  closeModalTitle?: string;\n  /**\n   * CloseModalDescription: description of the confirm when user clicks on close button\n   * @since 1.1.0\n   * @default 'Are you sure you want to close this window?'\n   */\n  closeModalDescription?: string;\n  /**\n   * CloseModalOk: text of the confirm button when user clicks on close button\n   * @since 1.1.0\n   * @default 'Close'\n   */\n  closeModalOk?: string;\n  /**\n   * CloseModalCancel: text of the cancel button when user clicks on close button\n   * @since 1.1.0\n   * @default 'Cancel'\n   */\n  closeModalCancel?: string;\n  /**\n   * visibleTitle: if true the website title would be shown else shown empty\n   * @since 1.2.5\n   * @default true\n   */\n  visibleTitle?: boolean;\n  /**\n   * toolbarColor: color of the toolbar in hex format\n   * @since 1.2.5\n   * @default '#ffffff'\n   * @example\n   * toolbarColor: '#FF5733'\n   * Test URL: https://capgo.app\n   */\n  toolbarColor?: string;\n  /**\n   * toolbarTextColor: color of the buttons and title in the toolbar in hex format\n   * When set, it overrides the automatic light/dark mode detection for text color\n   * @since 6.10.0\n   * @default calculated based on toolbarColor brightness\n   * @example\n   * toolbarTextColor: '#FFFFFF'\n   * Test URL: https://capgo.app\n   */\n  toolbarTextColor?: string;\n  /**\n   * showArrow: if true an arrow would be shown instead of cross for closing the window\n   * @since 1.2.5\n   * @default false\n   * @example\n   * showArrow: true\n   * Test URL: https://capgo.app\n   */\n  showArrow?: boolean;\n  /**\n   * ignoreUntrustedSSLError: if true, the webview will ignore untrusted SSL errors allowing the user to view the website.\n   * @since 6.1.0\n   * @default false\n   */\n  ignoreUntrustedSSLError?: boolean;\n  /**\n   * preShowScript: if isPresentAfterPageLoad is true and this variable is set the plugin will inject a script before showing the browser.\n   * This script will be run in an async context. The plugin will wait for the script to finish (max 10 seconds)\n   * @since 6.6.0\n   * @example\n   * preShowScript: \"await import('https://unpkg.com/darkreader@4.9.89/darkreader.js');\\nDarkReader.enable({ brightness: 100, contrast: 90, sepia: 10 });\"\n   * Test URL: https://capgo.app\n   */\n  preShowScript?: string;\n  /**\n   * proxyRequests is a regex expression. Please see [this pr](https://github.com/Cap-go/capacitor-inappbrowser/pull/222) for more info. (Android only)\n   * @since 6.9.0\n   */\n  proxyRequests?: string;\n  /**\n   * buttonNearDone allows for a creation of a custom button near the done/close button.\n   * The button is only shown when toolbarType is not \"activity\", \"navigation\", or \"blank\".\n   *\n   * For Android:\n   * - iconType must be \"asset\"\n   * - icon path should be in the public folder (e.g. \"monkey.svg\")\n   * - width and height are optional, defaults to 48dp\n   * - button is positioned at the end of toolbar with 8dp margin\n   *\n   * For iOS:\n   * - iconType can be \"sf-symbol\" or \"asset\"\n   * - for sf-symbol, icon should be the symbol name\n   * - for asset, icon should be the asset name\n   * @since 6.7.0\n   * @example\n   * buttonNearDone: {\n   *   ios: {\n   *     iconType: 'sf-symbol',\n   *     icon: 'star.fill'\n   *   },\n   *   android: {\n   *     iconType: 'asset',\n   *     icon: 'public/monkey.svg',\n   *     width: 24,\n   *     height: 24\n   *   }\n   * }\n   * Test URL: https://capgo.app\n   */\n  buttonNearDone?: {\n    ios: {\n      iconType: \"sf-symbol\" | \"asset\";\n      icon: string;\n    };\n    android: {\n      iconType: \"asset\" | \"vector\";\n      icon: string;\n      width?: number;\n      height?: number;\n    };\n  };\n  /**\n   * textZoom: sets the text zoom of the page in percent.\n   * Allows users to increase or decrease the text size for better readability.\n   * @since 7.6.0\n   * @default 100\n   * @example\n   * textZoom: 120\n   * Test URL: https://capgo.app\n   */\n  textZoom?: number;\n}\n\nexport interface InAppBrowserPlugin {\n  /**\n   * Open url in a new window fullscreen\n   *\n   * @since 0.1.0\n   */\n  open(options: OpenOptions): Promise<any>;\n\n  /**\n   * Clear cookies of url\n   *\n   * @since 0.5.0\n   */\n  clearCookies(options: ClearCookieOptions): Promise<any>;\n  /**\n   * Clear all cookies\n   *\n   * @since 6.5.0\n   */\n  clearAllCookies(): Promise<any>;\n\n  /**\n   * Clear cache\n   *\n   * @since 6.5.0\n   */\n  clearCache(): Promise<any>;\n\n  /**\n   * Get cookies for a specific URL.\n   * @param options The options, including the URL to get cookies for.\n   * @returns A promise that resolves with the cookies.\n   */\n  getCookies(options: GetCookieOptions): Promise<Record<string, string>>;\n  /**\n   * Close the webview.\n   */\n  close(): Promise<any>;\n  /**\n   * Open url in a new webview with toolbars, and enhanced capabilities, like camera access, file access, listen events, inject javascript, bi directional communication, etc.\n   *\n   * JavaScript Interface:\n   * When you open a webview with this method, a JavaScript interface is automatically injected that provides:\n   * - `window.mobileApp.close()`: Closes the webview from JavaScript\n   * - `window.mobileApp.postMessage(obj)`: Sends a message from the webview to the app\n   *\n   * @since 0.1.0\n   */\n  openWebView(options: OpenWebViewOptions): Promise<any>;\n  /**\n   * Injects JavaScript code into the InAppBrowser window.\n   */\n  executeScript({ code }: { code: string }): Promise<void>;\n  /**\n   * Sends an event to the webview(inappbrowser). you can listen to this event in the inappbrowser JS with window.addEventListener(\"messageFromNative\", listenerFunc: (event: Record<string, any>) => void)\n   * detail is the data you want to send to the webview, it's a requirement of Capacitor we cannot send direct objects\n   * Your object has to be serializable to JSON, so no functions or other non-JSON-serializable types are allowed.\n   */\n  postMessage(options: { detail: Record<string, any> }): Promise<void>;\n  /**\n   * Sets the URL of the webview.\n   */\n  setUrl(options: { url: string }): Promise<any>;\n  /**\n   * Listen for url change, only for openWebView\n   *\n   * @since 0.0.1\n   */\n  addListener(\n    eventName: \"urlChangeEvent\",\n    listenerFunc: UrlChangeListener,\n  ): Promise<PluginListenerHandle>;\n\n  addListener(\n    eventName: \"buttonNearDoneClick\",\n    listenerFunc: ButtonNearListener,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * Listen for close click only for openWebView\n   *\n   * @since 0.4.0\n   */\n  addListener(\n    eventName: \"closeEvent\",\n    listenerFunc: UrlChangeListener,\n  ): Promise<PluginListenerHandle>;\n  /**\n   * Will be triggered when user clicks on confirm button when disclaimer is required\n   *\n   * @since 0.0.1\n   */\n  addListener(\n    eventName: \"confirmBtnClicked\",\n    listenerFunc: ConfirmBtnListener,\n  ): Promise<PluginListenerHandle>;\n  /**\n   * Will be triggered when event is sent from webview(inappbrowser), to send an event to the main app use window.mobileApp.postMessage({ \"detail\": { \"message\": \"myMessage\" } })\n   * detail is the data you want to send to the main app, it's a requirement of Capacitor we cannot send direct objects\n   * Your object has to be serializable to JSON, no functions or other non-JSON-serializable types are allowed.\n   *\n   * This method is inject at runtime in the webview\n   */\n  addListener(\n    eventName: \"messageFromWebview\",\n    listenerFunc: (event: { detail: Record<string, any> }) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * Will be triggered when page is loaded\n   */\n  addListener(\n    eventName: \"browserPageLoaded\",\n    listenerFunc: () => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * Will be triggered when page load error\n   */\n  addListener(\n    eventName: \"pageLoadError\",\n    listenerFunc: () => void,\n  ): Promise<PluginListenerHandle>;\n  /**\n   * Remove all listeners for this plugin.\n   *\n   * @since 1.0.0\n   */\n  removeAllListeners(): Promise<void>;\n\n  /**\n   * Reload the current web page.\n   *\n   * @since 1.0.0\n   */\n  reload(): Promise<any>;\n}\n\n/**\n * JavaScript APIs available in the InAppBrowser WebView.\n *\n * These APIs are automatically injected into all webpages loaded in the InAppBrowser WebView.\n *\n * @example\n * // Closing the webview from JavaScript\n * window.mobileApp.close();\n *\n * // Sending a message from webview to the native app\n * window.mobileApp.postMessage({ key: 'value' });\n *\n * @since 6.10.0\n */\nexport interface InAppBrowserWebViewAPIs {\n  /**\n   * mobileApp - Global object injected into the WebView providing communication with the native app\n   */\n  mobileApp: {\n    /**\n     * Close the WebView from JavaScript\n     *\n     * @example\n     * // Add a button to close the webview\n     * const closeButton = document.createElement('button');\n     * closeButton.textContent = 'Close WebView';\n     * closeButton.addEventListener('click', () => {\n     *   window.mobileApp.close();\n     * });\n     * document.body.appendChild(closeButton);\n     *\n     * @since 6.10.0\n     */\n    close(): void;\n\n    /**\n     * Send a message from the WebView to the native app\n     * The native app can listen for these messages with the \"messageFromWebview\" event\n     *\n     * @param message Object to send to the native app\n     * @example\n     * // Send data to native app\n     * window.mobileApp.postMessage({\n     *   action: 'dataSubmitted',\n     *   data: { username: 'test', email: 'test@example.com' }\n     * });\n     *\n     * @since 6.10.0\n     */\n    postMessage(message: Record<string, any>): void;\n  };\n}\n"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAuBA,MAAM,CAAN,IAAY,eAGX;AAHD,WAAY,eAAe;IACzB,kCAAe,CAAA;IACf,kCAAe,CAAA;AACjB,CAAC,EAHW,eAAe,KAAf,eAAe,QAG1B;AACD,MAAM,CAAN,IAAY,WAgBX;AAhBD,WAAY,WAAW;IACrB;;;OAGG;IACH,oCAAqB,CAAA;IACrB;;;OAGG;IACH,wCAAyB,CAAA;IACzB;;;OAGG;IACH,8BAAe,CAAA;AACjB,CAAC,EAhBW,WAAW,KAAX,WAAW,QAgBtB","sourcesContent":["import type { PluginListenerHandle } from \"@capacitor/core\";\n\nexport interface UrlEvent {\n  /**\n   * Emit when the url changes\n   *\n   * @since 0.0.1\n   */\n  url: string;\n}\nexport interface BtnEvent {\n  /**\n   * Emit when a button is clicked.\n   *\n   * @since 0.0.1\n   */\n  url: string;\n}\n\nexport type UrlChangeListener = (state: UrlEvent) => void;\nexport type ConfirmBtnListener = (state: BtnEvent) => void;\nexport type ButtonNearListener = (state: object) => void;\n\nexport enum BackgroundColor {\n  WHITE = \"white\",\n  BLACK = \"black\",\n}\nexport enum ToolBarType {\n  /**\n   * Shows a simple toolbar with just a close button and share button\n   * @since 0.1.0\n   */\n  ACTIVITY = \"activity\",\n  /**\n   * Shows a full navigation toolbar with back/forward buttons\n   * @since 0.1.0\n   */\n  NAVIGATION = \"navigation\",\n  /**\n   * Shows no toolbar\n   * @since 0.1.0\n   */\n  BLANK = \"blank\",\n}\n\nexport interface Headers {\n  [key: string]: string;\n}\n\nexport interface GetCookieOptions {\n  url: string;\n  includeHttpOnly?: boolean;\n}\n\nexport interface ClearCookieOptions {\n  url: string;\n}\n\nexport interface Credentials {\n  username: string;\n  password: string;\n}\n\nexport interface OpenOptions {\n  /**\n   * Target URL to load.\n   * @since 0.1.0\n   */\n  url: string;\n  /**\n   * Headers to send with the request.\n   * @since 0.1.0\n   */\n  headers?: Headers;\n  /**\n   * Credentials to send with the request and all subsequent requests for the same host.\n   * @since 6.1.0\n   */\n  credentials?: Credentials;\n  /**\n   * if true, the browser will be presented after the page is loaded, if false, the browser will be presented immediately.\n   * @since 0.1.0\n   */\n  isPresentAfterPageLoad?: boolean;\n  /**\n   * if true the deeplink will not be opened, if false the deeplink will be opened when clicked on the link\n   * @since 0.1.0\n   */\n  preventDeeplink?: boolean;\n}\n\nexport interface DisclaimerOptions {\n  /**\n   * Title of the disclaimer dialog\n   * @default \"Title\"\n   */\n  title: string;\n  /**\n   * Message shown in the disclaimer dialog\n   * @default \"Message\"\n   */\n  message: string;\n  /**\n   * Text for the confirm button\n   * @default \"Confirm\"\n   */\n  confirmBtn: string;\n  /**\n   * Text for the cancel button\n   * @default \"Cancel\"\n   */\n  cancelBtn: string;\n}\n\nexport interface OpenWebViewOptions {\n  /**\n   * Target URL to load.\n   * @since 0.1.0\n   * @example \"https://capgo.app\"\n   */\n  url: string;\n  /**\n   * Headers to send with the request.\n   * @since 0.1.0\n   * @example\n   * headers: {\n   *   'Custom-Header': 'test-value',\n   *   'Authorization': 'Bearer test-token'\n   * }\n   * Test URL: https://www.whatismybrowser.com/detect/what-http-headers-is-my-browser-sending/\n   */\n  headers?: Headers;\n  /**\n   * Credentials to send with the request and all subsequent requests for the same host.\n   * @since 6.1.0\n   * @example\n   * credentials: {\n   *   username: 'test-user',\n   *   password: 'test-pass'\n   * }\n   * Test URL: https://www.whatismybrowser.com/detect/what-http-headers-is-my-browser-sending/\n   */\n  credentials?: Credentials;\n  /**\n   * materialPicker: if true, uses Material Design theme for date and time pickers on Android.\n   * This improves the appearance of HTML date inputs to use modern Material Design UI instead of the old style pickers.\n   * @since 7.4.1\n   * @default false\n   * @example\n   * materialPicker: true\n   * Test URL: https://show-picker.glitch.me/demo.html\n   */\n  materialPicker?: boolean;\n  /**\n   * JavaScript Interface:\n   * The webview automatically injects a JavaScript interface providing:\n   * - `window.mobileApp.close()`: Closes the webview from JavaScript\n   * - `window.mobileApp.postMessage(obj)`: Sends a message to the app (listen via \"messageFromWebview\" event)\n   *\n   * @example\n   * // In your webpage loaded in the webview:\n   * document.getElementById('closeBtn').addEventListener('click', () => {\n   *   window.mobileApp.close();\n   * });\n   *\n   * // Send data to the app\n   * window.mobileApp.postMessage({ action: 'login', data: { user: 'test' }});\n   *\n   * @since 6.10.0\n   */\n  jsInterface?: never; // This property doesn't exist, it's just for documentation\n  /**\n   * Share options for the webview. When provided, shows a disclaimer dialog before sharing content.\n   * This is useful for:\n   * - Warning users about sharing sensitive information\n   * - Getting user consent before sharing\n   * - Explaining what will be shared\n   * - Complying with privacy regulations\n   *\n   * Note: shareSubject is required when using shareDisclaimer\n   * @since 0.1.0\n   * @example\n   * shareDisclaimer: {\n   *   title: 'Disclaimer',\n   *   message: 'This is a test disclaimer',\n   *   confirmBtn: 'Accept',\n   *   cancelBtn: 'Decline'\n   * }\n   * Test URL: https://capgo.app\n   */\n  shareDisclaimer?: DisclaimerOptions;\n  /**\n   * Toolbar type determines the appearance and behavior of the browser's toolbar\n   * - \"activity\": Shows a simple toolbar with just a close button and share button\n   * - \"navigation\": Shows a full navigation toolbar with back/forward buttons\n   * - \"blank\": Shows no toolbar\n   * - \"\": Default toolbar with close button\n   * @since 0.1.0\n   * @default ToolBarType.DEFAULT\n   * @example\n   * toolbarType: ToolBarType.ACTIVITY,\n   * title: 'Activity Toolbar Test'\n   * Test URL: https://capgo.app\n   */\n  toolbarType?: ToolBarType;\n  /**\n   * Subject text for sharing. Required when using shareDisclaimer.\n   * This text will be used as the subject line when sharing content.\n   * @since 0.1.0\n   * @example \"Share this page\"\n   */\n  shareSubject?: string;\n  /**\n   * Title of the browser\n   * @since 0.1.0\n   * @default 'New Window'\n   * @example \"Camera Test\"\n   */\n  title?: string;\n  /**\n   * Background color of the browser\n   * @since 0.1.0\n   * @default BackgroundColor.BLACK\n   */\n  backgroundColor?: BackgroundColor;\n  /**\n   * If true, active the native navigation within the webview, Android only\n   * @default false\n   * @example\n   * activeNativeNavigationForWebview: true,\n   * disableGoBackOnNativeApplication: true\n   * Test URL: https://capgo.app\n   */\n  activeNativeNavigationForWebview?: boolean;\n  /**\n   * Disable the possibility to go back on native application,\n   * useful to force user to stay on the webview, Android only\n   * @default false\n   * @example\n   * disableGoBackOnNativeApplication: true\n   * Test URL: https://capgo.app\n   */\n  disableGoBackOnNativeApplication?: boolean;\n  /**\n   * Open url in a new window fullscreen\n   * isPresentAfterPageLoad: if true, the browser will be presented after the page is loaded, if false, the browser will be presented immediately.\n   * @since 0.1.0\n   * @default false\n   * @example\n   * isPresentAfterPageLoad: true,\n   * preShowScript: \"await import('https://unpkg.com/darkreader@4.9.89/darkreader.js');\\nDarkReader.enable({ brightness: 100, contrast: 90, sepia: 10 });\"\n   * Test URL: https://capgo.app\n   */\n  isPresentAfterPageLoad?: boolean;\n  /**\n   * Whether the website in the webview is inspectable or not, ios only\n   * @default false\n   */\n  isInspectable?: boolean;\n  /**\n   * Whether the webview opening is animated or not, ios only\n   * @default true\n   */\n  isAnimated?: boolean;\n  /**\n   * Shows a reload button that reloads the web page\n   * @since 1.0.15\n   * @default false\n   * @example\n   * showReloadButton: true\n   * Test URL: https://capgo.app\n   */\n  showReloadButton?: boolean;\n  /**\n   * CloseModal: if true a confirm will be displayed when user clicks on close button, if false the browser will be closed immediately.\n   * @since 1.1.0\n   * @default false\n   * @example\n   * closeModal: true,\n   * closeModalTitle: 'Close Window',\n   * closeModalDescription: 'Are you sure you want to close?',\n   * closeModalOk: 'Yes, close',\n   * closeModalCancel: 'No, stay'\n   * Test URL: https://capgo.app\n   */\n  closeModal?: boolean;\n  /**\n   * CloseModalTitle: title of the confirm when user clicks on close button\n   * @since 1.1.0\n   * @default 'Close'\n   */\n  closeModalTitle?: string;\n  /**\n   * CloseModalDescription: description of the confirm when user clicks on close button\n   * @since 1.1.0\n   * @default 'Are you sure you want to close this window?'\n   */\n  closeModalDescription?: string;\n  /**\n   * CloseModalOk: text of the confirm button when user clicks on close button\n   * @since 1.1.0\n   * @default 'Close'\n   */\n  closeModalOk?: string;\n  /**\n   * CloseModalCancel: text of the cancel button when user clicks on close button\n   * @since 1.1.0\n   * @default 'Cancel'\n   */\n  closeModalCancel?: string;\n  /**\n   * visibleTitle: if true the website title would be shown else shown empty\n   * @since 1.2.5\n   * @default true\n   */\n  visibleTitle?: boolean;\n  /**\n   * toolbarColor: color of the toolbar in hex format\n   * @since 1.2.5\n   * @default '#ffffff'\n   * @example\n   * toolbarColor: '#FF5733'\n   * Test URL: https://capgo.app\n   */\n  toolbarColor?: string;\n  /**\n   * toolbarTextColor: color of the buttons and title in the toolbar in hex format\n   * When set, it overrides the automatic light/dark mode detection for text color\n   * @since 6.10.0\n   * @default calculated based on toolbarColor brightness\n   * @example\n   * toolbarTextColor: '#FFFFFF'\n   * Test URL: https://capgo.app\n   */\n  toolbarTextColor?: string;\n  /**\n   * showArrow: if true an arrow would be shown instead of cross for closing the window\n   * @since 1.2.5\n   * @default false\n   * @example\n   * showArrow: true\n   * Test URL: https://capgo.app\n   */\n  showArrow?: boolean;\n  /**\n   * ignoreUntrustedSSLError: if true, the webview will ignore untrusted SSL errors allowing the user to view the website.\n   * @since 6.1.0\n   * @default false\n   */\n  ignoreUntrustedSSLError?: boolean;\n  /**\n   * preShowScript: if isPresentAfterPageLoad is true and this variable is set the plugin will inject a script before showing the browser.\n   * This script will be run in an async context. The plugin will wait for the script to finish (max 10 seconds)\n   * @since 6.6.0\n   * @example\n   * preShowScript: \"await import('https://unpkg.com/darkreader@4.9.89/darkreader.js');\\nDarkReader.enable({ brightness: 100, contrast: 90, sepia: 10 });\"\n   * Test URL: https://capgo.app\n   */\n  preShowScript?: string;\n  /**\n   * proxyRequests is a regex expression. Please see [this pr](https://github.com/Cap-go/capacitor-inappbrowser/pull/222) for more info. (Android only)\n   * @since 6.9.0\n   */\n  proxyRequests?: string;\n  /**\n   * buttonNearDone allows for a creation of a custom button near the done/close button.\n   * The button is only shown when toolbarType is not \"activity\", \"navigation\", or \"blank\".\n   *\n   * For Android:\n   * - iconType must be \"asset\"\n   * - icon path should be in the public folder (e.g. \"monkey.svg\")\n   * - width and height are optional, defaults to 48dp\n   * - button is positioned at the end of toolbar with 8dp margin\n   *\n   * For iOS:\n   * - iconType can be \"sf-symbol\" or \"asset\"\n   * - for sf-symbol, icon should be the symbol name\n   * - for asset, icon should be the asset name\n   * @since 6.7.0\n   * @example\n   * buttonNearDone: {\n   *   ios: {\n   *     iconType: 'sf-symbol',\n   *     icon: 'star.fill'\n   *   },\n   *   android: {\n   *     iconType: 'asset',\n   *     icon: 'public/monkey.svg',\n   *     width: 24,\n   *     height: 24\n   *   }\n   * }\n   * Test URL: https://capgo.app\n   */\n  buttonNearDone?: {\n    ios: {\n      iconType: \"sf-symbol\" | \"asset\";\n      icon: string;\n    };\n    android: {\n      iconType: \"asset\" | \"vector\";\n      icon: string;\n      width?: number;\n      height?: number;\n    };\n  };\n  /**\n   * textZoom: sets the text zoom of the page in percent.\n   * Allows users to increase or decrease the text size for better readability.\n   * @since 7.6.0\n   * @default 100\n   * @example\n   * textZoom: 120\n   * Test URL: https://capgo.app\n   */\n  textZoom?: number;\n}\n\nexport interface InAppBrowserPlugin {\n  /**\n   * Open url in a new window fullscreen\n   *\n   * @since 0.1.0\n   */\n  open(options: OpenOptions): Promise<any>;\n\n  /**\n   * Clear cookies of url\n   *\n   * @since 0.5.0\n   */\n  clearCookies(options: ClearCookieOptions): Promise<any>;\n  /**\n   * Clear all cookies\n   *\n   * @since 6.5.0\n   */\n  clearAllCookies(): Promise<any>;\n\n  /**\n   * Clear cache\n   *\n   * @since 6.5.0\n   */\n  clearCache(): Promise<any>;\n\n  /**\n   * Get cookies for a specific URL.\n   * @param options The options, including the URL to get cookies for.\n   * @returns A promise that resolves with the cookies.\n   */\n  getCookies(options: GetCookieOptions): Promise<Record<string, string>>;\n  /**\n   * Close the webview.\n   */\n  close(): Promise<any>;\n  /**\n   * Open url in a new webview with toolbars, and enhanced capabilities, like camera access, file access, listen events, inject javascript, bi directional communication, etc.\n   *\n   * JavaScript Interface:\n   * When you open a webview with this method, a JavaScript interface is automatically injected that provides:\n   * - `window.mobileApp.close()`: Closes the webview from JavaScript\n   * - `window.mobileApp.postMessage({detail: {message: 'myMessage'}})`: Sends a message from the webview to the app, detail object is the data you want to send to the webview\n   *\n   * @since 0.1.0\n   */\n  openWebView(options: OpenWebViewOptions): Promise<any>;\n  /**\n   * Injects JavaScript code into the InAppBrowser window.\n   */\n  executeScript({ code }: { code: string }): Promise<void>;\n  /**\n   * Sends an event to the webview(inappbrowser). you can listen to this event in the inappbrowser JS with window.addEventListener(\"messageFromNative\", listenerFunc: (event: Record<string, any>) => void)\n   * detail is the data you want to send to the webview, it's a requirement of Capacitor we cannot send direct objects\n   * Your object has to be serializable to JSON, so no functions or other non-JSON-serializable types are allowed.\n   */\n  postMessage(options: { detail: Record<string, any> }): Promise<void>;\n  /**\n   * Sets the URL of the webview.\n   */\n  setUrl(options: { url: string }): Promise<any>;\n  /**\n   * Listen for url change, only for openWebView\n   *\n   * @since 0.0.1\n   */\n  addListener(\n    eventName: \"urlChangeEvent\",\n    listenerFunc: UrlChangeListener,\n  ): Promise<PluginListenerHandle>;\n\n  addListener(\n    eventName: \"buttonNearDoneClick\",\n    listenerFunc: ButtonNearListener,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * Listen for close click only for openWebView\n   *\n   * @since 0.4.0\n   */\n  addListener(\n    eventName: \"closeEvent\",\n    listenerFunc: UrlChangeListener,\n  ): Promise<PluginListenerHandle>;\n  /**\n   * Will be triggered when user clicks on confirm button when disclaimer is required\n   *\n   * @since 0.0.1\n   */\n  addListener(\n    eventName: \"confirmBtnClicked\",\n    listenerFunc: ConfirmBtnListener,\n  ): Promise<PluginListenerHandle>;\n  /**\n   * Will be triggered when event is sent from webview(inappbrowser), to send an event to the main app use window.mobileApp.postMessage({ \"detail\": { \"message\": \"myMessage\" } })\n   * detail is the data you want to send to the main app, it's a requirement of Capacitor we cannot send direct objects\n   * Your object has to be serializable to JSON, no functions or other non-JSON-serializable types are allowed.\n   *\n   * This method is inject at runtime in the webview\n   */\n  addListener(\n    eventName: \"messageFromWebview\",\n    listenerFunc: (event: { detail: Record<string, any> }) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * Will be triggered when page is loaded\n   */\n  addListener(\n    eventName: \"browserPageLoaded\",\n    listenerFunc: () => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * Will be triggered when page load error\n   */\n  addListener(\n    eventName: \"pageLoadError\",\n    listenerFunc: () => void,\n  ): Promise<PluginListenerHandle>;\n  /**\n   * Remove all listeners for this plugin.\n   *\n   * @since 1.0.0\n   */\n  removeAllListeners(): Promise<void>;\n\n  /**\n   * Reload the current web page.\n   *\n   * @since 1.0.0\n   */\n  reload(): Promise<any>;\n}\n\n/**\n * JavaScript APIs available in the InAppBrowser WebView.\n *\n * These APIs are automatically injected into all webpages loaded in the InAppBrowser WebView.\n *\n * @example\n * // Closing the webview from JavaScript\n * window.mobileApp.close();\n *\n * // Sending a message from webview to the native app\n * window.mobileApp.postMessage({ key: 'value' });\n *\n * @since 6.10.0\n */\nexport interface InAppBrowserWebViewAPIs {\n  /**\n   * mobileApp - Global object injected into the WebView providing communication with the native app\n   */\n  mobileApp: {\n    /**\n     * Close the WebView from JavaScript\n     *\n     * @example\n     * // Add a button to close the webview\n     * const closeButton = document.createElement('button');\n     * closeButton.textContent = 'Close WebView';\n     * closeButton.addEventListener('click', () => {\n     *   window.mobileApp.close();\n     * });\n     * document.body.appendChild(closeButton);\n     *\n     * @since 6.10.0\n     */\n    close(): void;\n\n    /**\n     * Send a message from the WebView to the native app\n     * The native app can listen for these messages with the \"messageFromWebview\" event\n     *\n     * @param message Object to send to the native app\n     * @example\n     * // Send data to native app\n     * window.mobileApp.postMessage({\n     *   action: 'dataSubmitted',\n     *   data: { username: 'test', email: 'test@example.com' }\n     * });\n     *\n     * @since 6.10.0\n     */\n    postMessage(message: Record<string, any>): void;\n  };\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capgo/inappbrowser",
-  "version": "7.6.3",
+  "version": "7.6.4",
   "description": "Capacitor plugin in app browser",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",