@defra/forms-engine-plugin 4.0.40 → 4.0.42

package/.server/client/javascripts/location-map.d.ts

@@ -0,0 +1,93 @@
+/**
+ * Make a form submit handler that only allows submissions from allowed buttons
+ * @param {HTMLButtonElement[]} buttons - the form buttons to allow submissions
+ */
+export function formSubmitFactory(buttons: HTMLButtonElement[]): (e: SubmitEvent) => void;
+/**
+ * Initialise location maps
+ * @param {Partial<MapsEnvironmentConfig>} config - the map configuration
+ */
+export function initMaps(config?: Partial<MapsEnvironmentConfig>): void;
+/**
+ * OS API request proxy factory
+ * @param {string} apiPath - the root API path
+ */
+export function makeTileRequestTransformer(apiPath: string): (url: string, resourceType: string) => {
+    url: string;
+    headers: {};
+};
+/**
+ * - an instance of a InteractiveMap
+ */
+export type InteractiveMap = {
+    /**
+     * - register callback listeners to map events
+     */
+    on: Function;
+    /**
+     * - adds a new panel to the map
+     */
+    addPanel: Function;
+    /**
+     * - adds/updates a marker
+     */
+    addMarker: Function;
+};
+export type MapLibreMap = {
+    /**
+     * - pans/zooms to a new location
+     */
+    flyTo: Function;
+};
+/**
+ * - Map center point as [long, lat]
+ */
+export type MapCenter = [number, number];
+/**
+ * - additional config that can be provided to InteractiveMap
+ */
+export type InteractiveMapInitConfig = {
+    /**
+     * - the zoom level of the map
+     */
+    zoom: string;
+    /**
+     * - the center point of the map
+     */
+    center: MapCenter;
+    /**
+     * - the markers to add to the map
+     */
+    markers?: {
+        id: string;
+        coords: MapCenter;
+    }[] | undefined;
+};
+export type TileData = {
+    /**
+     * - the outdoor tile URL
+     */
+    VTS_OUTDOOR_URL: string;
+    /**
+     * - the dark tile URL
+     */
+    VTS_DARK_URL: string;
+    /**
+     * - the black and white tile URL
+     */
+    VTS_BLACK_AND_WHITE_URL: string;
+};
+export type MapsEnvironmentConfig = {
+    /**
+     * - the root asset path
+     */
+    assetPath: string;
+    /**
+     * - the root API path
+     */
+    apiPath: string;
+    /**
+     * - the tile data config
+     */
+    data: TileData;
+};