mvframe 1.0.73 → 1.0.74

package/README.cn.md

@@ -19,6 +19,7 @@
 - `"."` → `dist/index.js`（主插件，默认导出 `install` 函数）
 - `"./composition"` → `dist/composition.js`（`import { useMap, … } from 'mvframe/composition'`）
 - `"./store"`、`"./directive"`、`"./util"` → 对应 `dist` 下分包
+- `"./notify"` → `dist/notify.js`（浏览器端请求本地 `mvframe-notify` 服务的通知 helper）
 - `"./style"` → `dist/css/style.css`（由 `src/style/index.scss` 单独入口打包的全量工具类/变量）
 - `"./style/cpt"` → `dist/css/cpt.css`（随组件抽取的样式；一般用 `mvframe/style` 即可）
 
@@ -153,6 +154,59 @@ yarn build
 
 ---
 
+## 钉钉通知服务
+
+MVFrame 提供只支持钉钉机器人的本地 Node 服务，命令由框架包提供：
+
+```bash
+# 仅启动钉钉通知服务
+yarn notify
+# 或发布包命令
+yarn exec mvframe-notify
+
+# 同时启动 yarn dev 与通知服务
+yarn d
+# 或发布包命令
+yarn exec mvframe-d
+```
+
+服务读取宿主项目根目录的 `.env.mvframe-notify`（可用 `--env` 指定）：
+
+```env
+MVFRAME_NOTIFY_PORT=3300
+MVFRAME_NOTIFY_HOST=127.0.0.1
+MVFRAME_NOTIFY_TOKEN=
+DINGTALK_WEBHOOK="https://oapi.dingtalk.com/robot/send?access_token=xxxxxxxx"
+DINGTALK_SECRET="SECxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+```
+
+浏览器端只配置本地服务地址和访问 token：
+
+```js
+app.use(mvframe, {
+  config: {
+    notify: {
+      enabled: true,
+      endpoint: import.meta.env.VITE_MVFRAME_NOTIFY_ENDPOINT || "http://127.0.0.1:3300",
+      token: import.meta.env.VITE_MVFRAME_NOTIFY_TOKEN || "",
+    },
+  },
+});
+```
+
+发送消息：
+
+```js
+await globalThis.$notify.send("需要发送到钉钉的消息");
+
+import { notify } from "mvframe/notify";
+await notify("需要发送到钉钉的消息");
+```
+
+钉钉 webhook / secret 必须留在 Node 服务环境变量里，不要写进 `main.js`、`src/config/index.js` 或其它会被 Vite 打包到浏览器的文件。
+
+---
+
 ## 设计取向与注意
 
 - 布局、路由守卫、Tab、菜单等 **强绑定一套交互模型**；深度定制时可局部 fork `src/router`、`src/store/tab.js` 或外层包一层封装。  
@@ -163,7 +217,7 @@ yarn build
 
 ## 命令行：项目目录雏形（推荐）
 
-在**空目录或已有 Vite 工程根目录**执行，生成 `src/views`、`src/component`、`src/api`、`src/assets/img`、`src/assets/style`、`src/router`、`src/pinia/chip`、`src/config` 及示例 `main.js` / `App.vue`（已 `app.use(mvframe, …)` 挂好路由、Pinia `storeChips`、config），同时写入/更新宿主项目 **`AGENTS.md`** 的 MVFrame Codex 规则，并复制 **`/.cursor/rules/*.mdc`**（与 mvframe 仓库内 Cursor 规则一致）。若不存在则附带 `index.html` 与 `vite.config.js`。会**合并** `package.json` 的 `scripts` / `dependencies` / `devDependencies`（与 Vite 模板一致；**同名脚本和包保留你原有值**），并自动执行 **`yarn install`**，最后请执行 **`yarn dev`**；加 `--no-package-json` 可不改动 `package.json` 且跳过安装。
+在**空目录或已有 Vite 工程根目录**执行，生成 `src/views`、`src/component`、`src/api`、`src/assets/img`、`src/assets/style`、`src/router`、`src/pinia/chip`、`src/config` 及示例 `main.js` / `App.vue`（已 `app.use(mvframe, …)` 挂好路由、Pinia `storeChips`、config），同时写入/更新宿主项目 **`AGENTS.md`** 的 MVFrame Codex 规则，并复制 **`/.cursor/rules/*.mdc`**（与 mvframe 仓库内 Cursor 规则一致）。若不存在则附带 `index.html` 与 `vite.config.js`。会**合并** `package.json` 的 `scripts` / `dependencies` / `devDependencies`（与 Vite 模板一致；**同名脚本和包保留你原有值**），初始化 `.env.mvframe-notify.example` / `.env.local.example` 与 `config.notify`，并自动执行 **`yarn install`**，最后请执行 **`yarn dev`**；需要同时启动通知服务时显式执行 **`yarn exec mvframe-d`**。加 `--no-package-json` 可不改动 `package.json` 且跳过安装。
 
 ```bash
 cd /path/to/your-app
@@ -220,6 +274,15 @@ yarn exec mvframe-install-cursor-skill
 
 ---
 
+## 迭代记录
+
+- 新增 `mvframe-notify`：只支持钉钉机器人的本地通知服务，钉钉 webhook / secret 留在 Node 环境变量。
+- 新增 `mvframe/notify` 与全局 `$notify`：前端通过 `config.notify` 请求本地通知服务。
+- 新增框架命令 `yarn d` / `mvframe-d`：同时启动 `yarn dev` 与钉钉通知服务。
+- `mvframe-init-app` 初始化 `config.notify`、`.env.mvframe-notify.example` 与 `.env.local.example`，不自动覆盖宿主 `d` 脚本。
+
+---
+
 ## 协议
 
 ISC（见 `package.json`）。

package/README.md

@@ -19,6 +19,7 @@ A Vue 3 + Vite oriented admin-shell toolkit: **Frame layout**, **common business
 - `"."` → `dist/index.js` (main plugin; default export is the `install` function)
 - `"./composition"` → `dist/composition.js` (e.g. `import { useMap } from 'mvframe/composition'`)
 - `"./store"`, `"./directive"`, `"./util"` → matching chunks under `dist`
+- `"./notify"` → `dist/notify.js` (browser helper for the local `mvframe-notify` service)
 - `"./style"` → `dist/css/style.css` (full toolkit CSS from `src/style/index.scss` entry)
 - `"./style/cpt"` → `dist/css/cpt.css` (component-extracted CSS; usually `import 'mvframe/style'` is enough)
 
@@ -153,6 +154,46 @@ Production uses **library mode** with entry `src/index.js` and obfuscation-relat
 
 ---
 
+## DingTalk Notify Service
+
+MVFrame ships a local Node service for DingTalk robot messages only:
+
+```bash
+yarn notify
+yarn exec mvframe-notify
+
+yarn d
+yarn exec mvframe-d
+```
+
+The service reads `.env.mvframe-notify` from the host root:
+
+```env
+MVFRAME_NOTIFY_PORT=3300
+MVFRAME_NOTIFY_HOST=127.0.0.1
+MVFRAME_NOTIFY_TOKEN=
+DINGTALK_WEBHOOK="https://oapi.dingtalk.com/robot/send?access_token=xxxxxxxx"
+DINGTALK_SECRET="SECxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+```
+
+Browser code should only configure the local endpoint/token:
+
+```js
+app.use(mvframe, {
+  config: {
+    notify: {
+      enabled: true,
+      endpoint: import.meta.env.VITE_MVFRAME_NOTIFY_ENDPOINT || "http://127.0.0.1:3300",
+      token: import.meta.env.VITE_MVFRAME_NOTIFY_TOKEN || "",
+    },
+  },
+});
+```
+
+Send messages with `globalThis.$notify.send("message")` or `import { notify } from "mvframe/notify"`. Keep DingTalk webhook/secret out of browser-bundled files.
+
+---
+
 ## Design notes
 
 - Layout, guards, tabs, and menu behavior are **opinionated**; heavy customization may mean forking `src/router`, `src/store/tab.js`, or wrapping from the app.  
@@ -163,7 +204,7 @@ Production uses **library mode** with entry `src/index.js` and obfuscation-relat
 
 ## CLI: project skeleton
 
-From an **empty folder or existing Vite root**, generates `src/views`, `src/component`, `src/api`, `src/assets/img`, `src/assets/style`, `src/router`, `src/pinia/chip`, `src/config`, plus starter `main.js` / `App.vue` with `app.use(mvframe, …)` (routes, Pinia `storeChips`, config). It also writes/updates host-project **`AGENTS.md`** with MVFrame Codex rules, and copies **`/.cursor/rules/*.mdc`** from the package (same as this repo’s Cursor rules). Adds `index.html` and `vite.config.js` only if missing (use `--force` to overwrite). **Merges** `scripts` / `dependencies` / `devDependencies` into `package.json` (existing values win for shared keys), then runs **`yarn install`**; use `--no-package-json` to skip package changes and install. Then run **`yarn dev`**.
+From an **empty folder or existing Vite root**, generates `src/views`, `src/component`, `src/api`, `src/assets/img`, `src/assets/style`, `src/router`, `src/pinia/chip`, `src/config`, plus starter `main.js` / `App.vue` with `app.use(mvframe, …)` (routes, Pinia `storeChips`, config). It also writes/updates host-project **`AGENTS.md`** with MVFrame Codex rules, and copies **`/.cursor/rules/*.mdc`** from the package (same as this repo’s Cursor rules). Adds `index.html` and `vite.config.js` only if missing (use `--force` to overwrite). **Merges** `scripts` / `dependencies` / `devDependencies` into `package.json` (existing values win for shared keys), initializes `.env.mvframe-notify.example` / `.env.local.example` and `config.notify`, then runs **`yarn install`**; use `--no-package-json` to skip package changes and install. Then run **`yarn dev`** or explicitly run **`yarn exec mvframe-d`** to start Vite with the notify service.
 
 ```bash
 cd /path/to/your-app
@@ -218,6 +259,15 @@ Default target is **`./.cursor/skills/mvframe-app-init`** under the current work
 
 ---
 
+## Changelog
+
+- Added `mvframe-notify`, a DingTalk-only local Node notification service.
+- Added `mvframe/notify` and global `$notify` for browser calls through `config.notify`.
+- Added framework command `yarn d` / `mvframe-d` to run `yarn dev` with the notify service.
+- `mvframe-init-app` now initializes `config.notify`, `.env.mvframe-notify.example`, and `.env.local.example` without forcing host `d` scripts.
+
+---
+
 ## License
 
 ISC (see `package.json`).

package/dist/index.js

@@ -1,17 +1,18 @@
 import "./util.js";
 import "./directive.js";
 import "./store-shared.js";
-import { j as m, k as o, g as n, a as r, m as g, b as l, c as u, n as L, p as M, u as c } from "./vendor.js";
+import { j as o, k as r, g as n, a as g, m as l, b as u, c as L, n as M, p as c, u as b } from "./vendor.js";
+import "./notify.js";
 import "./composition.js";
 export {
-  m as builtinLocales,
-  o as default,
+  o as builtinLocales,
+  r as default,
   n as getBuiltinLangMaps,
-  r as getMaps,
-  g as mapLang,
-  l as mapLangPath,
-  u as mergeMaps,
-  L as normalizeBuiltinLocale,
-  M as patchMaps,
-  c as useMap
+  g as getMaps,
+  l as mapLang,
+  u as mapLangPath,
+  L as mergeMaps,
+  M as normalizeBuiltinLocale,
+  c as patchMaps,
+  b as useMap
 };

package/dist/notify.js

@@ -0,0 +1,80 @@
+const y = {
+  endpoint: "",
+  path: "/notify",
+  token: "",
+  timeout: 5e3
+};
+function d(n) {
+  return String(n || "").replace(/\/+$/, "");
+}
+function m(n) {
+  const t = String(n || "/notify");
+  return t.startsWith("/") ? t : `/${t}`;
+}
+function p(n = {}) {
+  var t;
+  return {
+    ...y,
+    ...((t = globalThis.$config) == null ? void 0 : t.notify) || {},
+    ...n || {}
+  };
+}
+function l(n = {}) {
+  const t = async (s, r = {}) => {
+    var f;
+    const o = p({
+      ...n,
+      ...r.config || {}
+    });
+    if (o.enabled === !1)
+      return {
+        ok: !0,
+        skipped: !0,
+        message: "notify disabled"
+      };
+    if (!o.endpoint)
+      throw new Error("missing notify.endpoint");
+    const c = new AbortController(), g = Number(o.timeout || 5e3), u = setTimeout(() => c.abort(), g);
+    try {
+      const i = await fetch(`${d(o.endpoint)}${m(o.path)}`, {
+        method: "POST",
+        headers: {
+          "Content-Type": "application/json",
+          ...o.token ? { "x-mvframe-notify-token": o.token } : {}
+        },
+        body: JSON.stringify({
+          message: s,
+          atMobiles: r.atMobiles,
+          atUserIds: r.atUserIds,
+          atAll: r.atAll
+        }),
+        signal: c.signal
+      }), e = (i.headers.get("content-type") || "").includes("application/json") ? await i.json() : { message: await i.text() };
+      if (!i.ok || (e == null ? void 0 : e.ok) === !1) {
+        const a = new Error((e == null ? void 0 : e.message) || ((f = e == null ? void 0 : e.push) == null ? void 0 : f.message) || "notify failed");
+        throw a.response = i, a.payload = e, a;
+      }
+      return e;
+    } finally {
+      clearTimeout(u);
+    }
+  };
+  return {
+    send: t,
+    ding: t,
+    dingtalk: t
+  };
+}
+async function b(n, t) {
+  return l().send(n, t);
+}
+const T = (n, t = {}) => {
+  const s = l(t);
+  n.config.globalProperties.$notify = s, globalThis.$notify = s;
+};
+export {
+  l as createNotifyClient,
+  T as default,
+  p as getNotifyConfig,
+  b as notify
+};