terra-draw 0.0.1-alpha.30 → 0.0.1-alpha.32

package/CHANGELOG.md

@@ -2,6 +2,30 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [0.0.1-alpha.32](https://github.com/JamesLMilner/terra-draw/compare/v0.0.1-alpha.31...v0.0.1-alpha.32) (2023-06-04)
+
+
+### Features
+
+* add the addFeatures method to allow adding of external data ([b6e0043](https://github.com/JamesLMilner/terra-draw/commit/b6e004377f1baff78e01f9324413469677f2df5b))
+
+
+### Chore
+
+* update docs ([36997cc](https://github.com/JamesLMilner/terra-draw/commit/36997cc7c7071af1af1a27ad457cab0361f3e5e9))
+
+### [0.0.1-alpha.31](https://github.com/JamesLMilner/terra-draw/compare/v0.0.1-alpha.30...v0.0.1-alpha.31) (2023-05-22)
+
+
+### Features
+
+* add onFinish event to terra draw ([fb36988](https://github.com/JamesLMilner/terra-draw/commit/fb36988ce3e291f4198e38a455d385eb40db326b))
+
+
+### Chore
+
+* update docs ([ed78e25](https://github.com/JamesLMilner/terra-draw/commit/ed78e2575b789429f08a4c0b96041bdf4deed5b9))
+
 ### [0.0.1-alpha.30](https://github.com/JamesLMilner/terra-draw/compare/v0.0.1-alpha.29...v0.0.1-alpha.30) (2023-05-21)
 
 

package/dist/common.d.ts

@@ -45,6 +45,7 @@ export interface TerraDrawModeRegisterConfig {
     onChange: StoreChangeHandler;
     onSelect: (selectedId: string) => void;
     onDeselect: (deselectedId: string) => void;
+    onFinish: (finishedId: string) => void;
     project: Project;
     unproject: Unproject;
 }

package/dist/geometry/boolean/is-valid-coordinate.d.ts

@@ -0,0 +1,4 @@
+export declare function validLatitude(lat: number): boolean;
+export declare function validLongitude(lng: number): boolean;
+export declare function coordinateIsValid(coordinate: unknown[], coordinatePrecision: number): boolean;
+export declare function getDecimalPlaces(value: number): number;

package/dist/geometry/boolean/is-valid-linestring-feature.d.ts

@@ -0,0 +1,2 @@
+import { GeoJSONStoreFeatures } from "../../terra-draw";
+export declare function isValidLineStringFeature(feature: GeoJSONStoreFeatures, coordinatePrecision: number): boolean;

package/dist/geometry/boolean/is-valid-point.d.ts

@@ -0,0 +1,2 @@
+import { GeoJSONStoreFeatures } from "../../terra-draw";
+export declare function isValidPoint(feature: GeoJSONStoreFeatures, coordinatePrecision: number): boolean;

package/dist/geometry/boolean/is-valid-polygon-feature.d.ts

@@ -0,0 +1,3 @@
+import { GeoJSONStoreFeatures } from "../../terra-draw";
+export declare function isValidPolygonFeature(feature: GeoJSONStoreFeatures, coordinatePrecision: number): boolean;
+export declare function isValidNonIntersectingPolygonFeature(feature: GeoJSONStoreFeatures, coordinatePrecision: number): boolean;

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

@@ -29,10 +29,12 @@ export declare abstract class TerraDrawBaseDrawMode<T extends CustomStyling> {
     protected setStarted(): void;
     protected setStopped(): void;
     register(config: TerraDrawModeRegisterConfig): void;
+    validateFeature(feature: unknown): feature is GeoJSONStoreFeatures;
     abstract start(): void;
     abstract stop(): void;
     abstract cleanUp(): void;
     abstract styleFeature(feature: GeoJSONStoreFeatures): TerraDrawAdapterStyling;
+    onFinish(finishedId: string): void;
     onDeselect(deselectedId: string): void;
     onSelect(selectedId: string): void;
     onKeyDown(event: TerraDrawKeyboardEvent): void;

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

@@ -44,5 +44,6 @@ export declare class TerraDrawCircleMode extends TerraDrawBaseDrawMode<FreehandP
     cleanUp(): void;
     /** @internal */
     styleFeature(feature: GeoJSONStoreFeatures): TerraDrawAdapterStyling;
+    validateFeature(feature: unknown): feature is GeoJSONStoreFeatures;
 }
 export {};

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

@@ -50,5 +50,6 @@ export declare class TerraDrawFreehandMode extends TerraDrawBaseDrawMode<Freehan
     cleanUp(): void;
     /** @internal */
     styleFeature(feature: GeoJSONStoreFeatures): TerraDrawAdapterStyling;
+    validateFeature(feature: unknown): feature is GeoJSONStoreFeatures;
 }
 export {};

package/dist/modes/greatcircle/great-circle.mode.d.ts

@@ -53,5 +53,6 @@ export declare class TerraDrawGreatCircleMode extends TerraDrawBaseDrawMode<Grea
     cleanUp(): void;
     /** @internal */
     styleFeature(feature: GeoJSONStoreFeatures): TerraDrawAdapterStyling;
+    validateFeature(feature: unknown): feature is GeoJSONStoreFeatures;
 }
 export {};

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

@@ -56,5 +56,6 @@ export declare class TerraDrawLineStringMode extends TerraDrawBaseDrawMode<LineS
     cleanUp(): void;
     /** @internal */
     styleFeature(feature: GeoJSONStoreFeatures): TerraDrawAdapterStyling;
+    validateFeature(feature: unknown): feature is GeoJSONStoreFeatures;
 }
 export {};

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

@@ -34,5 +34,6 @@ export declare class TerraDrawPointMode extends TerraDrawBaseDrawMode<PointModeS
     onDragEnd(): void;
     /** @internal */
     styleFeature(feature: GeoJSONStoreFeatures): TerraDrawAdapterStyling;
+    validateFeature(feature: unknown): feature is GeoJSONStoreFeatures;
 }
 export {};

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

@@ -59,5 +59,6 @@ export declare class TerraDrawPolygonMode extends TerraDrawBaseDrawMode<PolygonS
     cleanUp(): void;
     /** @internal */
     styleFeature(feature: GeoJSONStoreFeatures): TerraDrawAdapterStyling;
+    validateFeature(feature: unknown): feature is GeoJSONStoreFeatures;
 }
 export {};

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

@@ -21,6 +21,7 @@ export declare class TerraDrawRectangleMode extends TerraDrawBaseDrawMode<Rectan
         styles?: Partial<RectanglePolygonStyling>;
         keyEvents?: TerraDrawRectangleModeKeyEvents | null;
     });
+    private updateRectangle;
     private close;
     /** @internal */
     start(): void;
@@ -44,5 +45,6 @@ export declare class TerraDrawRectangleMode extends TerraDrawBaseDrawMode<Rectan
     cleanUp(): void;
     /** @internal */
     styleFeature(feature: GeoJSONStoreFeatures): TerraDrawAdapterStyling;
+    validateFeature(feature: unknown): feature is GeoJSONStoreFeatures;
 }
 export {};

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

@@ -1,6 +1,7 @@
 import { TerraDrawAdapterStyling } from "../../common";
 import { TerraDrawBaseDrawMode } from "../base.mode";
 import { BehaviorConfig } from "../base.behavior";
+import { GeoJSONStoreFeatures } from "../../terra-draw";
 type RenderModeStylingExt<T extends TerraDrawAdapterStyling> = {};
 type RenderModeStyling = RenderModeStylingExt<TerraDrawAdapterStyling>;
 export declare class TerraDrawRenderMode extends TerraDrawBaseDrawMode<RenderModeStyling> {
@@ -32,5 +33,6 @@ export declare class TerraDrawRenderMode extends TerraDrawBaseDrawMode<RenderMod
     cleanUp(): void;
     /** @internal */
     styleFeature(): TerraDrawAdapterStyling;
+    validateFeature(feature: unknown): feature is GeoJSONStoreFeatures;
 }
 export {};

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

@@ -0,0 +1,15 @@
+import { GeoJSONStoreFeatures } 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 FeatureHasNoGeometry: "Feature has no geometry";
+    readonly FeatureHasNoProperties: "Feature has no properties";
+    readonly FeatureGeometryNotSupported: "Feature is not Point, LineString or Polygon";
+    readonly FeatureCoordinatesNotAnArray: "Feature coordinates is not an array";
+    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;

package/dist/store/store.d.ts

@@ -11,9 +11,7 @@ export type GeoJSONStoreFeatures = Feature<GeoJSONStoreGeometries, DefinedProper
 export type StoreChangeEvents = "delete" | "create" | "update" | "styling";
 export type StoreChangeHandler = (ids: string[], change: StoreChangeEvents) => void;
 export type GeoJSONStoreConfig = {
-    data?: GeoJSONStoreFeatures[];
     tracked?: boolean;
-    validateFeature?: (feature: unknown, tracked?: boolean) => void;
 };
 export declare class GeoJSONStore {
     constructor(config?: GeoJSONStoreConfig);
@@ -24,7 +22,7 @@ export declare class GeoJSONStore {
     private getId;
     private clone;
     has(id: string): boolean;
-    load(data: GeoJSONStoreFeatures[], featureValidation?: (feature: unknown, tracked?: boolean) => void): void;
+    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;