jmapcloud-ng-core-types 1.1.36 → 1.1.37

package/index.d.ts

@@ -1,7 +1,9 @@
 /// <reference path="./public/global-aliases.d.ts" />
 import { Feature, FeatureCollection, LineString, MultiLineString, Point, Polygon } from "geojson"
-import { JForm as JFormJMC } from "jmapcloud-types"
+import { JAttribute, JDataSource, JDataSourceType, JForm as JFormJMC } from "jmapcloud-types"
+import type * as maplibregl from "maplibre-gl"
 import { Action, Store } from "redux"
+import { JDataSourceData, JDataSourceDataParams, JDataSourcePermissions } from "./public/jmap/datasource.ts"
 import type { JCoreState } from "./public/state.d.ts"
 
 export type { JCoreOptions } from "./public/jmap/startup-options.d.ts"
@@ -46,6 +48,7 @@ export interface JCoreService extends JCoreMainService {
   MapContext: JMapContextService
   UI: JUIService
   SimpleSearch: JSimpleSearchService
+  DataSource: JDataSourceService
   Table: JTableService
 }
 
@@ -733,7 +736,25 @@ export interface JLayerService {
   deleteLayer(layerId: JId): void
   hasInformationReport(layerId: JId): boolean
   openInformationReportInNewTab(layerId: JId, featureIds: JId[]): Promise<string>
-  getDataSourceAttributes(layerId: JId): Promise<JDataSourceAttribute[]>
+  getDataSourceAttributes(layerId: JId): Promise<JAttribute[]>
+}
+
+export interface JDataSourceService {
+  getAttributes(dataSourceId: JId): Promise<JAttribute[]>
+  getById(dataSourceId: JId): Promise<JDataSource>
+  getData(dataSourceId: JId, params: JDataSourceDataParams, dataSourceType?: JDataSourceType): Promise<JDataSourceData>
+  getPermissions(dataSourceId: JId): Promise<JDataSourcePermissions>
+  createRow(dataSourceId: JId, row: { [key: string]: any }): Promise<{ id: JId; links: any[] }>
+  updateRow(dataSourceId: JId, rowId: JId, row: { [key: string]: any }): Promise<void>
+  deleteRow(dataSourceId: JId, rowId: JId): Promise<void>
+  updateFeatureProperties(
+    dataSourceId: JId,
+    featureId: JId,
+    properties: { [key: string]: any }
+  ): Promise<GeoJSON.Feature>
+  deleteFeature(dataSourceId: JId, featureId: JId): Promise<JId>
+  getFeature(dataSourceId: string, featureId: number): Promise<GeoJSON.Feature>
+  getRow(dataSourceId: string, rowId: number): Promise<{ [key: string]: any }>
 }
 
 export interface JTableService {
@@ -743,7 +764,7 @@ export interface JTableService {
   createRow(tableId: JId, row: { [key: string]: any }): Promise<{ id: JId; links: Array<any> }>
   updateRow(tableId: JId, rowId: number, row: { [key: string]: any }): Promise<void>
   deleteRow(tableId: JId, rowId: number): Promise<void>
-  getDataSourceAttributes(tableId: JId): Promise<JDataSourceAttribute[]>
+  getDataSourceAttributes(tableId: JId): Promise<JAttribute[]>
   setDynamicFilterActive(tableId: JId, filterId: string, isActive: boolean): void
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jmapcloud-ng-core-types",
-  "version": "1.1.36",
+  "version": "1.1.37",
   "description": "JMap Cloud specific version of JMap Cloud NG Core types and interfaces",
   "main": "index.js",
   "types": "ambient.d.ts",

package/public/core.d.ts

@@ -1,7 +1,5 @@
-/// <reference path="./global-aliases.d.ts" />
-
+import { JAttribute } from "jmapcloud-types"
 import type { Action, Store } from "redux"
-import type { JCoreState } from "./state.d.ts"
 import type { JRequestConfig } from "./jmap/ajax.d.ts"
 import type {
   JAttachment,
@@ -9,7 +7,7 @@ import type {
   JCreateAttachmentParams,
   JUpdateAttachmentParams
 } from "./jmap/attachment.d.ts"
-import type { JDataSourceAttribute } from "./jmap/datasource.ts"
+import type { JDataSourceData, JDataSourceDataParams, JDataSourcePermissions } from "./jmap/datasource.ts"
 import type { JDateFormatParams, JDateLike, JTIME_UNITS } from "./jmap/date.d.ts"
 import type { JCoreExtension, JExtensionEventParams, JExtensionMouseOver } from "./jmap/extension.d.ts"
 import type {
@@ -178,6 +176,7 @@ import type {
   JUserEventSessionChangedParams,
   JUserInfo
 } from "./jmap/user.d.ts"
+import type { JCoreState } from "./state.d.ts"
 export {}
 /**
  * This is the JMap Cloud NG Core library API documentation.
@@ -2444,7 +2443,7 @@ export namespace JMap {
      *  .getDataSourceAttributes(3)
      * ```
      **/
-    function getDataSourceAttributes(layerId: JId): Promise<JDataSourceAttribute[]>
+    function getDataSourceAttributes(layerId: JId): Promise<JAttribute[]>
   }
   /**
    * **JMap.Geometry**
@@ -9822,6 +9821,194 @@ export namespace JMap {
      */
     function previewAttachments(attachment: JAttachmentFile, dataSourceId: string): Promise<void>
   }
+  /**
+   * **JMap.DataSource**
+   *
+   * Here you'll find all dataSource related methods
+   */
+  namespace DataSource {
+    /**
+     * **JMap.DataSource.getAttributes**
+     *
+     * Returns the attributes for a given datasource.
+     *
+     * @param dataSourceId the datasource id
+     * @throws if dataSourceId not valid or dataSource not found
+     * @example
+     * ```ts
+     * // Returns attributes, for dataSource id="be4552e1-d89d-48ec-a417-7b99d14b4d7b"
+     * JMap.DataSource.getAttributes("be4552e1-d89d-48ec-a417-7b99d14b4d7b")
+     * ```
+     **/
+    function getAttributes(dataSourceId: JId): Promise<JAttribute[]>
+
+    /**
+     * **JMap.DataSource.getById**
+     *
+     * Returns the datasource, for a given id.
+     *
+     * @param dataSourceId
+     * @throws if dataSourceId not valid
+     * @example
+     * ```ts
+     * // Returns dataSource, with id="be4552e1-d89d-48ec-a417-7b99d14b4d7b"
+     * JMap.DataSource.getById("be4552e1-d89d-48ec-a417-7b99d14b4d7b")
+     * ```
+     **/
+    function getById(dataSourceId: JId): Promise<any>
+
+    /**
+     * **JMap.DataSource.getData**
+     *
+     * Asynchronously retrieves data for a datasource.
+     *
+     * @throws {Error} If no data source is found for the given ID.
+     *
+     * @param {JId} dataSourceId - The datasource id.
+     * @param {JDataSourceDataParams} 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<JDataSourceData>} A promise that resolves to a `JDataSourceData` object representing the dataSource 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.DataSource.getData(3, {startIndex: 0, limit: 50, sort:"ATTRIBUTE_A ASC"}).then(dataSourceData => {
+     *   console.log(dataSourceData);
+     * }).catch(error => {
+     *   console.error("Failed to fetch dataSource data:", error);
+     * });
+     * ```
+     */
+    function getData(dataSourceId: JId, params: JDataSourceDataParams, dataSourceType?: any): Promise<JDataSourceData>
+
+    /**
+     * **JMap.DataSource.getPermissions**
+     *
+     * Returns the permissions, for a given dataSource id.
+     *
+     * @param dataSourceId
+     * @throws if dataSourceId not valid
+     * @example
+     * ```ts
+     * // Returns permissions for dataSource with id="be4552e1-d89d-48ec-a417-7b99d14b4d7b"
+     * JMap.DataSource.getPermissions("be4552e1-d89d-48ec-a417-7b99d14b4d7b")
+     * ```
+     **/
+    function getPermissions(dataSourceId: JId): Promise<JDataSourcePermissions>
+
+    /**
+     * **JMap.DataSource.createRow**
+     *
+     * Creates a new row in a tabular datasource.
+     *
+     * @param dataSourceId
+     * @param row
+     * @example
+     * ```ts
+     * JMap.DataSource.createRow("be4552e1-d89d-48ec-a417-7b99d14b4d7b", { NAME: "New row" })
+     * ```
+     **/
+    function createRow(dataSourceId: JId, row: { [key: string]: any }): Promise<{ id: JId; links: any[] }>
+
+    /**
+     * **JMap.DataSource.updateRow**
+     *
+     * Updates a row in a tabular datasource.
+     *
+     * @param dataSourceId
+     * @param rowId
+     * @param row
+     * @example
+     * ```ts
+     * JMap.DataSource.updateRow("be4552e1-d89d-48ec-a417-7b99d14b4d7b", 12, { NAME: "Updated" })
+     * ```
+     **/
+    function updateRow(dataSourceId: JId, rowId: JId, row: { [key: string]: any }): Promise<void>
+
+    /**
+     * **JMap.DataSource.deleteRow**
+     *
+     * Deletes a row from a tabular datasource.
+     *
+     * @param dataSourceId
+     * @param rowId
+     * @example
+     * ```ts
+     * JMap.DataSource.deleteRow("be4552e1-d89d-48ec-a417-7b99d14b4d7b", 12)
+     * ```
+     **/
+    function deleteRow(dataSourceId: JId, rowId: JId): Promise<void>
+
+    /**
+     * **JMap.DataSource.updateFeatureProperties**
+     *
+     * Updates properties for a feature in a spatial datasource.
+     *
+     * @param dataSourceId
+     * @param featureId
+     * @param properties
+     * @example
+     * ```ts
+     * JMap.DataSource.updateFeatureProperties(
+     *   "be4552e1-d89d-48ec-a417-7b99d14b4d7b",
+     *   42,
+     *   { NAME: "Updated" }
+     * )
+     * ```
+     **/
+    function updateFeatureProperties(
+      dataSourceId: JId,
+      featureId: JId,
+      properties: { [key: string]: any }
+    ): Promise<GeoJSON.Feature>
+
+    /**
+     * **JMap.DataSource.deleteFeature**
+     *
+     * Deletes a spatial feature from a spatial datasource.
+     *
+     * @param dataSourceId
+     * @param featureId
+     * @example
+     * ```ts
+     * JMap.DataSource.deleteFeature("be4552e1-d89d-48ec-a417-7b99d14b4d7b", 42)
+     * ```
+     **/
+    function deleteFeature(dataSourceId: JId, featureId: JId): Promise<JId>
+
+    /**
+     * **JMap.DataSource.getFeature**
+     *
+     * Returns a spatial feature for a datasource.
+     *
+     * @param dataSourceId
+     * @param featureId
+     * @example
+     * ```ts
+     * JMap.DataSource.getFeature("be4552e1-d89d-48ec-a417-7b99d14b4d7b", 42)
+     * ```
+     **/
+    function getFeature(dataSourceId: string, featureId: number): Promise<GeoJSON.Feature>
+
+    /**
+     * **JMap.DataSource.getRow**
+     *
+     * Returns a row for a tabular datasource.
+     *
+     * @param dataSourceId
+     * @param rowId
+     * @example
+     * ```ts
+     * JMap.DataSource.getRow("be4552e1-d89d-48ec-a417-7b99d14b4d7b", 12)
+     * ```
+     **/
+    function getRow(dataSourceId: string, rowId: number): Promise<{ [key: string]: any }>
+  }
+
   /**
    * **JMap.Form**
    *
@@ -12169,12 +12356,13 @@ export namespace JMap {
      *
      * @throws {Error} If no data source is found for the given ID.
      *
-     * @param {JId} tableId - The ID of the JMap Table.
+     * @param {JId} tableId - The ID of the JMap Table's dataSource.
      * @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.
+     * columns: the name of the columns to include.
      *
      * @returns {Promise<JTableData>} A promise that resolves to a `JTableData` object representing the table data.
      *
@@ -12282,7 +12470,7 @@ export namespace JMap {
      * JMap.Table.getDataSourceAttributes("be4552e1-d89d-48ec-a417-7b99d14b4d7b")
      * ```
      **/
-    function getDataSourceAttributes(tableId: JId): Promise<JDataSourceAttribute[]>
+    function getDataSourceAttributes(tableId: JId): Promise<JAttribute[]>
     /**
      * **JMap.Table.setDynamicFilterActive**
      *

package/public/global-aliases.d.ts

@@ -39,7 +39,10 @@ declare global {
   /** @internal */ type JCreateAttachmentFileParams = attachment.JCreateAttachmentFileParams
   /** @internal */ type JCreateAttachmentParams = attachment.JCreateAttachmentParams
   /** @internal */ type JUpdateAttachmentParams = attachment.JUpdateAttachmentParams
-  /** @internal */ type JDataSourceAttribute = datasource.JDataSourceAttribute
+  /** @internal */ type JDataSourceData = datasource.JDataSourceData
+  /** @internal */ type JDataSourceDataParams = datasource.JDataSourceDataParams
+  /** @internal */ type JDataSourcePermissions = datasource.JDataSourcePermissions
+  /** @internal */ type JDataSourcePermission = datasource.JDataSourcePermission
   /** @internal */ type JDateLike = date.JDateLike
   /** @internal */ type JTIME_UNITS = date.JTIME_UNITS
   /** @internal */ const JTIME_UNITS: typeof date.JTIME_UNITS
@@ -283,10 +286,8 @@ declare global {
   /** @internal */ type JLayerThematicSetCategoryVisibilityParams = layer.JLayerThematicSetCategoryVisibilityParams
   /** @internal */ type JLayerThematicSetConditionVisibilityParams = layer.JLayerThematicSetConditionVisibilityParams
   /** @internal */ type JLayerSetLayerGroupsExpansionParams = layer.JLayerSetLayerGroupsExpansionParams
-  /** @internal */ type JAttribute = layer.JAttribute
   /** @internal */ type ATTRIBUTE_TYPES = layer.ATTRIBUTE_TYPES
   /** @internal */ const ATTRIBUTE_TYPES: typeof layer.ATTRIBUTE_TYPES
-  /** @internal */ type JValueDomain = layer.JValueDomain
   /** @internal */ type JOPERATING_SYSTEMS = main.JOPERATING_SYSTEMS
   /** @internal */ const JOPERATING_SYSTEMS: typeof main.JOPERATING_SYSTEMS
   /** @internal */ type JFATAL_ERROR_CONTEXTS = main.JFATAL_ERROR_CONTEXTS

package/public/jmap/datasource.ts

@@ -1,11 +1,31 @@
-import type { JLocaleTranslation } from "./language.d.ts"
-import type { ATTRIBUTE_TYPES, JValueDomain } from "./layer.d.ts"
 export {}
-export interface JDataSourceAttribute {
-  id: string
-  name: string
-  type: ATTRIBUTE_TYPES
-  indexed: boolean
-  title: JLocaleTranslation
-  valueDomain?: JValueDomain[]
+export interface JDataSourceData {
+  features: GeoJSON.Feature[]
+  links: Array<{ href: string; rel: string; title: string; type: string }>
+  numberReturned: number
 }
+
+export interface JDataSourceDataParams {
+  startIndex?: number
+  limit?: number
+  filter?: string
+  sort?: string
+  attributes?: string[]
+}
+
+export type JDataSourcePermissions = Array<JDataSourcePermission>
+
+export type JDataSourcePermission =
+  | "OWNER"
+  | "VIEW"
+  | "MODIFY"
+  | "CREATE_FEATURE"
+  | "EXTRACT_FEATURE"
+  | "EDIT_FEATURE_GEOMETRY"
+  | "EDIT_FEATURE_ATTRIBUTES"
+  | "DELETE_FEATURE"
+  | "EXTRACT_RASTER"
+  | "EXTRACT_ROW"
+  | "CREATE_ROW"
+  | "EDIT_ROW"
+  | "DELETE_ROW"

package/public/jmap/layer.d.ts

@@ -1,8 +1,6 @@
-import type { JAnyFilterCondition, JDynamicFilterGraphQL } from "jmapcloud-types"
-import type { JDataSourceAttribute } from "./datasource.ts"
+import type { JAnyFilterCondition, JAttribute, JDynamicFilterGraphQL } from "jmapcloud-types"
 import type { JFORM_TYPES } from "./form.d.ts"
 import type { JBoundaryBox } from "./geometry.d.ts"
-import type { JLocaleTranslation } from "./language.d.ts"
 import type { JId } from "./main.d.ts"
 import type { JMapMouseOver } from "./mouseover.d.ts"
 import type { JTable } from "./table.d.ts"
@@ -323,7 +321,7 @@ export interface JLayer extends JLayerTreeElement {
   hasInformationReport: boolean
   informationReports: JLayerInformationReport[]
   spatialDataSourceId: string
-  spatialDataSourceAttributes: JDataSourceAttribute[] | null
+  spatialDataSourceAttributes: JAttribute[] | null
   selectionStyleId: string
   // dynamicFilter: JDynamicFilter
   // TODO JMAP8-3266 : use a localized type instad of a graphQL one
@@ -612,15 +610,6 @@ export interface JLayerSetLayerGroupsExpansionParams {
   open: boolean
 }
 
-export interface JAttribute {
-  id: string
-  name: string
-  type: ATTRIBUTE_TYPES
-  indexed: boolean
-  title: JLocaleTranslation
-  valueDomain?: JValueDomain[]
-}
-
 export enum ATTRIBUTE_TYPES {
   TINYINT = "TINYINT",
   SMALLINT = "SMALLINT",
@@ -640,13 +629,3 @@ export enum ATTRIBUTE_TYPES {
   ARRAY = "ARRAY",
   BOOLEAN = "BOOLEAN"
 }
-
-export type JValueDomain =
-  | {
-      value: string | number
-      title: JLocaleTranslation
-    }
-  | {
-      nullValue: true
-      title: JLocaleTranslation
-    }

package/public/jmap/table.d.ts

@@ -1,5 +1,4 @@
-import type { JAnyFilterCondition, JDynamicFilterGraphQL } from "jmapcloud-types"
-import type { JDataSourceAttribute } from "./datasource.ts"
+import type { JAnyFilterCondition, JAttribute, JAttributeType, JDynamicFilterGraphQL } from "jmapcloud-types"
 import type { JLocaleTranslation } from "./language.d.ts"
 export {}
 // ALL_TABLE_ATTRIBUTE_TYPES in all-enum.ts
@@ -21,8 +20,8 @@ export interface JTable {
   organizationId: string
   projectId: string
   name: string
-  attributes: JTableAttribute[]
-  dataSourceAttributes: JDataSourceAttribute[] | null
+  attributes: JAttribute[]
+  dataSourceAttributes: JAttribute[] | null
   listed: boolean
   description: JLocaleTranslation
   dataSourceId: string
@@ -38,7 +37,7 @@ export interface JTableAttribute {
   name: string
   title: string
   label: string
-  type: JTABLE_ATTRIBUTE_TYPES
+  type: JAttributeType
   indexed: boolean
 }
 
@@ -59,6 +58,7 @@ export interface JTableDataParams {
   limit?: number
   filter?: JAnyFilterCondition
   sort?: string
+  columns?: string[]
 }
 
 export interface JTablePermissions {