@pixerate/editor 0.210.0 → 0.212.0

package/dist/image-editor/controller.d.cts

@@ -2,6 +2,7 @@ import { AdjustmentKind, AdjustmentLayer, AdjustmentParamsMap, Annotation, Creat
 import { type PathToSelectionOptions, type SelectionToPathOptions } from './selection/path.cjs';
 import { type MagneticEdgeOptions } from './selection/magnetic.cjs';
 import type { ObjectTarget } from './selection/segment/grabcut.cjs';
+import { type DocumentPath } from './paths.cjs';
 import { type SelectionJob, type SelectionJobResult, type SelectionWorkerFactory } from './selection/worker.cjs';
 import type { SelectionProgress } from './selection/segment/work.cjs';
 import type { FocusAreaOptions } from './selection/segment/focus.cjs';
@@ -478,12 +479,17 @@ export interface StrokeSelectionOptions extends Omit<FillOptions, 'useSelection'
     /** Where the band lies against the selection edge (default `outside`). */
     location?: 'inside' | 'center' | 'outside';
 }
+/** Where Content-Aware Fill puts its result. */
+export type ContentAwareFillOutput = 'current' | 'new-layer' | 'duplicate-layer';
 /** Edit › Content-Aware Fill (see `contentAwareFill`). */
 export interface ContentAwareFillOptions {
     /** The pixel layer to sample and fill (default the active layer). */
     layerId?: string;
-    /** `current` (default) paints into the layer; `new-layer` puts the fill on a new layer above it. */
-    output?: 'current' | 'new-layer';
+    /**
+     * `current` (default) paints into the layer; `new-layer` puts the fill on a new layer above it;
+     * `duplicate-layer` paints it into a copy of the layer, above it.
+     */
+    output?: ContentAwareFillOutput;
     /** How far around the selection to sample, in pixels (default its larger side, at least 32). */
     sampleRadius?: number;
     /** Random seed: the same seed gives the same fill (default 0). */
@@ -1087,6 +1093,50 @@ export declare class ImageEditorController {
     pathToSelection(path: VectorMaskPathInput, options?: PathToSelectionOptions & {
         mode?: SelectionMode;
     }): boolean;
+    /** The document's paths: saved paths and the Work Path, in panel order. */
+    getPaths(): readonly DocumentPath[];
+    getPath(id: string): DocumentPath | null;
+    private requirePath;
+    /** Selects a path in the Paths panel (or none). View state: no undo step. */
+    setActivePath(id: string | null): void;
+    private commitPaths;
+    /**
+     * Paths › Make Work Path: the selection's outline, traced, becomes the Work Path (replacing the
+     * last one, unless it was saved). One undo step. Returns the path.
+     */
+    makeWorkPath(options?: SelectionToPathOptions): DocumentPath;
+    /** A new saved path from geometry (`shape`, `subpaths` or `components`). One undo step. */
+    addPath(input: VectorMaskPathInput & {
+        name?: string;
+    }): DocumentPath;
+    /** Replaces a path's geometry (its name is kept). One undo step. */
+    setPathGeometry(id: string, input: VectorMaskPathInput): DocumentPath;
+    /** Renames a path; renaming the Work Path saves it (Photoshop's Save Path). One undo step. */
+    renamePath(id: string, name: string): DocumentPath;
+    /** Duplicates a path as a saved path. One undo step. */
+    duplicatePath(id: string, name?: string): DocumentPath;
+    /** Deletes a path. One undo step. */
+    deletePath(id: string): void;
+    /** The area a path fills over the image, as a selection mask. */
+    private pathArea;
+    /** Paths › Make Selection: loads a path as the selection, combined by `mode`. One undo step. */
+    loadPathAsSelection(id: string, options?: PathToSelectionOptions & {
+        mode?: SelectionMode;
+    }): boolean;
+    /**
+     * Paths › Fill Path: fills the path's area on a pixel layer (default the active one) with a
+     * colour (default the foreground). The selection is not changed. One undo step.
+     */
+    fillPath(id: string, options?: Omit<FillOptions, 'useSelection'>): PaintStrokeResult;
+    /**
+     * Paths › Stroke Path: strokes along the path's outline on a pixel layer (default the active
+     * one), `width` px wide and centred on it. The selection is not changed. One undo step.
+     */
+    strokePath(id: string, options: Omit<StrokeSelectionOptions, 'location'>): PaintStrokeResult;
+    /** Paths › Add Vector Mask: masks a layer (default the active one) with a document path. One undo step. */
+    addVectorMaskFromPath(pathId: string, layerId?: string): VectorMask;
+    /** Runs `fn` with `mask` as the selection, then puts the selection back, all as one undo step. */
+    private withSelection;
     /** Replaces a vector mask's path (its properties are kept). One undo step. Returns the vector mask. */
     setVectorMaskPath(id: string, path: VectorMaskPathInput): VectorMask;
     /** Changes a vector mask's enabled, linked, inverted, density or feather (the path is kept). One undo step. */
@@ -1483,7 +1533,7 @@ export declare class ImageEditorController {
     contentAwareFill(options?: ContentAwareFillOptions): {
         layerId: string;
         bounds: CropBox;
-        output: 'current' | 'new-layer';
+        output: ContentAwareFillOutput;
     };
     /**
      * `contentAwareFill` with the synthesis in the selection worker when there is one, with
@@ -1495,7 +1545,7 @@ export declare class ImageEditorController {
     }): Promise<{
         layerId: string;
         bounds: CropBox;
-        output: 'current' | 'new-layer';
+        output: ContentAwareFillOutput;
     }>;
     /**
      * The fill without changing anything: the window, its pixels before and after (RGBA, the fill
@@ -1627,6 +1677,12 @@ export declare class ImageEditorController {
      * Returns false when nothing changed.
      */
     setSelection(mask: SelectionMask | null, mode?: SelectionMode): boolean;
+    /**
+     * Shows `mask` in place of the selection while a gesture runs (Quick Selection as the brush
+     * moves; `null` shows nothing selected), or with `undefined` stops. View state only: no undo
+     * step, not saved.
+     */
+    setSelectionPreview(mask: SelectionMask | null | undefined): void;
     /** Select › All. */
     selectAll(): boolean;
     /** Select › Deselect. */

package/dist/image-editor/controller.d.ts

@@ -2,6 +2,7 @@ import { AdjustmentKind, AdjustmentLayer, AdjustmentParamsMap, Annotation, Creat
 import { type PathToSelectionOptions, type SelectionToPathOptions } from './selection/path.js';
 import { type MagneticEdgeOptions } from './selection/magnetic.js';
 import type { ObjectTarget } from './selection/segment/grabcut.js';
+import { type DocumentPath } from './paths.js';
 import { type SelectionJob, type SelectionJobResult, type SelectionWorkerFactory } from './selection/worker.js';
 import type { SelectionProgress } from './selection/segment/work.js';
 import type { FocusAreaOptions } from './selection/segment/focus.js';
@@ -478,12 +479,17 @@ export interface StrokeSelectionOptions extends Omit<FillOptions, 'useSelection'
     /** Where the band lies against the selection edge (default `outside`). */
     location?: 'inside' | 'center' | 'outside';
 }
+/** Where Content-Aware Fill puts its result. */
+export type ContentAwareFillOutput = 'current' | 'new-layer' | 'duplicate-layer';
 /** Edit › Content-Aware Fill (see `contentAwareFill`). */
 export interface ContentAwareFillOptions {
     /** The pixel layer to sample and fill (default the active layer). */
     layerId?: string;
-    /** `current` (default) paints into the layer; `new-layer` puts the fill on a new layer above it. */
-    output?: 'current' | 'new-layer';
+    /**
+     * `current` (default) paints into the layer; `new-layer` puts the fill on a new layer above it;
+     * `duplicate-layer` paints it into a copy of the layer, above it.
+     */
+    output?: ContentAwareFillOutput;
     /** How far around the selection to sample, in pixels (default its larger side, at least 32). */
     sampleRadius?: number;
     /** Random seed: the same seed gives the same fill (default 0). */
@@ -1087,6 +1093,50 @@ export declare class ImageEditorController {
     pathToSelection(path: VectorMaskPathInput, options?: PathToSelectionOptions & {
         mode?: SelectionMode;
     }): boolean;
+    /** The document's paths: saved paths and the Work Path, in panel order. */
+    getPaths(): readonly DocumentPath[];
+    getPath(id: string): DocumentPath | null;
+    private requirePath;
+    /** Selects a path in the Paths panel (or none). View state: no undo step. */
+    setActivePath(id: string | null): void;
+    private commitPaths;
+    /**
+     * Paths › Make Work Path: the selection's outline, traced, becomes the Work Path (replacing the
+     * last one, unless it was saved). One undo step. Returns the path.
+     */
+    makeWorkPath(options?: SelectionToPathOptions): DocumentPath;
+    /** A new saved path from geometry (`shape`, `subpaths` or `components`). One undo step. */
+    addPath(input: VectorMaskPathInput & {
+        name?: string;
+    }): DocumentPath;
+    /** Replaces a path's geometry (its name is kept). One undo step. */
+    setPathGeometry(id: string, input: VectorMaskPathInput): DocumentPath;
+    /** Renames a path; renaming the Work Path saves it (Photoshop's Save Path). One undo step. */
+    renamePath(id: string, name: string): DocumentPath;
+    /** Duplicates a path as a saved path. One undo step. */
+    duplicatePath(id: string, name?: string): DocumentPath;
+    /** Deletes a path. One undo step. */
+    deletePath(id: string): void;
+    /** The area a path fills over the image, as a selection mask. */
+    private pathArea;
+    /** Paths › Make Selection: loads a path as the selection, combined by `mode`. One undo step. */
+    loadPathAsSelection(id: string, options?: PathToSelectionOptions & {
+        mode?: SelectionMode;
+    }): boolean;
+    /**
+     * Paths › Fill Path: fills the path's area on a pixel layer (default the active one) with a
+     * colour (default the foreground). The selection is not changed. One undo step.
+     */
+    fillPath(id: string, options?: Omit<FillOptions, 'useSelection'>): PaintStrokeResult;
+    /**
+     * Paths › Stroke Path: strokes along the path's outline on a pixel layer (default the active
+     * one), `width` px wide and centred on it. The selection is not changed. One undo step.
+     */
+    strokePath(id: string, options: Omit<StrokeSelectionOptions, 'location'>): PaintStrokeResult;
+    /** Paths › Add Vector Mask: masks a layer (default the active one) with a document path. One undo step. */
+    addVectorMaskFromPath(pathId: string, layerId?: string): VectorMask;
+    /** Runs `fn` with `mask` as the selection, then puts the selection back, all as one undo step. */
+    private withSelection;
     /** Replaces a vector mask's path (its properties are kept). One undo step. Returns the vector mask. */
     setVectorMaskPath(id: string, path: VectorMaskPathInput): VectorMask;
     /** Changes a vector mask's enabled, linked, inverted, density or feather (the path is kept). One undo step. */
@@ -1483,7 +1533,7 @@ export declare class ImageEditorController {
     contentAwareFill(options?: ContentAwareFillOptions): {
         layerId: string;
         bounds: CropBox;
-        output: 'current' | 'new-layer';
+        output: ContentAwareFillOutput;
     };
     /**
      * `contentAwareFill` with the synthesis in the selection worker when there is one, with
@@ -1495,7 +1545,7 @@ export declare class ImageEditorController {
     }): Promise<{
         layerId: string;
         bounds: CropBox;
-        output: 'current' | 'new-layer';
+        output: ContentAwareFillOutput;
     }>;
     /**
      * The fill without changing anything: the window, its pixels before and after (RGBA, the fill
@@ -1627,6 +1677,12 @@ export declare class ImageEditorController {
      * Returns false when nothing changed.
      */
     setSelection(mask: SelectionMask | null, mode?: SelectionMode): boolean;
+    /**
+     * Shows `mask` in place of the selection while a gesture runs (Quick Selection as the brush
+     * moves; `null` shows nothing selected), or with `undefined` stops. View state only: no undo
+     * step, not saved.
+     */
+    setSelectionPreview(mask: SelectionMask | null | undefined): void;
     /** Select › All. */
     selectAll(): boolean;
     /** Select › Deselect. */