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

package/CHANGELOG.md

@@ -2,6 +2,25 @@
 
 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.22](https://github.com/JamesLMilner/terra-draw/compare/v0.0.1-alpha.21...v0.0.1-alpha.22) (2023-03-26)
+
+
+### Features
+
+* add custom event pointer event handling system, use in leaflet adapter ([68c551b](https://github.com/JamesLMilner/terra-draw/commit/68c551bf99f0ca37053456a3815cee8fad0c1108))
+
+
+### Chore
+
+* update docs ([a8a91c3](https://github.com/JamesLMilner/terra-draw/commit/a8a91c39a899b5715d74875da63735360b9129f8))
+
+### [0.0.1-alpha.21](https://github.com/JamesLMilner/terra-draw/compare/v0.0.1-alpha.20...v0.0.1-alpha.21) (2023-03-24)
+
+
+### Bug Fixes
+
+* remove scratch folder ([6c671d6](https://github.com/JamesLMilner/terra-draw/commit/6c671d67ac9fec88e00774095beeb0d17738b563))
+
 ### [0.0.1-alpha.20](https://github.com/JamesLMilner/terra-draw/compare/v0.0.1-alpha.19...v0.0.1-alpha.20) (2023-03-24)
 
 

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

@@ -0,0 +1,31 @@
+import { Project, Unproject, TerraDrawCallbacks, TerraDrawChanges, TerraDrawMouseEvent, SetCursor, TerraDrawStylingFunction } from "../../common";
+import { AdapterListener } from "./adapter-listener";
+export declare abstract class TerraDrawAdapterBase {
+    constructor(config: {
+        coordinatePrecision?: number;
+        minPixelDragDistance?: number;
+    });
+    protected dragConter: number;
+    protected _minPixelDragDistance: number;
+    protected _lastDrawEvent: TerraDrawMouseEvent | undefined;
+    protected _coordinatePrecision: number;
+    protected _heldKeys: Set<string>;
+    protected listeners: AdapterListener[];
+    protected dragState: "not-dragging" | "pre-dragging" | "dragging";
+    protected currentModeCallbacks: TerraDrawCallbacks | undefined;
+    protected getButton(event: PointerEvent): "neither" | "left" | "middle" | "right";
+    protected getDrawEventFromPointerEvent(event: PointerEvent): TerraDrawMouseEvent;
+    abstract project(...args: Parameters<Project>): ReturnType<Project>;
+    abstract unproject(...args: Parameters<Unproject>): ReturnType<Unproject>;
+    abstract setCursor(...args: Parameters<SetCursor>): ReturnType<SetCursor>;
+    abstract getLngLatFromPointerEvent(event: PointerEvent): {
+        lng: number;
+        lat: number;
+    };
+    abstract setDraggability(enabled: boolean): void;
+    abstract setDoubleClickToZoom(enabled: boolean): void;
+    abstract getMapContainer(): HTMLElement;
+    abstract register(callbacks: TerraDrawCallbacks): void;
+    abstract unregister(): void;
+    abstract render(changes: TerraDrawChanges, styling: TerraDrawStylingFunction): void;
+}

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

@@ -1,26 +1,31 @@
-import { TerraDrawCallbacks, TerraDrawAdapter, TerraDrawModeRegisterConfig, TerraDrawAdapterStyling, TerraDrawChanges } from "../common";
+import { TerraDrawCallbacks, TerraDrawAdapterStyling, TerraDrawChanges, SetCursor } from "../common";
 import L from "leaflet";
 import { GeoJSONStoreFeatures } from "../store/store";
-export declare class TerraDrawLeafletAdapter implements TerraDrawAdapter {
+import { TerraDrawAdapterBase } from "./common/base-adapter";
+export declare class TerraDrawLeafletAdapter extends TerraDrawAdapterBase {
     constructor(config: {
         lib: typeof L;
         map: L.Map;
         coordinatePrecision?: number;
+        minPixelDragDistance?: number;
     });
-    private listeners;
-    private _heldKeys;
+    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 _coordinatePrecision;
     private _map;
     private _layer;
     private _panes;
-    private dragState;
-    private currentModeCallbacks;
-    setDoubleClickToZoom: TerraDrawModeRegisterConfig["setDoubleClickToZoom"];
-    project: TerraDrawModeRegisterConfig["project"];
-    unproject: TerraDrawModeRegisterConfig["unproject"];
-    setCursor: TerraDrawModeRegisterConfig["setCursor"];
-    getMapContainer: () => HTMLElement;
     private createPaneStyleSheet;
     register(callbacks: TerraDrawCallbacks): void;
     unregister(): void;

package/dist/common.d.ts

@@ -18,13 +18,13 @@ export interface TerraDrawMouseEvent {
     lat: number;
     containerX: number;
     containerY: number;
-    button: "left" | "right" | "pointer";
+    button: "neither" | "left" | "middle" | "right";
     heldKeys: string[];
 }
 export interface TerraDrawKeyboardEvent {
     key: string;
 }
-type SetCursor = (cursor: "unset" | "grab" | "grabbing" | "crosshair" | "pointer") => void;
+export type SetCursor = (cursor: "unset" | "grab" | "grabbing" | "crosshair" | "pointer") => void;
 export type Project = (lng: number, lat: number) => {
     x: number;
     y: number;
@@ -44,7 +44,7 @@ export interface TerraDrawModeRegisterConfig {
     project: Project;
     unproject: Unproject;
 }
-export type TerraDrawModeState = "unregistered" | "registered" | "started" | "stopped";
+export type TerraDrawModeState = "unregistered" | "registered" | "started" | "drawing" | "selected" | "stopped";
 export interface TerraDrawMode {
     mode: string;
     styleFeature: (feature: GeoJSONStoreFeatures) => TerraDrawAdapterStyling;
@@ -62,6 +62,7 @@ export interface TerraDrawMode {
     onDragEnd: (event: TerraDrawMouseEvent, setMapDraggability: (enabled: boolean) => void) => void;
 }
 export interface TerraDrawCallbacks {
+    getState: () => TerraDrawModeState;
     onKeyUp: (event: TerraDrawKeyboardEvent) => void;
     onKeyDown: (event: TerraDrawKeyboardEvent) => void;
     onClick: (event: TerraDrawMouseEvent) => void;
@@ -76,7 +77,7 @@ export interface TerraDrawChanges {
     unchanged: GeoJSONStoreFeatures[];
     deletedIds: string[];
 }
-type TerraDrawStylingFunction = {
+export type TerraDrawStylingFunction = {
     [mode: string]: (feature: GeoJSONStoreFeatures) => TerraDrawAdapterStyling;
 };
 export interface TerraDrawAdapter {
@@ -97,4 +98,3 @@ export declare const SELECT_PROPERTIES: {
 export declare const POLYGON_PROPERTIES: {
     CLOSING_POINT: string;
 };
-export {};

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

@@ -24,6 +24,7 @@ export declare abstract class TerraDrawBaseDrawMode<T extends CustomStyling> {
         pointerDistance?: number;
         coordinatePrecision?: number;
     });
+    protected setDrawing(): void;
     protected setStarted(): void;
     protected setStopped(): void;
     register(config: TerraDrawModeRegisterConfig): void;

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

@@ -12,6 +12,7 @@ export declare class TerraDrawPointMode extends TerraDrawBaseDrawMode<PointModeS
     constructor(options?: {
         styles?: Partial<PointModeStyling>;
     });
+    protected setStarted(): void;
     /** @internal */
     start(): void;
     /** @internal */