@crystaltech/hsms-shared-ui 0.7.21 → 0.7.23

package/dist/components/ui/AppUpdateBanner.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Says that a new version has been deployed and loads it on request. Never reloads by itself: a
+ * doctor in the middle of a prescription chooses when. "Later" hides it until the next check
+ * finds it again; it does not dismiss the update.
+ */
+declare const AppUpdateBanner: () => import("react/jsx-runtime").JSX.Element;
+export default AppUpdateBanner;

package/dist/components/ui/NetworkStatusIndicator.d.ts

@@ -0,0 +1,14 @@
+interface NetworkStatusIndicatorProps {
+    /** Shown before the status in the full form, e.g. "HSMS". */
+    systemName?: string;
+    /** The dot alone, with the status in a tooltip - for a collapsed sidebar. */
+    compact?: boolean;
+    /** Colour of the label text. */
+    textColor?: string;
+}
+/**
+ * A live connection status: a coloured dot and what it means. Red when the computer is offline,
+ * amber when the network is up but the server does not answer, green only when it does.
+ */
+declare const NetworkStatusIndicator: ({ systemName, compact, textColor, }: NetworkStatusIndicatorProps) => import("react/jsx-runtime").JSX.Element;
+export default NetworkStatusIndicator;

package/dist/hooks/useAppUpdate.d.ts

@@ -0,0 +1,8 @@
+import { AppUpdateState } from '../pwa/appUpdate';
+/**
+ * Whether a newer version of the app is waiting, and the function that loads it. Starts the
+ * watcher on first use - see pwa/appUpdate.
+ */
+export declare function useAppUpdate(): AppUpdateState & {
+    reload: () => void;
+};

package/dist/hooks/useNetworkStatus.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Whether this workstation can reach the system right now.
+ *
+ * - `online`: the browser has a network and the HSMS server answered.
+ * - `offline`: the browser has no network at all - cable out, Wi-Fi down.
+ * - `unreachable`: there is a network, but the HSMS server does not answer. The browser's own
+ *   flag says "online" here, which is why it is not trusted alone: a ward PC on a LAN whose
+ *   uplink is down reports itself online while every save fails.
+ * - `checking`: not known yet.
+ */
+export type NetworkStatus = "checking" | "online" | "offline" | "unreachable";
+/** How often the server is asked while the browser says it is online. */
+export declare const NETWORK_PROBE_INTERVAL_MS = 30000;
+export declare function probeServer(): Promise<boolean>;
+/**
+ * The workstation's network status, kept current: the browser's online/offline events answer at
+ * once, and the server is asked every {@link NETWORK_PROBE_INTERVAL_MS} - and as soon as the
+ * browser reports the network back - to tell "online" from "online but cut off".
+ */
+export declare function useNetworkStatus(): NetworkStatus;

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export { default as ThemeSetting } from './components/ThemeSetting';
+export { default as AppUpdateBanner } from './components/ui/AppUpdateBanner';
 export { default as Banner } from './components/banner/Banner';
 export { default as GlobalHospitalSelectDialog } from './components/GlobalHospitalSelectDialog';
 export { default as MainLayout } from './components/layout/MainLayout';
@@ -22,9 +23,15 @@ export { default as CustomSwitch } from './components/ui/CustomSwitch';
 export { default as CustomTabs } from './components/ui/CustomTabs';
 export { default as CustomTextField } from './components/ui/CustomTextfield';
 export { default as Loader } from './components/ui/Loader';
+export { default as NetworkStatusIndicator } from './components/ui/NetworkStatusIndicator';
 export { default as RoutesConfigLayout } from './routes/RoutesConfigLayout';
 export { default as ThemeCustomization } from './theme/ThemeCustomization';
 export { configureCommonPackage, getApiBaseUrl, getCommonConfig, setApiBaseUrl, } from './config/env';
 export { configureAuthPackage, getAccountConsoleUrl, getAuthConfig, getPostLogoutRedirectUri, setAccountConsoleRoutes, setAccountConsoleUrl, setPostLogoutRedirectUri, } from './config/auth';
+export { NETWORK_PROBE_INTERVAL_MS, probeServer, useNetworkStatus, } from './hooks/useNetworkStatus';
+export type { NetworkStatus } from './hooks/useNetworkStatus';
+export { useAppUpdate } from './hooks/useAppUpdate';
+export { applyAppUpdate, checkForAppUpdate, handleStaleBuildError, registerUnsavedWorkCheck, startAppUpdateWatcher, UPDATE_CHECK_INTERVAL_MS, } from './pwa/appUpdate';
+export type { AppUpdateReason, AppUpdateState } from './pwa/appUpdate';
 export { defaultTheme } from './theme/defaultTheme';
 export type { ITheme, TypographyStyle } from './theme/defaultTheme';