jmapcloud-ng-core-types 1.0.6 → 1.0.8

package/index.ts

@@ -148,6 +148,7 @@ export interface JPhotoService {
 export interface JFeatureService {
   getById(layerId: JId, featureId: JId): Promise<GeoJSON.Feature>
   getByIds(layerId: JId, featureIds: JId[]): Promise<GeoJSON.Feature[]>
+  getByLayerId(layerId: JId, bbox: JBoundaryBox): Promise<GeoJSON.Feature[]>
   geometryUpdateById(params: JFeatureGeometryUpdateParams): Promise<GeoJSON.Feature>
   deleteById(layerId: JId, featureId: JId): Promise<JId>
   // deleteByIds(layerId: JId, featureIds: JId[]): Promise<JFeatureDeleteByIdsResult>
@@ -708,14 +709,10 @@ export interface JMapService {
   setMapInfoControlVisibility(isVisible: boolean): void
   isMapInfoControlExpanded(): boolean
   setMapInfoControlExpansion(isExpanded: boolean): void
-  isLayerRendered(layerId: JId): boolean
-  getLayersVisibilityStatus(): JMapLayersVisibilityStatus
-  getLayersVisibilityStatusAsArray(): JMapLayerVisibilityStatus[]
   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[]
   getSourceFeatures(layerId: JId, params?: JGetSourceFeaturesParams): Feature[]
   getRenderedFeaturesAttributeValues(
@@ -825,8 +822,8 @@ export interface JMapFilterService {
 }
 
 export interface JProjectionService {
-  reprojectLocation(location: JLocation, toProjection: string, fromProjection?: string): JLocation
-  reprojectBoundaryBox(boundaryBox: JBoundaryBox, toProjection: string, fromProjection?: string): JBoundaryBox
+  reprojectLocation(location: JLocation, toProjection: string, fromProjection?: string): Promise<JLocation>
+  reprojectBoundaryBox(boundaryBox: JBoundaryBox, toProjection: string, fromProjection?: string): Promise<JBoundaryBox>
 }
 
 export interface JProjectService {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jmapcloud-ng-core-types",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "description": "JMap Cloud specific version of JMap Cloud NG Core types and interfaces",
   "main": "index.js",
   "scripts": {

package/public/core.d.ts

@@ -129,7 +129,6 @@ declare namespace JMap {
      */
     function getVersion(): JServerVersion
 
-
     /**
      * **JMap.Server.isMinimumVersionRespected**
      *
@@ -456,6 +455,33 @@ declare namespace JMap {
      */
     function getById(layerId: JId, featureId: JId): Promise<GeoJSON.Feature>
 
+    /**
+     * **JMap.Feature.getByLayerId**
+     *
+     * Returns the feature (EPSG:4326 projection) for the given layer and bbox.
+     *
+     * @param layerId the JMap layer id
+     * @param bbox the bounding box
+     * @throws if layer not found or bbox is invalid
+     * @example ```ts
+     *
+     * // returns the feature of layer id="36885146-7eed-4071-9f86-8e29c505af91" and bbox
+     * JMap.Feature.getByLayer("36885146-7eed-4071-9f86-8e29c505af91", {
+     *   ne: {
+     *     x: -73.69935286533261,
+     *     y: 45.51487645603402
+     *   },
+     *   sw: {
+     *     x: -73.78637009135603,
+     *     y: 45.47581946298703
+     *   }
+     * })
+     *   .then(features => console.info("Features has been fetched", features))
+     *   .catch(error => console.error("An error occured", error))
+     * ```
+     */
+
+    function getByLayerId(layerId: JId, bbox: JBoundaryBox): Promise<GeoJSON.Feature[]>
     /**
      * **JMap.Feature.getByIds**
      *
@@ -1834,20 +1860,16 @@ declare namespace JMap {
      *
      * Returns the extent of the layer in ESPG:4326 coordinates
      *
-     * With a JMap Cloud server, a call is made to the server.
-     *
-     * With a JMap 7 server, no call to server is made, returns the cached extent.
-     *
      * @example ```ts
      *
-     * // returns the bounding box (JBoundaryBox) of the layer ID 3 in decimal degrees
+     * // returns the bounding box (JBoundaryBox) of the layer ID "5d86a209-3a09-49d9-92f0-dce3c46bb23d" in decimal degrees
      * JMap.Layer
-     *  .getEPSG4326Extent(3)
-     *  .then(extent => console.info("Extent of layer id=3", extent))
+     *  .getEPSG4326Extent("5d86a209-3a09-49d9-92f0-dce3c46bb23d")
+     *  .then(extent => console.info("Extent of layer id=\"5d86a209-3a09-49d9-92f0-dce3c46bb23d\"", extent))
      *  .catch(error => console.error(error))
      * ```
      *
-     * @throws Error if no layer found for the id
+     * @throws Error if no layer found for the id or if layer is a group
      * @param layerId The JMap layer id
      */
     function getEPSG4326Extent(layerId: JId): Promise<JBoundaryBox | null>
@@ -3151,96 +3173,6 @@ declare namespace JMap {
      */
     function getScaleControlPosition(): JMAP_POSITIONS
 
-    /**
-     * **JMap.Map.isLayerRendered**
-     *
-     * Returns true if layer is visible on the map.
-     *
-     * To be true the layer visibility property has to be true,
-     * and the current map scale between the layer min and max scale.
-     *
-     * @example ```ts
-     *
-     * // returns true if layer is visible on the map
-     * JMap.Map.isLayerRendered(4)
-     * ```
-     */
-    function isLayerRendered(layerId: JId): boolean
-
-    /**
-     * **JMap.Map.getLayersVisibilityStatus**
-     *
-     * Returns layers visibility status.
-     *
-     * The result is a map (= javascript object) where :
-     *  - the key is the JMap layer id
-     *  - the value is a JMapLayersVisibilityStatus object
-     *
-     * A JMapLayersVisibilityStatus object has the following properties :
-     *  - layerId: the layer id
-     *  - layerName: the layer name
-     *  - isRendered: true if 'visibilityProperty', 'parentVisibility',
-     *                'scaleVisibility' and 'extentVisibility' are all true
-     *  - visibilityProperty: user can show or hide a layer
-     *  - parentVisibility: returns false if one of its group parent(s) has
-     *                      its visibility property equals to false
-     *  - scaleVisibility: returns false if at the current scale the layer
-     *                     cannot be displayed
-     *  - extentVisibility: returns false if the extent of the layer is not
-     *                      contains by the current view of the map
-     *
-     * @example ```ts
-     *
-     * // returns the visibility status
-     * JMap.Map.getLayersVisibilityStatus()
-     *
-     * // Example of result :
-     * {
-     *  1: { layerId: 1, layerName: "layer 1", isRendered: true, visibilityProperty: true, parentVisibility: true, scaleVisibility: true, extentVisibility: true }
-     *  2: { layerId: 2, layerName: "layer 2", isRendered: false, visibilityProperty: true, parentVisibility: true, scaleVisibility: false, extentVisibility: true }
-     *  3: { layerId: 3, layerName: "layer 3", isRendered: false, visibilityProperty: false, parentVisibility: true, scaleVisibility: false, extentVisibility: true }
-     *  4: { layerId: 4, layerName: "layer 4", isRendered: false, visibilityProperty: false, parentVisibility: false, scaleVisibility: false, extentVisibility: true }
-     *  5: { layerId: 5, layerName: "layer 5", isRendered: false, visibilityProperty: true, parentVisibility: true, scaleVisibility: true, extentVisibility: false }
-     * }
-     * ```
-     */
-    function getLayersVisibilityStatus(): JMapLayersVisibilityStatus
-
-    /**
-     * **JMap.Map.getLayersVisibilityStatusAsArray**
-     *
-     * Returns layers visibility status as an array of JMapLayersVisibilityStatus object.
-     *
-     * A JMapLayersVisibilityStatus object has the following properties :
-     *  - layerId: the layer id
-     *  - layerName: the layer name
-     *  - isRendered: true if 'visibilityProperty', 'parentVisibility',
-     *                'scaleVisibility' and 'extentVisibility' are all true
-     *  - visibilityProperty: user can show or hide a layer
-     *  - parentVisibility: returns false if one of its group parent(s) has
-     *                      its visibility property equals to false
-     *  - scaleVisibility: returns false if at the current scale the layer
-     *                     cannot be displayed
-     *  - extentVisibility: returns false if the extent of the layer is not
-     *                      contains by the current view of the map
-     *
-     * @example ```ts
-     *
-     * // returns the visibility status as an object array
-     * JMap.Map.getLayersVisibilityStatusAsArray()
-     *
-     * // Example of result :
-     * [
-     *  { layerId: 1, layerName: "layer 1", isRendered: true, visibilityProperty: true, parentVisibility: true, scaleVisibility: true, extentVisibility: true }
-     *  { layerId: 2, layerName: "layer 2", isRendered: false, visibilityProperty: true, parentVisibility: true, scaleVisibility: false, extentVisibility: true }
-     *  { layerId: 3, layerName: "layer 3", isRendered: false, visibilityProperty: false, parentVisibility: true, scaleVisibility: false, extentVisibility: true }
-     *  { layerId: 4, layerName: "layer 4", isRendered: false, visibilityProperty: false, parentVisibility: false, scaleVisibility: false, extentVisibility: true }
-     *  { layerId: 5, layerName: "layer 5", isRendered: false, visibilityProperty: true, parentVisibility: true, scaleVisibility: true, extentVisibility: false }
-     * ]
-     * ```
-     */
-    function getLayersVisibilityStatusAsArray(): JMapLayerVisibilityStatus[]
-
     /**
      * **JMap.Map.getMaplibreSupportedJMapLayerIds**
      *
@@ -3308,23 +3240,6 @@ declare namespace JMap {
      */
     function refreshLayerById(layerId: JId): void
 
-    /**
-     * **JMap.Map.getRenderedJMapLayerIds**
-     *
-     * Returns the ids of the layers that are displayed on the map.
-     *
-     * 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.
-     *
-     * @example ```ts
-     *
-     * // returns all layer ids that are managed by the map
-     * JMap.Map.getRenderedJMapLayerIds()
-     * ```
-     */
-    function getRenderedJMapLayerIds(): JId[]
-
     /**
      * **JMap.Map.getRenderedFeatures**
      *
@@ -5939,7 +5854,7 @@ declare namespace JMap {
      * @example ```ts
      *
      * // returns the location in long/lat
-     * const longLatLocation = JMap.Projection.reprojectLocation({
+     * const longLatLocation = await JMap.Projection.reprojectLocation({
      *    x: -8251305.053809433,
      *    y: 5683448.361086178
      *  },
@@ -5949,7 +5864,7 @@ declare namespace JMap {
      * console.log("Long/lat location", longLatLocation)
      * ```
      */
-    function reprojectLocation(location: JLocation, toProjection: string, fromProjection?: string): JLocation
+    function reprojectLocation(location: JLocation, toProjection: string, fromProjection?: string): Promise<JLocation>
 
     /**
      * ***JMap.Projection.reprojectBoundaryBox***
@@ -5963,7 +5878,7 @@ declare namespace JMap {
      * @example ```ts
      *
      * // returns the boundary box in long/lat
-     * const longLatBbox = JMap.Projection.reprojectBoundaryBox({
+     * const longLatBbox = await JMap.Projection.reprojectBoundaryBox({
      *    x: -8251305.053809433,
      *    y: 5683448.361086178
      *  },
@@ -5977,7 +5892,7 @@ declare namespace JMap {
       boundaryBox: JBoundaryBox,
       toProjection: string,
       fromProjection?: string
-    ): JBoundaryBox
+    ): Promise<JBoundaryBox>
   }
 
   /**
@@ -6474,9 +6389,7 @@ declare namespace JMap {
      * /*
      * ```
      */
-    function getPasswordPolicyCompliance(
-      password: string
-    ): JJMapPasswordPolicyCompliance
+    function getPasswordPolicyCompliance(password: string): JJMapPasswordPolicyCompliance
 
     /**
      * ***JMap.User.isPseudoUser***

package/public/jmap/map.d.ts

@@ -123,20 +123,6 @@ declare type JMapSelection = {
   [key in JId]: GeoJSON.Feature[]
 }
 
-declare interface JMapLayerVisibilityStatus {
-  layerId: JId
-  layerName: string
-  isRendered: boolean
-  visibilityProperty: boolean
-  parentVisibility: boolean
-  scaleVisibility: boolean
-  extentVisibility: boolean
-}
-
-declare type JMapLayersVisibilityStatus = {
-  [key in JId]: JMapLayerVisibilityStatus
-}
-
 declare interface JProjection {
   code: string
   name: string