@thebase/ui 1.1.7 → 1.2.0

package/docs/usage-guide.md

@@ -32,7 +32,7 @@ Save this as an `.html` file and open it — no build step, no server required.
 </html>
 ```
 
-`https://cdn.jsdelivr.net/npm/@thebase/ui@latest/dist/...` is the real jsDelivr URL for the published `@thebase/ui` npm package's `latest` tag, used here for a copy-paste-and-go quick start. Pin an exact version instead (e.g. `@1.1.7`, or `@1` to take only non-breaking updates) for production, so a new release can't change what your page loads. See [Installation](installation.md) for jsDelivr/unpkg/npm/self-hosted paths.
+`https://cdn.jsdelivr.net/npm/@thebase/ui@latest/dist/...` is the real jsDelivr URL for the published `@thebase/ui` npm package's `latest` tag, used here for a copy-paste-and-go quick start. Pin an exact version instead (e.g. `@1.2.0`, or `@1` to take only non-breaking updates) for production, so a new release can't change what your page loads. See [Installation](installation.md) for jsDelivr/unpkg/npm/self-hosted paths.
 
 The static bundle calls `thebase.mountAll()` automatically on `DOMContentLoaded`, so initial `[b-ui]` and `[b-icon]` markup mounts without an extra script. Call `thebase.mountAll(root)` yourself only after injecting new markup or when mounting a specific fragment. If the consumer is itself an application, use [step 2](#2-install-pure-owl-api--recommended) instead — that's the recommended path.
 
@@ -63,7 +63,7 @@ Both APIs come from the same package and the same CSS file, and can be mixed on
 </script>
 ```
 
-`https://unpkg.com/@thebase/ui@latest/dist/...` mirrors the same files as an alternative CDN if jsDelivr is unreachable — swap the host in each URL above. Pin an exact version (e.g. `@1.1.7`, or `@1` to take only non-breaking updates) instead of `@latest` for production.
+`https://unpkg.com/@thebase/ui@latest/dist/...` mirrors the same files as an alternative CDN if jsDelivr is unreachable — swap the host in each URL above. Pin an exact version (e.g. `@1.2.0`, or `@1` to take only non-breaking updates) instead of `@latest` for production.
 
 ```html
 <script type="module">
@@ -103,7 +103,7 @@ Two rules that account for most integration failures — see [Base Components](o
 <script src="https://cdn.jsdelivr.net/npm/@thebase/ui@latest/dist/baseui.min.js" defer></script>
 ```
 
-`https://unpkg.com/@thebase/ui@latest/dist/...` mirrors the same files as an alternative CDN if jsDelivr is unreachable. Pin an exact version (e.g. `@1.1.7`, or `@1` to take only non-breaking updates) instead of `@latest` for production.
+`https://unpkg.com/@thebase/ui@latest/dist/...` mirrors the same files as an alternative CDN if jsDelivr is unreachable. Pin an exact version (e.g. `@1.2.0`, or `@1` to take only non-breaking updates) instead of `@latest` for production.
 
 **Option B — npm (bundler-based apps: Vite, webpack, etc.):**
 
@@ -120,7 +120,7 @@ import "@thebase/ui"; // side-effect import: registers window.thebase and auto-m
 
 Rule that applies to both options:
 
-- Production pages must use a pinned version (e.g. `@thebase/ui@1.1.7` or `@thebase/ui@1`), never `@latest`.
+- Production pages must use a pinned version (e.g. `@thebase/ui@1.2.0` or `@thebase/ui@1`), never `@latest`.
 
 Mount markup:
 
@@ -219,7 +219,7 @@ export default {
   },
   serviceWorker: {
     cacheName: "my-app-cache-v1",
-    cdnVersion: "1.1.7", // pin to match the importmap in index.html
+    cdnVersion: "1.2.0", // pin to match the importmap in index.html
     appFiles: ["/app.css", "/app.js", "/app.xml", "/favicon.svg", "/icons/icon-192.png", "/icons/icon-512.png"],
   },
 };
@@ -227,9 +227,17 @@ export default {
 
 ```sh
 npx create-baseui-app pwa . --config baseui.pwa.config.js
-# writes ./manifest.webmanifest and ./sw.js
+# writes ./manifest.webmanifest, ./sw.js, ./sw-register.js and ./version.json
 ```
 
+**Auto-reload on a new deploy.** The generated `sw.js` fetches `version.json` (never cached) on activate, on
+every page navigation and when the page posts `"check-version"`. When the value differs from the last one it
+saw, it wipes the caches, re-precaches the app shell and posts `"version-changed"` to every open page.
+`sw-register.js` (load it with `<script type="module" src="/sw-register.js">`, replacing your own
+`serviceWorker.register`) registers the worker, reloads on that message and re-checks when the tab becomes
+visible. `version.json` is a content hash of `sw.js`, the manifest and every `appFiles` entry found under
+`<path>`, so re-run the `pwa` command as the last step of every deploy.
+
 Re-run the command whenever `appFiles`, the CDN pin, or manifest fields change — both output files are
 fully regenerated, never hand-patched. Only `manifest.name`, `serviceWorker.cacheName`, and
 `serviceWorker.cdnVersion` are required; everything else (icons, theme/background color, display
@@ -239,6 +247,15 @@ files are kept, so your own icons win). Serving icons from another folder? Set `
 service worker) and `manifestUrl` (service worker) in the config. See
 `dist/types/pwa.d.ts` for the full config shape.
 
+**Default in every scaffolded project.** `create-baseui-app create|init` projects ship
+`plugins: [baseuiPwa({ name })]` (from `@thebase/ui/vite`) in `vite.config.js`. Each `vite build` then emits
+`manifest.webmanifest`, `sw.js`, `sw-register.js`, `version.json` (hash of the built bundle) and the default
+icons into `dist/`, and injects the manifest link, theme color and register script into every page — no
+config file, no extra command. Every deploy with changed code therefore reloads open pages automatically.
+`vite dev` is untouched. Options: `name`, `description`, `themeColor` and the other manifest fields, plus
+`cdnVersion` (only for apps that load BaseUI from the CDN). For an existing project, add the plugin to
+`vite.config.js` (`convert` prints this hint). Remove the plugin to opt out.
+
 ## 6. Copy a block instead of assembling from primitives
 
 For common layouts (dashboard shells, sidebars, login/signup forms, charts), copy a ready-made block from the gallery instead of composing primitives by hand: [Blocks](blocks.md).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thebase/ui",
-  "version": "1.1.7",
+  "version": "1.2.0",
   "description": "CDN-installable Bootstrap 5 UI component library.",
   "type": "module",
   "main": "./dist/baseui.min.js",
@@ -34,6 +34,10 @@
       "types": "./dist/types/pwa.d.ts",
       "import": "./dist/baseui.pwa.esm.js"
     },
+    "./vite": {
+      "types": "./dist/types/vite.d.ts",
+      "import": "./dist/baseui.vite.esm.js"
+    },
     "./dist/baseui.templates.xml": "./dist/baseui.templates.xml"
   },
   "files": [
@@ -47,6 +51,7 @@
     "dist/baseui.apidoc.esm.js",
     "dist/baseui.apidoc.min.js",
     "dist/baseui.pwa.esm.js",
+    "dist/baseui.vite.esm.js",
     "dist/baseui.templates.xml",
     "dist/icons",
     "dist/pwa-icons",