terra-draw 1.4.3 → 1.6.0

package/README.md

@@ -17,10 +17,10 @@ Terra Draw centralizes map drawing logic and provides a host of out-of-the-box d
 
 Terra Draw works with your mapping library of choice via adapters. Please pick the adapter for the mapping library you are working with:
 
-* [terra-draw-maplibre-gl-js-adapter](https://www.npmjs.com/package/terra-draw-maplibre-gl-js-adapter)
+* [terra-draw-maplibre-gl-adapter](https://www.npmjs.com/package/terra-draw-maplibre-gl-adapter)
 * [terra-draw-leaflet-adapter](https://www.npmjs.com/package/terra-draw-leaflet-adapter)
 * [terra-draw-google-maps-adapter](https://www.npmjs.com/package/terra-draw-googl-emaps-adapter)
-* [terra-draw-mapbox-gl-js-adapter](https://www.npmjs.com/package/terra-draw-mapbox-gl-js-adapter)
+* [terra-draw-mapbox-gl-adapter](https://www.npmjs.com/package/terra-draw-mapbox-gl-adapter)
 * [terra-draw-google-maps-adapter](https://www.npmjs.com/package/terra-draw-google-maps-adapter)
 * [terra-draw-arcgis-adapter](https://www.npmjs.com/package/terra-draw-arcgis-adapter)
 

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

@@ -11,6 +11,7 @@ export type BaseAdapterConfig = {
 };
 export declare abstract class TerraDrawBaseAdapter implements TerraDrawAdapter {
     constructor(config: BaseAdapterConfig);
+    private _nextKeyUpIsContextMenu;
     protected _minPixelDragDistance: number;
     protected _minPixelDragDistanceDrawing: number;
     protected _minPixelDragDistanceSelecting: number;
@@ -26,7 +27,7 @@ export declare abstract class TerraDrawBaseAdapter implements TerraDrawAdapter {
         containerX: number;
         containerY: number;
     };
-    protected getDrawEventFromEvent(event: PointerEvent | MouseEvent): TerraDrawMouseEvent | null;
+    protected getDrawEventFromEvent(event: PointerEvent | MouseEvent, isContextMenu?: boolean): TerraDrawMouseEvent | null;
     /**
      * Registers the provided callbacks for the current drawing mode and attaches
      * the necessary event listeners.

package/dist/common.d.ts

@@ -26,6 +26,7 @@ export interface TerraDrawMouseEvent {
     containerY: number;
     button: "neither" | "left" | "middle" | "right";
     heldKeys: string[];
+    isContextMenu: boolean;
 }
 export interface TerraDrawKeyboardEvent {
     key: string;
@@ -48,12 +49,16 @@ export type OnFinishContext = {
     mode: string;
     action: string;
 };
+export type OnChangeContext = {
+    origin: "api";
+};
+export type TerraDrawGeoJSONStore = GeoJSONStore<OnChangeContext | undefined, FeatureId>;
 export interface TerraDrawModeRegisterConfig {
     mode: string;
-    store: GeoJSONStore;
+    store: TerraDrawGeoJSONStore;
     setDoubleClickToZoom: (enabled: boolean) => void;
     setCursor: SetCursor;
-    onChange: StoreChangeHandler;
+    onChange: StoreChangeHandler<OnChangeContext | undefined>;
     onSelect: (selectedId: string) => void;
     onDeselect: (deselectedId: string) => void;
     onFinish: (finishedId: string, context: OnFinishContext) => void;
@@ -118,6 +123,14 @@ export declare const COMMON_PROPERTIES: {
     CLOSING_POINT: string;
     SNAPPING_POINT: string;
     COORDINATE_POINT: string;
+    COORDINATE_POINT_FEATURE_ID: string;
     COORDINATE_POINT_IDS: string;
 };
+export declare const Z_INDEX: {
+    readonly LAYER_ONE: 10;
+    readonly LAYER_TWO: 20;
+    readonly LAYER_THREE: 30;
+    readonly LAYER_FOUR: 40;
+    readonly LAYER_FIVE: 50;
+};
 export {};

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

@@ -1,7 +1,6 @@
-import { Project, Projection, Unproject } from "../common";
-import { GeoJSONStore } from "../store/store";
+import { Project, Projection, TerraDrawGeoJSONStore, Unproject } from "../common";
 export type BehaviorConfig = {
-    store: GeoJSONStore;
+    store: TerraDrawGeoJSONStore;
     mode: string;
     project: Project;
     unproject: Unproject;
@@ -10,7 +9,7 @@ export type BehaviorConfig = {
     projection: Projection;
 };
 export declare class TerraDrawModeBehavior {
-    protected store: GeoJSONStore;
+    protected store: TerraDrawGeoJSONStore;
     protected mode: string;
     protected project: Project;
     protected unproject: Unproject;

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

@@ -1,6 +1,6 @@
 import { BehaviorConfig, TerraDrawModeBehavior } from "./base.behavior";
-import { HexColor, OnFinishContext, Projection, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, TerraDrawModeRegisterConfig, TerraDrawModeState, TerraDrawMouseEvent, Validation } from "../common";
-import { FeatureId, GeoJSONStore, GeoJSONStoreFeatures, StoreChangeHandler } from "../store/store";
+import { OnChangeContext, HexColor, OnFinishContext, Projection, TerraDrawAdapterStyling, TerraDrawGeoJSONStore, TerraDrawKeyboardEvent, TerraDrawModeRegisterConfig, TerraDrawModeState, TerraDrawMouseEvent, Validation } from "../common";
+import { FeatureId, GeoJSONStoreFeatures, StoreChangeHandler } from "../store/store";
 export type CustomStyling = Record<string, string | number | ((feature: GeoJSONStoreFeatures) => HexColor) | ((feature: GeoJSONStoreFeatures) => number)>;
 export declare enum ModeTypes {
     Drawing = "drawing",
@@ -8,11 +8,29 @@ export declare enum ModeTypes {
     Static = "static",
     Render = "render"
 }
+export declare const DefaultPointerEvents: {
+    readonly rightClick: true;
+    readonly contextMenu: false;
+    readonly leftClick: true;
+    readonly onDragStart: true;
+    readonly onDrag: true;
+    readonly onDragEnd: true;
+};
+type AllowPointerEvent = boolean | ((event: TerraDrawMouseEvent) => boolean);
+export interface PointerEvents {
+    leftClick: AllowPointerEvent;
+    rightClick: AllowPointerEvent;
+    contextMenu: AllowPointerEvent;
+    onDragStart: AllowPointerEvent;
+    onDrag: AllowPointerEvent;
+    onDragEnd: AllowPointerEvent;
+}
 export type BaseModeOptions<Styling extends CustomStyling> = {
     styles?: Partial<Styling>;
     pointerDistance?: number;
     validation?: Validation;
     projection?: Projection;
+    pointerEvents?: PointerEvents;
 };
 export declare abstract class TerraDrawBaseDrawMode<Styling extends CustomStyling> {
     protected _state: TerraDrawModeState;
@@ -21,12 +39,13 @@ export declare abstract class TerraDrawBaseDrawMode<Styling extends CustomStylin
     protected _styles: Partial<Styling>;
     get styles(): Partial<Styling>;
     set styles(styling: Partial<Styling>);
+    protected pointerEvents: PointerEvents;
     protected behaviors: TerraDrawModeBehavior[];
     protected validate: Validation | undefined;
     protected pointerDistance: number;
     protected coordinatePrecision: number;
-    protected onStyleChange: StoreChangeHandler;
-    protected store: GeoJSONStore;
+    protected onStyleChange: StoreChangeHandler<OnChangeContext | undefined>;
+    protected store: TerraDrawGeoJSONStore;
     protected projection: Projection;
     protected setDoubleClickToZoom: TerraDrawModeRegisterConfig["setDoubleClickToZoom"];
     protected unproject: TerraDrawModeRegisterConfig["unproject"];
@@ -35,6 +54,7 @@ export declare abstract class TerraDrawBaseDrawMode<Styling extends CustomStylin
     protected registerBehaviors(behaviorConfig: BehaviorConfig): void;
     constructor(options?: BaseModeOptions<Styling>, willCallUpdateOptionsInParentClass?: boolean);
     updateOptions(options?: BaseModeOptions<Styling>): void;
+    protected allowPointerEvent(pointerEvent: AllowPointerEvent, event: TerraDrawMouseEvent): boolean;
     type: ModeTypes;
     mode: string;
     protected setDrawing(): void;
@@ -68,3 +88,4 @@ export declare abstract class TerraDrawBaseSelectMode<Styling extends CustomStyl
     abstract selectFeature(featureId: FeatureId): void;
     abstract deselectFeature(featureId: FeatureId): void;
 }
+export {};

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

@@ -93,7 +93,7 @@ export declare class TerraDrawLineStringMode extends TerraDrawBaseDrawMode<LineS
     /** @internal */
     onDrag(event: TerraDrawMouseEvent, setMapDraggability: (enabled: boolean) => void): void;
     /** @internal */
-    onDragEnd(_: TerraDrawMouseEvent, setMapDraggability: (enabled: boolean) => void): void;
+    onDragEnd(event: TerraDrawMouseEvent, setMapDraggability: (enabled: boolean) => void): void;
     /** @internal */
     cleanUp(): void;
     /** @internal */

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

@@ -48,7 +48,7 @@ export declare class TerraDrawPointMode extends TerraDrawBaseDrawMode<PointModeS
     /** @internal */
     onDrag(event: TerraDrawMouseEvent, setMapDraggability: (enabled: boolean) => void): void;
     /** @internal */
-    onDragEnd(_: TerraDrawMouseEvent, setMapDraggability: (enabled: boolean) => void): void;
+    onDragEnd(event: TerraDrawMouseEvent, setMapDraggability: (enabled: boolean) => void): void;
     registerBehaviors(config: BehaviorConfig): void;
     /** @internal */
     styleFeature(feature: GeoJSONStoreFeatures): TerraDrawAdapterStyling;

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

@@ -1,6 +1,6 @@
 import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor, Project, Unproject } from "../../common";
 import { Polygon, Position } from "geojson";
-import { TerraDrawBaseDrawMode, BaseModeOptions, CustomStyling } from "../base.mode";
+import { TerraDrawBaseDrawMode, BaseModeOptions, CustomStyling, PointerEvents } from "../base.mode";
 import { BehaviorConfig } from "../base.behavior";
 import { FeatureId, GeoJSONStoreFeatures, StoreValidation } from "../../store/store";
 type TerraDrawPolygonModeKeyEvents = {
@@ -50,6 +50,7 @@ interface TerraDrawPolygonModeOptions<T extends CustomStyling> extends BaseModeO
     snapping?: Snapping;
     pointerDistance?: number;
     keyEvents?: TerraDrawPolygonModeKeyEvents | null;
+    pointerEvents?: PointerEvents;
     cursors?: Cursors;
     editable?: boolean;
     showCoordinatePoints?: boolean;
@@ -102,7 +103,7 @@ export declare class TerraDrawPolygonMode extends TerraDrawBaseDrawMode<PolygonS
     /** @internal */
     onDrag(event: TerraDrawMouseEvent, setMapDraggability: (enabled: boolean) => void): void;
     /** @internal */
-    onDragEnd(_: TerraDrawMouseEvent, setMapDraggability: (enabled: boolean) => void): void;
+    onDragEnd(event: TerraDrawMouseEvent, setMapDraggability: (enabled: boolean) => void): void;
     /** @internal */
     cleanUp(): void;
     /** @internal */

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

@@ -117,7 +117,7 @@ export declare class TerraDrawSelectMode extends TerraDrawBaseSelectMode<Selecti
     /** @internal */
     onDrag(event: TerraDrawMouseEvent, setMapDraggability: (enabled: boolean) => void): void;
     /** @internal */
-    onDragEnd(_: TerraDrawMouseEvent, setMapDraggability: (enabled: boolean) => void): void;
+    onDragEnd(event: TerraDrawMouseEvent, setMapDraggability: (enabled: boolean) => void): void;
     /** @internal */
     onMouseMove(event: TerraDrawMouseEvent): void;
     /** @internal */

package/dist/store/store.d.ts

@@ -13,7 +13,7 @@ export type StoreValidation = {
     id?: FeatureId;
 } & ReturnType<Validation>;
 type StoreChangeEvents = "delete" | "create" | "update" | "styling";
-export type StoreChangeHandler = (ids: FeatureId[], change: StoreChangeEvents) => void;
+export type StoreChangeHandler<OnChangeContext> = (ids: FeatureId[], change: StoreChangeEvents, context?: OnChangeContext) => void;
 export type FeatureId = string | number;
 export type IdStrategy<Id extends FeatureId> = {
     isValidId: (id: Id) => boolean;
@@ -27,7 +27,7 @@ export declare const defaultIdStrategy: {
     getId: <FeatureId>() => FeatureId;
     isValidId: (id: FeatureId) => boolean;
 };
-export declare class GeoJSONStore<Id extends FeatureId = FeatureId> {
+export declare class GeoJSONStore<OnChangeContext extends Record<string, JSON> | undefined, Id extends FeatureId = FeatureId> {
     constructor(config?: GeoJSONStoreConfig<Id>);
     idStrategy: IdStrategy<Id>;
     private tracked;
@@ -37,25 +37,25 @@ export declare class GeoJSONStore<Id extends FeatureId = FeatureId> {
     private clone;
     getId(): FeatureId;
     has(id: FeatureId): boolean;
-    load(data: GeoJSONStoreFeatures[], featureValidation?: (feature: unknown, tracked?: boolean) => StoreValidation, afterFeatureAdded?: (feature: GeoJSONStoreFeatures) => void): StoreValidation[];
+    load(data: GeoJSONStoreFeatures[], featureValidation?: (feature: unknown, tracked?: boolean) => StoreValidation, afterFeatureAdded?: (feature: GeoJSONStoreFeatures) => void, context?: OnChangeContext): StoreValidation[];
     search(bbox: BBoxPolygon, filter?: (feature: GeoJSONStoreFeatures) => boolean): GeoJSONStoreFeatures[];
-    registerOnChange(onChange: StoreChangeHandler): void;
+    registerOnChange(onChange: StoreChangeHandler<OnChangeContext | undefined>): void;
     getGeometryCopy<T extends GeoJSONStoreGeometries>(id: FeatureId): T;
     getPropertiesCopy(id: FeatureId): DefinedProperties;
     updateProperty(propertiesToUpdate: {
         id: FeatureId;
         property: string;
         value: JSON;
-    }[]): void;
+    }[], context?: OnChangeContext): void;
     updateGeometry(geometriesToUpdate: {
         id: FeatureId;
         geometry: GeoJSONStoreGeometries;
-    }[]): void;
+    }[], context?: OnChangeContext): void;
     create<Id extends FeatureId>(features: {
         geometry: GeoJSONStoreGeometries;
         properties?: JSONObject;
-    }[]): Id[];
-    delete(ids: FeatureId[]): void;
+    }[], context?: OnChangeContext): Id[];
+    delete(ids: FeatureId[], context?: OnChangeContext): void;
     copy(id: FeatureId): GeoJSONStoreFeatures;
     copyAll(): GeoJSONStoreFeatures[];
     copyAllWhere(equals: (properties: JSONObject) => boolean): GeoJSONStoreFeatures[];