terra-draw 0.0.1-alpha.51 → 0.0.1-alpha.54

package/README.md

@@ -22,11 +22,11 @@ Terra Draw uses the concept of 'adapters' to allow it to work with a host of dif
 
 ### Getting Started
 
-Please see the [the getting started guide](./guides/GETTING_STARTED.md) - this provides a host of information on how to get up and running with Terra Draw. You may also find some useful pointers for things you may be finding yourself wanting to do in the [common patterns guide](./guides/COMMON_PATTERNS.md).
+Please see the [the getting started guide](./guides/1.GETTING_STARTED.md) - this provides a host of information on how to get up and running with Terra Draw.
 
 ### Development
 
-Please see the [the development documentation](./guides/DEVELOPMENT.md)
+Please see the [the development documentation](./guides/6.DEVELOPMENT.md)
 
 ### Contributing
 

package/dist/adapters/arcgis-maps-sdk.adapter.d.ts

@@ -0,0 +1,105 @@
+import { SetCursor, TerraDrawCallbacks, TerraDrawChanges, TerraDrawStylingFunction } from "../common";
+import { BaseAdapterConfig, TerraDrawBaseAdapter } from "./common/base.adapter";
+import MapView from "@arcgis/core/views/MapView";
+import Point from "@arcgis/core/geometry/Point";
+import Polyline from "@arcgis/core/geometry/Polyline";
+import Polygon from "@arcgis/core/geometry/Polygon";
+import GraphicsLayer from "@arcgis/core/layers/GraphicsLayer";
+import Graphic from "@arcgis/core/Graphic";
+import SimpleMarkerSymbol from "@arcgis/core/symbols/SimpleMarkerSymbol";
+import SimpleLineSymbol from "@arcgis/core/symbols/SimpleLineSymbol";
+import SimpleFillSymbol from "@arcgis/core/symbols/SimpleFillSymbol";
+import Color from "@arcgis/core/Color";
+type InjectableArcGISMapsSDK = {
+    GraphicsLayer: typeof GraphicsLayer;
+    Point: typeof Point;
+    Polyline: typeof Polyline;
+    Polygon: typeof Polygon;
+    SimpleLineSymbol: typeof SimpleLineSymbol;
+    SimpleMarkerSymbol: typeof SimpleMarkerSymbol;
+    SimpleFillSymbol: typeof SimpleFillSymbol;
+    Graphic: typeof Graphic;
+    Color: typeof Color;
+};
+export declare class TerraDrawArcGISMapsSDKAdapter extends TerraDrawBaseAdapter {
+    private readonly _lib;
+    private readonly _mapView;
+    private readonly _container;
+    private readonly _featureIdAttributeName;
+    private readonly _featureLayerName;
+    private readonly _featureLayer;
+    private _dragEnabled;
+    private _zoomEnabled;
+    private _dragHandler;
+    private _doubleClickHandler;
+    constructor(config: {
+        map: MapView;
+        lib: InjectableArcGISMapsSDK;
+    } & BaseAdapterConfig);
+    register(callbacks: TerraDrawCallbacks): void;
+    unregister(): void;
+    /**
+     * Returns the longitude and latitude coordinates from a given PointerEvent on the map.
+     * @param event The PointerEvent or MouseEvent  containing the screen coordinates of the pointer.
+     * @returns An object with 'lng' and 'lat' properties representing the longitude and latitude, or null if the conversion is not possible.
+     */
+    getLngLatFromEvent(event: PointerEvent | MouseEvent): {
+        lng: number;
+        lat: number;
+    };
+    /**
+     * Retrieves the HTML element of the ArcGIS element that handles interaction events
+     * @returns The HTMLElement representing the map container.
+     */
+    getMapEventElement(): HTMLElement;
+    /**
+     * Enables or disables the draggable functionality of the map.
+     * @param enabled Set to true to enable map dragging, or false to disable it.
+     */
+    setDraggability(enabled: boolean): void;
+    /**
+     * Converts longitude and latitude coordinates to pixel coordinates in the map container.
+     * @param lng The longitude coordinate to project.
+     * @param lat The latitude coordinate to project.
+     * @returns An object with 'x' and 'y' properties representing the pixel coordinates within the map container.
+     */
+    project(lng: number, lat: number): {
+        x: number;
+        y: number;
+    };
+    /**
+     * Converts pixel coordinates in the map container to longitude and latitude coordinates.
+     * @param x The x-coordinate in the map container to unproject.
+     * @param y The y-coordinate in the map container to unproject.
+     * @returns An object with 'lng' and 'lat' properties representing the longitude and latitude coordinates.
+     */
+    unproject(x: number, y: number): {
+        lng: number;
+        lat: number;
+    };
+    /**
+     * Sets the cursor style for the map container.
+     * @param cursor The CSS cursor style to apply, or 'unset' to remove any previously applied cursor style.
+     */
+    setCursor(cursor: Parameters<SetCursor>[0]): void;
+    /**
+     * Enables or disables the double-click to zoom functionality on the map.
+     * @param enabled Set to true to enable double-click to zoom, or false to disable it.
+     */
+    setDoubleClickToZoom(enabled: boolean): void;
+    /**
+     * Renders GeoJSON features on the map using the provided styling configuration.
+     * @param changes An object containing arrays of created, updated, and unchanged features to render.
+     * @param styling An object mapping draw modes to feature styling functions
+     */
+    render(changes: TerraDrawChanges, styling: TerraDrawStylingFunction): void;
+    /**
+     * Clears the map and store of all rendered data layers
+     * @returns void
+     * */
+    clear(): void;
+    private removeFeatureById;
+    private addFeature;
+    private getColorFromHex;
+}
+export {};

package/dist/adapters/common/base.adapter.d.ts

@@ -3,13 +3,14 @@ import { AdapterListener } from "./adapter-listener";
 type BasePointerListener = (event: PointerEvent) => void;
 type BaseKeyboardListener = (event: KeyboardEvent) => void;
 type BaseMouseListener = (event: MouseEvent) => void;
+export type BaseAdapterConfig = {
+    coordinatePrecision?: number;
+    minPixelDragDistanceDrawing?: number;
+    minPixelDragDistance?: number;
+    minPixelDragDistanceSelecting?: number;
+};
 export declare abstract class TerraDrawBaseAdapter {
-    constructor(config: {
-        coordinatePrecision?: number;
-        minPixelDragDistanceDrawing?: number;
-        minPixelDragDistance?: number;
-        minPixelDragDistanceSelecting?: number;
-    });
+    constructor(config: BaseAdapterConfig);
     protected _minPixelDragDistance: number;
     protected _minPixelDragDistanceDrawing: number;
     protected _minPixelDragDistanceSelecting: number;
@@ -33,6 +34,12 @@ export declare abstract class TerraDrawBaseAdapter {
      * for handling various drawing events in the current mode.
      */
     register(callbacks: TerraDrawCallbacks): void;
+    /**
+     * Gets the coordinate precision.
+     * @returns {number} The coordinate precision.
+     * @description The coordinate precision is the number of decimal places. Note that the precision will be overriden by the precision of the TerraDraw Adapter.
+     */
+    getCoordinatePrecision(): number;
     private getAdapterListeners;
     /**
      * Unregisters the event listeners for the current drawing mode.

package/dist/adapters/google-maps.adapter.d.ts

@@ -1,12 +1,11 @@
 /// <reference types="google.maps" />
 import { TerraDrawChanges, SetCursor, TerraDrawStylingFunction, TerraDrawCallbacks } from "../common";
-import { TerraDrawBaseAdapter } from "./common/base.adapter";
+import { BaseAdapterConfig, TerraDrawBaseAdapter } from "./common/base.adapter";
 export declare class TerraDrawGoogleMapsAdapter extends TerraDrawBaseAdapter {
     constructor(config: {
         lib: typeof google.maps;
         map: google.maps.Map;
-        coordinatePrecision?: number;
-    });
+    } & BaseAdapterConfig);
     private _cursor;
     private _cursorStyleSheet;
     private _lib;

package/dist/adapters/leaflet.adapter.d.ts

@@ -1,13 +1,11 @@
 import { TerraDrawChanges, SetCursor, TerraDrawStylingFunction } from "../common";
 import L from "leaflet";
-import { TerraDrawBaseAdapter } from "./common/base.adapter";
+import { BaseAdapterConfig, TerraDrawBaseAdapter } from "./common/base.adapter";
 export declare class TerraDrawLeafletAdapter extends TerraDrawBaseAdapter {
     constructor(config: {
         lib: typeof L;
         map: L.Map;
-        coordinatePrecision?: number;
-        minPixelDragDistance?: number;
-    });
+    } & BaseAdapterConfig);
     private _lib;
     private _map;
     private _panes;

package/dist/adapters/mapbox-gl.adapter.d.ts

@@ -1,11 +1,10 @@
 import { TerraDrawChanges, SetCursor, TerraDrawStylingFunction } from "../common";
 import mapboxgl from "mapbox-gl";
-import { TerraDrawBaseAdapter } from "./common/base.adapter";
+import { BaseAdapterConfig, TerraDrawBaseAdapter } from "./common/base.adapter";
 export declare class TerraDrawMapboxGLAdapter extends TerraDrawBaseAdapter {
     constructor(config: {
         map: mapboxgl.Map;
-        coordinatePrecision?: number;
-    });
+    } & BaseAdapterConfig);
     private _nextRender;
     private _map;
     private _container;

package/dist/adapters/maplibre-gl.adapter.d.ts

@@ -1,12 +1,11 @@
 import { TerraDrawChanges, SetCursor, TerraDrawStylingFunction, TerraDrawCallbacks } from "../common";
 import { Map } from "maplibre-gl";
-import { TerraDrawBaseAdapter } from "./common/base.adapter";
+import { BaseAdapterConfig, TerraDrawBaseAdapter } from "./common/base.adapter";
 export declare class TerraDrawMapLibreGLAdapter extends TerraDrawBaseAdapter {
     private mapboxglAdapter;
     constructor(config: {
         map: Map;
-        coordinatePrecision?: number;
-    });
+    } & BaseAdapterConfig);
     register(callbacks: TerraDrawCallbacks): void;
     unregister(): void;
     /**

package/dist/adapters/openlayers.adapter.d.ts

@@ -9,7 +9,7 @@ import Style from "ol/style/Style";
 import VectorSource from "ol/source/Vector";
 import VectorLayer from "ol/layer/Vector";
 import { toLonLat } from "ol/proj";
-import { TerraDrawBaseAdapter } from "./common/base.adapter";
+import { BaseAdapterConfig, TerraDrawBaseAdapter } from "./common/base.adapter";
 type InjectableOL = {
     Circle: typeof CircleGeom;
     Feature: typeof Feature;
@@ -25,8 +25,7 @@ export declare class TerraDrawOpenLayersAdapter extends TerraDrawBaseAdapter {
     constructor(config: {
         map: Map;
         lib: InjectableOL;
-        coordinatePrecision?: number;
-    });
+    } & BaseAdapterConfig);
     private stylingFunction;
     private _lib;
     private _map;

package/dist/common.d.ts

@@ -56,6 +56,7 @@ export interface TerraDrawModeRegisterConfig {
     onFinish: (finishedId: string) => void;
     project: Project;
     unproject: Unproject;
+    coordinatePrecision: number;
 }
 export type TerraDrawModeState = "unregistered" | "registered" | "started" | "drawing" | "selecting" | "stopped";
 export interface TerraDrawCallbacks {
@@ -89,6 +90,7 @@ export interface TerraDrawAdapter {
     unregister(): void;
     render(changes: TerraDrawChanges, styling: TerraDrawStylingFunction): void;
     clear(): void;
+    getCoordinatePrecision(): number;
 }
 export declare const SELECT_PROPERTIES: {
     readonly SELECTED: "selected";

package/dist/modes/base.mode.d.ts

@@ -1,13 +1,17 @@
 import { BehaviorConfig, TerraDrawModeBehavior } from "./base.behavior";
 import { HexColor, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, TerraDrawModeRegisterConfig, TerraDrawModeState, TerraDrawMouseEvent } from "../common";
 import { GeoJSONStore, GeoJSONStoreFeatures, StoreChangeHandler } from "../store/store";
-type CustomStyling = Record<string, string | number | ((feature: GeoJSONStoreFeatures) => HexColor) | ((feature: GeoJSONStoreFeatures) => number)>;
+export type CustomStyling = Record<string, string | number | ((feature: GeoJSONStoreFeatures) => HexColor) | ((feature: GeoJSONStoreFeatures) => number)>;
 export declare enum ModeTypes {
     Drawing = "drawing",
     Select = "select",
     Static = "static",
     Render = "render"
 }
+export type BaseModeOptions<T extends CustomStyling> = {
+    styles?: Partial<T>;
+    pointerDistance?: number;
+};
 export declare abstract class TerraDrawBaseDrawMode<T extends CustomStyling> {
     protected _state: TerraDrawModeState;
     get state(): TerraDrawModeState;
@@ -25,11 +29,7 @@ export declare abstract class TerraDrawBaseDrawMode<T extends CustomStyling> {
     protected project: TerraDrawModeRegisterConfig["project"];
     protected setCursor: TerraDrawModeRegisterConfig["setCursor"];
     protected registerBehaviors(behaviorConfig: BehaviorConfig): void;
-    constructor(options?: {
-        styles?: Partial<T>;
-        pointerDistance?: number;
-        coordinatePrecision?: number;
-    });
+    constructor(options?: BaseModeOptions<T>);
     type: ModeTypes;
     mode: string;
     protected setDrawing(): void;
@@ -55,4 +55,3 @@ export declare abstract class TerraDrawBaseDrawMode<T extends CustomStyling> {
     protected getNumericStylingValue(value: number | ((feature: GeoJSONStoreFeatures) => number) | undefined, defaultValue: number, feature: GeoJSONStoreFeatures): number;
     private getStylingValue;
 }
-export {};

package/dist/modes/circle/circle.mode.d.ts

@@ -1,6 +1,6 @@
 import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor } from "../../common";
 import { GeoJSONStoreFeatures } from "../../store/store";
-import { TerraDrawBaseDrawMode } from "../base.mode";
+import { BaseModeOptions, CustomStyling, TerraDrawBaseDrawMode } from "../base.mode";
 type TerraDrawCircleModeKeyEvents = {
     cancel: KeyboardEvent["key"] | null;
     finish: KeyboardEvent["key"] | null;
@@ -14,6 +14,10 @@ type CirclePolygonStyling = {
 interface Cursors {
     start?: Cursor;
 }
+interface TerraDrawCircleModeOptions<T extends CustomStyling> extends BaseModeOptions<T> {
+    keyEvents?: TerraDrawCircleModeKeyEvents | null;
+    cursors?: Cursors;
+}
 export declare class TerraDrawCircleMode extends TerraDrawBaseDrawMode<CirclePolygonStyling> {
     mode: string;
     private center;
@@ -21,11 +25,7 @@ export declare class TerraDrawCircleMode extends TerraDrawBaseDrawMode<CirclePol
     private currentCircleId;
     private keyEvents;
     private cursors;
-    constructor(options?: {
-        styles?: Partial<CirclePolygonStyling>;
-        keyEvents?: TerraDrawCircleModeKeyEvents | null;
-        cursors?: Cursors;
-    });
+    constructor(options?: TerraDrawCircleModeOptions<CirclePolygonStyling>);
     private close;
     /** @internal */
     start(): void;
@@ -50,5 +50,6 @@ export declare class TerraDrawCircleMode extends TerraDrawBaseDrawMode<CirclePol
     /** @internal */
     styleFeature(feature: GeoJSONStoreFeatures): TerraDrawAdapterStyling;
     validateFeature(feature: unknown): feature is GeoJSONStoreFeatures;
+    private createCircle;
 }
 export {};

package/dist/modes/freehand/freehand.mode.d.ts

@@ -1,5 +1,5 @@
 import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor } from "../../common";
-import { TerraDrawBaseDrawMode } from "../base.mode";
+import { BaseModeOptions, CustomStyling, TerraDrawBaseDrawMode } from "../base.mode";
 import { GeoJSONStoreFeatures } from "../../store/store";
 type TerraDrawFreehandModeKeyEvents = {
     cancel: KeyboardEvent["key"] | null;
@@ -19,6 +19,12 @@ interface Cursors {
     start?: Cursor;
     close?: Cursor;
 }
+interface TerraDrawFreehandModeOptions<T extends CustomStyling> extends BaseModeOptions<T> {
+    minDistance?: number;
+    preventPointsNearClose?: boolean;
+    keyEvents?: TerraDrawFreehandModeKeyEvents | null;
+    cursors?: Cursors;
+}
 export declare class TerraDrawFreehandMode extends TerraDrawBaseDrawMode<FreehandPolygonStyling> {
     mode: string;
     private startingClick;
@@ -28,13 +34,7 @@ export declare class TerraDrawFreehandMode extends TerraDrawBaseDrawMode<Freehan
     private keyEvents;
     private cursors;
     private preventPointsNearClose;
-    constructor(options?: {
-        styles?: Partial<FreehandPolygonStyling>;
-        minDistance?: number;
-        preventPointsNearClose?: boolean;
-        keyEvents?: TerraDrawFreehandModeKeyEvents | null;
-        cursors?: Cursors;
-    });
+    constructor(options?: TerraDrawFreehandModeOptions<FreehandPolygonStyling>);
     private close;
     /** @internal */
     start(): void;

package/dist/modes/greatcircle/great-circle.mode.d.ts

@@ -1,5 +1,5 @@
 import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor } from "../../common";
-import { TerraDrawBaseDrawMode } from "../base.mode";
+import { BaseModeOptions, CustomStyling, TerraDrawBaseDrawMode } from "../base.mode";
 import { BehaviorConfig } from "../base.behavior";
 import { GeoJSONStoreFeatures } from "../../store/store";
 type TerraDrawGreateCircleModeKeyEvents = {
@@ -18,6 +18,12 @@ interface Cursors {
     start?: Cursor;
     close?: Cursor;
 }
+interface TerraDrawGreatCircleModeOptions<T extends CustomStyling> extends BaseModeOptions<T> {
+    snapping?: boolean;
+    pointerDistance?: number;
+    keyEvents?: TerraDrawGreateCircleModeKeyEvents | null;
+    cursors?: Cursors;
+}
 export declare class TerraDrawGreatCircleMode extends TerraDrawBaseDrawMode<GreateCircleStyling> {
     mode: string;
     private currentCoordinate;
@@ -27,13 +33,7 @@ export declare class TerraDrawGreatCircleMode extends TerraDrawBaseDrawMode<Grea
     private snappingEnabled;
     private cursors;
     private snapping;
-    constructor(options?: {
-        snapping?: boolean;
-        pointerDistance?: number;
-        styles?: Partial<GreateCircleStyling>;
-        keyEvents?: TerraDrawGreateCircleModeKeyEvents | null;
-        cursors?: Cursors;
-    });
+    constructor(options?: TerraDrawGreatCircleModeOptions<GreateCircleStyling>);
     private close;
     /** @internal */
     registerBehaviors(config: BehaviorConfig): void;

package/dist/modes/linestring/linestring.mode.d.ts

@@ -1,5 +1,5 @@
 import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor } from "../../common";
-import { TerraDrawBaseDrawMode } from "../base.mode";
+import { BaseModeOptions, CustomStyling, TerraDrawBaseDrawMode } from "../base.mode";
 import { BehaviorConfig } from "../base.behavior";
 import { GeoJSONStoreFeatures } from "../../store/store";
 type TerraDrawLineStringModeKeyEvents = {
@@ -18,6 +18,13 @@ interface Cursors {
     start?: Cursor;
     close?: Cursor;
 }
+interface TerraDrawLineStringModeOptions<T extends CustomStyling> extends BaseModeOptions<T> {
+    snapping?: boolean;
+    allowSelfIntersections?: boolean;
+    pointerDistance?: number;
+    keyEvents?: TerraDrawLineStringModeKeyEvents | null;
+    cursors?: Cursors;
+}
 export declare class TerraDrawLineStringMode extends TerraDrawBaseDrawMode<LineStringStyling> {
     mode: string;
     private currentCoordinate;
@@ -29,14 +36,7 @@ export declare class TerraDrawLineStringMode extends TerraDrawBaseDrawMode<LineS
     private cursors;
     private mouseMove;
     private snapping;
-    constructor(options?: {
-        snapping?: boolean;
-        allowSelfIntersections?: boolean;
-        pointerDistance?: number;
-        styles?: Partial<LineStringStyling>;
-        keyEvents?: TerraDrawLineStringModeKeyEvents | null;
-        cursors?: Cursors;
-    });
+    constructor(options?: TerraDrawLineStringModeOptions<LineStringStyling>);
     private close;
     /** @internal */
     registerBehaviors(config: BehaviorConfig): void;

package/dist/modes/point/point.mode.d.ts

@@ -1,6 +1,6 @@
 import { TerraDrawMouseEvent, TerraDrawAdapterStyling, NumericStyling, HexColorStyling, Cursor } from "../../common";
 import { GeoJSONStoreFeatures } from "../../store/store";
-import { TerraDrawBaseDrawMode } from "../base.mode";
+import { BaseModeOptions, CustomStyling, TerraDrawBaseDrawMode } from "../base.mode";
 type PointModeStyling = {
     pointWidth: NumericStyling;
     pointColor: HexColorStyling;
@@ -10,13 +10,13 @@ type PointModeStyling = {
 interface Cursors {
     create?: Cursor;
 }
+interface TerraDrawPointModeOptions<T extends CustomStyling> extends BaseModeOptions<T> {
+    cursors?: Cursors;
+}
 export declare class TerraDrawPointMode extends TerraDrawBaseDrawMode<PointModeStyling> {
     mode: string;
     private cursors;
-    constructor(options?: {
-        styles?: Partial<PointModeStyling>;
-        cursors?: Cursors;
-    });
+    constructor(options?: TerraDrawPointModeOptions<PointModeStyling>);
     /** @internal */
     start(): void;
     /** @internal */

package/dist/modes/polygon/polygon.mode.d.ts

@@ -1,5 +1,5 @@
 import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor } from "../../common";
-import { TerraDrawBaseDrawMode } from "../base.mode";
+import { TerraDrawBaseDrawMode, BaseModeOptions, CustomStyling } from "../base.mode";
 import { BehaviorConfig } from "../base.behavior";
 import { GeoJSONStoreFeatures } from "../../store/store";
 type TerraDrawPolygonModeKeyEvents = {
@@ -20,6 +20,13 @@ interface Cursors {
     start?: Cursor;
     close?: Cursor;
 }
+interface TerraDrawPolygonModeOptions<T extends CustomStyling> extends BaseModeOptions<T> {
+    allowSelfIntersections?: boolean;
+    snapping?: boolean;
+    pointerDistance?: number;
+    keyEvents?: TerraDrawPolygonModeKeyEvents | null;
+    cursors?: Cursors;
+}
 export declare class TerraDrawPolygonMode extends TerraDrawBaseDrawMode<PolygonStyling> {
     mode: string;
     private currentCoordinate;
@@ -32,14 +39,7 @@ export declare class TerraDrawPolygonMode extends TerraDrawBaseDrawMode<PolygonS
     private closingPoints;
     private cursors;
     private mouseMove;
-    constructor(options?: {
-        allowSelfIntersections?: boolean;
-        snapping?: boolean;
-        pointerDistance?: number;
-        styles?: Partial<PolygonStyling>;
-        keyEvents?: TerraDrawPolygonModeKeyEvents | null;
-        cursors?: Cursors;
-    });
+    constructor(options?: TerraDrawPolygonModeOptions<PolygonStyling>);
     private close;
     /** @internal */
     registerBehaviors(config: BehaviorConfig): void;

package/dist/modes/rectangle/rectangle.mode.d.ts

@@ -1,6 +1,6 @@
 import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor } from "../../common";
 import { GeoJSONStoreFeatures } from "../../store/store";
-import { TerraDrawBaseDrawMode } from "../base.mode";
+import { BaseModeOptions, CustomStyling, TerraDrawBaseDrawMode } from "../base.mode";
 type TerraDrawRectangleModeKeyEvents = {
     cancel: KeyboardEvent["key"] | null;
     finish: KeyboardEvent["key"] | null;
@@ -14,6 +14,10 @@ type RectanglePolygonStyling = {
 interface Cursors {
     start?: Cursor;
 }
+interface TerraDrawRectangleModeOptions<T extends CustomStyling> extends BaseModeOptions<T> {
+    keyEvents?: TerraDrawRectangleModeKeyEvents | null;
+    cursors?: Cursors;
+}
 export declare class TerraDrawRectangleMode extends TerraDrawBaseDrawMode<RectanglePolygonStyling> {
     mode: string;
     private center;
@@ -21,11 +25,7 @@ export declare class TerraDrawRectangleMode extends TerraDrawBaseDrawMode<Rectan
     private currentRectangleId;
     private keyEvents;
     private cursors;
-    constructor(options?: {
-        styles?: Partial<RectanglePolygonStyling>;
-        keyEvents?: TerraDrawRectangleModeKeyEvents | null;
-        cursors?: Cursors;
-    });
+    constructor(options?: TerraDrawRectangleModeOptions<RectanglePolygonStyling>);
     private updateRectangle;
     private close;
     /** @internal */

package/dist/modes/render/render.mode.d.ts

@@ -1,5 +1,5 @@
 import { HexColorStyling, NumericStyling, TerraDrawAdapterStyling } from "../../common";
-import { ModeTypes, TerraDrawBaseDrawMode } from "../base.mode";
+import { BaseModeOptions, CustomStyling, ModeTypes, TerraDrawBaseDrawMode } from "../base.mode";
 import { BehaviorConfig } from "../base.behavior";
 import { GeoJSONStoreFeatures } from "../../terra-draw";
 type RenderModeStyling = {
@@ -15,13 +15,14 @@ type RenderModeStyling = {
     lineStringColor: HexColorStyling;
     zIndex: NumericStyling;
 };
+interface TerraDrawRenderModeOptions<T extends CustomStyling> extends BaseModeOptions<T> {
+    modeName: string;
+    styles: Partial<T>;
+}
 export declare class TerraDrawRenderMode extends TerraDrawBaseDrawMode<RenderModeStyling> {
     type: ModeTypes;
     mode: string;
-    constructor(options: {
-        modeName: string;
-        styles: Partial<RenderModeStyling>;
-    });
+    constructor(options: TerraDrawRenderModeOptions<RenderModeStyling>);
     /** @internal */
     registerBehaviors(behaviorConfig: BehaviorConfig): void;
     /** @internal */

package/dist/modes/select/select.mode.d.ts

@@ -1,5 +1,5 @@
 import { TerraDrawMouseEvent, TerraDrawKeyboardEvent, TerraDrawAdapterStyling, HexColorStyling, NumericStyling, Cursor } from "../../common";
-import { ModeTypes, TerraDrawBaseDrawMode } from "../base.mode";
+import { BaseModeOptions, CustomStyling, ModeTypes, TerraDrawBaseDrawMode } from "../base.mode";
 import { BehaviorConfig } from "../base.behavior";
 import { GeoJSONStoreFeatures } from "../../store/store";
 type TerraDrawSelectModeKeyEvents = {
@@ -47,6 +47,15 @@ interface Cursors {
     dragEnd?: Cursor;
     insertMidpoint?: Cursor;
 }
+interface TerraDrawSelectModeOptions<T extends CustomStyling> extends BaseModeOptions<T> {
+    pointerDistance?: number;
+    flags?: {
+        [mode: string]: ModeFlags;
+    };
+    keyEvents?: TerraDrawSelectModeKeyEvents | null;
+    dragEventThrottle?: number;
+    cursors?: Cursors;
+}
 export declare class TerraDrawSelectMode extends TerraDrawBaseDrawMode<SelectionStyling> {
     type: ModeTypes;
     mode: string;
@@ -65,16 +74,7 @@ export declare class TerraDrawSelectMode extends TerraDrawBaseDrawMode<Selection
     private rotateFeature;
     private scaleFeature;
     private cursors;
-    constructor(options?: {
-        styles?: Partial<SelectionStyling>;
-        pointerDistance?: number;
-        flags?: {
-            [mode: string]: ModeFlags;
-        };
-        keyEvents?: TerraDrawSelectModeKeyEvents | null;
-        dragEventThrottle?: number;
-        cursors?: Cursors;
-    });
+    constructor(options?: TerraDrawSelectModeOptions<SelectionStyling>);
     setSelecting(): void;
     registerBehaviors(config: BehaviorConfig): void;
     private deselect;