terra-draw 0.0.1-alpha.40 → 0.0.1-alpha.42

package/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 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.42 (2023-07-24)
+
+### 0.0.1-alpha.41 (2023-07-16)
+
+
+### Chore
+
+* alpha release script ([7b743ab](https://github.com/JamesLMilner/terra-draw/commit/7b743ab48ec8db0a294373d9a3c2c066945a2fe4))
+
 ### [0.0.1-alpha.40](https://github.com/JamesLMilner/terra-draw/compare/v0.0.1-alpha.39...v0.0.1-alpha.40) (2023-07-15)
 
 

package/README.md

@@ -16,7 +16,7 @@ Terra Draw uses the concept of 'adapters' to allow it to work with a host of dif
 - [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
+- [MapLibre](https://maplibre.org/projects/maplibre-gl-js/) v2/v3
 - [Google Maps JS API](https://developers.google.com/maps/documentation/javascript/overview) v3
 
 ### Getting Started

package/dist/common.d.ts

@@ -1,5 +1,7 @@
 import { StoreChangeHandler, GeoJSONStore, GeoJSONStoreFeatures } from "./store/store";
 export type HexColor = `#${string}`;
+export type HexColorStyling = HexColor | ((feature: GeoJSONStoreFeatures) => HexColor);
+export type NumericStyling = number | ((feature: GeoJSONStoreFeatures) => number);
 export interface TerraDrawAdapterStyling {
     pointColor: HexColor;
     pointWidth: number;

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

@@ -1,7 +1,7 @@
 import { BehaviorConfig, TerraDrawModeBehavior } from "./base.behavior";
-import { TerraDrawAdapterStyling, TerraDrawKeyboardEvent, TerraDrawModeRegisterConfig, TerraDrawModeState, TerraDrawMouseEvent } from "../common";
+import { HexColor, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, TerraDrawModeRegisterConfig, TerraDrawModeState, TerraDrawMouseEvent } from "../common";
 import { GeoJSONStore, GeoJSONStoreFeatures, StoreChangeHandler } from "../store/store";
-type CustomStyling = Record<string, string | number>;
+type CustomStyling = Record<string, string | number | ((feature: GeoJSONStoreFeatures) => HexColor) | ((feature: GeoJSONStoreFeatures) => number)>;
 export declare enum ModeTypes {
     Drawing = "drawing",
     Select = "select",
@@ -51,5 +51,8 @@ export declare abstract class TerraDrawBaseDrawMode<T extends CustomStyling> {
     onDragStart(event: TerraDrawMouseEvent, setMapDraggability: (enabled: boolean) => void): void;
     onDrag(event: TerraDrawMouseEvent, setMapDraggability: (enabled: boolean) => void): void;
     onDragEnd(event: TerraDrawMouseEvent, setMapDraggability: (enabled: boolean) => void): void;
+    protected getHexColorStylingValue(value: HexColor | ((feature: GeoJSONStoreFeatures) => HexColor) | undefined, defaultValue: HexColor, feature: GeoJSONStoreFeatures): HexColor;
+    protected getNumericStylingValue(value: number | ((feature: GeoJSONStoreFeatures) => number) | undefined, defaultValue: number, feature: GeoJSONStoreFeatures): number;
+    private getStylingValue;
 }
 export {};

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

@@ -1,4 +1,4 @@
-import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColor } from "../../common";
+import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling } from "../../common";
 import { GeoJSONStoreFeatures } from "../../store/store";
 import { TerraDrawBaseDrawMode } from "../base.mode";
 type TerraDrawCircleModeKeyEvents = {
@@ -6,10 +6,10 @@ type TerraDrawCircleModeKeyEvents = {
     finish: KeyboardEvent["key"] | null;
 };
 type FreehandPolygonStyling = {
-    fillColor: HexColor;
-    outlineColor: HexColor;
-    outlineWidth: number;
-    fillOpacity: number;
+    fillColor: HexColorStyling;
+    outlineColor: HexColorStyling;
+    outlineWidth: NumericStyling;
+    fillOpacity: NumericStyling;
 };
 export declare class TerraDrawCircleMode extends TerraDrawBaseDrawMode<FreehandPolygonStyling> {
     mode: string;

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

@@ -1,4 +1,4 @@
-import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColor } from "../../common";
+import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling } from "../../common";
 import { TerraDrawBaseDrawMode } from "../base.mode";
 import { GeoJSONStoreFeatures } from "../../store/store";
 type TerraDrawFreehandModeKeyEvents = {
@@ -6,14 +6,14 @@ type TerraDrawFreehandModeKeyEvents = {
     finish: KeyboardEvent["key"] | null;
 };
 type FreehandPolygonStyling = {
-    fillColor: HexColor;
-    outlineColor: HexColor;
-    outlineWidth: number;
-    fillOpacity: number;
-    closingPointColor: HexColor;
-    closingPointWidth: number;
-    closingPointOutlineColor: HexColor;
-    closingPointOutlineWidth: number;
+    fillColor: HexColorStyling;
+    outlineColor: HexColorStyling;
+    outlineWidth: NumericStyling;
+    fillOpacity: NumericStyling;
+    closingPointColor: HexColorStyling;
+    closingPointWidth: NumericStyling;
+    closingPointOutlineColor: HexColorStyling;
+    closingPointOutlineWidth: NumericStyling;
 };
 export declare class TerraDrawFreehandMode extends TerraDrawBaseDrawMode<FreehandPolygonStyling> {
     mode: string;

package/dist/modes/greatcircle/great-circle.mode.d.ts

@@ -1,4 +1,4 @@
-import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColor } from "../../common";
+import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling } from "../../common";
 import { TerraDrawBaseDrawMode } from "../base.mode";
 import { BehaviorConfig } from "../base.behavior";
 import { GeoJSONStoreFeatures } from "../../store/store";
@@ -7,12 +7,12 @@ type TerraDrawGreateCircleModeKeyEvents = {
     finish: KeyboardEvent["key"] | null;
 };
 type GreateCircleStyling = {
-    lineStringWidth: number;
-    lineStringColor: HexColor;
-    closingPointColor: HexColor;
-    closingPointWidth: number;
-    closingPointOutlineColor: HexColor;
-    closingPointOutlineWidth: number;
+    lineStringWidth: NumericStyling;
+    lineStringColor: HexColorStyling;
+    closingPointColor: HexColorStyling;
+    closingPointWidth: NumericStyling;
+    closingPointOutlineColor: HexColorStyling;
+    closingPointOutlineWidth: NumericStyling;
 };
 export declare class TerraDrawGreatCircleMode extends TerraDrawBaseDrawMode<GreateCircleStyling> {
     mode: string;

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

@@ -1,4 +1,4 @@
-import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColor } from "../../common";
+import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling } from "../../common";
 import { TerraDrawBaseDrawMode } from "../base.mode";
 import { BehaviorConfig } from "../base.behavior";
 import { GeoJSONStoreFeatures } from "../../store/store";
@@ -7,12 +7,12 @@ type TerraDrawLineStringModeKeyEvents = {
     finish: KeyboardEvent["key"] | null;
 };
 type LineStringStyling = {
-    lineStringWidth: number;
-    lineStringColor: HexColor;
-    closingPointColor: HexColor;
-    closingPointWidth: number;
-    closingPointOutlineColor: HexColor;
-    closingPointOutlineWidth: number;
+    lineStringWidth: NumericStyling;
+    lineStringColor: HexColorStyling;
+    closingPointColor: HexColorStyling;
+    closingPointWidth: NumericStyling;
+    closingPointOutlineColor: HexColorStyling;
+    closingPointOutlineWidth: NumericStyling;
 };
 export declare class TerraDrawLineStringMode extends TerraDrawBaseDrawMode<LineStringStyling> {
     mode: string;

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

@@ -1,11 +1,11 @@
-import { TerraDrawMouseEvent, TerraDrawAdapterStyling, HexColor } from "../../common";
+import { TerraDrawMouseEvent, TerraDrawAdapterStyling, NumericStyling, HexColorStyling } from "../../common";
 import { GeoJSONStoreFeatures } from "../../store/store";
 import { TerraDrawBaseDrawMode } from "../base.mode";
 type PointModeStyling = {
-    pointWidth: number;
-    pointColor: HexColor;
-    pointOutlineColor: HexColor;
-    pointOutlineWidth: number;
+    pointWidth: NumericStyling;
+    pointColor: HexColorStyling;
+    pointOutlineColor: HexColorStyling;
+    pointOutlineWidth: NumericStyling;
 };
 export declare class TerraDrawPointMode extends TerraDrawBaseDrawMode<PointModeStyling> {
     mode: string;

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

@@ -1,4 +1,4 @@
-import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColor } from "../../common";
+import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling } from "../../common";
 import { TerraDrawBaseDrawMode } from "../base.mode";
 import { BehaviorConfig } from "../base.behavior";
 import { GeoJSONStoreFeatures } from "../../store/store";
@@ -7,14 +7,14 @@ type TerraDrawPolygonModeKeyEvents = {
     finish?: KeyboardEvent["key"] | null;
 };
 type PolygonStyling = {
-    fillColor: HexColor;
-    outlineColor: HexColor;
-    outlineWidth: number;
-    fillOpacity: number;
-    closingPointWidth: number;
-    closingPointColor: HexColor;
-    closingPointOutlineWidth: number;
-    closingPointOutlineColor: HexColor;
+    fillColor: HexColorStyling;
+    outlineColor: HexColorStyling;
+    outlineWidth: NumericStyling;
+    fillOpacity: NumericStyling;
+    closingPointWidth: NumericStyling;
+    closingPointColor: HexColorStyling;
+    closingPointOutlineWidth: NumericStyling;
+    closingPointOutlineColor: HexColorStyling;
 };
 export declare class TerraDrawPolygonMode extends TerraDrawBaseDrawMode<PolygonStyling> {
     mode: string;

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

@@ -1,4 +1,4 @@
-import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColor } from "../../common";
+import { TerraDrawMouseEvent, TerraDrawAdapterStyling, TerraDrawKeyboardEvent, HexColorStyling, NumericStyling } from "../../common";
 import { GeoJSONStoreFeatures } from "../../store/store";
 import { TerraDrawBaseDrawMode } from "../base.mode";
 type TerraDrawRectangleModeKeyEvents = {
@@ -6,10 +6,10 @@ type TerraDrawRectangleModeKeyEvents = {
     finish: KeyboardEvent["key"] | null;
 };
 type RectanglePolygonStyling = {
-    fillColor: HexColor;
-    outlineColor: HexColor;
-    outlineWidth: number;
-    fillOpacity: number;
+    fillColor: HexColorStyling;
+    outlineColor: HexColorStyling;
+    outlineWidth: NumericStyling;
+    fillOpacity: NumericStyling;
 };
 export declare class TerraDrawRectangleMode extends TerraDrawBaseDrawMode<RectanglePolygonStyling> {
     mode: string;

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

@@ -1,14 +1,25 @@
-import { TerraDrawAdapterStyling } from "../../common";
+import { HexColorStyling, NumericStyling, TerraDrawAdapterStyling } from "../../common";
 import { ModeTypes, TerraDrawBaseDrawMode } from "../base.mode";
 import { BehaviorConfig } from "../base.behavior";
 import { GeoJSONStoreFeatures } from "../../terra-draw";
-type RenderModeStylingExt<T extends TerraDrawAdapterStyling> = {};
-type RenderModeStyling = RenderModeStylingExt<TerraDrawAdapterStyling>;
+type RenderModeStyling = {
+    pointColor: HexColorStyling;
+    pointWidth: NumericStyling;
+    pointOutlineColor: HexColorStyling;
+    pointOutlineWidth: NumericStyling;
+    polygonFillColor: HexColorStyling;
+    polygonFillOpacity: NumericStyling;
+    polygonOutlineColor: HexColorStyling;
+    polygonOutlineWidth: NumericStyling;
+    lineStringWidth: NumericStyling;
+    lineStringColor: HexColorStyling;
+    zIndex: NumericStyling;
+};
 export declare class TerraDrawRenderMode extends TerraDrawBaseDrawMode<RenderModeStyling> {
     type: ModeTypes;
     mode: string;
     constructor(options: {
-        styles: Partial<TerraDrawAdapterStyling>;
+        styles: Partial<RenderModeStyling>;
     });
     /** @internal */
     registerBehaviors(behaviorConfig: BehaviorConfig): void;
@@ -33,7 +44,7 @@ export declare class TerraDrawRenderMode extends TerraDrawBaseDrawMode<RenderMod
     /** @internal */
     cleanUp(): void;
     /** @internal */
-    styleFeature(): TerraDrawAdapterStyling;
+    styleFeature(feature: GeoJSONStoreFeatures): TerraDrawAdapterStyling;
     validateFeature(feature: unknown): feature is GeoJSONStoreFeatures;
 }
 export {};

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

@@ -1,4 +1,4 @@
-import { TerraDrawMouseEvent, TerraDrawKeyboardEvent, HexColor, TerraDrawAdapterStyling } from "../../common";
+import { TerraDrawMouseEvent, TerraDrawKeyboardEvent, TerraDrawAdapterStyling, HexColorStyling, NumericStyling } from "../../common";
 import { ModeTypes, TerraDrawBaseDrawMode } from "../base.mode";
 import { BehaviorConfig } from "../base.behavior";
 import { GeoJSONStoreFeatures } from "../../store/store";
@@ -21,24 +21,24 @@ type ModeFlags = {
     };
 };
 type SelectionStyling = {
-    selectedPointColor: HexColor;
-    selectedPointWidth: number;
-    selectedPointOutlineColor: HexColor;
-    selectedPointOutlineWidth: number;
-    selectedLineStringColor: HexColor;
-    selectedLineStringWidth: number;
-    selectedPolygonColor: HexColor;
-    selectedPolygonFillOpacity: number;
-    selectedPolygonOutlineColor: HexColor;
-    selectedPolygonOutlineWidth: number;
-    selectionPointWidth: number;
-    selectionPointColor: HexColor;
-    selectionPointOutlineColor: HexColor;
-    selectionPointOutlineWidth: number;
-    midPointColor: HexColor;
-    midPointOutlineColor: HexColor;
-    midPointWidth: number;
-    midPointOutlineWidth: number;
+    selectedPointColor: HexColorStyling;
+    selectedPointWidth: NumericStyling;
+    selectedPointOutlineColor: HexColorStyling;
+    selectedPointOutlineWidth: NumericStyling;
+    selectedLineStringColor: HexColorStyling;
+    selectedLineStringWidth: NumericStyling;
+    selectedPolygonColor: HexColorStyling;
+    selectedPolygonFillOpacity: NumericStyling;
+    selectedPolygonOutlineColor: HexColorStyling;
+    selectedPolygonOutlineWidth: NumericStyling;
+    selectionPointWidth: NumericStyling;
+    selectionPointColor: HexColorStyling;
+    selectionPointOutlineColor: HexColorStyling;
+    selectionPointOutlineWidth: NumericStyling;
+    midPointColor: HexColorStyling;
+    midPointOutlineColor: HexColorStyling;
+    midPointWidth: NumericStyling;
+    midPointOutlineWidth: NumericStyling;
 };
 export declare class TerraDrawSelectMode extends TerraDrawBaseDrawMode<SelectionStyling> {
     type: ModeTypes;