terra-draw 1.0.0 → 1.1.0

package/README.md

@@ -1,7 +1,36 @@
-# Terra Draw
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="./assets/logo-dark-mode.png">
+  <source media="(prefers-color-scheme: light)" srcset="./assets/logo.png">
+  <img alt="Terra Draw logo" src="./assets/logo.png" width="400px">
+</picture>
 
-This package is the core package for Terra Draw. You can read more context about what Terra Draw is in [the root level README](../../README.md) and more information on how to get started in the [GUIDES section of the Terra Draw monorepo](../../guides/1.GETTING_STARTED.md).
+<p></p>
 
-## License 
+![Terra Draw CI Badge](https://github.com/JamesLMilner/terra-draw/actions/workflows/ci.yml/badge.svg)
+[![npm version](https://badge.fury.io/js/terra-draw.svg)](https://badge.fury.io/js/terra-draw)
 
-[MIT](../../LICENSE)
+Frictionless map drawing across mapping libraries.
+
+Terra Draw centralizes map drawing logic and provides a host of out-of-the-box drawing modes that work across different JavaScript mapping libraries. It also allows you to bring your own modes!
+
+### Supported Mapping Libraries
+
+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-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-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)
+
+### Getting Started
+
+* [Getting started guide](https://github.com/JamesLMilner/terra-draw/blob/main/guides/1.GETTING_STARTED.md)
+* [API Docs](https://terradraw.io/#/api)
+* [Repository](https://www.github.com/JamesLMilner/terra-draw)
+* [Website](https://www.terradraw.io)
+
+### License
+
+MIT

package/dist/common.d.ts

@@ -114,6 +114,7 @@ export declare const SELECT_PROPERTIES: {
     readonly SELECTION_POINT: "selectionPoint";
 };
 export declare const COMMON_PROPERTIES: {
+    EDITED: string;
     CLOSING_POINT: string;
     SNAPPING_POINT: string;
 };

package/dist/geometry/point-on-line.d.ts

@@ -2,4 +2,5 @@ import { Position } from "geojson";
 export declare function nearestPointOnLine(inputCoordinate: Position, lines: [Position, Position][]): {
     coordinate: Position;
     distance: number;
+    lineIndex: number;
 } | undefined;

package/dist/geometry/web-mercator-point-on-line.d.ts

@@ -7,5 +7,6 @@ import { Position } from "geojson";
  */
 export declare function webMercatorNearestPointOnLine(inputCoordinate: Position, lines: [Position, Position][]): {
     coordinate: Position;
+    lineIndex: number;
     distance: number;
 } | undefined;

package/dist/modes/coordinate-snapping.behavior.d.ts

@@ -1,6 +1,6 @@
 import { BehaviorConfig, TerraDrawModeBehavior } from "./base.behavior";
 import { TerraDrawMouseEvent } from "../common";
-import { Position } from "geojson";
+import { Feature, Position } from "geojson";
 import { ClickBoundingBoxBehavior } from "./click-bounding-box.behavior";
 import { FeatureId } from "../store/store";
 import { PixelDistanceBehavior } from "./pixel-distance.behavior";
@@ -12,5 +12,10 @@ export declare class CoordinateSnappingBehavior extends TerraDrawModeBehavior {
     /** Returns the nearest snappable coordinate - on first click there is no currentId so no need to provide */
     getSnappableCoordinateFirstClick: (event: TerraDrawMouseEvent) => Position | undefined;
     getSnappableCoordinate: (event: TerraDrawMouseEvent, currentFeatureId: FeatureId) => Position | undefined;
-    private getSnappable;
+    getSnappable(event: TerraDrawMouseEvent, filter?: (feature: Feature) => boolean): {
+        coordinate: undefined | Position;
+        minDist: number;
+        featureId: undefined | FeatureId;
+        featureCoordinateIndex: undefined | number;
+    };
 }

package/dist/modes/line-snapping.behavior.d.ts

@@ -1,6 +1,6 @@
 import { BehaviorConfig, TerraDrawModeBehavior } from "./base.behavior";
 import { TerraDrawMouseEvent } from "../common";
-import { Position } from "geojson";
+import { Feature, Position } from "geojson";
 import { ClickBoundingBoxBehavior } from "./click-bounding-box.behavior";
 import { FeatureId } from "../store/store";
 import { PixelDistanceBehavior } from "./pixel-distance.behavior";
@@ -12,5 +12,10 @@ export declare class LineSnappingBehavior extends TerraDrawModeBehavior {
     /** Returns the nearest snappable coordinate - on first click there is no currentId so no need to provide */
     getSnappableCoordinateFirstClick: (event: TerraDrawMouseEvent) => Position | undefined;
     getSnappableCoordinate: (event: TerraDrawMouseEvent, currentFeatureId: FeatureId) => Position | undefined;
-    private getSnappable;
+    getSnappable(event: TerraDrawMouseEvent, filter?: (feature: Feature) => boolean): {
+        coordinate: undefined | Position;
+        minDistance: number;
+        featureId: undefined | FeatureId;
+        featureCoordinateIndex: undefined | number;
+    };
 }

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

@@ -1,21 +1,33 @@
 import { TerraDrawMouseEvent, TerraDrawAdapterStyling, NumericStyling, HexColorStyling, Cursor } from "../../common";
 import { GeoJSONStoreFeatures, StoreValidation } from "../../store/store";
 import { BaseModeOptions, CustomStyling, TerraDrawBaseDrawMode } from "../base.mode";
+import { BehaviorConfig } from "../base.behavior";
 type PointModeStyling = {
     pointWidth: NumericStyling;
     pointColor: HexColorStyling;
     pointOutlineColor: HexColorStyling;
     pointOutlineWidth: NumericStyling;
+    editedPointColor: HexColorStyling;
+    editedPointWidth: NumericStyling;
+    editedPointOutlineColor: HexColorStyling;
+    editedPointOutlineWidth: NumericStyling;
 };
 interface Cursors {
     create?: Cursor;
+    dragStart?: Cursor;
+    dragEnd?: Cursor;
 }
 interface TerraDrawPointModeOptions<T extends CustomStyling> extends BaseModeOptions<T> {
     cursors?: Cursors;
+    editable?: boolean;
 }
 export declare class TerraDrawPointMode extends TerraDrawBaseDrawMode<PointModeStyling> {
     mode: string;
     private cursors;
+    private editable;
+    private editedFeatureId;
+    private pixelDistance;
+    private clickBoundingBox;
     constructor(options?: TerraDrawPointModeOptions<PointModeStyling>);
     /** @internal */
     start(): void;
@@ -31,12 +43,12 @@ export declare class TerraDrawPointMode extends TerraDrawBaseDrawMode<PointModeS
     onKeyUp(): void;
     /** @internal */
     cleanUp(): void;
+    onDragStart(event: TerraDrawMouseEvent, setMapDraggability: (enabled: boolean) => void): void;
     /** @internal */
-    onDragStart(): void;
+    onDrag(event: TerraDrawMouseEvent, setMapDraggability: (enabled: boolean) => void): void;
     /** @internal */
-    onDrag(): void;
-    /** @internal */
-    onDragEnd(): void;
+    onDragEnd(_: TerraDrawMouseEvent, setMapDraggability: (enabled: boolean) => void): void;
+    registerBehaviors(config: BehaviorConfig): void;
     /** @internal */
     styleFeature(feature: GeoJSONStoreFeatures): TerraDrawAdapterStyling;
     validateFeature(feature: unknown): StoreValidation;

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

@@ -20,10 +20,16 @@ type PolygonStyling = {
     snappingPointColor: HexColorStyling;
     snappingPointOutlineWidth: NumericStyling;
     snappingPointOutlineColor: HexColorStyling;
+    editedPointWidth: NumericStyling;
+    editedPointColor: HexColorStyling;
+    editedPointOutlineWidth: NumericStyling;
+    editedPointOutlineColor: HexColorStyling;
 };
 interface Cursors {
     start?: Cursor;
     close?: Cursor;
+    dragStart?: Cursor;
+    dragEnd?: Cursor;
 }
 interface Snapping {
     toLine?: boolean;
@@ -35,6 +41,7 @@ interface TerraDrawPolygonModeOptions<T extends CustomStyling> extends BaseModeO
     pointerDistance?: number;
     keyEvents?: TerraDrawPolygonModeKeyEvents | null;
     cursors?: Cursors;
+    editable?: boolean;
 }
 export declare class TerraDrawPolygonMode extends TerraDrawBaseDrawMode<PolygonStyling> {
     mode: string;
@@ -42,11 +49,18 @@ export declare class TerraDrawPolygonMode extends TerraDrawBaseDrawMode<PolygonS
     private currentId;
     private keyEvents;
     private snapping;
+    private editable;
     private snappedPointId;
+    private editedFeatureId;
+    private editedFeatureCoordinateIndex;
+    private editedSnapType;
+    private editedInsertIndex;
+    private editedPointId;
     private lineSnapping;
     private coordinateSnapping;
     private pixelDistance;
     private closingPoints;
+    private clickBoundingBox;
     private cursors;
     private mouseMove;
     constructor(options?: TerraDrawPolygonModeOptions<PolygonStyling>);
@@ -67,12 +81,11 @@ export declare class TerraDrawPolygonMode extends TerraDrawBaseDrawMode<PolygonS
     onKeyUp(event: TerraDrawKeyboardEvent): void;
     /** @internal */
     onKeyDown(): void;
+    onDragStart(event: TerraDrawMouseEvent, setMapDraggability: (enabled: boolean) => void): void;
     /** @internal */
-    onDragStart(): void;
+    onDrag(event: TerraDrawMouseEvent, setMapDraggability: (enabled: boolean) => void): void;
     /** @internal */
-    onDrag(): void;
-    /** @internal */
-    onDragEnd(): void;
+    onDragEnd(_: TerraDrawMouseEvent, setMapDraggability: (enabled: boolean) => void): void;
     /** @internal */
     cleanUp(): void;
     /** @internal */