@overtone-art/canvas-editor-core 0.2.6 → 0.2.8

package/dist/types-D60CfxL9.d.ts

@@ -0,0 +1,461 @@
+import { FabricObject } from 'fabric';
+
+type Unit = 'px' | 'mm' | 'in';
+type LayerType = 'image' | 'mask' | 'text' | 'shape' | 'template' | 'group';
+interface LayerData {
+    id: string;
+    type: LayerType;
+    name: string;
+    visible: boolean;
+    locked: boolean;
+    opacity: number;
+    /** Non-fabric metadata persisted with the layer (pattern config, etc). */
+    meta?: LayerMeta;
+}
+interface LayerMeta {
+    pattern?: PatternState;
+    mask?: {
+        width: number;
+        height: number;
+        revision: number;
+    };
+    [key: string]: unknown;
+}
+interface SerializedLayer extends LayerData {
+    fabricObject: Record<string, unknown>;
+}
+interface EditorState {
+    version: string;
+    canvas: {
+        width: number;
+        height: number;
+        unit?: Unit;
+        dpi?: number;
+    };
+    layers: SerializedLayer[];
+    background?: string;
+    backgroundImage?: Record<string, unknown> | null;
+    backgroundImageOptions?: SerializedBackgroundImageOptions | null;
+    mockup?: MockupConfig | null;
+}
+interface EditorConfig {
+    width: number;
+    height: number;
+    backgroundColor?: string;
+    fileAdapter?: FileAdapter;
+    imageProvider?: ImageProvider;
+    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;
+}
+type ExportFormat = 'png' | 'jpeg' | 'webp' | 'svg' | 'json';
+interface ResizeOptions {
+    /** Scale layer positions and dimensions with the canvas. Defaults to true. */
+    scaleContent?: boolean;
+}
+interface BackgroundImageOptions {
+    fit?: 'cover' | 'contain' | 'stretch';
+    opacity?: number;
+    /** Fabric/HTML image loading mode for remote assets. */
+    crossOrigin?: '' | 'anonymous' | 'use-credentials' | null;
+    /** Cancels the current load; never serialized. */
+    signal?: AbortSignal;
+}
+type SerializedBackgroundImageOptions = Omit<BackgroundImageOptions, 'signal'>;
+interface SemanticExportOptions extends PngLikeExportOptions {
+    /** Document keeps full-canvas coordinates; source returns native image pixels. */
+    resolution?: 'document' | 'source';
+}
+interface MaskPoint {
+    x: number;
+    y: number;
+}
+interface MaskBrushOptions {
+    mode: 'add' | 'subtract';
+    size: number;
+    /** Soft-edge inner radius ratio, from 0 (soft) to 1 (hard). */
+    hardness: number;
+}
+type MaskRefinementPrompt = {
+    type: 'point';
+    x: number;
+    y: number;
+    label: 'foreground' | 'background';
+} | {
+    type: 'rectangle';
+    left: number;
+    top: number;
+    width: number;
+    height: number;
+} | {
+    type: 'text';
+    value: string;
+};
+interface MaskRefinementRequest {
+    mask: string;
+    width: number;
+    height: number;
+    prompts: MaskRefinementPrompt[];
+}
+interface MaskRefinementResult {
+    dataUrl: string;
+    width?: number;
+    height?: number;
+    metadata?: Record<string, unknown>;
+}
+interface MaskRefinementProvider {
+    refine(request: MaskRefinementRequest, options?: {
+        signal?: AbortSignal;
+        onProgress?: (progress: number) => void;
+    }): Promise<MaskRefinementResult>;
+}
+/** Kept structural to avoid coupling the public types module to export.ts. */
+interface PngLikeExportOptions {
+    multiplier?: number;
+    quality?: number;
+}
+interface DpiIssue {
+    layerId: string;
+    layerName: string;
+    effectiveDpi: number;
+    minimumDpi: number;
+}
+interface ImageAdjustments {
+    /** Range -1 to 1. */
+    brightness?: number;
+    /** Range -1 to 1. */
+    contrast?: number;
+    /** Range -1 to 1. */
+    saturation?: number;
+    /** 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(...)`. */
+    source: string;
+    weight?: string;
+    style?: string;
+    display?: FontDisplay;
+}
+interface SvgExportOptions {
+    /** Embed registered URL/data fonts into the SVG. Defaults to true. */
+    embedFonts?: boolean;
+}
+interface LicensePayload {
+    id: string;
+    domains: string[];
+    expiresAt?: string;
+    features?: string[];
+}
+type LicenseStatus = {
+    state: 'community' | 'exempt' | 'checking';
+    payload: null;
+} | {
+    state: 'valid';
+    payload: LicensePayload;
+} | {
+    state: 'invalid' | 'expired' | 'domain-mismatch';
+    payload: LicensePayload | null;
+};
+interface LicenseConfig {
+    key?: string;
+    /** Offline signature decoder/verifier supplied by the commercial distribution. */
+    verifyOffline?: (key: string) => Promise<LicensePayload | null> | LicensePayload | null;
+    hostname?: string;
+    environment?: 'development' | 'test' | 'production';
+    onUsage?: (event: {
+        name: string;
+        at: string;
+        licenseId?: string;
+    }) => void;
+}
+interface CanvasSizePreset {
+    id: string;
+    name: string;
+    width: number;
+    height: number;
+    unit: Unit;
+    dpi: number;
+}
+interface FileAdapter {
+    save(data: Blob | string, filename: string, format: ExportFormat): Promise<string>;
+}
+interface ImageProviderResult {
+    id?: string;
+    url: string;
+    width: number;
+    height: number;
+    previewUrl?: string;
+    thumbnailUrl?: string;
+    alt?: string;
+    sourceUrl?: string;
+    attribution?: ImageAttribution;
+    /** Provider event endpoint retained for use tracking; never render this as an image. */
+    trackingUrl?: string;
+}
+interface ImageAttribution {
+    name: string;
+    url: string;
+    provider?: string;
+}
+interface ImageSearchOptions {
+    page?: number;
+    perPage?: number;
+    orientation?: 'landscape' | 'portrait' | 'squarish';
+    orderBy?: 'relevant' | 'latest';
+    contentFilter?: 'low' | 'high';
+}
+interface ImageSearchResult {
+    items: ImageProviderResult[];
+    page: number;
+    total: number;
+    totalPages: number;
+}
+interface ImageProvider {
+    upload?(file: File): Promise<ImageProviderResult>;
+    browse?(): Promise<ImageProviderResult | null>;
+    search?(query: string, options?: ImageSearchOptions): Promise<ImageSearchResult>;
+    /** Called immediately before a provider asset is inserted into the design. */
+    trackUse?(image: ImageProviderResult): Promise<void>;
+}
+interface ShapePlugin {
+    name: string;
+    icon: string;
+    category?: string;
+    create(options?: Record<string, unknown>): FabricObject;
+}
+interface TemplateParameter {
+    key: string;
+    label: string;
+    type: 'text' | 'color' | 'number' | 'font';
+    default?: string | number;
+}
+interface TemplateDefinition {
+    id: string;
+    name: string;
+    category: string;
+    svg: string;
+    parameters: TemplateParameter[];
+    preview?: string;
+}
+interface PrintifyPositioning {
+    x: number;
+    y: number;
+    scale: number;
+    angle: number;
+}
+interface NormalizedLayerPosition {
+    layerId: string;
+    name: string;
+    type: LayerType;
+    centerX: number;
+    centerY: number;
+    width: number;
+    height: number;
+    scaleX: number;
+    scaleY: number;
+    angle: number;
+}
+interface PositioningAdapter<T> {
+    readonly provider: string;
+    map(positions: NormalizedLayerPosition[], canvas: {
+        width: number;
+        height: number;
+    }): T;
+}
+interface ProjectPage {
+    id: string;
+    name: string;
+    state: EditorState;
+}
+interface ProjectState {
+    version: '1.0.0';
+    activePageId: string;
+    pages: ProjectPage[];
+}
+type TileMode = 'grid' | 'brick-horizontal' | 'brick-vertical';
+interface PatternConfig {
+    mode: TileMode;
+    /**
+     * Tile size as a % of the source image's on-canvas size (100 = natural).
+     * Smaller values pack more repeats across the print area; larger values make
+     * fewer, bigger tiles. Independent of how the source layer was placed.
+     */
+    scale: number;
+    /** Extra horizontal gap between tiles, as % of tile width. */
+    horizontalSpacing: number;
+    /** Extra vertical gap between tiles, as % of tile height. */
+    verticalSpacing: number;
+    /** Rotation of the whole pattern, in degrees. */
+    angle: number;
+    /** Brick row/column shift, as % of tile size. */
+    horizontalOffset: number;
+    /**
+     * Phase shift of the whole tile grid inside the print area, as % of tile
+     * width. The pattern object itself is pinned to the print area (it can't be
+     * dragged — that would expose bare edges), so this is how the tiling is
+     * nudged into alignment. Clamped to ±100% so coverage is never broken.
+     */
+    offsetX: number;
+    /** Phase shift of the tile grid, as % of tile height. See {@link offsetX}. */
+    offsetY: number;
+    /** Added rotation per horizontal step, in degrees. */
+    rotationStepH: number;
+    /** Added rotation per vertical step, in degrees. */
+    rotationStepV: number;
+}
+/** Fabric interaction flags frozen while a layer is rendered as a pattern. */
+interface PatternLocks {
+    lockMovementX: boolean;
+    lockMovementY: boolean;
+    lockScalingX: boolean;
+    lockScalingY: boolean;
+    lockRotation: boolean;
+    hasControls: boolean;
+}
+/** Persisted on a layer's meta while it is rendered as a repeating pattern. */
+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.
+     */
+    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.
+     */
+    originalLocks?: PatternLocks;
+    /** Original fabric transform, restored when the pattern is turned off. */
+    original: {
+        left: number;
+        top: number;
+        scaleX: number;
+        scaleY: number;
+        width: number;
+        height: number;
+        angle: number;
+        cropX: number;
+        cropY: number;
+    };
+}
+declare const DEFAULT_PATTERN_CONFIG: PatternConfig;
+interface MockupPrintArea {
+    left: number;
+    top: number;
+    width: number;
+    height: number;
+}
+type MockupBlendMode = 'normal' | 'multiply' | 'screen' | 'overlay' | 'soft-light' | 'hard-light';
+interface MockupOverlay {
+    /** Lighting, texture, or shadow image drawn above the design. */
+    image: string;
+    blendMode?: MockupBlendMode;
+    opacity?: number;
+}
+type MockupDisplacementChannel = 'red' | 'green' | 'blue' | 'alpha';
+interface MockupDisplacement {
+    /** Channel-map image cover-fitted to the mockup canvas. A value of 128 is neutral. */
+    image: string;
+    /** Maximum horizontal displacement in document pixels. Defaults to 10. */
+    scaleX?: number;
+    /** Maximum vertical displacement in document pixels. Defaults to 10. */
+    scaleY?: number;
+    /** Map channel controlling horizontal displacement. Defaults to red. */
+    channelX?: MockupDisplacementChannel;
+    /** Map channel controlling vertical displacement. Defaults to green. */
+    channelY?: MockupDisplacementChannel;
+}
+interface MockupConfig {
+    /** Garment/product image rendered behind the design. */
+    image: string;
+    /** Print-area rectangle, in canvas pixels. Drawn as a guide. */
+    printArea?: MockupPrintArea;
+    /** Clip the design to printArea. Defaults to true when printArea exists. */
+    clipToPrintArea?: boolean;
+    designBlendMode?: MockupBlendMode;
+    designOpacity?: number;
+    /** Optional channel-map warp applied to the design before compositing. */
+    displacement?: MockupDisplacement;
+    /** Optional product lighting/shadow pass rendered after the design. */
+    overlay?: MockupOverlay;
+}
+interface EditorEvents {
+    'layer:added': {
+        layer: LayerData;
+    };
+    'layer:removed': {
+        layerId: string;
+    };
+    'layer:selected': {
+        layerId: string | null;
+    };
+    'layer:modified': {
+        layerId: string;
+    };
+    'layer:reordered': {
+        layerIds: string[];
+    };
+    'layers:changed': {
+        layers: LayerData[];
+    };
+    'selection:changed': {
+        selected: string[];
+    };
+    'history:changed': {
+        canUndo: boolean;
+        canRedo: boolean;
+    };
+    'history:snapshot': {
+        bytes: number;
+        totalBytes: number;
+        entries: number;
+    };
+    'zoom:changed': {
+        zoom: number;
+    };
+    'snap:changed': {
+        enabled: boolean;
+    };
+    'crop:changed': {
+        active: boolean;
+        layerId: string | null;
+    };
+    'mockup:changed': {
+        mockup: MockupConfig | null;
+    };
+    'canvas:modified': Record<string, never>;
+    'project:changed': {
+        activePageId: string;
+        pages: Array<{
+            id: string;
+            name: string;
+        }>;
+    };
+    'export:start': {
+        format: string;
+    };
+    'export:complete': {
+        format: string;
+        url?: string;
+    };
+    error: {
+        message: string;
+        error?: unknown;
+    };
+}
+
+export { type PatternLocks as A, type BackgroundImageOptions as B, type CanvasSizePreset as C, DEFAULT_PATTERN_CONFIG as D, type EditorConfig as E, type FileAdapter as F, type PatternSourceResolver as G, type PatternState as H, type ImageAdjustments as I, type PositioningAdapter as J, type PrintifyPositioning as K, type LayerData as L, type MaskBrushOptions as M, type NormalizedLayerPosition as N, type ProjectPage as O, type PatternConfig as P, type ProjectState as Q, type ResizeOptions as R, type SemanticExportOptions as S, type SerializedBackgroundImageOptions as T, type SerializedLayer as U, type ShapePlugin as V, type SvgExportOptions as W, type TemplateDefinition as X, type TemplateParameter as Y, type TileMode as Z, type Unit as _, type DpiIssue as a, 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 LayerType as l, type LicenseConfig as m, type LicensePayload as n, type LicenseStatus as o, type MaskPoint as p, type MaskRefinementPrompt as q, type MaskRefinementProvider as r, type MaskRefinementRequest as s, type MaskRefinementResult as t, type MockupBlendMode as u, type MockupConfig as v, type MockupDisplacement as w, type MockupDisplacementChannel as x, type MockupOverlay as y, type MockupPrintArea as z };

package/package.json

@@ -1,9 +1,11 @@
 {
   "name": "@overtone-art/canvas-editor-core",
-  "version": "0.2.6",
+  "version": "0.2.8",
   "description": "Abstract pluggable canvas editor built on Fabric.js",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
+  "unpkg": "./dist/index.global.js",
+  "jsdelivr": "./dist/index.global.js",
   "types": "./dist/index.d.ts",
   "exports": {
     ".": {
@@ -15,6 +17,16 @@
         "types": "./dist/index.d.ts",
         "default": "./dist/index.js"
       }
+    },
+    "./node": {
+      "import": {
+        "types": "./dist/node.d.mts",
+        "default": "./dist/node.mjs"
+      },
+      "require": {
+        "types": "./dist/node.d.ts",
+        "default": "./dist/node.js"
+      }
     }
   },
   "files": [
@@ -25,9 +37,43 @@
   },
   "dependencies": {
     "fabric": "^7.4.0",
-    "nanoid": "^5.1.5"
+    "nanoid": "^5.1.16"
+  },
+  "peerDependencies": {
+    "fontkit": "^2.0.4",
+    "pdf-lib": "^1.17.1",
+    "pdfkit": "^0.19.1",
+    "sharp": "^0.35.0",
+    "svg-to-pdfkit": "^0.1.8"
+  },
+  "peerDependenciesMeta": {
+    "fontkit": {
+      "optional": true
+    },
+    "pdf-lib": {
+      "optional": true
+    },
+    "pdfkit": {
+      "optional": true
+    },
+    "sharp": {
+      "optional": true
+    },
+    "svg-to-pdfkit": {
+      "optional": true
+    }
   },
   "devDependencies": {
+    "@types/fontkit": "^2.0.9",
+    "@types/opentype.js": "^1.3.10",
+    "@types/pdfkit": "^0.17.6",
+    "@types/svg-to-pdfkit": "^0.1.4",
+    "fontkit": "^2.0.4",
+    "opentype.js": "^1.3.4",
+    "pdf-lib": "^1.17.1",
+    "pdfkit": "^0.19.1",
+    "sharp": "^0.35.0",
+    "svg-to-pdfkit": "^0.1.8",
     "tsup": "^8.4.0",
     "typescript": "^5.8.2",
     "vitest": "^3.2.1",
@@ -40,6 +86,7 @@
     "lint": "eslint src/",
     "type-check": "tsc --noEmit",
     "test": "vitest run",
+    "test:coverage": "vitest run --coverage",
     "test:watch": "vitest"
   }
 }