@capgo/inappbrowser 0.0.2 → 0.0.3

package/README.md

@@ -17,7 +17,10 @@ npx cap sync
 * [`close()`](#close)
 * [`openWebView(...)`](#openwebview)
 * [`setUrl(...)`](#seturl)
+* [`addListener('urlChangeEvent', ...)`](#addlistenerurlchangeevent)
+* [`addListener('confirmBtnClicked', ...)`](#addlistenerconfirmbtnclicked)
 * [Interfaces](#interfaces)
+* [Type Aliases](#type-aliases)
 * [Enums](#enums)
 
 </docgen-index>
@@ -81,6 +84,46 @@ setUrl(url: string) => Promise<any>
 --------------------
 
 
+### addListener('urlChangeEvent', ...)
+
+```typescript
+addListener(eventName: 'urlChangeEvent', listenerFunc: UrlChangeListener) => Promise<PluginListenerHandle> & PluginListenerHandle
+```
+
+Listen for url change
+
+| Param              | Type                                                            |
+| ------------------ | --------------------------------------------------------------- |
+| **`eventName`**    | <code>'urlChangeEvent'</code>                                   |
+| **`listenerFunc`** | <code><a href="#urlchangelistener">UrlChangeListener</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt; & <a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
+
+**Since:** 0.0.1
+
+--------------------
+
+
+### addListener('confirmBtnClicked', ...)
+
+```typescript
+addListener(eventName: 'confirmBtnClicked', listenerFunc: ConfirmBtnListener) => Promise<PluginListenerHandle> & PluginListenerHandle
+```
+
+Will be triggered when user clicks on confirm button when disclaimer is required, works only on iOS
+
+| Param              | Type                                                              |
+| ------------------ | ----------------------------------------------------------------- |
+| **`eventName`**    | <code>'confirmBtnClicked'</code>                                  |
+| **`listenerFunc`** | <code><a href="#confirmbtnlistener">ConfirmBtnListener</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt; & <a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
+
+**Since:** 0.0.1
+
+--------------------
+
+
 ### Interfaces
 
 
@@ -119,6 +162,40 @@ setUrl(url: string) => Promise<any>
 | **`cancelBtn`**  | <code>string</code> |
 
 
+#### PluginListenerHandle
+
+| Prop         | Type                                      |
+| ------------ | ----------------------------------------- |
+| **`remove`** | <code>() =&gt; Promise&lt;void&gt;</code> |
+
+
+#### UrlEvent
+
+| Prop      | Type                | Description               | Since |
+| --------- | ------------------- | ------------------------- | ----- |
+| **`url`** | <code>string</code> | Emit when the url changes | 0.0.1 |
+
+
+#### BtnEvent
+
+| Prop      | Type                | Description                    | Since |
+| --------- | ------------------- | ------------------------------ | ----- |
+| **`url`** | <code>string</code> | Emit when a button is clicked. | 0.0.1 |
+
+
+### Type Aliases
+
+
+#### UrlChangeListener
+
+<code>(state: <a href="#urlevent">UrlEvent</a>): void</code>
+
+
+#### ConfirmBtnListener
+
+<code>(state: <a href="#btnevent">BtnEvent</a>): void</code>
+
+
 ### Enums
 
 

package/dist/docs.json

@@ -66,6 +66,64 @@
         "docs": "",
         "complexTypes": [],
         "slug": "seturl"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'urlChangeEvent', listenerFunc: UrlChangeListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'urlChangeEvent'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "UrlChangeListener"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Listen for url change",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "UrlChangeListener"
+        ],
+        "slug": "addlistenerurlchangeevent"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'confirmBtnClicked', listenerFunc: ConfirmBtnListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'confirmBtnClicked'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "ConfirmBtnListener"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.0.1"
+          }
+        ],
+        "docs": "Will be triggered when user clicks on confirm button when disclaimer is required, works only on iOS",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "ConfirmBtnListener"
+        ],
+        "slug": "addlistenerconfirmbtnclicked"
       }
     ],
     "properties": []
@@ -211,6 +269,64 @@
           "type": "string"
         }
       ]
+    },
+    {
+      "name": "PluginListenerHandle",
+      "slug": "pluginlistenerhandle",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "remove",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "() => Promise<void>"
+        }
+      ]
+    },
+    {
+      "name": "UrlEvent",
+      "slug": "urlevent",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "url",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Emit when the url changes",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "BtnEvent",
+      "slug": "btnevent",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "url",
+          "tags": [
+            {
+              "text": "0.0.1",
+              "name": "since"
+            }
+          ],
+          "docs": "Emit when a button is clicked.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
     }
   ],
   "enums": [
@@ -245,6 +361,33 @@
       ]
     }
   ],
-  "typeAliases": [],
+  "typeAliases": [
+    {
+      "name": "UrlChangeListener",
+      "slug": "urlchangelistener",
+      "docs": "",
+      "types": [
+        {
+          "text": "(state: UrlEvent): void",
+          "complexTypes": [
+            "UrlEvent"
+          ]
+        }
+      ]
+    },
+    {
+      "name": "ConfirmBtnListener",
+      "slug": "confirmbtnlistener",
+      "docs": "",
+      "types": [
+        {
+          "text": "(state: BtnEvent): void",
+          "complexTypes": [
+            "BtnEvent"
+          ]
+        }
+      ]
+    }
+  ],
   "pluginConfigs": []
 }

package/dist/esm/definitions.d.ts

@@ -1,3 +1,22 @@
+import type { PluginListenerHandle } from '@capacitor/core';
+export interface UrlEvent {
+    /**
+     * Emit when the url changes
+     *
+     * @since 0.0.1
+     */
+    url: string;
+}
+export interface BtnEvent {
+    /**
+     * Emit when a button is clicked.
+     *
+     * @since 0.0.1
+     */
+    url: string;
+}
+export declare type UrlChangeListener = (state: UrlEvent) => void;
+export declare type ConfirmBtnListener = (state: BtnEvent) => void;
 export declare enum ToolBarType {
     ACTIVITY = "activity",
     NAVIGATION = "navigation",
@@ -32,4 +51,16 @@ export interface InAppBrowserPlugin {
     close(): Promise<any>;
     openWebView(options: OpenWebViewOptions): Promise<any>;
     setUrl(url: string): Promise<any>;
+    /**
+     * Listen for url change
+     *
+     * @since 0.0.1
+     */
+    addListener(eventName: 'urlChangeEvent', listenerFunc: UrlChangeListener): Promise<PluginListenerHandle> & PluginListenerHandle;
+    /**
+     * Will be triggered when user clicks on confirm button when disclaimer is required, works only on iOS
+     *
+     * @since 0.0.1
+     */
+    addListener(eventName: 'confirmBtnClicked', listenerFunc: ConfirmBtnListener): Promise<PluginListenerHandle> & PluginListenerHandle;
 }

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAAA,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":["export 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 OpenOptions {\n  url: string;\n  headers?: Headers;\n  isPresentAfterPageLoad?: boolean;\n}\n\nexport interface DisclaimerOptions {\n  title: string;\n  message: string;\n  confirmBtn: string;\n  cancelBtn: string;\n}\n\nexport interface OpenWebViewOptions {\n  url: string;\n  headers?: Headers;\n  shareDisclaimer?: DisclaimerOptions;\n  toolbarType?: ToolBarType;\n  shareSubject?: string;\n  title: string;\n  isPresentAfterPageLoad?: boolean;\n}\nexport interface InAppBrowserPlugin {\n  open(options: OpenOptions): Promise<any>;\n  close(): Promise<any>;\n  openWebView(options: OpenWebViewOptions): Promise<any>;\n  setUrl(url: string): Promise<any>;\n}\n"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAsBA,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 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 OpenOptions {\n  url: string;\n  headers?: Headers;\n  isPresentAfterPageLoad?: boolean;\n}\n\nexport interface DisclaimerOptions {\n  title: string;\n  message: string;\n  confirmBtn: string;\n  cancelBtn: string;\n}\n\nexport interface OpenWebViewOptions {\n  url: string;\n  headers?: Headers;\n  shareDisclaimer?: DisclaimerOptions;\n  toolbarType?: ToolBarType;\n  shareSubject?: string;\n  title: string;\n  isPresentAfterPageLoad?: boolean;\n}\n\n// CapBrowser.addListener(\"urlChangeEvent\", (info:  any) => {\n//   console.log(info.url)\n// })\n\n// CapBrowser.addListener(\"confirmBtnClicked\", (info:  any) => {\n//   // will be triggered when user clicks on confirm button when disclaimer is required, works only on iOS\n//   console.log(info.url)\n// })\nexport interface InAppBrowserPlugin {\n  open(options: OpenOptions): Promise<any>;\n  close(): Promise<any>;\n  openWebView(options: OpenWebViewOptions): Promise<any>;\n  setUrl(url: string): Promise<any>;\n  /**\n   * Listen for url change \n   *\n   * @since 0.0.1\n   */\n  addListener(\n    eventName: 'urlChangeEvent',\n    listenerFunc: UrlChangeListener,\n  ): Promise<PluginListenerHandle> & 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> & PluginListenerHandle;\n}\n"]}

package/ios/Plugin/InAppBrowserPlugin.swift

@@ -26,8 +26,8 @@ public class InAppBrowserPlugin: CAPPlugin {
     }
     
     func presentView() {
-        self.bridge.viewController.present(self.navigationWebViewController!, animated: true, completion: {
-            self.currentPluginCall?.success()
+        self.bridge?.viewController?.present(self.navigationWebViewController!, animated: true, completion: {
+            self.currentPluginCall?.resolve()
         })
     }
     
@@ -38,34 +38,34 @@ public class InAppBrowserPlugin: CAPPlugin {
         self.currentPluginCall = call
         
         guard let urlString = call.getString("url") else {
-            call.error("Must provide a URL to open")
+            call.reject("Must provide a URL to open")
             return
         }
         
         if urlString.isEmpty {
-            call.error("URL must not be empty")
+            call.reject("URL must not be empty")
             return
         }
         
-        let headers = call.get("headers", [String: String].self, [:])
+        let headers = call.getObject("headers", [:]).mapValues { String(describing: $0 as Any) }
         
-        var disclaimerContent = call.getObject("shareDisclaimer", defaultValue: nil)
+        var disclaimerContent = call.getObject("shareDisclaimer")
         let toolbarType = call.getString("toolbarType")
         if toolbarType != "activity" {
             disclaimerContent = nil
         }
         
-        self.isPresentAfterPageLoad = call.getBool("isPresentAfterPageLoad", false) ?? false
+        self.isPresentAfterPageLoad = call.getBool("isPresentAfterPageLoad", false)
         
         DispatchQueue.main.async {
             let url = URL(string: urlString)
             let webViewController: WKWebViewController?
             
             if self.isPresentAfterPageLoad {
-                webViewController = WKWebViewController.init(url: url!, headers: headers ?? [:])
+                webViewController = WKWebViewController.init(url: url!, headers: headers)
             } else {
                 webViewController = WKWebViewController.init()
-                webViewController?.setHeaders(headers: headers ?? [:])
+                webViewController?.setHeaders(headers: headers)
             }
             
             webViewController?.source = .remote(url!)
@@ -104,7 +104,7 @@ public class InAppBrowserPlugin: CAPPlugin {
     }
     
     @objc func setUrl(_ call: CAPPluginCall) {
-        call.success()
+        call.resolve()
     }
 
     @objc func open(_ call: CAPPluginCall) {
@@ -115,28 +115,28 @@ public class InAppBrowserPlugin: CAPPlugin {
         self.currentPluginCall = call
         
         guard let urlString = call.getString("url") else {
-            call.error("Must provide a URL to open")
+            call.reject("Must provide a URL to open")
             return
         }
         
         if urlString.isEmpty {
-            call.error("URL must not be empty")
+            call.reject("URL must not be empty")
             return
         }
         
-        let headers = call.get("headers", [String: String].self, [:])
+        let headers = call.getObject("headers", [:]).mapValues { String(describing: $0 as Any) }
         
-        self.isPresentAfterPageLoad = call.getBool("isPresentAfterPageLoad", false) ?? false
+        self.isPresentAfterPageLoad = call.getBool("isPresentAfterPageLoad", false)
         
         DispatchQueue.main.async {
             let url = URL(string: urlString)
             let webViewController: WKWebViewController?
             
             if self.isPresentAfterPageLoad {
-                webViewController = WKWebViewController.init(url: url!, headers: headers ?? [:])
+                webViewController = WKWebViewController.init(url: url!, headers: headers)
             } else {
                 webViewController = WKWebViewController.init()
-                webViewController?.setHeaders(headers: headers ?? [:])
+                webViewController?.setHeaders(headers: headers)
             }
             
             webViewController?.source = .remote(url!)
@@ -159,7 +159,7 @@ public class InAppBrowserPlugin: CAPPlugin {
     @objc func close(_ call: CAPPluginCall) {
         DispatchQueue.main.async {
          self.navigationWebViewController?.dismiss(animated: true, completion: nil)
-         call.success()
+         call.resolve()
         }
     }
     

package/ios/Plugin/WKWebViewController.swift

@@ -67,7 +67,7 @@ open class WKWebViewController: UIViewController {
     open var bypassedSSLHosts: [String]?
     open var cookies: [HTTPCookie]?
     open var headers: [String: String]?
-    open var capBrowserPlugin: CapBrowser?
+    open var capBrowserPlugin: InAppBrowserPlugin?
     var shareDisclaimer: [String: Any]?
     var shareSubject: String?
     var didpageInit = false
@@ -322,7 +322,7 @@ open class WKWebViewController: UIViewController {
                 self.navigationItem.title = webView?.url?.host
             }
         case "URL":
-            self.capBrowserPlugin?.notifyListeners("urlChangeEvent", data: ["url" : webView?.url?.absoluteString])
+            self.capBrowserPlugin?.notifyListeners("urlChangeEvent", data: ["url" : webView?.url?.absoluteString ?? ""])
         default:
             super.observeValue(forKeyPath: keyPath, of: object, change: change, context: context)
         }
@@ -583,7 +583,8 @@ fileprivate extension WKWebViewController {
     func openURLWithApp(_ url: URL) -> Bool {
         let application = UIApplication.shared
         if application.canOpenURL(url) {
-            return application.openURL(url)
+            application.open(url, options: [:], completionHandler: nil)
+            return true
         }
         
         return false

package/package.json

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