pixelkiln 0.84.0 → 0.85.0

package/dist/index.d.cts

@@ -14355,6 +14355,19 @@ interface ScenarioOptions {
     projectId?: string;
     /** Additional model-specific JSON inputs that cannot replace PixelKiln-owned intent. */
     parameters?: Record<string, unknown>;
+    /**
+     * The model input that takes images: a style's `styleImages` and a
+     * revision's parent are uploaded to Scenario and sent here as asset ids.
+     * Most image models call it `referenceImages` and take a list.
+     */
+    referenceParameter?: string;
+    /** False for a model whose reference input takes one image rather than a list. */
+    referenceArray?: boolean;
+}
+/** What the adapter needs to put one local image into a generation request. */
+interface ReferenceImage {
+    base64: string;
+    format: "png" | "jpeg";
 }
 interface ScenarioQuote {
     total: number;
@@ -14391,6 +14404,12 @@ declare class ScenarioClient {
     constructor(apiKey: string | undefined, apiSecret: string | undefined, baseUrl?: string, request?: typeof fetch, retry?: RetryOptions);
     quote(modelId: string, body: Record<string, unknown>, projectId?: string): Promise<ScenarioQuote>;
     submit(modelId: string, body: Record<string, unknown>, projectId?: string): Promise<string>;
+    /**
+     * Uploads one image (POST /assets) and returns its asset id, which a model's
+     * reference input takes. Free, and idempotent per image: the id is kept by
+     * content hash so a rerun does not upload the same bytes again.
+     */
+    uploadImage(image: ReferenceImage, projectId?: string): Promise<string>;
     job(id: string, projectId?: string): Promise<ScenarioJob>;
     asset(id: string, projectId?: string): Promise<ScenarioAsset>;
     download(url: string): Promise<Buffer>;
@@ -14407,6 +14426,12 @@ declare class ScenarioProvider implements Provider {
     static forOffline(): ScenarioProvider;
     static forDownloads(): ScenarioProvider;
     supports(generator: Generator): boolean;
+    /**
+     * An edit is a generation with the parent as a reference image, which the
+     * editing models (GPT Image, Gemini, FLUX) take. Masked inpainting and the
+     * PixelLab-specific modes have no common Scenario input.
+     */
+    supportsRevision(mode: RevisionMode): boolean;
     estimate(spec: ResolvedSpec): CostEstimate;
     validate(spec: ResolvedSpec, styleImages: ResolvedStyleImage[]): void;
     rateLimit(): RateLimit;

package/dist/index.d.ts

@@ -14355,6 +14355,19 @@ interface ScenarioOptions {
     projectId?: string;
     /** Additional model-specific JSON inputs that cannot replace PixelKiln-owned intent. */
     parameters?: Record<string, unknown>;
+    /**
+     * The model input that takes images: a style's `styleImages` and a
+     * revision's parent are uploaded to Scenario and sent here as asset ids.
+     * Most image models call it `referenceImages` and take a list.
+     */
+    referenceParameter?: string;
+    /** False for a model whose reference input takes one image rather than a list. */
+    referenceArray?: boolean;
+}
+/** What the adapter needs to put one local image into a generation request. */
+interface ReferenceImage {
+    base64: string;
+    format: "png" | "jpeg";
 }
 interface ScenarioQuote {
     total: number;
@@ -14391,6 +14404,12 @@ declare class ScenarioClient {
     constructor(apiKey: string | undefined, apiSecret: string | undefined, baseUrl?: string, request?: typeof fetch, retry?: RetryOptions);
     quote(modelId: string, body: Record<string, unknown>, projectId?: string): Promise<ScenarioQuote>;
     submit(modelId: string, body: Record<string, unknown>, projectId?: string): Promise<string>;
+    /**
+     * Uploads one image (POST /assets) and returns its asset id, which a model's
+     * reference input takes. Free, and idempotent per image: the id is kept by
+     * content hash so a rerun does not upload the same bytes again.
+     */
+    uploadImage(image: ReferenceImage, projectId?: string): Promise<string>;
     job(id: string, projectId?: string): Promise<ScenarioJob>;
     asset(id: string, projectId?: string): Promise<ScenarioAsset>;
     download(url: string): Promise<Buffer>;
@@ -14407,6 +14426,12 @@ declare class ScenarioProvider implements Provider {
     static forOffline(): ScenarioProvider;
     static forDownloads(): ScenarioProvider;
     supports(generator: Generator): boolean;
+    /**
+     * An edit is a generation with the parent as a reference image, which the
+     * editing models (GPT Image, Gemini, FLUX) take. Masked inpainting and the
+     * PixelLab-specific modes have no common Scenario input.
+     */
+    supportsRevision(mode: RevisionMode): boolean;
     estimate(spec: ResolvedSpec): CostEstimate;
     validate(spec: ResolvedSpec, styleImages: ResolvedStyleImage[]): void;
     rateLimit(): RateLimit;