terra-draw 0.0.1-alpha.67 → 0.0.1-alpha.69

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

@@ -1,4 +1,3 @@
-/// <reference types="google.maps" />
 import { TerraDrawChanges, SetCursor, TerraDrawStylingFunction, TerraDrawCallbacks } from "../common";
 import { BaseAdapterConfig, TerraDrawBaseAdapter } from "./common/base.adapter";
 export declare class TerraDrawGoogleMapsAdapter extends TerraDrawBaseAdapter {

package/dist/common.d.ts

@@ -45,6 +45,11 @@ export type GetLngLatFromEvent = (event: PointerEvent | MouseEvent) => {
     lng: number;
     lat: number;
 } | null;
+export type Projection = "web-mercator" | "globe";
+export type OnFinishContext = {
+    mode: string;
+    action: string;
+};
 export interface TerraDrawModeRegisterConfig {
     mode: string;
     store: GeoJSONStore;
@@ -53,12 +58,19 @@ export interface TerraDrawModeRegisterConfig {
     onChange: StoreChangeHandler;
     onSelect: (selectedId: string) => void;
     onDeselect: (deselectedId: string) => void;
-    onFinish: (finishedId: string) => void;
+    onFinish: (finishedId: string, context: OnFinishContext) => void;
     project: Project;
     unproject: Unproject;
     coordinatePrecision: number;
 }
-type ValidationContext = Pick<TerraDrawModeRegisterConfig, "project" | "unproject" | "coordinatePrecision">;
+export declare enum UpdateTypes {
+    Commit = "commit",
+    Provisional = "provisional",
+    Finish = "finish"
+}
+type ValidationContext = Pick<TerraDrawModeRegisterConfig, "project" | "unproject" | "coordinatePrecision"> & {
+    updateType: UpdateTypes;
+};
 export type Validation = (feature: GeoJSONStoreFeatures, context: ValidationContext) => boolean;
 export type TerraDrawModeState = "unregistered" | "registered" | "started" | "drawing" | "selecting" | "stopped";
 export interface TerraDrawCallbacks {

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

@@ -0,0 +1,2 @@
+import { Position } from "geojson";
+export declare function bearing(start: Position, end: Position): number;

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

@@ -0,0 +1,2 @@
+import { Position } from "geojson";
+export declare function destination(origin: Position, distance: number, bearing: number): Position;

package/dist/geometry/measure/slice-along.d.ts

@@ -0,0 +1,2 @@
+import { LineString, Position } from "geojson";
+export declare function lineSliceAlong(coords: LineString["coordinates"], startDist: number, stopDist: number): Position[];

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

@@ -7,4 +7,4 @@ export declare function createBBoxFromPoint({ unproject, point, pointerDistance,
     };
     unproject: Unproject;
     pointerDistance: number;
-}): Feature<Polygon, import("geojson").GeoJsonProperties>;
+}): Feature<Polygon>;

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

@@ -5,3 +5,9 @@ export declare function circle(options: {
     coordinatePrecision: number;
     steps?: number;
 }): Feature<Polygon>;
+export declare function circleWebMercator(options: {
+    center: Position;
+    radiusKilometers: number;
+    coordinatePrecision: number;
+    steps?: number;
+}): GeoJSON.Feature<GeoJSON.Polygon>;

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

@@ -0,0 +1,2 @@
+import { Position } from "geojson";
+export declare function generateGreatCircleCoordinates(start: Position, end: Position, numberOfPoints: number): Position[];

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

@@ -0,0 +1,2 @@
+import { Position } from "geojson";
+export declare function calculateWebMercatorDistortion(source: Position, target: Position): number;

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

@@ -1,5 +1,5 @@
 import { BehaviorConfig, TerraDrawModeBehavior } from "./base.behavior";
-import { HexColor, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, TerraDrawModeRegisterConfig, TerraDrawModeState, TerraDrawMouseEvent } from "../common";
+import { HexColor, OnFinishContext, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, TerraDrawModeRegisterConfig, TerraDrawModeState, TerraDrawMouseEvent, Validation } from "../common";
 import { FeatureId, GeoJSONStore, GeoJSONStoreFeatures, StoreChangeHandler } from "../store/store";
 export type CustomStyling = Record<string, string | number | ((feature: GeoJSONStoreFeatures) => HexColor) | ((feature: GeoJSONStoreFeatures) => number)>;
 export declare enum ModeTypes {
@@ -11,6 +11,7 @@ export declare enum ModeTypes {
 export type BaseModeOptions<T extends CustomStyling> = {
     styles?: Partial<T>;
     pointerDistance?: number;
+    validation?: Validation;
 };
 export declare abstract class TerraDrawBaseDrawMode<T extends CustomStyling> {
     protected _state: TerraDrawModeState;
@@ -20,6 +21,7 @@ export declare abstract class TerraDrawBaseDrawMode<T extends CustomStyling> {
     get styles(): Partial<T>;
     set styles(styling: Partial<T>);
     protected behaviors: TerraDrawModeBehavior[];
+    protected validate: Validation | undefined;
     protected pointerDistance: number;
     protected coordinatePrecision: number;
     protected onStyleChange: StoreChangeHandler;
@@ -41,7 +43,7 @@ export declare abstract class TerraDrawBaseDrawMode<T extends CustomStyling> {
     abstract stop(): void;
     abstract cleanUp(): void;
     abstract styleFeature(feature: GeoJSONStoreFeatures): TerraDrawAdapterStyling;
-    onFinish(finishedId: FeatureId): void;
+    onFinish(finishedId: FeatureId, context: OnFinishContext): void;
     onDeselect(deselectedId: FeatureId): void;
     onSelect(selectedId: FeatureId): void;
     onKeyDown(event: TerraDrawKeyboardEvent): void;

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

@@ -1,4 +1,4 @@
-import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor } from "../../common";
+import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor, Projection } from "../../common";
 import { GeoJSONStoreFeatures } from "../../store/store";
 import { BaseModeOptions, CustomStyling, TerraDrawBaseDrawMode } from "../base.mode";
 type TerraDrawCircleModeKeyEvents = {
@@ -17,22 +17,23 @@ interface Cursors {
 interface TerraDrawCircleModeOptions<T extends CustomStyling> extends BaseModeOptions<T> {
     keyEvents?: TerraDrawCircleModeKeyEvents | null;
     cursors?: Cursors;
-    minimumRadiusKilometers?: number;
+    startingRadiusKilometers?: number;
+    projection?: Projection;
 }
 export declare class TerraDrawCircleMode extends TerraDrawBaseDrawMode<CirclePolygonStyling> {
     mode: string;
+    private projection;
     private center;
     private clickCount;
     private currentCircleId;
     private keyEvents;
     private cursors;
-    private minimumRadiusKilometers;
+    private startingRadiusKilometers;
     /**
      * Create a new circle mode instance
      * @param options - Options to customize the behavior of the circle mode
      * @param options.keyEvents - Key events to cancel or finish the mode
      * @param options.cursors - Cursors to use for the mode
-     * @param options.minimumRadiusKilometers - Minimum radius for the circle
      * @param options.styles - Custom styling for the circle
      * @param options.pointerDistance - Distance in pixels to consider a pointer close to a vertex
      */
@@ -61,6 +62,6 @@ export declare class TerraDrawCircleMode extends TerraDrawBaseDrawMode<CirclePol
     /** @internal */
     styleFeature(feature: GeoJSONStoreFeatures): TerraDrawAdapterStyling;
     validateFeature(feature: unknown): feature is GeoJSONStoreFeatures;
-    private createCircle;
+    private updateCircle;
 }
 export {};

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

@@ -0,0 +1,9 @@
+import { BehaviorConfig, TerraDrawModeBehavior } from "./base.behavior";
+import { Position } from "geojson";
+export declare class InsertCoordinatesBehavior extends TerraDrawModeBehavior {
+    readonly config: BehaviorConfig;
+    constructor(config: BehaviorConfig);
+    generateInsertionCoordinates(coordinateOne: Position, coordinateTwo: Position, segmentLength: number): Position[];
+    generateInsertionGeodesicCoordinates(coordinateOne: Position, coordinateTwo: Position, segmentLength: number): Position[];
+    private limitCoordinates;
+}

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

@@ -1,4 +1,4 @@
-import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor } from "../../common";
+import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor, Projection } from "../../common";
 import { BaseModeOptions, CustomStyling, TerraDrawBaseDrawMode } from "../base.mode";
 import { BehaviorConfig } from "../base.behavior";
 import { GeoJSONStoreFeatures } from "../../store/store";
@@ -18,26 +18,39 @@ interface Cursors {
     start?: Cursor;
     close?: Cursor;
 }
+interface InertCoordinates {
+    strategy: "amount";
+    value: number;
+}
 interface TerraDrawLineStringModeOptions<T extends CustomStyling> extends BaseModeOptions<T> {
     snapping?: boolean;
-    allowSelfIntersections?: boolean;
     pointerDistance?: number;
     keyEvents?: TerraDrawLineStringModeKeyEvents | null;
     cursors?: Cursors;
+    insertCoordinates?: InertCoordinates;
+    projection?: Projection;
 }
 export declare class TerraDrawLineStringMode extends TerraDrawBaseDrawMode<LineStringStyling> {
     mode: string;
+    private projection;
     private currentCoordinate;
     private currentId;
     private closingPointId;
-    private allowSelfIntersections;
     private keyEvents;
     private snappingEnabled;
     private cursors;
     private mouseMove;
+    private insertCoordinates;
+    private lastCommitedCoordinates;
     private snapping;
+    private insertPoint;
     constructor(options?: TerraDrawLineStringModeOptions<LineStringStyling>);
     private close;
+    private updateGeometries;
+    private generateInsertCoordinates;
+    private createLine;
+    private firstUpdateToLine;
+    private updateToLine;
     /** @internal */
     registerBehaviors(config: BehaviorConfig): void;
     /** @internal */

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

@@ -21,7 +21,6 @@ interface Cursors {
     close?: Cursor;
 }
 interface TerraDrawPolygonModeOptions<T extends CustomStyling> extends BaseModeOptions<T> {
-    allowSelfIntersections?: boolean;
     snapping?: boolean;
     pointerDistance?: number;
     keyEvents?: TerraDrawPolygonModeKeyEvents | null;
@@ -31,7 +30,6 @@ export declare class TerraDrawPolygonMode extends TerraDrawBaseDrawMode<PolygonS
     mode: string;
     private currentCoordinate;
     private currentId;
-    private allowSelfIntersections;
     private keyEvents;
     private snappingEnabled;
     private snapping;
@@ -49,6 +47,7 @@ export declare class TerraDrawPolygonMode extends TerraDrawBaseDrawMode<PolygonS
     stop(): void;
     /** @internal */
     onMouseMove(event: TerraDrawMouseEvent): void;
+    private updatePolygonGeometry;
     /** @internal */
     onClick(event: TerraDrawMouseEvent): void;
     /** @internal */

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

@@ -16,16 +16,16 @@ export declare class TerraDrawStaticMode extends TerraDrawBaseDrawMode<StaticMod
     onMouseMove(): void;
     cleanUp(): void;
     styleFeature(): {
-        pointColor: `#${string}`;
+        pointColor: import("../../common").HexColor;
         pointWidth: number;
-        pointOutlineColor: `#${string}`;
+        pointOutlineColor: import("../../common").HexColor;
         pointOutlineWidth: number;
-        polygonFillColor: `#${string}`;
+        polygonFillColor: import("../../common").HexColor;
         polygonFillOpacity: number;
-        polygonOutlineColor: `#${string}`;
+        polygonOutlineColor: import("../../common").HexColor;
         polygonOutlineWidth: number;
         lineStringWidth: number;
-        lineStringColor: `#${string}`;
+        lineStringColor: import("../../common").HexColor;
         zIndex: number;
     };
 }