dsh-article-review 0.2.1-alpha.2 → 0.2.2-alpha.16

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 (37) hide show
  1. package/README.i18n.yaml +2 -2
  2. package/README.md +9 -5
  3. package/README.zh.md +9 -5
  4. package/lib/client.js +4235 -1544
  5. package/lib/index.js +670 -104
  6. package/lib/types/article-input.d.ts +8 -0
  7. package/lib/types/client/article-import.d.ts +9 -0
  8. package/lib/types/client/figure-companion.d.ts +31 -0
  9. package/lib/types/client/figure-layout.d.ts +5 -0
  10. package/lib/types/client/figure-references.d.ts +19 -0
  11. package/lib/types/client/figure-window.d.ts +50 -0
  12. package/lib/types/client/icons.d.ts +1 -1
  13. package/lib/types/client/locales.d.ts +80 -1
  14. package/lib/types/client/panel.d.ts +6 -1
  15. package/lib/types/client/reader-open.d.ts +22 -0
  16. package/lib/types/client/reader-scroll.d.ts +3 -2
  17. package/lib/types/client/reader-text.d.ts +3 -1
  18. package/lib/types/client/reading-figures.d.ts +23 -0
  19. package/lib/types/client/reading-sections.d.ts +12 -0
  20. package/lib/types/client/workbench-state.d.ts +63 -0
  21. package/lib/types/figure-panels.d.ts +62 -0
  22. package/lib/types/index.d.ts +1 -1
  23. package/lib/types/schema.d.ts +51 -0
  24. package/lib/types/store.d.ts +24 -1
  25. package/lib/types/workbench-view.d.ts +17 -0
  26. package/package.json +7 -6
  27. package/skills/paper-figure-panels/SKILL.md +48 -0
  28. package/skills/paper-figure-panels/references/files.md +17 -0
  29. package/skills/paper-figure-panels/references/parallel.md +24 -0
  30. package/skills/paper-figure-panels/scripts/inspect_figure.py +251 -0
  31. package/skills/paper-figure-panels/scripts/prepare_panels.py +132 -0
  32. package/skills/paper-figure-panels/scripts/split_panels.py +112 -0
  33. package/skills/paper-figure-panels/scripts/test_inspect_figure.py +196 -0
  34. package/skills/paper-figure-panels/scripts/test_prepare_panels.py +151 -0
  35. package/skills/paper-project-start/SKILL.md +35 -0
  36. package/skills/paper-project-start/scripts/import_article.py +394 -0
  37. package/skills/paper-project-start/scripts/test_import_article.py +97 -0
package/README.i18n.yaml CHANGED
@@ -1,3 +1,3 @@
1
1
  # Bilingual consistency record: Git blob hashes.
2
- README.md: 3510103710d25575c2bcb73302f06b1e26577130
3
- README.zh.md: 7a5742733fb10dc452595dc964a8dc7198e499e2
2
+ README.md: 885cf76d562237d63c5653160dd2de93c2630af5
3
+ README.zh.md: 311cc9fee3ec73f9b5956db9f265579416628194
package/README.md CHANGED
@@ -17,7 +17,9 @@ Across multiple revision rounds, each paragraph stays compared with **the last v
17
17
 
18
18
  ## Features
19
19
 
20
+ - **Start from an article** — import PDF, DOCX, LaTeX, TXT, Markdown, HTML or pasted prose with `paper-project-start`; preserve the source, prepare available figures and open the reader.
20
21
  - **Read and annotate** — highlights, underlines, comments and manuscript search.
22
+ - **Read text with figures** — whole figures or AI-prepared panels beside their paragraphs; optional section pages retain your reading position. See the [reading guide](docs/user-guide.md#text-figures-and-section-pages).
21
23
  - **Revise with AI** — propose replacements, insertions or deletions; revise pending proposals. Supports headings, lists and tables.
22
24
  - **Track your review** — mark and lock reviewed paragraphs; track later changes.
23
25
  - **Compare versions** — word-level comparisons and exact Markdown source diffs.
@@ -28,7 +30,7 @@ Across multiple revision rounds, each paragraph stays compared with **the last v
28
30
  <a id="installation"></a>
29
31
  ## Install
30
32
 
31
- Supports DSH Web `0.2.1-alpha.4` and Desktop `0.2.0-rc.2`. Uses your existing model configuration.
33
+ Version `0.2.2-alpha.16` supports DSH Web `0.2.1-alpha.4` and Desktop `0.2.0-rc.2` / `0.2.1-rc.2` / `0.2.1-rc.3` / `0.2.1-rc.4` / `0.2.2-alpha.2`. Uses your existing model configuration.
32
34
 
33
35
  ### Desktop App
34
36
 
@@ -37,7 +39,7 @@ The App includes its runtime; no separate Node installation is needed.
37
39
  1. Open **Plugins** in the App's left sidebar, then click **Add plugin**.
38
40
  2. Paste the npm package name and version:
39
41
 
40
- `dsh-article-review@0.2.1-alpha.2`
42
+ `dsh-article-review@0.2.2-alpha.16`
41
43
 
42
44
  3. After installation, click **Enable now** and follow any restart prompt.
43
45
  4. Choose a local workspace and open a conversation. In the right sidebar, choose **Read, annotate and revise**.
@@ -45,14 +47,14 @@ The App includes its runtime; no separate Node installation is needed.
45
47
 
46
48
  Desktop uses its own `desktop` profile. Installing into the `web` profile does not install into the App. If you previously installed `@deepseek-ai/dsh-experimental-paper-review` from GitHub, uninstall that package in Plugins before installing the npm package above and restarting. Workspace review records in `.paper-review/` continue to be used. macOS Desktop has been exercised; see [platform requirements](docs/development.md#scope-and-compatibility) for Windows.
47
49
 
48
- Choose the official npm registry or the mainland China mirror. If the mirror has not synced this version, use the official registry. GitHub installation is also available as `github:Biogod2020/dsh-article-review#v0.2.1-alpha.2`. If GitHub times out, download the [prebuilt release archive](https://codeload.github.com/Biogod2020/dsh-article-review/tar.gz/refs/tags/v0.2.1-alpha.2) and enter its absolute local path in **Plugins → Add plugin**, without extracting or building it. Tags through `v0.2.1-alpha.1` retain the old package name; install one package name at a time.
50
+ Choose the official npm registry or the mainland China mirror. If the mirror has not synced this version, use the official registry. GitHub installation is also available as `github:Biogod2020/dsh-article-review#v0.2.2-alpha.16`. If GitHub times out, download the [prebuilt release archive](https://codeload.github.com/Biogod2020/dsh-article-review/tar.gz/refs/tags/v0.2.2-alpha.16) and enter its absolute local path in **Plugins → Add plugin**, without extracting or building it. Tags through `v0.2.1-alpha.1` retain the old package name; install one package name at a time.
49
51
 
50
52
  ### Web
51
53
 
52
- Requires Node.js 22 (≥22.19) or 24+:
54
+ DSH `0.2.2-alpha.2` requires Node.js 24.9 or later. Earlier supported DSH versions retain their own Node.js requirements (22 ≥22.19 or 24+):
53
55
 
54
56
  ```sh
55
- dsh plugin --profile web add 'dsh-article-review@0.2.1-alpha.2'
57
+ dsh plugin --profile web add 'dsh-article-review@0.2.2-alpha.16'
56
58
  dsh web
57
59
  ```
58
60
 
@@ -60,6 +62,8 @@ Restart a running Web profile after installation. For GitHub installation, use t
60
62
 
61
63
  ## Start reviewing
62
64
 
65
+ For a document or pasted article, choose **Import article** in the reader's file controls, or invoke `/paper-project-start` in the conversation and identify the source. Conversion creates a separate project in the conversation workspace. The first run uses `uv` to prepare document tools there. Text-only articles skip figure preparation; scans require OCR and verification. See the [import guide](docs/user-guide.md#start-from-an-article).
66
+
63
67
  1. Choose **Read, annotate and revise** in the right sidebar and open a Markdown manuscript.
64
68
  2. Select text, annotate it, attach the notes to the conversation and send your request.
65
69
  3. In **Review changes**, accept, reject or request a revision; check the result and mark it reviewed.
package/README.zh.md CHANGED
@@ -17,7 +17,9 @@ kind: "package-bundle"
17
17
 
18
18
  ## 核心功能
19
19
 
20
+ - **从文章开始**:固定的 `paper-project-start` skill 支持 PDF、DOCX、LaTeX、TXT、Markdown、HTML 和粘贴正文,保留原稿,准备已有图片并打开阅读器。
20
21
  - **阅读批注**:高亮、下划线、评论与全文搜索。
22
+ - **图文对照**:整图或 AI 切分的 panel 与正文一起阅读,可选小节分页,切换时保留位置。见[阅读指南](docs/user-guide.zh.md#图文对照与小节分页)。
21
23
  - **AI 修稿**:替换、增删和重写提案,支持标题、列表、表格。
22
24
  - **审阅进度**:标记、锁定已审段落,追踪后续变化。
23
25
  - **版本对比**:逐词对比与 Markdown 源码差异。
@@ -28,7 +30,7 @@ kind: "package-bundle"
28
30
  <a id="installation"></a>
29
31
  ## 安装
30
32
 
31
- 支持 DSH Web `0.2.1-alpha.4` 和 Desktop `0.2.0-rc.2`,沿用现有模型配置。
33
+ `0.2.2-alpha.16` 支持 DSH Web `0.2.1-alpha.4` 和 Desktop `0.2.0-rc.2` / `0.2.1-rc.2` / `0.2.1-rc.3` / `0.2.1-rc.4` / `0.2.2-alpha.2`,沿用现有模型配置。
32
34
 
33
35
  ### Desktop App
34
36
 
@@ -37,7 +39,7 @@ App 自带运行环境,无需另装 Node。
37
39
  1. 在 App 左侧打开 **Plugins(插件)**,点击 **Add plugin(添加插件)**。
38
40
  2. 粘贴 npm 包名及版本:
39
41
 
40
- `dsh-article-review@0.2.1-alpha.2`
42
+ `dsh-article-review@0.2.2-alpha.16`
41
43
 
42
44
  3. 安装完成后点击 **Enable now(立即启用)**,按提示重启。
43
45
  4. 选择本地工作区并打开一个对话,在右侧栏选择**阅读、批注与局部修改**。
@@ -45,14 +47,14 @@ App 自带运行环境,无需另装 Node。
45
47
 
46
48
  Desktop 使用独立的 `desktop` 配置,安装到 `web` 不会同时安装到 App。若之前通过 GitHub 安装了旧包 `@deepseek-ai/dsh-experimental-paper-review`,先在 Plugins 中卸载旧包,再安装上述 npm 包并按提示重启;工作区中的 `.paper-review/` 审阅记录继续使用。macOS Desktop 已实测;Windows 要求见[支持范围与兼容性](docs/development.zh.md#scope-and-compatibility)。
47
49
 
48
- 可选择 npm 官方源或中国大陆镜像。镜像尚未同步新版本时,先切回官方源。GitHub 安装地址为 `github:Biogod2020/dsh-article-review#v0.2.1-alpha.2`。若 GitHub 地址连接超时,可下载[预构建发行归档](https://codeload.github.com/Biogod2020/dsh-article-review/tar.gz/refs/tags/v0.2.1-alpha.2),在 **Plugins → Add plugin** 中输入本地归档的绝对路径,无需解压或构建。`v0.2.1-alpha.1` 及更早 tag 保留旧包名,两种包名请选择一种安装。
50
+ 可选择 npm 官方源或中国大陆镜像。镜像尚未同步新版本时,先切回官方源。GitHub 安装地址为 `github:Biogod2020/dsh-article-review#v0.2.2-alpha.16`。若 GitHub 地址连接超时,可下载[预构建发行归档](https://codeload.github.com/Biogod2020/dsh-article-review/tar.gz/refs/tags/v0.2.2-alpha.16),在 **Plugins → Add plugin** 中输入本地归档的绝对路径,无需解压或构建。`v0.2.1-alpha.1` 及更早 tag 保留旧包名,两种包名请选择一种安装。
49
51
 
50
52
  ### Web
51
53
 
52
- 需要 Node.js 22(≥22.19)或 24+:
54
+ DSH `0.2.2-alpha.2` 需要 Node.js 24.9 或更新版本;此前支持的 DSH 版本沿用各自的 Node.js 要求(22 ≥22.19 或 24+):
53
55
 
54
56
  ```sh
55
- dsh plugin --profile web add 'dsh-article-review@0.2.1-alpha.2'
57
+ dsh plugin --profile web add 'dsh-article-review@0.2.2-alpha.16'
56
58
  dsh web
57
59
  ```
58
60
 
@@ -60,6 +62,8 @@ dsh web
60
62
 
61
63
  ## 开始审阅
62
64
 
65
+ 导入文档或粘贴正文时,在阅读器文件操作区点击**导入文章**,或在对话中使用 `/paper-project-start` 并指定原稿。转换结果保存在当前对话工作区的新目录中。首次运行通过 `uv` 在项目内准备转换工具;无图文章跳过裁切,扫描件需要 OCR 和核对。见[文章导入说明](docs/user-guide.zh.md#从文章开始)。
66
+
63
67
  1. 在右侧栏选择**阅读、批注与局部修改**,打开 Markdown 稿件。
64
68
  2. 选中文字添加批注,附到对话输入框,发送修改要求。
65
69
  3. 在**审阅变更**中接受、拒绝或要求重写,检查后确认已审。