pixelkiln 0.63.0 → 0.64.0

package/README.md

@@ -391,8 +391,8 @@ package share one source. Policies: [Contributing](./CONTRIBUTING.md),
 
 ## Scope
 
-Salvaging characters, PixelLab's portrait and outfit tools, cross-project
-cache reuse, and `workspace find` are not implemented; see the open [issues](https://github.com/gfargo/pixelkiln/issues).
+PixelLab's portrait and outfit tools, cross-project cache reuse, and
+`workspace find` are not implemented; see the open [issues](https://github.com/gfargo/pixelkiln/issues).
 
 ## License
 

package/dist/cli.js

@@ -8373,8 +8373,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 = path12.join(_PixelLabProvider.cacheDir(), `${tilesetId}-${index}.png`);
         writeFileSync(file, Buffer.from(tile.image.base64, "base64"));
         sources.push({ url: `file://${file}`, role });
@@ -8493,6 +8493,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);
@@ -11406,6 +11409,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;
@@ -11429,6 +11435,122 @@ async function findOrphans(provider, claimed, opts = {}) {
   })).sort((a, b) => b.createdAt.localeCompare(a.createdAt));
   return { orphans, total: all.length };
 }
+async function findOrphanCharacters(provider, claimed, opts = {}) {
+  const log2 = opts.onProgress ?? (() => {
+  });
+  if (!provider.listCharacters) return { orphans: [], total: 0, partlyClaimed: 0 };
+  const all = [];
+  for await (const character of provider.listCharacters()) all.push(character);
+  log2(`  scanned ${all.length} character(s) on the account`);
+  const isClaimed = (id) => claimed.has(id) || claimed.has(providerClaimId(provider.id, id));
+  const groups = /* @__PURE__ */ new Map();
+  for (const character of all) {
+    const key = character.groupId ?? character.id;
+    groups.set(key, [...groups.get(key) ?? [], character]);
+  }
+  let partlyClaimed = 0;
+  const orphans = [];
+  for (const members of groups.values()) {
+    const unclaimed = members.filter((character) => !isClaimed(character.id));
+    if (!unclaimed.length) continue;
+    if (unclaimed.length < members.length) {
+      partlyClaimed++;
+      continue;
+    }
+    const ordered = [...members].sort((a, b) => Number(isState(a)) - Number(isState(b)) || a.createdAt.localeCompare(b.createdAt));
+    const base = ordered[0];
+    if (base.status !== "completed" || !base.previewUrl) continue;
+    const states = ordered.length - 1;
+    const loops = ordered.reduce((sum, character) => sum + character.animationCount, 0);
+    orphans.push({
+      id: base.id,
+      prompt: base.prompt || base.name || "(no prompt recorded)",
+      width: base.width,
+      height: base.height,
+      createdAt: base.createdAt,
+      previewUrl: base.previewUrl,
+      tags: base.tags ?? [],
+      kind: "character",
+      note: `character \xB7 ${base.directions} directions \xB7 ${states} state${states === 1 ? "" : "s"} \xB7 ${loops} loop${loops === 1 ? "" : "s"}`,
+      members: ordered.map((character) => ({ id: character.id, tags: character.tags ?? [] }))
+    });
+  }
+  orphans.sort((a, b) => b.createdAt.localeCompare(a.createdAt));
+  return { orphans, total: all.length, partlyClaimed };
+}
+function isState(character) {
+  return Boolean(character.stateName && character.stateName !== "Idle");
+}
+function characterStyleIds(manifest) {
+  return Object.keys(manifest.styles).filter((id) => manifest.styles[id].generator === "character");
+}
+function withoutCharacterStyles(manifest) {
+  const characters = new Set(characterStyleIds(manifest));
+  return {
+    ...manifest,
+    styles: Object.fromEntries(Object.entries(manifest.styles).filter(([id]) => !characters.has(id)))
+  };
+}
+function routeCharacterOrphans(orphans, manifest) {
+  const styleIds = characterStyleIds(manifest);
+  const matched = /* @__PURE__ */ new Map();
+  const unmatched = [];
+  const only = { ...manifest, styles: Object.fromEntries(styleIds.map((id) => [id, manifest.styles[id]])) };
+  for (const orphan of orphans) {
+    const styleId = styleIds.length === 1 ? styleIds[0] : styleIds.length ? matchStyleByPattern(orphan.prompt, only) : null;
+    if (!styleId) {
+      unmatched.push(orphan);
+      continue;
+    }
+    matched.set(styleId, [...matched.get(styleId) ?? [], orphan]);
+  }
+  return { matched, unmatched };
+}
+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();
@@ -11553,18 +11675,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++;
-      log2(`  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++;
+        log2(`  tag failed ${target.id}: ${err instanceof Error ? err.message : String(err)}`);
+      }
     }
   }
   return { tagged, failed };
@@ -11710,7 +11836,7 @@ import path19 from "path";
 // src/pick/salvage-sheet.ts
 var escapeHtml = (s) => s.replace(/[&<>"']/g, (c) => ({ "&": "&amp;", "<": "&lt;", ">": "&gt;", '"': "&quot;", "'": "&#39;" })[c]);
 function renderSalvageSheet(orphans, ctx) {
-  const safe = orphans.map((o) => ({ ...o, prompt: escapeHtml(o.prompt) }));
+  const safe = orphans.map((o) => ({ ...o, prompt: escapeHtml(o.prompt), ...o.note ? { note: escapeHtml(o.note) } : {} }));
   const data = JSON.stringify(safe).replace(/<\//g, "<\\/");
   const styleId = ctx ? escapeHtml(ctx.styleId) : null;
   const importDir = ctx ? escapeHtml(ctx.importDir) : null;
@@ -11796,6 +11922,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>' +
@@ -11973,6 +12100,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,
@@ -11989,10 +12119,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) log2(`  not imported: ${line}`);
+            result.imported++;
+            log2(`  imported character ${orphan.id} as ${Object.keys(assets).length} asset(s)`);
+          } catch (err) {
+            result.failed++;
+            log2(`  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");
@@ -12056,11 +12210,12 @@ async function runSalvage(provider, orphans, ctx, opts = {}) {
           result.discarded++;
         }
       }
-      await applyTags(provider, decisions, existingTags, { onProgress: log2 });
+      await applyTags(provider, decisions, existingTags, { onProgress: log2, characters: characterMembers });
       const raw = JSON.parse(await readFile14(ctx.manifestPath, "utf8"));
       for (const id of importedAssetIds) raw.assets[id] = ctx.manifest.assets[id];
       await writeFile9(ctx.manifestPath, JSON.stringify(raw, null, 2) + "\n");
       await saveLock(ctx.lockPath, ctx.lock);
+      if (characterAssetIds.length) result.characterAssetIds = characterAssetIds;
       return result;
     }
   });
@@ -12502,7 +12657,18 @@ async function runSalvage2(args) {
   const claimed = await loadClaims(lockPaths, { provider: provider.id });
   const { orphans, total } = await findOrphans(provider, claimed, { onProgress: diag });
   diag(`  ${claimed.size} claimed \xB7 ${orphans.length} unclaimed of ${total}`);
-  if (!orphans.length) {
+  const characterScan = await findOrphanCharacters(provider, claimed, { onProgress: diag });
+  const characterOrphans = characterScan.orphans;
+  if (characterScan.total) {
+    diag(`  ${characterOrphans.length} unclaimed character group(s) of ${characterScan.total} character(s)`);
+  }
+  if (characterScan.partlyClaimed) {
+    diag(
+      `  ${characterScan.partlyClaimed} character group(s) are partly claimed (a base or state some project uses);
+  they are left out here. Declare their other states and run \`pixelkiln adopt\` instead.`
+    );
+  }
+  if (!orphans.length && !characterOrphans.length) {
     if (jsonMode) log("[]");
     else log(`
   nothing to triage`);
@@ -12513,9 +12679,10 @@ async function runSalvage2(args) {
     workspaceProjects.map((p) => resolveProject(workspaceDir, p).manifestPath),
     args.claims
   );
-  const { matched, unmatched, elsewhere } = groupOrphansByStyle(orphans, accountManifest, siblings);
-  const multiStyle = Object.keys(accountManifest.styles).length > 1;
-  if (multiStyle) {
+  const objectManifest = withoutCharacterStyles(accountManifest);
+  const { matched, unmatched, elsewhere } = groupOrphansByStyle(orphans, objectManifest, siblings);
+  const multiStyle = Object.keys(objectManifest.styles).length > 1;
+  if (multiStyle && orphans.length) {
     diag(`
   by style (matched against each style's prompt prefix/suffix):`);
     for (const [id, list] of matched) diag(`    ${id.padEnd(24)} ${list.length}`);
@@ -12536,16 +12703,33 @@ async function runSalvage2(args) {
   out of the sessions below; force them into one style with --style <id>.`
     );
   }
+  const characterRoutes = routeCharacterOrphans(characterOrphans, accountManifest);
+  if (characterOrphans.length && !characterStyleIds(accountManifest).length) {
+    diag(
+      `
+  ${characterOrphans.length} unclaimed character group(s), but this manifest has no character style
+  to import them into. Add a style with "generator": "character" to triage them.`
+    );
+  } else if (characterRoutes.unmatched.length) {
+    diag(
+      `
+  ${characterRoutes.unmatched.length} character group(s) don't match any character style's pattern;
+  force them into one with --style <character style id>.`
+    );
+  }
   if (args.dryRun) {
+    const listed = [...orphans, ...characterOrphans];
     if (args.json) {
-      log(JSON.stringify(orphans, null, 2));
+      log(JSON.stringify(listed, null, 2));
     } else {
-      const shown = args.all ? orphans : orphans.slice(0, 30);
+      const shown = args.all ? listed : listed.slice(0, 30);
       for (const o of shown) {
-        log(`    ${o.id}  ${o.width}x${o.height}  ${o.createdAt.slice(0, 10)}  ${o.prompt.slice(0, 50)}`);
+        log(
+          `    ${o.id}  ${o.width}x${o.height}  ${o.createdAt.slice(0, 10)}  ` + (o.kind === "character" ? `[${o.note}]  ` : "") + o.prompt.slice(0, 50)
+        );
       }
-      if (!args.all && orphans.length > 30) {
-        log(`    \u2026 and ${orphans.length - 30} more (--all for the full list, --json for machine-readable)`);
+      if (!args.all && listed.length > 30) {
+        log(`    \u2026 and ${listed.length - 30} more (--all for the full list, --json for machine-readable)`);
       }
     }
     diag(`
@@ -12566,6 +12750,12 @@ async function runSalvage2(args) {
     await saveLock(args.lock, lock);
     if (n) log(`  baselined ${n} imported asset(s) against the manifest`);
   };
+  const adoptImported = async (assetIds) => {
+    const resolve = async () => (await resolveSpecs(await loadManifest(args.manifest), { assets: assetIds })).filter((spec) => spec.provider === provider.id);
+    const adopted = await adoptCharacters(provider, await resolve(), lock, args.lock, { onProgress: log, resolve });
+    log(`  adopted ${adopted.matched} of ${assetIds.length} imported character asset(s)`);
+    for (const line of adopted.unmatched) log(`    not adopted: ${line}`);
+  };
   const runOne = async (styleId, list) => {
     const style = accountManifest.styles[styleId];
     const res = await runSalvage(
@@ -12585,10 +12775,19 @@ async function runSalvage2(args) {
       `  imported ${res.imported} \xB7 kept ${res.kept} \xB7 tagged-discard ${res.discarded}` + (res.failed ? ` \xB7 failed ${res.failed}` : "")
     );
     if (res.imported > 0) await rebaseline();
+    if (res.characterAssetIds?.length) await adoptImported(res.characterAssetIds);
     return res;
   };
   if (args.styles.length) {
-    const res = await runOne(args.styles[0], orphans);
+    const styleId = args.styles[0];
+    const isCharacterStyle = characterStyleIds(accountManifest).includes(styleId);
+    const list = isCharacterStyle ? characterOrphans : orphans;
+    if (!list.length) {
+      log(`
+  nothing unclaimed to triage into ${styleId}`);
+      return;
+    }
+    const res = await runOne(styleId, list);
     if (res.discarded) {
       log(`
   Nothing was deleted. To actually remove the discarded objects:`);
@@ -12597,17 +12796,18 @@ async function runSalvage2(args) {
     }
     return;
   }
-  if (!matched.size) {
+  const sessions = [...matched, ...characterRoutes.matched];
+  if (!sessions.length) {
     log(`
   nothing matched a known style; nothing to triage`);
     return;
   }
   log(`
-  ${matched.size} session(s), one style at a time:`);
+  ${sessions.length} session(s), one style at a time:`);
   let totalDiscarded = 0;
-  for (const [styleId, list] of matched) {
+  for (const [styleId, list] of sessions) {
     log(`
-  ${styleId} (${list.length})`);
+  ${styleId} (${list.length}${list[0]?.kind === "character" ? " character group(s)" : ""})`);
     const res = await runOne(styleId, list);
     totalDiscarded += res.discarded;
   }
@@ -12625,16 +12825,30 @@ async function runPurge(args) {
   const doomed = [];
   for await (const obj of requireList(provider)()) {
     if (obj.tags.includes("pixelkiln:discard")) {
-      doomed.push({ id: obj.id, prompt: obj.prompt });
+      doomed.push({ id: obj.id, prompt: obj.prompt, kind: "object" });
+    }
+  }
+  if (provider.listCharacters && provider.deleteCharacter) {
+    for await (const character of provider.listCharacters()) {
+      if (character.tags.includes("pixelkiln:discard")) {
+        const label = character.stateName && character.stateName !== "Idle" ? ` (${character.stateName})` : "";
+        doomed.push({ id: character.id, prompt: `${character.prompt || character.name}${label}`, kind: "character" });
+      }
     }
   }
   if (!doomed.length) {
     log(`  nothing tagged pixelkiln:discard; run \`pixelkiln salvage\` first`);
     return;
   }
+  const characters = doomed.filter((d) => d.kind === "character").length;
+  const objects = doomed.length - characters;
+  const counted = [
+    objects ? `${objects} object(s)` : "",
+    characters ? `${characters} character(s)` : ""
+  ].filter(Boolean).join(" and ");
   log(`
-  ${doomed.length} object(s) tagged for discard:`);
-  for (const d of doomed.slice(0, 20)) log(`    ${d.id}  ${d.prompt.slice(0, 60)}`);
+  ${counted} tagged for discard:`);
+  for (const d of doomed.slice(0, 20)) log(`    ${d.id}  ${d.kind === "character" ? "[character] " : ""}${d.prompt.slice(0, 60)}`);
   if (doomed.length > 20) log(`    \u2026 and ${doomed.length - 20} more`);
   if (args.dryRun) {
     log(`
@@ -12645,7 +12859,8 @@ async function runPurge(args) {
   This permanently deletes them from your ${provider.id} account.`);
   log(`  Any local files already downloaded are untouched, but the objects`);
   log(`  and their URLs are gone and cannot be re-downloaded.`);
-  if (!await confirm(`  Delete ${doomed.length} object(s)?`, args.yes)) {
+  if (characters) log(`  A deleted character takes its animations with it.`);
+  if (!await confirm(`  Delete ${counted}?`, args.yes)) {
     log(`  aborted`);
     return;
   }
@@ -12653,7 +12868,8 @@ async function runPurge(args) {
   let failed = 0;
   for (const d of doomed) {
     try {
-      await requireDelete(provider)(d.id);
+      if (d.kind === "character") await provider.deleteCharacter(d.id);
+      else await requireDelete(provider)(d.id);
       deleted++;
     } catch (err) {
       failed++;