@pixerate/editor 0.205.0 → 0.207.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';
@@ -170,6 +171,8 @@ export interface RefineOutputResult {
     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 {
@@ -1651,10 +1654,18 @@ export declare class ImageEditorController {
      * - `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

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';
@@ -170,6 +171,8 @@ export interface RefineOutputResult {
     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 {
@@ -1651,10 +1654,18 @@ export declare class ImageEditorController {
      * - `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