terra-draw 0.0.1-alpha.22 → 0.0.1-alpha.24

package/CHANGELOG.md

@@ -2,6 +2,56 @@
 
 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.24](https://github.com/JamesLMilner/terra-draw/compare/v0.0.1-alpha.23...v0.0.1-alpha.24) (2023-04-07)
+
+
+### Features
+
+* export base adapter and mode so that 3rd party developers can extend ([1662960](https://github.com/JamesLMilner/terra-draw/commit/16629602d8cb7f9b7d163c581ebe23abfd734c5d))
+
+
+### Chore
+
+* add example drawing gif image to readme ([edde444](https://github.com/JamesLMilner/terra-draw/commit/edde4442bc3aa6b6854d708edb477bb068331f8e))
+* crop gif to make it a bit cleaner ([6fc4adf](https://github.com/JamesLMilner/terra-draw/commit/6fc4adfb12236428101b8a579649b9ff8ee3e946))
+* update docs ([75c0848](https://github.com/JamesLMilner/terra-draw/commit/75c0848e582db24e287ff81d628de0486ad1e4e7))
+
+### [0.0.1-alpha.23](https://github.com/JamesLMilner/terra-draw/compare/v0.0.1-alpha.22...v0.0.1-alpha.23) (2023-04-04)
+
+
+### Features
+
+* cache container for all adapters to avoid refetching it ([d0e3332](https://github.com/JamesLMilner/terra-draw/commit/d0e3332c873587f5c148b4999b46fc4392d84393))
+* google maps adapter now uses base pointer based event system ([03b131d](https://github.com/JamesLMilner/terra-draw/commit/03b131db9d5ed4fd4658bf7dd2fba16dbb45b04a))
+* move google maps to use base adapter ([5e52f4d](https://github.com/JamesLMilner/terra-draw/commit/5e52f4d849ec3fd2e0371f121a1bf5aac2b5491e))
+* move mapbox adapter to use the base adapter ([08ddb8e](https://github.com/JamesLMilner/terra-draw/commit/08ddb8e0ff3b37628aef9893a28d52ef1e98536b))
+* move openlayers adapter to use base event adapter ([92213f8](https://github.com/JamesLMilner/terra-draw/commit/92213f8ee4943825e6ddb036ceea21658b5ca8a7))
+
+
+### Bug Fixes
+
+* turn off tolerance on geojson layers for mapbox/maplibre adapters ([fb1e7a2](https://github.com/JamesLMilner/terra-draw/commit/fb1e7a2b26f30a26026bb1211211d18a7600a6f5))
+
+
+### Chore
+
+* add better comments around the getting started example ([811d5b6](https://github.com/JamesLMilner/terra-draw/commit/811d5b6178c5cc4eb63fa5aacd4cdca6928aa87f))
+* add getting started guide ([c926568](https://github.com/JamesLMilner/terra-draw/commit/c926568f68ee87fb48795b9d34b176ba82bf99a0))
+* add useful comments to adapter listener ([e882911](https://github.com/JamesLMilner/terra-draw/commit/e8829119658f0d636beb8ff9ef4cf4d8f8d69706))
+* better typescript typing for onStyleChange ([476fe3c](https://github.com/JamesLMilner/terra-draw/commit/476fe3c6f89a34a66e916dbc91a9fd6a3b2accb0))
+* bump typedoc ([be457de](https://github.com/JamesLMilner/terra-draw/commit/be457de36e03a2d00c9831af7247079e08914dc0))
+* bump typescript to version 5 ([0dedc54](https://github.com/JamesLMilner/terra-draw/commit/0dedc54042d2019f00117b3764ee09a5195deaf0))
+* create start and stop as abstract methods on base.mode ([bb1d330](https://github.com/JamesLMilner/terra-draw/commit/bb1d330060dfad72af921e1c76672b6b151427d3))
+* fix polygon.mode.spec test for offset change ([23ef0ab](https://github.com/JamesLMilner/terra-draw/commit/23ef0ab981115e1a5172e68cd13cf19c0c5c2f0b))
+* improve guides with additional information for new users ([ec785d5](https://github.com/JamesLMilner/terra-draw/commit/ec785d5f82f2f40acc730ad11cbb388cd312d480))
+* minor tidy up to all adapters ([e644459](https://github.com/JamesLMilner/terra-draw/commit/e644459459faee21854d51436c6730b3932e80f0))
+* remove logs ([a7c00c2](https://github.com/JamesLMilner/terra-draw/commit/a7c00c28b69e54cfe69454e4501dd4fee8eaa1d7))
+* remove uncessary override of point mode setStarted ([e8bebca](https://github.com/JamesLMilner/terra-draw/commit/e8bebcadc34315d3da1d0e05bb4939343cbe0c64))
+* rename base-adapter.ts to base.adapter.ts for consistency ([753c77c](https://github.com/JamesLMilner/terra-draw/commit/753c77c8ecc2f6b88c668ba5432e681db98b5221))
+* swap leaflet and openlayers ordering in development app ([4ebf3c8](https://github.com/JamesLMilner/terra-draw/commit/4ebf3c837dc84d710fd0fd8e341e4f63d820c05e))
+* update docs ([29ff37a](https://github.com/JamesLMilner/terra-draw/commit/29ff37a37f1b744df299a724d6da324ed31f1045))
+* update wording around getting started guide ([f6bc21e](https://github.com/JamesLMilner/terra-draw/commit/f6bc21eb6c811af2bd1f59289dedc124c29cfca6))
+
 ### [0.0.1-alpha.22](https://github.com/JamesLMilner/terra-draw/compare/v0.0.1-alpha.21...v0.0.1-alpha.22) (2023-03-26)
 
 

package/README.md

@@ -7,33 +7,29 @@ Frictionless map drawing across mapping libraries.
 
 Terra Draw centralises map drawing logic and provides a host of out the box drawing modes that work across different JavaScript mapping libraries. It also also you bring your own modes!
 
-### Library Support 
+![An example of drawing geodesic lines using Terra Draw with Leaflet](./readme.gif)
 
-Terra Draw uses the concept of 'adapters' to allow it to work with a host of different mapping libraries. Currently supported are:
-
-* [Leaflet](https://leafletjs.com/) v1
-* [OpenLayers](https://openlayers.org/) v7
-* [Mapbox GL JS](https://www.mapbox.com/mapbox-gljs) v2
-* [MapLibre](https://maplibre.org/projects/maplibre-gl-js/) v2
-* [Google Maps JS API](https://developers.google.com/maps/documentation/javascript/overview) v3
+### Library Support
 
-### Install
+Terra Draw uses the concept of 'adapters' to allow it to work with a host of different mapping libraries. Currently supported are:
 
-You can install the Terra Draw into your project like so:
+- [Leaflet](https://leafletjs.com/) v1
+- [OpenLayers](https://openlayers.org/) v7
+- [Mapbox GL JS](https://www.mapbox.com/mapbox-gljs) v2
+- [MapLibre](https://maplibre.org/projects/maplibre-gl-js/) v2
+- [Google Maps JS API](https://developers.google.com/maps/documentation/javascript/overview) v3
 
-```shell
-npm install terra-draw
-```
+### Getting Started
 
-Be aware Terra Draw is currently in alpha, the initial API is still being finalised  
+Please see the [the getting started guide](./guides/GETTING_STARTED.md)
 
 ### Development
 
-Please see the [the development documentation](./DEVELOPMENT.md)
+Please see the [the development documentation](./guides/DEVELOPMENT.md)
 
 ### Contributing
 
-Please see the [the contributing documentation](./CONTRIBUTING.md)
+Please see the [the contributing documentation](./guides/CONTRIBUTING.md)
 
 ### Project Website
 

package/dist/adapters/common/adapter-listener.d.ts

@@ -1,14 +1,22 @@
-export declare class AdapterListener {
-    name: string;
-    callback: (...args: any[]) => any;
-    registered: boolean;
-    register: any;
-    unregister: any;
-    private listeners;
-    constructor({ name, callback, unregister, register, }: {
-        name: string;
-        callback: (...args: any[]) => any;
-        unregister: (...callbacks: any[]) => void;
-        register: (callback: (...args: any[]) => any) => any[];
-    });
-}
+export declare class AdapterListener<Callback extends (...args: any[]) => any> {
+    name: string;
+    callback: (...args: any[]) => any;
+    registered: boolean;
+    register: any;
+    unregister: any;
+    /**
+     * Creates a new AdapterListener instance with the provided configuration.
+     *
+     * @param {Object} config - The configuration object for the listener.
+     * @param {string} config.name - The name of the event listener.
+     * @param {Function} config.callback - The callback function to be called when the event is triggered.
+     * @param {Function} config.unregister - The function to unregister the event listeners.
+     * @param {Function} config.register - The function to register the event listeners.
+     */
+    constructor({ name, callback, unregister, register, }: {
+        name: string;
+        callback: Callback;
+        unregister: (callbacks: Callback) => void;
+        register: (callback: Callback) => void;
+    });
+}

package/dist/adapters/common/base.adapter.d.ts

@@ -0,0 +1,45 @@
+import { Project, Unproject, TerraDrawCallbacks, TerraDrawChanges, TerraDrawMouseEvent, SetCursor, TerraDrawStylingFunction } from "../../common";
+import { AdapterListener } from "./adapter-listener";
+type BasePointerListener = (event: PointerEvent) => void;
+type BaseKeyboardListener = (event: KeyboardEvent) => void;
+type BaseMouseListener = (event: MouseEvent) => void;
+export declare abstract class TerraDrawBaseAdapter {
+    constructor(config: {
+        coordinatePrecision?: number;
+        minPixelDragDistance?: number;
+    });
+    protected _minPixelDragDistance: number;
+    protected _lastDrawEvent: TerraDrawMouseEvent | undefined;
+    protected _coordinatePrecision: number;
+    protected _heldKeys: Set<string>;
+    protected _listeners: AdapterListener<BasePointerListener | BaseKeyboardListener | BaseMouseListener>[];
+    protected _dragState: "not-dragging" | "pre-dragging" | "dragging";
+    protected _currentModeCallbacks: TerraDrawCallbacks | undefined;
+    protected getButton(event: PointerEvent | MouseEvent): "neither" | "left" | "middle" | "right";
+    protected getDrawEventFromEvent(event: PointerEvent | MouseEvent): TerraDrawMouseEvent | null;
+    /**
+     * Registers the provided callbacks for the current drawing mode and attaches
+     * the necessary event listeners.
+     * @param {TerraDrawCallbacks} callbacks - An object containing callback functions
+     * for handling various drawing events in the current mode.
+     */
+    register(callbacks: TerraDrawCallbacks): void;
+    /**
+     * Unregisters the event listeners for the current drawing mode.
+     * This is typically called when switching between drawing modes or
+     * stopping the drawing process.
+     */
+    unregister(): void;
+    abstract project(...args: Parameters<Project>): ReturnType<Project>;
+    abstract unproject(...args: Parameters<Unproject>): ReturnType<Unproject>;
+    abstract setCursor(...args: Parameters<SetCursor>): ReturnType<SetCursor>;
+    abstract getLngLatFromEvent(event: PointerEvent | MouseEvent): {
+        lng: number;
+        lat: number;
+    } | null;
+    abstract setDraggability(enabled: boolean): void;
+    abstract setDoubleClickToZoom(enabled: boolean): void;
+    abstract getMapContainer(): HTMLElement;
+    abstract render(changes: TerraDrawChanges, styling: TerraDrawStylingFunction): void;
+}
+export {};

package/dist/adapters/google-maps.adapter.d.ts

@@ -1,31 +1,80 @@
-/// <reference types="google.maps" />
-import { TerraDrawCallbacks, TerraDrawAdapter, TerraDrawModeRegisterConfig, TerraDrawAdapterStyling, TerraDrawChanges } from "../common";
-import { GeoJSONStoreFeatures } from "../store/store";
-export declare class TerraDrawGoogleMapsAdapter implements TerraDrawAdapter {
-    constructor(config: {
-        lib: typeof google.maps;
-        map: google.maps.Map;
-        coordinatePrecision?: number;
-    });
-    private _heldKeys;
-    private _cursor;
-    private _cursorStyleSheet;
-    private _coordinatePrecision;
-    private _lib;
-    private _map;
-    private _layers;
-    getMapContainer: () => HTMLElement;
-    setDoubleClickToZoom: TerraDrawModeRegisterConfig["setDoubleClickToZoom"];
-    unproject: TerraDrawModeRegisterConfig["unproject"];
-    project: TerraDrawModeRegisterConfig["project"];
-    setCursor: TerraDrawModeRegisterConfig["setCursor"];
-    private circlePath;
-    private currentModeCallbacks;
-    private listeners;
-    private dragState;
-    register(callbacks: TerraDrawCallbacks): void;
-    unregister(): void;
-    render(changes: TerraDrawChanges, styling: {
-        [mode: string]: (feature: GeoJSONStoreFeatures) => TerraDrawAdapterStyling;
-    }): void;
-}
+/// <reference types="google.maps" />
+import { TerraDrawChanges, SetCursor, TerraDrawStylingFunction } from "../common";
+import { TerraDrawBaseAdapter } from "./common/base.adapter";
+export declare class TerraDrawGoogleMapsAdapter extends TerraDrawBaseAdapter {
+    constructor(config: {
+        lib: typeof google.maps;
+        map: google.maps.Map;
+        coordinatePrecision?: number;
+    });
+    private _cursor;
+    private _cursorStyleSheet;
+    private _lib;
+    private _map;
+    private _layers;
+    private _overlay;
+    /**
+     * Generates an SVG path string for a circle with the given center coordinates and radius.
+     * Based off this StackOverflow answer: https://stackoverflow.com/a/27905268/1363484
+     * @param cx The x-coordinate of the circle's center.
+     * @param cy The y-coordinate of the circle's center.
+     * @param r The radius of the circle.
+     * @returns The SVG path string representing the circle.
+     */
+    private circlePath;
+    /**
+     * Returns the longitude and latitude coordinates from a given PointerEvent on the map.
+     * @param event The PointerEvent or MouseEvent containing the screen coordinates of the pointer.
+     * @returns An object with 'lng' and 'lat' properties representing the longitude and latitude, or null if the conversion is not possible.
+     */
+    getLngLatFromEvent(event: PointerEvent | MouseEvent): {
+        lng: number;
+        lat: number;
+    } | null;
+    /**
+     * Retrieves the HTML container element of the Leaflet map.
+     * @returns The HTMLElement representing the map container.
+     */
+    getMapContainer(): HTMLElement;
+    /**
+     * Converts longitude and latitude coordinates to pixel coordinates in the map container.
+     * @param lng The longitude coordinate to project.
+     * @param lat The latitude coordinate to project.
+     * @returns An object with 'x' and 'y' properties representing the pixel coordinates within the map container.
+     */
+    project(lng: number, lat: number): {
+        x: number;
+        y: number;
+    };
+    /**
+     * Converts pixel coordinates in the map container to longitude and latitude coordinates.
+     * @param x The x-coordinate in the map container to unproject.
+     * @param y The y-coordinate in the map container to unproject.
+     * @returns An object with 'lng' and 'lat' properties representing the longitude and latitude coordinates.
+     */
+    unproject(x: number, y: number): {
+        lng: number;
+        lat: number;
+    };
+    /**
+     * Sets the cursor style for the map container.
+     * @param cursor The CSS cursor style to apply, or 'unset' to remove any previously applied cursor style.
+     */
+    setCursor(cursor: Parameters<SetCursor>[0]): void;
+    /**
+     * Enables or disables the double-click to zoom functionality on the map.
+     * @param enabled Set to true to enable double-click to zoom, or false to disable it.
+     */
+    setDoubleClickToZoom(enabled: boolean): void;
+    /**
+     * Enables or disables the draggable functionality of the map.
+     * @param enabled Set to true to enable map dragging, or false to disable it.
+     */
+    setDraggability(enabled: boolean): void;
+    /**
+     * Renders GeoJSON features on the map using the provided styling configuration.
+     * @param changes An object containing arrays of created, updated, and unchanged features to render.
+     * @param styling An object mapping draw modes to feature styling functions
+     */
+    render(changes: TerraDrawChanges, styling: TerraDrawStylingFunction): void;
+}

package/dist/adapters/leaflet.adapter.d.ts

@@ -1,35 +1,78 @@
-import { TerraDrawCallbacks, TerraDrawAdapterStyling, TerraDrawChanges, SetCursor } from "../common";
-import L from "leaflet";
-import { GeoJSONStoreFeatures } from "../store/store";
-import { TerraDrawAdapterBase } from "./common/base-adapter";
-export declare class TerraDrawLeafletAdapter extends TerraDrawAdapterBase {
-    constructor(config: {
-        lib: typeof L;
-        map: L.Map;
-        coordinatePrecision?: number;
-        minPixelDragDistance?: number;
-    });
-    getLngLatFromPointerEvent(event: PointerEvent): L.LatLng;
-    getMapContainer(): HTMLElement;
-    setDraggability(enabled: boolean): void;
-    unproject(x: number, y: number): {
-        lng: number;
-        lat: number;
-    };
-    setCursor(cursor: Parameters<SetCursor>[0]): void;
-    setDoubleClickToZoom(enabled: boolean): void;
-    project(lng: number, lat: number): {
-        x: number;
-        y: number;
-    };
-    private _lib;
-    private _map;
-    private _layer;
-    private _panes;
-    private createPaneStyleSheet;
-    register(callbacks: TerraDrawCallbacks): void;
-    unregister(): void;
-    render(changes: TerraDrawChanges, styling: {
-        [mode: string]: (feature: GeoJSONStoreFeatures) => TerraDrawAdapterStyling;
-    }): void;
-}
+import { TerraDrawChanges, SetCursor, TerraDrawStylingFunction } from "../common";
+import L from "leaflet";
+import { TerraDrawBaseAdapter } from "./common/base.adapter";
+export declare class TerraDrawLeafletAdapter extends TerraDrawBaseAdapter {
+    constructor(config: {
+        lib: typeof L;
+        map: L.Map;
+        coordinatePrecision?: number;
+        minPixelDragDistance?: number;
+    });
+    private _lib;
+    private _map;
+    private _layer;
+    private _panes;
+    private _container;
+    /**
+     * Creates a pane and its associated style sheet
+     * @param pane - The pane name
+     * @param zIndex - The zIndex value for the pane
+     * @returns The created style element
+     */
+    private createPaneStyleSheet;
+    /**
+     * Returns the longitude and latitude coordinates from a given PointerEvent on the map.
+     * @param event The PointerEvent or MouseEvent  containing the screen coordinates of the pointer.
+     * @returns An object with 'lng' and 'lat' properties representing the longitude and latitude, or null if the conversion is not possible.
+     */
+    getLngLatFromEvent(event: PointerEvent | MouseEvent): {
+        lng: number;
+        lat: number;
+    } | null;
+    /**
+     * Retrieves the HTML container element of the Leaflet map.
+     * @returns The HTMLElement representing the map container.
+     */
+    getMapContainer(): HTMLElement;
+    /**
+     * Enables or disables the draggable functionality of the map.
+     * @param enabled Set to true to enable map dragging, or false to disable it.
+     */
+    setDraggability(enabled: boolean): void;
+    /**
+     * Converts longitude and latitude coordinates to pixel coordinates in the map container.
+     * @param lng The longitude coordinate to project.
+     * @param lat The latitude coordinate to project.
+     * @returns An object with 'x' and 'y' properties representing the pixel coordinates within the map container.
+     */
+    project(lng: number, lat: number): {
+        x: number;
+        y: number;
+    };
+    /**
+     * Converts pixel coordinates in the map container to longitude and latitude coordinates.
+     * @param x The x-coordinate in the map container to unproject.
+     * @param y The y-coordinate in the map container to unproject.
+     * @returns An object with 'lng' and 'lat' properties representing the longitude and latitude coordinates.
+     */
+    unproject(x: number, y: number): {
+        lng: number;
+        lat: number;
+    };
+    /**
+     * Sets the cursor style for the map container.
+     * @param cursor The CSS cursor style to apply, or 'unset' to remove any previously applied cursor style.
+     */
+    setCursor(cursor: Parameters<SetCursor>[0]): void;
+    /**
+     * Enables or disables the double-click to zoom functionality on the map.
+     * @param enabled Set to true to enable double-click to zoom, or false to disable it.
+     */
+    setDoubleClickToZoom(enabled: boolean): void;
+    /**
+     * Renders GeoJSON features on the map using the provided styling configuration.
+     * @param changes An object containing arrays of created, updated, and unchanged features to render.
+     * @param styling An object mapping draw modes to feature styling functions
+     */
+    render(changes: TerraDrawChanges, styling: TerraDrawStylingFunction): void;
+}

package/dist/adapters/mapbox-gl.adapter.d.ts

@@ -1,34 +1,75 @@
-import { TerraDrawCallbacks, TerraDrawAdapter, TerraDrawModeRegisterConfig, TerraDrawAdapterStyling, TerraDrawChanges } from "../common";
-import mapboxgl from "mapbox-gl";
-import { GeoJSONStoreFeatures } from "../store/store";
-export declare class TerraDrawMapboxGLAdapter implements TerraDrawAdapter {
-    constructor(config: {
-        map: mapboxgl.Map;
-        coordinatePrecision?: number;
-    });
-    private dragState;
-    setDoubleClickToZoom: TerraDrawModeRegisterConfig["setDoubleClickToZoom"];
-    unproject: TerraDrawModeRegisterConfig["unproject"];
-    project: TerraDrawModeRegisterConfig["project"];
-    setCursor: TerraDrawModeRegisterConfig["setCursor"];
-    getMapContainer: () => HTMLElement;
-    private _listeners;
-    private _currentModeCallbacks;
-    private _heldKeys;
-    private _coordinatePrecision;
-    private _map;
-    private _rendered;
-    private _addGeoJSONSource;
-    private _addFillLayer;
-    private _addFillOutlineLayer;
-    private _addLineLayer;
-    private _addPointLayer;
-    private _addLayer;
-    private _addGeoJSONLayer;
-    private _setGeoJSONLayerData;
-    register(callbacks: TerraDrawCallbacks): void;
-    unregister(): void;
-    render(changes: TerraDrawChanges, styling: {
-        [mode: string]: (feature: GeoJSONStoreFeatures) => TerraDrawAdapterStyling;
-    }): void;
-}
+import { TerraDrawChanges, SetCursor, TerraDrawStylingFunction } from "../common";
+import mapboxgl from "mapbox-gl";
+import { TerraDrawBaseAdapter } from "./common/base.adapter";
+export declare class TerraDrawMapboxGLAdapter extends TerraDrawBaseAdapter {
+    constructor(config: {
+        map: mapboxgl.Map;
+        coordinatePrecision?: number;
+    });
+    private _map;
+    private _container;
+    private _rendered;
+    private _addGeoJSONSource;
+    private _addFillLayer;
+    private _addFillOutlineLayer;
+    private _addLineLayer;
+    private _addPointLayer;
+    private _addLayer;
+    private _addGeoJSONLayer;
+    private _setGeoJSONLayerData;
+    /**
+     * Returns the longitude and latitude coordinates from a given PointerEvent on the map.
+     * @param event The PointerEvent or MouseEvent  containing the screen coordinates of the pointer.
+     * @returns An object with 'lng' and 'lat' properties representing the longitude and latitude, or null if the conversion is not possible.
+     */
+    getLngLatFromEvent(event: PointerEvent | MouseEvent): {
+        lng: number;
+        lat: number;
+    };
+    /**
+     * Retrieves the HTML container element of the Leaflet map.
+     * @returns The HTMLElement representing the map container.
+     */
+    getMapContainer(): HTMLElement;
+    /**
+     * Enables or disables the draggable functionality of the map.
+     * @param enabled Set to true to enable map dragging, or false to disable it.
+     */
+    setDraggability(enabled: boolean): void;
+    /**
+     * Converts longitude and latitude coordinates to pixel coordinates in the map container.
+     * @param lng The longitude coordinate to project.
+     * @param lat The latitude coordinate to project.
+     * @returns An object with 'x' and 'y' properties representing the pixel coordinates within the map container.
+     */
+    project(lng: number, lat: number): {
+        x: number;
+        y: number;
+    };
+    /**
+     * Converts pixel coordinates in the map container to longitude and latitude coordinates.
+     * @param x The x-coordinate in the map container to unproject.
+     * @param y The y-coordinate in the map container to unproject.
+     * @returns An object with 'lng' and 'lat' properties representing the longitude and latitude coordinates.
+     */
+    unproject(x: number, y: number): {
+        lng: number;
+        lat: number;
+    };
+    /**
+     * Sets the cursor style for the map container.
+     * @param cursor The CSS cursor style to apply, or 'unset' to remove any previously applied cursor style.
+     */
+    setCursor(style: Parameters<SetCursor>[0]): void;
+    /**
+     * Enables or disables the double-click to zoom functionality on the map.
+     * @param enabled Set to true to enable double-click to zoom, or false to disable it.
+     */
+    setDoubleClickToZoom(enabled: boolean): void;
+    /**
+     * Renders GeoJSON features on the map using the provided styling configuration.
+     * @param changes An object containing arrays of created, updated, and unchanged features to render.
+     * @param styling An object mapping draw modes to feature styling functions
+     */
+    render(changes: TerraDrawChanges, styling: TerraDrawStylingFunction): void;
+}

package/dist/adapters/maplibre-gl.adapter.d.ts

@@ -1,20 +1,65 @@
-import { TerraDrawCallbacks, TerraDrawAdapter, TerraDrawModeRegisterConfig, TerraDrawAdapterStyling, TerraDrawChanges } from "../common";
-import { Map } from "maplibre-gl";
-import { GeoJSONStoreFeatures } from "../store/store";
-export declare class TerraDrawMapLibreGLAdapter implements TerraDrawAdapter {
-    private mapboxglAdapter;
-    constructor(config: {
-        map: Map;
-        coordinatePrecision?: number;
-    });
-    setDoubleClickToZoom: TerraDrawModeRegisterConfig["setDoubleClickToZoom"];
-    unproject: TerraDrawModeRegisterConfig["unproject"];
-    project: TerraDrawModeRegisterConfig["project"];
-    setCursor: TerraDrawModeRegisterConfig["setCursor"];
-    getMapContainer: () => HTMLElement;
-    register(callbacks: TerraDrawCallbacks): void;
-    unregister(): void;
-    render(changes: TerraDrawChanges, styling: {
-        [mode: string]: (feature: GeoJSONStoreFeatures) => TerraDrawAdapterStyling;
-    }): void;
-}
+import { TerraDrawChanges, SetCursor, TerraDrawStylingFunction } from "../common";
+import { Map } from "maplibre-gl";
+import { TerraDrawBaseAdapter } from "./common/base.adapter";
+export declare class TerraDrawMapLibreGLAdapter extends TerraDrawBaseAdapter {
+    private mapboxglAdapter;
+    constructor(config: {
+        map: Map;
+        coordinatePrecision?: number;
+    });
+    /**
+     * Returns the longitude and latitude coordinates from a given PointerEvent on the map.
+     * @param event The PointerEvent or MouseEvent  containing the screen coordinates of the pointer.
+     * @returns An object with 'lng' and 'lat' properties representing the longitude and latitude, or null if the conversion is not possible.
+     */
+    getLngLatFromEvent(event: PointerEvent | MouseEvent): {
+        lng: number;
+        lat: number;
+    };
+    /**
+     * Retrieves the HTML container element of the Leaflet map.
+     * @returns The HTMLElement representing the map container.
+     */
+    getMapContainer(): HTMLElement;
+    /**
+     * Enables or disables the draggable functionality of the map.
+     * @param enabled Set to true to enable map dragging, or false to disable it.
+     */
+    setDraggability(enabled: boolean): void;
+    /**
+     * Converts longitude and latitude coordinates to pixel coordinates in the map container.
+     * @param lng The longitude coordinate to project.
+     * @param lat The latitude coordinate to project.
+     * @returns An object with 'x' and 'y' properties representing the pixel coordinates within the map container.
+     */
+    project(lng: number, lat: number): {
+        x: number;
+        y: number;
+    };
+    /**
+     * Converts pixel coordinates in the map container to longitude and latitude coordinates.
+     * @param x The x-coordinate in the map container to unproject.
+     * @param y The y-coordinate in the map container to unproject.
+     * @returns An object with 'lng' and 'lat' properties representing the longitude and latitude coordinates.
+     */
+    unproject(x: number, y: number): {
+        lng: number;
+        lat: number;
+    };
+    /**
+     * Sets the cursor style for the map container.
+     * @param cursor The CSS cursor style to apply, or 'unset' to remove any previously applied cursor style.
+     */
+    setCursor(style: Parameters<SetCursor>[0]): void;
+    /**
+     * Enables or disables the double-click to zoom functionality on the map.
+     * @param enabled Set to true to enable double-click to zoom, or false to disable it.
+     */
+    setDoubleClickToZoom(enabled: boolean): void;
+    /**
+     * Renders GeoJSON features on the map using the provided styling configuration.
+     * @param changes An object containing arrays of created, updated, and unchanged features to render.
+     * @param styling An object mapping draw modes to feature styling functions
+     */
+    render(changes: TerraDrawChanges, styling: TerraDrawStylingFunction): void;
+}