@opensystemslab/map 0.3.5 → 0.4.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opensystemslab/map",
-  "version": "0.3.5",
+  "version": "0.4.1",
   "license": "OGL-UK-3.0",
   "private": false,
   "repository": {
@@ -18,7 +18,8 @@
   "scripts": {
     "dev": "vite",
     "build": "tsc && vite build && sed 's/src=\".*\"/src=\"map.es.js\"/' index.html > dist/index.html",
-    "prepublishOnly": "rm -rf dist types && npm run build"
+    "prepublishOnly": "rm -rf dist types && npm run build",
+    "prepare": "husky install"
   },
   "dependencies": {
     "@turf/union": "^6.5.0",
@@ -30,7 +31,7 @@
   "devDependencies": {
     "@types/node": "^16.4.13",
     "husky": "^7.0.1",
-    "lint-staged": "^11.1.2",
+    "lint-staged": "^12.0.3",
     "prettier": "^2.3.2",
     "typescript": "^4.3.5",
     "vite": "^2.4.4"

package/types/{draw.d.ts → drawing.d.ts}

@@ -1,8 +1,9 @@
 import { Draw, Modify, Snap } from "ol/interaction";
 import { Vector as VectorLayer } from "ol/layer";
 import { Vector as VectorSource } from "ol/source";
+export declare type DrawPointerEnum = "crosshair" | "dot";
 export declare const drawingSource: VectorSource<import("ol/geom/Geometry").default>;
 export declare const drawingLayer: VectorLayer<VectorSource<import("ol/geom/Geometry").default>>;
-export declare const draw: Draw;
+export declare function configureDraw(pointerStyle: DrawPointerEnum): Draw;
 export declare const snap: Snap;
-export declare const modify: Modify;
+export declare function configureModify(pointerStyle: DrawPointerEnum): Modify;

package/types/my-map.d.ts

@@ -1,4 +1,5 @@
 import { LitElement } from "lit";
+import { DrawPointerEnum } from "./drawing";
 import { AreaUnitEnum } from "./utils";
 export declare class MyMap extends LitElement {
     static styles: import("lit").CSSResultGroup;
@@ -13,6 +14,7 @@ export declare class MyMap extends LitElement {
         geometry: {};
     };
     drawGeojsonDataBuffer: number;
+    drawPointer: DrawPointerEnum;
     showFeaturesAtPoint: boolean;
     clickFeatures: boolean;
     featureColor: string;
@@ -28,10 +30,10 @@ export declare class MyMap extends LitElement {
     disableVectorTiles: boolean;
     osVectorTilesApiKey: string;
     osFeaturesApiKey: string;
+    osCopyright: string;
     hideResetControl: boolean;
     staticMode: boolean;
     areaUnit: AreaUnitEnum;
-    ariaLabel: string;
     showScale: boolean;
     useScaleBarStyle: boolean;
     firstUpdated(): void;

package/types/os-layers.d.ts

@@ -1,5 +1,5 @@
 import { Tile as TileLayer } from "ol/layer";
 import VectorTileLayer from "ol/layer/VectorTile";
 import { XYZ } from "ol/source";
-export declare function makeRasterBaseMap(apiKey?: string): TileLayer<XYZ>;
-export declare function makeOsVectorTileBaseMap(apiKey: string): VectorTileLayer;
+export declare function makeRasterBaseMap(copyright: string, apiKey?: string): TileLayer<XYZ>;
+export declare function makeOsVectorTileBaseMap(copyright: string, apiKey: string): VectorTileLayer;

package/types/snapping.d.ts

@@ -0,0 +1,12 @@
+import { Vector as VectorLayer } from "ol/layer";
+import VectorTileLayer from "ol/layer/VectorTile";
+import VectorSource from "ol/source/Vector";
+export declare const pointsSource: VectorSource<import("ol/geom/Geometry").default>;
+export declare const pointsLayer: VectorLayer<VectorSource<import("ol/geom/Geometry").default>>;
+/**
+ * Extract points that are available to snap to when a VectorTileLayer basemap is displayed
+ * @param basemap - a VectorTileLayer
+ * @param extent - an array of 4 points
+ * @returns - a VectorSource populated with points within the extent
+ */
+export declare function getSnapPointsFromVectorTiles(basemap: VectorTileLayer, extent: number[]): void;