terra-draw 1.6.3 → 1.8.0

package/dist/common.d.ts

@@ -1,3 +1,4 @@
+import { LineString, Polygon, Position } from "geojson";
 import { StoreChangeHandler, GeoJSONStore, GeoJSONStoreFeatures, FeatureId } from "./store/store";
 export type HexColor = `#${string}`;
 export type HexColorStyling = HexColor | ((feature: GeoJSONStoreFeatures) => HexColor);
@@ -78,6 +79,17 @@ export type Validation = (feature: GeoJSONStoreFeatures, context: ValidationCont
     valid: boolean;
     reason?: string;
 };
+export interface Snapping {
+    toLine?: boolean;
+    toCoordinate?: boolean;
+    toCustom?: (event: TerraDrawMouseEvent, context: {
+        currentId?: FeatureId;
+        currentCoordinate?: number;
+        getCurrentGeometrySnapshot: () => (Polygon | LineString) | null;
+        project: Project;
+        unproject: Unproject;
+    }) => Position | undefined;
+}
 export type TerraDrawModeState = "unregistered" | "registered" | "started" | "drawing" | "selecting" | "stopped";
 export interface TerraDrawCallbacks {
     getState: () => TerraDrawModeState;
@@ -116,15 +128,16 @@ export interface TerraDrawAdapter {
 export declare const SELECT_PROPERTIES: {
     readonly SELECTED: "selected";
     readonly MID_POINT: "midPoint";
+    readonly SELECTION_POINT_FEATURE_ID: "selectionPointFeatureId";
     readonly SELECTION_POINT: "selectionPoint";
 };
 export declare const COMMON_PROPERTIES: {
-    EDITED: string;
-    CLOSING_POINT: string;
-    SNAPPING_POINT: string;
-    COORDINATE_POINT: string;
-    COORDINATE_POINT_FEATURE_ID: string;
-    COORDINATE_POINT_IDS: string;
+    readonly EDITED: "edited";
+    readonly CLOSING_POINT: "closingPoint";
+    readonly SNAPPING_POINT: "snappingPoint";
+    readonly COORDINATE_POINT: "coordinatePoint";
+    readonly COORDINATE_POINT_FEATURE_ID: "coordinatePointFeatureId";
+    readonly COORDINATE_POINT_IDS: "coordinatePointIds";
 };
 export declare const Z_INDEX: {
     readonly LAYER_ONE: 10;

package/dist/geometry/get-coordinates-as-points.d.ts

@@ -1,6 +1,6 @@
 import { Point, Position } from "geojson";
 import { JSONObject } from "../store/store";
-export declare function getCoordinatesAsPoints(selectedCoords: Position[], geometryType: "Polygon" | "LineString", properties: (index: number) => JSONObject): {
+export declare function getCoordinatesAsPoints<Properties extends JSONObject>(selectedCoords: Position[], geometryType: "Polygon" | "LineString", properties: (index: number) => Properties): {
     geometry: Point;
-    properties: JSONObject;
+    properties: Properties;
 }[];

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

@@ -1,5 +1,4 @@
-import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor } from "../../common";
-import { Position } from "geojson";
+import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor, Snapping } from "../../common";
 import { BaseModeOptions, CustomStyling, TerraDrawBaseDrawMode } from "../base.mode";
 import { BehaviorConfig } from "../base.behavior";
 import { GeoJSONStoreFeatures, StoreValidation } from "../../store/store";
@@ -29,10 +28,6 @@ interface InertCoordinates {
     strategy: "amount";
     value: number;
 }
-interface Snapping {
-    toCoordinate?: boolean;
-    toCustom?: (event: TerraDrawMouseEvent) => Position | undefined;
-}
 interface TerraDrawLineStringModeOptions<T extends CustomStyling> extends BaseModeOptions<T> {
     snapping?: Snapping;
     pointerDistance?: number;

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

@@ -1,8 +1,7 @@
-import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor, Project, Unproject } from "../../common";
-import { Polygon, Position } from "geojson";
+import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor, Snapping } from "../../common";
 import { TerraDrawBaseDrawMode, BaseModeOptions, CustomStyling, PointerEvents } from "../base.mode";
 import { BehaviorConfig } from "../base.behavior";
-import { FeatureId, GeoJSONStoreFeatures, StoreValidation } from "../../store/store";
+import { GeoJSONStoreFeatures, StoreValidation } from "../../store/store";
 type TerraDrawPolygonModeKeyEvents = {
     cancel?: KeyboardEvent["key"] | null;
     finish?: KeyboardEvent["key"] | null;
@@ -35,17 +34,6 @@ interface Cursors {
     dragStart?: Cursor;
     dragEnd?: Cursor;
 }
-interface Snapping {
-    toLine?: boolean;
-    toCoordinate?: boolean;
-    toCustom?: (event: TerraDrawMouseEvent, context: {
-        currentId?: FeatureId;
-        currentCoordinate?: number;
-        getCurrentGeometrySnapshot: () => Polygon | null;
-        project: Project;
-        unproject: Unproject;
-    }) => Position | undefined;
-}
 interface TerraDrawPolygonModeOptions<T extends CustomStyling> extends BaseModeOptions<T> {
     snapping?: Snapping;
     pointerDistance?: number;

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

@@ -1,4 +1,4 @@
-import { TerraDrawMouseEvent, Validation } from "../../../common";
+import { Snapping, TerraDrawMouseEvent, Validation } from "../../../common";
 import { BehaviorConfig, TerraDrawModeBehavior } from "../../base.behavior";
 import { PixelDistanceBehavior } from "../../pixel-distance.behavior";
 import { MidPointBehavior } from "./midpoint.behavior";
@@ -6,6 +6,7 @@ import { SelectionPointBehavior } from "./selection-point.behavior";
 import { FeatureId } from "../../../store/store";
 import { CoordinatePointBehavior } from "./coordinate-point.behavior";
 import { CoordinateSnappingBehavior } from "../../coordinate-snapping.behavior";
+import { LineSnappingBehavior } from "../../line-snapping.behavior";
 export declare class DragCoordinateBehavior extends TerraDrawModeBehavior {
     readonly config: BehaviorConfig;
     private readonly pixelDistance;
@@ -13,11 +14,13 @@ export declare class DragCoordinateBehavior extends TerraDrawModeBehavior {
     private readonly midPoints;
     private readonly coordinatePoints;
     private readonly coordinateSnapping;
-    constructor(config: BehaviorConfig, pixelDistance: PixelDistanceBehavior, selectionPoints: SelectionPointBehavior, midPoints: MidPointBehavior, coordinatePoints: CoordinatePointBehavior, coordinateSnapping: CoordinateSnappingBehavior);
+    private readonly lineSnapping;
+    constructor(config: BehaviorConfig, pixelDistance: PixelDistanceBehavior, selectionPoints: SelectionPointBehavior, midPoints: MidPointBehavior, coordinatePoints: CoordinatePointBehavior, coordinateSnapping: CoordinateSnappingBehavior, lineSnapping: LineSnappingBehavior);
     private draggedCoordinate;
     private getClosestCoordinate;
     getDraggableIndex(event: TerraDrawMouseEvent, selectedId: FeatureId): number;
-    drag(event: TerraDrawMouseEvent, allowSelfIntersection: boolean, validateFeature: Validation, snapping: boolean): boolean;
+    private snapCoordinate;
+    drag(event: TerraDrawMouseEvent, allowSelfIntersection: boolean, validateFeature: Validation, snapping: Snapping): boolean;
     isDragging(): boolean;
     startDragging(id: FeatureId, index: number): void;
     stopDragging(): void;

package/dist/modes/select/behaviors/selection-point.behavior.d.ts

@@ -1,6 +1,13 @@
 import { LineString, Point, Polygon, Position } from "geojson";
 import { BehaviorConfig, TerraDrawModeBehavior } from "../../base.behavior";
 import { FeatureId } from "../../../store/store";
+import { SELECT_PROPERTIES } from "../../../common";
+export type SelectionPointProperties = {
+    mode: string;
+    index: number;
+    [SELECT_PROPERTIES.SELECTION_POINT_FEATURE_ID]: string;
+    [SELECT_PROPERTIES.SELECTION_POINT]: true;
+};
 export declare class SelectionPointBehavior extends TerraDrawModeBehavior {
     constructor(config: BehaviorConfig);
     private _selectionPoints;

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

@@ -1,4 +1,4 @@
-import { TerraDrawMouseEvent, TerraDrawKeyboardEvent, TerraDrawAdapterStyling, HexColorStyling, NumericStyling, Cursor, Validation } from "../../common";
+import { TerraDrawMouseEvent, TerraDrawKeyboardEvent, TerraDrawAdapterStyling, HexColorStyling, NumericStyling, Cursor, Validation, Snapping } from "../../common";
 import { BaseModeOptions, CustomStyling, TerraDrawBaseSelectMode } from "../base.mode";
 import { BehaviorConfig } from "../base.behavior";
 import { FeatureId, GeoJSONStoreFeatures } from "../../store/store";
@@ -17,7 +17,7 @@ type ModeFlags = {
         scaleable?: boolean;
         selfIntersectable?: boolean;
         coordinates?: {
-            snappable?: boolean;
+            snappable?: boolean | Snapping;
             midpoints?: boolean | {
                 draggable?: boolean;
             };
@@ -85,9 +85,9 @@ export declare class TerraDrawSelectMode extends TerraDrawBaseSelectMode<Selecti
     private scaleFeature;
     private dragCoordinateResizeFeature;
     private coordinatePoints;
+    private lineSnap;
     constructor(options?: TerraDrawSelectModeOptions<SelectionStyling>);
     updateOptions(options?: TerraDrawSelectModeOptions<SelectionStyling>): void;
-    private createOrUpdateCoordinatePoint;
     selectFeature(featureId: FeatureId): void;
     setSelecting(): void;
     registerBehaviors(config: BehaviorConfig): void;