@chatcode/cco-better-sidebar 0.18.0-alpha.0

package/src/config.ts

@@ -0,0 +1,207 @@
+/**
+ * Serializable configuration and defaults for the sidebar host half. Loader
+ * schema validation normally fills defaults; {@link resolveSidebarConfig}
+ * applies the same defaults for direct callers that bypass the Loader.
+ * @module dsh-better-sidebar/config
+ */
+
+import z from 'schemastery'
+import {
+  SIDEBAR_PREFS_DEFAULTS,
+  SIDEBAR_PREFS_NS,
+  TERMINAL_FONT_SIZE_DEFAULT,
+  TERMINAL_FONT_SIZE_MAX,
+  TERMINAL_FONT_SIZE_MIN,
+  TITLE_BAR_STRIP_DEFAULT,
+  TITLE_BAR_STRIP_MAX,
+  TITLE_BAR_STRIP_MIN,
+  WIDTH_PERCENT_DEFAULT,
+  WIDTH_PERCENT_MAX,
+  WIDTH_PERCENT_MIN,
+  type SidebarPrefs,
+} from './prefs-shared.ts'
+
+export {
+  SIDEBAR_PREFS_DEFAULTS,
+  SIDEBAR_PREFS_NS,
+  TERMINAL_FONT_SIZE_DEFAULT,
+  TERMINAL_FONT_SIZE_MAX,
+  TERMINAL_FONT_SIZE_MIN,
+  TITLE_BAR_STRIP_DEFAULT,
+  TITLE_BAR_STRIP_MAX,
+  TITLE_BAR_STRIP_MIN,
+  WIDTH_PERCENT_DEFAULT,
+  WIDTH_PERCENT_MAX,
+  WIDTH_PERCENT_MIN,
+  type SidebarPrefs,
+} from './prefs-shared.ts'
+
+/** Tunable sidebar host limits (every field optional; defaults fill in). */
+export interface SidebarConfig {
+  /** Read cap of one text file (bytes); larger files return truncated. */
+  readLimit?: number
+  /** Media route cap (bytes); larger binaries are refused. */
+  mediaLimit?: number
+  /** Upload route cap (bytes); larger files are refused without touching disk. */
+  uploadLimit?: number
+  /** Explorer row bound of one level. */
+  listLimit?: number
+  /** Terminals per session. */
+  terminalsPerSession?: number
+  /** How long a disconnected terminal process survives awaiting a reconnect. */
+  reconnectGraceMs?: number
+  /**
+   * Terminal shell (absolute path or bare executable name) for BOTH the UI
+   * terminal tabs and the model-facing `terminal_*` tools. Empty = auto:
+   * POSIX follows `$SHELL` then the account login shell; Windows follows
+   * `DSH_SIDEBAR_SHELL`, then probes for `pwsh.exe`, then falls back to the
+   * inbox `powershell.exe` (5.1). Set it from `cordis.patch.yml` / profile
+   * plugin config, e.g. `config: { shell: /bin/zsh }`.
+   */
+  shell?: string
+  /**
+   * Optional arguments passed to the shell executable. When non-empty these
+   * REPLACE the automatic platform defaults (POSIX `-l` / Windows none), so
+   * the deployment has full control over how the shell starts. When omitted
+   * the existing default behavior is kept.
+   */
+  shellArgs?: string[]
+  /** Display name shown by the bottom-left account menu. Defaults to the host OS user. */
+  userName?: string
+  /** Connection details for the CodingPlan model catalogue. This is host-only
+   * configuration: API keys returned by CodingPlan are never part of it and
+   * are never sent to the browser. */
+  codingPlan?: CodingPlanConfig
+}
+
+/** Deployment-owned identity and endpoint used to read CodingPlan models. */
+export interface CodingPlanConfig {
+  /** CodingPlan service origin. */
+  baseUrl?: string
+  /** Identity query parameters required by the CodingPlan catalogue API. */
+  userId?: string
+  accountUuid?: string
+  userEmail?: string
+  emailAddress?: string
+  /** Catalogue request timeout in milliseconds. */
+  requestTimeoutMs?: number
+}
+
+/** Schemastery schema for the plugin configuration. */
+export const Config: z<SidebarConfig> = z.object({
+  readLimit: z.number().step(1).min(1).default(512 * 1024),
+  mediaLimit: z.number().step(1).min(1).default(20 * 1024 * 1024),
+  uploadLimit: z.number().step(1).min(1).default(128 * 1024 * 1024),
+  listLimit: z.number().step(1).min(1).default(1000),
+  terminalsPerSession: z.number().step(1).min(1).default(3),
+  reconnectGraceMs: z.number().step(1).min(0).default(30_000),
+  shell: z.string().default(''),
+  shellArgs: z.array(z.string()).default([]),
+  userName: z.string().default(''),
+  codingPlan: z.object({
+    baseUrl: z.string().default('http://localhost:8080'),
+    userId: z.string().default('admin-pingtai3'),
+    accountUuid: z.string().default('admin-pingtai3'),
+    userEmail: z.string().default('lull30'),
+    emailAddress: z.string().default('lull30'),
+    requestTimeoutMs: z.number().step(1).min(1000).max(60_000).default(10_000),
+  }),
+})
+
+/** Fully defaulted sidebar host settings. */
+export interface ResolvedSidebarConfig {
+  readLimit: number
+  mediaLimit: number
+  uploadLimit: number
+  listLimit: number
+  terminalsPerSession: number
+  reconnectGraceMs: number
+  /** The configured terminal shell; empty means the host auto-resolves it. */
+  shell: string
+  /** Explicit shell arguments; empty means use the platform defaults. */
+  shellArgs: string[]
+  /** Account-menu display name. */
+  userName: string
+  /** Fully resolved CodingPlan catalogue connection settings. */
+  codingPlan: ResolvedCodingPlanConfig
+}
+
+/** Fully defaulted CodingPlan configuration consumed by the host route. */
+export interface ResolvedCodingPlanConfig {
+  baseUrl: string
+  userId: string
+  accountUuid: string
+  userEmail: string
+  emailAddress: string
+  requestTimeoutMs: number
+}
+
+/**
+ * Apply direct-call defaults after Loader schema validation has normally run.
+ *
+ * @param config - Deployment-provided sidebar host settings.
+ * @returns Complete settings consumed by the host half.
+ */
+export function resolveSidebarConfig(config: SidebarConfig | undefined): ResolvedSidebarConfig {
+  return {
+    readLimit: config?.readLimit ?? 512 * 1024,
+    mediaLimit: config?.mediaLimit ?? 20 * 1024 * 1024,
+    uploadLimit: config?.uploadLimit ?? 128 * 1024 * 1024,
+    listLimit: config?.listLimit ?? 1000,
+    terminalsPerSession: config?.terminalsPerSession ?? 3,
+    reconnectGraceMs: config?.reconnectGraceMs ?? 30_000,
+    shell: config?.shell?.trim() ?? '',
+    shellArgs: config?.shellArgs ?? [],
+    userName: config?.userName?.trim() || process.env.USERNAME?.trim() || process.env.USER?.trim() || 'User',
+    codingPlan: {
+      baseUrl: config?.codingPlan?.baseUrl?.trim() || 'http://localhost:8080',
+      userId: config?.codingPlan?.userId?.trim() || 'admin-pingtai3',
+      accountUuid: config?.codingPlan?.accountUuid?.trim() || 'admin-pingtai3',
+      userEmail: config?.codingPlan?.userEmail?.trim() || 'lull30',
+      emailAddress: config?.codingPlan?.emailAddress?.trim() || 'lull30',
+      requestTimeoutMs: config?.codingPlan?.requestTimeoutMs ?? 10_000,
+    },
+  }
+}
+
+// ── User-facing "Side card" preferences ─────────────────────────────────────
+
+/** Schemastery schema for the user-facing preferences (validated by the settings service). */
+export const PrefsSchema: z<SidebarPrefs> = z.object({
+  openByDefault: z.boolean().default(false),
+  defaultWidthPercent: z.number().step(1).min(WIDTH_PERCENT_MIN).max(WIDTH_PERCENT_MAX).default(WIDTH_PERCENT_DEFAULT),
+  autoOpenSubagent: z.boolean().default(true),
+  autoOpenJobs: z.boolean().default(true),
+  agentTerminalTools: z.boolean().default(false),
+  agentOpenTools: z.boolean().default(false),
+  bottomPanelAutoTerminal: z.boolean().default(true),
+  terminalFontFamily: z.string().default(''),
+  terminalFontSize: z.number().step(1).min(TERMINAL_FONT_SIZE_MIN).max(TERMINAL_FONT_SIZE_MAX).default(TERMINAL_FONT_SIZE_DEFAULT),
+  interceptOpenPath: z.boolean().default(true),
+  editorExplorer: z.boolean().default(false),
+  workspaceFence: z.boolean().default(true),
+  terminalShell: z.string().default(''),
+  terminalShellArgs: z.string().default(''),
+  titleBarScheme: z.union([z.const('auto'), z.const('web'), z.const('preset'), z.const('custom')]),
+  titleBarPresetId: z.string(),
+  customCss: z.string(),
+  titleBarCompat: z.boolean().default(false),
+  titleBarStripPx: z.number().step(1).min(TITLE_BAR_STRIP_MIN).max(TITLE_BAR_STRIP_MAX).default(TITLE_BAR_STRIP_DEFAULT),
+  htmlViewerNoSandbox: z.boolean().default(false),
+  htmlViewerDefaultUnsafe: z.boolean().default(false),
+  browserNoSandbox: z.boolean().default(false),
+  browserInterceptLinks: z.boolean().default(true),
+  browserInterceptHttp: z.boolean().default(true),
+  browserInterceptHttps: z.boolean().default(false),
+  browserAllowedLoopback: z.string().default(''),
+  // Per-feature enable switches are OPEN maps (any tab/viewer id, built-in or
+  // external): an absent key means enabled, so old documents resolve to {}
+  // (everything on) with no migration. Non-boolean values fail validation.
+  tabsEnabled: z.dict(z.boolean()).default({}),
+  viewersEnabled: z.dict(z.boolean()).default({}),
+  // Plugin-owned settings blobs (v0.12.0+) are an OPEN nested map: any
+  // descriptor id may carry any JSON-serializable values. This is the
+  // "settings seam" opening — without it the seam would drop third-party
+  // keys as unknown schema fields.
+  pluginSettings: z.dict(z.dict(z.any())).default({}),
+})