@pixerate/editor 0.220.0 → 0.221.1

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

@@ -1,5 +1,6 @@
 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 SelectionRecipeStep } from './selection/recipe.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';
@@ -745,10 +746,6 @@ export declare function migrateToLayeredState(data: Partial<SerializedImageEdito
 }, size: ImageDimensions): SerializedLayeredImageEditorState;
 export declare const DEFAULT_TRANSFORM: ImageTransform;
 export declare const DEFAULT_DEPTH_MASK: DepthMaskOptions;
-/**
- * ImageEditorController manages the complete lifecycle, canvas rendering pipeline,
- * tool interaction states, undo/redo history, serialization, and image export.
- */
 export declare class ImageEditorController {
     private state;
     private renderer;
@@ -1802,6 +1799,32 @@ export declare class ImageEditorController {
      * Returns false when nothing changed.
      */
     setSelection(mask: SelectionMask | null, mode?: SelectionMode): boolean;
+    /** The recipe step of the selection command now running, taken by `setSelection`. */
+    private pendingStep;
+    /** Runs a selection command whose change `step` describes, so the selection's recipe records it. */
+    private withRecipeStep;
+    /** The selection's recipe as agents and panels read it (empty and not live when frozen or empty). */
+    getSelectionRecipe(): {
+        live: boolean;
+        steps: Array<{
+            index: number;
+        } & SelectionRecipeStep>;
+    };
+    private requireRecipe;
+    /**
+     * Replaces the selection's recipe with `steps` (checked first) and the selection with what they
+     * make, from nothing. One undo step; nothing changes on an error. Returns the recipe.
+     */
+    setSelectionRecipe(steps: readonly unknown[]): Promise<ReturnType<ImageEditorController['getSelectionRecipe']>>;
+    /** Changes step `index` of the selection's recipe (fields given replace its own; `op` replaces it whole) and replays. One undo step. */
+    editSelectionStep(index: number, changes: Record<string, unknown>): Promise<ReturnType<ImageEditorController['getSelectionRecipe']>>;
+    /** Inserts a step at `index` (0..length; length appends) and replays. One undo step. */
+    insertSelectionStep(index: number, step: unknown): Promise<ReturnType<ImageEditorController['getSelectionRecipe']>>;
+    /** Removes step `index` and replays (the last step cannot go: deselect instead). One undo step. */
+    removeSelectionStep(index: number): Promise<ReturnType<ImageEditorController['getSelectionRecipe']>>;
+    /** Drops the selection's recipe, keeping the selection as it is (a plain bitmap). One undo step. */
+    freezeSelection(): boolean;
+    private recipeIndex;
     /**
      * 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

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

@@ -1,5 +1,6 @@
 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 SelectionRecipeStep } from './selection/recipe.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';
@@ -745,10 +746,6 @@ export declare function migrateToLayeredState(data: Partial<SerializedImageEdito
 }, size: ImageDimensions): SerializedLayeredImageEditorState;
 export declare const DEFAULT_TRANSFORM: ImageTransform;
 export declare const DEFAULT_DEPTH_MASK: DepthMaskOptions;
-/**
- * ImageEditorController manages the complete lifecycle, canvas rendering pipeline,
- * tool interaction states, undo/redo history, serialization, and image export.
- */
 export declare class ImageEditorController {
     private state;
     private renderer;
@@ -1802,6 +1799,32 @@ export declare class ImageEditorController {
      * Returns false when nothing changed.
      */
     setSelection(mask: SelectionMask | null, mode?: SelectionMode): boolean;
+    /** The recipe step of the selection command now running, taken by `setSelection`. */
+    private pendingStep;
+    /** Runs a selection command whose change `step` describes, so the selection's recipe records it. */
+    private withRecipeStep;
+    /** The selection's recipe as agents and panels read it (empty and not live when frozen or empty). */
+    getSelectionRecipe(): {
+        live: boolean;
+        steps: Array<{
+            index: number;
+        } & SelectionRecipeStep>;
+    };
+    private requireRecipe;
+    /**
+     * Replaces the selection's recipe with `steps` (checked first) and the selection with what they
+     * make, from nothing. One undo step; nothing changes on an error. Returns the recipe.
+     */
+    setSelectionRecipe(steps: readonly unknown[]): Promise<ReturnType<ImageEditorController['getSelectionRecipe']>>;
+    /** Changes step `index` of the selection's recipe (fields given replace its own; `op` replaces it whole) and replays. One undo step. */
+    editSelectionStep(index: number, changes: Record<string, unknown>): Promise<ReturnType<ImageEditorController['getSelectionRecipe']>>;
+    /** Inserts a step at `index` (0..length; length appends) and replays. One undo step. */
+    insertSelectionStep(index: number, step: unknown): Promise<ReturnType<ImageEditorController['getSelectionRecipe']>>;
+    /** Removes step `index` and replays (the last step cannot go: deselect instead). One undo step. */
+    removeSelectionStep(index: number): Promise<ReturnType<ImageEditorController['getSelectionRecipe']>>;
+    /** Drops the selection's recipe, keeping the selection as it is (a plain bitmap). One undo step. */
+    freezeSelection(): boolean;
+    private recipeIndex;
     /**
      * 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