jmapcloud-ng-core-types 1.0.39 → 1.0.40

package/all-enums.ts

@@ -275,7 +275,17 @@ export const ALL_MAP_RASTER_SCHEME_TYPES: JMAP_RASTER_SCHEME_TYPES[] = [
   JMAP_RASTER_SCHEME_TYPES.XYZ
 ]
 
-export const ALL_SERVER_STATUS: JSERVER_STATUS[] = [JSERVER_STATUS.STARTING, JSERVER_STATUS.UP, JSERVER_STATUS.DOWN]
+export const ALL_SERVER_IDENTITY_PROVIDER_TYPES: JSERVER_IDENTITY_PROVIDER_TYPES[] = [
+  JSERVER_IDENTITY_PROVIDER_TYPES.AUTH0_SPA,
+  JSERVER_IDENTITY_PROVIDER_TYPES.JMAP_CLOUD,
+  JSERVER_IDENTITY_PROVIDER_TYPES.ANONYMOUS
+]
+
+export const ALL_SERVER_MICRO_SERVICE_STATUSES: JSERVER_MICRO_SERVICE_STATUSES[] = [
+  JSERVER_MICRO_SERVICE_STATUSES.STARTING,
+  JSERVER_MICRO_SERVICE_STATUSES.UP,
+  JSERVER_MICRO_SERVICE_STATUSES.DOWN
+]
 
 export const ALL_JORGANIZATION_EXTERNAL_API_KEY_TYPES: JORGANIZATION_EXTERNAL_API_KEY_TYPES[] = [
   JORGANIZATION_EXTERNAL_API_KEY_TYPES.MAPBOX_ACCESS_TOKEN
@@ -285,3 +295,22 @@ export const ALL_TERRAIN_ILLUMINATION_ANCHOR_TYPES: JTERRAIN_ILLUMINATION_ANCHOR
   JTERRAIN_ILLUMINATION_ANCHOR_TYPES.MAP,
   JTERRAIN_ILLUMINATION_ANCHOR_TYPES.VIEWPORT
 ]
+
+export const ALL_LOGIN_STATUS: LOGIN_STATUS[] = [
+  LOGIN_STATUS.LOGGED_IN,
+  LOGIN_STATUS.LOGGED_OUT,
+  LOGIN_STATUS.LOGGING_IN,
+  LOGIN_STATUS.LOGIN_ERROR,
+  LOGIN_STATUS.LOGIN_ERROR_INSUFFICIENT_ROLES,
+  LOGIN_STATUS.SWITCHING_ORG
+]
+
+export const ALL_ROLES: ROLES[] = [
+  ROLES.ORG_ADMIN,
+  ROLES.ORG_EDITOR,
+  ROLES.ORG_VIEWER,
+  ROLES.ACCOUNT_MANAGER,
+  ROLES.SYS_ADMIN
+]
+
+export const ALL_MEMBER_ROLES: MEMBER_ROLES[] = [ROLES.ORG_ADMIN, ROLES.ORG_EDITOR, ROLES.ORG_VIEWER]

package/index.ts

@@ -565,11 +565,16 @@ export interface JUserState extends JTokenInfo {
   isLoggingIn: boolean
   isLoggingIntoOrganization: boolean
   isReloadingSession: boolean
-  identity: JUserIdentity
+  identity: JUser
   currentOrganization: JOrganization // the organization in which the user is currently logged in
   organizationInfos: JOrganizationInfo[] // the info about all organizations the user belongs to
   informations: JUserInfo[]
   changePasswordAllowed: boolean
+  identityProviderType: JSERVER_IDENTITY_PROVIDER_TYPES
+  // from portal
+  loginStatus: LOGIN_STATUS
+  loginStatusDetailTranslationKey: string
+  callbackAtTokenRefresh: (() => void) | null
 }
 
 export interface JLanguageState {
@@ -948,8 +953,8 @@ export interface JUserService {
   removePreference(name: string): Promise<string | null>
   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>
+  login(login?: string, password?: string): Promise<JSessionData> | Promise<void>
+  loginIntoOrganization(organizationId: string): Promise<JSessionData> | Promise<void>
   loginWithIdentityProvider(providerId: string): void
   logout(): Promise<void>
   isLoggedIn(): boolean

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jmapcloud-ng-core-types",
-  "version": "1.0.39",
+  "version": "1.0.40",
   "description": "JMap Cloud specific version of JMap Cloud NG Core types and interfaces",
   "main": "index.js",
   "scripts": {
@@ -31,9 +31,10 @@
     "typedoc": "^0.25.13"
   },
   "dependencies": {
+    "@auth0/auth0-spa-js": "^2.1.3",
     "@types/geojson": "^7946.0.14",
     "geojson": "^0.5.0",
     "maplibre-gl": "^4.3.1",
     "redux": "^5.0.1"
   }
-}
+}

package/public/core.d.ts

@@ -6356,8 +6356,13 @@ declare namespace JMap {
     /**
      * **JMap.User.login**
      *
-     * The login function, returns a promise. Make a call to the server and if
-     * login is successful resolve the promise providing the user session data.
+     * The login function, returns a promise.
+     *
+     * When using the new oAuth2 authentication scheme, no username or password are required. It triggers a redirect to
+     * the identity provider, resolving with not data.
+     *
+     * When using the legacy REST API-based authentication scheme, username and password are mandatory. The method will
+     * make a call to the server and if login is successful resolve the promise providing the user session data.
      *
      * If an error occurs, 3 differents string message can be returned :
      *   - ***"user.login.error.credential"*** => Bad username or password
@@ -6365,8 +6370,8 @@ declare namespace JMap {
      *   - ***"user.login.error.unexpected"*** => Unexpected error client side
      *
      * @throws Error if bad credentials or server error.
-     * @param login The user's username
-     * @param password The user's password
+     * @param login The user's username (when using {@link JCoreOptions.legacyAuthentication})
+     * @param password The user's password (when using {@link JCoreOptions.legacyAuthentication}
      * @example
      * ```ts
      * const userLogin = "jdo@mycompany.com"
@@ -6383,14 +6388,15 @@ declare namespace JMap {
      *    })
      * ```
      */
-    function login(login: string, password: string): Promise<JSessionData>
+    function login(login?: string, password?: string): Promise<void> | Promise<JSessionData>
 
     /**
      * **JMap.User.loginIntoOrganization**
      *
-     * For JMapCloud only.
+     * When using the new oAuth2 authentication setup, will redirect the user to the identity provider and be redirected back. The method resolves with nothing.
+     *
+     * When using the legacy REST API-based authentication method, it 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.
      *
-     * 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
@@ -6400,7 +6406,7 @@ declare namespace JMap {
      * const userLogin = "jdo@mycompany.com"
      * const userPassword = "xxx"
      *
-     * // Open a new user session, and get back user data from server
+     * // Open a new user session in a REST API-based authentication setup, and get back user data from server
      * JMap.User
      *    .login(userLogin, userPassword)
      *    .then(sessionData => {
@@ -6421,13 +6427,16 @@ declare namespace JMap {
      *    })
      * ```
      */
-    function loginIntoOrganization(organizationId: string): Promise<JSessionData>
+    function loginIntoOrganization(organizationId: string): Promise<JSessionData> | Promise<void>
 
     /**
      * **JMap.User.loginWithIdentityProvider**
      *
+     * Not currently supported in JMap Cloud
+     *
      * Logs in the user using the specified Identity Provider. See {@link JMap.Server.getAllIdentityProvidersById} for info about Identity providers
      *
+     * @deprecated
      * @example
      * ```ts
      * // fetch all Identity Providers
@@ -6445,7 +6454,7 @@ declare namespace JMap {
     /**
      * **JMap.User.logout**
      *
-     * Logout function. Make a call to the server to invalidate the session id.
+     * Logout function. Makes a call to the server to invalidate the session.
      *
      * If an error occurs, 2 differents string message can be returned :
      *   - ***"user.logout.error.server"*** => Unexpected error while requesting the server
@@ -6481,37 +6490,13 @@ declare namespace JMap {
      *
      * Sets the user session data. Useful if you want to make a call to our Rest API and set the session token by yourself.
      *
+     * Calling this method will acctivate {@link JCoreOptions.legacyAuthentication}
      *
-     * This process is a bit different for JMap Server than for JMap CLoud.
      *
-     * For JMap Server, you need to fetch a session token from the REST API, and call {@link JMap.User.setToken} without spedifying the organization Id.
-     *
-     * For JMap Cloud, you need to fetch a ***refresh token*** from the JMap Cloud Rest API, and pass this refresh token, along with the the optional organisation Id, to the {@link JMap.User.setToken} method. Beware that a refresh token can only be used once, it is invalidated afterward
+     * You need to fetch a ***refresh token*** from the JMap Cloud Rest API, and pass this refresh token, along with the optional organisation Id, to the {@link JMap.User.setToken} method. Beware that a refresh token can only be used once, it is invalidated afterward
      *
      * Fetching data from a REST API can be done with the curl command-line tool (https://curl.haxx.se/docs/)
      *
-     * a JMap Server example:
-     *
-     * ```sh
-     * # getting a session token from JMap Server
-     * curl -X POST "https://my-jmap-server/services/rest/v2.0/session" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"username\": \"jdo@company.com\", \"password\": \"xxx\", \"type\": \"NG\"}"
-     * ```
-     *
-     * will return something like:
-     *
-     * ```js
-     * {
-     *   "message": "The result is a NG session info",
-     *   "status": "OK",
-     *   "result": {
-     *     ...
-     *     "sessionId": 23558109, // session id in the Rest API response is the session token.
-     *     ...
-     *   }
-     * }
-     * ```
-     *
-     * a JMap Cloud example:
      *
      * ```sh
      * # getting a session token from JMap Cloud
@@ -6544,21 +6529,7 @@ declare namespace JMap {
      * @param organizationId The JMap Cloud organization id
      * @example
      * ```ts
-     * // Set the user session token for JMap server
-     * JMap.User.setToken("23558109")
-     *  .then(userData => {
-     *    console.log(`Session token = "${userData.accessToken}""`)
-     *    console.log(`The session belongs to ${userData.user.fullName}`)
-     *  })
-     *  .catch(error => {
-     *    if (error === "user.token.invalid") {
-     *      console.log(`Invalid token`)
-     *    } else {
-     *      console.log(`Server error`)
-     *    }
-     *  })
-     *
-     * // Set the user session token for JMap Cloud
+     * // Set the user session token
      * JMap.User.setToken("v1.MRq [.....] Rehef72YWws","my-organization-id")
      *  .then(userData => {
      *    console.log(`Session token = "${userData.accessToken}""`)

package/public/jmap/server.d.ts

@@ -1,13 +1,14 @@
-// ALL_SERVER_SAAS_STATUS in all-enum.ts
-declare const enum JSERVER_STATUS {
+// ALL_SERVER_MICRO_SERVICE_STATUSES in all-enum.ts
+declare const enum JSERVER_MICRO_SERVICE_STATUSES {
   STARTING = "STARTING",
   UP = "UP",
   DOWN = "DOWN"
 }
 
-// ALL_SERVER_SAAS_STATUS in all-enum.ts
+// ALL_SERVER_IDENTITY_PROVIDER_TYPES in all-enum.ts
 declare const enum JSERVER_IDENTITY_PROVIDER_TYPES {
-  SSO = "sso",
+  ANONYMOUS = "anonymous",
+  JMAP_CLOUD = "jmapcloud.io",
   AUTH0_SPA = "auth0-spa"
 }
 
@@ -15,7 +16,7 @@ declare interface JServerIdentityProviderById {
   [id: string]: JServerAnyIdentityProvider
 }
 
-declare interface JServerServiceById {
+declare interface JServerMicroServiceById {
   [id: string]: JServerService
 }
 
@@ -23,18 +24,21 @@ declare interface JServerInfo {
   identityProviderById: JServerIdentityProviderById
   standardLoginAvailable: boolean
   version: JServerVersion
-  serviceById?: JServerServiceById
+  serviceById: JServerMicroServiceById
 }
 
 declare interface JServerService {
   id: string
   name: string
   version: string
-  status: JSERVER_STATUS
+  status: JSERVER_MICRO_SERVICE_STATUSES
   restBaseUrl: string
 }
 
-declare type JServerAnyIdentityProvider = JServerIdentityProviderAuth0Password | JServerIdentityProviderSso
+declare type JServerAnyIdentityProvider =
+  | JServerIdentityProviderAuth0Spa
+  | JServerIdentityProviderJMapCloudNative
+  | JServerIdentityProviderJMapCloudAnonymous
 
 declare interface JServerIdentityProviderBase {
   id: string
@@ -42,17 +46,20 @@ declare interface JServerIdentityProviderBase {
   type: JSERVER_IDENTITY_PROVIDER_TYPES
 }
 
-declare interface JServerIdentityProviderAuth0Password extends JServerIdentityProviderBase {
+declare interface JServerIdentityProviderAuth0Spa extends JServerIdentityProviderBase {
   type: JSERVER_IDENTITY_PROVIDER_TYPES.AUTH0_SPA
   domain: string
   clientId: string
-  realm: string
+  audience: string
+  logoutRedirectUrl: string
 }
 
-declare interface JServerIdentityProviderSso extends JServerIdentityProviderBase {
-  type: JSERVER_IDENTITY_PROVIDER_TYPES.SSO
-  imageData: string
-  loginUrl: string
+declare interface JServerIdentityProviderJMapCloudNative extends JServerIdentityProviderBase {
+  type: JSERVER_IDENTITY_PROVIDER_TYPES.JMAP_CLOUD
+}
+
+declare interface JServerIdentityProviderJMapCloudAnonymous extends JServerIdentityProviderBase {
+  type: JSERVER_IDENTITY_PROVIDER_TYPES.ANONYMOUS
 }
 
 declare interface JServerVersion {

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

@@ -230,6 +230,9 @@ declare interface JCoreOptions {
   restBaseUrl?: string
 
   /**
+   *
+   * "***anonymous***" must be specified together with a valid {@link JCoreOptions.organizationId}, otherwise it will not be taken into account
+   *
    * If the project you access can be accessed anonymously,
    * you are not forced to pass a session token but you have
    * to explicitly tell the JMap Cloud NG library to log as an anonymous
@@ -247,6 +250,8 @@ declare interface JCoreOptions {
    *         restBaseUrl: "http://my-jmap-server/services/rest/v2.0",
    *         // The anonymous parameter
    *         anonymous: true
+   *         // The organization id
+   *         organizationId: "some-valid-id"
    *         ... // other optional JMAP params
    *       }
    *     </script>
@@ -261,11 +266,52 @@ declare interface JCoreOptions {
   anonymous?: boolean
 
   /**
-   * The JMap user's session token.
+   * The default authentication method in NG is now using an oAuth2 setup. This allows sharing session with JMap Cloud's Portal.
+   *
+   * However, if for technical reasons you need to revert to a REST API-based technique of authentication, you can do it by setting ***legacyAuthentication*** to "true".
+   *
+   * {@link JCoreOptions.anonymous} has precedence over ***legacyAuthentication***.
+   *
+   * If you specify a {@link JCoreOptions.token}, ***legacyAuthentication*** will automatically be activated. This may change in the future.
+   *
+   * ```html
+   * <html>
+   *   ...
+   *   <body>
+   *     <script type="text/javascript">
+   *       window.JMAP_OPTIONS = {
+   *         // a valid project id
+   *         projectId: "<project-uuid>",
+   *         // a valid JMap Cloud Rest url
+   *         restBaseUrl: "http://my-jmap-server/",
+   *         // The legacyAuthentication parameter
+   *         legacyAuthentication: true
+   *         ... // other optional JMAP params
+   *       }
+   *     </script>
+   *
+   *     ... your web page
+   *
+   *     <script defer type="text/javascript" src="https://cdn.jsdelivr.net/npm/jmap-core-js@x.x.x/public/"></script>
+   *   </body>
+   * </html>
+   * ```
+   */
+  legacyAuthentication?: boolean
+
+  /**
+   * A JMap user's session refresh token.
+   *
+   * If you want to open a session automatically without user interaction and you don't use the library anonymously
+   * (see the ***{@link JCoreOptions.anonymous}*** parameter in this section), you must provide a JMap Cloud refresh
+   * token to the JMap library to initialize the user session.
+   *
+   * A refresh token can be used only once.
    *
-   * If you don't use the library with an anonymous user (see the ***{@link JCoreOptions.anonymous}*** parameter in this section), you must provide a JMap Server session token or a JMap Cloud refresh token to the JMap library.
+   * Specifying ***token*** will automatically activate {@link JCoreOptions.legacyAuthentication}
    *
-   * To get a session or refresh token, you can use the JMap Rest API on your JMap Server. See {@link JMap.User.setToken} for detailed examples on how to fetch a token through JMap's REST API.
+   * To get a refresh token, you can use the JMap Rest API on your JMap Cloud Server.
+   * See {@link JMap.User.setToken} for detailed examples on how to fetch a token through JMap's REST API.
    *
    * So to start the library using the fetched token you can configure your startup options like this :
    * ```html
@@ -274,7 +320,7 @@ declare interface JCoreOptions {
    *   <body>
    *     <script type="text/javascript">
    *       window.JMAP_OPTIONS = {
-   *         token: "23558109"
+   *         token: "some-valid-refresh-token"
    *       }
    *     </script>
    *     ...

package/public/jmap/user.d.ts

@@ -1,54 +1,82 @@
+// ALL_LOGIN_STATUS in all-enum.ts
+declare const enum LOGIN_STATUS {
+  LOGGING_IN = "LOGGING_IN",
+  LOGGED_IN = "LOGGED_IN",
+  LOGGED_OUT = "LOGGED_OUT",
+  LOGIN_ERROR = "LOGIN_ERROR",
+  LOGIN_ERROR_INSUFFICIENT_ROLES = "LOGIN_ERROR_INSUFFICIENT_ROLES",
+  SWITCHING_ORG = "SWITCHING_ORG"
+}
+
+// ALL_ROLES in all-enum.ts
+declare const enum ROLES {
+  SYS_ADMIN = "SYS_ADMIN",
+  ORG_ADMIN = "ORG_ADMIN",
+  ORG_EDITOR = "ORG_EDITOR",
+  ORG_VIEWER = "ORG_VIEWER",
+  ACCOUNT_MANAGER = "ACCOUNT_MANAGER"
+}
+
+// ALL_MEMBER_ROLES in all-enum.ts
+declare type MEMBER_ROLES = ROLES.ORG_ADMIN | ROLES.ORG_EDITOR | ROLES.ORG_VIEWER
+
 declare interface JUserEventSessionChangedParams {
   session: JSessionData
 }
 
 declare interface JTokenInfo {
   /**
-   * The JMap user session token (legacy) or access token (Saas JMap Cloud).
+   * The JMap Cloud access token.
    */
   accessToken: string
+
+  // TODO: remove
   /**
    * The refresh token.
+   * @deprecated
    */
   refreshToken: string
+
+  // TODO: remove
   /**
    * The access token expiration time in seconds.
+   * @deprecated
    */
   accessTokenExpiration: number
+
+  /**
+   * The access token expiration time in miliseconds.
+   */
+  accessTokenExpirationInMSecs: number
+  roles: ROLES[]
+  organizationId: string
+  idToken: import("@auth0/auth0-spa-js").IdToken
+  picture: string
 }
 
-declare interface JSessionData extends JTokenInfo {
+declare interface JSessionData extends JUser, JTokenInfo {
   /**
    * The user permission to change his password
+   * @deprecated
    */
   changePasswordAllowed: boolean
+
   /**
-   * The user information.
-   *
-   * @example
-   * ```ts
-   * user: {
-   *   username: "jdo@company.com",
-   *   fullName: "John Do",
-   *   admin: true
-   * }
-   * ```
-   */
-  user: JUserIdentity
-  /**
-   * Infos about the user's organizations, only for JMap Cloud servers.
+   * Infos about the user's organizations.
    */
   organizationInfos: JOrganizationInfo[]
+
   /**
-   * THe JMap Cloud organization in which the user is currently logged in, only for JMap Cloud servers.
+   * THe JMap Cloud organization in which the user is currently logged in.
    */
   currentOrganization: JOrganization
 }
 
-declare interface JUserIdentity {
-  username: string
-  fullName: string
+declare interface JUser {
+  name: string
   email: string
+  organizationInfos: JOrganizationInfo[]
+  roles: ROLES[]
 }
 
 declare interface JUserInfo {
@@ -65,6 +93,10 @@ declare interface JOrganizationInfo {
   primaryColor: string
   backgroundColor: string
   active: boolean
+  createdBy: string
+  creationDate: Date
+  lastModifiedBy: string
+  lastModificationDate: Date
 }
 
 declare interface JOrganization extends JOrganizationInfo {