pixelkiln 0.48.0 → 0.49.0

package/dist/index.d.cts

@@ -8591,6 +8591,52 @@ declare class PixelLabClient {
         total: number;
     }>;
     iterateCharacters(pageSize?: number): AsyncGenerator<PixelLabCharacter>;
+    /**
+     * Masked inpaint, PixelLab's `/inpaint-v3` (the endpoint its own docs list
+     * first in the Inpaint section, its convention for "reach for this by
+     * default"). Unlike the rest of this client, this method's shape is taken
+     * from the OpenAPI spec, not exercised against a live account: the request
+     * side is exact (`InpaintV3Request`), but a completed job's `last_response`
+     * has no documented example for this endpoint (the spec's only worked
+     * example is a character job's shape). `pollRevision` in pixellab.ts reads
+     * it defensively and fails loudly on an unrecognized shape rather than
+     * guessing.
+     *
+     * `crop_to_mask` defaults true upstream (confirmed in the schema): PixelLab
+     * otherwise blends generated pixels outside the mask edge to "fit
+     * naturally," which is the opposite of what a mask boundary is for.
+     */
+    inpaintV3(args: {
+        description: string;
+        image: Base64Image;
+        width: number;
+        height: number;
+        maskImage: Base64Image;
+        noBackground?: boolean;
+        cropToMask?: boolean;
+        seed?: number;
+    }): Promise<{
+        background_job_id: string;
+        status: string;
+    }>;
+    /**
+     * Whole-image edit with no mask, PixelLab's `/edit-images-v2`. Same
+     * not-yet-live-verified caveat as `inpaintV3` above. `edit_images` takes an
+     * array (the endpoint supports editing several images with one
+     * instruction); pixelkiln's `revision` model is one parent per child, so
+     * this always sends exactly one.
+     */
+    editImagesV2(args: {
+        description: string;
+        image: Base64Image;
+        width: number;
+        height: number;
+        noBackground?: boolean;
+        seed?: number;
+    }): Promise<{
+        background_job_id: string;
+        status: string;
+    }>;
     getBackgroundJob(jobId: string): Promise<{
         id: string;
         status: string;
@@ -8637,6 +8683,13 @@ declare class PixelLabProvider implements Provider {
     /** Capability and cost estimation only; makes no network request itself. */
     static forOffline(): PixelLabProvider;
     supports(generator: Generator): boolean;
+    /**
+     * `inpaint` (`/inpaint-v3`, a mask) and `image-to-image` (`/edit-images-v2`,
+     * no mask) both exist on PixelLab. `outpaint` does not: there is no
+     * canvas-expansion endpoint in the API, matching docs/REVISIONS.md's note
+     * that no provider ships a tested outpaint path yet.
+     */
+    supportsRevision(mode: RevisionMode): boolean;
     /** PixelLab's own constraints: submissions must be >2s apart, and
      *  background jobs in flight are capped by subscription tier (Tier 1=8,
      *  Tier 2=10, Tier 3=20); 8 is the safe floor across every tier. */
@@ -8673,6 +8726,15 @@ declare class PixelLabProvider implements Provider {
         jobId: string;
         metadata?: Record<string, unknown>;
     }>;
+    /**
+     * `inpaint` reads the mask as PixelLab's own convention: white marks the
+     * area to generate, black the area to preserve (`InpaintV3Request`'s own
+     * field description). Unlike ComfyUI's revision graph, there is no
+     * configurable side to this — document it as fixed rather than leave an
+     * agent to guess, the way docs/REVISIONS.md tells a ComfyUI author to test
+     * their own graph.
+     */
+    private submitRevision;
     /**
      * What a background job actually billed, once its own record is still
      * around to ask; see `billedFromUsage`. A stale or already-cleaned-up job
@@ -8681,6 +8743,21 @@ declare class PixelLabProvider implements Provider {
      */
     private billedForJob;
     poll(jobId: string, generator: Generator, context?: PollContext): Promise<JobState>;
+    /**
+     * `/inpaint-v3` and `/edit-images-v2` both hand back a plain background
+     * job with no resource of its own, polled generically at
+     * `GET /background-jobs/{id}`. What a *completed* job's `last_response`
+     * actually contains is not documented for either endpoint: the OpenAPI
+     * spec's only worked example of that field is a character job's shape
+     * (`character_id`, `uploaded_directions`, ...), not an inpaint or edit
+     * job's. This reads every image shape seen elsewhere in this client
+     * (a nested `{image: {base64, format}}`, a bare `{base64, format}`, or a
+     * hosted URL under a handful of plausible keys) and fails loudly, naming
+     * the keys it actually got, rather than guess wrong silently. Fixing a
+     * real completed response into this list is a one-line change once one is
+     * seen live.
+     */
+    private pollRevision;
     /**
      * Map objects need their own path because the `/map-objects/{id}` record is
      * deleted upstream roughly 8 hours after creation while the image survives in

package/dist/index.d.ts

@@ -8591,6 +8591,52 @@ declare class PixelLabClient {
         total: number;
     }>;
     iterateCharacters(pageSize?: number): AsyncGenerator<PixelLabCharacter>;
+    /**
+     * Masked inpaint, PixelLab's `/inpaint-v3` (the endpoint its own docs list
+     * first in the Inpaint section, its convention for "reach for this by
+     * default"). Unlike the rest of this client, this method's shape is taken
+     * from the OpenAPI spec, not exercised against a live account: the request
+     * side is exact (`InpaintV3Request`), but a completed job's `last_response`
+     * has no documented example for this endpoint (the spec's only worked
+     * example is a character job's shape). `pollRevision` in pixellab.ts reads
+     * it defensively and fails loudly on an unrecognized shape rather than
+     * guessing.
+     *
+     * `crop_to_mask` defaults true upstream (confirmed in the schema): PixelLab
+     * otherwise blends generated pixels outside the mask edge to "fit
+     * naturally," which is the opposite of what a mask boundary is for.
+     */
+    inpaintV3(args: {
+        description: string;
+        image: Base64Image;
+        width: number;
+        height: number;
+        maskImage: Base64Image;
+        noBackground?: boolean;
+        cropToMask?: boolean;
+        seed?: number;
+    }): Promise<{
+        background_job_id: string;
+        status: string;
+    }>;
+    /**
+     * Whole-image edit with no mask, PixelLab's `/edit-images-v2`. Same
+     * not-yet-live-verified caveat as `inpaintV3` above. `edit_images` takes an
+     * array (the endpoint supports editing several images with one
+     * instruction); pixelkiln's `revision` model is one parent per child, so
+     * this always sends exactly one.
+     */
+    editImagesV2(args: {
+        description: string;
+        image: Base64Image;
+        width: number;
+        height: number;
+        noBackground?: boolean;
+        seed?: number;
+    }): Promise<{
+        background_job_id: string;
+        status: string;
+    }>;
     getBackgroundJob(jobId: string): Promise<{
         id: string;
         status: string;
@@ -8637,6 +8683,13 @@ declare class PixelLabProvider implements Provider {
     /** Capability and cost estimation only; makes no network request itself. */
     static forOffline(): PixelLabProvider;
     supports(generator: Generator): boolean;
+    /**
+     * `inpaint` (`/inpaint-v3`, a mask) and `image-to-image` (`/edit-images-v2`,
+     * no mask) both exist on PixelLab. `outpaint` does not: there is no
+     * canvas-expansion endpoint in the API, matching docs/REVISIONS.md's note
+     * that no provider ships a tested outpaint path yet.
+     */
+    supportsRevision(mode: RevisionMode): boolean;
     /** PixelLab's own constraints: submissions must be >2s apart, and
      *  background jobs in flight are capped by subscription tier (Tier 1=8,
      *  Tier 2=10, Tier 3=20); 8 is the safe floor across every tier. */
@@ -8673,6 +8726,15 @@ declare class PixelLabProvider implements Provider {
         jobId: string;
         metadata?: Record<string, unknown>;
     }>;
+    /**
+     * `inpaint` reads the mask as PixelLab's own convention: white marks the
+     * area to generate, black the area to preserve (`InpaintV3Request`'s own
+     * field description). Unlike ComfyUI's revision graph, there is no
+     * configurable side to this — document it as fixed rather than leave an
+     * agent to guess, the way docs/REVISIONS.md tells a ComfyUI author to test
+     * their own graph.
+     */
+    private submitRevision;
     /**
      * What a background job actually billed, once its own record is still
      * around to ask; see `billedFromUsage`. A stale or already-cleaned-up job
@@ -8681,6 +8743,21 @@ declare class PixelLabProvider implements Provider {
      */
     private billedForJob;
     poll(jobId: string, generator: Generator, context?: PollContext): Promise<JobState>;
+    /**
+     * `/inpaint-v3` and `/edit-images-v2` both hand back a plain background
+     * job with no resource of its own, polled generically at
+     * `GET /background-jobs/{id}`. What a *completed* job's `last_response`
+     * actually contains is not documented for either endpoint: the OpenAPI
+     * spec's only worked example of that field is a character job's shape
+     * (`character_id`, `uploaded_directions`, ...), not an inpaint or edit
+     * job's. This reads every image shape seen elsewhere in this client
+     * (a nested `{image: {base64, format}}`, a bare `{base64, format}`, or a
+     * hosted URL under a handful of plausible keys) and fails loudly, naming
+     * the keys it actually got, rather than guess wrong silently. Fixing a
+     * real completed response into this list is a one-line change once one is
+     * seen live.
+     */
+    private pollRevision;
     /**
      * Map objects need their own path because the `/map-objects/{id}` record is
      * deleted upstream roughly 8 hours after creation while the image survives in

package/dist/index.js

@@ -944,6 +944,10 @@ var TilesProSchema = z2.object({
   kind: z2.string().nullable().default(null),
   tile_rules: z2.record(z2.unknown()).nullable().optional()
 }).passthrough();
+var RevisionJobSubmitSchema = z2.object({
+  background_job_id: z2.string().min(1),
+  status: z2.string().default("processing")
+}).passthrough();
 var PixelLabObjectSchema = z2.object({
   id: z2.string().min(1),
   name: z2.string().nullable().default(null),
@@ -1415,6 +1419,59 @@ var PixelLabClient = class {
       if (page.characters.length === 0 || offset >= page.total) return;
     }
   }
+  /**
+   * Masked inpaint, PixelLab's `/inpaint-v3` (the endpoint its own docs list
+   * first in the Inpaint section, its convention for "reach for this by
+   * default"). Unlike the rest of this client, this method's shape is taken
+   * from the OpenAPI spec, not exercised against a live account: the request
+   * side is exact (`InpaintV3Request`), but a completed job's `last_response`
+   * has no documented example for this endpoint (the spec's only worked
+   * example is a character job's shape). `pollRevision` in pixellab.ts reads
+   * it defensively and fails loudly on an unrecognized shape rather than
+   * guessing.
+   *
+   * `crop_to_mask` defaults true upstream (confirmed in the schema): PixelLab
+   * otherwise blends generated pixels outside the mask edge to "fit
+   * naturally," which is the opposite of what a mask boundary is for.
+   */
+  async inpaintV3(args) {
+    const size = { width: args.width, height: args.height };
+    const body = {
+      description: args.description,
+      inpainting_image: { image: args.image, size },
+      mask_image: { image: args.maskImage, size }
+    };
+    if (args.noBackground != null) body.no_background = args.noBackground;
+    if (args.cropToMask != null) body.crop_to_mask = args.cropToMask;
+    if (args.seed != null) body.seed = args.seed;
+    return validateResponse(
+      RevisionJobSubmitSchema,
+      await this.request("/inpaint-v3", { method: "POST", body: JSON.stringify(body) }),
+      "inpaint-v3"
+    );
+  }
+  /**
+   * Whole-image edit with no mask, PixelLab's `/edit-images-v2`. Same
+   * not-yet-live-verified caveat as `inpaintV3` above. `edit_images` takes an
+   * array (the endpoint supports editing several images with one
+   * instruction); pixelkiln's `revision` model is one parent per child, so
+   * this always sends exactly one.
+   */
+  async editImagesV2(args) {
+    const body = {
+      method: "edit_with_text",
+      description: args.description,
+      edit_images: [{ image: args.image, width: args.width, height: args.height }],
+      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;
+    return validateResponse(
+      RevisionJobSubmitSchema,
+      await this.request("/edit-images-v2", { method: "POST", body: JSON.stringify(body) }),
+      "edit-images-v2"
+    );
+  }
   async getBackgroundJob(jobId) {
     const raw = await this.request(`/background-jobs/${encodeURIComponent(jobId)}`);
     return validateResponse(BackgroundJobSchema, raw, "background-jobs/{id}");
@@ -2196,6 +2253,15 @@ var PixelLabProvider = class _PixelLabProvider {
   supports(generator) {
     return generator === "1dir" || generator === "map" || generator === "pixflux" || generator === "tiles" || generator === "character";
   }
+  /**
+   * `inpaint` (`/inpaint-v3`, a mask) and `image-to-image` (`/edit-images-v2`,
+   * no mask) both exist on PixelLab. `outpaint` does not: there is no
+   * canvas-expansion endpoint in the API, matching docs/REVISIONS.md's note
+   * that no provider ships a tested outpaint path yet.
+   */
+  supportsRevision(mode2) {
+    return mode2 === "inpaint" || mode2 === "image-to-image";
+  }
   /** PixelLab's own constraints: submissions must be >2s apart, and
    *  background jobs in flight are capped by subscription tier (Tier 1=8,
    *  Tier 2=10, Tier 3=20); 8 is the safe floor across every tier. */
@@ -2216,6 +2282,11 @@ var PixelLabProvider = class _PixelLabProvider {
     return dir;
   }
   estimate(spec) {
+    if (spec.revision) {
+      const width = spec.revision.sourceWidth ?? spec.width;
+      const height = spec.revision.sourceHeight ?? spec.height;
+      return { unit: "generations", amount: generationCost(width, height, "1dir"), candidates: 1 };
+    }
     if (spec.generator === "tiles") {
       return { unit: "generations", amount: spec.cost, candidates: spec.candidates };
     }
@@ -2229,6 +2300,12 @@ var PixelLabProvider = class _PixelLabProvider {
     };
   }
   validate(spec, styleImages) {
+    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`);
+      }
+    }
     if (spec.generator === "1dir" && (spec.width < 32 || spec.width > 256)) {
       throw new Error("PixelLab 1dir dimensions must be between 32 and 256 pixels");
     }
@@ -2578,6 +2655,7 @@ var PixelLabProvider = class _PixelLabProvider {
   }
   async submit(spec, styleImages, context) {
     this.validate(spec, styleImages);
+    if (spec.revision) return this.submitRevision(spec);
     if (spec.generator === "character") return this.submitCharacter(spec, styleImages, context);
     if (spec.generator === "pixflux") {
       const swatch = spec.palette.length ? paletteSwatch(spec.palette).toString("base64") : void 0;
@@ -2629,6 +2707,60 @@ var PixelLabProvider = class _PixelLabProvider {
     });
     return { jobId: res.object_id, metadata: { backgroundJobId: res.background_job_id } };
   }
+  /**
+   * `inpaint` reads the mask as PixelLab's own convention: white marks the
+   * area to generate, black the area to preserve (`InpaintV3Request`'s own
+   * field description). Unlike ComfyUI's revision graph, there is no
+   * configurable side to this — document it as fixed rather than leave an
+   * agent to guess, the way docs/REVISIONS.md tells a ComfyUI author to test
+   * their own graph.
+   */
+  async submitRevision(spec) {
+    const revision = spec.revision;
+    if (!revision.sourceSha256 || !revision.sourceFormat || revision.sourceWidth == null || revision.sourceHeight == null) {
+      throw new Error(`${spec.styleId}/${spec.assetId}: revision source is not ready`);
+    }
+    const sourceBytes = readFileSync(revision.sourceFile);
+    if (sha256(sourceBytes) !== revision.sourceSha256) {
+      throw new Error(`${spec.styleId}/${spec.assetId}: revision source changed after the manifest was resolved`);
+    }
+    const image = { base64: sourceBytes.toString("base64"), format: revision.sourceFormat };
+    const width = revision.sourceWidth;
+    const height = revision.sourceHeight;
+    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 res2 = await this.client.inpaintV3({
+        description: spec.prompt,
+        image,
+        width,
+        height,
+        maskImage: { base64: maskBytes.toString("base64"), format: revision.maskFormat },
+        noBackground: spec.noBackground,
+        seed: spec.seed
+      });
+      return { jobId: res2.background_job_id };
+    }
+    if (revision.strength != null) {
+      throw new Error(
+        `${spec.styleId}/${spec.assetId}: PixelLab image-to-image revisions take no strength; edit-images-v2 always applies the full instruction`
+      );
+    }
+    const res = await this.client.editImagesV2({
+      description: spec.prompt,
+      image,
+      width,
+      height,
+      noBackground: spec.noBackground,
+      seed: spec.seed
+    });
+    return { jobId: 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
@@ -2645,6 +2777,7 @@ var PixelLabProvider = class _PixelLabProvider {
     }
   }
   async poll(jobId, generator, context) {
+    if (context?.spec?.revision) return this.pollRevision(jobId);
     if (generator === "pixflux") {
       const file = path.join(_PixelLabProvider.cacheDir(), `${jobId}.png`);
       if (existsSync(file)) {
@@ -2675,6 +2808,58 @@ var PixelLabProvider = class _PixelLabProvider {
       etaSeconds: obj.eta_seconds ?? null
     };
   }
+  /**
+   * `/inpaint-v3` and `/edit-images-v2` both hand back a plain background
+   * job with no resource of its own, polled generically at
+   * `GET /background-jobs/{id}`. What a *completed* job's `last_response`
+   * actually contains is not documented for either endpoint: the OpenAPI
+   * spec's only worked example of that field is a character job's shape
+   * (`character_id`, `uploaded_directions`, ...), not an inpaint or edit
+   * job's. This reads every image shape seen elsewhere in this client
+   * (a nested `{image: {base64, format}}`, a bare `{base64, format}`, or a
+   * hosted URL under a handful of plausible keys) and fails loudly, naming
+   * the keys it actually got, rather than guess wrong silently. Fixing a
+   * real completed response into this list is a one-line change once one is
+   * seen live.
+   */
+  async pollRevision(jobId) {
+    const job = await this.client.getBackgroundJob(jobId);
+    if (job.status === "failed") return { status: "failed", error: "revision job failed upstream" };
+    if (job.status !== "completed") return { status: "processing" };
+    const billed = billedFromUsage(job.usage);
+    const done = job.last_response ?? {};
+    const urlKeys = ["image_url", "download_url", "url", "output_url"];
+    for (const key of urlKeys) {
+      const url = done[key];
+      if (typeof url === "string" && url) {
+        return { status: "ready", objectId: jobId, sourceUrl: url, sources: [{ url }], billed };
+      }
+    }
+    const imageKeys = ["image", "output_image", "result_image", "edited_image"];
+    for (const key of imageKeys) {
+      const candidate = done[key];
+      const base64 = extractBase64(candidate);
+      if (base64) {
+        const file = path.join(_PixelLabProvider.cacheDir(), `${jobId}.png`);
+        writeFileSync(file, Buffer.from(base64, "base64"));
+        const sourceUrl = `file://${file}`;
+        return { status: "ready", objectId: jobId, sourceUrl, sources: [{ url: sourceUrl }], billed };
+      }
+    }
+    if (Array.isArray(done.images) && done.images.length) {
+      const base64 = extractBase64(done.images[0]);
+      if (base64) {
+        const file = path.join(_PixelLabProvider.cacheDir(), `${jobId}.png`);
+        writeFileSync(file, Buffer.from(base64, "base64"));
+        const sourceUrl = `file://${file}`;
+        return { status: "ready", objectId: jobId, sourceUrl, sources: [{ url: sourceUrl }], billed };
+      }
+    }
+    return {
+      status: "failed",
+      error: `Invalid PixelLab response for revision job ${jobId}: completed with no recognized image field (got: ${Object.keys(done).join(", ") || "no keys"}); update pollRevision in src/providers/pixellab.ts with the real shape`
+    };
+  }
   /**
    * Map objects need their own path because the `/map-objects/{id}` record is
    * deleted upstream roughly 8 hours after creation while the image survives in
@@ -2866,6 +3051,15 @@ function firstUrl(urls) {
   if (!urls) return null;
   return Object.values(urls).find((u) => typeof u === "string") ?? null;
 }
+function extractBase64(value) {
+  if (typeof value === "string" && value) return value;
+  if (value && typeof value === "object") {
+    const obj = value;
+    if (typeof obj.base64 === "string" && obj.base64) return obj.base64;
+    if (obj.image) return extractBase64(obj.image);
+  }
+  return null;
+}
 function readReference(spec, reference) {
   const images = {};
   for (const [direction, image] of Object.entries(reference)) {
@@ -12037,7 +12231,9 @@ function describeHistory(media, entry, cacheDir) {
       retiredAt: generation.retiredAt,
       outputs,
       cached: outputs.length > 0 && outputs.every((output) => output.url !== null),
-      upstreamUrl: generation.provider === "pixellab" ? pixelLabObjectUrl(generation.generator, generation.objectId) : null
+      // A revision's jobId is a plain background job id, not a PixelLab
+      // account object: there is no `/create-object` page to point at.
+      upstreamUrl: generation.provider === "pixellab" && !entry.revision ? pixelLabObjectUrl(generation.generator, generation.objectId) : null
     };
   });
 }
@@ -12302,7 +12498,7 @@ async function buildGallerySnapshot(opts) {
       editChanged,
       editStatus,
       editMeta,
-      upstreamUrl: entry?.provider === "pixellab" ? pixelLabObjectUrl(entry.generator, entry.objectId) : null,
+      upstreamUrl: entry?.provider === "pixellab" && !spec.revision ? pixelLabObjectUrl(entry.generator, entry.objectId) : null,
       refreshable: Boolean(entry && entry.status === "downloaded" && entry.outputs.length && (entry.sourceUrls?.length || entry.sourceUrl)),
       history: entry ? describeHistory(media, entry, cacheDir) : [],
       tags: spec.tags,
@@ -12366,7 +12562,7 @@ async function buildGallerySnapshot(opts) {
       editChanged: [],
       editStatus: null,
       editMeta: null,
-      upstreamUrl: entry.provider === "pixellab" ? pixelLabObjectUrl(entry.generator, entry.objectId) : null,
+      upstreamUrl: entry.provider === "pixellab" && !entry.revision ? pixelLabObjectUrl(entry.generator, entry.objectId) : null,
       refreshable: false,
       history: describeHistory(media, entry, cacheDir),
       tags: [],