pixelkiln 0.67.0 → 0.68.0

package/dist/index.js

@@ -200,6 +200,16 @@ var CharacterPortraitSchema = z.object({
   of: z.string().min(1),
   size: CharacterPortraitSizeSchema.default(64)
 }).strict();
+var MapScenePlacementSchema = z.union([
+  z.object({ oval: z.number().min(0.05).max(0.95) }).strict(),
+  z.object({ rectangle: z.number().min(0.05).max(0.95) }).strict(),
+  z.object({ mask: z.string().min(1) }).strict()
+]);
+var MapSceneSchema = z.object({
+  /** Manifest-relative PNG of the scene. Any earlier asset's output file works. */
+  image: z.string().min(1),
+  placement: MapScenePlacementSchema.default({ oval: 0.3 })
+}).strict();
 var CharacterOutfitSchema = z.object({
   /** The loop (a character animation asset) to re-clothe, in the same style. */
   of: z.string().min(1),
@@ -894,6 +904,8 @@ var AssetSchema = z.object({
   portrait: CharacterPortraitSchema.optional(),
   /** `character` styles: this asset re-clothes an existing loop's frames with a reference outfit. */
   outfit: CharacterOutfitSchema.optional(),
+  /** `map` styles only: draw this object in the style of a scene image. See `MapSceneSchema`. */
+  scene: MapSceneSchema.optional(),
   /** `character` styles, `standard` humanoid bases: this character's proportions, over the style's. */
   proportions: CharacterProportionsSchema.optional(),
   /**
@@ -970,7 +982,7 @@ var AssetSchema = z.object({
       path: ["revision"]
     });
   }
-  const shapes = [asset.revision && "revision", asset.state && "state", asset.animation && "animation", asset.mirror && "mirror", asset.batch && "batch", asset.portrait && "portrait", asset.outfit && "outfit"].filter(Boolean);
+  const shapes = [asset.revision && "revision", asset.state && "state", asset.animation && "animation", asset.mirror && "mirror", asset.batch && "batch", asset.portrait && "portrait", asset.outfit && "outfit", asset.scene && "scene"].filter(Boolean);
   if (shapes.length > 1) {
     context.addIssue({
       code: z.ZodIssueCode.custom,
@@ -1766,6 +1778,12 @@ var PixelLabClient = class {
     if (args.shading) body.shading = args.shading;
     if (args.detail) body.detail = args.detail;
     if (args.seed != null) body.seed = args.seed;
+    if (args.scene) {
+      const encode = (image) => ({ type: "base64", base64: image.base64, format: image.format });
+      const placement = args.scene.placement;
+      body.background_image = encode(args.scene.image);
+      body.inpainting = placement.type === "mask" ? { type: "mask", mask_image: encode(placement.mask) } : { type: placement.type, fraction: placement.fraction };
+    }
     return validateResponse(
       MapSubmitSchema,
       await this.request("/map-objects", { method: "POST", body: JSON.stringify(body) }),
@@ -3388,6 +3406,11 @@ function specHash(spec, styleImageHashes, providerOptionIdentity = spec.provider
       uiPieces: spec.uiPieces,
       uiElements: spec.uiElements,
       uiColorPalette: spec.uiColorPalette,
+      // Scene and mask enter as their bytes' hashes, never their paths.
+      scene: spec.scene ? {
+        image: spec.scene.sha256,
+        placement: spec.scene.placement.type === "mask" ? { type: "mask", mask: spec.scene.placement.sha256 } : spec.scene.placement
+      } : void 0,
       styleTraits: spec.styleTraits,
       styleImages: styleImageHashes,
       // A character family: the engine and rotations of a base, the parent's
@@ -3619,6 +3642,8 @@ var PixelLabProvider = class _PixelLabProvider {
   supports(generator) {
     return generator === "1dir" || generator === "map" || generator === "pixflux" || generator === "tiles" || generator === "terrain" || generator === "imagePro" || generator === "character" || generator === "isometricTile" || generator === "objectPro" || generator === "uiAsset" || generator === "uiElement" || generator === "imageProFlash";
   }
+  /** `/map-objects` style matching: `background_image` plus `inpainting`. */
+  supportsMapScene = true;
   /**
    * `inpaint` (`/inpaint-v3`, a mask) and `image-to-image` (`/edit-images-v2`,
    * no mask) both exist on PixelLab, and so do `reduce-colors`
@@ -4764,7 +4789,8 @@ var PixelLabProvider = class _PixelLabProvider {
       outline: spec.outline,
       shading: spec.shading,
       detail: spec.detail,
-      seed: spec.seed
+      seed: spec.seed,
+      scene: spec.scene ? mapScenePayload(spec) : void 0
     });
     return { jobId: res.object_id, metadata: { backgroundJobId: res.background_job_id } };
   }
@@ -5641,6 +5667,21 @@ function findObjectAnimation(object, name, direction, animationId) {
   }
   return null;
 }
+function mapScenePayload(spec) {
+  const scene = spec.scene;
+  const read = (file, hash, label) => {
+    const bytes = readFileSync(file);
+    if (!hash || sha256(bytes) !== hash) {
+      throw new Error(`${spec.styleId}/${spec.assetId}: ${label} changed after the manifest was resolved`);
+    }
+    return { base64: bytes.toString("base64"), format: "png" };
+  };
+  const placement = scene.placement;
+  return {
+    image: read(scene.file, scene.sha256, "scene image"),
+    placement: placement.type === "mask" ? { type: "mask", mask: read(placement.file, placement.sha256, "scene mask") } : placement
+  };
+}
 
 // src/providers/retrodiffusion.ts
 var DEFAULT_BASE_URL = "https://api.retrodiffusion.ai/v1";
@@ -7420,6 +7461,7 @@ var FakeProvider = class {
   supports(generator) {
     return generator === "1dir" || generator === "map" || generator === "character";
   }
+  supportsMapScene = true;
   supportsRevision(_mode) {
     return true;
   }
@@ -8750,6 +8792,7 @@ async function resolveSpecs(loaded, filter) {
           };
         }
       }
+      if (asset.scene) resolved.scene = await resolveMapScene(root, styleId, assetId, resolved.generator, asset.scene, activeProvider);
       resolved.specHash = specHash(
         resolved,
         styleImageHashes,
@@ -8808,6 +8851,32 @@ function pngPath(file) {
   const extension = path5.extname(file);
   return extension ? `${file.slice(0, -extension.length)}.png` : `${file}.png`;
 }
+async function resolveMapScene(root, styleId, assetId, generator, scene, provider) {
+  if (generator !== "map") {
+    throw new Error(`assets.${assetId}.scene: only a map object can be drawn into a scene; style "${styleId}" uses "${generator}"`);
+  }
+  if (!provider.supportsMapScene) {
+    throw new Error(`assets.${assetId}.scene: provider "${provider.id}" cannot draw into a scene; PixelLab's /map-objects can`);
+  }
+  const file = path5.resolve(root, scene.image);
+  const image = await optionalRevisionImage(file, "scene image", "png");
+  const base = { file, sha256: image?.hash ?? null, width: image?.width ?? null, height: image?.height ?? null };
+  const placement = scene.placement;
+  if ("mask" in placement) {
+    const maskFile = path5.resolve(root, placement.mask);
+    const mask = await optionalRevisionImage(maskFile, "scene mask", "png");
+    if (image && mask && (image.width !== mask.width || image.height !== mask.height)) {
+      throw new Error(
+        `assets.${assetId}.scene: the mask is ${mask.width}x${mask.height}; the scene ${scene.image} is ${image.width}x${image.height}`
+      );
+    }
+    return {
+      ...base,
+      placement: { type: "mask", file: maskFile, sha256: mask?.hash ?? null, width: mask?.width ?? null, height: mask?.height ?? null }
+    };
+  }
+  return "oval" in placement ? { ...base, placement: { type: "oval", fraction: placement.oval } } : { ...base, placement: { type: "rectangle", fraction: placement.rectangle } };
+}
 async function optionalRevisionImage(file, label, requiredFormat) {
   if (!existsSync4(file)) return null;
   const bytes = await readFile3(file);
@@ -10478,6 +10547,7 @@ async function inspectRevisionReadiness(spec, lock) {
   if (spec.character?.parentSpec) return inspectCharacterParent(spec, lock, /* @__PURE__ */ new Set());
   if (spec.character?.styleAnchor) return inspectStyleAnchor(spec, lock, /* @__PURE__ */ new Set());
   if (spec.objectPro?.parentSpec) return inspectObjectProParent(spec, lock, /* @__PURE__ */ new Set());
+  if (spec.scene) return inspectScene(spec);
   if (!spec.revision) return null;
   return inspectRevision(spec, lock, /* @__PURE__ */ new Set());
 }
@@ -10495,6 +10565,16 @@ async function inspectStyleAnchor(spec, lock, seen) {
   }
   return { ready: true, reason: `${label} is current` };
 }
+async function inspectScene(spec) {
+  const scene = spec.scene;
+  const files = [{ label: "scene image", file: scene.file, sha256: scene.sha256 }];
+  if (scene.placement.type === "mask") files.push({ label: "scene mask", file: scene.placement.file, sha256: scene.placement.sha256 });
+  for (const { label, file, sha256: sha2562 } of files) {
+    if (!sha2562 || !existsSync7(file)) return { ready: false, reason: `${label} does not exist yet: ${file}` };
+    if (await sha256File(file) !== sha2562) return { ready: false, reason: `${label} changed after the manifest was resolved` };
+  }
+  return { ready: true, reason: "scene is current" };
+}
 async function inspectMirror(spec, lock, seen) {
   const source = spec.mirror.sourceSpec;
   const label = `mirror source ${spec.styleId}/${spec.mirror.sourceAssetId}`;
@@ -17863,6 +17943,8 @@ export {
   ManifestEditSchema,
   ManifestInputSchema,
   ManifestSchema,
+  MapScenePlacementSchema,
+  MapSceneSchema,
   MediaType,
   OverwriteRefusedError,
   PIXEL_ART_FIXER_REVISION,