@bensitu/image-editor 1.2.1 → 1.3.0

package/image-editor.d.ts

@@ -4,13 +4,16 @@ declare module '@bensitu/image-editor' {
   import { Canvas, Image as FabricImage, Object as FabricObject } from 'fabric';
 
   export interface LabelOptions {
-    getText?: (mask: MaskObject, maskIndex: number) => string;
+    /** Receives the mask and its stable zero-based creation index (`mask.maskId - 1`). */
+    getText?: (mask: MaskObject, creationIndex: number) => string;
     create?: (mask: MaskObject, fabric: any) => FabricObject;
     textOptions?: Record<string, any>;
   }
 
   export interface CropOptions {
+    /** Minimum crop rectangle width, clamped to the current image bounds. */
     minWidth?: number;
+    /** Minimum crop rectangle height, clamped to the current image bounds. */
     minHeight?: number;
     padding?: number;
     hideMasksDuringCrop?: boolean;
@@ -36,6 +39,7 @@ declare module '@bensitu/image-editor' {
     downsampleMaxWidth?: number;
     downsampleMaxHeight?: number;
     downsampleQuality?: number;
+    imageLoadTimeoutMs?: number;
 
     exportMultiplier?: number;
     exportImageAreaByDefault?: boolean;
@@ -95,7 +99,7 @@ declare module '@bensitu/image-editor' {
     radius?: number | string | ((canvas: Canvas, options: ImageEditorOptions) => number);
     rx?: number | string | ((canvas: Canvas, options: ImageEditorOptions) => number);
     ry?: number | string | ((canvas: Canvas, options: ImageEditorOptions) => number);
-    points?: Array<{ x: number; y: number }>;
+    points?: Array<{ x: number; y: number }> | Array<[number, number]>;
     color?: string;
     alpha?: number;
     gap?: number;
@@ -124,6 +128,9 @@ declare module '@bensitu/image-editor' {
   export interface Base64ExportOptions {
     exportImageArea?: boolean;
     multiplier?: number;
+    quality?: number;
+    fileType?: 'jpeg' | 'jpg' | 'png' | 'webp' | 'image/jpeg' | 'image/png' | 'image/webp';
+    format?: 'jpeg' | 'jpg' | 'png' | 'webp' | 'image/jpeg' | 'image/png' | 'image/webp';
   }
 
   export interface ImageFileExportOptions {
@@ -134,11 +141,26 @@ declare module '@bensitu/image-editor' {
     fileName?: string;
   }
 
+  export interface RemoveAllMasksOptions {
+    saveHistory?: boolean;
+  }
+
+  export interface LoadImageOptions {
+    preserveScroll?: boolean;
+  }
+
   export class ImageEditor {
     readonly options: ImageEditorOptions;
     readonly canvas: Canvas | null;
+    readonly canvasElement: HTMLCanvasElement | null;
+    readonly containerElement: HTMLElement | null;
+    readonly placeholderElement: HTMLElement | null;
+    /** @deprecated Use canvasElement instead. This alias will be removed in v2.0.0. */
     readonly canvasEl: HTMLCanvasElement | null;
+    /** @deprecated Use containerElement instead. This alias will be removed in v2.0.0. */
     readonly containerEl: HTMLElement | null;
+    /** @deprecated Use placeholderElement instead. This alias will be removed in v2.0.0. */
+    readonly placeholderEl: HTMLElement | null;
     readonly originalImage: FabricImage | null;
     readonly currentScale: number;
     readonly currentRotation: number;
@@ -149,30 +171,40 @@ declare module '@bensitu/image-editor' {
     constructor(options?: ImageEditorOptions);
 
     init(idMap?: ElementIdMap): void;
-    loadImage(base64: string): Promise<void>;
+    loadImage(imageBase64: string, options?: LoadImageOptions): Promise<void>;
     isImageLoaded(): boolean;
 
+    /** Public callers should pass only `factor`; internal history control options are intentionally not exposed. */
     scaleImage(factor: number): Promise<void>;
+    /** Public callers should pass only `degrees`; internal history control options are intentionally not exposed. */
     rotateImage(degrees: number): Promise<void>;
+    resetImageTransform(): Promise<void>;
+    /** @deprecated Use resetImageTransform() instead. This alias will be removed in v2.0.0. */
     reset(): Promise<void>;
 
+    createMask(config?: MaskConfig): MaskObject | null;
+    /** @deprecated Use createMask() instead. This alias will be removed in v2.0.0. */
     addMask(config?: MaskConfig): MaskObject | null;
     removeSelectedMask(): void;
-    removeAllMasks(): void;
+    removeAllMasks(options?: RemoveAllMasksOptions): void;
 
+    mergeMasks(): Promise<void>;
+    /** @deprecated Use mergeMasks() instead. This alias will be removed in v2.0.0. */
     merge(): Promise<void>;
     downloadImage(fileName?: string): void;
-    getImageBase64(opts?: Base64ExportOptions): Promise<string>;
-    exportImageFile(opts?: ImageFileExportOptions): Promise<File>;
+    exportImageBase64(options?: Base64ExportOptions): Promise<string>;
+    /** @deprecated Use exportImageBase64() instead. This alias will be removed in v2.0.0. */
+    getImageBase64(options?: Base64ExportOptions): Promise<string>;
+    exportImageFile(options?: ImageFileExportOptions): Promise<File>;
 
     enterCropMode(): void;
     cancelCrop(): void;
     applyCrop(): Promise<void>;
 
-    undo(): void;
-    redo(): void;
+    undo(): Promise<void>;
+    redo(): Promise<void>;
     saveState(): void;
-    loadFromState(jsonString: string | object): void;
+    loadFromState(serializedState: string | object): Promise<void>;
 
     dispose(): void;
   }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@bensitu/image-editor",
-    "version": "1.2.1",
+    "version": "1.3.0",
     "description": "Lightweight canvas-based image editor",
     "main": "./dist/image-editor.js",
     "module": "./dist/image-editor.esm.mjs",