dsh-background-by-model 0.3.2 → 0.4.1

package/lib/index.js

@@ -1,75 +1,67 @@
 import { access, mkdir, readFile, readdir, rename, rm, writeFile } from "node:fs/promises";
 import { dshHomePath } from "@deepseek-ai/dsh-home-paths";
-//#region src/index.ts
+//#region src/schema.ts
+/** Every accepted `bgMode`, in UI order. */
+const BG_MODES = [
+	"fit",
+	"fill",
+	"stretch",
+	"tile",
+	"center"
+];
 /**
-* Node half of dsh-background-by-model: file-backed rule persistence.
-*
-* Owns the `~/.dsh/.dsh-background-by-model-data/` store and exposes a small RPC
-* surface on the dedicated `/dsh-background-by-model` channel (never the shared
-* `/api`, so slash commands stay intact).
-*
-*   theme-config.json   the ordered rule list + the global interface settings
-*   modelbg-<slot>      one background image per rule (raw bytes, no extension;
-*                       the MIME is sniffed from the magic bytes when served)
-*
-* Images travel as data URLs over the RPC channel — there is no separate HTTP
-* image route. A legacy single-wallpaper / video-background store is migrated
-* to rule 1 on first read.
+* Main interface opacities (0..1), global (Interface page):
+*   `bg`      main background (`--dsw-alias-bg-base`)
+*   `sidebar` sidebar (`--dsw-specific-sidebar-fill`)
+*   `card`    cards/panels (`--dsw-alias-bg-layer-1/2/3`, `--dsw-specific-menu`
+*             and its 0.1.7 alias `--dsw-menu-surface-fill`)
+*   `input`   input/control surfaces (`--dsw-specific-input-major`)
 */
-const name = "dsh-background-by-model";
-const inject = ["connection", "webServer"];
-const DATA_DIR = ".dsh-background-by-model-data";
-const CONFIG_FILE = "theme-config.json";
-const IMAGE_PREFIX = "modelbg-";
-const LEGACY_WALLPAPER = "wallpaper.jpg";
-const LEGACY_FILES = [
-	"wallpaper.mp4",
-	"wallpaper.webm",
-	"wallpaper.ogv",
-	"wallpaper.mov",
-	"wallpaper.mkv",
-	"wallpaper.video",
-	"wallpaper.upload.tmp"
+const PART_OPACITY_KEYS = [
+	"bg",
+	"sidebar",
+	"card",
+	"input"
 ];
-/** Slot names reach the filesystem, so they are strictly whitelisted. */
-const SLOT_RE = /^[A-Za-z0-9_-]{1,32}$/;
-const WALLPAPER_FETCH_MAX = 26214400;
-const WALLPAPER_FETCH_TIMEOUT = 2e4;
-const DEFAULT_CONFIG = {
-	rules: [],
-	opacities: {
-		bg: .85,
-		sidebar: .93,
-		card: 1,
-		input: 1
-	},
-	blurs: {
-		bg: 0,
-		sidebar: 0,
-		card: 0,
-		settings: 0,
-		chat: 0,
-		trajectory: 0,
-		rightbar: 0,
-		input: 0
-	},
-	settingsOpacity: 1,
-	chatTextOpacity: 0,
-	trajectoryOpacity: 1,
-	rightbarOpacity: null
+const DEFAULT_PART_OPACITIES = {
+	bg: .85,
+	sidebar: .93,
+	card: 1,
+	input: 1
 };
-const dataDir = () => dshHomePath(DATA_DIR);
-const configPath = () => dshHomePath(DATA_DIR, CONFIG_FILE);
-const legacyWallpaperPath = () => dshHomePath(DATA_DIR, LEGACY_WALLPAPER);
-const imagePath = (slot) => dshHomePath(DATA_DIR, `${IMAGE_PREFIX}${slot}`);
-const exists = async (p) => {
-	try {
-		await access(p);
-		return true;
-	} catch {
-		return false;
-	}
+/**
+* Interface blur (px, 0..60), global (Interface page):
+*   `bg`         main background (AppFrame grid)
+*   `sidebar`    sidebar column
+*   `card`       cards/panels (center + details columns, dialog option panels)
+*   `settings`   settings panel
+*   `chat`       conversation text region (message column of the chat view)
+*   `trajectory` trajectory view surface
+*   `rightbar`   file-preview panel — the right sidebar a file click opens
+*   `input`      input/control surfaces ([data-composer-card], [data-cordis-panel])
+*/
+const PART_BLUR_KEYS = [
+	"bg",
+	"sidebar",
+	"card",
+	"settings",
+	"chat",
+	"trajectory",
+	"rightbar",
+	"input"
+];
+const DEFAULT_PART_BLURS = {
+	bg: 0,
+	sidebar: 0,
+	card: 0,
+	settings: 0,
+	chat: 0,
+	trajectory: 0,
+	rightbar: 0,
+	input: 0
 };
+/** Slot names reach the filesystem, so they are strictly whitelisted. */
+const SLOT_RE = /^[A-Za-z0-9_-]{1,32}$/;
 function clamp(n, lo, hi, def) {
 	return typeof n === "number" && isFinite(n) ? Math.min(hi, Math.max(lo, n)) : def;
 }
@@ -84,31 +76,29 @@ function normalizeBgState(s) {
 		ih: typeof v.ih === "number" && v.ih > 0 ? v.ih : 0
 	};
 }
+/** One `[h, s, l]` triple, or null when the value is not a complete finite triple. */
+function normalizeHsl(raw) {
+	if (!Array.isArray(raw) || raw.length !== 3) return null;
+	if (!raw.every((n) => typeof n === "number" && isFinite(n))) return null;
+	return [
+		clamp(raw[0], 0, 360, 220),
+		clamp(raw[1], 0, 1, .55),
+		clamp(raw[2], 0, 1, .25)
+	];
+}
 /** Coerce one persisted rule, or null when it lacks a usable id/slot. */
 function normalizeRule(raw) {
 	const r = raw ?? {};
 	const id = typeof r.id === "string" && r.id !== "" ? r.id : null;
 	const slot = typeof r.slot === "string" && SLOT_RE.test(r.slot) ? r.slot : null;
 	if (id === null || slot === null) return null;
-	const c = r.color;
-	const color = Array.isArray(c) && c.length === 3 && c.every((n) => typeof n === "number" && isFinite(n)) ? [
-		clamp(c[0], 0, 360, 220),
-		clamp(c[1], 0, 1, .55),
-		clamp(c[2], 0, 1, .25)
-	] : null;
-	const mode = [
-		"fit",
-		"fill",
-		"stretch",
-		"tile",
-		"center"
-	].includes(r.bgMode) ? r.bgMode : "fit";
+	const mode = BG_MODES.includes(r.bgMode) ? r.bgMode : "fit";
 	return {
 		id,
 		slot,
 		match: typeof r.match === "string" ? r.match : "",
 		enabled: r.enabled !== false,
-		color,
+		color: normalizeHsl(r.color),
 		bgMode: mode,
 		wallpaperOpacity: clamp01(r.wallpaperOpacity, 1),
 		blur: clamp(r.blur, 0, 60, 0),
@@ -122,31 +112,66 @@ function normalizeConfig(raw) {
 	const ops = r.opacities ?? {};
 	const bl = r.blurs ?? {};
 	const blurs = {};
-	for (const k of [
-		"bg",
-		"sidebar",
-		"card",
-		"settings",
-		"chat",
-		"trajectory",
-		"rightbar",
-		"input"
-	]) blurs[k] = clamp(bl[k], 0, 60, DEFAULT_CONFIG.blurs[k]);
+	for (const k of PART_BLUR_KEYS) blurs[k] = clamp(bl[k], 0, 60, DEFAULT_PART_BLURS[k]);
+	const opacities = {};
+	for (const k of PART_OPACITY_KEYS) opacities[k] = clamp01(ops[k], DEFAULT_PART_OPACITIES[k]);
 	return {
 		rules,
-		opacities: {
-			bg: clamp01(ops.bg, DEFAULT_CONFIG.opacities.bg),
-			sidebar: clamp01(ops.sidebar, DEFAULT_CONFIG.opacities.sidebar),
-			card: clamp01(ops.card, DEFAULT_CONFIG.opacities.card),
-			input: clamp01(ops.input, DEFAULT_CONFIG.opacities.input)
-		},
+		opacities,
 		blurs,
-		settingsOpacity: clamp01(r.settingsOpacity, DEFAULT_CONFIG.settingsOpacity),
-		chatTextOpacity: clamp01(r.chatTextOpacity, DEFAULT_CONFIG.chatTextOpacity),
-		trajectoryOpacity: clamp01(r.trajectoryOpacity, DEFAULT_CONFIG.trajectoryOpacity),
-		rightbarOpacity: typeof r.rightbarOpacity === "number" && isFinite(r.rightbarOpacity) ? clamp01(r.rightbarOpacity, 1) : null
+		settingsOpacity: clamp01(r.settingsOpacity, 1),
+		chatTextOpacity: clamp01(r.chatTextOpacity, 0),
+		trajectoryOpacity: clamp01(r.trajectoryOpacity, 1),
+		rightbarOpacity: typeof r.rightbarOpacity === "number" && isFinite(r.rightbarOpacity) ? clamp01(r.rightbarOpacity, 1) : null,
+		autoExtract: r.autoExtract !== false
 	};
 }
+//#endregion
+//#region src/index.ts
+/**
+* Node half of dsh-background-by-model: file-backed rule persistence.
+*
+* Owns the `~/.dsh/.dsh-background-by-model-data/` store and exposes a small RPC
+* surface on the dedicated `/dsh-background-by-model` channel (never the shared
+* `/api`, so slash commands stay intact).
+*
+*   theme-config.json   the ordered rule list + the global interface settings
+*   modelbg-<slot>      one background image per rule (raw bytes, no extension;
+*                       the MIME is sniffed from the magic bytes when served)
+*
+* Images travel as data URLs over the RPC channel — there is no separate HTTP
+* image route. A legacy single-wallpaper / video-background store is migrated
+* to rule 1 on first read.
+*/
+const name = "dsh-background-by-model";
+const inject = ["connection", "webServer"];
+const DATA_DIR = ".dsh-background-by-model-data";
+const CONFIG_FILE = "theme-config.json";
+const IMAGE_PREFIX = "modelbg-";
+const LEGACY_WALLPAPER = "wallpaper.jpg";
+const LEGACY_FILES = [
+	"wallpaper.mp4",
+	"wallpaper.webm",
+	"wallpaper.ogv",
+	"wallpaper.mov",
+	"wallpaper.mkv",
+	"wallpaper.video",
+	"wallpaper.upload.tmp"
+];
+const WALLPAPER_FETCH_MAX = 26214400;
+const WALLPAPER_FETCH_TIMEOUT = 2e4;
+const dataDir = () => dshHomePath(DATA_DIR);
+const configPath = () => dshHomePath(DATA_DIR, CONFIG_FILE);
+const legacyWallpaperPath = () => dshHomePath(DATA_DIR, LEGACY_WALLPAPER);
+const imagePath = (slot) => dshHomePath(DATA_DIR, `${IMAGE_PREFIX}${slot}`);
+const exists = async (p) => {
+	try {
+		await access(p);
+		return true;
+	} catch {
+		return false;
+	}
+};
 /**
 * One-shot migration of the pre-0.3 store.
 *
@@ -216,10 +241,44 @@ async function readConfig() {
 	}
 	return normalizeConfig(await migrateLegacy(raw));
 }
+const LEGACY_CONFIG_KEYS = /* @__PURE__ */ new Set([
+	"color",
+	"bgMode",
+	"wallpaperOpacity",
+	"blur",
+	"bgState"
+]);
+const warnedConfigKeys = /* @__PURE__ */ new Set();
+function warnUnknownConfigKeys(raw, normalized) {
+	if (raw === null || typeof raw !== "object") return;
+	const r = raw;
+	const warned = (id) => {
+		if (warnedConfigKeys.has(id)) return;
+		warnedConfigKeys.add(id);
+		console.warn(`dsh-background-by-model: ignoring unknown config field "${id}" (declared in one half only?)`);
+	};
+	const known = new Set(Object.keys(normalized));
+	for (const key of Object.keys(r)) if (!known.has(key) && !LEGACY_CONFIG_KEYS.has(key)) warned(key);
+	const groups = [["blurs", normalized.blurs], ["opacities", normalized.opacities]];
+	for (const [group, have] of groups) {
+		const got = r[group];
+		if (got === null || typeof got !== "object") continue;
+		const keys = new Set(Object.keys(have));
+		for (const key of Object.keys(got)) if (!keys.has(key)) warned(`${group}.${key}`);
+	}
+	const sent = Array.isArray(r.rules) ? r.rules[0] : void 0;
+	const have = normalized.rules[0];
+	if (sent !== null && typeof sent === "object" && have !== void 0) {
+		const keys = new Set(Object.keys(have));
+		for (const key of Object.keys(sent)) if (!keys.has(key)) warned(`rules[].${key}`);
+	}
+}
 async function writeConfig(config) {
 	await ensureDir();
 	try {
-		await writeFile(configPath(), JSON.stringify(normalizeConfig(config), null, 2), "utf8");
+		const normalized = normalizeConfig(config);
+		warnUnknownConfigKeys(config, normalized);
+		await writeFile(configPath(), JSON.stringify(normalized, null, 2), "utf8");
 		return true;
 	} catch (e) {
 		console.error(`dsh-background-by-model: failed to write "${CONFIG_FILE}"`, e);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dsh-background-by-model",
-  "version": "0.3.2",
+  "version": "0.4.1",
   "description": "Appearance plugin for DeepSeek Harness: an ordered list of model rules, each carrying its own wallpaper, theme color, layout mode, opacity and blur — the background follows the model you switch to.",
   "keywords": [
     "deepseek-harness",
@@ -23,7 +23,7 @@
   "author": "Tkingxiao",
   "type": "module",
   "engines": {
-    "dsh": ">=0.1.2-rc.1"
+    "dsh": ">=0.1.7-rc.2"
   },
   "exports": {
     ".": {
@@ -68,12 +68,12 @@
   },
   "peerDependencies": {
     "@deepseek-ai/cordis": "^4.0.2",
-    "@deepseek-ai/dsh-client-locale": "^0.1.2-alpha.2",
-    "@deepseek-ai/dsh-client-store": "^0.1.2-alpha.2",
-    "@deepseek-ai/dsh-client-connection": "^0.1.2-alpha.2",
-    "@deepseek-ai/dsh-client-ui-settings": "^0.1.2-alpha.2",
-    "@deepseek-ai/dsh-client-ui-theme": "^0.1.2-alpha.2",
-    "@deepseek-ai/dsh-invariants": "^0.1.2-alpha.2",
+    "@deepseek-ai/dsh-client-locale": ">=0.1.7-rc.2",
+    "@deepseek-ai/dsh-client-store": ">=0.1.7-rc.2",
+    "@deepseek-ai/dsh-client-connection": ">=0.1.7-rc.2",
+    "@deepseek-ai/dsh-client-ui-settings": ">=0.1.7-rc.2",
+    "@deepseek-ai/dsh-client-ui-theme": ">=0.1.7-rc.2",
+    "@deepseek-ai/dsh-invariants": ">=0.1.7-rc.2",
     "react": "^18.2.0"
   },
   "peerDependenciesMeta": {