pixelkiln 0.65.0 → 0.66.0

package/dist/index.js

@@ -1,7 +1,7 @@
 // src/types.ts
 import { z } from "zod";
 var MediaTypeSchema = z.enum(["image/png", "image/gif"]);
-var GeneratorSchema = z.enum(["1dir", "map", "pixflux", "tiles", "animation", "frames", "character", "terrain", "imagePro", "isometricTile", "objectPro", "uiAsset", "uiElement"]);
+var GeneratorSchema = z.enum(["1dir", "map", "pixflux", "tiles", "animation", "frames", "character", "terrain", "imagePro", "isometricTile", "objectPro", "uiAsset", "uiElement", "imageProFlash"]);
 var GridConfidenceSchema = z.enum(["low", "medium", "high"]);
 var RevisionModeSchema = z.enum([
   "image-to-image",
@@ -328,8 +328,22 @@ var RevisionSchema = z.object({
   /** `animate-pixminimax` only: facing direction, used only alongside `enhancePrompt` to hold the sprite's facing. */
   direction: CharacterDirectionSchema.optional(),
   /** `animate`/`animate-pixminimax` only: let PixelLab expand the action into a fuller motion description first. */
-  enhancePrompt: z.boolean().optional()
+  enhancePrompt: z.boolean().optional(),
+  /**
+   * `image-to-image`/`inpaint` only: which provider engine draws the
+   * edit. `pro-flash` selects PixelLab's Pro Flash edit and inpaint tier
+   * (`/edit-image-pro-flash`, `/inpaint-image-pro-flash`) instead of the
+   * default Pro endpoints; omit it for the default.
+   */
+  engine: z.enum(["pro-flash"]).optional()
 }).strict().superRefine((revision, context) => {
+  if (revision.engine !== void 0 && revision.mode !== "image-to-image" && revision.mode !== "inpaint") {
+    context.addIssue({
+      code: z.ZodIssueCode.custom,
+      message: "engine applies to image-to-image and inpaint revisions only",
+      path: ["engine"]
+    });
+  }
   if (revision.mode === "inpaint" && !revision.mask) {
     context.addIssue({
       code: z.ZodIssueCode.custom,
@@ -618,8 +632,8 @@ var StyleObjectSchema = z.object({
   /** `character` only. Body template: `mannequin` (default), a quadruped (`bear`, `cat`, `dog`, `horse`, `lion`), or `custom` for `pro-flash`. */
   template: z.string().min(1).optional(),
   /**
-   * `character` only, `pro-flash` bases with a style image: which traits
-   * the style image lends. Each defaults to true.
+   * `character` `pro-flash` bases and `imageProFlash` styles, with a
+   * style image: which traits the style image lends. Each defaults to true.
    */
   styleTraits: z.object({
     palette: z.boolean().optional(),
@@ -1052,7 +1066,8 @@ var LockEntrySchema = z.object({
     fps: z.number().int().min(1).max(60).optional(),
     lastFrameSha256: z.string().regex(/^[0-9a-f]{64}$/).optional(),
     direction: CharacterDirectionSchema.optional(),
-    enhancePrompt: z.boolean().optional()
+    enhancePrompt: z.boolean().optional(),
+    engine: z.enum(["pro-flash"]).optional()
   }).strict().nullable().default(null),
   /** For a mirror: the asset it flips and a hash over that asset's output hashes when this was made. */
   mirror: z.object({
@@ -1429,6 +1444,14 @@ var CorrectPixelartResponseSchema = z2.object({
   images: z2.array(z2.object({ base64: z2.string().min(1) }).passthrough()).min(1),
   usage: z2.unknown().optional()
 }).passthrough();
+var ProFlashImageSubmitSchema = z2.object({
+  background_job_id: z2.string().min(1),
+  image_id: z2.string().min(1),
+  source_image_id: z2.string().min(1),
+  status: z2.string().default("processing"),
+  estimated_generations: z2.number().nullable().optional(),
+  usage: z2.unknown().optional()
+}).passthrough();
 var UnzoomResponseSchema = z2.object({
   image: z2.object({ base64: z2.string().min(1) }).passthrough(),
   original_size: z2.object({ width: z2.number().int(), height: z2.number().int() }).passthrough(),
@@ -1869,7 +1892,7 @@ var PixelLabClient = class {
     const body = {
       description: args.description,
       n_directions: args.directions,
-      ...args.reference ? { first_frame: encode(args.reference) } : { image_size: { width: args.size, height: args.size } },
+      ...args.sourceImageId ? { source_image_id: args.sourceImageId } : args.reference ? { first_frame: encode(args.reference) } : { image_size: { width: args.size, height: args.size } },
       ...args.view ? { view: args.view } : {},
       ...args.seed != null ? { seed: args.seed } : {},
       ...args.styleReference && args.styleReferenceSize ? {
@@ -2016,8 +2039,9 @@ var PixelLabClient = class {
         description: args.description,
         template_id: args.template,
         n_directions: 8,
-        // The author's sprite sets the canvas; a size only applies to text creation.
-        ...south ? { first_frame: encode(south) } : { image_size: imageSize },
+        // The author's sprite sets the canvas; a size only applies to text
+        // creation. An owned copy of the same sprite is referenced by id.
+        ...args.sourceImageId ? { source_image_id: args.sourceImageId } : south ? { first_frame: encode(south) } : { image_size: imageSize },
         ...args.view ? { view: args.view } : {},
         ...args.seed != null ? { seed: args.seed } : {},
         ...args.styleReference && args.styleReferenceSize ? {
@@ -2289,6 +2313,66 @@ var PixelLabClient = class {
       "generate-image-v2"
     );
   }
+  /**
+   * `/create-image-pro-flash`: one native pixel-art image from a
+   * description, optionally styled after a style image with per-trait
+   * toggles, on the same Pro Flash model `character`/`objectPro` use for
+   * their `pro-flash` engine. Sizes run 16 to 256 per side in multiples of 4.
+   * A plain background job; `pollRevision`'s generic reader takes the
+   * finished image. The response's `source_image_id` is what a Pro Flash
+   * character or object can reuse instead of an upload.
+   */
+  async createImageProFlash(args) {
+    const body = {
+      description: args.description,
+      image_size: { width: args.width, height: args.height }
+    };
+    if (args.noBackground != null) body.no_background = args.noBackground;
+    if (args.seed != null) body.seed = args.seed;
+    if (args.styleImage) {
+      body.style_image = { image: args.styleImage.image, size: { width: args.styleImage.width, height: args.styleImage.height } };
+      const traits = args.styleTraits;
+      if (traits) {
+        body.style_options = {
+          ...traits.palette !== void 0 ? { color_palette: traits.palette } : {},
+          ...traits.outline !== void 0 ? { outline: traits.outline } : {},
+          ...traits.detail !== void 0 ? { detail: traits.detail } : {},
+          ...traits.shading !== void 0 ? { shading: traits.shading } : {}
+        };
+      }
+    }
+    return validateResponse(
+      ProFlashImageSubmitSchema,
+      await this.request("/create-image-pro-flash", { method: "POST", body: JSON.stringify(body) }),
+      "create-image-pro-flash"
+    );
+  }
+  /** `/edit-image-pro-flash`, text method: edit one image at its own size. The canvas never grows or resizes. */
+  async editImageProFlash(args) {
+    const body = { image: args.image, method: "text", description: args.description };
+    if (args.noBackground != null) body.no_background = args.noBackground;
+    if (args.seed != null) body.seed = args.seed;
+    return validateResponse(
+      ProFlashImageSubmitSchema,
+      await this.request("/edit-image-pro-flash", { method: "POST", body: JSON.stringify(body) }),
+      "edit-image-pro-flash"
+    );
+  }
+  /**
+   * `/inpaint-image-pro-flash`: replace only the white pixels of a same-size
+   * black/white mask, keeping everything else exactly. `Modify current
+   * layer` (the endpoint's default) returns the full composite.
+   */
+  async inpaintImageProFlash(args) {
+    const body = { image: args.image, mask_image: args.maskImage, description: args.description };
+    if (args.noBackground != null) body.no_background = args.noBackground;
+    if (args.seed != null) body.seed = args.seed;
+    return validateResponse(
+      ProFlashImageSubmitSchema,
+      await this.request("/inpaint-image-pro-flash", { method: "POST", body: JSON.stringify(body) }),
+      "inpaint-image-pro-flash"
+    );
+  }
   /**
    * `/generate-ui-v2` ("Generate UI (Pro)"): one UI element (a button, a
    * health bar, an inventory slot, a dialogue box) from a description,
@@ -3169,6 +3253,7 @@ function specHash(spec, styleImageHashes, providerOptionIdentity = spec.provider
       uiPieces: spec.uiPieces,
       uiElements: spec.uiElements,
       uiColorPalette: spec.uiColorPalette,
+      styleTraits: spec.styleTraits,
       styleImages: styleImageHashes,
       // A character family: the engine and rotations of a base, the parent's
       // generated bytes for a state or animation (so a regenerated parent
@@ -3245,7 +3330,8 @@ function specHash(spec, styleImageHashes, providerOptionIdentity = spec.provider
         fps: spec.revision.fps,
         lastFrameSha256: spec.revision.lastFrameSha256,
         direction: spec.revision.direction,
-        enhancePrompt: spec.revision.enhancePrompt
+        enhancePrompt: spec.revision.enhancePrompt,
+        engine: spec.revision.engine
       } : void 0
     })
   );
@@ -3301,8 +3387,11 @@ function proFlashCharacterCost(width, height, fromReference) {
   const side = Math.max(32, Math.ceil(Math.max(width, height) / 4) * 4);
   const rotations = Math.max(1, Math.ceil(side * side * 8 / 65536));
   if (fromReference) return rotations;
-  const image = side <= 96 ? 5 : side <= 208 ? 6 : 9;
-  return image + rotations;
+  return proFlashImageCost(side, side) + rotations;
+}
+function proFlashImageCost(width, height) {
+  const side = Math.max(width, height);
+  return side <= 96 ? 5 : side <= 208 ? 6 : 9;
 }
 function characterAnimationName(spec) {
   return `pixelkiln:${spec.styleId}/${spec.assetId}`;
@@ -3378,7 +3467,7 @@ var PixelLabProvider = class _PixelLabProvider {
     return new _PixelLabProvider(new PixelLabClient("download-only"));
   }
   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";
+    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";
   }
   /**
    * `inpaint` (`/inpaint-v3`, a mask) and `image-to-image` (`/edit-images-v2`,
@@ -3440,6 +3529,13 @@ var PixelLabProvider = class _PixelLabProvider {
       const base = Math.max(1, Math.ceil(width * height * frames / 65536));
       return { unit: "generations", amount: spec.revision.enhancePrompt ? base + 0.05 : base, candidates: 1 };
     }
+    if (spec.revision?.engine === "pro-flash") {
+      return {
+        unit: "generations",
+        amount: proFlashImageCost(spec.revision.sourceWidth ?? spec.width, spec.revision.sourceHeight ?? spec.height),
+        candidates: 1
+      };
+    }
     if (spec.revision) {
       const width = spec.revision.sourceWidth ?? spec.width;
       const height = spec.revision.sourceHeight ?? spec.height;
@@ -3454,6 +3550,9 @@ var PixelLabProvider = class _PixelLabProvider {
     if (spec.generator === "objectPro") {
       return { unit: "generations", amount: objectProCost(spec), candidates: 1 };
     }
+    if (spec.generator === "imageProFlash") {
+      return { unit: "generations", amount: proFlashImageCost(spec.width, spec.height), candidates: 1 };
+    }
     return {
       unit: "generations",
       amount: generationCost(spec.width, spec.height, spec.generator),
@@ -3467,7 +3566,17 @@ var PixelLabProvider = class _PixelLabProvider {
         `PixelLab ${spec.revision.mode} reads one source image; ${spec.revision.sourceAssetId} is a ${members.length}-member set (${members[0].role}, ...). Revise one member through a declared source, or use reduce-colors, correct-pixelart, or edit-animation, which take the whole set`
       );
     }
-    if (spec.revision?.mode === "inpaint") {
+    if (spec.revision?.engine === "pro-flash") {
+      const { sourceWidth: width, sourceHeight: height, mode: mode2 } = spec.revision;
+      if (width != null && height != null && (width < 32 || height < 32 || width > 256 || height > 256 || width % 4 || height % 4)) {
+        throw new Error(
+          `PixelLab pro-flash ${mode2} source is ${width}x${height}; the API takes 32 to 256 pixels per side, in multiples of 4`
+        );
+      }
+      if (spec.revision.strength != null) {
+        throw new Error(`PixelLab pro-flash ${mode2} takes no strength; the edit applies in full`);
+      }
+    } else if (spec.revision?.mode === "inpaint") {
       const { sourceWidth: width, sourceHeight: height } = spec.revision;
       if (width != null && height != null && (width < 32 || height < 32 || width > 512 || height > 512)) {
         throw new Error(`PixelLab inpaint source is ${width}x${height}; the API takes 32 to 512 pixels per side`);
@@ -3548,6 +3657,19 @@ var PixelLabProvider = class _PixelLabProvider {
         `PixelLab uiAsset is ${spec.width}x${spec.height}; the API takes 192 to 688 pixels per side (the exact ceiling also depends on aspect ratio \u2014 square tops out at 512, 16:9 at 688x384, 9:16 at 384x688, 4:3 at 600x448, 3:4 at 448x600)`
       );
     }
+    if (spec.generator === "imageProFlash") {
+      if (spec.width < 16 || spec.height < 16 || spec.width > 256 || spec.height > 256 || spec.width % 4 || spec.height % 4) {
+        throw new Error(
+          `PixelLab imageProFlash is ${spec.width}x${spec.height}; the API takes 16 to 256 pixels per side, in multiples of 4`
+        );
+      }
+      if (styleImages.length > 1) {
+        throw new Error("PixelLab imageProFlash takes one style image; list at most one styleImages entry");
+      }
+      if (spec.styleTraits && !styleImages.length) {
+        throw new Error("PixelLab imageProFlash: styleTraits choose what a style image lends; add a styleImages entry or drop them");
+      }
+    }
     if (spec.generator === "uiElement" && (spec.width < 16 || spec.height < 16 || spec.width > 792 || spec.height > 688)) {
       throw new Error(
         `PixelLab uiElement is ${spec.width}x${spec.height}; the API takes 16 to 792 wide and 16 to 688 tall (the exact ceiling depends on aspect ratio \u2014 square tops out at 512, 16:9 at 688x384)`
@@ -3901,7 +4023,8 @@ var PixelLabProvider = class _PixelLabProvider {
         concept: character.concept ? readPose(spec, "concept image", character.concept) : void 0,
         styleCharacterId: character.styleAnchor ? requireStyleObjectId(spec, context) : void 0,
         styleReferenceSize: styleImage ? { width: styleImage.width, height: styleImage.height } : void 0,
-        styleTraits: character.styleTraits
+        styleTraits: character.styleTraits,
+        sourceImageId: character.mode === "pro-flash" ? context?.referenceSourceImageId : void 0
       });
       return { jobId: res2.character_id, metadata: { character: { kind: "base", characterId: res2.character_id, mode: character.mode, directions: character.directions, backgroundJobId: res2.background_job_id } } };
     }
@@ -4036,7 +4159,8 @@ var PixelLabProvider = class _PixelLabProvider {
         reference: object.reference ? readPose(spec, "reference sprite", object.reference) : void 0,
         styleReference: styleImage ? { base64: styleImage.base64, format: styleImage.format } : void 0,
         styleReferenceSize: styleImage ? { width: styleImage.width, height: styleImage.height } : void 0,
-        styleTraits: object.styleTraits
+        styleTraits: object.styleTraits,
+        sourceImageId: context?.referenceSourceImageId
       });
       return { jobId: res2.object_id, metadata: { objectPro: { kind: "base", objectId: res2.object_id, directions: object.directions, backgroundJobId: res2.background_job_id } } };
     }
@@ -4335,6 +4459,19 @@ var PixelLabProvider = class _PixelLabProvider {
       });
       return { jobId: res2.ui_asset_id, metadata: { backgroundJobId: res2.background_job_id } };
     }
+    if (spec.generator === "imageProFlash") {
+      const style = styleImages[0];
+      const res2 = await this.client.createImageProFlash({
+        description: spec.prompt,
+        width: spec.width,
+        height: spec.height,
+        noBackground: spec.noBackground,
+        seed: spec.seed,
+        styleImage: style ? { image: { base64: style.base64, format: style.format }, width: style.width, height: style.height } : void 0,
+        styleTraits: spec.styleTraits
+      });
+      return { jobId: res2.background_job_id, metadata: { imageProFlash: proFlashRecord(res2) } };
+    }
     if (spec.generator === "uiElement") {
       const concept = styleImages[0];
       const res2 = await this.client.generateUiV2({
@@ -4488,6 +4625,32 @@ var PixelLabProvider = class _PixelLabProvider {
     const width = revision.sourceWidth;
     const height = revision.sourceHeight;
     const roles = revision.sourceMembers?.map((member) => member.role);
+    if (revision.engine === "pro-flash") {
+      if (revision.mode === "inpaint") {
+        if (!revision.maskFile || !revision.maskSha256 || !revision.maskFormat) {
+          throw new Error(`${spec.styleId}/${spec.assetId}: revision mask is not ready`);
+        }
+        const maskBytes = readFileSync(revision.maskFile);
+        if (sha256(maskBytes) !== revision.maskSha256) {
+          throw new Error(`${spec.styleId}/${spec.assetId}: revision mask changed after the manifest was resolved`);
+        }
+        const res3 = await this.client.inpaintImageProFlash({
+          image,
+          maskImage: { base64: maskBytes.toString("base64"), format: revision.maskFormat },
+          description: spec.prompt,
+          noBackground: spec.noBackground,
+          seed: spec.seed
+        });
+        return { jobId: res3.background_job_id, metadata: { imageProFlash: proFlashRecord(res3) } };
+      }
+      const res2 = await this.client.editImageProFlash({
+        image,
+        description: spec.prompt,
+        noBackground: spec.noBackground,
+        seed: spec.seed
+      });
+      return { jobId: res2.background_job_id, metadata: { imageProFlash: proFlashRecord(res2) } };
+    }
     if (revision.mode === "inpaint") {
       if (!revision.maskFile || !revision.maskSha256 || !revision.maskFormat) {
         throw new Error(`${spec.styleId}/${spec.assetId}: revision mask is not ready`);
@@ -4652,6 +4815,7 @@ var PixelLabProvider = class _PixelLabProvider {
       return this.pollAnimateRevision(jobId, context);
     }
     if (context?.spec?.revision) return this.pollRevision(jobId);
+    if (generator === "imageProFlash") return this.pollRevision(jobId);
     if (generator === "pixflux") {
       const file = path.join(_PixelLabProvider.cacheDir(), `${jobId}.png`);
       if (existsSync(file)) {
@@ -5232,6 +5396,13 @@ function readPose(spec, what, image) {
   }
   return { base64: bytes.toString("base64"), format: image.format };
 }
+function proFlashRecord(res) {
+  return {
+    imageId: res.image_id,
+    sourceImageId: res.source_image_id,
+    ...res.estimated_generations != null ? { estimatedGenerations: res.estimated_generations } : {}
+  };
+}
 function editAnimationFrameCeiling(width, height) {
   const side = Math.max(width, height);
   if (side <= 64) return 16;
@@ -6435,6 +6606,11 @@ var ComfyUIProvider = class _ComfyUIProvider {
       throw new Error("ComfyUI providerOptions.frames requires generator: frames");
     }
     if (spec.revision) {
+      if (spec.revision.engine) {
+        throw new Error(
+          `ComfyUI has no "${spec.revision.engine}" revision engine; that selects PixelLab's Pro Flash edit/inpaint endpoints. Drop engine to run the revision through this style's own workflow.`
+        );
+      }
       if (spec.revision.sourceMembers) {
         throw new Error(
           `ComfyUI revisions read one source image; ${spec.revision.sourceAssetId} is a ${spec.revision.sourceMembers.length}-member set (directions or frames)`
@@ -8032,6 +8208,7 @@ async function resolveSpecs(loaded, filter) {
         uiPieces: generator === "uiAsset" ? asset.pieces : void 0,
         uiElements: generator === "uiAsset" ? asset.elements : void 0,
         uiColorPalette: generator === "uiAsset" || generator === "uiElement" ? style.uiColorPalette : void 0,
+        ...generator === "imageProFlash" && style.styleTraits ? { styleTraits: style.styleTraits } : {},
         palette: style.palette,
         enforcePalette: style.enforcePalette,
         noBackground: style.noBackground,
@@ -8315,7 +8492,8 @@ async function resolveSpecs(loaded, filter) {
             lastFrameFormat: lastFrame?.format ?? null
           } : {},
           ...asset.revision.direction ? { direction: asset.revision.direction } : {},
-          ...asset.revision.enhancePrompt == null ? {} : { enhancePrompt: asset.revision.enhancePrompt }
+          ...asset.revision.enhancePrompt == null ? {} : { enhancePrompt: asset.revision.enhancePrompt },
+          ...asset.revision.engine ? { engine: asset.revision.engine } : {}
         };
       }
       if (asset.batch) {
@@ -13087,7 +13265,8 @@ async function submit(provider, loaded, items, lock, lockPath, opts = {}) {
         ...spec.revision.fps == null ? {} : { fps: spec.revision.fps },
         ...spec.revision.lastFrameSha256 ? { lastFrameSha256: spec.revision.lastFrameSha256 } : {},
         ...spec.revision.direction ? { direction: spec.revision.direction } : {},
-        ...spec.revision.enhancePrompt == null ? {} : { enhancePrompt: spec.revision.enhancePrompt }
+        ...spec.revision.enhancePrompt == null ? {} : { enhancePrompt: spec.revision.enhancePrompt },
+        ...spec.revision.engine ? { engine: spec.revision.engine } : {}
       } : null,
       outfit: spec.character?.kind === "outfit" && outfitParentEntry ? {
         sourceAssetId: spec.character.parentAssetId,
@@ -13131,8 +13310,10 @@ async function submit(provider, loaded, items, lock, lockPath, opts = {}) {
         path: currentEntryOutputPath(parentEntry, spec.character.parentSpec, index),
         role: output.role
       })) : void 0;
+      const referenceSourceImageId = ownedReferenceImageId(spec, lock, provider.id);
       const { jobId, metadata } = await provider.submit(spec, refs, {
         ...previousJobId ? { previousJobId } : {},
+        ...referenceSourceImageId ? { referenceSourceImageId } : {},
         ...parentEntry?.objectId ? { parentObjectId: parentEntry.objectId } : {},
         ...anchorEntry?.objectId ? { styleObjectId: anchorEntry.objectId } : {},
         ...parentOutputs ? { parentOutputs } : {},
@@ -13199,6 +13380,17 @@ async function submit(provider, loaded, items, lock, lockPath, opts = {}) {
   }
   return { submitted, failed, spent, unit };
 }
+function ownedReferenceImageId(spec, lock, providerId) {
+  const sha2562 = spec.character?.kind === "base" && spec.character.mode === "pro-flash" ? spec.character.reference?.south?.sha256 : spec.objectPro?.kind === "base" ? spec.objectPro.reference?.sha256 : void 0;
+  if (!sha2562) return void 0;
+  for (const entry of Object.values(lock.entries)) {
+    if (entry.provider !== providerId || entry.generator !== "imageProFlash" || entry.status !== "downloaded") continue;
+    if (entry.outputs.length !== 1 || entry.outputs[0].sha256 !== sha2562) continue;
+    const recorded = entry.providerMetadata?.[providerId]?.imageProFlash;
+    if (typeof recorded?.sourceImageId === "string" && recorded.sourceImageId) return recorded.sourceImageId;
+  }
+  return void 0;
+}
 
 // src/pipeline/poll.ts
 var sleep2 = (ms) => new Promise((r) => setTimeout(r, ms));