jmapcloud-ng-core-types 1.0.1003 → 1.1.0

package/all-enums.ts

@@ -139,16 +139,15 @@ export const ALL_LAYER_THEMATIC_FAMILY_TYPES: JLAYER_THEMATIC_FAMILY_TYPES[] = [
 export const ALL_LAYER_STYLE_TYPES: JLAYER_STYLE_TYPES[] = [
   JLAYER_STYLE_TYPES.POINT,
   JLAYER_STYLE_TYPES.LINE,
-  JLAYER_STYLE_TYPES.SURFACE,
-  JLAYER_STYLE_TYPES.ANNOTATION,
   JLAYER_STYLE_TYPES.IMAGE,
-  JLAYER_STYLE_TYPES.MIXED
+  JLAYER_STYLE_TYPES.TEXT,
+  JLAYER_STYLE_TYPES.IMAGE
 ]
 
-export const ALL_LAYER_STYLE_ARROWS: JLAYER_STYLE_ARROWS[] = [
-  JLAYER_STYLE_ARROWS.NONE,
-  JLAYER_STYLE_ARROWS.FORWARD,
-  JLAYER_STYLE_ARROWS.BACKWARD
+export const ALL_LAYER_STYLE_ARROW_TYPES: JLAYER_STYLE_ARROW_TYPES[] = [
+  JLAYER_STYLE_ARROW_TYPES.NONE,
+  JLAYER_STYLE_ARROW_TYPES.FORWARD,
+  JLAYER_STYLE_ARROW_TYPES.BACKWARD
 ]
 
 export const ALL_LAYER_INFORMATION_REPORT_TYPES: JLAYER_INFORMATION_REPORT_TYPES[] = [
@@ -192,16 +191,16 @@ export const ALL_LAYER_DYNAMIC_FILTER_OPERATORS: JLAYER_DYNAMIC_FILTER_OPERATORS
   JLAYER_DYNAMIC_FILTER_OPERATORS.INTERVAL
 ]
 
-export const ALL_LAYER_STYLE_LINE_STROKE_CAP: JLAYER_STYLE_LINE_STROKE_CAP[] = [
-  JLAYER_STYLE_LINE_STROKE_CAP.BUTT,
-  JLAYER_STYLE_LINE_STROKE_CAP.ROUND,
-  JLAYER_STYLE_LINE_STROKE_CAP.SQUARE
+export const ALL_LAYER_STYLE_LINE_CAP: JLAYER_STYLE_LINE_CAP[] = [
+  JLAYER_STYLE_LINE_CAP.BUTT,
+  JLAYER_STYLE_LINE_CAP.ROUND,
+  JLAYER_STYLE_LINE_CAP.SQUARE
 ]
 
-export const ALL_LAYER_STYLE_LINE_STROKE_JOIN: JLAYER_STYLE_LINE_STROKE_JOIN[] = [
-  JLAYER_STYLE_LINE_STROKE_JOIN.MITER,
-  JLAYER_STYLE_LINE_STROKE_JOIN.ROUND,
-  JLAYER_STYLE_LINE_STROKE_JOIN.BEVEL
+export const ALL_LAYER_STYLE_LINE_JOIN: JLAYER_STYLE_LINE_JOIN[] = [
+  JLAYER_STYLE_LINE_JOIN.MITER,
+  JLAYER_STYLE_LINE_JOIN.ROUND,
+  JLAYER_STYLE_LINE_JOIN.BEVEL
 ]
 
 export const ALL_LAYER_METADATA_TYPES: JLAYER_METADATA_TYPES[] = [
@@ -246,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,
@@ -278,14 +275,42 @@ 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_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_SAAS_STATUS: JSERVER_SAAS_STATUS[] = [
-  JSERVER_SAAS_STATUS.STARTING,
-  JSERVER_SAAS_STATUS.UP,
-  JSERVER_SAAS_STATUS.DOWN
+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
 ]
+
+export const ALL_TERRAIN_ILLUMINATION_ANCHOR_TYPES: JTERRAIN_ILLUMINATION_ANCHOR_TYPES[] = [
+  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

@@ -1,5 +1,4 @@
 import { Feature, FeatureCollection, LineString, MultiLineString, Point, Polygon } from "geojson"
-import { Map } from "maplibre-gl"
 import { Store } from "redux"
 
 export interface JCoreService extends JCoreMainService {
@@ -14,7 +13,7 @@ export interface JCoreService extends JCoreMainService {
   Geometry: JGeometryService
   MouseOver: JMouseOverService
   Form: JFormService
-  Query: JQueryService
+  FormJMC: JFormJMCService
   Event: JEventService
   History: JHistoryService
   Extension: JExtensionService
@@ -26,6 +25,7 @@ export interface JCoreService extends JCoreMainService {
   MapContext: JMapContextService
   UI: JUIService
   SimpleSearch: JSimpleSearchService
+  Table: JTableService
 }
 
 export interface JUIService {
@@ -148,12 +148,15 @@ export interface JPhotoService {
 export interface JFeatureService {
   getById(layerId: JId, featureId: JId): Promise<GeoJSON.Feature>
   getByIds(layerId: JId, featureIds: JId[]): Promise<GeoJSON.Feature[]>
+  getByLayerId(layerId: JId, bbox: JBoundaryBox): Promise<GeoJSON.Feature[]>
   geometryUpdateById(params: JFeatureGeometryUpdateParams): Promise<GeoJSON.Feature>
+  propertiesUpdateById(params: JFeaturePropertiesUpdateParams): Promise<GeoJSON.Feature>
   deleteById(layerId: JId, featureId: JId): Promise<JId>
   // deleteByIds(layerId: JId, featureIds: JId[]): Promise<JFeatureDeleteByIdsResult>
   // TODO: see if the future endpoint will return detail about individual deleted features success or failure
   // https://k2geospatial.atlassian.net/browse/JMAP8-1589
   deleteByIds(layerId: JId, featureIds: JId[]): Promise<JId[]>
+  geometryCreate(params: JFeatureGeometryCreateParams): Promise<GeoJSON.Feature>
 }
 
 export interface JCoreMainService {
@@ -180,18 +183,6 @@ export interface JGeolocationService {
   goToMyLocation(options?: JPanAndZoomOptions): Promise<JLocation>
 }
 
-export interface JQueryService {
-  initializeQueryFormById(layerId: JId, queryId: string): Promise<JQuery>
-  getAllGroups(): JQueryGroup[]
-  groupExist(groupId: JId): boolean
-  getQueriesByLayerId(layerId: JId): JQuery[]
-  getQueryByLayerId(layerId: JId, queryId: string): JQuery
-  getQueriesByGroupId(groupId: JId): JQuery[]
-  getQueryByGroupId(groupId: JId, queryId: string): JQuery
-  queryExist(groupId: JId, queryId: string): boolean
-  fetchFeatures(layerId: JId, queryId: string, data: any): Promise<Feature[]>
-}
-
 export interface JAjaxService {
   get(config: JRequestConfig): Promise<any>
   post(config: JRequestConfig): Promise<any>
@@ -216,7 +207,6 @@ export interface JEventService {
   MouseOver: JMouseOverEventModule
   MapContext: JMapContextEventModule
   Server: JServerEventModule
-  Query: JQueryEventModule
 }
 
 export type JEventFunction = (params?: any) => void | Promise<any>
@@ -242,15 +232,6 @@ export interface JEventModule {
   remove(listenerId: string): void
 }
 
-export interface JQueryEventModule extends JEventModule {
-  on: {
-    queryFormLoad(listenerId: string, fn: (params: JQueryQueryFormHasLoadedEventParams) => void): void
-    beforeSubmit(listenerId: string, fn: (params: JQueryBeforeEventParams) => void): void
-    success(listenerId: string, fn: (params: JQuerySuccessEventParams) => void): void
-    error(listenerId: string, fn: (params: JQueryErrorEventParams) => void): void
-  }
-}
-
 export interface JServerEventModule extends JEventModule {
   on: {
     infoReady(listenerId: string, fn: (params: JServerInfoReadyEventParams) => void): void
@@ -330,6 +311,8 @@ export interface JLayerEventModule extends JEventModule {
     sourceChange(listenerId: string, fn: (params: JLayerEventParams) => void): void
     selectabilityWillChange(listenerId: string, fn: (params: JLayerEventSelectabilityParams) => void): void
     layerDeletion(listenerId: string, fn: (params: JLayerEventParams) => void): void
+    thematicAddition(listenerId: string, fn: (params: JAddMapThematicEventParams) => void): void
+    thematicDeletion(listenerId: string, fn: (params: JLayerThematicEventParams) => void): void
     initialSearchApplied(listenerId: string, fn: (params: JLayerInitialSearchEventParams) => void): void
     dynamicFilterSet(listenerId: string, fn: (params: JLayerDynamicFilterSetParams) => void): void
     dynamicFilterActivationChange(listenerId: string, fn: (params: JLayerDynamicFilterActivationParams) => void): void
@@ -409,10 +392,10 @@ export interface JCoreState {
   map: JMapState
   project: JProjectState
   layer: JLayerState
+  table: JTableState
   user: JUserState
   language: JLanguageState
   photo: JPhotoState
-  query: JQueryState
   geocoding: JGeocodingState
   simpleSearch: JSimpleSearchState
   geolocation: JGeolocationState
@@ -436,7 +419,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
@@ -472,7 +455,7 @@ export interface JSimpleSearchState {
   isLoading: boolean
   hasLoadingError: boolean
   queryString: string
-  results: JSimpleSearchResult
+  results: JSimpleSearchResult[]
 }
 
 export interface JGeolocationState {
@@ -501,9 +484,12 @@ export interface JMapState {
   scaleControlPosition: JMAP_POSITIONS
   distanceUnit: JMAP_DISTANCE_UNITS
   isNavigationHistoryControlVisible: boolean
+  isTerrainAvailable: boolean
+  isTerrainActive: boolean
   isScaleControlVisible: boolean
   isMapRotationControlVisible: boolean
-  isInfoControlVisible: boolean
+  isTerrainControlVisible: boolean
+  isMapInfoControlVisible: boolean
   isInfoControlExpanded: boolean
   defaultZoomOptions: JZoomOptions
   containerWidth: number
@@ -511,6 +497,7 @@ export interface JMapState {
   modificationType: JMAP_MODIFICATION_TYPES
   attributions: JMapAttribution[]
   rasterOpacityByLayerId: { [id: JId]: number }
+  projection: JProjection
 }
 
 export interface JProjectState {
@@ -532,6 +519,12 @@ export interface JLayerState {
   vectorLayerIds: JId[]
 }
 
+export interface JTableState {
+  isLoading: boolean
+  hasLoadingError: boolean
+  tables: JTable[]
+}
+
 export interface JPhotoState {
   selectedPhotoId: JId | undefined
   photos: JPhoto[]
@@ -541,21 +534,23 @@ export interface JPhotoState {
   isDownloading: boolean
 }
 
-export interface JQueryState {
-  groups: JQueryGroup[]
-  queriesByLayerId: { [key in JId]: JQuery[] }
-}
-
 export interface JUserState extends JTokenInfo {
   isAnonymous: boolean
+  anonymousOrganizationId: string
+  anonymousProjectId: JId
   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 {
@@ -570,6 +565,11 @@ export interface JServerState extends JServerInfo {
 
 export type JHistoryListener = (oldValue: string | undefined, newValue: string | undefined) => void
 
+export interface JFormJMCService {
+  getJsonForm(dataSourceId: string): Promise<JJsonFormSchemas>
+  getForm(layerId: string): Promise<JFormJMC>
+}
+
 export interface JFormService {
   // REPO METHODS
   getFormsMetaDataByLayerId(layerId: JId): Promise<JFormMetaData[]>
@@ -678,7 +678,7 @@ export interface JMapService {
   Selection: JMapSelectionService
   Basemap: JMapBasemapService
   Attribution: JMapAttributionService
-  getMap(): Map
+  getMap(): maplibregl.Map
   getMapJSLib(): any
   getDomContainerId(): string
   getAllDistanceUnits(): JMAP_DISTANCE_UNITS[]
@@ -691,6 +691,12 @@ export interface JMapService {
   getZoom(): number
   getMaplibreSourceIdByJMapLayerId(layerId: JId): string
   isScaleControlVisible(): boolean
+  isTerrainAvailable(): boolean
+  isTerrainActive(): boolean
+  setTerrainActive(active: boolean): void
+  isTerrainControlVisible(): boolean
+  setSelectionStyle(layerId: JId, style: JLayerSetStyleParams): void
+  resetSelectionStyle(layerId: JId): void
   setScaleControlVisibility(isVisible: boolean, position?: JMAP_POSITIONS): void
   setScaleControlUnits(units: "imperial" | "metric" | "nautical"): void
   setScaleControlPosition(position: JMAP_POSITIONS): void
@@ -701,16 +707,13 @@ export interface JMapService {
   setMapRotationControlVisibility(isVisible: boolean): void
   isMapInfoControlVisible(): boolean
   setMapInfoControlVisibility(isVisible: boolean): void
+  setTerrainControlVisibility(isVisible: boolean): void
   isMapInfoControlExpanded(): boolean
   setMapInfoControlExpansion(isExpanded: boolean): void
-  isLayerRendered(layerId: JId): boolean
-  getLayersVisibilityStatus(): JMapLayersVisibilityStatus
-  getLayersVisibilityStatusAsArray(): JMapLayerVisibilityStatus[]
   getMaplibreSupportedJMapLayerIds(): JId[]
   getMaplibreSupportedJMapLayerIdBefore(layerId: JId): JId | undefined
   getMaplibreSupportedJMapLayerIdAfter(layerId: JId): JId | undefined
   refreshLayerById(layerId: JId): void
-  getRenderedJMapLayerIds(): JId[]
   getRenderedFeatures(layerId: JId, params?: JLocation | JBoundaryBox | JCircle | JGetRenderedFeaturesParams): Feature[]
   getSourceFeatures(layerId: JId, params?: JGetSourceFeaturesParams): Feature[]
   getRenderedFeaturesAttributeValues(
@@ -820,8 +823,8 @@ export interface JMapFilterService {
 }
 
 export interface JProjectionService {
-  reprojectLocation(location: JLocation, toProjection: string, fromProjection?: string): JLocation
-  reprojectBoundaryBox(boundaryBox: JBoundaryBox, toProjection: string, fromProjection?: string): JBoundaryBox
+  reprojectLocation(location: JLocation, toProjection: string, fromProjection?: string): Promise<JLocation>
+  reprojectBoundaryBox(boundaryBox: JBoundaryBox, toProjection: string, fromProjection?: string): Promise<JBoundaryBox>
 }
 
 export interface JProjectService {
@@ -850,6 +853,8 @@ export interface JProjectService {
   isChangeDisabled(): boolean
   setChangeEnabled(): void
   setChangeDisabled(): void
+  getElevationAtLocation(location: JLocation): Promise<number | null>
+  hasTerrain(): boolean
 }
 
 export interface JLayerService {
@@ -887,6 +892,16 @@ export interface JLayerService {
   deleteLayer(layerId: JId): void
   hasInformationReport(layerId: JId): boolean
   openInformationReportInNewTab(layerId: JId, featureIds: JId[]): Promise<string>
+  getDataSourceAttributes(dataSourceId: JId): Promise<JAttribute[]>
+}
+
+export interface JTableService {
+  getTables(): JTable[]
+  getTableData(dataSourceId: JId, params: JTableDataParams): Promise<JTableData>
+  getById(tableId: JId): JTable
+  createRow(dataSourceId: JId, row: { [key: string]: any }): Promise<void>
+  updateRow(dataSourceId: JId, rowId: number, row: { [key: string]: any }): Promise<void>
+  deleteRow(dataSourceId: JId, rowId: number): Promise<void>
 }
 
 export interface JLayerSearchService {
@@ -894,6 +909,8 @@ export interface JLayerSearchService {
 }
 
 export interface JLayerThematicService {
+  addThematic(params: JLayerAddThematicParams): Promise<void>
+  deleteThematic(layerId: JId, thematicId: JId): void
   getAllByLayerId(layerId: JId): JLayerThematic[]
   getById(layerId: JId, thematicId: JId): JLayerThematic
   existsById(layerId: JId, thematicId: JId): boolean
@@ -913,16 +930,19 @@ 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>
   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
+  isLoggedInOrAnonymous(): boolean
+  isAnonymous(): boolean
   getAllInfos(): JUserInfo[]
   addInfo(info: JUserInfo): void
   removeInfo(infoId: string): void
@@ -930,10 +950,7 @@ export interface JUserService {
   changeFullName(newFullName: string): Promise<void>
   getMinimumPasswordLength(): number
   isPasswordCompliant(password: string): boolean
-  getPasswordPolicyCompliance(
-    password: string
-  ): JJMapServerPasswordPolicyCompliance | JJMapCloudPasswordPolicyCompliance
-  isPseudoUser(): boolean
+  getPasswordPolicyCompliance(password: string): JJMapPasswordPolicyCompliance
   getOrganizationId(): string
 }
 
@@ -960,7 +977,7 @@ export interface JMouseOverService {
   openPopup(params: JMouseOverOpenPopupParams): void
   openPopupForSelection(params: JMouseOverOpenPopupForSelectionParams): void
   renderForFeaturesAtLocation(containerId: string, location: JLocation): boolean // return true if has mouseover
-  renderForFeaturesSelection(containerId: string, selection: JMapSelection): boolean // return true if has mouseover
+  renderForFeaturesSelection(containerId: string, selection: JMapSelection, location?: JLocation): boolean // return true if has mouseover
   openInformationReportInNewTab(layerId: JId): Promise<string>
 }
 
@@ -975,10 +992,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,12 +1,11 @@
 {
   "name": "jmapcloud-ng-core-types",
-  "version": "1.0.1003",
+  "version": "1.1.0",
   "description": "JMap Cloud specific version of JMap Cloud NG Core types and interfaces",
   "main": "index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "pub": "export NODE_ENV='production'; node build/buildfile.js publish;",
-    "copy": "export NODE_ENV='production'; node build/buildfile.js copy;",
     "commit-doc": "export NODE_ENV='production'; node build/buildfile.js commit-doc;",
     "doc-test": "export DOC_DIR='./docs/latest'; node build/buildfile.js doc-test;",
     "copy-latest": "node build/buildfile.js copy-latest;"
@@ -28,12 +27,14 @@
   },
   "homepage": "https://github.com/k2geospatial/jmapcloud-ng-core-types#readme",
   "devDependencies": {
-    "typedoc": "^0.24.8"
+    "typedoc": "^0.25.13",
+    "patch-package": "^8.0.0"
   },
   "dependencies": {
-    "@types/geojson": "^7946.0.7",
+    "@auth0/auth0-spa-js": "^2.1.3",
+    "@types/geojson": "^7946.0.14",
     "geojson": "^0.5.0",
-    "maplibre-gl": "^3.2.1",
-    "redux": "^4.0.0"
+    "maplibre-gl": "^4.7.1",
+    "redux": "^5.0.1"
   }
 }