terra-draw 1.0.0-beta.7 → 1.0.0-beta.9

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

@@ -40,7 +40,7 @@ export declare abstract class TerraDrawBaseAdapter implements TerraDrawAdapter {
      * @returns {number} The coordinate precision.
      */
     getCoordinatePrecision(): number;
-    private getAdapterListeners;
+    protected getAdapterListeners(): AdapterListener<BasePointerListener>[];
     /**
      * Unregisters the event listeners for the current drawing mode.
      * This is typically called when switching between drawing modes or

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

@@ -25,6 +25,7 @@ export declare class TerraDrawOpenLayersAdapter extends TerraDrawBaseAdapter {
     constructor(config: {
         map: Map;
         lib: InjectableOL;
+        zIndex?: number;
     } & BaseAdapterConfig);
     private stylingFunction;
     private _lib;
@@ -47,6 +48,12 @@ export declare class TerraDrawOpenLayersAdapter extends TerraDrawBaseAdapter {
     private clearLayers;
     private addFeature;
     private removeFeature;
+    /**
+     * Sorts an array of DOM elements based on their order in the document, from earliest to latest.
+     * @param elements - An array of `HTMLElement` objects to be sorted.
+     * @returns A new array of `HTMLElement` objects sorted by their document order.
+     */
+    private sortElementsByDOMOrder;
     /**
      * 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.
@@ -107,6 +114,7 @@ export declare class TerraDrawOpenLayersAdapter extends TerraDrawBaseAdapter {
      * @returns void
      * */
     clear(): void;
+    private registeredLayerHandlers;
     register(callbacks: TerraDrawCallbacks): void;
     getCoordinatePrecision(): number;
     unregister(): void;

package/dist/common.d.ts

@@ -68,7 +68,10 @@ export declare enum UpdateTypes {
 type ValidationContext = Pick<TerraDrawModeRegisterConfig, "project" | "unproject" | "coordinatePrecision"> & {
     updateType: UpdateTypes;
 };
-export type Validation = (feature: GeoJSONStoreFeatures, context: ValidationContext) => boolean;
+export type Validation = (feature: GeoJSONStoreFeatures, context: ValidationContext) => {
+    valid: boolean;
+    reason?: string;
+};
 export type TerraDrawModeState = "unregistered" | "registered" | "started" | "drawing" | "selecting" | "stopped";
 export interface TerraDrawCallbacks {
     getState: () => TerraDrawModeState;

package/dist/extend.d.ts

@@ -1,4 +1,4 @@
 import { TerraDrawBaseAdapter, BaseAdapterConfig } from "./adapters/common/base.adapter";
-import { HexColorStyling, NumericStyling } from "./common";
+import { HexColorStyling, NumericStyling, TerraDrawCallbacks } from "./common";
 import { BaseModeOptions, TerraDrawBaseDrawMode } from "./modes/base.mode";
-export { TerraDrawBaseDrawMode, TerraDrawBaseAdapter, BaseAdapterConfig, NumericStyling, HexColorStyling, BaseModeOptions, };
+export { TerraDrawBaseDrawMode, TerraDrawBaseAdapter, BaseAdapterConfig, NumericStyling, HexColorStyling, BaseModeOptions, TerraDrawCallbacks, };

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

@@ -1,6 +1,6 @@
 import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor } from "../../common";
 import { TerraDrawBaseDrawMode, BaseModeOptions, CustomStyling } from "../base.mode";
-import { GeoJSONStoreFeatures } from "../../store/store";
+import { GeoJSONStoreFeatures, StoreValidation } from "../../store/store";
 type TerraDrawPolygonModeKeyEvents = {
     cancel?: KeyboardEvent["key"] | null;
     finish?: KeyboardEvent["key"] | null;
@@ -53,6 +53,6 @@ export declare class TerraDrawAngledRectangleMode extends TerraDrawBaseDrawMode<
     cleanUp(): void;
     /** @internal */
     styleFeature(feature: GeoJSONStoreFeatures): TerraDrawAdapterStyling;
-    validateFeature(feature: unknown): feature is GeoJSONStoreFeatures;
+    validateFeature(feature: unknown): StoreValidation;
 }
 export {};

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

@@ -40,7 +40,9 @@ export declare abstract class TerraDrawBaseDrawMode<T extends CustomStyling> {
     protected setStarted(): void;
     protected setStopped(): void;
     register(config: TerraDrawModeRegisterConfig): void;
-    validateFeature(feature: unknown): feature is GeoJSONStoreFeatures;
+    validateFeature(feature: unknown): ReturnType<Validation>;
+    private performFeatureValidation;
+    protected validateModeFeature(feature: unknown, modeValidationFn: (feature: GeoJSONStoreFeatures) => ReturnType<Validation>): ReturnType<Validation>;
     abstract start(): void;
     abstract stop(): void;
     abstract cleanUp(): void;

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

@@ -1,5 +1,5 @@
 import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor, Projection } from "../../common";
-import { GeoJSONStoreFeatures } from "../../store/store";
+import { GeoJSONStoreFeatures, StoreValidation } from "../../store/store";
 import { BaseModeOptions, CustomStyling, TerraDrawBaseDrawMode } from "../base.mode";
 type TerraDrawCircleModeKeyEvents = {
     cancel: KeyboardEvent["key"] | null;
@@ -28,6 +28,7 @@ export declare class TerraDrawCircleMode extends TerraDrawBaseDrawMode<CirclePol
     private keyEvents;
     private cursors;
     private startingRadiusKilometers;
+    private cursorMovedAfterInitialCursorDown;
     /**
      * Create a new circle mode instance
      * @param options - Options to customize the behavior of the circle mode
@@ -60,7 +61,7 @@ export declare class TerraDrawCircleMode extends TerraDrawBaseDrawMode<CirclePol
     cleanUp(): void;
     /** @internal */
     styleFeature(feature: GeoJSONStoreFeatures): TerraDrawAdapterStyling;
-    validateFeature(feature: unknown): feature is GeoJSONStoreFeatures;
+    validateFeature(feature: unknown): StoreValidation;
     private updateCircle;
 }
 export {};

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

@@ -1,6 +1,6 @@
 import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor } from "../../common";
 import { BaseModeOptions, CustomStyling, TerraDrawBaseDrawMode } from "../base.mode";
-import { GeoJSONStoreFeatures } from "../../store/store";
+import { GeoJSONStoreFeatures, StoreValidation } from "../../store/store";
 type TerraDrawFreehandModeKeyEvents = {
     cancel: KeyboardEvent["key"] | null;
     finish: KeyboardEvent["key"] | null;
@@ -22,6 +22,8 @@ interface Cursors {
 interface TerraDrawFreehandModeOptions<T extends CustomStyling> extends BaseModeOptions<T> {
     minDistance?: number;
     preventPointsNearClose?: boolean;
+    autoClose?: boolean;
+    autoCloseTimeout?: number;
     keyEvents?: TerraDrawFreehandModeKeyEvents | null;
     cursors?: Cursors;
 }
@@ -34,6 +36,10 @@ export declare class TerraDrawFreehandMode extends TerraDrawBaseDrawMode<Freehan
     private keyEvents;
     private cursors;
     private preventPointsNearClose;
+    private autoClose;
+    private autoCloseTimeout;
+    private hasLeftStartingPoint;
+    private preventNewFeature;
     constructor(options?: TerraDrawFreehandModeOptions<FreehandPolygonStyling>);
     private close;
     /** @internal */
@@ -58,6 +64,6 @@ export declare class TerraDrawFreehandMode extends TerraDrawBaseDrawMode<Freehan
     cleanUp(): void;
     /** @internal */
     styleFeature(feature: GeoJSONStoreFeatures): TerraDrawAdapterStyling;
-    validateFeature(feature: unknown): feature is GeoJSONStoreFeatures;
+    validateFeature(feature: unknown): StoreValidation;
 }
 export {};

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

@@ -1,7 +1,7 @@
 import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor } from "../../common";
 import { BaseModeOptions, CustomStyling, TerraDrawBaseDrawMode } from "../base.mode";
 import { BehaviorConfig } from "../base.behavior";
-import { GeoJSONStoreFeatures } from "../../store/store";
+import { GeoJSONStoreFeatures, StoreValidation } from "../../store/store";
 type TerraDrawLineStringModeKeyEvents = {
     cancel: KeyboardEvent["key"] | null;
     finish: KeyboardEvent["key"] | null;
@@ -73,6 +73,6 @@ export declare class TerraDrawLineStringMode extends TerraDrawBaseDrawMode<LineS
     cleanUp(): void;
     /** @internal */
     styleFeature(feature: GeoJSONStoreFeatures): TerraDrawAdapterStyling;
-    validateFeature(feature: unknown): feature is GeoJSONStoreFeatures;
+    validateFeature(feature: unknown): StoreValidation;
 }
 export {};

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

@@ -1,5 +1,5 @@
 import { TerraDrawMouseEvent, TerraDrawAdapterStyling, NumericStyling, HexColorStyling, Cursor } from "../../common";
-import { GeoJSONStoreFeatures } from "../../store/store";
+import { GeoJSONStoreFeatures, StoreValidation } from "../../store/store";
 import { BaseModeOptions, CustomStyling, TerraDrawBaseDrawMode } from "../base.mode";
 type PointModeStyling = {
     pointWidth: NumericStyling;
@@ -39,6 +39,6 @@ export declare class TerraDrawPointMode extends TerraDrawBaseDrawMode<PointModeS
     onDragEnd(): void;
     /** @internal */
     styleFeature(feature: GeoJSONStoreFeatures): TerraDrawAdapterStyling;
-    validateFeature(feature: unknown): feature is GeoJSONStoreFeatures;
+    validateFeature(feature: unknown): StoreValidation;
 }
 export {};

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

@@ -1,7 +1,7 @@
 import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor } from "../../common";
 import { TerraDrawBaseDrawMode, BaseModeOptions, CustomStyling } from "../base.mode";
 import { BehaviorConfig } from "../base.behavior";
-import { GeoJSONStoreFeatures } from "../../store/store";
+import { GeoJSONStoreFeatures, StoreValidation } from "../../store/store";
 type TerraDrawPolygonModeKeyEvents = {
     cancel?: KeyboardEvent["key"] | null;
     finish?: KeyboardEvent["key"] | null;
@@ -64,6 +64,6 @@ export declare class TerraDrawPolygonMode extends TerraDrawBaseDrawMode<PolygonS
     cleanUp(): void;
     /** @internal */
     styleFeature(feature: GeoJSONStoreFeatures): TerraDrawAdapterStyling;
-    validateFeature(feature: unknown): feature is GeoJSONStoreFeatures;
+    validateFeature(feature: unknown): StoreValidation;
 }
 export {};

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

@@ -1,5 +1,5 @@
 import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor } from "../../common";
-import { GeoJSONStoreFeatures } from "../../store/store";
+import { GeoJSONStoreFeatures, StoreValidation } from "../../store/store";
 import { BaseModeOptions, CustomStyling, TerraDrawBaseDrawMode } from "../base.mode";
 type TerraDrawRectangleModeKeyEvents = {
     cancel: KeyboardEvent["key"] | null;
@@ -50,6 +50,6 @@ export declare class TerraDrawRectangleMode extends TerraDrawBaseDrawMode<Rectan
     cleanUp(): void;
     /** @internal */
     styleFeature(feature: GeoJSONStoreFeatures): TerraDrawAdapterStyling;
-    validateFeature(feature: unknown): feature is GeoJSONStoreFeatures;
+    validateFeature(feature: unknown): StoreValidation;
 }
 export {};

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

@@ -2,6 +2,7 @@ import { HexColorStyling, NumericStyling, TerraDrawAdapterStyling } from "../../
 import { BaseModeOptions, CustomStyling, ModeTypes, TerraDrawBaseDrawMode } from "../base.mode";
 import { BehaviorConfig } from "../base.behavior";
 import { GeoJSONStoreFeatures } from "../../terra-draw";
+import { StoreValidation } from "../../store/store";
 type RenderModeStyling = {
     pointColor: HexColorStyling;
     pointWidth: NumericStyling;
@@ -47,6 +48,6 @@ export declare class TerraDrawRenderMode extends TerraDrawBaseDrawMode<RenderMod
     cleanUp(): void;
     /** @internal */
     styleFeature(feature: GeoJSONStoreFeatures): TerraDrawAdapterStyling;
-    validateFeature(feature: unknown): feature is GeoJSONStoreFeatures;
+    validateFeature(feature: unknown): StoreValidation;
 }
 export {};

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

@@ -1,6 +1,6 @@
 import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor } from "../../common";
 import { TerraDrawBaseDrawMode, BaseModeOptions, CustomStyling } from "../base.mode";
-import { GeoJSONStoreFeatures } from "../../store/store";
+import { GeoJSONStoreFeatures, StoreValidation } from "../../store/store";
 type TerraDrawSectorModeKeyEvents = {
     cancel?: KeyboardEvent["key"] | null;
     finish?: KeyboardEvent["key"] | null;
@@ -55,6 +55,6 @@ export declare class TerraDrawSectorMode extends TerraDrawBaseDrawMode<SectorPol
     cleanUp(): void;
     /** @internal */
     styleFeature(feature: GeoJSONStoreFeatures): TerraDrawAdapterStyling;
-    validateFeature(feature: unknown): feature is GeoJSONStoreFeatures;
+    validateFeature(feature: unknown): StoreValidation;
 }
 export {};

package/dist/modes/select/behaviors/drag-feature.behavior.d.ts

@@ -6,10 +6,10 @@ import { MidPointBehavior } from "./midpoint.behavior";
 import { FeatureId } from "../../../store/store";
 export declare class DragFeatureBehavior extends TerraDrawModeBehavior {
     readonly config: BehaviorConfig;
-    private readonly featuresAtMouseEvent;
+    private readonly featuresAtCursorEvent;
     private readonly selectionPoints;
     private readonly midPoints;
-    constructor(config: BehaviorConfig, featuresAtMouseEvent: FeatureAtPointerEventBehavior, selectionPoints: SelectionPointBehavior, midPoints: MidPointBehavior);
+    constructor(config: BehaviorConfig, featuresAtCursorEvent: FeatureAtPointerEventBehavior, selectionPoints: SelectionPointBehavior, midPoints: MidPointBehavior);
     private draggedFeatureId;
     private dragPosition;
     startDragging(event: TerraDrawMouseEvent, id: FeatureId): void;

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

@@ -1,6 +1,6 @@
 import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor } from "../../common";
 import { TerraDrawBaseDrawMode, BaseModeOptions, CustomStyling } from "../base.mode";
-import { GeoJSONStoreFeatures } from "../../store/store";
+import { GeoJSONStoreFeatures, StoreValidation } from "../../store/store";
 type TerraDrawSensorModeKeyEvents = {
     cancel?: KeyboardEvent["key"] | null;
     finish?: KeyboardEvent["key"] | null;
@@ -62,7 +62,7 @@ export declare class TerraDrawSensorMode extends TerraDrawBaseDrawMode<SensorPol
     cleanUp(): void;
     /** @internal */
     styleFeature(feature: GeoJSONStoreFeatures): TerraDrawAdapterStyling;
-    validateFeature(feature: unknown): feature is GeoJSONStoreFeatures;
+    validateFeature(feature: unknown): StoreValidation;
     private getDeltaBearing;
     private notInSector;
 }

package/dist/store/store-feature-validation.d.ts

@@ -1,4 +1,5 @@
-import { FeatureId, GeoJSONStoreFeatures, IdStrategy } from "./store";
+import { Validation } from "../common";
+import { FeatureId, IdStrategy } from "./store";
 export declare const StoreValidationErrors: {
     readonly FeatureHasNoId: "Feature has no id";
     readonly FeatureIsNotObject: "Feature is not object";
@@ -12,5 +13,10 @@ export declare const StoreValidationErrors: {
     readonly FeatureCoordinatesNotAnArray: "Feature coordinates is not an array";
     readonly InvalidModeProperty: "Feature does not have a valid mode property";
 };
+export declare function hasModeProperty(feature: unknown): feature is {
+    properties: {
+        mode: string;
+    };
+};
 export declare function isValidTimestamp(timestamp: unknown): boolean;
-export declare function isValidStoreFeature(feature: unknown, isValidId: IdStrategy<FeatureId>["isValidId"]): feature is GeoJSONStoreFeatures;
+export declare function isValidStoreFeature(feature: unknown, isValidId: IdStrategy<FeatureId>["isValidId"]): ReturnType<Validation>;

package/dist/store/store.d.ts

@@ -1,4 +1,5 @@
 import { Feature, Point, Polygon, LineString } from "geojson";
+import { Validation } from "../common";
 type JSON = string | number | boolean | null | JSONArray | JSONObject;
 export interface JSONObject {
     [member: string]: JSON;
@@ -8,6 +9,9 @@ type DefinedProperties = Record<string, JSON>;
 export type GeoJSONStoreGeometries = Polygon | LineString | Point;
 export type BBoxPolygon = Feature<Polygon, DefinedProperties>;
 export type GeoJSONStoreFeatures = Feature<GeoJSONStoreGeometries, DefinedProperties>;
+export type StoreValidation = {
+    id?: FeatureId;
+} & ReturnType<Validation>;
 type StoreChangeEvents = "delete" | "create" | "update" | "styling";
 export type StoreChangeHandler = (ids: FeatureId[], change: StoreChangeEvents) => void;
 export type FeatureId = string | number;
@@ -33,7 +37,7 @@ export declare class GeoJSONStore<Id extends FeatureId = FeatureId> {
     private clone;
     getId(): FeatureId;
     has(id: FeatureId): boolean;
-    load(data: GeoJSONStoreFeatures[], featureValidation?: (feature: unknown, tracked?: boolean) => boolean): void;
+    load(data: GeoJSONStoreFeatures[], featureValidation?: (feature: unknown, tracked?: boolean) => StoreValidation): StoreValidation[];
     search(bbox: BBoxPolygon, filter?: (feature: GeoJSONStoreFeatures) => boolean): GeoJSONStoreFeatures[];
     registerOnChange(onChange: StoreChangeHandler): void;
     getGeometryCopy<T extends GeoJSONStoreGeometries>(id: FeatureId): T;