jmapcloud-ng-core-types 1.1.34 → 1.1.36

package/index.d.ts

@@ -1,8 +1,26 @@
+/// <reference path="./public/global-aliases.d.ts" />
 import { Feature, FeatureCollection, LineString, MultiLineString, Point, Polygon } from "geojson"
 import { JForm as JFormJMC } from "jmapcloud-types"
-import { Store } from "redux"
+import { Action, Store } from "redux"
+import type { JCoreState } from "./public/state.d.ts"
 
 export type { JCoreOptions } from "./public/jmap/startup-options.d.ts"
+export type {
+  JCoreState,
+  JFormState,
+  JGeocodingState,
+  JGeolocationState,
+  JLanguageState,
+  JLayerState,
+  JMapContextState,
+  JMapState,
+  JProjectState,
+  JServerState,
+  JSimpleSearchState,
+  JTableState,
+  JUIState,
+  JUserState
+} from "./public/state.d.ts"
 
 export interface JCoreService extends JCoreMainService {
   Project: JProjectService
@@ -158,7 +176,7 @@ export interface JFeatureService {
 export interface JCoreMainService {
   getVersion(): string
   getApiVersion(): string
-  getDataStore(): Store<JCoreState> | undefined
+  getDataStore(): Store<JCoreState, Action>
   getRestUrl(): string
   openDocumentation(): void
   getOS(): JOPERATING_SYSTEMS
@@ -377,171 +395,6 @@ export interface JMapContextEventModule extends JEventModule {
   }
 }
 
-export interface JCoreState {
-  map: JMapState
-  project: JProjectState
-  layer: JLayerState
-  table: JTableState
-  user: JUserState
-  language: JLanguageState
-  geocoding: JGeocodingState
-  simpleSearch: JSimpleSearchState
-  geolocation: JGeolocationState
-  form: JFormState
-  server: JServerState
-  mapContext: JMapContextState
-  ui: JUIState
-  external?: any
-}
-
-export interface JUIState {
-  isMainLayoutVisible: boolean
-  iframePopup: JIFramePopup
-}
-
-export interface JMapContextState {
-  isInitialized: boolean
-  isActive: boolean
-  isLoading: boolean
-  hasLoadingError: boolean
-  isApplying: boolean
-  activeTab: JMAP_CONTEXT_TABS
-  contexts: JMapContext[]
-  defaultContextId: string | undefined
-  filter: string
-  sortBy: JMAP_CONTEXT_SORT_BY_OPTIONS
-  sortByDirection: JMAP_CONTEXT_SORT_BY_DIRECTIONS
-  createTitle: string
-  createDescription: string
-  createTitleError: boolean
-}
-
-export interface JFormState {
-  layerId: JId // set as "" when no layer is set
-  formMetaDataById: JFormMetaDataById
-  isLoadingLayer: boolean
-  hasLoadingLayerError: boolean
-  isSubmitting: boolean
-  submitErrors: string[]
-  activeTabIndex: number
-  attributeForm: JForm | undefined
-  externalForms: JForm[]
-  subForms: JForm[]
-}
-
-export interface JGeocodingState {
-  isAvailable: boolean
-  isLoadPending: boolean
-  isLoading: boolean
-  hasLoadingError: boolean
-  searchString: string
-  results: JGeocodingResult[]
-}
-
-export interface JSimpleSearchState {
-  isLoadPending: boolean
-  isLoading: boolean
-  hasLoadingError: boolean
-  queryString: string
-  results: JSimpleSearchResult[]
-}
-
-export interface JGeolocationState {
-  isLocationDisplayed: boolean
-  isEnabled: boolean
-  isSupported: boolean
-  currentLocation: JLocation | undefined
-}
-
-export interface JMapState {
-  pitch: number
-  rotation: number
-  bearing: number
-  isLoaded: boolean
-  hasFirstLoaded: boolean
-  hasLoadingError: boolean
-  navigationHistory: JMapNavigationStep[]
-  center: JLocation
-  zoom: number
-  scale: number
-  boundaryBox: JBoundaryBox
-  activeBasemapId: string | undefined
-  basemaps: JBasemap[]
-  selection: JMapSelection
-  jmapLayerIdsSupportedByMaplibre: JId[]
-  scaleControlPosition: JMAP_POSITIONS
-  distanceUnit: JMAP_DISTANCE_UNITS
-  isNavigationHistoryControlVisible: boolean
-  isTerrainAvailable: boolean
-  isTerrainActive: boolean
-  isScaleControlVisible: boolean
-  isMapRotationControlVisible: boolean
-  isTerrainControlVisible: boolean
-  isMapInfoControlVisible: boolean
-  isInfoControlExpanded: boolean
-  defaultZoomOptions: JZoomOptions
-  containerWidth: number
-  containerHeight: number
-  modificationType: JMAP_MODIFICATION_TYPES
-  attributions: JMapAttribution[]
-  rasterOpacityByLayerId: { [id: JId]: number }
-  projection: JProjection
-}
-
-export interface JProjectState {
-  isLoading: boolean
-  hasLoadingError: boolean
-  allProjects: JProject[]
-  selectedProject: JProject
-  disableProjectChange: boolean
-}
-
-export interface JLayerState {
-  isLoading: boolean
-  hasLoadingError: boolean
-  metadataSchema: JLayerMetadataSchemaItem[]
-  tree: JLayerTree
-  styleSamplesById: JLayerStyleSamplesById
-  allById: { [treeElementId: string]: JLayerTreeElement }
-  orderedLayerIds: JId[]
-  vectorLayerIds: JId[]
-}
-
-export interface JTableState {
-  isLoading: boolean
-  hasLoadingError: boolean
-  tables: JTable[]
-}
-
-export interface JUserState extends JTokenInfo {
-  isAnonymous: boolean
-  anonymousOrganizationId: string
-  anonymousProjectId: JId
-  isLoggingIn: boolean
-  isLoggingIntoOrganization: boolean
-  isReloadingSession: boolean
-  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 {
-  locale: JLOCALES
-}
-
-export interface JServerState extends JServerInfo {
-  isReady: boolean
-  isLoading: boolean
-  hasLoadingError: boolean
-}
-
 export type JHistoryListener = (oldValue: string | undefined, newValue: string | undefined) => void
 
 export interface JFormJMCService {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jmapcloud-ng-core-types",
-  "version": "1.1.34",
+  "version": "1.1.36",
   "description": "JMap Cloud specific version of JMap Cloud NG Core types and interfaces",
   "main": "index.js",
   "types": "ambient.d.ts",

package/public/core.d.ts

@@ -1,5 +1,7 @@
 /// <reference path="./global-aliases.d.ts" />
 
+import type { Action, Store } from "redux"
+import type { JCoreState } from "./state.d.ts"
 import type { JRequestConfig } from "./jmap/ajax.d.ts"
 import type {
   JAttachment,
@@ -229,7 +231,7 @@ export namespace JMap {
    * reduxStore.dispatch(...)
    * ```
    */
-  function getDataStore(): any | undefined
+  function getDataStore(): Store<JCoreState, Action>
   /**
    * **JMap.getRestUrl**
    *

package/public/state.d.ts

@@ -0,0 +1,194 @@
+import type { JForm, JFormMetaDataById } from "./jmap/form.d.ts"
+import type { JGeocodingResult } from "./jmap/geocoding.d.ts"
+import type { JBoundaryBox, JLocation } from "./jmap/geometry.d.ts"
+import type { JLOCALES } from "./jmap/language.d.ts"
+import type { JLayerMetadataSchemaItem, JLayerStyleSamplesById, JLayerTree, JLayerTreeElement } from "./jmap/layer.d.ts"
+import type { JId } from "./jmap/main.d.ts"
+import type {
+  JMAP_CONTEXT_SORT_BY_DIRECTIONS,
+  JMAP_CONTEXT_SORT_BY_OPTIONS,
+  JMAP_CONTEXT_TABS,
+  JMapContext
+} from "./jmap/map-context.d.ts"
+import type {
+  JBasemap,
+  JMAP_DISTANCE_UNITS,
+  JMAP_MODIFICATION_TYPES,
+  JMAP_POSITIONS,
+  JMapAttribution,
+  JMapNavigationStep,
+  JMapSelection,
+  JProjection,
+  JZoomOptions
+} from "./jmap/map.d.ts"
+import type { JProject } from "./jmap/project.d.ts"
+import type { JSERVER_IDENTITY_PROVIDER_TYPES, JServerInfo } from "./jmap/server.d.ts"
+import type { JSimpleSearchResult } from "./jmap/simple-search.d.ts"
+import type { JTable } from "./jmap/table.d.ts"
+import type { JIFramePopup } from "./jmap/ui.d.ts"
+import type { JOrganization, JOrganizationInfo, JTokenInfo, JUser, JUserInfo, LOGIN_STATUS } from "./jmap/user.d.ts"
+export {}
+
+export interface JCoreState {
+  map: JMapState
+  project: JProjectState
+  layer: JLayerState
+  table: JTableState
+  user: JUserState
+  language: JLanguageState
+  geocoding: JGeocodingState
+  simpleSearch: JSimpleSearchState
+  geolocation: JGeolocationState
+  form: JFormState
+  server: JServerState
+  mapContext: JMapContextState
+  ui: JUIState
+  external?: any
+}
+
+export interface JUIState {
+  isMainLayoutVisible: boolean
+  iframePopup: JIFramePopup
+}
+
+export interface JMapContextState {
+  isInitialized: boolean
+  isActive: boolean
+  isLoading: boolean
+  hasLoadingError: boolean
+  isApplying: boolean
+  activeTab: JMAP_CONTEXT_TABS
+  contexts: JMapContext[]
+  defaultContextId: string | undefined
+  filter: string
+  sortBy: JMAP_CONTEXT_SORT_BY_OPTIONS
+  sortByDirection: JMAP_CONTEXT_SORT_BY_DIRECTIONS
+  createTitle: string
+  createDescription: string
+  createTitleError: boolean
+}
+
+export interface JFormState {
+  layerId: JId // set as "" when no layer is set
+  formMetaDataById: JFormMetaDataById
+  isLoadingLayer: boolean
+  hasLoadingLayerError: boolean
+  isSubmitting: boolean
+  submitErrors: string[]
+  activeTabIndex: number
+  attributeForm: JForm | undefined
+  externalForms: JForm[]
+  subForms: JForm[]
+}
+
+export interface JGeocodingState {
+  isAvailable: boolean
+  isLoadPending: boolean
+  isLoading: boolean
+  hasLoadingError: boolean
+  searchString: string
+  results: JGeocodingResult[]
+}
+
+export interface JSimpleSearchState {
+  isLoadPending: boolean
+  isLoading: boolean
+  hasLoadingError: boolean
+  queryString: string
+  results: JSimpleSearchResult[]
+}
+
+export interface JGeolocationState {
+  isLocationDisplayed: boolean
+  isEnabled: boolean
+  isSupported: boolean
+  currentLocation: JLocation | undefined
+}
+
+export interface JMapState {
+  pitch: number
+  rotation: number
+  bearing: number
+  isLoaded: boolean
+  hasFirstLoaded: boolean
+  hasLoadingError: boolean
+  navigationHistory: JMapNavigationStep[]
+  center: JLocation
+  zoom: number
+  scale: number
+  boundaryBox: JBoundaryBox
+  activeBasemapId: string | undefined
+  basemaps: JBasemap[]
+  selection: JMapSelection
+  jmapLayerIdsSupportedByMaplibre: JId[]
+  scaleControlPosition: JMAP_POSITIONS
+  distanceUnit: JMAP_DISTANCE_UNITS
+  isNavigationHistoryControlVisible: boolean
+  isTerrainAvailable: boolean
+  isTerrainActive: boolean
+  isScaleControlVisible: boolean
+  isMapRotationControlVisible: boolean
+  isTerrainControlVisible: boolean
+  isMapInfoControlVisible: boolean
+  isInfoControlExpanded: boolean
+  defaultZoomOptions: JZoomOptions
+  containerWidth: number
+  containerHeight: number
+  modificationType: JMAP_MODIFICATION_TYPES
+  attributions: JMapAttribution[]
+  rasterOpacityByLayerId: { [id: JId]: number }
+  projection: JProjection
+}
+
+export interface JProjectState {
+  isLoading: boolean
+  hasLoadingError: boolean
+  allProjects: JProject[]
+  selectedProject: JProject
+  disableProjectChange: boolean
+}
+
+export interface JLayerState {
+  isLoading: boolean
+  hasLoadingError: boolean
+  metadataSchema: JLayerMetadataSchemaItem[]
+  tree: JLayerTree
+  styleSamplesById: JLayerStyleSamplesById
+  allById: { [treeElementId: string]: JLayerTreeElement }
+  orderedLayerIds: JId[]
+  vectorLayerIds: JId[]
+}
+
+export interface JTableState {
+  isLoading: boolean
+  hasLoadingError: boolean
+  tables: JTable[]
+}
+
+export interface JUserState extends JTokenInfo {
+  isAnonymous: boolean
+  anonymousOrganizationId: string
+  anonymousProjectId: JId
+  isLoggingIn: boolean
+  isLoggingIntoOrganization: boolean
+  isReloadingSession: boolean
+  identity: JUser
+  currentOrganization: JOrganization
+  organizationInfos: JOrganizationInfo[]
+  informations: JUserInfo[]
+  changePasswordAllowed: boolean
+  identityProviderType: JSERVER_IDENTITY_PROVIDER_TYPES
+  loginStatus: LOGIN_STATUS
+  loginStatusDetailTranslationKey: string
+  callbackAtTokenRefresh: (() => void) | null
+}
+
+export interface JLanguageState {
+  locale: JLOCALES
+}
+
+export interface JServerState extends JServerInfo {
+  isReady: boolean
+  isLoading: boolean
+  hasLoadingError: boolean
+}