terra-draw 0.0.1-alpha.64 → 0.0.1-alpha.66

package/README.md

@@ -16,7 +16,7 @@ Terra Draw uses the concept of 'adapters' to allow it to work with a host of dif
 - [Leaflet](https://leafletjs.com/) v1
 - [OpenLayers](https://openlayers.org/) v7
 - [Mapbox GL JS](https://www.mapbox.com/mapbox-gljs) v2
-- [MapLibre](https://maplibre.org/projects/maplibre-gl-js/) v2/v3
+- [MapLibre](https://maplibre.org/maplibre-gl-js/docs/) v2/v3
 - [Google Maps JS API](https://developers.google.com/maps/documentation/javascript/overview) v3
 - [ArcGIS JavaScript SDK](https://developers.arcgis.com/javascript/latest/) v4 (MapView)
 
@@ -26,8 +26,8 @@ Please see the [the getting started guide](./guides/1.GETTING_STARTED.md) - this
 
 ### Development & Contributing
 
-* For development, please see the [the development documentation](./guides/6.DEVELOPMENT.md)
-* For guidance on contributing, please see the [the contributing documentation](./guides/CONTRIBUTING.md)
+* For development, please see the [the development documentation](./guides/7.DEVELOPMENT.md)
+* For guidance on contributing, please see the [the contributing documentation](./guides/7.DEVELOPMENT.md#contributing)
 
 
 ### Project Website

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

@@ -38,6 +38,7 @@ export declare class TerraDrawArcGISMapsSDKAdapter extends TerraDrawBaseAdapter
     } & BaseAdapterConfig);
     register(callbacks: TerraDrawCallbacks): void;
     unregister(): void;
+    getCoordinatePrecision(): number;
     /**
      * 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.

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

@@ -87,4 +87,5 @@ export declare class TerraDrawGoogleMapsAdapter extends TerraDrawBaseAdapter {
      * @returns void
      * */
     clear(): void;
+    getCoordinatePrecision(): number;
 }

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

@@ -94,4 +94,6 @@ export declare class TerraDrawLeafletAdapter extends TerraDrawBaseAdapter {
      * */
     clear(): void;
     register(callbacks: TerraDrawCallbacks): void;
+    getCoordinatePrecision(): number;
+    unregister(): void;
 }

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

@@ -85,5 +85,7 @@ export declare class TerraDrawMapboxGLAdapter extends TerraDrawBaseAdapter {
      * @returns void
      * */
     clear(): void;
+    getCoordinatePrecision(): number;
+    unregister(): void;
     register(callbacks: TerraDrawCallbacks): void;
 }

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

@@ -8,6 +8,7 @@ export declare class TerraDrawMapLibreGLAdapter extends TerraDrawBaseAdapter {
     } & BaseAdapterConfig);
     register(callbacks: TerraDrawCallbacks): void;
     unregister(): void;
+    getCoordinatePrecision(): number;
     /**
      * 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.

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

@@ -114,5 +114,7 @@ export declare class TerraDrawOpenLayersAdapter extends TerraDrawBaseAdapter {
      * */
     clear(): void;
     register(callbacks: TerraDrawCallbacks): void;
+    getCoordinatePrecision(): number;
+    unregister(): void;
 }
 export {};

package/dist/common.d.ts

@@ -58,6 +58,8 @@ export interface TerraDrawModeRegisterConfig {
     unproject: Unproject;
     coordinatePrecision: number;
 }
+type ValidationContext = Pick<TerraDrawModeRegisterConfig, "project" | "unproject" | "coordinatePrecision">;
+export type Validation = (feature: GeoJSONStoreFeatures, context: ValidationContext) => boolean;
 export type TerraDrawModeState = "unregistered" | "registered" | "started" | "drawing" | "selecting" | "stopped";
 export interface TerraDrawCallbacks {
     getState: () => TerraDrawModeState;
@@ -101,3 +103,4 @@ export declare const SELECT_PROPERTIES: {
 export declare const POLYGON_PROPERTIES: {
     CLOSING_POINT: string;
 };
+export {};

package/dist/geometry/web-mercator-center.d.ts

@@ -0,0 +1,5 @@
+import { Feature, LineString, Polygon } from "geojson";
+export declare function webMercatorCenter(feature: Feature<Polygon | LineString>): {
+    x: number;
+    y: number;
+};

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

@@ -1,9 +1,9 @@
-import { TerraDrawMouseEvent } from "../../../common";
+import { TerraDrawMouseEvent, Validation } from "../../../common";
 import { BehaviorConfig, TerraDrawModeBehavior } from "../../base.behavior";
 import { PixelDistanceBehavior } from "../../pixel-distance.behavior";
 import { MidPointBehavior } from "./midpoint.behavior";
 import { SelectionPointBehavior } from "./selection-point.behavior";
-import { FeatureId, GeoJSONStoreFeatures } from "../../../store/store";
+import { FeatureId } from "../../../store/store";
 export type ResizeOptions = "center-web-mercator" | "opposite-web-mercator" | "center-fixed-web-mercator" | "opposite-fixed-web-mercator";
 export declare class DragCoordinateResizeBehavior extends TerraDrawModeBehavior {
     readonly config: BehaviorConfig;
@@ -58,5 +58,5 @@ export declare class DragCoordinateResizeBehavior extends TerraDrawModeBehavior
      * @param resizeOption - the resize option, either "center-web-mercator" or "opposite-web-mercator"
      * @returns - true is resize was successful, false otherwise
      */
-    drag(event: TerraDrawMouseEvent, resizeOption: ResizeOptions, validateFeature?: (feature: GeoJSONStoreFeatures) => boolean): boolean;
+    drag(event: TerraDrawMouseEvent, resizeOption: ResizeOptions, validateFeature?: Validation): boolean;
 }

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

@@ -1,9 +1,9 @@
-import { TerraDrawMouseEvent } from "../../../common";
+import { TerraDrawMouseEvent, Validation } from "../../../common";
 import { BehaviorConfig, TerraDrawModeBehavior } from "../../base.behavior";
 import { PixelDistanceBehavior } from "../../pixel-distance.behavior";
 import { MidPointBehavior } from "./midpoint.behavior";
 import { SelectionPointBehavior } from "./selection-point.behavior";
-import { FeatureId, GeoJSONStoreFeatures } from "../../../store/store";
+import { FeatureId } from "../../../store/store";
 export declare class DragCoordinateBehavior extends TerraDrawModeBehavior {
     readonly config: BehaviorConfig;
     private readonly pixelDistance;
@@ -13,7 +13,7 @@ export declare class DragCoordinateBehavior extends TerraDrawModeBehavior {
     private draggedCoordinate;
     private getClosestCoordinate;
     getDraggableIndex(event: TerraDrawMouseEvent, selectedId: FeatureId): number;
-    drag(event: TerraDrawMouseEvent, allowSelfIntersection: boolean, validateFeature?: (feature: GeoJSONStoreFeatures) => boolean): boolean;
+    drag(event: TerraDrawMouseEvent, allowSelfIntersection: boolean, validateFeature?: Validation): boolean;
     isDragging(): boolean;
     startDragging(id: FeatureId, index: number): void;
     stopDragging(): void;

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

@@ -1,9 +1,9 @@
-import { TerraDrawMouseEvent } from "../../../common";
+import { TerraDrawMouseEvent, Validation } from "../../../common";
 import { BehaviorConfig, TerraDrawModeBehavior } from "../../base.behavior";
 import { FeatureAtPointerEventBehavior } from "./feature-at-pointer-event.behavior";
 import { SelectionPointBehavior } from "./selection-point.behavior";
 import { MidPointBehavior } from "./midpoint.behavior";
-import { FeatureId, GeoJSONStoreFeatures } from "../../../store/store";
+import { FeatureId } from "../../../store/store";
 export declare class DragFeatureBehavior extends TerraDrawModeBehavior {
     readonly config: BehaviorConfig;
     private readonly featuresAtMouseEvent;
@@ -16,5 +16,5 @@ export declare class DragFeatureBehavior extends TerraDrawModeBehavior {
     stopDragging(): void;
     isDragging(): boolean;
     canDrag(event: TerraDrawMouseEvent, selectedId: FeatureId): boolean;
-    drag(event: TerraDrawMouseEvent, validateFeature?: (feature: GeoJSONStoreFeatures) => boolean): false | undefined;
+    drag(event: TerraDrawMouseEvent, validateFeature?: Validation): false | undefined;
 }

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

@@ -1,8 +1,8 @@
-import { TerraDrawMouseEvent } from "../../../common";
+import { TerraDrawMouseEvent, Validation } from "../../../common";
 import { BehaviorConfig, TerraDrawModeBehavior } from "../../base.behavior";
 import { SelectionPointBehavior } from "./selection-point.behavior";
 import { MidPointBehavior } from "./midpoint.behavior";
-import { FeatureId, GeoJSONStoreFeatures } from "../../../store/store";
+import { FeatureId } from "../../../store/store";
 export declare class RotateFeatureBehavior extends TerraDrawModeBehavior {
     readonly config: BehaviorConfig;
     private readonly selectionPoints;
@@ -10,5 +10,5 @@ export declare class RotateFeatureBehavior extends TerraDrawModeBehavior {
     constructor(config: BehaviorConfig, selectionPoints: SelectionPointBehavior, midPoints: MidPointBehavior);
     private lastBearing;
     reset(): void;
-    rotate(event: TerraDrawMouseEvent, selectedId: FeatureId, validateFeature?: (feature: GeoJSONStoreFeatures) => boolean): false | undefined;
+    rotate(event: TerraDrawMouseEvent, selectedId: FeatureId, validateFeature?: Validation): false | undefined;
 }

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

@@ -1,8 +1,8 @@
-import { TerraDrawMouseEvent } from "../../../common";
+import { TerraDrawMouseEvent, Validation } from "../../../common";
 import { BehaviorConfig, TerraDrawModeBehavior } from "../../base.behavior";
 import { SelectionPointBehavior } from "./selection-point.behavior";
 import { MidPointBehavior } from "./midpoint.behavior";
-import { FeatureId, GeoJSONStoreFeatures } from "../../../store/store";
+import { FeatureId } from "../../../store/store";
 export declare class ScaleFeatureBehavior extends TerraDrawModeBehavior {
     readonly config: BehaviorConfig;
     private readonly selectionPoints;
@@ -10,5 +10,5 @@ export declare class ScaleFeatureBehavior extends TerraDrawModeBehavior {
     constructor(config: BehaviorConfig, selectionPoints: SelectionPointBehavior, midPoints: MidPointBehavior);
     private lastDistance;
     reset(): void;
-    scale(event: TerraDrawMouseEvent, selectedId: FeatureId, validateFeature?: (feature: GeoJSONStoreFeatures) => boolean): false | undefined;
+    scale(event: TerraDrawMouseEvent, selectedId: FeatureId, validateFeature?: Validation): false | undefined;
 }

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

@@ -1,4 +1,4 @@
-import { TerraDrawMouseEvent, TerraDrawKeyboardEvent, TerraDrawAdapterStyling, HexColorStyling, NumericStyling, Cursor } from "../../common";
+import { TerraDrawMouseEvent, TerraDrawKeyboardEvent, TerraDrawAdapterStyling, HexColorStyling, NumericStyling, Cursor, Validation } from "../../common";
 import { BaseModeOptions, CustomStyling, TerraDrawBaseSelectMode } from "../base.mode";
 import { BehaviorConfig } from "../base.behavior";
 import { FeatureId, GeoJSONStoreFeatures } from "../../store/store";
@@ -11,7 +11,7 @@ type TerraDrawSelectModeKeyEvents = {
 };
 type ModeFlags = {
     feature?: {
-        validation?: (geometry: GeoJSONStoreFeatures) => boolean;
+        validation?: Validation;
         draggable?: boolean;
         rotateable?: boolean;
         scaleable?: boolean;