terra-draw 0.0.1-alpha.9 → 1.0.0-beta.1

package/dist/terra-draw.d.ts

@@ -1,48 +1,223 @@
-import { TerraDrawGoogleMapsAdapter } from "./adapters/google-maps.adapter";
-import { TerraDrawLeafletAdapter } from "./adapters/leaflet.adapter";
-import { TerraDrawMapboxGLAdapter } from "./adapters/mapbox-gl.adapter";
-import { TerraDrawMode, TerraDrawAdapter, TerraDrawAdapterStyling } from "./common";
-import { TerraDrawCircleMode } from "./modes/circle/circle.mode";
-import { TerraDrawFreehandMode } from "./modes/freehand/freehand.mode";
-import { TerraDrawLineStringMode } from "./modes/linestring/linestring.mode";
-import { TerraDrawPointMode } from "./modes/point/point.mode";
-import { TerraDrawPolygonMode } from "./modes/polygon/polygon.mode";
-import { TerraDrawRenderMode } from "./modes/render/render.mode";
-import { TerraDrawSelectMode } from "./modes/select/select.mode";
-import { GeoJSONStoreFeatures } from "./store/store";
-declare type ChangeListener = (ids: string[], type: string) => void;
-declare type SelectListener = (id: string) => void;
-declare type DeselectListener = () => void;
-interface TerraDrawEventListeners {
-    change: ChangeListener;
-    select: SelectListener;
-    deselect: DeselectListener;
-}
-declare type TerraDrawEvents = keyof TerraDrawEventListeners;
-declare class TerraDraw {
-    private _modes;
-    private _mode;
-    private _adapter;
-    private _enabled;
-    private _store;
-    private _eventListeners;
-    constructor(options: {
-        adapter: TerraDrawAdapter;
-        modes: {
-            [mode: string]: TerraDrawMode;
-        };
-        data?: GeoJSONStoreFeatures[];
-    });
-    private getModeStyles;
-    setModeStyles(mode: string, styles: TerraDrawAdapterStyling): void;
-    getSnapshot(): GeoJSONStoreFeatures[];
-    get enabled(): boolean;
-    set enabled(_: boolean);
-    getCurrentMode(): string;
-    changeMode(mode: string): void;
-    start(): void;
-    stop(): void;
-    on<T extends TerraDrawEvents>(event: T, callback: TerraDrawEventListeners[T]): void;
-    off<T extends TerraDrawEvents>(event: TerraDrawEvents, callback: TerraDrawEventListeners[T]): void;
-}
-export { TerraDraw, TerraDrawSelectMode, TerraDrawPointMode, TerraDrawLineStringMode, TerraDrawPolygonMode, TerraDrawCircleMode, TerraDrawFreehandMode, TerraDrawRenderMode, TerraDrawGoogleMapsAdapter, TerraDrawMapboxGLAdapter, TerraDrawLeafletAdapter, };
+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";
+import { TerraDrawAdapter, TerraDrawAdapterStyling, GetLngLatFromEvent, Project, SetCursor, TerraDrawChanges, TerraDrawStylingFunction, Unproject, HexColor, TerraDrawKeyboardEvent, TerraDrawMouseEvent, OnFinishContext } from "./common";
+import { TerraDrawBaseAdapter } from "./adapters/common/base.adapter";
+import { TerraDrawBaseDrawMode } from "./modes/base.mode";
+import { TerraDrawCircleMode } from "./modes/circle/circle.mode";
+import { TerraDrawFreehandMode } from "./modes/freehand/freehand.mode";
+import { TerraDrawLineStringMode } from "./modes/linestring/linestring.mode";
+import { TerraDrawPointMode } from "./modes/point/point.mode";
+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 { BehaviorConfig } from "./modes/base.behavior";
+import { ValidateMinAreaSquareMeters } from "./validations/min-size.validation";
+import { ValidateMaxAreaSquareMeters } from "./validations/max-size.validation";
+import { ValidateNotSelfIntersecting } from "./validations/not-self-intersecting.validation";
+import { TerraDrawAngledRectangleMode } from "./modes/angled-rectangle/angled-rectangle.mode";
+type FinishListener = (id: FeatureId, context: OnFinishContext) => void;
+type ChangeListener = (ids: FeatureId[], type: string) => void;
+type SelectListener = (id: FeatureId) => void;
+type DeselectListener = () => void;
+interface TerraDrawEventListeners {
+    ready: () => void;
+    finish: FinishListener;
+    change: ChangeListener;
+    select: SelectListener;
+    deselect: DeselectListener;
+}
+type TerraDrawEvents = keyof TerraDrawEventListeners;
+declare class TerraDraw {
+    private _modes;
+    private _mode;
+    private _adapter;
+    private _enabled;
+    private _store;
+    private _eventListeners;
+    private _instanceSelectMode;
+    constructor(options: {
+        adapter: TerraDrawAdapter;
+        modes: TerraDrawBaseDrawMode<any>[];
+        idStrategy?: IdStrategy<FeatureId>;
+        tracked?: boolean;
+    });
+    private checkEnabled;
+    private getModeStyles;
+    private featuresAtLocation;
+    private getSelectMode;
+    /**
+     * Allows the setting of a style for a given mode
+     *
+     * @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;
+    /**
+     * A property used to determine whether the instance is active or not. You
+     * can use the start method to set this to true, and stop method to set this to false.
+     * This is a read only property.
+     *
+     * @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;
+    /**
+     * Provides the ability to programmatically select a feature using the instances provided select mode.
+     * 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;
+    /**
+     * Provides the ability to programmatically deselect a feature using the instances provided select mode.
+     * 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;
+    /**
+     * Returns the next feature id from the store - defaults to UUID4 unless you have
+     * set a custom idStrategy. This method can be useful if you are needing creating features
+     * 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;
+    /**
+     * 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
+     *
+     * @beta
+     */
+    addFeatures(features: GeoJSONStoreFeatures[]): void;
+    /**
+     * 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;
+        lat: number;
+    }, options?: {
+        pointerDistance: number;
+        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
+     */
+    getFeaturesAtPointerEvent(event: PointerEvent | MouseEvent, options?: {
+        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;
+    /**
+     * Registers a Terra Draw event
+     *
+     * @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;
+    /**
+     * Unregisters a Terra Draw event
+     *
+     * @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;
+}
+declare const TerraDrawExtend: {
+    TerraDrawBaseDrawMode: typeof TerraDrawBaseDrawMode;
+    TerraDrawBaseAdapter: typeof TerraDrawBaseAdapter;
+};
+export { TerraDraw, TerraDrawSelectMode, TerraDrawPointMode, TerraDrawLineStringMode, TerraDrawPolygonMode, TerraDrawCircleMode, TerraDrawFreehandMode, TerraDrawRenderMode, TerraDrawRectangleMode, TerraDrawAngledRectangleMode, TerraDrawGoogleMapsAdapter, TerraDrawMapboxGLAdapter, TerraDrawLeafletAdapter, TerraDrawMapLibreGLAdapter, TerraDrawOpenLayersAdapter, TerraDrawArcGISMapsSDKAdapter, TerraDrawExtend, BehaviorConfig, GeoJSONStoreFeatures, HexColor, TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, TerraDrawChanges, TerraDrawStylingFunction, Project, Unproject, SetCursor, GetLngLatFromEvent, ValidateMinAreaSquareMeters, ValidateMaxAreaSquareMeters, ValidateNotSelfIntersecting, };