version-rocket/index.js

Tools to check version monitoring (updates) for web application. web 应用版本监测(更新)工具

import { versionTipDialog } from './components/versionTipDialog';
import { createWorker, createWorkerFunc, cancelUpdateFunc, checkVersionTypeFunc, } from './utils/index';
/**
 * Polling monitoring version update (No longer maintain)
 *
 * @param {string} localPackageVersion the current version of the page in the browser
 * @param {string} originVersionFileUrl remote server version file address
 * @param {number} [pollingTime = 5000] polling interval, in ms (Optional)
 * @param {function} onVersionUpdate callback when updating version, used when customizing UI (Optional)
 * @return {object}  { refreshPageVersion } new version number
 */
export const pollingCompareVersion = (localPackageVersion, originVersionFileUrl, pollingTime, onVersionUpdate) => {
    const worker = createWorker(createWorkerFunc);
    worker.postMessage({
        'version-key': localPackageVersion,
        'polling-time': pollingTime,
        'origin-version-file-url': originVersionFileUrl,
    });
    worker.onmessage = (event) => {
        // custom version tip UI
        if (typeof onVersionUpdate === 'function') {
            onVersionUpdate(event.data);
        }
        else {
            // default version tip ui
            versionTipDialog({ newVersion: event.data.refreshPageVersion });
        }
    };
};
/**
 * Polling monitoring version update v2 (Recommended)
 *
 * @param {object} config Polling the configuration parameters of the monitoring version
 * @param {string} config.originVersionFileUrl remote server version file address (Required)
 * @param {string} config.localPackageVersion  the current version of the page in the browser
 * @param {number} [config.pollingTime = 5000] polling interval, in ms (Optional)
 * @param {function} config.onVersionUpdate callback when updating version, used when customizing UI (Optional)
 *
 * @param {object} options Customize version update popup copy and themes
 * @param {string} [options.title = 'Update'] popup title (Optional)
 * @param {string} [options.description = 'V xxx is available'] popup description (Optional)
 * @param {string} [options.buttonText = 'Refresh'] popup button text (Optional)
 * @param {string} [options.cancelButtonText] close popup button text (Optional)
 * @param {string} [options.cancelMode = 'ignore-current-version'] close popup button mode
 * @param {string} [options.cancelUpdateAndStopWorker = false] close popup and stop worker
 * @param {string} options.imageUrl custom popup image address (Optional)
 * @param {string} options.rocketColor custom popup rocket color in the picture (Optional)
 * @param {string} options.primaryColor custom popup primary color, act on image background color and button background color (Optional)
 * @param {string} options.buttonStyle custom popup button style (Optional)
 *
 * @return {object}  { refreshPageVersion } new version number
 */
let worker = undefined;
export const checkVersion = (config, options) => {
    if (config.enable === false)
        return;
    if (!worker) {
        worker = createWorker(createWorkerFunc, [checkVersionTypeFunc]);
    }
    const processUserInput = (input) => {
        if (!input) {
            return;
        }
        if (!Array.isArray(input)) {
            console.warn('Invalid input: Expected an array.');
            return [];
        }
        return [...new Set(input)].filter((item) => item != null);
    };
    worker.postMessage({
        'version-key': config.localPackageVersion || '',
        'polling-time': config.pollingTime || 5000,
        immediate: config.immediate || false,
        'origin-version-file-url': config.originVersionFileUrl || '',
        'check-origin-specified-files-url': processUserInput(config.checkOriginSpecifiedFilesUrl),
        'check-origin-specified-files-url-mode': config.checkOriginSpecifiedFilesUrlMode || 'one',
        'clear-interval-on-dialog': config.clearIntervalOnDialog || false,
    });
    worker.onmessage = (event) => {
        var _a;
        const cancelUpdateLock = cancelUpdateFunc(options === null || options === void 0 ? void 0 : options.cancelMode, (_a = event.data) === null || _a === void 0 ? void 0 : _a.refreshPageVersion, options === null || options === void 0 ? void 0 : options.cancelUpdateAndStopWorker, worker);
        if (cancelUpdateLock)
            return;
        localStorage.removeItem('version-rocket:cancelled');
        sessionStorage.removeItem('version-rocket:cancelled');
        // custom version tip UI
        if (typeof config.onVersionUpdate === 'function') {
            config.onVersionUpdate(event.data);
        }
        else {
            // default version tip ui
            const { title, description, buttonText, cancelButtonText, cancelMode, imageUrl, rocketColor, primaryColor, buttonStyle, } = options || {};
            const { onRefresh, onCancel } = config || {};
            versionTipDialog({
                title,
                description,
                buttonText,
                cancelButtonText,
                cancelMode,
                imageUrl,
                rocketColor,
                primaryColor,
                buttonStyle,
                newVersion: event.data.refreshPageVersion,
                needRefresh: event.data.refreshPageVersion,
                onRefresh,
                onCancel,
            });
        }
    };
};
/**
 * destroy checkVersion
 */
export const unCheckVersion = ({ closeDialog = false, closeWorker = true }) => {
    if (closeWorker) {
        worker === null || worker === void 0 ? void 0 : worker.terminate();
        worker = undefined;
    }
    if (closeDialog) {
        const dialogElement = document.querySelector('#version-rocket');
        const dialogElementParent = dialogElement === null || dialogElement === void 0 ? void 0 : dialogElement.parentElement;
        if (dialogElement && dialogElementParent) {
            dialogElementParent.removeChild(dialogElement);
        }
    }
};