terra-draw 0.0.1-alpha.54 → 0.0.1-alpha.55

package/dist/common.d.ts

@@ -1,4 +1,4 @@
-import { StoreChangeHandler, GeoJSONStore, GeoJSONStoreFeatures } from "./store/store";
+import { StoreChangeHandler, GeoJSONStore, GeoJSONStoreFeatures, FeatureId } from "./store/store";
 export type HexColor = `#${string}`;
 export type HexColorStyling = HexColor | ((feature: GeoJSONStoreFeatures) => HexColor);
 export type NumericStyling = number | ((feature: GeoJSONStoreFeatures) => number);
@@ -74,7 +74,7 @@ export interface TerraDrawChanges {
     created: GeoJSONStoreFeatures[];
     updated: GeoJSONStoreFeatures[];
     unchanged: GeoJSONStoreFeatures[];
-    deletedIds: string[];
+    deletedIds: FeatureId[];
 }
 export type TerraDrawStylingFunction = {
     [mode: string]: (feature: GeoJSONStoreFeatures) => TerraDrawAdapterStyling;

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

@@ -1,6 +1,6 @@
 import { BehaviorConfig, TerraDrawModeBehavior } from "./base.behavior";
 import { HexColor, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, TerraDrawModeRegisterConfig, TerraDrawModeState, TerraDrawMouseEvent } from "../common";
-import { GeoJSONStore, GeoJSONStoreFeatures, StoreChangeHandler } from "../store/store";
+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 {
     Drawing = "drawing",
@@ -41,9 +41,9 @@ export declare abstract class TerraDrawBaseDrawMode<T extends CustomStyling> {
     abstract stop(): void;
     abstract cleanUp(): void;
     abstract styleFeature(feature: GeoJSONStoreFeatures): TerraDrawAdapterStyling;
-    onFinish(finishedId: string): void;
-    onDeselect(deselectedId: string): void;
-    onSelect(selectedId: string): void;
+    onFinish(finishedId: FeatureId): void;
+    onDeselect(deselectedId: FeatureId): void;
+    onSelect(selectedId: FeatureId): void;
     onKeyDown(event: TerraDrawKeyboardEvent): void;
     onKeyUp(event: TerraDrawKeyboardEvent): void;
     onMouseMove(event: TerraDrawMouseEvent): void;

package/dist/modes/great-circle-snapping.behavior.d.ts

@@ -2,12 +2,13 @@ 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 GreatCircleSnappingBehavior extends TerraDrawModeBehavior {
     readonly config: BehaviorConfig;
     private readonly pixelDistance;
     private readonly clickBoundingBox;
     constructor(config: BehaviorConfig, pixelDistance: PixelDistanceBehavior, clickBoundingBox: ClickBoundingBoxBehavior);
-    getSnappableCoordinate: (event: TerraDrawMouseEvent, currentFeatureId?: string) => Position | undefined;
+    getSnappableCoordinate: (event: TerraDrawMouseEvent, currentFeatureId?: FeatureId) => Position | undefined;
     private getSnappableEnds;
 }

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

@@ -3,6 +3,7 @@ import { BehaviorConfig, TerraDrawModeBehavior } from "../../base.behavior";
 import { PixelDistanceBehavior } from "../../pixel-distance.behavior";
 import { MidPointBehavior } from "./midpoint.behavior";
 import { SelectionPointBehavior } from "./selection-point.behavior";
+import { FeatureId } from "../../../store/store";
 export declare class DragCoordinateBehavior extends TerraDrawModeBehavior {
     readonly config: BehaviorConfig;
     private readonly pixelDistance;
@@ -11,9 +12,9 @@ export declare class DragCoordinateBehavior extends TerraDrawModeBehavior {
     constructor(config: BehaviorConfig, pixelDistance: PixelDistanceBehavior, selectionPoints: SelectionPointBehavior, midPoints: MidPointBehavior);
     private draggedCoordinate;
     private getClosestCoordinate;
-    getDraggableIndex(event: TerraDrawMouseEvent, selectedId: string): number;
+    getDraggableIndex(event: TerraDrawMouseEvent, selectedId: FeatureId): number;
     drag(event: TerraDrawMouseEvent, allowSelfIntersection: boolean): boolean;
     isDragging(): boolean;
-    startDragging(id: string, index: number): void;
+    startDragging(id: FeatureId, index: number): void;
     stopDragging(): void;
 }

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

@@ -3,6 +3,7 @@ import { BehaviorConfig, TerraDrawModeBehavior } from "../../base.behavior";
 import { FeatureAtPointerEventBehavior } from "./feature-at-pointer-event.behavior";
 import { SelectionPointBehavior } from "./selection-point.behavior";
 import { MidPointBehavior } from "./midpoint.behavior";
+import { FeatureId } from "../../../store/store";
 export declare class DragFeatureBehavior extends TerraDrawModeBehavior {
     readonly config: BehaviorConfig;
     private readonly featuresAtMouseEvent;
@@ -11,9 +12,9 @@ export declare class DragFeatureBehavior extends TerraDrawModeBehavior {
     constructor(config: BehaviorConfig, featuresAtMouseEvent: FeatureAtPointerEventBehavior, selectionPoints: SelectionPointBehavior, midPoints: MidPointBehavior);
     private draggedFeatureId;
     private dragPosition;
-    startDragging(event: TerraDrawMouseEvent, id: string): void;
+    startDragging(event: TerraDrawMouseEvent, id: FeatureId): void;
     stopDragging(): void;
     isDragging(): boolean;
-    canDrag(event: TerraDrawMouseEvent, selectedId: string): boolean;
+    canDrag(event: TerraDrawMouseEvent, selectedId: FeatureId): boolean;
     drag(event: TerraDrawMouseEvent): false | undefined;
 }

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

@@ -1,6 +1,7 @@
 import { Point, Position } from "geojson";
 import { BehaviorConfig, TerraDrawModeBehavior } from "../../base.behavior";
 import { SelectionPointBehavior } from "./selection-point.behavior";
+import { FeatureId } from "../../../store/store";
 export declare class MidPointBehavior extends TerraDrawModeBehavior {
     readonly config: BehaviorConfig;
     private readonly selectionPointBehavior;
@@ -9,7 +10,7 @@ export declare class MidPointBehavior extends TerraDrawModeBehavior {
     get ids(): string[];
     set ids(_: string[]);
     insert(midPointId: string, coordinatePrecision: number): void;
-    create(selectedCoords: Position[], featureId: string, coordinatePrecision: number): void;
+    create(selectedCoords: Position[], featureId: FeatureId, coordinatePrecision: number): void;
     delete(): void;
     getUpdated(updatedCoordinates: Position[]): {
         id: string;

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

@@ -2,6 +2,7 @@ import { TerraDrawMouseEvent } from "../../../common";
 import { BehaviorConfig, TerraDrawModeBehavior } from "../../base.behavior";
 import { SelectionPointBehavior } from "./selection-point.behavior";
 import { MidPointBehavior } from "./midpoint.behavior";
+import { FeatureId } from "../../../store/store";
 export declare class RotateFeatureBehavior extends TerraDrawModeBehavior {
     readonly config: BehaviorConfig;
     private readonly selectionPoints;
@@ -9,5 +10,5 @@ export declare class RotateFeatureBehavior extends TerraDrawModeBehavior {
     constructor(config: BehaviorConfig, selectionPoints: SelectionPointBehavior, midPoints: MidPointBehavior);
     private lastBearing;
     reset(): void;
-    rotate(event: TerraDrawMouseEvent, selectedId: string): void;
+    rotate(event: TerraDrawMouseEvent, selectedId: FeatureId): void;
 }

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

@@ -2,6 +2,7 @@ import { TerraDrawMouseEvent } from "../../../common";
 import { BehaviorConfig, TerraDrawModeBehavior } from "../../base.behavior";
 import { SelectionPointBehavior } from "./selection-point.behavior";
 import { MidPointBehavior } from "./midpoint.behavior";
+import { FeatureId } from "../../../store/store";
 export declare class ScaleFeatureBehavior extends TerraDrawModeBehavior {
     readonly config: BehaviorConfig;
     private readonly selectionPoints;
@@ -9,5 +10,5 @@ export declare class ScaleFeatureBehavior extends TerraDrawModeBehavior {
     constructor(config: BehaviorConfig, selectionPoints: SelectionPointBehavior, midPoints: MidPointBehavior);
     private lastDistance;
     reset(): void;
-    scale(event: TerraDrawMouseEvent, selectedId: string): void;
+    scale(event: TerraDrawMouseEvent, selectedId: FeatureId): void;
 }

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

@@ -1,14 +1,15 @@
 import { LineString, Point, Polygon, Position } from "geojson";
 import { BehaviorConfig, TerraDrawModeBehavior } from "../../base.behavior";
+import { FeatureId } from "../../../store/store";
 export declare class SelectionPointBehavior extends TerraDrawModeBehavior {
     constructor(config: BehaviorConfig);
     private _selectionPoints;
-    get ids(): string[];
-    set ids(_: string[]);
-    create(selectedCoords: Position[], type: Polygon["type"] | LineString["type"], featureId: string): void;
+    get ids(): FeatureId[];
+    set ids(_: FeatureId[]);
+    create(selectedCoords: Position[], type: Polygon["type"] | LineString["type"], featureId: FeatureId): void;
     delete(): void;
     getUpdated(updatedCoordinates: Position[]): {
-        id: string;
+        id: FeatureId;
         geometry: Point;
     }[] | undefined;
     getOneUpdated(index: number, updatedCoordinate: Position): {

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

@@ -2,6 +2,7 @@ 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 SnappingBehavior extends TerraDrawModeBehavior {
     readonly config: BehaviorConfig;
@@ -10,6 +11,6 @@ export declare class SnappingBehavior extends TerraDrawModeBehavior {
     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: string) => Position | undefined;
+    getSnappableCoordinate: (event: TerraDrawMouseEvent, currentFeatureId: FeatureId) => Position | undefined;
     private getSnappable;
 }

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

@@ -1,4 +1,4 @@
-import { GeoJSONStoreFeatures } from "../store";
+import { FeatureId, GeoJSONStoreFeatures } from "../store";
 export declare class SpatialIndex {
     private tree;
     private idToNode;
@@ -11,8 +11,8 @@ export declare class SpatialIndex {
     insert(feature: GeoJSONStoreFeatures): void;
     load(features: GeoJSONStoreFeatures[]): void;
     update(feature: GeoJSONStoreFeatures): void;
-    remove(featureId: string): void;
+    remove(featureId: FeatureId): void;
     clear(): void;
-    search(feature: GeoJSONStoreFeatures): string[];
+    search(feature: GeoJSONStoreFeatures): FeatureId[];
     collides(feature: GeoJSONStoreFeatures): boolean;
 }

package/dist/store/store-feature-validation.d.ts

@@ -1,10 +1,11 @@
-import { GeoJSONStoreFeatures } from "./store";
+import { FeatureId, GeoJSONStoreFeatures, IdStrategy } from "./store";
 export declare const StoreValidationErrors: {
     readonly FeatureHasNoId: "Feature has no id";
     readonly FeatureIsNotObject: "Feature is not object";
     readonly InvalidTrackedProperties: "updatedAt and createdAt are not valid timestamps";
     readonly FeatureHasNoMode: "Feature does not have a set mode";
-    readonly FeatureIdIsNotUUID4: "Feature must have UUID4 id";
+    readonly FeatureIdIsNotValidGeoJSON: "Feature must be string or number as per GeoJSON spec";
+    readonly FeatureIdIsNotValid: "Feature must match the id strategy (default is UUID4)";
     readonly FeatureHasNoGeometry: "Feature has no geometry";
     readonly FeatureHasNoProperties: "Feature has no properties";
     readonly FeatureGeometryNotSupported: "Feature is not Point, LineString or Polygon";
@@ -12,4 +13,4 @@ export declare const StoreValidationErrors: {
     readonly InvalidModeProperty: "Feature does not have a valid mode property";
 };
 export declare function isValidTimestamp(timestamp: unknown): boolean;
-export declare function isValidStoreFeature(feature: unknown): feature is GeoJSONStoreFeatures;
+export declare function isValidStoreFeature(feature: unknown, isValidId: IdStrategy<FeatureId>["isValidId"]): feature is GeoJSONStoreFeatures;

package/dist/store/store.d.ts

@@ -9,38 +9,49 @@ 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 StoreChangeHandler = (ids: string[], change: StoreChangeEvents) => void;
-export type GeoJSONStoreConfig = {
+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> = {
+    idStrategy?: IdStrategy<Id>;
     tracked?: boolean;
 };
-export declare class GeoJSONStore {
-    constructor(config?: GeoJSONStoreConfig);
+export declare const defaultIdStrategy: {
+    getId: <FeatureId_1>() => FeatureId_1;
+    isValidId: (id: FeatureId) => boolean;
+};
+export declare class GeoJSONStore<Id extends FeatureId = FeatureId> {
+    constructor(config?: GeoJSONStoreConfig<Id>);
+    idStrategy: IdStrategy<Id>;
     private tracked;
     private spatialIndex;
     private store;
     private _onChange;
-    private getId;
     private clone;
-    has(id: string): boolean;
+    getId(): FeatureId;
+    has(id: FeatureId): boolean;
     load(data: GeoJSONStoreFeatures[], featureValidation?: (feature: unknown, tracked?: boolean) => boolean): void;
     search(bbox: BBoxPolygon, filter?: (feature: GeoJSONStoreFeatures) => boolean): GeoJSONStoreFeatures[];
     registerOnChange(onChange: StoreChangeHandler): void;
-    getGeometryCopy<T extends GeoJSONStoreGeometries>(id: string): T;
-    getPropertiesCopy(id: string): DefinedProperties;
+    getGeometryCopy<T extends GeoJSONStoreGeometries>(id: FeatureId): T;
+    getPropertiesCopy(id: FeatureId): DefinedProperties;
     updateProperty(propertiesToUpdate: {
-        id: string;
+        id: FeatureId;
         property: string;
         value: JSON;
     }[]): void;
     updateGeometry(geometriesToUpdate: {
-        id: string;
+        id: FeatureId;
         geometry: GeoJSONStoreGeometries;
     }[]): void;
-    create(features: {
+    create<Id extends FeatureId>(features: {
         geometry: GeoJSONStoreGeometries;
         properties?: JSONObject;
-    }[]): string[];
-    delete(ids: string[]): void;
+    }[]): Id[];
+    delete(ids: FeatureId[]): void;
     copyAll(): GeoJSONStoreFeatures[];
     clear(): void;
     size(): number;