canvas2d-wrapper 1.9.1 → 1.11.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2021-2022 Dysnomia
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2021-2025 Dysnomia
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/canvas2d-wrapper.d.ts

@@ -1,30 +1,53 @@
 declare module "canvas2d-wrapper" {
+	export type Position2D = {
+		x: number,
+		y: number
+	};
+
+	export type Surface2D = {
+		x: number,
+		y: number,
+		width: number,
+		height: number
+	};
+
+	export type Canvas2DEventCallbackParams = {
+		id: string | null,
+		element: CanvasObject | null,
+		originalEvent: Event,
+		posOnMap: Position2D
+	};
+
 	// React component
 	export type Canvas2DProps = {
-		width : number,
-		height : number,
-		trackMouseMove? : boolean,
-		minZoom? : number,
-		maxZoom? : number,
-		tileSize? : number,
-		onClick : (element : CanvasObject) => void,
-		onRightClick? : (element : CanvasObject) => void,
-		onHover? : (element : CanvasObject, { x, y } : { x : number, y : number }) => void,
-		onElementMoved? : (element : CanvasObject, x : number, y : number) => void,
-		onWheel? : (e : Event) => void,
-		onFrame : () => CanvasObject[],
-		lockXAxis? : boolean,
-		lockYAxis? : boolean,
-		smoothingQuality? : string,
-		dragObjects? : boolean,
-		deltaLeft? : number,
-		deltaTop? : number,
+		width: number,
+		height: number,
+		trackMouseMove?: boolean,
+		minZoom?: number,
+		maxZoom?: number,
+		tileSize?: number,
+		onClick: ({ id, element, originalEvent }: Canvas2DEventCallbackParams) => void,
+		onRightClick?: ({ id, element, originalEvent }: Canvas2DEventCallbackParams) => void,
+		onHover?: ({ id, element, originalEvent }?: Canvas2DEventCallbackParams | null, position: Position2D | undefined) => void,
+		onElementMoved?: (element: CanvasObject, x: number, y: number) => void,
+		onWheel?: (e: Event) => void,
+		onFrame: () => CanvasObject[],
+		lockXAxis?: boolean,
+		lockYAxis?: boolean,
+		smoothingQuality?: string,
+		dragObjects?: boolean,
+		deltaLeft?: number,
+		deltaTop?: number,
 		// Additional props
 		id: string,
 		className?: string,
+		showMinimap?: boolean,
+		minimapWidth?: number,
+		minimapHeight?: number,
+		minimapFilter?: (e: CanvasObject) => boolean,
 	};
 
-	export function Canvas2D(props : Canvas2DProps);
+	export function Canvas2D(props: Canvas2DProps);
 
 	// Shapes
 	export class CanvasObject {
@@ -36,11 +59,11 @@ declare module "canvas2d-wrapper" {
 			draggable?: boolean
 		);
 
-		get constructorName() : string;
+		get constructorName(): string;
 
-		get zIndex() : number;
+		get zIndex(): number;
 
-		set zIndex(zIndex : number);
+		set zIndex(zIndex: number);
 
 		id: string;
 		x: number;
@@ -66,7 +89,7 @@ declare module "canvas2d-wrapper" {
 	}
 
 	export class CanvasImage extends ColoredCanvasObject {
-		constructor({ id, x, y, width, height, src, zIndex, draggable } : {
+		constructor({ id, x, y, width, height, src, zIndex, draggable }: {
 			id: string,
 			x: number,
 			y: number,
@@ -77,7 +100,7 @@ declare module "canvas2d-wrapper" {
 			draggable?: boolean,
 		});
 
-		crop(sx : number, swidth : number, sheight : number);
+		crop(sx: number, swidth: number, sheight: number);
 
 		src: string;
 		width: number;
@@ -85,7 +108,7 @@ declare module "canvas2d-wrapper" {
 	}
 
 	export class Circle extends ColoredCanvasObject {
-		constructor({ id, x, y, radius, fill, stroke, zIndex, draggable } : {
+		constructor({ id, x, y, radius, fill, stroke, zIndex, draggable }: {
 			id: string,
 			x: number,
 			y: number,
@@ -99,27 +122,38 @@ declare module "canvas2d-wrapper" {
 		radius: number;
 	}
 
+	export class LinePath extends ColoredCanvasObject {
+		constructor({ id, points, stroke, zIndex }: {
+			id: string,
+			lineWidth: number,
+			points: Position2D[],
+			stroke: string,
+			zIndex?: number,
+			smoothCorners?: boolean,
+			smoothCornersRadius?: number,
+		});
+
+		points: Position2D[];
+		lineWidth: number;
+		smoothCorners?: boolean;
+		smoothCornersRadius?: number;
+	}
+
 	export class Polygon extends ColoredCanvasObject {
-		constructor({ id, x, y, width, height, src, zIndex, draggable } : {
+		constructor({ id, points, width, height, src, zIndex, draggable }: {
 			id: string,
-			points: {
-				x: number,
-				y: number,
-			}[],
+			points: Position2D[],
 			fill?: string,
 			stroke?: string,
 			zIndex?: number,
 			draggable?: boolean,
 		});
 
-		points: {
-			x: number,
-			y: number,
-		}[];
+		points: Position2D[];
 	}
 
 	export class Rect extends ColoredCanvasObject {
-		constructor({ id, x, y, width, height, src, zIndex, draggable } : {
+		constructor({ id, x, y, width, height, src, zIndex, draggable }: {
 			id: string,
 			x: number,
 			y: number,
@@ -136,17 +170,17 @@ declare module "canvas2d-wrapper" {
 	}
 
 	// Functions
-	export function preloadImages(images : string[]) : void;
+	export function preloadImages(images: string[]): void;
 
 	// Hooks
-	export function useGamepad() : { [id : string] : string };
-	export function useKeyboard() : { [id : string] : string };
-	export function useMousePosition() : {
-		x : number | null,
-		y : number | null,
+	export function useGamepad(): { [id: string]: string };
+	export function useKeyboard(): { [id: string]: string };
+	export function useMousePosition(): {
+		x: number | null,
+		y: number | null,
 	};
-	export function useWindowDimensions() : {
-		width : number,
-		height : number,
+	export function useWindowDimensions(): {
+		width: number,
+		height: number,
 	};
 }