jmapcloud-ng-core-types 1.0.1002 → 1.0.1003

package/index.ts

@@ -149,8 +149,11 @@ export interface JFeatureService {
   getById(layerId: JId, featureId: JId): Promise<GeoJSON.Feature>
   getByIds(layerId: JId, featureIds: JId[]): Promise<GeoJSON.Feature[]>
   geometryUpdateById(params: JFeatureGeometryUpdateParams): Promise<GeoJSON.Feature>
-  deleteById(layerId: JId, featureId: JId): Promise<GeoJSON.Feature>
-  deleteByIds(layerId: JId, featureIds: JId[]): Promise<JFeatureDeleteByIdsResult>
+  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
+  // https://k2geospatial.atlassian.net/browse/JMAP8-1589
+  deleteByIds(layerId: JId, featureIds: JId[]): Promise<JId[]>
 }
 
 export interface JCoreMainService {

package/package.json

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

package/public/core.d.ts

@@ -566,11 +566,11 @@ declare namespace JMap {
      * // deletes the feature id="4" on layer id="3"
      * JMap.Feature
      *  .deleteById(3, 4)
-     *  .then(deletedFeature => console.info("Feature has been deleted", deletedFeature))
+     *  .then(deletedFeatureId => console.info("Feature id=" + deletedFeatureId + " has been deleted"))
      *  .catch(error => console.error("An error occured", error))
      * ```
      */
-    function deleteById(layerId: JId, featureId: JId): Promise<GeoJSON.Feature>
+    function deleteById(layerId: JId, featureId: JId): Promise<JId>
 
     /**
      * **JMap.Feature.deleteByIds**
@@ -589,7 +589,11 @@ declare namespace JMap {
      *  .catch(error => console.error("An error occured", error))
      * ```
      */
-    function deleteByIds(layerId: JId, featureIds: JId[]): Promise<JFeatureDeleteByIdsResult>
+
+    // deleteByIds(layerId: JId, featureIds: JId[]): Promise<JFeatureDeleteByIdsResult>
+    // TODO: see if the future endpoint will return detail about individual deleted features success or failure
+    // https://k2geospatial.atlassian.net/browse/JMAP8-1589
+    function deleteByIds(layerId: JId, featureIds: JId[]): Promise<JId[]>
   }
 
   /**
@@ -6792,9 +6796,9 @@ declare namespace JMap {
   /**
    * **JMap.SimpleSearch**
    *
-   * A search mecanism that let the user  find features on any layer that has been indexed.
+   * A search mecanism that let the user find features on any layer that has been indexed.
    *
-   * The JMap Cloud administrator is responsible to specify which attributes of which spatial data sources are indexed. Once set, a global search can be made over a whole project to find features based on those indexed attributes.
+   * The JMap Cloud administrator is responsible for specifying which attributes of which spatial data sources are indexed. Once indices are set, a global search can be made over a whole project to find features based on those indexed attributes.
    *
    * JMap Cloud implements the OpenSearch standard. For more details, see {@link https://opensearch.org/docs/latest/ the official documentation}
    *
@@ -6804,11 +6808,13 @@ declare namespace JMap {
     /**
      * ***JMap.SimpleSearch.setQueryString***
      *
-     * execute a "query string" search on all layers of the current project using the passed string as the query. See {@link https://opensearch.org/docs/latest/query-dsl/full-text/query-string/#query-string-syntax here} for details
+     * Executes a "query string" search on all layers of the current project using the passed string as the query. See {@link https://opensearch.org/docs/latest/query-dsl/full-text/query-string/#query-string-syntax here} for details.
+     *
+     * All query_string reserved characters are escaped, and the following characters can't be used: "<>"
      *
      * This method will fetch a result object indicating all matches found.
      *
-     * @throws if no project is loaded
+     * @throws if no project is loaded, if the passed search string is not a string or if it contains invalid characters.
      * @param queryString the search string to be used
      * @example ```ts
      *
@@ -6833,7 +6839,7 @@ declare namespace JMap {
     /**
      * **JMap.SimpleSearch.getInvalidQueryStringCharacters**
      *
-     * Returns a string composed of all forbiden characters in simple search strings
+     * Returns a string composed of all forbidden characters in simple search strings.
      *
      * @example ```ts
      *

package/public/jmap/simple-search.d.ts

@@ -27,7 +27,7 @@ declare interface JSimpleSearchResult {
 
 declare interface JSimpleSearchResultHit {
   _index: string
-  _source: { spatialDataSourceId: string } & { [attributeName: string]: any }
+  _source: { [attributeName: string]: any }
   _id: JId
   _score: number
   highlight?: { [attributeName: string]: string[] }