@pixerate/editor 0.204.0 → 0.206.0

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

@@ -13,6 +13,7 @@ import { type GrowSimilarOptions, type ColorRangeOptions, type ColorRangePreset,
 import { type SelectionModifyOp } from './selection/modify.cjs';
 import { type SegmentationProvider } from './selection/segmentation.cjs';
 import { type RefineEdgeParams } from './selection/refine.cjs';
+import { type RefineEdit } from './selection/refine-edits.cjs';
 import { type LayerMaskProps } from './selection/layer-mask.cjs';
 import { type AlphaChannel } from './selection/channels.cjs';
 import type { AdjustmentLayerMask } from './types.cjs';
@@ -161,6 +162,18 @@ export interface FocusAreaCommandOptions extends FocusAreaOptions {
     /** Sample every layer (default true) or only the active pixel layer. */
     sampleAllLayers?: boolean;
 }
+/** Where Select and Mask puts its result (Photoshop's Output To). */
+export type RefineOutput = 'selection' | 'layer-mask' | 'new-layer' | 'new-layer-with-mask';
+/** What {@link ImageEditorController.refineSelectionTo} made. */
+export interface RefineOutputResult {
+    output: RefineOutput;
+    /** The layer the output came from (all but `selection`). */
+    layerId?: string;
+    /** The layer it made (`new-layer`, `new-layer-with-mask`). */
+    newLayerId?: string;
+    /** How the edge was refined: by colour, or with the segmentation model (object aware). */
+    refineMode: 'color' | 'object';
+}
 /** Options of {@link ImageEditorController.selectSky}. */
 export interface SkyCommandOptions extends SkyOptions {
     /** With a segmentation provider set, ask it for the sky (default true); false finds it classically. */
@@ -1632,6 +1645,34 @@ export declare class ImageEditorController {
      * to the image's edges with a guided filter, then smooth / feather / contrast / shift edge.
      */
     refineSelection(params: RefineEdgeParams, options?: SampleOptions): Promise<boolean>;
+    /**
+     * Select and Mask's output: refines the selection with `params`, then puts the result where
+     * `output` says, as one undo step:
+     * - `selection`: the refined selection;
+     * - `layer-mask`: a mask on the layer (`layerId`, default the active one), then deselects;
+     * - `new-layer`: a new layer of the layer's selected pixels (Layer via Copy), the source hidden;
+     * - `new-layer-with-mask`: a copy of the layer masked by the selection, the source hidden.
+     * `decontaminate` (0..100, new-layer outputs only) replaces the old background's colour in the
+     * soft edge with the subject's own (see `decontaminateColors`).
+     *
+     * `edits` are the workspace's strokes, applied first in order (Quick Selection, Brush and
+     * Refine Edge Brush; see `RefineEdit`); with them, an empty selection is a valid start.
+     * `refineMode: 'object'` asks the segmentation provider for the object in the selection's
+     * bounds and refines from its outline, kept to near the selection's edge.
+     */
+    refineSelectionTo(params: RefineEdgeParams, output?: RefineOutput, options?: SampleOptions & {
+        layerId?: string;
+        decontaminate?: number;
+        edits?: RefineEdit[];
+        refineMode?: 'color' | 'object';
+        signal?: AbortSignal;
+    }): Promise<RefineOutputResult>;
+    /**
+     * Decontaminate Colors along the soft edge of `coverage`: the colours are estimated from the
+     * source layer (whose background is still there) and written into layer `id`'s RGB, keeping
+     * its alpha.
+     */
+    private decontaminateLayer;
     /**
      * Loads a selection from a mask image (an AI segmentation, a saved mask): a data URL / URL or
      * RGBA pixels, by luminance (white = selected) or a channel. Any size; it is resampled.

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

@@ -13,6 +13,7 @@ import { type GrowSimilarOptions, type ColorRangeOptions, type ColorRangePreset,
 import { type SelectionModifyOp } from './selection/modify.js';
 import { type SegmentationProvider } from './selection/segmentation.js';
 import { type RefineEdgeParams } from './selection/refine.js';
+import { type RefineEdit } from './selection/refine-edits.js';
 import { type LayerMaskProps } from './selection/layer-mask.js';
 import { type AlphaChannel } from './selection/channels.js';
 import type { AdjustmentLayerMask } from './types.js';
@@ -161,6 +162,18 @@ export interface FocusAreaCommandOptions extends FocusAreaOptions {
     /** Sample every layer (default true) or only the active pixel layer. */
     sampleAllLayers?: boolean;
 }
+/** Where Select and Mask puts its result (Photoshop's Output To). */
+export type RefineOutput = 'selection' | 'layer-mask' | 'new-layer' | 'new-layer-with-mask';
+/** What {@link ImageEditorController.refineSelectionTo} made. */
+export interface RefineOutputResult {
+    output: RefineOutput;
+    /** The layer the output came from (all but `selection`). */
+    layerId?: string;
+    /** The layer it made (`new-layer`, `new-layer-with-mask`). */
+    newLayerId?: string;
+    /** How the edge was refined: by colour, or with the segmentation model (object aware). */
+    refineMode: 'color' | 'object';
+}
 /** Options of {@link ImageEditorController.selectSky}. */
 export interface SkyCommandOptions extends SkyOptions {
     /** With a segmentation provider set, ask it for the sky (default true); false finds it classically. */
@@ -1632,6 +1645,34 @@ export declare class ImageEditorController {
      * to the image's edges with a guided filter, then smooth / feather / contrast / shift edge.
      */
     refineSelection(params: RefineEdgeParams, options?: SampleOptions): Promise<boolean>;
+    /**
+     * Select and Mask's output: refines the selection with `params`, then puts the result where
+     * `output` says, as one undo step:
+     * - `selection`: the refined selection;
+     * - `layer-mask`: a mask on the layer (`layerId`, default the active one), then deselects;
+     * - `new-layer`: a new layer of the layer's selected pixels (Layer via Copy), the source hidden;
+     * - `new-layer-with-mask`: a copy of the layer masked by the selection, the source hidden.
+     * `decontaminate` (0..100, new-layer outputs only) replaces the old background's colour in the
+     * soft edge with the subject's own (see `decontaminateColors`).
+     *
+     * `edits` are the workspace's strokes, applied first in order (Quick Selection, Brush and
+     * Refine Edge Brush; see `RefineEdit`); with them, an empty selection is a valid start.
+     * `refineMode: 'object'` asks the segmentation provider for the object in the selection's
+     * bounds and refines from its outline, kept to near the selection's edge.
+     */
+    refineSelectionTo(params: RefineEdgeParams, output?: RefineOutput, options?: SampleOptions & {
+        layerId?: string;
+        decontaminate?: number;
+        edits?: RefineEdit[];
+        refineMode?: 'color' | 'object';
+        signal?: AbortSignal;
+    }): Promise<RefineOutputResult>;
+    /**
+     * Decontaminate Colors along the soft edge of `coverage`: the colours are estimated from the
+     * source layer (whose background is still there) and written into layer `id`'s RGB, keeping
+     * its alpha.
+     */
+    private decontaminateLayer;
     /**
      * Loads a selection from a mask image (an AI segmentation, a saved mask): a data URL / URL or
      * RGBA pixels, by luminance (white = selected) or a channel. Any size; it is resampled.