@capawesome/capacitor-in-app-browser 0.0.1

package/dist/esm/definitions.d.ts

@@ -0,0 +1,540 @@
+import type { PluginListenerHandle } from '@capacitor/core';
+export interface InAppBrowserPlugin {
+    /**
+     * Clear the cache of the web view.
+     *
+     * Only available on Android and iOS.
+     *
+     * @since 0.1.0
+     */
+    clearCache(): Promise<void>;
+    /**
+     * Clear the session data (cookies and web storage) of the web view.
+     *
+     * Only available on Android and iOS.
+     *
+     * @since 0.1.0
+     */
+    clearSessionData(): Promise<void>;
+    /**
+     * Close the currently open browser.
+     *
+     * This closes browsers opened with `openInWebView(...)` or
+     * `openInSystemBrowser(...)`.
+     *
+     * Only available on Android and iOS.
+     *
+     * @since 0.1.0
+     */
+    close(): Promise<void>;
+    /**
+     * Execute a JavaScript script in the currently open web view.
+     *
+     * This method is only available for browsers opened with
+     * `openInWebView(...)`.
+     *
+     * Only available on Android and iOS.
+     *
+     * @since 0.1.0
+     */
+    executeScript(options: ExecuteScriptOptions): Promise<ExecuteScriptResult>;
+    /**
+     * Get the cookies for a specific URL.
+     *
+     * On iOS, only cookies from the shared data store are returned. Cookies from
+     * a web view opened with `dataStore: 'isolated'` are not included.
+     *
+     * Only available on Android and iOS.
+     *
+     * @since 0.1.0
+     */
+    getCookies(options: GetCookiesOptions): Promise<GetCookiesResult>;
+    /**
+     * Open a URL in the default browser app of the device.
+     *
+     * @since 0.1.0
+     */
+    openInExternalBrowser(options: OpenInExternalBrowserOptions): Promise<void>;
+    /**
+     * Open a URL in the system browser (Custom Tabs on Android,
+     * `SFSafariViewController` on iOS).
+     *
+     * Only available on Android and iOS.
+     *
+     * @since 0.1.0
+     */
+    openInSystemBrowser(options: OpenInSystemBrowserOptions): Promise<void>;
+    /**
+     * Open a URL in an embedded web view with a native toolbar.
+     *
+     * Only available on Android and iOS.
+     *
+     * @since 0.1.0
+     */
+    openInWebView(options: OpenInWebViewOptions): Promise<void>;
+    /**
+     * Post a message to the currently open web view.
+     *
+     * The web page receives the message by listening for the
+     * `capacitorInAppBrowserMessage` window event. The message data is
+     * available in the `detail` property of the event.
+     *
+     * This method is only available for browsers opened with
+     * `openInWebView(...)`.
+     *
+     * Only available on Android and iOS.
+     *
+     * @since 0.1.0
+     */
+    postMessage(options: PostMessageOptions): Promise<void>;
+    /**
+     * Called when the browser is closed.
+     *
+     * Only available on Android and iOS.
+     *
+     * @since 0.1.0
+     */
+    addListener(eventName: 'browserClosed', listenerFunc: () => void): Promise<PluginListenerHandle>;
+    /**
+     * Called when the initial page of the browser has finished loading.
+     *
+     * On Android, this event is only emitted for browsers opened with
+     * `openInWebView(...)`.
+     *
+     * Only available on Android and iOS.
+     *
+     * @since 0.1.0
+     */
+    addListener(eventName: 'browserPageLoaded', listenerFunc: () => void): Promise<PluginListenerHandle>;
+    /**
+     * Called when a page navigation has been completed in the web view.
+     *
+     * This event is only emitted for browsers opened with `openInWebView(...)`.
+     *
+     * Only available on Android and iOS.
+     *
+     * @since 0.1.0
+     */
+    addListener(eventName: 'browserPageNavigationCompleted', listenerFunc: (event: BrowserPageNavigationCompletedEvent) => void): Promise<PluginListenerHandle>;
+    /**
+     * Called when the web page posts a message to the app using the injected
+     * `window.CapacitorInAppBrowser.postMessage(...)` function.
+     *
+     * This event is only emitted for browsers opened with `openInWebView(...)`.
+     *
+     * Only available on Android and iOS.
+     *
+     * @since 0.1.0
+     */
+    addListener(eventName: 'messageReceived', listenerFunc: (event: MessageReceivedEvent) => void): Promise<PluginListenerHandle>;
+    /**
+     * Remove all listeners for this plugin.
+     *
+     * @since 0.1.0
+     */
+    removeAllListeners(): Promise<void>;
+}
+/**
+ * @since 0.1.0
+ */
+export interface OpenInExternalBrowserOptions {
+    /**
+     * The URL to open in the external browser.
+     *
+     * @example 'https://capawesome.io'
+     * @since 0.1.0
+     */
+    url: string;
+}
+/**
+ * @since 0.1.0
+ */
+export interface OpenInSystemBrowserOptions {
+    /**
+     * Options that are only applied on Android.
+     *
+     * Only available on Android.
+     *
+     * @since 0.1.0
+     */
+    android?: OpenInSystemBrowserAndroidOptions;
+    /**
+     * Options that are only applied on iOS.
+     *
+     * Only available on iOS.
+     *
+     * @since 0.1.0
+     */
+    ios?: OpenInSystemBrowserIosOptions;
+    /**
+     * The URL to open in the system browser.
+     *
+     * @example 'https://capawesome.io'
+     * @since 0.1.0
+     */
+    url: string;
+}
+/**
+ * @since 0.1.0
+ */
+export interface OpenInSystemBrowserAndroidOptions {
+    /**
+     * Whether or not the toolbar should be hidden when the user scrolls down
+     * and shown when the user scrolls up.
+     *
+     * @default false
+     * @since 0.1.0
+     */
+    hideToolbarOnScroll?: boolean;
+    /**
+     * Whether or not the title of the web page should be shown in the toolbar.
+     *
+     * @default false
+     * @since 0.1.0
+     */
+    showTitle?: boolean;
+    /**
+     * The background color of the toolbar as a hex color code.
+     *
+     * @example '#008080'
+     * @since 0.1.0
+     */
+    toolbarColor?: string;
+}
+/**
+ * @since 0.1.0
+ */
+export interface OpenInSystemBrowserIosOptions {
+    /**
+     * Whether or not the toolbar should collapse when the user scrolls down.
+     *
+     * @default true
+     * @since 0.1.0
+     */
+    barCollapsing?: boolean;
+    /**
+     * The style of the dismiss button in the toolbar.
+     *
+     * @default 'done'
+     * @since 0.1.0
+     */
+    dismissButtonStyle?: DismissButtonStyle;
+    /**
+     * Whether or not the reader mode should be entered if it is available for
+     * the web page.
+     *
+     * @default false
+     * @since 0.1.0
+     */
+    readerMode?: boolean;
+    /**
+     * The background color of the toolbar as a hex color code.
+     *
+     * @example '#008080'
+     * @since 0.1.0
+     */
+    toolbarColor?: string;
+}
+/**
+ * @since 0.1.0
+ */
+export interface OpenInWebViewOptions {
+    /**
+     * Options that are only applied on Android.
+     *
+     * Only available on Android.
+     *
+     * @since 0.1.0
+     */
+    android?: OpenInWebViewAndroidOptions;
+    /**
+     * The data store to use for the web view.
+     *
+     * On Android, this option is ignored. The web view always uses the
+     * app-global (`shared`) data store.
+     *
+     * Only available on iOS.
+     *
+     * @default 'shared'
+     * @since 0.1.0
+     */
+    dataStore?: WebViewDataStore;
+    /**
+     * Additional HTTP headers to send with the initial request.
+     *
+     * @since 0.1.0
+     */
+    headers?: {
+        [key: string]: string;
+    };
+    /**
+     * Options that are only applied on iOS.
+     *
+     * Only available on iOS.
+     *
+     * @since 0.1.0
+     */
+    ios?: OpenInWebViewIosOptions;
+    /**
+     * Whether or not media playback requires user action.
+     *
+     * @default false
+     * @since 0.1.0
+     */
+    mediaPlaybackRequiresUserAction?: boolean;
+    /**
+     * Options for the toolbar of the web view.
+     *
+     * @since 0.1.0
+     */
+    toolbar?: WebViewToolbarOptions;
+    /**
+     * The URL to open in the web view.
+     *
+     * @example 'https://capawesome.io'
+     * @since 0.1.0
+     */
+    url: string;
+    /**
+     * The custom user agent to use for the web view.
+     *
+     * @since 0.1.0
+     */
+    userAgent?: string;
+}
+/**
+ * @since 0.1.0
+ */
+export interface WebViewToolbarOptions {
+    /**
+     * The background color of the toolbar as a hex color code.
+     *
+     * @example '#008080'
+     * @since 0.1.0
+     */
+    backgroundColor?: string;
+    /**
+     * The text of the close button in the toolbar.
+     *
+     * @default 'Close'
+     * @since 0.1.0
+     */
+    closeButtonText?: string;
+    /**
+     * The text color of the toolbar as a hex color code.
+     *
+     * @example '#FFFFFF'
+     * @since 0.1.0
+     */
+    color?: string;
+    /**
+     * Whether or not the back and forward navigation buttons should be shown
+     * in the toolbar.
+     *
+     * @default false
+     * @since 0.1.0
+     */
+    showNavigationButtons?: boolean;
+    /**
+     * Whether or not the current URL should be displayed in the toolbar
+     * instead of the title.
+     *
+     * @default false
+     * @since 0.1.0
+     */
+    showUrl?: boolean;
+    /**
+     * The fixed title to display in the toolbar.
+     *
+     * If not set, the title of the current web page is displayed.
+     *
+     * @since 0.1.0
+     */
+    title?: string;
+    /**
+     * Whether or not the toolbar should be visible.
+     *
+     * @default true
+     * @since 0.1.0
+     */
+    visible?: boolean;
+}
+/**
+ * @since 0.1.0
+ */
+export interface OpenInWebViewAndroidOptions {
+    /**
+     * Whether or not the user can zoom the web page.
+     *
+     * @default false
+     * @since 0.1.0
+     */
+    allowZoom?: boolean;
+    /**
+     * Whether or not the hardware back button navigates back in the web view's
+     * history before closing the web view.
+     *
+     * If `false`, the hardware back button closes the web view immediately.
+     *
+     * @default true
+     * @since 0.1.0
+     */
+    hardwareBackButton?: boolean;
+    /**
+     * Whether or not media playback is paused when the app is hidden.
+     *
+     * @default true
+     * @since 0.1.0
+     */
+    pauseMediaWhenHidden?: boolean;
+}
+/**
+ * @since 0.1.0
+ */
+export interface OpenInWebViewIosOptions {
+    /**
+     * Whether or not horizontal swipe gestures navigate back and forward in
+     * the web view's history.
+     *
+     * @default false
+     * @since 0.1.0
+     */
+    allowsBackForwardNavigationGestures?: boolean;
+    /**
+     * Whether or not the web view bounces when scrolled past the edge of the
+     * content.
+     *
+     * @default true
+     * @since 0.1.0
+     */
+    overscroll?: boolean;
+}
+/**
+ * @since 0.1.0
+ */
+export interface ExecuteScriptOptions {
+    /**
+     * The JavaScript code to execute in the web view.
+     *
+     * @example 'document.title'
+     * @since 0.1.0
+     */
+    script: string;
+}
+/**
+ * @since 0.1.0
+ */
+export interface ExecuteScriptResult {
+    /**
+     * The result of the script execution serialized as a JSON string.
+     *
+     * If the script does not return a JSON-serializable value, `null` is
+     * returned.
+     *
+     * @example '"Capawesome"'
+     * @since 0.1.0
+     */
+    result: string | null;
+}
+/**
+ * @since 0.1.0
+ */
+export interface PostMessageOptions {
+    /**
+     * The message data to post to the web view.
+     *
+     * Must be a JSON-serializable object.
+     *
+     * @example { name: 'Capawesome' }
+     * @since 0.1.0
+     */
+    data: {
+        [key: string]: unknown;
+    };
+}
+/**
+ * @since 0.1.0
+ */
+export interface GetCookiesOptions {
+    /**
+     * The URL to get the cookies for.
+     *
+     * @example 'https://capawesome.io'
+     * @since 0.1.0
+     */
+    url: string;
+}
+/**
+ * @since 0.1.0
+ */
+export interface GetCookiesResult {
+    /**
+     * The cookies for the URL as a map of cookie names to values.
+     *
+     * @since 0.1.0
+     */
+    cookies: {
+        [key: string]: string;
+    };
+}
+/**
+ * @since 0.1.0
+ */
+export interface BrowserPageNavigationCompletedEvent {
+    /**
+     * The URL of the page that was navigated to.
+     *
+     * @example 'https://capawesome.io'
+     * @since 0.1.0
+     */
+    url: string;
+}
+/**
+ * @since 0.1.0
+ */
+export interface MessageReceivedEvent {
+    /**
+     * The message data posted by the web page.
+     *
+     * @since 0.1.0
+     */
+    data: unknown;
+}
+/**
+ * The style of the dismiss button in the toolbar of the system browser.
+ *
+ * - `cancel`: A button with the text "Cancel".
+ * - `close`: A button with the text "Close".
+ * - `done`: A button with the text "Done".
+ *
+ * @since 0.1.0
+ */
+export type DismissButtonStyle = 'cancel' | 'close' | 'done';
+/**
+ * The data store to use for the web view.
+ *
+ * - `isolated`: The web view uses a non-persistent data store. Cookies and
+ *   web storage are discarded when the web view is closed.
+ * - `shared`: The web view uses the app-global data store which is shared
+ *   with other web views.
+ *
+ * @since 0.1.0
+ */
+export type WebViewDataStore = 'isolated' | 'shared';
+/**
+ * @since 0.1.0
+ */
+export declare enum ErrorCode {
+    /**
+     * No app was found on the device that can open the URL.
+     *
+     * @since 0.1.0
+     */
+    BrowserNotFound = "BROWSER_NOT_FOUND",
+    /**
+     * No browser is currently open.
+     *
+     * @since 0.1.0
+     */
+    NoBrowserOpen = "NO_BROWSER_OPEN"
+}

package/dist/esm/definitions.js

@@ -0,0 +1,19 @@
+/**
+ * @since 0.1.0
+ */
+export var ErrorCode;
+(function (ErrorCode) {
+    /**
+     * No app was found on the device that can open the URL.
+     *
+     * @since 0.1.0
+     */
+    ErrorCode["BrowserNotFound"] = "BROWSER_NOT_FOUND";
+    /**
+     * No browser is currently open.
+     *
+     * @since 0.1.0
+     */
+    ErrorCode["NoBrowserOpen"] = "NO_BROWSER_OPEN";
+})(ErrorCode || (ErrorCode = {}));
+//# sourceMappingURL=definitions.js.map

package/dist/esm/definitions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAoiBA;;GAEG;AACH,MAAM,CAAN,IAAY,SAaX;AAbD,WAAY,SAAS;IACnB;;;;OAIG;IACH,kDAAqC,CAAA;IACrC;;;;OAIG;IACH,8CAAiC,CAAA;AACnC,CAAC,EAbW,SAAS,KAAT,SAAS,QAapB","sourcesContent":["import type { PluginListenerHandle } from '@capacitor/core';\n\nexport interface InAppBrowserPlugin {\n  /**\n   * Clear the cache of the web view.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 0.1.0\n   */\n  clearCache(): Promise<void>;\n  /**\n   * Clear the session data (cookies and web storage) of the web view.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 0.1.0\n   */\n  clearSessionData(): Promise<void>;\n  /**\n   * Close the currently open browser.\n   *\n   * This closes browsers opened with `openInWebView(...)` or\n   * `openInSystemBrowser(...)`.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 0.1.0\n   */\n  close(): Promise<void>;\n  /**\n   * Execute a JavaScript script in the currently open web view.\n   *\n   * This method is only available for browsers opened with\n   * `openInWebView(...)`.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 0.1.0\n   */\n  executeScript(options: ExecuteScriptOptions): Promise<ExecuteScriptResult>;\n  /**\n   * Get the cookies for a specific URL.\n   *\n   * On iOS, only cookies from the shared data store are returned. Cookies from\n   * a web view opened with `dataStore: 'isolated'` are not included.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 0.1.0\n   */\n  getCookies(options: GetCookiesOptions): Promise<GetCookiesResult>;\n  /**\n   * Open a URL in the default browser app of the device.\n   *\n   * @since 0.1.0\n   */\n  openInExternalBrowser(options: OpenInExternalBrowserOptions): Promise<void>;\n  /**\n   * Open a URL in the system browser (Custom Tabs on Android,\n   * `SFSafariViewController` on iOS).\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 0.1.0\n   */\n  openInSystemBrowser(options: OpenInSystemBrowserOptions): Promise<void>;\n  /**\n   * Open a URL in an embedded web view with a native toolbar.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 0.1.0\n   */\n  openInWebView(options: OpenInWebViewOptions): Promise<void>;\n  /**\n   * Post a message to the currently open web view.\n   *\n   * The web page receives the message by listening for the\n   * `capacitorInAppBrowserMessage` window event. The message data is\n   * available in the `detail` property of the event.\n   *\n   * This method is only available for browsers opened with\n   * `openInWebView(...)`.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 0.1.0\n   */\n  postMessage(options: PostMessageOptions): Promise<void>;\n  /**\n   * Called when the browser is closed.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 0.1.0\n   */\n  addListener(\n    eventName: 'browserClosed',\n    listenerFunc: () => void,\n  ): Promise<PluginListenerHandle>;\n  /**\n   * Called when the initial page of the browser has finished loading.\n   *\n   * On Android, this event is only emitted for browsers opened with\n   * `openInWebView(...)`.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 0.1.0\n   */\n  addListener(\n    eventName: 'browserPageLoaded',\n    listenerFunc: () => void,\n  ): Promise<PluginListenerHandle>;\n  /**\n   * Called when a page navigation has been completed in the web view.\n   *\n   * This event is only emitted for browsers opened with `openInWebView(...)`.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 0.1.0\n   */\n  addListener(\n    eventName: 'browserPageNavigationCompleted',\n    listenerFunc: (event: BrowserPageNavigationCompletedEvent) => void,\n  ): Promise<PluginListenerHandle>;\n  /**\n   * Called when the web page posts a message to the app using the injected\n   * `window.CapacitorInAppBrowser.postMessage(...)` function.\n   *\n   * This event is only emitted for browsers opened with `openInWebView(...)`.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 0.1.0\n   */\n  addListener(\n    eventName: 'messageReceived',\n    listenerFunc: (event: MessageReceivedEvent) => void,\n  ): Promise<PluginListenerHandle>;\n  /**\n   * Remove all listeners for this plugin.\n   *\n   * @since 0.1.0\n   */\n  removeAllListeners(): Promise<void>;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface OpenInExternalBrowserOptions {\n  /**\n   * The URL to open in the external browser.\n   *\n   * @example 'https://capawesome.io'\n   * @since 0.1.0\n   */\n  url: string;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface OpenInSystemBrowserOptions {\n  /**\n   * Options that are only applied on Android.\n   *\n   * Only available on Android.\n   *\n   * @since 0.1.0\n   */\n  android?: OpenInSystemBrowserAndroidOptions;\n  /**\n   * Options that are only applied on iOS.\n   *\n   * Only available on iOS.\n   *\n   * @since 0.1.0\n   */\n  ios?: OpenInSystemBrowserIosOptions;\n  /**\n   * The URL to open in the system browser.\n   *\n   * @example 'https://capawesome.io'\n   * @since 0.1.0\n   */\n  url: string;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface OpenInSystemBrowserAndroidOptions {\n  /**\n   * Whether or not the toolbar should be hidden when the user scrolls down\n   * and shown when the user scrolls up.\n   *\n   * @default false\n   * @since 0.1.0\n   */\n  hideToolbarOnScroll?: boolean;\n  /**\n   * Whether or not the title of the web page should be shown in the toolbar.\n   *\n   * @default false\n   * @since 0.1.0\n   */\n  showTitle?: boolean;\n  /**\n   * The background color of the toolbar as a hex color code.\n   *\n   * @example '#008080'\n   * @since 0.1.0\n   */\n  toolbarColor?: string;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface OpenInSystemBrowserIosOptions {\n  /**\n   * Whether or not the toolbar should collapse when the user scrolls down.\n   *\n   * @default true\n   * @since 0.1.0\n   */\n  barCollapsing?: boolean;\n  /**\n   * The style of the dismiss button in the toolbar.\n   *\n   * @default 'done'\n   * @since 0.1.0\n   */\n  dismissButtonStyle?: DismissButtonStyle;\n  /**\n   * Whether or not the reader mode should be entered if it is available for\n   * the web page.\n   *\n   * @default false\n   * @since 0.1.0\n   */\n  readerMode?: boolean;\n  /**\n   * The background color of the toolbar as a hex color code.\n   *\n   * @example '#008080'\n   * @since 0.1.0\n   */\n  toolbarColor?: string;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface OpenInWebViewOptions {\n  /**\n   * Options that are only applied on Android.\n   *\n   * Only available on Android.\n   *\n   * @since 0.1.0\n   */\n  android?: OpenInWebViewAndroidOptions;\n  /**\n   * The data store to use for the web view.\n   *\n   * On Android, this option is ignored. The web view always uses the\n   * app-global (`shared`) data store.\n   *\n   * Only available on iOS.\n   *\n   * @default 'shared'\n   * @since 0.1.0\n   */\n  dataStore?: WebViewDataStore;\n  /**\n   * Additional HTTP headers to send with the initial request.\n   *\n   * @since 0.1.0\n   */\n  headers?: { [key: string]: string };\n  /**\n   * Options that are only applied on iOS.\n   *\n   * Only available on iOS.\n   *\n   * @since 0.1.0\n   */\n  ios?: OpenInWebViewIosOptions;\n  /**\n   * Whether or not media playback requires user action.\n   *\n   * @default false\n   * @since 0.1.0\n   */\n  mediaPlaybackRequiresUserAction?: boolean;\n  /**\n   * Options for the toolbar of the web view.\n   *\n   * @since 0.1.0\n   */\n  toolbar?: WebViewToolbarOptions;\n  /**\n   * The URL to open in the web view.\n   *\n   * @example 'https://capawesome.io'\n   * @since 0.1.0\n   */\n  url: string;\n  /**\n   * The custom user agent to use for the web view.\n   *\n   * @since 0.1.0\n   */\n  userAgent?: string;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface WebViewToolbarOptions {\n  /**\n   * The background color of the toolbar as a hex color code.\n   *\n   * @example '#008080'\n   * @since 0.1.0\n   */\n  backgroundColor?: string;\n  /**\n   * The text of the close button in the toolbar.\n   *\n   * @default 'Close'\n   * @since 0.1.0\n   */\n  closeButtonText?: string;\n  /**\n   * The text color of the toolbar as a hex color code.\n   *\n   * @example '#FFFFFF'\n   * @since 0.1.0\n   */\n  color?: string;\n  /**\n   * Whether or not the back and forward navigation buttons should be shown\n   * in the toolbar.\n   *\n   * @default false\n   * @since 0.1.0\n   */\n  showNavigationButtons?: boolean;\n  /**\n   * Whether or not the current URL should be displayed in the toolbar\n   * instead of the title.\n   *\n   * @default false\n   * @since 0.1.0\n   */\n  showUrl?: boolean;\n  /**\n   * The fixed title to display in the toolbar.\n   *\n   * If not set, the title of the current web page is displayed.\n   *\n   * @since 0.1.0\n   */\n  title?: string;\n  /**\n   * Whether or not the toolbar should be visible.\n   *\n   * @default true\n   * @since 0.1.0\n   */\n  visible?: boolean;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface OpenInWebViewAndroidOptions {\n  /**\n   * Whether or not the user can zoom the web page.\n   *\n   * @default false\n   * @since 0.1.0\n   */\n  allowZoom?: boolean;\n  /**\n   * Whether or not the hardware back button navigates back in the web view's\n   * history before closing the web view.\n   *\n   * If `false`, the hardware back button closes the web view immediately.\n   *\n   * @default true\n   * @since 0.1.0\n   */\n  hardwareBackButton?: boolean;\n  /**\n   * Whether or not media playback is paused when the app is hidden.\n   *\n   * @default true\n   * @since 0.1.0\n   */\n  pauseMediaWhenHidden?: boolean;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface OpenInWebViewIosOptions {\n  /**\n   * Whether or not horizontal swipe gestures navigate back and forward in\n   * the web view's history.\n   *\n   * @default false\n   * @since 0.1.0\n   */\n  allowsBackForwardNavigationGestures?: boolean;\n  /**\n   * Whether or not the web view bounces when scrolled past the edge of the\n   * content.\n   *\n   * @default true\n   * @since 0.1.0\n   */\n  overscroll?: boolean;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface ExecuteScriptOptions {\n  /**\n   * The JavaScript code to execute in the web view.\n   *\n   * @example 'document.title'\n   * @since 0.1.0\n   */\n  script: string;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface ExecuteScriptResult {\n  /**\n   * The result of the script execution serialized as a JSON string.\n   *\n   * If the script does not return a JSON-serializable value, `null` is\n   * returned.\n   *\n   * @example '\"Capawesome\"'\n   * @since 0.1.0\n   */\n  result: string | null;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface PostMessageOptions {\n  /**\n   * The message data to post to the web view.\n   *\n   * Must be a JSON-serializable object.\n   *\n   * @example { name: 'Capawesome' }\n   * @since 0.1.0\n   */\n  data: { [key: string]: unknown };\n}\n\n/**\n * @since 0.1.0\n */\nexport interface GetCookiesOptions {\n  /**\n   * The URL to get the cookies for.\n   *\n   * @example 'https://capawesome.io'\n   * @since 0.1.0\n   */\n  url: string;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface GetCookiesResult {\n  /**\n   * The cookies for the URL as a map of cookie names to values.\n   *\n   * @since 0.1.0\n   */\n  cookies: { [key: string]: string };\n}\n\n/**\n * @since 0.1.0\n */\nexport interface BrowserPageNavigationCompletedEvent {\n  /**\n   * The URL of the page that was navigated to.\n   *\n   * @example 'https://capawesome.io'\n   * @since 0.1.0\n   */\n  url: string;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface MessageReceivedEvent {\n  /**\n   * The message data posted by the web page.\n   *\n   * @since 0.1.0\n   */\n  data: unknown;\n}\n\n/**\n * The style of the dismiss button in the toolbar of the system browser.\n *\n * - `cancel`: A button with the text \"Cancel\".\n * - `close`: A button with the text \"Close\".\n * - `done`: A button with the text \"Done\".\n *\n * @since 0.1.0\n */\nexport type DismissButtonStyle = 'cancel' | 'close' | 'done';\n\n/**\n * The data store to use for the web view.\n *\n * - `isolated`: The web view uses a non-persistent data store. Cookies and\n *   web storage are discarded when the web view is closed.\n * - `shared`: The web view uses the app-global data store which is shared\n *   with other web views.\n *\n * @since 0.1.0\n */\nexport type WebViewDataStore = 'isolated' | 'shared';\n\n/**\n * @since 0.1.0\n */\nexport enum ErrorCode {\n  /**\n   * No app was found on the device that can open the URL.\n   *\n   * @since 0.1.0\n   */\n  BrowserNotFound = 'BROWSER_NOT_FOUND',\n  /**\n   * No browser is currently open.\n   *\n   * @since 0.1.0\n   */\n  NoBrowserOpen = 'NO_BROWSER_OPEN',\n}\n"]}

package/dist/esm/index.d.ts

@@ -0,0 +1,4 @@
+import type { InAppBrowserPlugin } from './definitions';
+declare const InAppBrowser: InAppBrowserPlugin;
+export * from './definitions';
+export { InAppBrowser };

package/dist/esm/index.js

@@ -0,0 +1,7 @@
+import { registerPlugin } from '@capacitor/core';
+const InAppBrowser = registerPlugin('InAppBrowser', {
+    web: () => import('./web').then(m => new m.InAppBrowserWeb()),
+});
+export * from './definitions';
+export { InAppBrowser };
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAIjD,MAAM,YAAY,GAAG,cAAc,CAAqB,cAAc,EAAE;IACtE,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,eAAe,EAAE,CAAC;CAC9D,CAAC,CAAC;AAEH,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,YAAY,EAAE,CAAC","sourcesContent":["import { registerPlugin } from '@capacitor/core';\n\nimport type { InAppBrowserPlugin } from './definitions';\n\nconst InAppBrowser = registerPlugin<InAppBrowserPlugin>('InAppBrowser', {\n  web: () => import('./web').then(m => new m.InAppBrowserWeb()),\n});\n\nexport * from './definitions';\nexport { InAppBrowser };\n"]}

package/dist/esm/web.d.ts

@@ -0,0 +1,14 @@
+import { WebPlugin } from '@capacitor/core';
+import type { ExecuteScriptResult, GetCookiesResult, InAppBrowserPlugin, OpenInExternalBrowserOptions } from './definitions';
+export declare class InAppBrowserWeb extends WebPlugin implements InAppBrowserPlugin {
+    private static errorUrlMissing;
+    clearCache(): Promise<void>;
+    clearSessionData(): Promise<void>;
+    close(): Promise<void>;
+    executeScript(): Promise<ExecuteScriptResult>;
+    getCookies(): Promise<GetCookiesResult>;
+    openInExternalBrowser(options: OpenInExternalBrowserOptions): Promise<void>;
+    openInSystemBrowser(): Promise<void>;
+    openInWebView(): Promise<void>;
+    postMessage(): Promise<void>;
+}

package/dist/esm/web.js

@@ -0,0 +1,35 @@
+import { WebPlugin } from '@capacitor/core';
+export class InAppBrowserWeb extends WebPlugin {
+    async clearCache() {
+        throw this.unimplemented('Not implemented on web.');
+    }
+    async clearSessionData() {
+        throw this.unimplemented('Not implemented on web.');
+    }
+    async close() {
+        throw this.unimplemented('Not implemented on web.');
+    }
+    async executeScript() {
+        throw this.unimplemented('Not implemented on web.');
+    }
+    async getCookies() {
+        throw this.unimplemented('Not implemented on web.');
+    }
+    async openInExternalBrowser(options) {
+        if (!options.url) {
+            throw new Error(InAppBrowserWeb.errorUrlMissing);
+        }
+        window.open(options.url, '_blank');
+    }
+    async openInSystemBrowser() {
+        throw this.unimplemented('Not implemented on web.');
+    }
+    async openInWebView() {
+        throw this.unimplemented('Not implemented on web.');
+    }
+    async postMessage() {
+        throw this.unimplemented('Not implemented on web.');
+    }
+}
+InAppBrowserWeb.errorUrlMissing = 'url must be provided.';
+//# sourceMappingURL=web.js.map

package/dist/esm/web.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"web.js","sourceRoot":"","sources":["../../src/web.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAS5C,MAAM,OAAO,eAAgB,SAAQ,SAAS;IAG5C,KAAK,CAAC,UAAU;QACd,MAAM,IAAI,CAAC,aAAa,CAAC,yBAAyB,CAAC,CAAC;IACtD,CAAC;IAED,KAAK,CAAC,gBAAgB;QACpB,MAAM,IAAI,CAAC,aAAa,CAAC,yBAAyB,CAAC,CAAC;IACtD,CAAC;IAED,KAAK,CAAC,KAAK;QACT,MAAM,IAAI,CAAC,aAAa,CAAC,yBAAyB,CAAC,CAAC;IACtD,CAAC;IAED,KAAK,CAAC,aAAa;QACjB,MAAM,IAAI,CAAC,aAAa,CAAC,yBAAyB,CAAC,CAAC;IACtD,CAAC;IAED,KAAK,CAAC,UAAU;QACd,MAAM,IAAI,CAAC,aAAa,CAAC,yBAAyB,CAAC,CAAC;IACtD,CAAC;IAED,KAAK,CAAC,qBAAqB,CACzB,OAAqC;QAErC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,eAAe,CAAC,CAAC;QACnD,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IACrC,CAAC;IAED,KAAK,CAAC,mBAAmB;QACvB,MAAM,IAAI,CAAC,aAAa,CAAC,yBAAyB,CAAC,CAAC;IACtD,CAAC;IAED,KAAK,CAAC,aAAa;QACjB,MAAM,IAAI,CAAC,aAAa,CAAC,yBAAyB,CAAC,CAAC;IACtD,CAAC;IAED,KAAK,CAAC,WAAW;QACf,MAAM,IAAI,CAAC,aAAa,CAAC,yBAAyB,CAAC,CAAC;IACtD,CAAC;;AAzCc,+BAAe,GAAG,uBAAuB,CAAC","sourcesContent":["import { WebPlugin } from '@capacitor/core';\n\nimport type {\n  ExecuteScriptResult,\n  GetCookiesResult,\n  InAppBrowserPlugin,\n  OpenInExternalBrowserOptions,\n} from './definitions';\n\nexport class InAppBrowserWeb extends WebPlugin implements InAppBrowserPlugin {\n  private static errorUrlMissing = 'url must be provided.';\n\n  async clearCache(): Promise<void> {\n    throw this.unimplemented('Not implemented on web.');\n  }\n\n  async clearSessionData(): Promise<void> {\n    throw this.unimplemented('Not implemented on web.');\n  }\n\n  async close(): Promise<void> {\n    throw this.unimplemented('Not implemented on web.');\n  }\n\n  async executeScript(): Promise<ExecuteScriptResult> {\n    throw this.unimplemented('Not implemented on web.');\n  }\n\n  async getCookies(): Promise<GetCookiesResult> {\n    throw this.unimplemented('Not implemented on web.');\n  }\n\n  async openInExternalBrowser(\n    options: OpenInExternalBrowserOptions,\n  ): Promise<void> {\n    if (!options.url) {\n      throw new Error(InAppBrowserWeb.errorUrlMissing);\n    }\n    window.open(options.url, '_blank');\n  }\n\n  async openInSystemBrowser(): Promise<void> {\n    throw this.unimplemented('Not implemented on web.');\n  }\n\n  async openInWebView(): Promise<void> {\n    throw this.unimplemented('Not implemented on web.');\n  }\n\n  async postMessage(): Promise<void> {\n    throw this.unimplemented('Not implemented on web.');\n  }\n}\n"]}