@geospatial-sdk/core 0.0.5-alpha.9 → 0.0.5-dev.0.sha-bfaf14b

package/README.md

@@ -1,11 +1,44 @@
-# `core`
+# `@geospatial-sdk/core`
 
-> TODO: description
+<!-- #region body -->
 
-## Usage
+This package provides the foundation for the Geospatial SDK.
+
+It includes:
+
+- **Map Context model**: TypeScript types and interfaces for declaratively defining maps, layers, and views
+- **Diff algorithms**: Utilities to compute differences between Map Context objects (`computeMapContextDiff`)
+- **Validation utilities**: Tools for working with and validating geospatial data
+- **Shared constants**: Common definitions used across all packages
+
+The `@geospatial-sdk/core` package is framework-agnostic and does not depend on any specific mapping library. It's required by all other packages in the SDK.
 
+## Installation
+
+```sh
+npm install @geospatial-sdk/core
 ```
-const core = require('core');
 
-// TODO: DEMONSTRATE API
+## Usage
+
+```typescript
+import { computeMapContextDiff, type MapContext } from "@geospatial-sdk/core";
+
+const oldContext: MapContext = {
+  layers: [{ type: "xyz", url: "https://example.com/{z}/{x}/{y}.png" }],
+  view: { center: [0, 0], zoom: 2 },
+};
+
+const newContext: MapContext = {
+  layers: [{ type: "xyz", url: "https://example.com/{z}/{x}/{y}.png" }],
+  view: { center: [5, 45], zoom: 5 },
+};
+
+const diff = computeMapContextDiff(newContext, oldContext);
 ```
+
+<!-- #endregion body -->
+
+## Documentation
+
+For more detailed API documentation, see the [documentation website](https://camptocamp.github.io/geospatial-sdk/docs/).

package/dist/constant/projections.d.ts

@@ -0,0 +1,2 @@
+export declare const LONLAT_CRS_CODES: string[];
+//# sourceMappingURL=projections.d.ts.map

package/dist/constant/projections.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"projections.d.ts","sourceRoot":"","sources":["../../lib/constant/projections.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,gBAAgB,UAA0B,CAAC"}

package/dist/constant/projections.js

@@ -0,0 +1 @@
+export const LONLAT_CRS_CODES = ["EPSG:4326", "CRS:84"];

package/dist/index.d.ts

@@ -1,3 +1,8 @@
-export * from "./utils";
-export * from "./model";
+/**
+ * {@include ../README.md#body}
+ *
+ * @module 📦 core
+ */
+export * from "./utils/index.js";
+export * from "./model/index.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

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

package/dist/index.js

@@ -1,3 +1,7 @@
-// PUBLIC API
-export * from "./utils";
-export * from "./model";
+/**
+ * {@include ../README.md#body}
+ *
+ * @module 📦 core
+ */
+export * from "./utils/index.js";
+export * from "./model/index.js";

package/dist/model/events.d.ts

@@ -0,0 +1,86 @@
+import { EndpointError } from "@camptocamp/ogc-client";
+import { Feature } from "geojson";
+import BaseEvent from "ol/events/Event.js";
+import type { Extent } from "ol/extent.js";
+import { ResolvedMapLayerState, ResolvedMapState, ResolvedMapViewState } from "./resolved-map-state.js";
+export type FeaturesByLayerIndex = Map<number, Feature[]>;
+export declare const FeaturesClickEventType = "features-click";
+export interface FeaturesClickEvent {
+    type: typeof FeaturesClickEventType;
+    features: Feature[];
+    featuresByLayer: FeaturesByLayerIndex;
+}
+export declare const FeaturesHoverEventType = "features-hover";
+export interface FeaturesHoverEvent {
+    type: typeof FeaturesHoverEventType;
+    features: Feature[];
+    featuresByLayer: FeaturesByLayerIndex;
+}
+export declare const MapClickEventType = "map-click";
+export interface MapClickEvent {
+    type: typeof MapClickEventType;
+    coordinate: [number, number];
+}
+export declare const MapViewStateChangeEventType = "map-view-state-change";
+export interface MapViewStateChangeEvent {
+    type: typeof MapViewStateChangeEventType;
+    viewState: ResolvedMapViewState;
+}
+export declare const MapLayerStateChangeEventType = "map-layer-state-change";
+export interface MapLayerStateChangeEvent {
+    type: typeof MapLayerStateChangeEventType;
+    layerState: ResolvedMapLayerState;
+    layerIndex: number;
+    layerId?: string | number;
+}
+export declare const MapStateChangeEventType = "map-state-change";
+export interface MapStateChangeEvent {
+    type: typeof MapStateChangeEventType;
+    mapState: ResolvedMapState;
+}
+export declare const LayerCreationErrorEventType = "layer-creation-error";
+export interface LayerCreationErrorEvent {
+    type: typeof LayerCreationErrorEventType;
+    error: Error;
+}
+export declare const LayerLoadingErrorEventType = "layer-loading-error";
+export interface LayerLoadingErrorEvent {
+    type: typeof LayerLoadingErrorEventType;
+    error: Error;
+    httpStatus?: number;
+}
+/**
+ * DEPRECATED
+ * Use the MapViewStateChangeEvent instead
+ */
+export declare const MapExtentChangeEventType = "map-extent-change";
+export interface MapExtentChangeEvent {
+    type: typeof MapExtentChangeEventType;
+    extent: Extent;
+}
+/**
+ * DEPRECATED
+ * Use the MapLayerStateChangeEvent and LayerLoadingErrorEvent instead
+ */
+export declare const SourceLoadErrorType = "source-load-error";
+export declare class SourceLoadErrorEvent extends BaseEvent {
+    message: string;
+    httpStatus?: number;
+    constructor(error: EndpointError | Error | Response);
+}
+export interface MapEventsByType {
+    [FeaturesClickEventType]: FeaturesClickEvent;
+    [FeaturesHoverEventType]: FeaturesHoverEvent;
+    [MapClickEventType]: MapClickEvent;
+    [MapViewStateChangeEventType]: MapViewStateChangeEvent;
+    [MapLayerStateChangeEventType]: MapLayerStateChangeEvent;
+    [MapStateChangeEventType]: MapStateChangeEvent;
+    [LayerCreationErrorEventType]: LayerCreationErrorEvent;
+    [LayerLoadingErrorEventType]: LayerLoadingErrorEvent;
+    /**
+     * DEPRECATED
+     */
+    [MapExtentChangeEventType]: MapExtentChangeEvent;
+    [SourceLoadErrorType]: SourceLoadErrorEvent;
+}
+//# sourceMappingURL=events.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../lib/model/events.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,SAAS,MAAM,oBAAoB,CAAC;AAC3C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EACL,qBAAqB,EACrB,gBAAgB,EAChB,oBAAoB,EACrB,MAAM,yBAAyB,CAAC;AAEjC,MAAM,MAAM,oBAAoB,GAAG,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;AAE1D,eAAO,MAAM,sBAAsB,mBAAmB,CAAC;AACvD,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,OAAO,sBAAsB,CAAC;IACpC,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,eAAe,EAAE,oBAAoB,CAAC;CACvC;AAED,eAAO,MAAM,sBAAsB,mBAAmB,CAAC;AACvD,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,OAAO,sBAAsB,CAAC;IACpC,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,eAAe,EAAE,oBAAoB,CAAC;CACvC;AAED,eAAO,MAAM,iBAAiB,cAAc,CAAC;AAC7C,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,OAAO,iBAAiB,CAAC;IAC/B,UAAU,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC9B;AAED,eAAO,MAAM,2BAA2B,0BAA0B,CAAC;AACnE,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,OAAO,2BAA2B,CAAC;IACzC,SAAS,EAAE,oBAAoB,CAAC;CACjC;AAED,eAAO,MAAM,4BAA4B,2BAA2B,CAAC;AACrE,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,OAAO,4BAA4B,CAAC;IAC1C,UAAU,EAAE,qBAAqB,CAAC;IAClC,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CAC3B;AAED,eAAO,MAAM,uBAAuB,qBAAqB,CAAC;AAC1D,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,OAAO,uBAAuB,CAAC;IACrC,QAAQ,EAAE,gBAAgB,CAAC;CAC5B;AAED,eAAO,MAAM,2BAA2B,yBAAyB,CAAC;AAClE,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,OAAO,2BAA2B,CAAC;IACzC,KAAK,EAAE,KAAK,CAAC;CACd;AAED,eAAO,MAAM,0BAA0B,wBAAwB,CAAC;AAChE,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,OAAO,0BAA0B,CAAC;IACxC,KAAK,EAAE,KAAK,CAAC;IACb,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,eAAO,MAAM,wBAAwB,sBAAsB,CAAC;AAC5D,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,OAAO,wBAAwB,CAAC;IACtC,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,eAAO,MAAM,mBAAmB,sBAAsB,CAAC;AACvD,qBAAa,oBAAqB,SAAQ,SAAS;IACjD,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;gBACR,KAAK,EAAE,aAAa,GAAG,KAAK,GAAG,QAAQ;CAapD;AAED,MAAM,WAAW,eAAe;IAC9B,CAAC,sBAAsB,CAAC,EAAE,kBAAkB,CAAC;IAC7C,CAAC,sBAAsB,CAAC,EAAE,kBAAkB,CAAC;IAC7C,CAAC,iBAAiB,CAAC,EAAE,aAAa,CAAC;IACnC,CAAC,2BAA2B,CAAC,EAAE,uBAAuB,CAAC;IACvD,CAAC,4BAA4B,CAAC,EAAE,wBAAwB,CAAC;IACzD,CAAC,uBAAuB,CAAC,EAAE,mBAAmB,CAAC;IAC/C,CAAC,2BAA2B,CAAC,EAAE,uBAAuB,CAAC;IACvD,CAAC,0BAA0B,CAAC,EAAE,sBAAsB,CAAC;IACrD;;OAEG;IACH,CAAC,wBAAwB,CAAC,EAAE,oBAAoB,CAAC;IACjD,CAAC,mBAAmB,CAAC,EAAE,oBAAoB,CAAC;CAC7C"}

package/dist/model/events.js

@@ -0,0 +1,37 @@
+import { EndpointError } from "@camptocamp/ogc-client";
+import BaseEvent from "ol/events/Event.js";
+export const FeaturesClickEventType = "features-click";
+export const FeaturesHoverEventType = "features-hover";
+export const MapClickEventType = "map-click";
+export const MapViewStateChangeEventType = "map-view-state-change";
+export const MapLayerStateChangeEventType = "map-layer-state-change";
+export const MapStateChangeEventType = "map-state-change";
+export const LayerCreationErrorEventType = "layer-creation-error";
+export const LayerLoadingErrorEventType = "layer-loading-error";
+/**
+ * DEPRECATED
+ * Use the MapViewStateChangeEvent instead
+ */
+export const MapExtentChangeEventType = "map-extent-change";
+/**
+ * DEPRECATED
+ * Use the MapLayerStateChangeEvent and LayerLoadingErrorEvent instead
+ */
+export const SourceLoadErrorType = "source-load-error";
+export class SourceLoadErrorEvent extends BaseEvent {
+    constructor(error) {
+        super(SourceLoadErrorType);
+        if (error instanceof Response) {
+            this.message = error.statusText;
+            this.httpStatus = error.status;
+        }
+        else if (error instanceof EndpointError) {
+            const e = error;
+            this.message = e.message;
+            this.httpStatus = e.httpStatus;
+        }
+        else {
+            this.message = error.message;
+        }
+    }
+}

package/dist/model/index.d.ts

@@ -1,3 +1,10 @@
-export * from "./map-context";
-export * from "./map-context-diff";
+/**
+ * @group Types
+ * @packageDocumentation
+ */
+export * from "./map-context.js";
+export * from "./map-context-diff.js";
+export * from "./events.js";
+export * from "./resolved-map-state.js";
+export * from "./style.js";
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/model/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,oBAAoB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/model/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,kBAAkB,CAAC;AACjC,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,cAAc,yBAAyB,CAAC;AACxC,cAAc,YAAY,CAAC"}

package/dist/model/index.js

@@ -1,2 +1,9 @@
-export * from "./map-context";
-export * from "./map-context-diff";
+/**
+ * @group Types
+ * @packageDocumentation
+ */
+export * from "./map-context.js";
+export * from "./map-context-diff.js";
+export * from "./events.js";
+export * from "./resolved-map-state.js";
+export * from "./style.js";

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

@@ -1,4 +1,4 @@
-import { MapContextLayer, MapContextView } from "./map-context";
+import { MapContextLayer, MapContextView } from "./map-context.js";
 /**
  * Associates a position to a layer; the position is the index of
  * the layer in the layers array
@@ -15,6 +15,14 @@ export interface MapContextLayerReordered {
     newPosition: number;
     previousPosition: number;
 }
+/**
+ * Describes a layer that was changed: both states before and after change are included
+ */
+export interface MapContextLayerChanged {
+    layer: MapContextLayer;
+    previousLayer: MapContextLayer;
+    position: number;
+}
 /**
  * Describes a delta between two contexts, in order to be
  * applied to an existing map.
@@ -26,10 +34,10 @@ export interface MapContextLayerReordered {
  * 4. change layers
  */
 export interface MapContextDiff {
-    layersChanged: MapContextLayerPositioned[];
+    layersChanged: MapContextLayerChanged[];
     layersReordered: MapContextLayerReordered[];
     layersRemoved: MapContextLayerPositioned[];
     layersAdded: MapContextLayerPositioned[];
-    viewChanges: MapContextView;
+    viewChanges?: MapContextView | null;
 }
 //# sourceMappingURL=map-context-diff.d.ts.map

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

@@ -1 +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"}
+{"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,kBAAkB,CAAC;AAEnE;;;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;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,eAAe,CAAC;IACvB,aAAa,EAAE,eAAe,CAAC;IAC/B,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,cAAc;IAC7B,aAAa,EAAE,sBAAsB,EAAE,CAAC;IACxC,eAAe,EAAE,wBAAwB,EAAE,CAAC;IAC5C,aAAa,EAAE,yBAAyB,EAAE,CAAC;IAC3C,WAAW,EAAE,yBAAyB,EAAE,CAAC;IACzC,WAAW,CAAC,EAAE,cAAc,GAAG,IAAI,CAAC;CACrC"}

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

@@ -1,8 +1,19 @@
 import { FeatureCollection, Geometry } from "geojson";
-export type LayerDimensions = Record<string, string>;
+import { VectorStyle } from "./style.js";
+import { WmsLayerDimensionValue } from "@camptocamp/ogc-client";
+/**
+ * @private
+ * @inline
+ */
 export type LayerExtras = Record<string, unknown>;
 export interface MapContextBaseLayer {
+    /**
+     * An optional identifier for the layer; if provided, will improve performance when the layers is updated through a context diff.
+     */
     id?: string | number;
+    /**
+     * Optional version indicator; if provided, must be increased by the application for the change detection to trigger, otherwise the SDK will consider that the layer is unchanged.
+     */
     version?: number;
     /**
      * This property can be used to store anything application-specific on layers; as its content may occasionally
@@ -10,73 +21,214 @@ export interface MapContextBaseLayer {
      * non-serializable entities
      */
     extras?: LayerExtras;
+    /**
+     * Whether the layer is visible or not on the map. A non-visible layer will still have its data queried and kept in memory, so switching this on/off shows immediately on the map.
+     *
+     * Default value is `true` (visible).
+     */
     visibility?: boolean;
+    /**
+     * Opacity level; between 0 and 1.
+     *
+     * Default value is 1 (fully opaque).
+     */
     opacity?: number;
+    /**
+     * Optional label for the layer, typically used to represent the layer in a layer list or when showing a popup above a feature.
+     */
     label?: string;
+    /**
+     * Attributions for the layer. Optional but strongly recommended: remember to attribute your map!
+     */
     attributions?: string;
+    /**
+     * Whether data on the layer can be picked up using the `feature-click` event.
+     *
+     * Default value is `true`. Set to `false` to save performance.
+     */
+    clickable?: boolean;
+    /**
+     * Whether features on the layer can be picked up using the `feature-hover` event. Mostly has an effect only for vector layers.
+     *
+     * Default value is `false`.
+     */
+    hoverable?: boolean;
+    /**
+     * Controls the `Referer` header sent with tile/image requests.
+     * See the [MDN documentation](https://developer.mozilla.org/en-US/docs/Web/API/Request/referrerPolicy) for possible values.
+     *
+     * Support depends on the layer type and the map library used.
+     */
+    referrerPolicy?: ReferrerPolicy;
+}
+/**
+ * Dates are expressed as ISO8601 strings, e.g. "2023-01-01T00:00:00Z" or "2023-01-01"
+ */
+export type DateString = string;
+export interface TimeInterval {
+    begin: DateString;
+    end: DateString;
+}
+export interface ValueInterval {
+    begin: WmsLayerDimensionValue;
+    end: WmsLayerDimensionValue;
 }
+export type LayerDimensionValue = WmsLayerDimensionValue | WmsLayerDimensionValue[] | ValueInterval;
+export type LayerTimeDimensionValue = DateString | DateString[] | TimeInterval | "current";
 export interface MapContextLayerWms extends MapContextBaseLayer {
     type: "wms";
     url: string;
     name: string;
-    dimensions?: LayerDimensions;
+    /**
+     * value of the built-in TIME dimension to request; can be a single date, a list of dates, a temporal interval, or a list of intervals
+     */
+    timeValue?: LayerTimeDimensionValue;
+    /**
+     * value of the built-in ELEVATION dimension to request; can be a single value, a list of discrete values, an interval, or a list of intervals
+     */
+    elevationValue?: LayerDimensionValue;
+    /**
+     * value of any other dimension to request (either scalar or temporal); key is the dimension name, it will be prefixed by DIM_ in the request
+     */
+    otherDimensionValues?: Record<string, LayerDimensionValue | LayerTimeDimensionValue>;
+    /**
+     * If unspecified, will use the default one
+     */
     style?: string;
+    /**
+     * Vendor-specific WMS parameters that are appended as-is to every GetMap request.
+     * Use this for non-standard server extensions such as NcWMS (`COLORSCALERANGE`, `LOGSCALE`).
+     * Keys are case-sensitive; they are passed without transformation.
+     */
+    customParams?: Record<string, string>;
+    /**
+     * Whether to use tiled WMS requests. Tiled requests include a `TILED=true` parameter as per https://wiki.osgeo.org/wiki/WMS_Tiling_Client_Recommendation
+     *
+     * Using tiled requests allow tiles to be cached and thus the server load to potentially be reduced; on the other hand,
+     * it can increase the time to show the layer and degrade the quality of the rendering (e.g. with labels).
+     *
+     * Note: untiled requests are not supported by MapLibre-GL-JS
+     *
+     * Default value: `true` (use tiled requests)
+     */
+    useTiles?: boolean;
+    /**
+     * The image format MIME type to use for WMS requests, e.g. `"image/png"` or `"image/jpeg"`.
+     *
+     * If not specified, the WMS server's default format will be used.
+     */
+    format?: string;
+    /**
+     * An OGC encoded filter (e.g. an OGC `<Filter>` document) applied verbatim to the WMS
+     * GetMap `FILTER` parameter. Use it to restrict the features rendered by the layer.
+     *
+     * The value is passed through as-is; the SDK does not validate or transform it.
+     */
+    filter?: string;
 }
+/**
+ * @private
+ * @inline
+ */
+export type LayerDimensionSimpleValue = string | number | DateString | "current";
 export interface MapContextLayerWmts extends MapContextBaseLayer {
     type: "wmts";
     url: string;
     name: string;
-    dimensions?: LayerDimensions;
+    dimensionValues?: Record<string, LayerDimensionSimpleValue>;
     style?: string;
 }
-export interface MapContextLayerWfs extends MapContextBaseLayer {
+export interface MapContextLayerVector {
+    style?: VectorStyle;
+    hoverStyle?: VectorStyle;
+}
+export type MapContextLayerWfs = MapContextBaseLayer & MapContextLayerVector & {
     type: "wfs";
     url: string;
     featureType: string;
+};
+export type MapContextLayerOgcApi = MapContextBaseLayer & MapContextLayerVector & {
+    type: "ogcapi";
+    url: string;
+    collection: string;
+    useTiles?: "vector" | "map";
+    tileMatrixSet?: string;
+    options?: Record<string, string>;
+};
+export interface MapContextLayerMapLibreStyle extends MapContextBaseLayer {
+    type: "maplibre-style";
+    styleUrl: string;
+    accessToken?: string;
+}
+export interface MapContextLayerGeotiff extends MapContextBaseLayer {
+    type: "geotiff";
+    url: string;
 }
 export interface MapContextLayerXyz extends MapContextBaseLayer {
     type: "xyz";
     url: string;
+    tileFormat?: "application/vnd.mapbox-vector-tile";
 }
-interface LayerGeojson extends MapContextBaseLayer {
+export type LayerGeojson = MapContextBaseLayer & MapContextLayerVector & {
     type: "geojson";
-}
-interface LayerGeojsonWithUrl extends LayerGeojson {
+};
+export interface LayerGeojsonWithUrl extends LayerGeojson {
     url: string;
     data?: never;
 }
-interface LayerGeojsonWithData extends LayerGeojson {
+export interface LayerGeojsonWithData extends LayerGeojson {
     data: FeatureCollection<Geometry | null> | string;
     url?: never;
 }
-/**
- * @interface
- */
 export type MapContextLayerGeojson = LayerGeojsonWithUrl | LayerGeojsonWithData;
 /**
- * @interface
+ * A layer that can be used in a map context.
  */
-export type MapContextLayer = MapContextLayerWms | MapContextLayerWmts | MapContextLayerWfs | MapContextLayerXyz | MapContextLayerGeojson;
+export type MapContextLayer = MapContextLayerWms | MapContextLayerWmts | MapContextLayerWfs | MapContextLayerXyz | MapContextLayerGeojson | MapContextLayerOgcApi | MapContextLayerMapLibreStyle | MapContextLayerGeotiff;
 export type Coordinate = [number, number];
 /**
- * Min X, min Y, max X, max Y
+ * Array components are respectively: minX, minY, maxX, maxY
  */
 export type Extent = [number, number, number, number];
 /**
  * @property center Expressed in longitude/latitude
+ * @property zoom
+ */
+export interface ViewByZoomAndCenter {
+    center: Coordinate;
+    zoom: number;
+}
+/**
  * @property extent Expressed in longitude/latitude
- * @property maxExtent Expressed in longitude/latitude
  */
-export interface MapContextView {
-    center?: Coordinate;
-    zoom?: number;
-    extent?: Extent;
+export interface ViewByExtent {
+    extent: Extent;
+}
+/**
+ * @property geometry Expressed in GeoJSON
+ */
+export interface ViewByGeometry {
+    geometry: Geometry;
+}
+/**
+ * A description of a map viewport in one of three ways:
+ *  * by center and zoom level,
+ *  * by extent,
+ *  * by geometry (in GeoJSON)
+ *
+ * Also allows specifying constraints for zoom and extent.
+ */
+export type MapContextView = (ViewByZoomAndCenter | ViewByExtent | ViewByGeometry) & {
     maxZoom?: number;
     maxExtent?: Extent;
-}
+};
+/**
+ * A map context, containing layers and a view.
+ *
+ * Note: setting the `view` property to `null` indicates that the map should use a default global view.
+ */
 export interface MapContext {
     layers: MapContextLayer[];
-    view: MapContextView;
+    view: MapContextView | null;
 }
-export {};
 //# sourceMappingURL=map-context.d.ts.map

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

@@ -1 +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"}
+{"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;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACzC,OAAO,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AAEhE;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAElD,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACrB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;IAErB;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,cAAc,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC;AAEhC,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,UAAU,CAAC;IAClB,GAAG,EAAE,UAAU,CAAC;CACjB;AACD,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,sBAAsB,CAAC;IAC9B,GAAG,EAAE,sBAAsB,CAAC;CAC7B;AACD,MAAM,MAAM,mBAAmB,GAC7B,sBAAsB,GAAG,sBAAsB,EAAE,GAAG,aAAa,CAAC;AAEpE,MAAM,MAAM,uBAAuB,GACjC,UAAU,GAAG,UAAU,EAAE,GAAG,YAAY,GAAG,SAAS,CAAC;AAEvD,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;IAC7D,IAAI,EAAE,KAAK,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,CAAC,EAAE,uBAAuB,CAAC;IAEpC;;OAEG;IACH,cAAc,CAAC,EAAE,mBAAmB,CAAC;IAErC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAC3B,MAAM,EACN,mBAAmB,GAAG,uBAAuB,CAC9C,CAAC;IAEF;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEtC;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,MAAM,yBAAyB,GACnC,MAAM,GAAG,MAAM,GAAG,UAAU,GAAG,SAAS,CAAC;AAE3C,MAAM,WAAW,mBAAoB,SAAQ,mBAAmB;IAC9D,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IAEb,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,yBAAyB,CAAC,CAAC;IAC5D,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,qBAAqB;IACpC,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,UAAU,CAAC,EAAE,WAAW,CAAC;CAC1B;AAED,MAAM,MAAM,kBAAkB,GAAG,mBAAmB,GAClD,qBAAqB,GAAG;IACtB,IAAI,EAAE,KAAK,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEJ,MAAM,MAAM,qBAAqB,GAAG,mBAAmB,GACrD,qBAAqB,GAAG;IACtB,IAAI,EAAE,QAAQ,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,QAAQ,GAAG,KAAK,CAAC;IAC5B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC,CAAC;AAGJ,MAAM,WAAW,4BAA6B,SAAQ,mBAAmB;IACvE,IAAI,EAAE,gBAAgB,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,sBAAuB,SAAQ,mBAAmB;IACjE,IAAI,EAAE,SAAS,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;IAC7D,IAAI,EAAE,KAAK,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,CAAC,EAAE,oCAAoC,CAAC;CACnD;AAED,MAAM,MAAM,YAAY,GAAG,mBAAmB,GAC5C,qBAAqB,GAAG;IACtB,IAAI,EAAE,SAAS,CAAC;CACjB,CAAC;AACJ,MAAM,WAAW,mBAAoB,SAAQ,YAAY;IACvD,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,KAAK,CAAC;CACd;AACD,MAAM,WAAW,oBAAqB,SAAQ,YAAY;IACxD,IAAI,EAAE,iBAAiB,CAAC,QAAQ,GAAG,IAAI,CAAC,GAAG,MAAM,CAAC;IAClD,GAAG,CAAC,EAAE,KAAK,CAAC;CACb;AACD,MAAM,MAAM,sBAAsB,GAAG,mBAAmB,GAAG,oBAAoB,CAAC;AAEhF;;GAEG;AACH,MAAM,MAAM,eAAe,GACvB,kBAAkB,GAClB,mBAAmB,GACnB,kBAAkB,GAClB,kBAAkB,GAClB,sBAAsB,GACtB,qBAAqB,GACrB,4BAA4B,GAC5B,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;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,UAAU,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,cAAc,GAAG,CAC3B,mBAAmB,GAAG,YAAY,GAAG,cAAc,CACpD,GAAG;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,UAAU;IACzB,MAAM,EAAE,eAAe,EAAE,CAAC;IAC1B,IAAI,EAAE,cAAc,GAAG,IAAI,CAAC;CAC7B"}

package/dist/model/resolved-map-state.d.ts

@@ -0,0 +1,49 @@
+import { Coordinate, Extent } from "./map-context.js";
+export type MapLayerCreationStatus = {
+    created: true;
+} | {
+    creationError: true;
+    creationErrorMessage: string;
+};
+export type MapLayerLoadingStatus = {
+    loaded: true;
+} | {
+    loadingError: true;
+    loadingErrorMessage: string;
+    loadingErrorHttpStatus?: number;
+} | {
+    loading: true;
+};
+export interface MapLayerDataInfo {
+    featuresCount?: number;
+    geometryTypes?: Array<"Point" | "LineString" | "Polygon">;
+}
+export interface ResolvedMapLayerIdentity {
+    id?: string | number;
+}
+export type ResolvedMapLayerState = MapLayerCreationStatus & MapLayerLoadingStatus & MapLayerDataInfo & ResolvedMapLayerIdentity;
+/**
+ * Describes the actual view state of a map
+ */
+export interface ResolvedMapViewState {
+    /** View center in longitude/latitude */
+    center: Coordinate;
+    /** Actual view extent in longitude/latitude */
+    extent: Extent;
+    /** Map units per pixel */
+    resolution: number;
+    /** Scale denominator (takes into account an estimated DPI) */
+    scaleDenominator: number;
+    /** Bearing in degrees; 90 is North (up) */
+    bearing: number;
+}
+/**
+ * Describes the actual state of a map after a context or context diff was applied to it.
+ * A `view` of null means the view state hasn't been changed yet.
+ * A `layer` item of null means the layer state hasn't been changed yet.
+ */
+export interface ResolvedMapState {
+    layers: Array<ResolvedMapLayerState | null>;
+    view: ResolvedMapViewState | null;
+}
+//# sourceMappingURL=resolved-map-state.d.ts.map

package/dist/model/resolved-map-state.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolved-map-state.d.ts","sourceRoot":"","sources":["../../lib/model/resolved-map-state.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAEtD,MAAM,MAAM,sBAAsB,GAC9B;IACE,OAAO,EAAE,IAAI,CAAC;CACf,GACD;IACE,aAAa,EAAE,IAAI,CAAC;IACpB,oBAAoB,EAAE,MAAM,CAAC;CAC9B,CAAC;AAEN,MAAM,MAAM,qBAAqB,GAC7B;IACE,MAAM,EAAE,IAAI,CAAC;CACd,GACD;IACE,YAAY,EAAE,IAAI,CAAC;IACnB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACjC,GACD;IACE,OAAO,EAAE,IAAI,CAAC;CACf,CAAC;AAEN,MAAM,WAAW,gBAAgB;IAC/B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,KAAK,CAAC,OAAO,GAAG,YAAY,GAAG,SAAS,CAAC,CAAC;CAC3D;AAED,MAAM,WAAW,wBAAwB;IACvC,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACtB;AAED,MAAM,MAAM,qBAAqB,GAAG,sBAAsB,GACxD,qBAAqB,GACrB,gBAAgB,GAChB,wBAAwB,CAAC;AAE3B;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,wCAAwC;IACxC,MAAM,EAAE,UAAU,CAAC;IAEnB,+CAA+C;IAC/C,MAAM,EAAE,MAAM,CAAC;IAEf,0BAA0B;IAC1B,UAAU,EAAE,MAAM,CAAC;IAEnB,8DAA8D;IAC9D,gBAAgB,EAAE,MAAM,CAAC;IAEzB,2CAA2C;IAC3C,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,KAAK,CAAC,qBAAqB,GAAG,IAAI,CAAC,CAAC;IAC5C,IAAI,EAAE,oBAAoB,GAAG,IAAI,CAAC;CACnC"}

package/dist/model/resolved-map-state.js

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

package/dist/model/style.d.ts

@@ -0,0 +1,3 @@
+import type { FlatStyleLike } from "ol/style/flat.js";
+export type VectorStyle = FlatStyleLike;
+//# sourceMappingURL=style.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"style.d.ts","sourceRoot":"","sources":["../../lib/model/style.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEtD,MAAM,MAAM,WAAW,GAAG,aAAa,CAAC"}

package/dist/model/style.js

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

package/dist/utils/hash.d.ts

@@ -0,0 +1,2 @@
+export declare function getHash(input: unknown, ignoreKeys?: string[]): string;
+//# sourceMappingURL=hash.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"hash.d.ts","sourceRoot":"","sources":["../../lib/utils/hash.ts"],"names":[],"mappings":"AAOA,wBAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,GAAE,MAAM,EAAO,GAAG,MAAM,CAoBzE"}