terra-draw 1.0.0-beta.9 → 1.1.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, StoreValidation } 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";
@@ -60,23 +57,17 @@ declare class TerraDraw {
      * @param mode - The mode you wish to set a style for
      * @param styles - The styles you wish to set for the mode - this is
      * the same as the initialisation style schema
-     *
-     * @beta
      */
     setModeStyles<Styling extends Record<string, number | HexColor>>(mode: string, styles: Styling): void;
     /**
      * Allows the user to get a snapshot (copy) of all given features
      *
      * @returns An array of all given Feature Geometries in the instances store
-     *
-     * @beta
      */
     getSnapshot(): GeoJSONStoreFeatures[];
     /**
      * Removes all data from the current store and removes any rendered layers
      * via the registering the adapter.
-     *
-     * @beta
      */
     clear(): void;
     /**
@@ -86,37 +77,27 @@ declare class TerraDraw {
      *
      * @return true or false depending on if the instance is stopped or started
      * @readonly
-     * @beta
      */
     get enabled(): boolean;
     /**
      * enabled is a read only property and will throw and error if you try and set it.
-     *
-     * @beta
      */
     set enabled(_: boolean);
     /**
      * A method for getting the current mode name
-     *
      * @return the current mode name
-     *
-     * @beta
      */
     getMode(): string;
     /**
      * A method for setting the current mode by name. Under the hood this will stop
      * the previous mode and start the new one.
      * @param mode - The mode name you wish to start
-     *
-     * @beta
      */
     setMode(mode: string): void;
     /**
      * A method for removing features to the store
      * @param ids
      * @returns
-     *
-     * @beta
      */
     removeFeatures(ids: FeatureId[]): void;
     /**
@@ -124,7 +105,6 @@ declare class TerraDraw {
      * If not select mode is provided in the instance, an error will be thrown. If the instance is not currently
      * in the select mode, it will switch to it.
      * @param id - the id of the feature to select
-     * @beta
      */
     selectFeature(id: FeatureId): void;
     /**
@@ -132,7 +112,6 @@ declare class TerraDraw {
      * If not select mode is provided in the instance, an error will be thrown. If the instance is not currently
      * in the select mode, it will switch to it.
      * @param id  - the id of the feature to deselect
-     * @beta
      */
     deselectFeature(id: FeatureId): void;
     /**
@@ -141,14 +120,11 @@ declare class TerraDraw {
      * outside of the Terra Draw instance but want to add them in to the store.
      * @returns a id, either number of string based on whatever the configured idStrategy is
      *
-     * @beta
      */
     getFeatureId(): FeatureId;
     /**
      * Returns true or false depending on if the Terra Draw instance has a feature with a given id
      * @returns a boolean determining if the instance has a feature with the given id
-     *
-     * @beta
      */
     hasFeature(id: FeatureId): boolean;
     /**
@@ -157,23 +133,17 @@ declare class TerraDraw {
      * in the instance.
      * @param features - an array of GeoJSON features
      * @returns an array of validation results
-     *
-     * @beta
      */
     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.
-     *
-     * @beta
      */
     start(): void;
     /**
      * Gets the features at a given longitude and latitude.
      * Will return point and linestrings that are a given pixel distance
      * away from the lng/lat and any polygons which contain it.
-     *
-     * @beta
      */
     getFeaturesAtLngLat(lngLat: {
         lng: number;
@@ -183,21 +153,16 @@ declare class TerraDraw {
         ignoreSelectFeatures: boolean;
     }): GeoJSONStoreFeatures[];
     /**
-     * Takes a given pointer event and
-     * Will return point and linestrings that are a given pixel distance
-     * away from the lng/lat and any polygons which contain it.
-     *
-     * @beta
+     * Takes a given pointer event and will return point and linestrings that are
+     * a given pixel distance away from the longitude/latitude, and any polygons which contain it.
      */
     getFeaturesAtPointerEvent(event: PointerEvent | MouseEvent, options?: {
-        pointerDistance: number;
-        ignoreSelectFeatures: boolean;
+        pointerDistance?: number;
+        ignoreSelectFeatures?: boolean;
     }): GeoJSONStoreFeatures[];
     /**
      * A method for stopping Terra Draw. Will clear the store, deregister the adapter and
      * remove any rendered layers in the process.
-     *
-     * @beta
      */
     stop(): void;
     /**
@@ -206,7 +171,6 @@ declare class TerraDraw {
      * @param event - The name of the event you wish to listen for
      * @param callback - The callback with you wish to be called when this event occurs
      *
-     * @beta
      */
     on<T extends TerraDrawEvents>(event: T, callback: TerraDrawEventListeners[T]): void;
     /**
@@ -215,8 +179,7 @@ declare class TerraDraw {
      * @param event - The name of the event you wish to unregister
      * @param callback - The callback you originally provided to the 'on' method
      *
-     * @beta
      */
     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, ValidationReasons, };
+export { TerraDraw, 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 {};