@pixerate/editor 0.189.0 → 0.190.0

package/dist/image-editor/layers/panel.d.ts

@@ -18,6 +18,16 @@ export declare function maskThumbnailClick(controller: ImageEditorController, la
     shiftKey?: boolean;
     altKey?: boolean;
 }): void;
+/**
+ * A click on a layer's vector mask thumbnail: Ctrl/⌘-click loads the path as the selection (Shift
+ * adds, Alt subtracts, both intersect) and Shift-click turns the vector mask on or off.
+ */
+export declare function vectorMaskThumbnailClick(controller: ImageEditorController, layer: ImageLayer, e: {
+    ctrlKey?: boolean;
+    metaKey?: boolean;
+    shiftKey?: boolean;
+    altKey?: boolean;
+}): void;
 /**
  * A click on a layer's pixel thumbnail: Ctrl/⌘-click loads the layer's transparency as the
  * selection (Shift adds, Alt subtracts, both intersect) and returns true; other clicks are left
@@ -57,7 +67,7 @@ export type DropZone = 'above' | 'below' | 'inside';
 export declare function dropZone(fraction: number, isGroup: boolean): DropZone;
 /** The placement for `move_layer` when `dragId` is dropped on row `targetId` in `zone`, or `null` for a no-op. */
 export declare function dropPlacement(layers: readonly ImageLayer[], dragId: string, targetId: string, zone: DropZone): LayerPlacement | null;
-export type LayerMenuAction = 'new-layer' | 'new-group' | 'duplicate' | 'delete' | 'group-selected' | 'ungroup' | 'merge-down' | 'merge-visible' | 'flatten' | 'via-copy' | 'via-cut' | 'add-mask' | 'add-mask-selection' | 'add-mask-hide-selection' | 'add-mask-transparency' | 'select-transparency' | 'apply-mask' | 'delete-mask' | 'toggle-mask' | 'toggle-mask-link' | 'toggle-clip' | 'rasterize' | 'convert-smart' | 'edit-contents' | 'smart-via-copy' | 'add-filter-mask';
+export type LayerMenuAction = 'new-layer' | 'new-group' | 'duplicate' | 'delete' | 'group-selected' | 'ungroup' | 'merge-down' | 'merge-visible' | 'flatten' | 'via-copy' | 'via-cut' | 'add-mask' | 'add-vector-mask' | 'add-vector-mask-hide' | 'delete-vector-mask' | 'toggle-vector-mask' | 'rasterize-vector-mask' | 'add-mask-selection' | 'add-mask-hide-selection' | 'add-mask-transparency' | 'select-transparency' | 'apply-mask' | 'delete-mask' | 'toggle-mask' | 'toggle-mask-link' | 'toggle-clip' | 'rasterize' | 'convert-smart' | 'edit-contents' | 'smart-via-copy' | 'add-filter-mask';
 export interface LayerMenuItem {
     action: LayerMenuAction;
     label: string;

package/dist/image-editor/layers/serialize.d.cts

@@ -40,9 +40,20 @@ interface SerializedLayerBase {
     blend: string;
     clipped?: boolean;
     mask?: SerializedRasterMask;
+    vectorMask?: SerializedVectorMask;
     locks?: LayerLocks;
     effects?: SerializedLayerEffects;
 }
+/** A stored vector mask: its components as JSON (document pixels) and its properties. */
+export interface SerializedVectorMask {
+    components: unknown[];
+    fillRule?: 'evenodd';
+    inverted?: true;
+    enabled?: false;
+    linked?: false;
+    density?: number;
+    feather?: number;
+}
 /** A layer's effects: the effect list as JSON plus the PSD block they came from (base64). */
 export interface SerializedLayerEffects {
     enabled: boolean;

package/dist/image-editor/layers/serialize.d.ts

@@ -40,9 +40,20 @@ interface SerializedLayerBase {
     blend: string;
     clipped?: boolean;
     mask?: SerializedRasterMask;
+    vectorMask?: SerializedVectorMask;
     locks?: LayerLocks;
     effects?: SerializedLayerEffects;
 }
+/** A stored vector mask: its components as JSON (document pixels) and its properties. */
+export interface SerializedVectorMask {
+    components: unknown[];
+    fillRule?: 'evenodd';
+    inverted?: true;
+    enabled?: false;
+    linked?: false;
+    density?: number;
+    feather?: number;
+}
 /** A layer's effects: the effect list as JSON plus the PSD block they came from (base64). */
 export interface SerializedLayerEffects {
     enabled: boolean;

package/dist/image-editor/layers/shape.d.cts

@@ -50,6 +50,11 @@ export declare function shapeGeometryBounds(layer: Pick<ShapeLayer, 'components'
     width: number;
     height: number;
 } | null;
+/**
+ * Coverage (0..1) of `components` over `rect`, filled with `rule` and combined by their ops;
+ * `inverted` covers the outside instead. Used for vector masks.
+ */
+export declare function componentsCoverage(components: readonly ShapeComponent[], rect: CropBox, rule?: ShapeFillRule, inverted?: boolean): Float32Array;
 /** Where a shape renders: the canvas grown by the margin. */
 export declare function shapeRenderClip(env: Pick<ShapeEnv, 'width' | 'height'>): CropBox;
 /**

package/dist/image-editor/layers/shape.d.ts

@@ -50,6 +50,11 @@ export declare function shapeGeometryBounds(layer: Pick<ShapeLayer, 'components'
     width: number;
     height: number;
 } | null;
+/**
+ * Coverage (0..1) of `components` over `rect`, filled with `rule` and combined by their ops;
+ * `inverted` covers the outside instead. Used for vector masks.
+ */
+export declare function componentsCoverage(components: readonly ShapeComponent[], rect: CropBox, rule?: ShapeFillRule, inverted?: boolean): Float32Array;
 /** Where a shape renders: the canvas grown by the margin. */
 export declare function shapeRenderClip(env: Pick<ShapeEnv, 'width' | 'height'>): CropBox;
 /**

package/dist/image-editor/layers/vector-mask.d.cts

@@ -0,0 +1,51 @@
+/**
+ * Vector masks: a path on a layer that reveals it (Photoshop's Layer › Vector Mask). The paths are
+ * shape components in document pixels; the compositor sees them through `resolveVectorMasks`, which
+ * gives each layer with a vector mask a raster mask that is its raster mask times the path's
+ * coverage, so the tile engine and its caches need nothing new.
+ */
+import type { CropBox } from '../types.cjs';
+import type { AffineMatrix } from '../../geom/types.cjs';
+import type { ImageLayer, RasterMask, VectorMask } from './model.cjs';
+/** Whether a vector mask takes part in compositing. */
+export declare function isActiveVectorMask(vm: VectorMask | undefined): vm is VectorMask;
+/**
+ * The vector mask's coverage (0..1) over the `width × height` canvas, with its feather and
+ * density applied.
+ */
+export declare function vectorMaskCoverage(vm: VectorMask, width: number, height: number): Float32Array;
+/**
+ * The raster mask a layer composites with: its raster mask times its vector mask (layer space,
+ * feather and density baked in), or the raster mask alone when there is no active vector mask.
+ * A depth (parametric) mask cannot be combined, so it wins.
+ */
+export declare function effectiveLayerMask(layer: ImageLayer, width: number, height: number): RasterMask | undefined;
+/**
+ * The stack as the compositor should see it: each layer with an active vector mask replaced by a
+ * copy whose `mask` is `effectiveLayerMask` (cached per layer object and canvas size, so the
+ * engine's tile caches keep working). Returns `layers` itself when there are none.
+ */
+export declare function resolveVectorMasks(layers: readonly ImageLayer[], width: number, height: number): readonly ImageLayer[];
+/** A vector mask moved by (dx, dy) document pixels. */
+export declare function offsetVectorMask(vm: VectorMask, dx: number, dy: number): VectorMask;
+/** A vector mask with its paths mapped by `f` (document space); `affine` keeps live shapes live. */
+export declare function transformVectorMask(vm: VectorMask, f: (p: {
+    x: number;
+    y: number;
+}) => {
+    x: number;
+    y: number;
+}, affine?: AffineMatrix): VectorMask;
+/** A linked vector mask moved with its layer by (dx, dy); unlinked ones stay. */
+export declare function followLayerMove<T extends ImageLayer>(layer: T, dx: number, dy: number): T;
+/** Bounds of a vector mask's paths (document pixels), or `null` when it has none. */
+export declare function vectorMaskBounds(vm: VectorMask): CropBox | null;
+/**
+ * A vector mask's thumbnail over the `width × height` canvas, at most `maxSide` px: grey RGBA,
+ * white where the path reveals (cached per mask object).
+ */
+export declare function vectorMaskThumbnail(vm: VectorMask, width: number, height: number, maxSide?: number): {
+    width: number;
+    height: number;
+    data: Uint8ClampedArray;
+};

package/dist/image-editor/layers/vector-mask.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Vector masks: a path on a layer that reveals it (Photoshop's Layer › Vector Mask). The paths are
+ * shape components in document pixels; the compositor sees them through `resolveVectorMasks`, which
+ * gives each layer with a vector mask a raster mask that is its raster mask times the path's
+ * coverage, so the tile engine and its caches need nothing new.
+ */
+import type { CropBox } from '../types.js';
+import type { AffineMatrix } from '../../geom/types.js';
+import type { ImageLayer, RasterMask, VectorMask } from './model.js';
+/** Whether a vector mask takes part in compositing. */
+export declare function isActiveVectorMask(vm: VectorMask | undefined): vm is VectorMask;
+/**
+ * The vector mask's coverage (0..1) over the `width × height` canvas, with its feather and
+ * density applied.
+ */
+export declare function vectorMaskCoverage(vm: VectorMask, width: number, height: number): Float32Array;
+/**
+ * The raster mask a layer composites with: its raster mask times its vector mask (layer space,
+ * feather and density baked in), or the raster mask alone when there is no active vector mask.
+ * A depth (parametric) mask cannot be combined, so it wins.
+ */
+export declare function effectiveLayerMask(layer: ImageLayer, width: number, height: number): RasterMask | undefined;
+/**
+ * The stack as the compositor should see it: each layer with an active vector mask replaced by a
+ * copy whose `mask` is `effectiveLayerMask` (cached per layer object and canvas size, so the
+ * engine's tile caches keep working). Returns `layers` itself when there are none.
+ */
+export declare function resolveVectorMasks(layers: readonly ImageLayer[], width: number, height: number): readonly ImageLayer[];
+/** A vector mask moved by (dx, dy) document pixels. */
+export declare function offsetVectorMask(vm: VectorMask, dx: number, dy: number): VectorMask;
+/** A vector mask with its paths mapped by `f` (document space); `affine` keeps live shapes live. */
+export declare function transformVectorMask(vm: VectorMask, f: (p: {
+    x: number;
+    y: number;
+}) => {
+    x: number;
+    y: number;
+}, affine?: AffineMatrix): VectorMask;
+/** A linked vector mask moved with its layer by (dx, dy); unlinked ones stay. */
+export declare function followLayerMove<T extends ImageLayer>(layer: T, dx: number, dy: number): T;
+/** Bounds of a vector mask's paths (document pixels), or `null` when it has none. */
+export declare function vectorMaskBounds(vm: VectorMask): CropBox | null;
+/**
+ * A vector mask's thumbnail over the `width × height` canvas, at most `maxSide` px: grey RGBA,
+ * white where the path reveals (cached per mask object).
+ */
+export declare function vectorMaskThumbnail(vm: VectorMask, width: number, height: number, maxSide?: number): {
+    width: number;
+    height: number;
+    data: Uint8ClampedArray;
+};

package/dist/image-editor/psd/import.d.cts

@@ -1,10 +1,3 @@
-/**
- * PSD / PSB → our layer tree. Everything the model holds maps directly (smart objects with their
- * embedded contents, placement, warp, smart filters and filter mask; shape layers with their
- * paths, fill, stroke and live shapes; type layers with their text, styles and Photoshop's pixels
- * until edited); everything else comes in as close as it can (fill layers as their stored pixels)
- * with a warning naming the layers.
- */
 import { type PsdAlphaChannel } from './channels.cjs';
 import type { ImageLayer, LayerBlendMode } from '../layers/model.cjs';
 import { type PsdFile } from './file.cjs';

package/dist/image-editor/psd/import.d.ts

@@ -1,10 +1,3 @@
-/**
- * PSD / PSB → our layer tree. Everything the model holds maps directly (smart objects with their
- * embedded contents, placement, warp, smart filters and filter mask; shape layers with their
- * paths, fill, stroke and live shapes; type layers with their text, styles and Photoshop's pixels
- * until edited); everything else comes in as close as it can (fill layers as their stored pixels)
- * with a warning naming the layers.
- */
 import { type PsdAlphaChannel } from './channels.js';
 import type { ImageLayer, LayerBlendMode } from '../layers/model.js';
 import { type PsdFile } from './file.js';

package/dist/paint-editor/index.cjs

@@ -7,7 +7,7 @@ var _chunkZ64NRDEHcjs = require('../chunk-Z64NRDEH.cjs');
 
 
 
-var _chunkED4L4UD6cjs = require('../chunk-ED4L4UD6.cjs');
+var _chunkT4U4O6DScjs = require('../chunk-T4U4O6DS.cjs');
 require('../chunk-A2IS7EHE.cjs');
 
 
@@ -1653,11 +1653,11 @@ function header(state, options) {
   return out;
 }
 function serializePaintDocument(state, options = {}) {
-  const { layers, assets } = _chunkED4L4UD6cjs.serializeLayers.call(void 0, state.layers);
+  const { layers, assets } = _chunkT4U4O6DScjs.serializeLayers.call(void 0, state.layers);
   return { ...header(state, options), layers, assets };
 }
 async function serializePaintDocumentExternal(state, store, options = {}) {
-  const { layers, assets } = await _chunkED4L4UD6cjs.serializeLayersExternal.call(void 0, state.layers, store);
+  const { layers, assets } = await _chunkT4U4O6DScjs.serializeLayersExternal.call(void 0, state.layers, store);
   return { ...header(state, options), layers, assets };
 }
 function paintLayersOnly(layers, problems) {
@@ -1694,7 +1694,7 @@ function deserializePaintDocument(raw) {
   const canvas = normalizeCanvas({ width: r.width, height: r.height, dpi: _nullishCoalesce(r.dpi, () => ( void 0)) });
   const paper = _chunkYQ5C5BVKcjs.normalizePaper.call(void 0, _nullishCoalesce(r.paper, () => ( {})));
   const assets = r.assets && typeof r.assets === "object" ? r.assets : {};
-  const layers = paintLayersOnly(_chunkED4L4UD6cjs.deserializeLayers.call(void 0, r.layers, { assets, problems }), problems);
+  const layers = paintLayersOnly(_chunkT4U4O6DScjs.deserializeLayers.call(void 0, r.layers, { assets, problems }), problems);
   const wanted = typeof r.activeLayerId === "string" ? r.activeLayerId : null;
   const activeLayerId = wanted && _chunkHGTDMKNEcjs.findLayer.call(void 0, layers, wanted) ? wanted : _nullishCoalesce(_optionalChain([_chunkHGTDMKNEcjs.flattenLayers.call(void 0, layers), 'access', _70 => _70.filter, 'call', _71 => _71((l) => l.type === "pixel"), 'access', _72 => _72.pop, 'call', _73 => _73(), 'optionalAccess', _74 => _74.id]), () => ( null));
   const wetEvents = Array.isArray(r.wetEvents) ? r.wetEvents.filter((e) => e && typeof e === "object" && Number.isInteger(e.clock) && typeof e.kind === "string") : [];
@@ -1710,7 +1710,7 @@ async function deserializePaintDocumentAsync(raw, store) {
   if (!raw || typeof raw !== "object") throw new Error("Not a paint document: expected a JSON object.");
   const r = raw;
   const problems = [];
-  const assets = await _chunkED4L4UD6cjs.resolveExternalAssets.call(void 0, _nullishCoalesce(r.assets, () => ( {})), store, problems);
+  const assets = await _chunkT4U4O6DScjs.resolveExternalAssets.call(void 0, _nullishCoalesce(r.assets, () => ( {})), store, problems);
   const loaded = deserializePaintDocument({ ...r, assets });
   return { ...loaded, problems: [...problems, ...loaded.problems] };
 }
@@ -5409,7 +5409,7 @@ var PaintEditorController = (_class10 = class _PaintEditorController {
       return next.type === "group" ? { ...next, children: toStandard(next.children) } : next;
     });
     const layers = toStandard(dried);
-    const result = _chunkED4L4UD6cjs.exportPsd.call(void 0, { width, height, layers: [paperLayer, ...layers], merged, resolution: dpi });
+    const result = _chunkT4U4O6DScjs.exportPsd.call(void 0, { width, height, layers: [paperLayer, ...layers], merged, resolution: dpi });
     for (const [mode, names] of changed) {
       const label = _nullishCoalesce(_optionalChain([_chunkCWM3CUUXcjs.BLEND_MODES, 'access', _271 => _271.find, 'call', _272 => _272((m) => m.id === mode), 'optionalAccess', _273 => _273.label]), () => ( mode));
       const std = _nullishCoalesce(_optionalChain([_chunkCWM3CUUXcjs.BLEND_MODES, 'access', _274 => _274.find, 'call', _275 => _275((m) => m.id === _chunkCWM3CUUXcjs.standardBlendMode.call(void 0, mode)), 'optionalAccess', _276 => _276.label]), () => ( _chunkCWM3CUUXcjs.standardBlendMode.call(void 0, mode)));

package/dist/paint-editor/index.js

@@ -7,7 +7,7 @@ import {
   resolveExternalAssets,
   serializeLayers,
   serializeLayersExternal
-} from "../chunk-ZEHTUR7Z.js";
+} from "../chunk-7ZWLDVFH.js";
 import "../chunk-3CI7FRMK.js";
 import {
   EffectRendererPool

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pixerate/editor",
-  "version": "0.189.0",
+  "version": "0.190.0",
   "description": "UI-agnostic rich text and media editing core library",
   "author": "Pixerate",
   "license": "MIT",

package/skills/pixerate-image-editor/SKILL.md

@@ -313,6 +313,12 @@ in the source frame at the document's bit depth, colour mode and profile. Read
 | `add_shape_component` | Add a live shape or path to a shape layer with `op` (`combine`, `subtract`, `intersect`, `exclude`), on top unless `index`. Use it for cut-outs, rings, badges. Returns the shape. |
 | `remove_shape_component` | Delete one component (not the last: delete the layer instead). Returns the shape. |
 | `merge_shape_components` | Merge Shape Components: the combined area becomes one plain component (live shapes become paths); the look does not change. Returns the shape. |
+| `get_vector_mask` | Read-only. A layer's vector mask: enabled, linked, inverted, fill rule, density, feather, bounds and components (subpaths in document px), or null. Read it before editing the path. |
+| `add_vector_mask` | Layer › Vector Mask on any layer but a shape: `from` `path` (a `shape`, `subpaths` or `components`, like `add_shape_layer`), `reveal-all` or `hide-all` (empty path). Reveals inside the path, sharp at any size; it combines with the raster mask. Returns the vector mask. |
+| `set_vector_mask_path` | Replace the vector mask's path (properties kept). Returns the vector mask. |
+| `set_vector_mask_properties` | `enabled`, `linked` (false: stays put when the layer moves), `inverted`, `density`, `feather` px; the path is kept. Returns the vector mask. |
+| `rasterize_vector_mask` | Multiply the path into the raster mask (adding one) and drop the vector mask, so it can be painted. Returns the mask summary. |
+| `remove_vector_mask` | Delete the vector mask (the raster mask stays). |
 | `convert_to_smart_object` | Convert sibling `layerIds` (default the active layer) to one smart object at the top one's position, optional `name`. One pixel layer keeps its id, look and properties (filters become smart filters); several layers, groups or adjustments nest as a layer document. Returns the `layer` and the `smartObject` summary. |
 | `rasterize_smart_object` | Turn a smart object into a pixel layer holding what it shows now (smart filters baked; same id, mask, effects, opacity, blend). Destructive: the contents and filters are gone. Returns the layer. |
 | `set_smart_object_transform` | Set a smart object's transform absolutely: `corners`, `matrix` (contents → document), or `scaleX` / `scaleY` (percent of the contents), `rotate`, `skewX`, `skewY`, `x`, `y` (where the contents' centre goes; unset numbers keep their values); `warp` preset or mesh in contents px, `null` removes it; `interpolation`. Re-renders from the contents. Returns `placement`, `masksMoved` and `bounds`. |

package/skills/pixerate-image-selection-masking/SKILL.md

@@ -66,7 +66,9 @@ This skill is the method. `pixerate-image-editor` has the full tool reference.
      by it), or `apply_selection_as_mask` with `kind`. Filters (`apply_effect`,
      `add_smart_filter`) are also limited to an active selection.
    - A cutout: `layer_via_copy` (the original stays), or `add_layer_mask` `from: "selection"` on
-     the layer itself.
+     the layer itself. For a hard geometric or traced edge that must stay sharp and editable
+     (a product, a screen, a window), `add_vector_mask` with the path instead; it moves and
+     transforms with the layer, and `rasterize_vector_mask` turns it into paintable pixels.
    - Painting or fills inside it: keep the selection active and paint; `stroke_selection` for
      an outline that follows it.
    - Removing what it covers: `content_aware_fill` `output: "new-layer"`.
@@ -98,7 +100,7 @@ This skill is the method. `pixerate-image-editor` has the full tool reference.
 | Tones (shadows, highlights, a luminosity mask) | `select_color_range` with `preset` `shadows` / `midtones` / `highlights` |
 | Skin for retouching | `select_color_range` `preset: "skinTones"`, then `intersect` with a box around the face |
 | An AI matte or saved mask from the host | `load_selection_from_image` (soft: no `threshold`), then `refine_selection`; `load_channel_from_image` to keep it for later |
-| An existing layer mask | `load_selection_from_mask` |
+| An existing layer mask | `load_selection_from_mask` (`source: "vector"` for a vector mask) |
 | A cutout, shape or text already on its own layer | `select_layer_transparency` (exact, soft where the layer is) |
 | A dead pixel row or column | `select_line`, then fill or heal it |
 
@@ -195,6 +197,8 @@ This skill is the method. `pixerate-image-editor` has the full tool reference.
 - `load_selection_from_mask`: a layer mask back to a selection
 - `set_selection_display`: ants, Quick Mask tint or hidden
 - `set_mask_view`: a layer mask alone in grey or as a red overlay, to check it
+- `add_vector_mask`, `set_vector_mask_path`, `set_vector_mask_properties`, `get_vector_mask`: sharp, editable path masks
+- `rasterize_vector_mask`, `remove_vector_mask`: turn a vector mask into pixels, or drop it
 - `modify_selection`: expand, contract, feather, border, smooth
 - `refine_selection`: snap the edge to the image
 - `transform_selection`: move or scale the outline only