terra-draw 1.0.0-beta.1 → 1.0.0-beta.10

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/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/sector/sector.mode.d.ts

@@ -0,0 +1,60 @@
+import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor } from "../../common";
+import { TerraDrawBaseDrawMode, BaseModeOptions, CustomStyling } from "../base.mode";
+import { GeoJSONStoreFeatures, StoreValidation } from "../../store/store";
+type TerraDrawSectorModeKeyEvents = {
+    cancel?: KeyboardEvent["key"] | null;
+    finish?: KeyboardEvent["key"] | null;
+};
+type SectorPolygonStyling = {
+    fillColor: HexColorStyling;
+    outlineColor: HexColorStyling;
+    outlineWidth: NumericStyling;
+    fillOpacity: NumericStyling;
+};
+interface Cursors {
+    start?: Cursor;
+    close?: Cursor;
+}
+interface TerraDrawSectorModeOptions<T extends CustomStyling> extends BaseModeOptions<T> {
+    arcPoints?: number;
+    pointerDistance?: number;
+    keyEvents?: TerraDrawSectorModeKeyEvents | null;
+    cursors?: Cursors;
+}
+export declare class TerraDrawSectorMode extends TerraDrawBaseDrawMode<SectorPolygonStyling> {
+    mode: string;
+    private currentCoordinate;
+    private currentId;
+    private keyEvents;
+    private direction;
+    private arcPoints;
+    private cursors;
+    private mouseMove;
+    constructor(options?: TerraDrawSectorModeOptions<SectorPolygonStyling>);
+    private close;
+    /** @internal */
+    start(): void;
+    /** @internal */
+    stop(): void;
+    /** @internal */
+    onMouseMove(event: TerraDrawMouseEvent): void;
+    private updatePolygonGeometry;
+    /** @internal */
+    onClick(event: TerraDrawMouseEvent): void;
+    /** @internal */
+    onKeyUp(event: TerraDrawKeyboardEvent): void;
+    /** @internal */
+    onKeyDown(): void;
+    /** @internal */
+    onDragStart(): void;
+    /** @internal */
+    onDrag(): void;
+    /** @internal */
+    onDragEnd(): void;
+    /** @internal */
+    cleanUp(): void;
+    /** @internal */
+    styleFeature(feature: GeoJSONStoreFeatures): TerraDrawAdapterStyling;
+    validateFeature(feature: unknown): StoreValidation;
+}
+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/sensor/sensor.mode.d.ts

@@ -0,0 +1,69 @@
+import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling, Cursor } from "../../common";
+import { TerraDrawBaseDrawMode, BaseModeOptions, CustomStyling } from "../base.mode";
+import { GeoJSONStoreFeatures, StoreValidation } from "../../store/store";
+type TerraDrawSensorModeKeyEvents = {
+    cancel?: KeyboardEvent["key"] | null;
+    finish?: KeyboardEvent["key"] | null;
+};
+type SensorPolygonStyling = {
+    centerPointColor: HexColorStyling;
+    centerPointWidth: NumericStyling;
+    centerPointOutlineColor: HexColorStyling;
+    centerPointOutlineWidth: NumericStyling;
+    fillColor: HexColorStyling;
+    outlineColor: HexColorStyling;
+    outlineWidth: NumericStyling;
+    fillOpacity: NumericStyling;
+};
+interface Cursors {
+    start?: Cursor;
+    close?: Cursor;
+}
+interface TerraDrawSensorModeOptions<T extends CustomStyling> extends BaseModeOptions<T> {
+    arcPoints?: number;
+    pointerDistance?: number;
+    keyEvents?: TerraDrawSensorModeKeyEvents | null;
+    cursors?: Cursors;
+}
+export declare class TerraDrawSensorMode extends TerraDrawBaseDrawMode<SensorPolygonStyling> {
+    mode: string;
+    private currentCoordinate;
+    private currentId;
+    private currentInitialArcId;
+    private currentStartingPointId;
+    private keyEvents;
+    private direction;
+    private arcPoints;
+    private cursors;
+    private mouseMove;
+    constructor(options?: TerraDrawSensorModeOptions<SensorPolygonStyling>);
+    private close;
+    /** @internal */
+    start(): void;
+    /** @internal */
+    stop(): void;
+    /** @internal */
+    onMouseMove(event: TerraDrawMouseEvent): void;
+    private updateLineStringGeometry;
+    private updatePolygonGeometry;
+    /** @internal */
+    onClick(event: TerraDrawMouseEvent): void;
+    /** @internal */
+    onKeyUp(event: TerraDrawKeyboardEvent): void;
+    /** @internal */
+    onKeyDown(): void;
+    /** @internal */
+    onDragStart(): void;
+    /** @internal */
+    onDrag(): void;
+    /** @internal */
+    onDragEnd(): void;
+    /** @internal */
+    cleanUp(): void;
+    /** @internal */
+    styleFeature(feature: GeoJSONStoreFeatures): TerraDrawAdapterStyling;
+    validateFeature(feature: unknown): StoreValidation;
+    private getDeltaBearing;
+    private notInSector;
+}
+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.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,14 +9,17 @@ 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 StoreChangeEvents = "delete" | "create" | "update" | "styling";
+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;
 export type IdStrategy<Id extends FeatureId> = {
     isValidId: (id: Id) => boolean;
     getId: () => Id;
 };
-export type GeoJSONStoreConfig<Id extends FeatureId> = {
+type GeoJSONStoreConfig<Id extends FeatureId> = {
     idStrategy?: IdStrategy<Id>;
     tracked?: boolean;
 };
@@ -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;