terra-draw 1.0.0-beta.8 → 1.0.0

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

@@ -1,90 +0,0 @@
-import { TerraDrawChanges, SetCursor, TerraDrawStylingFunction, TerraDrawCallbacks } from "../common";
-import { BaseAdapterConfig, TerraDrawBaseAdapter } from "./common/base.adapter";
-export declare class TerraDrawGoogleMapsAdapter extends TerraDrawBaseAdapter {
-    constructor(config: {
-        lib: typeof google.maps;
-        map: google.maps.Map;
-    } & BaseAdapterConfig);
-    private _cursor;
-    private _cursorStyleSheet;
-    private _lib;
-    private _map;
-    private _overlay;
-    private _clickEventListener;
-    private _mouseMoveEventListener;
-    private get _layers();
-    /**
-     * 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;
-    register(callbacks: TerraDrawCallbacks): void;
-    unregister(): void;
-    /**
-     * 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 element of the Google Map element that handles interaction events
-     * @returns The HTMLElement representing the map container.
-     */
-    getMapEventElement(): HTMLDivElement;
-    /**
-     * 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;
-    private renderedFeatureIds;
-    /**
-     * 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;
-    private clearLayers;
-    /**
-     * Clears the map and store of all rendered data layers
-     * @returns void
-     * */
-    clear(): void;
-    getCoordinatePrecision(): number;
-}

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

@@ -1,99 +0,0 @@
-import { TerraDrawChanges, SetCursor, TerraDrawStylingFunction, TerraDrawCallbacks } from "../common";
-import L from "leaflet";
-import { BaseAdapterConfig, TerraDrawBaseAdapter } from "./common/base.adapter";
-export declare class TerraDrawLeafletAdapter extends TerraDrawBaseAdapter {
-    constructor(config: {
-        lib: typeof L;
-        map: L.Map;
-    } & BaseAdapterConfig);
-    private _lib;
-    private _map;
-    private _panes;
-    private _container;
-    private _layers;
-    /**
-     * 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;
-    /**
-     * Clears the panes created by the adapter
-     * @returns void
-     * */
-    private clearPanes;
-    /**
-     * Clears the leaflet layers created by the adapter
-     * @returns void
-     * */
-    private clearLayers;
-    /**
-     * Styles a GeoJSON layer based on the styling function
-     * @param styling - The styling function
-     * */
-    private styleGeoJSONLayer;
-    /**
-     * 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 element of the Leaflet element that handles interaction events
-     * @returns The HTMLElement representing the map container.
-     */
-    getMapEventElement(): 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;
-    /**
-     * Clears the map and store of all rendered data layers
-     * @returns void
-     * */
-    clear(): void;
-    register(callbacks: TerraDrawCallbacks): void;
-    getCoordinatePrecision(): number;
-    unregister(): void;
-}

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

@@ -1,90 +0,0 @@
-import { TerraDrawChanges, SetCursor, TerraDrawStylingFunction, TerraDrawCallbacks } from "../common";
-import mapboxgl from "mapbox-gl";
-import { BaseAdapterConfig, TerraDrawBaseAdapter } from "./common/base.adapter";
-export declare class TerraDrawMapboxGLAdapter extends TerraDrawBaseAdapter {
-    constructor(config: {
-        map: mapboxgl.Map;
-    } & BaseAdapterConfig);
-    private _nextRender;
-    private _map;
-    private _container;
-    private _rendered;
-    /**
-     * Clears the map of rendered layers and sources
-     * @returns void
-     * */
-    private clearLayers;
-    private _addGeoJSONSource;
-    private _addFillLayer;
-    private _addFillOutlineLayer;
-    private _addLineLayer;
-    private _addPointLayer;
-    private _addLayer;
-    private _addGeoJSONLayer;
-    private _setGeoJSONLayerData;
-    private changedIds;
-    private updateChangedIds;
-    /**
-     * 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 element of the Mapbox element that handles interaction events
-     * @returns The HTMLElement representing the map container.
-     */
-    getMapEventElement(): HTMLCanvasElement;
-    /**
-     * 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;
-    /**
-     * Clears the map and store of all rendered data layers
-     * @returns void
-     * */
-    clear(): void;
-    getCoordinatePrecision(): number;
-    unregister(): void;
-    register(callbacks: TerraDrawCallbacks): void;
-}

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

@@ -1,72 +0,0 @@
-import { TerraDrawChanges, SetCursor, TerraDrawStylingFunction, TerraDrawCallbacks } from "../common";
-import { Map } from "maplibre-gl";
-import { BaseAdapterConfig, TerraDrawBaseAdapter } from "./common/base.adapter";
-export declare class TerraDrawMapLibreGLAdapter extends TerraDrawBaseAdapter {
-    private mapboxglAdapter;
-    constructor(config: {
-        map: Map;
-    } & BaseAdapterConfig);
-    register(callbacks: TerraDrawCallbacks): void;
-    unregister(): void;
-    getCoordinatePrecision(): 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 element of the MapLibre element that handles interaction events
-     * @returns The HTMLElement representing the map container.
-     */
-    getMapEventElement(): HTMLCanvasElement;
-    /**
-     * 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;
-    /**
-     * Clears the map and store of all rendered data layers
-     * @returns void
-     * */
-    clear(): void;
-}

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

@@ -1,121 +0,0 @@
-import { TerraDrawChanges, SetCursor, TerraDrawStylingFunction, TerraDrawCallbacks } from "../common";
-import Feature from "ol/Feature";
-import GeoJSON from "ol/format/GeoJSON";
-import Map from "ol/Map";
-import Circle from "ol/style/Circle";
-import Fill from "ol/style/Fill";
-import Stroke from "ol/style/Stroke";
-import Style from "ol/style/Style";
-import VectorSource from "ol/source/Vector";
-import VectorLayer from "ol/layer/Vector";
-import { getUserProjection } from "ol/proj";
-import { BaseAdapterConfig, TerraDrawBaseAdapter } from "./common/base.adapter";
-export type InjectableOL = {
-    Fill: typeof Fill;
-    Feature: typeof Feature;
-    GeoJSON: typeof GeoJSON;
-    Style: typeof Style;
-    Circle: typeof Circle;
-    VectorLayer: typeof VectorLayer;
-    VectorSource: typeof VectorSource;
-    Stroke: typeof Stroke;
-    getUserProjection: typeof getUserProjection;
-};
-export declare class TerraDrawOpenLayersAdapter extends TerraDrawBaseAdapter {
-    constructor(config: {
-        map: Map;
-        lib: InjectableOL;
-        zIndex?: number;
-    } & BaseAdapterConfig);
-    private stylingFunction;
-    private _lib;
-    private _map;
-    private _container;
-    private _projection;
-    private _vectorSource;
-    private _geoJSONReader;
-    /**
-     * Converts a hexideciaml color to RGB
-     * @param hex a string of the hexidecimal string
-     * @returns an object to red green and blue (RGB) color
-     */
-    private hexToRGB;
-    private getStyles;
-    /**
-     * Clears the layers created by the adapter
-     * @returns void
-     * */
-    private clearLayers;
-    private addFeature;
-    private removeFeature;
-    /**
-     * Sorts an array of DOM elements based on their order in the document, from earliest to latest.
-     * @param elements - An array of `HTMLElement` objects to be sorted.
-     * @returns A new array of `HTMLElement` objects sorted by their document order.
-     */
-    private sortElementsByDOMOrder;
-    /**
-     * 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 element of the OpenLayers element that handles interaction events
-     * @returns The HTMLElement representing the map container.
-     */
-    getMapEventElement(): HTMLCanvasElement;
-    /**
-     * 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;
-    /**
-     * Clears the map and store of all rendered data layers
-     * @returns void
-     * */
-    clear(): void;
-    private registeredLayerHandlers;
-    register(callbacks: TerraDrawCallbacks): void;
-    getCoordinatePrecision(): number;
-    unregister(): void;
-}

package/e2e/README.md

@@ -1,29 +0,0 @@
-# E2E Testing with Playwright
-
-We provide a basic end-to-end (E2E) test suite via Playwright, testing against the Leaflet Adapter. The test suite aims to emulate how an end user would interact with and use Terra Draw. Here we can attempt to catch bugs earlier in the pipeline and ensure that new behaviours in the future adhere to a given specification. 
-
-## Installation
-
-Installation can be down via npm like so:
-
-```shell
-npm install
-```
-
-## Running
-
-You can run the tests headless (i.e. no opening of Chromimum) like so:
-
-```shell
-npm run test
-```
-
-Or you can run them headed (i.e. Chromimum will open and you will see the tests run) like so:
-
-```shell
-npm run test:headed
-```
-
-## Tests
-
-Tests are located in the `tests` folder. You will see the `leaflet.spec.ts` file, this is where the tests are kept for the E2E tests written for the Leaflet Adapter. There are also some convienence methods written in the `setup.ts` file which can be leveraged to write tests more easily.