@capgo/capacitor-webview-version-checker 8.0.0

package/dist/docs.json

@@ -0,0 +1,560 @@
+{
+  "api": {
+    "name": "WebviewVersionCheckerPlugin",
+    "slug": "webviewversioncheckerplugin",
+    "docs": "Public API for checking WebView freshness and guiding users to updates.",
+    "tags": [],
+    "methods": [
+      {
+        "name": "check",
+        "signature": "(options?: CheckWebViewOptions | undefined) => Promise<WebViewVersionStatus>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "CheckWebViewOptions | undefined"
+          }
+        ],
+        "returns": "Promise<WebViewVersionStatus>",
+        "tags": [],
+        "docs": "Runs a version check and returns the latest known status.",
+        "complexTypes": [
+          "WebViewVersionStatus",
+          "CheckWebViewOptions"
+        ],
+        "slug": "check"
+      },
+      {
+        "name": "startMonitoring",
+        "signature": "(options?: StartMonitoringOptions | undefined) => Promise<MonitoringStateResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "StartMonitoringOptions | undefined"
+          }
+        ],
+        "returns": "Promise<MonitoringStateResult>",
+        "tags": [],
+        "docs": "Enables background monitoring (typically on app resume).",
+        "complexTypes": [
+          "MonitoringStateResult",
+          "StartMonitoringOptions"
+        ],
+        "slug": "startmonitoring"
+      },
+      {
+        "name": "stopMonitoring",
+        "signature": "() => Promise<MonitoringStateResult>",
+        "parameters": [],
+        "returns": "Promise<MonitoringStateResult>",
+        "tags": [],
+        "docs": "Disables monitoring.",
+        "complexTypes": [
+          "MonitoringStateResult"
+        ],
+        "slug": "stopmonitoring"
+      },
+      {
+        "name": "getLastStatus",
+        "signature": "() => Promise<LastStatusResult>",
+        "parameters": [],
+        "returns": "Promise<LastStatusResult>",
+        "tags": [],
+        "docs": "Returns the last resolved status, or `null` if no check was run yet.",
+        "complexTypes": [
+          "LastStatusResult"
+        ],
+        "slug": "getlaststatus"
+      },
+      {
+        "name": "showUpdatePrompt",
+        "signature": "(options?: ShowUpdatePromptOptions | undefined) => Promise<ShowUpdatePromptResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "ShowUpdatePromptOptions | undefined"
+          }
+        ],
+        "returns": "Promise<ShowUpdatePromptResult>",
+        "tags": [],
+        "docs": "Shows a native prompt asking the user to update the WebView.",
+        "complexTypes": [
+          "ShowUpdatePromptResult",
+          "ShowUpdatePromptOptions"
+        ],
+        "slug": "showupdateprompt"
+      },
+      {
+        "name": "openUpdatePage",
+        "signature": "(options?: OpenUpdatePageOptions | undefined) => Promise<OpenUpdatePageResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "OpenUpdatePageOptions | undefined"
+          }
+        ],
+        "returns": "Promise<OpenUpdatePageResult>",
+        "tags": [],
+        "docs": "Opens the configured update page directly.",
+        "complexTypes": [
+          "OpenUpdatePageResult",
+          "OpenUpdatePageOptions"
+        ],
+        "slug": "openupdatepage"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'statusChanged', listenerFunc: (status: WebViewVersionStatus) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'statusChanged'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(status: WebViewVersionStatus) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [],
+        "docs": "Fired for every successful status evaluation.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "WebViewVersionStatus"
+        ],
+        "slug": "addlistenerstatuschanged-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'webViewLatest', listenerFunc: (status: WebViewVersionStatus) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'webViewLatest'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(status: WebViewVersionStatus) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [],
+        "docs": "Fired when the state resolves to `latest`.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "WebViewVersionStatus"
+        ],
+        "slug": "addlistenerwebviewlatest-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'webViewOutdated', listenerFunc: (status: WebViewVersionStatus) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'webViewOutdated'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(status: WebViewVersionStatus) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [],
+        "docs": "Fired when the state resolves to `outdated`.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "WebViewVersionStatus"
+        ],
+        "slug": "addlistenerwebviewoutdated-"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "WebViewVersionStatus",
+      "slug": "webviewversionstatus",
+      "docs": "Snapshot of the currently detected WebView status.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "platform",
+          "tags": [],
+          "docs": "Native platform that generated the status.",
+          "complexTypes": [
+            "WebViewPlatform"
+          ],
+          "type": "WebViewPlatform"
+        },
+        {
+          "name": "state",
+          "tags": [],
+          "docs": "Resolved version state.",
+          "complexTypes": [
+            "WebViewVersionState"
+          ],
+          "type": "WebViewVersionState"
+        },
+        {
+          "name": "isLatest",
+          "tags": [],
+          "docs": "Convenience boolean equivalent to `state === 'latest'`.",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "checkedAt",
+          "tags": [],
+          "docs": "ISO-8601 timestamp of the check.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "reason",
+          "tags": [],
+          "docs": "Human-readable explanation for the reported state.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "currentVersion",
+          "tags": [],
+          "docs": "Current WebView (or iOS system WebKit) version string.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "currentMajorVersion",
+          "tags": [],
+          "docs": "Current detected major version (if parseable).",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "latestVersion",
+          "tags": [],
+          "docs": "Resolved latest version used for comparison.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "latestMajorVersion",
+          "tags": [],
+          "docs": "Resolved latest major version (if parseable).",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "providerPackage",
+          "tags": [],
+          "docs": "Android package name of the active WebView provider.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "updateUrl",
+          "tags": [],
+          "docs": "URL that should be opened to update when outdated.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "source",
+          "tags": [],
+          "docs": "Internal source identifier for the check implementation.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "CheckWebViewOptions",
+      "slug": "checkwebviewoptions",
+      "docs": "Options for running a WebView version check.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "showPromptOnOutdated",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            }
+          ],
+          "docs": "Force showing a native prompt if an outdated WebView is detected.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "source",
+          "tags": [
+            {
+              "text": "\"manual\"",
+              "name": "default"
+            }
+          ],
+          "docs": "Optional tag included in the status payload so you can identify the check origin.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "MonitoringStateResult",
+      "slug": "monitoringstateresult",
+      "docs": "Result payload for monitor controls.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "monitoring",
+          "tags": [],
+          "docs": "Whether monitoring is currently active.",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "checkOnResume",
+          "tags": [],
+          "docs": "Whether checks run on app resume while monitoring is active.",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "autoPromptOnOutdated",
+          "tags": [],
+          "docs": "Whether outdated checks auto-trigger the native prompt.",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
+    {
+      "name": "StartMonitoringOptions",
+      "slug": "startmonitoringoptions",
+      "docs": "Options for starting monitor mode.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "checkOnStart",
+          "tags": [
+            {
+              "text": "true",
+              "name": "default"
+            }
+          ],
+          "docs": "Run a check immediately when monitoring starts.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "checkOnResume",
+          "tags": [
+            {
+              "text": "true",
+              "name": "default"
+            }
+          ],
+          "docs": "Whether foreground checks should run while monitoring is enabled.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        }
+      ]
+    },
+    {
+      "name": "LastStatusResult",
+      "slug": "laststatusresult",
+      "docs": "Last known check snapshot.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "status",
+          "tags": [],
+          "docs": "Null until the first check completes.",
+          "complexTypes": [
+            "WebViewVersionStatus"
+          ],
+          "type": "WebViewVersionStatus | null"
+        }
+      ]
+    },
+    {
+      "name": "ShowUpdatePromptResult",
+      "slug": "showupdatepromptresult",
+      "docs": "Result payload for `showUpdatePrompt()`.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "shown",
+          "tags": [],
+          "docs": "Whether a native prompt was actually shown.",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "openedUpdatePage",
+          "tags": [],
+          "docs": "Whether the update page was opened from the prompt action.",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
+    {
+      "name": "ShowUpdatePromptOptions",
+      "slug": "showupdatepromptoptions",
+      "docs": "Options for showing the native update prompt.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "title",
+          "tags": [],
+          "docs": "Prompt title.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "message",
+          "tags": [],
+          "docs": "Prompt message.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "updateButtonText",
+          "tags": [],
+          "docs": "Update CTA label.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "cancelButtonText",
+          "tags": [],
+          "docs": "Cancel CTA label.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "updateUrl",
+          "tags": [],
+          "docs": "Optional URL to open if the update action is selected.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "OpenUpdatePageResult",
+      "slug": "openupdatepageresult",
+      "docs": "Result payload for `openUpdatePage()`.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "opened",
+          "tags": [],
+          "docs": "Whether opening the update URL succeeded.",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "url",
+          "tags": [],
+          "docs": "URL that was attempted.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "OpenUpdatePageOptions",
+      "slug": "openupdatepageoptions",
+      "docs": "Options for opening the update page directly.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "updateUrl",
+          "tags": [],
+          "docs": "Optional URL override.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "PluginListenerHandle",
+      "slug": "pluginlistenerhandle",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "remove",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "() => Promise<void>"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [
+    {
+      "name": "WebViewPlatform",
+      "slug": "webviewplatform",
+      "docs": "",
+      "types": [
+        {
+          "text": "'android'",
+          "complexTypes": []
+        },
+        {
+          "text": "'ios'",
+          "complexTypes": []
+        },
+        {
+          "text": "'web'",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "WebViewVersionState",
+      "slug": "webviewversionstate",
+      "docs": "",
+      "types": [
+        {
+          "text": "'latest'",
+          "complexTypes": []
+        },
+        {
+          "text": "'outdated'",
+          "complexTypes": []
+        },
+        {
+          "text": "'unknown'",
+          "complexTypes": []
+        }
+      ]
+    }
+  ],
+  "pluginConfigs": []
+}