rvlib-shipkit 2.7.0 → 2.8.0

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 2.8.0
+
+- **A brand's `icon` draws the favicon family at each size.** `icon: canvas(draw)` in `.shipkit/identity/brand.ts` draws `favicon.png` (512), `favicon-32.png`, `favicon-16.png` and `apple-touch-icon.png` (180, flattened on `palette.bg`), each at its own size, `asset.id` naming the file, so a 16 px tab reads a shape made for it, never a shrunk logo. Without one the favicon is the logo master resized, as before.
+- **comfy-ts is an optional peer, no longer a dependency.** A repo that never declares comfy no longer installs it (npm and bun both skip an optional peer). The toolkit names comfy-ts in no import, a type import included, so importing it, `sk ci`, `sk serve`, the hub and `sk assets identity` never load it. It is loaded at the first workflow load, from the repo's copy. A repo with comfy kinds or `.cflow.ts` modules installs it itself: `bun add -d comfy-ts`. Without it, a workflow load fails loud with that line, and `sk sound` fails loud when no `comfy-ts` is on PATH. `LoadedWorkflow.wf` is typed by the toolkit's own `CflowWorkflow`, the slice of comfy-ts it drives, held to comfy-ts's types by a test.
+- **`og.png` is written small.** The identity writer encodes the og card as a 256 colour palette png at maximum compression: invisible at preview size, and a photo card drops about 3x (pkm-multi's banner card: 970 KB → 280 KB), under the size where some chat apps stop showing a preview. The file name and format stay `og.png`.
+
 ## 2.7.0
 
 - **What waits on the owner is a pill on every repo's row of the project list.** Beside the open asks badge, a pill in the review hue counts the cards that wait on the owner's verdict or answer; zero draws none, and folded it rides the icon's top left corner. A click opens that repo's review page on its first waiting card, the list on the owner's move. One count, `waitingCards` (`collections/review.ts`), read by the tree's review row, `sk needs`, the review page and the list; `/api/projects.json` reads it on every request, so a new card shows within one poll and a verdict at once. Below 768 px the list is always the rail, so the pills show on a phone.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "rvlib-shipkit",
-    "version": "2.7.0",
+    "version": "2.8.0",
     "funding": "https://github.com/sponsors/rvion",
     "description": "All-in-one repo companion: ci gate (task DAG), auto-discovered health checks, release-contract fulfillness, asks queue, md-wiki tools, asset atelier, live tui",
     "license": "MIT",
@@ -25,7 +25,8 @@
         "@types/bun": "^1.3.14",
         "@types/react": "^19.2.17",
         "@types/react-dom": "^19.2.3",
-        "@types/sanitize-html": "^2.16.1"
+        "@types/sanitize-html": "^2.16.1",
+        "comfy-ts": "^2.9.0"
     },
     "overrides": {
         "mobx": "^7.0.0",
@@ -38,7 +39,6 @@
         "@floating-ui/react": "^0.27.20",
         "@napi-rs/canvas": "^1.1.0",
         "clipanion": "^4.0.0-rc.4",
-        "comfy-ts": "^2.9.0",
         "ink": "^7.1.1",
         "marked": "^18.0.7",
         "mobx": "^7.0.0",
@@ -48,5 +48,13 @@
         "react-resizable-panels": "^4.13.3",
         "sanitize-html": "^2.17.6",
         "sharp": "^0.35.3"
+    },
+    "peerDependencies": {
+        "comfy-ts": "^2.9.0"
+    },
+    "peerDependenciesMeta": {
+        "comfy-ts": {
+            "optional": true
+        }
     }
 }

package/src/assets/gen/comfyts-gen.ts

@@ -4,16 +4,40 @@
 // must disconnectAll() in a finally, or the host websocket keeps bun alive.
 // Workflows are discriminated by duck-typing, never instanceof: a consumer's
 // .cflow.ts may hold a second copy of comfy-ts in its module graph.
+// comfy-ts is an optional peer: this file is the one place that loads it, at
+// the first workflow load, and never names it in an import, so a repo without
+// it imports and typechecks the toolkit (tests/comfy-optional.test.ts).
 import { existsSync, mkdirSync, readdirSync, readFileSync, writeFileSync } from 'fs'
 import { basename, join } from 'path'
 import { pathToFileURL } from 'url'
-import { ComfyTS, type AnyVar, type ComfyExecution, type DefinedWorkflow, type MediaImage } from 'comfy-ts'
+
+// the slice of comfy-ts the toolkit drives, held to comfy-ts's own types by
+// tests/comfy-optional.test.ts
+export type CflowVar = { readonly kind: string; parse(raw: string): boolean; loadJSON(value: unknown): unknown; reset(): unknown }
+export type CflowImage = { readonly ComfyNode: { class_type?: string } | null | undefined; readonly metadata: { type?: string }; readonly buffer: Uint8Array }
+export type CflowExecution = { readonly status: string | null | undefined; data: { error?: unknown }; images: CflowImage[]; imageErrors: unknown[] }
+export type CflowHost = {
+    data: { id: string }
+    schema: { readonly size: number }
+    getServerHostHTTP(): string
+    disconnect(): void
+    interrupt(): Promise<void>
+}
+export type CflowWorkflow = {
+    spec: { id?: string }
+    readonly vars: { [key: string]: CflowVar }
+    host: CflowHost
+    entries(): [string, CflowVar][]
+    build(): Promise<{ problems: { title: string }[]; readonly size: number }>
+    run(settings?: { onProgress?: (p: { percent: number; nodeName: string | null }) => void }): Promise<CflowExecution>
+}
+type ComfyTsModule = { ComfyTS?: { create(o: { rootPath: string }): unknown } }
 
 export type GenProgress = { value: number; max: number; node: string | null }
 export type OnProgress = (p: GenProgress) => void
 
 /** root: the repo the workflow belongs to, which holds its drafts */
-export type LoadedWorkflow = { id: string; root: string; file: string; wf: DefinedWorkflow }
+export type LoadedWorkflow = { id: string; root: string; file: string; wf: CflowWorkflow }
 export type ComfyTsRuntime = { workflows: Map<string, LoadedWorkflow>; heal?: string }
 
 // function declaration, not const — TS only narrows on never-calls to
@@ -22,35 +46,39 @@ function fail(msg: string): never { throw new Error(msg) }
 
 // same duck predicate the comfy-ts TUI and serve bind to: a module valid
 // for shipkit is valid for `bunx comfy-ts tui` and vice versa
-function findDefinedWorkflow(mod: Record<string, unknown>): DefinedWorkflow | null {
-    const isDefined = (x: unknown): x is DefinedWorkflow =>
+function findDefinedWorkflow(mod: Record<string, unknown>): CflowWorkflow | null {
+    const isDefined = (x: unknown): x is CflowWorkflow =>
         typeof x === 'object' && x != null && 'spec' in x &&
-        typeof (x as DefinedWorkflow).run === 'function' &&
-        typeof (x as DefinedWorkflow).entries === 'function'
+        typeof (x as CflowWorkflow).run === 'function' &&
+        typeof (x as CflowWorkflow).entries === 'function'
     return [mod.default, ...Object.values(mod)].find(isDefined) ?? null
 }
 
-const varsOf = (wf: DefinedWorkflow): Record<string, AnyVar> => wf.vars as Record<string, AnyVar>
-
 /** true when the image belongs in a roll. Preview-family nodes (PreviewImage,
  *  PreviewBridge, …) emit raw temp images that comfy-ts downloads like any
  *  output, in completion order, and MediaImage drops the server-side
  *  'temp' marker, so the producing node's class_type is the only signal left.
  *  no node json (SaveImageWebsocket frames) = deliberate output, kept. */
-export const isRollImage = (img: Pick<MediaImage, 'ComfyNode'>): boolean =>
+export const isRollImage = (img: Pick<CflowImage, 'ComfyNode'>): boolean =>
     !/preview/i.test(img.ComfyNode?.class_type ?? '')
 
-/** the ComfyTS class of the comfy-ts a bare import from `dir` reaches,
- *  shipkit's own when the repo carries none */
-async function comfyTsOf(dir: string): Promise<typeof ComfyTS> {
-    let path: string
-    try {
-        path = Bun.resolveSync('comfy-ts', dir)
-    } catch {
-        return ComfyTS
+const COMFY_TS = 'comfy-ts'
+const INSTALL_COMFY_TS = 'Install it in this repo: bun add -d comfy-ts'
+
+/** the ComfyTS class of the comfy-ts a bare import from `dir` reaches, else
+ *  the toolkit's own; loud when neither is installed */
+async function comfyTsOf(dir: string): Promise<NonNullable<ComfyTsModule['ComfyTS']>> {
+    for (const from of [dir, import.meta.dir]) {
+        let path: string
+        try {
+            path = Bun.resolveSync(COMFY_TS, from)
+        } catch {
+            continue
+        }
+        const mod = (await import(path)) as ComfyTsModule
+        if (typeof mod.ComfyTS?.create === 'function') return mod.ComfyTS
     }
-    const mod = (await import(path)) as { ComfyTS?: typeof ComfyTS }
-    return typeof mod.ComfyTS?.create === 'function' ? mod.ComfyTS : ComfyTS
+    fail(`comfy-ts is not installed, and ${dir}/ holds comfy-ts workflow modules. ${INSTALL_COMFY_TS}`)
 }
 
 /** dir = the flat folder holding the <id>.cflow.ts workflow modules.
@@ -74,7 +102,10 @@ export async function loadCflowWorkflows(root: string, dir: string): Promise<Map
     for (const f of readdirSync(dir).filter((x) => x.endsWith('.cflow.ts')).sort()) {
         const file = join(dir, f)
         const id = basename(f, '.cflow.ts')
-        const mod = (await import(pathToFileURL(file).href)) as Record<string, unknown>
+        const mod = (await import(pathToFileURL(file).href).catch((e: Error) => {
+            if (/Cannot find (package|module) 'comfy-ts'/.test(e.message)) fail(`${file} imports comfy-ts, which this repo does not install. ${INSTALL_COMFY_TS}`)
+            throw e
+        })) as Record<string, unknown>
         const wf = findDefinedWorkflow(mod)
         if (wf == null) fail(`${file}: exports no DefinedWorkflow — export default host.defineWorkflow({...})`)
         // the file name IS the id: it is also the comfy-ts draft folder key,
@@ -96,7 +127,7 @@ export function workflowFor(workflows: Map<string, LoadedWorkflow>, ref: { workf
         : workflows.size === 1
           ? [...workflows.values()][0]!
           : fail(`asset '${ref.assetId ?? '?'}' names no workflow and ${workflows.size} are loaded (${[...workflows.keys()].join(', ')}) — set workflow on the kind`)
-    const vars = varsOf(lw.wf)
+    const vars = lw.wf.vars
     if (vars.prompt?.kind !== 'prompt' || vars.seed?.kind !== 'seed')
         fail(`kind '${ref.kind ?? '?'}' drives workflow '${lw.id}', which must declare vars.prompt (v.prompt) and vars.seed (v.seed) — the atelier writes both`)
     return lw
@@ -105,8 +136,8 @@ export function workflowFor(workflows: Map<string, LoadedWorkflow>, ref: { workf
 /** Apply a name→value record onto a workflow's vars: strings go through
  *  parse (validated), everything else through loadJSON (the drafts setter).
  *  Unknown names throw listing what the workflow has. */
-export function applyVarValues(wf: DefinedWorkflow, vars: Record<string, unknown>, source: string): void {
-    const defs = varsOf(wf)
+export function applyVarValues(wf: CflowWorkflow, vars: Record<string, unknown>, source: string): void {
+    const defs = wf.vars
     for (const [name, value] of Object.entries(vars)) {
         const varDef = defs[name]
         if (varDef == null) fail(`${source}: unknown var '${name}' on workflow '${wf.spec.id ?? '?'}' (has: ${wf.entries().map(([n, d]) => `${n}:${d.kind}`).join(', ')})`)
@@ -167,7 +198,7 @@ export async function generateComfyTs(
     // names no kind. It is what the tune button edits
     const draftId = args.draftId ?? args.assetId
     ensureAssetDraft(lw, draftId, args.prompt)
-    const defs = varsOf(lw.wf)
+    const defs = lw.wf.vars
     // modules are import-cached: a previous asset's values must not leak
     for (const [, varDef] of lw.wf.entries()) varDef.reset()
     if (args.vars != null) applyVarValues(lw.wf, args.vars, `asset '${args.assetId}' kit vars`)
@@ -192,7 +223,7 @@ export async function generateComfyTs(
     defs.seed!.parse(`= ${args.seed}`)
     mkdirSync(args.destDir, { recursive: true })
     const healHint = rt.heal != null ? ` — is the backend up? (${rt.heal})` : ''
-    let execution: ComfyExecution
+    let execution: CflowExecution
     try {
         execution = await lw.wf.run({
             onProgress: args.onProgress == null ? undefined : (p) => args.onProgress!({ value: Math.round(p.percent), max: 100, node: p.nodeName }),

package/src/assets/kits/identity-kit.ts

@@ -1,6 +1,7 @@
 // kits/identity — favicon / logo / OG as asset kinds. One render path
 // (renderIdentityFromMark: mark png → logo master 1024², favicon 512², og
-// card), two ways to get the mark:
+// card; a brand's `icon` draws the favicon family at each size instead), two
+// ways to get the mark:
 // - canvas mark: deterministic, instant — `shipkit assets identity` draws it
 //   headlessly and renders the set.
 // - comfy mark: roll-and-pick in the studio; the kind carries a BUILT-IN ship
@@ -28,6 +29,12 @@ export type Brand = {
     /** comfy marks: the FULL generation prompt for identity-logo rolls
      *  (style included — the studio shows/edits exactly this) */
     markPrompt?: string
+    /** the small mark, when the logo does not read at 16 px: favicon.png,
+     *  favicon-32.png, favicon-16.png and apple-touch-icon.png (180², flattened
+     *  on palette.bg) are each drawn at their own size; `asset.id` names the
+     *  file (apple-touch-icon fills its square: iOS rounds it). Absent, the
+     *  favicon is the logo master resized */
+    icon?: CanvasGen
     /** og layout hook — replaces the WHOLE default card (bg + mark left +
      *  name/tagline right); the hook owns compositing the mark if it wants one */
     drawOg?: (ctx: SKRSContext2D, brand: Brand, size: { w: number; h: number }) => void
@@ -42,6 +49,8 @@ export const FAVICON_SIZE = 512
 export const OG_W = 1200
 export const OG_H = 630
 export const LOGO_SIZE = 1024
+/** what a brand's `icon` draws, each at its own size */
+export const ICON_FILES = [['favicon', FAVICON_SIZE], ['favicon-32', 32], ['favicon-16', 16], ['apple-touch-icon', 180]] as const
 
 /** the one next step when a comfy mark has no picked roll yet */
 export const NO_PICK_FIX = 'roll + pick in the studio: bun run hub → /assets/#identity-logo'
@@ -110,13 +119,23 @@ export async function renderIdentityFromMark(brand: Brand, root: string, markPng
         .resize(LOGO_SIZE, LOGO_SIZE, { fit: 'contain', background: { r: 0, g: 0, b: 0, alpha: 0 } })
         .png().toBuffer()
     await write('logo.png', logoPng)
-    // favicon = logo master resized to 512² (browsers derive the rest)
-    await write('favicon.png', await sharp(logoPng).resize(FAVICON_SIZE, FAVICON_SIZE).png().toBuffer())
+    if (brand.icon != null) {
+        for (const [id, px] of ICON_FILES) {
+            const c = createCanvas(px, px)
+            await brand.icon.draw(c.getContext('2d'), { id, prompt: '' })
+            const png = sharp(c.toBuffer('image/png'))
+            await write(`${id}.png`, await (id === 'apple-touch-icon' ? png.flatten({ background: brand.palette.bg }) : png).png().toBuffer())
+        }
+    } else {
+        // favicon = logo master resized to 512² (browsers derive the rest)
+        await write('favicon.png', await sharp(logoPng).resize(FAVICON_SIZE, FAVICON_SIZE).png().toBuffer())
+    }
     const og = createCanvas(OG_W, OG_H)
     const ctx = og.getContext('2d')
     if (brand.drawOg != null) brand.drawOg(ctx, brand, { w: OG_W, h: OG_H })
     else defaultOg(ctx, brand, { w: OG_W, h: OG_H }, await loadImage(logoPng))
-    await write('og.png', og.toBuffer('image/png'))
+    // a link preview is small: a 256 colour palette is invisible there and cuts a photo card about 3x (some chat apps drop a preview past ~300 KB)
+    await write('og.png', await sharp(og.toBuffer('image/png')).png({ palette: true, quality: 90, effort: 10, compressionLevel: 9 }).toBuffer())
     return out
 }
 

package/src/trailer/sound/comfy.ts

@@ -12,6 +12,7 @@ export function comfyModule(comfy: string | undefined, name: string): string {
 const COMFY_TIMEOUT_S = 15 * 60
 
 export async function comfyRun(module: string, vars: Record<string, string | number | boolean | undefined>, out: string): Promise<void> {
+    if (Bun.which('comfy-ts') == null) throw new Error(`comfy-ts is not on PATH, and ${module} is a comfy-ts module. Install it: bun add -g comfy-ts`)
     const args = ['comfy-ts', 'run', module]
     for (const [k, v] of Object.entries(vars)) if (v !== undefined) args.push(`--${k}`, String(v))
     args.push('--out', out, '--json')