@guowenzhang/dsh-whiteboard 0.2.1 → 0.3.0

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.
Files changed (6) hide show
  1. package/README.md +40 -37
  2. package/README.zh.md +40 -37
  3. package/lib/client.js +5 -2
  4. package/locale/en.json +6 -0
  5. package/locale/zh.json +6 -0
  6. package/package.json +5 -2
package/README.md CHANGED
@@ -1,37 +1,40 @@
1
- # dsh-whiteboard
2
-
3
- Whiteboards for DeepSeek Harness: a board gallery in the main panel and draw.io editing in the Sidebar, with boards stored inside the plugin. No workspace selection is needed: a dedicated session grants write access to the plugin's `files/` directory.
4
-
5
- ## Screenshots
6
-
7
- ![Whiteboard gallery with name search](docs/images/gallery.png)
8
-
9
- ![New whiteboard dialog](docs/images/new-board.png)
10
-
11
- ![Editing a board in draw.io](docs/images/editor.png)
12
-
13
- ## Install
14
-
15
- Install and enable [`@guowenzhang/dsh-drawioedit`](../dsh-drawioedit) first, then this plugin:
16
-
17
- ```sh
18
- npx @deepseek-ai/dsh plugin --profile web add @guowenzhang/dsh-drawioedit
19
- npx @deepseek-ai/dsh plugin --profile web add @guowenzhang/dsh-whiteboard
20
- ```
21
-
22
- From the npm registry: <https://www.npmjs.com/package/@guowenzhang/dsh-whiteboard> — restart the host afterwards; local checkouts, git sources and troubleshooting are in [AGENTS.md](AGENTS.md).
23
-
24
- Restart DSH Web and open **Whiteboards** in the left navigation. **New whiteboard** first opens a dialog with an editable timestamp-based name. Only **Create** writes the `.drawio` file under the plugin's `files/` directory and opens it in drawioedit. Drawioedit autosaves changes. Each card shows its name, a first-page preview, and last modification time. Click the card to edit, or click the top-right X and confirm to delete the file. The persistent search box in the toolbar filters the loaded cards by name and shows an empty-result hint when nothing matches. Returning to the **Whiteboards** page goes straight back to the board whose editor tab is still open — collapsing the Sidebar or switching pages keeps it — and only an explicit tab close, a deleted board or a replaced file leaves you on the gallery. Oversized or unreadable diagrams show a preview placeholder. On desktop, opening a board expands the editor column to fullscreen so draw.io can show its own left shapes palette and right format panel; leaving fullscreen shows the board gallery on the left and keeps the current editor on the right, rather than exposing a blank Conversation. Collapsing the editor also keeps the gallery available; click a card to continue editing.
25
-
26
- New whiteboards have a single `.drawio` file. Legacy UUID files and their sidecars remain visible. Back up `files/` before replacing or uninstalling the plugin.
27
-
28
- ## Development
29
-
30
- ```sh
31
- npm ci --legacy-peer-deps
32
- npm run typecheck
33
- npm run build
34
- npm test
35
- ```
36
-
37
- Commit the generated `lib/` with source changes. `dsh-drawioedit` supplies the editor assets at runtime.
1
+ # dsh-whiteboard
2
+
3
+ English | [中文](README.zh.md)
4
+
5
+ ## Why I built this plugin
6
+
7
+ I often need somewhere to jot down drafts while thinking. I used to do that in documents, but now that AI tools are part of my everyday workflow, I wanted that space right inside DeepSeek Harness. A whiteboard is more flexible for sketching ideas and mapping out processes. It uses the open `.drawio` file format, so boards can also be edited in draw.io and other compatible tools.
8
+
9
+ In the plugin list, display names and descriptions follow the Harness language setting in English or Chinese (English is the default fallback); English names use the package name without its npm scope, Chinese names describe the purpose, and installation still uses the unchanged real package name.
10
+
11
+ ## Screenshots
12
+
13
+ ![Whiteboard gallery with name search](docs/images/gallery.png)
14
+
15
+ ![New whiteboard](docs/images/new-board.png)
16
+
17
+ ![Whiteboard editor](docs/images/editor.png)
18
+
19
+ The editor screenshot shows an earlier version. The current version keeps the gallery visible beside the editor.
20
+
21
+ ## Install
22
+
23
+ Install the editor dependency first, then the whiteboard plugin:
24
+
25
+ ```sh
26
+ npx @deepseek-ai/dsh plugin --profile web add @guowenzhang/dsh-drawioedit
27
+ npx @deepseek-ai/dsh plugin --profile web add @guowenzhang/dsh-whiteboard
28
+ ```
29
+
30
+ Restart DSH Web, open **Whiteboards** in the left navigation, and click **New whiteboard** to confirm a name and get started. Click an existing card to continue editing.
31
+
32
+ ## Notes
33
+
34
+ - The editor saves your drawings automatically; no manual saving is needed.
35
+ - Boards are stored in the plugin's `files/` directory, not the current workspace. Back up that directory before updating, replacing, or uninstalling the plugin.
36
+ - Deleting a board removes its file, so check before confirming.
37
+
38
+ ## License
39
+
40
+ [Apache-2.0](LICENSE). See [NOTICE](NOTICE) for third-party notices.
package/README.zh.md CHANGED
@@ -1,37 +1,40 @@
1
- # dsh-whiteboard
2
-
3
- 为 DeepSeek Harness 提供白板：主面板是白板卡片列表，右侧边栏用 draw.io 编辑，白板文件保存在插件内。无需选择工作区：白板为该目录创建专用会话并授予写入权限。
4
-
5
- ## 界面截图
6
-
7
- ![白板列表与名称搜索](docs/images/gallery.png)
8
-
9
- ![新建白板对话框](docs/images/new-board.png)
10
-
11
- ![在 draw.io 中编辑白板](docs/images/editor.png)
12
-
13
- ## 安装
14
-
15
- 先安装并启用 [`@guowenzhang/dsh-drawioedit`](../dsh-drawioedit)，再安装本插件：
16
-
17
- ```sh
18
- npx @deepseek-ai/dsh plugin --profile web add @guowenzhang/dsh-drawioedit
19
- npx @deepseek-ai/dsh plugin --profile web add @guowenzhang/dsh-whiteboard
20
- ```
21
-
22
- 来自 npm 官方源：<https://www.npmjs.com/package/@guowenzhang/dsh-whiteboard>。装完重启宿主；本地目录开发安装、git 源与排查见 [AGENTS.md](AGENTS.md)。
23
-
24
- 重启 DSH Web 后，打开左侧导航中的“白板”。点击“新建白板”会先显示命名对话框，默认填入时间名称，可直接修改；只有点击“确认创建”才会在插件 `files/` 目录创建 `.drawio` 文件并交给 drawioedit 打开。绘图内容由 drawioedit 自动保存。卡片显示名称、第一页缩略图和最近修改时间；点击卡片可继续编辑，点击右上角叉号并确认可删除文件。工具条上的搜索框按名称筛选当前卡片列表，不匹配时显示空结果提示。再次进入“白板”页时，如果上一块白板的编辑标签仍开着（只是收起过侧边栏或切到过别的页面），会直接回到那块白板；只有主动关闭标签、或该文件已被删除或替换，才会停在白板列表。过大或无法解析的图表显示预览占位内容。桌面端打开白板时右侧编辑列展开为全屏，编辑器可以完整显示自己的左侧形状面板和右侧格式面板；取消全屏后，左侧显示白板列表、右侧保留当前编辑器，不会露出“新建会话”页面；收起编辑列时也保留白板列表，再点卡片可继续编辑。
25
-
26
- 新白板只有一个 `.drawio` 文件；旧版 UUID 文件和元数据仍可显示。替换或卸载插件前请备份 `files/` 目录。
27
-
28
- ## 开发
29
-
30
- ```sh
31
- npm ci --legacy-peer-deps
32
- npm run typecheck
33
- npm run build
34
- npm test
35
- ```
36
-
37
- 修改源码后须重新构建并提交 `lib/`。`dsh-drawioedit` 在运行时提供编辑器资源。
1
+ # dsh-whiteboard
2
+
3
+ [English](README.md) | 中文
4
+
5
+ ## 为什么做这个插件
6
+
7
+ 我在思考时，经常需要一个地方记录草稿，以前一般会写在文档里。现在全面使用 AI 工具，就把这个空间直接集成到了 DeepSeek Harness 中。白板比文档更灵活，适合随手记录想法、梳理流程；采用开放的 `.drawio` 文件格式，也方便在 draw.io 等兼容工具中继续编辑。
8
+
9
+ 插件列表的显示名称与介绍支持英文和中文，随 Harness 语言设置显示，英文为默认回退；英文名称为去掉 npm scope 的原包名，中文名称说明用途，安装仍使用不变的真实包名。
10
+
11
+ ## 截图
12
+
13
+ ![白板列表与名称搜索](docs/images/gallery.png)
14
+
15
+ ![新建白板](docs/images/new-board.png)
16
+
17
+ ![白板编辑器](docs/images/editor.png)
18
+
19
+ 编辑器截图来自旧版；当前版本在编辑器旁保留白板列表。
20
+
21
+ ## 安装
22
+
23
+ 先安装编辑器依赖，再安装白板插件：
24
+
25
+ ```sh
26
+ npx @deepseek-ai/dsh plugin --profile web add @guowenzhang/dsh-drawioedit
27
+ npx @deepseek-ai/dsh plugin --profile web add @guowenzhang/dsh-whiteboard
28
+ ```
29
+
30
+ 重启 DSH Web，打开左侧“白板”，点击“新建白板”并确认名称即可开始；点击已有卡片可继续编辑。
31
+
32
+ ## 注意事项
33
+
34
+ - 绘图内容由编辑器自动保存，无需手动保存。
35
+ - 白板保存在插件的 `files/` 目录，不在当前工作区；更新、替换或卸载插件前请备份该目录。
36
+ - 删除白板会删除对应文件，请确认后再操作。
37
+
38
+ ## 许可
39
+
40
+ [Apache-2.0](LICENSE)，第三方组件声明见 [NOTICE](NOTICE)。
package/lib/client.js CHANGED
@@ -31019,8 +31019,11 @@ segment: 30 };
31019
31019
  open: async (board) => {
31020
31020
  if (!ctx.sidebarRightTabs.get("drawio-edit")) throw new Error(t("editorMissing"));
31021
31021
  const catalog = sessions.list.getSnapshot().byId;
31022
- let sessionId = lastSessionId && catalog[lastSessionId] ? lastSessionId : void 0;
31023
- if (!sessionId) sessionId = await sessions.create({ cwd: board.directory });
31022
+ const reusableId = lastSessionId && catalog[lastSessionId]?.cwd === board.directory ? lastSessionId : void 0;
31023
+ const sessionId = await sessions.create({
31024
+ cwd: board.directory,
31025
+ ...reusableId ? { sessionId: reusableId } : {}
31026
+ });
31024
31027
  await unwrap(remote().grantBoardSession({ sessionId }));
31025
31028
  lastSessionId = sessionId;
31026
31029
  writeBoardSession(sessionId);
package/locale/en.json ADDED
@@ -0,0 +1,6 @@
1
+ {
2
+ "meta": {
3
+ "title": "dsh-whiteboard",
4
+ "description": "Browse a whiteboard gallery and edit boards with draw.io; board files are stored inside the plugin."
5
+ }
6
+ }
package/locale/zh.json ADDED
@@ -0,0 +1,6 @@
1
+ {
2
+ "meta": {
3
+ "title": "白板",
4
+ "description": "浏览白板图库并使用 draw.io 编辑，白板文件保存在插件自己的目录中。"
5
+ }
6
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@guowenzhang/dsh-whiteboard",
3
- "version": "0.2.1",
3
+ "version": "0.3.0",
4
4
  "description": "Whiteboards for DeepSeek Harness: a board gallery in the main panel and draw.io editing in the Sidebar, with boards stored inside the plugin",
5
5
  "type": "module",
6
6
  "license": "Apache-2.0",
@@ -9,7 +9,8 @@
9
9
  ".": "./lib/index.mjs",
10
10
  "./client": "./lib/client.js",
11
11
  "./package.json": "./package.json",
12
- "./cordis.patch.yml": "./cordis.patch.yml"
12
+ "./cordis.patch.yml": "./cordis.patch.yml",
13
+ "./locale/*": "./locale/*"
13
14
  },
14
15
  "engines": {
15
16
  "node": "^22.19.0 || >=24.0.0",
@@ -35,6 +36,7 @@
35
36
  }
36
37
  },
37
38
  "files": [
39
+ "locale",
38
40
  "lib",
39
41
  "docs",
40
42
  "files/README.md",
@@ -45,6 +47,7 @@
45
47
  "NOTICE"
46
48
  ],
47
49
  "scripts": {
50
+ "test:metadata": "node --test tests/plugin-metadata.test.mjs",
48
51
  "build": "tsdown -c tsdown.config.ts && node build-client.mjs",
49
52
  "typecheck": "tsc --noEmit -p tsconfig.json",
50
53
  "test": "vitest run"