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

package/dist/common.d.ts

@@ -45,6 +45,10 @@ export type GetLngLatFromEvent = (event: PointerEvent | MouseEvent) => {
     lng: number;
     lat: number;
 } | null;
+export type OnFinishContext = {
+    mode: string;
+    action: string;
+};
 export interface TerraDrawModeRegisterConfig {
     mode: string;
     store: GeoJSONStore;
@@ -53,12 +57,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/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

@@ -17,7 +17,7 @@ interface Cursors {
 interface TerraDrawCircleModeOptions<T extends CustomStyling> extends BaseModeOptions<T> {
     keyEvents?: TerraDrawCircleModeKeyEvents | null;
     cursors?: Cursors;
-    minimumRadiusKilometers?: number;
+    startingRadiusKilometers?: number;
 }
 export declare class TerraDrawCircleMode extends TerraDrawBaseDrawMode<CirclePolygonStyling> {
     mode: string;
@@ -26,13 +26,12 @@ export declare class TerraDrawCircleMode extends TerraDrawBaseDrawMode<CirclePol
     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 +60,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/linestring/linestring.mode.d.ts

@@ -20,7 +20,6 @@ interface Cursors {
 }
 interface TerraDrawLineStringModeOptions<T extends CustomStyling> extends BaseModeOptions<T> {
     snapping?: boolean;
-    allowSelfIntersections?: boolean;
     pointerDistance?: number;
     keyEvents?: TerraDrawLineStringModeKeyEvents | null;
     cursors?: Cursors;
@@ -30,7 +29,6 @@ export declare class TerraDrawLineStringMode extends TerraDrawBaseDrawMode<LineS
     private currentCoordinate;
     private currentId;
     private closingPointId;
-    private allowSelfIntersections;
     private keyEvents;
     private snappingEnabled;
     private cursors;
@@ -38,6 +36,7 @@ export declare class TerraDrawLineStringMode extends TerraDrawBaseDrawMode<LineS
     private snapping;
     constructor(options?: TerraDrawLineStringModeOptions<LineStringStyling>);
     private close;
+    private updateGeometries;
     /** @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 */