@capgo/inappbrowser 6.4.3 → 6.4.4

package/README.md

@@ -335,7 +335,7 @@ Will be triggered when page is loaded
 addListener(eventName: "pageLoadError", listenerFunc: () => void) => Promise<PluginListenerHandle>
 ```
 
-Will be triggered when page is loaded
+Will be triggered when page load error
 
 | Param              | Type                         |
 | ------------------ | ---------------------------- |

package/dist/docs.json

@@ -313,7 +313,7 @@
         ],
         "returns": "Promise<PluginListenerHandle>",
         "tags": [],
-        "docs": "Will be triggered when page is loaded",
+        "docs": "Will be triggered when page load error",
         "complexTypes": [
           "PluginListenerHandle"
         ],

package/dist/esm/definitions.d.ts

@@ -300,7 +300,7 @@ export interface InAppBrowserPlugin {
      */
     addListener(eventName: "browserPageLoaded", listenerFunc: () => void): Promise<PluginListenerHandle>;
     /**
-     * Will be triggered when page is loaded
+     * Will be triggered when page load error
      */
     addListener(eventName: "pageLoadError", listenerFunc: () => void): Promise<PluginListenerHandle>;
     /**

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAsBA,MAAM,CAAN,IAAY,eAGX;AAHD,WAAY,eAAe;IACzB,kCAAe,CAAA;IACf,kCAAe,CAAA;AACjB,CAAC,EAHW,eAAe,KAAf,eAAe,QAG1B;AACD,MAAM,CAAN,IAAY,WAKX;AALD,WAAY,WAAW;IACrB,oCAAqB,CAAA;IACrB,wCAAyB,CAAA;IACzB,8BAAe,CAAA;IACf,2BAAY,CAAA;AACd,CAAC,EALW,WAAW,KAAX,WAAW,QAKtB","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;\n\nexport enum BackgroundColor {\n  WHITE = \"white\",\n  BLACK = \"black\",\n}\nexport enum ToolBarType {\n  ACTIVITY = \"activity\",\n  NAVIGATION = \"navigation\",\n  BLANK = \"blank\",\n  DEFAULT = \"\",\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  cache?: boolean;\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  preventDeeplink?: boolean;\n}\n\nexport interface DisclaimerOptions {\n  title: string;\n  message: string;\n  confirmBtn: string;\n  cancelBtn: string;\n}\n\nexport interface OpenWebViewOptions {\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   * share options\n   * @since 0.1.0\n   */\n  shareDisclaimer?: DisclaimerOptions;\n  /**\n   * Toolbar type\n   * @since 0.1.0\n   * @default ToolBarType.DEFAULT\n   */\n  toolbarType?: ToolBarType;\n  /**\n   * Share subject\n   * @since 0.1.0\n   */\n  shareSubject?: string;\n  /**\n   * Title of the browser\n   * @since 0.1.0\n   * @default 'New Window'\n   */\n  title?: string;\n  /**\n   * Background color of the browser, only on IOS\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   *\n   * @default false\n   */\n  activeNativeNavigationForWebview?: boolean;\n  /**\n   * Disable the possibility to go back on native application,\n   * usefull to force user to stay on the webview, Android only\n   *\n   * @default false\n   */\n  disableGoBackOnNativeApplication?: boolean;\n  /**\n   * Open url in a new window fullscreen\n   *\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   */\n  isPresentAfterPageLoad?: boolean;\n  /**\n   * Whether the website in the webview is inspectable or not, ios only\n   *\n   * @default false\n   */\n  isInspectable?: boolean;\n  /**\n   * Whether the webview opening is animated or not, ios only\n   *\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   */\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   *\n   * @since 1.1.0\n   * @default false\n   */\n  closeModal?: boolean;\n  /**\n   * CloseModalTitle: title of the confirm when user clicks on close button, only on IOS\n   *\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, only on IOS\n   *\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, only on IOS\n   *\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, only on IOS\n   *\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   *\n   * @since 1.2.5\n   * @default true\n   */\n  visibleTitle?: boolean;\n  /**\n   * toolbarColor: color of the toolbar in hex format\n   *\n   * @since 1.2.5\n   * @default '#ffffff''\n   */\n  toolbarColor?: string;\n  /**\n   * showArrow: if true an arrow would be shown instead of cross for closing the window\n   *\n   * @since 1.2.5\n   * @default false\n   */\n  showArrow?: boolean;\n  /**\n   * ignoreUntrustedSSLError: if true, the webview will ignore untrusted SSL errors allowing the user to view the website.\n   *\n   * @since 6.1.0\n   * @default false\n   */\n  ignoreUntrustedSSLError?: boolean;\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  /**\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\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. you can listen to this event with addListener(\"messageFromWebview\", 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  /**\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, works only on iOS\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, to send an event to the webview use window.mobileApp.postMessage({ \"detail\": { \"message\": \"myMessage\" } })\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   * 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 is loaded\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>; // Add this line\n}\n"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAsBA,MAAM,CAAN,IAAY,eAGX;AAHD,WAAY,eAAe;IACzB,kCAAe,CAAA;IACf,kCAAe,CAAA;AACjB,CAAC,EAHW,eAAe,KAAf,eAAe,QAG1B;AACD,MAAM,CAAN,IAAY,WAKX;AALD,WAAY,WAAW;IACrB,oCAAqB,CAAA;IACrB,wCAAyB,CAAA;IACzB,8BAAe,CAAA;IACf,2BAAY,CAAA;AACd,CAAC,EALW,WAAW,KAAX,WAAW,QAKtB","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;\n\nexport enum BackgroundColor {\n  WHITE = \"white\",\n  BLACK = \"black\",\n}\nexport enum ToolBarType {\n  ACTIVITY = \"activity\",\n  NAVIGATION = \"navigation\",\n  BLANK = \"blank\",\n  DEFAULT = \"\",\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  cache?: boolean;\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  preventDeeplink?: boolean;\n}\n\nexport interface DisclaimerOptions {\n  title: string;\n  message: string;\n  confirmBtn: string;\n  cancelBtn: string;\n}\n\nexport interface OpenWebViewOptions {\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   * share options\n   * @since 0.1.0\n   */\n  shareDisclaimer?: DisclaimerOptions;\n  /**\n   * Toolbar type\n   * @since 0.1.0\n   * @default ToolBarType.DEFAULT\n   */\n  toolbarType?: ToolBarType;\n  /**\n   * Share subject\n   * @since 0.1.0\n   */\n  shareSubject?: string;\n  /**\n   * Title of the browser\n   * @since 0.1.0\n   * @default 'New Window'\n   */\n  title?: string;\n  /**\n   * Background color of the browser, only on IOS\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   *\n   * @default false\n   */\n  activeNativeNavigationForWebview?: boolean;\n  /**\n   * Disable the possibility to go back on native application,\n   * usefull to force user to stay on the webview, Android only\n   *\n   * @default false\n   */\n  disableGoBackOnNativeApplication?: boolean;\n  /**\n   * Open url in a new window fullscreen\n   *\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   */\n  isPresentAfterPageLoad?: boolean;\n  /**\n   * Whether the website in the webview is inspectable or not, ios only\n   *\n   * @default false\n   */\n  isInspectable?: boolean;\n  /**\n   * Whether the webview opening is animated or not, ios only\n   *\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   */\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   *\n   * @since 1.1.0\n   * @default false\n   */\n  closeModal?: boolean;\n  /**\n   * CloseModalTitle: title of the confirm when user clicks on close button, only on IOS\n   *\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, only on IOS\n   *\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, only on IOS\n   *\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, only on IOS\n   *\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   *\n   * @since 1.2.5\n   * @default true\n   */\n  visibleTitle?: boolean;\n  /**\n   * toolbarColor: color of the toolbar in hex format\n   *\n   * @since 1.2.5\n   * @default '#ffffff''\n   */\n  toolbarColor?: string;\n  /**\n   * showArrow: if true an arrow would be shown instead of cross for closing the window\n   *\n   * @since 1.2.5\n   * @default false\n   */\n  showArrow?: boolean;\n  /**\n   * ignoreUntrustedSSLError: if true, the webview will ignore untrusted SSL errors allowing the user to view the website.\n   *\n   * @since 6.1.0\n   * @default false\n   */\n  ignoreUntrustedSSLError?: boolean;\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  /**\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\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. you can listen to this event with addListener(\"messageFromWebview\", 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  /**\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, works only on iOS\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, to send an event to the webview use window.mobileApp.postMessage({ \"detail\": { \"message\": \"myMessage\" } })\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   * 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>; // Add this line\n}\n"]}

package/package.json

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