@crystaltech/hsms-shared-ui 0.7.22 → 0.7.23

package/dist/pwa/appUpdate.d.ts

@@ -0,0 +1,57 @@
+/**
+ * Getting a deployed version onto screens that stay open all day.
+ *
+ * A service worker is only checked for a new version when the browser navigates, and a
+ * single-page app never does: a doctor who opened the module in the morning kept running the
+ * morning's build until somebody hard-reloaded. And when a new worker did take over by itself
+ * (`skipWaiting`), it deleted the old build's files from under the open tab, so the next screen
+ * the tab lazy-loaded failed.
+ *
+ * So here:
+ * - the worker is asked for an update every {@link UPDATE_CHECK_INTERVAL_MS}, whenever the tab
+ *   comes back into view, and when the network returns;
+ * - a new version waits (the app builds with `registerType: "prompt"`), and the user is told it
+ *   is there - it is never swapped in under someone writing a prescription;
+ * - "Reload" activates it and reloads once;
+ * - a screen that fails to load because its file belongs to a build that is gone reloads by
+ *   itself, unless the app says there is unsaved work - then the user is asked first.
+ *
+ * Framework-free; React reads it through useAppUpdate.
+ */
+/** How often an open tab asks whether a new version has been deployed. */
+export declare const UPDATE_CHECK_INTERVAL_MS: number;
+export type AppUpdateReason = 
+/** A new version is installed and waiting. */
+"update-ready"
+/** A part of the app failed to load: the build it belongs to is no longer on the server. */
+ | "load-failed";
+export interface AppUpdateState {
+    /** Something newer than what is running is waiting to be loaded. */
+    available: boolean;
+    reason: AppUpdateReason | null;
+}
+type Listener = (state: AppUpdateState) => void;
+export declare const getAppUpdateState: () => AppUpdateState;
+export declare const subscribeAppUpdate: (listener: Listener) => (() => void);
+/**
+ * Lets the app say when reloading would lose something - a prescription being written. Then a
+ * failed load asks before reloading instead of reloading at once. Returns the function that
+ * removes the check.
+ */
+export declare const registerUnsavedWorkCheck: (check: () => boolean) => (() => void);
+/** Asks the server whether a new version has been deployed. Safe to call at any time. */
+export declare const checkForAppUpdate: () => Promise<void>;
+/** Loads the new version: the waiting worker takes over, then the page reloads once. */
+export declare const applyAppUpdate: () => void;
+/**
+ * For an app's error boundary: whether the error is a part of the app that failed to load because
+ * its build is gone - and if so, handled as such (reload, or the user asked first). An error
+ * boundary catches what a lazily loaded screen throws before any window listener sees it.
+ */
+export declare const handleStaleBuildError: (error: unknown) => boolean;
+/**
+ * Starts watching for new versions. Called once per page - again is a no-op - by the shared
+ * layout, so every module gets it.
+ */
+export declare const startAppUpdateWatcher: (intervalMs?: number) => void;
+export {};

package/dist/sw.js

@@ -1 +1 @@
-if(!self.define){let e,s={};const i=(i,r)=>(i=new URL(i+".js",r).href,s[i]||new Promise(s=>{if("document"in self){const e=document.createElement("script");e.src=i,e.onload=s,document.head.appendChild(e)}else e=i,importScripts(i),s()}).then(()=>{let e=s[i];if(!e)throw new Error(`Module ${i} didn’t register its module`);return e}));self.define=(r,n)=>{const o=e||("document"in self?document.currentScript.src:"")||location.href;if(s[o])return;let f={};const t=e=>i(e,o),c={module:{uri:o},exports:f,require:t};s[o]=Promise.all(r.map(e=>c[e]||t(e))).then(e=>(n(...e),f))}}define(["./workbox-3105ea8d"],function(e){"use strict";self.skipWaiting(),e.clientsClaim(),e.precacheAndRoute([{url:"registerSW.js",revision:"1872c500de691dce40960bb85481de07"},{url:"preMountSplash.js",revision:"46986fe18311b1852bd4ebf684726bab"},{url:"preMountSplash.es.js",revision:"f363010fb7eaab98ab53522f58febacb"},{url:"index.js",revision:"69cf7c3009b4e77f9f38dca4214df797"},{url:"index.es.js",revision:"e31b8a5ccc82fe8703101b689a938776"},{url:"hsms-shared-ui.css",revision:"7f5aef0a9303b4cde437120fbb05ea5b"},{url:"Loader-D1FpX_bV.js",revision:"c37d04f117789f8752c3fc903951c281"},{url:"manifest.webmanifest",revision:"e6d4972ea70a2ecb105e17f18dad67f9"}],{}),e.cleanupOutdatedCaches(),e.registerRoute(new e.NavigationRoute(e.createHandlerBoundToURL("index.html")))});
+if(!self.define){let e,s={};const i=(i,r)=>(i=new URL(i+".js",r).href,s[i]||new Promise(s=>{if("document"in self){const e=document.createElement("script");e.src=i,e.onload=s,document.head.appendChild(e)}else e=i,importScripts(i),s()}).then(()=>{let e=s[i];if(!e)throw new Error(`Module ${i} didn’t register its module`);return e}));self.define=(r,n)=>{const o=e||("document"in self?document.currentScript.src:"")||location.href;if(s[o])return;let d={};const t=e=>i(e,o),f={module:{uri:o},exports:d,require:t};s[o]=Promise.all(r.map(e=>f[e]||t(e))).then(e=>(n(...e),d))}}define(["./workbox-3105ea8d"],function(e){"use strict";self.skipWaiting(),e.clientsClaim(),e.precacheAndRoute([{url:"registerSW.js",revision:"1872c500de691dce40960bb85481de07"},{url:"preMountSplash.js",revision:"46986fe18311b1852bd4ebf684726bab"},{url:"preMountSplash.es.js",revision:"f363010fb7eaab98ab53522f58febacb"},{url:"index.js",revision:"965e0209efd7000d76429aac1dfb6084"},{url:"index.es.js",revision:"cc07bc1b13df203d9992499e133cd52f"},{url:"hsms-shared-ui.css",revision:"7f5aef0a9303b4cde437120fbb05ea5b"},{url:"Loader-D1FpX_bV.js",revision:"c37d04f117789f8752c3fc903951c281"},{url:"manifest.webmanifest",revision:"e6d4972ea70a2ecb105e17f18dad67f9"}],{}),e.cleanupOutdatedCaches(),e.registerRoute(new e.NavigationRoute(e.createHandlerBoundToURL("index.html")))});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crystaltech/hsms-shared-ui",
-  "version": "0.7.22",
+  "version": "0.7.23",
   "private": false,
   "type": "module",
   "main": "dist/index.cjs",