@huanlin/dsh-plugin-sidebar-brand-text 0.6.1 → 0.6.2

package/lib/index.js

@@ -1,234 +1,200 @@
-import z from "@deepseek-ai/schemastery";
-
-//#region src/config.ts
-/** Schemastery schema for the composition entry and the settings namespace. */
-const Config = z.object({
-	name: z.string().default("DSH Local Build").description("Brand name text shown in the sidebar next to the logo."),
-	revision: z.string().default("").description("Revision badge text shown beside the brand name. Empty string hides the badge.")
-});
-/**
-* Resolve a raw config object into a complete {@link BrandTextConfig}.
-*
-* Unknown keys are dropped; missing or wrong-typed keys fall back to
-* the defaults. This runs on every gateway read so the client always
-* sees a well-formed value.
-* @param config - raw config (entry source or settings layer).
-* @returns the resolved config with defaults applied.
-*/
-function resolveConfig(config = {}) {
-	return {
-		name: typeof config.name === "string" ? config.name : DEFAULT.name,
-		revision: typeof config.revision === "string" ? config.revision : DEFAULT.revision
-	};
-}
-/** Defaults used when no config arrives (defensive only). */
-const DEFAULT = {
-	name: "DSH Local Build",
-	revision: ""
-};
-
-//#endregion
-//#region src/settings.ts
-/** Settings namespace under which brand-text config persists. */
-const SETTINGS_NAMESPACE = "sidebar-brand-text";
-/**
-* Mirror of the dsh-settings internal `isUnloading` guard. The cordis const
-* enum for fiber state is erased at compile time, so the literal states are
-* matched numerically: 4 = DISPOSED, 5 = UNLOADING.
-*/
-function isUnloading(ctx) {
-	const state = ctx.fiber?.state;
-	return state === 4 || state === 5;
-}
-/**
-* 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.
-*/
-function installBrandTextSettings(ctx, entry) {
-	const listeners = /* @__PURE__ */ new Set();
-	let source = () => entry;
-	const notify = () => {
-		for (const listener of [...listeners]) listener();
-	};
-	ctx.inject(["settings"], (sctx) => {
-		let scope;
-		try {
-			scope = sctx.settings.register(SETTINGS_NAMESPACE, Config, { base: entry });
-		} catch (error) {
-			if (!(error instanceof Error) || !error.message.includes("already registered")) throw error;
-			ctx.logger("sidebar-brand-text")?.debug("settings namespace already registered — entry-source fallback");
-			return;
-		}
-		source = () => scope.get();
-		sctx.effect(() => () => {
-			if (isUnloading(ctx)) return;
-			source = () => entry;
-			notify();
-		});
-		notify();
-		scope.watch(() => {
-			if (isUnloading(ctx)) return;
-			notify();
-		});
-	});
-	return {
-		source: () => source(),
-		onChange: (cb) => {
-			listeners.add(cb);
-			return () => {
-				listeners.delete(cb);
-			};
-		}
-	};
-}
-
-//#endregion
-//#region src/gateway.ts
-/** HTTP route prefix owning every sidebar-brand-text API request. */
-const API_PREFIX = "/sbbt/api";
-/** Config keys the `set` endpoint accepts (allow-list; unknown keys are dropped). */
-const ALLOWED_KEYS = new Set(["name", "revision"]);
-/**
-* Register the `/sbbt/api` HTTP route on the host's web server.
-*
-* @param ctx - host context carrying `webServer`.
-* @param bridge - the settings bridge the route reads through.
-*/
-function registerBrandTextGateway(ctx, bridge) {
-	let settings;
-	ctx.inject(["settings"], (sctx) => {
-		settings = sctx.settings;
-		return () => {
-			settings = void 0;
-		};
-	});
-	ctx.effect(() => {
-		const webServer = ctx.webServer;
-		if (!webServer || typeof webServer.register !== "function") return () => {};
-		return webServer.register({
-			kind: "prefix",
-			path: API_PREFIX,
-			handler: async (req, res) => {
-				if ((req.method ?? "") !== "POST") {
-					writeJson(res, 405, envelopeError("method-not-allowed", "POST only"));
-					return;
-				}
-				const origin = req.headers.origin;
-				if (typeof origin === "string" && origin) {
-					let originHost;
-					try {
-						originHost = new URL(origin).host;
-					} catch {
-						writeJson(res, 400, envelopeError("invalid-origin", "invalid Origin header"));
-						return;
-					}
-					const reqHost = req.headers.host;
-					if (typeof reqHost === "string" && originHost !== reqHost) {
-						writeJson(res, 403, envelopeError("origin-not-allowed", "same-origin requests only"));
-						return;
-					}
-				}
-				if (!String(req.headers["content-type"] ?? "").toLowerCase().startsWith("application/json")) {
-					writeJson(res, 415, envelopeError("content-type-not-supported", "application/json required"));
-					return;
-				}
-				const pathname = new URL(req.url ?? "/", "http://dsh.internal").pathname;
-				const method = pathname.startsWith(`${API_PREFIX}/`) ? pathname.slice(`${API_PREFIX}/`.length) : void 0;
-				if (method === void 0 || method.includes("/")) {
-					writeJson(res, 404, envelopeError("not-found", "unknown sidebar-brand-text API method"));
-					return;
-				}
-				try {
-					const body = await readJsonBody(req);
-					if (method === "get") writeJson(res, 200, envelopeOk({ config: resolveConfig(bridge.source()) }));
-					else if (method === "set") writeJson(res, 200, envelopeOk(await handleSet(body, settings, bridge)));
-					else writeJson(res, 404, envelopeError("not-found", `unknown sidebar-brand-text API method "${method}"`));
-				} catch (error) {
-					writeJson(res, 500, envelopeError("internal", error instanceof Error ? error.message : String(error)));
-				}
-			}
-		});
-	}, "sidebar-brand-text: /sbbt/api routes");
-}
-/** Handle the `set` method: validate patch, write user layer, return resolved config. */
-async function handleSet(body, settings, bridge) {
-	const patch = extractPatch(body);
-	if (Object.keys(patch).length === 0) return { config: resolveConfig(bridge.source()) };
-	if (settings === void 0) throw new Error("sidebar-brand-text: settings service is unavailable — configuration cannot be written");
-	await settings.update(SETTINGS_NAMESPACE, patch);
-	return { config: resolveConfig(bridge.source()) };
-}
-/** Extract and validate the patch from the request body. */
-function extractPatch(body) {
-	if (typeof body !== "object" || body === null) return {};
-	const raw = Reflect.get(body, "patch");
-	if (typeof raw !== "object" || raw === null) return {};
-	const normalized = {};
-	for (const [key, value] of Object.entries(raw)) {
-		if (!ALLOWED_KEYS.has(key)) continue;
-		if (value === null || value === void 0) continue;
-		if (typeof value === "string") {
-			if (key === "name") normalized.name = value;
-			else if (key === "revision") normalized.revision = value;
-		}
-	}
-	return normalized;
-}
-/** Read and parse a JSON body from a node:http request. */
-async function readJsonBody(req, maxBytes = 8192) {
-	const chunks = [];
-	let bytes = 0;
-	for await (const chunk of req) {
-		const buffer = Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk);
-		bytes += buffer.length;
-		if (bytes > maxBytes) throw new Error("request body too large");
-		chunks.push(buffer);
-	}
-	const text = Buffer.concat(chunks).toString("utf8");
-	if (text === "") return {};
-	return JSON.parse(text);
-}
-/** Write a JSON response envelope. */
-function writeJson(res, status, body) {
-	const json = JSON.stringify(body);
-	res.writeHead(status, { "content-type": "application/json" });
-	res.end(json);
-}
-/** Build a success envelope. */
-function envelopeOk(value) {
-	return {
-		ok: true,
-		value
-	};
-}
-/** Build an error envelope. */
-function envelopeError(code, message) {
-	return {
-		ok: false,
-		error: {
-			code,
-			message
-		}
-	};
-}
-
-//#endregion
-//#region src/index.ts
-const name = "sidebar-brand-text";
-/** `webServer` is required for the HTTP gateway that backs the settings card. */
-const inject = ["webServer"];
-/**
-* Plugin body: install the settings bridge and register the HTTP gateway.
-*
-* @param ctx - host context carrying `webServer`.
-* @param config - resolved config (seed values).
-*/
-function apply(ctx, config) {
-	registerBrandTextGateway(ctx, installBrandTextSettings(ctx, resolveConfig(config)));
-}
-
-//#endregion
+import z from "@deepseek-ai/schemastery";
+
+//#region src/config.ts
+/** Schemastery schema for the composition entry (live-editable via `.volatile()`). */
+const Config = z.object({
+	name: z.string().default("DSH Local Build").description("Brand name text shown in the sidebar next to the logo.").volatile(),
+	revision: z.string().default("").description("Revision badge text shown beside the brand name. Empty string hides the badge.").volatile()
+});
+/**
+* Resolve a raw config object into a complete {@link BrandTextConfig}.
+*
+* Unknown keys are dropped; missing or wrong-typed keys fall back to
+* the defaults. This runs on every gateway read so the client always
+* sees a well-formed value.
+* @param config - raw config (entry source or settings layer).
+* @returns the resolved config with defaults applied.
+*/
+function resolveConfig(config = {}) {
+	return {
+		name: typeof config.name === "string" ? config.name : DEFAULT.name,
+		revision: typeof config.revision === "string" ? config.revision : DEFAULT.revision
+	};
+}
+/** Defaults used when no config arrives (defensive only). */
+const DEFAULT = {
+	name: "DSH Local Build",
+	revision: ""
+};
+
+//#endregion
+//#region src/settings.ts
+/** The composition row id: the settings namespace / profile entry id. */
+const SETTINGS_NAMESPACE = "sidebar-brand-text";
+/**
+* Declare the plugin's settings presentation policy and return the bridge.
+*
+* `auto: false` suppresses a schema-generated page: this plugin ships its own
+* form through the `plugins.row.config` slot on the Plugins page.
+*
+* @param ctx - host context.
+* @param config - the entry's volatile Cordis config.
+* @returns the settings bridge.
+*/
+function installBrandTextSettings(ctx, config) {
+	ctx.inject(["settings"], (sctx) => {
+		sctx.effect(() => sctx.settings.configure({ auto: false }, ctx.fiber));
+	});
+	return { source: () => resolveConfig({
+		name: config.name.get(),
+		revision: config.revision.get()
+	}) };
+}
+
+//#endregion
+//#region src/gateway.ts
+/** HTTP route prefix owning every sidebar-brand-text API request. */
+const API_PREFIX = "/sbbt/api";
+/** Config keys the `set` endpoint accepts (allow-list; unknown keys are dropped). */
+const ALLOWED_KEYS = new Set(["name", "revision"]);
+/**
+* Register the `/sbbt/api` HTTP route on the host's web server.
+*
+* @param ctx - host context carrying `webServer`.
+* @param bridge - the settings bridge the route reads through.
+*/
+function registerBrandTextGateway(ctx, bridge) {
+	let settings;
+	ctx.inject(["settings"], (sctx) => {
+		settings = sctx.settings;
+		return () => {
+			settings = void 0;
+		};
+	});
+	ctx.effect(() => {
+		const webServer = ctx.webServer;
+		if (!webServer || typeof webServer.register !== "function") return () => {};
+		return webServer.register({
+			kind: "prefix",
+			path: API_PREFIX,
+			handler: async (req, res) => {
+				if ((req.method ?? "") !== "POST") {
+					writeJson(res, 405, envelopeError("method-not-allowed", "POST only"));
+					return;
+				}
+				const origin = req.headers.origin;
+				if (typeof origin === "string" && origin) {
+					let originHost;
+					try {
+						originHost = new URL(origin).host;
+					} catch {
+						writeJson(res, 400, envelopeError("invalid-origin", "invalid Origin header"));
+						return;
+					}
+					const reqHost = req.headers.host;
+					if (typeof reqHost === "string" && originHost !== reqHost) {
+						writeJson(res, 403, envelopeError("origin-not-allowed", "same-origin requests only"));
+						return;
+					}
+				}
+				if (!String(req.headers["content-type"] ?? "").toLowerCase().startsWith("application/json")) {
+					writeJson(res, 415, envelopeError("content-type-not-supported", "application/json required"));
+					return;
+				}
+				const pathname = new URL(req.url ?? "/", "http://dsh.internal").pathname;
+				const method = pathname.startsWith(`${API_PREFIX}/`) ? pathname.slice(`${API_PREFIX}/`.length) : void 0;
+				if (method === void 0 || method.includes("/")) {
+					writeJson(res, 404, envelopeError("not-found", "unknown sidebar-brand-text API method"));
+					return;
+				}
+				try {
+					const body = await readJsonBody(req);
+					if (method === "get") writeJson(res, 200, envelopeOk({ config: resolveConfig(bridge.source()) }));
+					else if (method === "set") writeJson(res, 200, envelopeOk(await handleSet(body, settings, bridge)));
+					else writeJson(res, 404, envelopeError("not-found", `unknown sidebar-brand-text API method "${method}"`));
+				} catch (error) {
+					writeJson(res, 500, envelopeError("internal", error instanceof Error ? error.message : String(error)));
+				}
+			}
+		});
+	}, "sidebar-brand-text: /sbbt/api routes");
+}
+/** Handle the `set` method: validate patch, write user layer, return resolved config. */
+async function handleSet(body, settings, bridge) {
+	const patch = extractPatch(body);
+	if (Object.keys(patch).length === 0) return { config: resolveConfig(bridge.source()) };
+	if (settings === void 0) throw new Error("sidebar-brand-text: settings service is unavailable — configuration cannot be written");
+	await settings.update(SETTINGS_NAMESPACE, patch);
+	return { config: resolveConfig(bridge.source()) };
+}
+/** Extract and validate the patch from the request body. */
+function extractPatch(body) {
+	if (typeof body !== "object" || body === null) return {};
+	const raw = Reflect.get(body, "patch");
+	if (typeof raw !== "object" || raw === null) return {};
+	const normalized = {};
+	for (const [key, value] of Object.entries(raw)) {
+		if (!ALLOWED_KEYS.has(key)) continue;
+		if (value === null || value === void 0) continue;
+		if (typeof value === "string") {
+			if (key === "name") normalized.name = value;
+			else if (key === "revision") normalized.revision = value;
+		}
+	}
+	return normalized;
+}
+/** Read and parse a JSON body from a node:http request. */
+async function readJsonBody(req, maxBytes = 8192) {
+	const chunks = [];
+	let bytes = 0;
+	for await (const chunk of req) {
+		const buffer = Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk);
+		bytes += buffer.length;
+		if (bytes > maxBytes) throw new Error("request body too large");
+		chunks.push(buffer);
+	}
+	const text = Buffer.concat(chunks).toString("utf8");
+	if (text === "") return {};
+	return JSON.parse(text);
+}
+/** Write a JSON response envelope. */
+function writeJson(res, status, body) {
+	const json = JSON.stringify(body);
+	res.writeHead(status, { "content-type": "application/json" });
+	res.end(json);
+}
+/** Build a success envelope. */
+function envelopeOk(value) {
+	return {
+		ok: true,
+		value
+	};
+}
+/** Build an error envelope. */
+function envelopeError(code, message) {
+	return {
+		ok: false,
+		error: {
+			code,
+			message
+		}
+	};
+}
+
+//#endregion
+//#region src/index.ts
+const name = "sidebar-brand-text";
+/** `webServer` is required for the HTTP gateway that backs the settings card. */
+const inject = ["webServer"];
+/**
+* Plugin body: install the settings bridge and register the HTTP gateway.
+*
+* @param ctx - host context carrying `webServer`.
+* @param config - the entry's volatile Cordis config.
+*/
+function apply(ctx, config) {
+	registerBrandTextGateway(ctx, installBrandTextSettings(ctx, config));
+}
+
+//#endregion
 export { Config, apply, inject, name };

package/lib/types/client/BrandTextCard.d.ts

@@ -1,4 +1,4 @@
-import type { PropsLocale } from '@deepseek-ai/dsh-client-ui-slots';
+import type { PropsLocale, PropsRuntime } from '@deepseek-ai/dsh-client-ui-slots';
 import type { SnapshotSelectorHook } from '@deepseek-ai/dsh-client-ui-slots';
 import type { BrandTextState } from './controller.ts';
 /** Inject face: controller + selector hook. */
@@ -12,11 +12,11 @@ export interface BrandTextCardInjected {
     };
     readonly useSnapshot: SnapshotSelectorHook<BrandTextState>;
 }
-/** Full props: locale seat + inject. */
-export type BrandTextCardProps = PropsLocale<'dsh-plugin-sidebar-brand-text'> & BrandTextCardInjected;
+/** Full props: the `plugins.row.config` owner share (view + form), locale seat, and inject. */
+export type BrandTextCardProps = PropsRuntime<'plugins.row.config'> & PropsLocale<'dsh-plugin-sidebar-brand-text'> & BrandTextCardInjected;
 /**
  * Render the sidebar-brand-text settings card.
  * @param props - locale + controller/useSnapshot inject.
  * @returns a `<li>` card element.
  */
-export declare function BrandTextCard({ t, controller, useSnapshot }: BrandTextCardProps): import("react").JSX.Element;
+export declare function BrandTextCard({ view, t, controller, useSnapshot }: BrandTextCardProps): string | import("react").JSX.Element;

package/lib/types/client/controller.d.ts

@@ -1,66 +1,66 @@
-/**
- * `BrandTextSettingsController` — client-side state store for the
- * sidebar-brand-text config.
- *
- * Loads the config from the host's `/sbbt/api/get` route, stages edits,
- * and saves via `/sbbt/api/set`. The `sidebar.brand.name` slot occupant
- * and the `settings.plugin.item` card both read from the same store via
- * `bindSnapshotSelector`, so a save is instantly reflected in the sidebar
- * without a DOM event or page reload.
- *
- * Mirrors the ego-browser `EgoBrowserSettingsController` pattern.
- *
- * @module @huanlin/dsh-plugin-sidebar-brand-text/client/controller
- */
-import { type SnapshotStore } from '@deepseek-ai/dsh-client-store';
-import { type BrandTextConfig } from '../types.ts';
-/** The controller's snapshot state. */
-export interface BrandTextState {
-    /** 'idle' | 'loading' | 'ready' */
-    status: 'idle' | 'loading' | 'ready';
-    /** True after a successful `/sbbt/api/get`; false when the route is unreachable. */
-    available: boolean;
-    /** False when the settings service is absent (read-only). */
-    writable: boolean;
-    /** Current draft values (edited by the card, read by the brand slot). */
-    draft: BrandTextConfig;
-    /** True when the draft differs from the last-saved config. */
-    dirty: boolean;
-    /** Apply lifecycle: 'idle' | 'saving' | 'saved' | 'error'. */
-    applyState: {
-        kind: 'idle';
-    } | {
-        kind: 'saving';
-    } | {
-        kind: 'saved';
-    } | {
-        kind: 'error';
-        message: string;
-    };
-    /** Card expand state (toggled by the card header button). */
-    _open: boolean;
-}
-/**
- * Controller managing the brand-text config lifecycle.
- *
- * Constructed once in the client `apply()` and shared between the
- * `sidebar.brand.name` slot and the `settings.plugin.item` card.
- */
-export declare class BrandTextSettingsController {
-    readonly store: SnapshotStore<BrandTextState>;
-    loaded: boolean;
-    private generation;
-    constructor();
-    /** Fetch the config from `/sbbt/api/get` and update the store. */
-    load(): Promise<void>;
-    /** Stage an edit to a field (does not save). */
-    edit(field: 'name' | 'revision', value: string): void;
-    /** Discard staged edits and reload from the host. */
-    discard(): void;
-    /** Save the staged draft via `/sbbt/api/set`. */
-    save(): Promise<void>;
-    /** Toggle the card's expand state (mirrors ego-browser `controller.toggle()`). */
-    toggle(): void;
-    /** Mark the store as unavailable (route unreachable or settings service absent). */
-    private markUnavailable;
-}
+/**
+ * `BrandTextSettingsController` — client-side state store for the
+ * sidebar-brand-text config.
+ *
+ * Loads the config from the host's `/sbbt/api/get` route, stages edits,
+ * and saves via `/sbbt/api/set`. The `sidebar.brand.name` slot occupant
+ * and the `plugins.row.config` card both read from the same store via
+ * `bindSnapshotSelector`, so a save is instantly reflected in the sidebar
+ * without a DOM event or page reload.
+ *
+ * Mirrors the ego-browser `EgoBrowserSettingsController` pattern.
+ *
+ * @module @huanlin/dsh-plugin-sidebar-brand-text/client/controller
+ */
+import { type SnapshotStore } from '@deepseek-ai/dsh-client-store';
+import { type BrandTextConfig } from '../types.ts';
+/** The controller's snapshot state. */
+export interface BrandTextState {
+    /** 'idle' | 'loading' | 'ready' */
+    status: 'idle' | 'loading' | 'ready';
+    /** True after a successful `/sbbt/api/get`; false when the route is unreachable. */
+    available: boolean;
+    /** False when the settings service is absent (read-only). */
+    writable: boolean;
+    /** Current draft values (edited by the card, read by the brand slot). */
+    draft: BrandTextConfig;
+    /** True when the draft differs from the last-saved config. */
+    dirty: boolean;
+    /** Apply lifecycle: 'idle' | 'saving' | 'saved' | 'error'. */
+    applyState: {
+        kind: 'idle';
+    } | {
+        kind: 'saving';
+    } | {
+        kind: 'saved';
+    } | {
+        kind: 'error';
+        message: string;
+    };
+    /** Card expand state (toggled by the card header button). */
+    _open: boolean;
+}
+/**
+ * Controller managing the brand-text config lifecycle.
+ *
+ * Constructed once in the client `apply()` and shared between the
+ * `sidebar.brand.name` slot and the `plugins.row.config` card.
+ */
+export declare class BrandTextSettingsController {
+    readonly store: SnapshotStore<BrandTextState>;
+    loaded: boolean;
+    private generation;
+    constructor();
+    /** Fetch the config from `/sbbt/api/get` and update the store. */
+    load(): Promise<void>;
+    /** Stage an edit to a field (does not save). */
+    edit(field: 'name' | 'revision', value: string): void;
+    /** Discard staged edits and reload from the host. */
+    discard(): void;
+    /** Save the staged draft via `/sbbt/api/set`. */
+    save(): Promise<void>;
+    /** Toggle the card's expand state (mirrors ego-browser `controller.toggle()`). */
+    toggle(): void;
+    /** Mark the store as unavailable (route unreachable or settings service absent). */
+    private markUnavailable;
+}