@cowwo/dsh-icon-custom 0.7.1 → 0.8.1

package/lib/index.js

@@ -27,6 +27,15 @@ import { mkdir, rename, writeFile } from 'node:fs/promises'
 import { createRequire } from 'node:module'
 import { homedir } from 'node:os'
 import { join, resolve } from 'node:path'
+import {
+	LAST_TURN_END_KEY,
+	applyLastTurnEnd,
+	initLastTurnEnd,
+	lastTurnEndStateSchema,
+	lastTurnEndView,
+	lastTurnEndViewSchema,
+	normalizeUnreadConfig
+} from './unread.js'
 
 const MAX_BYTES = 10 * 1024 * 1024 // 10 MB
 // Normalized mime -> safe extension. CUR (mouse cursor) is accepted as ICO.
@@ -306,13 +315,33 @@ export class FaviconCustomService extends TypertRemoteService {
 		this.storageDir = join(resolveHome(), 'custom-favicon')
 		this.libraryDir = join(this.storageDir, 'library')
 		this.indexPath = join(this.storageDir, 'library.json')
+		this.unreadPath = join(this.storageDir, 'unread.json')
 		// { activeId, icons: { [id]: { id, mime, ext, name, size, savedAt, rev, pwa, logo } } }
 		this.library = { activeId: null, icons: {} }
 		// The active icon's loaded state: { rev, mime, ext, name, size, savedAt, pwa, logo, bytes } | null
 		this.current = null
+		// Unread-badge rule: { reasons: { [reason]: boolean }, pending: boolean }.
+		// Kept in its own file so a settings change can never corrupt the icon
+		// library index.
+		this.unread = normalizeUnreadConfig(null)
 		// Platform PWA manifest (raw + parsed), read once at startup.
 		this.baseManifest = loadBaseManifest()
 		this._load()
+		this._loadUnread()
+		// "How did this session's last turn end" as an official session
+		// projection. Optional registration on purpose: this plugin is a display
+		// plugin first, so a deployment without the projection service loses the
+		// badge's number, never the favicon.
+		ctx.inject(['sessionProjections'], (projectionCtx) => {
+			projectionCtx.sessionProjections.register({
+				key: LAST_TURN_END_KEY,
+				stateSchema: lastTurnEndStateSchema,
+				stateVersion: 1,
+				init: () => initLastTurnEnd(),
+				apply: applyLastTurnEnd,
+				wire: { viewSchema: lastTurnEndViewSchema, view: lastTurnEndView }
+			})
+		})
 		ctx.effect(() => ctx.webServer.register({
 			kind: 'exact',
 			path: '/icon-custom.svg',
@@ -383,6 +412,19 @@ export class FaviconCustomService extends TypertRemoteService {
 		return writeFile(this.indexPath, JSON.stringify(this.library, null, 2))
 	}
 
+	/** Load the unread-badge rule (missing or corrupt file = defaults). */
+	_loadUnread() {
+		try {
+			const raw = JSON.parse(readFileSync(this.unreadPath).toString('utf8'))
+			this.unread = normalizeUnreadConfig(raw)
+		} catch { /* no persisted rule yet: keep defaults */ }
+	}
+
+	/** Persist the unread-badge rule (best effort, advisory file). */
+	_saveUnread() {
+		return writeFile(this.unreadPath, JSON.stringify(this.unread, null, 2))
+	}
+
 	/** Currently active icon as a JSON-safe status object (no raw bytes). */
 	status() {
 		const c = this.current
@@ -396,6 +438,35 @@ export class FaviconCustomService extends TypertRemoteService {
 		return this.status()
 	}
 
+	/**
+	 * typert endpoint: read the unread-badge rule.
+	 *
+	 * Deliberately its own endpoint instead of a field on `status()`: the five
+	 * icon RPCs (`getStatus` / `setIcon` / `setPwa` / `setLogo` / `resetIcon`)
+	 * keep their EXACT pre-badge response shape, so a problem in this feature
+	 * can never break the icon itself.
+	 * @returns `{ reasons, pending }`.
+	 */
+	async getUnreadRule() {
+		return { reasons: this.unread.reasons, pending: this.unread.pending, workspaceDot: this.unread.workspaceDot }
+	}
+
+	/**
+	 * typert endpoint: replace the unread-badge rule — which turn-end reasons
+	 * light the badge. The rule is applied on the client, so this takes effect
+	 * without re-folding any session log.
+	 * @param request - `{ reasons, pending? }`; unknown or missing keys fall back to defaults.
+	 * @returns the stored rule.
+	 */
+	async setUnreadRule(request) {
+		if (request === null || typeof request !== 'object') {
+			throw new Error('缺少 reasons 参数')
+		}
+		this.unread = normalizeUnreadConfig(request)
+		await this._saveUnread().catch(() => {}) // rule file is advisory
+		return { reasons: this.unread.reasons, pending: this.unread.pending, workspaceDot: this.unread.workspaceDot }
+	}
+
 	/** typert endpoint: store a new icon uploaded as a data URL and make it active. */
 	async setIcon(request) {
 		if (request === null || typeof request !== 'object') throw new Error('缺少图标参数')

package/lib/typert.host.js

@@ -1,4 +1,13 @@
 /* Hand-written typert host manifest for dsh-icon-custom (strict face).
+ *
+ * DSH 0.2.x contract: every strict codec carries a `create()` FACTORY returning
+ * its zod schema — the gateway calls `codec.create().parse(value)` and the
+ * registry caches the result. The 0.1.x bare `schema:` field is gone; keeping
+ * it makes `validateTypertManifest` throw `has no create() factory`, so the
+ * host endpoints below never register and the settings page silently stops
+ * working (0.8.0 shipped this way — see the 0.8.1 fix). Do not reintroduce
+ * `schema:` here: run the compatibility check before publishing.
+ *
  * The request/response shapes are unchanged from 0.6.x. From 0.7.0 the host
  * additionally derives a canonical PNG set (see lib/index.js); `status.mime` /
  * `status.ext` still reflect the *uploaded* format, while the PWA/logo path
@@ -34,6 +43,24 @@ const setLogoRequestSchema = z.object({
 	enabled: z.boolean()
 })
 
+/**
+ * Unread-badge rule: which `turn/end` reasons light the badge, plus whether
+ * "someone is waiting for you" counts. Its own endpoint pair on purpose — the
+ * icon RPCs above keep their exact pre-badge response shape.
+ */
+const unreadRuleSchema = z.object({
+	reasons: z.record(z.string(), z.boolean()),
+	pending: z.boolean(),
+	/** 实验项:工作区图标上的红点(贴产品 DOM,可一键关闭)。 */
+	workspaceDot: z.boolean()
+})
+
+const setUnreadRuleRequestSchema = z.object({
+	reasons: z.record(z.string(), z.boolean()),
+	pending: z.boolean().optional(),
+	workspaceDot: z.boolean().optional()
+})
+
 const setIconResultSchema = statusSchema
 
 export const TYPERT = {
@@ -51,7 +78,7 @@ export const TYPERT = {
 			result: {
 				mode: 'strict',
 				typeSymbol: 'dsh-icon-custom#iconCustom/getStatus:result',
-				schema: statusSchema
+				create: () => statusSchema
 			},
 			sourceLocation: { file: 'lib/index.js', line: 1, column: 1 }
 		},
@@ -69,14 +96,14 @@ export const TYPERT = {
 					codec: {
 						mode: 'strict',
 						typeSymbol: 'dsh-icon-custom#iconCustom/setIcon:request',
-						schema: setIconRequestSchema
+						create: () => setIconRequestSchema
 					}
 				}
 			],
 			result: {
 				mode: 'strict',
 				typeSymbol: 'dsh-icon-custom#iconCustom/setIcon:result',
-				schema: setIconResultSchema
+				create: () => setIconResultSchema
 			},
 			sourceLocation: { file: 'lib/index.js', line: 1, column: 1 }
 		},
@@ -94,14 +121,14 @@ export const TYPERT = {
 					codec: {
 						mode: 'strict',
 						typeSymbol: 'dsh-icon-custom#iconCustom/setPwa:request',
-						schema: setPwaRequestSchema
+						create: () => setPwaRequestSchema
 					}
 				}
 			],
 			result: {
 				mode: 'strict',
 				typeSymbol: 'dsh-icon-custom#iconCustom/setPwa:result',
-				schema: statusSchema
+				create: () => statusSchema
 			},
 			sourceLocation: { file: 'lib/index.js', line: 1, column: 1 }
 		},
@@ -119,14 +146,14 @@ export const TYPERT = {
 					codec: {
 						mode: 'strict',
 						typeSymbol: 'dsh-icon-custom#iconCustom/setLogo:request',
-						schema: setLogoRequestSchema
+						create: () => setLogoRequestSchema
 					}
 				}
 			],
 			result: {
 				mode: 'strict',
 				typeSymbol: 'dsh-icon-custom#iconCustom/setLogo:result',
-				schema: statusSchema
+				create: () => statusSchema
 			},
 			sourceLocation: { file: 'lib/index.js', line: 1, column: 1 }
 		},
@@ -140,7 +167,46 @@ export const TYPERT = {
 			result: {
 				mode: 'strict',
 				typeSymbol: 'dsh-icon-custom#iconCustom/resetIcon:result',
-				schema: statusSchema
+				create: () => statusSchema
+			},
+			sourceLocation: { file: 'lib/index.js', line: 1, column: 1 }
+		},
+		{
+			id: 'dsh-icon-custom#iconCustom/getUnreadRule',
+			service: 'iconCustom',
+			namespace: 'iconCustom',
+			method: 'getUnreadRule',
+			invocation: { kind: 'direct' },
+			parameters: [],
+			result: {
+				mode: 'strict',
+				typeSymbol: 'dsh-icon-custom#iconCustom/getUnreadRule:result',
+				create: () => unreadRuleSchema
+			},
+			sourceLocation: { file: 'lib/index.js', line: 1, column: 1 }
+		},
+		{
+			id: 'dsh-icon-custom#iconCustom/setUnreadRule',
+			service: 'iconCustom',
+			namespace: 'iconCustom',
+			method: 'setUnreadRule',
+			invocation: { kind: 'direct' },
+			parameters: [
+				{
+					name: 'request',
+					wire: 'request',
+					source: 'json',
+					codec: {
+						mode: 'strict',
+						typeSymbol: 'dsh-icon-custom#iconCustom/setUnreadRule:request',
+						create: () => setUnreadRuleRequestSchema
+					}
+				}
+			],
+			result: {
+				mode: 'strict',
+				typeSymbol: 'dsh-icon-custom#iconCustom/setUnreadRule:result',
+				create: () => unreadRuleSchema
 			},
 			sourceLocation: { file: 'lib/index.js', line: 1, column: 1 }
 		}
@@ -199,6 +265,24 @@ export const TYPERT = {
 						summary: "Clear the custom favicon.",
 						jsDoc: "/** Clear the custom favicon. */",
 						tags: []
+					},
+					{
+						kind: 'method',
+						name: 'getUnreadRule',
+						signature: 'async getUnreadRule(): Promise<{ reasons: Record<string, boolean>; pending: boolean; workspaceDot: boolean }>',
+						description: "Read the unread-badge rule.",
+						summary: "Read the unread-badge rule.",
+						jsDoc: "/** Read the unread-badge rule. */",
+						tags: []
+					},
+					{
+						kind: 'method',
+						name: 'setUnreadRule',
+						signature: 'async setUnreadRule(request: { reasons: Record<string, boolean>; pending?: boolean; workspaceDot?: boolean }): Promise<{ reasons: Record<string, boolean>; pending: boolean; workspaceDot: boolean }>',
+						description: "Replace the unread-badge rule: which turn-end reasons light the red dot.",
+						summary: "Set the unread-badge rule.",
+						jsDoc: "/** Set the unread-badge rule. */",
+						tags: []
 					}
 				],
 				types: []

package/lib/unread.js

@@ -0,0 +1,131 @@
+/**
+ * dsh-icon-custom · "未读"规则(宿主半,纯函数)
+ *
+ * 只干一件事:把会话日志里的 `turn/end` 折叠成一条**事实**——
+ * 「这个会话最后一次是怎么结束的、什么时候结束的」。
+ *
+ * 它**不判断**「这种结束值不值得亮红点」。那是用户设置,由客户端套用。
+ * 这样勾掉一个原因会立刻生效,不需要回头重折任何日志。
+ *
+ * 这个文件不碰 cordis、不碰文件系统、不认任何其他插件:
+ * 纯 reducer + 一套原因词汇表。以后想把它搬进独立的包,原样搬走即可。
+ */
+import { z } from 'zod'
+
+/**
+ * 红点可以为哪些结束原因亮起来。
+ * `aborted`(被取消)按取消来源拆成两条——你亲手按的停止不该提醒你。
+ */
+export const UNREAD_REASONS = [
+	'completed',
+	'error',
+	'blocked',
+	'max-tokens',
+	'interrupted',
+	'aborted:user',
+	'aborted:other'
+]
+
+/** 默认:除了"你自己按的停止",其余都算。 */
+export const UNREAD_REASON_DEFAULTS = {
+	completed: true,
+	error: true,
+	blocked: true,
+	'max-tokens': true,
+	interrupted: true,
+	'aborted:user': false,
+	'aborted:other': true
+}
+
+/** 投影 key:客户端从 `entry.projectionValues[LAST_TURN_END_KEY]` 读它。 */
+export const LAST_TURN_END_KEY = 'lastTurnEnd'
+
+/** 默认:门铃("有人在等你")也算一条。 */
+export const UNREAD_PENDING_DEFAULT = true
+
+/**
+ * 默认:在工作区那一行的文件夹图标上画红点。
+ *
+ * 这是全套功能里**唯一贴着产品 DOM 走**的部分(侧栏那片没有插槽),
+ * 所以它有自己的开关:一旦 DSH 升级改了结构导致它失效或画歪,
+ * 关掉它就行,红点数字/清单/跳转那些稳的部分完全不受影响。
+ */
+export const UNREAD_WORKSPACE_DOT_DEFAULT = true
+
+/** 把任意输入夹成一张完整、只有布尔值的开关表(缺项取默认)。 */
+export function normalizeReasons(input) {
+	const out = {}
+	for (const key of UNREAD_REASONS) {
+		const value = input !== null && typeof input === 'object' ? input[key] : undefined
+		out[key] = typeof value === 'boolean' ? value : UNREAD_REASON_DEFAULTS[key]
+	}
+	return out
+}
+
+/**
+ * 把任意输入夹成完整设置。
+ * @param input - `{ reasons?, pending? }`,可以是脏的、缺项的、null
+ * @returns `{ reasons, pending }` —— 两张表都完整
+ */
+export function normalizeUnreadConfig(input) {
+	const source = input !== null && typeof input === 'object' ? input : {}
+	return {
+		reasons: normalizeReasons(source.reasons),
+		pending: typeof source.pending === 'boolean' ? source.pending : UNREAD_PENDING_DEFAULT,
+		workspaceDot: typeof source.workspaceDot === 'boolean' ? source.workspaceDot : UNREAD_WORKSPACE_DOT_DEFAULT
+	}
+}
+
+/**
+ * 一个 `turn/end` 的 reason → 稳定的原因 key。
+ * `aborted` 再看一层 `reason.kind`:`user` 是你自己按的,其余是重启/热更/父级取消。
+ * @param reason - `TurnEndReason`
+ * @returns 原因 key(`'aborted:user'` / `'aborted:other'` / 原 kind / `'unknown'`)
+ */
+export function reasonKey(reason) {
+	const kind = reason !== null && typeof reason === 'object' && typeof reason.kind === 'string' ? reason.kind : 'unknown'
+	if (kind !== 'aborted') return kind
+	const cause = reason.reason !== null && typeof reason.reason === 'object' ? reason.reason.kind : undefined
+	return cause === 'user' ? 'aborted:user' : 'aborted:other'
+}
+
+/** 折叠初始态:还没有任何回合结束过。 */
+export function initLastTurnEnd() {
+	return { endAt: 0, reason: null }
+}
+
+/**
+ * 纯转移:只有 `turn/end` 改动它,其余事件原样返回同一个引用
+ * (契约要求 `Object.is` 不变以产生零下游工作)。
+ * @param state - 覆盖此前全部事件的状态
+ * @param event - 下一个已提交的会话事件
+ * @returns 下一个状态(事件与本单元无关时返回同一个引用)
+ */
+export function applyLastTurnEnd(state, event) {
+	if (event === null || typeof event !== 'object' || event.type !== 'turn/end') return state
+	const data = event.data !== null && typeof event.data === 'object' ? event.data : {}
+	const reason = reasonKey(data.reason)
+	const endAt = typeof event.time === 'number' ? event.time : 0
+	if (state.endAt === endAt && state.reason === reason) return state
+	return { endAt, reason }
+}
+
+/** 状态 → 上线载荷。 */
+export function lastTurnEndView(state) {
+	return {
+		endAt: typeof state.endAt === 'number' ? state.endAt : 0,
+		reason: typeof state.reason === 'string' && state.reason !== '' ? state.reason : null
+	}
+}
+
+/** 持久化折叠状态(纯 JSON,供投影缓存检查点)。 */
+export const lastTurnEndStateSchema = z.object({
+	endAt: z.number(),
+	reason: z.string().nullable()
+})
+
+/** 上线载荷。 */
+export const lastTurnEndViewSchema = z.object({
+	endAt: z.number(),
+	reason: z.string().nullable()
+})

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cowwo/dsh-icon-custom",
-  "version": "0.7.1",
+  "version": "0.8.1",
   "description": "自定义浏览器标签页图标:在设置页上传 SVG/PNG/ICO,立即生效并持久保存,自动适配安卓/iOS/平板 PWA 图标。· Custom browser tab favicon: upload SVG/PNG/ICO from the settings page, applies instantly and persists, auto-sizes PWA icons for Android/iOS/tablets.",
   "type": "module",
   "main": "lib/index.js",