jmapcloud-ng-types 2.0.19 → 2.0.20-qa.10

package/index.ts

@@ -21,7 +21,7 @@ export interface JAppState {
   dataGrid: JAppDataGridState
 }
 
-export type JAppActiveDataGrid = { type: "table"; id: JId } | { type: "layer"; id: JId }
+export type JAppActiveDataGrid = { type: "table"; id: string } | { type: "layer"; id: string }
 
 export interface JAppDataGridState {
   activeDataGrid: JAppActiveDataGrid | undefined
@@ -34,8 +34,8 @@ export type JAppCoordinateInputMode = "project" | "web-mercator" | "wgs84-decima
 export interface JAppGeometryState {
   /** Selected CRS and format; undefined uses the project default. */
   coordinateInputMode: JAppCoordinateInputMode | undefined
-  layerId: JId | undefined
-  featureId: JId | undefined // needed for update
+  layerId: string | undefined
+  featureId: number | undefined // needed for update
   hasChanged: boolean
   feature: GeoJSON.Feature | undefined
   isUpdate: boolean
@@ -43,7 +43,7 @@ export interface JAppGeometryState {
 }
 
 export interface JAppFeatureState {
-  layerId: JId | undefined
+  layerId: string | undefined
   isLoading: boolean
   hasLoadingError: boolean
   features: GeoJSON.Feature[]
@@ -63,11 +63,11 @@ export interface JAppLayerState {
   isLayerOrderActive: boolean
   treeFilter: JAppLayerTreeFilterState
   editionActiveTab: JAPP_LAYER_EDITION_TABS
-  inEditionLayerId: JId | undefined
+  inEditionLayerId: string | undefined
 }
 
 export interface JAppTableState {
-  inEditionTableId: JId | undefined
+  inEditionTableId: string | undefined
 }
 
 export interface JAppUiState {
@@ -120,7 +120,7 @@ export interface JAppAnnotationState {
 }
 
 export interface JAppSnapState {
-  layerId: JId | undefined
+  layerId: string | undefined
   isEnabled: boolean
 }
 
@@ -142,9 +142,10 @@ export interface JAppPrintState {
 }
 
 export interface JAppSelectionState {
-  displayedLayerId: JId
+  displayedLayerId: string | null
   isNewElement: boolean
   tableVisibility: boolean
+  /** @deprecated Always false. Use tableVisibility for the in-app selection table. */
   isTabOpened: boolean
   activeType: JAPP_SELECTION_TYPES
 }
@@ -172,10 +173,10 @@ export interface JAppGeometryService {
   /** @deprecated Use JMap.Draw.setSnapping("geometry", ...) instead. */
   setSnapEnabled(isEnabled: boolean): void
   /** @deprecated Use JMap.Draw.setSnapping("geometry", ...) instead. */
-  setSnapLayerId(layerId: JId): void
+  setSnapLayerId(layerId: string): void
   openPanelForCreation(): void
   openPanelForUpdate(params: JAppGeometryUpdateParams): void
-  selectLayer(layerId: JId): void
+  selectLayer(layerId: string): void
   startCreationDrawing(): void
   stopCreationDrawing(): void
   finishUpdate(): Promise<void>
@@ -183,14 +184,14 @@ export interface JAppGeometryService {
 }
 
 export interface JAppFeatureService {
-  openEditMenuById(layerId: JId, featureId: JId): Promise<GeoJSON.Feature>
-  openEditMenuByIds(layerId: JId, featureIds: JId[]): Promise<GeoJSON.Feature[]>
+  openEditMenuById(layerId: string, featureId: number): Promise<GeoJSON.Feature>
+  openEditMenuByIds(layerId: string, featureIds: number[]): Promise<GeoJSON.Feature[]>
   closeEditMenu(): void
-  deleteByIds(layerId: JId, featureIds: JId[]): Promise<JId[]>
+  deleteByIds(layerId: string, featureIds: number[]): Promise<number[]>
 }
 
 export interface JAppProjectService {
-  activateById(projectId: JId): JProject
+  activateById(projectId: string): JProject
   setSelectionPanelVisibility(isVisible: boolean): void
   setPresentationShowOnOpen(value: boolean): void
 }
@@ -207,7 +208,7 @@ export interface JAppAnnotationService {
   /** @deprecated Use JMap.Draw.setSnapping("annotation", ...) instead. */
   setSnapEnabled(isEnabled: boolean): void
   /** @deprecated Use JMap.Draw.setSnapping("annotation", ...) instead. */
-  setSnapLayerId(layerId: JId): void
+  setSnapLayerId(layerId: string): void
   existsById(annotationId: string): boolean
   getById(annotationId: string): JAppAnnotation
   getAll(): JAppAnnotation[]
@@ -284,16 +285,19 @@ export interface JAppEventService {
 }
 
 export interface JAppSelectionService {
-  getDisplayedLayerId(): JId
-  setDisplayedLayerId(layerId: JId): void
+  getDisplayedLayerId(): string | null
+  setDisplayedLayerId(layerId: string | null): void
   activateSelectionType(selectionType: JAPP_SELECTION_TYPES): void
   getActiveSelectionType(): JAPP_SELECTION_TYPES
   getTableVisibility(): boolean
   setTableVisibility(tableVisibility: boolean): void
+  /** @deprecated Always false. Use getTableVisibility for the in-app selection table. */
   isTableDisplayedInTab(): boolean
+  /** @deprecated No-op that warns once. Use setTableVisibility(true) for the in-app selection table. */
   openTableInTab(): void
+  /** @deprecated No-op that warns once. Use setTableVisibility(false) for the in-app selection table. */
   closeTableTab(): void
-  clearSelectionForLayer(layerId: JId): void
+  clearSelectionForLayer(layerId: string): void
   clearSelection(): void
   selectFromFeature(feature: GeoJSON.Feature, selectionType?: JAPP_SELECTION_TYPES): void
   exportAsExcelFile(): void
@@ -304,7 +308,7 @@ export interface JAppMeasureService {
   /** @deprecated Use JMap.Draw.setSnapping("measure", ...) instead. */
   setSnapEnabled(isEnabled: boolean): void
   /** @deprecated Use JMap.Draw.setSnapping("measure", ...) instead. */
-  setSnapLayerId(layerId: JId): void
+  setSnapLayerId(layerId: string): void
   getAll(): JAppMeasure[]
   existsById(measureId: string): boolean
   getById(measureId: string): JAppMeasure
@@ -381,26 +385,26 @@ export interface JAppLayerService {
 }
 
 export interface JAppDynamicFilterService {
-  openPanel(layerId: JId): void
+  openPanel(layerId: string): void
   closePanel(): void
 }
 
 export interface JAppTableService {
   Edition: {
     DynamicFilter: {
-      openPanel(tableId: JId): void
+      openPanel(tableId: string): void
       closePanel(): void
     }
   }
 }
 
 export interface JAppLayerEditionInfoService {
-  openPanel(layerId: JId): void
+  openPanel(layerId: string): void
   closePanel(): void
 }
 
 export interface JAppLayerEditionThematicService {
-  openPanel(layerId: JId): void
+  openPanel(layerId: string): void
   closePanel(): void
 }
 
@@ -408,7 +412,7 @@ export interface JAppLayerEditionService {
   DynamicFilter: JAppDynamicFilterService
   Info: JAppLayerEditionInfoService
   Thematic: JAppLayerEditionThematicService
-  openPanel(layerId: JId, tab: JAPP_LAYER_EDITION_TABS): void
+  openPanel(layerId: string, tab: JAPP_LAYER_EDITION_TABS): void
   closePanel(): void
 }
 
@@ -425,7 +429,7 @@ export interface JAppLayerTreeFilterService {
   /** @deprecated Removed API. This method now does nothing and always returns false. */
   existById(filterId: number): boolean
   /** @deprecated Removed API. This method now does nothing and always returns false. */
-  oneFilterExistForMetadataId(metadataId: JId): boolean
+  oneFilterExistForMetadataId(metadataId: string): boolean
   /** @deprecated Removed API. This method now returns an empty result. */
   getAll(): JAppGetAllFiltersResult
   /** @deprecated Removed API. Filters no longer exist, so this method always throws "Filter id not found", matching the original error contract. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jmapcloud-ng-types",
-  "version": "2.0.19",
+  "version": "2.0.20-qa.10",
   "description": "JMap Cloud specific version of JMap Cloud NG types and interfaces",
   "main": "src/app.ts",
   "types": "ambient.d.ts",
@@ -11,14 +11,15 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/k2geospatial/jmapcloud-ng-types.git"
+    "url": "https://github.com/k2geospatial/jmapcloud-frontend.git",
+    "directory": "app/jmapcloud-ng/ng-types"
   },
   "author": "K2 Geospatial",
   "license": "ISC",
   "bugs": {
-    "url": "https://github.com/k2geospatial/jmapcloud-ng-types/issues"
+    "url": "https://github.com/k2geospatial/jmapcloud-frontend/issues"
   },
-  "homepage": "https://github.com/k2geospatial/jmapcloud-ng-types#readme",
+  "homepage": "https://github.com/k2geospatial/jmapcloud-frontend/tree/master/app/jmapcloud-ng/ng-types#readme",
   "devDependencies": {
     "@fortawesome/fontawesome-svg-core": "7.2.0",
     "@types/react": "^19.2.17",

package/public/app.d.ts

@@ -162,7 +162,7 @@ declare global {
          * JMap.Application.Annotation.setSnapLayerId("36885146-7eed-4071-9f86-8e29c505af91")
          * ```
          */
-        function setSnapLayerId(layerId: JId): void
+        function setSnapLayerId(layerId: string): void
 
         /**
          * **JMap.Application.Annotation.existsById**
@@ -548,7 +548,7 @@ declare global {
          * JMap.Application.Feature.openEditMenuById(5, 234)
          * ```
          */
-        function openEditMenuById(layerId: JId, featureId: JId): Promise<GeoJSON.Feature>
+        function openEditMenuById(layerId: string, featureId: number): Promise<GeoJSON.Feature>
 
         /**
          * **JMap.Application.Feature.openEditMenuByIds**
@@ -563,7 +563,7 @@ declare global {
          * JMap.Application.Feature.openEditMenuByIds(5, [234, 452, 176])
          * ```
          */
-        function openEditMenuByIds(layerId: JId, featureIds: JId[]): Promise<GeoJSON.Feature[]>
+        function openEditMenuByIds(layerId: string, featureIds: number[]): Promise<GeoJSON.Feature[]>
 
         /**
          * **JMap.Application.Feature.closeEditMenu**
@@ -593,7 +593,7 @@ declare global {
          * JMap.Application.Feature.deleteByIds(4, [23, 76]).then(result => console.log("Delete result", result))
          * ```
          */
-        function deleteByIds(layerId: JId, featureIds: JId[]): Promise<JId[]>
+        function deleteByIds(layerId: string, featureIds: number[]): Promise<number[]>
       }
 
       /**
@@ -628,7 +628,7 @@ declare global {
          * JMap.Application.Geometry.setSnapLayerId("36885146-7eed-4071-9f86-8e29c505af91")
          * ```
          */
-        function setSnapLayerId(layerId: JId): void
+        function setSnapLayerId(layerId: string): void
 
         /**
          * **JMap.Application.Geometry.openPanelForCreation**
@@ -672,7 +672,7 @@ declare global {
          * JMap.Application.Geometry.selectLayer(3)
          * ```
          */
-        function selectLayer(layerId: JId): void
+        function selectLayer(layerId: string): void
 
         /**
          * **JMap.Application.Geometry.startCreationDrawing**
@@ -761,7 +761,7 @@ declare global {
          * JMap.Application.Measure.setSnapLayerId("36885146-7eed-4071-9f86-8e29c505af91")
          * ```
          */
-        function setSnapLayerId(layerId: JId): void
+        function setSnapLayerId(layerId: string): void
 
         /**
          * **JMap.Application.Measure.getAll**
@@ -1064,7 +1064,7 @@ declare global {
          *
          * The selection of only one layer can be diplayed at a time.
          *
-         * This function returns the id of the layer for which the selection is displayed.
+         * This function returns the id of the layer for which the selection is displayed, or null when none is.
          *
          * @example
          * ```ts
@@ -1072,7 +1072,7 @@ declare global {
          * JMap.Application.Selection.getDisplayedLayerId()
          * ```
          */
-        function getDisplayedLayerId(): JId
+        function getDisplayedLayerId(): string | null
 
         /**
          * **JMap.Application.Selection.setDisplayedLayerId**
@@ -1081,14 +1081,19 @@ declare global {
          *
          * If layer selection has no selection, hides the layer selection list.
          *
+         * Pass null to display no layer. Passing -1 for that still works but is deprecated and logs a warning.
+         *
          * @throws if layer not found for the given layer id
          * @example
          * ```ts
-         * // display the layer id=2 selection
-         * JMap.Application.Selection.setDisplayedLayerId(2)
+         * // display the selection of the layer
+         * JMap.Application.Selection.setDisplayedLayerId("f3af01ab-4042-4ccf-be04-33dc96228ce7")
+         *
+         * // display no layer selection
+         * JMap.Application.Selection.setDisplayedLayerId(null)
          * ```
          */
-        function setDisplayedLayerId(layerId: JId): void
+        function setDisplayedLayerId(layerId: string | null): void
 
         /**
          * **JMap.Application.Selection.activateSelectionType**
@@ -1148,11 +1153,12 @@ declare global {
         /**
          * **JMap.Application.Selection.isTableDisplayedInTab**
          *
-         * Returns true if the selection table is displayed in an external browser tab.
+         * Always returns false; the external selection page was removed.
          *
+         * @deprecated Use {@link JMap.Application.Selection.getTableVisibility} for the in-app selection table.
          * @example
          * ```ts
-         * // returns true if the selection table is displayed in an external browser tab.
+         * // returns false.
          * JMap.Application.Selection.isTableDisplayedInTab()
          * ```
          */
@@ -1161,13 +1167,13 @@ declare global {
         /**
          * **JMap.Application.Selection.openTableInTab**
          *
-         * Displays the selection table in another tab.
-         *
-         * If the table is not visible, make it visible.
+         * Does nothing and warns once per page load. The external selection page was removed.
+         * Does not change the in-app table's visibility.
          *
+         * @deprecated Use {@link JMap.Application.Selection.setTableVisibility} with true to show the in-app selection table.
          * @example
          * ```ts
-         * // displays the selection table in another tab.
+         * // deprecated no-op; warns once.
          * JMap.Application.Selection.openTableInTab()
          * ```
          */
@@ -1176,15 +1182,13 @@ declare global {
         /**
          * **JMap.Application.Selection.closeTableTab**
          *
-         * Closes the selection table tab.
-         *
-         * If the table is not visible, or not opened in another tab, do nothing.
-         *
-         * If the table is opened in another tab, close the tab and display the table over the map.
+         * Does nothing and warns once per page load. The external selection page was removed.
+         * Does not change the in-app table's visibility.
          *
+         * @deprecated Use {@link JMap.Application.Selection.setTableVisibility} with false to hide the in-app selection table.
          * @example
          * ```ts
-         * // closes the selection table tab.
+         * // deprecated no-op; warns once.
          * JMap.Application.Selection.closeTableTab()
          * ```
          */
@@ -1202,7 +1206,7 @@ declare global {
          * JMap.Application.Selection.clearSelectionForLayer(2)
          * ```
          */
-        function clearSelectionForLayer(layerId: JId): void
+        function clearSelectionForLayer(layerId: string): void
 
         /**
          * **JMap.Application.Selection.clearSelection**
@@ -1286,7 +1290,7 @@ declare global {
          * JMap.Application.Project.activateById(33)
          * ```
          */
-        function activateById(projectId: JId): JProject
+        function activateById(projectId: string): JProject
 
         /**
          * **JMap.Application.Project.setSelectionPanelVisibility**
@@ -1335,7 +1339,7 @@ declare global {
              * JMap.Application.Table.Edition.DynamicFilter.openPanel("table-id")
              * ```
              */
-            function openPanel(tableId: JId): void
+            function openPanel(tableId: string): void
 
             /**
              * Closes the table filter sub-panel and returns to the layer/table list.
@@ -1513,7 +1517,7 @@ declare global {
              * @param metadataId Unused
              * @returns Always false
              */
-            function oneFilterExistForMetadataId(metadataId: JId): boolean
+            function oneFilterExistForMetadataId(metadataId: string): boolean
 
             /**
              * **JMap.Application.Layer.Tree.Filter.getAll**
@@ -1605,7 +1609,7 @@ declare global {
              * JMap.Application.Layer.Edition.DynamicFilter.openPanel(3)
              * ```
              */
-            function openPanel(layerId: JId): void
+            function openPanel(layerId: string): void
 
             /**
              * **JMap.Application.Layer.Edition.DynamicFilter.closePanel**
@@ -1640,7 +1644,7 @@ declare global {
              * JMap.Application.Layer.Edition.Info.openPanel(3)
              * ```
              */
-            function openPanel(layerId: JId): void
+            function openPanel(layerId: string): void
 
             /**
              * **JMap.Application.Layer.Edition.Info.closePanel**
@@ -1675,7 +1679,7 @@ declare global {
              * JMap.Application.Layer.Edition.Thematic.openPanel(3)
              * ```
              */
-            function openPanel(layerId: JId): void
+            function openPanel(layerId: string): void
 
             /**
              * **JMap.Application.Layer.Edition.Thematic.closePanel**
@@ -1712,7 +1716,7 @@ declare global {
            * JMap.Application.Layer.Edition.openPanel(2, "dynamic-filter")
            * ```
            */
-          function openPanel(layerId: JId, activeTab: JAPP_LAYER_EDITION_TABS): void
+          function openPanel(layerId: string, activeTab: JAPP_LAYER_EDITION_TABS): void
 
           /**
            * **JMap.Application.Layer.Edition.closePanel**
@@ -3520,7 +3524,7 @@ declare global {
          *
          * @param params The parameters that configure which sub-form to open:
          *   - `dataSourceId` (string): The data source ID that provides the form.
-         *   - For `layerUpdate`: `featureId` (JId), `isReadOnly` (boolean).
+         *   - For `layerUpdate`: `featureId` (number), `isReadOnly` (boolean).
          *   - For `tableUpdate`: `rowId` (number), `isReadOnly` (boolean).
          *   - For `tableCreate`: `isReadOnly` is always `false`.
          *   - `onSubmit?` (() => void): (Optional) Callback invoked after submit.

package/public/form.d.ts

@@ -3,7 +3,7 @@ export type JFormDialogParams =
   | {
       type: "layerUpdate"
       layer: JLayer
-      featureId: JId
+      featureId: number
       isReadOnly: boolean
       onSubmit?: () => void
     }
@@ -33,7 +33,7 @@ export type JSubFormDialogParams =
       type: "layerUpdate"
       dataSourceId: string
       organizationId: string
-      featureId: JId
+      featureId: number
       isReadOnly: boolean
       onSubmit?: () => void
     }

package/public/geometry.d.ts

@@ -1,5 +1,5 @@
 export {}
 export interface JAppGeometryUpdateParams {
-  layerId: JId
+  layerId: string
   feature: GeoJSON.Feature
 }

package/public/layer.d.ts

@@ -49,8 +49,8 @@ export type JAppLayerAnyFilterOperatorType = JAPP_LAYER_DATE_FILTER_OPERATOR_TYP
 export interface JAppLayerTreeFilterState {
   active: boolean
   nameFilter: string
-  exactlyMatchedTreeItemIds: JId[]
-  expandedMatchedTreeItemIds: JId[]
+  exactlyMatchedTreeItemIds: string[]
+  expandedMatchedTreeItemIds: string[]
 }
 
 /** @deprecated The legacy layer dynamic-filter API was removed. */
@@ -65,7 +65,7 @@ export type JAppAnyLayerFilter = JAppNumberLayerFilter | JAppTextLayerFilter | J
 /** @deprecated The legacy layer dynamic-filter API was removed. */
 export interface JAppBaseLayerFilter {
   id: number
-  metadataItemId: JId
+  metadataItemId: string
   type: JLAYER_METADATA_TYPES
 }