unplugin-version-checker 1.0.0

package/dist/esbuild.cjs

@@ -0,0 +1,8 @@
+'use strict';
+
+const index = require('./index.cjs');
+require('unplugin');
+
+const esbuild = index.esbuild;
+
+module.exports = esbuild;

package/dist/esbuild.d.cts

@@ -0,0 +1,3 @@
+declare const _default: any;
+
+export = _default;

package/dist/esbuild.d.mts

@@ -0,0 +1,3 @@
+declare const _default: any;
+
+export { _default as default };

package/dist/esbuild.d.ts

@@ -0,0 +1,3 @@
+declare const _default: any;
+
+export = _default;

package/dist/esbuild.mjs

@@ -0,0 +1,6 @@
+import unplugin from './index.mjs';
+import 'unplugin';
+
+const esbuild = unplugin.esbuild;
+
+export { esbuild as default };

package/dist/index.cjs

@@ -0,0 +1,47 @@
+'use strict';
+
+const unplugin$1 = require('unplugin');
+
+const unplugin = unplugin$1.createUnplugin((options = {}) => {
+  const {
+    metaFileName = "meta.json",
+    generateOnBuild = true,
+    devMock = true,
+    injectComponent = false
+    // 由于跨构建工具自动注入组件复杂，建议用户手动注册组件
+  } = options;
+  return {
+    name: "unplugin-version-checker",
+    enforce: "post",
+    writeBundle() {
+      if (!generateOnBuild) return;
+      const versionInfo = {
+        buildTime: (/* @__PURE__ */ new Date()).toISOString(),
+        version: process.env.BUILD_ID || process.env.npm_package_version,
+        commitHash: process.env.COMMIT_SHORT || process.env.GIT_COMMIT_SHORT
+      };
+      this.emitFile({
+        type: "asset",
+        fileName: metaFileName,
+        source: JSON.stringify(versionInfo, null, 2)
+      });
+    },
+    configureServer(server) {
+      if (!devMock) return;
+      server.middlewares.use((req, res, next) => {
+        if (req.url === `/${metaFileName}`) {
+          res.setHeader("Content-Type", "application/json");
+          res.end(JSON.stringify({
+            buildTime: (/* @__PURE__ */ new Date()).toISOString(),
+            version: "dev",
+            commitHash: "dev"
+          }));
+          return;
+        }
+        next();
+      });
+    }
+  };
+});
+
+module.exports = unplugin;

package/dist/index.d.cts

@@ -0,0 +1,3 @@
+declare const _default: any;
+
+export = _default;

package/dist/index.d.mts

@@ -0,0 +1,3 @@
+declare const _default: any;
+
+export { _default as default };

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+declare const _default: any;
+
+export = _default;

package/dist/index.mjs

@@ -0,0 +1,45 @@
+import { createUnplugin } from 'unplugin';
+
+const unplugin = createUnplugin((options = {}) => {
+  const {
+    metaFileName = "meta.json",
+    generateOnBuild = true,
+    devMock = true,
+    injectComponent = false
+    // 由于跨构建工具自动注入组件复杂，建议用户手动注册组件
+  } = options;
+  return {
+    name: "unplugin-version-checker",
+    enforce: "post",
+    writeBundle() {
+      if (!generateOnBuild) return;
+      const versionInfo = {
+        buildTime: (/* @__PURE__ */ new Date()).toISOString(),
+        version: process.env.BUILD_ID || process.env.npm_package_version,
+        commitHash: process.env.COMMIT_SHORT || process.env.GIT_COMMIT_SHORT
+      };
+      this.emitFile({
+        type: "asset",
+        fileName: metaFileName,
+        source: JSON.stringify(versionInfo, null, 2)
+      });
+    },
+    configureServer(server) {
+      if (!devMock) return;
+      server.middlewares.use((req, res, next) => {
+        if (req.url === `/${metaFileName}`) {
+          res.setHeader("Content-Type", "application/json");
+          res.end(JSON.stringify({
+            buildTime: (/* @__PURE__ */ new Date()).toISOString(),
+            version: "dev",
+            commitHash: "dev"
+          }));
+          return;
+        }
+        next();
+      });
+    }
+  };
+});
+
+export { unplugin as default };

package/dist/rollup.cjs

@@ -0,0 +1,8 @@
+'use strict';
+
+const index = require('./index.cjs');
+require('unplugin');
+
+const rollup = index.rollup;
+
+module.exports = rollup;

package/dist/rollup.d.cts

@@ -0,0 +1,3 @@
+declare const _default: any;
+
+export = _default;

package/dist/rollup.d.mts

@@ -0,0 +1,3 @@
+declare const _default: any;
+
+export { _default as default };

package/dist/rollup.d.ts

@@ -0,0 +1,3 @@
+declare const _default: any;
+
+export = _default;

package/dist/rollup.mjs

@@ -0,0 +1,6 @@
+import unplugin from './index.mjs';
+import 'unplugin';
+
+const rollup = unplugin.rollup;
+
+export { rollup as default };

package/dist/runtime.cjs

@@ -0,0 +1,45 @@
+'use strict';
+
+const vue = require('vue');
+
+const VersionChecker = vue.defineComponent({
+  name: "VersionChecker",
+  props: {
+    metaFileName: { type: String, default: "meta.json" },
+    storageKey: { type: String, default: "app-version" },
+    interval: { type: Number, default: 6e4 }
+  },
+  setup(props) {
+    const show = vue.ref(false);
+    let timer;
+    const check = async () => {
+      try {
+        const url = `/${props.metaFileName}?t=${Date.now()}`;
+        const res = await fetch(url);
+        const { buildTime: latest } = await res.json();
+        const local = localStorage.getItem(props.storageKey);
+        if (local && local !== latest) show.value = true;
+        localStorage.setItem(props.storageKey, latest);
+      } catch {
+      }
+    };
+    vue.onMounted(() => {
+      check();
+      timer = setInterval(check, props.interval);
+    });
+    vue.onUnmounted(() => clearInterval(timer));
+    return { show, refresh: () => location.reload(true), dismiss: () => show.value = false };
+  },
+  render() {
+    if (!this.show) return null;
+    return vue.h("div", { class: "version-update-notification" }, [
+      vue.h("span", { class: "message" }, "\u{1F4C4} \u5185\u5BB9\u5DF2\u66F4\u65B0\uFF0C\u8BF7\u5237\u65B0\u9875\u9762"),
+      vue.h("div", { class: "actions" }, [
+        vue.h("button", { class: "refresh", onClick: this.refresh }, "\u5237\u65B0"),
+        vue.h("button", { class: "dismiss", onClick: this.dismiss }, "\u5FFD\u7565")
+      ])
+    ]);
+  }
+});
+
+exports.VersionChecker = VersionChecker;

package/dist/runtime.d.cts

@@ -0,0 +1,3 @@
+declare const VersionChecker: any;
+
+export { VersionChecker };

package/dist/runtime.d.mts

@@ -0,0 +1,3 @@
+declare const VersionChecker: any;
+
+export { VersionChecker };

package/dist/runtime.d.ts

@@ -0,0 +1,3 @@
+declare const VersionChecker: any;
+
+export { VersionChecker };

package/dist/runtime.mjs

@@ -0,0 +1,43 @@
+import { defineComponent, h, ref, onMounted, onUnmounted } from 'vue';
+
+const VersionChecker = defineComponent({
+  name: "VersionChecker",
+  props: {
+    metaFileName: { type: String, default: "meta.json" },
+    storageKey: { type: String, default: "app-version" },
+    interval: { type: Number, default: 6e4 }
+  },
+  setup(props) {
+    const show = ref(false);
+    let timer;
+    const check = async () => {
+      try {
+        const url = `/${props.metaFileName}?t=${Date.now()}`;
+        const res = await fetch(url);
+        const { buildTime: latest } = await res.json();
+        const local = localStorage.getItem(props.storageKey);
+        if (local && local !== latest) show.value = true;
+        localStorage.setItem(props.storageKey, latest);
+      } catch {
+      }
+    };
+    onMounted(() => {
+      check();
+      timer = setInterval(check, props.interval);
+    });
+    onUnmounted(() => clearInterval(timer));
+    return { show, refresh: () => location.reload(true), dismiss: () => show.value = false };
+  },
+  render() {
+    if (!this.show) return null;
+    return h("div", { class: "version-update-notification" }, [
+      h("span", { class: "message" }, "\u{1F4C4} \u5185\u5BB9\u5DF2\u66F4\u65B0\uFF0C\u8BF7\u5237\u65B0\u9875\u9762"),
+      h("div", { class: "actions" }, [
+        h("button", { class: "refresh", onClick: this.refresh }, "\u5237\u65B0"),
+        h("button", { class: "dismiss", onClick: this.dismiss }, "\u5FFD\u7565")
+      ])
+    ]);
+  }
+});
+
+export { VersionChecker };

package/dist/vite.cjs

@@ -0,0 +1,8 @@
+'use strict';
+
+const index = require('./index.cjs');
+require('unplugin');
+
+const vite = index.vite;
+
+module.exports = vite;

package/dist/vite.d.cts

@@ -0,0 +1,3 @@
+declare const _default: any;
+
+export = _default;

package/dist/vite.d.mts

@@ -0,0 +1,3 @@
+declare const _default: any;
+
+export { _default as default };

package/dist/vite.d.ts

@@ -0,0 +1,3 @@
+declare const _default: any;
+
+export = _default;

package/dist/vite.mjs

@@ -0,0 +1,6 @@
+import unplugin from './index.mjs';
+import 'unplugin';
+
+const vite = unplugin.vite;
+
+export { vite as default };

package/dist/webpack.cjs

@@ -0,0 +1,8 @@
+'use strict';
+
+const index = require('./index.cjs');
+require('unplugin');
+
+const webpack = index.webpack;
+
+module.exports = webpack;

package/dist/webpack.d.cts

@@ -0,0 +1,3 @@
+declare const _default: any;
+
+export = _default;

package/dist/webpack.d.mts

@@ -0,0 +1,3 @@
+declare const _default: any;
+
+export { _default as default };

package/dist/webpack.d.ts

@@ -0,0 +1,3 @@
+declare const _default: any;
+
+export = _default;

package/dist/webpack.mjs

@@ -0,0 +1,6 @@
+import unplugin from './index.mjs';
+import 'unplugin';
+
+const webpack = unplugin.webpack;
+
+export { webpack as default };

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "unplugin-version-checker",
+  "version": "1.0.0",
+  "description": "Universal build plugin + Vue component for app version checking",
+  "type": "module",
+  "files": [
+    "dist",
+    "src",
+    "runtime.js"
+  ],
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./vite": {
+      "import": "./dist/vite.js",
+      "require": "./dist/vite.cjs"
+    },
+    "./webpack": {
+      "import": "./dist/webpack.js",
+      "require": "./dist/webpack.cjs"
+    },
+    "./rollup": {
+      "import": "./dist/rollup.js",
+      "require": "./dist/rollup.cjs"
+    },
+    "./runtime": {
+      "import": "./dist/runtime.js",
+      "require": "./dist/runtime.cjs"
+    }
+  },
+  "peerDependencies": {
+    "vue": "^3.2.0"
+  },
+  "devDependencies": {
+    "esbuild": "^0.20.0",
+    "rollup": "^4.0.0",
+    "unbuild": "^3.6.1",
+    "unplugin": "^1.16.1",
+    "vite": "^5.0.0",
+    "vue": "^3.5.28",
+    "webpack": "^5.0.0"
+  },
+  "scripts": {
+    "build": "unbuild",
+    "prepublishOnly": "npm run build"
+  }
+}

package/src/esbuild.ts

@@ -0,0 +1,2 @@
+import unplugin from './index'
+export default unplugin.esbuild

package/src/index.ts

@@ -0,0 +1,46 @@
+import { createUnplugin } from 'unplugin'
+import type { Options } from './types'
+
+export default createUnplugin<Options | undefined>((options = {}) => {
+  const {
+    metaFileName = 'meta.json',
+    generateOnBuild = true,
+    devMock = true,
+    injectComponent = false,  // 由于跨构建工具自动注入组件复杂，建议用户手动注册组件
+  } = options
+
+  return {
+    name: 'unplugin-version-checker',
+    enforce: 'post',
+
+    writeBundle() {
+      if (!generateOnBuild) return
+      const versionInfo = {
+        buildTime: new Date().toISOString(),
+        version: process.env.BUILD_ID || process.env.npm_package_version,
+        commitHash: process.env.COMMIT_SHORT || process.env.GIT_COMMIT_SHORT,
+      }
+      this.emitFile({
+        type: 'asset',
+        fileName: metaFileName,
+        source: JSON.stringify(versionInfo, null, 2),
+      })
+    },
+
+    configureServer(server) {
+      if (!devMock) return
+      server.middlewares.use((req, res, next) => {
+        if (req.url === `/${metaFileName}`) {
+          res.setHeader('Content-Type', 'application/json')
+          res.end(JSON.stringify({
+            buildTime: new Date().toISOString(),
+            version: 'dev',
+            commitHash: 'dev',
+          }))
+          return
+        }
+        next()
+      })
+    }
+  }
+})

package/src/rollup.ts

@@ -0,0 +1,2 @@
+import unplugin from './index'
+export default unplugin.rollup

package/src/runtime.ts

@@ -0,0 +1,43 @@
+import { defineComponent, ref, onMounted, onUnmounted, h } from 'vue'
+
+export const VersionChecker = defineComponent({
+  name: 'VersionChecker',
+  props: {
+    metaFileName: { type: String, default: 'meta.json' },
+    storageKey: { type: String, default: 'app-version' },
+    interval: { type: Number, default: 60000 },
+  },
+  setup(props) {
+    const show = ref(false)
+    let timer: ReturnType<typeof setInterval>
+
+    const check = async () => {
+      try {
+        const url = `/${props.metaFileName}?t=${Date.now()}`
+        const res = await fetch(url)
+        const { buildTime: latest } = await res.json()
+        const local = localStorage.getItem(props.storageKey)
+        if (local && local !== latest) show.value = true
+        localStorage.setItem(props.storageKey, latest)
+      } catch {}
+    }
+
+    onMounted(() => {
+      check()
+      timer = setInterval(check, props.interval)
+    })
+    onUnmounted(() => clearInterval(timer))
+
+    return { show, refresh: () => location.reload(true), dismiss: () => show.value = false }
+  },
+  render() {
+    if (!this.show) return null
+    return h('div', { class: 'version-update-notification' }, [
+      h('span', { class: 'message' }, '📄 内容已更新，请刷新页面'),
+      h('div', { class: 'actions' }, [
+        h('button', { class: 'refresh', onClick: this.refresh }, '刷新'),
+        h('button', { class: 'dismiss', onClick: this.dismiss }, '忽略')
+      ])
+    ])
+  }
+})

package/src/types.ts

@@ -0,0 +1,6 @@
+export interface Options {
+  metaFileName?: string
+  generateOnBuild?: boolean
+  devMock?: boolean
+  injectComponent?: boolean
+}

package/src/vite.ts

@@ -0,0 +1,2 @@
+import unplugin from './index'
+export default unplugin.vite

package/src/webpack.ts

@@ -0,0 +1,2 @@
+import unplugin from './index'
+export default unplugin.webpack