@leancodepl/force-update 8.5.0

package/index.cjs.default.js

@@ -0,0 +1 @@
+exports._default = require('./index.cjs.js').default;

package/index.cjs.js

@@ -0,0 +1,79 @@
+'use strict';
+
+var react = require('react');
+var rxjs = require('rxjs');
+var ajax = require('rxjs/ajax');
+var operators = require('rxjs/operators');
+
+const defaultVersionCheckIntervalPeriod = 3 * 60 * 1000;
+/**
+ * Listens for force updates by periodically checking the `/version` endpoint.
+ * When a new version is detected, it calls the provided callback function.
+ *
+ * @param params - Configuration object for force update listening
+ * @param params.versionCheckIntervalPeriod - The interval period in milliseconds to check for version updates (default: 180000 - 3 minutes)
+ * @param params.onNewVersionAvailable - Callback function that is called when a new version is available
+ * @returns A cleanup function that unsubscribes from the version checking
+ */ const listenOnForceUpdate = ({ versionCheckIntervalPeriod = defaultVersionCheckIntervalPeriod, onNewVersionAvailable })=>{
+    const versionUrl = ()=>ajax.ajax({
+            url: "/version",
+            responseType: "text",
+            headers: {
+                "Cache-Control": "no-store"
+            }
+        }).pipe(operators.map((response)=>{
+            const version = response.response;
+            return typeof version === "string" ? version.trim() : null;
+        }), operators.catchError(()=>rxjs.of(null)));
+    const subscription = rxjs.interval(versionCheckIntervalPeriod).pipe(operators.mergeMap(versionUrl), operators.scan((lastVersion, version)=>version != null ? version : lastVersion), operators.pairwise(), operators.first(([previousVersion, currentVersion])=>!!previousVersion && previousVersion !== currentVersion)).subscribe(()=>{
+        onNewVersionAvailable();
+        subscription.unsubscribe();
+    });
+    return ()=>subscription.unsubscribe();
+};
+
+function ForceUpdateNotification({ message = "A new version of the app is available. Please reload the page to access latest features." }) {
+    react.useEffect(()=>{
+        const cleanup = listenOnForceUpdate({
+            onNewVersionAvailable: ()=>{
+                if (window.confirm(message)) {
+                    window.location.reload();
+                }
+            }
+        });
+        return cleanup;
+    }, [
+        message
+    ]);
+    return null;
+}
+
+/**
+ * Vite plugin that emits a version asset file based on an environment variable, 'APP_VERSION' as default
+ * This is used for force update mechanism that needs to check the current app version.
+ *
+ * @param options - Configuration options for the plugin
+ * @param options.envVarName - The name of the environment variable to read the version from (default: 'APP_VERSION')
+ * @returns A Vite plugin that creates a /version endpoint serving the current app version
+ */ function vitePluginForceUpdate(options = {}) {
+    const { envVarName = "APP_VERSION" } = options;
+    return {
+        name: "vite-plugin-force-update",
+        generateBundle () {
+            const version = process.env[envVarName];
+            if (!version) {
+                console.warn(`Environment variable ${envVarName} is not set.`);
+                return;
+            }
+            this.emitFile({
+                type: "asset",
+                fileName: "version",
+                source: version.trim()
+            });
+        }
+    };
+}
+
+exports.ForceUpdateNotification = ForceUpdateNotification;
+exports.listenOnForceUpdate = listenOnForceUpdate;
+exports.vitePluginForceUpdate = vitePluginForceUpdate;

package/index.cjs.mjs

@@ -0,0 +1,2 @@
+export * from './index.cjs.js';
+export { _default as default } from './index.cjs.default.js';

package/index.d.ts

@@ -0,0 +1 @@
+export * from "./src/index";

package/index.esm.js

@@ -0,0 +1,75 @@
+import { useEffect } from 'react';
+import { interval, of } from 'rxjs';
+import { ajax } from 'rxjs/ajax';
+import { mergeMap, scan, pairwise, first, map, catchError } from 'rxjs/operators';
+
+const defaultVersionCheckIntervalPeriod = 3 * 60 * 1000;
+/**
+ * Listens for force updates by periodically checking the `/version` endpoint.
+ * When a new version is detected, it calls the provided callback function.
+ *
+ * @param params - Configuration object for force update listening
+ * @param params.versionCheckIntervalPeriod - The interval period in milliseconds to check for version updates (default: 180000 - 3 minutes)
+ * @param params.onNewVersionAvailable - Callback function that is called when a new version is available
+ * @returns A cleanup function that unsubscribes from the version checking
+ */ const listenOnForceUpdate = ({ versionCheckIntervalPeriod = defaultVersionCheckIntervalPeriod, onNewVersionAvailable })=>{
+    const versionUrl = ()=>ajax({
+            url: "/version",
+            responseType: "text",
+            headers: {
+                "Cache-Control": "no-store"
+            }
+        }).pipe(map((response)=>{
+            const version = response.response;
+            return typeof version === "string" ? version.trim() : null;
+        }), catchError(()=>of(null)));
+    const subscription = interval(versionCheckIntervalPeriod).pipe(mergeMap(versionUrl), scan((lastVersion, version)=>version != null ? version : lastVersion), pairwise(), first(([previousVersion, currentVersion])=>!!previousVersion && previousVersion !== currentVersion)).subscribe(()=>{
+        onNewVersionAvailable();
+        subscription.unsubscribe();
+    });
+    return ()=>subscription.unsubscribe();
+};
+
+function ForceUpdateNotification({ message = "A new version of the app is available. Please reload the page to access latest features." }) {
+    useEffect(()=>{
+        const cleanup = listenOnForceUpdate({
+            onNewVersionAvailable: ()=>{
+                if (window.confirm(message)) {
+                    window.location.reload();
+                }
+            }
+        });
+        return cleanup;
+    }, [
+        message
+    ]);
+    return null;
+}
+
+/**
+ * Vite plugin that emits a version asset file based on an environment variable, 'APP_VERSION' as default
+ * This is used for force update mechanism that needs to check the current app version.
+ *
+ * @param options - Configuration options for the plugin
+ * @param options.envVarName - The name of the environment variable to read the version from (default: 'APP_VERSION')
+ * @returns A Vite plugin that creates a /version endpoint serving the current app version
+ */ function vitePluginForceUpdate(options = {}) {
+    const { envVarName = "APP_VERSION" } = options;
+    return {
+        name: "vite-plugin-force-update",
+        generateBundle () {
+            const version = process.env[envVarName];
+            if (!version) {
+                console.warn(`Environment variable ${envVarName} is not set.`);
+                return;
+            }
+            this.emitFile({
+                type: "asset",
+                fileName: "version",
+                source: version.trim()
+            });
+        }
+    };
+}
+
+export { ForceUpdateNotification, listenOnForceUpdate, vitePluginForceUpdate };

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@leancodepl/force-update",
+  "version": "8.5.0",
+  "license": "Apache-2.0",
+  "dependencies": {
+    "rxjs": ">=7.0.0"
+  },
+  "peerDependencies": {
+    "react": "*",
+    "vite": ">=4.0.0"
+  },
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "module": "./index.esm.js",
+      "types": "./index.d.ts",
+      "import": "./index.cjs.mjs",
+      "default": "./index.cjs.js"
+    }
+  },
+  "module": "./index.esm.js",
+  "main": "./index.cjs.js",
+  "types": "./index.d.ts"
+}

package/src/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./lib/ForceUpdateNotification";
+export * from "./lib/listenOnForceUpdate";
+export * from "./lib/vitePluginForceUpdate";

package/src/lib/ForceUpdateNotification/index.d.ts

@@ -0,0 +1,4 @@
+export type ForceUpdateNotificationProps = {
+    message?: string;
+};
+export declare function ForceUpdateNotification({ message, }: ForceUpdateNotificationProps): null;

package/src/lib/listenOnForceUpdate.d.ts

@@ -0,0 +1,14 @@
+export type ForceUpdateParams = {
+    versionCheckIntervalPeriod?: number;
+    onNewVersionAvailable: () => void;
+};
+/**
+ * Listens for force updates by periodically checking the `/version` endpoint.
+ * When a new version is detected, it calls the provided callback function.
+ *
+ * @param params - Configuration object for force update listening
+ * @param params.versionCheckIntervalPeriod - The interval period in milliseconds to check for version updates (default: 180000 - 3 minutes)
+ * @param params.onNewVersionAvailable - Callback function that is called when a new version is available
+ * @returns A cleanup function that unsubscribes from the version checking
+ */
+export declare const listenOnForceUpdate: ({ versionCheckIntervalPeriod, onNewVersionAvailable, }: ForceUpdateParams) => () => void;

package/src/lib/vitePluginForceUpdate.d.ts

@@ -0,0 +1,13 @@
+import type { Plugin } from "vite";
+export interface ForceUpdatePluginOptions {
+    envVarName?: string;
+}
+/**
+ * Vite plugin that emits a version asset file based on an environment variable, 'APP_VERSION' as default
+ * This is used for force update mechanism that needs to check the current app version.
+ *
+ * @param options - Configuration options for the plugin
+ * @param options.envVarName - The name of the environment variable to read the version from (default: 'APP_VERSION')
+ * @returns A Vite plugin that creates a /version endpoint serving the current app version
+ */
+export declare function vitePluginForceUpdate(options?: ForceUpdatePluginOptions): Plugin;