jmapcloud-ng-types 1.0.47 → 1.0.49

package/index.ts

@@ -8,7 +8,6 @@ export interface JAppState {
   layer: JAppLayerState
   ui: JAppUiState
   map: JAppMapState
-  query: JAppQueryState
   print: JAppPrintState
   project: JAppProjectState
   annotation: JAppAnnotationState
@@ -49,12 +48,6 @@ export interface JAppProjectState {
   showProjectList: boolean
 }
 
-export interface JAppQueryState {
-  activeQuery: JQuery | undefined
-  defaultValueById: { [id: string]: any } | undefined
-  displayInDialog: boolean
-}
-
 export interface JAppPanelState {
   active: JAppPanel
   all: JAppPanel[]
@@ -81,7 +74,7 @@ export interface JAppMapState {
 }
 
 export interface JAppFormState {
-  expandedSections: { [id: string]: boolean }
+  dialogParams: JFormDialogParams | null
 }
 
 export interface JAppMeasureState {
@@ -161,7 +154,6 @@ export interface JApplicationService extends JApplicationMainService {
   Layer: JAppLayerService
   Print: JAppPrintService
   UI: JApplicationUIService
-  Query: JAppQueryService
   Event: JAppEventService
   Annotation: JAppAnnotationService
   Extension: JAppExtensionService
@@ -232,16 +224,6 @@ export interface JAppAnnotationService {
   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
@@ -435,8 +417,7 @@ export interface JAppLayerTreeFilterService {
 }
 
 export interface JAppFormService {
-  render(containerId: string, formParams: JFormParams): JFormMetaData
-  destroyByContainerId(containerId: string): void
+  openForm(params: JFormDialogParams): void
 }
 
 export interface JAppAppEventModule extends JEventModule {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jmapcloud-ng-types",
-  "version": "1.0.47",
+  "version": "1.0.49",
   "description": "JMap Cloud specific version of JMap Cloud NG types and interfaces",
   "main": "src/app.ts",
   "scripts": {
@@ -23,7 +23,7 @@
   "homepage": "https://github.com/k2geospatial/jmapcloud-ng-types#readme",
   "devDependencies": {
     "@types/react": "^18.3.2",
-    "jmapcloud-ng-core-types": "1.0.49",
+    "jmapcloud-ng-core-types": "1.0.52",
     "maplibre-gl": "^4.3.1",
     "react": "^18.3.1",
     "typedoc": "^0.25.13"

package/public/app.d.ts

@@ -2509,146 +2509,6 @@ declare namespace JMap {
       ): Promise<void | JAppPrintCaptureResult>
     }
 
-    /**
-     * **JMap.Application.Query**
-     *
-     * You can manage everything related to query here.
-     */
-    namespace Query {
-      /**
-       * **JMap.Application.Query.activateQuery**
-       *
-       * Activates a query by id and group id.
-       *
-       * It displays the query form (replacing the list of queries) in the query panel.
-       *
-       * @param groupId the query group id
-       * @param queryId the query id
-       * @example
-       * ```ts
-       * // activate query id=43 on group id=23
-       * JMap.Application.Print.activateQuery(23, 43)
-       * ```
-       */
-      function activateQuery(groupId: JId, queryId: string): void
-
-      /**
-       * **JMap.Application.Query.deactivateQuery**
-       *
-       * Deactivatea the current query. If no query is active, does nothing.
-       *
-       * If a query form is active (= its form is displayed), hidea it and returns to the query list.
-       *
-       * @example
-       * ```ts
-       * // if a query form is displayed, hide it and return to the query list.
-       * JMap.Application.Print.deactivateQuery()
-       * ```
-       */
-      function deactivateQuery(): void
-
-      /**
-       * **JMap.Application.Query.getDefaultData**
-       *
-       * Returns the current query form data.
-       *
-       * If there is no active form, warns in the console and returns an empty object {}.
-       *
-       * @example
-       * ```ts
-       * // returns the current query form data
-       * JMap.Application.Print.getDefaultData()
-       * ```
-       */
-      function getDefaultData(): { [id: string]: any }
-
-      /**
-       * **JMap.Application.Query.setDefaultData**
-       *
-       * Sets active query form data. If there is no active form, this function throws.
-       *
-       * @throws if no query is active
-       * @param values the form data, depends on the form
-       * @example
-       * ```ts
-       * // set the current query form data
-       * JMap.Application.Print.setDefaultData({
-       *  $param1: "black",
-       *  $param2: "white"
-       * })
-       * ```
-       */
-      function setDefaultData(values: any): void
-
-      /**
-       * **JMap.Application.Query.clearDefaultData**
-       *
-       * Resets the current query form data.
-       *
-       * If there is no active form, does nothing.
-       *
-       * @example
-       * ```ts
-       * // clear the current query form data
-       * JMap.Application.Print.clearDefaultData()
-       * ```
-       */
-      function clearDefaultData(): void
-
-      /**
-       * **JMap.Application.Query.displayInDialog**
-       *
-       * By default, the query form is displayed in the left panel with a simple layout, one field per line.
-       *
-       * But it is possible to display it in a modal window, with the layout defined in the project.
-       *
-       * @throws if isVisibleInDialog is not a boolean
-       * @param isVisibleInDialog true in modal window, false in left panel
-       * @example
-       * ```ts
-       * // display the current form in a modal window
-       * JMap.Application.Print.displayInDialog(true)
-       *
-       * // display the current form in the left panel
-       * JMap.Application.Print.displayInDialog(false)
-       * ```
-       */
-      function displayInDialog(isVisibleInDialog: boolean): void
-
-      /**
-       * **JMap.Application.Query.processQuery**
-       *
-       * Processes the active query form with the given values.
-       *
-       * Throws if no query is active.
-       *
-       * Resolves only if some features are found.
-       *
-       * If features are found, makes the layer selectable and visible if needed, then selects and zooms on found features.
-       *
-       * If no feature is found, the Promise rejects with a human readable error in the current user's locale.
-       *
-       * @throws if no query is active
-       * @param values the form data, depends on the form
-       * @example
-       * ```ts
-       * // display the current form in a modal window
-       * JMap.Application.Print
-       *   .processQuery({
-       *    $param1: "black",
-       *    $param2: "white"
-       *   })
-       *   .then(features => console.info(`Found ${features.length} feature(s)`, features))
-       *   .catch(error => {
-       *     // pass here if no features are found, or other error
-       *     // thrown error is a readable error using the user locale
-       *     console.error(error)
-       *   })
-       * ```
-       */
-      function processQuery(values: any): Promise<GeoJSON.Feature[]>
-    }
-
     /**
      * **JMap.Application.Event**
      *
@@ -3490,101 +3350,49 @@ declare namespace JMap {
      */
     namespace Form {
       /**
-       * ***JMap.Application.Form.render***
-       *
-       * Renders a form with given params in a container.
-       *
-       * @param containerId id of the container where the form will be rendered
-       * @param formParams a JFormParams object
-       * @example
-       * ```ts
-       * // this example will show you how to create a custom form in an extension
-       * // it will render the form in the extension panel
-       * window.JMAP_OPTIONS = {
-       *   ...
-       *   application: {
-       *     extensions: [{
-       *       id: "test-form",
-       *       panelTitle: "Test of form component API",
-       *       initFn: () => {},
-       *       onPanelCreation: panelContainerId => {
-       *         document.getElementById(panelContainerId).style.padding = "1rem"
-       *         // create a custom form in the extension panel container
-       *         JMap.Application.Form.render(panelContainerId, {
-       *           id: "search-form",
-       *           schema: {
-       *             properties: {
-       *               name: {
-       *                 title: "Office Name",
-       *                 type: "string",
-       *                 isRequired: true,
-       *                 maxLength: 255
-       *               },
-       *               type: {
-       *                 title: "Office type",
-       *                 type: "number",
-       *                 // default: 2,
-       *                 enum: [1, 2, 3],
-       *                 enumNames: ["Local", "External", "Mixte"]
-       *               }
-       *             }
-       *           },
-       *           uiSchema: [
-       *            {
-       *              type: "Tab",
-       *              controls: [
-       *                {
-       *                  id: "name",
-       *                  label: "Office name",
-       *                  widget: "input",
-       *                  scope: "#/properties/name"
-       *                },
-       *                {
-       *                  id: "type",
-       *                  label: "Office type",
-       *                  widget: "select",
-       *                  scope: "#/properties/type"
-       *                 }
-       *               ]
-       *             }
-       *           ],
-       *           defaultValueById: { // defaultValueById is optional
-       *             name: "default value",
-       *             type: 2
-       *           },
-       *           validate: (values, formMetaData) => JMap.Form.validateData(formMetaData, JMap.Form.getPreparedData(formMetaData, values)),
-       *           onSubmit: values => {
-       *             // saving your data
-       *             // return a string if an error occurred
-       *             // return a promise, and the form will display a loading button until the promise resolved
-       *             JMap.Application.Message.info(`Submitted values: ${JSON.stringify(values)}`)
-       *           }
-       *         })
-       *       },
-       *       onPanelDestroy: panelContainerId => {
-       *         JMap.Application.Form.destroyByContainerId(panelContainerId)
-       *       }
-       *     }]
+       * **JMap.Application.Form.openForm**
+       *
+       * Opens a form dialog in the application. Depending on the shape of `params`, this will open either:
+       *  - a layer-based form (when `layerId` is provided), or
+       *  - a table-based form (when `tableId` is provided).
+       *
+       * When opening a layer form:
+       *  - `layerId` is required.
+       *  - You can optionally pass `featureId` or a full `feature` (GeoJSON.Feature) to edit an existing feature.
+       *  - `isReadOnly` controls whether the form is editable.
+       *  - `onSubmit` (if provided) is called after the user submits the form.
+       *
+       * When opening a table form:
+       *  - `tableId` is required.
+       *  - You can optionally pass `row` (an object of key/value pairs) to edit an existing row.
+       *  - `isReadOnly` controls whether the form is editable.
+       *  - `onSubmit` (if provided) is called after the user submits the form.
+       *
+       * @param params The parameters that configure which form to open:
+       *   - For a **layer form**:
+       *     - `layerId` (string): The ID of the layer to open the form for.
+       *     - `featureId?` (string): (Optional) The ID of the feature in that layer to load.
+       *     - `feature?` (GeoJSON.Feature): (Optional) A full GeoJSON feature to load instead of just an ID.
+       *   - For a **table form**:
+       *     - `tableId` (string): The ID of the table to open the form for.
+       *     - `row?` ({ [key: string]: any }): (Optional) The row data to load into the form.
+       *   - Common to both shapes:
+       *     - `isReadOnly` (boolean): If `true`, the form will be displayed in read‐only mode.
+       *     - `onSubmit?` (() => void): (Optional) Callback invoked after the form is successfully submitted.
+       * @example
+       * ```ts
+       * // Example: Open a layer form for editing an existing feature
+       * formSVC.openForm({
+       *   layerId: "db4bc79b-03fe-4cf7-a4bc-fb76d69cabdf",
+       *   featureId: "3022",
+       *   isReadOnly: false,
+       *   onSubmit: () => {
+       *     console.log("Layer form submitted successfully");
        *   }
-       * }
-       * ```
-       *
-       */
-      function render(containerId: string, formParams: JFormParams): JFormMetaData
-
-      /**
-       *
-       * ***JMap.Application.Form.destroyByContainerId***
-       *
-       * Unmounts form by using container Id where it was rendered
-       *
-       * @param containerId id of the container to unmount
-       * @example
-       * ```ts
-       * JMap.Application.Form.destroy("new-form")
+       * });
        * ```
        */
-      function destroyByContainerId(containerId: string): void
+      function openForm(params: JFormDialogParams): 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
+}