jmapcloud-ng-core-types 0.3.0 → 0.3.2

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.3.0",
+  "version": "0.3.2",
   "description": "JMap Cloud specific version of JMap Cloud NG Core types and interfaces",
   "main": "index.js",
   "scripts": {
@@ -29,14 +29,13 @@
   "homepage": "https://github.com/k2geospatial/jmapcloud-ng-core-types#readme",
   "devDependencies": {
     "gulp": "^4.0.2",
-    "gulp-typedoc-k2": "^3.0.2-k2.1",
     "typedoc": "^0.24.8"
   },
   "dependencies": {
     "@types/geojson": "^7946.0.7",
-    "maplibre-gl": "^3.2.1",
     "@types/react": "^16.8.3",
     "geojson": "^0.5.0",
+    "maplibre-gl": "^3.2.1",
     "redux": "^4.0.0"
   }
 }

package/public/core.d.ts

@@ -3,7 +3,7 @@
  *
  * Examples are availables <a href="https://doc.k2geospatial.com/jmap/doc/ng_dev/examples.html" target="_blank">here</a>.
  *
- * You can customize JMap Cloud NG Core library by providing startup options ([[JCoreOptions]]).
+ * You can customize JMap Cloud NG Core library by providing startup options ({@link JCoreOptions}).
  *
  * After being loaded, the **NG Core** library is accessible through the namespace **JMap** in the javascript console. For example :
  * ```ts
@@ -87,7 +87,7 @@ declare namespace JMap {
    *
    * Returns the operating system on witch JMap Cloud NG Core library is running client side.
    *
-   * Possible values returned are defined here [[JOPERATING_SYSTEMS]].
+   * Possible values returned are defined here {@link JOPERATING_SYSTEMS}.
    *
    * @example ```ts
    *
@@ -230,7 +230,7 @@ declare namespace JMap {
     /**
      * **JMap.Server.getIdentityProviderById**
      *
-     * Returns the specified Identity Provider. Provider Ids can be derived from [[JMap.Server.getAllIdentityProvidersById]]
+     * Returns the specified Identity Provider. Provider Ids can be derived from {@link JMap.Server.getAllIdentityProvidersById}
      *
      * @throws if specified provider id is not valid or not found, or if the server is not ready (info from server has not been fetched). Call JMap.Server.isReady() to know this information.
      * @param providerId the provider identity id
@@ -369,9 +369,9 @@ declare namespace JMap {
     /**
      * **JMap.Geocoding.forwardSearch**
      *
-     * Proceeds with a forward geocoding search. Some characters are not permitted in search strings (see [[JMap.Geocoding.getInvalidSearchStringCharacters]]).
+     * Proceeds with a forward geocoding search. Some characters are not permitted in search strings (see {@link JMap.Geocoding.getInvalidSearchStringCharacters}).
      * Calling this method may not trigger immediately a forward geocoding search if the string is too short, or if the method is repetitively called too fast.
-     * You can set an event listener to have access to the forward search results (see [[TBD]]). Search Reasults are also available in the redux store under store-->geocoding-->results
+     * You can set an event listener to have access to the forward search results. Search Reasults are also available in the redux store under store-->geocoding-->results
      *
      * @param searchText The place name to search for. Can be an address, a region's name, or a geographical location expressed as "longitude,latitude" (ex: "-73.576321,45.495757" )
      * @param options an optional JGeocodingOptions object
@@ -395,7 +395,7 @@ declare namespace JMap {
     /**
      * **JMap.Geocoding.displayForwardSearchResult**
      *
-     * Will display on the map the result of a [[JMap.Geocoding.forwardSearch]] single result.
+     * Will display on the map the result of a {@link JMap.Geocoding.forwardSearch} single result.
      *
      * @param forwardSearchResult A JGeocodingResult object
      * @throws If geocoding is not enabled, or if an unexpected error occurs
@@ -442,7 +442,7 @@ declare namespace JMap {
      *
      * Returns false if the JMap Cloud NG Core library has been started with option that disable the geolocation.
      *
-     * See startup parameter [[JCoreOption.geolocationEnabled]].
+     * See startup parameter {@link JCoreOptions.geolocationEnabled}.
      *
      * @example ```ts
      *
@@ -739,7 +739,7 @@ declare namespace JMap {
      * @param parameterName: the name of the parameter
      * @param fn: the function that will be processed when the property changed
      *
-     * @returns the listener id, can be used to remove the listener with [[JMap.History.removePropertyChangeListener]]
+     * @returns the listener id, can be used to remove the listener with {@link JMap.History.removePropertyChangeListener}
      *
      * @throws Error if parameterName is not a valid string or fn is not a function
      *
@@ -759,7 +759,7 @@ declare namespace JMap {
      * **JMap.History.removePropertyChangeListener**
      *
      * You can detach a property listener by its id that has been returned when it has been created
-     * with function [[JMap.History.onParameterChange]].
+     * with function {@link JMap.History.onParameterChange}.
      *
      * After that the listener will be destroyed.
      *
@@ -945,7 +945,7 @@ declare namespace JMap {
        * Shows or hides a specific layer thematic category on the map.
        *
        * @throws Error if layer or thematic is not found, or if an invalid param is provided
-       * @param params a [[JLayerThematicSetCategoryVisibilityParams]] object
+       * @param params a {@link JLayerThematicSetCategoryVisibilityParams} object
        * @example ```ts
        *
        * // Hide the first category of thematic id=3 of layer id=7
@@ -988,7 +988,7 @@ declare namespace JMap {
        * Works only for JMap Cloud server.
        *
        * @throws Error if layer or thematic is not found, or thematic is not a style rule thematic, or if an invalid param is provided
-       * @param params a [[JLayerThematicSetConditionVisibilityParams]] object
+       * @param params a {@link JLayerThematicSetConditionVisibilityParams} object
        * @example ```ts
        *
        * // Hide condition of thematic id="ac7b197c-ca14-4295-b349-8cba6a4dc631" of layer id="53ff7632-0d5e-497a-a1b0-25ce3f941023"
@@ -2451,7 +2451,7 @@ declare namespace JMap {
     /**
      * **JMap.Geometry.getFeatureFromLine**
      *
-     * Returns a line feature from a line object ([[JLine]]).
+     * Returns a line feature from a line object ({@link JLine}).
      *
      * @param line A line array
      * @example ```ts
@@ -2483,7 +2483,7 @@ declare namespace JMap {
     /**
      * **JMap.Geometry.getPolygonFeatureFromCircle**
      *
-     * Returns a polygon feature from a circle object ([[JCircle]]).
+     * Returns a polygon feature from a circle object ({@link JCircle}).
      *
      * @param circle A circle object
      * @param units unit of the radius
@@ -2499,7 +2499,7 @@ declare namespace JMap {
     /**
      * **JMap.Geometry.getFeatureFromPolygon**
      *
-     * Returns a polygon feature from a polygon array ([[JPolygon]]).
+     * Returns a polygon feature from a polygon array ({@link JPolygon}).
      *
      * @param polygon A polygon array
      * @example ```ts
@@ -2514,7 +2514,7 @@ declare namespace JMap {
     /**
      * **JMap.Geometry.getBboxFromFeature**
      *
-     * Returns the feature geometry boundary box ([[JBoundaryBox]]).
+     * Returns the feature geometry boundary box ({@link JBoundaryBox}).
      *
      * @param feature A feature object
      * @example ```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
@@ -3711,7 +3711,7 @@ declare namespace JMap {
      *
      * Display a pulsing dot on the map to hilite a location, with options
      *
-     * Flashed feature can be immediatly removed using [[JMap.Map.clearFlashingLocations]]
+     * Flashed feature can be immediatly removed using {@link JMap.Map.clearFlashingLocations}
      *
      * @param location a JLocation
      * @param options (see example)
@@ -3756,7 +3756,7 @@ declare namespace JMap {
      *
      * Display a collection of pulsing dots on the map to hilite several locations, with options
      *
-     * Flashed features can be immediatly removed using [[JMap.Map.clearFlashingLocations]]
+     * Flashed features can be immediatly removed using {@link JMap.Map.clearFlashingLocations}
      *
      * @param locations an array of JLocations
      * @param options (see example)
@@ -3799,7 +3799,7 @@ declare namespace JMap {
     /**
      * **JMap.Map.clearFlashingLocations**
      *
-     * Immediatly remove all flashed locations on the map that have been displayed using [[JMap.Map.flashLocation]] or [[JMap.Map.flashLocations]]
+     * Immediatly remove all flashed locations on the map that have been displayed using {@link JMap.Map.flashLocation} or {@link JMap.Map.flashLocations}
      *
      * @example ```ts
      *
@@ -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
@@ -4142,7 +4142,7 @@ declare namespace JMap {
      *
      * So we defined our own map interactors for JMap, and we also allow you to create and register your own interactors.
      *
-     * An interactor is a JS object that define 4 functions (for more details consult interface [[JMapInteractor]]) :
+     * An interactor is a JS object that define 4 functions (for more details consult interface {@link JMapInteractor}) :
      * ```ts
      *  - init(map: maplibregl.Map): void
      *  - activate(): void
@@ -4664,7 +4664,7 @@ declare namespace JMap {
        * @throws Error if layer is not found or location format is not good
        * @param layerId The JMap layer id
        * @param location The location where you want feature selection
-       * @param params selection parameters, see [[JMapSelectionParams]]
+       * @param params selection parameters, see {@link JMapSelectionParams}
        * @returns The features array
        * @example ```ts
        *
@@ -4686,7 +4686,7 @@ declare namespace JMap {
        * @throws Error if layer is not found or if circle format is not good
        * @param layerId The JMap layer id
        * @param circle The circle
-       * @param params selection parameters, see [[JMapSelectionParams]]
+       * @param params selection parameters, see {@link JMapSelectionParams}
        * @returns The features array
        * @example ```ts
        *
@@ -4715,7 +4715,7 @@ declare namespace JMap {
        * @throws Error if layer is not found or if line format is not good
        * @param layerId The JMap layer id
        * @param line The line
-       * @param params selection parameters, see [[JMapSelectionParams]]
+       * @param params selection parameters, see {@link JMapSelectionParams}
        * @returns The features array
        * @example ```ts
        *
@@ -4741,7 +4741,7 @@ declare namespace JMap {
        * @throws Error if layer is not found or if line format is not good
        * @param layerId The JMap layer id
        * @param polygon The line
-       * @param params selection parameters, see [[JMapSelectionParams]]
+       * @param params selection parameters, see {@link JMapSelectionParams}
        * @returns The features array
        * @example ```ts
        *
@@ -4772,7 +4772,7 @@ declare namespace JMap {
        *
        * @throws Error if location format is not good
        * @param location The location where you want feature selection
-       * @param params selection parameters, see [[JMapSelectionParams]]
+       * @param params selection parameters, see {@link JMapSelectionParams}
        * @returns The new feature selection
        * @example ```ts
        *
@@ -4789,7 +4789,7 @@ declare namespace JMap {
        *
        * @throws Error if circle format is not good
        * @param circle The circle
-       * @param params selection parameters, see [[JMapSelectionParams]]
+       * @param params selection parameters, see {@link JMapSelectionParams}
        * @returns The new feature selection
        * @example ```ts
        *
@@ -4810,7 +4810,7 @@ declare namespace JMap {
        *
        * @throws Error if line format is not good
        * @param line The line
-       * @param params selection parameters, see [[JMapSelectionParams]]
+       * @param params selection parameters, see {@link JMapSelectionParams}
        * @returns The new feature selection
        * @example ```ts
        *
@@ -4832,7 +4832,7 @@ declare namespace JMap {
        *
        * @throws Error if polygon format is not good
        * @param polygon The polygon
-       * @param params selection parameters, see [[JMapSelectionParams]]
+       * @param params selection parameters, see {@link JMapSelectionParams}
        * @returns The new feature selection
        * @example ```ts
        *
@@ -5030,7 +5030,7 @@ declare namespace JMap {
        *
        * Returns true if basemaps are disabled.
        *
-       * Can be disabled with option disableBasemaps [[JCoreOptions]] in JS options, or with url param "ngDisableBasemaps=true".
+       * Can be disabled with option disableBasemaps {@link JCoreOptions} in JS options, or with url param "ngDisableBasemaps=true".
        *
        * @example ```ts
        *
@@ -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
@@ -5874,7 +5874,7 @@ declare namespace JMap {
     /**
      * **JMap.Project.isChangeDisabled**
      *
-     * Returns true if the project change has been disabled by startup option "disableProjectChange" (see [[JCoreOptions]]).
+     * Returns true if the project change has been disabled by startup option "disableProjectChange" (see {@link JCoreOptions}).
      *
      * Notice that as long the first project has not been loaded, this method returns false even if the parameter is true.
      *
@@ -6167,7 +6167,7 @@ declare namespace JMap {
      *
      * For JMapCloud only.
      *
-     * Sets and returns Session Data specific to a JMap Cloud organization. You need to be previously authenticated via the [[JMap.User.login]] method before calling this method.
+     * Sets and returns Session Data specific to a JMap Cloud organization. You need to be previously authenticated via the {@link JMap.User.login} method before calling this method.
      * This method can also be used to switch between organizations while a user is already logged in.
      *
      * @throws Error if user is not authenticated
@@ -6203,7 +6203,7 @@ declare namespace JMap {
     /**
      * **JMap.User.loginWithIdentityProvider**
      *
-     * Logs in the user using the specified Identity Provider. See [[JMap.Server.getAllIdentityProvidersById]] for info about Identity providers
+     * Logs in the user using the specified Identity Provider. See {@link JMap.Server.getAllIdentityProvidersById} for info about Identity providers
      *
      * @example ```ts
      *
@@ -6261,9 +6261,9 @@ declare namespace JMap {
      *
      * This process is a bit different for JMap Server than for JMap CLoud.
      *
-     * For JMap Server, you need to fetch a session token from the REST API, and call [[JMap.User.setToken]] without spedifying the organization Id.
+     * For JMap Server, you need to fetch a session token from the REST API, and call {@link JMap.User.setToken} without spedifying the organization Id.
      *
-     * For JMap Cloud, you need to fetch a ***refresh token*** from the JMap Cloud Rest API, and pass this refresh token, along with the the optional organisation Id, to the [[JMap.User.setToken]] method. Beware that a refresh token can only be used once, it is invalidated afterward
+     * For JMap Cloud, you need to fetch a ***refresh token*** from the JMap Cloud Rest API, and pass this refresh token, along with the the optional organisation Id, to the {@link JMap.User.setToken} method. Beware that a refresh token can only be used once, it is invalidated afterward
      *
      * Fetching data from a REST API can be done with the curl command-line tool (https://curl.haxx.se/docs/)
      *
@@ -6610,7 +6610,7 @@ declare namespace JMap {
      * 
      * @example ```ts
      * 
-     * // Supported locales can be retrieved by calling [[JMap.Language.getLocales()]]
+     * // Supported locales can be retrieved by calling JMap.Language.getLocales()
      * const locale = "fr"
      * JMap.Language.setLocale(locale)
      * ```
@@ -6627,11 +6627,11 @@ declare namespace JMap {
      * in your bundle for the current locale.
      *
      * @throws if bundle is invalid or already defined
-     * @param bundle a [[JTranslationBundle]] object
+     * @param bundle a {@link JTranslationBundle} object
      *
      * @example ```ts
      *
-     * // Supported locales can be retrieved by calling [[JMap.Language.getLocales()]]
+     * // Supported locales can be retrieved by calling JMap.Language.getLocales()
      *
      * const bundle = {
      *  id: "my-custom-bundle-id",
@@ -6718,7 +6718,7 @@ declare namespace JMap {
      *
      * @example ```ts
      *
-     * // Supported locales can be retrieved by calling [[JMap.Language.getLocales()]]
+     * // Supported locales can be retrieved by calling JMap.Language.getLocales()
      *
      * const bundle = {
      *  id: "my-custom-bundle-id",
@@ -6987,7 +6987,7 @@ declare namespace JMap {
      *
      * Here you can manage all JMap Cloud NG Core high level event listeners.
      *
-     * Click to see all events available: ***[[JMap.Event.Main.on]]***.
+     * Click to see all events available: ***{@link JMap.Event.Main.on}***.
      */
     namespace Main {
       /**
@@ -7110,7 +7110,7 @@ declare namespace JMap {
      *
      * Here you can manage all query event listeners.
      *
-     * Click to see all events available: ***[[JMap.Event.Query.on]]***.
+     * Click to see all events available: ***{@link JMap.Event.Query.on}***.
      */
     namespace Query {
       /**
@@ -7254,7 +7254,7 @@ declare namespace JMap {
      *
      * Here you can manage all geocoding event listeners.
      *
-     * Click to see all events available: ***[[JMap.Event.Geocoding.on]]***.
+     * Click to see all events available: ***{@link JMap.Event.Geocoding.on}***.
      */
     namespace Geocoding {
       /**
@@ -7445,7 +7445,7 @@ declare namespace JMap {
      *
      * Here you can manage all JMap Cloud NG map context event listeners.
      *
-     * Click to see all events available: ***[[JMap.Event.MapContext.on]]***.
+     * Click to see all events available: ***{@link JMap.Event.MapContext.on}***.
      */
     namespace MapContext {
       /**
@@ -7664,7 +7664,7 @@ declare namespace JMap {
      *
      * Here you can manage all extension event listeners.
      *
-     * List of events are located in ***[[JMap.Event.Extension.on]]***.
+     * List of events are located in ***{@link JMap.Event.Extension.on}***.
      */
     namespace Extension {
       /**
@@ -7788,7 +7788,7 @@ declare namespace JMap {
      *
      * Here you can manage all form event listeners.
      *
-     * Click to see all events available: ***[[JMap.Event.Form.on]]***.
+     * Click to see all events available: ***{@link JMap.Event.Form.on}***.
      */
     namespace Form {
       /**
@@ -8001,7 +8001,7 @@ declare namespace JMap {
      *
      * Here you can manage all project related event listeners.
      *
-     * Click to see all events available: ***[[JMap.Event.Project.on]]***.
+     * Click to see all events available: ***{@link JMap.Event.Project.on}***.
      */
     namespace Project {
       /**
@@ -8153,7 +8153,7 @@ declare namespace JMap {
      *
      * Here you can manage all layer related event listeners.
      *
-     * Click to see all events available: ***[[JMap.Event.Layer.on]]***.
+     * Click to see all events available: ***{@link JMap.Event.Layer.on}***.
      */
     namespace Layer {
       /**
@@ -8379,7 +8379,7 @@ declare namespace JMap {
          *
          * This event is triggered when some dynamic filters are set.
          *
-         * Could happen when a map context is applied, or when we use the method [[JMap.Layer.DynamicFilter.set]].
+         * Could happen when a map context is applied, or when we use the method {@link JMap.Layer.DynamicFilter.set}.
          *
          * @param listenerId Your listener id (must be unique for all layer events)
          * @param fn Your listener function
@@ -8548,7 +8548,7 @@ declare namespace JMap {
      *
      * Here you can manage all map related event listeners.
      *
-     * Click to see all events available: ***[[JMap.Event.Map.on]]***.
+     * Click to see all events available: ***{@link JMap.Event.Map.on}***.
      */
     namespace Map {
       /**
@@ -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
          *      )
          *    }
          * )
@@ -9108,7 +9108,7 @@ declare namespace JMap {
      *
      * Here you can manage all photo event listeners.
      *
-     * Click to see all events available: ***[[JMap.Event.Photo.on]]***.
+     * Click to see all events available: ***{@link JMap.Event.Photo.on}***.
      */
     namespace Photo {
       /**
@@ -9198,7 +9198,7 @@ declare namespace JMap {
      *
      * Here you can manage all feature related event listeners.
      *
-     * Click to see all events available: ***[[JMap.Event.Feature.on]]***.
+     * Click to see all events available: ***{@link JMap.Event.Feature.on}***.
      */
     namespace Feature {
       /**
@@ -9325,7 +9325,7 @@ declare namespace JMap {
      *
      * Here you can manage all language related event listeners.
      *
-     * Click to see all events available: ***[[JMap.Event.Language.on]]***.
+     * Click to see all events available: ***{@link JMap.Event.Language.on}***.
      */
     namespace Language {
       /**
@@ -9413,7 +9413,7 @@ declare namespace JMap {
      *
      * Here you can manage all user related event listeners.
      *
-     * Click to see all events available: ***[[JMap.Event.User.on]]***.
+     * Click to see all events available: ***{@link JMap.Event.User.on}***.
      */
     namespace User {
       /**
@@ -9510,7 +9510,7 @@ declare namespace JMap {
      *
      * Here you can manage all mouseover related event listeners.
      *
-     * List of events are located in ***[[JMap.Event.MouseOver.on]]***.
+     * List of events are located in ***{@link JMap.Event.MouseOver.on}***.
      */
     namespace MouseOver {
       /**
@@ -9712,7 +9712,7 @@ declare namespace JMap {
    *
    * This mecanism provide a clean way to integrate in JMap your own extension plugin.
    *
-   * You can create an object that implement the interface [[JCoreExtension]], and register it
+   * You can create an object that implement the interface {@link JCoreExtension}, and register it
    * from this section.
    *
    * By example you register an extension with id="***MyCompany***"".
@@ -10100,7 +10100,7 @@ declare namespace JMap {
      *
      * Returns the currently displayed form.
      *
-     * Use [[JMap.Form.hasDisplayedForm()]] to know if a form is currently displayed.
+     * Use {@link JMap.Form.hasDisplayedForm} to know if a form is currently displayed.
      *
      * @throws if no layer is displayed
      * @example ```ts
@@ -10119,7 +10119,7 @@ declare namespace JMap {
      *
      * Resets the currently displayed form.
      *
-     * Use [[JMap.Form.hasDisplayedForm()]] to know if a form is currently displayed.
+     * Use {@link JMap.Form.hasDisplayedForm} to know if a form is currently displayed.
      *
      * @throws if no layer is displayed
      * @example ```ts
@@ -10142,7 +10142,7 @@ declare namespace JMap {
      *
      * Index starts at 0 (attribute form), 1 (first external form), etc...
      *
-     * Use [[JMap.Form.hasDisplayedForm()]] to know if a form is currently displayed.
+     * Use {@link JMap.Form.hasDisplayedForm} to know if a form is currently displayed.
      *
      * @param tabIndex the tab index
      * @throws if no layer is displayed, if index is invalid.
@@ -10305,7 +10305,7 @@ declare namespace JMap {
      *  const layerId = 3
      *  const featureId = 4
      *  // in this exemple we fetch the feature from the server, but we could get from the map
-     *  // with the following method [[JMap.Map.getRenderedFeatures]]
+     *  // with the following method JMap.Map.getRenderedFeatures
      *  const feature = await JMap.Feature.getById(layerId, featureId)
      *  // opens form update dialog for one element of layer id=3
      *  JMap.Form
@@ -11377,7 +11377,7 @@ declare namespace JMap {
      *
      * Throws an Error if the passed Id is not a valid JMap Id, otherwise does nothing. You can use this method as a safeguard in your methods that accept JMap Ids.
      * JMap.Util.checkJmapId always run a strict check on the passed value, i.e. the string "123" will not pass. If you want the value to be compliant, you
-     * can use [[JMap.Util.getJmapIdAsIntegerIfPossible]] to transform it.
+     * can use {@link JMap.Util.getJmapIdAsIntegerIfPossible} to transform it.
      *
      *
      * @param id The JMap Id to validate
@@ -11674,7 +11674,7 @@ declare namespace JMap {
      *
      * Updates a map context meta-data (= data that describe the context), without changing the map data.
      *
-     * The map context map's data will not be changed, for that use [[JMap.MapContext.update]] function.
+     * The map context map's data will not be changed, for that use {@link JMap.MapContext.update} function.
      *
      * The map-context meta-data is persisted server-side.
      *
@@ -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

@@ -6,9 +6,9 @@ declare interface JExtensionServerOverride {
   /**
    * The extension's override unique identifier.
    *
-   * For JMap CLoud, this would be the [[JCoreExtension.jmapCloudExtensionUrn]] property of your extension
+   * For JMap CLoud, this would be the {@link JCoreExtension.jmapCloudExtensionUrn} property of your extension
    *
-   * For JMap Server, this would be the [[JCoreExtension.serverExtensionId]] property of your extension
+   * For JMap Server, this would be the {@link JCoreExtension.serverExtensionId} property of your extension
    *
    */
   extensionUniqueIdentifier: string
@@ -84,11 +84,11 @@ declare interface JCoreExtension {
    *
    * This parameter is used to uniquely identify your extension among all other JMap Cloud extensions.
    *
-   * This parameter can be set alongside [[JCoreExtension.serverExtensionId]] if your extension is also available for JMap Server.
+   * This parameter can be set alongside {@link JCoreExtension.serverExtensionId} if your extension is also available for JMap Server.
    *
    * If set, this parameter ***must*** be a {@link https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random)|UUID v4 string}. Each Jmap Cloud extension must have a unique identifier, so you have to make sure that each of your extensions defines a unique `jmapCloudExtensionUrn`.
    *
-   * JMap Cloud ***only*** supports [[JCoreExtension.isProjectExtension|Project extensions]]
+   * JMap Cloud ***only*** supports {@link JCoreExtension.isProjectExtension|Project extensions}
    *
    */
   jmapCloudExtensionUrn?: string
@@ -113,7 +113,7 @@ declare interface JCoreExtension {
   startBeforeMapIsReady?: boolean
   /**
    * You can provide a translation bundle for your extesion. All translations will be handled by the JMap Cloud NG
-   * translation engine. See [[JMap.Language.addBundle]] for more details on bundles
+   * translation engine. See {@link JMap.Language.addBundle} for more details on bundles
    */
   translationBundle?: JTranslationBundle
   /**
@@ -147,7 +147,7 @@ declare interface JCoreExtension {
    *
    * Like that you can develop UI component that react to the redux state changes.
    *
-   * You can get the data store using this function : [[JMap.getDataStore]], and then dispatch
+   * You can get the data store using this function : {@link JMap.getDataStore}, and then dispatch
    * your own actions.
    *
    * A redux reducer is a pure JS function that take the current reducer state (can be undefined first time)
@@ -157,7 +157,7 @@ declare interface JCoreExtension {
   /**
    * You can provide a renderMouseOver function.
    *
-   * If set, this function has to return a [[JExtensionMouseOver]], and it will be displayed
+   * If set, this function has to return a {@link JExtensionMouseOver}, and it will be displayed
    * at the end of the standard mouseover.
    *
    * @param layer The JMap layer object
@@ -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

package/public/jmap/startup-options.d.ts

@@ -263,9 +263,9 @@ declare interface JCoreOptions {
   /**
    * The JMap user's session token.
    *
-   * If you don't use the library with an anonymous user (see the [[***JCoreOptions.anonymous***]] parameter in this section), you must provide a JMap Server session token or a JMap Cloud refresh token to the JMap library.
+   * If you don't use the library with an anonymous user (see the ***{@link JCoreOptions.anonymous}*** parameter in this section), you must provide a JMap Server session token or a JMap Cloud refresh token to the JMap library.
    *
-   * To get a session or refresh token, you can use the JMap Rest API on your JMap Server. See [[JMap.User.setToken]] for detailed examples on how to fetch a token through JMap's REST API.
+   * To get a session or refresh token, you can use the JMap Rest API on your JMap Server. See {@link JMap.User.setToken} for detailed examples on how to fetch a token through JMap's REST API.
    *
    * So to start the library using the fetched token you can configure your startup options like this :
    * ```html
@@ -328,7 +328,7 @@ declare interface JCoreOptions {
   /**
    * The JMap Cloud organization id associated with the refresh token.
    *
-   * For JMap CLoud only. Only taken into account if a refresh token has been passed via the [[JCoreOptions.token]] startup option (or the equivalent hash parameter version)
+   * For JMap CLoud only. Only taken into account if a refresh token has been passed via the {@link JCoreOptions.token} startup option (or the equivalent hash parameter version)
    * ***or*** if the "anonymous" option has been passed, together with a project id.
    *
    * You can pass this organization id to open a session on JMap Cloud via the startup options.
@@ -394,14 +394,14 @@ declare interface JCoreOptions {
   /**
    * All map related options.
    *
-   * Click on [[JCoreMapOptions]] to get details.
+   * Click on {@link JCoreMapOptions} to get details.
    */
   map?: JCoreMapOptions
 
   /**
    * Optional extensions.
    *
-   * Click [[JCoreExtension]] to get details about how defining an extension.
+   * Click {@link JCoreExtension} to get details about how defining an extension.
    */
   extensions?: JCoreExtension[]
 
@@ -413,7 +413,7 @@ declare interface JCoreOptions {
   /**
    * If set to any of the locales supported by JMap, will define the default locale, bypassing browser or user-defined locale.
    *
-   * Supported locales  can be retrieved by calling [[JMap.User.getLocales()]]
+   * Supported locales  can be retrieved by calling {@link JMap.Language.getLocales}
    */
   locale?: string
 
@@ -476,7 +476,7 @@ declare interface JCoreOptions {
    *
    * If provided, will use the corresponding basemap as the default basemap.
    *
-   * If the id is unknown, will do nothing. To get all basemaps ids in the project, use [[JMap.Map.Basemap.getAllIds()]]
+   * If the id is unknown, will do nothing. To get all basemaps ids in the project, use {@link JMap.Map.Basemap.getAllIds}
    *
    * Using the id "none" will use no basemap at startup.
    *