@overtone-art/canvas-editor-core 0.3.2 → 0.5.0

package/dist/node.d.mts

@@ -1,4 +1,4 @@
-import { c as EditorState } from './types-Dh1unrzT.mjs';
+import { c as EditorState } from './types-JP8MZsIs.mjs';
 import 'fabric';
 
 interface PrintPdfOptions {

package/dist/node.d.ts

@@ -1,4 +1,4 @@
-import { c as EditorState } from './types-Dh1unrzT.js';
+import { c as EditorState } from './types-JP8MZsIs.js';
 import 'fabric';
 
 interface PrintPdfOptions {

package/dist/{types-Dh1unrzT.d.mts → types-JP8MZsIs.d.mts}

@@ -21,6 +21,10 @@ interface LayerMeta {
     };
     /** Preset silhouette or texture the layer is clipped to. */
     maskPreset?: MaskPresetId;
+    /** Ordered mask stack clipping this layer (see `LayerMaskManager`). */
+    maskStack?: LayerMaskEntry[];
+    /** Marks the overlay layer that carries the whole-design mask stack. */
+    canvasMask?: boolean;
     /** Baseline curve applied to a text layer. */
     curve?: TextCurveConfig;
     /** Text box width authored before a curve widened it, in px. */
@@ -41,6 +45,36 @@ interface TextCurveConfig {
 type ShapeMaskPresetId = 'circle' | 'square' | 'triangle' | 'star' | 'heart' | 'octagram' | 'arch' | 'zigzag';
 type TextureMaskPresetId = 'vignette' | 'halftone' | 'spray' | 'grunge' | 'torn' | 'band';
 type MaskPresetId = ShapeMaskPresetId | TextureMaskPresetId;
+/**
+ * How one mask combines with the masks under it in the stack:
+ *  - `add`       — keeps what it covers, on top of what earlier masks kept (union)
+ *  - `subtract`  — punches its shape out of what earlier masks kept
+ *  - `intersect` — keeps only what it and the earlier masks both cover
+ */
+type LayerMaskMode = 'add' | 'subtract' | 'intersect';
+interface LayerMaskEntry {
+    id: string;
+    name: string;
+    mode: LayerMaskMode;
+    /**
+     * A linked mask follows the host layer's transform; an unlinked one is pinned
+     * to the canvas, so moving the layer slides the artwork under a static mask.
+     * Always false on the whole-design stack, which has no host to follow.
+     */
+    linked: boolean;
+    /** A hidden mask keeps its slot and its geometry, contributing nothing. */
+    visible: boolean;
+    /** 0…1 — a partly transparent mask reveals its area partly. */
+    opacity: number;
+    /**
+     * The mask's transform relative to its host, recorded only while the stack is
+     * composed in canvas space (an unlinked sibling forces that), so a linked mask
+     * can be re-derived after the host moves.
+     */
+    rel?: number[];
+    /** Host data describing where the geometry came from (preset id, generator…). */
+    meta?: Record<string, unknown>;
+}
 interface LayerShadowConfig {
     enabled: boolean;
     color: string;
@@ -74,8 +108,6 @@ interface EditorConfig {
     preserveObjectStacking?: boolean;
     unit?: Unit;
     dpi?: number;
-    /** Resolve a non-CORS image through a trusted proxy or same-origin store for pattern rendering. */
-    patternSourceResolver?: PatternSourceResolver;
     fonts?: FontDefinition[];
     license?: LicenseConfig;
 }
@@ -161,7 +193,6 @@ interface ImageAdjustments {
     /** Range 0 to 1. */
     blur?: number;
 }
-type PatternSourceResolver = (source: string) => Promise<string>;
 interface FontDefinition {
     family: string;
     /** URL, data URL, or a complete CSS FontFace source such as `local(...)`. */
@@ -346,28 +377,25 @@ interface PatternLocks {
     lockRotation: boolean;
     hasControls: boolean;
 }
-/** Persisted on a layer's meta while it is rendered as a repeating pattern. */
+/**
+ * Persisted on a layer's meta while it is tiled across the print area.
+ *
+ * Current states carry `config` and nothing else: the layer keeps its real
+ * object and the tiling is drawn by a render proxy, so there is no "original"
+ * to remember. The `original*` fields belong to states written by the engine
+ * that baked the tiled bitmap into the layer; they are read once, on restore,
+ * to put the artwork back (see `PatternManager.rehydrateAll`).
+ */
 interface PatternState {
     config: PatternConfig;
-    /** Original (pre-pattern) image source, as a durable data URL when possible. */
-    originalSrc: string;
-    /**
-     * Serialized `clipPath` the image carried before it became a pattern, or null
-     * if it had none. A pattern must fill the whole print area, so any pre-pattern
-     * clip (e.g. a template crop sized to the original box) is stripped while the
-     * pattern is on and re-applied when it is turned off. Persisted so it survives
-     * serialization / reload / undo.
-     */
+    /** Legacy: pre-bake image source, as a durable data URL when possible. */
+    originalSrc?: string;
+    /** Legacy: serialized `clipPath` the image carried before it was baked. */
     originalClip?: Record<string, unknown> | null;
-    /**
-     * Interaction flags the object carried before it became a pattern. A pattern
-     * fills the whole print area, so while it is on the object is locked in place
-     * (a drag/resize would slide the tiled bitmap off the area and leave a bare
-     * band); the captured flags are restored when the pattern is turned off.
-     */
+    /** Legacy: interaction flags frozen while the baked bitmap was in place. */
     originalLocks?: PatternLocks;
-    /** Original fabric transform, restored when the pattern is turned off. */
-    original: {
+    /** Legacy: fabric transform to restore when un-baking. */
+    original?: {
         left: number;
         top: number;
         scaleX: number;
@@ -439,6 +467,13 @@ interface EditorEvents {
     'layers:changed': {
         layers: LayerData[];
     };
+    'masks:changed': {
+        target: string;
+    };
+    'mask:selected': {
+        target: string | null;
+        maskId: string | null;
+    };
     'selection:changed': {
         selected: string[];
     };
@@ -485,4 +520,4 @@ interface EditorEvents {
     };
 }
 
-export { type TemplateParameter as $, type MockupOverlay as A, type BackgroundImageOptions as B, type CanvasSizePreset as C, DEFAULT_PATTERN_CONFIG as D, type EditorConfig as E, type FileAdapter as F, type MockupPrintArea as G, type PatternLocks as H, type ImageAdjustments as I, type PatternSourceResolver as J, type PatternState as K, type LayerData as L, type MaskBrushOptions as M, type NormalizedLayerPosition as N, type PositioningAdapter as O, type PatternConfig as P, type PrintifyPositioning as Q, type ProjectPage as R, type ProjectState as S, type ResizeOptions as T, type SemanticExportOptions as U, type SerializedBackgroundImageOptions as V, type SerializedLayer as W, type ShapeMaskPresetId as X, type ShapePlugin as Y, type SvgExportOptions as Z, type TemplateDefinition as _, type DpiIssue as a, type TextCurveConfig as a0, type TextureMaskPresetId as a1, type TileMode as a2, type Unit as a3, type EditorEvents as b, type EditorState as c, type ExportFormat as d, type FontDefinition as e, type ImageAttribution as f, type ImageProvider as g, type ImageProviderResult as h, type ImageSearchOptions as i, type ImageSearchResult as j, type LayerMeta as k, type LayerShadowConfig as l, type LayerType as m, type LicenseConfig as n, type LicensePayload as o, type LicenseStatus as p, type MaskPoint as q, type MaskPresetId as r, type MaskRefinementPrompt as s, type MaskRefinementProvider as t, type MaskRefinementRequest as u, type MaskRefinementResult as v, type MockupBlendMode as w, type MockupConfig as x, type MockupDisplacement as y, type MockupDisplacementChannel as z };
+export { type TemplateDefinition as $, type MockupDisplacement as A, type BackgroundImageOptions as B, type CanvasSizePreset as C, DEFAULT_PATTERN_CONFIG as D, type EditorConfig as E, type FileAdapter as F, type MockupDisplacementChannel as G, type MockupOverlay as H, type ImageAdjustments as I, type MockupPrintArea as J, type PatternLocks as K, type LayerData as L, type MaskBrushOptions as M, type NormalizedLayerPosition as N, type PatternState as O, type PatternConfig as P, type PositioningAdapter as Q, type PrintifyPositioning as R, type ProjectPage as S, type ProjectState as T, type ResizeOptions as U, type SemanticExportOptions as V, type SerializedBackgroundImageOptions as W, type SerializedLayer as X, type ShapeMaskPresetId as Y, type ShapePlugin as Z, type SvgExportOptions as _, type DpiIssue as a, type TemplateParameter as a0, type TextCurveConfig as a1, type TextureMaskPresetId as a2, type TileMode as a3, type Unit as a4, type EditorEvents as b, type EditorState as c, type ExportFormat as d, type FontDefinition as e, type ImageAttribution as f, type ImageProvider as g, type ImageProviderResult as h, type ImageSearchOptions as i, type ImageSearchResult as j, type LayerMaskEntry as k, type LayerMaskMode as l, type LayerMeta as m, type LayerShadowConfig as n, type LayerType as o, type LicenseConfig as p, type LicensePayload as q, type LicenseStatus as r, type MaskPoint as s, type MaskPresetId as t, type MaskRefinementPrompt as u, type MaskRefinementProvider as v, type MaskRefinementRequest as w, type MaskRefinementResult as x, type MockupBlendMode as y, type MockupConfig as z };

package/dist/{types-Dh1unrzT.d.ts → types-JP8MZsIs.d.ts}

@@ -21,6 +21,10 @@ interface LayerMeta {
     };
     /** Preset silhouette or texture the layer is clipped to. */
     maskPreset?: MaskPresetId;
+    /** Ordered mask stack clipping this layer (see `LayerMaskManager`). */
+    maskStack?: LayerMaskEntry[];
+    /** Marks the overlay layer that carries the whole-design mask stack. */
+    canvasMask?: boolean;
     /** Baseline curve applied to a text layer. */
     curve?: TextCurveConfig;
     /** Text box width authored before a curve widened it, in px. */
@@ -41,6 +45,36 @@ interface TextCurveConfig {
 type ShapeMaskPresetId = 'circle' | 'square' | 'triangle' | 'star' | 'heart' | 'octagram' | 'arch' | 'zigzag';
 type TextureMaskPresetId = 'vignette' | 'halftone' | 'spray' | 'grunge' | 'torn' | 'band';
 type MaskPresetId = ShapeMaskPresetId | TextureMaskPresetId;
+/**
+ * How one mask combines with the masks under it in the stack:
+ *  - `add`       — keeps what it covers, on top of what earlier masks kept (union)
+ *  - `subtract`  — punches its shape out of what earlier masks kept
+ *  - `intersect` — keeps only what it and the earlier masks both cover
+ */
+type LayerMaskMode = 'add' | 'subtract' | 'intersect';
+interface LayerMaskEntry {
+    id: string;
+    name: string;
+    mode: LayerMaskMode;
+    /**
+     * A linked mask follows the host layer's transform; an unlinked one is pinned
+     * to the canvas, so moving the layer slides the artwork under a static mask.
+     * Always false on the whole-design stack, which has no host to follow.
+     */
+    linked: boolean;
+    /** A hidden mask keeps its slot and its geometry, contributing nothing. */
+    visible: boolean;
+    /** 0…1 — a partly transparent mask reveals its area partly. */
+    opacity: number;
+    /**
+     * The mask's transform relative to its host, recorded only while the stack is
+     * composed in canvas space (an unlinked sibling forces that), so a linked mask
+     * can be re-derived after the host moves.
+     */
+    rel?: number[];
+    /** Host data describing where the geometry came from (preset id, generator…). */
+    meta?: Record<string, unknown>;
+}
 interface LayerShadowConfig {
     enabled: boolean;
     color: string;
@@ -74,8 +108,6 @@ interface EditorConfig {
     preserveObjectStacking?: boolean;
     unit?: Unit;
     dpi?: number;
-    /** Resolve a non-CORS image through a trusted proxy or same-origin store for pattern rendering. */
-    patternSourceResolver?: PatternSourceResolver;
     fonts?: FontDefinition[];
     license?: LicenseConfig;
 }
@@ -161,7 +193,6 @@ interface ImageAdjustments {
     /** Range 0 to 1. */
     blur?: number;
 }
-type PatternSourceResolver = (source: string) => Promise<string>;
 interface FontDefinition {
     family: string;
     /** URL, data URL, or a complete CSS FontFace source such as `local(...)`. */
@@ -346,28 +377,25 @@ interface PatternLocks {
     lockRotation: boolean;
     hasControls: boolean;
 }
-/** Persisted on a layer's meta while it is rendered as a repeating pattern. */
+/**
+ * Persisted on a layer's meta while it is tiled across the print area.
+ *
+ * Current states carry `config` and nothing else: the layer keeps its real
+ * object and the tiling is drawn by a render proxy, so there is no "original"
+ * to remember. The `original*` fields belong to states written by the engine
+ * that baked the tiled bitmap into the layer; they are read once, on restore,
+ * to put the artwork back (see `PatternManager.rehydrateAll`).
+ */
 interface PatternState {
     config: PatternConfig;
-    /** Original (pre-pattern) image source, as a durable data URL when possible. */
-    originalSrc: string;
-    /**
-     * Serialized `clipPath` the image carried before it became a pattern, or null
-     * if it had none. A pattern must fill the whole print area, so any pre-pattern
-     * clip (e.g. a template crop sized to the original box) is stripped while the
-     * pattern is on and re-applied when it is turned off. Persisted so it survives
-     * serialization / reload / undo.
-     */
+    /** Legacy: pre-bake image source, as a durable data URL when possible. */
+    originalSrc?: string;
+    /** Legacy: serialized `clipPath` the image carried before it was baked. */
     originalClip?: Record<string, unknown> | null;
-    /**
-     * Interaction flags the object carried before it became a pattern. A pattern
-     * fills the whole print area, so while it is on the object is locked in place
-     * (a drag/resize would slide the tiled bitmap off the area and leave a bare
-     * band); the captured flags are restored when the pattern is turned off.
-     */
+    /** Legacy: interaction flags frozen while the baked bitmap was in place. */
     originalLocks?: PatternLocks;
-    /** Original fabric transform, restored when the pattern is turned off. */
-    original: {
+    /** Legacy: fabric transform to restore when un-baking. */
+    original?: {
         left: number;
         top: number;
         scaleX: number;
@@ -439,6 +467,13 @@ interface EditorEvents {
     'layers:changed': {
         layers: LayerData[];
     };
+    'masks:changed': {
+        target: string;
+    };
+    'mask:selected': {
+        target: string | null;
+        maskId: string | null;
+    };
     'selection:changed': {
         selected: string[];
     };
@@ -485,4 +520,4 @@ interface EditorEvents {
     };
 }
 
-export { type TemplateParameter as $, type MockupOverlay as A, type BackgroundImageOptions as B, type CanvasSizePreset as C, DEFAULT_PATTERN_CONFIG as D, type EditorConfig as E, type FileAdapter as F, type MockupPrintArea as G, type PatternLocks as H, type ImageAdjustments as I, type PatternSourceResolver as J, type PatternState as K, type LayerData as L, type MaskBrushOptions as M, type NormalizedLayerPosition as N, type PositioningAdapter as O, type PatternConfig as P, type PrintifyPositioning as Q, type ProjectPage as R, type ProjectState as S, type ResizeOptions as T, type SemanticExportOptions as U, type SerializedBackgroundImageOptions as V, type SerializedLayer as W, type ShapeMaskPresetId as X, type ShapePlugin as Y, type SvgExportOptions as Z, type TemplateDefinition as _, type DpiIssue as a, type TextCurveConfig as a0, type TextureMaskPresetId as a1, type TileMode as a2, type Unit as a3, type EditorEvents as b, type EditorState as c, type ExportFormat as d, type FontDefinition as e, type ImageAttribution as f, type ImageProvider as g, type ImageProviderResult as h, type ImageSearchOptions as i, type ImageSearchResult as j, type LayerMeta as k, type LayerShadowConfig as l, type LayerType as m, type LicenseConfig as n, type LicensePayload as o, type LicenseStatus as p, type MaskPoint as q, type MaskPresetId as r, type MaskRefinementPrompt as s, type MaskRefinementProvider as t, type MaskRefinementRequest as u, type MaskRefinementResult as v, type MockupBlendMode as w, type MockupConfig as x, type MockupDisplacement as y, type MockupDisplacementChannel as z };
+export { type TemplateDefinition as $, type MockupDisplacement as A, type BackgroundImageOptions as B, type CanvasSizePreset as C, DEFAULT_PATTERN_CONFIG as D, type EditorConfig as E, type FileAdapter as F, type MockupDisplacementChannel as G, type MockupOverlay as H, type ImageAdjustments as I, type MockupPrintArea as J, type PatternLocks as K, type LayerData as L, type MaskBrushOptions as M, type NormalizedLayerPosition as N, type PatternState as O, type PatternConfig as P, type PositioningAdapter as Q, type PrintifyPositioning as R, type ProjectPage as S, type ProjectState as T, type ResizeOptions as U, type SemanticExportOptions as V, type SerializedBackgroundImageOptions as W, type SerializedLayer as X, type ShapeMaskPresetId as Y, type ShapePlugin as Z, type SvgExportOptions as _, type DpiIssue as a, type TemplateParameter as a0, type TextCurveConfig as a1, type TextureMaskPresetId as a2, type TileMode as a3, type Unit as a4, type EditorEvents as b, type EditorState as c, type ExportFormat as d, type FontDefinition as e, type ImageAttribution as f, type ImageProvider as g, type ImageProviderResult as h, type ImageSearchOptions as i, type ImageSearchResult as j, type LayerMaskEntry as k, type LayerMaskMode as l, type LayerMeta as m, type LayerShadowConfig as n, type LayerType as o, type LicenseConfig as p, type LicensePayload as q, type LicenseStatus as r, type MaskPoint as s, type MaskPresetId as t, type MaskRefinementPrompt as u, type MaskRefinementProvider as v, type MaskRefinementRequest as w, type MaskRefinementResult as x, type MockupBlendMode as y, type MockupConfig as z };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@overtone-art/canvas-editor-core",
-  "version": "0.3.2",
+  "version": "0.5.0",
   "description": "Abstract pluggable canvas editor built on Fabric.js",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",