terra-draw 1.0.0-beta.8 → 1.0.0

package/dist/terra-draw.d.ts

@@ -1,9 +1,6 @@
-import { TerraDrawGoogleMapsAdapter } from "./adapters/google-maps.adapter";
-import { TerraDrawLeafletAdapter } from "./adapters/leaflet.adapter";
-import { TerraDrawMapboxGLAdapter } from "./adapters/mapbox-gl.adapter";
-import { TerraDrawMapLibreGLAdapter } from "./adapters/maplibre-gl.adapter";
-import { TerraDrawOpenLayersAdapter } from "./adapters/openlayers.adapter";
-import { TerraDrawArcGISMapsSDKAdapter } from "./adapters/arcgis-maps-sdk.adapter";
+/**
+ * @module terra-draw
+ */
 import { TerraDrawAdapter, TerraDrawAdapterStyling, GetLngLatFromEvent, Project, SetCursor, TerraDrawChanges, TerraDrawStylingFunction, Unproject, HexColor, TerraDrawKeyboardEvent, TerraDrawMouseEvent, OnFinishContext } from "./common";
 import { TerraDrawBaseDrawMode } from "./modes/base.mode";
 import { TerraDrawCircleMode } from "./modes/circle/circle.mode";
@@ -14,7 +11,7 @@ import { TerraDrawPolygonMode } from "./modes/polygon/polygon.mode";
 import { TerraDrawRectangleMode } from "./modes/rectangle/rectangle.mode";
 import { TerraDrawRenderMode } from "./modes/render/render.mode";
 import { TerraDrawSelectMode } from "./modes/select/select.mode";
-import { FeatureId, GeoJSONStoreFeatures, IdStrategy } from "./store/store";
+import { FeatureId, GeoJSONStoreFeatures, GeoJSONStoreGeometries, IdStrategy, StoreValidation } from "./store/store";
 import { BehaviorConfig } from "./modes/base.behavior";
 import { ValidateMinAreaSquareMeters } from "./validations/min-size.validation";
 import { ValidateMaxAreaSquareMeters } from "./validations/max-size.validation";
@@ -23,6 +20,7 @@ import { TerraDrawAngledRectangleMode } from "./modes/angled-rectangle/angled-re
 import { TerraDrawSectorMode } from "./modes/sector/sector.mode";
 import { TerraDrawSensorMode } from "./modes/sensor/sensor.mode";
 import * as TerraDrawExtend from "./extend";
+import { ValidationReasons } from "./validation-reasons";
 type FinishListener = (id: FeatureId, context: OnFinishContext) => void;
 type ChangeListener = (ids: FeatureId[], type: string) => void;
 type SelectListener = (id: FeatureId) => void;
@@ -151,15 +149,15 @@ declare class TerraDraw {
      */
     hasFeature(id: FeatureId): boolean;
     /**
-     * A method for adding features to the store. This method will validate the features.
-     * Features must match one of the modes enabled in the instance.
-     * @param mode
-     * @param features
-     * @returns
+     * A method for adding features to the store. This method will validate the features
+     * returning an array of validation results. Features must match one of the modes enabled
+     * in the instance.
+     * @param features - an array of GeoJSON features
+     * @returns an array of validation results
      *
      * @beta
      */
-    addFeatures(features: GeoJSONStoreFeatures[]): void;
+    addFeatures(features: GeoJSONStoreFeatures[]): StoreValidation[];
     /**
      * A method starting Terra Draw. It put the instance into a started state, and
      * in registers the passed adapter giving it all the callbacks required to operate.
@@ -218,4 +216,5 @@ declare class TerraDraw {
      */
     off<T extends TerraDrawEvents>(event: TerraDrawEvents, callback: TerraDrawEventListeners[T]): void;
 }
-export { TerraDraw, TerraDrawSelectMode, TerraDrawPointMode, TerraDrawLineStringMode, TerraDrawPolygonMode, TerraDrawCircleMode, TerraDrawFreehandMode, TerraDrawRenderMode, TerraDrawRectangleMode, TerraDrawAngledRectangleMode, TerraDrawSectorMode, TerraDrawSensorMode, TerraDrawGoogleMapsAdapter, TerraDrawMapboxGLAdapter, TerraDrawLeafletAdapter, TerraDrawMapLibreGLAdapter, TerraDrawOpenLayersAdapter, TerraDrawArcGISMapsSDKAdapter, TerraDrawExtend, BehaviorConfig, GeoJSONStoreFeatures, HexColor, TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, TerraDrawChanges, TerraDrawStylingFunction, Project, Unproject, SetCursor, GetLngLatFromEvent, ValidateMinAreaSquareMeters, ValidateMaxAreaSquareMeters, ValidateNotSelfIntersecting, };
+declare const HELLO = "HELLO";
+export { TerraDraw, HELLO, TerraDrawSelectMode, TerraDrawPointMode, TerraDrawLineStringMode, TerraDrawPolygonMode, TerraDrawCircleMode, TerraDrawFreehandMode, TerraDrawRenderMode, TerraDrawRectangleMode, TerraDrawAngledRectangleMode, TerraDrawSectorMode, TerraDrawSensorMode, TerraDrawExtend, BehaviorConfig, GeoJSONStoreFeatures, GeoJSONStoreGeometries, HexColor, TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, TerraDrawChanges, TerraDrawStylingFunction, Project, Unproject, SetCursor, GetLngLatFromEvent, ValidateMinAreaSquareMeters, ValidateMaxAreaSquareMeters, ValidateNotSelfIntersecting, ValidationReasons, };

package/dist/terra-draw.extensions.spec.d.ts

@@ -0,0 +1,28 @@
+/**
+ * For this specific test suite we should only ever import from the Terra Draw
+ * public API, and not from the internal library code. This is to ensure that
+ * a developer can write a custom adapter exclusively from the publicly exposed base
+ * classes and types of the library.
+ */
+import { GetLngLatFromEvent, Project, SetCursor, TerraDrawChanges, TerraDrawExtend, TerraDrawStylingFunction, Unproject } from "./terra-draw";
+declare const TerraDrawBaseAdapter: typeof TerraDrawExtend.TerraDrawBaseAdapter;
+/**
+ * A mock implementation of a custom adapter - this is to ensure that it is possible to write
+ * custom adapters for Terra Draw exclusively relying on the public API of the library.
+ */
+export declare class TerraDrawTestAdapter extends TerraDrawBaseAdapter {
+    constructor(config: {
+        lib: Record<string, unknown>;
+    } & TerraDrawExtend.BaseAdapterConfig);
+    getMapEventElement(): HTMLElement;
+    clear(): void;
+    project(lng: number, lat: number): ReturnType<Project>;
+    unproject(x: number, y: number): ReturnType<Unproject>;
+    setCursor(_: "move" | "unset" | "grab" | "grabbing" | "crosshair" | "pointer" | "wait"): ReturnType<SetCursor>;
+    getLngLatFromEvent(_: PointerEvent | MouseEvent): ReturnType<GetLngLatFromEvent>;
+    setDraggability(_: boolean): void;
+    setDoubleClickToZoom(_: boolean): void;
+    render(_1: TerraDrawChanges, _2: TerraDrawStylingFunction): void;
+    register(callbacks: TerraDrawExtend.TerraDrawCallbacks): void;
+}
+export {};