jmapcloud-ng-core-types 0.2.3 → 0.3.1

package/index.ts

@@ -37,7 +37,6 @@ export interface JUIService {
 
 export interface JLibraryService {
   maplibregl(): any
-  // mapboxgl(): any // TODO: remove
   html2canvas(): any
 }
 
@@ -471,7 +470,7 @@ export interface JMapState {
   activeBasemapId: string | undefined
   basemaps: JBasemap[]
   selection: JMapSelection
-  jmapLayerIdsSupportedByMapbox: JId[]
+  jmapLayerIdsSupportedByMaplibre: JId[]
   scaleControlPosition: JMAP_POSITIONS
   distanceUnit: JMAP_DISTANCE_UNITS
   isNavigationHistoryControlVisible: boolean
@@ -663,7 +662,7 @@ export interface JMapService {
   getExtent(): JBoundaryBox
   getCenter(): { x: number; y: number }
   getZoom(): number
-  getMapBoxSourceIdByJMapLayerId(layerId: JId): string
+  getMaplibreSourceIdByJMapLayerId(layerId: JId): string
   isScaleControlVisible(): boolean
   setScaleControlVisibility(isVisible: boolean, position?: JMAP_POSITIONS): void
   setScaleControlUnits(units: "imperial" | "metric" | "nautical"): void
@@ -680,9 +679,9 @@ export interface JMapService {
   isLayerRendered(layerId: JId): boolean
   getLayersVisibilityStatus(): JMapLayersVisibilityStatus
   getLayersVisibilityStatusAsArray(): JMapLayerVisibilityStatus[]
-  getMapboxSupportedJMapLayerIds(): JId[]
-  getMapboxSupportedJMapLayerBefore(layerId: JId): JId | undefined
-  getMapboxSupportedJMapLayerAfter(layerId: JId): JId | undefined
+  getMaplibreSupportedJMapLayerIds(): JId[]
+  getMaplibreSupportedJMapLayerIdBefore(layerId: JId): JId | undefined
+  getMaplibreSupportedJMapLayerIdAfter(layerId: JId): JId | undefined
   refreshLayerById(layerId: JId): void
   getRenderedJMapLayerIds(): JId[]
   getRenderedFeatures(layerId: JId, params?: JLocation | JBoundaryBox | JCircle | JGetRenderedFeaturesParams): Feature[]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jmapcloud-ng-core-types",
-  "version": "0.2.3",
+  "version": "0.3.1",
   "description": "JMap Cloud specific version of JMap Cloud NG Core types and interfaces",
   "main": "index.js",
   "scripts": {
@@ -29,12 +29,12 @@
   "homepage": "https://github.com/k2geospatial/jmapcloud-ng-core-types#readme",
   "devDependencies": {
     "gulp": "^4.0.2",
-    "gulp-typedoc-k2": "^3.0.2-k2",
-    "typedoc": "^0.22.0"
+    "gulp-typedoc-k2": "^3.0.2-k2.1",
+    "typedoc": "^0.24.8"
   },
   "dependencies": {
     "@types/geojson": "^7946.0.7",
-    "maplibre-gl": "^2.4.0",
+    "maplibre-gl": "^3.2.1",
     "@types/react": "^16.8.3",
     "geojson": "^0.5.0",
     "redux": "^4.0.0"

package/public/core.d.ts

@@ -2791,11 +2791,11 @@ declare namespace JMap {
     /**
      * **JMap.Map.getMap**
      *
-     * Returns the Mapbox map instance, a MapBox map.
+     * Returns the Maplibre map instance, a Maplibre map.
      *
      * @example ```ts
      *
-     * // returns the Mapbox map instance
+     * // returns the Maplibre map instance
      * JMap.Map.getMap()
      * ```
      */
@@ -2804,13 +2804,13 @@ declare namespace JMap {
     /**
      * **JMap.Map.getMapJSLib**
      *
-     * Returns the MapBox JS library used to create the map.
+     * Returns the JS library used to create the map (Maplibre).
      *
-     * Useful to be able to create a map library object, by example a popup.
+     * Useful to be able to create a map library object, for instance a popup.
      *
      * @example ```ts
      *
-     * // Create a MapBox popup
+     * // Create a Map popup
      * const myCustomPopup = JMap.Map.getMapJSLib().Popup({
      *   closeButton: false,
      *   closeOnClick: false
@@ -2946,7 +2946,7 @@ declare namespace JMap {
     function getZoom(): number
 
     /**
-     * ***JMap.Map.getMapBoxSourceIdByJMapLayerId***
+     * ***JMap.Map.getMaplibreSourceIdByJMapLayerId***
      *
      * Returns the source id of the given Jmap layer id.
      *
@@ -2955,10 +2955,10 @@ declare namespace JMap {
      * @example ```ts
      *
      * // returns the source id of the JMap layer with id 4
-     * JMap.Map.getMapBoxSourceIdByJMapLayerId(4)
+     * JMap.Map.getMaplibreSourceIdByJMapLayerId(4)
      * ```
      */
-    function getMapBoxSourceIdByJMapLayerId(layerId: JId): string
+    function getMaplibreSourceIdByJMapLayerId(layerId: JId): string
 
     /**
      * ***JMap.Map.isNavigationHistoryControlVisible***
@@ -3247,26 +3247,26 @@ declare namespace JMap {
     function getLayersVisibilityStatusAsArray(): JMapLayerVisibilityStatus[]
 
     /**
-     * **JMap.Map.getMapboxSupportedJMapLayerIds**
+     * **JMap.Map.getMaplibreSupportedJMapLayerIds**
      *
      * Returns all layer ids that are displayed by the map.
      *
-     * Mapbox doesn't support all layer types defined in JMap Server.
+     * The Map JS library doesn't support all layer types defined in JMap .
      *
      * This function returns all layers ids that are managed by the map.
      *
      * @example ```ts
      *
-     * // returns layer ids supported by the Mapbox
-     * JMap.Map.getMapboxSupportedJMapLayerIds()
+     * // returns layer ids supported by the Map JS library
+     * JMap.Map.getMaplibreSupportedJMapLayerIds()
      * ```
      */
-    function getMapboxSupportedJMapLayerIds(): JId[]
+    function getMaplibreSupportedJMapLayerIds(): JId[]
 
     /**
-     * **JMap.Map.getMapboxSupportedJMapLayerBefore**
+     * **JMap.Map.getMaplibreSupportedJMapLayerIdBefore**
      *
-     * Returns the Mapbox supported JMap layer id that is ordered before the JMap layer id provided in argument.
+     * Returns the Map JS library supported JMap layer id that is ordered before the JMap layer id provided in argument.
      *
      * @throws Error if layer is not found
      * @param layerId The JMap layer id
@@ -3274,15 +3274,15 @@ declare namespace JMap {
      * @example ```ts
      *
      * // Returns the layer id that is located before layer id=4
-     * JMap.Map.getMapboxSupportedJMapLayerBefore(4)
+     * JMap.Map.getMaplibreSupportedJMapLayerIdBefore(4)
      * ```
      */
-    function getMapboxSupportedJMapLayerBefore(layerId: JId): JId | undefined
+    function getMaplibreSupportedJMapLayerIdBefore(layerId: JId): JId | undefined
 
     /**
-     * **JMap.Map.getMapboxSupportedJMapLayerAfter**
+     * **JMap.Map.getMaplibreSupportedJMapLayerIdAfter**
      *
-     * Returns the Mapbox supported JMap layer id that is ordered after the JMap layer id provided in argument.
+     * Returns the Map JS library supported JMap layer id that is ordered after the JMap layer id provided in argument.
      *
      * @throws Error if layer is not found
      * @param layerId The JMap layer id
@@ -3290,10 +3290,10 @@ declare namespace JMap {
      * @example ```ts
      *
      * // Returns the layer id that is located after layer id=3
-     * JMap.Map.getMapboxSupportedJMapLayerAfter(3)
+     * JMap.Map.getMaplibreSupportedJMapLayerIdAfter(3)
      * ```
      */
-    function getMapboxSupportedJMapLayerAfter(layerId: JId): JId | undefined
+    function getMaplibreSupportedJMapLayerIdAfter(layerId: JId): JId | undefined
 
     /**
      * **JMap.Map.refreshLayerById**
@@ -3318,7 +3318,7 @@ declare namespace JMap {
      *
      * Returns the ids of the layers that are displayed on the map.
      *
-     * Mapbox doesn't support all layer types defined on JMap Server.
+     * The Map JS library doesn't support all layer types defined on JMap Server.
      *
      * This function returns all layers ids that are managed by the map.
      *
@@ -3333,11 +3333,11 @@ declare namespace JMap {
     /**
      * **JMap.Map.getRenderedFeatures**
      *
-     * Returns rendered geojson features for the specified Jmap layer. Features that are not rendered (i.e. filtered by MapBox) are not returned
+     * Returns rendered geojson features for the specified Jmap layer. Features that are not rendered (i.e. filtered by the Map JS library) are not returned
      *
      * If the JMap layer is not visible, no features are returned.
      *
-     * MapBox splits geometries along tiles internally, meaning for instance that a polygon feature that crosses many tiles will be returned as multiple polygon pieces (sharing all properties of the original source features).
+     * The Map JS library splits geometries along tiles internally, meaning for instance that a polygon feature that crosses many tiles will be returned as multiple polygon pieces (sharing all properties of the original source features).
      * By default, getRenderedFeatures will only return one of those pieces (a random one).
      * If you pass a JGetRenderedFeaturesParams with keepAllTiles = true, all feature pieces will be returned by getRenderedFeatures.
      *
@@ -3364,8 +3364,8 @@ declare namespace JMap {
      *  ne: { x: 48.54, y: 70.43 }
      * })
      *
-     * // Returns all rendered geojson features for layer 4 that intersect a circle (radius in km), without any mapbox filter
-     * JMap.Map.getRenderedFeatures(4, {filter: { center: { x: 45.54, y: 65.43 }, radius: .5 }, ignoreMapBoxFilter: true})
+     * // Returns all rendered geojson features for layer 4 that intersect a circle (radius in km), without any Map JS library filter
+     * JMap.Map.getRenderedFeatures(4, {geoFilter: { center: { x: 45.54, y: 65.43 }, radius: .5 }})
      * ```
      */
     function getRenderedFeatures(
@@ -3376,11 +3376,11 @@ declare namespace JMap {
     /**
      * **JMap.Map.getSourceFeatures**
      *
-     * Returns geojson features for the specified JMap layer whether or not they are currently rendered by MapBox (i.e. whether or not they are filtered on screen)
+     * Returns geojson features for the specified JMap layer whether or not they are currently rendered by the map (i.e. whether or not they are filtered on screen)
      *
      * If the JMap layer is not visible, no features are returned.
      *
-     * MapBox splits geometries along tiles internally, meaning for instance that a polygon feature that crosses many tiles will be returned as multiple polygon pieces (sharing all properties of the original source features).
+     * The map splits geometries along tiles internally, meaning for instance that a polygon feature that crosses many tiles will be returned as multiple polygon pieces (sharing all properties of the original source features).
      * By default, getSourceFeatures will only return one of those pieces (a random one).
      * If you pass a JGetSourceFeaturesParams with keepAllTiles = true, all feature pieces will be returned by getSourceFeatures.
      * If you pass a JGetSourceFeaturesParams with keepAllTiles = false (or if keepAllTiles is not specified), and if a viewport is specified in the JGetSourceFeaturesParams, the sole feature piece returned is garanteed to be included in the viewport.
@@ -3673,7 +3673,7 @@ declare namespace JMap {
      * @example ```ts
      *
      * // Navigate to a location on the map
-     * JMap.Map.navigateTo({center: { x: 45.34, y: 65.87 }, zoom: 5, bearing: 170, pitch: 30, mapBoxEventData: { stopJMapEventPropagation: true }})
+     * JMap.Map.navigateTo({center: { x: 45.34, y: 65.87 }, zoom: 5, bearing: 170, pitch: 30, maplibreEventData: { stopJMapEventPropagation: true }})
      * ```
      */
     function navigateTo(params: JMapNavigateToParams): void
@@ -3973,7 +3973,7 @@ declare namespace JMap {
      *
      * Set the map mouse cursor.
      *
-     * If cursor is an empty string will unset the cursor (the mapbox default will be used).
+     * If cursor is an empty string will unset the cursor (the map default cursor will be used).
      *
      * @throws if the map is not ready
      * @param cursor the mouse cursor
@@ -5684,7 +5684,7 @@ declare namespace JMap {
      *
      * Returns loaded JMap project projection.
      *
-     * In MapBox, projection is always "***EPSG:3857***", but that function returns the project
+     * In the map, the projection is always "***EPSG:3857***", but that function returns the project
      * defined projection (so it can be different than ***ESPG:3857***).
      *
      * @throws If no project is loaded
@@ -8609,7 +8609,7 @@ declare namespace JMap {
          *    "custom-map-move-start",
          *    args => {
          *      console.log(`The map start moving`, args.map, args.mapEvent)
-         *      // mapEvent is the Mapbox event
+         *      // mapEvent is the Maplibre event
          *    }
          * )
          * ```
@@ -8630,7 +8630,7 @@ declare namespace JMap {
          *    "custom-map-move",
          *    args => {
          *      console.log(`The map is moving`, args.map, args.mapEvent)
-         *      // mapEvent is the Mapbox event
+         *      // mapEvent is the Maplibre event
          *    }
          * )
          * ```
@@ -8651,7 +8651,7 @@ declare namespace JMap {
          *    "custom-map-move-end",
          *    args => {
          *      console.log(`The map stop moving`, args.map, args.mapEvent)
-         *      // mapEvent is the Mapbox event
+         *      // mapEvent is the Maplibre event
          *    }
          * )
          * ```
@@ -8673,7 +8673,7 @@ declare namespace JMap {
          *    args => {
          *      console.log(
          *          `The mouse is moving on layer id="${args.layerId}"`, map.location,
-         *          args.map, args.mapEvent // mapEvent is the Mapbox event
+         *          args.map, args.mapEvent // mapEvent is the Maplibre event
          *      )
          *    }
          * )
@@ -8701,7 +8701,7 @@ declare namespace JMap {
          *    args => {
          *      console.log(
          *          `The mouse is moving on layer id="${args.layerId}"`,
-         *          args.map, args.mapEvent // the mapEvent is the Mapbox event
+         *          args.map, args.mapEvent // the mapEvent is the Maplibre event
          *      )
          *      console.log(
          *        `The mouse cursor is over ${args.features.length} features`,
@@ -8737,7 +8737,7 @@ declare namespace JMap {
          *    args => {
          *      console.log(
          *          `The mouse entered an element of layer id="${args.layerId}"`,
-         *          args.map, args.mapEvent // mapEvent is the Mapbox event
+         *          args.map, args.mapEvent // mapEvent is the Maplibre event
          *      )
          *      console.log(
          *        `The mouse cursor is over ${args.features.length} features`,
@@ -8773,7 +8773,7 @@ declare namespace JMap {
          *    args => {
          *      console.log(
          *          `The mouse leaved the layer id="${args.layerId}"`, args.location,
-         *          args.map, args.mapEvent // mapEvent is the Mapbox event
+         *          args.map, args.mapEvent // mapEvent is the Maplibre event
          *      )
          *    }
          * )
@@ -8797,7 +8797,7 @@ declare namespace JMap {
          *      const location = args.location
          *      console.log(
          *          `The mouse has been clicked at { x="${location.x}, y="${location.y}" }"`,
-         *          args.map, args.mapEvent // mapEvent is the Mapbox event
+         *          args.map, args.mapEvent // mapEvent is the Maplibre event
          *      )
          *    }
          * )
@@ -12123,19 +12123,6 @@ declare namespace JMap {
    * Here you'll find all external library JMap expose to its client
    */
   namespace Library {
-    // /**
-    //  * **JMap.Library.mapboxgl**
-    //  *
-    //  * Returns the mapboxgl library.
-    //  *
-    //  * @example ```ts
-    //  *
-    //  * // get the mapboxgl library
-    //  * const mapboxgl = JMap.Library.mapboxgl()
-    //  * ```
-    //  */
-    // function mapboxgl(): any
-
     /**
      * **JMap.Library.maplibregl**
      *

package/public/jmap/extension.d.ts

@@ -172,19 +172,19 @@ declare interface JCoreExtension {
   onRegistrationDone?: () => void
 
   /**
-   * An optional handler that returns a Mapbox GL JS RequestParameters object
+   * An optional handler that returns a Maplibre RequestParameters object
    *
-   * Provide this handler if your extentions needs to add something special in MapBox map requests,
+   * Provide this handler if your extentions needs to add something special in map requests,
    * like providing credentials, adding headers, etc.
    *
    * Great care must be taken to not blindly modify every request passed to this handler. You should only modify requests known to your extension. This can usually
    * be determined by looking at the url received by the handler.
    *
-   * See Mapbox documentation for reference:
+   * See Maplibre documentation for reference:
    *
-   * https://docs.mapbox.com/mapbox-gl-js/api/map/#map-parameters
+   * https://maplibre.org/maplibre-gl-js/docs/API/types/maplibregl.MapOptions
    *
-   * https://docs.mapbox.com/mapbox-gl-js/api/properties/#requestparameters
+   * https://maplibre.org/maplibre-gl-js/docs/API/types/maplibregl.RequestParameters
    *
    * @example ```ts
    * JMap.Extension.register({

package/public/jmap/geometry.d.ts

@@ -32,7 +32,7 @@ declare type JPolygon = JPoint[]
 declare interface JCircle {
   center: JLocation
   /**
-   * With mapbox the radius unit is kilometer
+   * The radius unit is kilometer
    */
   radius: number
 }

package/public/jmap/layer.d.ts

@@ -276,8 +276,8 @@ declare interface JLayer extends JLayerTreeElement {
   metadataSections: JLayerMetadataSection[]
   attributes: JLayerAttribute[]
   mouseOver: JMapMouseOver
-  minimumVisibleMapboxZoom: number | undefined
-  maximumVisibleMapboxZoom: number | undefined
+  minimumVisibleZoom: number | undefined
+  maximumVisibleZoom: number | undefined
   styleRules: JLayerStyleRule[]
   defaultStyleRule: JLayerStyleRule | undefined
   thematics: JLayerThematic[]
@@ -440,8 +440,8 @@ declare interface JLayerStyleRuleCondition {
 declare interface JLayerStyleScaled {
   id: string
   styleId: string
-  minimumVisibleMapboxZoom: number
-  maximumVisibleMapboxZoom: number
+  minimumVisibleZoom: number
+  maximumVisibleZoom: number
 }
 
 declare interface JLayerStyleSample {

package/public/jmap/map.d.ts

@@ -162,14 +162,14 @@ declare interface JMapNavigationStep {
 }
 
 /**
- *  **JMapBoxEventData**
+ *  **JMaplibreEventData**
  *
- * This interface describe optionnal data we can pass to MapBox events
+ * This interface describe optionnal data we can pass to Map events
  * in order to transport useful information while consuming the events in your application
  *
  *
  */
-declare interface JMapBoxEventData {
+declare interface JMaplibreEventData {
   /**
    * **stopJMapEventPropagation**
    *
@@ -187,11 +187,6 @@ declare interface JMapBoxEventData {
   preventNavigationStepPush?: boolean
 }
 
-declare interface JMapMapboxLayerStyleDefinition {
-  styleLayer: maplibregl.LayerSpecification
-  borderStyleLayer?: maplibregl.LayerSpecification
-}
-
 declare interface JMapNavigateToParams extends JPanAndZoomOptions {
   center: JLocation
   zoom: number
@@ -264,9 +259,9 @@ declare interface JZoomOptions {
 
 declare interface JPanAndZoomOptions extends Partial<JZoomOptions> {
   /**
-   * Event related options
+   * Event related options/data passed to Maplibre event
    */
-  mapBoxEventData?: JMapBoxEventData
+  maplibreEventData?: JMaplibreEventData
 }
 
 declare interface JCoreMapOptions {
@@ -301,8 +296,8 @@ declare interface JCoreMapOptions {
    * If a mapbox token is set through the JMap Admin interface,
    * the JMap Cloud NG Core library will use it automatically, nothing else to do for you.
    *
-   * The Mapbox token is used by JMap in order to fully use Mapbox capabilities
-   * like displaying a mapbox base maps.
+   * The mapbox token is used by JMap in order to fully use mapbox capabilities
+   * like displaying a mapbox base maps or using mapbox geocoding.
    *
    * But if no token is set in JMap Admin, or if you want to use
    * the mapbox token of your choice, you have to set the "***mapboxToken***" parameter :

package/public/jmap/mouseover.d.ts

@@ -2,8 +2,8 @@ declare interface JMapMouseOver {
   text: string
   preventTextDuplication: boolean
   backgroundColor: string
-  maximumVisibleMapboxZoom: number
-  minimumVisibleMapboxZoom: number
+  maximumVisibleZoom: number
+  minimumVisibleZoom: number
 }
 
 declare interface JMouseOverContent {

package/public/jmap/project.d.ts

@@ -29,8 +29,8 @@ declare interface JProject {
   colorSelection: string
   colorBackground: string
   initialExtent: JBounds | null
-  minimumVisibleMapboxZoom: number
-  maximumVisibleMapboxZoom: number
+  minimumVisibleZoom: number
+  maximumVisibleZoom: number
   mapUnit: JMAP_DISTANCE_UNITS
   apiKey: {
     google: string | null