jmapserver-ng-core-types 2.0.0 → 2.0.2

package/all-enums.ts

@@ -278,14 +278,6 @@ 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_JORGANIZATION_EXTERNAL_API_KEY_TYPES: JORGANIZATION_EXTERNAL_API_KEY_TYPES[] = [
   JORGANIZATION_EXTERNAL_API_KEY_TYPES.MAPBOX_ACCESS_TOKEN
 ]

package/index.ts

@@ -841,6 +841,7 @@ export interface JLayerService {
   exists(layerId: JId): boolean
   attributeExists(layerId: JId, attributeName: string): boolean
   getById(layerId: JId): JLayerTreeElement
+  getLayerAttributesWithStatistics(layerId: JId): Promise<JLayerAttribute[]>
   getSelfOrChildren(layerId: JId): JLayer[]
   getName(layerId: JId): string
   getDescription(layerId: JId): string
@@ -892,7 +893,6 @@ export interface JUserService {
   setPreference(name: string, value: string | undefined): Promise<void>
   setToken(token: string, organizationId?: string): Promise<JSessionData>
   login(login: string, password: string): Promise<JSessionData>
-  loginIntoOrganization(organizationId: string): Promise<JSessionData>
   loginWithIdentityProvider(providerId: string): void
   logout(): Promise<void>
   isLoggedIn(): boolean
@@ -903,9 +903,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
   isSystemUser(): boolean
   getOrganizationId(): string
@@ -949,10 +947,7 @@ export interface JExtensionService {
 export interface JServerService {
   isReady(): boolean
   getVersion(): JServerVersion
-  getType(): JSERVER_TYPES
-  isSaas(): boolean
-  isLegacy(): boolean
-  getMinimumVersion(): JMinimumServerVersion
+  getMinimumVersion(): JServerVersion
   isMinimumVersionRespected(serverInfo?: JServerInfo): boolean
   getShortVersion(): string
   isStandardLoginAvailable(): boolean

package/package.json

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

package/public/core.d.ts

@@ -129,48 +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 Server 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**
      *
@@ -183,7 +141,7 @@ declare namespace JMap {
      * JMap.Server.getMinimumVersion()
      * ```
      */
-    function getMinimumVersion(): JMinimumServerVersion
+    function getMinimumVersion(): JServerVersion
 
     /**
      * **JMap.Server.isMinimumVersionRespected**
@@ -1831,6 +1789,21 @@ declare namespace JMap {
      */
     function getById(layerId: JId): JLayerTreeElement
 
+    /**
+     * **JMap.Layer.getLayerAttributesWithStatistics**
+     *
+     * Returns the layer's attributes with their statistics.
+     *
+     * @throws Error if no layer found for the id
+     * @param layerId The JMap layer id
+     * @example ```ts
+     *
+     * // returns the attributes of layer id=3 with their statistics
+     * JMap.Layer.getLayerAttributesWithStatistics(3)
+     * ```
+     */
+    function getLayerAttributesWithStatistics(layerId: JId): Promise<JLayerAttribute[]>
+
     /**
      * **JMap.Layer.getSelfOrChildren**
      *
@@ -6155,44 +6128,6 @@ declare namespace JMap {
      */
     function login(login: string, password: string): Promise<JSessionData>
 
-    /**
-     * **JMap.User.loginIntoOrganization**
-     *
-     * For JMapCloud only.
-     *
-     * 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
-     * @param organizationId
-     * @example ```ts
-     *
-     * const userLogin = "jdo@mycompany.com"
-     * const userPassword = "xxx"
-     *
-     * // Open a new user session, and get back user data from server
-     * JMap.User
-     *    .login(userLogin, userPassword)
-     *    .then(sessionData => {
-     *        console.log(`User ${userLogin} has been authenticated, will login to one of it's organization`)
-     *        if(sessionData.organizationInfos.length === 0){
-     *          console.error("User has no organization")
-     *        }else{
-     *          const organizationInfo = sessionData.organizationInfos[sessionData.organizationInfos.length - 1]
-     *          JMap.User
-     *            .loginIntoOrganization(organizationInfo.id)
-     *            .then(sessionData2=>{
-     *              console.log(`User ${userLogin} has been logged into organization "${sessionData2.currentOrganization.name}", his session token is "${sessionData2.accessToken}"`)
-     *            })
-     *        }
-     *    })
-     *    .catch(error => {
-     *      console.error(`Cannot loggin ${userLogin}, error: `, error)
-     *    })
-     * ```
-     */
-    function loginIntoOrganization(organizationId: string): Promise<JSessionData>
-
     /**
      * **JMap.User.loginWithIdentityProvider**
      *
@@ -6462,7 +6397,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 Server )
      *
      * @example ```ts
      *
@@ -6479,9 +6414,7 @@ declare namespace JMap {
      * /*
      * ```
      */
-    function getPasswordPolicyCompliance(
-      password: string
-    ): JJMapServerPasswordPolicyCompliance | JJMapCloudPasswordPolicyCompliance
+    function getPasswordPolicyCompliance(password: string): JJMapPasswordPolicyCompliance
 
     /**
      * ***JMap.User.isPseudoUser***

package/public/jmap/layer.d.ts

@@ -347,8 +347,18 @@ declare interface JLayerAttribute {
   name: string
   label: string
   type: JLAYER_ATTRIBUTE_TYPES
+  attributeStatistics: JLayerAttributeStatistics | null
 }
 
+declare interface JLayerAttributeStatistics {
+  tooManyUniqueValues: boolean
+  uniqueValues?: any[]
+  minimumValue?: number
+  maximumValue?: number
+  sum?: number
+  average?: number
+  standardDeviation?: number
+}
 declare interface JLayerTreeElement {
   id: JId
   name: string

package/public/jmap/server.d.ts

@@ -1,17 +1,3 @@
-// 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 {
-  STARTING = "STARTING",
-  UP = "UP",
-  DOWN = "DOWN"
-}
-
-// ALL_SERVER_SAAS_STATUS in all-enum.ts
 declare const enum JSERVER_IDENTITY_PROVIDER_TYPES {
   SSO = "sso",
   AUTH0_SPA = "auth0-spa"
@@ -21,24 +7,10 @@ declare interface JServerIdentityProviderById {
   [id: string]: JServerAnyIdentityProvider
 }
 
-declare interface JServerSaasServiceById {
-  [id: string]: JServerSaasService
-}
-
 declare interface JServerInfo {
   identityProviderById: JServerIdentityProviderById
   standardLoginAvailable: boolean
   version: JServerVersion
-  type: JSERVER_TYPES
-  saasServiceById?: JServerSaasServiceById
-}
-
-declare interface JServerSaasService {
-  id: string
-  name: string
-  version: string
-  status: JSERVER_SAAS_STATUS
-  restBaseUrl: string
 }
 
 declare type JServerAnyIdentityProvider = JServerIdentityProviderAuth0Password | JServerIdentityProviderSso
@@ -68,11 +40,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

@@ -7,10 +7,6 @@ declare interface JTokenInfo {
    * The JMap user session token (legacy) or access token (Saas JMap Cloud).
    */
   accessToken: string
-  /**
-   * The refresh token.
-   */
-  refreshToken: string
   /**
    * The access token expiration time in seconds.
    */
@@ -79,17 +75,10 @@ declare interface JOrganizationExternalApiKey {
   type: JORGANIZATION_EXTERNAL_API_KEY_TYPES
 }
 
-declare interface JJMapServerPasswordPolicyCompliance {
+declare interface JJMapPasswordPolicyCompliance {
   hasMinimumLength: boolean
 }
 
-declare interface JJMapCloudPasswordPolicyCompliance extends JJMapServerPasswordPolicyCompliance {
-  hasLowercaseLetters: boolean
-  hasUppercaseLetters: boolean
-  hasNumbers: boolean
-  hasSpecialCharacters: boolean
-}
-
 // ALL_JORGANIZATION_EXTERNAL_API_KEY_TYPES in all-enum.ts
 declare const enum JORGANIZATION_EXTERNAL_API_KEY_TYPES {
   MAPBOX_ACCESS_TOKEN = "MAPBOX_ACCESS_TOKEN"