@capgo/capacitor-webview-crash 8.0.1 → 8.0.3

package/Package.swift

@@ -2,11 +2,11 @@
 import PackageDescription
 
 let package = Package(
-    name: "CapgoCapacitorWebViewCrash",
+    name: "CapgoCapacitorWebviewCrash",
     platforms: [.iOS(.v15)],
     products: [
         .library(
-            name: "CapgoCapacitorWebViewCrash",
+            name: "CapgoCapacitorWebviewCrash",
             targets: ["WebViewCrashPlugin"])
     ],
     dependencies: [

package/README.md

@@ -3,7 +3,7 @@
 <a href="https://capgo.app/">
   <img
     src="https://raw.githubusercontent.com/Cap-go/capgo/main/assets/capgo_banner.png"
-    alt="Capgo - Instant updates for capacitor"
+    alt="Capgo - Instant updates for Capacitor"
   />
 </a>
 
@@ -13,54 +13,25 @@
   </h2>
   <h2>
     <a href="https://capgo.app/consulting/?ref=plugin_webview_crash">
-      {' '}
       Missing a feature? We’ll build the plugin for you 💪
     </a>
   </h2>
 </div>
 
-## Snapshot
+Detect a recovered Capacitor WebView crash and give the next JavaScript runtime the native crash marker it needs to recover application state.
 
-- **Plugin name:** `WebView Crash`
-- **One-line value:** `Detect a crashed Capacitor WebView and tell the next JavaScript runtime what happened.`
-- **Maintainer:** `Capgo`
-- **Status:** `alpha`
-
-## Pre-Release Checklist
-
-- [x] Replace all template placeholders in this README.
-- [x] Replace the Capgo CTA tracking slug.
-- [x] Replace the template keywords in `package.json`.
-- [x] Remove the bootstrap-only init script from the generated plugin copy.
-- [x] Update `src/definitions.ts` with the real public API and JSDoc.
-- [ ] Set GitHub repo description to start with `Capacitor plugin for ...`.
-- [ ] Set GitHub repo homepage to `https://capgo.app/docs/plugins/webview-crash/`.
-- [ ] Open the docs/website PR for the Capgo site.
-- [ ] Run `bun run verify` on a machine with full iOS toolchain support before publishing.
-
-## Problem & Scope
-
-### Why this plugin exists
-
-A WebView renderer crash kills the current JavaScript context. After the app recovers, the next JS runtime has no built-in signal that the previous WebView died and some in-memory state may have been lost. This plugin stores that crash marker natively and exposes it to the recovered runtime.
-
-### What it does
+## What It Does
 
 - Stores a native crash marker when Android reports `onRenderProcessGone`.
-- Hooks the iOS WebView termination callback and preserves equivalent crash metadata.
-- Exposes that marker through an event, a polling method, and a simulation helper for testing.
+- Hooks the iOS WebView termination callback and persists equivalent crash metadata.
+- Exposes the marker through an event, a polling method, and a simulation helper for testing recovery flows.
+- Ships a web implementation that simulates the same recovery flow with local storage.
 
-### What it does not do
+## What It Does Not Do
 
 - Prevent the underlying WebView crash from happening.
 - Restore lost in-memory JavaScript state automatically.
 
-## Capgo Links
-
-- **Plugin docs URL:** `https://capgo.app/docs/plugins/webview-crash/`
-- **Plugin tutorial URL:** `Pending publication`
-- **Website/docs repo:** `https://github.com/Cap-go/website`
-
 ## Compatibility
 
 | Plugin version | Capacitor compatibility | Maintained |
@@ -74,18 +45,14 @@ Policy:
 - New plugins start at version `8.0.0` (Capacitor 8 baseline).
 - Backward compatibility for older Capacitor majors is supported on demand.
 
-## Template Base
-
-This repository was initialized from `Cap-go/capacitor-plugin-template` and then rewritten with the real WebView crash recovery API and native implementations.
-
 ## Install
 
 ```bash
-bun add @capgo/capacitor-webview-crash
-bunx cap sync
+npm install @capgo/capacitor-webview-crash
+npx cap sync
 ```
 
-## Minimal Usage
+## Usage
 
 ```typescript
 import { WebViewCrash } from '@capgo/capacitor-webview-crash';
@@ -101,27 +68,31 @@ if (pending.value) {
 }
 ```
 
-## Integration Notes
+Use `simulateCrashRecovery()` in development or automated tests to exercise your recovery UI without forcing a real native WebView crash.
+
+## Platform Notes
 
 - **iOS:** Uses method swizzling on Capacitor's `WebViewDelegationHandler` to persist crash metadata before Capacitor reloads the WebView. No extra permissions are required.
 - **Android:** Registers a Capacitor `WebViewListener` and persists crash metadata from `onRenderProcessGone`. No extra permissions are required.
 - **Web:** There is no real browser crash detection. The web implementation only simulates the recovery flow with local storage.
 
-## Example App
+## Documentation
 
-The `example-app/` folder is linked via `file:..` and shows the pending marker, recovery event, and simulation button for local validation.
+- [Plugin docs](https://capgo.app/docs/plugins/webview-crash/)
+- [Getting started guide](https://capgo.app/docs/plugins/webview-crash/getting-started/)
+- [Example app](./example-app)
 
 ## API
 
 <docgen-index>
 
-* [`getPendingCrashInfo()`](#getpendingcrashinfo)
-* [`clearPendingCrashInfo()`](#clearpendingcrashinfo)
-* [`simulateCrashRecovery()`](#simulatecrashrecovery)
-* [`addListener('webViewRestoredAfterCrash', ...)`](#addlistenerwebviewrestoredaftercrash-)
-* [`removeAllListeners()`](#removealllisteners)
-* [Interfaces](#interfaces)
-* [Type Aliases](#type-aliases)
+- [`getPendingCrashInfo()`](#getpendingcrashinfo)
+- [`clearPendingCrashInfo()`](#clearpendingcrashinfo)
+- [`simulateCrashRecovery()`](#simulatecrashrecovery)
+- [`addListener('webViewRestoredAfterCrash', ...)`](#addlistenerwebviewrestoredaftercrash-)
+- [`removeAllListeners()`](#removealllisteners)
+- [Interfaces](#interfaces)
+- [Type Aliases](#type-aliases)
 
 </docgen-index>
 
@@ -140,8 +111,7 @@ Returns the pending native crash marker, if one exists.
 
 **Returns:** <code>Promise&lt;<a href="#pendingcrashinforesult">PendingCrashInfoResult</a>&gt;</code>
 
---------------------
-
+---
 
 ### clearPendingCrashInfo()
 
@@ -151,8 +121,7 @@ clearPendingCrashInfo() => Promise<void>
 
 Clears the stored crash marker after the app has handled recovery.
 
---------------------
-
+---
 
 ### simulateCrashRecovery()
 
@@ -164,8 +133,7 @@ Creates a fake crash marker so recovery flows can be tested locally.
 
 **Returns:** <code>Promise&lt;<a href="#pendingcrashinforesult">PendingCrashInfoResult</a>&gt;</code>
 
---------------------
-
+---
 
 ### addListener('webViewRestoredAfterCrash', ...)
 
@@ -182,8 +150,7 @@ Fires after a new JavaScript runtime attaches a listener and a crash marker is s
 
 **Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
 
---------------------
-
+---
 
 ### removeAllListeners()
 
@@ -193,12 +160,10 @@ removeAllListeners() => Promise<void>
 
 Removes all plugin listeners.
 
---------------------
-
+---
 
 ### Interfaces
 
-
 #### PendingCrashInfoResult
 
 Pending crash marker returned to JavaScript.
@@ -207,7 +172,6 @@ Pending crash marker returned to JavaScript.
 | ----------- | --------------------------------------------------------------------- | ----------------------------------------------------------- |
 | **`value`** | <code><a href="#webviewcrashinfo">WebViewCrashInfo</a> \| null</code> | Stored crash metadata, or `null` when no marker is pending. |
 
-
 #### WebViewCrashInfo
 
 Metadata captured natively after the previous WebView process died.
@@ -223,31 +187,26 @@ Metadata captured natively after the previous WebView process died.
 | **`rendererPriorityAtExit`** | <code>number</code>                                                   | Android-only renderer priority reported at exit.                       |
 | **`appState`**               | <code><a href="#webviewcrashappstate">WebViewCrashAppState</a></code> | iOS-only application state captured when the crash marker was written. |
 
-
 #### PluginListenerHandle
 
 | Prop         | Type                                      |
 | ------------ | ----------------------------------------- |
 | **`remove`** | <code>() =&gt; Promise&lt;void&gt;</code> |
 
-
 ### Type Aliases
 
-
 #### WebViewCrashPlatform
 
 Platform that produced the stored crash marker.
 
 <code>'android' | 'ios' | 'web'</code>
 
-
 #### WebViewCrashReason
 
 Native reason reported for the previous WebView failure.
 
 <code>'renderProcessGone' | 'webContentProcessDidTerminate' | 'simulated'</code>
 
-
 #### WebViewCrashAppState
 
 Best-effort application state captured on iOS when the WebView process died.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capgo/capacitor-webview-crash",
-  "version": "8.0.1",
+  "version": "8.0.3",
   "description": "Capacitor plugin for detecting WebView crash recovery and informing the next JS runtime.",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
@@ -36,7 +36,7 @@
   ],
   "scripts": {
     "verify": "bun run verify:ios && bun run verify:android && bun run verify:web",
-    "verify:ios": "xcodebuild -scheme CapgoCapacitorWebViewCrash -destination generic/platform=iOS",
+    "verify:ios": "xcodebuild -scheme CapgoCapacitorWebviewCrash -destination generic/platform=iOS",
     "verify:android": "cd android && ./gradlew clean build test && cd ..",
     "verify:web": "bun run build && bun test",
     "test": "bun test",
@@ -45,7 +45,7 @@
     "eslint": "eslint . --ext .ts",
     "prettier": "prettier-pretty-check \"**/*.{css,html,ts,js,java,json,md}\" --plugin=prettier-plugin-java",
     "swiftlint": "node-swiftlint",
-    "docgen": "docgen --api WebViewCrashPlugin --output-readme README.md --output-json dist/docs.json",
+    "docgen": "docgen --api WebViewCrashPlugin --output-readme README.md --output-json dist/docs.json && prettier --write README.md",
     "build": "bun run clean && bun run docgen && tsc && rollup -c rollup.config.mjs",
     "clean": "rimraf ./dist",
     "watch": "tsc --watch",