@waterwx/dsh-novel-forge 0.1.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 (50) hide show
  1. package/LICENSE +202 -0
  2. package/README.md +180 -0
  3. package/cordis.patch.yml +13 -0
  4. package/lib/client.js +3924 -0
  5. package/lib/client.js.map +1 -0
  6. package/lib/index.js +3120 -0
  7. package/lib/index.js.map +1 -0
  8. package/lib/types/assets.d.ts +35 -0
  9. package/lib/types/assistant.d.ts +43 -0
  10. package/lib/types/bookshelf.d.ts +35 -0
  11. package/lib/types/client/api.d.ts +68 -0
  12. package/lib/types/client/docx.d.ts +15 -0
  13. package/lib/types/client/index.d.ts +14 -0
  14. package/lib/types/client/locales.d.ts +139 -0
  15. package/lib/types/client/mount.d.ts +9 -0
  16. package/lib/types/client/panel/AssetsTab.d.ts +7 -0
  17. package/lib/types/client/panel/AssistantTab.d.ts +7 -0
  18. package/lib/types/client/panel/BookshelfBar.d.ts +11 -0
  19. package/lib/types/client/panel/NovelPanel.d.ts +13 -0
  20. package/lib/types/client/panel/controller.d.ts +19 -0
  21. package/lib/types/client/panel/helpers.d.ts +8 -0
  22. package/lib/types/client/sidebar-entry.d.ts +13 -0
  23. package/lib/types/docx.d.ts +19 -0
  24. package/lib/types/engine.d.ts +95 -0
  25. package/lib/types/index.d.ts +55 -0
  26. package/lib/types/protocol.d.ts +521 -0
  27. package/lib/types/routes.d.ts +29 -0
  28. package/package.json +105 -0
  29. package/src/assets.ts +518 -0
  30. package/src/assistant.ts +547 -0
  31. package/src/bookshelf.ts +137 -0
  32. package/src/client/api.ts +254 -0
  33. package/src/client/css-modules.d.ts +8 -0
  34. package/src/client/docx.ts +69 -0
  35. package/src/client/index.ts +34 -0
  36. package/src/client/locales.ts +271 -0
  37. package/src/client/mount.tsx +97 -0
  38. package/src/client/panel/AssetsTab.tsx +341 -0
  39. package/src/client/panel/AssistantTab.tsx +188 -0
  40. package/src/client/panel/BookshelfBar.tsx +116 -0
  41. package/src/client/panel/NovelPanel.tsx +990 -0
  42. package/src/client/panel/controller.ts +45 -0
  43. package/src/client/panel/helpers.ts +17 -0
  44. package/src/client/panel/panel.module.css +894 -0
  45. package/src/client/sidebar-entry.ts +122 -0
  46. package/src/docx.ts +83 -0
  47. package/src/engine.ts +1019 -0
  48. package/src/index.ts +184 -0
  49. package/src/protocol.ts +539 -0
  50. package/src/routes.ts +955 -0
package/LICENSE ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
package/README.md ADDED
@@ -0,0 +1,180 @@
1
+ # dsh-novel-forge — AI 编译小说工作台 / AI Novel Writing Workbench
2
+
3
+ **中文** | [English](#english)
4
+
5
+ 你的专属 AI 小说写作插件:把一份大纲"编译"成一本完整的小说。
6
+ Your personal AI novel-writing plugin for DSH: turn an outline into a complete novel.
7
+
8
+ ---
9
+
10
+ ## 功能一览 / Features
11
+
12
+ | 中文 | English |
13
+ |---|---|
14
+ | **创作工作流**:大纲 → 设定圣经 → 卷计划 → 章节计划 → 逐章生成 + AI 审稿 → 润色/导出 | **Workflow**: outline → story bible → volumes → chapter plan → chapter-by-chapter writing with AI review → polish/export |
15
+ | **书架**:同时管理多本书,点击切换进度继续编译,可新建书 | **Bookshelf**: manage multiple books at once — click to switch and keep writing, or start a new one |
16
+ | **写作资产**:题材基底库 / 推进模式库 / 8 套预置写法模板 / 12 条反 AI 规则 / 自定义写法引擎 | **Writing assets**: genre library / progression modes / 8 preset style templates / 12 anti-AI rules / custom style engine |
17
+ | **AI 助手**:对话讨论剧情,助手可直接修改大纲、设定、章节(工具调用实时可见) | **AI assistant**: chat about the plot; the assistant edits outline, settings, and chapters live |
18
+ | **docx 导入**:点击选择或拖拽本机大纲文件,浏览器本地解析 | **docx import**: pick or drag a local outline file — parsed in the browser |
19
+ | **逐章生成**:3000–4000 字/章,自动摘要(叙事记忆)+ AI 审稿 + 按意见修订 + 去 AI 味 | **Chapter generation**: 3000–4000 chars per chapter with summaries, AI review, revise-by-feedback, de-AI polish |
20
+ | **伏笔管理 / 全本导出(TXT/MD)** | **Foreshadowing / full-book export (TXT/MD)** |
21
+
22
+ ## 快速开始 / Quick Start
23
+
24
+ ```sh
25
+ pnpm install # 安装依赖 / install dependencies
26
+ pnpm build # 重新构建 lib/ / rebuild lib/
27
+ ```
28
+
29
+ 挂载到 dsh web profile / Mount into the dsh web profile:
30
+
31
+ ```sh
32
+ dsh plugin --profile web add link:"<此目录绝对路径>"
33
+ ```
34
+
35
+ 或 / or in `~/.dsh/profiles/web/cordis.patch.yml`:
36
+
37
+ ```yaml
38
+ - insert:
39
+ - id: novel-forge
40
+ name: '@waterwx/dsh-novel-forge'
41
+ ```
42
+
43
+ 重启 dsh web 后,侧边栏出现「小说工坊」。
44
+ Restart dsh web and the "Novel Forge" entry appears in the sidebar.
45
+
46
+ ## 安装方式 / Installation
47
+
48
+ ### 从 GitHub 安装 / Install from GitHub
49
+
50
+ ```sh
51
+ dsh plugin --profile web add github:watersxya/dsh-novel-forge
52
+ ```
53
+
54
+ > 注意:pnpm ≥10 默认拒绝运行 git 依赖的 `prepare` 构建脚本。首次安装失败时,把 pnpm 提示的包键加入该 profile 的 `pnpm-workspace.yaml`:
55
+ > Note: pnpm ≥10 refuses to run `prepare` build scripts of git dependencies by default. On first failure, add the package key pnpm prints to the profile's `pnpm-workspace.yaml`:
56
+ >
57
+ > ```yaml
58
+ > allowBuilds:
59
+ > '@waterwx/dsh-novel-forge': true
60
+ > ```
61
+ >
62
+ > 然后重新执行 `add`。只对源码可信的包授权。
63
+ > Then re-run `add`. Only allow packages whose source you trust.
64
+
65
+ ### 从 npm 安装 / Install from npm(推荐 / recommended)
66
+
67
+ ```sh
68
+ dsh plugin --profile web add @waterwx/dsh-novel-forge
69
+ ```
70
+
71
+ npm 分发的是预构建产物,无需任何构建授权。
72
+ npm distribution ships prebuilt artifacts — no build authorization needed.
73
+
74
+ ### 本地开发 / Local development
75
+
76
+ ```sh
77
+ pnpm install && pnpm build
78
+ dsh plugin --profile web add link:"<本目录绝对路径>"
79
+ ```
80
+
81
+ ## 目录结构 / Directory Layout
82
+
83
+ ```
84
+ src/ 插件源码(宿主半 + 浏览器半)/ plugin source (host + browser)
85
+ lib/ 构建产物(lib/index.js 宿主 / lib/client.js 浏览器)/ build output
86
+ scripts/ 工具脚本 / utility scripts
87
+ package.json 包定义(dsh.bundle.patch + dsh.client 声明)/ package definition
88
+ cordis.patch.yml profile 挂载补丁 / profile mount patch
89
+ tsdown.config.ts 双面打包配置 / dual-face bundling config
90
+ ```
91
+
92
+ ## 数据位置 / Data Locations
93
+
94
+ - 书架 / Bookshelf:`~/.dsh/dsh-novel-forge-bookshelf.json`
95
+ - 每本书一个输出目录(含 `novel-project.json` + 各章 Markdown)/ each book owns an output directory
96
+ - AI 助手对话记录 / assistant log:`<输出目录>/novel-assistant.jsonl`
97
+
98
+ ## 限制 / Limitations
99
+
100
+ - 生成消耗 LLM API 额度(默认 deepseek-official / deepseek-v4-flash)/ generation consumes LLM API quota
101
+ - 章节质量取决于大纲完整度 / chapter quality depends on outline completeness
102
+ - 设置写入 `~/.dsh/settings.yaml` 的 `dsh-novel-forge` 段 / settings persist in `~/.dsh/settings.yaml`
103
+
104
+ ---
105
+
106
+ <a id="english"></a>
107
+
108
+ ## English
109
+
110
+ # My Personal AI Novel Forge (Standalone Copy)
111
+
112
+ This is a **complete, standalone copy** of the `dsh-novel-forge` plugin. All
113
+ source code, build artifacts, and configuration are included — install, build,
114
+ and mount it any time.
115
+
116
+ ## Feature Overview
117
+
118
+ - **Workflow**: Outline → Story Bible → Volume Plan → Chapter Plan → chapter-by-chapter
119
+ writing with AI review → polish / export
120
+ - **Bookshelf**: manage multiple books at once — click to switch progress and keep
121
+ writing, or start a new book
122
+ - **Writing assets**: genre base library / progression mode library / 8 preset style
123
+ templates / 12 anti-AI rules / custom style engine
124
+ - **AI Assistant**: discuss plot in chat; the assistant can directly edit the outline,
125
+ settings, and chapters (tool calls are visible live)
126
+ - **docx import**: pick a local outline file or drag & drop it — parsed in the browser,
127
+ no server upload
128
+ - **Chapter generation**: 3000–4000 characters per chapter, with automatic summary
129
+ (narrative memory), AI review, revise-by-feedback, and de-AI polish
130
+ - **Foreshadowing management / full-book export (TXT/MD)**
131
+
132
+ ## Getting Started
133
+
134
+ ```sh
135
+ pnpm install # install dependencies
136
+ pnpm build # rebuild lib/
137
+ ```
138
+
139
+ Mount into the dsh web profile:
140
+
141
+ ```sh
142
+ dsh plugin --profile web add link:"<absolute path to this directory>"
143
+ ```
144
+
145
+ Or insert into `~/.dsh/profiles/web/cordis.patch.yml`:
146
+
147
+ ```yaml
148
+ - insert:
149
+ - id: novel-forge
150
+ name: '@waterwx/dsh-novel-forge'
151
+ ```
152
+
153
+ Restart dsh web, and the "Novel Forge" entry appears in the sidebar.
154
+
155
+ ## Directory Layout
156
+
157
+ ```
158
+ src/ Plugin source (host half + browser half)
159
+ lib/ Build output (lib/index.js host / lib/client.js browser)
160
+ scripts/ Utility scripts
161
+ package.json Package definition (dsh.bundle.patch + dsh.client declaration)
162
+ cordis.patch.yml Profile mount patch
163
+ tsdown.config.ts Dual-face bundling config
164
+ ```
165
+
166
+ ## Data Locations
167
+
168
+ - Bookshelf: `~/.dsh/dsh-novel-forge-bookshelf.json`
169
+ - Each book owns an output directory (containing `novel-project.json` project state
170
+ plus per-chapter Markdown files)
171
+ - AI assistant conversation log: `<output-dir>/novel-assistant.jsonl`
172
+
173
+ ## Limitations
174
+
175
+ - Generation consumes LLM API quota (provider/model default: `deepseek-official` /
176
+ `deepseek-v4-flash`)
177
+ - Chapter quality depends on outline completeness; batch generation is serial
178
+ - Settings (output directory, model, review threshold, etc.) are edited in the
179
+ panel's "Settings" tab and written to the `dsh-novel-forge` section of
180
+ `~/.dsh/settings.yaml`
@@ -0,0 +1,13 @@
1
+ # dsh-novel-forge bundle patch: inserts the dual-face plugin row into the web
2
+ # profile roster. Applied as a profile bundle layer (the `dsh.bundle.patch`
3
+ # manifest field) over dsh-base; activate with
4
+ # `dsh plugin --profile <name> add link:<absolute path to this package>`.
5
+ #
6
+ # The row is a bare plugin by package name: the node half (exports ".") runs
7
+ # in the host process (docx outline parsing, LLM chapter planning/generation,
8
+ # /api/dsh-novel-forge routes, markdown output), and the `dsh.client`
9
+ # declaration in package.json makes the browser half (exports "./client",
10
+ # served at /plugins/<id>/client.js) load in the web GUI.
11
+ - insert:
12
+ - id: novel-forge
13
+ name: '@ryan/dsh-novel-forge'