@cdfrd/publish-notification-plugin 0.1.0 → 0.1.2

package/README.md

@@ -1,106 +1,77 @@
-# publish-notification-plugin
+# @cdfrd/publish-notification-plugin
 
-Web 端版本更新提醒插件，支持 **Vite** / **Webpack 5**，可接入 qiankun 微前端。仅在 **production** 构建时注入。
+Web 版本更新提醒工具包：**Runtime API** + **薄构建辅助**（只生成 `version.json`，不注入 HTML / 脚本）。本版以 **Vite** 为主。
 
 ## 安装
 
 ```bash
-pnpm add publish-notification-plugin -D
+pnpm add @cdfrd/publish-notification-plugin
 ```
 
-## 快速接入
-
-### 单体应用
+## 单体应用（Vite 双零配置）
 
 ```ts
 // vite.config.ts
-import { ViteUpdateNotificationPlugin } from 'publish-notification-plugin'
+import { defineConfig } from 'vite'
+import { vitePluginVersion } from '@cdfrd/publish-notification-plugin/vite'
 
 export default defineConfig({
-  plugins: [ViteUpdateNotificationPlugin()],
+  plugins: [vitePluginVersion()],
 })
 ```
 
-```js
-// webpack.config.js
-const { WebpackUpdateNotificationPlugin } = require('publish-notification-plugin')
+```ts
+// main.ts
+import { createUpdateNotice } from '@cdfrd/publish-notification-plugin'
 
-module.exports = {
-  plugins: [
-    new HtmlWebpackPlugin({ template: './index.html' }),
-    new WebpackUpdateNotificationPlugin(),
-  ],
-}
+createUpdateNotice()
 ```
 
-未配置字段走默认：中文、浅色主题、可选更新、右上角、10 分钟轮询。
-
-### 微前端（qiankun）
+## 微前端（qiankun）
 
-1. **Host 必装**插件（创建 `window.updateNoticeManager`）
-2. 子应用各自安装，并配置 `microApp: { enabled: true, appId }`（`appId` 须与 qiankun `app.name` 一致）
-3. Host 在路由 / `beforeMount` 中调用 `setActiveApp(appId)`，只有当前激活应用会弹窗
+每个应用各自接入 `vitePluginVersion()` + `createUpdateNotice`；Host 同步 `setActiveApp`。
 
 ```ts
-// host
-ViteUpdateNotificationPlugin({
-  microApp: { enabled: true, appId: 'host' },
-})
+// host/main.ts
+import { createUpdateNotice, getUpdateNotice } from '@cdfrd/publish-notification-plugin'
 
-// 子应用
-ViteUpdateNotificationPlugin({
-  microApp: { enabled: true, appId: 'order-center' },
+createUpdateNotice({
+  microApp: { enabled: true, appId: 'host' },
+  // 纯壳 Host：disableNotification: true,
 })
-```
 
-```ts
 registerMicroApps(apps, {
   beforeMount: [
     (app) => {
-      window.updateNoticeManager?.setActiveApp(app.name)
+      getUpdateNotice()?.setActiveApp(app.name)
       return Promise.resolve()
     },
   ],
 })
-
-// Host 自有页（如 /home）按路由同步
-window.updateNoticeManager?.setActiveApp('host')
 ```
 
-
-
-## 常用配置与运行时
-
-
-| 场景        | 做法                                                 |
-| --------- | -------------------------------------------------- |
-| 强制更新      | `forcedUpdate: true`，可选 `countdown`（默认 30s）        |
-| 改文案       | `notification`（单语言）或 `localeData`（多语言，二者勿同时配）      |
-| 纯壳 Host   | `disableNotification: true`（只建 Manager，自己不弹窗）      |
-| 自定义 UI    | `hiddenDefaultNotice: true`，监听 `web_update_notice` |
-| 切换主题 / 语言 | `setTheme('dark'                                   |
-
-
 ```ts
-window.updateNoticeManager?.setTheme('dark')
-window.updateNoticeManager?.setLocale('en_US')
-window.updateNoticeManager?.checkUpdate()
+// order/main.ts
+createUpdateNotice({
+  microApp: { enabled: true, appId: 'order-center' },
+})
 ```
 
+## 事后切换语言 / 主题
 
+```ts
+import { getUpdateNotice } from '@cdfrd/publish-notification-plugin'
+
+getUpdateNotice()?.setLocale('en_US')
+getUpdateNotice()?.setTheme('dark')
+```
 
 ## 本地示例
 
 ```bash
 pnpm install
 pnpm build
-pnpm dev:vite    # http://localhost:7100
-pnpm dev:webpack # http://localhost:7200
+pnpm dev:vite   # Host http://localhost:7100 · 单体 http://localhost:7103
 ```
 
-更多示例说明见 [docs/examples.md](./docs/examples.md)。
-
-# TODO:
-
-> Webpack插件功能待测试
-
+更多示例见 [docs/examples.md](./docs/examples.md)。