jmapserver-ng-core-types 2.0.7 → 2.0.9

package/all-enums.ts

@@ -279,5 +279,6 @@ export const ALL_MAP_RASTER_SCHEME_TYPES: JMAP_RASTER_SCHEME_TYPES[] = [
 ]
 
 export const ALL_JORGANIZATION_EXTERNAL_API_KEY_TYPES: JORGANIZATION_EXTERNAL_API_KEY_TYPES[] = [
-  JORGANIZATION_EXTERNAL_API_KEY_TYPES.MAPBOX_ACCESS_TOKEN
+  JORGANIZATION_EXTERNAL_API_KEY_TYPES.MAPBOX_ACCESS_TOKEN,
+  JORGANIZATION_EXTERNAL_API_KEY_TYPES.GOOGLE_MAPS_API_KEY
 ]

package/index.ts

@@ -140,6 +140,7 @@ export interface JPhotoService {
 
 export interface JFeatureService {
   getById(layerId: JId, featureId: JId): Promise<GeoJSON.Feature>
+  getByLayerId(layerId: JId, bbox: JBoundaryBox): Promise<GeoJSON.Feature[]>
   getByIds(layerId: JId, featureIds: JId[]): Promise<GeoJSON.Feature[]>
   geometryUpdateById(params: JFeatureGeometryUpdateParams): Promise<GeoJSON.Feature>
   deleteById(layerId: JId, featureId: JId): Promise<GeoJSON.Feature>
@@ -734,6 +735,7 @@ export interface JMapBasemapService {
   isDisabled(): boolean
   isActive(): boolean
   isMapboxId(basemapId: string): boolean
+  isGoogleMapsId(basemapId: string): boolean
   isOSMId(basemapId: string): boolean
   getActiveId(): string | undefined
   existsById(basemapId: string): boolean

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jmapserver-ng-core-types",
-  "version": "2.0.7",
+  "version": "2.0.9",
   "description": "JMap Server specific version of JMap Server NG Core types and interfaces",
   "main": "index.js",
   "scripts": {

package/public/core.d.ts

@@ -469,6 +469,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="3" and bbox
+     * JMap.Feature.getByLayer(3, {
+     *   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**
      *
@@ -5057,6 +5084,22 @@ declare namespace JMap {
        */
       function isOSMId(basemapId: string): boolean
 
+      /**
+       * ***JMap.Map.Basemap.isGoogleMapsId***
+       *
+       * Returns true if the basemap id is a Google Maps basemap.
+       *
+       * @example ```ts
+       *
+       * // returns true
+       * JMap.Map.Basemap.isGoogleMapsId("google-roadmap")
+       *
+       * // returns false
+       * JMap.Map.Basemap.isGoogleMapsId("mapbox-streets")
+       * ```
+       */
+      function isGoogleMapsId(basemapId: string): boolean
+
       /**
        * ***JMap.Map.Basemap.getActiveId***
        *

package/public/jmap/map.d.ts

@@ -321,6 +321,36 @@ declare interface JCoreMapOptions {
    */
   mapboxToken?: string
 
+  /**
+   * If a Google Maps API key is set through the JMap Admin interface,
+   * the JMap Server NG Core library will use it automatically, nothing else to do for you.
+   *
+   * The Google Maps API key is used by JMap Server NG in order to display Google basemaps and to use other Google related functionalities.
+   *
+   * In order to use Google basemaps, you need to enable the Map Tiles API in your Google account. See the {@link https://developers.google.com/maps/documentation/tile/cloud-setup?_gl=1*hgipm1*_up*MQ..*_ga*MTE3OTc5MTI1Ni4xNzEyMzI0Njc4*_ga_NRWSTWS78N*MTcxMjMyNDY3Ny4xLjAuMTcxMjMyNDY3Ny4wLjAuMA.. |documentation} for more details about this
+   *
+   * If no Google Maps API key is set in JMap Admin, or if you want to use
+   * the Google Maps API key of your choice, you have to set the "***googleMapsApiKey***" parameter :
+   *
+   * ```html
+   * <html>
+   *   ...
+   *   <body>
+   *     <script type="text/javascript">
+   *       window.JMAP_OPTIONS = {
+   *         ...
+   *         map: {
+   *           googleMapsApiKey: "google-maps-api-key"
+   *         }
+   *       }
+   *     </script>
+   *     ...
+   *   </body>
+   * </html>
+   * ```
+   */
+  googleMapsApiKey?: string
+
   /**
    * By default the Map Rotation control is not visible.
    *

package/public/jmap/user.d.ts

@@ -81,5 +81,6 @@ declare interface JJMapPasswordPolicyCompliance {
 
 // ALL_JORGANIZATION_EXTERNAL_API_KEY_TYPES in all-enum.ts
 declare const enum JORGANIZATION_EXTERNAL_API_KEY_TYPES {
-  MAPBOX_ACCESS_TOKEN = "MAPBOX_ACCESS_TOKEN"
+  MAPBOX_ACCESS_TOKEN = "MAPBOX_ACCESS_TOKEN",
+  GOOGLE_MAPS_API_KEY = "GOOGLE_MAPS_API_KEY"
 }