@dickpy/dsh-imagegen 1.5.1 → 1.5.2

package/src/routes.ts

@@ -16,10 +16,11 @@ import { normalizeImageModels } from './image-models.ts'
 import { ImageGenerationRuntime, type ChannelsView } from './generation-runtime.ts'
 import { appendHistory, clearHistory, listHistory, readHistoryImage, removeHistory } from './history-store.ts'
 import { appendGallery, clearGallery, listGallery, readGalleryImage, removeGallery, updateGalleryTags } from './gallery-store.ts'
-import { listTemplates, readTemplateImage, refreshTemplates } from './templates-store.ts'
+import { listTemplates, readTemplateImage, refreshTemplates, sampleTemplates } from './templates-store.ts'
+import { addTemplateFavorite, listTemplateFavorites, removeTemplateFavorite } from './template-favorites.ts'
 import { checkForUpdate, CURRENT_VERSION, installUpdate } from './updater.ts'
 import { IMAGE_PRESETS } from './presets.ts'
-import { AGENT_IMAGE_API, CONVERSATION_IMAGE_API, GALLERY_API, GENERATE_API, HISTORY_API, IMAGEGEN_SETTINGS_NAMESPACE, IMAGE_MODEL_API, PRESETS_API, PROMPT_ENHANCE_API, SETTINGS_API, TASK_API, TEMPLATES_API, UPDATE_API, USAGE_API, type GeneratedImage, type GenerateRequest, type HistoryEntry, type HistoryEntryInput, type ModelMapping, type PresetProviderView, type TemplateListResult, type TemplateRefreshResult } from './protocol.ts'
+import { AGENT_IMAGE_API, CONVERSATION_IMAGE_API, DEFAULT_TEMPLATE_SOURCE_ID, GALLERY_API, GENERATE_API, HISTORY_API, IMAGEGEN_SETTINGS_NAMESPACE, IMAGE_MODEL_API, PRESETS_API, PROMPT_ENHANCE_API, SETTINGS_API, TASK_API, TEMPLATE_FAVORITES_API, TEMPLATES_API, UPDATE_API, USAGE_API, isTemplateSourceId, type GeneratedImage, type GenerateRequest, type HistoryEntry, type HistoryEntryInput, type ModelMapping, type PresetProviderView, type TemplateFavorite, type TemplateListResult, type TemplateRefreshResult, type TemplateSample } from './protocol.ts'
 
 /** Cap on JSON request bodies (settings ops and generate payloads are small). */
 const MAX_JSON_BODY_BYTES = 24 * 1024 * 1024
@@ -74,9 +75,16 @@ export interface ImageGenRoutesDeps {
   }
   /** Overrideable template-library backend, primarily for host integration tests. */
   templates?: {
-    list: () => Promise<TemplateListResult>
-    refresh: () => Promise<TemplateRefreshResult>
-    readImage: (file: string) => Promise<{ data: Buffer; mime: string } | undefined>
+    list: (sourceId: string) => Promise<TemplateListResult>
+    refresh: (sourceId: string) => Promise<TemplateRefreshResult>
+    sample: (count: number) => Promise<TemplateSample[]>
+    readImage: (sourceId: string, file: string) => Promise<{ data: Buffer; mime: string } | undefined>
+  }
+  /** Overrideable template-favorites backend, primarily for host integration tests. */
+  favorites?: {
+    list: () => Promise<TemplateFavorite[]>
+    add: (sourceId: string, item: TemplateFavorite['case']) => Promise<TemplateFavorite[]>
+    remove: (key: string) => Promise<TemplateFavorite[]>
   }
   /** Shared host queue, used by Agent tools and browser task endpoints. */
   runtime?: ImageGenerationRuntime
@@ -135,6 +143,13 @@ function messageOf(error: unknown): string {
   return error instanceof Error ? error.message : String(error)
 }
 
+/** Validate the { source } body of a template-library request. */
+function templateSourceOf(body: Record<string, unknown> | undefined): string | undefined {
+  const raw = body?.source
+  if (raw === undefined || raw === '') return DEFAULT_TEMPLATE_SOURCE_ID
+  return typeof raw === 'string' && isTemplateSourceId(raw) ? raw : undefined
+}
+
 function parseGenerateRequest(body: Record<string, unknown>): GenerateRequest | undefined {
   const prompt = typeof body.prompt === 'string' ? body.prompt.trim() : ''
   if (prompt === '') return undefined
@@ -311,8 +326,14 @@ export function makeRoutes(deps: ImageGenRoutesDeps): WebRoute[] {
   const templates = deps.templates ?? {
     list: listTemplates,
     refresh: refreshTemplates,
+    sample: sampleTemplates,
     readImage: readTemplateImage,
   }
+  const favorites = deps.favorites ?? {
+    list: listTemplateFavorites,
+    add: addTemplateFavorite,
+    remove: removeTemplateFavorite,
+  }
   const resolvePrompt = deps.resolvePrompt ?? (() => ({ apiUrl: '', apiKey: '', model: '' }))
   const resolveImageModels = deps.resolveImageModels ?? (() => normalizeImageModels(undefined))
 
@@ -908,8 +929,14 @@ export function makeRoutes(deps: ImageGenRoutesDeps): WebRoute[] {
       path: TEMPLATES_API.list,
       handler: async (req, res) => {
         if (!guard(req, res, 'POST')) return
+        const body = await readJsonBody(req)
+        const sourceId = templateSourceOf(body)
+        if (sourceId === undefined) {
+          writeJson(res, 200, { ok: false, code: 'templates-source-unknown', message: `未知的模板库来源：${String(body?.source ?? '')}` })
+          return
+        }
         try {
-          const result = await templates.list()
+          const result = await templates.list(sourceId)
           writeJson(res, 200, { ok: true, ...result })
         } catch (error) {
           writeJson(res, 200, { ok: false, code: 'templates-failed', message: messageOf(error) })
@@ -922,14 +949,36 @@ export function makeRoutes(deps: ImageGenRoutesDeps): WebRoute[] {
       path: TEMPLATES_API.refresh,
       handler: async (req, res) => {
         if (!guard(req, res, 'POST')) return
+        const body = await readJsonBody(req)
+        const sourceId = templateSourceOf(body)
+        if (sourceId === undefined) {
+          writeJson(res, 200, { ok: false, code: 'templates-source-unknown', message: `未知的模板库来源：${String(body?.source ?? '')}` })
+          return
+        }
         try {
-          const result = await templates.refresh()
+          const result = await templates.refresh(sourceId)
           writeJson(res, 200, { ok: true, ...result })
         } catch (error) {
           writeJson(res, 200, { ok: false, code: 'templates-refresh-failed', message: messageOf(error) })
         }
       },
     },
+    // --------------------------------------------- templates random sample
+    {
+      kind: 'exact',
+      path: TEMPLATES_API.sample,
+      handler: async (req, res) => {
+        if (!guard(req, res, 'POST')) return
+        const body = await readJsonBody(req)
+        const requested = Number(body?.count)
+        const count = Number.isFinite(requested) ? requested : 9
+        try {
+          writeJson(res, 200, { ok: true, samples: await templates.sample(count) })
+        } catch (error) {
+          writeJson(res, 200, { ok: false, code: 'templates-sample-failed', message: messageOf(error) })
+        }
+      },
+    },
     // -------------------------------------- templates image (prefix, proxied)
     {
       kind: 'prefix',
@@ -943,12 +992,17 @@ export function makeRoutes(deps: ImageGenRoutesDeps): WebRoute[] {
           writeJson(res, 405, { error: `method not allowed: ${req.method}` })
           return
         }
-        const file = imageFileFrom(req.url, TEMPLATES_API.image)
-        if (file === undefined) {
+        // Source-scoped: /image/<sourceId>/<file> (file names collide across
+        // sources, so the pool on disk is per source).
+        const raw = imageFileFrom(req.url, TEMPLATES_API.image)
+        const slash = raw?.indexOf('/') ?? -1
+        const sourceId = slash > 0 ? raw!.slice(0, slash) : ''
+        const file = slash > 0 ? raw!.slice(slash + 1) : ''
+        if (sourceId === '' || !isTemplateSourceId(sourceId) || file === '') {
           writeJson(res, 404, { error: 'not found' })
           return
         }
-        const found = await templates.readImage(file)
+        const found = await templates.readImage(sourceId, file)
         if (found === undefined) {
           writeJson(res, 404, { error: 'not found' })
           return
@@ -962,5 +1016,65 @@ export function makeRoutes(deps: ImageGenRoutesDeps): WebRoute[] {
         res.end(found.data)
       },
     },
+    // ------------------------------------------ template favorites: list
+    {
+      kind: 'exact',
+      path: TEMPLATE_FAVORITES_API.list,
+      handler: async (req, res) => {
+        if (!guard(req, res, 'POST')) return
+        try {
+          writeJson(res, 200, { ok: true, favorites: await favorites.list() })
+        } catch (error) {
+          writeJson(res, 200, { ok: false, code: 'template-favorites-failed', message: messageOf(error) })
+        }
+      },
+    },
+    // ------------------------------------------- template favorites: add
+    {
+      kind: 'exact',
+      path: TEMPLATE_FAVORITES_API.add,
+      handler: async (req, res) => {
+        if (!guard(req, res, 'POST')) return
+        const body = await readJsonBody(req)
+        const sourceId = templateSourceOf(body)
+        const rawCase = body?.case
+        if (sourceId === undefined || rawCase === null || typeof rawCase !== 'object') {
+          writeJson(res, 200, { ok: false, code: 'template-favorite-invalid', message: '收藏请求缺少有效的来源或模板数据' })
+          return
+        }
+        const record = rawCase as Record<string, unknown>
+        const id = Number(record.id)
+        const title = typeof record.title === 'string' ? record.title.trim() : ''
+        const prompt = typeof record.prompt === 'string' ? record.prompt.trim() : ''
+        if (!Number.isInteger(id) || title === '' || prompt === '') {
+          writeJson(res, 200, { ok: false, code: 'template-favorite-invalid', message: '收藏请求缺少有效的模板数据' })
+          return
+        }
+        try {
+          writeJson(res, 200, { ok: true, favorites: await favorites.add(sourceId, rawCase as TemplateFavorite['case']) })
+        } catch (error) {
+          writeJson(res, 200, { ok: false, code: 'template-favorites-failed', message: messageOf(error) })
+        }
+      },
+    },
+    // ---------------------------------------- template favorites: remove
+    {
+      kind: 'exact',
+      path: TEMPLATE_FAVORITES_API.remove,
+      handler: async (req, res) => {
+        if (!guard(req, res, 'POST')) return
+        const body = await readJsonBody(req)
+        const key = typeof body?.key === 'string' ? body.key : ''
+        if (key === '') {
+          writeJson(res, 200, { ok: false, code: 'template-favorite-invalid', message: '取消收藏请求缺少模板标识' })
+          return
+        }
+        try {
+          writeJson(res, 200, { ok: true, favorites: await favorites.remove(key) })
+        } catch (error) {
+          writeJson(res, 200, { ok: false, code: 'template-favorites-failed', message: messageOf(error) })
+        }
+      },
+    },
   ]
 }

package/src/template-favorites.ts

@@ -0,0 +1,108 @@
+/**
+ * Favorites store for the prompt-template library.
+ *
+ * The user's starred templates persist host-side as full case snapshots under
+ * ~/.dsh/dsh-imagegen/templates/favorites.json, keyed by
+ * `${sourceId}:${caseId}` — the snapshot means a favorite stays usable even
+ * after the upstream list drops or renumbers the case. Framework-free
+ * (node:fs only) so the route layer and tests can drive it directly.
+ */
+
+import { promises as fs } from 'node:fs'
+import { homedir } from 'node:os'
+import path from 'node:path'
+import { isTemplateSourceId, type TemplateCase, type TemplateFavorite } from './protocol.ts'
+
+const DATA_DIR = path.join(homedir(), '.dsh', 'dsh-imagegen')
+const FAVORITES_PATH = path.join(DATA_DIR, 'templates', 'favorites.json')
+
+/** Refuse to grow the file without bound; the user curates this list. */
+const MAX_FAVORITES = 1000
+
+/** In-memory memo of the persisted list. */
+let memo: TemplateFavorite[] | undefined
+
+/** Build the stable key of one case within a source. */
+export function templateFavoriteKey(sourceId: string, caseId: number): string {
+  return `${sourceId}:${caseId}`
+}
+
+/** Validate + normalize one raw stored favorite; undefined when unusable. */
+function normalizeFavorite(raw: unknown): TemplateFavorite | undefined {
+  if (raw === null || typeof raw !== 'object') return undefined
+  const record = raw as Record<string, unknown>
+  if (typeof record.key !== 'string' || typeof record.savedAt !== 'string') return undefined
+  const sourceId = typeof record.sourceId === 'string' ? record.sourceId : ''
+  if (!isTemplateSourceId(sourceId)) return undefined
+  if (record.key !== templateFavoriteKey(sourceId, Number(record.case && (record.case as TemplateCase).id))) return undefined
+  const rawCase = record.case
+  if (rawCase === null || typeof rawCase !== 'object') return undefined
+  const item = rawCase as Record<string, unknown>
+  const id = Number(item.id)
+  const title = typeof item.title === 'string' ? item.title : ''
+  const prompt = typeof item.prompt === 'string' ? item.prompt : ''
+  if (!Number.isInteger(id) || title === '' || prompt === '') return undefined
+  // Keep only the wire fields so hand-edited files cannot smuggle extras.
+  const snapshot: TemplateCase = {
+    id,
+    title,
+    prompt,
+    category: typeof item.category === 'string' ? item.category : '',
+    categoryZh: typeof item.categoryZh === 'string' ? item.categoryZh : '',
+    styles: Array.isArray(item.styles) ? item.styles.map(String) : [],
+    scenes: Array.isArray(item.scenes) ? item.scenes.map(String) : [],
+    sourceLabel: typeof item.sourceLabel === 'string' ? item.sourceLabel : '',
+    sourceUrl: typeof item.sourceUrl === 'string' ? item.sourceUrl : '',
+    githubUrl: typeof item.githubUrl === 'string' ? item.githubUrl : '',
+    image: typeof item.image === 'string' ? item.image : '',
+    featured: item.featured === true,
+  }
+  return { key: record.key, sourceId, savedAt: record.savedAt, case: snapshot }
+}
+
+/** Read + parse the favorites file (memoized). */
+export async function listTemplateFavorites(): Promise<TemplateFavorite[]> {
+  if (memo !== undefined) return memo
+  try {
+    const parsed: unknown = JSON.parse(await fs.readFile(FAVORITES_PATH, 'utf8'))
+    memo = Array.isArray(parsed)
+      ? parsed.map(normalizeFavorite).filter((entry): entry is TemplateFavorite => entry !== undefined)
+      : []
+  } catch {
+    memo = []
+  }
+  return memo
+}
+
+/** Persist the list atomically and update the memo. */
+async function writeFavorites(entries: TemplateFavorite[]): Promise<void> {
+  memo = entries
+  await fs.mkdir(path.dirname(FAVORITES_PATH), { recursive: true })
+  const tmp = `${FAVORITES_PATH}.tmp-${process.pid}`
+  await fs.writeFile(tmp, JSON.stringify(entries, null, 2), 'utf8')
+  await fs.rename(tmp, FAVORITES_PATH)
+}
+
+/** Star one template. Re-starring refreshes the snapshot and is idempotent. */
+export async function addTemplateFavorite(sourceId: string, item: TemplateCase): Promise<TemplateFavorite[]> {
+  if (!isTemplateSourceId(sourceId)) throw new Error(`未知的模板库来源：${sourceId}`)
+  const key = templateFavoriteKey(sourceId, item.id)
+  const rest = (await listTemplateFavorites()).filter(entry => entry.key !== key)
+  const entry: TemplateFavorite = { key, sourceId, savedAt: new Date().toISOString(), case: item }
+  const next = [entry, ...rest].slice(0, MAX_FAVORITES)
+  await writeFavorites(next)
+  return next
+}
+
+/** Unstar one template by key; unknown keys are a no-op. */
+export async function removeTemplateFavorite(key: string): Promise<TemplateFavorite[]> {
+  const next = (await listTemplateFavorites()).filter(entry => entry.key !== key)
+  if (next.length === memo?.length) return next
+  await writeFavorites(next)
+  return next
+}
+
+/** Drop the in-memory memo (tests). */
+export function clearTemplateFavoritesMemo(): void {
+  memo = undefined
+}