dsh-tiddlywiki 0.16.21 → 0.16.23

package/package.json

@@ -1,86 +1,86 @@
-{
-  "name": "dsh-tiddlywiki",
-  "description": "TiddlyWiki 5 as the DSH persistent knowledge base: tiddlywiki_* agent tools (search with filters/recent/tags/batch/rename + git sync & conflict resolve), a full TiddlyWiki editor embedded in the GUI center column (same-origin proxy, works over Tailscale/LAN/domain), a quick-note card with draft auto-save & recent-notes picker behind a single knowledge FAB, and git-based sync with auto-commit. Mounts via the official dsh plugin system — no DSH source changes.",
-  "version": "0.16.21",
-  "type": "module",
-  "keywords": [
-    "dsh",
-    "dsh-plugin",
-    "tiddlywiki",
-    "knowledge-base",
-    "note-taking",
-    "notes",
-    "wiki",
-    "git-sync",
-    "agent-tools",
-    "plugin"
-  ],
-  "author": {
-    "name": "bbqisbbq",
-    "url": "https://github.com/bbqisbbq"
-  },
-  "main": "lib/index.js",
-  "exports": {
-    ".": "./lib/index.js",
-    "./client": "./lib/client.js",
-    "./package.json": "./package.json"
-  },
-  "dsh": {
-    "bundle": {
-      "patch": "./cordis.patch.yml"
-    },
-    "client": {
-      "inject": [
-        "slots"
-      ],
-      "platform": "web"
-    }
-  },
-  "files": [
-    "lib/**/*.js",
-    "lib/**/*.js.map",
-    "src",
-    "docs",
-    "cordis.patch.yml",
-    "LICENSE",
-    "README.md"
-  ],
-  "license": "MIT",
-  "homepage": "https://github.com/bbqisbbq/dsh-tiddlywiki#readme",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/bbqisbbq/dsh-tiddlywiki.git"
-  },
-  "bugs": {
-    "url": "https://github.com/bbqisbbq/dsh-tiddlywiki/issues"
-  },
-  "engines": {
-    "node": ">=22"
-  },
-  "dependencies": {
-    "tiddlywiki": "^5.4.1"
-  },
-  "devDependencies": {
-    "@codemirror/commands": "^6.11.0",
-    "@codemirror/lang-markdown": "^6.5.2",
-    "@codemirror/language": "^6.12.4",
-    "@codemirror/state": "^6.7.2",
-    "@codemirror/view": "^6.43.10",
-    "@lezer/highlight": "^1.2.3",
-    "@types/node": "^22.20.1",
-    "@types/react": "^19.1.0",
-    "react": "^19.1.0",
-    "tsdown": "0.22.2",
-    "tsx": "^4.19.2",
-    "typescript": "~5.7.2",
-    "unrun": "*"
-  },
-  "scripts": {
-    "build": "node scripts/clean-lib.mjs && npm run build:host && npm run build:client",
-    "build:host": "tsdown -c tsdown.host.config.ts",
-    "build:client": "tsdown -c tsdown.client.config.ts && node scripts/wrap-client.mjs",
-    "watch": "tsdown -c tsdown.host.config.ts --watch",
-    "typecheck": "tsc --noEmit",
-    "selftest": "node scripts/selftest.mjs"
-  }
-}
+{
+  "name": "dsh-tiddlywiki",
+  "description": "TiddlyWiki 5 as the DSH persistent knowledge base: tiddlywiki_* agent tools (search with filters/recent/tags/batch/rename + git sync & conflict resolve), a full TiddlyWiki editor embedded in the GUI center column (same-origin proxy, works over Tailscale/LAN/domain), a quick-note card with draft auto-save & recent-notes picker behind a single knowledge FAB, and git-based sync with auto-commit. Mounts via the official dsh plugin system — no DSH source changes.",
+  "version": "0.16.23",
+  "type": "module",
+  "keywords": [
+    "dsh",
+    "dsh-plugin",
+    "tiddlywiki",
+    "knowledge-base",
+    "note-taking",
+    "notes",
+    "wiki",
+    "git-sync",
+    "agent-tools",
+    "plugin"
+  ],
+  "author": {
+    "name": "bbqisbbq",
+    "url": "https://github.com/bbqisbbq"
+  },
+  "main": "lib/index.js",
+  "exports": {
+    ".": "./lib/index.js",
+    "./client": "./lib/client.js",
+    "./package.json": "./package.json"
+  },
+  "dsh": {
+    "bundle": {
+      "patch": "./cordis.patch.yml"
+    },
+    "client": {
+      "inject": [
+        "slots"
+      ],
+      "platform": "web"
+    }
+  },
+  "files": [
+    "lib/**/*.js",
+    "lib/**/*.js.map",
+    "src",
+    "docs",
+    "cordis.patch.yml",
+    "LICENSE",
+    "README.md"
+  ],
+  "license": "MIT",
+  "homepage": "https://github.com/bbqisbbq/dsh-tiddlywiki#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/bbqisbbq/dsh-tiddlywiki.git"
+  },
+  "bugs": {
+    "url": "https://github.com/bbqisbbq/dsh-tiddlywiki/issues"
+  },
+  "engines": {
+    "node": ">=22"
+  },
+  "dependencies": {
+    "tiddlywiki": "^5.4.1"
+  },
+  "devDependencies": {
+    "@codemirror/commands": "^6.11.0",
+    "@codemirror/lang-markdown": "^6.5.2",
+    "@codemirror/language": "^6.12.4",
+    "@codemirror/state": "^6.7.2",
+    "@codemirror/view": "^6.43.10",
+    "@lezer/highlight": "^1.2.3",
+    "@types/node": "^22.20.1",
+    "@types/react": "^19.1.0",
+    "react": "^19.1.0",
+    "tsdown": "0.22.2",
+    "tsx": "^4.19.2",
+    "typescript": "~5.7.2",
+    "unrun": "*"
+  },
+  "scripts": {
+    "build": "node scripts/clean-lib.mjs && npm run build:host && npm run build:client",
+    "build:host": "tsdown -c tsdown.host.config.ts",
+    "build:client": "tsdown -c tsdown.client.config.ts && node scripts/wrap-client.mjs",
+    "watch": "tsdown -c tsdown.host.config.ts --watch",
+    "typecheck": "tsc --noEmit",
+    "selftest": "node scripts/selftest.mjs"
+  }
+}

package/src/client/better-sidebar-tab.ts

@@ -0,0 +1,136 @@
+/**
+ * DSH Better Sidebar (dsh-better-sidebar) TiddlyWiki tab type (v0.16.23).
+ *
+ * dsh-better-sidebar exposes a client-side registry service on the cordis
+ * context as `ctx.betterSidebar` (registerTab / registerFileViewer / openTab /
+ * closeTab …). This module registers a TW tab type there: the sidebar's + menu
+ * (and any caller of `openTab({ type: 'dsh-tiddlywiki' })`) opens the
+ * SAME-ORIGIN TW proxy iframe — the same shared machinery the center panel and
+ * the native rightbar tab use (tw-frame.ts).
+ *
+ * Mutual exclusion (one TW client at a time) rides the shared
+ * `dsh-panel-activate` protocol: when this tab becomes visible the center
+ * overlay / rightbar tab close; when another TW surface activates, this tab
+ * closes itself through the service (closeTab). Wiki links in the reply
+ * stream route here while the tab is visible (tw-frame.ts' live-frame
+ * registry → panel.ts).
+ *
+ * The integration is optional: the caller reads `ctx.get('betterSidebar')`
+ * and skips silently when the plugin is not installed (older DSH / other web
+ * profiles). Registering a tab also gives every better-sidebar user an
+ * enable/disable switch for it in the Side card settings page — that gate is
+ * the plugin's own, independent of our `ui.showBetterSidebarTab` config.
+ *
+ * @module dsh-tiddlywiki/client/better-sidebar-tab
+ */
+import * as React from 'react'
+import {
+  ACTIVATE_EVENT,
+  createTwFrameController,
+  getTabLabel,
+  TwTabIcon,
+  type TwFrameController,
+  warmTabLabel,
+} from './tw-frame.ts'
+
+/** The tab type this package owns in the better-sidebar registry. */
+export const TW_BETTER_SIDEBAR_ID = 'dsh-tiddlywiki'
+/** Activation-event name for THIS surface (distinct from center 'dsh-tiddlywiki' / rightbar). */
+const BETTER_SIDEBAR_PANEL_NAME = 'dsh-tiddlywiki/bettersidebar'
+
+/** Structural faces over the better-sidebar contract (no @deepseek-ai imports). */
+
+export interface BetterSidebarTabProps {
+  ctx: { get?(name: string): unknown }
+  scope: { sessionId?: string; cwd?: string }
+  tab: { id: string; type: string }
+  /** Whether this tab is the active one AND the panel is open (live views pause otherwise). */
+  visible: boolean
+}
+
+/** Structural face over the better-sidebar registry service (no @deepseek-ai imports). */
+export interface BetterSidebarFace {
+  registerTab(descriptor: {
+    id: string
+    title: string | (() => string)
+    icon?: unknown
+    single?: boolean
+    component: (props: BetterSidebarTabProps) => unknown
+  }): () => void
+  closeTab(tabId: string, scope?: unknown): void
+}
+
+/**
+ * The tab body: a thin React wrapper that mounts the TW iframe into a
+ * plain-DOM host, like the rightbar tab body. `visible` pauses/resumes the
+ * frame (lazy-loads on the first show); the `dsh-panel-activate` protocol
+ * keeps exactly one TW client on screen.
+ */
+export function TwBetterSidebarTabBody(props: BetterSidebarTabProps): React.ReactElement {
+  const { ctx, scope, tab } = props
+  // 老版本 better-sidebar 可能不传 visible（缺失按「已可见」处理——tab 渲染在其
+  // 面板内即视为在屏）。
+  const visible = props.visible !== false
+  const hostRef = React.useRef<HTMLDivElement | null>(null)
+  const controllerRef = React.useRef<TwFrameController | null>(null)
+
+  React.useEffect(() => {
+    const host = hostRef.current
+    if (host === null) return
+    const ac = new AbortController()
+    const controller = createTwFrameController(host, ac.signal)
+    controllerRef.current = controller
+    return () => {
+      controller.dispose()
+      ac.abort()
+      controllerRef.current = null
+    }
+    // eslint-disable-next-line react-hooks/exhaustive-deps -- one controller per tab (id stable; single-instance type).
+  }, [tab.id])
+
+  React.useEffect(() => {
+    controllerRef.current?.setVisible(visible)
+  }, [visible])
+
+  // When this tab becomes visible, close the center overlay / rightbar tab.
+  // When any OTHER TW surface activates, close this tab (one TW client).
+  React.useEffect(() => {
+    if (!visible) return
+    document.dispatchEvent(new CustomEvent(ACTIVATE_EVENT, { detail: BETTER_SIDEBAR_PANEL_NAME }))
+    const onActivate = (event: Event): void => {
+      const detail = (event as CustomEvent).detail
+      if (detail !== BETTER_SIDEBAR_PANEL_NAME) {
+        const service = ctx.get?.('betterSidebar') as BetterSidebarFace | undefined
+        service?.closeTab(tab.id, scope)
+      }
+    }
+    document.addEventListener(ACTIVATE_EVENT, onActivate)
+    return () => document.removeEventListener(ACTIVATE_EVENT, onActivate)
+  }, [visible, tab.id, scope, ctx])
+
+  return React.createElement('div', { ref: hostRef, className: 'dsh-tw-rightbar-tab', 'data-dsh-tw-bettersidebar': '' })
+}
+
+/**
+ * Register the TW tab type in a live better-sidebar service for the caller's
+ * lifetime; the returned disposer unregisters it. Call only when
+ * `ctx.get('betterSidebar')` actually returned a service.
+ */
+export function mountBetterSidebarTab(service: BetterSidebarFace): (() => void) | undefined {
+  try {
+    const remove = service.registerTab({
+      id: TW_BETTER_SIDEBAR_ID,
+      title: (): string => getTabLabel(),
+      icon: (size: number) => TwTabIcon({ size }),
+      // Single instance: opening the tab focuses the existing one.
+      single: true,
+      component: (props: BetterSidebarTabProps) => TwBetterSidebarTabBody(props),
+    })
+    // Warm the + menu label from the live config (ui.tabLabel).
+    warmTabLabel()
+    return remove
+  } catch (error) {
+    console.error('[dsh-tiddlywiki] better-sidebar tab mount failed:', error)
+    return undefined
+  }
+}

package/src/client/index.ts

@@ -25,6 +25,7 @@ import { disposeEditorPopup } from './editor-popup.ts'
 import { SettingsSection } from './settings-page.ts'
 import { registerToolViews, installWikiLinkInterceptor } from './tool-views.ts'
 import { mountRightbarTab, type RightbarSlotsFace } from './rightbar-tab.ts'
+import { mountBetterSidebarTab, type BetterSidebarFace } from './better-sidebar-tab.ts'
 
 /** Client plugin name. */
 export const name = 'dsh-tiddlywiki/client'
@@ -127,6 +128,35 @@ export function apply(ctx: ClientContextFace): void {
       // 右侧栏集成失败只影响该功能本身，绝不让整个插件挂掉。
       console.error('[dsh-tiddlywiki] rightbar mount failed:', error)
     }
+    try {
+      // DSH Better Sidebar（dsh-better-sidebar 插件）集成：可选挂载——仅当该
+      // 插件的 client 半部提供了 betterSidebar 服务时才启用（未安装 / 老版本
+      // DSH 静默跳过，插件其余功能不受影响）。注册 TW tab 类型（+ 菜单可开）；
+      // 由 ui.showBetterSidebarTab 控制（默认开）。better-sidebar 的 Side
+      // 设置页也会为已注册 tab 自动提供它自己的启用开关。
+      let bsRetryTimer: number | undefined
+      const tryMountBetterSidebar = (attempt: number): void => {
+        const service = ctx.get?.('betterSidebar') as BetterSidebarFace | undefined
+        if (service === undefined) {
+          // better-sidebar 插件可能在本次 apply 之后才就绪：有限重试几次即可。
+          if (attempt < 6 && !clientDisposed) {
+            bsRetryTimer = window.setTimeout(() => tryMountBetterSidebar(attempt + 1), 500 * (attempt + 1))
+          }
+          return
+        }
+        void fetchUiConfig().then((cfg) => {
+          if (clientDisposed) return
+          if (!cfg.showBetterSidebarTab) return
+          const removeBs = mountBetterSidebarTab(service)
+          if (removeBs !== undefined) disposers.push(removeBs)
+        })
+      }
+      tryMountBetterSidebar(0)
+      disposers.push(() => { if (bsRetryTimer !== undefined) window.clearTimeout(bsRetryTimer) })
+    } catch (error) {
+      // Better Sidebar 集成失败只影响该功能本身，绝不让整个插件挂掉。
+      console.error('[dsh-tiddlywiki] better-sidebar mount failed:', error)
+    }
     try {
       // Reply-stream native tool cards: keyed `tool.call.toolview` slots for
       // every tiddlywiki_* tool (additive — our keys are unclaimed).

package/src/client/panel.ts

@@ -23,7 +23,7 @@
 import type { PanelState } from './state.ts'
 import { ENTRY_SELECTOR } from './sidebar-entry.ts'
 import { attachThemeSync, setThemeSyncConfig } from './theme-sync.ts'
-import { openTiddlerInRightbar } from './rightbar-tab.ts'
+import { openTiddlerInLiveTab } from './tw-frame.ts'
 
 export const PANEL_RELOAD_EVENT = 'dsh-tw-panel-reload'
 
@@ -317,9 +317,10 @@ export function mountPanel(state: PanelState): () => void {
     const detail = (event as CustomEvent).detail as { title?: unknown } | undefined
     const title = typeof detail?.title === 'string' && detail.title.length > 0 ? detail.title : ''
     if (title.length === 0) return
-    // 右侧栏的 TW tab 可见时，链接直接在那里打开（与聊天并排）；否则退回
-    // 中央面板。互斥由 rightbar-tab 的 dsh-panel-activate 协议保证。
-    if (openTiddlerInRightbar(title)) return
+    // 侧边栏（rightbar / better-sidebar）的 TW tab 可见时，链接直接在那里
+    // 打开（与聊天并排）；否则退回中央面板。互斥由 tw-frame.ts 共享的
+    // dsh-panel-activate 协议保证。
+    if (openTiddlerInLiveTab(title)) return
     pendingHash = `#${encodeURIComponent(title)}`
     state.openPanel()
     applyPendingHash()