terra-draw 1.0.0-beta.8 → 1.0.0

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

@@ -1,7 +1,8 @@
 import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor } from "../../common";
+import { Position } from "geojson";
 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;
@@ -15,13 +16,22 @@ type PolygonStyling = {
     closingPointColor: HexColorStyling;
     closingPointOutlineWidth: NumericStyling;
     closingPointOutlineColor: HexColorStyling;
+    snappingPointWidth: NumericStyling;
+    snappingPointColor: HexColorStyling;
+    snappingPointOutlineWidth: NumericStyling;
+    snappingPointOutlineColor: HexColorStyling;
 };
 interface Cursors {
     start?: Cursor;
     close?: Cursor;
 }
+interface Snapping {
+    toLine?: boolean;
+    toCoordinate?: boolean;
+    toCustom?: (event: TerraDrawMouseEvent) => Position | undefined;
+}
 interface TerraDrawPolygonModeOptions<T extends CustomStyling> extends BaseModeOptions<T> {
-    snapping?: boolean;
+    snapping?: Snapping;
     pointerDistance?: number;
     keyEvents?: TerraDrawPolygonModeKeyEvents | null;
     cursors?: Cursors;
@@ -31,8 +41,10 @@ export declare class TerraDrawPolygonMode extends TerraDrawBaseDrawMode<PolygonS
     private currentCoordinate;
     private currentId;
     private keyEvents;
-    private snappingEnabled;
     private snapping;
+    private snappedPointId;
+    private lineSnapping;
+    private coordinateSnapping;
     private pixelDistance;
     private closingPoints;
     private cursors;
@@ -48,6 +60,7 @@ export declare class TerraDrawPolygonMode extends TerraDrawBaseDrawMode<PolygonS
     /** @internal */
     onMouseMove(event: TerraDrawMouseEvent): void;
     private updatePolygonGeometry;
+    private snapCoordinate;
     /** @internal */
     onClick(event: TerraDrawMouseEvent): void;
     /** @internal */
@@ -64,6 +77,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/polygon/polygon.mode.spec.d.ts

@@ -0,0 +1 @@
+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/rectangle/rectangle.mode.spec.d.ts

@@ -0,0 +1 @@
+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/render/render.mode.spec.d.ts

@@ -0,0 +1 @@
+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/sector/sector.mode.spec.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1 @@
+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/select/behaviors/drag-feature.behavior.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/modes/select/behaviors/feature-at-pointer-event.behavior.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/modes/select/behaviors/midpoint.behavior.spec.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1 @@
+export {};

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/modes/sensor/sensor.mode.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/modes/static/static.mode.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/store/spatial-index/quickselect.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/store/spatial-index/rbush.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/store/spatial-index/spatial-index.spec.d.ts

@@ -0,0 +1 @@
+export {};

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-validation.spec.d.ts

@@ -0,0 +1 @@
+export {};

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;

package/dist/store/store.spec.d.ts

@@ -0,0 +1 @@
+export {};