@geospatial-sdk/core 0.0.5-alpha.0

package/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2023, Camptocamp
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,11 @@
+# `core`
+
+> TODO: description
+
+## Usage
+
+```
+const core = require('core');
+
+// TODO: DEMONSTRATE API
+```

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./utils";
+export * from "./model";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":"AACA,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC"}

package/dist/index.js

@@ -0,0 +1,3 @@
+// PUBLIC API
+export * from "./utils";
+export * from "./model";

package/dist/model/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./map-context";
+export * from "./map-context-diff";
+//# sourceMappingURL=index.d.ts.map

package/dist/model/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/model/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,oBAAoB,CAAC"}

package/dist/model/index.js

@@ -0,0 +1,2 @@
+export * from "./map-context";
+export * from "./map-context-diff";

package/dist/model/map-context-diff.d.ts

@@ -0,0 +1,35 @@
+import { MapContextLayer, MapContextView } from "./map-context";
+/**
+ * Associates a position to a layer; the position is the index of
+ * the layer in the layers array
+ */
+export interface MapContextLayerPositioned {
+    layer: MapContextLayer;
+    position: number;
+}
+/**
+ * Describes a layer being moved to a different position
+ */
+export interface MapContextLayerReordered {
+    layer: MapContextLayer;
+    newPosition: number;
+    previousPosition: number;
+}
+/**
+ * Describes a delta between two contexts, in order to be
+ * applied to an existing map.
+ *
+ * For positions to be correct the order of operations should be:
+ * 1. remove layers
+ * 2. add layers
+ * 3. move layers
+ * 4. change layers
+ */
+export interface MapContextDiff {
+    layersChanged: MapContextLayerPositioned[];
+    layersReordered: MapContextLayerReordered[];
+    layersRemoved: MapContextLayerPositioned[];
+    layersAdded: MapContextLayerPositioned[];
+    viewChanges: MapContextView;
+}
+//# sourceMappingURL=map-context-diff.d.ts.map

package/dist/model/map-context-diff.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"map-context-diff.d.ts","sourceRoot":"","sources":["../../lib/model/map-context-diff.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAEhE;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,KAAK,EAAE,eAAe,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,eAAe,CAAC;IACvB,WAAW,EAAE,MAAM,CAAC;IACpB,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,cAAc;IAC7B,aAAa,EAAE,yBAAyB,EAAE,CAAC;IAC3C,eAAe,EAAE,wBAAwB,EAAE,CAAC;IAC5C,aAAa,EAAE,yBAAyB,EAAE,CAAC;IAC3C,WAAW,EAAE,yBAAyB,EAAE,CAAC;IACzC,WAAW,EAAE,cAAc,CAAC;CAC7B"}

package/dist/model/map-context-diff.js

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

package/dist/model/map-context.d.ts

@@ -0,0 +1,82 @@
+import { FeatureCollection, Geometry } from "geojson";
+export type LayerDimensions = Record<string, string>;
+export type LayerExtras = Record<string, unknown>;
+export interface MapContextBaseLayer {
+    id?: string | number;
+    version?: number;
+    /**
+     * This property can be used to store anything application-specific on layers; as its content may occasionally
+     * be serialized to JSON for change detection purposes, it is not recommended to store Functions or other
+     * non-serializable entities
+     */
+    extras?: LayerExtras;
+    visibility?: boolean;
+    opacity?: number;
+    label?: string;
+    attributions?: string;
+}
+export interface MapContextLayerWms extends MapContextBaseLayer {
+    type: "wms";
+    url: string;
+    name: string;
+    dimensions?: LayerDimensions;
+    style?: string;
+}
+export interface MapContextLayerWmts extends MapContextBaseLayer {
+    type: "wmts";
+    url: string;
+    name: string;
+    dimensions?: LayerDimensions;
+    style?: string;
+}
+export interface MapContextLayerWfs extends MapContextBaseLayer {
+    type: "wfs";
+    url: string;
+    featureType: string;
+}
+export interface MapContextLayerXyz extends MapContextBaseLayer {
+    type: "xyz";
+    url: string;
+}
+interface LayerGeojson extends MapContextBaseLayer {
+    type: "geojson";
+}
+interface LayerGeojsonWithUrl extends LayerGeojson {
+    url: string;
+    data?: never;
+}
+interface LayerGeojsonWithData extends LayerGeojson {
+    data: FeatureCollection<Geometry | null> | string;
+    url?: never;
+}
+/**
+ * @interface
+ */
+export type MapContextLayerGeojson = LayerGeojsonWithUrl | LayerGeojsonWithData;
+/**
+ * @interface
+ */
+export type MapContextLayer = MapContextLayerWms | MapContextLayerWmts | MapContextLayerWfs | MapContextLayerXyz | MapContextLayerGeojson;
+export type Coordinate = [number, number];
+/**
+ * Min X, min Y, max X, max Y
+ */
+export type Extent = [number, number, number, number];
+/**
+ * @property center Expressed in longitude/latitude
+ * @property extent Expressed in longitude/latitude
+ * @property maxExtent Expressed in longitude/latitude
+ */
+export interface MapContextView {
+    center?: Coordinate;
+    zoom?: number;
+    extent?: Extent;
+    maxZoom?: number;
+    maxExtent?: Extent;
+}
+export interface MapContext {
+    layers: MapContextLayer[];
+    view: MapContextView;
+}
+export {};
+//# sourceMappingURL=map-context.d.ts.map

package/dist/model/map-context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"map-context.d.ts","sourceRoot":"","sources":["../../lib/model/map-context.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAEtD,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAErD,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAElD,MAAM,WAAW,mBAAmB;IAClC,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;IAC7D,IAAI,EAAE,KAAK,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,eAAe,CAAC;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,mBAAoB,SAAQ,mBAAmB;IAC9D,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,eAAe,CAAC;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;IAC7D,IAAI,EAAE,KAAK,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;IAC7D,IAAI,EAAE,KAAK,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACb;AAED,UAAU,YAAa,SAAQ,mBAAmB;IAChD,IAAI,EAAE,SAAS,CAAC;CACjB;AACD,UAAU,mBAAoB,SAAQ,YAAY;IAChD,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,KAAK,CAAC;CACd;AACD,UAAU,oBAAqB,SAAQ,YAAY;IACjD,IAAI,EAAE,iBAAiB,CAAC,QAAQ,GAAG,IAAI,CAAC,GAAG,MAAM,CAAC;IAClD,GAAG,CAAC,EAAE,KAAK,CAAC;CACb;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,mBAAmB,GAAG,oBAAoB,CAAC;AAEhF;;GAEG;AACH,MAAM,MAAM,eAAe,GACvB,kBAAkB,GAClB,mBAAmB,GACnB,kBAAkB,GAClB,kBAAkB,GAClB,sBAAsB,CAAC;AAE3B,MAAM,MAAM,UAAU,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAE1C;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;AAEtD;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,UAAU;IACzB,MAAM,EAAE,eAAe,EAAE,CAAC;IAC1B,IAAI,EAAE,cAAc,CAAC;CACtB"}

package/dist/model/map-context.js

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

package/dist/utils/freeze.d.ts

@@ -0,0 +1,2 @@
+export declare function deepFreeze<U>(obj: U): U;
+//# sourceMappingURL=freeze.d.ts.map

package/dist/utils/freeze.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"freeze.d.ts","sourceRoot":"","sources":["../../lib/utils/freeze.ts"],"names":[],"mappings":"AAAA,wBAAgB,UAAU,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,CAavC"}

package/dist/utils/freeze.js

@@ -0,0 +1,15 @@
+export function deepFreeze(obj) {
+    if (Array.isArray(obj)) {
+        for (const elt of obj) {
+            deepFreeze(elt);
+        }
+        return obj;
+    }
+    else if (obj instanceof Object) {
+        for (const prop in obj) {
+            deepFreeze(obj[prop]);
+        }
+        return Object.freeze(obj);
+    }
+    return obj;
+}

package/dist/utils/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./url";
+export * from "./freeze";
+export { computeMapContextDiff } from "./map-context-diff";
+export { getLayerPosition } from "./map-context";
+//# sourceMappingURL=index.d.ts.map

package/dist/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAC;AACtB,cAAc,UAAU,CAAC;AACzB,OAAO,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC"}

package/dist/utils/index.js

@@ -0,0 +1,4 @@
+export * from "./url";
+export * from "./freeze";
+export { computeMapContextDiff } from "./map-context-diff";
+export { getLayerPosition } from "./map-context";

package/dist/utils/map-context-diff.d.ts

@@ -0,0 +1,22 @@
+import { MapContext, MapContextDiff } from "../model";
+/**
+ * The following logic is produced by identifying layers in both context
+ * and determining whether they have been added, removed, changed or reordered.
+ *
+ * Identifying layers to determine if they have been added/removed/reordered is done like so:
+ * 1. For layers with an `id` property, use non-strict equality on it (e.g. '2' and 2 are equivalent);
+ * 2. For layers without `id`, compute a hash of their base properties _excluding the `extras` property_
+ *
+ * Determining whether layers have changed is done like so:
+ * 1. For layers with an `id` property, the value of the `version` field is compared;
+ *    if values are different (using non-strict equality), then the layer is considered to have changed; otherwise
+ *    it is considered to have remained the same
+ * 2. For layers without `id`, a full hash is computed _including the `extras` property_;
+ *    this means that a layer which only had changes in its `extras` object will not be considered added/removed,
+ *    but only changed
+ *
+ * @param nextContext
+ * @param previousContext
+ */
+export declare function computeMapContextDiff(nextContext: MapContext, previousContext: MapContext): MapContextDiff;
+//# sourceMappingURL=map-context-diff.d.ts.map

package/dist/utils/map-context-diff.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"map-context-diff.d.ts","sourceRoot":"","sources":["../../lib/utils/map-context-diff.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,cAAc,EAKf,MAAM,UAAU,CAAC;AAGlB;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,qBAAqB,CACnC,WAAW,EAAE,UAAU,EACvB,eAAe,EAAE,UAAU,GAC1B,cAAc,CAqEhB"}

package/dist/utils/map-context-diff.js

@@ -0,0 +1,79 @@
+import { isLayerSame, isLayerSameAndUnchanged } from "./map-context";
+/**
+ * The following logic is produced by identifying layers in both context
+ * and determining whether they have been added, removed, changed or reordered.
+ *
+ * Identifying layers to determine if they have been added/removed/reordered is done like so:
+ * 1. For layers with an `id` property, use non-strict equality on it (e.g. '2' and 2 are equivalent);
+ * 2. For layers without `id`, compute a hash of their base properties _excluding the `extras` property_
+ *
+ * Determining whether layers have changed is done like so:
+ * 1. For layers with an `id` property, the value of the `version` field is compared;
+ *    if values are different (using non-strict equality), then the layer is considered to have changed; otherwise
+ *    it is considered to have remained the same
+ * 2. For layers without `id`, a full hash is computed _including the `extras` property_;
+ *    this means that a layer which only had changes in its `extras` object will not be considered added/removed,
+ *    but only changed
+ *
+ * @param nextContext
+ * @param previousContext
+ */
+export function computeMapContextDiff(nextContext, previousContext) {
+    function getLayerPosition(layer, layers) {
+        for (let i = 0; i < layers.length; i++) {
+            if (isLayerSame(layers[i], layer)) {
+                return i;
+            }
+        }
+        return -1;
+    }
+    const layersChanged = [];
+    const layersReordered = [];
+    const layersRemoved = [];
+    const layersAdded = [];
+    const viewChanges = {};
+    // loop on prev context layers (for removed layers)
+    for (let i = 0; i < previousContext.layers.length; i++) {
+        const layer = previousContext.layers[i];
+        const nextPosition = getLayerPosition(layer, nextContext.layers);
+        const prevPosition = getLayerPosition(layer, previousContext.layers);
+        if (nextPosition === -1) {
+            layersRemoved.push({ layer, position: prevPosition });
+        }
+    }
+    // loop on next context layers (for added & updated)
+    for (let i = 0; i < nextContext.layers.length; i++) {
+        const layer = nextContext.layers[i];
+        const prevPosition = getLayerPosition(layer, previousContext.layers);
+        if (prevPosition === -1) {
+            layersAdded.push({ layer, position: i });
+        }
+        else {
+            const prevLayer = previousContext.layers[prevPosition];
+            if (!isLayerSameAndUnchanged(layer, prevLayer)) {
+                layersChanged.push({ layer, position: i });
+            }
+        }
+    }
+    // look for moved layers
+    const prevLayersFiltered = previousContext.layers.filter((l) => !layersRemoved.find(({ layer }) => l === layer));
+    const nextLayersFiltered = nextContext.layers.filter((l) => !layersAdded.find(({ layer }) => l === layer));
+    for (let i = 0; i < nextLayersFiltered.length; i++) {
+        const layer = nextLayersFiltered[i];
+        const prevPosition = getLayerPosition(layer, prevLayersFiltered);
+        if (i !== prevPosition) {
+            layersReordered.push({
+                layer,
+                newPosition: getLayerPosition(layer, nextContext.layers),
+                previousPosition: getLayerPosition(layer, previousContext.layers),
+            });
+        }
+    }
+    return {
+        layersAdded,
+        layersChanged,
+        layersRemoved,
+        layersReordered,
+        viewChanges,
+    };
+}

package/dist/utils/map-context.d.ts

@@ -0,0 +1,6 @@
+import { MapContext, MapContextLayer } from "../model";
+export declare function getLayerHash(layer: MapContextLayer, includeExtras?: boolean): string;
+export declare function isLayerSame(layerA: MapContextLayer, layerB: MapContextLayer): boolean;
+export declare function isLayerSameAndUnchanged(layerA: MapContextLayer, layerB: MapContextLayer): boolean;
+export declare function getLayerPosition(context: MapContext, layerModel: MapContextLayer): number;
+//# sourceMappingURL=map-context.d.ts.map

package/dist/utils/map-context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"map-context.d.ts","sourceRoot":"","sources":["../../lib/utils/map-context.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAEvD,wBAAgB,YAAY,CAC1B,KAAK,EAAE,eAAe,EACtB,aAAa,UAAQ,GACpB,MAAM,CAkBR;AAED,wBAAgB,WAAW,CACzB,MAAM,EAAE,eAAe,EACvB,MAAM,EAAE,eAAe,GACtB,OAAO,CAKT;AAED,wBAAgB,uBAAuB,CACrC,MAAM,EAAE,eAAe,EACvB,MAAM,EAAE,eAAe,GACtB,OAAO,CAKT;AAED,wBAAgB,gBAAgB,CAC9B,OAAO,EAAE,UAAU,EACnB,UAAU,EAAE,eAAe,GAC1B,MAAM,CAER"}

package/dist/utils/map-context.js

@@ -0,0 +1,36 @@
+export function getLayerHash(layer, includeExtras = false) {
+    function getHash(input) {
+        if (input instanceof Object) {
+            const obj = {};
+            const keys = Object.keys(input).sort();
+            for (const key of keys) {
+                if (!includeExtras && key === "extras")
+                    continue;
+                obj[key] = getHash(input[key]);
+            }
+            const hash = JSON.stringify(obj)
+                .split("")
+                .reduce((prev, curr) => (prev << 5) - prev + curr.charCodeAt(0), 0);
+            return (hash >>> 0).toString();
+        }
+        else {
+            return JSON.stringify(input);
+        }
+    }
+    return getHash(layer);
+}
+export function isLayerSame(layerA, layerB) {
+    if ("id" in layerA && "id" in layerB) {
+        return layerA.id == layerB.id;
+    }
+    return getLayerHash(layerA) === getLayerHash(layerB);
+}
+export function isLayerSameAndUnchanged(layerA, layerB) {
+    if ("id" in layerA && "id" in layerB) {
+        return layerA.id == layerB.id && layerA.version == layerB.version;
+    }
+    return getLayerHash(layerA, true) === getLayerHash(layerB, true);
+}
+export function getLayerPosition(context, layerModel) {
+    return context.layers.findIndex((l) => isLayerSame(layerModel, l));
+}

package/dist/utils/url.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Removes the given search params from the URL completely; this is case-insensitive
+ * @param url
+ * @param searchParams
+ */
+export declare function removeSearchParams(url: string, searchParams: string[]): string;
+//# sourceMappingURL=url.d.ts.map

package/dist/utils/url.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"url.d.ts","sourceRoot":"","sources":["../../lib/utils/url.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,wBAAgB,kBAAkB,CAChC,GAAG,EAAE,MAAM,EACX,YAAY,EAAE,MAAM,EAAE,GACrB,MAAM,CAWR"}

package/dist/utils/url.js

@@ -0,0 +1,17 @@
+/**
+ * Removes the given search params from the URL completely; this is case-insensitive
+ * @param url
+ * @param searchParams
+ */
+export function removeSearchParams(url, searchParams) {
+    const toDelete = [];
+    const urlObj = new URL(url, window.location.toString());
+    const keysLower = searchParams.map((p) => p.toLowerCase());
+    for (const param of urlObj.searchParams.keys()) {
+        if (keysLower.indexOf(param.toLowerCase()) > -1) {
+            toDelete.push(param);
+        }
+    }
+    toDelete.map((param) => urlObj.searchParams.delete(param));
+    return urlObj.toString();
+}

package/lib/index.ts

@@ -0,0 +1,3 @@
+// PUBLIC API
+export * from "./utils";
+export * from "./model";

package/lib/model/index.ts

@@ -0,0 +1,2 @@
+export * from "./map-context";
+export * from "./map-context-diff";

package/lib/model/map-context-diff.ts

@@ -0,0 +1,37 @@
+import { MapContextLayer, MapContextView } from "./map-context";
+
+/**
+ * Associates a position to a layer; the position is the index of
+ * the layer in the layers array
+ */
+export interface MapContextLayerPositioned {
+  layer: MapContextLayer;
+  position: number;
+}
+
+/**
+ * Describes a layer being moved to a different position
+ */
+export interface MapContextLayerReordered {
+  layer: MapContextLayer;
+  newPosition: number;
+  previousPosition: number;
+}
+
+/**
+ * Describes a delta between two contexts, in order to be
+ * applied to an existing map.
+ *
+ * For positions to be correct the order of operations should be:
+ * 1. remove layers
+ * 2. add layers
+ * 3. move layers
+ * 4. change layers
+ */
+export interface MapContextDiff {
+  layersChanged: MapContextLayerPositioned[];
+  layersReordered: MapContextLayerReordered[];
+  layersRemoved: MapContextLayerPositioned[];
+  layersAdded: MapContextLayerPositioned[];
+  viewChanges: MapContextView;
+}

package/lib/model/map-context.ts

@@ -0,0 +1,100 @@
+import { FeatureCollection, Geometry } from "geojson";
+
+export type LayerDimensions = Record<string, string>;
+
+export type LayerExtras = Record<string, unknown>;
+
+export interface MapContextBaseLayer {
+  id?: string | number;
+  version?: number;
+
+  /**
+   * This property can be used to store anything application-specific on layers; as its content may occasionally
+   * be serialized to JSON for change detection purposes, it is not recommended to store Functions or other
+   * non-serializable entities
+   */
+  extras?: LayerExtras;
+  visibility?: boolean;
+  opacity?: number;
+  label?: string;
+  attributions?: string;
+}
+
+export interface MapContextLayerWms extends MapContextBaseLayer {
+  type: "wms";
+  url: string;
+  name: string;
+  dimensions?: LayerDimensions;
+  style?: string;
+}
+
+export interface MapContextLayerWmts extends MapContextBaseLayer {
+  type: "wmts";
+  url: string;
+  name: string;
+  dimensions?: LayerDimensions;
+  style?: string;
+}
+
+export interface MapContextLayerWfs extends MapContextBaseLayer {
+  type: "wfs";
+  url: string;
+  featureType: string;
+}
+
+export interface MapContextLayerXyz extends MapContextBaseLayer {
+  type: "xyz";
+  url: string;
+}
+
+interface LayerGeojson extends MapContextBaseLayer {
+  type: "geojson";
+}
+interface LayerGeojsonWithUrl extends LayerGeojson {
+  url: string;
+  data?: never;
+}
+interface LayerGeojsonWithData extends LayerGeojson {
+  data: FeatureCollection<Geometry | null> | string;
+  url?: never;
+}
+
+/**
+ * @interface
+ */
+export type MapContextLayerGeojson = LayerGeojsonWithUrl | LayerGeojsonWithData;
+
+/**
+ * @interface
+ */
+export type MapContextLayer =
+  | MapContextLayerWms
+  | MapContextLayerWmts
+  | MapContextLayerWfs
+  | MapContextLayerXyz
+  | MapContextLayerGeojson;
+
+export type Coordinate = [number, number];
+
+/**
+ * Min X, min Y, max X, max Y
+ */
+export type Extent = [number, number, number, number];
+
+/**
+ * @property center Expressed in longitude/latitude
+ * @property extent Expressed in longitude/latitude
+ * @property maxExtent Expressed in longitude/latitude
+ */
+export interface MapContextView {
+  center?: Coordinate;
+  zoom?: number;
+  extent?: Extent;
+  maxZoom?: number;
+  maxExtent?: Extent;
+}
+
+export interface MapContext {
+  layers: MapContextLayer[];
+  view: MapContextView;
+}

package/lib/utils/freeze.test.ts

@@ -0,0 +1,52 @@
+import { deepFreeze } from "./freeze";
+
+describe("freeze util", () => {
+  describe("deepFreeze", () => {
+    let obj: any;
+    beforeEach(() => {
+      obj = deepFreeze({
+        ab: "cde",
+        fg: {
+          h: true,
+          ij: 12,
+        },
+        k: [
+          {
+            l: 456,
+            mn: ["opqr"],
+          },
+        ],
+      });
+    });
+    it("prevents mutation of root properties", () => {
+      expect(() => {
+        obj.ab = "AA";
+      }).toThrow();
+    });
+    it("prevents mutation of nested properties", () => {
+      expect(() => {
+        obj.fg.h = "AA";
+      }).toThrow();
+    });
+    it("prevents mutation of objects inside nested arrays", () => {
+      expect(() => {
+        obj.k[0].l = "AA";
+      }).toThrow();
+    });
+    describe("starting with array", () => {
+      beforeEach(() => {
+        obj = deepFreeze([
+          {
+            l: 456,
+            mn: ["opqr"],
+          },
+        ]);
+      });
+      it("prevents mutation of nested objects", () => {
+        expect(() => {
+          obj[0].l = "AA";
+        }).toThrow();
+      });
+    });
+  });
+});

package/lib/utils/freeze.ts

@@ -0,0 +1,14 @@
+export function deepFreeze<U>(obj: U): U {
+  if (Array.isArray(obj)) {
+    for (const elt of obj) {
+      deepFreeze(elt);
+    }
+    return obj;
+  } else if (obj instanceof Object) {
+    for (const prop in obj) {
+      deepFreeze((obj as Record<string, unknown>)[prop]);
+    }
+    return Object.freeze(obj);
+  }
+  return obj;
+}

package/lib/utils/index.ts

@@ -0,0 +1,4 @@
+export * from "./url";
+export * from "./freeze";
+export { computeMapContextDiff } from "./map-context-diff";
+export { getLayerPosition } from "./map-context";