jmapcloud-ng-core-types 1.0.50 → 1.0.52

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jmapcloud-ng-core-types",
-  "version": "1.0.50",
+  "version": "1.0.52",
   "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**
      *

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