@opensystemslab/map 0.6.2 → 0.7.0

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/components/my-map/utils.d.ts

@@ -1,6 +1,10 @@
+import { GeoJSONObject } from "ol/format/GeoJSON";
 import Geometry from "ol/geom/Geometry";
+import { Feature } from "ol/index";
 import Map from "ol/Map";
 import { Vector } from "ol/source";
+import VectorSource from "ol/source/Vector";
+import { ProjectionEnum } from "./projections";
 export declare type AreaUnitEnum = "m2" | "ha";
 /**
  * Calculate & format the area of a polygon
@@ -24,3 +28,10 @@ export declare function fitToData(olMap: Map, olSource: Vector<Geometry>, buffer
  * @returns - a 'rgba(r,g,b,a)' string
  */
 export declare function hexToRgba(hexColor: string, alpha: number): string;
+/**
+ * Generate a geojson object from a vector source or an array of features
+ * @param source
+ * @param projection
+ * @returns
+ */
+export declare function makeGeoJSON(source: VectorSource<Geometry> | Feature<Geometry>[], projection: ProjectionEnum): GeoJSONObject;

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>;