@yorab/react-paint 0.11.7 → 0.11.21

package/README.md

@@ -1,4 +1,4 @@
-# React Paint V0.11.7
+# React Paint
 
 An open-source canvas-based library for React used for image annotation or as a digital whiteboard
 

package/dist/canvas/constants/app.d.ts

@@ -1,4 +1,4 @@
-import type { DrawableShape, Point } from './../../common/types/Shapes';
+import type { ExportedDrawableShape, Point } from './../../common/types/Shapes';
 import type { CustomToolInput } from './../../common/types/tools';
 import type { RecursivePartial } from './../../common/types/utils';
 export declare const APP_NAME = "react_paint";
@@ -29,7 +29,7 @@ type AppOptionsType = {
     withUrlPicture: boolean;
     withFrameSelection: boolean;
     withSkeleton: boolean;
-    clearCallback: 'empty' | 'defaultShapes' | (() => DrawableShape[]);
+    clearCallback: 'empty' | 'defaultShapes' | (() => ExportedDrawableShape[]);
     brushAlgo: BrushAlgo;
     isBrushShapeDoneOnMouseUp: boolean;
     canvasSelectionPadding: number;

package/dist/canvas/hooks/useReactPaint.d.ts

@@ -1,19 +1,19 @@
 import { type OptionalOptions, type UtilsSettings } from './../../canvas/constants/app';
-import type { DrawableShape, Point, ShapeEntity, StateData } from './../../common/types/Shapes';
+import type { ExportedDrawableShape, Point, ShapeEntity, StateData } from './../../common/types/Shapes';
 import type { ToolsType } from './../../common/types/tools';
 type UseReactPaintProps = {
     width?: number;
     height?: number;
-    shapes?: DrawableShape[];
+    shapes?: ExportedDrawableShape[];
     mode?: 'editor' | 'viewer';
     disabled?: boolean;
     options?: OptionalOptions;
 };
-declare const useReactPaint: ({ width, height, shapes: defaultShapes, mode, disabled, options }: UseReactPaintProps) => {
+declare const useReactPaint: ({ width, height, shapes: defaultShapes, mode, disabled, options }?: UseReactPaintProps) => {
     editorProps: {
         shapesRef: import("react").MutableRefObject<ShapeEntity[]>;
         addPictureShape: (fileOrUrl: File | string, maxWidth?: number, maxHeight?: number) => Promise<ShapeEntity<"picture">>;
-        moveShapes: (firstShapeId: string, lastShapeId: string) => void;
+        moveShapes: (startPositionShapeId: string, endPositionShapeId: string) => void;
         toggleShapeVisibility: (shape: ShapeEntity) => void;
         toggleShapeLock: (shape: ShapeEntity) => void;
         canGoBackward: boolean;
@@ -110,7 +110,7 @@ declare const useReactPaint: ({ width, height, shapes: defaultShapes, mode, disa
     };
     registerEvent: (event: "dataChanged", fn: (data: StateData, source: "user" | "remote") => void) => void;
     unregisterEvent: (event: "dataChanged", fn?: (data: StateData, source: "user" | "remote") => void) => void;
-    resetCanvas: (json?: DrawableShape[], clearHistory?: boolean) => void;
+    resetCanvas: (json?: ExportedDrawableShape[], clearHistory?: boolean) => void;
     getCurrentImage: () => string | undefined;
     getCurrentData: () => StateData;
 };

package/dist/canvas/hooks/useShapes.d.ts

@@ -11,7 +11,7 @@ declare const useShapes: (settings: UtilsSettings, width: number, height: number
     refreshSelectedShapes: (ctx: CanvasRenderingContext2D, cursorPosition: Point) => void;
     addShape: (newShape: ShapeEntity) => void;
     addPictureShape: (fileOrUrl: File | string, maxWidth?: number, maxHeight?: number) => Promise<ShapeEntity<"picture">>;
-    moveShapes: (firstShapeId: string, lastShapeId: string) => void;
+    moveShapes: (startPositionShapeId: string, endPositionShapeId: string) => void;
     saveShapes: () => void;
     setSelectedShape: import("react").Dispatch<import("react").SetStateAction<ShapeEntity | undefined>>;
     refreshHoveredShape: (e: MouseEvent | TouchEvent, ctx: CanvasRenderingContext2D, cursorPosition: Point) => void;

package/dist/canvas/utils/file.d.ts

@@ -1,5 +1,5 @@
 import type { UtilsSettings } from './../../canvas/constants/app';
-import type { DrawableShape, ShapeEntity } from './../../common/types/Shapes';
+import type { DrawableShape, ExportedDrawableShape, ShapeEntity } from './../../common/types/Shapes';
 export declare const addSizeAndConvertSvgToObjectUrl: (svgFileContent: string) => string;
 export declare const isSvg: (fileOrUrl: File | string) => boolean;
 export declare const fetchAndStringify: (url: string) => Promise<string>;
@@ -9,4 +9,4 @@ export declare const getStringifiedImage: (shape: DrawableShape<"picture">) => s
 export declare const getCanvasImage: (shapes: DrawableShape[], width: number, height: number, settings: UtilsSettings) => string;
 export declare const encodeShapesInString: (shapes: DrawableShape[], width: number, height: number) => string;
 export declare const decodeJson: (file: File) => Promise<unknown>;
-export declare const decodeImportedData: (shapesForJson: DrawableShape[], settings: UtilsSettings) => Promise<ShapeEntity[]>;
+export declare const decodeImportedData: (shapesForJson: ExportedDrawableShape[], settings: UtilsSettings) => Promise<ShapeEntity[]>;

package/dist/common/types/Shapes.d.ts

@@ -115,6 +115,7 @@ export type DrawableShape<T extends ShapeType = ShapeType> = {
     scaleX?: number;
     scaleY?: number;
 } : never);
+export type ExportedDrawableShape<T extends ShapeType = ShapeType> = T extends 'picture' ? Omit<DrawableShape<'picture'>, 'img'> : DrawableShape<T>;
 export type ShapeEntity<T extends Exclude<ShapeType, 'triangle'> = Exclude<ShapeType, 'triangle'>> = {
     id: string;
     toolId?: string;

package/dist/common/utils/array.d.ts

@@ -1 +1,2 @@
 export declare const compact: <T>(array: (T | undefined | null)[]) => T[];
+export declare const moveItemPosition: <T>(array: T[], positionToMove: number, positionToEnd: number) => T[];

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import type { OptionalOptions } from './canvas/constants/app';
 import useReactPaint from './canvas/hooks/useReactPaint';
 import Canvas from './canvas/index';
-import type { DrawableShape, StateData } from './common/types/Shapes';
+import type { ExportedDrawableShape, StateData } from './common/types/Shapes';
 import Editor from './editor/index';
+type DrawableShape = ExportedDrawableShape;
 export { Editor, Canvas, useReactPaint, type DrawableShape, type StateData, type OptionalOptions };