jmapcloud-ng-types 1.0.1001 → 1.1.0

package/public/extension.d.ts

@@ -1,44 +1,44 @@
 /**
  * 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.
@@ -50,23 +50,29 @@ declare interface JAppExtension extends JCoreExtension {
   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
+  /**
+   * Specify to omit the panel header if required.
+   *
+   * If set to true, NG will not display the panel header, including the extension's title. The extension developer is then responsible for displaying the extension's title inside its panel. The panel scrolling behaviour will also have to be handled by the developer.
+   */
+  omitPanelHeader?: boolean
   /**
    * 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

package/public/form.d.ts

@@ -1,24 +1,16 @@
-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
+declare type JFormDialogParams = JFormDialogLayerParams | JFormDialogTableParams
+
+declare type JFormDialogLayerParams = {
+  layerId: JId
+  featureId?: JId
+  feature?: GeoJSON.Feature
+  isReadOnly: boolean
+  onSubmit?: () => void
 }
+
+declare type JFormDialogTableParams = {
+  tableId: JId
+  row?: { [key: string]: any }
+  isReadOnly: boolean
+  onSubmit?: () => void
+}  

package/public/panel.d.ts

@@ -7,15 +7,19 @@ declare interface JAppPanelDeactivationParams extends JAppPanelActivationParams
 }
 
 declare interface JAppPanelLeaveResponse {
-  title: string,
+  title: string
   message: string
 }
 
 declare interface JAppPanel {
   id: string
-  icon: string // url or base64 or app name
+  /**
+   * must be a fontawesome IconDefinition or a valid <img> src (url or base64 data), or an svg string
+   */
+  icon: import("@fortawesome/fontawesome-svg-core").IconDefinition | string
   iconTooltip: string | JTranslationItem | (() => string)
   interactorId?: string | (() => string | undefined)
+  omitPanelHeader?: boolean
   title?: string | JTranslationItem | (() => string)
   isPopup?: boolean
   onPanelCreation?: (panelContainerId: string) => void

package/public/print.d.ts

@@ -10,7 +10,8 @@ declare const enum JAPP_PRINT_PAPER_SIZES {
   LETTER = "letter",
   LEGAL = "legal",
   A3 = "a3",
-  A4 = "a4"
+  A4 = "a4",
+  CUSTOM = "custom"
 }
 
 // ALL_APP_PRINT_LEGEND_POSITION in all-enum.ts
@@ -25,3 +26,9 @@ declare interface JAppPaperFormat {
   height: number
   ratio: number
 }
+
+declare interface JAppPrintCaptureResult {
+  height: number
+  width: number
+  dataUrl: string
+}

package/public/startup-options.d.ts

@@ -1,9 +1,10 @@
 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
+   * @example
+   * ```html
    * <html>
    *   ...
    *   <body>
@@ -26,7 +27,7 @@ declare interface JCoreOptions {
    *    <script defer type="text/javascript" src="https://cdn.jsdelivr.net/npm/jmapcloud-ng@0.1.1/public/index.js"></script>
    *   </body>
    * </html>
-   * 
+   *
    * ```
    */
   application?: JApplicationOptions
@@ -35,9 +36,9 @@ declare interface JCoreOptions {
 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>
@@ -58,7 +59,7 @@ declare interface JApplicationOptions {
    * ```
    *
    * 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
@@ -66,7 +67,7 @@ declare interface JApplicationOptions {
   /**
    * Set a custom application background login image, by default the JMap background is displayed.
    * Background login image is used for login screen.
-   * 
+   *
    * ```html
    * <html>
    *   ...
@@ -85,12 +86,12 @@ declare interface JApplicationOptions {
    * </html>
    * ```
    */
-   loginBackgroundImageUrl?: string
+  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>
    *   ...
@@ -109,11 +110,11 @@ declare interface JApplicationOptions {
    * </html>
    * ```
    */
-   projectBackgroundImageUrl?: string
+  projectBackgroundImageUrl?: string
 
   /**
    * Set a custom application logo, by default the JMap logo is displayed.
-   * 
+   *
    * ```html
    * <html>
    *   ...
@@ -136,7 +137,7 @@ declare interface JApplicationOptions {
 
   /**
    * Set the UI theme as dark or light.
-   * 
+   *
    * ```html
    * <html>
    *   ...
@@ -157,13 +158,61 @@ declare interface JApplicationOptions {
    */
   theme?: "dark" | "light"
 
+  /**
+   * By default the Simple Search control is visible.
+   *
+   * But if ***simpleSearchControlVisible*** is false, it will be hidden over the map.
+   *
+   * ```html
+   * <html>
+   *   ...
+   *   <body>
+   *     <script type="text/javascript">
+   *       window.JMAP_OPTIONS = {
+   *         ...
+   *         application: {
+   *           simpleSearchControlVisible: false,
+   *         }
+   *       }
+   *     </script>
+   *     ...
+   *   </body>
+   * </html>
+   * ```
+   */
+  simpleSearchControlVisible?: boolean
+
+  /**
+   * By default the Geocoding control is visible.
+   *
+   * But if ***geocodingControlVisible*** is false, it will be hidden over the map.
+   *
+   * ```html
+   * <html>
+   *   ...
+   *   <body>
+   *     <script type="text/javascript">
+   *       window.JMAP_OPTIONS = {
+   *         ...
+   *         application: {
+   *           geocodingControlVisible: false,
+   *         }
+   *       }
+   *     </script>
+   *     ...
+   *   </body>
+   * </html>
+   * ```
+   */
+  geocodingControlVisible?: boolean
+
   /**
    * 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>
    *   ...
@@ -186,11 +235,11 @@ declare interface JApplicationOptions {
 
   /**
    * 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>
    *   ...
@@ -213,9 +262,9 @@ declare interface JApplicationOptions {
 
   /**
    * 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>
    *   ...
@@ -241,9 +290,9 @@ declare interface JApplicationOptions {
    *  - 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>
    *   ...
@@ -268,9 +317,9 @@ declare interface JApplicationOptions {
    * 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>
    *   ...
@@ -293,9 +342,9 @@ declare interface JApplicationOptions {
 
   /**
    * 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/user.d.ts

@@ -1,7 +1,10 @@
 declare interface JAppUserAction {
   id: string
   label: string | JTranslationItem
-  icon: string
+  /**
+   * must be a fontawsome IconDefinition or a valid <img> src (url or base64 data)
+   */
+  icon: import("@fortawesome/fontawesome-svg-core").IconDefinition | string
   isHelp?: boolean
   href?: string
   disabled?: boolean