dsh-jianji 1.0.27 → 1.0.29

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # 简记
2
2
 
3
- 简记现在是一个 DeepSeek Harness(DSH)插件,在 DSH Web 端和桌面端左侧菜单提供“简记”入口。原有待办、记录、标签、搜索、看板、统计、Gitee 同步和 Android APK 能力继续保留,并新增按主题组织的灵感空间。
3
+ 简记现在是一个 DeepSeek Harness(DSH)插件,在 DSH Web 端和桌面端左侧菜单提供“简记”入口。原有待办、笔记、标签、搜索、看板、统计、Gitee 同步和 Android APK 能力继续保留。
4
4
 
5
5
  ## DSH 插件
6
6
 
@@ -13,15 +13,23 @@ dsh --profile web
13
13
 
14
14
  `dsh-jianji` 发布在 npm 官方 registry。省略版本号时会安装 `latest`;需要固定当前版本时使用 `dsh-jianji@1.0.20`。如果本机 npm 默认源不是官网,执行命令时必须保留 `--registry=https://registry.npmjs.org/`。
15
15
 
16
- 启动后,左侧菜单会出现“简记”。待办、记录、灵感、常用标签以及插件设置都由 DSH Host 持久化在 `$DSH_HOME/storages/jianji/`,不再只依赖插件页面的浏览器 localStorage。DSH 重启或插件重新加载后,Gitee 仓库、Gitee 私人令牌、DeepSeek API Key 与 GitHub 更新令牌会自动恢复。
16
+ 也可以在 DSH 的**插件 → 发现**里添加索引源后一键安装和更新:
17
17
 
18
- 插件同时向模型注册以下工具,待办、记录、灵感和常用标签均可读取与修改:
18
+ ```text
19
+ https://fastly.jsdelivr.net/npm/dsh-jianji@latest/market/index.json
20
+ ```
21
+
22
+ 这个索引随 npm 包一起发布,已经落在 `market/index.json`,由发版流程自动重建,所以「发现」里始终能看到当前发布的版本。
23
+
24
+ 启动后,左侧菜单会出现“简记”。待办、Markdown 笔记、图片附件、常用标签以及插件设置都由 DSH Host 持久化在 `$DSH_HOME/storages/jianji/`,不再只依赖插件页面的浏览器 localStorage。DSH 重启或插件重新加载后,Gitee 仓库、Gitee 私人令牌、DeepSeek API Key 与 GitHub 更新令牌会自动恢复。
25
+
26
+ 插件同时向模型注册以下工具,待办、笔记和常用标签均可读取与修改:
19
27
 
20
28
  - `jianji_list`:按类型、状态、来源、日期、关键词和数量读取数据。
21
- - `jianji_get`:按 id 或 `sourceKey` 读取一条待办、记录或灵感的全部字段。
22
- - `jianji_create`:新建待办、记录或灵感;待办支持文字醒目样式和“AI 整理”来源字段,灵感需要主题与内容。
23
- - `jianji_update`:更新状态、正文、截止日期、标签、置顶、排序或灵感主题等字段,可追加执行结果。
24
- - `jianji_delete`:软删除或永久删除待办、记录与灵感。
29
+ - `jianji_get`:按 id 或 `sourceKey` 读取一条待办或笔记的全部字段。
30
+ - `jianji_create`:新建待办或笔记;待办支持任务清单、文字醒目样式和“AI 整理”来源字段,笔记支持 Markdown 正文与图片附件。
31
+ - `jianji_update`:更新状态、清单、正文、截止日期、标签、置顶、排序等字段,可追加执行结果。
32
+ - `jianji_delete`:软删除或永久删除待办与笔记。
25
33
  - `jianji_tags`:读取、添加或移除常用标签。
26
34
  - `jianji_sync_ai_tasks`:按天批量写入“AI 整理”待办,以 `sourceKey` 去重,供每日定时任务增量产出和更新。
27
35
 
@@ -36,12 +44,13 @@ DSH Web 端和 Electron 桌面端共用同一个 Host 数据源。Gitee 私人
36
44
  | 数据 | 读取 | 新建 | 更新 | 删除 |
37
45
  | --- | --- | --- | --- | --- |
38
46
  | 待办 `task` | `jianji_list` / `jianji_get` | `jianji_create` | `jianji_update` | `jianji_delete` |
39
- | 记录 `record` | `jianji_list` / `jianji_get` | `jianji_create` | `jianji_update` | `jianji_delete` |
40
- | 灵感 `inspiration` | `jianji_list` / `jianji_get` | `jianji_create` | `jianji_update` | `jianji_delete` |
47
+ | 笔记 `record`(兼容资源名) | `jianji_list` / `jianji_get` | `jianji_create` | `jianji_update` | `jianji_delete` |
41
48
  | 常用标签 `common_tag` | `jianji_tags`(`list`) | `jianji_tags`(`add`) | — | `jianji_tags`(`remove`) |
42
49
  | AI 整理待办 | `jianji_list`(`source: "ai"`) | `jianji_sync_ai_tasks` | `jianji_sync_ai_tasks` / `jianji_update` | `jianji_sync_ai_tasks`(`removeMissing`)/ `jianji_delete` |
43
50
 
44
- 待办字段固定为 `title`、`notes`、`status`(`todo` / `doing` / `held` / `done`)、`emphasis`、`dueDate`、`tags`、`pinned`、`order`,以及“AI 整理”用的 `source`(`manual` / `ai`)、`sourceKey`、`sourceDate`(`YYYY-MM-DD`);记录为 `title`、`body`;灵感为 `topic`、`body`。所有字段都会随 Gitee 同步在设备之间保持一致。
51
+ 待办字段固定为 `title`、`checklist`、`notes`、`status`(`todo` / `doing` / `held` / `done`)、`emphasis`、`dueDate`、`tags`、`pinned`、`order`,以及“AI 整理”用的 `source`(`manual` / `ai`)、`sourceKey`、`sourceDate`(`YYYY-MM-DD`);笔记为 `title`、Markdown `body` 和 `attachments`。图片附件项包含 `id`、`name`、`dataUrl`、`createdAt`,正文使用 `![说明](attachment:id)` 引用。为避免旧调用失效,工具中的资源名继续使用 `record`。所有字段都会随 Gitee 同步在设备之间保持一致。`notes` 是 `checklist` 的纯文本投影,保留给旧版本读取;旧版纯文本正文会在首次读取时整段迁移为第一条清单项。
52
+
53
+ 模型工具读取笔记时,图片附件只返回 `id`、`name`、`createdAt` 和 `hasData`,不会把 Base64 图片重复塞进模型上下文;创建或更新时仍可传入完整 `dataUrl`。
45
54
 
46
55
  ### AI 整理(待办的子分类)
47
56
 
@@ -65,18 +74,19 @@ DSH Web 端和 Electron 桌面端共用同一个 Host 数据源。Gitee 私人
65
74
 
66
75
  ## 功能
67
76
 
68
- - 移动端顶部提供记录、待办、灵感三个主入口,待办状态通过列表分组和筛选查看。
77
+ - 移动端顶部提供笔记、待办两个主入口,待办状态通过列表分组和筛选查看。
69
78
  - 移动端合并顶部导航并显示同步状态,新建或编辑时使用应用内状态、日期选择器和操作提示。
70
- - PC 顶部栏统一提供记录、待办、同步、设置和热力图入口,设置与热力图在弹窗中完成操作。
79
+ - PC 顶部栏统一提供笔记、待办、同步、设置和热力图入口,设置与热力图在弹窗中完成操作。
71
80
  - PC 四列看板每条泳道可以单独打马赛克,排序右侧有“全部马赛克 / 还原全部”一键切换;马赛克状态由 DSH Host 持久化,重启或换了端口也能恢复。
72
81
  - 待办新增“AI 整理”子分类,模型从聊天记录整理的待办集中在这里,每天可由定时任务增量产出和更新。
73
- - 灵感按主题自动聚合,每个主题下可以持续追加、编辑和删除独立灵感。
74
- - 独立的完整记录与随笔空间,不进入待办状态和完成流程。
75
- - 新建或编辑待办、新建记录或灵感时可以上传图片,由 DeepSeek 识别文字并预填标题、正文、主题、到期日与标签。
82
+ - 独立的 Markdown 笔记空间,不进入待办状态和完成流程;新建与编辑使用整页编辑器,桌面端同时显示源码和实时预览,移动端切换编辑/预览。
83
+ - 笔记支持标题、列表、引用、代码、链接和图片。可以选择、粘贴或拖入本地图片,压缩后作为附件随笔记同步;也可以直接使用 Markdown 图片链接。
84
+ - 新建或编辑待办、笔记时可以上传截图,由 DeepSeek 识别文字并预填标题、任务清单、到期日与标签。
76
85
  - 待办文字醒目支持普通、加粗、下划线、强调及红、橙、绿、蓝、紫五种文字颜色,并随待办同步。
86
+ - 待办正文改为可勾选的任务清单:标题与清单至少填一项即可保存;清单项支持新增、编辑、删除和拖动排序,保存时只保留非空项、已完成的项自动沉到未完成项之后,卡片显示 n/m 完成进度,详情里逐条勾选。
77
87
  - 新建、编辑、标签、截止日期、搜索、置顶、拖拽排序和撤销。
78
88
  - PC 四列看板与移动端单列/双列布局。
79
- - 待办、记录与灵感优先保存在本机,可通过 Gitee 私有仓库在 PC 与 Android 间同步。
89
+ - 待办、笔记与笔记图片附件优先保存在本机,可通过 Gitee 私有仓库在 PC 与 Android 间同步。
80
90
  - Android 启动时自动检查 GitHub Release,并可在应用内浏览历史版本、查看更新内容、下载、校验和安装 APK。
81
91
  - Android 截止日当天 09:00 本地通知,完成后自动取消。
82
92
  - Android 13+ 通知权限、闹钟与提醒权限、重启后恢复通知。
@@ -140,11 +150,13 @@ GitHub Actions 发布包使用固定 release 签名,构建脚本自动同步 W
140
150
 
141
151
  普通提交和推送不会触发版本发布。只有明确要求“提交并升级版本”或“发版”时才会执行发布流程。发布顺序固定为先发布 DSH 插件,再构建 Android APK,确保两边使用同一个版本:
142
152
 
143
- 1. 本地递增 `patch` 版本、`versionCode` 和 Android `versionName`,提交并推送版本变更。
153
+ 1. 本地递增 `patch` 版本、`versionCode` 和 Android `versionName`,同时重新生成「发现」用的插件索引 `market/index.json`,提交并推送版本变更。
144
154
  2. 发布 DSH 插件并验证 npm registry 的 `latest` 与 `gitHead`。
145
- 3. 触发 Android 工作流;工作流校验 npm 版本后构建并签名 APK。
155
+ 3. 触发 Android 工作流;工作流校验 npm 版本和插件索引后构建并签名 APK。
146
156
  4. 创建 `vX.Y.Z` 标签和 GitHub Release,上传 APK 与 SHA256。
147
157
 
158
+ 第 1 步由 `node scripts/bump-version.js` 一并完成:它在改完版本号后调用 `scripts/build-market-index.mjs`,从 npm registry 读取全部版本并写入 `market/index.json`,本次待发布版本也会补进去,因此索引随 npm 包一起发布,不需要单独维护。索引生成失败时 bump 会提示,补跑 `npm run market:index` 即可;`npm publish` 前的 `market:check` 会拦住索引不含本次版本的发布。
159
+
148
160
  需要升级 `minor` 或 `major` 时,在本地将 `node scripts/bump-version.js patch` 中的 `patch` 替换为对应类型。npm 发布成功后使用 GitHub CLI 触发构建:
149
161
 
150
162
  ```powershell
@@ -212,8 +224,8 @@ Android 首次开启“设置与同步 → 截止日提醒”时,系统会请
212
224
 
213
225
  同步规则:
214
226
 
215
- - 记录、待办和灵感应分别保存在 `records.json`、`todos.json` 和 `inspirations.json`;目标文件不存在时会自动创建。
216
- - 旧版单文件中的记录和灵感会在首次同步时自动迁移到对应文件,之后以三个独立文件为准。
227
+ - 笔记与待办分别保存在兼容文件名 `records.json` 和 `todos.json`;目标文件不存在时会自动创建。保留 `records.json` 文件名是为了不破坏已有同步仓库。
228
+ - 旧版单文件中的笔记会在首次同步时自动迁移到 `records.json`,之后以两个独立文件为准。
217
229
  - 断网时继续使用本地数据,联网后自动同步。
218
230
  - 每个待办带独立更新时间,不同设备的修改按事项合并。
219
231
  - 删除使用 90 天墓碑记录,避免离线设备把已删除事项重新带回。
@@ -224,14 +236,14 @@ Android 首次开启“设置与同步 → 截止日提醒”时,系统会请
224
236
 
225
237
  1. 在 DeepSeek 开放平台生成 API Key。
226
238
  2. 打开简记的“设置 → 图片转文字”,填写 Key 并保存。
227
- 3. 新建或编辑待办、新建记录或灵感时点击“图片转文字”,选择一张截图;识别结果会直接填入表单,保存前仍可修改。
239
+ 3. 新建或编辑待办、笔记时点击“图片转文字”,选择一张截图;识别结果会直接填入整页表单,保存前仍可修改。
228
240
 
229
241
  图片识别使用 `deepseek-flash` 的 `image_url` 输入。上传前会在本机压缩图片;未配置 Key 或调用失败时不会影响手动填写和保存。
230
242
 
231
243
  ## 数据与隐私
232
244
 
233
245
  - DSH 插件中的 Gitee 令牌、GitHub 更新令牌、DeepSeek API Key 和连接设置保存在 `$DSH_HOME/storages/jianji/`;独立 Web 和 Android 版本仍保存在浏览器或 Android WebView 的本地存储中。
234
- - DeepSeek API Key 不会进入待办数据或同步仓库。图片转文字时,压缩后的图片只会发送到 `api.deepseek.com`。
246
+ - DeepSeek API Key 不会进入待办数据或同步仓库。图片转文字时,压缩后的图片只会发送到 `api.deepseek.com`,不会作为笔记附件保存。手动添加到笔记的图片会写入该笔记的附件并随同步仓库上传。
235
247
  - Android 禁止应用数据备份,避免令牌随系统备份迁移。
236
248
  - Gitee 令牌只用于请求 Gitee API;GitHub 更新令牌只用于请求 GitHub Release API 和下载 APK。
237
249
 
@@ -240,7 +252,7 @@ Android 首次开启“设置与同步 → 截止日提醒”时,系统会请
240
252
  ```text
241
253
  index.html 应用页面
242
254
  src/app.js 待办交互、本地存储与 Gitee 同步
243
- src/sync-files.js 三类远端 JSON 文件的路径与文档格式
255
+ src/sync-files.js 两类远端 JSON 文件的路径与文档格式
244
256
  src/recognizer.js 图片压缩、DeepSeek 识图与结果归一化
245
257
  src/reminders.js Android 本地通知与提醒调度
246
258
  src/updater.js GitHub Release 检查、版本比较与更新下载