jmapcloud-ng-types 0.0.0

package/public/draw.d.ts

@@ -0,0 +1,53 @@
+// ALL_APP_DRAW_TYPES in all-enum.ts
+declare const enum JAPP_DRAW_TYPES {
+  POINT = "point",
+  POLYGON = "polygon",
+  LINE_STRING = "line_string",
+  RECTANGLE = "rectangle",
+  CIRCLE = "circle",
+  TEXT = "text"
+}
+
+// ALL_APP_DRAW_MODES in all-enum.ts
+declare const enum JAPP_DRAW_MODES {
+  DRAW = "draw",
+  SELECT = "select",
+  DELETE = "delete"
+}
+
+declare type JAppDrawFeaturesFn = (features: JAppDrawFeature[]) => void
+
+declare interface JAppDrawFeature extends GeoJSON.Feature {
+  id: string
+  properties: JAppDrawStyle
+  coordinates: JPoint[]
+  addCoordinate: (path?: string | number, lng?: number, lat?: number) => void
+  isValid: () => boolean
+  updateCoordinate: (path?: string | number, lng?: number, lat?: number) => void
+  toGeoJSON: () => GeoJSON.Feature
+  removeCoordinate: (path: string | number) => void
+  incomingCoords(coords: JPoint[][]): void
+}
+
+declare interface JAppDrawStyle extends Partial<JAppDrawTextStyle> {
+  fillColor?: string
+  fillOpacity?: number
+  lineColor?: string
+  lineOpacity?: number
+  lineWidth?: number
+  shapeType?: string
+  radiusInKm?: number
+  pointRadiusStrokeInactive?: number
+  pointRadiusActive?: number
+  pointRadiusStrokeActive?: number
+  pointRadiusInactive?: number
+  center?: number[]
+  useLocationIcon?: boolean
+}
+
+declare interface JAppDrawTextStyle {
+  textSize: number
+  textColor: string
+  textRotation: number
+  textZoomRef?: number
+}

package/public/extension.d.ts

@@ -0,0 +1,77 @@
+/**
+ * You can create a custom application panel throught the app extension mecanism.
+ * 
+ * It offers a way to add your own panel, map interactor, redux store data, etc ...
+ * 
+ * This way you can fully customize your JMap Cloud NG with your own code, written with your favourite dev tools.
+ */
+declare interface JAppExtension extends JCoreExtension {
+  /**
+   * The panel creation method.
+   * 
+   * This is where you have to :
+   *  - Create your panel UI
+   *  - Add your listeners (like Redux subscribe)
+   *  - ect ...
+   * 
+   * This method is called each time the panel is :
+   *  - Created : after a panel change
+   *  - Displayed : after the panel is displayed after been hidden
+   * 
+   * @param panelContainerId The html container id where you can insert your application.
+   */
+  onPanelCreation: (panelContainerId: string) => void
+  /**
+   * The panel destroy method.
+   * 
+   * This is where you have to :
+   *  - Destroy the panel UI (if not yet done).
+   *  - Remove your listeners (like Redux unsubscribe)
+   *  - etc ...
+   * 
+   * This method is called each time the panel is :
+   *  - Destroyed : after a panel change (panelContainerId div doesn't exist when called)
+   *  - Hidden : when the panel is hidden (panelContainerId div still exist when called)
+   * 
+   * @param panelContainerId The html container id where you can insert your application.
+   */
+  onPanelDestroy?: (panelContainerId: string) => void
+  /**
+   * The panel icon.
+   * 
+   * An url (png, jpeg, svg, etc ...), a base 64 string or an svg tag as a string, as you like.
+   * For an svg string a viewbox need to be specified for the icon to appear,
+   * if no fill attribute is specified, the icon will follow the app theme.
+   */
+  panelIcon?: string
+  /**
+   * The panel icon tooltip.
+   */
+  panelTooltip?: string | JTranslationItem
+  /**
+   * The panel title.
+   * 
+   * If provided, will create a header on top of the panel having
+   * the same style of the others panels headers.
+   */
+  panelTitle?: string | JTranslationItem
+  /**
+   * An optional map interactor.
+   * 
+   * See [[JMap.Service.Map.Interaction]] for more details.
+   */
+  interactor?: JMapInteractor
+  /**
+   * The panel registration method.
+   * 
+   * This method is called each time the app extension is :
+   *  - Registered, after the panel and interactors have been created
+   * 
+   * Here you can perform actions after the registering of the extension.
+   */
+  onAppRegistrationDone?: () => void
+}
+
+declare interface JAppExtensionEventParams {
+  extensionId: string
+}

package/public/form.d.ts

@@ -0,0 +1,24 @@
+declare interface JFormParams {
+  id: JId
+  label: string
+  schema: JFormSchema
+  uiSchema: JFormUISchema
+  validationRules?: JFormValidationRules,
+  readOnly?: boolean
+  defaultValueById?: { [id: string]: any }
+  viewId?: number
+  hideClearButton?: boolean
+  buttonLabelSubmit?: string
+  buttonLabelCancel?: string
+  buttonLabelClear?: string
+  formIsDestroyedAfterSubmit?: boolean
+  isSearch?: boolean
+  smallScreenDisplay?: boolean
+  disableSubmit?: boolean
+  submitErrors?: string[]
+  messageToDisplay?: string
+  validate: (values: any, formMetada: JFormMetaData) => { [key: string]: string }
+  onSubmit: (values: any, formMetada: JFormMetaData) => void | string | Promise<any>
+  onCancel?: () => void
+  onReset?: () => void
+}

package/public/geometry.d.ts

@@ -0,0 +1,10 @@
+// ALL_APP_GEOMETRY_WIZARD_STEPS in all-enum.ts
+declare const enum JAPP_GEOMETRY_WIZARD_STEPS {
+  SELECT_LAYER = "select-layer",
+  DRAW = "draw"
+}
+
+declare interface JAppGeometryUpdateParams {
+  layerId: JId
+  feature: GeoJSON.Feature
+}

package/public/layer.d.ts

@@ -0,0 +1,88 @@
+// ALL_APP_LAYER_DATE_FILTER_OPERATOR_TYPES in all-enum.ts
+declare const enum JAPP_LAYER_DATE_FILTER_OPERATOR_TYPES {
+  BEFORE = "before",
+  AFTER = "after",
+  BETWEEN = "between",
+  LAST_PERIOD = "lastPeriod"
+}
+
+// ALL_APP_LAYER_TEXT_FILTER_OPERATOR_TYPES in all-enum.ts
+declare const enum JAPP_LAYER_TEXT_FILTER_OPERATOR_TYPES {
+  CONTAINS = "contains",
+  DOES_NOT_CONTAIN = "doesNotContain",
+  EQUALS = "equals",
+  DOES_NOT_EQUALS = "doesNotEqual"
+}
+
+// ALL_APP_LAYER_NUMBER_FILTER_OPERATOR_TYPES in all-enum.ts
+declare const enum JAPP_LAYER_NUMBER_FILTER_OPERATOR_TYPES {
+  EQUALS = "equals",
+  DOES_NOT_EQUALS = "doesNotEqual",
+  SMALLER_THAN = "smallerThan",
+  GREATER_THAN = "greaterThan"
+}
+
+// ALL_APP_LAYER_FILTER_DATE_PERIOD_TYPES in all-enum.ts
+declare const enum JAPP_LAYER_FILTER_DATE_PERIOD_TYPES {
+  DAY = "day",
+  WEEK = "week",
+  MONTH = "month",
+  YEAR = "year"
+}
+
+// ALL_APP_LAYER_EDITION_TABS in all-enum.ts
+declare const enum JAPP_LAYER_EDITION_TABS {
+  THEMATICS = "thematics",
+  DYNAMIC_FILTER = "dynamic-filter",
+  GENERAL = "general"
+}
+
+declare type JAppLayerAnyFilterOperatorType =
+  | JAPP_LAYER_DATE_FILTER_OPERATOR_TYPES
+  | JAPP_LAYER_TEXT_FILTER_OPERATOR_TYPES
+  | JAPP_LAYER_NUMBER_FILTER_OPERATOR_TYPES
+
+declare interface JAppLayerTreeFilterState {
+  active: boolean
+  isAddingFilter: boolean
+  nameFilter: string
+  filters: JAppAnyLayerFilter[]
+  exactlyMatchedTreeItemIds: JId[]
+  expandedMatchedTreeItemIds: JId[]
+  layerIdsByFilterId: JAppLayerIdByFilterId
+}
+
+declare interface JAppGetAllFiltersResult {
+  nameFilter: string
+  filters: JAppAnyLayerFilter[]
+}
+
+declare type JAppLayerIdByFilterId = { [filterId: number]: JId[] }
+
+declare type JAppAnyLayerFilter = JAppNumberLayerFilter | JAppTextLayerFilter | JAppDateLayerFilter
+
+declare interface JAppBaseLayerFilter {
+  id: number
+  metadataItemId: JId
+  type: JLAYER_METADATA_TYPES
+}
+
+declare interface JAppNumberLayerFilter extends JAppBaseLayerFilter {
+  operator: JAPP_LAYER_NUMBER_FILTER_OPERATOR_TYPES
+  value: number
+}
+
+declare interface JAppTextLayerFilter extends JAppBaseLayerFilter {
+  operator: JAPP_LAYER_TEXT_FILTER_OPERATOR_TYPES
+  value: string
+}
+
+declare interface JAppDateLayerFilter extends JAppBaseLayerFilter {
+  operator: JAPP_LAYER_DATE_FILTER_OPERATOR_TYPES
+  datePeriod?: JAPP_LAYER_FILTER_DATE_PERIOD_TYPES
+  value: number | Date | Date[]
+}
+
+declare interface JAppLayerEventParams {
+  layer: JLayer
+}

package/public/map-context.d.ts

@@ -0,0 +1,5 @@
+declare interface JAppMapContextData {
+  measures: JAppMeasure[]
+  annotations: JAppAnnotation[]
+  annotationsTextMarkersProperties: JappTextMarkerProperties[]
+}

package/public/measure.d.ts

@@ -0,0 +1,25 @@
+declare type JAPP_MEASURE_TYPES = JAPP_DRAW_TYPES.POLYGON | JAPP_DRAW_TYPES.LINE_STRING | JAPP_DRAW_TYPES.CIRCLE
+
+// ALL_APP_MEASUREMENT_SYSTEMS in all-enum.ts
+declare const enum JAPP_MEASUREMENT_SYSTEMS {
+  PLANAR = "planar",
+  GEODETIC = "geodetic"
+}
+
+declare type JAPP_MEASURE_SPACE_TYPES = JAPP_DRAW_TYPES.POLYGON | JAPP_DRAW_TYPES.LINE_STRING | JAPP_DRAW_TYPES.CIRCLE
+
+declare interface JAppMeasureEdge {
+  popupLocation: JPoint
+  distance: number
+}
+
+declare interface JAppMeasure {
+  id: string
+  type: JAPP_MEASURE_TYPES
+  feature: GeoJSON.Feature<GeoJSON.LineString | GeoJSON.Polygon>
+  totalEdges: number
+  centroid: JPoint
+  edges: JAppMeasureEdge[]
+  area: number
+  radius: number
+}

package/public/message.d.ts

@@ -0,0 +1,38 @@
+// ALL_APP_MESSAGE_SEVERITIES in all-enum.ts
+declare const enum JAPP_MESSAGE_SEVERITIES {
+  SUCCESS = "success",
+  INFO = "info",
+  WARNING = "warning",
+  ERROR = "error"
+}
+
+declare interface JAppMessage {
+  id: string
+  text: string
+  severity: JAPP_MESSAGE_SEVERITIES
+  expired: boolean
+  duration: number | null
+}
+
+declare interface JAppOverlayMessage {
+  id: string
+  text: string
+}
+
+declare interface JAppConfirmMessage {
+  message: string
+  title: string
+  isInputMessage?: boolean
+  isInputOptional?: boolean
+  inputPlaceholder?: string
+  confirmButtonLabel?: string
+  cancelButtonLabel?: string
+  locale?: JLOCALES
+  onSuccess: (input: string) => any
+  onCancel?: () => any
+}
+
+declare interface JAppMessageOptions {
+  severity?: JAPP_MESSAGE_SEVERITIES
+  duration?: number | null
+}

package/public/panel.d.ts

@@ -0,0 +1,24 @@
+declare interface JAppPanelActivationParams {
+  ignoreConfirmationMessage?: boolean
+}
+
+declare interface JAppPanelDeactivationParams extends JAppPanelActivationParams {
+  activatePrevious?: boolean
+}
+
+declare interface JAppPanelLeaveResponse {
+  title: string,
+  message: string
+}
+
+declare interface JAppPanel {
+  id: string
+  icon: string // url or base64 or app name
+  iconTooltip: string | JTranslationItem | (() => string)
+  interactorId?: string | (() => string | undefined)
+  title?: string | JTranslationItem | (() => string)
+  isPopup?: boolean
+  onPanelCreation?: (panelContainerId: string) => void
+  onPanelDestroy?: (panelContainerId: string) => void
+  leaveConfirmationMessageFn?: () => JAppPanelLeaveResponse | undefined // returning a message will display popup
+}

package/public/print.d.ts

@@ -0,0 +1,27 @@
+// ALL_APP_PRINT_FILE_TYPES in all-enum.ts
+declare const enum JAPP_PRINT_FILE_TYPES {
+  PNG = "png",
+  JPEG = "jpeg",
+  PDF = "pdf"
+}
+
+// ALL_APP_PRINT_PAPER_SIZES in all-enum.ts
+declare const enum JAPP_PRINT_PAPER_SIZES {
+  LETTER = "letter",
+  LEGAL = "legal",
+  A3 = "a3",
+  A4 = "a4"
+}
+
+// ALL_APP_PRINT_LEGEND_POSITION in all-enum.ts
+declare const enum JAPP_PRINT_LEGEND_POSITION {
+  TOP_RIGHT = "top-right",
+  TOP_LEFT = "top-left"
+}
+
+declare interface JAppPaperFormat {
+  paperSize: JAPP_PRINT_PAPER_SIZES
+  width: number
+  height: number
+  ratio: number
+}

package/public/selection.d.ts

@@ -0,0 +1,6 @@
+declare type JAPP_SELECTION_TYPES =
+  | JAPP_DRAW_TYPES.POINT
+  | JAPP_DRAW_TYPES.LINE_STRING
+  | JAPP_DRAW_TYPES.RECTANGLE
+  | JAPP_DRAW_TYPES.CIRCLE
+  | JAPP_DRAW_TYPES.POLYGON

package/public/startup-options.d.ts

@@ -0,0 +1,302 @@
+declare interface JCoreOptions {
+  /**
+   * This section is about the JMap Cloud NG startup options.
+   * 
+   * An example of how to configure the application startup options :
+   * @example ```html
+   * <html>
+   *   ...
+   *   <body>
+   *    <div id="custom-app"></div>
+   *    <script>
+   *      window.JMAP_OPTIONS = {
+   *        projectId: 10,
+   *        restBaseUrl: "http://my-jmap-server/services/rest/v2.0",
+   *        session: {
+   *          token: 2345677654
+   *        },
+   *        application: {
+   *          // will create the application in the div id="custom-app"
+   *          containerId: "custom-app"
+   *        }
+   *      }
+   *    </script>
+   *    ...
+   *    <script defer type="text/javascript" src="https://cdn.jsdelivr.net/npm/jmapcloud-ng-core@0.5.0/public/index.js"></script>
+   *    <script defer type="text/javascript" src="https://cdn.jsdelivr.net/npm/jmapcloud-ng@0.1.1/public/index.js"></script>
+   *   </body>
+   * </html>
+   * 
+   * ```
+   */
+  application?: JApplicationOptions
+}
+
+declare interface JApplicationOptions {
+  /**
+   * When the application start it will create or use an existing div container in which the app will be inserted into.
+   * 
+   * All application dom elements will be inserted inside this div.
+   * 
+   * By default the div container id is "***jmapcloud-ng***", but you can set the id of your choice like that :
+   * ```html
+   * <html>
+   *   ...
+   *   <body>
+   *     <div id="my-custom-container-id"></div>
+   *     <script type="text/javascript">
+   *       window.JMAP_OPTIONS = {
+   *         ...
+   *         application: {
+   *           containerId: "my-custom-container-id"
+   *         }
+   *       }
+   *     </script>
+   *     ...
+   *  </body>
+   * </html>
+   * ```
+   *
+   * In the above example the application will be inserted in the div having "my-custom-container-id" as id. You need to set the width and the height of this div by yourself.
+   * 
+   * If no container is found in the DOM with the specified id, JMap Cloud NG will create and append it automatically in the body element of the web page.
+   */
+  containerId?: string
+
+  /**
+   * Set a custom application background login image, by default the JMap background is displayed.
+   * Background login image is used for login screen.
+   * 
+   * ```html
+   * <html>
+   *   ...
+   *   <body>
+   *     <script type="text/javascript">
+   *       window.JMAP_OPTIONS = {
+   *         ...
+   *         application: {
+   *           loginBackgroundImageUrl: "https://images.pexels.com/photos/1227520/pexels-photo-1227520.jpeg?auto=compress&cs=tinysrgb&dpr=3&h=750&w=1260",
+   *           ...
+   *         }
+   *       }
+   *     </script>
+   *     ...
+   *   </body>
+   * </html>
+   * ```
+   */
+   loginBackgroundImageUrl?: string
+
+  /**
+   * Set a custom application background project image, by default the JMap background is displayed.
+   * Background project image is used for projects screen.
+   * 
+   * ```html
+   * <html>
+   *   ...
+   *   <body>
+   *     <script type="text/javascript">
+   *       window.JMAP_OPTIONS = {
+   *         ...
+   *         application: {
+   *           projectBackgroundImageUrl: "https://images.pexels.com/photos/1227520/pexels-photo-1227520.jpeg?auto=compress&cs=tinysrgb&dpr=3&h=750&w=1260",
+   *           ...
+   *         }
+   *       }
+   *     </script>
+   *     ...
+   *   </body>
+   * </html>
+   * ```
+   */
+   projectBackgroundImageUrl?: string
+
+  /**
+   * Set a custom application logo, by default the JMap logo is displayed.
+   * 
+   * ```html
+   * <html>
+   *   ...
+   *   <body>
+   *     <script type="text/javascript">
+   *       window.JMAP_OPTIONS = {
+   *         ...
+   *         application: {
+   *           logoImageUrl: "https://upload.wikimedia.org/wikipedia/commons/thumb/3/3b/Atari_logo.svg/640px-Atari_logo.svg.png",
+   *           ...
+   *         }
+   *       }
+   *     </script>
+   *     ...
+   *   </body>
+   * </html>
+   * ```
+   */
+  logoImageUrl?: string
+
+  /**
+   * Set the UI theme as dark or light.
+   * 
+   * ```html
+   * <html>
+   *   ...
+   *   <body>
+   *     <script type="text/javascript">
+   *       window.JMAP_OPTIONS = {
+   *         ...
+   *         application: {
+   *           theme: "dark",
+   *           ...
+   *         }
+   *       }
+   *     </script>
+   *     ...
+   *   </body>
+   * </html>
+   * ```
+   */
+  theme?: "dark" | "light"
+
+  /**
+   * By default the active panel (the one displayed), is the "layer" panel.
+   * 
+   * Standard application panels ids are : "layer", "selection", "measure", "mapcontext", "print", "user", "query", "annotation".
+   * 
+   * But if ***panel*** is defined, it will display the corresponding panel on the screen.
+   * 
+   * ```html
+   * <html>
+   *   ...
+   *   <body>
+   *     <script type="text/javascript">
+   *       window.JMAP_OPTIONS = {
+   *         ...
+   *         application: {
+   *           panel: "project",
+   *           ...
+   *         }
+   *       }
+   *     </script>
+   *     ...
+   *   </body>
+   * </html>
+   * ```
+   */
+  panel?: string
+
+  /**
+   * The application have multiple panels available by default : "layer", "selection", "measure", "mapcontext", "print", "user", "query", "annotation".
+   * 
+   * But you can tell JMap Cloud NG to disabled some panels. If a panel is disabled it will disappear on the left menu.
+   * 
+   * The ***disabledPanels*** parameter is an array with the panel ids you want to be disabled.
+   * 
+   * ```html
+   * <html>
+   *   ...
+   *   <body>
+   *     <script type="text/javascript">
+   *       window.JMAP_OPTIONS = {
+   *         ...
+   *         application: {
+   *           disabledPanels: [ "measure", "print" ],
+   *           ...
+   *         }
+   *       }
+   *     </script>
+   *     ...
+   *   </body>
+   * </html>
+   * ```
+   */
+  disabledPanels?: string[]
+
+  /**
+   * Controls the side panel default visibility state.
+   * 
+   * The JMap Cloud NG side panel is open by default when the application starts, but you can change this behaviour by using this option.
+   *  
+   * ```html
+   * <html>
+   *   ...
+   *   <body>
+   *     <script type="text/javascript">
+   *       window.JMAP_OPTIONS = {
+   *         ...
+   *         application: {
+   *           sidePanelInitialVisibility: false, // this will initially hide the panel
+   *           ...
+   *         }
+   *       }
+   *     </script>
+   *     ...
+   *   </body>
+   * </html>
+   * ```
+   */
+  sidePanelInitialVisibility?: boolean
+
+  /**
+   * If provided this function will be processed each time the application is ready :
+   *  - A valid user session is set
+   *  - A project is selected
+   *  - The main menu is rendered
+   * 
+   * It could be called multiple times, if the user change the project, or the user logout and login.
+   * 
+   * ```html
+   * <html>
+   *   ...
+   *   <body>
+   *     <script type="text/javascript">
+   *       window.JMAP_OPTIONS = {
+   *         ...
+   *         application: {
+   *           onAppLoad: () => console.log("App is ready !"),
+   *           ...
+   *         }
+   *       }
+   *     </script>
+   *     ...
+   *   </body>
+   * </html>
+   * ```
+   */
+  onAppLoad?: () => void
+
+  /**
+   * If provided this function will be processed each time the application is not loaded anymore :
+   *  - User session token become invalid
+   *  - Project is changed and app is loading the new one
+   * 
+   * It could be called multiple times.
+   * 
+   * ```html
+   * <html>
+   *   ...
+   *   <body>
+   *     <script type="text/javascript">
+   *       window.JMAP_OPTIONS = {
+   *         ...
+   *         application: {
+   *           onAppUnload: () => console.log("App is not ready anymore !"),
+   *           ...
+   *         }
+   *       }
+   *     </script>
+   *     ...
+   *   </body>
+   * </html>
+   * ```
+   */
+  onAppUnload?: () => void
+
+  /**
+   * You can provide your own application extensions.
+   * 
+   * This mechanism offer a way to add your own panel, map interactor, redux store data, etc ...
+   * 
+   * You can fully customize JMap Cloud NG with your own code, written with your favourite dev tools.
+   */
+  extensions?: JAppExtension[]
+}

package/public/ui.d.ts

@@ -0,0 +1,7 @@
+declare interface JAppUISidePanelVisibilityChangedEventParams {
+  isVisible: boolean
+}
+
+declare interface JAppUISidePanelWidthChangedEventParams {
+  width: number
+}