dsh-smooth-stream 0.1.0 → 0.3.1

package/src/plugin.ts

@@ -1,8 +1,14 @@
 import type { Context } from '@deepseek-ai/cordis'
 import type {} from '@deepseek-ai/dsh-host-webserver'
+import type { ConnectionRpcHandler } from '@deepseek-ai/dsh-client-connection'
+import { settingsNamespace } from '@deepseek-ai/dsh-settings'
 import Schema from '@deepseek-ai/schemastery'
 import { DEFAULT_STREAM_CONFIG, type StreamConfig } from './config.ts'
 import { injectStreamConfig } from './boot-config.ts'
+import { STREAM_PACKAGE_NAME, STREAM_PACKAGE_VERSION } from './package-meta.ts'
+import { inspectProfileInstallation, updateNpmProfilePackage } from './profile-installation.ts'
+import { STREAM_SETTINGS_RPC, STREAM_SETTINGS_RPC_CHANNEL, type StreamSettingsView } from './settings-api.ts'
+import { DEFAULT_STREAM_SETTINGS, STREAM_SETTINGS_NS, type StreamSettings } from './settings.ts'
 
 /** Display name shown by the Host loader while the plugin is mounted. */
 export const name = 'dsh-smooth-stream'
@@ -31,6 +37,14 @@ export const Config: Schema<Config> = Schema.object({
     .default(DEFAULT_STREAM_CONFIG.maxScrollSpeedPxPerSec),
 })
 
+/**
+ * Schema of the user-owned settings section. The Host keeps it in the durable
+ * settings provider while the browser edits it through the plugin RPC below.
+ */
+export const StreamSettingsSchema: Schema<StreamSettings> = Schema.object({
+  thinkAutoExpand: Schema.boolean().default(DEFAULT_STREAM_SETTINGS.thinkAutoExpand),
+})
+
 /**
  * Host half: log the resolved configuration and bridge it to the browser
  * half. The web boot graph carries no per-entry config, so the validated
@@ -51,4 +65,91 @@ export function apply(ctx: Context, config: Config): void {
       'dsh-smooth-stream: boot config bridge',
     )
   })
+  // The core settings RPC deliberately filters third-party namespaces. Keep
+  // the durable provider as the authority, but expose this one schema through
+  // the plugin's own loopback-only connection channel instead.
+  ctx.inject(['settings'], (settingsCtx) => {
+    const scope = settingsCtx.settings.register(
+      settingsNamespace(STREAM_SETTINGS_NS),
+      StreamSettingsSchema,
+      { applies: 'live' },
+    )
+    settingsCtx.inject(['connection'], (connectionCtx) => {
+      let upgrade: Promise<void> | undefined
+
+      const view = (): StreamSettingsView => {
+        const installation = inspectProfileInstallation(connectionCtx.baseUrl, STREAM_PACKAGE_NAME)
+        return {
+          version: STREAM_PACKAGE_VERSION,
+          installation: installation.kind,
+          writable: connectionCtx.settings.writable,
+          thinkAutoExpand: scope.get().thinkAutoExpand,
+          canUpgrade: installation.kind === 'npm',
+        }
+      }
+
+      const handle: ConnectionRpcHandler = async (endpoint, payload) => {
+        if (endpoint === STREAM_SETTINGS_RPC.read) return { ok: true, value: view() }
+        if (endpoint === STREAM_SETTINGS_RPC.write) {
+          if (typeof payload !== 'object' || payload === null
+            || typeof (payload as { thinkAutoExpand?: unknown }).thinkAutoExpand !== 'boolean') {
+            return {
+              ok: false,
+              error: {
+                code: 'settings-rejected',
+                message: 'thinkAutoExpand must be a boolean',
+                details: { ns: STREAM_SETTINGS_NS },
+              },
+            }
+          }
+          if (!connectionCtx.settings.writable) {
+            return {
+              ok: false,
+              error: {
+                code: 'settings-rejected',
+                message: 'smooth-stream settings are read-only',
+                details: { ns: STREAM_SETTINGS_NS },
+              },
+            }
+          }
+          try {
+            await scope.update({ thinkAutoExpand: (payload as { thinkAutoExpand: boolean }).thinkAutoExpand })
+          } catch {
+            return {
+              ok: false,
+              error: {
+                code: 'settings-rejected',
+                message: 'smooth-stream settings update failed',
+                details: { ns: STREAM_SETTINGS_NS },
+              },
+            }
+          }
+          return { ok: true, value: view() }
+        }
+        if (endpoint === STREAM_SETTINGS_RPC.upgrade) {
+          const installation = inspectProfileInstallation(connectionCtx.baseUrl, STREAM_PACKAGE_NAME)
+          if (installation.kind !== 'npm') {
+            return { ok: false, error: { code: 'internal', message: 'smooth-stream is not an npm profile dependency', details: {} } }
+          }
+          if (upgrade !== undefined) {
+            return { ok: false, error: { code: 'internal', message: 'smooth-stream update is already running', details: {} } }
+          }
+          upgrade = updateNpmProfilePackage(installation.profileDir, STREAM_PACKAGE_NAME)
+          try {
+            await upgrade
+          } catch {
+            return { ok: false, error: { code: 'internal', message: 'smooth-stream update failed', details: {} } }
+          } finally {
+            upgrade = undefined
+          }
+          return { ok: true, value: { restartRequired: true } }
+        }
+        return { ok: false, error: { code: 'internal', message: `unknown smooth-stream endpoint ${JSON.stringify(endpoint)}`, details: {} } }
+      }
+      connectionCtx.effect(
+        () => connectionCtx.connection.rpc.handle(STREAM_SETTINGS_RPC_CHANNEL, handle, { authority: 'loopback' }),
+        'dsh-smooth-stream: settings RPC',
+      )
+    })
+  })
 }

package/src/profile-installation.ts

@@ -0,0 +1,121 @@
+/** Host-only profile source inspection and fixed npm update runner. */
+
+import { spawn } from 'node:child_process'
+import { readFileSync } from 'node:fs'
+import { basename, isAbsolute, join } from 'node:path'
+import { fileURLToPath } from 'node:url'
+
+/** A profile installation that can be updated through a fixed pnpm invocation. */
+export interface NpmProfileInstallation {
+  kind: 'npm'
+  profileDir: string
+  profileName: string
+}
+
+/** A local source is deliberately not eligible for one-click npm updates. */
+export interface DevelopmentProfileInstallation {
+  kind: 'development'
+}
+
+/** The active context is not a recognized profile dependency. */
+export interface UnmanagedProfileInstallation {
+  kind: 'unmanaged'
+}
+
+/** Installation source visible to the plugin's Host RPC. */
+export type ProfileInstallation = NpmProfileInstallation | DevelopmentProfileInstallation | UnmanagedProfileInstallation
+
+interface ProfileManifest {
+  dependencies?: unknown
+  dsh?: unknown
+}
+
+function record(value: unknown): Record<string, unknown> | undefined {
+  return typeof value === 'object' && value !== null && !Array.isArray(value)
+    ? value as Record<string, unknown>
+    : undefined
+}
+
+function profileDirectory(baseUrl: string | undefined): string | undefined {
+  if (baseUrl === undefined) return undefined
+  try {
+    const url = new URL(baseUrl)
+    return url.protocol === 'file:' ? fileURLToPath(url) : undefined
+  } catch {
+    return undefined
+  }
+}
+
+function hasBundle(manifest: ProfileManifest, packageName: string): boolean {
+  const dsh = record(manifest.dsh)
+  const profile = record(dsh?.profile)
+  const bundles = profile?.bundles
+  return Array.isArray(bundles) && bundles.includes(packageName)
+}
+
+function isLocalSpecifier(specifier: string): boolean {
+  return specifier.startsWith('link:')
+    || specifier.startsWith('file:')
+    || specifier.startsWith('.')
+    || isAbsolute(specifier)
+    || /^[A-Za-z]:[\\/]/.test(specifier)
+}
+
+function isRegistrySpecifier(specifier: string): boolean {
+  // A registry range/tag contains neither a scheme nor a path. Treat every
+  // package-manager extension (catalog:, patch:, portal:, workspace:, etc.)
+  // as unconfirmed rather than guessing that an update may replace it.
+  return specifier.length > 0 && !specifier.includes(':') && !/[\\/]/.test(specifier)
+}
+
+function isNpmSpecifier(specifier: string, packageName: string): boolean {
+  if (!specifier.startsWith('npm:')) return isRegistrySpecifier(specifier)
+  const aliased = specifier.slice('npm:'.length)
+  if (aliased === packageName) return true
+  const prefix = `${packageName}@`
+  return aliased.startsWith(prefix) && isRegistrySpecifier(aliased.slice(prefix.length))
+}
+
+/**
+ * Read only the profile manifest anchored by the current Cordis config tree.
+ * A malformed or unrelated tree never receives an update affordance.
+ */
+export function inspectProfileInstallation(
+  baseUrl: string | undefined,
+  packageName: string,
+): ProfileInstallation {
+  const profileDir = profileDirectory(baseUrl)
+  if (profileDir === undefined) return { kind: 'unmanaged' }
+  let manifest: ProfileManifest
+  try {
+    manifest = JSON.parse(readFileSync(join(profileDir, 'package.json'), 'utf8')) as ProfileManifest
+  } catch {
+    return { kind: 'unmanaged' }
+  }
+  const dependencies = record(manifest.dependencies)
+  const specifier = dependencies?.[packageName]
+  if (typeof specifier !== 'string' || !hasBundle(manifest, packageName)) {
+    return { kind: 'unmanaged' }
+  }
+  if (isLocalSpecifier(specifier)) return { kind: 'development' }
+  if (!isNpmSpecifier(specifier, packageName)) return { kind: 'unmanaged' }
+  return { kind: 'npm', profileDir, profileName: basename(profileDir) }
+}
+
+/** Run the same fixed package update operation that a profile user would invoke. */
+export function updateNpmProfilePackage(profileDir: string, packageName: string): Promise<void> {
+  const command = process.platform === 'win32' ? 'pnpm.cmd' : 'pnpm'
+  return new Promise((resolve, reject) => {
+    const child = spawn(command, ['update', packageName], {
+      cwd: profileDir,
+      stdio: 'ignore',
+      shell: false,
+      windowsHide: true,
+    })
+    child.once('error', reject)
+    child.once('exit', (code, signal) => {
+      if (code === 0) resolve()
+      else reject(new Error(`dsh-smooth-stream: pnpm update failed (${signal ?? String(code)})`))
+    })
+  })
+}

package/src/settings-api.ts

@@ -0,0 +1,33 @@
+/** Shared wire vocabulary for the plugin-owned settings RPC channel. */
+
+/** Dedicated, loopback-only RPC channel registered by the Host half. */
+export const STREAM_SETTINGS_RPC_CHANNEL = '/smooth-stream'
+
+/** Endpoints accepted by {@link STREAM_SETTINGS_RPC_CHANNEL}. */
+export const STREAM_SETTINGS_RPC = {
+  read: 'settings.read',
+  write: 'settings.write',
+  upgrade: 'plugin.upgrade',
+} as const
+
+/** How the active profile supplied this plugin. */
+export type StreamInstallationKind = 'npm' | 'development' | 'unmanaged'
+
+/** Redacted, plugin-owned configuration state returned to the browser. */
+export interface StreamSettingsView {
+  /** Version of the package currently running in the Host process. */
+  version: string
+  /** Source class of this package in the active profile. */
+  installation: StreamInstallationKind
+  /** Whether the Host settings provider permits a write. */
+  writable: boolean
+  /** Current resolved preference. */
+  thinkAutoExpand: boolean
+  /** Whether a fixed npm update command is safe to offer. */
+  canUpgrade: boolean
+}
+
+/** Successful package update acknowledgement; loading the new code needs a restart. */
+export interface StreamUpgradeView {
+  restartRequired: true
+}

package/src/settings.ts

@@ -0,0 +1,30 @@
+/**
+ * User-owned settings for the smooth-stream plugin, exposed to the Host
+ * settings service and edited from the Web Settings "plugin configuration"
+ * page. This is the runtime-editable complement to {@link StreamConfig}: that
+ * contract is composed at load and bridged once through the boot global, while
+ * these preferences live in the durable user-settings document and take effect
+ * live.
+ */
+
+/** Settings namespace registered by the Host and served through the plugin RPC. */
+export const STREAM_SETTINGS_NS = 'smooth-stream'
+
+/**
+ * Preferences a user may set. Deliberately separate from {@link StreamConfig}
+ * because the two change at different times: composition-time values go
+ * through the boot global, a live UI edit goes through the protected plugin RPC.
+ */
+export interface StreamSettings {
+  /**
+   * Whether a reasoning ("Think") block auto-expands while it is the
+   * streaming tail. Off keeps the block collapsed — the user can still open
+   * it by hand — and stops the running state from re-owning the disclosure.
+   */
+  thinkAutoExpand: boolean
+}
+
+/** Defaults shared by the Host schema and the client-side fallback. */
+export const DEFAULT_STREAM_SETTINGS: StreamSettings = {
+  thinkAutoExpand: true,
+}

package/README.zh.md

@@ -1,88 +0,0 @@
-# dsh-smooth-stream
-
-[English](README.md) | 中文
-
-[![featured on dsh-suite](https://img.shields.io/badge/featured%20on-dsh--suite-4d6bfe)](https://whyihaveyou.github.io/dsh-suite/)
-
-**dsh-smooth-stream** 是 [DeepSeek Harness](https://github.com/deepseek-ai/deepseek-harness)（`dsh`）的社区插件，给 Web 对话做**丝滑流式渲染**：字跟着模型走、换行滑入、不闪。不是官方发行的一部分。
-
-项目主页：<https://laplace-bit.github.io/dsh-smooth-stream/>
-
-## 效果
-
-左：默认 Web UI。右：dsh-smooth-stream。
-
-![左：未使用插件。右：使用 dsh-smooth-stream。](docs/compare.gif)
-
-## 它做什么
-
-- **揭示跟着模型走。** 助手文本按到达速率出现。突发不会整段倒出来，慢流也不会停住再猛地补上。
-- **一直是 Markdown。** 代码、强调等在流式过程中就按格式渲染，没有先出纯文本再换成排版的交接。
-- **换行是滑进来的。** 新的一行或正在变高的工具卡片会滑入视野，而不是把整段记录往上顶一格。
-- **滚动条归你。** 往上翻看前文时 overlay 会松手。只有回到底部才会继续跟随——点「回到底部」也算。
-- **思考仍是内置那一行。** 推理用原来的 disclosure。它是当前流式尾部时展开，思考一结束就收起；箭头仍可手动开关。
-- **整轮一起动。** 运行中的工具卡片、模型重试、workflow run 共用同一套跟随，所以滑的是整轮回复，不只是助手正文。
-- **该停的时候会停。** `prefers-reduced-motion` 会直接给出全文，也不接管跟随。帧率低于 30 fps 且回复在屏外时，揭示会暂停，画面恢复后再补上。
-
-## 安装
-
-在 DeepSeek Harness 源码仓库里：
-
-```sh
-pnpm dsh plugin --profile web add github:Laplace-bit/dsh-smooth-stream
-```
-
-如果 `PATH` 上已经有 `dsh`：
-
-```sh
-dsh plugin --profile web add github:Laplace-bit/dsh-smooth-stream
-```
-
-第一次 `add` 失败是正常的。git 安装需要跑这个包的 `prepare` 脚本，pnpm ≥10 在你授权之前会拦截。打开 `~/.dsh/profiles/web/pnpm-workspace.yaml`，把 pnpm 打印的那段加进去。当前 pnpm 打印的是：
-
-```yaml
-onlyBuiltDependencies:
-  - dsh-smooth-stream
-```
-
-然后重新执行同一条 `add`。
-
-启动界面：
-
-```sh
-pnpm dsh web
-```
-
-Host 日志里应出现 `[dsh-smooth-stream] plugin loaded!`。
-
-卸载：`pnpm dsh plugin --profile web remove dsh-smooth-stream`（或 `dsh plugin --profile web remove dsh-smooth-stream`）。
-
-## 配置
-
-组合包默认 `preset: balanced`。要换节拍，在 profile 的 `cordis.patch.yml` 里改：
-
-| `preset` | 手感 |
-| --- | --- |
-| `realtime` | 更贴模型到达 |
-| `balanced` | 默认 |
-| `silky` | 缓冲更大，追上更慢 |
-
-`maxScrollSpeedPxPerSec`（默认 `1000`）是速度上限，避免第一次滞后过大时瞬移。
-
-## 常见问题
-
-**这是 DeepSeek 官方插件吗？**
-不是。它是 DeepSeek Harness（`dsh`）Web UI 的社区插件，MIT 协议开源，不属于 DeepSeek 官方发行。
-
-**dsh 插件怎么安装？**
-用内置插件命令：在 dsh 源码目录运行 `dsh plugin --profile web add github:Laplace-bit/dsh-smooth-stream`（pnpm ≥10 的构建授权说明见[安装](#安装)）。
-
-**能用 npm 安装吗？**
-暂时不能，目前只支持从 GitHub 安装。可以关注本仓库，npm 发布后会有通知。
-
-**支持 `prefers-reduced-motion` 吗？**
-支持。系统开启减少动态效果时直接显示完整文本、不接管跟随；帧率低于 30 fps 且回复在屏外时，揭示自动暂停、恢复后再补上。
-
-## 许可证
-
-[MIT](LICENSE)