@pixerate/editor 0.215.0 → 0.217.0

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

@@ -1,5 +1,7 @@
 import { AdjustmentKind, AdjustmentLayer, AdjustmentParamsMap, Annotation, CreateAnnotationPayload, AspectRatio, CropBox, DepthMaskOptions, ExportOptions, ImageAdjustments, ImageDimensions, ImageEditorFit, ImageEditorOptions, ImageEditorState, ImageEditorTool, ImageTransform, ImagePoint, SerializedImageEditorState, DocumentOpener } from './types.cjs';
 import { type InspectMaskEdgeOptions, type MaskEdgeReport } from './selection/inspect.cjs';
+import { type CompareSelectionsOptions, type SelectionDiff } from './selection/diff.cjs';
+import { type SelectionUncertainty, type SelectionUncertaintyOptions } from './selection/uncertainty.cjs';
 import { type PathToSelectionOptions, type SelectionToPathOptions } from './selection/path.cjs';
 import { type MagneticEdgeOptions } from './selection/magnetic.cjs';
 import type { ObjectTarget } from './selection/segment/grabcut.cjs';
@@ -283,6 +285,22 @@ export interface CloneSource {
 /** A vector mask's path: several `components`, or one `shape` / `subpaths` (with `op`). */
 /** What `inspectMaskEdge` reads: the selection, a layer's painted mask or its vector mask. */
 export type MaskEdgeTarget = 'selection' | 'layer-mask' | 'vector-mask';
+/** A selection `compareSelections` reads (see `selectionFrom`). */
+export type SelectionSource = {
+    kind: 'selection';
+} | {
+    kind: 'history';
+    steps?: number;
+} | {
+    kind: 'channel';
+    channelId: string;
+} | {
+    kind: 'layer-mask';
+    layerId: string;
+} | {
+    kind: 'vector-mask';
+    layerId: string;
+};
 /** A layer's edge colour as `getEdgeColor` describes it (percentages). */
 export interface EdgeColorInfo {
     layerId: string;
@@ -1876,6 +1894,8 @@ export declare class ImageEditorController {
         decontaminate?: number;
         edits?: RefineEdit[];
         refineMode?: 'color' | 'object';
+        /** Refine only inside these rectangles (e.g. `selectionUncertainty().regions`); the rest stays as it was. */
+        regions?: CropBox[];
         signal?: AbortSignal;
     }): Promise<RefineOutputResult>;
     /**
@@ -2054,6 +2074,31 @@ export declare class ImageEditorController {
         target: MaskEdgeTarget;
         layerId?: string;
     };
+    /** Whole-pixel rectangles inside the canvas, or a useful error; undefined stays undefined. */
+    private checkRegions;
+    /**
+     * Where the selection is unsure of itself: the stretches of its edge with no image edge under
+     * them, widened into a band (a trimap's unknown), as a mask and regions with bounds and
+     * confidence, least confident first. Measured against the composite. Read-only; an empty
+     * selection has none.
+     */
+    selectionUncertainty(options?: SelectionUncertaintyOptions): SelectionUncertainty;
+    /**
+     * A selection to compare (`compareSelections`): the current one, the one `steps` undo steps
+     * ago, a saved channel, or a layer's painted or vector mask. `null` is nothing selected.
+     */
+    selectionFrom(source: SelectionSource): SelectionMask | null;
+    /**
+     * What changed from selection `a` (default: before the last undo step) to `b` (default: the
+     * current selection): added and removed area with their largest pieces, IoU and the coverage
+     * change. With `show` (default true) the canvas tints added area green and removed red until the
+     * selection next changes (view state, no undo step). Read-only otherwise.
+     */
+    compareSelections(a?: SelectionSource, b?: SelectionSource, options?: CompareSelectionsOptions & {
+        show?: boolean;
+    }): SelectionDiff;
+    /** Hides the `compareSelections` overlay. */
+    clearSelectionDiff(): void;
     /** A layer's painted mask over the canvas as a selection mask; null without one (or for a depth mask). */
     private layerMaskCoverage;
     /**

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

@@ -1,5 +1,7 @@
 import { AdjustmentKind, AdjustmentLayer, AdjustmentParamsMap, Annotation, CreateAnnotationPayload, AspectRatio, CropBox, DepthMaskOptions, ExportOptions, ImageAdjustments, ImageDimensions, ImageEditorFit, ImageEditorOptions, ImageEditorState, ImageEditorTool, ImageTransform, ImagePoint, SerializedImageEditorState, DocumentOpener } from './types.js';
 import { type InspectMaskEdgeOptions, type MaskEdgeReport } from './selection/inspect.js';
+import { type CompareSelectionsOptions, type SelectionDiff } from './selection/diff.js';
+import { type SelectionUncertainty, type SelectionUncertaintyOptions } from './selection/uncertainty.js';
 import { type PathToSelectionOptions, type SelectionToPathOptions } from './selection/path.js';
 import { type MagneticEdgeOptions } from './selection/magnetic.js';
 import type { ObjectTarget } from './selection/segment/grabcut.js';
@@ -283,6 +285,22 @@ export interface CloneSource {
 /** A vector mask's path: several `components`, or one `shape` / `subpaths` (with `op`). */
 /** What `inspectMaskEdge` reads: the selection, a layer's painted mask or its vector mask. */
 export type MaskEdgeTarget = 'selection' | 'layer-mask' | 'vector-mask';
+/** A selection `compareSelections` reads (see `selectionFrom`). */
+export type SelectionSource = {
+    kind: 'selection';
+} | {
+    kind: 'history';
+    steps?: number;
+} | {
+    kind: 'channel';
+    channelId: string;
+} | {
+    kind: 'layer-mask';
+    layerId: string;
+} | {
+    kind: 'vector-mask';
+    layerId: string;
+};
 /** A layer's edge colour as `getEdgeColor` describes it (percentages). */
 export interface EdgeColorInfo {
     layerId: string;
@@ -1876,6 +1894,8 @@ export declare class ImageEditorController {
         decontaminate?: number;
         edits?: RefineEdit[];
         refineMode?: 'color' | 'object';
+        /** Refine only inside these rectangles (e.g. `selectionUncertainty().regions`); the rest stays as it was. */
+        regions?: CropBox[];
         signal?: AbortSignal;
     }): Promise<RefineOutputResult>;
     /**
@@ -2054,6 +2074,31 @@ export declare class ImageEditorController {
         target: MaskEdgeTarget;
         layerId?: string;
     };
+    /** Whole-pixel rectangles inside the canvas, or a useful error; undefined stays undefined. */
+    private checkRegions;
+    /**
+     * Where the selection is unsure of itself: the stretches of its edge with no image edge under
+     * them, widened into a band (a trimap's unknown), as a mask and regions with bounds and
+     * confidence, least confident first. Measured against the composite. Read-only; an empty
+     * selection has none.
+     */
+    selectionUncertainty(options?: SelectionUncertaintyOptions): SelectionUncertainty;
+    /**
+     * A selection to compare (`compareSelections`): the current one, the one `steps` undo steps
+     * ago, a saved channel, or a layer's painted or vector mask. `null` is nothing selected.
+     */
+    selectionFrom(source: SelectionSource): SelectionMask | null;
+    /**
+     * What changed from selection `a` (default: before the last undo step) to `b` (default: the
+     * current selection): added and removed area with their largest pieces, IoU and the coverage
+     * change. With `show` (default true) the canvas tints added area green and removed red until the
+     * selection next changes (view state, no undo step). Read-only otherwise.
+     */
+    compareSelections(a?: SelectionSource, b?: SelectionSource, options?: CompareSelectionsOptions & {
+        show?: boolean;
+    }): SelectionDiff;
+    /** Hides the `compareSelections` overlay. */
+    clearSelectionDiff(): void;
     /** A layer's painted mask over the canvas as a selection mask; null without one (or for a depth mask). */
     private layerMaskCoverage;
     /**