jmapcloud-ng-types 0.0.0

package/.prettierrc

@@ -0,0 +1,10 @@
+{
+  "printWidth": 120,
+  "semi": false,
+  "quoteProps": "consistent",
+  "jsxBracketSameLine": true,
+  "trailingComma": "none",
+  "tabWidth": 2,
+  "arrowParens": "avoid",
+  "bracketSpacing": true
+}

package/README.md

@@ -0,0 +1,7 @@
+# jmapcloud-ng-types
+JMap Cloud NG
+
+The latest version of JMap Cloud NG Javascript API documentation is available <a href="https://k2geospatial.github.io/jmapcloud-ng-types/latest/modules/jmap.html" target="_blank">here</a>.
+
+Examples and user documentation is available <a href="https://doc.k2geospatial.com/jmap/doc/ng_dev/" target="_blank">here</a>.
+

package/all-enums.ts

@@ -0,0 +1,97 @@
+export const ALL_APP_DRAW_TYPES: JAPP_DRAW_TYPES[] = [
+  JAPP_DRAW_TYPES.POINT,
+  JAPP_DRAW_TYPES.POLYGON,
+  JAPP_DRAW_TYPES.LINE_STRING,
+  JAPP_DRAW_TYPES.RECTANGLE,
+  JAPP_DRAW_TYPES.CIRCLE,
+  JAPP_DRAW_TYPES.TEXT
+]
+
+export const ALL_APP_MEASUREMENT_SYSTEMS: JAPP_MEASUREMENT_SYSTEMS[] = [
+  JAPP_MEASUREMENT_SYSTEMS.GEODETIC,
+  JAPP_MEASUREMENT_SYSTEMS.PLANAR
+]
+
+export const ALL_APP_DRAW_MODES: JAPP_DRAW_MODES[] = [
+  JAPP_DRAW_MODES.DRAW,
+  JAPP_DRAW_MODES.SELECT,
+  JAPP_DRAW_MODES.DELETE
+]
+
+export const ALL_APP_GEOMETRY_WIZARD_STEPS: JAPP_GEOMETRY_WIZARD_STEPS[] = [
+  JAPP_GEOMETRY_WIZARD_STEPS.SELECT_LAYER,
+  JAPP_GEOMETRY_WIZARD_STEPS.DRAW
+]
+
+export const ALL_APP_LAYER_DATE_FILTER_OPERATOR_TYPES: JAPP_LAYER_DATE_FILTER_OPERATOR_TYPES[] = [
+  JAPP_LAYER_DATE_FILTER_OPERATOR_TYPES.BEFORE,
+  JAPP_LAYER_DATE_FILTER_OPERATOR_TYPES.AFTER,
+  JAPP_LAYER_DATE_FILTER_OPERATOR_TYPES.BETWEEN,
+  JAPP_LAYER_DATE_FILTER_OPERATOR_TYPES.LAST_PERIOD
+]
+
+export const ALL_APP_LAYER_TEXT_FILTER_OPERATOR_TYPES: JAPP_LAYER_TEXT_FILTER_OPERATOR_TYPES[] = [
+  JAPP_LAYER_TEXT_FILTER_OPERATOR_TYPES.CONTAINS,
+  JAPP_LAYER_TEXT_FILTER_OPERATOR_TYPES.DOES_NOT_CONTAIN,
+  JAPP_LAYER_TEXT_FILTER_OPERATOR_TYPES.EQUALS,
+  JAPP_LAYER_TEXT_FILTER_OPERATOR_TYPES.DOES_NOT_EQUALS
+]
+
+export const ALL_APP_LAYER_NUMBER_FILTER_OPERATOR_TYPES: JAPP_LAYER_NUMBER_FILTER_OPERATOR_TYPES[] = [
+  JAPP_LAYER_NUMBER_FILTER_OPERATOR_TYPES.EQUALS,
+  JAPP_LAYER_NUMBER_FILTER_OPERATOR_TYPES.DOES_NOT_EQUALS,
+  JAPP_LAYER_NUMBER_FILTER_OPERATOR_TYPES.SMALLER_THAN,
+  JAPP_LAYER_NUMBER_FILTER_OPERATOR_TYPES.GREATER_THAN
+]
+
+export const ALL_APP_LAYER_FILTER_DATE_PERIOD_TYPES: JAPP_LAYER_FILTER_DATE_PERIOD_TYPES[] = [
+  JAPP_LAYER_FILTER_DATE_PERIOD_TYPES.DAY,
+  JAPP_LAYER_FILTER_DATE_PERIOD_TYPES.WEEK,
+  JAPP_LAYER_FILTER_DATE_PERIOD_TYPES.MONTH,
+  JAPP_LAYER_FILTER_DATE_PERIOD_TYPES.YEAR
+]
+
+export const ALL_APP_LAYER_EDITION_TABS: JAPP_LAYER_EDITION_TABS[] = [
+  JAPP_LAYER_EDITION_TABS.THEMATICS,
+  JAPP_LAYER_EDITION_TABS.DYNAMIC_FILTER,
+  JAPP_LAYER_EDITION_TABS.GENERAL
+]
+
+export const ALL_APP_MESSAGE_SEVERITIES: JAPP_MESSAGE_SEVERITIES[] = [
+  JAPP_MESSAGE_SEVERITIES.SUCCESS,
+  JAPP_MESSAGE_SEVERITIES.INFO,
+  JAPP_MESSAGE_SEVERITIES.WARNING,
+  JAPP_MESSAGE_SEVERITIES.ERROR
+]
+
+export const ALL_APP_PRINT_FILE_TYPES: JAPP_PRINT_FILE_TYPES[] = [
+  JAPP_PRINT_FILE_TYPES.PNG,
+  JAPP_PRINT_FILE_TYPES.JPEG,
+  JAPP_PRINT_FILE_TYPES.PDF
+]
+
+export const ALL_APP_PRINT_PAPER_SIZES: JAPP_PRINT_PAPER_SIZES[] = [
+  JAPP_PRINT_PAPER_SIZES.LETTER,
+  JAPP_PRINT_PAPER_SIZES.LEGAL,
+  JAPP_PRINT_PAPER_SIZES.A3,
+  JAPP_PRINT_PAPER_SIZES.A4
+]
+
+export const ALL_APP_PRINT_LEGEND_POSITION: JAPP_PRINT_LEGEND_POSITION[] = [
+  JAPP_PRINT_LEGEND_POSITION.TOP_RIGHT,
+  JAPP_PRINT_LEGEND_POSITION.TOP_LEFT
+]
+
+export const ALL_APP_SELECTION_TYPES: JAPP_SELECTION_TYPES[] = [
+  JAPP_DRAW_TYPES.POINT,
+  JAPP_DRAW_TYPES.LINE_STRING,
+  JAPP_DRAW_TYPES.RECTANGLE,
+  JAPP_DRAW_TYPES.CIRCLE,
+  JAPP_DRAW_TYPES.POLYGON
+]
+
+export const ALL_APP_MEASURE_TYPES: JAPP_MEASURE_TYPES[] = [
+  JAPP_DRAW_TYPES.POLYGON,
+  JAPP_DRAW_TYPES.LINE_STRING,
+  JAPP_DRAW_TYPES.CIRCLE
+]

package/index.ts

@@ -0,0 +1,434 @@
+import { JEventModule } from "jmapcloud-ng-core-types"
+
+export interface JAppState {
+  panel: JAppPanelState
+  measure: JAppMeasureState
+  form: JAppFormState
+  selection: JAppSelectionState
+  layer: JAppLayerState
+  ui: JAppUiState
+  query: JAppQueryState
+  print: JAppPrintState
+  project: JAppProjectState
+  annotation: JAppAnnotationState
+  message: JAppMessageState
+  user: JAppUserState
+  feature: JAppFeatureState
+  geometry: JAppGeometryState
+}
+
+export interface JAppGeometryState {
+  layerId: JId | undefined
+  featureId: JId | undefined // needed for update
+  hasChanged: boolean
+  feature: GeoJSON.Feature | undefined
+  isUpdate: boolean
+  wizardStep: JAPP_GEOMETRY_WIZARD_STEPS
+  draw: JAppDrawState
+}
+
+export interface JAppFeatureState {
+  layerId: JId | undefined
+  isLoading: boolean
+  hasLoadingError: boolean
+  features: GeoJSON.Feature[]
+}
+
+export interface JAppProjectState {
+  urlExist: boolean
+  showProjectList: boolean
+}
+
+export interface JAppQueryState {
+  activeQuery: JQuery | undefined
+  defaultValueById: { [id: string]: any } | undefined
+  displayInDialog: boolean
+}
+
+export interface JAppPanelState {
+  active: JAppPanel
+  all: JAppPanel[]
+}
+
+export interface JAppLayerState {
+  treeFilter: JAppLayerTreeFilterState
+  popupMenuLayerId: JId | undefined
+  editionActiveTab: JAPP_LAYER_EDITION_TABS
+  inEditionLayerId: JId | undefined
+  isDynamicFilterDialogOpened: boolean
+  inEditionDynamicFilterConditionId: number | undefined
+}
+
+export interface JAppUiState {
+  sidePanelVisible: boolean
+  mainPanelWidthInPixel: number
+  theme: { [key: string]: any }
+}
+
+export interface JAppFormState {
+  expandedSections: { [id: string]: boolean }
+}
+
+export interface JAppMeasureState {
+  measurementSystem: JAPP_MEASUREMENT_SYSTEMS
+  measures: JAppMeasure[]
+  isSelectionActive: boolean
+  isNewElement: boolean
+  draw: JAppDrawState
+}
+
+export interface JAppDrawState {
+  type: JAPP_DRAW_TYPES
+  mode: JAPP_DRAW_MODES
+  featuresSelected: JAppDrawFeature[]
+  isDeleting: boolean
+  isNewElement: boolean
+  isStyling: boolean
+  style: JAppDrawStyle
+}
+
+export interface JAppAnnotationState {
+  annotations: JAppAnnotation[]
+  draw: JAppDrawState
+  presetColors: string[]
+}
+
+export interface JAppPrintState {
+  paperFormat: JAppPaperFormat
+  fileType: JAPP_PRINT_FILE_TYPES
+  isOrientationPortrait: boolean
+  base64Image: string
+  pageTitle: string
+  pageSubTitle: string
+  isDateVisible: boolean
+  isNorthArrowVisible: boolean
+  isScaleVisible: boolean
+  isLegend: boolean
+  isHiResolution: boolean
+  legendTitle: string
+  legendSubTitle: string
+  legendPosition: JAPP_PRINT_LEGEND_POSITION
+  filterList: any[]
+}
+
+export interface JAppSelectionState {
+  displayedLayerId: JId
+  isNewElement: boolean
+  tableVisibility: boolean
+  isTabOpened: boolean
+  draw: JAppDrawState
+}
+
+export interface JAppMessageState {
+  messages: JAppMessage[]
+  overlayMessages: JAppOverlayMessage[]
+  confirmMessage: JAppConfirmMessage | undefined
+}
+
+export interface JAppUserState {
+  actions: JAppUserAction[]
+}
+
+export interface JApplicationService extends JApplicationMainService {
+  User: JApplicationUserService
+  Panel: JAppPanelService
+  Measure: JAppMeasureService
+  Selection: JAppSelectionService
+  Layer: JAppLayerService
+  Print: JAppPrintService
+  UI: JApplicationUIService
+  Query: JAppQueryService
+  Event: JAppEventService
+  Annotation: JAppAnnotationService
+  Extension: JAppExtensionService
+  Message: JAppMessageService
+  Project: JAppProjectService
+  Feature: JAppFeatureService
+  Geometry: JAppGeometryService
+  Form: JAppFormService
+}
+
+export interface JAppGeometryService {
+  openPanelForCreation(): void
+  openPanelForUpdate(params: JAppGeometryUpdateParams): void
+  selectLayer(layerId: JId): void
+  startCreationDrawing(): void
+  stopCreationDrawing(): void
+  finishCreate(): void
+  finishUpdate(): Promise<void>
+  closePanel(): void
+}
+
+export interface JAppFeatureService {
+  openEditMenuById(layerId: JId, featureId: JId): Promise<GeoJSON.Feature>
+  openEditMenuByIds(layerId: JId, featureIds: JId[]): Promise<GeoJSON.Feature[]>
+  closeEditMenu(): void
+  deleteByIds(layerId: JId, featureIds: JId[]): Promise<JFeatureDeleteByIdsResult>
+}
+
+export interface JAppProjectService {
+  activateById(projectId: JId): JProject
+  setSelectionPanelVisibility(isVisible: boolean): void
+}
+
+export interface JAppMessageService {
+  error(message: string, options?: JAppMessageOptions): void
+  warning(message: string, options?: JAppMessageOptions): void
+  info(message: string, options?: JAppMessageOptions): void
+  success(message: string, options?: JAppMessageOptions): void
+  confirmMessage(params: JAppConfirmMessage): void
+  display(message: string, options?: JAppMessageOptions): void
+  displayWaitingOverlay(message: string): string
+  closeWaitingOverlay(messageId?: string): void
+}
+
+export interface JAppAnnotationService {
+  getDrawMode(): JAPP_DRAW_MODES
+  setDrawMode(drawMode: JAPP_DRAW_MODES): void
+  getDrawType(): JAPP_DRAW_TYPES
+  setDrawType(drawType: JAPP_DRAW_TYPES): void
+  existsById(annotationId: string): boolean
+  getById(annotationId: string): JAppAnnotation
+  getAll(): JAppAnnotation[]
+  getSelectedIds(): string[]
+  deleteAll(): void
+  deleteByType(annotationType: JAPP_DRAW_TYPES): void
+  deleteByIds(annotationIds: string[]): void
+  deleteSelected(): void
+  getStyle(): JAppDrawStyle
+  updateStyle(style: JAppDrawStyle): void
+  setStyleByAnnotationIds(annotationIds: string[], style: JAppDrawStyle): void
+  setPresetColors(presetColors: string[]): void
+  getPresetColors(): string[]
+  addPresetColor(presetColor: string): void
+  deletePresetColor(presetColor: string): void
+}
+
+export interface JAppQueryService {
+  activateQuery(groupId: JId, queryId: string): void
+  deactivateQuery(): void
+  setDefaultData(values: any): void
+  getDefaultData(): { [id: string]: any }
+  clearDefaultData(): void
+  displayInDialog(isVisibleInDialog: boolean): void
+  processQuery(values: any): Promise<GeoJSON.Feature[]>
+}
+
+export interface JApplicationUserService {
+  addPopupMenuAction(action: JAppUserAction, index?: number): void
+  existsPopupMenuActionById(actionId: string): boolean
+  removePopupMenuActionById(actionId: string): void
+}
+
+export interface JApplicationMainService {
+  getVersion(): string
+  getApiVersion(): string
+  openDocumentation(): void
+  openUserManual(): void
+}
+
+export interface JApplicationUIService {
+  Container: {
+    getId(): string
+    getWidth(): number
+    getHeight(): number
+    getVisiblePolygonGeometry(): GeoJSON.Polygon
+  }
+  SidePanel: {
+    isVisible(): boolean
+    toggleVisibility(): void
+    setVisible(isVisible: boolean): void
+    getWidthOpenInRem(): string
+    getWidthOpenInPixel(): number
+    getMinimumWidthOpenInPixel(): number
+    setWidthOpenInPixel(width: number): void
+    getWidthCloseInRem(): string
+    getWidthCloseInPixel(): number
+    getMainPanelWidthInRem(): string
+    getMainPanelWidthInPixel(): number
+    getHeaderMinHeightInRem(): string
+    getHeaderMinHeightInPixel(): number
+    getTitleMinHeightInRem(): string
+    getTitleMinHeightInPixel(): number
+  }
+  Theme: {
+    setDark(isDark: boolean): void
+    isDark(): boolean
+  }
+}
+
+export interface JAppEventService {
+  Main: JAppAppEventModule
+  Layer: JAppLayerEventModule
+  UI: JAppUIEventModule
+  Extension: JAppExtensionEventModule
+  MapContext: JAppMapContextEventModule
+}
+
+export interface JAppSelectionService {
+  getDisplayedLayerId(): JId
+  setDisplayedLayerId(layerId: JId): void
+  activateSelectionType(selectionType: JAPP_SELECTION_TYPES): void
+  getActiveSelectionType(): JAPP_SELECTION_TYPES
+  getTableVisibility(): boolean
+  setTableVisibility(tableVisibility: boolean): void
+  isTableDisplayedInTab(): boolean
+  openTableInTab(): void
+  closeTableTab(): void
+  clearSelectionForLayer(layerId: JId): void
+  clearSelection(): void
+  selectFromFeature(feature: GeoJSON.Feature, selectionType?: JAPP_SELECTION_TYPES): void
+  exportAsExcelFile(): void
+  fitMapToDisplayLayerSelection(options?: JPanAndZoomOptions): void
+}
+
+export interface JAppMeasureService {
+  getAll(): JAppMeasure[]
+  existsById(measureId: string): boolean
+  getById(measureId: string): JAppMeasure
+  getAllLineMeasures(): JAppMeasure[]
+  getAllPolygonMeasures(): JAppMeasure[]
+  getAllCircleMeasures(): JAppMeasure[]
+  setAllMeasures(measures: JAppMeasure[]): void
+  activateMeasureType(measureType: JAPP_MEASURE_TYPES): void
+  getActiveMeasureType(): JAPP_MEASURE_TYPES
+  getSelectedIds(): string[]
+  setSelectionActive(isSelectionActive: boolean): void
+  deleteAll(): number
+  deleteSelected(): number
+  deleteMeasuresById(measureIds: string[]): number
+  deleteAllLines(): number
+  deleteAllPolygons(): number
+  deleteAllCircles(): number
+  setMeasurementSystem(measurementSystem: JAPP_MEASUREMENT_SYSTEMS): void
+  getMeasurementSystem(): JAPP_MEASUREMENT_SYSTEMS
+}
+
+export interface JAppExtensionService {
+  register(extension: JAppExtension): void
+  isRegistered(extensionId: string): boolean
+  getAllRegisteredIds(): string[]
+}
+
+export interface JAppPanelService {
+  getActive(): JAppPanel
+  getAll(): JAppPanel[]
+  existById(panelId: string): boolean
+  activateById(panelId?: string, params?: JAppPanelActivationParams): void
+  deactivateCurrent(params?: JAppPanelDeactivationParams): void
+  add(panel: JAppPanel): void
+  removeById(panelId: string): void
+}
+
+export interface JAppPrintService {
+  setScaleControlVisibility(isVisible: boolean): void
+  isScaleControlVisible(): boolean
+  setPageTitle(title: string): void
+  getPageTitle(): string
+  setPageSubTitle(subTitle: string): void
+  getPageSubTitle(): string
+  setDateVisibility(isVisible: boolean): void
+  isDateVisibile(): boolean
+  setNorthArrowVisibility(isVisible: boolean): void
+  isNorthArrowVisible(): boolean
+  getAllPaperFormats(): JAppPaperFormat[]
+  setPaperFormat(format: JAppPaperFormat | string): void
+  getPaperFormat(): JAppPaperFormat
+  setOrientation(isPortrait: boolean): void
+  isOrientationPortrait(): boolean
+  setFileType(fileType: JAPP_PRINT_FILE_TYPES): void
+  getFileType(): JAPP_PRINT_FILE_TYPES
+  setHiResolution(isHiResolution: boolean): void
+  getHiResolution():boolean
+  takeCapture(): void
+}
+
+export interface JAppLayerService {
+  Tree: JAppLayerTreeService
+  Edition: JAppLayerEditionService
+}
+
+export interface JAppDynamicFilterService {
+  openPanel(layerId: JId): void
+  closePanel(): void
+  openCreateDialog(layerId: JId): void
+  openUpdateDialog(layerId: JId, conditionId: number): void
+  closeDialog(): void
+}
+
+export interface JAppLayerEditionInfoService {
+  openPanel(layerId: JId): void
+  closePanel(): void
+}
+
+export interface JAppLayerEditionThematicService {
+  openPanel(layerId: JId): void
+  closePanel(): void
+}
+
+export interface JAppLayerEditionService {
+  DynamicFilter: JAppDynamicFilterService
+  Info: JAppLayerEditionInfoService
+  Thematic: JAppLayerEditionThematicService
+  openPanel(layerId: JId, tab: JAPP_LAYER_EDITION_TABS): void
+  closePanel(): void
+}
+
+export interface JAppLayerTreeService {
+  Filter: JAppLayerTreeFilterService
+}
+
+export interface JAppLayerTreeFilterService {
+  setName(nameFilter: string): void
+  isApplied(): boolean
+  isActive(): boolean
+  setActive(active: boolean): void
+  applyToMap(): void
+  existById(filterId: number): boolean
+  oneFilterExistForMetadataId(metadataId: JId): boolean
+  getAll(): JAppGetAllFiltersResult
+  getById(filterId: number): JAppAnyLayerFilter
+  add(filter: JAppAnyLayerFilter): JAppAnyLayerFilter
+  deleteById(filterId: number): JAppAnyLayerFilter
+  openAddFilterDialog(): void
+  closeAddFilterDialog(): void
+}
+
+export interface JAppFormService {
+  render(containerId: string, formParams: JFormParams): JFormMetaData
+  destroyByContainerId(containerId: string): void
+}
+
+export interface JAppAppEventModule extends JEventModule {
+  on: {
+    appReady(listenerId: string, fn: () => void): void
+  }
+}
+
+export interface JAppLayerEventModule extends JEventModule {
+  on: {
+    doubleClick(listenerId: string, fn: (params: JAppLayerEventParams) => void): void
+  }
+}
+
+export interface JAppExtensionEventModule extends JEventModule {
+  on: {
+    registration(listenerId: string, fn: (params: JAppExtensionEventParams) => void): void
+  }
+}
+
+export interface JAppUIEventModule extends JEventModule {
+  on: {
+    sidePanelVisibilityChanged(
+      listenerId: string,
+      fn: (params: JAppUISidePanelVisibilityChangedEventParams) => void
+    ): void
+    sidePanelWidthChanged(listenerId: string, fn: (params: JAppUISidePanelWidthChangedEventParams) => void): void
+  }
+}
+
+export interface JAppMapContextEventModule extends JEventModule {
+  on: {
+    afterApply(listenerId: string, fn: (params: JMapContextAfterApplyEventParams) => void): void
+  }
+}

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "jmapcloud-ng-types",
+  "version": "0.0.0",
+  "description": "JMap Cloud specific version of JMap Cloud NG types and interfaces",
+  "main": "src/app.ts",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "pub": "export NODE_ENV='production'; gulp publish --gulpfile build/gulpfile.js;",
+    "copy": "export NODE_ENV='production'; gulp copy --gulpfile build/gulpfile.js;",
+    "commit-doc": "export NODE_ENV='production'; gulp commit-doc --gulpfile build/gulpfile.js;",
+    "doc-test": "export DOC_DIR='./docs/latest'; gulp typedoc --gulpfile build/gulpfile.js;"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/k2geospatial/jmapcloud-ng-types.git"
+  },
+  "author": "K2 Geospatial",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/k2geospatial/jmapcloud-ng-types/issues"
+  },
+  "homepage": "https://github.com/k2geospatial/jmapcloud-ng-types#readme",
+  "devDependencies": {
+    "gulp": "^4.0.2",
+    "gulp-typedoc": "^2.2.2",
+    "jmapcloud-ng-core-types": "0.0.4",
+    "typedoc": "^0.15.0"
+  }
+}

package/public/annotation.d.ts

@@ -0,0 +1,16 @@
+declare interface JAppAnnotation {
+  id: string
+  type: JAPP_DRAW_TYPES
+  feature: any
+}
+
+declare interface JappTextMarkerProperties {
+  id: string
+  location: mapboxgl.LngLatLike
+  textSize: number
+  textColor: string
+  textRotation: number
+  label: string
+  zoomRef: number
+  shapeType: string
+}