pixelkiln 0.62.0 → 0.64.0

package/dist/index.js

@@ -193,6 +193,14 @@ var CharacterAnimationSchema = z.object({
   template: z.string().min(1).optional(),
   /** Direction to animate. */
   direction: CharacterDirectionSchema.default("south"),
+  /**
+   * Shorthand for one loop in several directions, instead of `direction`.
+   * Expanded when the manifest loads into one loop per named direction
+   * (`<id>.<direction>`) plus a mirror for each direction whose flip is
+   * not named, exactly as if each had been written out. See
+   * `src/loop-directions.ts`.
+   */
+  directions: z.array(CharacterDirectionSchema).min(1).optional(),
   /** Frames to generate without a template (v3). Even, 4 to 16. */
   frames: z.number().int().min(4).max(16).optional(),
   /** Playback rate recorded with the frames; PixelLab does not store one. */
@@ -221,6 +229,13 @@ var CharacterAnimationSchema = z.object({
   /** v3 text loops only: let PixelLab expand the action into a fuller motion description first. */
   enhancePrompt: z.boolean().optional()
 }).strict().superRefine((animation, context) => {
+  if (animation.directions !== void 0) {
+    context.addIssue({
+      code: z.ZodIssueCode.custom,
+      message: "directions is expanded when the manifest loads; validate the loaded manifest, not the raw file",
+      path: ["directions"]
+    });
+  }
   if (animation.frames !== void 0 && animation.frames % 2 !== 0) {
     context.addIssue({ code: z.ZodIssueCode.custom, message: "frames must be even", path: ["frames"] });
   }
@@ -4719,8 +4734,8 @@ var PixelLabProvider = class _PixelLabProvider {
       const sources = [];
       const terrainTiles = [];
       for (const [index, tile] of tileset.tiles.entries()) {
-        const slug = tile.name.toLowerCase().replace(/[^a-z0-9]+/g, "-").replace(/^-+|-+$/g, "") || "tile";
-        const role = `tile-${String(index).padStart(2, "0")}-${slug}`;
+        const slug2 = tile.name.toLowerCase().replace(/[^a-z0-9]+/g, "-").replace(/^-+|-+$/g, "") || "tile";
+        const role = `tile-${String(index).padStart(2, "0")}-${slug2}`;
         const file = path.join(_PixelLabProvider.cacheDir(), `${tilesetId}-${index}.png`);
         writeFileSync(file, Buffer.from(tile.image.base64, "base64"));
         sources.push({ url: `file://${file}`, role });
@@ -4839,6 +4854,9 @@ var PixelLabProvider = class _PixelLabProvider {
   async delete(assetId) {
     await this.client.deleteObject(assetId);
   }
+  async deleteCharacter(id) {
+    await this.client.deleteCharacter(id);
+  }
   async *listCharacters() {
     for await (const character of this.client.iterateCharacters(100)) {
       yield remoteCharacter(character);
@@ -6862,6 +6880,8 @@ var FakeProvider = class {
     this.tags.set(objectId, [...tags]);
     const asset = this.assets.get(objectId);
     if (asset) asset.tags = [...tags];
+    const character = this.characters.get(objectId.split("#")[0]);
+    if (character) character.tags = [...tags];
   }
   /**
    * Assigned in the constructor rather than declared as a method, so a test can
@@ -6896,6 +6916,10 @@ var FakeProvider = class {
     this.deleted.push(assetId);
     this.assets.delete(assetId);
   }
+  async deleteCharacter(id) {
+    this.deleted.push(id);
+    this.characters.delete(id);
+  }
   /** Seed a pre-existing remote asset, for adopt / salvage tests. */
   seed(asset) {
     const full = {
@@ -6992,6 +7016,91 @@ import { readFile as readFile3 } from "fs/promises";
 import { existsSync as existsSync4 } from "fs";
 import path5 from "path";
 
+// src/loop-directions.ts
+var SINGLE_OUTPUT_FIELDS = ["file", "cell", "remoteId", "source", "sourceByStyle", "outputRole"];
+var MIRROR_FIELDS = ["category", "tags", "styles"];
+function loopDirectionId(shorthandId, direction) {
+  return `${shorthandId}.${direction}`;
+}
+function expandLoopDirections(raw) {
+  const families = {};
+  const issues = [];
+  if (!isObject2(raw) || !isObject2(raw.assets)) return { raw, families, issues };
+  const assets = raw.assets;
+  if (!Object.values(assets).some((asset) => isObject2(asset) && isObject2(asset.animation) && "directions" in asset.animation)) {
+    return { raw, families, issues };
+  }
+  const expanded = {};
+  const claimed = new Set(Object.keys(assets));
+  for (const [id, asset] of Object.entries(assets)) {
+    if (!isObject2(asset) || !isObject2(asset.animation) || !("directions" in asset.animation)) {
+      expanded[id] = asset;
+      continue;
+    }
+    const where = `assets.${id}.animation.directions`;
+    const { directions: rawDirections, ...animation } = asset.animation;
+    const parsed = CharacterDirectionSchema.array().min(1).safeParse(rawDirections);
+    if (!parsed.success) {
+      issues.push(`${where}: expected a non-empty list of directions (${CharacterDirectionSchema.options.join(", ")})`);
+      continue;
+    }
+    const directions = parsed.data;
+    const duplicate = directions.find((direction, index) => directions.indexOf(direction) !== index);
+    if (duplicate) {
+      issues.push(`${where}: "${duplicate}" is listed twice`);
+      continue;
+    }
+    if ("direction" in animation) {
+      issues.push(`assets.${id}.animation: direction and directions are mutually exclusive; directions names every loop to make`);
+      continue;
+    }
+    const single = SINGLE_OUTPUT_FIELDS.filter((field) => field in asset);
+    if (single.length) {
+      issues.push(
+        `assets.${id}: ${single.join(", ")} name${single.length === 1 ? "s" : ""} one output, but directions makes ${directions.length} loops; declare the loops explicitly to set ${single.length === 1 ? "it" : "them"} per direction`
+      );
+      continue;
+    }
+    const loops = directions.map((direction) => ({ id: loopDirectionId(id, direction), direction }));
+    const named = new Set(directions);
+    const mirrors = [];
+    for (const { id: loopId, direction } of loops) {
+      const flipped = MIRRORED_DIRECTION[direction];
+      if (flipped === direction || named.has(flipped)) continue;
+      named.add(flipped);
+      mirrors.push({ id: loopDirectionId(id, flipped), of: loopId });
+    }
+    const ids = [...loops.map((loop) => loop.id), ...mirrors.map((mirror) => mirror.id)];
+    const collision = ids.find((expandedId) => claimed.has(expandedId));
+    if (collision) {
+      issues.push(`${where}: expands to "${collision}", which is already declared`);
+      continue;
+    }
+    for (const expandedId of ids) claimed.add(expandedId);
+    for (const loop of loops) {
+      expanded[loop.id] = { ...asset, animation: { ...animation, direction: loop.direction } };
+    }
+    for (const mirror of mirrors) {
+      const inherited = {};
+      for (const field of MIRROR_FIELDS) if (field in asset) inherited[field] = asset[field];
+      expanded[mirror.id] = { mirror: mirror.of, ...inherited };
+    }
+    families[id] = ids;
+  }
+  return { raw: { ...raw, assets: expanded }, families, issues };
+}
+function expandAssetFilter(ids, families) {
+  if (!families) return [...ids];
+  return [...new Set(ids.flatMap((id) => families[id] ?? [id]))];
+}
+function loopShorthandOf(assetId, families) {
+  if (!families) return void 0;
+  return Object.keys(families).find((id) => families[id].includes(assetId));
+}
+function isObject2(value) {
+  return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+
 // src/outputs.ts
 import { existsSync as existsSync3 } from "fs";
 import path4 from "path";
@@ -7310,7 +7419,12 @@ function frameSetFps(entry) {
 async function loadManifest(manifestPath) {
   const abs = path5.resolve(manifestPath);
   if (!existsSync4(abs)) throw new ProjectError(`No manifest at ${abs}`);
-  const input = ManifestInputSchema.safeParse(JSON.parse(await readFile3(abs, "utf8")));
+  const expansion = expandLoopDirections(JSON.parse(await readFile3(abs, "utf8")));
+  if (expansion.issues.length) {
+    throw new ProjectError(`Manifest at ${abs} is invalid:
+${expansion.issues.map((i) => `  ${i}`).join("\n")}`);
+  }
+  const input = ManifestInputSchema.safeParse(expansion.raw);
   if (!input.success) {
     const issues = formatManifestIssues(input.error.issues);
     throw new ProjectError(`Manifest at ${abs} is invalid:
@@ -7395,7 +7509,8 @@ ${issues}`);
     throw new ProjectError(`Manifest at ${abs} is invalid:
 ${unknownReferences.map((i) => `  ${i}`).join("\n")}`);
   }
-  return { manifest: parsed.data, root: path5.dirname(abs), path: abs };
+  const loopFamilies = Object.keys(expansion.families).length ? { loopFamilies: expansion.families } : {};
+  return { manifest: parsed.data, root: path5.dirname(abs), path: abs, ...loopFamilies };
 }
 function parentAssetId(asset) {
   return asset?.revision?.from ?? asset?.state?.of ?? asset?.animation?.of;
@@ -7479,12 +7594,13 @@ async function resolveSpecs(loaded, filter) {
       );
     }
   }
-  for (const unknownAsset of filter?.assets ?? []) {
+  const assetFilter = expandAssetFilter(filter?.assets ?? [], loaded.loopFamilies);
+  for (const unknownAsset of assetFilter) {
     if (!manifest.assets[unknownAsset]) {
       throw new UsageError(`Unknown asset "${unknownAsset}".`);
     }
   }
-  const requestedAssetIds = new Set(filter?.assets?.length ? filter.assets : Object.keys(manifest.assets));
+  const requestedAssetIds = new Set(assetFilter.length ? assetFilter : Object.keys(manifest.assets));
   const resolutionAssetIds = new Set(requestedAssetIds);
   for (const assetId of [...requestedAssetIds]) {
     let current = parentAssetId(manifest.assets[assetId]);
@@ -14208,11 +14324,21 @@ function assetStyles(raw, asset) {
   const own = Array.isArray(asset.styles) ? asset.styles : [];
   return own.length ? own : Object.keys(raw.styles ?? {});
 }
+function declaredAssets(raw) {
+  const expanded = expandLoopDirections(raw).raw;
+  return new Set(Object.keys(expanded.assets ?? {}));
+}
+function undeclaredAsset(raw, assetId) {
+  const shorthand = loopShorthandOf(assetId, expandLoopDirections(raw).families);
+  return new ManifestEditError(
+    shorthand ? `asset "${assetId}" is expanded from "${shorthand}"'s animation.directions; edit "${shorthand}" (it applies to every direction), or write this direction out as its own asset to change it alone` : `asset "${assetId}" is not declared by the manifest`
+  );
+}
 function applyEdit(raw, edit) {
   raw.assets ??= {};
   if (edit.action === "set-source" || edit.action === "clear-source") {
     const asset2 = Object.hasOwn(raw.assets, edit.assetId) ? raw.assets[edit.assetId] : void 0;
-    if (!asset2) throw new ManifestEditError(`asset "${edit.assetId}" is not declared by the manifest`);
+    if (!asset2) throw undeclaredAsset(raw, edit.assetId);
     if (!raw.styles || !Object.hasOwn(raw.styles, edit.styleId)) {
       throw new ManifestEditError(`unknown style "${edit.styleId}"`);
     }
@@ -14264,7 +14390,7 @@ function applyEdit(raw, edit) {
     return;
   }
   if (edit.action === "add-asset") {
-    if (Object.hasOwn(raw.assets, edit.assetId)) {
+    if (declaredAssets(raw).has(edit.assetId)) {
       throw new ManifestEditError(`asset "${edit.assetId}" already exists`);
     }
     const { styles, tags, ...rest } = edit.asset;
@@ -14278,20 +14404,20 @@ function applyEdit(raw, edit) {
       }
       asset2.styles = styles;
     }
-    if (edit.asset.revision && !Object.hasOwn(raw.assets, edit.asset.revision.from)) {
+    if (edit.asset.revision && !declaredAssets(raw).has(edit.asset.revision.from)) {
       throw new ManifestEditError(`revision parent "${edit.asset.revision.from}" is not declared by the manifest`);
     }
-    if (edit.asset.state && !Object.hasOwn(raw.assets, edit.asset.state.of)) {
+    if (edit.asset.state && !declaredAssets(raw).has(edit.asset.state.of)) {
       throw new ManifestEditError(`state parent "${edit.asset.state.of}" is not declared by the manifest`);
     }
-    if (edit.asset.animation && !Object.hasOwn(raw.assets, edit.asset.animation.of)) {
+    if (edit.asset.animation && !declaredAssets(raw).has(edit.asset.animation.of)) {
       throw new ManifestEditError(`animation parent "${edit.asset.animation.of}" is not declared by the manifest`);
     }
     raw.assets[edit.assetId] = asset2;
     return;
   }
   const asset = Object.hasOwn(raw.assets, edit.assetId) ? raw.assets[edit.assetId] : void 0;
-  if (!asset) throw new ManifestEditError(`asset "${edit.assetId}" is not declared by the manifest`);
+  if (!asset) throw undeclaredAsset(raw, edit.assetId);
   const { patch } = edit;
   if (patch.prompt !== void 0) asset.prompt = patch.prompt;
   if (patch.promptForStyle) {
@@ -14905,6 +15031,7 @@ async function describeQuality(media, root, inspection) {
 }
 async function buildGallerySnapshot(opts) {
   const { loaded, specs, lock } = opts;
+  const filter = opts.filter?.assets?.length ? { ...opts.filter, assets: expandAssetFilter(opts.filter.assets, loaded.loopFamilies) } : opts.filter;
   const root = loaded.root;
   const media = /* @__PURE__ */ new Map();
   const plan = await buildPlan(specs, lock);
@@ -15049,7 +15176,7 @@ async function buildGallerySnapshot(opts) {
   for (const [key, entry] of Object.entries(lock.entries)) {
     if (shown.has(key)) continue;
     if (isDeclared(loaded, entry.styleId, entry.assetId)) continue;
-    if (!matchesFilter(opts.filter, entry.styleId, entry.assetId)) continue;
+    if (!matchesFilter(filter, entry.styleId, entry.assetId)) continue;
     const outputs = await Promise.all(
       entry.outputs.map(
         (output) => describeOutput(media, root, resolveOutputPath(output.path, root), output)
@@ -15215,7 +15342,7 @@ async function buildWorkspaceGallerySnapshot(opts) {
     try {
       const loaded = await loadManifest(manifestPath);
       const styleFilter = filter.styles.filter((id) => loaded.manifest.styles[id]);
-      const assetFilter = filter.assets.filter((id) => loaded.manifest.assets[id]);
+      const assetFilter = expandAssetFilter(filter.assets, loaded.loopFamilies).filter((id) => loaded.manifest.assets[id]);
       const excluded = filter.styles.length > 0 && styleFilter.length === 0 || filter.assets.length > 0 && assetFilter.length === 0;
       const lock = await loadLock(lockPath);
       let projectItems = [];
@@ -16317,6 +16444,9 @@ async function loadClaims(lockPaths, opts = {}) {
       add(entry.objectId);
       add(entry.reviewObjectId);
       add(entry.jobId);
+      for (const id of [entry.objectId, entry.jobId]) {
+        if (id?.includes("#")) add(id.split("#")[0]);
+      }
     }
   }
   return claimed;
@@ -16340,6 +16470,54 @@ async function findOrphans(provider, claimed, opts = {}) {
   })).sort((a, b) => b.createdAt.localeCompare(a.createdAt));
   return { orphans, total: all.length };
 }
+function isState(character) {
+  return Boolean(character.stateName && character.stateName !== "Idle");
+}
+function characterSalvageAssets(characters, ctx) {
+  const ordered = [...characters].sort((a, b) => Number(isState(a)) - Number(isState(b)) || a.createdAt.localeCompare(b.createdAt));
+  const base = ordered[0];
+  const common = { styles: [ctx.styleId], tags: ["salvaged"] };
+  const assets = {};
+  const skipped = [];
+  const baseId = idFromPrompt(base.name || base.prompt, ctx.taken);
+  const size = base.width === base.height && base.width >= 32 && base.width <= 256 && base.width !== ctx.styleSize ? { size: base.width } : {};
+  assets[baseId] = { prompt: base.prompt || base.name || baseId, remoteId: base.id, ...size, ...common };
+  const assetIdOf = /* @__PURE__ */ new Map([[base.id, baseId]]);
+  for (const state of ordered.slice(1)) {
+    const stateId = uniqueId(`${baseId}_${slug(state.stateName ?? "state")}`, ctx.taken);
+    assetIdOf.set(state.id, stateId);
+    assets[stateId] = { prompt: state.prompt || state.stateName || stateId, state: { of: baseId }, remoteId: state.id, ...common };
+  }
+  for (const character of ordered) {
+    const parentId = assetIdOf.get(character.id);
+    for (const animation of character.animations) {
+      if (!animation.frames.length) continue;
+      const label = animation.name || animation.type;
+      if (!animation.groupId) {
+        skipped.push(`${parentId}: "${label}" ${animation.direction} loop has no animation group id to adopt it by`);
+        continue;
+      }
+      const loopId = uniqueId(`${parentId}.${slug(label)}.${animation.direction}`, ctx.taken);
+      assets[loopId] = {
+        prompt: label,
+        animation: { of: parentId, direction: animation.direction },
+        remoteId: `${character.id}#${animation.groupId}`,
+        ...common
+      };
+    }
+  }
+  return { assets, skipped };
+}
+function slug(text) {
+  return text.toLowerCase().replace(/^pixelkiln:.*\//, "").replace(/[^a-z0-9]+/g, "_").replace(/^_+|_+$/g, "") || "loop";
+}
+function uniqueId(base, taken) {
+  let id = base;
+  let n = 2;
+  while (taken.has(id)) id = `${base}_${n++}`;
+  taken.add(id);
+  return id;
+}
 var MIN_STYLE_FRAGMENT_LENGTH = 12;
 function matchStyleByPattern(prompt, manifest) {
   const p = prompt.toLowerCase();
@@ -16469,18 +16647,22 @@ async function applyTags(provider, decisions, existing, opts = {}) {
   let tagged = 0;
   let failed = 0;
   for (const { id, action } of decisions) {
-    const current = (existing.get(id) ?? []).filter(
-      (t) => t !== "pixelkiln:keep" && t !== "pixelkiln:discard" && t !== "pixelkiln:imported"
-    );
-    const decisionTag = `pixelkiln:${action === "import" ? "imported" : action}`;
-    const next = [...current.slice(0, 19), decisionTag];
-    if (!provider.setTags) return { tagged, failed };
-    try {
-      await provider.setTags(id, next);
-      tagged++;
-    } catch (err) {
-      failed++;
-      log(`  tag failed ${id}: ${err instanceof Error ? err.message : String(err)}`);
+    const group = opts.characters?.get(id);
+    const targets = group ?? [{ id, tags: existing.get(id) ?? [] }];
+    for (const target of targets) {
+      const current = target.tags.filter(
+        (t) => t !== "pixelkiln:keep" && t !== "pixelkiln:discard" && t !== "pixelkiln:imported"
+      );
+      const decisionTag = `pixelkiln:${action === "import" ? "imported" : action}`;
+      const next = [...current.slice(0, 19), decisionTag];
+      if (!provider.setTags) return { tagged, failed };
+      try {
+        await provider.setTags(target.id, next, group ? "character" : void 0);
+        tagged++;
+      } catch (err) {
+        failed++;
+        log(`  tag failed ${target.id}: ${err instanceof Error ? err.message : String(err)}`);
+      }
     }
   }
   return { tagged, failed };
@@ -16493,7 +16675,7 @@ import path33 from "path";
 // src/pick/salvage-sheet.ts
 var escapeHtml3 = (s) => s.replace(/[&<>"']/g, (c) => ({ "&": "&amp;", "<": "&lt;", ">": "&gt;", '"': "&quot;", "'": "&#39;" })[c]);
 function renderSalvageSheet(orphans, ctx) {
-  const safe = orphans.map((o) => ({ ...o, prompt: escapeHtml3(o.prompt) }));
+  const safe = orphans.map((o) => ({ ...o, prompt: escapeHtml3(o.prompt), ...o.note ? { note: escapeHtml3(o.note) } : {} }));
   const data = JSON.stringify(safe).replace(/<\//g, "<\\/");
   const styleId = ctx ? escapeHtml3(ctx.styleId) : null;
   const importDir = ctx ? escapeHtml3(ctx.importDir) : null;
@@ -16579,6 +16761,7 @@ ITEMS.forEach((o, i) => {
   el.innerHTML =
     '<div class="thumb"><img src="' + o.previewUrl + '" loading="lazy"></div>' +
     '<div class="meta">' + o.width + '\xD7' + o.height + ' \xB7 ' + o.createdAt.slice(0,10) + '</div>' +
+    (o.note ? '<div class="meta">' + o.note + '</div>' : '') +
     '<div class="prompt">' + o.prompt + '</div>' +
     '<div class="acts">' +
       '<button data-a="import">import</button>' +
@@ -16657,6 +16840,9 @@ async function runSalvage(provider, orphans, ctx, opts = {}) {
   });
   const byId = new Map(orphans.map((o) => [o.id, o]));
   const existingTags = new Map(orphans.map((o) => [o.id, o.tags]));
+  const characterMembers = new Map(
+    orphans.flatMap((o) => o.kind === "character" && o.members ? [[o.id, o.members]] : [])
+  );
   return serveReviewPage({
     html,
     port: opts.port,
@@ -16673,10 +16859,34 @@ async function runSalvage(provider, orphans, ctx, opts = {}) {
       const result = { imported: 0, kept: 0, discarded: 0, failed: 0 };
       const taken = new Set(Object.keys(ctx.manifest.assets));
       const importedAssetIds = [];
+      const characterAssetIds = [];
       for (const decision of decisions) {
         const orphan = byId.get(decision.id);
         if (!orphan) continue;
-        if (decision.action === "import") {
+        if (decision.action === "import" && orphan.kind === "character") {
+          try {
+            if (!provider.getCharacter) throw new Error(`provider ${provider.id} cannot read characters`);
+            const details = [];
+            for (const member of orphan.members ?? [{ id: orphan.id }]) details.push(await provider.getCharacter(member.id));
+            const style = ctx.manifest.styles[ctx.styleId];
+            const { assets, skipped } = characterSalvageAssets(details, {
+              styleId: ctx.styleId,
+              styleSize: style?.size,
+              taken
+            });
+            for (const [assetId, asset] of Object.entries(assets)) {
+              ctx.manifest.assets[assetId] = asset;
+              importedAssetIds.push(assetId);
+              characterAssetIds.push(assetId);
+            }
+            for (const line of skipped) log(`  not imported: ${line}`);
+            result.imported++;
+            log(`  imported character ${orphan.id} as ${Object.keys(assets).length} asset(s)`);
+          } catch (err) {
+            result.failed++;
+            log(`  import failed ${orphan.id}: ${err instanceof Error ? err.message : String(err)}`);
+          }
+        } else if (decision.action === "import") {
           try {
             const buf = await provider.download(orphan.previewUrl);
             if (!buf.subarray(0, 8).equals(PNG_SIGNATURE2)) throw new Error("not a PNG");
@@ -16740,11 +16950,12 @@ async function runSalvage(provider, orphans, ctx, opts = {}) {
           result.discarded++;
         }
       }
-      await applyTags(provider, decisions, existingTags, { onProgress: log });
+      await applyTags(provider, decisions, existingTags, { onProgress: log, characters: characterMembers });
       const raw = JSON.parse(await readFile26(ctx.manifestPath, "utf8"));
       for (const id of importedAssetIds) raw.assets[id] = ctx.manifest.assets[id];
       await writeFile13(ctx.manifestPath, JSON.stringify(raw, null, 2) + "\n");
       await saveLock(ctx.lockPath, ctx.lock);
+      if (characterAssetIds.length) result.characterAssetIds = characterAssetIds;
       return result;
     }
   });