@pixerate/editor 0.179.0 → 0.180.0

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

@@ -6,6 +6,7 @@ import { type PixelBuffer, type SelectionChannel, type SelectionMask, type Selec
 import { type ShapeSelectionOptions } from './selection/shapes.cjs';
 import { type ColorRangeOptions, type ColorRangeSample, type MagicWandOptions } from './selection/wand.cjs';
 import { type SelectionModifyOp } from './selection/modify.cjs';
+import { type SegmentationProvider } from './selection/segmentation.cjs';
 import { type RefineEdgeParams } from './selection/refine.cjs';
 import type { LayerMaskProps } from './selection/layer-mask.cjs';
 import type { AdjustmentLayerMask } from './types.cjs';
@@ -538,6 +539,8 @@ export declare class ImageEditorController {
     private viewKey;
     /** For `compositePixels` and mask evaluation (the renderer keeps its own for the viewport). */
     private compositor;
+    /** The segmentation provider behind `selectSubject` (see `setSegmentationProvider`). */
+    private segmentation;
     /** The effects provider slot (see `setEffectsProvider`). */
     readonly effects: EffectsSlot;
     /** Renders provider effects: effect smart filter results and effect layers. */
@@ -566,6 +569,10 @@ export declare class ImageEditorController {
      * or those drawn while a result was rendering, once it is in. A cache refresh: no undo step.
      */
     private refreshEffectSurfaces;
+    /** The registered segmentation provider, or `null` (then `selectSubject` is unavailable). */
+    get segmentationProvider(): SegmentationProvider | null;
+    /** Registers (or with `null` removes) the segmentation provider. Not an edit: no undo step. */
+    setSegmentationProvider(provider: SegmentationProvider | null): void;
     /** The registered effects provider, or `null`. */
     get effectsProvider(): EffectProvider | null;
     /** Registers (or with `null` removes) the effects provider. Not an edit: no undo step. */
@@ -1304,6 +1311,24 @@ export declare class ImageEditorController {
         threshold?: number;
         mode?: SelectionMode;
     }): Promise<SelectionMask | null>;
+    /** A mask image (data URL / URL, or pixels as they are) as RGBA pixels. */
+    private decodeMaskImage;
+    /**
+     * Select › Subject: asks the segmentation provider for the objects matching `target` ("the
+     * dog", "the sky") in the flattened image and selects their shapes, combined with the
+     * selection by `mode`, as one undo step. Returns what was found (labels and bounds in natural
+     * pixels); an empty list leaves the selection as it was. Throws without a provider.
+     */
+    selectSubject(target: string, options?: SelectionCommandOptions & {
+        maxSegments?: number;
+        signal?: AbortSignal;
+    }): Promise<{
+        segments: {
+            label: string;
+            bounds: CropBox | null;
+            score?: number;
+        }[];
+    }>;
     /** Quick Mask view (tints the unselected area). View state: no undo step. */
     setQuickMask(on: boolean): void;
     private maskFromSelection;

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

@@ -6,6 +6,7 @@ import { type PixelBuffer, type SelectionChannel, type SelectionMask, type Selec
 import { type ShapeSelectionOptions } from './selection/shapes.js';
 import { type ColorRangeOptions, type ColorRangeSample, type MagicWandOptions } from './selection/wand.js';
 import { type SelectionModifyOp } from './selection/modify.js';
+import { type SegmentationProvider } from './selection/segmentation.js';
 import { type RefineEdgeParams } from './selection/refine.js';
 import type { LayerMaskProps } from './selection/layer-mask.js';
 import type { AdjustmentLayerMask } from './types.js';
@@ -538,6 +539,8 @@ export declare class ImageEditorController {
     private viewKey;
     /** For `compositePixels` and mask evaluation (the renderer keeps its own for the viewport). */
     private compositor;
+    /** The segmentation provider behind `selectSubject` (see `setSegmentationProvider`). */
+    private segmentation;
     /** The effects provider slot (see `setEffectsProvider`). */
     readonly effects: EffectsSlot;
     /** Renders provider effects: effect smart filter results and effect layers. */
@@ -566,6 +569,10 @@ export declare class ImageEditorController {
      * or those drawn while a result was rendering, once it is in. A cache refresh: no undo step.
      */
     private refreshEffectSurfaces;
+    /** The registered segmentation provider, or `null` (then `selectSubject` is unavailable). */
+    get segmentationProvider(): SegmentationProvider | null;
+    /** Registers (or with `null` removes) the segmentation provider. Not an edit: no undo step. */
+    setSegmentationProvider(provider: SegmentationProvider | null): void;
     /** The registered effects provider, or `null`. */
     get effectsProvider(): EffectProvider | null;
     /** Registers (or with `null` removes) the effects provider. Not an edit: no undo step. */
@@ -1304,6 +1311,24 @@ export declare class ImageEditorController {
         threshold?: number;
         mode?: SelectionMode;
     }): Promise<SelectionMask | null>;
+    /** A mask image (data URL / URL, or pixels as they are) as RGBA pixels. */
+    private decodeMaskImage;
+    /**
+     * Select › Subject: asks the segmentation provider for the objects matching `target` ("the
+     * dog", "the sky") in the flattened image and selects their shapes, combined with the
+     * selection by `mode`, as one undo step. Returns what was found (labels and bounds in natural
+     * pixels); an empty list leaves the selection as it was. Throws without a provider.
+     */
+    selectSubject(target: string, options?: SelectionCommandOptions & {
+        maxSegments?: number;
+        signal?: AbortSignal;
+    }): Promise<{
+        segments: {
+            label: string;
+            bounds: CropBox | null;
+            score?: number;
+        }[];
+    }>;
     /** Quick Mask view (tints the unselected area). View state: no undo step. */
     setQuickMask(on: boolean): void;
     private maskFromSelection;