@pixerate/editor 0.188.0 → 0.190.0

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

@@ -11,7 +11,7 @@ import { type RefineEdgeParams } from './selection/refine.cjs';
 import { type LayerMaskProps } from './selection/layer-mask.cjs';
 import { type AlphaChannel } from './selection/channels.cjs';
 import type { AdjustmentLayerMask } from './types.cjs';
-import { type LayerBlendMode, type ImageLayer, type LayerFilter, type LayerTarget, type PixelLayer, type RasterMask, type SmartContents, type SmartFilter, type SmartPlacement, type LiveShape, type ShapeFillRule, type ShapeOperation, type ShapePaint, type ShapeStroke, type ParagraphStyle, type TextStyle, type TypeLayer, type ImageEffectAnimation } from './layers/model.cjs';
+import { type LayerBlendMode, type ImageLayer, type LayerFilter, type LayerTarget, type PixelLayer, type RasterMask, type SmartContents, type SmartFilter, type SmartPlacement, type LiveShape, type ShapeFillRule, type VectorMask, type ShapeOperation, type ShapePaint, type ShapeStroke, type ParagraphStyle, type TextStyle, type TypeLayer, type ImageEffectAnimation } from './layers/model.cjs';
 import { type TextLayout, type TextShaper } from './layers/text.cjs';
 import type { VectorSubpath } from '../vector/types.cjs';
 import { EffectsSlot } from '../effects/helpers.cjs';
@@ -113,6 +113,8 @@ export interface SelectionCommandOptions {
 }
 /** How the canvas shows the selection: marching ants, a Quick Mask tint, or not at all. */
 export type SelectionDisplay = 'ants' | 'quickMask' | 'none';
+/** How a layer mask is shown on the canvas: alone in grey, or as a red tint over the image. */
+export type MaskViewMode = 'gray' | 'overlay';
 /** What `exportMaskImage` writes: the selection, an alpha channel or a layer's painted mask. */
 export type MaskImageSource = 'selection' | {
     channelId: string;
@@ -207,6 +209,29 @@ export interface CloneSource {
  * 'star' | 'line', … }`, see `LiveShape`) or subpaths (`[{ anchors: [{ x, y, in?, out? }],
  * closed }]` or SVG path data), and how it combines with the components below it.
  */
+/** A vector mask's path: several `components`, or one `shape` / `subpaths` (with `op`). */
+export interface VectorMaskPathInput extends ShapeGeometryInput {
+    components?: ShapeGeometryInput[];
+    fillRule?: ShapeFillRule;
+}
+/** A vector mask as `getVectorMask` describes it. */
+export interface VectorMaskInfo {
+    layerId: string;
+    enabled: boolean;
+    linked: boolean;
+    inverted: boolean;
+    fillRule: ShapeFillRule;
+    density: number;
+    feather: number;
+    /** Bounds of the path's anchors and handles (document px), or `null` for an empty path. */
+    bounds: CropBox | null;
+    components: Array<{
+        index: number;
+        op: ShapeOperation;
+        live: LiveShape | null;
+        subpaths: VectorSubpath[];
+    }>;
+}
 export interface ShapeGeometryInput {
     shape?: LiveShape | Record<string, unknown>;
     subpaths?: VectorSubpath[] | string;
@@ -886,6 +911,33 @@ export declare class ImageEditorController {
     addLayerMask(id: string, from?: 'reveal-all' | 'hide-all' | 'selection' | 'hide-selection' | 'transparency', props?: LayerMaskProps): RasterMask;
     /** Removes a layer's mask (one undo step). */
     removeLayerMask(id: string): void;
+    /** The layer for a vector mask command: not a shape layer (its path is its vector mask), not a depth-masked one. */
+    private vectorMaskLayer;
+    private requireVectorMask;
+    /** Components from a path spec: `components`, or one `shape` / `subpaths`. */
+    private vectorMaskComponents;
+    /**
+     * Layer › Vector Mask: `reveal-all` (an empty path showing everything), `hide-all` (an empty path
+     * hiding everything) or `path` (reveals inside the path given). Replaces an existing vector mask;
+     * the raster mask is kept and both apply. One undo step. Returns the vector mask.
+     */
+    addVectorMask(id: string, from?: 'reveal-all' | 'hide-all' | 'path', path?: VectorMaskPathInput): VectorMask;
+    /** Replaces a vector mask's path (its properties are kept). One undo step. Returns the vector mask. */
+    setVectorMaskPath(id: string, path: VectorMaskPathInput): VectorMask;
+    /** Changes a vector mask's enabled, linked, inverted, density or feather (the path is kept). One undo step. */
+    setVectorMaskProps(id: string, props: Partial<Pick<VectorMask, 'enabled' | 'linked' | 'inverted' | 'density' | 'feather'>>): VectorMask;
+    /** Deletes a layer's vector mask (one undo step). */
+    removeVectorMask(id: string): void;
+    /**
+     * Layer › Rasterize › Vector Mask: multiplies the path (with its density and feather) into the
+     * layer's raster mask, adding one when there is none, and removes the vector mask. The raster
+     * mask keeps its own properties. One undo step. Returns the raster mask.
+     */
+    rasterizeVectorMask(id: string): RasterMask;
+    /** Load Selection from a vector mask's path (density and feather are not applied), inverted with `invert`. */
+    selectionFromVectorMask(id: string, mode?: SelectionMode, invert?: boolean): boolean;
+    /** A layer's vector mask with its paths (rounded), or `null` without one. */
+    getVectorMask(id: string): VectorMaskInfo | null;
     /** Changes any layer mask's density, feather, enabled or linked flag (pixels kept). Returns the mask. */
     setLayerMaskProps(id: string, props: LayerMaskProps, commitToHistory?: boolean): RasterMask;
     /**
@@ -1506,6 +1558,21 @@ export declare class ImageEditorController {
      * it (the selection still applies). View state: no undo step, not saved.
      */
     setSelectionDisplay(display: SelectionDisplay): void;
+    /** The layer mask shown on the canvas, or `null` (see `setMaskView`). */
+    getMaskView(): {
+        layerId: string;
+        mode: MaskViewMode;
+    } | null;
+    /**
+     * Shows a layer's mask on the canvas: `gray` alone in grey (Alt-click the mask thumbnail),
+     * `overlay` as a red tint over what it hides (the \ key), `off` back to the image. The layer
+     * defaults to the active one. View state: no undo step, not saved. Throws when the layer has
+     * no painted mask.
+     */
+    setMaskView(mode: MaskViewMode | 'off', layerId?: string): {
+        layerId: string;
+        mode: MaskViewMode;
+    } | null;
     /** The alpha channels (saved selections), in panel order. */
     getChannels(): readonly AlphaChannel[];
     getChannel(id: string): AlphaChannel | null;

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

@@ -11,7 +11,7 @@ import { type RefineEdgeParams } from './selection/refine.js';
 import { type LayerMaskProps } from './selection/layer-mask.js';
 import { type AlphaChannel } from './selection/channels.js';
 import type { AdjustmentLayerMask } from './types.js';
-import { type LayerBlendMode, type ImageLayer, type LayerFilter, type LayerTarget, type PixelLayer, type RasterMask, type SmartContents, type SmartFilter, type SmartPlacement, type LiveShape, type ShapeFillRule, type ShapeOperation, type ShapePaint, type ShapeStroke, type ParagraphStyle, type TextStyle, type TypeLayer, type ImageEffectAnimation } from './layers/model.js';
+import { type LayerBlendMode, type ImageLayer, type LayerFilter, type LayerTarget, type PixelLayer, type RasterMask, type SmartContents, type SmartFilter, type SmartPlacement, type LiveShape, type ShapeFillRule, type VectorMask, type ShapeOperation, type ShapePaint, type ShapeStroke, type ParagraphStyle, type TextStyle, type TypeLayer, type ImageEffectAnimation } from './layers/model.js';
 import { type TextLayout, type TextShaper } from './layers/text.js';
 import type { VectorSubpath } from '../vector/types.js';
 import { EffectsSlot } from '../effects/helpers.js';
@@ -113,6 +113,8 @@ export interface SelectionCommandOptions {
 }
 /** How the canvas shows the selection: marching ants, a Quick Mask tint, or not at all. */
 export type SelectionDisplay = 'ants' | 'quickMask' | 'none';
+/** How a layer mask is shown on the canvas: alone in grey, or as a red tint over the image. */
+export type MaskViewMode = 'gray' | 'overlay';
 /** What `exportMaskImage` writes: the selection, an alpha channel or a layer's painted mask. */
 export type MaskImageSource = 'selection' | {
     channelId: string;
@@ -207,6 +209,29 @@ export interface CloneSource {
  * 'star' | 'line', … }`, see `LiveShape`) or subpaths (`[{ anchors: [{ x, y, in?, out? }],
  * closed }]` or SVG path data), and how it combines with the components below it.
  */
+/** A vector mask's path: several `components`, or one `shape` / `subpaths` (with `op`). */
+export interface VectorMaskPathInput extends ShapeGeometryInput {
+    components?: ShapeGeometryInput[];
+    fillRule?: ShapeFillRule;
+}
+/** A vector mask as `getVectorMask` describes it. */
+export interface VectorMaskInfo {
+    layerId: string;
+    enabled: boolean;
+    linked: boolean;
+    inverted: boolean;
+    fillRule: ShapeFillRule;
+    density: number;
+    feather: number;
+    /** Bounds of the path's anchors and handles (document px), or `null` for an empty path. */
+    bounds: CropBox | null;
+    components: Array<{
+        index: number;
+        op: ShapeOperation;
+        live: LiveShape | null;
+        subpaths: VectorSubpath[];
+    }>;
+}
 export interface ShapeGeometryInput {
     shape?: LiveShape | Record<string, unknown>;
     subpaths?: VectorSubpath[] | string;
@@ -886,6 +911,33 @@ export declare class ImageEditorController {
     addLayerMask(id: string, from?: 'reveal-all' | 'hide-all' | 'selection' | 'hide-selection' | 'transparency', props?: LayerMaskProps): RasterMask;
     /** Removes a layer's mask (one undo step). */
     removeLayerMask(id: string): void;
+    /** The layer for a vector mask command: not a shape layer (its path is its vector mask), not a depth-masked one. */
+    private vectorMaskLayer;
+    private requireVectorMask;
+    /** Components from a path spec: `components`, or one `shape` / `subpaths`. */
+    private vectorMaskComponents;
+    /**
+     * Layer › Vector Mask: `reveal-all` (an empty path showing everything), `hide-all` (an empty path
+     * hiding everything) or `path` (reveals inside the path given). Replaces an existing vector mask;
+     * the raster mask is kept and both apply. One undo step. Returns the vector mask.
+     */
+    addVectorMask(id: string, from?: 'reveal-all' | 'hide-all' | 'path', path?: VectorMaskPathInput): VectorMask;
+    /** Replaces a vector mask's path (its properties are kept). One undo step. Returns the vector mask. */
+    setVectorMaskPath(id: string, path: VectorMaskPathInput): VectorMask;
+    /** Changes a vector mask's enabled, linked, inverted, density or feather (the path is kept). One undo step. */
+    setVectorMaskProps(id: string, props: Partial<Pick<VectorMask, 'enabled' | 'linked' | 'inverted' | 'density' | 'feather'>>): VectorMask;
+    /** Deletes a layer's vector mask (one undo step). */
+    removeVectorMask(id: string): void;
+    /**
+     * Layer › Rasterize › Vector Mask: multiplies the path (with its density and feather) into the
+     * layer's raster mask, adding one when there is none, and removes the vector mask. The raster
+     * mask keeps its own properties. One undo step. Returns the raster mask.
+     */
+    rasterizeVectorMask(id: string): RasterMask;
+    /** Load Selection from a vector mask's path (density and feather are not applied), inverted with `invert`. */
+    selectionFromVectorMask(id: string, mode?: SelectionMode, invert?: boolean): boolean;
+    /** A layer's vector mask with its paths (rounded), or `null` without one. */
+    getVectorMask(id: string): VectorMaskInfo | null;
     /** Changes any layer mask's density, feather, enabled or linked flag (pixels kept). Returns the mask. */
     setLayerMaskProps(id: string, props: LayerMaskProps, commitToHistory?: boolean): RasterMask;
     /**
@@ -1506,6 +1558,21 @@ export declare class ImageEditorController {
      * it (the selection still applies). View state: no undo step, not saved.
      */
     setSelectionDisplay(display: SelectionDisplay): void;
+    /** The layer mask shown on the canvas, or `null` (see `setMaskView`). */
+    getMaskView(): {
+        layerId: string;
+        mode: MaskViewMode;
+    } | null;
+    /**
+     * Shows a layer's mask on the canvas: `gray` alone in grey (Alt-click the mask thumbnail),
+     * `overlay` as a red tint over what it hides (the \ key), `off` back to the image. The layer
+     * defaults to the active one. View state: no undo step, not saved. Throws when the layer has
+     * no painted mask.
+     */
+    setMaskView(mode: MaskViewMode | 'off', layerId?: string): {
+        layerId: string;
+        mode: MaskViewMode;
+    } | null;
     /** The alpha channels (saved selections), in panel order. */
     getChannels(): readonly AlphaChannel[];
     getChannel(id: string): AlphaChannel | null;

package/dist/image-editor/free-transform.d.cts

@@ -1,9 +1,3 @@
-/**
- * Free Transform sessions: what a transform moves (a layer's pixels with its linked mask, a lone
- * unlinked mask, the selected pixels as a floating piece, a copy of them on a new layer, or just
- * the selection outline), a live preview while the geometry changes, and one undo step when it is
- * committed with full-quality resampling.
- */
 import { TiledSurface } from '../raster/surface.cjs';
 import { type Interpolation } from '../raster/transform.cjs';
 import { type ImageLayer, type LayerTarget, type PixelLayer, type SmartObjectLayer } from './layers/model.cjs';
@@ -147,6 +141,9 @@ export declare class FreeTransformSession {
     }, preview?: FreeTransformPreview | false): FreeTransformGeometry;
     /** Resamples every part for the current geometry and shows it (or returns it, for commit). */
     private resample;
+    /** A linked vector mask follows the layer's content through the same document-space map. */
+    private moveVectorMask;
+    private resampleContent;
     /**
      * A shape with its paths mapped through the current geometry and rendered again (live shapes
      * stay live under an affine map; perspective and warps turn them into plain paths). Previews

package/dist/image-editor/free-transform.d.ts

@@ -1,9 +1,3 @@
-/**
- * Free Transform sessions: what a transform moves (a layer's pixels with its linked mask, a lone
- * unlinked mask, the selected pixels as a floating piece, a copy of them on a new layer, or just
- * the selection outline), a live preview while the geometry changes, and one undo step when it is
- * committed with full-quality resampling.
- */
 import { TiledSurface } from '../raster/surface.js';
 import { type Interpolation } from '../raster/transform.js';
 import { type ImageLayer, type LayerTarget, type PixelLayer, type SmartObjectLayer } from './layers/model.js';
@@ -147,6 +141,9 @@ export declare class FreeTransformSession {
     }, preview?: FreeTransformPreview | false): FreeTransformGeometry;
     /** Resamples every part for the current geometry and shows it (or returns it, for commit). */
     private resample;
+    /** A linked vector mask follows the layer's content through the same document-space map. */
+    private moveVectorMask;
+    private resampleContent;
     /**
      * A shape with its paths mapped through the current geometry and rendered again (live shapes
      * stay live under an affine map; perspective and warps turn them into plain paths). Previews