jmapcloud-ng-core-types 1.1.39 → 1.1.41

package/README.md

@@ -1,7 +1,7 @@
 # jmapcloud-ng-core-types
+
 JMap Cloud NG Core
 
 The latest version of the JMap Cloud NG Core Javascript API documentation is available <a href="https://k2geospatial.github.io/jmapcloud-frontend/jmapcloud-ng-core-types/latest" target="_blank">here</a>.
 
 Examples and user documentation are available <a href="https://docs.jmapcloud.io/en/jmap-ng/jmap-ng-developer-documentation" target="_blank">here</a>.
-

package/index.d.ts

@@ -613,10 +613,7 @@ export interface JMapService {
 
 export interface JMapBasemapService {
   getAllIds(): string[]
-  isDisabled(): boolean
   isActive(): boolean
-  isMapboxId(basemapId: string): boolean
-  isOSMId(basemapId: string): boolean
   getActiveId(): string | undefined
   existsById(basemapId: string): boolean
   getById(basemapId: string): JBasemap
@@ -693,13 +690,13 @@ export interface JProjectService {
   getByName(projectName: string): JProject
   getId(): JId
   getName(): string
-  getDescription(): string
+  getDescription(): string | undefined
   getProjection(): JProjection
   getDefaultDistanceUnit(): JMAP_DISTANCE_UNITS
   getMapUnit(): JMAP_DISTANCE_UNITS
-  getInitialRotation(): number
-  getSelectionColor(): string
-  getBackgroundColor(): string
+  getInitialRotation(): number | undefined
+  getSelectionColor(): string | undefined
+  getBackgroundColor(): string | undefined
   getInitialExtent(): JBounds | null
   getBase64ImageThumbnail(): string
   loadAllProjectThumbnails(params?: JProjectLoadThumbnailsParams): Promise<void>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jmapcloud-ng-core-types",
-  "version": "1.1.39",
+  "version": "1.1.41",
   "description": "JMap Cloud specific version of JMap Cloud NG Core types and interfaces",
   "main": "index.js",
   "types": "ambient.d.ts",
@@ -33,7 +33,7 @@
     "@auth0/auth0-spa-js": "^2.1.3",
     "@types/geojson": "^7946.0.14",
     "geojson": "^0.5.0",
-    "jmapcloud-types": "../../../packages/jmapcloud-types",
+    "jmapcloud-types": "../packages/jmapcloud-types",
     "maplibre-gl": "^4.7.1",
     "redux": "^5.0.1"
   }

package/public/core.d.ts

@@ -5121,19 +5121,6 @@ export namespace JMap {
        * ```
        */
       function getAllIds(): string[]
-      /**
-       * ***JMap.Map.Basemap.isDisabled***
-       *
-       * Returns true if basemaps are disabled.
-       *
-       * Can be disabled with option disableBasemaps {@link JCoreOptions} in JS options, or with url param "ngDisableBasemaps=true".
-       *
-       * @example
-       * ```ts
-       * JMap.Map.Basemap.isDisabled()
-       * ```
-       */
-      function isDisabled(): boolean
       /**
        * ***JMap.Map.Basemap.isActive***
        *
@@ -5153,36 +5140,6 @@ export namespace JMap {
        * ```
        */
       function isActive(): boolean
-      /**
-       * ***JMap.Map.Basemap.isMapboxId***
-       *
-       * Returns true if the basemap id is a mapbox basemap.
-       *
-       * @example
-       * ```ts
-       * // returns true
-       * JMap.Map.Basemap.isMapboxId("mapbox-streets")
-       *
-       * // returns false
-       * JMap.Map.Basemap.isMapboxId("my-custom-basemap")
-       * ```
-       */
-      function isMapboxId(basemapId: string): boolean
-      /**
-       * ***JMap.Map.Basemap.isOSMId***
-       *
-       * Returns true if the basemap id is an Open Street Map basemap.
-       *
-       * @example
-       * ```ts
-       * // returns true
-       * JMap.Map.Basemap.isOSMId("osm-standard")
-       *
-       * // returns false
-       * JMap.Map.Basemap.isOSMId("mapbox-streets")
-       * ```
-       */
-      function isOSMId(basemapId: string): boolean
       /**
        * ***JMap.Map.Basemap.getActiveId***
        *
@@ -5269,24 +5226,24 @@ export namespace JMap {
        * // add an osm basemap
        * JMap.Map.Basemap.add({
        *   id: "osm",
-       *   label: "Open Street Map",
+       *   name: "Open Street Map",
        *   tileUrls: [
        *     "https://a.tile.openstreetmap.org/{z}/{x}/{y}.png",
        *     "https://b.tile.openstreetmap.org/{z}/{x}/{y}.png",
        *     "https://c.tile.openstreetmap.org/{z}/{x}/{y}.png"
        *   ],
-       *   previewImageAsUrlOrBase64: "https://searchengineland.com/figz/wp-content/seloads/2013/11/Screen-Shot-2013-11-22-at-3.41.27-PM.png"
+       *   imageUrl: "https://searchengineland.com/figz/wp-content/seloads/2013/11/Screen-Shot-2013-11-22-at-3.41.27-PM.png"
        *  }, true) // true = activate the new basemap
        *
        * // Add a quadkey (not x/y/z) basemap
        * JMap.Map.Basemap.add(
        *  {
        *    id: "My custom map",
-       *    label: "My map",
+       *    name: "My map",
        *    tileUrls: [
        *      "https://t.ssl.ak.dynamic.tiles.virtualearth.net/comp/ch/{quadkey}?mkt=fr-CA&it=G,LC,BX,RL&shading=hill&n=z&og=1226&cstl=vb&src=o"
        *    ],
-       *    previewImageAsUrlOrBase64: "http://www.toxel.com/wp-content/uploads/2008/08/creativelogos11.jpg"
+       *    imageUrl: "http://www.toxel.com/wp-content/uploads/2008/08/creativelogos11.jpg"
        *  }, true) // true = activate the new basemap
        * ```
        */
@@ -5739,7 +5696,7 @@ export namespace JMap {
      * JMap.Project.getDescription()
      * ```
      */
-    function getDescription(): string
+    function getDescription(): string | undefined
     /**
      * **JMap.Project.getProjection**
      *
@@ -5769,7 +5726,7 @@ export namespace JMap {
      * JMap.Project.getInitialRotation()
      * ```
      */
-    function getInitialRotation(): number
+    function getInitialRotation(): number | undefined
     /**
      * **JMap.Project.getSelectionColor**
      *
@@ -5785,7 +5742,7 @@ export namespace JMap {
      * JMap.Project.getSelectionColor()
      * ```
      */
-    function getSelectionColor(): string
+    function getSelectionColor(): string | undefined
     /**
      * **JMap.Project.getBackgroundColor**
      *
@@ -5799,7 +5756,7 @@ export namespace JMap {
      * JMap.Project.getBackgroundColor()
      * ```
      */
-    function getBackgroundColor(): string
+    function getBackgroundColor(): string | undefined
     /**
      * **JMap.Project.getInitialExtent**
      *

package/public/jmap/map.d.ts

@@ -128,10 +128,7 @@ export type JMapSelection = {
   [key in JId]: GeoJSON.Feature[]
 }
 
-export interface JProjection {
-  code: string
-  name: string
-}
+export type JProjection = string
 
 export interface JMapFeatureAttributeValues {
   featureId: JId
@@ -203,9 +200,9 @@ export interface JMapFlashLocationParams {
 
 export interface JBasemap {
   id: string
-  label: string
+  name: string
   tileUrls: string[]
-  previewImageAsUrlOrBase64?: string
+  imageUrl?: string
   scheme?: JMAP_RASTER_SCHEME_TYPES
   minzoom?: number
   maxzoom?: number

package/public/jmap/project.d.ts

@@ -1,6 +1,7 @@
+import { LOCALES } from "jmapcloud-types"
+import type { components as McsComponents } from "jmapcloud-types/generated/mcs-generated"
 import type { JBounds } from "./geometry.d.ts"
-import type { JId } from "./main.d.ts"
-import type { JMAP_DISTANCE_UNITS, JProjection } from "./map.d.ts"
+import type { JMAP_DISTANCE_UNITS } from "./map.d.ts"
 export {}
 // ALL_TERRAIN_ILLUMINATION_ANCHOR_TYPES in all-enum.ts
 export const enum JTERRAIN_ILLUMINATION_ANCHOR_TYPES {
@@ -30,26 +31,19 @@ export interface JProjectServerExtension {
   version: string
 }
 
-export interface JProject {
-  id: JId //TODO: refactoring will be done in JWNG-351
-  name: string
-  description: string
-  projection: JProjection
-  initialRotation: number
-  colorSelection: string
-  colorBackground: string
-  terrain?: JTerrainSpecification
-  initialExtent: JBounds | null
+export interface JProject extends Omit<
+  McsComponents["schemas"]["LocalizedProjectDTO"],
+  "mapUnit" | "distanceUnit" | "displayUnit" | "initialExtent" | "maximumExtent" | "terrain"
+> {
+  defaultLanguage: LOCALES
   mapUnit: JMAP_DISTANCE_UNITS
-  apiKey: {
-    google: string | null
-    bing: string | null
-    mapBox: string | null
-  }
-  defaultDistanceUnit: JMAP_DISTANCE_UNITS
+  distanceUnit: JMAP_DISTANCE_UNITS
+  displayUnit: JMAP_DISTANCE_UNITS
+  initialExtent: JBounds | null
+  maximumExtent: JBounds | null
+  terrain?: JTerrainSpecification
   base64ImageThumbnail: string
   extensions: JProjectServerExtension[]
-  usageStatisticsActive: boolean
 }
 
 export interface JTerrainSpecification {

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

@@ -506,35 +506,4 @@ export interface JCoreOptions {
    * For example NG don't need NG Core minimal UI and use this option.
    */
   hideMainLayout?: boolean
-  /**
-   * If true, no basemap will be available/displayed.
-   * In JMap Cloud NG, no basemap panel will be displayed in the left panel
-   */
-  disableBasemaps?: boolean
-  /**
-   * A basemap id.
-   *
-   * 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](../functions/JMap_Cloud_NG_Core___API.JMap.Map.Basemap.getAllIds.html)
-   *
-   * Using the id "none" will use no basemap at startup.
-   *
-   * ```html
-   * <html>
-   *   ...
-   *   <body>
-   *     <script type="text/javascript">
-   *       window.JMAP_OPTIONS = {
-   *         ...
-   *         // disable the default basemap
-   *         defaultBasemapId: "none"
-   *       }
-   *     </script>
-   *     ...
-   *   </body>
-   * </html>
-   * ```
-   */
-  defaultBasemapId?: string
 }