terra-draw 1.0.0-beta.8 → 1.0.0

package/.versionrc.cjs

@@ -0,0 +1,9 @@
+const path = require("path");
+const packageJsonPath = path.resolve(__dirname, `package.json`);
+const packageName = require(packageJsonPath).name
+console.log(`✔ Package: ${packageName}`)
+
+const changelogPath = path.resolve(__dirname, "/CHANGELOG.md")
+const releaseConfig = require('../../release')
+
+module.exports = releaseConfig(packageName, packageJsonPath, changelogPath)

package/README.md

@@ -1,50 +1,7 @@
-<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>
+# Terra Draw
 
-<p></p>
+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).
 
-![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)
+## 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!
-
-![An example of drawing geodesic lines using Terra Draw with Leaflet](./assets/readme.gif)
-
-
-### Library Support
-
-Terra Draw uses the concept of 'adapters' to allow it to work with a host of different mapping libraries. Currently supported are:
-
-- [Leaflet](https://leafletjs.com/) v1
-- [OpenLayers](https://openlayers.org/) v10
-- [Mapbox GL JS](https://www.mapbox.com/mapbox-gljs) v2
-- [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)
-
-### Getting Started
-
-Please see the [the getting started guide](./guides/1.GETTING_STARTED.md) - this provides a host of information on how to get up and running with Terra Draw.
-
-### Development & Contributing
-
-* 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
-
-You can check out the official Terra Draw website at [terradraw.io](https://www.terradraw.io). If you are interested in contributing to the website please see [this repository](https://www.github.com/JamesLMilner/terra-draw-website).
-
-### Contact
-
-Email: [contact@terradraw.io](mailto:contact@terradraw.io)
-
-### License
-
-MIT
+[MIT](../../LICENSE)

package/dist/common/adapter-listener.spec.d.ts

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

package/dist/{adapters/common → common}/base.adapter.d.ts

@@ -1,4 +1,4 @@
-import { Project, Unproject, TerraDrawCallbacks, TerraDrawChanges, TerraDrawMouseEvent, SetCursor, TerraDrawStylingFunction, GetLngLatFromEvent, TerraDrawAdapter } from "../../common";
+import { Project, Unproject, TerraDrawCallbacks, TerraDrawChanges, TerraDrawMouseEvent, SetCursor, TerraDrawStylingFunction, GetLngLatFromEvent, TerraDrawAdapter } from "../common";
 import { AdapterListener } from "./adapter-listener";
 type BasePointerListener = (event: PointerEvent) => void;
 type BaseKeyboardListener = (event: KeyboardEvent) => void;

package/dist/common.d.ts

@@ -15,6 +15,10 @@ export interface TerraDrawAdapterStyling {
     lineStringColor: HexColor;
     zIndex: number;
 }
+export type CartesianPoint = {
+    x: number;
+    y: number;
+};
 export interface TerraDrawMouseEvent {
     lng: number;
     lat: number;
@@ -30,10 +34,7 @@ export interface TerraDrawKeyboardEvent {
 }
 export type Cursor = Parameters<SetCursor>[0];
 export type SetCursor = (cursor: "unset" | "grab" | "grabbing" | "crosshair" | "pointer" | "wait" | "move") => void;
-export type Project = (lng: number, lat: number) => {
-    x: number;
-    y: number;
-};
+export type Project = (lng: number, lat: number) => CartesianPoint;
 export type Unproject = (x: number, y: number) => {
     lat: number;
     lng: number;
@@ -68,7 +69,10 @@ export declare enum UpdateTypes {
 type ValidationContext = Pick<TerraDrawModeRegisterConfig, "project" | "unproject" | "coordinatePrecision"> & {
     updateType: UpdateTypes;
 };
-export type Validation = (feature: GeoJSONStoreFeatures, context: ValidationContext) => boolean;
+export type Validation = (feature: GeoJSONStoreFeatures, context: ValidationContext) => {
+    valid: boolean;
+    reason?: string;
+};
 export type TerraDrawModeState = "unregistered" | "registered" | "started" | "drawing" | "selecting" | "stopped";
 export interface TerraDrawCallbacks {
     getState: () => TerraDrawModeState;
@@ -109,7 +113,8 @@ export declare const SELECT_PROPERTIES: {
     readonly MID_POINT: "midPoint";
     readonly SELECTION_POINT: "selectionPoint";
 };
-export declare const POLYGON_PROPERTIES: {
+export declare const COMMON_PROPERTIES: {
     CLOSING_POINT: string;
+    SNAPPING_POINT: string;
 };
 export {};

package/dist/extend.d.ts

@@ -1,4 +1,5 @@
-import { TerraDrawBaseAdapter, BaseAdapterConfig } from "./adapters/common/base.adapter";
-import { HexColorStyling, NumericStyling } from "./common";
+import { TerraDrawBaseAdapter, BaseAdapterConfig } from "./common/base.adapter";
+import { HexColorStyling, NumericStyling, SELECT_PROPERTIES, TerraDrawCallbacks } from "./common";
 import { BaseModeOptions, TerraDrawBaseDrawMode } from "./modes/base.mode";
-export { TerraDrawBaseDrawMode, TerraDrawBaseAdapter, BaseAdapterConfig, NumericStyling, HexColorStyling, BaseModeOptions, };
+import { FeatureId, GeoJSONStore } from "./store/store";
+export { GeoJSONStore, TerraDrawBaseDrawMode, TerraDrawBaseAdapter, BaseAdapterConfig, NumericStyling, HexColorStyling, BaseModeOptions, TerraDrawCallbacks, FeatureId, SELECT_PROPERTIES, };

package/dist/geometry/boolean/is-valid-coordinate.spec.d.ts

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

package/dist/geometry/boolean/point-in-polygon.spec.d.ts

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

package/dist/geometry/boolean/self-intersects.spec.d.ts

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

package/dist/geometry/calculate-relative-angle.d.ts

@@ -1,3 +1,4 @@
+import { CartesianPoint } from "../common";
 /**
  * Calculate the relative angle between two lines
  * @param A The first point of the first line
@@ -5,13 +6,4 @@
  * @param C The second point of the second line
  * @returns The relative angle between the two lines
  */
-export declare function calculateRelativeAngle(A: {
-    x: number;
-    y: number;
-}, B: {
-    x: number;
-    y: number;
-}, C: {
-    x: number;
-    y: number;
-}): number;
+export declare function calculateRelativeAngle(A: CartesianPoint, B: CartesianPoint, C: CartesianPoint): number;

package/dist/geometry/calculate-relative-angle.spec.d.ts

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

package/dist/geometry/centroid.spec.d.ts

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

package/dist/geometry/clockwise.d.ts

@@ -1,10 +1,2 @@
-export declare function isClockwiseWebMercator(center: {
-    x: number;
-    y: number;
-}, secondCoord: {
-    x: number;
-    y: number;
-}, thirdCoord: {
-    x: number;
-    y: number;
-}): boolean;
+import { CartesianPoint } from "../common";
+export declare function isClockwiseWebMercator(center: CartesianPoint, secondCoord: CartesianPoint, thirdCoord: CartesianPoint): boolean;

package/dist/geometry/clockwise.spec.d.ts

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

package/dist/geometry/coordinates-identical.spec.d.ts

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

package/dist/geometry/determine-halfplane.d.ts

@@ -1,10 +1,2 @@
-export declare function determineHalfPlane(point: {
-    x: number;
-    y: number;
-}, lineStart: {
-    x: number;
-    y: number;
-}, lineEnd: {
-    x: number;
-    y: number;
-}): string;
+import { CartesianPoint } from "../common";
+export declare function determineHalfPlane(point: CartesianPoint, lineStart: CartesianPoint, lineEnd: CartesianPoint): string;

package/dist/geometry/determine-halfplane.spec.d.ts

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

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

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

package/dist/geometry/get-midpoint.spec.d.ts

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

package/dist/geometry/limit-decimal-precision.spec.d.ts

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

package/dist/geometry/measure/bearing.d.ts

@@ -1,10 +1,5 @@
 import { Position } from "geojson";
+import { CartesianPoint } from "../../common";
 export declare function bearing(start: Position, end: Position): number;
-export declare function webMercatorBearing({ x: x1, y: y1 }: {
-    x: number;
-    y: number;
-}, { x: x2, y: y2 }: {
-    x: number;
-    y: number;
-}): number;
+export declare function webMercatorBearing({ x: x1, y: y1 }: CartesianPoint, { x: x2, y: y2 }: CartesianPoint): number;
 export declare function normalizeBearing(bearing: number): number;

package/dist/geometry/measure/bearing.spec.d.ts

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

package/dist/geometry/measure/desination.spec.d.ts

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

package/dist/geometry/measure/destination.d.ts

@@ -1,9 +1,4 @@
 import { Position } from "geojson";
+import { CartesianPoint } from "../../common";
 export declare function destination(origin: Position, distance: number, bearing: number): Position;
-export declare function webMercatorDestination({ x, y }: {
-    x: number;
-    y: number;
-}, distance: number, bearing: number): {
-    x: number;
-    y: number;
-};
+export declare function webMercatorDestination({ x, y }: CartesianPoint, distance: number, bearing: number): CartesianPoint;

package/dist/geometry/measure/haversine-distance.spec.d.ts

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

package/dist/geometry/measure/pixel-distance-to-line.d.ts

@@ -1,10 +1,2 @@
-export declare const pixelDistanceToLine: (point: {
-    x: number;
-    y: number;
-}, linePointOne: {
-    x: number;
-    y: number;
-}, linePointTwo: {
-    x: number;
-    y: number;
-}) => number;
+import { CartesianPoint } from "../../common";
+export declare const pixelDistanceToLine: (point: CartesianPoint, linePointOne: CartesianPoint, linePointTwo: CartesianPoint) => number;

package/dist/geometry/measure/pixel-distance-to-line.spec.d.ts

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

package/dist/geometry/measure/pixel-distance.d.ts

@@ -1,7 +1,2 @@
-export declare const cartesianDistance: (pointOne: {
-    x: number;
-    y: number;
-}, pointTwo: {
-    x: number;
-    y: number;
-}) => number;
+import { CartesianPoint } from "../../common";
+export declare const cartesianDistance: (pointOne: CartesianPoint, pointTwo: CartesianPoint) => number;

package/dist/geometry/measure/pixel-distance.spec.d.ts

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

package/dist/geometry/measure/rhumb-bearing.spec.d.ts

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

package/dist/geometry/measure/rhumb-destination.spec.d.ts

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

package/dist/geometry/measure/rhumb-distance.spec.d.ts

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

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

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

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

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

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

@@ -1,13 +1,11 @@
+import { CartesianPoint } from "../../common";
 /**
  * Convert longitude and latitude to web mercator x and y
  * @param lng
  * @param lat
  * @returns - web mercator x and y
  */
-export declare const lngLatToWebMercatorXY: (lng: number, lat: number) => {
-    x: number;
-    y: number;
-};
+export declare const lngLatToWebMercatorXY: (lng: number, lat: number) => CartesianPoint;
 /**
  * Convert web mercator x and y to longitude and latitude
  * @param x - web mercator x

package/dist/geometry/project/web-mercator.spec.d.ts

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

package/dist/geometry/shape/create-bbox.spec.d.ts

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

package/dist/geometry/shape/create-circle.spec.d.ts

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

package/dist/geometry/shape/great-circle-coordinates.spec.d.ts

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

package/dist/geometry/shape/web-mercator-distortion.spec.d.ts

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

package/dist/geometry/transform/rotate.spec.d.ts

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

package/dist/geometry/transform/scale.spec.d.ts

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

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

@@ -1,11 +1,9 @@
 import { Feature, LineString, Polygon } from "geojson";
+import { CartesianPoint } from "../common";
 /**
  * Calculates the centroid of a GeoJSON Polygon or LineString in Web Mercator
 
  * @param {Feature<Polygon | LineString>} feature - The GeoJSON Feature containing either a Polygon or LineString
  * @returns {{ x: number, y: number }} The centroid of the polygon or line string in Web Mercator coordinates.
  */
-export declare function webMercatorCentroid(feature: Feature<Polygon | LineString>): {
-    x: number;
-    y: number;
-};
+export declare function webMercatorCentroid(feature: Feature<Polygon | LineString>): CartesianPoint;

package/dist/geometry/web-mercator-centroid.spec.d.ts

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

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

@@ -0,0 +1,11 @@
+import { Position } from "geojson";
+/**
+ * Takes two points and finds the closest point on the line between them to a third point.
+ * @param lines
+ * @param inputCoordinate
+ * @returns
+ */
+export declare function webMercatorNearestPointOnLine(inputCoordinate: Position, lines: [Position, Position][]): {
+    coordinate: Position;
+    distance: number;
+} | undefined;

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

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

package/dist/modes/angled-rectangle/angled-rectangle.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 TerraDrawPolygonModeKeyEvents = {
     cancel?: KeyboardEvent["key"] | null;
     finish?: KeyboardEvent["key"] | null;
@@ -16,7 +16,6 @@ interface Cursors {
     close?: Cursor;
 }
 interface TerraDrawPolygonModeOptions<T extends CustomStyling> extends BaseModeOptions<T> {
-    snapping?: boolean;
     pointerDistance?: number;
     keyEvents?: TerraDrawPolygonModeKeyEvents | null;
     cursors?: Cursors;
@@ -53,6 +52,6 @@ export declare class TerraDrawAngledRectangleMode extends TerraDrawBaseDrawMode<
     cleanUp(): void;
     /** @internal */
     styleFeature(feature: GeoJSONStoreFeatures): TerraDrawAdapterStyling;
-    validateFeature(feature: unknown): feature is GeoJSONStoreFeatures;
+    validateFeature(feature: unknown): StoreValidation;
 }
 export {};

package/dist/modes/angled-rectangle/angled-rectangle.mode.spec.d.ts

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

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

@@ -40,7 +40,9 @@ export declare abstract class TerraDrawBaseDrawMode<T extends CustomStyling> {
     protected setStarted(): void;
     protected setStopped(): void;
     register(config: TerraDrawModeRegisterConfig): void;
-    validateFeature(feature: unknown): feature is GeoJSONStoreFeatures;
+    validateFeature(feature: unknown): ReturnType<Validation>;
+    private performFeatureValidation;
+    protected validateModeFeature(feature: unknown, modeValidationFn: (feature: GeoJSONStoreFeatures) => ReturnType<Validation>): ReturnType<Validation>;
     abstract start(): void;
     abstract stop(): void;
     abstract cleanUp(): void;

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

@@ -1,5 +1,5 @@
 import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor, Projection } from "../../common";
-import { GeoJSONStoreFeatures } from "../../store/store";
+import { GeoJSONStoreFeatures, StoreValidation } from "../../store/store";
 import { BaseModeOptions, CustomStyling, TerraDrawBaseDrawMode } from "../base.mode";
 type TerraDrawCircleModeKeyEvents = {
     cancel: KeyboardEvent["key"] | null;
@@ -28,6 +28,7 @@ export declare class TerraDrawCircleMode extends TerraDrawBaseDrawMode<CirclePol
     private keyEvents;
     private cursors;
     private startingRadiusKilometers;
+    private cursorMovedAfterInitialCursorDown;
     /**
      * Create a new circle mode instance
      * @param options - Options to customize the behavior of the circle mode
@@ -60,7 +61,7 @@ export declare class TerraDrawCircleMode extends TerraDrawBaseDrawMode<CirclePol
     cleanUp(): void;
     /** @internal */
     styleFeature(feature: GeoJSONStoreFeatures): TerraDrawAdapterStyling;
-    validateFeature(feature: unknown): feature is GeoJSONStoreFeatures;
+    validateFeature(feature: unknown): StoreValidation;
     private updateCircle;
 }
 export {};

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

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

package/dist/modes/click-bounding-box.behavior.spec.d.ts

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

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

@@ -0,0 +1,16 @@
+import { BehaviorConfig, TerraDrawModeBehavior } from "./base.behavior";
+import { TerraDrawMouseEvent } from "../common";
+import { Position } from "geojson";
+import { ClickBoundingBoxBehavior } from "./click-bounding-box.behavior";
+import { FeatureId } from "../store/store";
+import { PixelDistanceBehavior } from "./pixel-distance.behavior";
+export declare class CoordinateSnappingBehavior extends TerraDrawModeBehavior {
+    readonly config: BehaviorConfig;
+    private readonly pixelDistance;
+    private readonly clickBoundingBox;
+    constructor(config: BehaviorConfig, pixelDistance: PixelDistanceBehavior, clickBoundingBox: ClickBoundingBoxBehavior);
+    /** 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;
+}

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

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

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

@@ -1,6 +1,6 @@
 import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor } from "../../common";
 import { BaseModeOptions, CustomStyling, TerraDrawBaseDrawMode } from "../base.mode";
-import { GeoJSONStoreFeatures } from "../../store/store";
+import { GeoJSONStoreFeatures, StoreValidation } from "../../store/store";
 type TerraDrawFreehandModeKeyEvents = {
     cancel: KeyboardEvent["key"] | null;
     finish: KeyboardEvent["key"] | null;
@@ -22,6 +22,8 @@ interface Cursors {
 interface TerraDrawFreehandModeOptions<T extends CustomStyling> extends BaseModeOptions<T> {
     minDistance?: number;
     preventPointsNearClose?: boolean;
+    autoClose?: boolean;
+    autoCloseTimeout?: number;
     keyEvents?: TerraDrawFreehandModeKeyEvents | null;
     cursors?: Cursors;
 }
@@ -34,6 +36,10 @@ export declare class TerraDrawFreehandMode extends TerraDrawBaseDrawMode<Freehan
     private keyEvents;
     private cursors;
     private preventPointsNearClose;
+    private autoClose;
+    private autoCloseTimeout;
+    private hasLeftStartingPoint;
+    private preventNewFeature;
     constructor(options?: TerraDrawFreehandModeOptions<FreehandPolygonStyling>);
     private close;
     /** @internal */
@@ -58,6 +64,6 @@ export declare class TerraDrawFreehandMode extends TerraDrawBaseDrawMode<Freehan
     cleanUp(): void;
     /** @internal */
     styleFeature(feature: GeoJSONStoreFeatures): TerraDrawAdapterStyling;
-    validateFeature(feature: unknown): feature is GeoJSONStoreFeatures;
+    validateFeature(feature: unknown): StoreValidation;
 }
 export {};

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

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

package/dist/modes/insert-coordinates.behavior.spec.d.ts

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

package/dist/modes/{snapping.behavior.d.ts → line-snapping.behavior.d.ts}

@@ -4,7 +4,7 @@ import { Position } from "geojson";
 import { ClickBoundingBoxBehavior } from "./click-bounding-box.behavior";
 import { FeatureId } from "../store/store";
 import { PixelDistanceBehavior } from "./pixel-distance.behavior";
-export declare class SnappingBehavior extends TerraDrawModeBehavior {
+export declare class LineSnappingBehavior extends TerraDrawModeBehavior {
     readonly config: BehaviorConfig;
     private readonly pixelDistance;
     private readonly clickBoundingBox;

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

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

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

@@ -1,7 +1,8 @@
 import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor } from "../../common";
+import { Position } from "geojson";
 import { BaseModeOptions, CustomStyling, TerraDrawBaseDrawMode } from "../base.mode";
 import { BehaviorConfig } from "../base.behavior";
-import { GeoJSONStoreFeatures } from "../../store/store";
+import { GeoJSONStoreFeatures, StoreValidation } from "../../store/store";
 type TerraDrawLineStringModeKeyEvents = {
     cancel: KeyboardEvent["key"] | null;
     finish: KeyboardEvent["key"] | null;
@@ -13,6 +14,10 @@ type LineStringStyling = {
     closingPointWidth: NumericStyling;
     closingPointOutlineColor: HexColorStyling;
     closingPointOutlineWidth: NumericStyling;
+    snappingPointColor: HexColorStyling;
+    snappingPointWidth: NumericStyling;
+    snappingPointOutlineColor: HexColorStyling;
+    snappingPointOutlineWidth: NumericStyling;
 };
 interface Cursors {
     start?: Cursor;
@@ -22,8 +27,12 @@ interface InertCoordinates {
     strategy: "amount";
     value: number;
 }
+interface Snapping {
+    toCoordinate?: boolean;
+    toCustom?: (event: TerraDrawMouseEvent) => Position | undefined;
+}
 interface TerraDrawLineStringModeOptions<T extends CustomStyling> extends BaseModeOptions<T> {
-    snapping?: boolean;
+    snapping?: Snapping;
     pointerDistance?: number;
     keyEvents?: TerraDrawLineStringModeKeyEvents | null;
     cursors?: Cursors;
@@ -35,12 +44,13 @@ export declare class TerraDrawLineStringMode extends TerraDrawBaseDrawMode<LineS
     private currentId;
     private closingPointId;
     private keyEvents;
-    private snappingEnabled;
+    private snapping;
     private cursors;
     private mouseMove;
     private insertCoordinates;
     private lastCommitedCoordinates;
-    private snapping;
+    private snappedPointId;
+    private coordinateSnapping;
     private insertPoint;
     constructor(options?: TerraDrawLineStringModeOptions<LineStringStyling>);
     private close;
@@ -73,6 +83,7 @@ export declare class TerraDrawLineStringMode extends TerraDrawBaseDrawMode<LineS
     cleanUp(): void;
     /** @internal */
     styleFeature(feature: GeoJSONStoreFeatures): TerraDrawAdapterStyling;
-    validateFeature(feature: unknown): feature is GeoJSONStoreFeatures;
+    validateFeature(feature: unknown): StoreValidation;
+    private snapCoordinate;
 }
 export {};

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

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

package/dist/modes/pixel-distance.behavior.spec.d.ts

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

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

@@ -1,5 +1,5 @@
 import { TerraDrawMouseEvent, TerraDrawAdapterStyling, NumericStyling, HexColorStyling, Cursor } from "../../common";
-import { GeoJSONStoreFeatures } from "../../store/store";
+import { GeoJSONStoreFeatures, StoreValidation } from "../../store/store";
 import { BaseModeOptions, CustomStyling, TerraDrawBaseDrawMode } from "../base.mode";
 type PointModeStyling = {
     pointWidth: NumericStyling;
@@ -39,6 +39,6 @@ export declare class TerraDrawPointMode extends TerraDrawBaseDrawMode<PointModeS
     onDragEnd(): void;
     /** @internal */
     styleFeature(feature: GeoJSONStoreFeatures): TerraDrawAdapterStyling;
-    validateFeature(feature: unknown): feature is GeoJSONStoreFeatures;
+    validateFeature(feature: unknown): StoreValidation;
 }
 export {};

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

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

package/dist/modes/polygon/behaviors/closing-points.behavior.spec.d.ts

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