dsh-tiddlywiki 0.30.44 → 0.30.45

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/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "dsh-tiddlywiki",
3
3
  "description": "把 TiddlyWiki 5 变成你和 Agent 共用的本地文档中心(纯文本 + git):你在 DSH 界面里阅读、写作、记日记,Agent 用 15 个 tiddlywiki_* 工具读写同一批笔记;每条笔记都是你能读、能改、能审计、能随时带走的文件——不是自动记忆插件,不做后台抓取。可选一键发布到微信公众号草稿箱。 Turn TiddlyWiki 5 into a document center you and your agent share, in plain text under git — a knowledge base you can read, edit, audit and take with you, not an auto-memory plugin. Mounts via the official dsh plugin system; no DSH source changes.",
4
- "version": "0.30.44",
4
+ "version": "0.30.45",
5
5
  "type": "module",
6
6
  "keywords": [
7
7
  "dsh",
@@ -0,0 +1,193 @@
1
+ /**
2
+ * The quick-note card's two **write-out** paths — 「保存」(`POST /note`)与
3
+ * 「✏️ 在 TW 中编辑」(`POST /edit`)—— extracted out of the ~385-line `build()`
4
+ * (v0.30.45).
5
+ *
6
+ * 分界线(可复用的判据):`build()` 里剩下的几乎全是**建 DOM 与接线**,只有这一组
7
+ * 真的"说话"(发请求、读回执、弹 toast、按状态改按钮文案与禁用态)。它自带一个私有
8
+ * 状态 `saving`(在途互斥,只有 `doSave` 碰它)—— 与 v0.30.44 的 autosave 片同款:
9
+ * **状态跟着函数走**,而不是摊成访问器。
10
+ *
11
+ * 刻意**留在卡片里**的四样,各有理由:
12
+ * - `close()`:卡片自己的可见性收尾(`opened` / `root.hidden` / `recent.close()` /
13
+ * `emitState`),不属于"保存"。
14
+ * - `postEditAndOpen()`:**两条路径共用**(卡片的 `doEdit` 与 `openNative()`),
15
+ * 所以它必须住在两者都看得见的地方 —— 也就是卡片。
16
+ * - `loadedToken`:**「🕘 最近」picker 写它、保存读它**,主人是卡片 ⇒ 按
17
+ * getter/setter 传(与 v0.30.41 的 `persistedSignature` 同款)。
18
+ * - `scope`:这里只读它**一个**方法(`stoppedTarget()`),所以传函数而不是整个模块。
19
+ *
20
+ * ⚠️ `const doSave = async (): Promise<void> => {` 这一行是**逐字保留**的:
21
+ * `verify-wiki-focus.mjs` 用 `indexOf(那句签名)` 定位函数体,再断言其后 900 字符内
22
+ * 出现 `stoppedTarget()`(=「卡片保存同样要拒绝未运行的目标库」,v0.29.0)。它是
23
+ * **族读**(`readFamily('src/client/note-widget')`)⇒ 搬到这个文件仍然命中;会失配的
24
+ * 是把它改名成 `async save()` 之类 —— 那条断言钉的正是「保存前必须先问一句目标库在
25
+ * 不在跑」这条不变量,不是排版。
26
+ *
27
+ * ⚠️ 那条判据在 v0.30.45 被**加固**过一次:改成跑在**剥掉注释**的源码上。起因正是
28
+ * **这段注释** —— 它逐字引用了那句签名、又提到 `stoppedTarget()`,于是 raw 文本里的
29
+ * `indexOf` 先命中注释,断言被自己的文档满足(反向验证实测:把函数改名、甚至删掉整个
30
+ * 拒绝分支,守门都照样绿)。因此现在可以放心在这里引用签名:加固后的判据不会被注释骗
31
+ * 到,而引用它让「这一行为什么不许改名」变得可读。
32
+ *
33
+ * 一个诚实的差异(不改变可观察行为):旧代码在 `build()` 里直接闭包引用
34
+ * `editor` / `titleInput` / `tagEditor` / `saveBtn` / `editBtn`,这里改经 `deps.getUi()`,
35
+ * 于是两个函数各多了一条 `ui === undefined` 早退。它在实践中**不可达** —— 两者都由
36
+ * `build()` 建出来的按钮与编辑器键位触发,而那一定发生在 `ui` 赋值之后 —— 写出来只是
37
+ * 为了让类型收窄(与 `note-widget-autosave.ts` 的同一条差异一致)。
38
+ *
39
+ * @module dsh-tiddlywiki/client/note-widget-save
40
+ */
41
+ import { t } from './i18n.ts'
42
+ import { toast } from './toast.ts'
43
+ import { NOTE_ENDPOINT } from './endpoints.ts'
44
+ import { clearDraft, timestampTitle } from './note-widget-draft.ts'
45
+
46
+ /** 本模块对卡片 DOM 的**最小**需求(`BuiltUi` 结构上满足它)。 */
47
+ export interface NoteSaveUi {
48
+ editor: { getValue: () => string }
49
+ titleInput: { value: string }
50
+ /** 保存要**提交**半打的标签,所以用 `getTags()`(不是 `peekTags()`)。 */
51
+ tagEditor: { getTags: () => string[] }
52
+ saveBtn: { disabled: boolean; textContent: string | null }
53
+ editBtn: { disabled: boolean; textContent: string | null }
54
+ }
55
+
56
+ /** 「🕘 最近」载入的那篇笔记的乐观并发令牌(v0.19.1)。 */
57
+ export interface NoteLoadedToken {
58
+ title: string
59
+ modified?: string
60
+ revision?: number
61
+ }
62
+
63
+ /** 草稿状态机(note-widget-autosave.ts)里这一组用到的三件事。 */
64
+ export interface NoteSaveAutosave {
65
+ /** 收起「已恢复未保存草稿」横幅。 */
66
+ hideBanner: () => void
67
+ /**
68
+ * 内容刚进 wiki:记为"已定型"。少了它,保存后任何一个 change 事件(哪怕内容没变)
69
+ * 都会把整篇重新写成"未保存草稿",下次打开对着空白编辑器报「已恢复未保存草稿」。
70
+ */
71
+ markPersisted: (title: string, text: string, tags: string[]) => void
72
+ /** 保存后把编辑器重置成一张空白新笔记,并让这次重置**定型**(幽灵草稿 v0.22.8)。 */
73
+ resetForNewNote: () => void
74
+ }
75
+
76
+ export interface NoteSaveDeps {
77
+ /** 建好的卡片;`build()` 之前与 `dispose()` 之后是 undefined。 */
78
+ getUi: () => NoteSaveUi | undefined
79
+ autosave: NoteSaveAutosave
80
+ /** 「写入」选中的库没在跑 ⇒ 返回它(host 也会 503):先拒绝,再说话。 */
81
+ stoppedTarget: () => { label: string } | undefined
82
+ getLoadedToken: () => NoteLoadedToken | null
83
+ clearLoadedToken: () => void
84
+ /** 每条请求都要带上「写进哪个库」(漏了这条就会去默认库)。 */
85
+ wikiQuery: (endpoint: string) => string
86
+ /** 卡片自己的 `POST /edit` + 弹出 TW 原生编辑器(与 native 路径共用)。 */
87
+ postEditAndOpen: (title: string, text: string, tags: string[]) => Promise<boolean>
88
+ /** 保存成功后的收尾:卡片自己的 `close()`。 */
89
+ close: () => void
90
+ }
91
+
92
+ export interface NoteSave {
93
+ /** Ctrl+Enter / 「保存」按钮。 */
94
+ doSave: () => Promise<void>
95
+ /** 「✏️ 在 TW 中编辑」:把当前内容存进 wiki,再打开 TW 原生编辑器。 */
96
+ doEdit: () => Promise<void>
97
+ }
98
+
99
+ export function createNoteSave(deps: NoteSaveDeps): NoteSave {
100
+ // In-flight guard: the save button is disabled while saving, but Ctrl+Enter
101
+ // from the editor keymap is not — a second POST within the same second
102
+ // would carry the same timestamp title and silently overwrite the first.
103
+ let saving = false
104
+
105
+ /**
106
+ * 保存成功后的收尾。顺序是承重的:`markPersisted` 必须取到**重置之前**的
107
+ * 标题/正文/标签(`resetForNewNote` 会把它们换成一张空白新笔记)。
108
+ */
109
+ const saveDone = (ui: NoteSaveUi): void => {
110
+ clearDraft()
111
+ deps.autosave.hideBanner()
112
+ // 这份内容已经进 wiki 了:同内容不再回写成草稿(v0.19.1),token 也失效。
113
+ deps.autosave.markPersisted(ui.titleInput.value.trim(), ui.editor.getValue(), ui.tagEditor.getTags())
114
+ deps.clearLoadedToken()
115
+ deps.autosave.resetForNewNote()
116
+ deps.close()
117
+ }
118
+
119
+ const doSave = async (): Promise<void> => {
120
+ const ui = deps.getUi()
121
+ if (ui === undefined) return
122
+ if (saving) return
123
+ const text = ui.editor.getValue().trim()
124
+ if (text.length === 0) {
125
+ toast(t('note.saveEmpty'))
126
+ return
127
+ }
128
+ // 「写入」选中的那个库没在跑:host 现在会拒绝(而不是写进默认库),
129
+ // 所以先说清楚,别让用户写完一整段才发现(v0.29.0)。
130
+ const stopped = deps.stoppedTarget()
131
+ if (stopped !== undefined) {
132
+ toast(t('note.saveTargetStopped', { label: stopped.label }))
133
+ return
134
+ }
135
+ saving = true
136
+ ui.saveBtn.disabled = true
137
+ ui.saveBtn.textContent = t('note.saving')
138
+ try {
139
+ const title = ui.titleInput.value.trim()
140
+ const body: Record<string, unknown> = { title, tags: ui.tagEditor.getTags(), text }
141
+ // Echo the token of the note loaded from 「🕘 最近」 (v0.19.1): if a human
142
+ // edited it in the embedded TW editor meanwhile, the host answers 409 and
143
+ // we refuse instead of silently overwriting their change.
144
+ const loadedToken = deps.getLoadedToken()
145
+ if (loadedToken !== null && loadedToken.title === title) {
146
+ if (loadedToken.modified !== undefined) body.expectedModified = loadedToken.modified
147
+ if (loadedToken.revision !== undefined) body.expectedRevision = loadedToken.revision
148
+ }
149
+ const res = await fetch(deps.wikiQuery(NOTE_ENDPOINT), {
150
+ method: 'POST',
151
+ headers: { 'content-type': 'application/json' },
152
+ body: JSON.stringify(body),
153
+ signal: AbortSignal.timeout(10_000),
154
+ })
155
+ const payload = (await res.json().catch(() => null)) as { ok?: boolean; title?: string; error?: string; conflict?: boolean } | null
156
+ if (!res.ok || payload?.ok !== true) {
157
+ if (res.status === 409 || payload?.conflict === true) {
158
+ toast(t('note.saveConflict'))
159
+ return
160
+ }
161
+ toast(t('note.saveFailed', { message: payload?.error ?? `HTTP ${res.status}` }))
162
+ return
163
+ }
164
+ saveDone(ui)
165
+ toast(t('note.saved', { title: payload.title ?? ui.titleInput.value }))
166
+ } catch (err) {
167
+ toast(t('note.saveFailed', { message: err instanceof Error ? err.message : String(err) }))
168
+ } finally {
169
+ saving = false
170
+ ui.saveBtn.disabled = false
171
+ ui.saveBtn.textContent = t('note.save')
172
+ }
173
+ }
174
+
175
+ /** Save (if non-empty) and open the tiddler in TW's native editor. */
176
+ const doEdit = async (): Promise<void> => {
177
+ const ui = deps.getUi()
178
+ if (ui === undefined) return
179
+ const title = ui.titleInput.value.trim().length > 0 ? ui.titleInput.value.trim() : timestampTitle()
180
+ const text = ui.editor.getValue()
181
+ const tags = ui.tagEditor.getTags()
182
+ ui.editBtn.disabled = true
183
+ ui.editBtn.textContent = t('note.opening')
184
+ try {
185
+ await deps.postEditAndOpen(title, text, tags)
186
+ } finally {
187
+ ui.editBtn.disabled = false
188
+ ui.editBtn.textContent = t('note.editInTw')
189
+ }
190
+ }
191
+
192
+ return { doSave, doEdit }
193
+ }
@@ -42,6 +42,10 @@
42
42
  * plus「重置即定型」(v0.30.44). It OWNS `draftTimer` /
43
43
  * `persistedSignature`; the card only reads/writes them
44
44
  * through the handle it returns.
45
+ * - note-widget-save.ts the two write-out paths: 「保存」(POST /note) and
46
+ * 「✏️ 在 TW 中编辑」/ Ctrl+Enter (POST /edit). It OWNS the
47
+ * in-flight `saving` flag (v0.30.45); `postEditAndOpen`
48
+ * stays in the card because openNative() shares it.
45
49
  *
46
50
  * @module dsh-tiddlywiki/client/note-widget
47
51
  */
@@ -49,13 +53,14 @@ import { t } from './i18n.ts'
49
53
  import { toast } from './toast.ts'
50
54
  import { openEditorPopup, isEditorPopupOpen, isEditorPopupBlank } from './editor-popup.ts'
51
55
  import { buildMarkdownEditor, type MarkdownEditor } from './markdown-editor.ts'
52
- import { EDIT_ENDPOINT, NOTE_ENDPOINT, resolveTwUrl, twProxyFor } from './endpoints.ts'
56
+ import { EDIT_ENDPOINT, resolveTwUrl, twProxyFor } from './endpoints.ts'
53
57
  import { buildTagEditor } from './note-widget-tags.ts'
54
58
  import { uploadInto } from './note-widget-upload.ts'
55
59
  import { createRecentPicker } from './note-widget-recent.ts'
56
60
  import { createNoteScope } from './note-widget-scope.ts'
57
61
  import { installCardDrag, positionCard } from './note-widget-placement.ts'
58
62
  import { createDraftAutosave } from './note-widget-autosave.ts'
63
+ import { createNoteSave } from './note-widget-save.ts'
59
64
  import { adoptDraft, clearDraft, fetchDefaultTag, loadDraft, timestampTitle } from './note-widget-draft.ts'
60
65
 
61
66
  /**
@@ -438,91 +443,24 @@ export function createNoteWidget(): NoteWidgetHandle {
438
443
  // note-widget-autosave.ts 的 `resetForNewNote()` 里 —— 它与 `draftTimer` /
439
444
  // `persistedSignature` 是同一个不变量,所以一起搬走。
440
445
 
441
- const saveDone = (): void => {
442
- clearDraft()
443
- hideDraftBanner()
444
- // 这份内容已经进 wiki 了:同内容不再回写成草稿(v0.19.1),token 也失效。
445
- autosave.markPersisted(titleInput.value.trim(), editor.getValue(), tagEditor.getTags())
446
- loadedToken = null
447
- autosave.resetForNewNote()
448
- close()
449
- }
450
-
451
- // In-flight guard: the save button is disabled while saving, but Ctrl+Enter
452
- // from the editor keymap is not — a second POST within the same second
453
- // would carry the same timestamp title and silently overwrite the first.
454
- let saving = false
455
- doSave = async (): Promise<void> => {
456
- if (saving) return
457
- const text = editor.getValue().trim()
458
- if (text.length === 0) {
459
- toast(t('note.saveEmpty'))
460
- return
461
- }
462
- // 「写入」选中的那个库没在跑:host 现在会拒绝(而不是写进默认库),
463
- // 所以先说清楚,别让用户写完一整段才发现(v0.29.0)。
464
- const stopped = scope.stoppedTarget()
465
- if (stopped !== undefined) {
466
- toast(t('note.saveTargetStopped', { label: stopped.label }))
467
- return
468
- }
469
- saving = true
470
- saveBtn.disabled = true
471
- saveBtn.textContent = t('note.saving')
472
- try {
473
- const title = titleInput.value.trim()
474
- const body: Record<string, unknown> = { title, tags: tagEditor.getTags(), text }
475
- // Echo the token of the note loaded from 「🕘 最近」 (v0.19.1): if a human
476
- // edited it in the embedded TW editor meanwhile, the host answers 409 and
477
- // we refuse instead of silently overwriting their change.
478
- if (loadedToken !== null && loadedToken.title === title) {
479
- if (loadedToken.modified !== undefined) body.expectedModified = loadedToken.modified
480
- if (loadedToken.revision !== undefined) body.expectedRevision = loadedToken.revision
481
- }
482
- const res = await fetch(wikiQuery(NOTE_ENDPOINT), {
483
- method: 'POST',
484
- headers: { 'content-type': 'application/json' },
485
- body: JSON.stringify(body),
486
- signal: AbortSignal.timeout(10_000),
487
- })
488
- const payload = (await res.json().catch(() => null)) as { ok?: boolean; title?: string; error?: string; conflict?: boolean } | null
489
- if (!res.ok || payload?.ok !== true) {
490
- if (res.status === 409 || payload?.conflict === true) {
491
- toast(t('note.saveConflict'))
492
- return
493
- }
494
- toast(t('note.saveFailed', { message: payload?.error ?? `HTTP ${res.status}` }))
495
- return
496
- }
497
- saveDone()
498
- toast(t('note.saved', { title: payload.title ?? titleInput.value }))
499
- } catch (err) {
500
- toast(t('note.saveFailed', { message: err instanceof Error ? err.message : String(err) }))
501
- } finally {
502
- saving = false
503
- saveBtn.disabled = false
504
- saveBtn.textContent = t('note.save')
505
- }
506
- }
507
-
508
- saveBtn.addEventListener('click', () => { void doSave?.() })
509
-
510
- /** Save (if non-empty) and open the tiddler in TW's native editor. */
511
- const doEdit = async (): Promise<void> => {
512
- const title = titleInput.value.trim().length > 0 ? titleInput.value.trim() : timestampTitle()
513
- const text = editor.getValue()
514
- const tags = tagEditor.getTags()
515
- editBtn.disabled = true
516
- editBtn.textContent = t('note.opening')
517
- try {
518
- await postEditAndOpen(title, text, tags)
519
- } finally {
520
- editBtn.disabled = false
521
- editBtn.textContent = t('note.editInTw')
522
- }
523
- }
524
-
525
- editBtn.addEventListener('click', () => { void doEdit() })
446
+ // 保存 / 「在 TW 中编辑」整组(`saveDone` · `saving` · `doSave` · `doEdit`)现在住在
447
+ // note-widget-save.ts(v0.30.45):`build()` 里别的部分都是建 DOM 与接线,只有这一组
448
+ // 真的"说话"(发请求 / 读回执 / 弹 toast / 改按钮状态)。`postEditAndOpen` 与
449
+ // `loadedToken` 刻意留在卡片里 —— 前者 native 路径也调用,后者「🕘 最近」picker 要写。
450
+ const save = createNoteSave({
451
+ getUi: () => ui,
452
+ autosave,
453
+ stoppedTarget: scope.stoppedTarget,
454
+ getLoadedToken: () => loadedToken,
455
+ clearLoadedToken: () => { loadedToken = null },
456
+ wikiQuery,
457
+ postEditAndOpen,
458
+ close,
459
+ })
460
+ // 编辑器键位绑的是上面那个 `doSave` 变量,实现到这里才拿得到。
461
+ doSave = save.doSave
462
+ saveBtn.addEventListener('click', () => { void save.doSave() })
463
+ editBtn.addEventListener('click', () => { void save.doEdit() })
526
464
  closeBtn.addEventListener('click', close)
527
465
 
528
466
  // ── 自由拖动(按住标题栏拖动整张卡片;✕ 仍是唯一关闭方式)──────────