pixelkiln 0.22.0 → 0.24.0

package/dist/index.d.ts

@@ -1656,6 +1656,15 @@ declare const AssetSchema: z.ZodEffects<z.ZodObject<{
      * that wasn't. `prompt` still records what was asked for.
      */
     source: z.ZodOptional<z.ZodString>;
+    /**
+     * Per-style replacement for `source`, keyed by style id.
+     *
+     * A hand edit belongs to one generation: the same asset generated in two
+     * styles is two different pictures, so the touch-up of one must not be
+     * placed for the other. `pixelkiln edit` writes here when an asset is in
+     * more than one style, and to `source` when it is in exactly one.
+     */
+    sourceByStyle: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
     /** Controlled generation derived from another asset in the same style. */
     revision: z.ZodOptional<z.ZodEffects<z.ZodObject<{
         /** What kind of controlled change the provider workflow performs. */
@@ -1716,6 +1725,7 @@ declare const AssetSchema: z.ZodEffects<z.ZodObject<{
 }, "strict", z.ZodTypeAny, {
     tags: string[];
     prompt: string;
+    sourceByStyle: Record<string, string>;
     styles: string[];
     promptByStyle: Record<string, string>;
     providerInputs: Record<string, string | number | boolean | (string | number | boolean)[]>;
@@ -1743,6 +1753,7 @@ declare const AssetSchema: z.ZodEffects<z.ZodObject<{
     file?: string | undefined;
     cell?: [number, number] | undefined;
     source?: string | undefined;
+    sourceByStyle?: Record<string, string> | undefined;
     revision?: {
         mode: "image-to-image" | "inpaint" | "outpaint";
         from: string;
@@ -1756,6 +1767,7 @@ declare const AssetSchema: z.ZodEffects<z.ZodObject<{
 }>, {
     tags: string[];
     prompt: string;
+    sourceByStyle: Record<string, string>;
     styles: string[];
     promptByStyle: Record<string, string>;
     providerInputs: Record<string, string | number | boolean | (string | number | boolean)[]>;
@@ -1783,6 +1795,7 @@ declare const AssetSchema: z.ZodEffects<z.ZodObject<{
     file?: string | undefined;
     cell?: [number, number] | undefined;
     source?: string | undefined;
+    sourceByStyle?: Record<string, string> | undefined;
     revision?: {
         mode: "image-to-image" | "inpaint" | "outpaint";
         from: string;
@@ -2249,6 +2262,15 @@ declare const ManifestSchema: z.ZodObject<{
          * that wasn't. `prompt` still records what was asked for.
          */
         source: z.ZodOptional<z.ZodString>;
+        /**
+         * Per-style replacement for `source`, keyed by style id.
+         *
+         * A hand edit belongs to one generation: the same asset generated in two
+         * styles is two different pictures, so the touch-up of one must not be
+         * placed for the other. `pixelkiln edit` writes here when an asset is in
+         * more than one style, and to `source` when it is in exactly one.
+         */
+        sourceByStyle: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
         /** Controlled generation derived from another asset in the same style. */
         revision: z.ZodOptional<z.ZodEffects<z.ZodObject<{
             /** What kind of controlled change the provider workflow performs. */
@@ -2309,6 +2331,7 @@ declare const ManifestSchema: z.ZodObject<{
     }, "strict", z.ZodTypeAny, {
         tags: string[];
         prompt: string;
+        sourceByStyle: Record<string, string>;
         styles: string[];
         promptByStyle: Record<string, string>;
         providerInputs: Record<string, string | number | boolean | (string | number | boolean)[]>;
@@ -2336,6 +2359,7 @@ declare const ManifestSchema: z.ZodObject<{
         file?: string | undefined;
         cell?: [number, number] | undefined;
         source?: string | undefined;
+        sourceByStyle?: Record<string, string> | undefined;
         revision?: {
             mode: "image-to-image" | "inpaint" | "outpaint";
             from: string;
@@ -2349,6 +2373,7 @@ declare const ManifestSchema: z.ZodObject<{
     }>, {
         tags: string[];
         prompt: string;
+        sourceByStyle: Record<string, string>;
         styles: string[];
         promptByStyle: Record<string, string>;
         providerInputs: Record<string, string | number | boolean | (string | number | boolean)[]>;
@@ -2376,6 +2401,7 @@ declare const ManifestSchema: z.ZodObject<{
         file?: string | undefined;
         cell?: [number, number] | undefined;
         source?: string | undefined;
+        sourceByStyle?: Record<string, string> | undefined;
         revision?: {
             mode: "image-to-image" | "inpaint" | "outpaint";
             from: string;
@@ -2433,6 +2459,7 @@ declare const ManifestSchema: z.ZodObject<{
     assets: Record<string, {
         tags: string[];
         prompt: string;
+        sourceByStyle: Record<string, string>;
         styles: string[];
         promptByStyle: Record<string, string>;
         providerInputs: Record<string, string | number | boolean | (string | number | boolean)[]>;
@@ -2504,6 +2531,7 @@ declare const ManifestSchema: z.ZodObject<{
         file?: string | undefined;
         cell?: [number, number] | undefined;
         source?: string | undefined;
+        sourceByStyle?: Record<string, string> | undefined;
         revision?: {
             mode: "image-to-image" | "inpaint" | "outpaint";
             from: string;
@@ -3132,6 +3160,15 @@ declare const ManifestInputSchema: z.ZodObject<{
          * that wasn't. `prompt` still records what was asked for.
          */
         source: z.ZodOptional<z.ZodString>;
+        /**
+         * Per-style replacement for `source`, keyed by style id.
+         *
+         * A hand edit belongs to one generation: the same asset generated in two
+         * styles is two different pictures, so the touch-up of one must not be
+         * placed for the other. `pixelkiln edit` writes here when an asset is in
+         * more than one style, and to `source` when it is in exactly one.
+         */
+        sourceByStyle: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
         /** Controlled generation derived from another asset in the same style. */
         revision: z.ZodOptional<z.ZodEffects<z.ZodObject<{
             /** What kind of controlled change the provider workflow performs. */
@@ -3192,6 +3229,7 @@ declare const ManifestInputSchema: z.ZodObject<{
     }, "strict", z.ZodTypeAny, {
         tags: string[];
         prompt: string;
+        sourceByStyle: Record<string, string>;
         styles: string[];
         promptByStyle: Record<string, string>;
         providerInputs: Record<string, string | number | boolean | (string | number | boolean)[]>;
@@ -3219,6 +3257,7 @@ declare const ManifestInputSchema: z.ZodObject<{
         file?: string | undefined;
         cell?: [number, number] | undefined;
         source?: string | undefined;
+        sourceByStyle?: Record<string, string> | undefined;
         revision?: {
             mode: "image-to-image" | "inpaint" | "outpaint";
             from: string;
@@ -3232,6 +3271,7 @@ declare const ManifestInputSchema: z.ZodObject<{
     }>, {
         tags: string[];
         prompt: string;
+        sourceByStyle: Record<string, string>;
         styles: string[];
         promptByStyle: Record<string, string>;
         providerInputs: Record<string, string | number | boolean | (string | number | boolean)[]>;
@@ -3259,6 +3299,7 @@ declare const ManifestInputSchema: z.ZodObject<{
         file?: string | undefined;
         cell?: [number, number] | undefined;
         source?: string | undefined;
+        sourceByStyle?: Record<string, string> | undefined;
         revision?: {
             mode: "image-to-image" | "inpaint" | "outpaint";
             from: string;
@@ -3356,6 +3397,7 @@ declare const ManifestInputSchema: z.ZodObject<{
     assets: Record<string, {
         tags: string[];
         prompt: string;
+        sourceByStyle: Record<string, string>;
         styles: string[];
         promptByStyle: Record<string, string>;
         providerInputs: Record<string, string | number | boolean | (string | number | boolean)[]>;
@@ -3467,6 +3509,7 @@ declare const ManifestInputSchema: z.ZodObject<{
         file?: string | undefined;
         cell?: [number, number] | undefined;
         source?: string | undefined;
+        sourceByStyle?: Record<string, string> | undefined;
         revision?: {
             mode: "image-to-image" | "inpaint" | "outpaint";
             from: string;
@@ -6997,6 +7040,13 @@ declare function packStyle(lock: Lock, styleId: string, manifestDir: string, opt
     primaryOnly?: boolean;
     /** Approved manifest quality outputs keyed by asset id or role-qualified frame id. */
     sourceOverrides?: Record<string, string>;
+    /**
+     * Manifest `source` art keyed by asset id, manifest-relative. A hand edit
+     * or other post-processed file stands in for that asset's single output,
+     * and an asset with a source but no lock entry is packed from it — the
+     * same rule `mount` applies. Structural sets keep their lock outputs.
+     */
+    sources?: Record<string, string>;
 }): PackedSheet;
 interface MountPlacement extends SpriteInput {
     /** Grid cell this sprite owns, as [column, row]. */
@@ -7504,9 +7554,20 @@ interface GalleryOutput {
     mediaType: MediaType | null;
     exists: boolean;
     bytes: number | null;
+    /** File modification time, for telling an edit from the generation it started from. */
+    modifiedAt: string | null;
     /** Served only while the gallery runs; null when the file is missing. */
     url: string | null;
 }
+type HandEditStatus = 
+/** The edit file is byte-identical to the generated art. */
+"same"
+/** The author changed it. */
+ | "edited"
+/** The generated art changed after the edit was last saved. */
+ | "regenerated-since"
+/** The declared file is not on disk. */
+ | "missing";
 interface GalleryQuality {
     state: QualityProfileInspection["state"];
     reason: string;
@@ -7602,6 +7663,13 @@ interface GalleryItem {
     asset: Asset | null;
     /** Manifest-relative committed art placed instead of generated output. */
     source: string | null;
+    /**
+     * The hand edit that stands in for this generation, when the asset has both
+     * a lock entry and a `source`. Placed by mount and pack in place of the
+     * generated file, which stays on disk as the record.
+     */
+    edit: GalleryOutput | null;
+    editStatus: HandEditStatus | null;
     tags: string[];
     category: string | null;
 }
@@ -7616,6 +7684,10 @@ interface GalleryStyle {
     promptPrefix: string;
     promptSuffix: string;
     palette: string[];
+    /** Provider view name, when the style sets one. */
+    view: string | null;
+    /** Strip the generated background (sent for pixflux and non-PixelLab providers). */
+    noBackground: boolean;
     quality: boolean;
     tags: string[];
     /** Parent style id when this style `extends` one. */
@@ -7758,6 +7830,111 @@ interface RenderGalleryOptions {
 }
 declare function renderGallery(snapshot: GallerySnapshot, opts?: RenderGalleryOptions): string;
 
+/**
+ * Generation from the gallery is the CLI's `gen`, run as a background job:
+ * the same `buildPlan`, the same per-provider budget and balance preflight,
+ * the same `submit → poll → fetch` library calls writing the same lockfile.
+ * The page adds nothing the terminal cannot do; it only shows the estimate,
+ * asks, and reports progress.
+ *
+ * Two ceilings guard spend. The session budget is passed when the gallery
+ * starts (`--budget`, optionally keyed per provider) and every job's estimate
+ * is charged against it up front, so the page can never exceed what the
+ * person typed. Each submission also carries the remaining ceiling as its
+ * own `budget`, the way `gen --budget` does, so a provider estimate that
+ * grows between plan and submit is refused rather than paid.
+ */
+type GeneratePhase = "queued" | "submitting" | "polling" | "fetching" | "review" | "done" | "failed";
+interface GenerateJob {
+    id: string;
+    project: string | null;
+    keys: string[];
+    /** `resume` skips submission: poll, review, and fetch existing work at no cost. */
+    mode: "generate" | "resume";
+    phase: GeneratePhase;
+    startedAt: string;
+    finishedAt: string | null;
+    /** Progress lines, exactly what the CLI would have printed. */
+    messages: string[];
+    error: string | null;
+    /** Successful-submission estimates this job charged, by provider. */
+    spent: Record<string, number>;
+    /** Keys still waiting for a human choice. */
+    review: string[];
+    counts: {
+        submitted: number;
+        failed: number;
+        downloaded: number;
+    };
+}
+interface GalleryProjectContext {
+    loaded: LoadedManifest;
+    /** Every spec the project declares, unfiltered. */
+    specs: ResolvedSpec[];
+    lock: Lock;
+    lockPath: string;
+}
+interface SessionBudget {
+    /** Unkeyed ceiling, valid only when a run involves a single provider. */
+    amount?: number;
+    /** Provider-keyed ceilings. */
+    byProvider: Record<string, number>;
+}
+interface GenerateHandlerOptions {
+    /** Load a project fresh from disk; `project` is the workspace id, if any. */
+    loadProject: (project?: string) => Promise<GalleryProjectContext>;
+    /** An online provider for a project; the caller owns env loading and caching. */
+    providerFor: (project: string | undefined, providerId: string) => Provider;
+    budget: SessionBudget;
+    reload: () => Promise<GalleryBuild>;
+    onProgress?: (msg: string) => void;
+    /** Test hooks. */
+    pollIntervalMs?: number;
+    submitSpacingMs?: number;
+    /** Deterministic clock hook. */
+    now?: () => Date;
+}
+interface GenerateStatus {
+    jobs: GenerateJob[];
+    budget: SessionBudget;
+    /** Estimates charged so far this session, by provider. */
+    spent: Record<string, number>;
+    /** Providers whose spend unit is known, for display. */
+    units: Record<string, CostUnit>;
+}
+interface GalleryGenerateHandlers {
+    start(body: unknown): Promise<GenerateJob>;
+    status(): GenerateStatus;
+    /** The embedded review sheet for a job's waiting keys; null when nothing waits. */
+    review(jobId: string, options: RenderSheetOptions & {
+        routePrefix: string;
+    }): Promise<ReviewSession | null>;
+    applyReview(jobId: string, body: unknown): Promise<PickResult>;
+}
+declare const GenerateRequestSchema: z.ZodObject<{
+    project: z.ZodOptional<z.ZodString>;
+    keys: z.ZodArray<z.ZodString, "many">;
+    /** Regenerate work that is up to date, as `gen --force` does. */
+    force: z.ZodOptional<z.ZodBoolean>;
+    /** Advance in-flight, review, or selected work without submitting anything. */
+    resume: z.ZodOptional<z.ZodBoolean>;
+}, "strict", z.ZodTypeAny, {
+    keys: string[];
+    resume?: boolean | undefined;
+    force?: boolean | undefined;
+    project?: string | undefined;
+}, {
+    keys: string[];
+    resume?: boolean | undefined;
+    force?: boolean | undefined;
+    project?: string | undefined;
+}>;
+declare class GenerateRequestError extends Error {
+    readonly status: number;
+    constructor(message: string, status?: number);
+}
+declare function createGenerateHandlers(opts: GenerateHandlerOptions): GalleryGenerateHandlers;
+
 declare const ManifestEditSchema: z.ZodDiscriminatedUnion<"action", [z.ZodObject<{
     action: z.ZodLiteral<"patch-asset">;
     /** Workspace project id; omitted for a single-project gallery. */
@@ -7899,6 +8076,46 @@ declare const ManifestEditSchema: z.ZodDiscriminatedUnion<"action", [z.ZodObject
     expectedSha256: string;
     action: "add-asset";
     project?: string | undefined;
+}>, z.ZodObject<{
+    action: z.ZodLiteral<"set-source">;
+    project: z.ZodOptional<z.ZodString>;
+    assetId: z.ZodString;
+    styleId: z.ZodString;
+    /** Manifest-relative path of the art that stands in for this asset in this style. */
+    source: z.ZodString;
+    expectedSha256: z.ZodString;
+}, "strict", z.ZodTypeAny, {
+    source: string;
+    styleId: string;
+    assetId: string;
+    expectedSha256: string;
+    action: "set-source";
+    project?: string | undefined;
+}, {
+    source: string;
+    styleId: string;
+    assetId: string;
+    expectedSha256: string;
+    action: "set-source";
+    project?: string | undefined;
+}>, z.ZodObject<{
+    action: z.ZodLiteral<"clear-source">;
+    project: z.ZodOptional<z.ZodString>;
+    assetId: z.ZodString;
+    styleId: z.ZodString;
+    expectedSha256: z.ZodString;
+}, "strict", z.ZodTypeAny, {
+    styleId: string;
+    assetId: string;
+    expectedSha256: string;
+    action: "clear-source";
+    project?: string | undefined;
+}, {
+    styleId: string;
+    assetId: string;
+    expectedSha256: string;
+    action: "clear-source";
+    project?: string | undefined;
 }>, z.ZodObject<{
     action: z.ZodLiteral<"patch-style">;
     project: z.ZodOptional<z.ZodString>;
@@ -7912,34 +8129,48 @@ declare const ManifestEditSchema: z.ZodDiscriminatedUnion<"action", [z.ZodObject
         promptSuffix: z.ZodOptional<z.ZodString>;
         /** `#rrggbb` values; null or empty clears the style's own palette. */
         palette: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString, "many">>>;
+        /** Provider view name (PixelLab: low top-down, high top-down, side); empty clears. */
+        view: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        /** pixflux only; null clears the style's own value. */
+        noBackground: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
     }, "strict", z.ZodTypeAny, {
         candidates?: number | undefined;
         palette?: string[] | null | undefined;
+        view?: string | null | undefined;
         promptSuffix?: string | undefined;
         promptPrefix?: string | undefined;
+        noBackground?: boolean | null | undefined;
     }, {
         candidates?: number | undefined;
         palette?: string[] | null | undefined;
+        view?: string | null | undefined;
         promptSuffix?: string | undefined;
         promptPrefix?: string | undefined;
+        noBackground?: boolean | null | undefined;
     }>, {
         candidates?: number | undefined;
         palette?: string[] | null | undefined;
+        view?: string | null | undefined;
         promptSuffix?: string | undefined;
         promptPrefix?: string | undefined;
+        noBackground?: boolean | null | undefined;
     }, {
         candidates?: number | undefined;
         palette?: string[] | null | undefined;
+        view?: string | null | undefined;
         promptSuffix?: string | undefined;
         promptPrefix?: string | undefined;
+        noBackground?: boolean | null | undefined;
     }>;
 }, "strict", z.ZodTypeAny, {
     styleId: string;
     patch: {
         candidates?: number | undefined;
         palette?: string[] | null | undefined;
+        view?: string | null | undefined;
         promptSuffix?: string | undefined;
         promptPrefix?: string | undefined;
+        noBackground?: boolean | null | undefined;
     };
     expectedSha256: string;
     action: "patch-style";
@@ -7949,8 +8180,10 @@ declare const ManifestEditSchema: z.ZodDiscriminatedUnion<"action", [z.ZodObject
     patch: {
         candidates?: number | undefined;
         palette?: string[] | null | undefined;
+        view?: string | null | undefined;
         promptSuffix?: string | undefined;
         promptPrefix?: string | undefined;
+        noBackground?: boolean | null | undefined;
     };
     expectedSha256: string;
     action: "patch-style";
@@ -7979,121 +8212,21 @@ interface ManifestEditResult {
  * manifest fails to load or resolve — an invalid manifest never lands.
  */
 declare function applyManifestEdit(manifestPath: string, edit: ManifestEdit): Promise<ManifestEditResult>;
+
 interface GalleryEditHandlerOptions {
     /** Resolves the manifest an edit may rewrite; must never trust a client path. */
     manifestFor: (project?: string) => string | Promise<string>;
     /** Rebuilds the gallery after a successful write. */
     reload: () => Promise<GalleryBuild>;
+    /** Loads a project for hand-edit actions, which need resolved specs and the lock. */
+    loadProject?: (project?: string) => Promise<GalleryProjectContext>;
+    /** Launches the author's editor; defaults to `openInEditor`. */
+    openEditor?: (file: string) => string;
     onProgress?: (msg: string) => void;
 }
 /** The `edit` callback `serveGallery` expects: validate, apply, rebuild. */
 declare function createGalleryEditHandler(opts: GalleryEditHandlerOptions): (body: unknown) => Promise<GalleryBuild>;
 
-/**
- * Generation from the gallery is the CLI's `gen`, run as a background job:
- * the same `buildPlan`, the same per-provider budget and balance preflight,
- * the same `submit → poll → fetch` library calls writing the same lockfile.
- * The page adds nothing the terminal cannot do; it only shows the estimate,
- * asks, and reports progress.
- *
- * Two ceilings guard spend. The session budget is passed when the gallery
- * starts (`--budget`, optionally keyed per provider) and every job's estimate
- * is charged against it up front, so the page can never exceed what the
- * person typed. Each submission also carries the remaining ceiling as its
- * own `budget`, the way `gen --budget` does, so a provider estimate that
- * grows between plan and submit is refused rather than paid.
- */
-type GeneratePhase = "queued" | "submitting" | "polling" | "fetching" | "review" | "done" | "failed";
-interface GenerateJob {
-    id: string;
-    project: string | null;
-    keys: string[];
-    /** `resume` skips submission: poll, review, and fetch existing work at no cost. */
-    mode: "generate" | "resume";
-    phase: GeneratePhase;
-    startedAt: string;
-    finishedAt: string | null;
-    /** Progress lines, exactly what the CLI would have printed. */
-    messages: string[];
-    error: string | null;
-    /** Successful-submission estimates this job charged, by provider. */
-    spent: Record<string, number>;
-    /** Keys still waiting for a human choice. */
-    review: string[];
-    counts: {
-        submitted: number;
-        failed: number;
-        downloaded: number;
-    };
-}
-interface GalleryProjectContext {
-    loaded: LoadedManifest;
-    /** Every spec the project declares, unfiltered. */
-    specs: ResolvedSpec[];
-    lock: Lock;
-    lockPath: string;
-}
-interface SessionBudget {
-    /** Unkeyed ceiling, valid only when a run involves a single provider. */
-    amount?: number;
-    /** Provider-keyed ceilings. */
-    byProvider: Record<string, number>;
-}
-interface GenerateHandlerOptions {
-    /** Load a project fresh from disk; `project` is the workspace id, if any. */
-    loadProject: (project?: string) => Promise<GalleryProjectContext>;
-    /** An online provider for a project; the caller owns env loading and caching. */
-    providerFor: (project: string | undefined, providerId: string) => Provider;
-    budget: SessionBudget;
-    reload: () => Promise<GalleryBuild>;
-    onProgress?: (msg: string) => void;
-    /** Test hooks. */
-    pollIntervalMs?: number;
-    submitSpacingMs?: number;
-    /** Deterministic clock hook. */
-    now?: () => Date;
-}
-interface GenerateStatus {
-    jobs: GenerateJob[];
-    budget: SessionBudget;
-    /** Estimates charged so far this session, by provider. */
-    spent: Record<string, number>;
-    /** Providers whose spend unit is known, for display. */
-    units: Record<string, CostUnit>;
-}
-interface GalleryGenerateHandlers {
-    start(body: unknown): Promise<GenerateJob>;
-    status(): GenerateStatus;
-    /** The embedded review sheet for a job's waiting keys; null when nothing waits. */
-    review(jobId: string, options: RenderSheetOptions & {
-        routePrefix: string;
-    }): Promise<ReviewSession | null>;
-    applyReview(jobId: string, body: unknown): Promise<PickResult>;
-}
-declare const GenerateRequestSchema: z.ZodObject<{
-    project: z.ZodOptional<z.ZodString>;
-    keys: z.ZodArray<z.ZodString, "many">;
-    /** Regenerate work that is up to date, as `gen --force` does. */
-    force: z.ZodOptional<z.ZodBoolean>;
-    /** Advance in-flight, review, or selected work without submitting anything. */
-    resume: z.ZodOptional<z.ZodBoolean>;
-}, "strict", z.ZodTypeAny, {
-    keys: string[];
-    resume?: boolean | undefined;
-    force?: boolean | undefined;
-    project?: string | undefined;
-}, {
-    keys: string[];
-    resume?: boolean | undefined;
-    force?: boolean | undefined;
-    project?: string | undefined;
-}>;
-declare class GenerateRequestError extends Error {
-    readonly status: number;
-    constructor(message: string, status?: number);
-}
-declare function createGenerateHandlers(opts: GenerateHandlerOptions): GalleryGenerateHandlers;
-
 /**
  * The gallery's HTTP surface. Unlike the review server this is long-lived:
  * three GET routes, bound to loopback, running until the caller closes it