jmapcloud-ng-core-types 1.0.35 → 1.0.36

package/index.ts

@@ -26,6 +26,7 @@ export interface JCoreService extends JCoreMainService {
   MapContext: JMapContextService
   UI: JUIService
   SimpleSearch: JSimpleSearchService
+  Table: JTableService
 }
 
 export interface JUIService {
@@ -412,6 +413,7 @@ export interface JCoreState {
   map: JMapState
   project: JProjectState
   layer: JLayerState
+  table: JTableState
   user: JUserState
   language: JLanguageState
   photo: JPhotoState
@@ -538,6 +540,12 @@ export interface JLayerState {
   vectorLayerIds: JId[]
 }
 
+export interface JTableState {
+  isLoading: boolean
+  hasLoadingError: boolean
+  tables: JTable[]
+}
+
 export interface JPhotoState {
   selectedPhotoId: JId | undefined
   photos: JPhoto[]
@@ -903,6 +911,11 @@ export interface JLayerService {
   openInformationReportInNewTab(layerId: JId, featureIds: JId[]): Promise<string>
 }
 
+export interface JTableService {
+  getTables(): JTable[]
+  getTableData(dataSourceId: JId, params: JTableDataParams): Promise<JTableData>
+}
+
 export interface JLayerSearchService {
   byAttribute(params: JLayerSearchByAttributesParams): Promise<Feature[]>
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jmapcloud-ng-core-types",
-  "version": "1.0.35",
+  "version": "1.0.36",
   "description": "JMap Cloud specific version of JMap Cloud NG Core types and interfaces",
   "main": "index.js",
   "scripts": {

package/public/core.d.ts

@@ -12725,4 +12725,50 @@ declare namespace JMap {
      */
     function getContainerHeight(): number
   }
+  namespace Table {
+    /**
+     * **JMap.Layer.getTables**
+     *
+     * Returns an array of JMap tables available in the current project.
+     *
+     * If no project is loaded, it returns an empty array.
+     *
+     * @returns {JTable[]} An array of `JTable` objects representing the tables in the current project.
+     *
+     * @example
+     * ```ts
+     * // Retrieves all JMap tables
+     * JMap.Layer.getTables();
+     * ```
+     */
+    function getTables(): JTable[]
+
+    /**
+     * **JMap.Table.getTableData**
+     *
+     * Asynchronously retrieves the JMap table data for a specified tabular data source ID.
+     *
+     * @throws {Error} If no data source is found for the given ID.
+     *
+     * @param {JId} dataSourceId - The ID of the JMap data source.
+     * @param {JTableDataParams} params - Includes the following optional parameters: startIndex, limit, filter, sort.
+     * startIndex: The starting index for data retrieval (zero-based).
+     * limit: The maximum number of records to retrieve.
+     * filter: A CQL filter.
+     * sort: A sort model.
+     *
+     * @returns {Promise<JTableData>} A promise that resolves to a `JTableData` object representing the table data.
+     *
+     * @example
+     * ```ts
+     * // Retrieves up to 50 rows from data source ID 3, starting at index 0, sorted in ascending order based on the "ATTRIBUTE_A" attribute
+     * JMap.Table.getTableData(3, {startIndex: 0, limit: 50, sort:"ATTRIBUTE_A ASC"}).then(tableData => {
+     *   console.log(tableData);
+     * }).catch(error => {
+     *   console.error("Failed to fetch table data:", error);
+     * });
+     * ```
+     */
+    function getTableData(dataSourceId: JId, params: JTableDataParams): Promise<JTableData>
+  }
 }

package/public/jmap/table.d.ts

@@ -0,0 +1,23 @@
+declare interface JTable {
+  id: string
+  organizationId: string
+  projectId: string
+  name: JLocaleTranslation
+  description: JLocaleTranslation
+  dataSourceId: string
+  allowClientSideEditing: boolean
+}
+
+declare interface JTableData {
+  columns: string[]
+  links: Array<{ href: string; rel: string; title: string; type: string }>
+  numberReturned: number
+  rows: []
+}
+
+declare interface JTableDataParams {
+  startIndex?: number
+  limit?: number
+  filter?: string
+  sort?: string
+}