@lijian-ui/dsh-file-manager 0.1.20

package/src/index.ts

@@ -0,0 +1,97 @@
+/**
+ * @lijian-ui/dsh-file-manager — host half: the workspace-gated
+ * filesystem + git services and the /filemgr/* HTTP routes (JSON
+ * operations + SSE change stream) on the shared webserver. The browser half
+ * (exports "./client") is served by client-modules from the same package's
+ * dsh.client declaration.
+ *
+ * The host half also announces the plugin to every agent through the
+ * system-prompt section mechanism (the same band task-board uses), so agents
+ * know the right-panel system exists and how to cooperate with it.
+ *
+ * FileManager right-panel design (Apache-2.0, iOfficeAI/FileManager) — re-implemented
+ * from measured behavior and architecture, not copied code.
+ * @module @lijian-ui/dsh-file-manager
+ */
+
+import type { Context } from '@deepseek-ai/cordis'
+import type {} from '@deepseek-ai/dsh-host-webserver'
+import type {} from '@deepseek-ai/dsh-subprocess'
+import type {} from '@deepseek-ai/dsh-workspace'
+import type {} from '@deepseek-ai/dsh-system-prompt'
+import { installSettingsSection, settingsNamespace } from '@deepseek-ai/dsh-settings'
+import z from 'schemastery'
+import { FsService } from './host/fs-service.ts'
+import { GitService, subprocessRunner } from './host/git-service.ts'
+import { createWorkspaceGate } from './host/gate.ts'
+import { registerPanelRoutes } from './host/routes.ts'
+import { mountOnce } from './mount-once.ts'
+
+/** Required services: the route registry, the managed subprocess seam, the workspace registry, and the prompt band. */
+export const inject = ['webServer', 'subprocess', 'workspaceRegistry', 'systemPrompt']
+
+/** Settings namespace the browser settings card edits (the Host registers it). */
+export const FILEMANAGER_PANEL_SETTINGS_NAMESPACE = 'filemgr'
+
+/** Order of the announcement section within the tool-guidance band. */
+const SECTION_ORDER = 210
+
+/** Model-facing announcement: plugin presence, capabilities, and limits. */
+export const FILEMANAGER_PANEL_GUIDANCE = '本机已安装 dsh-filemgr 插件（DSH Web GUI 的右侧面板系统）：项目会话打开时，聊天区右侧出现「预览」与「文件/变更」两块面板。能力：Explorer 文件树（点击文件在预览面板打开、整行点击展开文件夹、按文件名搜索定位）；Preview 多 tab 预览（markdown/html/code/diff/csv/pdf/office/图片/文本等格式，支持源码/预览切换、分屏编辑、保存；markdown 与聊天消息中的 mermaid 代码块会渲染成图表，图源语法错误时回退为代码块）；SCM 变更面板（真实 git stage/unstage/discard）；面板宽度可拖拽调整（Explorer 220~500px、Preview 340~1200px），双击把手复位默认宽度，折叠状态与宽度按项目持久化（localStorage）。数据源为当前会话工作目录的真实文件系统与真实 git 仓库，宿主进程经 /filemgr/* 路由提供。用户提到「右侧面板 / 预览面板 / 文件树 / 变更面板」时即指本插件，请据此协作。'
+
+/** Settings section the browser card edits: a total on/off switch (issue #307). */
+export interface FileManagerPanelSettings {
+  /** Whether the right-panel system is mounted at all; default on. */
+  enabled?: boolean
+}
+
+/**
+ * Mount the panel data services and their routes.
+ * @param ctx - context carrying webServer, subprocess, workspaceRegistry, systemPrompt.
+ */
+export const apply = mountOnce('@lijian-ui/dsh-file-manager', applyImpl)
+
+function applyImpl(ctx: Context, config: FileManagerPanelSettings = {}): void {
+  const gate = createWorkspaceGate(ctx)
+  const fs = new FsService(gate)
+  const git = new GitService(subprocessRunner(ctx), gate, (root, rel) => fs.delete(root, rel))
+
+  // Settings the browser card edits through the 'filemgr' namespace:
+  // turning the panel off unmounts the /filemgr/* routes (which stops
+  // the workspace fs watch and git polling, since both live behind the SSE
+  // stream) and the agent-facing announcement, mirroring the pet's model.
+  let current: () => FileManagerPanelSettings = () => base
+  const base: FileManagerPanelSettings = { enabled: config.enabled ?? true }
+  let disposePanel: (() => void) | undefined
+  let disposePrompt: (() => void) | undefined
+  const syncPanel = (): void => {
+    const enabled = current().enabled ?? true
+    if (disposePanel === undefined && enabled) {
+      disposePanel = ctx.effect(() => {
+        const disposeRoutes = registerPanelRoutes(ctx, fs, git)
+        return () => disposeRoutes()
+      }, 'dsh-filemgr: /filemgr routes')
+      disposePrompt = ctx.effect(() => ctx.systemPrompt.section({
+        name: 'plugin:filemgr',
+        order: SECTION_ORDER,
+        text: FILEMANAGER_PANEL_GUIDANCE,
+      }), 'dsh-filemgr: prompt section')
+    } else if (disposePanel !== undefined && !enabled) {
+      disposePanel()
+      disposePanel = undefined
+      disposePrompt?.()
+      disposePrompt = undefined
+    }
+  }
+  installSettingsSection(
+    ctx,
+    settingsNamespace(FILEMANAGER_PANEL_SETTINGS_NAMESPACE),
+    z.object({ enabled: z.boolean().default(true) }),
+    base,
+    {
+      setSource: (source) => { current = source },
+      onChange: () => syncPanel(),
+    },
+  )
+  syncPanel()
+}

package/src/mount-once.ts

@@ -0,0 +1,48 @@
+// Generated by scripts/sync-shared.mjs from shared/host/mount-once.ts. Do not edit this copy; edit the shared source and run "node scripts/sync-shared.mjs".
+/**
+ * Host single-instance guard shared by the plugin family. The family bundle
+ * (dsh-web-ui-all / dsh-skins) namespaces every child row id (web-ui-*), so
+ * the loader accepts a standalone install of the same package side by side;
+ * without this guard the second instance would still re-register the same
+ * webserver routes, tools, settings namespaces, and system-prompt sections
+ * and fail the boot. mountOnce makes the second host apply a no-op for the
+ * lifetime of the first instance (the browser half is already deduped by
+ * package name in the client module host).
+ *
+ * The registry rides a global symbol so two module instances of the same
+ * package (npm copy vs repository link) still share one verdict. cordis
+ * `ctx.effect` runs its callback immediately and treats the callback's
+ * return value as the fiber disposer, so the unmarker is returned, not run.
+ */
+
+const MOUNTED = Symbol.for('dsh-web-ui.mounted-plugins')
+
+interface MountRegistry {
+  [MOUNTED]?: Set<string>
+}
+
+function mountedSet(): Set<string> {
+  const registry = globalThis as MountRegistry
+  return (registry[MOUNTED] ??= new Set())
+}
+
+/**
+ * Wrap a cordis plugin apply so the package runs at most once per process.
+ * The first mount registers normally and unmarks when its fiber disposes;
+ * any later mount of the same package name is a no-op.
+ * @param packageName - npm package identity shared by every install source.
+ * @param fn - the original plugin apply.
+ * @returns an apply of the same shape.
+ */
+export function mountOnce<T extends (...args: any[]) => unknown>(packageName: string, fn: T): T {
+  return ((...args: unknown[]) => {
+    const mounted = mountedSet()
+    if (mounted.has(packageName)) return
+    mounted.add(packageName)
+    const ctx = args[0] as { effect?: (effect: () => unknown) => unknown } | undefined
+    ctx?.effect?.(() => () => {
+      mounted.delete(packageName)
+    })
+    return fn(...args)
+  }) as T
+}