dfs-page-config 0.8.15 → 0.9.1

package/dist/app-update.cjs

@@ -0,0 +1 @@
+"use strict";const h=require("element-plus"),i="dfs_app_update:breaking",a="dfs_app_update:pending",f="dfs_app_update:routes";function g(t,r){return!r||r.length===0?!0:r.some(o=>{if(o.endsWith("/**")){const s=o.slice(0,-3);return s?t===s||t.startsWith(`${s}/`):!0}return t===o})}async function S(){try{const t=await fetch(`/version.json?t=${Date.now()}`,{cache:"no-store"});if(!t.ok)return null;const r=await t.json();return{version:String(r.version??""),breaking:Number(r.breaking)||0,forceReloadRoutes:Array.isArray(r.forceReloadRoutes)?r.forceReloadRoutes.map(String):[]}}catch{return null}}let d=!1;async function m(){if(!d){d=!0;try{await h.ElMessageBox.alert("系统已更新，请刷新页面后继续使用","版本更新",{confirmButtonText:"刷新",showClose:!1,closeOnClickModal:!1,closeOnPressEscape:!1,showCancelButton:!1,type:"warning",lockScroll:!0})}catch{}finally{location.reload()}}}function y(t){const r=t.checkIntervalMs??6e4,o=(e,n)=>{if(g(e,n)){sessionStorage.removeItem(a),m();return}sessionStorage.setItem(a,"1"),sessionStorage.setItem(f,JSON.stringify(n))},s=e=>{if(sessionStorage.getItem(a)!=="1")return;let n=[];try{n=JSON.parse(sessionStorage.getItem(f)||"[]")}catch{n=[]}g(e,n)&&(sessionStorage.removeItem(a),m())},c=async()=>{const e=await S();if(!e)return;const n=localStorage.getItem(i);if(n===null){localStorage.setItem(i,String(e.breaking));return}const p=Number(n)||0;e.breaking<=p||(localStorage.setItem(i,String(e.breaking)),o(t.router.currentRoute.value.path,e.forceReloadRoutes))};let l;const u=()=>{window.clearInterval(l),document.visibilityState==="visible"&&(c(),l=window.setInterval(c,r))};document.addEventListener("visibilitychange",u),u(),t.router.afterEach(e=>{s(e.path)})}module.exports=y;

package/dist/app-update.js

@@ -0,0 +1,91 @@
+import { ElMessageBox as h } from "element-plus";
+const i = "dfs_app_update:breaking", s = "dfs_app_update:pending", f = "dfs_app_update:routes";
+function g(t, r) {
+  return !r || r.length === 0 ? !0 : r.some((o) => {
+    if (o.endsWith("/**")) {
+      const a = o.slice(0, -3);
+      return a ? t === a || t.startsWith(`${a}/`) : !0;
+    }
+    return t === o;
+  });
+}
+async function S() {
+  try {
+    const t = await fetch(`/version.json?t=${Date.now()}`, {
+      cache: "no-store"
+    });
+    if (!t.ok)
+      return null;
+    const r = await t.json();
+    return {
+      version: String(r.version ?? ""),
+      breaking: Number(r.breaking) || 0,
+      forceReloadRoutes: Array.isArray(r.forceReloadRoutes) ? r.forceReloadRoutes.map(String) : []
+    };
+  } catch {
+    return null;
+  }
+}
+let d = !1;
+async function m() {
+  if (!d) {
+    d = !0;
+    try {
+      await h.alert("系统已更新，请刷新页面后继续使用", "版本更新", {
+        confirmButtonText: "刷新",
+        showClose: !1,
+        closeOnClickModal: !1,
+        closeOnPressEscape: !1,
+        showCancelButton: !1,
+        type: "warning",
+        lockScroll: !0
+      });
+    } catch {
+    } finally {
+      location.reload();
+    }
+  }
+}
+function R(t) {
+  const r = t.checkIntervalMs ?? 6e4, o = (e, n) => {
+    if (g(e, n)) {
+      sessionStorage.removeItem(s), m();
+      return;
+    }
+    sessionStorage.setItem(s, "1"), sessionStorage.setItem(f, JSON.stringify(n));
+  }, a = (e) => {
+    if (sessionStorage.getItem(s) !== "1")
+      return;
+    let n = [];
+    try {
+      n = JSON.parse(sessionStorage.getItem(f) || "[]");
+    } catch {
+      n = [];
+    }
+    g(e, n) && (sessionStorage.removeItem(s), m());
+  }, c = async () => {
+    const e = await S();
+    if (!e)
+      return;
+    const n = localStorage.getItem(i);
+    if (n === null) {
+      localStorage.setItem(i, String(e.breaking));
+      return;
+    }
+    const p = Number(n) || 0;
+    e.breaking <= p || (localStorage.setItem(i, String(e.breaking)), o(
+      t.router.currentRoute.value.path,
+      e.forceReloadRoutes
+    ));
+  };
+  let l;
+  const u = () => {
+    window.clearInterval(l), document.visibilityState === "visible" && (c(), l = window.setInterval(c, r));
+  };
+  document.addEventListener("visibilitychange", u), u(), t.router.afterEach((e) => {
+    a(e.path);
+  });
+}
+export {
+  R as default
+};

package/package.json

@@ -1,9 +1,11 @@
 {
   "name": "dfs-page-config",
-  "version": "0.8.15",
+  "version": "0.9.1",
   "type": "module",
   "files": [
-    "dist"
+    "dist",
+    "vite-plugin-app-update.js",
+    "vite-plugin-app-update.cjs"
   ],
   "main": "./dist/dfs-page-config.umd.cjs",
   "module": "./dist/dfs-page-config.js",
@@ -12,11 +14,19 @@
       "import": "./dist/dfs-page-config.js",
       "require": "./dist/dfs-page-config.umd.cjs"
     },
+    "./vite-plugin-app-update": {
+      "import": "./vite-plugin-app-update.js",
+      "require": "./vite-plugin-app-update.cjs"
+    },
+    "./app-update": {
+      "import": "./dist/app-update.js",
+      "require": "./dist/app-update.cjs"
+    },
     "./css": "./dist/style.css"
   },
   "scripts": {
     "dev": "vite",
-    "build": "vite build",
+    "build": "vite build && vite build --config vite.config.app-update.ts",
     "package": "vue-tsc && build",
     "preview": "vite preview"
   },
@@ -51,6 +61,7 @@
   "peerDependencies": {
     "axios": ">=0.21.1",
     "vue": ">=3.2.22",
+    "vue-router": ">=4.0.0",
     "vuex": ">=4.0.0"
   }
 }

package/vite-plugin-app-update.cjs

@@ -0,0 +1,80 @@
+/**
+ * Vite 插件（CJS）：根据业务项目根目录 app-update.config.json 生成 /version.json
+
+ * import generateAppUpdateVersion from 'dfs-page-config/vite-plugin-app-update'
+ * plugins: [generateAppUpdateVersion()]
+ */
+const fs = require("fs");
+const path = require("path");
+
+/**
+ * @param {object} [options]
+ * @param {string} [options.configFile='app-update.config.json'] 相对 cwd 的配置路径
+ * @param {string} [options.outFile='version.json'] 写入 dist 的文件名
+ * @returns {import('vite').Plugin}
+ */
+function generateAppUpdateVersion(options = {}) {
+  const configFile = options.configFile || "app-update.config.json";
+  const outFile = options.outFile || "version.json";
+
+  function readConfig() {
+    const configPath = path.resolve(process.cwd(), configFile);
+    if (!fs.existsSync(configPath)) {
+      return { breaking: 0, forceReloadRoutes: [] };
+    }
+    const raw = JSON.parse(fs.readFileSync(configPath, "utf-8"));
+    return {
+      breaking: Number(raw.breaking) || 0,
+      forceReloadRoutes: Array.isArray(raw.forceReloadRoutes)
+        ? raw.forceReloadRoutes.map(String)
+        : [],
+    };
+  }
+
+  function buildPolicy() {
+    const config = readConfig();
+    return {
+      version: `${Date.now()}`,
+      breaking: config.breaking,
+      forceReloadRoutes: config.forceReloadRoutes,
+    };
+  }
+
+  return {
+    name: "dfs-generate-app-update-version",
+    configureServer(server) {
+      server.middlewares.use((req, res, next) => {
+        const url = req.url?.split("?")[0];
+        if (url !== `/${outFile}`) {
+          next();
+          return;
+        }
+        try {
+          const body = JSON.stringify(buildPolicy());
+          res.setHeader("Content-Type", "application/json; charset=utf-8");
+          res.setHeader("Cache-Control", "no-store, no-cache, must-revalidate");
+          res.end(body);
+        } catch (err) {
+          res.statusCode = 500;
+          res.end(JSON.stringify({ message: String(err) }));
+        }
+      });
+    },
+    closeBundle() {
+      const outDir = path.resolve(process.cwd(), "dist");
+      if (!fs.existsSync(outDir)) return;
+      const policy = buildPolicy();
+      fs.writeFileSync(
+        path.join(outDir, outFile),
+        JSON.stringify(policy, null, 2),
+        "utf-8"
+      );
+      console.log(
+        `[dfs-app-update] wrote ${outFile} version=${policy.version} breaking=${policy.breaking}`
+      );
+    },
+  };
+}
+
+module.exports = generateAppUpdateVersion;
+module.exports.default = generateAppUpdateVersion;

package/vite-plugin-app-update.js

@@ -0,0 +1,80 @@
+/**
+ * Vite 插件：根据业务项目根目录 app-update.config.json 生成 /version.json
+ *
+ * import generateAppUpdateVersion from 'dfs-page-config/vite-plugin-app-update'
+ * plugins: [generateAppUpdateVersion()]
+ *
+ * app-update.config.json:
+ *   { "breaking": 0, "forceReloadRoutes": [] }
+ */
+import fs from "fs";
+import path from "path";
+
+/**
+ * @param {object} [options]
+ * @param {string} [options.configFile='app-update.config.json'] 相对 cwd 的配置路径
+ * @param {string} [options.outFile='version.json'] 写入 dist 的文件名
+ * @returns {import('vite').Plugin}
+ */
+export default function generateAppUpdateVersion(options = {}) {
+  const configFile = options.configFile || "app-update.config.json";
+  const outFile = options.outFile || "version.json";
+
+  function readConfig() {
+    const configPath = path.resolve(process.cwd(), configFile);
+    if (!fs.existsSync(configPath)) {
+      return { breaking: 0, forceReloadRoutes: [] };
+    }
+    const raw = JSON.parse(fs.readFileSync(configPath, "utf-8"));
+    return {
+      breaking: Number(raw.breaking) || 0,
+      forceReloadRoutes: Array.isArray(raw.forceReloadRoutes)
+        ? raw.forceReloadRoutes.map(String)
+        : [],
+    };
+  }
+
+  function buildPolicy() {
+    const config = readConfig();
+    return {
+      version: `${Date.now()}`,
+      breaking: config.breaking,
+      forceReloadRoutes: config.forceReloadRoutes,
+    };
+  }
+
+  return {
+    name: "dfs-generate-app-update-version",
+    configureServer(server) {
+      server.middlewares.use((req, res, next) => {
+        const url = req.url?.split("?")[0];
+        if (url !== `/${outFile}`) {
+          next();
+          return;
+        }
+        try {
+          const body = JSON.stringify(buildPolicy());
+          res.setHeader("Content-Type", "application/json; charset=utf-8");
+          res.setHeader("Cache-Control", "no-store, no-cache, must-revalidate");
+          res.end(body);
+        } catch (err) {
+          res.statusCode = 500;
+          res.end(JSON.stringify({ message: String(err) }));
+        }
+      });
+    },
+    closeBundle() {
+      const outDir = path.resolve(process.cwd(), "dist");
+      if (!fs.existsSync(outDir)) return;
+      const policy = buildPolicy();
+      fs.writeFileSync(
+        path.join(outDir, outFile),
+        JSON.stringify(policy, null, 2),
+        "utf-8"
+      );
+      console.log(
+        `[dfs-app-update] wrote ${outFile} version=${policy.version} breaking=${policy.breaking}`
+      );
+    },
+  };
+}