pixelkiln 0.47.0 → 0.48.0

package/dist/cli.js

@@ -1374,6 +1374,8 @@ var LockHistoryEntrySchema = z.object({
   downloadedAt: z.string().nullable().default(null),
   cost: z.number().finite().nonnegative().default(0),
   costUnit: z.string().min(1).default("generations"),
+  /** What the provider actually billed, read from the completed job; null when never read. */
+  billed: z.object({ amount: z.number(), unit: z.string() }).nullable().default(null),
   provider: z.string().default("pixellab"),
   postprocess: PostprocessSchema.optional(),
   /** When the replacement was submitted. */
@@ -1465,6 +1467,14 @@ var LockEntrySchema = z.object({
   cost: z.number().finite().nonnegative().default(0),
   /** Unit for `cost`. Defaults preserve pre-unit PixelLab lockfiles. */
   costUnit: z.string().min(1).default("generations"),
+  /**
+   * What the provider actually billed, read from the completed job rather
+   * than estimated at submit time. Null until a poll reads it, and for a
+   * provider or generator `poll` does not read it from at all; `cost` above
+   * is still what a wave budget spends against, since the real number is
+   * only known after the fact.
+   */
+  billed: z.object({ amount: z.number(), unit: z.string() }).nullable().default(null),
   /** Which provider produced this. Absent on entries written before providers. */
   provider: z.string().default("pixellab"),
   /** Generations this entry replaced, newest first; see LockHistoryEntrySchema. */
@@ -5193,7 +5203,13 @@ var CharacterListSchema = z2.object({ characters: z2.array(CharacterSchema), tot
 var BackgroundJobSchema = z2.object({
   id: z2.string(),
   status: z2.string(),
-  last_response: z2.record(z2.unknown()).nullable().optional()
+  last_response: z2.record(z2.unknown()).nullable().optional(),
+  /**
+   * The billed amount, confirmed live for a `map` object and a standard
+   * character base (docs/ENDPOINTS.md, "Limits and billing"); duplicated at
+   * `last_response.billing_usage` on the jobs observed so far.
+   */
+  usage: UsageSchema
 }).passthrough();
 var DeleteAnimationsSchema = z2.object({ success: z2.boolean(), deleted_count: z2.number().int().default(0), error: z2.string().nullable().optional() }).passthrough();
 function validateResponse(schema, raw, operation) {
@@ -5647,6 +5663,14 @@ function pixelLabObjectUrl(generator, objectId) {
   }
   return null;
 }
+function billedFromUsage(usage) {
+  if (!usage) return null;
+  if (usage.type === "usd" || usage.type === void 0 && typeof usage.usd === "number") {
+    return typeof usage.usd === "number" ? { amount: usage.usd, unit: "usd" } : null;
+  }
+  if (typeof usage.generations === "number") return { amount: usage.generations, unit: "generations" };
+  return null;
+}
 function characterCost(spec) {
   const character = spec.character;
   if (!character) return generationCost(spec.width, spec.height, "1dir");
@@ -6017,6 +6041,7 @@ var PixelLabProvider = class _PixelLabProvider {
     if (character.status !== "completed" || !character.rotation_urls) return { status: "processing" };
     const sources = rotationSources(character);
     if (!sources.length) return { status: "failed", error: "character completed with no rotation images" };
+    const backgroundJobId = context?.metadata?.character?.backgroundJobId;
     return {
       status: "ready",
       objectId: character.id,
@@ -6032,7 +6057,8 @@ var PixelLabProvider = class _PixelLabProvider {
           size: character.size,
           updatedAt: character.updated_at ?? null
         }
-      }
+      },
+      billed: await this.billedForJob(backgroundJobId)
     };
   }
   /**
@@ -6044,7 +6070,7 @@ var PixelLabProvider = class _PixelLabProvider {
    */
   async pollCharacterAnimation(job, context) {
     const fps = context?.spec?.character?.animation?.fps ?? 8;
-    const review = (frames, animationId, groupId) => ({
+    const review = (frames, animationId, groupId, billed) => ({
       status: "review-set",
       objectId: `${job.characterId}#${groupId ?? animationId ?? job.name}`,
       frameUrls: frames,
@@ -6060,7 +6086,8 @@ var PixelLabProvider = class _PixelLabProvider {
           animationName: job.name,
           direction: job.direction
         }
-      }
+      },
+      billed
     });
     let cleanedUp = job.jobIds.length === 0;
     for (const id of job.jobIds) {
@@ -6080,13 +6107,13 @@ var PixelLabProvider = class _PixelLabProvider {
       if (Array.isArray(frames) && frames.length && frames.every((f) => typeof f === "string")) {
         const character2 = await this.client.getCharacter(job.characterId);
         const group = findAnimation(character2, job.name, job.direction, animationId);
-        return review(frames, animationId, group?.groupId ?? null);
+        return review(frames, animationId, group?.groupId ?? null, billedFromUsage(status.usage));
       }
     }
     const recorded = context?.metadata?.character?.animationId ?? null;
     const character = await this.client.getCharacter(job.characterId);
     const found = findAnimation(character, job.name, job.direction, recorded);
-    if (found) return review(found.frames, found.animationId, found.groupId);
+    if (found) return review(found.frames, found.animationId, found.groupId, null);
     return cleanedUp ? { status: "failed", error: `animation job is gone upstream and no "${job.name}" ${job.direction} animation exists on the character` } : { status: "processing" };
   }
   async submit(spec, styleImages, context) {
@@ -6119,7 +6146,7 @@ var PixelLabProvider = class _PixelLabProvider {
         // unlike 1dir's {type, base64, format} payload.
         styleImages: styleImages.map(({ base64, width, height }) => ({ base64, width, height }))
       });
-      return { jobId: res2.tile_id };
+      return { jobId: res2.tile_id, metadata: { backgroundJobId: res2.background_job_id } };
     }
     if (spec.generator === "1dir") {
       const res2 = await this.client.create1Direction({
@@ -6128,7 +6155,7 @@ var PixelLabProvider = class _PixelLabProvider {
         view: spec.view === "sidescroller" ? "sidescroller" : "top-down",
         styleImages
       });
-      return { jobId: res2.object_id };
+      return { jobId: res2.object_id, metadata: { backgroundJobId: res2.background_job_id } };
     }
     const res = await this.client.createMapObject({
       description: spec.prompt,
@@ -6140,7 +6167,22 @@ var PixelLabProvider = class _PixelLabProvider {
       detail: spec.detail,
       seed: spec.seed
     });
-    return { jobId: res.object_id };
+    return { jobId: res.object_id, metadata: { backgroundJobId: res.background_job_id } };
+  }
+  /**
+   * What a background job actually billed, once its own record is still
+   * around to ask; see `billedFromUsage`. A stale or already-cleaned-up job
+   * (a map object's record expires in hours; see `pollMap`) means "not
+   * known", not a failure worth surfacing.
+   */
+  async billedForJob(backgroundJobId) {
+    if (!backgroundJobId) return null;
+    try {
+      const job = await this.client.getBackgroundJob(backgroundJobId);
+      return billedFromUsage(job.usage);
+    } catch {
+      return null;
+    }
   }
   async poll(jobId, generator, context) {
     if (generator === "pixflux") {
@@ -6154,16 +6196,17 @@ var PixelLabProvider = class _PixelLabProvider {
         error: "pixflux result is no longer cached locally; re-run submit for this asset"
       };
     }
-    if (generator === "map") return this.pollMap(jobId);
-    if (generator === "tiles") return this.pollTiles(jobId, Boolean(context?.tileFeature));
+    if (generator === "map") return this.pollMap(jobId, context);
+    if (generator === "tiles") return this.pollTiles(jobId, Boolean(context?.tileFeature), context);
     if (generator === "character") return this.pollCharacter(jobId, context);
+    const backgroundJobId = context?.metadata?.backgroundJobId;
     const obj = await this.client.getObject(jobId);
     if (obj.status === "review") {
-      return { status: "review", candidateUrls: obj.frame_urls ?? [] };
+      return { status: "review", candidateUrls: obj.frame_urls ?? [], billed: await this.billedForJob(backgroundJobId) };
     }
     if (obj.status === "completed") {
       const url = firstUrl(obj.rotation_urls) ?? obj.preview_url ?? null;
-      return { status: "ready", objectId: obj.id, sourceUrl: url, sources: url ? [{ url }] : [] };
+      return { status: "ready", objectId: obj.id, sourceUrl: url, sources: url ? [{ url }] : [], billed: await this.billedForJob(backgroundJobId) };
     }
     if (obj.status === "failed") return { status: "failed", error: "generation failed upstream" };
     return {
@@ -6179,7 +6222,8 @@ var PixelLabProvider = class _PixelLabProvider {
    * `/objects` four months on, with `/map-objects` returning 404 for the same
    * id. So a 404 here is not evidence the work is lost.
    */
-  async pollMap(jobId) {
+  async pollMap(jobId, context) {
+    const backgroundJobId = context?.metadata?.backgroundJobId;
     try {
       const obj = await this.client.getMapObject(jobId);
       if (obj.status === "completed" && obj.download_url) {
@@ -6187,7 +6231,8 @@ var PixelLabProvider = class _PixelLabProvider {
           status: "ready",
           objectId: jobId,
           sourceUrl: obj.download_url,
-          sources: [{ url: obj.download_url }]
+          sources: [{ url: obj.download_url }],
+          billed: await this.billedForJob(backgroundJobId)
         };
       }
       if (obj.status === "failed") return { status: "failed", error: "generation failed upstream" };
@@ -6198,7 +6243,7 @@ var PixelLabProvider = class _PixelLabProvider {
       const survivor = await this.client.getObject(jobId).catch(() => null);
       const url = firstUrl(survivor?.rotation_urls) ?? survivor?.preview_url ?? null;
       if (survivor?.status === "completed" && url) {
-        return { status: "ready", objectId: survivor.id, sourceUrl: url, sources: [{ url }] };
+        return { status: "ready", objectId: survivor.id, sourceUrl: url, sources: [{ url }], billed: null };
       }
       return {
         status: "failed",
@@ -6211,12 +6256,14 @@ var PixelLabProvider = class _PixelLabProvider {
    * `storage_urls` once finished. There is no `status` field to read and no
    * progress percentage on offer, so "processing" here carries no ETA.
    */
-  async pollTiles(tileId, connectable) {
+  async pollTiles(tileId, connectable, context) {
     try {
       const set = await this.client.getTilesPro(tileId);
       const tiles = tilesInIndexOrder(set.storage_urls);
       if (!tiles.length) return { status: "failed", error: "tiles job returned no storage urls" };
-      if (!connectable) return { status: "review", candidateUrls: tiles.map((tile) => tile.url) };
+      const backgroundJobId = context?.metadata?.backgroundJobId;
+      const billed = await this.billedForJob(backgroundJobId);
+      if (!connectable) return { status: "review", candidateUrls: tiles.map((tile) => tile.url), billed };
       return {
         status: "ready",
         objectId: tileId,
@@ -6228,7 +6275,8 @@ var PixelLabProvider = class _PixelLabProvider {
         metadata: {
           tileKind: set.kind,
           ...set.tile_rules ? { tileRules: set.tile_rules } : {}
-        }
+        },
+        billed
       };
     } catch (err) {
       if (err instanceof PixelLabError && err.status === 423) return { status: "processing" };
@@ -10722,6 +10770,7 @@ function retireGeneration(entry, retiredAt) {
     downloadedAt: entry.downloadedAt,
     cost: entry.cost,
     costUnit: entry.costUnit,
+    billed: entry.billed,
     provider: entry.provider,
     postprocess: entry.postprocess,
     retiredAt
@@ -10812,6 +10861,7 @@ async function revertGeneration(provider, spec, lock, lockPath, opts) {
     downloadedAt: generation.downloadedAt,
     cost: generation.cost,
     costUnit: generation.costUnit,
+    billed: generation.billed,
     provider: generation.provider,
     postprocess: generation.postprocess,
     history
@@ -10870,6 +10920,7 @@ function describeHistory(media, entry, cacheDir) {
       height: generation.height,
       cost: generation.cost,
       costUnit: generation.costUnit,
+      billed: generation.billed,
       submittedAt: generation.submittedAt,
       downloadedAt: generation.downloadedAt,
       retiredAt: generation.retiredAt,
@@ -11113,6 +11164,7 @@ async function buildGallerySnapshot(opts) {
       fps: quality?.frameSet?.fps ?? metadataFps(entry) ?? spec.quality?.fps ?? null,
       cost: entry?.cost ?? 0,
       costUnit: entry?.costUnit ?? spec.costUnit,
+      billed: entry?.billed ?? null,
       estimatedCost: spec.cost,
       candidates: spec.candidates,
       submittedAt: entry?.submittedAt ?? null,
@@ -11176,6 +11228,7 @@ async function buildGallerySnapshot(opts) {
       fps: metadataFps(entry),
       cost: entry.cost,
       costUnit: entry.costUnit,
+      billed: entry.billed,
       estimatedCost: null,
       candidates: null,
       submittedAt: entry.submittedAt,
@@ -11818,7 +11871,8 @@ async function poll(provider, lock, lockPath, opts = {}) {
                 ...entry.providerMetadata[provider.id],
                 ...state.metadata
               }
-            } : entry.providerMetadata
+            } : entry.providerMetadata,
+            billed: state.billed ?? entry.billed
           });
           result.review++;
           log2(
@@ -11838,7 +11892,8 @@ async function poll(provider, lock, lockPath, opts = {}) {
                 ...state.metadata
               }
             } : entry.providerMetadata,
-            error: null
+            error: null,
+            billed: state.billed ?? entry.billed
           });
           result.completed++;
           log2(`  ready   ${key}`);
@@ -13746,6 +13801,10 @@ async function runLifecycle(args, wave, spent) {
 }
 
 // src/cli/commands/history.ts
+function billedNote(cost, costUnit, billed) {
+  if (!billed || billed.unit === costUnit && billed.amount === cost) return "";
+  return `  (billed ${formatCost(billed.unit, billed.amount)})`;
+}
 async function runHistory(args) {
   const { loaded, specs, lock } = await openProject2(args);
   const limit = historyLimit(loaded.manifest);
@@ -13756,7 +13815,7 @@ async function runHistory(args) {
       limit,
       assets: selected.map(({ spec, entry }) => ({
         key: lockKey(spec.styleId, spec.assetId),
-        current: entry ? { objectId: entry.objectId, outputs: entry.outputs, downloadedAt: entry.downloadedAt, cost: entry.cost, costUnit: entry.costUnit } : null,
+        current: entry ? { objectId: entry.objectId, outputs: entry.outputs, downloadedAt: entry.downloadedAt, cost: entry.cost, costUnit: entry.costUnit, billed: entry.billed } : null,
         history: entry?.history ?? []
       }))
     }, null, 2));
@@ -13770,10 +13829,10 @@ async function runHistory(args) {
     const key = lockKey(spec.styleId, spec.assetId);
     log(`
   ${key}`);
-    log(`    current  ${entry.outputs[0]?.sha256.slice(0, 12) ?? "\u2014"}  ${entry.downloadedAt ?? ""}  ${entry.objectId ?? ""}`);
+    log(`    current  ${entry.outputs[0]?.sha256.slice(0, 12) ?? "\u2014"}  ${entry.downloadedAt ?? ""}  ${entry.objectId ?? ""}${billedNote(entry.cost, entry.costUnit, entry.billed)}`);
     for (const [i, generation] of entry.history.entries()) {
       const changed = generation.prompt !== entry.prompt ? "  (different prompt)" : "";
-      log(`    #${String(i + 1).padEnd(2)}      ${generation.outputs[0]?.sha256.slice(0, 12) ?? "\u2014"}  ${generation.downloadedAt ?? ""}  ${generation.objectId ?? ""}${changed}`);
+      log(`    #${String(i + 1).padEnd(2)}      ${generation.outputs[0]?.sha256.slice(0, 12) ?? "\u2014"}  ${generation.downloadedAt ?? ""}  ${generation.objectId ?? ""}${changed}${billedNote(generation.cost, generation.costUnit, generation.billed)}`);
     }
   }
   if (!shown) log(`  no asset has a previous generation recorded${selected.length ? "" : " (nothing selected)"}`);
@@ -14468,21 +14527,29 @@ async function runPlan(args) {
         actionable: group.actionable.map((item) => item.key)
       })),
       actionable: plan.actionable.map((i) => i.key),
-      items: plan.items.map(({ key, state, reason, quality, spec }) => ({
-        key,
-        state,
-        reason,
-        ...spec.revision ? {
-          revision: {
-            mode: spec.revision.mode,
-            from: spec.revision.sourceAssetId,
-            sourceSha256: spec.revision.sourceSha256,
-            ...spec.revision.maskSha256 ? { maskSha256: spec.revision.maskSha256 } : {},
-            ...spec.revision.strength == null ? {} : { strength: spec.revision.strength }
-          }
-        } : {},
-        ...quality ? { quality: { state: quality.state, reason: quality.reason } } : {}
-      }))
+      items: plan.items.map(({ key, state, reason, quality, spec }) => {
+        const entry = lock.entries[key];
+        const billedDiffers = entry?.billed && (entry.billed.unit !== entry.costUnit || entry.billed.amount !== entry.cost);
+        return {
+          key,
+          state,
+          reason,
+          ...spec.revision ? {
+            revision: {
+              mode: spec.revision.mode,
+              from: spec.revision.sourceAssetId,
+              sourceSha256: spec.revision.sourceSha256,
+              ...spec.revision.maskSha256 ? { maskSha256: spec.revision.maskSha256 } : {},
+              ...spec.revision.strength == null ? {} : { strength: spec.revision.strength }
+            }
+          } : {},
+          ...quality ? { quality: { state: quality.state, reason: quality.reason } } : {},
+          // The estimate a wave budget spent against; present alongside the
+          // provider's actual charge only when `poll` has read one and it
+          // differs, since that is the only time the gap is worth a look.
+          ...billedDiffers ? { cost: entry.cost, costUnit: entry.costUnit, billed: entry.billed } : {}
+        };
+      })
     }, null, 2));
   } else {
     printPlan(plan);
@@ -14601,15 +14668,27 @@ function packSprites(inputs, options = {}) {
   const sheetH = rows * cellH;
   const rgba = Buffer.alloc(sheetW * sheetH * 4);
   const frames = [];
+  const pivot = options.pivot ?? "top-left";
   sprites.forEach((sprite, i) => {
-    const ox = i % columns * cellW;
-    const oy = Math.floor(i / columns) * cellH;
+    const cellOx = i % columns * cellW;
+    const cellOy = Math.floor(i / columns) * cellH;
+    const offsetX = pivot === "bottom-center" ? Math.floor((cellW - sprite.width) / 2) : 0;
+    const offsetY = pivot === "bottom-center" ? cellH - sprite.height : 0;
+    const ox = cellOx + offsetX;
+    const oy = cellOy + offsetY;
     for (let y = 0; y < sprite.height; y++) {
       const src = y * sprite.width * 4;
       const dst = ((oy + y) * sheetW + ox) * 4;
       sprite.pixels.copy(rgba, dst, src, src + sprite.width * 4);
     }
-    frames.push({ id: sprite.id, x: ox, y: oy, width: sprite.width, height: sprite.height });
+    frames.push({
+      id: sprite.id,
+      x: ox,
+      y: oy,
+      width: sprite.width,
+      height: sprite.height,
+      ...offsetX || offsetY ? { offsetX, offsetY } : {}
+    });
   });
   return {
     png: encodeRgbaPng(sheetW, sheetH, rgba),
@@ -15126,12 +15205,15 @@ function renderAsepriteSheet(atlas, opts) {
   }
   const frames = {};
   for (const frame of atlas.frames) {
+    const offsetX = frame.offsetX ?? 0;
+    const offsetY = frame.offsetY ?? 0;
+    const pivoted = offsetX !== 0 || offsetY !== 0;
     frames[frame.id] = {
       frame: { x: frame.x, y: frame.y, w: frame.width, h: frame.height },
       rotated: false,
-      trimmed: false,
-      spriteSourceSize: { x: 0, y: 0, w: frame.width, h: frame.height },
-      sourceSize: { w: frame.width, h: frame.height },
+      trimmed: pivoted,
+      spriteSourceSize: pivoted ? { x: offsetX, y: offsetY, w: frame.width, h: frame.height } : { x: 0, y: 0, w: frame.width, h: frame.height },
+      sourceSize: pivoted ? { w: atlas.cell.width, h: atlas.cell.height } : { w: frame.width, h: frame.height },
       duration: durations.get(frame.id) ?? ASEPRITE_DEFAULT_DURATION_MS
     };
   }
@@ -15236,16 +15318,18 @@ async function runPack(args) {
   const manifestDir = path38.dirname(path38.resolve(args.manifest));
   const styleIds = args.styles.length ? args.styles : Object.keys(loaded.manifest.styles);
   for (const styleId of styleIds) {
+    const style = loaded.manifest.styles[styleId];
+    const pivot = style?.generator === "character" ? "bottom-center" : "top-left";
     const packagingSpecs = await resolveSpecs(loaded, { styles: [styleId] });
     const qualitySources = await requireApprovedQualitySources(packagingSpecs, lock);
     const { png, atlas, skipped, sources } = packStyle(lock, styleId, manifestDir, {
       columns: args.columns,
       outputRoles: args.outputRoles,
       primaryOnly: args.primaryOnly,
+      pivot,
       sourceOverrides: qualitySources,
       sources: manifestSources(loaded.manifest, styleId)
     });
-    const style = loaded.manifest.styles[styleId];
     const base = args.out ? path38.resolve(args.out.replace(/\.(?:png|json|tres)$/i, "")) : path38.resolve(manifestDir, style.outDir, `${styleId}-sheet`);
     const format = sheetFormat(args);
     const { extension, document } = renderSheetDocument(format, atlas, { imageName: path38.basename(`${base}.png`) });
@@ -15272,6 +15356,7 @@ async function runPack(args) {
         format,
         order: "id",
         outputRoles: [...args.outputRoles].sort(),
+        pivot,
         primaryOnly: args.primaryOnly,
         style: styleId
       }