@dickpy/dsh-imagegen 1.0.0 → 1.0.2

package/src/client/panel.module.css

@@ -166,6 +166,56 @@ html[data-dsh-imagegen-active]:not([data-dsh-taskboard-active]):not([data-dsh-ss
   border-color: var(--dsw-alias-state-warn-primary);
 }
 
+.updateBanner {
+  display: flex;
+  align-items: center;
+  justify-content: space-between;
+  gap: 12px;
+  flex: none;
+  padding: 7px 10px 7px 12px;
+  font-size: 12px;
+  line-height: 1.5;
+  border-radius: 10px;
+  border: 1px solid var(--dsw-alias-state-warn-primary);
+  color: var(--dsw-alias-state-warn-primary);
+  overflow-wrap: anywhere;
+}
+
+.updateBanner[data-kind='ok'] {
+  color: var(--dsw-alias-state-success-primary);
+  border-color: var(--dsw-alias-state-success-primary);
+}
+
+.updateText {
+  min-width: 0;
+}
+
+.updateActions {
+  display: inline-flex;
+  align-items: center;
+  gap: 10px;
+  flex: none;
+}
+
+.updateRelease {
+  color: inherit;
+  text-decoration: underline;
+  text-underline-offset: 2px;
+  white-space: nowrap;
+}
+
+@media (max-width: 700px) {
+  .updateBanner {
+    align-items: flex-start;
+    flex-direction: column;
+  }
+
+  .updateActions {
+    width: 100%;
+    justify-content: space-between;
+  }
+}
+
 /* --- studio split: left config sidebar (narrow) + right canvas (wide) --------- */
 
 .studio {

package/src/history-store.ts

@@ -17,6 +17,16 @@ const HISTORY_DIR = path.join(homedir(), '.dsh', 'dsh-imagegen')
 const INDEX_PATH = path.join(HISTORY_DIR, 'index.json')
 const IMAGES_DIR = path.join(HISTORY_DIR, 'images')
 
+// History mutations read and replace one shared index. Serialize them so
+// overlapping requests cannot each read an old index and lose the other's row.
+let pendingMutation: Promise<void> = Promise.resolve()
+
+function mutateHistory<T>(operation: () => Promise<T>): Promise<T> {
+  const next = pendingMutation.then(operation, operation)
+  pendingMutation = next.then(() => undefined, () => undefined)
+  return next
+}
+
 /** One image's on-disk record (file name + mime, never base64). */
 interface StoredImage {
   file: string
@@ -152,55 +162,66 @@ export async function listHistory(): Promise<HistoryEntry[]> {
 
 /** Append one generation, evicting the oldest beyond HISTORY_MAX. */
 export async function appendHistory(input: HistoryEntryInput): Promise<HistoryEntry[]> {
-  await ensureDirs()
-  const prefix = safeId(input.id)
-  const storedImages: StoredImage[] = []
-  for (let index = 0; index < input.images.length; index++) {
-    const image = input.images[index]!
-    const file = `${prefix}-${index}.${extensionOf(image.mime)}`
-    await fs.writeFile(path.join(IMAGES_DIR, file), Buffer.from(image.b64, 'base64'))
-    storedImages.push({
-      file,
-      mime: image.mime,
-      ...image.revisedPrompt === undefined ? {} : { revisedPrompt: image.revisedPrompt },
-    })
-  }
-  const entry: StoredEntry = {
-    id: input.id,
-    createdAt: input.createdAt,
-    mode: input.mode,
-    model: input.model,
-    prompt: input.prompt,
-    size: input.size,
-    quality: input.quality,
-    detail: input.detail,
-    n: input.n,
-    images: storedImages,
-    ...input.refName === undefined ? {} : { refName: input.refName },
-  }
-  const merged = [entry, ...await readIndex()]
-  const kept = merged.slice(0, HISTORY_MAX)
-  for (const dropped of merged.slice(HISTORY_MAX)) await removeEntryFiles(dropped)
-  await writeIndex(kept)
-  return kept.map(toWire)
+  return mutateHistory(async () => {
+    await ensureDirs()
+    const prefix = safeId(input.id)
+    const storedImages: StoredImage[] = []
+    try {
+      for (let index = 0; index < input.images.length; index++) {
+        const image = input.images[index]!
+        const file = `${prefix}-${index}.${extensionOf(image.mime)}`
+        await fs.writeFile(path.join(IMAGES_DIR, file), Buffer.from(image.b64, 'base64'))
+        storedImages.push({
+          file,
+          mime: image.mime,
+          ...image.revisedPrompt === undefined ? {} : { revisedPrompt: image.revisedPrompt },
+        })
+      }
+    } catch (error) {
+      await removeEntryFiles({ images: storedImages } as StoredEntry)
+      throw error
+    }
+    const entry: StoredEntry = {
+      id: input.id,
+      createdAt: input.createdAt,
+      mode: input.mode,
+      model: input.model,
+      prompt: input.prompt,
+      size: input.size,
+      quality: input.quality,
+      detail: input.detail,
+      n: input.n,
+      images: storedImages,
+      ...input.refName === undefined ? {} : { refName: input.refName },
+    }
+    const merged = [entry, ...await readIndex()]
+    const kept = merged.slice(0, HISTORY_MAX)
+    for (const dropped of merged.slice(HISTORY_MAX)) await removeEntryFiles(dropped)
+    await writeIndex(kept)
+    return kept.map(toWire)
+  })
 }
 
 /** Remove one entry (and its image files). */
 export async function removeHistory(id: string): Promise<HistoryEntry[]> {
-  const previous = await readIndex()
-  const target = previous.find(entry => entry.id === id)
-  if (target !== undefined) await removeEntryFiles(target)
-  const kept = previous.filter(entry => entry.id !== id)
-  await writeIndex(kept)
-  return kept.map(toWire)
+  return mutateHistory(async () => {
+    const previous = await readIndex()
+    const target = previous.find(entry => entry.id === id)
+    if (target !== undefined) await removeEntryFiles(target)
+    const kept = previous.filter(entry => entry.id !== id)
+    await writeIndex(kept)
+    return kept.map(toWire)
+  })
 }
 
 /** Remove every entry (and all image files). */
 export async function clearHistory(): Promise<HistoryEntry[]> {
-  const previous = await readIndex()
-  for (const entry of previous) await removeEntryFiles(entry)
-  await writeIndex([])
-  return []
+  return mutateHistory(async () => {
+    const previous = await readIndex()
+    for (const entry of previous) await removeEntryFiles(entry)
+    await writeIndex([])
+    return []
+  })
 }
 
 /** Read one stored image file by its (validated) file name. */

package/src/index.ts

@@ -26,6 +26,7 @@ export const inject = ['webServer', 'systemPrompt']
 // contract only requires name / inject / Config / apply.
 export { makeRoutes } from './routes.ts'
 export { generateImage, ImageGenError } from './engine.ts'
+export { checkForUpdate, clearUpdateCache, compareVersions, CURRENT_VERSION, installUpdate, profileFromProcess } from './updater.ts'
 
 /** The branded settings namespace of this plugin (the card edits it). */
 export const ImageGenSettingsNamespace = settingsNamespace(IMAGEGEN_SETTINGS_NAMESPACE)
@@ -57,7 +58,7 @@ const DEFAULT_ANNOUNCE = true
 const SECTION_ORDER = 150
 
 /** Model-facing announcement: plugin presence, capabilities, and limits. */
-export const IMAGEGEN_GUIDANCE = '本机已安装 dsh-imagegen 插件（DSH AI 生图）：侧边栏「AI 生图」入口；本地插件（源码位于 E:\\dsh-plugin，独立于 dsh-web-ui 插件全家桶）。能力：对接 OpenAI 兼容图像生成 API（模型 gpt-image-2），支持文生图（/images/generations）与图生图（/images/edits，上传参考图）；API 地址与密钥在 GUI「设置 → 插件 → 可配置」中配置，密钥仅存于本机设置文档；生成请求由本地宿主代理转发，结果以 base64 返回面板，可预览与下载。限制：生成消耗上游 API 额度；图片内容由上游模型生成，可能不符合预期或包含不适宜内容；api_key 以明文存储在设置文档中；参考图会发送至所配置的 API 服务。用户提到「生图 / 绘画 / 生成图片 / gpt-image-2 / 文生图 / 图生图」时即指本插件，请据此协作。'
+export const IMAGEGEN_GUIDANCE = '本机已安装 dsh-imagegen 插件（DSH AI 生图）：侧边栏「AI 生图」入口。能力：对接 OpenAI 兼容图像生成 API（模型 gpt-image-2），支持文生图（/images/generations）与图生图（/images/edits，上传参考图）；API 地址与密钥在 GUI「设置 → 插件 → 可配置」中配置，密钥仅存于本机设置文档；生成请求由本地宿主代理转发，结果以 base64 返回面板，可预览与下载。限制：生成消耗上游 API 额度；图片内容由上游模型生成，可能不符合预期或包含不适宜内容；api_key 以明文存储在设置文档中；参考图会发送至所配置的 API 服务。用户提到「生图 / 绘画 / 生成图片 / gpt-image-2 / 文生图 / 图生图」时即指本插件，请据此协作。'
 
 /** Effective config (schema defaults applied). */
 interface EffectiveConfig {

package/src/protocol.ts

@@ -16,6 +16,12 @@ export const SETTINGS_API = {
 /** The image-generation proxy route. */
 export const GENERATE_API = '/api/dsh-imagegen/generate'
 
+/** Host-mediated GitHub Release update routes. */
+export const UPDATE_API = {
+  check: '/api/dsh-imagegen/update/check',
+  apply: '/api/dsh-imagegen/update/apply',
+} as const
+
 /**
  * Same-origin route family for the host-persisted generation history. Images
  * live as files under ~/.dsh/dsh-imagegen/images/ and are served back through
@@ -58,6 +64,8 @@ export interface GenerateRequest {
   detail: string
   /** Reference image as a data URL (edit mode only). */
   image?: string
+  /** Original reference-image name, retained in the history entry. */
+  refName?: string
 }
 
 /** One generated image, normalized host-side to base64 so the browser never
@@ -74,6 +82,19 @@ export interface GeneratedImage {
 /** Successful generate outcome. */
 export interface GenerateResult {
   images: GeneratedImage[]
+  /** Updated host-persisted history, when returned by the generate route. */
+  history?: HistoryEntry[]
+  /** Persistence failure after images were successfully generated. */
+  historyError?: string
+}
+
+/** GitHub Release update information shown by the client. */
+export interface UpdateInfo {
+  currentVersion: string
+  latestVersion: string
+  updateAvailable: boolean
+  releaseUrl: string
+  publishedAt?: string
 }
 
 /** One history image reference as the browser consumes it (a served URL). */

package/src/routes.ts

@@ -6,11 +6,13 @@
  */
 
 import type { IncomingMessage, ServerResponse } from 'node:http'
+import { randomUUID } from 'node:crypto'
 import type { WebRoute } from '@deepseek-ai/dsh-host-webserver'
 import { SettingsConflictError, settingsNamespace, type SettingsDescriptor } from '@deepseek-ai/dsh-settings'
 import { generateImage, type UpstreamConfig } from './engine.ts'
 import { appendHistory, clearHistory, listHistory, readHistoryImage, removeHistory } from './history-store.ts'
-import { GENERATE_API, HISTORY_API, IMAGEGEN_SETTINGS_NAMESPACE, SETTINGS_API, type GeneratedImage, type GenerateRequest, type HistoryEntryInput } from './protocol.ts'
+import { checkForUpdate, CURRENT_VERSION, installUpdate } from './updater.ts'
+import { GENERATE_API, HISTORY_API, IMAGEGEN_SETTINGS_NAMESPACE, SETTINGS_API, UPDATE_API, type GeneratedImage, type GenerateRequest, type HistoryEntry, type HistoryEntryInput } from './protocol.ts'
 
 /** Cap on JSON request bodies (settings ops and generate payloads are small). */
 const MAX_JSON_BODY_BYTES = 24 * 1024 * 1024
@@ -31,6 +33,14 @@ export interface ImageGenRoutesDeps {
   settings: SettingsSeam
   /** Resolve the current upstream config (composition entry + settings). */
   resolve: () => UpstreamConfig
+  /** Overrideable history backend, primarily for host integration tests. */
+  history?: {
+    list: () => Promise<HistoryEntry[]>
+    append: (entry: HistoryEntryInput) => Promise<HistoryEntry[]>
+    remove: (id: string) => Promise<HistoryEntry[]>
+    clear: () => Promise<HistoryEntry[]>
+    readImage: (file: string) => Promise<{ data: Buffer; mime: string } | undefined>
+  }
 }
 
 /** Loopback literal check plus browser same-origin markers (mirrors dsh-ssh). */
@@ -166,6 +176,13 @@ function failureOf(error: unknown): { ok: false; code: string; message: string }
  * @returns the route registrations.
  */
 export function makeRoutes(deps: ImageGenRoutesDeps): WebRoute[] {
+  const history = deps.history ?? {
+    list: listHistory,
+    append: appendHistory,
+    remove: removeHistory,
+    clear: clearHistory,
+    readImage: readHistoryImage,
+  }
   const guard = (req: IncomingMessage, res: ServerResponse, method: string): boolean => {
     if (!isLoopbackRequest(req)) {
       writeJson(res, 403, { error: 'forbidden: loopback-only' })
@@ -257,10 +274,28 @@ export function makeRoutes(deps: ImageGenRoutesDeps): WebRoute[] {
           n: typeof body.n === 'number' ? body.n : 1,
           detail: typeof body.detail === 'string' ? body.detail : '',
           ...typeof body.image === 'string' && body.image !== '' ? { image: body.image } : {},
+          ...typeof body.refName === 'string' && body.refName !== '' ? { refName: body.refName } : {},
         }
         try {
           const result = await generateImage(deps.resolve(), request)
-          writeJson(res, 200, { ok: true, ...result })
+          try {
+            const entries = await history.append({
+              id: randomUUID(),
+              createdAt: Date.now(),
+              mode: request.mode,
+              model: request.model,
+              prompt: request.prompt,
+              size: request.size,
+              quality: request.quality,
+              detail: request.detail,
+              n: request.n,
+              images: result.images,
+              ...request.refName === undefined ? {} : { refName: request.refName },
+            })
+            writeJson(res, 200, { ok: true, ...result, history: entries })
+          } catch (error) {
+            writeJson(res, 200, { ok: true, ...result, historyError: messageOf(error) })
+          }
         } catch (error) {
           const message = error instanceof Error ? error.message : String(error)
           const code = error instanceof Error && 'code' in error && typeof (error as { code?: unknown }).code === 'string'
@@ -270,6 +305,44 @@ export function makeRoutes(deps: ImageGenRoutesDeps): WebRoute[] {
         }
       },
     },
+    // ----------------------------------------------- update check
+    {
+      kind: 'exact',
+      path: UPDATE_API.check,
+      handler: async (req, res) => {
+        if (!guard(req, res, 'POST')) return
+        try {
+          writeJson(res, 200, { ok: true, update: await checkForUpdate() })
+        } catch (error) {
+          writeJson(res, 200, { ok: false, code: 'update-check-failed', message: messageOf(error) })
+        }
+      },
+    },
+    // ----------------------------------------------- update apply
+    {
+      kind: 'exact',
+      path: UPDATE_API.apply,
+      handler: async (req, res) => {
+        if (!guard(req, res, 'POST')) return
+        const body = await readJsonBody(req)
+        const version = body !== undefined && typeof body.version === 'string' ? body.version.trim() : ''
+        if (version === '') {
+          writeJson(res, 200, { ok: false, code: 'bad-request', message: 'update version is required' })
+          return
+        }
+        try {
+          const latest = await checkForUpdate()
+          if (!latest.updateAvailable || latest.latestVersion !== version) {
+            writeJson(res, 200, { ok: false, code: 'update-not-available', message: `version ${version} is not the latest available release` })
+            return
+          }
+          await installUpdate(version)
+          writeJson(res, 200, { ok: true, currentVersion: CURRENT_VERSION, updatedVersion: version, restartRequired: true })
+        } catch (error) {
+          writeJson(res, 200, { ok: false, code: 'update-failed', message: messageOf(error) })
+        }
+      },
+    },
     // ----------------------------------------------------- history list
     {
       kind: 'exact',
@@ -277,7 +350,7 @@ export function makeRoutes(deps: ImageGenRoutesDeps): WebRoute[] {
       handler: async (req, res) => {
         if (!guard(req, res, 'POST')) return
         try {
-          writeJson(res, 200, { ok: true, entries: await listHistory() })
+          writeJson(res, 200, { ok: true, entries: await history.list() })
         } catch (error) {
           writeJson(res, 200, { ok: false, code: 'history-failed', message: messageOf(error) })
         }
@@ -300,7 +373,7 @@ export function makeRoutes(deps: ImageGenRoutesDeps): WebRoute[] {
           return
         }
         try {
-          writeJson(res, 200, { ok: true, entries: await appendHistory(entry) })
+          writeJson(res, 200, { ok: true, entries: await history.append(entry) })
         } catch (error) {
           writeJson(res, 200, { ok: false, code: 'history-failed', message: messageOf(error) })
         }
@@ -319,7 +392,7 @@ export function makeRoutes(deps: ImageGenRoutesDeps): WebRoute[] {
           return
         }
         try {
-          writeJson(res, 200, { ok: true, entries: await removeHistory(id) })
+          writeJson(res, 200, { ok: true, entries: await history.remove(id) })
         } catch (error) {
           writeJson(res, 200, { ok: false, code: 'history-failed', message: messageOf(error) })
         }
@@ -332,7 +405,7 @@ export function makeRoutes(deps: ImageGenRoutesDeps): WebRoute[] {
       handler: async (req, res) => {
         if (!guard(req, res, 'POST')) return
         try {
-          writeJson(res, 200, { ok: true, entries: await clearHistory() })
+          writeJson(res, 200, { ok: true, entries: await history.clear() })
         } catch (error) {
           writeJson(res, 200, { ok: false, code: 'history-failed', message: messageOf(error) })
         }
@@ -356,7 +429,7 @@ export function makeRoutes(deps: ImageGenRoutesDeps): WebRoute[] {
           writeJson(res, 404, { error: 'not found' })
           return
         }
-        const found = await readHistoryImage(file)
+        const found = await history.readImage(file)
         if (found === undefined) {
           writeJson(res, 404, { error: 'not found' })
           return

package/src/updater.ts

@@ -0,0 +1,116 @@
+/** GitHub Release discovery and explicit, user-triggered plugin updates. */
+
+import { spawn, type ChildProcess } from 'node:child_process'
+
+/** Keep this in sync with package.json for each published release. */
+export const CURRENT_VERSION = '1.0.2'
+export const PACKAGE_NAME = '@dickpy/dsh-imagegen'
+export const RELEASES_URL = 'https://api.github.com/repos/dickpy/dsh-imagegen/releases/latest'
+
+const CHECK_TIMEOUT_MS = 10_000
+const CACHE_TTL_MS = 15 * 60_000
+
+export interface UpdateInfo {
+  currentVersion: string
+  latestVersion: string
+  updateAvailable: boolean
+  releaseUrl: string
+  publishedAt?: string
+}
+
+interface GitHubRelease {
+  tag_name?: unknown
+  html_url?: unknown
+  published_at?: unknown
+  draft?: unknown
+  prerelease?: unknown
+}
+
+let cached: { expiresAt: number; value: UpdateInfo } | undefined
+
+/** Compare stable semver triples; returns positive when `left` is newer. */
+export function compareVersions(left: string, right: string): number {
+  const parse = (value: string): [number, number, number] => {
+    const match = /^v?(\d+)\.(\d+)\.(\d+)/.exec(value.trim())
+    if (match === null) return [0, 0, 0]
+    return [Number(match[1]), Number(match[2]), Number(match[3])]
+  }
+  const a = parse(left)
+  const b = parse(right)
+  return a[0] - b[0] || a[1] - b[1] || a[2] - b[2]
+}
+
+function normalizedReleaseVersion(tag: unknown): string | undefined {
+  if (typeof tag !== 'string' || !/^v?\d+\.\d+\.\d+(?:-[0-9A-Za-z.-]+)?$/.test(tag.trim())) return undefined
+  return tag.trim().replace(/^v/, '')
+}
+
+/** Read the latest stable GitHub Release, with a short host-side cache. */
+export async function checkForUpdate(fetchFn: typeof fetch = fetch, now = Date.now()): Promise<UpdateInfo> {
+  if (cached !== undefined && cached.expiresAt > now) return cached.value
+  const response = await fetchFn(RELEASES_URL, {
+    headers: {
+      accept: 'application/vnd.github+json',
+      'user-agent': 'dsh-imagegen-update-check',
+    },
+    signal: AbortSignal.timeout(CHECK_TIMEOUT_MS),
+  })
+  if (!response.ok) throw new Error(`GitHub Releases returned HTTP ${response.status}`)
+  const payload: unknown = await response.json()
+  if (payload === null || typeof payload !== 'object') throw new Error('GitHub Releases returned malformed JSON')
+  const release = payload as GitHubRelease
+  if (release.draft === true || release.prerelease === true) throw new Error('latest GitHub Release is not stable')
+  const latestVersion = normalizedReleaseVersion(release.tag_name)
+  if (latestVersion === undefined) throw new Error('latest GitHub Release has an invalid version tag')
+  const releaseUrl = typeof release.html_url === 'string' ? release.html_url : 'https://github.com/dickpy/dsh-imagegen/releases'
+  const value: UpdateInfo = {
+    currentVersion: CURRENT_VERSION,
+    latestVersion,
+    updateAvailable: compareVersions(latestVersion, CURRENT_VERSION) > 0,
+    releaseUrl,
+    ...typeof release.published_at === 'string' ? { publishedAt: release.published_at } : {},
+  }
+  cached = { expiresAt: now + CACHE_TTL_MS, value }
+  return value
+}
+
+/** Resolve the profile that launched the current DSH process. */
+export function profileFromProcess(argv: readonly string[] = process.argv, env: NodeJS.ProcessEnv = process.env): string {
+  const envProfile = env.DSH_PROFILE?.trim()
+  if (envProfile !== undefined && /^[a-zA-Z0-9_-]+$/.test(envProfile)) return envProfile
+  const profileIndex = argv.indexOf('--profile')
+  const explicit = profileIndex >= 0 ? argv[profileIndex + 1]?.trim() : undefined
+  if (explicit !== undefined && /^[a-zA-Z0-9_-]+$/.test(explicit)) return explicit
+  if (argv.includes('web')) return 'web'
+  return 'web'
+}
+
+/** Run the same official command documented for plugin installation. */
+export function installUpdate(
+  version: string,
+  spawnFn: typeof spawn = spawn,
+  argv: readonly string[] = process.argv,
+  env: NodeJS.ProcessEnv = process.env,
+): Promise<void> {
+  if (!/^\d+\.\d+\.\d+(?:-[0-9A-Za-z.-]+)?$/.test(version)) {
+    return Promise.reject(new Error('invalid update version'))
+  }
+  const profile = profileFromProcess(argv, env)
+  const command = process.platform === 'win32' ? 'dsh.cmd' : 'dsh'
+  const child = spawnFn(command, ['plugin', '--profile', profile, 'add', `${PACKAGE_NAME}@${version}`], {
+    shell: process.platform === 'win32',
+    stdio: 'ignore',
+  }) as ChildProcess
+  return new Promise((resolve, reject) => {
+    child.once('error', reject)
+    child.once('exit', (code, signal) => {
+      if (code === 0) resolve()
+      else reject(new Error(signal === null ? `plugin update exited with code ${code ?? 'unknown'}` : `plugin update terminated by ${signal}`))
+    })
+  })
+}
+
+/** Test helper: clear the host-side Release cache. */
+export function clearUpdateCache(): void {
+  cached = undefined
+}