@huanlin/dsh-plugin-sidebar-brand-text 0.3.0

package/lib/types/invariant.d.ts

@@ -0,0 +1,10 @@
+/** Package invariant companion for dsh-plugin-sidebar-brand-text. */
+import type { Context } from '@deepseek-ai/cordis';
+export declare const name = "sidebar-brand-text-invariant";
+export declare const inject: string[];
+/**
+ * Register this package's invariant companion.
+ * @param ctx - Cordis context carrying the invariant service.
+ * @returns the installed registration's disposer after setup succeeds.
+ */
+export declare const apply: (ctx: Context) => Promise<() => void>;

package/lib/types/settings.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Host-side settings bridge for `sidebar-brand-text`.
+ *
+ * Mirrors the ego-browser / dsh-plugin-interpreters pattern: a `source()`
+ * thunk the HTTP gateway reads in-process, plus an `onChange()` subscription.
+ * The settings service is reached through `ctx.inject(['settings'], ...)` so a
+ * composition without a settings provider still loads (entry-source fallback,
+ * no persistence). Multi-fiber dedupe is handled by catching the
+ * `"already registered"` rejection.
+ *
+ * @module @huanlin/dsh-plugin-sidebar-brand-text/settings
+ */
+import type { Context } from '@deepseek-ai/cordis';
+import type { BrandTextConfig } from './types.ts';
+/** Settings namespace under which brand-text config persists. */
+export declare const SETTINGS_NAMESPACE: import("@deepseek-ai/dsh-settings").SettingsNamespace;
+/** Bridge returned by {@link installBrandTextSettings}. */
+export interface BrandTextSettingsBridge {
+    /** Read the current resolved config (entry source or settings layer). */
+    source(): BrandTextConfig;
+    /** Subscribe to config changes (live re-registration follows every commit). */
+    onChange(callback: () => void): () => void;
+}
+/**
+ * Install the `sidebar-brand-text` settings namespace and return the bridge.
+ *
+ * @param ctx - host context.
+ * @param entry - raw composition-layer config seed.
+ * @returns the settings bridge.
+ */
+export declare function installBrandTextSettings(ctx: Context, entry: BrandTextConfig): BrandTextSettingsBridge;

package/lib/types/types.d.ts

@@ -0,0 +1,21 @@
+/** Shared config surface of the sidebar-brand-text plugin (host + client halves). */
+/**
+ * The plugin's user-facing settings, persisted through the settings seam
+ * under the `sidebar-brand-text` namespace in `$DSH_HOME/settings.yaml`.
+ * The browser half reads these via the `/sbbt/api/get` HTTP route.
+ */
+export interface BrandTextConfig {
+    /**
+     * Brand name text shown in the sidebar's top-left brand row, beside the
+     * mark slot. Replaces the shell's "DSH Local Build" fallback.
+     */
+    name: string;
+    /**
+     * Revision badge text rendered beside the brand name. Empty string hides
+     * the badge entirely. Replaces the shell's 7-character
+     * `DSH_CLIENT_COMMIT_HASH` fallback.
+     */
+    revision: string;
+}
+/** Runtime defaults applied when no config arrives (defensive only). */
+export declare const DEFAULT_BRAND_TEXT_CONFIG: BrandTextConfig;

package/package.json

@@ -0,0 +1,123 @@
+{
+  "name": "@huanlin/dsh-plugin-sidebar-brand-text",
+  "version": "0.3.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "dsh-plugin"
+  ],
+  "description": "替换侧边栏左上角的品牌名与构建徽标文案（默认 DSH Local Build + commit hash），经 WebUI 插件配置页卡片实时配置。 | Replace the sidebar's top-left brand name and build-revision badge text (defaults to DSH Local Build + commit hash) via a live settings card in the Plugin Config page.",
+  "type": "module",
+  "license": "MIT",
+  "main": "./lib/index.js",
+  "types": "./lib/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/types/index.d.ts",
+      "import": "./lib/index.js"
+    },
+    "./invariant": {
+      "types": "./lib/types/invariant.d.ts",
+      "import": "./lib/invariant.js"
+    },
+    "./client": {
+      "types": "./lib/types/client/index.d.ts",
+      "default": "./lib/client.js"
+    },
+    "./src/*": "./src/*",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "lib/",
+    "cordis.patch.yml"
+  ],
+  "dsh": {
+    "bundle": {
+      "patch": "./cordis.patch.yml"
+    },
+    "client": {
+      "inject": [
+        "@deepseek-ai/dsh-client-runtime",
+        "@deepseek-ai/dsh-client-locale",
+        "@deepseek-ai/dsh-client-ui-slots",
+        "@deepseek-ai/dsh-client-ui-sidebar",
+        "@deepseek-ai/dsh-client-ui-settings-plugins"
+      ],
+      "platform": "web"
+    }
+  },
+  "peerDependencies": {
+    "@deepseek-ai/cordis": "^4.0.0-rc.7",
+    "@deepseek-ai/dsh-client-locale": "0.1.0-rc.8",
+    "@deepseek-ai/dsh-client-runtime": "0.1.0-rc.8",
+    "@deepseek-ai/dsh-client-ui-settings-plugins": "0.1.0-rc.8",
+    "@deepseek-ai/dsh-client-ui-sidebar": "0.1.0-rc.8",
+    "@deepseek-ai/dsh-client-ui-slots": "0.1.0-rc.8",
+    "@deepseek-ai/dsh-invariants": "0.1.0-rc.8",
+    "@deepseek-ai/dsh-settings": "0.1.0-rc.8",
+    "@deepseek-ai/schemastery": "^3.18.1",
+    "react": "^18.2.0"
+  },
+  "peerDependenciesMeta": {
+    "@deepseek-ai/cordis": {
+      "optional": true
+    },
+    "@deepseek-ai/dsh-client-locale": {
+      "optional": true
+    },
+    "@deepseek-ai/dsh-client-runtime": {
+      "optional": true
+    },
+    "@deepseek-ai/dsh-client-ui-settings-plugins": {
+      "optional": true
+    },
+    "@deepseek-ai/dsh-client-ui-sidebar": {
+      "optional": true
+    },
+    "@deepseek-ai/dsh-client-ui-slots": {
+      "optional": true
+    },
+    "@deepseek-ai/dsh-invariants": {
+      "optional": true
+    },
+    "@deepseek-ai/dsh-settings": {
+      "optional": true
+    },
+    "@deepseek-ai/schemastery": {
+      "optional": true
+    },
+    "react": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@deepseek-ai/cordis": "^4.0.0-rc.7",
+    "@deepseek-ai/dsh-client-locale": "0.1.0-rc.8",
+    "@deepseek-ai/dsh-client-runtime": "0.1.0-rc.8",
+    "@deepseek-ai/dsh-client-ui-settings-plugins": "0.1.0-rc.8",
+    "@deepseek-ai/dsh-client-ui-sidebar": "0.1.0-rc.8",
+    "@deepseek-ai/dsh-client-ui-slots": "0.1.0-rc.8",
+    "@deepseek-ai/dsh-invariants": "0.1.0-rc.8",
+    "@deepseek-ai/dsh-settings": "0.1.0-rc.8",
+    "@deepseek-ai/schemastery": "^3.18.1",
+    "@types/node": "^22.20.1",
+    "@types/react": "~18.3.31",
+    "jsdom": "^26.0.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "schemastery": "^3.18.0",
+    "tsdown": "^0.15.0",
+    "typescript": "^5.9.0",
+    "vitest": "^3.2.0"
+  },
+  "engines": {
+    "node": ">=22.0.0"
+  },
+  "scripts": {
+    "typecheck": "tsc --noEmit -p tsconfig.json",
+    "test": "vitest run",
+    "build": "tsdown -c tsdown.config.ts && tsc -p tsconfig.json",
+    "bundle:client": "tsdown -c tsdown.config.ts"
+  }
+}