terra-draw 0.0.1-alpha.47 → 0.0.1-alpha.49

package/.devcontainer/Dockerfile

@@ -0,0 +1,8 @@
+ARG NODE_MAJOR_VERSION
+
+FROM mcr.microsoft.com/devcontainers/javascript-node:${NODE_MAJOR_VERSION}
+
+ENV EDITOR="code -w" VISUAL="code -w" CHOKIDAR_USEPOLLING="1"
+
+# uncomment to install additional npm packages
+# RUN su node -c 'npm i -g cowsay@1.5.0'

package/.devcontainer/devcontainer.json

@@ -0,0 +1,21 @@
+{
+	"name": "terra-draw",
+	"dockerFile": "Dockerfile",
+	"build": {
+		"args": { "NODE_MAJOR_VERSION": "18" }
+	},
+	"postCreateCommand": [".devcontainer/post-create.sh"],
+	"portsAttributes": {
+		"3000": { "label": "Docs" },
+		"9000": { "label": "Development" }
+	},
+	"customizations": {
+		"vscode": {
+			"extensions": [
+				"dbaeumer.vscode-eslint",
+				"esbenp.prettier-vscode",
+				"mikestead.dotenv"
+			]
+		}
+	}
+}

package/.devcontainer/post-create.sh

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+
+set -eo pipefail
+
+# when in a VS Code or GitHub Codespaces devcontainer
+if [ -n "${REMOTE_CONTAINERS}" ] || [ -n "${CODESPACES}" ]; then
+	this_dir=$(cd -P -- "$(dirname -- "$(command -v -- "$0")")" && pwd -P)
+	workspace_root=$(realpath ${this_dir}/..)
+
+	# perform additional one-time setup just after
+	# the devcontainer is created
+	npm ci --prefix "${workspace_root}"             # install lib node dependencies
+	npm ci --prefix "${workspace_root}/development" # install dev node dependencies
+	touch "${workspace_root}/development/.env"      # ensure dev .env file exists
+
+fi

package/README.md

@@ -5,7 +5,7 @@
 
 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!
+Terra Draw centralizes map drawing logic and provides a host of out-of-the-box drawing modes that work across different JavaScript mapping libraries. It also allows you to bring your own modes!
 
 ![An example of drawing geodesic lines using Terra Draw with Leaflet](./readme.gif)
 
@@ -22,7 +22,7 @@ Terra Draw uses the concept of 'adapters' to allow it to work with a host of dif
 
 ### Getting Started
 
-Please see the [the getting started guide](./guides/GETTING_STARTED.md) - this provides a host of information on how get up and running with Terra Draw. You may also find some useful pointers for things you may be finding yourself wanting to do in the [common patterns guide](./guides/COMMON_PATTERNS.md).
+Please see the [the getting started guide](./guides/GETTING_STARTED.md) - this provides a host of information on how to get up and running with Terra Draw. You may also find some useful pointers for things you may be finding yourself wanting to do in the [common patterns guide](./guides/COMMON_PATTERNS.md).
 
 ### Development
 
@@ -34,7 +34,7 @@ Please see the [the contributing documentation](./guides/CONTRIBUTING.md)
 
 ### Project Website
 
-You can checkout the offical Terra Draw website at [terradraw.io](https://www.terradraw.io). If you are interested in contributing to the website please see [this repository](https://www.github.com/JamesLMilner/terra-draw-website).
+You can check out the official Terra Draw website at [terradraw.io](https://www.terradraw.io). If you are interested in contributing to the website please see [this repository](https://www.github.com/JamesLMilner/terra-draw-website).
 
 ### License
 

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

@@ -19,8 +19,9 @@ export declare abstract class TerraDrawBaseAdapter {
     protected _listeners: AdapterListener<BasePointerListener | BaseKeyboardListener | BaseMouseListener>[];
     protected _dragState: "not-dragging" | "pre-dragging" | "dragging";
     protected _currentModeCallbacks: TerraDrawCallbacks | undefined;
+    protected abstract getMapEventElement(): HTMLElement;
     protected getButton(event: PointerEvent | MouseEvent): "neither" | "left" | "middle" | "right";
-    protected getContainerXYPosition(event: PointerEvent | MouseEvent): {
+    protected getMapElementXYPosition(event: PointerEvent | MouseEvent): {
         containerX: number;
         containerY: number;
     };
@@ -32,6 +33,7 @@ export declare abstract class TerraDrawBaseAdapter {
      * for handling various drawing events in the current mode.
      */
     register(callbacks: TerraDrawCallbacks): void;
+    private getAdapterListeners;
     /**
      * Unregisters the event listeners for the current drawing mode.
      * This is typically called when switching between drawing modes or
@@ -45,7 +47,6 @@ export declare abstract class TerraDrawBaseAdapter {
     abstract getLngLatFromEvent(...event: Parameters<GetLngLatFromEvent>): ReturnType<GetLngLatFromEvent>;
     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,5 +1,5 @@
 /// <reference types="google.maps" />
-import { TerraDrawChanges, SetCursor, TerraDrawStylingFunction } from "../common";
+import { TerraDrawChanges, SetCursor, TerraDrawStylingFunction, TerraDrawCallbacks } from "../common";
 import { TerraDrawBaseAdapter } from "./common/base.adapter";
 export declare class TerraDrawGoogleMapsAdapter extends TerraDrawBaseAdapter {
     constructor(config: {
@@ -11,8 +11,10 @@ export declare class TerraDrawGoogleMapsAdapter extends TerraDrawBaseAdapter {
     private _cursorStyleSheet;
     private _lib;
     private _map;
-    private _layers;
     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
@@ -22,6 +24,8 @@ export declare class TerraDrawGoogleMapsAdapter extends TerraDrawBaseAdapter {
      * @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.
@@ -32,10 +36,10 @@ export declare class TerraDrawGoogleMapsAdapter extends TerraDrawBaseAdapter {
         lat: number;
     } | null;
     /**
-     * Retrieves the HTML container element of the Leaflet map.
+     * Retrieves the HTML element of the Google Map element that handles interaction events
      * @returns The HTMLElement representing the map container.
      */
-    getMapContainer(): HTMLElement;
+    getMapEventElement(): HTMLDivElement;
     /**
      * Converts longitude and latitude coordinates to pixel coordinates in the map container.
      * @param lng The longitude coordinate to project.
@@ -71,7 +75,7 @@ export declare class TerraDrawGoogleMapsAdapter extends TerraDrawBaseAdapter {
      * @param enabled Set to true to enable map dragging, or false to disable it.
      */
     setDraggability(enabled: boolean): void;
-    private renderedFeatures;
+    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.

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

@@ -45,10 +45,10 @@ export declare class TerraDrawLeafletAdapter extends TerraDrawBaseAdapter {
         lat: number;
     } | null;
     /**
-     * Retrieves the HTML container element of the Leaflet map.
+     * Retrieves the HTML element of the Leaflet element that handles interaction events
      * @returns The HTMLElement representing the map container.
      */
-    getMapContainer(): HTMLElement;
+    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.

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

@@ -36,10 +36,10 @@ export declare class TerraDrawMapboxGLAdapter extends TerraDrawBaseAdapter {
         lat: number;
     };
     /**
-     * Retrieves the HTML container element of the Leaflet map.
+     *Retrieves the HTML element of the Mapbox element that handles interaction events
      * @returns The HTMLElement representing the map container.
      */
-    getMapContainer(): HTMLElement;
+    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.

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

@@ -19,10 +19,10 @@ export declare class TerraDrawMapLibreGLAdapter extends TerraDrawBaseAdapter {
         lat: number;
     };
     /**
-     * Retrieves the HTML container element of the Leaflet map.
+     * Retrieves the HTML element of the MapLibre element that handles interaction events
      * @returns The HTMLElement representing the map container.
      */
-    getMapContainer(): HTMLElement;
+    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.

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

@@ -27,6 +27,7 @@ export declare class TerraDrawOpenLayersAdapter extends TerraDrawBaseAdapter {
         lib: InjectableOL;
         coordinatePrecision?: number;
     });
+    private stylingFunction;
     private _lib;
     private _map;
     private _container;
@@ -63,10 +64,10 @@ export declare class TerraDrawOpenLayersAdapter extends TerraDrawBaseAdapter {
         lat: number;
     } | null;
     /**
-     * Retrieves the HTML container element of the Leaflet map.
+     * Retrieves the HTML element of the OpenLayers element that handles interaction events
      * @returns The HTMLElement representing the map container.
      */
-    getMapContainer(): HTMLElement;
+    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.

package/dist/common.d.ts

@@ -84,7 +84,7 @@ export interface TerraDrawAdapter {
     setCursor: SetCursor;
     getLngLatFromEvent: GetLngLatFromEvent;
     setDoubleClickToZoom: (enabled: boolean) => void;
-    getMapContainer: () => HTMLElement;
+    getMapEventElement: () => HTMLElement;
     register(callbacks: TerraDrawCallbacks): void;
     unregister(): void;
     render(changes: TerraDrawChanges, styling: TerraDrawStylingFunction): void;

package/dist/modes/freehand/freehand.mode.d.ts

@@ -27,9 +27,11 @@ export declare class TerraDrawFreehandMode extends TerraDrawBaseDrawMode<Freehan
     private minDistance;
     private keyEvents;
     private cursors;
+    private preventPointsNearClose;
     constructor(options?: {
         styles?: Partial<FreehandPolygonStyling>;
         minDistance?: number;
+        preventPointsNearClose?: boolean;
         keyEvents?: TerraDrawFreehandModeKeyEvents | null;
         cursors?: Cursors;
     });