terra-draw 1.4.2 → 1.5.0

package/dist/common.d.ts

@@ -48,12 +48,16 @@ export type OnFinishContext = {
     mode: string;
     action: string;
 };
+export type OnChangeContext = {
+    origin: "api";
+};
+export type TerraDrawGeoJSONStore = GeoJSONStore<OnChangeContext | undefined, FeatureId>;
 export interface TerraDrawModeRegisterConfig {
     mode: string;
-    store: GeoJSONStore;
+    store: TerraDrawGeoJSONStore;
     setDoubleClickToZoom: (enabled: boolean) => void;
     setCursor: SetCursor;
-    onChange: StoreChangeHandler;
+    onChange: StoreChangeHandler<OnChangeContext | undefined>;
     onSelect: (selectedId: string) => void;
     onDeselect: (deselectedId: string) => void;
     onFinish: (finishedId: string, context: OnFinishContext) => void;

package/dist/extend.d.ts

@@ -1,5 +1,6 @@
 import { TerraDrawBaseAdapter, BaseAdapterConfig } from "./common/base.adapter";
-import { HexColorStyling, NumericStyling, SELECT_PROPERTIES, TerraDrawCallbacks } from "./common";
-import { BaseModeOptions, TerraDrawBaseDrawMode } from "./modes/base.mode";
+import { Cursor, HexColorStyling, NumericStyling, SELECT_PROPERTIES, TerraDrawCallbacks } from "./common";
+import { BaseModeOptions, CustomStyling, TerraDrawBaseDrawMode, TerraDrawBaseSelectMode } from "./modes/base.mode";
 import { FeatureId, GeoJSONStore } from "./store/store";
-export { GeoJSONStore, TerraDrawBaseDrawMode, TerraDrawBaseAdapter, BaseAdapterConfig, NumericStyling, HexColorStyling, BaseModeOptions, TerraDrawCallbacks, FeatureId, SELECT_PROPERTIES, };
+import { getDefaultStyling } from "./util/styling";
+export { GeoJSONStore, TerraDrawBaseDrawMode, TerraDrawBaseSelectMode, TerraDrawBaseAdapter, getDefaultStyling, SELECT_PROPERTIES, FeatureId, Cursor, BaseModeOptions, CustomStyling, NumericStyling, HexColorStyling, TerraDrawCallbacks, BaseAdapterConfig, };

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

@@ -1,7 +1,6 @@
-import { Project, Projection, Unproject } from "../common";
-import { GeoJSONStore } from "../store/store";
+import { Project, Projection, TerraDrawGeoJSONStore, Unproject } from "../common";
 export type BehaviorConfig = {
-    store: GeoJSONStore;
+    store: TerraDrawGeoJSONStore;
     mode: string;
     project: Project;
     unproject: Unproject;
@@ -10,7 +9,7 @@ export type BehaviorConfig = {
     projection: Projection;
 };
 export declare class TerraDrawModeBehavior {
-    protected store: GeoJSONStore;
+    protected store: TerraDrawGeoJSONStore;
     protected mode: string;
     protected project: Project;
     protected unproject: Unproject;

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

@@ -1,6 +1,6 @@
 import { BehaviorConfig, TerraDrawModeBehavior } from "./base.behavior";
-import { HexColor, OnFinishContext, Projection, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, TerraDrawModeRegisterConfig, TerraDrawModeState, TerraDrawMouseEvent, Validation } from "../common";
-import { FeatureId, GeoJSONStore, GeoJSONStoreFeatures, StoreChangeHandler } from "../store/store";
+import { OnChangeContext, HexColor, OnFinishContext, Projection, TerraDrawAdapterStyling, TerraDrawGeoJSONStore, TerraDrawKeyboardEvent, TerraDrawModeRegisterConfig, TerraDrawModeState, TerraDrawMouseEvent, Validation } from "../common";
+import { FeatureId, GeoJSONStoreFeatures, StoreChangeHandler } from "../store/store";
 export type CustomStyling = Record<string, string | number | ((feature: GeoJSONStoreFeatures) => HexColor) | ((feature: GeoJSONStoreFeatures) => number)>;
 export declare enum ModeTypes {
     Drawing = "drawing",
@@ -25,8 +25,8 @@ export declare abstract class TerraDrawBaseDrawMode<Styling extends CustomStylin
     protected validate: Validation | undefined;
     protected pointerDistance: number;
     protected coordinatePrecision: number;
-    protected onStyleChange: StoreChangeHandler;
-    protected store: GeoJSONStore;
+    protected onStyleChange: StoreChangeHandler<OnChangeContext | undefined>;
+    protected store: TerraDrawGeoJSONStore;
     protected projection: Projection;
     protected setDoubleClickToZoom: TerraDrawModeRegisterConfig["setDoubleClickToZoom"];
     protected unproject: TerraDrawModeRegisterConfig["unproject"];

package/dist/store/store.d.ts

@@ -13,7 +13,7 @@ export type StoreValidation = {
     id?: FeatureId;
 } & ReturnType<Validation>;
 type StoreChangeEvents = "delete" | "create" | "update" | "styling";
-export type StoreChangeHandler = (ids: FeatureId[], change: StoreChangeEvents) => void;
+export type StoreChangeHandler<OnChangeContext> = (ids: FeatureId[], change: StoreChangeEvents, context?: OnChangeContext) => void;
 export type FeatureId = string | number;
 export type IdStrategy<Id extends FeatureId> = {
     isValidId: (id: Id) => boolean;
@@ -27,7 +27,7 @@ export declare const defaultIdStrategy: {
     getId: <FeatureId>() => FeatureId;
     isValidId: (id: FeatureId) => boolean;
 };
-export declare class GeoJSONStore<Id extends FeatureId = FeatureId> {
+export declare class GeoJSONStore<OnChangeContext extends Record<string, JSON> | undefined, Id extends FeatureId = FeatureId> {
     constructor(config?: GeoJSONStoreConfig<Id>);
     idStrategy: IdStrategy<Id>;
     private tracked;
@@ -37,25 +37,25 @@ export declare class GeoJSONStore<Id extends FeatureId = FeatureId> {
     private clone;
     getId(): FeatureId;
     has(id: FeatureId): boolean;
-    load(data: GeoJSONStoreFeatures[], featureValidation?: (feature: unknown, tracked?: boolean) => StoreValidation, afterFeatureAdded?: (feature: GeoJSONStoreFeatures) => void): StoreValidation[];
+    load(data: GeoJSONStoreFeatures[], featureValidation?: (feature: unknown, tracked?: boolean) => StoreValidation, afterFeatureAdded?: (feature: GeoJSONStoreFeatures) => void, context?: OnChangeContext): StoreValidation[];
     search(bbox: BBoxPolygon, filter?: (feature: GeoJSONStoreFeatures) => boolean): GeoJSONStoreFeatures[];
-    registerOnChange(onChange: StoreChangeHandler): void;
+    registerOnChange(onChange: StoreChangeHandler<OnChangeContext | undefined>): void;
     getGeometryCopy<T extends GeoJSONStoreGeometries>(id: FeatureId): T;
     getPropertiesCopy(id: FeatureId): DefinedProperties;
     updateProperty(propertiesToUpdate: {
         id: FeatureId;
         property: string;
         value: JSON;
-    }[]): void;
+    }[], context?: OnChangeContext): void;
     updateGeometry(geometriesToUpdate: {
         id: FeatureId;
         geometry: GeoJSONStoreGeometries;
-    }[]): void;
+    }[], context?: OnChangeContext): void;
     create<Id extends FeatureId>(features: {
         geometry: GeoJSONStoreGeometries;
         properties?: JSONObject;
-    }[]): Id[];
-    delete(ids: FeatureId[]): void;
+    }[], context?: OnChangeContext): Id[];
+    delete(ids: FeatureId[], context?: OnChangeContext): void;
     copy(id: FeatureId): GeoJSONStoreFeatures;
     copyAll(): GeoJSONStoreFeatures[];
     copyAllWhere(equals: (properties: JSONObject) => boolean): GeoJSONStoreFeatures[];