@opensystemslab/map 0.6.2 → 0.6.3

package/dist/index.html

@@ -43,7 +43,7 @@
     <div style="display:flex;flex-direction:column;">
       <h1 style="color:red;font-family:Inter,Helvetica,sans-serif;font-size:16px;">*** This is a testing sandbox - these components are unaware of each other! ***</h1>
       <div style="margin-bottom:1em">
-        <my-map zoom="20" maxZoom="23" drawMode drawPointer="dot" id="example-map" showScale />
+        <my-map zoom="20" maxZoom="23" drawMode drawPointer="dot" id="example-map" showScale disableVectorTiles osProxyEndpoint="https://api.editor.planx.dev/proxy/ordnance-survey" />
       </div>
       <div style="margin-bottom:1em">
         <postcode-search hintText="Optional hint text shows up here" id="example-postcode" />

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opensystemslab/map",
-  "version": "0.6.2",
+  "version": "0.6.3",
   "license": "OGL-UK-3.0",
   "private": false,
   "repository": {
@@ -42,7 +42,7 @@
     "@testing-library/user-event": "^14.4.3",
     "@types/node": "^18.6.3",
     "@types/proj4": "^2.5.2",
-    "@vitest/ui": "^0.25.5",
+    "@vitest/ui": "^0.26.1",
     "happy-dom": "^8.1.0",
     "husky": "^8.0.1",
     "lint-staged": "^13.0.3",
@@ -51,7 +51,7 @@
     "sass": "^1.44.0",
     "typescript": "^4.3.5",
     "vite": "^4.0.0",
-    "vitest": "0.25.6",
+    "vitest": "0.26.1",
     "wait-for-expect": "^3.0.2"
   },
   "engines": {

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

@@ -11,6 +11,7 @@ export declare class AddressAutocomplete extends LitElement {
     label: string;
     initialAddress: string;
     osPlacesApiKey: string;
+    osProxyEndpoint: string;
     arrowStyle: ArrowStyleEnum;
     labelStyle: LabelStyleEnum;
     private _totalAddresses;

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

@@ -45,6 +45,7 @@ export declare class MyMap extends LitElement {
     osVectorTilesApiKey: string;
     osFeaturesApiKey: string;
     osCopyright: string;
+    osProxyEndpoint: string;
     hideResetControl: boolean;
     resetControlImage: ResetControlImageEnum;
     staticMode: boolean;

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

@@ -7,6 +7,7 @@ export declare function makeFeatureLayer(color: string, featureFill: boolean, bo
  *   features containing the coordinates of the provided point
  * @param coord - xy coordinate
  * @param apiKey - Ordnance Survey Features API key, sign up here: https://osdatahub.os.uk/plans
+ * @param proxyEndpoint - Endpoint to proxy all requests to Ordnance Survey
  * @param supportClickFeatures - whether the featureSource should support `clickFeatures` mode or be cleared upfront
  */
-export declare function getFeaturesAtPoint(coord: Array<number>, apiKey: any, supportClickFeatures: boolean): void;
+export declare function getFeaturesAtPoint(coord: Array<number>, apiKey: any, proxyEndpoint: string, supportClickFeatures: boolean): void;

package/types/components/my-map/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(copyright: string, apiKey?: string): TileLayer<XYZ>;
-export declare function makeOsVectorTileBaseMap(copyright: string, apiKey: string): VectorTileLayer;
+import { OSM } from "ol/source";
+export declare function makeRasterBaseMap(apiKey: string, proxyEndpoint: string, copyright: string): TileLayer<OSM>;
+export declare function makeOsVectorTileBaseMap(apiKey: string, proxyEndpoint: string, copyright: string): VectorTileLayer | undefined;

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

@@ -0,0 +1,10 @@
+import "./index";
+import type { IWindow } from "happy-dom";
+declare global {
+    interface Window extends IWindow {
+    }
+}
+declare global {
+    interface Window extends IWindow {
+    }
+}

package/types/lib/ordnanceSurvey.d.ts

@@ -0,0 +1,19 @@
+declare type OSServices = "xyz" | "vectorTile" | "vectorTileStyle" | "places" | "features";
+interface ServiceOptions {
+    service: OSServices;
+    apiKey: string;
+    proxyEndpoint: string;
+    params?: Record<string, string>;
+}
+export declare function constructURL(domain: string, path: string, params?: Record<string, string>): string;
+export declare function getOSServiceURL({ service, apiKey, params, }: Omit<ServiceOptions, "proxyEndpoint">): string;
+/**
+ * Generate a proxied OS service URL
+ * XXX: OS API key must be appended to requests by the proxy endpoint
+ */
+export declare function getProxyServiceURL({ service, proxyEndpoint, params, }: Omit<ServiceOptions, "apiKey">): string;
+/**
+ * Get either an OS service URL, or a proxied endpoint to an OS service URL
+ */
+export declare function getServiceURL({ service, apiKey, proxyEndpoint, params, }: ServiceOptions): string;
+export {};

package/types/lib/ordnanceSurvey.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/test-utils.d.ts

@@ -1,2 +1,3 @@
 export declare function getShadowRoot(customEl: string): ShadowRoot | null | undefined;
 export declare function getShadowRootEl(customEl: string, el: string): Element | null | undefined;
+export declare function setupMap(mapElement: any): Promise<void>;