dsh-ssh-workspace-companion 0.0.0-stage → 0.2.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 i060912
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,46 @@
-# Temporary Holding Version
+# dsh-ssh-workspace-companion
 
-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.
+[dsh-ssh-workspace](https://www.npmjs.com/package/dsh-ssh-workspace) 的远程配套插件。安装在每台远程机器的 DeepSeek Harness（DSH）Web profile 中，让本地插件可以打开和操作该机器的工作区与会话。
+
+## 安装位置
+
+- 本地机器安装 `dsh-ssh-workspace`。
+- 每台远程机器安装本包 `dsh-ssh-workspace-companion`。
+
+本包需要配合本地插件使用。
+
+## 兼容性
+
+插件 0.2.x 面向 **DSH 0.2.0-rc.2**，不支持 DSH 0.1.x。本地插件与所有远程 companion 应使用相同版本，更新后重启 DSH。
+
+## 远程机器安装
+
+```sh
+dsh plugin --profile web add dsh-ssh-workspace-companion
+```
+
+远程 Web 服务应绑定 loopback：
+
+```sh
+dsh --profile web --host 127.0.0.1 --port 30800 --trusted-host 127.0.0.1:30800
+```
+
+本地插件通过 SSH 隧道连接该服务。如果使用自定义 `DSH_HOME`，安装、启动和本地 Remote Desktop 设置中的远程 profile 路径必须对应同一个目录。
+
+随后在本地机器安装主插件，并在 **Settings → Remote Desktop** 中连接 SSH 主机：
+
+```sh
+dsh plugin --profile web add dsh-ssh-workspace
+```
+
+## 工作方式
+
+companion 在本地插件打开的远程 iframe 中验证父页面来源和连接 token，通过专用 MessageChannel 转发 DSH 官方 Controller 状态与操作，并隐藏 iframe 中的远程侧栏。远程业务数据继续由远程 DSH 的认证服务处理。
+
+## 文档与反馈
+
+- [项目与完整使用说明](https://github.com/sincerity711/dsh-ssh-workspace)
+- [远程服务器配置](https://github.com/sincerity711/dsh-ssh-workspace/blob/main/docs/remote-server-setup.md)
+- [问题反馈](https://github.com/sincerity711/dsh-ssh-workspace/issues)
+
+开发时修改 `packages/companion/src/client.js`，再在仓库根目录执行 `npm run build` 和 `npm run check`。

package/cordis.patch.yml

@@ -0,0 +1,3 @@
+- insert:
+    - id: remote-desktop-companion
+      name: dsh-ssh-workspace-companion

package/lib/client.js

@@ -0,0 +1,230 @@
+// Generated by scripts/build-clients.mjs. Edit packages/companion/src/client.js instead.
+window.__ModuleLoader__.load({
+  id: 'dsh-remote-desktop-companion',
+  factory: (require) => {
+    const module = { exports: {} }
+    const exports = module.exports
+    exports.inject = ['sessions', 'workspaces', 'uiWorkspace']
+
+    const BRIDGE_PROTOCOL_VERSION = 1
+    const BRIDGE_CAPABILITIES = Object.freeze([
+      'session/open',
+      'session/create',
+      'session/search',
+      'session/rename',
+      'session/fork',
+      'workspace/create',
+      'workspace/rename',
+      'workspace/delete',
+      'workspace/insertBefore',
+      'workspace/archiveSession',
+      'workspace/insertSessionBefore',
+    ])
+    const BRIDGE_METHODS = new Set(BRIDGE_CAPABILITIES)
+
+    function parseHash() {
+      const params = new URLSearchParams(window.location.hash.replace(/^#/, ''))
+      return { token: params.get('token') || '', parent: params.get('parent') || '' }
+    }
+
+    function installEmbeddedCss() {
+      document.body.setAttribute('data-dsh-remote-desktop-child', 'true')
+      const style = document.createElement('style')
+      style.setAttribute('data-dsh-remote-desktop-companion', '')
+      style.textContent = `
+        body[data-dsh-remote-desktop-child="true"] #root [class*="frame"]:has(> [class*="sidebarCol"]) > [class*="sidebarCol"] { visibility: hidden !important; pointer-events: none !important; overflow: hidden !important; }
+        body[data-dsh-remote-desktop-child="true"] [class*="handle"][data-side="sidebar"] { display: none !important; }
+        body[data-dsh-remote-desktop-child="true"] #root [class*="frame"]:has(> [class*="sidebarCol"]) { grid-template-columns: 0 minmax(0, 1fr) 0 !important; }
+      `
+      document.head.appendChild(style)
+      return () => { style.remove(); document.body.removeAttribute('data-dsh-remote-desktop-child') }
+    }
+
+    function controllerSnapshot(ctx) {
+      const sessions = ctx.sessions.list.getSnapshot()
+      const workspaces = ctx.workspaces.list.getSnapshot()
+      return {
+        sessions: {
+          ...sessions,
+          items: (sessions.ids || Object.keys(sessions.byId || {}))
+            .map(id => sessions.byId?.[id])
+            .filter(Boolean),
+        },
+        workspaces: {
+          ...workspaces,
+          items: [...(workspaces.items || [])],
+          archivedSessionIds: [...(workspaces.archivedSessionIds || [])],
+        },
+      }
+    }
+
+    function structuredError(error) {
+      const code = typeof error?.code === 'string' ? error.code : 'remote_desktop_bridge_failed'
+      const message = error instanceof Error ? error.message : String(error)
+      return { code, message }
+    }
+
+    async function waitUntilCurrent(ctx, sessionId, signal) {
+      signal.throwIfAborted()
+      ctx.uiWorkspace.openSession(sessionId)
+      await ctx.sessions.using(sessionId, { source: 'controllerOperation', signal }, async reference => {
+        await reference.ready
+        signal.throwIfAborted()
+        const owners = ctx.sessions.retainInfo(sessionId).getSnapshot().retainedBy
+        if ((owners.mainView || 0) === 0) throw new Error('session open superseded')
+      })
+    }
+
+    async function invoke(ctx, method, payload, signal) {
+      if (!BRIDGE_METHODS.has(method)) throw new Error(`unsupported remote desktop bridge method ${String(method)}`)
+      switch (method) {
+        case 'session/open': await waitUntilCurrent(ctx, payload.sessionId, signal); return { sessionId: payload.sessionId }
+        case 'session/create': return { sessionId: await ctx.sessions.create({ workspaceId: payload.workspaceId }) }
+        case 'session/search': {
+          const result = await ctx.sessions.search(String(payload.query || ''), signal)
+          if (!result.ok) throw new Error(result.error.message)
+          return result.value
+        }
+        case 'session/rename': {
+          return ctx.sessions.using(payload.sessionId, { source: 'controllerOperation', signal }, async reference => {
+            const binding = await reference.ready
+            const result = await binding.session.rename(payload.title)
+            if (!result.ok) throw new Error(result.error.message)
+            return result.value
+          })
+        }
+        case 'session/fork': {
+          const sessionId = await ctx.sessions.fork({ sessionId: payload.sessionId, increaseTitle: true })
+          return { sessionId }
+        }
+        case 'workspace/create': return { workspace: await ctx.workspaces.create({ path: payload.path }) }
+        case 'workspace/rename': return { workspace: await ctx.workspaces.rename(payload.workspaceId, payload.title) }
+        case 'workspace/delete': await ctx.workspaces.delete(payload.workspaceId); return {}
+        case 'workspace/insertBefore': await ctx.workspaces.insertBefore(payload.workspaceId, payload.beforeWorkspaceId); return {}
+        case 'workspace/archiveSession': await ctx.workspaces.archiveSession(payload.sessionId); return {}
+        case 'workspace/insertSessionBefore':
+          return { workspace: await ctx.workspaces.insertSessionBefore(payload.workspaceId, payload.sessionId, payload.beforeSessionId) }
+        default: throw new Error(`unsupported remote desktop bridge method ${String(method)}`)
+      }
+    }
+
+    exports.apply = function apply(ctx) {
+      const marker = new URLSearchParams(window.location.search).get('dshRemoteDesktop')
+      const { token, parent } = parseHash()
+      if (marker !== '1' || token === '' || parent === '') return
+      ctx.effect(() => {
+        const disposeCss = installEmbeddedCss()
+        let channel
+        let channelCleanup = () => {}
+        let openController
+        let announceTimer
+
+        const announceListening = () => {
+          window.parent.postMessage({
+            type: 'dsh-remote-desktop/bridge-listening',
+            protocolVersion: BRIDGE_PROTOCOL_VERSION,
+            sourceToken: token,
+          }, parent)
+        }
+
+        const attach = (port) => {
+          window.clearInterval(announceTimer)
+          channelCleanup()
+          channel = port
+          const generation = globalThis.crypto?.randomUUID?.() || `${Date.now()}-${Math.random()}`
+          let revision = 0
+          let queued = false
+          const publishBaseline = () => {
+            if (queued) return
+            queued = true
+            queueMicrotask(() => {
+              queued = false
+              if (channel !== port) return
+              revision += 1
+              port.postMessage({
+                type: 'dsh-remote-desktop/state-baseline',
+                protocolVersion: BRIDGE_PROTOCOL_VERSION,
+                sourceToken: token,
+                generation,
+                revision,
+                snapshot: controllerSnapshot(ctx),
+              })
+            })
+          }
+          const disposeSessions = ctx.sessions.list.subscribe(publishBaseline)
+          const disposeWorkspaces = ctx.workspaces.list.subscribe(publishBaseline)
+          port.onmessage = (event) => {
+            const data = event.data
+            if (data?.sourceToken !== token || data.protocolVersion !== BRIDGE_PROTOCOL_VERSION) return
+            if (data.type === 'dsh-remote-desktop/state-resync') {
+              publishBaseline()
+              return
+            }
+            if (data.type !== 'dsh-remote-desktop/request') return
+            if (typeof data.requestId !== 'string' || typeof data.method !== 'string') return
+            if (!BRIDGE_METHODS.has(data.method)) {
+              port.postMessage({
+                type: 'dsh-remote-desktop/result', protocolVersion: BRIDGE_PROTOCOL_VERSION,
+                sourceToken: token, requestId: data.requestId, ok: false,
+                error: { code: 'unsupported_method', message: `unsupported remote desktop bridge method ${data.method}` },
+              })
+              return
+            }
+            if (data.method === 'session/open') {
+              openController?.abort(new Error('session open superseded'))
+              openController = new AbortController()
+            }
+            const signal = data.method === 'session/open' ? openController.signal : AbortSignal.timeout(30_000)
+            void invoke(ctx, data.method, data.payload || {}, signal).then((value) => {
+              port.postMessage({
+                type: 'dsh-remote-desktop/result', protocolVersion: BRIDGE_PROTOCOL_VERSION,
+                sourceToken: token, requestId: data.requestId, ok: true, value,
+              })
+            }).catch((error) => {
+              port.postMessage({
+                type: 'dsh-remote-desktop/result', protocolVersion: BRIDGE_PROTOCOL_VERSION,
+                sourceToken: token, requestId: data.requestId, ok: false, error: structuredError(error),
+              })
+            })
+          }
+          port.start?.()
+          port.postMessage({
+            type: 'dsh-remote-desktop/ready',
+            protocolVersion: BRIDGE_PROTOCOL_VERSION,
+            sourceToken: token,
+            generation,
+            capabilities: BRIDGE_CAPABILITIES,
+          })
+          publishBaseline()
+          channelCleanup = () => {
+            disposeWorkspaces()
+            disposeSessions()
+            port.close()
+          }
+        }
+
+        const onMessage = (event) => {
+          if (event.origin !== parent || event.source !== window.parent) return
+          const data = event.data
+          if (data?.type !== 'dsh-remote-desktop/connect'
+            || data.protocolVersion !== BRIDGE_PROTOCOL_VERSION
+            || data.sourceToken !== token) return
+          const port = event.ports?.[0]
+          if (port === undefined) return
+          attach(port)
+        }
+        window.addEventListener('message', onMessage)
+        announceListening()
+        announceTimer = window.setInterval(announceListening, 500)
+        return () => {
+          window.clearInterval(announceTimer)
+          openController?.abort(new Error('remote desktop companion disposed'))
+          channelCleanup()
+          window.removeEventListener('message', onMessage)
+          disposeCss()
+        }
+      }, 'dsh-remote-desktop-companion: iframe bridge')
+    }
+    return module.exports
+  },
+})

package/lib/index.js

@@ -0,0 +1,23 @@
+export const name = 'dsh-remote-desktop-companion'
+export const inject = ['webServer']
+
+const HEALTH_PATH = '/remote-desktop-companion/api/health'
+
+/**
+ * Transitional package-readiness probe. Session and Workspace data always use
+ * the authenticated DSH Client Controller running inside the remote iframe.
+ */
+export function apply(ctx) {
+  const disposeHealth = ctx.webServer.register({
+    kind: 'exact',
+    path: HEALTH_PATH,
+    handler: (_req, res) => {
+      res.writeHead(200, {
+        'content-type': 'application/json; charset=utf-8',
+        'cache-control': 'no-store',
+      })
+      res.end(JSON.stringify({ ok: true, name }))
+    },
+  })
+  ctx.effect(() => disposeHealth, 'dsh-remote-desktop-companion: readiness route')
+}

package/package.json

@@ -1,6 +1,65 @@
 {
   "name": "dsh-ssh-workspace-companion",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.2.2",
+  "description": "Remote companion for dsh-remote-desktop iframe control.",
+  "type": "module",
+  "main": "lib/index.js",
+  "exports": {
+    ".": "./lib/index.js",
+    "./client": "./lib/client.js",
+    "./package.json": "./package.json"
+  },
+  "dsh": {
+    "bundle": {
+      "patch": "./cordis.patch.yml"
+    },
+    "client": {
+      "inject": [
+        "@deepseek-ai/dsh-api-session-controller",
+        "@deepseek-ai/dsh-api-workspace-controller",
+        "@deepseek-ai/dsh-client-ui-workspace"
+      ],
+      "platform": "web"
+    }
+  },
+  "peerDependencies": {
+    "@deepseek-ai/cordis": "^4.0.1",
+    "@deepseek-ai/dsh-api-session-controller": "0.2.0-rc.2",
+    "@deepseek-ai/dsh-api-workspace-controller": "0.2.0-rc.2",
+    "@deepseek-ai/dsh-host-webserver": "0.2.0-rc.2",
+    "@deepseek-ai/dsh-workspace": "0.2.0-rc.2"
+  },
+  "files": [
+    "lib",
+    "cordis.patch.yml",
+    "README.md",
+    "LICENSE"
+  ],
+  "license": "MIT",
+  "keywords": [
+    "dsh-plugin",
+    "deepseek-harness",
+    "dsh",
+    "deepseek",
+    "cordis",
+    "remote-desktop",
+    "iframe",
+    "companion",
+    "remote-workspace",
+    "ssh-workspace",
+    "dsh-ssh-workspace"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sincerity711/dsh-ssh-workspace.git",
+    "directory": "packages/companion"
+  },
+  "bugs": {
+    "url": "https://github.com/sincerity711/dsh-ssh-workspace/issues"
+  },
+  "homepage": "https://github.com/sincerity711/dsh-ssh-workspace#readme",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}