jmapcloud-ng-core-types 1.0.25 → 1.0.27

package/all-enums.ts

@@ -245,8 +245,6 @@ export const ALL_MAP_CONTEXT_SORT_BY_DIRECTIONS: JMAP_CONTEXT_SORT_BY_DIRECTIONS
   JMAP_CONTEXT_SORT_BY_DIRECTIONS.DESC
 ]
 
-export const ALL_MAP_CONTEXT_VERSIONS: JMAP_CONTEXT_VERSIONS[] = [JMAP_CONTEXT_VERSIONS.V0, JMAP_CONTEXT_VERSIONS.V1]
-
 export const ALL_MAP_MODIFICATION_TYPES: JMAP_MODIFICATION_TYPES[] = [
   JMAP_MODIFICATION_TYPES.NONE,
   JMAP_MODIFICATION_TYPES.CENTER,

package/index.ts

@@ -439,7 +439,7 @@ export interface JMapContextState {
   isApplying: boolean
   activeTab: JMAP_CONTEXT_TABS
   contexts: JMapContext[]
-  defaultContextId: JId | undefined
+  defaultContextId: string | undefined
   filter: string
   sortBy: JMAP_CONTEXT_SORT_BY_OPTIONS
   sortByDirection: JMAP_CONTEXT_SORT_BY_DIRECTIONS
@@ -928,6 +928,7 @@ export interface JUserService {
   getOrganization(): JOrganization
   getFullName(): string
   getUsername(): string
+  getEmail(): string
   getPreference(name: string): Promise<string | null>
   hasPreference(name: string): Promise<boolean>
   removePreference(name: string): Promise<string | null>

package/package.json

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

package/public/core.d.ts

@@ -6248,6 +6248,19 @@ declare namespace JMap {
      */
     function getUsername(): string
 
+    /**
+     * ***JMap.User.getEmail***
+     *
+     * Returns the user email.
+     *
+     * @example
+     * ```ts
+     * // returns the email
+     * JMap.User.getEmail()
+     * ```
+     */
+    function getEmail(): string
+
     /**
      * **JMap.User.getPreference**
      *

package/public/jmap/map-context.d.ts

@@ -23,14 +23,6 @@ declare const enum JMAP_CONTEXT_SORT_BY_DIRECTIONS {
   DESC = "desc"
 }
 
-// ALL_MAP_CONTEXT_VERSIONS in all-enum.ts
-declare const enum JMAP_CONTEXT_VERSIONS {
-  V0 = 0,
-  V1 = 1
-}
-
-declare type JMapContextVersions = JMapContext | JMapContextV0 | JMapContextV1
-
 declare interface JMapContextEditResponse {
   id: JId
   uuid: string
@@ -44,59 +36,7 @@ declare interface JMapContextMetaData {
   thumbnailUrl?: string
 }
 
-/**
- * Never change this interface !!!
- * This is the picture of a map-context in version 0
- * Use for mapcontext migrations
- */
-declare interface JMapContextDataV0 {
-  layerElements: Array<{
-    id: string | number
-    isGroup: boolean
-    isVisible: boolean
-  }>
-  mapCenter: { x: number; y: number }
-  mapZoom: number
-  mapPitch: number
-  mapBearing: number
-  baseMap: string | undefined
-  selection: {
-    [key in string | number]: GeoJSON.Feature[]
-  }
-  measures: Array<{
-    id: string
-    type: "polygon" | "line_string" | "circle"
-    feature: GeoJSON.Feature<GeoJSON.LineString | GeoJSON.Polygon>
-    totalEdges: number
-    centroid: JPoint
-    edges: Array<{
-      popupLocation: JPoint
-      distance: number
-    }>
-    area: number
-    radius: number
-  }>
-  thumbnail: string
-  annotations: Array<{
-    id: string
-    type: "point" | "polygon" | "line_string" | "rectangle" | "circle" | "text"
-    feature: any
-  }>
-  annotationsTextMarkersProperties: Array<{
-    id: string
-    location: maplibregl.LngLatLike
-    textSize: number
-    textColor: string
-    textRotation: number
-    label: string
-    zoomRef: number
-    shapeType: string
-  }>
-  extensionData?: { [extensionId: string]: any }
-}
-
 declare interface JMapContextData {
-  version: JMAP_CONTEXT_VERSIONS
   layerElements: JMapContextDataLayerElement[]
   mapCenter: JLocation
   mapZoom: number
@@ -129,36 +69,18 @@ declare interface JMapContextDataThematic {
   hiddenConditionIds?: string[]
 }
 
-declare interface JMapContext {
-  id?: JId
+declare interface JMapContextCreationParams {
   title: string
   description: string
   shared: boolean
-  origin: "web-ng"
-  uuid?: string
-  author?: string
-  creationDate?: string
-  modificationDate?: string
-  projectId?: string
+  author: string
+  creationDate: string
+  modificationDate: string
   data: JMapContextData
 }
 
-declare interface JMapContextV0 {
-  id?: number | string
-  title: string
-  description: string
-  shared: boolean
-  origin: "web-ng"
-  uuid?: string
-  author?: string
-  creationDate?: string
-  modificationDate?: string
-  projectId?: string
-  data: JMapContextDataV0
-}
-
-declare interface JMapContextV1 extends JMapContext {
-  // nothing to change here
+declare interface JMapContext extends JMapContextCreationParams {
+  id: string
 }
 
 declare interface JMapContextEventParams {

package/public/jmap/user.d.ts

@@ -91,3 +91,55 @@ declare interface JJMapPasswordPolicyCompliance {
 declare const enum JORGANIZATION_EXTERNAL_API_KEY_TYPES {
   MAPBOX_ACCESS_TOKEN = "MAPBOX_ACCESS_TOKEN"
 }
+
+declare type JUserResourceType = "MAPS" | "EXTENSION" | "PREFERENCE_PORTAL" | "PREFERENCES_NG"
+declare type JUserResourceExtensionType = Extract<JUserResourceType, "EXTENSION">
+declare type JUserResourceMapsType = Extract<JUserResourceType, "MAPS">
+declare type JUserResourcePreferencesType = Extract<JUserResourceType, "PREFERENCE_PORTAL" | "PREFERENCES_NG">
+
+declare interface JUserResourceBase {
+  id: string
+  type: JUserResourceType
+  content: Record<string, any>
+}
+
+declare interface JUserResourceMaps extends JUserResourceBase {
+  type: JUserResourceMapsType
+  projectId: string
+}
+
+declare interface JUserResourceMapsUpdateParams extends JUserResourceMaps {}
+
+declare type JUserResourceMapsCreateParams = Omit<JUserResourceMaps, "id">
+
+declare interface JUserResourceExtension extends JUserResourceBase {
+  type: JUserResourceExtensionType
+  extensionId: string
+  projectId: string
+}
+
+declare interface JUserResourceExtensionUpdateParams extends JUserResourceExtension {}
+
+declare type JUserResourceExtensionCreateParams = Omit<JUserResourceExtension, "id">
+
+// Eventually, the NG and Portal preferences will have an optional projectId to include in the logic below
+declare interface JUserResourcePreferences extends JUserResourceBase {
+  type: JUserResourcePreferencesType
+}
+
+declare interface JUserResourcePreferencesUpdateParams extends JUserResourcePreferences {}
+
+declare type JUserResourcePreferencesCreateParams = Omit<JUserResourcePreferences, "id">
+
+type JUserResourcePermissionType = "VIEW" | "MODIFY" | "OWNER"
+type JUserViewPermissionType = Extract<JUserResourcePermissionType, "VIEW">
+
+declare interface JUserResourcePermissionParams {
+  permission: JUserViewPermissionType
+  principal: string
+}
+
+declare interface JUserResourcePermissionsResponse {
+  permissions: JUserResourcePermissionType[]
+  principal: string
+}