@geospatial-sdk/core 0.0.5-dev.55 → 0.0.5-dev.56

package/dist/model/events.d.ts

@@ -2,6 +2,7 @@ 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 {
@@ -20,11 +21,46 @@ 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;
+}
+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;
@@ -35,6 +71,14 @@ export interface MapEventsByType {
     [FeaturesClickEventType]: FeaturesClickEvent;
     [FeaturesHoverEventType]: FeaturesHoverEvent;
     [MapClickEventType]: MapClickEvent;
+    [MapViewStateChangeEventType]: MapViewStateChangeEvent;
+    [MapLayerStateChangeEventType]: MapLayerStateChangeEvent;
+    [MapStateChangeEventType]: MapStateChangeEvent;
+    [LayerCreationErrorEventType]: LayerCreationErrorEvent;
+    [LayerLoadingErrorEventType]: LayerLoadingErrorEvent;
+    /**
+     * DEPRECATED
+     */
     [MapExtentChangeEventType]: MapExtentChangeEvent;
     [SourceLoadErrorType]: SourceLoadErrorEvent;
 }

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

@@ -1 +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;AAE3C,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,wBAAwB,sBAAsB,CAAC;AAC5D,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,OAAO,wBAAwB,CAAC;IACtC,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,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;CAiBpD;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,wBAAwB,CAAC,EAAE,oBAAoB,CAAC;IACjD,CAAC,mBAAmB,CAAC,EAAE,oBAAoB,CAAC;CAC7C"}
+{"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;CACpB;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

@@ -1,8 +1,22 @@
+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) {
@@ -11,9 +25,7 @@ export class SourceLoadErrorEvent extends BaseEvent {
             this.message = error.statusText;
             this.httpStatus = error.status;
         }
-        else if (error instanceof Error &&
-            "isCrossOriginRelated" in error &&
-            "httpStatus" in error) {
+        else if (error instanceof EndpointError) {
             const e = error;
             this.message = e.message;
             this.httpStatus = e.httpStatus;

package/dist/model/index.d.ts

@@ -5,4 +5,6 @@
 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;;;GAGG;AAEH,cAAc,kBAAkB,CAAC;AACjC,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,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

@@ -5,3 +5,5 @@
 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.d.ts

@@ -1,17 +1,28 @@
 import { FeatureCollection, Geometry } from "geojson";
 import { VectorStyle } from "./style.js";
+export type LayerDimensionValueSingle = string | number | Date;
+export type LayerDimensionValueRange = {
+    start: LayerDimensionValueSingle | null;
+    end: LayerDimensionValueSingle | null;
+};
 /**
  * @private
  * @inline
  */
-export type LayerDimensions = Record<string, string>;
+export type LayerDimensionValues = Record<string, LayerDimensionValueSingle | LayerDimensionValueRange>;
 /**
  * @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
@@ -19,25 +30,51 @@ 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;
 }
 export interface MapContextLayerWms extends MapContextBaseLayer {
     type: "wms";
     url: string;
     name: string;
-    dimensions?: LayerDimensions;
+    dimensionValues?: LayerDimensionValues;
     style?: string;
 }
 export interface MapContextLayerWmts extends MapContextBaseLayer {
     type: "wmts";
     url: string;
     name: string;
-    dimensions?: LayerDimensions;
+    dimensionValues?: LayerDimensionValues;
     style?: string;
 }
 export interface MapContextLayerVector {

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;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAErD;;;GAGG;AACH,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;IACtB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;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,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,CACzB,mBAAmB,GACnB,YAAY,GACZ,cAAc,CACjB,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"}
+{"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;AAEzC,MAAM,MAAM,yBAAyB,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;AAC/D,MAAM,MAAM,wBAAwB,GAAG;IACrC,KAAK,EAAE,yBAAyB,GAAG,IAAI,CAAC;IACxC,GAAG,EAAE,yBAAyB,GAAG,IAAI,CAAC;CACvC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,CACvC,MAAM,EACN,yBAAyB,GAAG,wBAAwB,CACrD,CAAC;AAEF;;;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;CACrB;AAED,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;IAC7D,IAAI,EAAE,KAAK,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IAEb,eAAe,CAAC,EAAE,oBAAoB,CAAC;IACvC,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;IAEb,eAAe,CAAC,EAAE,oBAAoB,CAAC;IACvC,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,CACzB,mBAAmB,GACnB,YAAY,GACZ,cAAc,CACjB,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,46 @@
+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 type ResolvedMapLayerState = MapLayerCreationStatus & MapLayerLoadingStatus & MapLayerDataInfo;
+/**
+ * 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,MAAM,qBAAqB,GAAG,sBAAsB,GACxD,qBAAqB,GACrB,gBAAgB,CAAC;AAEnB;;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/utils/hash.js

@@ -1,5 +1,5 @@
 function isGeoJsonGeometry(object) {
-    return "type" in object && "coordinates" in object;
+    return "type" in object && ("coordinates" in object || "features" in object);
 }
 export function getHash(input, ignoreKeys = []) {
     if (input instanceof Object && isGeoJsonGeometry(input)) {

package/lib/model/events.ts

@@ -2,6 +2,11 @@ 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[]>;
 
@@ -25,12 +30,52 @@ export interface MapClickEvent {
   coordinate: [number, number]; // expressed in lon/lat
 }
 
+export const MapViewStateChangeEventType = "map-view-state-change";
+export interface MapViewStateChangeEvent {
+  type: typeof MapViewStateChangeEventType;
+  viewState: ResolvedMapViewState;
+}
+
+export const MapLayerStateChangeEventType = "map-layer-state-change";
+export interface MapLayerStateChangeEvent {
+  type: typeof MapLayerStateChangeEventType;
+  layerState: ResolvedMapLayerState;
+  layerIndex: number;
+}
+
+export const MapStateChangeEventType = "map-state-change";
+export interface MapStateChangeEvent {
+  type: typeof MapStateChangeEventType;
+  mapState: ResolvedMapState;
+}
+
+export const LayerCreationErrorEventType = "layer-creation-error";
+export interface LayerCreationErrorEvent {
+  type: typeof LayerCreationErrorEventType;
+  error: Error;
+}
+
+export const LayerLoadingErrorEventType = "layer-loading-error";
+export interface LayerLoadingErrorEvent {
+  type: typeof LayerLoadingErrorEventType;
+  error: Error;
+  httpStatus?: number;
+}
+
+/**
+ * DEPRECATED
+ * Use the MapViewStateChangeEvent instead
+ */
 export const MapExtentChangeEventType = "map-extent-change";
 export interface MapExtentChangeEvent {
   type: typeof MapExtentChangeEventType;
   extent: Extent;
 }
 
+/**
+ * DEPRECATED
+ * Use the MapLayerStateChangeEvent and LayerLoadingErrorEvent instead
+ */
 export const SourceLoadErrorType = "source-load-error";
 export class SourceLoadErrorEvent extends BaseEvent {
   message: string;
@@ -40,11 +85,7 @@ export class SourceLoadErrorEvent extends BaseEvent {
     if (error instanceof Response) {
       this.message = error.statusText;
       this.httpStatus = error.status;
-    } else if (
-      error instanceof Error &&
-      "isCrossOriginRelated" in error &&
-      "httpStatus" in error
-    ) {
+    } else if (error instanceof EndpointError) {
       const e = error as EndpointError;
       this.message = e.message;
       this.httpStatus = e.httpStatus;
@@ -58,6 +99,14 @@ export interface MapEventsByType {
   [FeaturesClickEventType]: FeaturesClickEvent;
   [FeaturesHoverEventType]: FeaturesHoverEvent;
   [MapClickEventType]: MapClickEvent;
+  [MapViewStateChangeEventType]: MapViewStateChangeEvent;
+  [MapLayerStateChangeEventType]: MapLayerStateChangeEvent;
+  [MapStateChangeEventType]: MapStateChangeEvent;
+  [LayerCreationErrorEventType]: LayerCreationErrorEvent;
+  [LayerLoadingErrorEventType]: LayerLoadingErrorEvent;
+  /**
+   * DEPRECATED
+   */
   [MapExtentChangeEventType]: MapExtentChangeEvent;
   [SourceLoadErrorType]: SourceLoadErrorEvent;
 }

package/lib/model/index.ts

@@ -6,3 +6,5 @@
 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/lib/model/map-context.ts

@@ -1,11 +1,20 @@
 import { FeatureCollection, Geometry } from "geojson";
 import { VectorStyle } from "./style.js";
 
+export type LayerDimensionValueSingle = string | number | Date;
+export type LayerDimensionValueRange = {
+  start: LayerDimensionValueSingle | null;
+  end: LayerDimensionValueSingle | null;
+};
+
 /**
  * @private
  * @inline
  */
-export type LayerDimensions = Record<string, string>;
+export type LayerDimensionValues = Record<
+  string,
+  LayerDimensionValueSingle | LayerDimensionValueRange
+>;
 
 /**
  * @private
@@ -14,7 +23,13 @@ export type LayerDimensions = Record<string, string>;
 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;
 
   /**
@@ -23,11 +38,43 @@ 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;
 }
 
@@ -35,7 +82,8 @@ export interface MapContextLayerWms extends MapContextBaseLayer {
   type: "wms";
   url: string;
   name: string;
-  dimensions?: LayerDimensions;
+  // TODO: add support for these
+  dimensionValues?: LayerDimensionValues;
   style?: string;
 }
 
@@ -43,7 +91,8 @@ export interface MapContextLayerWmts extends MapContextBaseLayer {
   type: "wmts";
   url: string;
   name: string;
-  dimensions?: LayerDimensions;
+  // TODO: add support for these
+  dimensionValues?: LayerDimensionValues;
   style?: string;
 }
 

package/lib/model/resolved-map-state.ts

@@ -0,0 +1,62 @@
+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 type ResolvedMapLayerState = MapLayerCreationStatus &
+  MapLayerLoadingStatus &
+  MapLayerDataInfo;
+
+/**
+ * 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;
+}

package/lib/utils/hash.test.ts

@@ -66,6 +66,21 @@ describe("getHash", () => {
     });
     expect(hashB).toEqual(hashA);
   });
+  it("stable with identical GeoJSON collection", () => {
+    const hashA = getHash({
+      geometry: {
+        type: "FeatureCollection",
+        features: [{ type: "Feature", properties: {}, geometry: null }],
+      },
+    });
+    const hashB = getHash({
+      geometry: {
+        type: "FeatureCollection",
+        features: [{ type: "Feature", properties: {}, geometry: null }],
+      },
+    });
+    expect(hashB).toEqual(hashA);
+  });
   it("different if GeoJSON geometry properties are not in the same order", () => {
     const hashA = getHash({
       geometry: {

package/lib/utils/hash.ts

@@ -1,5 +1,5 @@
 function isGeoJsonGeometry(object: object) {
-  return "type" in object && "coordinates" in object;
+  return "type" in object && ("coordinates" in object || "features" in object);
 }
 
 export function getHash(input: unknown, ignoreKeys: string[] = []): string {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@geospatial-sdk/core",
-  "version": "0.0.5-dev.55+475f057",
+  "version": "0.0.5-dev.56+eae591c",
   "description": "Core functions and models for the SDK",
   "author": "Olivia <olivia.guyot@camptocamp.com>",
   "homepage": "",
@@ -22,7 +22,7 @@
     "test": "vitest",
     "build": "tsc"
   },
-  "gitHead": "475f057bccd243497d84db212b50812633e7398b",
+  "gitHead": "eae591cfcca0346c3cac6fe7d5dcddf88fe408f4",
   "dependencies": {
     "chroma-js": "^2.4.2",
     "proj4": "^2.9.2"