@tracktor/shared-module 2.17.1 → 2.18.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Changelog
 
-## [2.17.1] - 2025-07-15
+## [2.18.0] - 2025-09-30
 
-### 🔧 Fixes
--  fix behavior `syncWithUrl` to `useFilters`
+### ✨ Features
+- introduce `AppUpdateHandler` component to monitor Service Worker updates and prompt users when a new version of the app is available

package/dist/components/Utils/UpdateNotifier.d.ts

@@ -0,0 +1,45 @@
+import { ReactNode } from 'react';
+export interface UpdateNotifierProps {
+    /**
+     * If true, clears all CacheStorage entries before reloading.
+     * Default false to avoid wiping host-origin caches unexpectedly.
+     */
+    clearCachesOnReload?: boolean;
+    /**
+     * Optional custom component to display when an update is available.
+     * It receives an `onReload` callback that should be called to reload the app.
+     */
+    renderDialog?: (handleReloadApp: () => void) => ReactNode;
+}
+/**
+ * UpdateNotifier monitors Service Worker updates and informs the user
+ * when a new version of the app is available.
+ *
+ * Behavior:
+ * - Detects when a new Service Worker has been installed and is waiting to activate.
+ * - If a custom `renderDialog` component is provided, it will be rendered when an update is available,
+ *   and will receive an `onReload` callback to trigger the reload flow.
+ * - If no `renderDialog` is provided, a default `window.confirm` prompt is shown,
+ *   and the app reloads automatically after user confirmation.
+ * - If `clearCachesOnReload` is true, all entries in CacheStorage will be cleared before reloading
+ *   (use with caution, as this removes *all* caches for the current origin).
+ *
+ * Usage:
+ * Place <UpdateNotifier /> once at the root of your app (e.g., in App.tsx).
+ *
+ * Example with a custom banner:
+ * ```tsx
+ * <UpdateNotifier
+ *   renderDialog={(handleReloadApp) => (
+ *     <div style={{ position: "fixed", bottom: 0, width: "100%", background: "orange", padding: "1rem" }}>
+ *       <span>A new version is available.</span>
+ *       <button onClick={onReload} style={{ marginLeft: "1rem" }}>
+ *         Reload now
+ *       </button>
+ *     </div>
+ *   )}
+ * />
+ * ```
+ */
+declare const UpdateNotifier: ({ renderDialog, clearCachesOnReload }: UpdateNotifierProps) => ReactNode;
+export default UpdateNotifier;

package/dist/main.d.ts

@@ -15,6 +15,8 @@ export { default as InitializeDaysJSConfig } from './components/Utils/Initialize
 export * from './components/Utils/InitializeDaysJSConfig';
 export { default as PreloadErrorHandler } from './components/Utils/PreloadErrorHandler';
 export * from './components/Utils/PreloadErrorHandler';
+export { default as UpdateNotifier } from './components/Utils/UpdateNotifier';
+export * from './components/Utils/UpdateNotifier';
 export { default as InjectDependenciesProvider } from './context/InjectDependenciesProvider';
 export * from './context/InjectDependenciesProvider';
 export { default as QueryClientProviderWithConfig } from './context/QueryClientProviderWithConfig';