@capgo/inappbrowser 6.0.0 → 6.0.3

package/dist/docs.json

@@ -7,7 +7,7 @@
     "methods": [
       {
         "name": "open",
-        "signature": "(options: OpenOptions) => any",
+        "signature": "(options: OpenOptions) => Promise<any>",
         "parameters": [
           {
             "name": "options",
@@ -15,7 +15,7 @@
             "type": "OpenOptions"
           }
         ],
-        "returns": "any",
+        "returns": "Promise<any>",
         "tags": [
           {
             "name": "since",
@@ -30,24 +30,60 @@
       },
       {
         "name": "clearCookies",
-        "signature": "() => any",
-        "parameters": [],
-        "returns": "any",
+        "signature": "(options: ClearCookieOptions) => Promise<any>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "ClearCookieOptions"
+          }
+        ],
+        "returns": "Promise<any>",
         "tags": [
           {
             "name": "since",
             "text": "0.5.0"
           }
         ],
-        "docs": "Clear all cookies",
-        "complexTypes": [],
+        "docs": "Clear cookies of url",
+        "complexTypes": [
+          "ClearCookieOptions"
+        ],
         "slug": "clearcookies"
       },
+      {
+        "name": "getCookies",
+        "signature": "(options: GetCookieOptions) => Promise<Record<string, string>>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "The options, including the URL to get cookies for.",
+            "type": "GetCookieOptions"
+          }
+        ],
+        "returns": "Promise<Record<string, string>>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options The options, including the URL to get cookies for."
+          },
+          {
+            "name": "returns",
+            "text": "A promise that resolves with the cookies."
+          }
+        ],
+        "docs": "Get cookies for a specific URL.",
+        "complexTypes": [
+          "Record",
+          "GetCookieOptions"
+        ],
+        "slug": "getcookies"
+      },
       {
         "name": "close",
-        "signature": "() => any",
+        "signature": "() => Promise<any>",
         "parameters": [],
-        "returns": "any",
+        "returns": "Promise<any>",
         "tags": [],
         "docs": "",
         "complexTypes": [],
@@ -55,7 +91,7 @@
       },
       {
         "name": "openWebView",
-        "signature": "(options: OpenWebViewOptions) => any",
+        "signature": "(options: OpenWebViewOptions) => Promise<any>",
         "parameters": [
           {
             "name": "options",
@@ -63,7 +99,7 @@
             "type": "OpenWebViewOptions"
           }
         ],
-        "returns": "any",
+        "returns": "Promise<any>",
         "tags": [
           {
             "name": "since",
@@ -76,9 +112,25 @@
         ],
         "slug": "openwebview"
       },
+      {
+        "name": "executeScript",
+        "signature": "({ code }: { code: string; }) => Promise<void>",
+        "parameters": [
+          {
+            "name": "__0",
+            "docs": "",
+            "type": "{ code: string; }"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Injects JavaScript code into the InAppBrowser window.",
+        "complexTypes": [],
+        "slug": "executescript"
+      },
       {
         "name": "setUrl",
-        "signature": "(options: { url: string; }) => any",
+        "signature": "(options: { url: string; }) => Promise<any>",
         "parameters": [
           {
             "name": "options",
@@ -86,7 +138,7 @@
             "type": "{ url: string; }"
           }
         ],
-        "returns": "any",
+        "returns": "Promise<any>",
         "tags": [],
         "docs": "",
         "complexTypes": [],
@@ -94,7 +146,7 @@
       },
       {
         "name": "addListener",
-        "signature": "(eventName: \"urlChangeEvent\", listenerFunc: UrlChangeListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
+        "signature": "(eventName: \"urlChangeEvent\", listenerFunc: UrlChangeListener) => Promise<PluginListenerHandle>",
         "parameters": [
           {
             "name": "eventName",
@@ -107,23 +159,23 @@
             "type": "UrlChangeListener"
           }
         ],
-        "returns": "any",
+        "returns": "Promise<PluginListenerHandle>",
         "tags": [
           {
             "name": "since",
             "text": "0.0.1"
           }
         ],
-        "docs": "Listen for url change",
+        "docs": "Listen for url change, only for openWebView",
         "complexTypes": [
-          "UrlChangeListener",
-          "PluginListenerHandle"
+          "PluginListenerHandle",
+          "UrlChangeListener"
         ],
-        "slug": "addlistenerurlchangeevent"
+        "slug": "addlistenerurlchangeevent-"
       },
       {
         "name": "addListener",
-        "signature": "(eventName: \"closeEvent\", listenerFunc: UrlChangeListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
+        "signature": "(eventName: \"closeEvent\", listenerFunc: UrlChangeListener) => Promise<PluginListenerHandle>",
         "parameters": [
           {
             "name": "eventName",
@@ -136,23 +188,23 @@
             "type": "UrlChangeListener"
           }
         ],
-        "returns": "any",
+        "returns": "Promise<PluginListenerHandle>",
         "tags": [
           {
             "name": "since",
             "text": "0.4.0"
           }
         ],
-        "docs": "Listen for close click",
+        "docs": "Listen for close click only for openWebView",
         "complexTypes": [
-          "UrlChangeListener",
-          "PluginListenerHandle"
+          "PluginListenerHandle",
+          "UrlChangeListener"
         ],
-        "slug": "addlistenercloseevent"
+        "slug": "addlistenercloseevent-"
       },
       {
         "name": "addListener",
-        "signature": "(eventName: \"confirmBtnClicked\", listenerFunc: ConfirmBtnListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
+        "signature": "(eventName: \"confirmBtnClicked\", listenerFunc: ConfirmBtnListener) => Promise<PluginListenerHandle>",
         "parameters": [
           {
             "name": "eventName",
@@ -165,7 +217,7 @@
             "type": "ConfirmBtnListener"
           }
         ],
-        "returns": "any",
+        "returns": "Promise<PluginListenerHandle>",
         "tags": [
           {
             "name": "since",
@@ -174,16 +226,16 @@
         ],
         "docs": "Will be triggered when user clicks on confirm button when disclaimer is required, works only on iOS",
         "complexTypes": [
-          "ConfirmBtnListener",
-          "PluginListenerHandle"
+          "PluginListenerHandle",
+          "ConfirmBtnListener"
         ],
-        "slug": "addlistenerconfirmbtnclicked"
+        "slug": "addlistenerconfirmbtnclicked-"
       },
       {
         "name": "removeAllListeners",
-        "signature": "() => any",
+        "signature": "() => Promise<void>",
         "parameters": [],
-        "returns": "any",
+        "returns": "Promise<void>",
         "tags": [
           {
             "name": "since",
@@ -193,6 +245,21 @@
         "docs": "Remove all listeners for this plugin.",
         "complexTypes": [],
         "slug": "removealllisteners"
+      },
+      {
+        "name": "reload",
+        "signature": "() => Promise<any>",
+        "parameters": [],
+        "returns": "Promise<any>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "1.0.0"
+          }
+        ],
+        "docs": "Reload the current web page.",
+        "complexTypes": [],
+        "slug": "reload"
       }
     ],
     "properties": []
@@ -260,6 +327,82 @@
       "methods": [],
       "properties": []
     },
+    {
+      "name": "ClearCookieOptions",
+      "slug": "clearcookieoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "url",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "cache",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        }
+      ]
+    },
+    {
+      "name": "HttpCookie",
+      "slug": "httpcookie",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "url",
+          "tags": [],
+          "docs": "The URL of the cookie.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "key",
+          "tags": [],
+          "docs": "The key of the cookie.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "value",
+          "tags": [],
+          "docs": "The value of the cookie.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "GetCookieOptions",
+      "slug": "getcookieoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "url",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "includeHttpOnly",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        }
+      ]
+    },
     {
       "name": "OpenWebViewOptions",
       "slug": "openwebviewoptions",
@@ -351,7 +494,7 @@
           ],
           "docs": "Title of the browser",
           "complexTypes": [],
-          "type": "string"
+          "type": "string | undefined"
         },
         {
           "name": "backgroundColor",
@@ -371,6 +514,30 @@
           ],
           "type": "BackgroundColor"
         },
+        {
+          "name": "activeNativeNavigationForWebview",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            }
+          ],
+          "docs": "If true, active the native navigation within the webview, Android only",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "disableGoBackOnNativeApplication",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            }
+          ],
+          "docs": "Disable the possibility to go back on native application,\nusefull to force user to stay on the webview, Android only",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
         {
           "name": "isPresentAfterPageLoad",
           "tags": [
@@ -386,6 +553,174 @@
           "docs": "Open url in a new window fullscreen\n\nisPresentAfterPageLoad: if true, the browser will be presented after the page is loaded, if false, the browser will be presented immediately.",
           "complexTypes": [],
           "type": "boolean | undefined"
+        },
+        {
+          "name": "isInspectable",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            }
+          ],
+          "docs": "Whether the website in the webview is inspectable or not, ios only",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "isAnimated",
+          "tags": [
+            {
+              "text": "true",
+              "name": "default"
+            }
+          ],
+          "docs": "Whether the webview opening is animated or not, ios only",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "showReloadButton",
+          "tags": [
+            {
+              "text": "1.0.15",
+              "name": "since"
+            },
+            {
+              "text": "false",
+              "name": "default"
+            }
+          ],
+          "docs": "Shows a reload button that reloads the web page",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "closeModal",
+          "tags": [
+            {
+              "text": "1.1.0",
+              "name": "since"
+            },
+            {
+              "text": "false",
+              "name": "default"
+            }
+          ],
+          "docs": "CloseModal: if true a confirm will be displayed when user clicks on close button, if false the browser will be closed immediately.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "closeModalTitle",
+          "tags": [
+            {
+              "text": "1.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'Close'",
+              "name": "default"
+            }
+          ],
+          "docs": "CloseModalTitle: title of the confirm when user clicks on close button, only on IOS",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "closeModalDescription",
+          "tags": [
+            {
+              "text": "1.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'Are you sure you want to close this window?'",
+              "name": "default"
+            }
+          ],
+          "docs": "CloseModalDescription: description of the confirm when user clicks on close button, only on IOS",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "closeModalOk",
+          "tags": [
+            {
+              "text": "1.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'Close'",
+              "name": "default"
+            }
+          ],
+          "docs": "CloseModalOk: text of the confirm button when user clicks on close button, only on IOS",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "closeModalCancel",
+          "tags": [
+            {
+              "text": "1.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'Cancel'",
+              "name": "default"
+            }
+          ],
+          "docs": "CloseModalCancel: text of the cancel button when user clicks on close button, only on IOS",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "visibleTitle",
+          "tags": [
+            {
+              "text": "1.2.5",
+              "name": "since"
+            },
+            {
+              "text": "true",
+              "name": "default"
+            }
+          ],
+          "docs": "visibleTitle: if true the website title would be shown else shown empty",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "toolbarColor",
+          "tags": [
+            {
+              "text": "1.2.5",
+              "name": "since"
+            },
+            {
+              "text": "'#ffffff''",
+              "name": "default"
+            }
+          ],
+          "docs": "toolbarColor: color of the toolbar in hex format",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "showArrow",
+          "tags": [
+            {
+              "text": "1.2.5",
+              "name": "since"
+            },
+            {
+              "text": "false",
+              "name": "default"
+            }
+          ],
+          "docs": "showArrow: if true an arrow would be shown instead of cross for closing the window",
+          "complexTypes": [],
+          "type": "boolean | undefined"
         }
       ]
     },
@@ -426,6 +761,22 @@
         }
       ]
     },
+    {
+      "name": "PluginListenerHandle",
+      "slug": "pluginlistenerhandle",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "remove",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "() => Promise<void>"
+        }
+      ]
+    },
     {
       "name": "UrlEvent",
       "slug": "urlevent",
@@ -447,22 +798,6 @@
         }
       ]
     },
-    {
-      "name": "PluginListenerHandle",
-      "slug": "pluginlistenerhandle",
-      "docs": "",
-      "tags": [],
-      "methods": [],
-      "properties": [
-        {
-          "name": "remove",
-          "tags": [],
-          "docs": "",
-          "complexTypes": [],
-          "type": "() => any"
-        }
-      ]
-    },
     {
       "name": "BtnEvent",
       "slug": "btnevent",
@@ -536,6 +871,93 @@
     }
   ],
   "typeAliases": [
+    {
+      "name": "ClearCookieOptions",
+      "slug": "clearcookieoptions",
+      "docs": "",
+      "types": [
+        {
+          "text": "Omit<HttpCookie, 'key' | 'value'>",
+          "complexTypes": [
+            "Omit",
+            "HttpCookie"
+          ]
+        }
+      ]
+    },
+    {
+      "name": "Omit",
+      "slug": "omit",
+      "docs": "Construct a type with the properties of T except for those in type K.",
+      "types": [
+        {
+          "text": "Pick<T, Exclude<keyof T, K>>",
+          "complexTypes": [
+            "Pick",
+            "T",
+            "Exclude",
+            "K"
+          ]
+        }
+      ]
+    },
+    {
+      "name": "Pick",
+      "slug": "pick",
+      "docs": "From T, pick a set of properties whose keys are in the union K",
+      "types": [
+        {
+          "text": "{\r\n    [P in K]: T[P];\r\n}",
+          "complexTypes": [
+            "K",
+            "T",
+            "P"
+          ]
+        }
+      ]
+    },
+    {
+      "name": "Exclude",
+      "slug": "exclude",
+      "docs": "Exclude from T those types that are assignable to U",
+      "types": [
+        {
+          "text": "T extends U ? never : T",
+          "complexTypes": [
+            "T",
+            "U"
+          ]
+        }
+      ]
+    },
+    {
+      "name": "Record",
+      "slug": "record",
+      "docs": "Construct a type with a set of properties K of type T",
+      "types": [
+        {
+          "text": "{\r\n    [P in K]: T;\r\n}",
+          "complexTypes": [
+            "K",
+            "T"
+          ]
+        }
+      ]
+    },
+    {
+      "name": "GetCookieOptions",
+      "slug": "getcookieoptions",
+      "docs": "",
+      "types": [
+        {
+          "text": "Omit<HttpCookie, 'key' | 'value'>",
+          "complexTypes": [
+            "Omit",
+            "HttpCookie"
+          ]
+        }
+      ]
+    },
     {
       "name": "UrlChangeListener",
       "slug": "urlchangelistener",