@broberg/pwa 0.2.1 → 0.2.2

package/dist/react.d.cts

@@ -0,0 +1,67 @@
+import * as react from 'react';
+
+interface PwaUpdaterOptions {
+    /** Service-worker script URL to register. Default `/sw.js`. */
+    swUrl?: string;
+    /**
+     * Register `swUrl` ourselves (manual `sw.js` style). Set `false` when the
+     * app already registers the SW (e.g. Serwist's `registerSW` / `@serwist/next`)
+     * — the updater then attaches to the existing registration via
+     * `navigator.serviceWorker.ready` instead of registering again. Default `true`.
+     */
+    register?: boolean;
+    /** How often to poll `registration.update()` (ms). `0` disables. Default 60 min. */
+    pollIntervalMs?: number;
+    /**
+     * Also check for an update when the tab regains focus / becomes visible.
+     * A constantly-focused tab never fires `visibilitychange`, so `focus` is the
+     * one that catches "user came back to the app". Default `true`.
+     */
+    updateOnFocus?: boolean;
+    /** Reload the page once the new worker takes control. Default `true`. */
+    reloadOnControllerChange?: boolean;
+    /**
+     * Consumer guard. When `true` the updater is an inert no-op (registers
+     * nothing). Pass your own policy, e.g. `disabled: isNativeCapacitor || isDev`
+     * — the package never hardcodes an environment or a `.native` check.
+     */
+    disabled?: boolean;
+}
+
+/**
+ * React binding for {@link createPwaUpdater}. Returns whether an update is
+ * ready plus the `applyUpdate` action. The controller is created once and
+ * torn down on unmount.
+ */
+declare function usePwaUpdate(options?: PwaUpdaterOptions): {
+    updateReady: boolean;
+    applyUpdate: () => void;
+};
+interface PwaUpdateBannerLabels {
+    title?: string;
+    body?: string;
+    update?: string;
+    dismiss?: string;
+    close?: string;
+}
+interface PwaUpdateBannerProps {
+    /** From `usePwaUpdate().updateReady`. Nothing renders when false. */
+    updateReady: boolean;
+    /** From `usePwaUpdate().applyUpdate`. */
+    onUpdate: () => void;
+    /** Optional dismiss handler (wired to both "Later" and the close ✕). */
+    onDismiss?: () => void;
+    /** Override any of the built-in strings (i18n). */
+    labels?: PwaUpdateBannerLabels;
+    /** Your class(es) — the skeleton carries NO colours or design-system styling. */
+    className?: string;
+}
+/**
+ * Unstyled, accessible "new version available" banner skeleton. It ships
+ * structure + a11y + stable testids only; you own the look via `className`
+ * and your design tokens. Prefer {@link usePwaUpdate} directly if you'd rather
+ * build the UI yourself.
+ */
+declare function PwaUpdateBanner({ updateReady, onUpdate, onDismiss, labels, className, }: PwaUpdateBannerProps): react.JSX.Element | null;
+
+export { PwaUpdateBanner, type PwaUpdateBannerLabels, type PwaUpdateBannerProps, usePwaUpdate };

package/dist/react.d.ts

@@ -0,0 +1,67 @@
+import * as react from 'react';
+
+interface PwaUpdaterOptions {
+    /** Service-worker script URL to register. Default `/sw.js`. */
+    swUrl?: string;
+    /**
+     * Register `swUrl` ourselves (manual `sw.js` style). Set `false` when the
+     * app already registers the SW (e.g. Serwist's `registerSW` / `@serwist/next`)
+     * — the updater then attaches to the existing registration via
+     * `navigator.serviceWorker.ready` instead of registering again. Default `true`.
+     */
+    register?: boolean;
+    /** How often to poll `registration.update()` (ms). `0` disables. Default 60 min. */
+    pollIntervalMs?: number;
+    /**
+     * Also check for an update when the tab regains focus / becomes visible.
+     * A constantly-focused tab never fires `visibilitychange`, so `focus` is the
+     * one that catches "user came back to the app". Default `true`.
+     */
+    updateOnFocus?: boolean;
+    /** Reload the page once the new worker takes control. Default `true`. */
+    reloadOnControllerChange?: boolean;
+    /**
+     * Consumer guard. When `true` the updater is an inert no-op (registers
+     * nothing). Pass your own policy, e.g. `disabled: isNativeCapacitor || isDev`
+     * — the package never hardcodes an environment or a `.native` check.
+     */
+    disabled?: boolean;
+}
+
+/**
+ * React binding for {@link createPwaUpdater}. Returns whether an update is
+ * ready plus the `applyUpdate` action. The controller is created once and
+ * torn down on unmount.
+ */
+declare function usePwaUpdate(options?: PwaUpdaterOptions): {
+    updateReady: boolean;
+    applyUpdate: () => void;
+};
+interface PwaUpdateBannerLabels {
+    title?: string;
+    body?: string;
+    update?: string;
+    dismiss?: string;
+    close?: string;
+}
+interface PwaUpdateBannerProps {
+    /** From `usePwaUpdate().updateReady`. Nothing renders when false. */
+    updateReady: boolean;
+    /** From `usePwaUpdate().applyUpdate`. */
+    onUpdate: () => void;
+    /** Optional dismiss handler (wired to both "Later" and the close ✕). */
+    onDismiss?: () => void;
+    /** Override any of the built-in strings (i18n). */
+    labels?: PwaUpdateBannerLabels;
+    /** Your class(es) — the skeleton carries NO colours or design-system styling. */
+    className?: string;
+}
+/**
+ * Unstyled, accessible "new version available" banner skeleton. It ships
+ * structure + a11y + stable testids only; you own the look via `className`
+ * and your design tokens. Prefer {@link usePwaUpdate} directly if you'd rather
+ * build the UI yourself.
+ */
+declare function PwaUpdateBanner({ updateReady, onUpdate, onDismiss, labels, className, }: PwaUpdateBannerProps): react.JSX.Element | null;
+
+export { PwaUpdateBanner, type PwaUpdateBannerLabels, type PwaUpdateBannerProps, usePwaUpdate };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@broberg/pwa",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "Fleet PWA primitive: a framework-agnostic service-worker update-detection controller (new-version-available lifecycle) + a React hook and unstyled banner skeleton + a service-worker skip-waiting helper. Zero runtime deps; ship-dark.",
   "type": "module",
   "license": "MIT",
@@ -40,13 +40,13 @@
     }
   },
   "scripts": {
-    "build": "tsup",
+    "build": "rm -rf dist && tsup && node verify-exports.mjs",
     "test": "vitest run",
     "typecheck": "tsc --noEmit"
   },
   "peerDependencies": {
-    "react": ">=18.0.0",
-    "preact": ">=10.0.0"
+    "preact": ">=10.0.0",
+    "react": ">=18.0.0"
   },
   "peerDependenciesMeta": {
     "react": {