jmapcloud-ng-core-types 1.0.3 → 1.0.5

package/all-enums.ts

@@ -278,13 +278,7 @@ export const ALL_MAP_RASTER_SCHEME_TYPES: JMAP_RASTER_SCHEME_TYPES[] = [
   JMAP_RASTER_SCHEME_TYPES.XYZ
 ]
 
-export const ALL_SERVER_TYPES: JSERVER_TYPES[] = [JSERVER_TYPES.LEGACY, JSERVER_TYPES.SAAS]
-
-export const ALL_SERVER_SAAS_STATUS: JSERVER_SAAS_STATUS[] = [
-  JSERVER_SAAS_STATUS.STARTING,
-  JSERVER_SAAS_STATUS.UP,
-  JSERVER_SAAS_STATUS.DOWN
-]
+export const ALL_SERVER_STATUS: JSERVER_STATUS[] = [JSERVER_STATUS.STARTING, JSERVER_STATUS.UP, JSERVER_STATUS.DOWN]
 
 export const ALL_JORGANIZATION_EXTERNAL_API_KEY_TYPES: JORGANIZATION_EXTERNAL_API_KEY_TYPES[] = [
   JORGANIZATION_EXTERNAL_API_KEY_TYPES.MAPBOX_ACCESS_TOKEN

package/index.ts

@@ -181,7 +181,6 @@ export interface JGeolocationService {
 }
 
 export interface JQueryService {
-  initializeQueryFormById(layerId: JId, queryId: string): Promise<JQuery>
   getAllGroups(): JQueryGroup[]
   groupExist(groupId: JId): boolean
   getQueriesByLayerId(layerId: JId): JQuery[]
@@ -501,6 +500,8 @@ export interface JMapState {
   scaleControlPosition: JMAP_POSITIONS
   distanceUnit: JMAP_DISTANCE_UNITS
   isNavigationHistoryControlVisible: boolean
+  isTerrainAvailable: boolean
+  isTerrainActive: boolean
   isScaleControlVisible: boolean
   isMapRotationControlVisible: boolean
   isInfoControlVisible: boolean
@@ -691,6 +692,9 @@ export interface JMapService {
   getZoom(): number
   getMaplibreSourceIdByJMapLayerId(layerId: JId): string
   isScaleControlVisible(): boolean
+  isTerrainAvailable(): boolean
+  isTerrainActive(): boolean
+  setTerrainActive(active: boolean): void
   setScaleControlVisibility(isVisible: boolean, position?: JMAP_POSITIONS): void
   setScaleControlUnits(units: "imperial" | "metric" | "nautical"): void
   setScaleControlPosition(position: JMAP_POSITIONS): void
@@ -930,9 +934,7 @@ export interface JUserService {
   changeFullName(newFullName: string): Promise<void>
   getMinimumPasswordLength(): number
   isPasswordCompliant(password: string): boolean
-  getPasswordPolicyCompliance(
-    password: string
-  ): JJMapServerPasswordPolicyCompliance | JJMapCloudPasswordPolicyCompliance
+  getPasswordPolicyCompliance(password: string): JJMapPasswordPolicyCompliance
   isPseudoUser(): boolean
   getOrganizationId(): string
 }
@@ -975,10 +977,8 @@ export interface JExtensionService {
 export interface JServerService {
   isReady(): boolean
   getVersion(): JServerVersion
-  getType(): JSERVER_TYPES
-  isSaas(): boolean
-  isLegacy(): boolean
-  getMinimumVersion(): JMinimumServerVersion
+  //TODO: JIRA JMAP8-1655
+  getMinimumVersion(): JServerVersion
   isMinimumVersionRespected(serverInfo?: JServerInfo): boolean
   getShortVersion(): string
   isStandardLoginAvailable(): boolean

package/package.json

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

package/public/core.d.ts

@@ -129,61 +129,6 @@ declare namespace JMap {
      */
     function getVersion(): JServerVersion
 
-    /**
-     * **JMap.Server.getType**
-     *
-     * Returns the server type.
-     *
-     * @throws if the server is not ready (info from server has not been fetched). Call JMap.Server.isReady() to know this information.
-     * @example ```ts
-     *
-     * // display the server type, "legacy" (JMap 7) or "saas" (JMap Cloud)
-     * console.log(`Server type is "${JMap.Server.getType()}"`)
-     * ```
-     */
-    function getType(): JSERVER_TYPES
-
-    /**
-     * **JMap.Server.isSaas**
-     *
-     * Returns true if the server is a JMap Cloud instance.
-     *
-     * @throws if the server is not ready (info from server has not been fetched). Call JMap.Server.isReady() to know this information.
-     * @example ```ts
-     *
-     * // display the type of server
-     * console.log(`Server type is "${JMap.Server.isSaas() ? 'JMap Cloud' : 'JMap 7'}"`)
-     * ```
-     */
-    function isSaas(): boolean
-
-    /**
-     * **JMap.Server.isLegacy**
-     *
-     * Returns true if the server is a JMap 7 instance.
-     *
-     * @throws if the server is not ready (info from server has not been fetched). Call JMap.Server.isReady() to know this information.
-     * @example ```ts
-     *
-     * // display the type of server
-     * console.log(`Server type is "${JMap.Server.isLegacy() ? 'JMap 7' : 'JMap Cloud'}"`)
-     * ```
-     */
-    function isLegacy(): boolean
-
-    /**
-     * **JMap.Server.getMinimumVersion**
-     *
-     * Returns the minimum server version required by NG to work fine.
-     *
-     * @throws if the server is not ready (info from server has not been fetched). Call JMap.Server.isReady() to know this information.
-     * @example ```ts
-     *
-     * // returns the minimum server version required by NG to work fine
-     * JMap.Server.getMinimumVersion()
-     * ```
-     */
-    function getMinimumVersion(): JMinimumServerVersion
 
     /**
      * **JMap.Server.isMinimumVersionRespected**
@@ -3101,6 +3046,52 @@ declare namespace JMap {
      */
     function isScaleControlVisible(): boolean
 
+    /**
+     * ***JMap.Map.isTerrainAvailable***
+     *
+     * Returns true if the map is associated with a terrain.
+     *
+     * @example ```ts
+     *
+     * // returns true if the map is associated with a terrain
+     * JMap.Map.isTerrainAvailable()
+     * ```
+     */
+    function isTerrainAvailable(): boolean
+
+    /**
+     * ***JMap.Map.isTerrainActive***
+     *
+     * Returns true if the map is associated with an active terrain, false otherwise.
+     *
+     * @example ```ts
+     *
+     * // returns true if the map is associated with an active terrain, false otherwise
+     * JMap.Map.isTerrainActive()
+     * ```
+     */
+    function isTerrainActive(): boolean
+
+    /**
+     * ***JMap.Map.setTerrainActive***
+     *
+     * Returns true if the map is associated with a terrain.
+     *
+     * @param active whether to activate or deactivate the terrain
+     * @throws Error is no terrain is available
+     *
+     * @example ```ts
+     *
+     * // returns true if the map is associated with a terrain
+     * if(JMap.Map.isTerrainAvailable()){
+     *    JMap.Map.setTerrainActive(true)
+     * }else{
+     *    console.log("no terrain available")
+     * }
+     * ```
+     */
+    function setTerrainActive(active: boolean): void
+
     /**
      * ***JMap.Map.setScaleControlVisibility***
      *
@@ -6466,7 +6457,7 @@ declare namespace JMap {
     /**
      * ***JMap.User.getPasswordPolicyCompliance***
      *
-     * Returns an object describing the password compliance with the platform's password policy (JMap Server or JMap Cloud)
+     * Returns an object describing the password compliance with the platform's password policy ( JMap Cloud)
      *
      * @example ```ts
      *
@@ -6485,7 +6476,7 @@ declare namespace JMap {
      */
     function getPasswordPolicyCompliance(
       password: string
-    ): JJMapServerPasswordPolicyCompliance | JJMapCloudPasswordPolicyCompliance
+    ): JJMapPasswordPolicyCompliance
 
     /**
      * ***JMap.User.isPseudoUser***

package/public/jmap/server.d.ts

@@ -1,11 +1,5 @@
-// ALL_SERVER_TYPES in all-enum.ts
-declare const enum JSERVER_TYPES {
-  LEGACY = "legacy",
-  SAAS = "saas"
-}
-
 // ALL_SERVER_SAAS_STATUS in all-enum.ts
-declare const enum JSERVER_SAAS_STATUS {
+declare const enum JSERVER_STATUS {
   STARTING = "STARTING",
   UP = "UP",
   DOWN = "DOWN"
@@ -21,23 +15,22 @@ declare interface JServerIdentityProviderById {
   [id: string]: JServerAnyIdentityProvider
 }
 
-declare interface JServerSaasServiceById {
-  [id: string]: JServerSaasService
+declare interface JServerServiceById {
+  [id: string]: JServerService
 }
 
 declare interface JServerInfo {
   identityProviderById: JServerIdentityProviderById
   standardLoginAvailable: boolean
   version: JServerVersion
-  type: JSERVER_TYPES
-  saasServiceById?: JServerSaasServiceById
+  serviceById?: JServerServiceById
 }
 
-declare interface JServerSaasService {
+declare interface JServerService {
   id: string
   name: string
   version: string
-  status: JSERVER_SAAS_STATUS
+  status: JSERVER_STATUS
   restBaseUrl: string
 }
 
@@ -68,11 +61,6 @@ declare interface JServerVersion {
   buildNumber: number
 }
 
-declare interface JMinimumServerVersion {
-  legacy: JServerVersion
-  saas: JServerVersion
-}
-
 declare interface JServerInfoReadyEventParams {
   serverInfo: JServerInfo
   isMinimumVersionRespected: boolean

package/public/jmap/user.d.ts

@@ -79,15 +79,12 @@ declare interface JOrganizationExternalApiKey {
   type: JORGANIZATION_EXTERNAL_API_KEY_TYPES
 }
 
-declare interface JJMapServerPasswordPolicyCompliance {
-  hasMinimumLength: boolean
-}
-
-declare interface JJMapCloudPasswordPolicyCompliance extends JJMapServerPasswordPolicyCompliance {
+declare interface JJMapPasswordPolicyCompliance {
   hasLowercaseLetters: boolean
   hasUppercaseLetters: boolean
   hasNumbers: boolean
   hasSpecialCharacters: boolean
+  hasMinimumLength: boolean
 }
 
 // ALL_JORGANIZATION_EXTERNAL_API_KEY_TYPES in all-enum.ts