@opensystemslab/map 0.8.3 → 1.0.0-alpha.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opensystemslab/map",
-  "version": "0.8.3",
+  "version": "1.0.0-alpha.1",
   "license": "MPL-2.0",
   "private": false,
   "repository": {
@@ -26,36 +26,36 @@
     "docsPublish": "pitsby build"
   },
   "dependencies": {
-    "@turf/union": "^6.5.0",
+    "@turf/union": "^7.0.0",
     "accessible-autocomplete": "^2.0.4",
     "file-saver": "^2.0.5",
-    "govuk-frontend": "^5.0.0",
+    "govuk-frontend": "^5.4.0",
     "jspdf": "^2.5.1",
     "lit": "^3.0.1",
     "ol": "^9.1.0",
-    "ol-ext": "^4.0.17",
+    "ol-ext": "^4.0.21",
     "ol-mapbox-style": "^12.3.0",
     "postcode": "^5.1.0",
-    "proj4": "^2.9.2",
-    "rambda": "^8.6.0"
+    "proj4": "^2.11.0",
+    "rambda": "^9.2.1"
   },
   "devDependencies": {
-    "@glorious/pitsby": "^1.37.0",
-    "@testing-library/dom": "^9.3.4",
+    "@glorious/pitsby": "^1.37.2",
+    "@testing-library/dom": "^10.4.0",
     "@testing-library/user-event": "^14.5.2",
     "@types/file-saver": "^2.0.7",
-    "@types/node": "18.19.21",
+    "@types/node": "22.0.3",
     "@types/ol-ext": "npm:@siedlerchr/types-ol-ext@^3.3.0",
     "@types/proj4": "^2.5.5",
     "@vitest/ui": "^0.34.7",
     "happy-dom": "^9.1.9",
     "husky": "^8.0.3",
-    "lint-staged": "^14.0.1",
+    "lint-staged": "^15.2.7",
     "prettier": "^3.2.5",
     "rollup-plugin-postcss-lit": "^2.1.0",
     "sass": "^1.69.5",
-    "typescript": "^5.3.3",
-    "vite": "^5.1.7",
+    "typescript": "^5.5.2",
+    "vite": "^5.3.2",
     "vitest": "0.34.6",
     "wait-for-expect": "^3.0.2"
   },

package/types/components/address-autocomplete/index.d.ts

@@ -10,7 +10,11 @@ export declare class AddressAutocomplete extends LitElement {
     postcode: string;
     label: string;
     initialAddress: string;
-    osPlacesApiKey: string;
+    osApiKey: string;
+    /**
+     * @deprecated - please set singular `osApiKey`
+     */
+    osPlacesApiKey: any;
     osProxyEndpoint: string;
     arrowStyle: ArrowStyleEnum;
     labelStyle: LabelStyleEnum;

package/types/components/my-map/drawing.d.ts

@@ -1,10 +1,11 @@
+import { Type } from "ol/geom/Geometry";
 import { Draw, Modify, Snap } from "ol/interaction";
 import { Vector as VectorLayer } from "ol/layer";
 import { Vector as VectorSource } from "ol/source";
-export type DrawTypeEnum = "Polygon" | "Point";
+export type DrawTypeEnum = Extract<Type, "Polygon" | "Point" | "Circle">;
 export type DrawPointerEnum = "crosshair" | "dot";
-export declare const drawingSource: VectorSource<import("ol/Feature").default<import("ol/geom/Geometry").default>>;
-export declare function configureDrawingLayer(drawType: DrawTypeEnum, pointColor: string, drawColor: string, drawFillColor: string): VectorLayer<VectorSource<import("ol/Feature").default<import("ol/geom/Geometry").default>>>;
-export declare function configureDraw(drawType: DrawTypeEnum, pointerStyle: DrawPointerEnum, pointColor: string, drawColor: string, drawFillColor: string): Draw;
+export declare const drawingSource: VectorSource<import("ol/Feature").default<import("ol/geom").Geometry>>;
+export declare function configureDrawingLayer(drawType: DrawTypeEnum, drawColor: string, drawMany: boolean): VectorLayer<VectorSource<import("ol/Feature").default<import("ol/geom").Geometry>>>;
+export declare function configureDraw(drawType: DrawTypeEnum, drawPointer: DrawPointerEnum, drawColor: string): Draw;
 export declare const snap: Snap;
-export declare function configureModify(pointerStyle: DrawPointerEnum, drawColor: string): Modify;
+export declare function configureModify(drawPointer: DrawPointerEnum, drawColor: string): Modify;

package/types/components/my-map/index.d.ts

@@ -1,6 +1,7 @@
 import { LitElement } from "lit";
 import Map from "ol/Map";
 import { DrawPointerEnum, DrawTypeEnum } from "./drawing";
+import { BasemapEnum } from "./layers";
 import { ProjectionEnum } from "./projections";
 import { AreaUnitEnum } from "./utils";
 type MarkerImageEnum = "circle" | "pin";
@@ -8,14 +9,20 @@ type ResetControlImageEnum = "unicode" | "trash";
 export declare class MyMap extends LitElement {
     static styles: import("lit").CSSResult;
     id: string;
+    dataTestId: string;
     latitude: number;
     longitude: number;
+    basemap: BasemapEnum;
     projection: ProjectionEnum;
     zoom: number;
     minZoom: number;
     maxZoom: number;
     drawMode: boolean;
+    drawMany: boolean;
     drawType: DrawTypeEnum;
+    /**
+     * @deprecated - please set `drawColor` regardless of `drawType`
+     */
     drawPointColor: string;
     drawGeojsonData: {
         type: string;
@@ -24,15 +31,20 @@ export declare class MyMap extends LitElement {
     drawGeojsonDataCopyright: string;
     drawGeojsonDataBuffer: number;
     drawPointer: DrawPointerEnum;
-    showFeaturesAtPoint: boolean;
     clickFeatures: boolean;
     drawColor: string;
+    /**
+     * @deprecated - please set `drawColor` and fill will be automatically inferred using 20% opacity
+     */
     drawFillColor: string;
+    showFeaturesAtPoint: boolean;
     featureColor: string;
     featureFill: boolean;
+    /**
+     * @deprecated
+     */
     featureBorderNone: boolean;
     featureBuffer: number;
-    showGeojsonDataMarkers: boolean;
     showCentreMarker: boolean;
     markerImage: MarkerImageEnum;
     markerLatitude: number;
@@ -42,18 +54,37 @@ export declare class MyMap extends LitElement {
         type: string;
         features: never[];
     };
+    showGeojsonDataMarkers: boolean;
     geojsonDataCopyright: string;
     geojsonColor: string;
     geojsonFill: boolean;
     geojsonBuffer: number;
+    /**
+     * @deprecated - please specify `basemap="OSRaster"` directly instead
+     */
     disableVectorTiles: boolean;
-    osVectorTilesApiKey: string;
-    osFeaturesApiKey: string;
+    osApiKey: string;
+    /**
+     * @deprecated - please set singular `osApiKey`
+     */
+    osVectorTilesApiKey: any;
+    /**
+     * @deprecated - please set singular `osApiKey`
+     */
+    osFeaturesApiKey: any;
     osCopyright: string;
     osProxyEndpoint: string;
+    /**
+     * @deprecated - please specify `basemap="MapboxSatellite"` + `mapboxAccessToken` instead
+     */
+    applySatelliteStyle: boolean;
+    mapboxAccessToken: string;
     hideResetControl: boolean;
     resetControlImage: ResetControlImageEnum;
     staticMode: boolean;
+    /**
+     * @deprecated - both `area.squareMetres` & `area.hectares` are calculated by default now in applicable `geojsonChange` events
+     */
     areaUnit: AreaUnitEnum;
     showScale: boolean;
     useScaleBarStyle: boolean;

package/types/components/my-map/layers.d.ts

@@ -0,0 +1,10 @@
+import { Tile as TileLayer } from "ol/layer";
+import VectorTileLayer from "ol/layer/VectorTile";
+import { OSM, XYZ } from "ol/source";
+import VectorLayer from "ol/layer/Vector";
+import VectorSource from "ol/source/Vector";
+export type BasemapEnum = "OSM" | "MapboxSatellite" | "OSRaster" | "OSVectorTile";
+export declare function makeDefaultTileLayer(): TileLayer<OSM>;
+export declare function makeMapboxSatelliteBasemap(): VectorLayer<VectorSource>;
+export declare function makeOSRasterBasemap(apiKey: string, proxyEndpoint: string, copyright: string): TileLayer<XYZ>;
+export declare function makeOsVectorTileBasemap(apiKey: string, proxyEndpoint: string, copyright: string): VectorTileLayer;

package/types/components/my-map/os-features.d.ts

@@ -1,7 +1,7 @@
 import { Vector as VectorLayer } from "ol/layer";
 import { Vector as VectorSource } from "ol/source";
-export declare const outlineSource: VectorSource<import("ol/Feature").default<import("ol/geom/Geometry").default>>;
-export declare function makeFeatureLayer(color: string, featureFill: boolean, borderNone: boolean): VectorLayer<VectorSource<import("ol/Feature").default<import("ol/geom/Geometry").default>>>;
+export declare const outlineSource: VectorSource<import("ol").Feature<import("ol/geom").Geometry>>;
+export declare function makeFeatureLayer(color: string, featureFill: boolean): VectorLayer<VectorSource<import("ol").Feature<import("ol/geom").Geometry>>>;
 /**
  * Create an OGC XML filter parameter value which will select the TopographicArea
  *   features containing the coordinates of the provided point

package/types/components/my-map/utils.d.ts

@@ -7,12 +7,12 @@ import VectorSource from "ol/source/Vector";
 import { ProjectionEnum } from "./projections";
 export type AreaUnitEnum = "m2" | "ha";
 /**
- * Calculate & format the area of a polygon
+ * Calculate the area of a polygon
  * @param polygon
  * @param unit - defaults to square metres ("m2"), or supports "ha" for hectares
- * @returns - the total area formatted with unit as a string
+ * @returns - the total area
  */
-export declare function formatArea(polygon: Geometry, unit: AreaUnitEnum): string | undefined;
+export declare function calculateArea(polygon: Geometry, unit?: AreaUnitEnum): number;
 /**
  * Fit map view to extent of data features, overriding default zoom & center
  * @param olMap - an OpenLayers map

package/types/components/my-map/os-layers.d.ts

@@ -1,5 +0,0 @@
-import { Tile as TileLayer } from "ol/layer";
-import VectorTileLayer from "ol/layer/VectorTile";
-import { OSM } from "ol/source";
-export declare function makeRasterBaseMap(apiKey: string, proxyEndpoint: string, copyright: string, collapseAttributions: boolean): TileLayer<OSM>;
-export declare function makeOsVectorTileBaseMap(apiKey: string, proxyEndpoint: string, copyright: string, collapseAttributions: boolean): VectorTileLayer | undefined;