dsh-article-review 0.0.0-stage → 0.2.1-alpha.2

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 (52) hide show
  1. package/LICENSE +21 -0
  2. package/README.i18n.yaml +3 -0
  3. package/README.md +105 -2
  4. package/README.zh.md +106 -0
  5. package/cordis.patch.yml +3 -0
  6. package/lib/client.js +24031 -0
  7. package/lib/index.js +9763 -0
  8. package/lib/types/bibliography.d.ts +50 -0
  9. package/lib/types/change-audit.d.ts +25 -0
  10. package/lib/types/client/bib-display.d.ts +32 -0
  11. package/lib/types/client/block-pairing.d.ts +9 -0
  12. package/lib/types/client/change-evidence.d.ts +8 -0
  13. package/lib/types/client/citation-display.d.ts +12 -0
  14. package/lib/types/client/composer.d.ts +12 -0
  15. package/lib/types/client/context.d.ts +13 -0
  16. package/lib/types/client/desktop-file-picker.d.ts +2 -0
  17. package/lib/types/client/figure-gallery.d.ts +46 -0
  18. package/lib/types/client/figure-preview.d.ts +23 -0
  19. package/lib/types/client/figures.d.ts +3 -0
  20. package/lib/types/client/icons.d.ts +14 -0
  21. package/lib/types/client/index.d.ts +9 -0
  22. package/lib/types/client/legacy-tables.d.ts +6 -0
  23. package/lib/types/client/locales.d.ts +281 -0
  24. package/lib/types/client/near-viewport.d.ts +5 -0
  25. package/lib/types/client/panel.d.ts +71 -0
  26. package/lib/types/client/paper-find.d.ts +45 -0
  27. package/lib/types/client/reader-scroll.d.ts +39 -0
  28. package/lib/types/client/reader-text.d.ts +27 -0
  29. package/lib/types/client/references.d.ts +62 -0
  30. package/lib/types/client/rendered-diff.d.ts +48 -0
  31. package/lib/types/client/review-navigation.d.ts +40 -0
  32. package/lib/types/client/review-progress.d.ts +10 -0
  33. package/lib/types/client/revision-pair.d.ts +12 -0
  34. package/lib/types/client/selection-menu.d.ts +18 -0
  35. package/lib/types/client/selection.d.ts +32 -0
  36. package/lib/types/client/versions.d.ts +34 -0
  37. package/lib/types/client/workbench-state.d.ts +88 -0
  38. package/lib/types/document.d.ts +29 -0
  39. package/lib/types/figure-thumbnail.d.ts +8 -0
  40. package/lib/types/figures.d.ts +45 -0
  41. package/lib/types/index.d.ts +32 -0
  42. package/lib/types/manuscript-read.d.ts +29 -0
  43. package/lib/types/native-file-picker.d.ts +29 -0
  44. package/lib/types/owner-lock.d.ts +9 -0
  45. package/lib/types/pdf-preview-cache.d.ts +22 -0
  46. package/lib/types/review-blocks.d.ts +14 -0
  47. package/lib/types/review-queue.d.ts +10 -0
  48. package/lib/types/schema.d.ts +793 -0
  49. package/lib/types/selected-file.d.ts +2 -0
  50. package/lib/types/store.d.ts +236 -0
  51. package/lib/types/workbench-view.d.ts +144 -0
  52. package/package.json +82 -4
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 DeepSeek and contributors
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,3 @@
1
+ # Bilingual consistency record: Git blob hashes.
2
+ README.md: 3510103710d25575c2bcb73302f06b1e26577130
3
+ README.zh.md: 7a5742733fb10dc452595dc964a8dc7198e499e2
package/README.md CHANGED
@@ -1,3 +1,106 @@
1
- # Temporary Holding Version
1
+ ---
2
+ description: "Read, annotate and revise Markdown manuscripts in DSH with AI proposals, word-level diffs and persistent review baselines."
3
+ kind: "package-bundle"
4
+ ---
2
5
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
6
+ # DSH Article Review
7
+
8
+ English | [中文](README.zh.md)
9
+
10
+ Read, annotate and revise Markdown manuscripts alongside your [DSH](https://github.com/deepseek-ai/deepseek-harness) conversation. AI submits revision proposals; you inspect the changes, accept or reject them, or request another revision.
11
+
12
+ Across multiple revision rounds, each paragraph stays compared with **the last version you marked reviewed**, so you can see what still needs your attention.
13
+
14
+ ![Review an AI proposal with rendered and source differences](docs/screenshots/review-proposal.png)
15
+
16
+ *Screenshots use fictional manuscripts; proposals include real model runs.*
17
+
18
+ ## Features
19
+
20
+ - **Read and annotate** — highlights, underlines, comments and manuscript search.
21
+ - **Revise with AI** — propose replacements, insertions or deletions; revise pending proposals. Supports headings, lists and tables.
22
+ - **Track your review** — mark and lock reviewed paragraphs; track later changes.
23
+ - **Compare versions** — word-level comparisons and exact Markdown source diffs.
24
+ - **Review figures** — preview and propose replacements; keep before/after copies.
25
+ - **Preview companion documents** — open the manuscript or workspace files in DSH’s native preview alongside the review.
26
+ - **Manage references** — bind BibTeX, jump to citations and check new citation keys.
27
+
28
+ <a id="installation"></a>
29
+ ## Install
30
+
31
+ Supports DSH Web `0.2.1-alpha.4` and Desktop `0.2.0-rc.2`. Uses your existing model configuration.
32
+
33
+ ### Desktop App
34
+
35
+ The App includes its runtime; no separate Node installation is needed.
36
+
37
+ 1. Open **Plugins** in the App's left sidebar, then click **Add plugin**.
38
+ 2. Paste the npm package name and version:
39
+
40
+ `dsh-article-review@0.2.1-alpha.2`
41
+
42
+ 3. After installation, click **Enable now** and follow any restart prompt.
43
+ 4. Choose a local workspace and open a conversation. In the right sidebar, choose **Read, annotate and revise**.
44
+ 5. Click **Browse workspace → Choose local file** to open a Markdown manuscript. The system dialog belongs to the App; the selected file must be inside this conversation's workspace. BibTeX and replacement figures use the same Desktop picker.
45
+
46
+ 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
+
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.
49
+
50
+ ### Web
51
+
52
+ Requires Node.js 22 (≥22.19) or 24+:
53
+
54
+ ```sh
55
+ dsh plugin --profile web add 'dsh-article-review@0.2.1-alpha.2'
56
+ dsh web
57
+ ```
58
+
59
+ Restart a running Web profile after installation. For GitHub installation, use the prebuilt tag; `main` contains development source.
60
+
61
+ ## Start reviewing
62
+
63
+ 1. Choose **Read, annotate and revise** in the right sidebar and open a Markdown manuscript.
64
+ 2. Select text, annotate it, attach the notes to the conversation and send your request.
65
+ 3. In **Review changes**, accept, reject or request a revision; check the result and mark it reviewed.
66
+
67
+ Accepting updates the manuscript and keeps your review baseline. Back up `.paper-review/` with the manuscript and exclude it from public Git history. Paragraph locks apply within this plugin.
68
+
69
+ ## Screenshots
70
+
71
+ Select text and right-click to highlight or annotate.
72
+
73
+ ![Selection actions](docs/screenshots/select-text.png)
74
+
75
+ Save annotations and attach revision requests to the conversation.
76
+
77
+ ![Annotations and highlights](docs/screenshots/annotate.png)
78
+
79
+ Check review progress and jump to sections or paragraphs.
80
+
81
+ ![Review progress and navigation](docs/screenshots/review-outline.jpg)
82
+
83
+ Compare two versions and see changed words directly.
84
+
85
+ ![Version comparison](docs/screenshots/versions-rendered.jpg)
86
+
87
+ Preview PDFs, review figure replacements and browse references.
88
+
89
+ ![PDF preview](docs/screenshots/figure-pdf.jpg)
90
+
91
+ ![Figure replacement](docs/screenshots/figure-replacement.jpg)
92
+
93
+ ![Reference browser](docs/screenshots/references.jpg)
94
+
95
+ Compact reading on narrow screens.
96
+
97
+ <img src="docs/screenshots/narrow-zh-light.jpg" alt="Narrow-screen reading" width="360">
98
+
99
+ ## Documentation
100
+
101
+ - [User guide](docs/user-guide.md) — operations and configuration.
102
+ - [Development and compatibility](docs/development.md) — builds, tools and persistence.
103
+
104
+ Edit Markdown manuscripts; figures support images and PDFs. See [other formats and platforms](docs/development.md#scope-and-compatibility).
105
+
106
+ [MIT License](LICENSE)
package/README.zh.md ADDED
@@ -0,0 +1,106 @@
1
+ ---
2
+ description: "在 DSH 中阅读、批注与修改 Markdown 稿件,查看 AI 提案、逐词差异及相对上次审阅的累计变化。"
3
+ kind: "package-bundle"
4
+ ---
5
+
6
+ # DSH Article Review
7
+
8
+ [English](README.md) | 中文
9
+
10
+ 在 [DSH](https://github.com/deepseek-ai/deepseek-harness) 对话旁读论文、写批注、与 AI 逐段修稿。AI 提交修改提案,你查看差异、接受、拒绝或要求重写。
11
+
12
+ 经历多轮修改后,每段仍对照**你最后确认已审的版本**,待审变化一目了然。
13
+
14
+ ![查看 AI 提案的渲染效果与源码差异](docs/screenshots/review-proposal.png)
15
+
16
+ *截图使用虚构稿件,含真实模型提案。*
17
+
18
+ ## 核心功能
19
+
20
+ - **阅读批注**:高亮、下划线、评论与全文搜索。
21
+ - **AI 修稿**:替换、增删和重写提案,支持标题、列表、表格。
22
+ - **审阅进度**:标记、锁定已审段落,追踪后续变化。
23
+ - **版本对比**:逐词对比与 Markdown 源码差异。
24
+ - **图表审阅**:预览、提议换图,保留前后副本。
25
+ - **配套文档预览**:使用 DSH 原生预览打开 Markdown、PDF、Office 等文件,保留当前审稿状态。
26
+ - **文献管理**:绑定 BibTeX,定位引用,检查新增引用键。
27
+
28
+ <a id="installation"></a>
29
+ ## 安装
30
+
31
+ 支持 DSH Web `0.2.1-alpha.4` 和 Desktop `0.2.0-rc.2`,沿用现有模型配置。
32
+
33
+ ### Desktop App
34
+
35
+ App 自带运行环境,无需另装 Node。
36
+
37
+ 1. 在 App 左侧打开 **Plugins(插件)**,点击 **Add plugin(添加插件)**。
38
+ 2. 粘贴 npm 包名及版本:
39
+
40
+ `dsh-article-review@0.2.1-alpha.2`
41
+
42
+ 3. 安装完成后点击 **Enable now(立即启用)**,按提示重启。
43
+ 4. 选择本地工作区并打开一个对话,在右侧栏选择**阅读、批注与局部修改**。
44
+ 5. 点击**浏览工作区 → 选择本地文件**打开 Markdown 稿件。系统选择窗口属于 App,文件必须位于当前对话工作区内。BibTeX 和替换图片也使用同一 Desktop 选择器。
45
+
46
+ 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
+
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 保留旧包名,两种包名请选择一种安装。
49
+
50
+ ### Web
51
+
52
+ 需要 Node.js 22(≥22.19)或 24+:
53
+
54
+ ```sh
55
+ dsh plugin --profile web add 'dsh-article-review@0.2.1-alpha.2'
56
+ dsh web
57
+ ```
58
+
59
+ 安装后重启正在运行的 Web 配置。GitHub 安装请使用预构建 tag;`main` 是开发源码。
60
+
61
+ ## 开始审阅
62
+
63
+ 1. 在右侧栏选择**阅读、批注与局部修改**,打开 Markdown 稿件。
64
+ 2. 选中文字添加批注,附到对话输入框,发送修改要求。
65
+ 3. 在**审阅变更**中接受、拒绝或要求重写,检查后确认已审。
66
+
67
+ 接受提案更新正文,保留已审基线。审阅记录位于 `.paper-review/`,随稿件备份,勿提交公开仓库。段落锁仅约束本插件。
68
+
69
+ ## 操作截图
70
+
71
+ 选中文字,右键添加高亮或批注。
72
+
73
+ ![选区操作菜单](docs/screenshots/select-text.png)
74
+
75
+ 保存批注,把修改要求附到对话。
76
+
77
+ ![批注与高亮](docs/screenshots/annotate.png)
78
+
79
+ 查看已审进度,跳转章节与段落。
80
+
81
+ ![审阅进度与导航](docs/screenshots/review-outline.jpg)
82
+
83
+ 比较两个版本,直接查看字词变化。
84
+
85
+ ![版本对比](docs/screenshots/versions-rendered.jpg)
86
+
87
+ 预览 PDF、审阅换图、浏览文献。
88
+
89
+ ![PDF 预览](docs/screenshots/figure-pdf.jpg)
90
+
91
+ ![换图前后对比](docs/screenshots/figure-replacement.jpg)
92
+
93
+ ![文献浏览](docs/screenshots/references.jpg)
94
+
95
+ 窄屏也能顺畅阅读。
96
+
97
+ <img src="docs/screenshots/narrow-zh-light.jpg" alt="窄屏阅读" width="360">
98
+
99
+ ## 文档
100
+
101
+ - [使用指南](docs/user-guide.zh.md):操作与配置。
102
+ - [开发与兼容性](docs/development.zh.md):构建、工具与持久化。
103
+
104
+ 编辑 Markdown 稿件,图表支持图片与 PDF。[其他格式与平台](docs/development.zh.md#scope-and-compatibility)。
105
+
106
+ [MIT 许可证](LICENSE)
@@ -0,0 +1,3 @@
1
+ - insert:
2
+ - id: paper-review
3
+ name: dsh-article-review