jmapcloud-ng-core-types 1.0.49 → 1.0.51

package/index.ts

@@ -151,6 +151,7 @@ export interface JFeatureService {
   getByIds(layerId: JId, featureIds: JId[]): Promise<GeoJSON.Feature[]>
   getByLayerId(layerId: JId, bbox: JBoundaryBox): Promise<GeoJSON.Feature[]>
   geometryUpdateById(params: JFeatureGeometryUpdateParams): Promise<GeoJSON.Feature>
+  propertiesUpdateById(params: JFeaturePropertiesUpdateParams): Promise<GeoJSON.Feature>
   deleteById(layerId: JId, featureId: JId): Promise<JId>
   // deleteByIds(layerId: JId, featureIds: JId[]): Promise<JFeatureDeleteByIdsResult>
   // TODO: see if the future endpoint will return detail about individual deleted features success or failure
@@ -593,7 +594,7 @@ export interface JServerState extends JServerInfo {
 export type JHistoryListener = (oldValue: string | undefined, newValue: string | undefined) => void
 
 export interface JFormJMCService {
-  getJsonForm(layerId: string): JJsonFormSchemas
+  getJsonForm(dataSourceId: string): Promise<JJsonFormSchemas>
   getForm(layerId: string): Promise<JFormJMC>
 }
 
@@ -924,6 +925,10 @@ export interface JLayerService {
 export interface JTableService {
   getTables(): JTable[]
   getTableData(dataSourceId: JId, params: JTableDataParams): Promise<JTableData>
+  getById(tableId: JId): JTable
+  createRow(dataSourceId: JId, row: { [key: string]: any }): Promise<void>
+  updateRow(dataSourceId: JId, rowId: number, row: { [key: string]: any }): Promise<void>
+  deleteRow(dataSourceId: JId, rowId: number): Promise<void>
 }
 
 export interface JLayerSearchService {

package/package.json

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

package/public/core.d.ts

@@ -524,6 +524,29 @@ declare namespace JMap {
      */
     function geometryUpdateById(params: JFeatureGeometryUpdateParams): Promise<GeoJSON.Feature>
 
+    /**
+     * **JMap.Feature.propertiesUpdateById**
+     *
+     * Change the feature properties for the given layer id, feature id and properties.
+     *
+     * @param params contains the JMap layer id, the JMap feature id and its properties
+     * @throws if layer or feature not found, or if properties are invalid
+     * @example
+     * ```ts
+     * const newProperties = { ... }
+     * // change the properties of feature id="4" on layer id="3"
+     * JMap.Feature
+     *  .propertiesUpdateById({
+     *    layerId: 3,
+     *    featureId: 4,
+     *    properties: newProperties
+     *  })
+     *  .then(feature => console.info("Feature properties' have been changed", feature))
+     *  .catch(error => console.error("An error occured", error))
+     * ```
+     */
+    function propertiesUpdateById(params: JFeaturePropertiesUpdateParams): Promise<GeoJSON.Feature>
+
     /**
      * **JMap.Feature.deleteById**
      *
@@ -10262,23 +10285,23 @@ declare namespace JMap {
     /**
      * ***JMap.FormJMC.getJsonForm***
      *
-     * Returns the jsonForm schema and uiSchema for a layer.
+     * Returns the jsonForm schema and uiSchema for a data source.
      *
-     * fetch the attributes of a layer and then builds and returns the schema and uiSchema required for jsonForms. The schemas will be null if there is no attributes on the layer
+     * fetch the attributes of a data source and then builds and returns the schema and uiSchema required for jsonForms. The schemas will be null if there is no attributes on the data source
      *
-     * @param layerId the JMap layer id
+     * @param dataSourceId the JMap data source id
      * @example
      * ```ts
-     * // returns the schema and uiSchema for layer id=f47ac10b-58cc-4372-a567-0e02b2c3d479
+     * // returns the schema and uiSchema for data source id=f47ac10b-58cc-4372-a567-0e02b2c3d479
 
 
      * JMap.FormJMC
      *  .getJsonForm("f47ac10b-58cc-4372-a567-0e02b2c3d479")
-     *  .then(schemas => console.log("jsonForms schemas of layer f47ac10b-58cc-4372-a567-0e02b2c3d479", schemas))
+     *  .then(schemas => console.log("jsonForms schemas of data source f47ac10b-58cc-4372-a567-0e02b2c3d479", schemas))
      *  .catch(error => console.error("An error occurred when getting jsonForm schema", error))
      * ```
      */
-    function getJsonForm(layerId: JId): JJsonFormSchemas
+    function getJsonForm(dataSourceId: JId): Promise<JJsonFormSchemas>
 
     /**
      * ***JMap.FormJMC.getForm***
@@ -12786,5 +12809,75 @@ declare namespace JMap {
      * ```
      */
     function getTableData(dataSourceId: JId, params: JTableDataParams): Promise<JTableData>
+
+    /**
+     * **JMap.Table.getById**
+     *
+     * Returns the JMap table having the id.
+     *
+     * @throws Error if no table found for the id
+     * @param tableId The JMap table id
+     * @example
+     * ```ts
+     * // returns the JMap table id=3
+     * JMap.Table.getById(3)
+     * ```
+     */
+    function getById(tableId: JId): JTable
+
+    /**
+     * **JMap.Table.createRow**
+     *
+     * Create a row from a table
+     *
+     * @param {JId} dataSourceId - The Id of the data source.
+     * @param {{ [key: string]: any }} row - the data of the row to be updated.
+     *
+     * @returns {Promise<void>}
+     *
+     * @example
+     * ```ts
+     * // Create a row in the dataSet with id : "be4552e1-d89d-48ec-a417-7b99d14b4d7b" with the data: {city: Montreal, country:Canada}.
+     * JMap.Table.createRow("be4552e1-d89d-48ec-a417-7b99d14b4d7b", {city: "Montreal", country: "Canada"});
+     * ```
+     */
+    function createRow(dataSourceId: JId, row: { [key: string]: any }): Promise<void>
+
+    /**
+     * **JMap.Table.updateRow**
+     *
+     * Update a row from a table
+     *
+     * @param {JId} dataSourceId - The ID of the data source.
+     * @param {number} rowId - Id of the row to be updated.
+     * @param {{ [key: string]: any }} row - the data of the row to be updated.
+     *
+     * @returns {Promise<void>}
+     *
+     * @example
+     * ```ts
+     * // Update the row with an id of 3086627 from the dataSet with id : "be4552e1-d89d-48ec-a417-7b99d14b4d7b".
+     * JMap.Table.updateRow("be4552e1-d89d-48ec-a417-7b99d14b4d7b", 3086627, {city: "Montreal", country: "Canada"});
+     * ```
+     */
+    function updateRow(dataSourceId: JId, rowId: number, row: { [key: string]: any }): Promise<void>
+
+    /**
+     * **JMap.Table.deleteRow**
+     *
+     * Delete a row from a table
+     *
+     * @param {JId} dataSourceId - The ID of the JMap data source.
+     * @param {number} rowId - Id of the row to be updated.
+     *
+     * @returns {Promise<void>}
+     *
+     * @example
+     * ```ts
+     * // Delete the row with an id of 3086627 from the dataSet with id : "be4552e1-d89d-48ec-a417-7b99d14b4d7b"
+     * JMap.Table.deleteRow("be4552e1-d89d-48ec-a417-7b99d14b4d7b", 3086627);
+     * ```
+     */
+    function deleteRow(dataSourceId: JId, rowId: number): Promise<void>
   }
 }

package/public/jmap/features.d.ts

@@ -9,6 +9,12 @@ declare interface JFeatureGeometryUpdateParams {
   properties?: JAttributeValueByName
 }
 
+declare interface JFeaturePropertiesUpdateParams {
+  layerId: JId
+  featureId: JId
+  properties: JAttributeValueByName
+}
+
 declare interface JFeatureEventGeometryUpdateParams {
   layerId: JId
   updatedFeature: GeoJSON.Feature

package/public/jmap/formJMC.d.ts

@@ -1,6 +1,6 @@
 declare interface JJsonFormSchemas {
   schema: JFormSchemaJMC | null
-  uiSchema: FormNodeVertical | null
+  uiSchema: FormNodeVertical | undefined
 }
 
 declare interface JFormSchemaJMC {

package/public/jmap/layer.d.ts

@@ -167,6 +167,7 @@ declare interface JLayerStyleSamplesById {
 declare interface JLayersConfiguration {
   metadataSchema: JLayerMetadataSchemaItem[]
   layerTree: JLayerTree
+  tables: JTable[]
   styleSamples: JLayerStyleSamplesById
 }
 

package/public/jmap/table.d.ts

@@ -2,10 +2,11 @@ declare interface JTable {
   id: string
   organizationId: string
   projectId: string
-  name: JLocaleTranslation
+  name: string
   description: JLocaleTranslation
   dataSourceId: string
   allowClientSideEditing: boolean
+  permissions: JTablePermissions
 }
 
 declare interface JTableData {
@@ -21,3 +22,10 @@ declare interface JTableDataParams {
   filter?: string
   sort?: string
 }
+
+declare interface JTablePermissions {
+  EXTRACT_ROW: boolean
+  CREATE_ROW: boolean
+  EDIT_ROW: boolean
+  DELETE_ROW: boolean
+}