jmapcloud-ng-core-types 1.0.1 → 1.0.1002

package/index.ts

@@ -25,6 +25,7 @@ export interface JCoreService extends JCoreMainService {
   Projection: JProjectionService
   MapContext: JMapContextService
   UI: JUIService
+  SimpleSearch: JSimpleSearchService
 }
 
 export interface JUIService {
@@ -35,6 +36,12 @@ export interface JUIService {
   getContainerHeight(): number
 }
 
+export interface JSimpleSearchService {
+  getInvalidQueryStringCharacters(): string
+  setQueryString(queryString: string): void
+  getMinimumQueryStringLength(): number
+}
+
 export interface JLibraryService {
   maplibregl(): any
   html2canvas(): any
@@ -196,6 +203,7 @@ export interface JEventService {
   Language: JLanguageEventModule
   Map: JMapEventModule
   Geocoding: JGeocodingEventModule
+  SimpleSearch: JSimpleSearchEventModule
   Photo: JPhotoEventModule
   Project: JProjectEventModule
   User: JUserEventModule
@@ -296,6 +304,13 @@ export interface JGeocodingEventModule extends JEventModule {
   }
 }
 
+export interface JSimpleSearchEventModule extends JEventModule {
+  on: {
+    success(listenerId: string, fn: (params: JSimpleSearchSuccessEventParams) => void): void
+    error(listenerId: string, fn: (params: JSimpleSearchErrorEventParams) => void): void
+  }
+}
+
 export interface JLayerEventModule extends JEventModule {
   on: {
     layersChange(listenerId: string, fn: (params: JLayerEventChangeParams) => void): void
@@ -396,6 +411,7 @@ export interface JCoreState {
   photo: JPhotoState
   query: JQueryState
   geocoding: JGeocodingState
+  simpleSearch: JSimpleSearchState
   geolocation: JGeolocationState
   form: JFormState
   server: JServerState
@@ -448,6 +464,14 @@ export interface JGeocodingState {
   results: JGeocodingResult[]
 }
 
+export interface JSimpleSearchState {
+  isLoadPending: boolean
+  isLoading: boolean
+  hasLoadingError: boolean
+  queryString: string
+  results: JSimpleSearchResult
+}
+
 export interface JGeolocationState {
   isLocationDisplayed: boolean
   isEnabled: boolean

package/package.json

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

package/public/core.d.ts

@@ -6789,6 +6789,62 @@ declare namespace JMap {
     function getDateFnsDateFormat(): string
   }
 
+  /**
+   * **JMap.SimpleSearch**
+   *
+   * 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.
+   *
+   * JMap Cloud implements the OpenSearch standard. For more details, see {@link https://opensearch.org/docs/latest/ the official documentation}
+   *
+   */
+
+  namespace SimpleSearch {
+    /**
+     * ***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
+     *
+     * This method will fetch a result object indicating all matches found.
+     *
+     * @throws if no project is loaded
+     * @param queryString the search string to be used
+     * @example ```ts
+     *
+     * ```
+     */
+    function setQueryString(queryString: string): void
+
+    /**
+     * **JMap.SimpleSearch.getMinimumQueryStringLength**
+     *
+     * Returns the query string length required to trigger a simple search
+     *
+     * @example ```ts
+     *
+     * // returns the minimum search string length
+     * JMap.SimpleSearch.getMinimumQueryStringLength()
+     * // 3
+     * ```
+     */
+    function getMinimumQueryStringLength(): number
+
+    /**
+     * **JMap.SimpleSearch.getInvalidQueryStringCharacters**
+     *
+     * Returns a string composed of all forbiden characters in simple search strings
+     *
+     * @example ```ts
+     *
+     * // returns the invalid characters
+     * JMap.SimpleSearch.getInvalidQueryStringCharacters()
+     * // ";"
+     * ```
+     */
+    function getInvalidQueryStringCharacters(): string
+  }
+
   /**
    * **JMap.Query**
    *
@@ -7348,6 +7404,112 @@ declare namespace JMap {
       function remove(listenerId: string): void
     }
 
+    /**
+     * ***JMap.Event.SimpleSearch***
+     *
+     * Here you can manage all simple search event listeners.
+     *
+     * Click to see all events available: ***{@link JMap.Event.SimpleSearch.on}***.
+     */
+    namespace SimpleSearch {
+      /**
+       * ***JMap.Event.SimpleSearch.on***
+       *
+       * Here you have all JMap Cloud NG Core simple search events on which you can attach a listener.
+       */
+      namespace on {
+        /**
+         * ***JMap.Event.SimpleSearch.on.success***
+         *
+         * This event is triggered when a simple search has been completed.
+         *
+         * @param listenerId Your listener id (must be unique)
+         * @param fn Your listener function
+         * @example ```ts
+         *
+         * // log a message in the console once the simple search has been completed
+         * JMap.Event.SimpleSearch.on.success(
+         *   "custom-simple-search-success",
+         *   params => console.log("A simple search has been completed", params.results)
+         * )
+         * ```
+         */
+        function success(listenerId: string, fn: (params: JSimpleSearchSuccessEventParams) => void): void
+
+        /**
+         * ***JMap.Event.SimpleSearch.on.error***
+         *
+         * This event is triggered when a simple search has been processed, but an error occured.
+         *
+         * @param listenerId Your listener id (must be unique)
+         * @param fn Your listener function
+         * @example ```ts
+         *
+         * // log a message in the console if a simple search error occured
+         * JMap.Event.SimpleSearch.on.error(
+         *   "custom-simple-search-error",
+         *   params => console.log("A simple search has failed", params)
+         * )
+         * ```
+         */
+        function error(listenerId: string, fn: (params: JSimpleSearchErrorEventParams) => void): void
+      }
+
+      /**
+       * ***JMap.Event.SimpleSearch.activate***
+       *
+       * Activate the listener.
+       *
+       * If the listener is already active, do nothing.
+       *
+       * If the listener is inactive, it will be reactivated and will be called again ...
+       *
+       * @param listenerId The listener id
+       * @example ```ts
+       *
+       * // activate the listener "my-simple-search-listener"
+       * JMap.Event.SimpleSearch.activate("my-simple-search-listener")
+       * ```
+       */
+      function activate(listenerId: string): void
+
+      /**
+       * ***JMap.Event.SimpleSearch.deactivate***
+       *
+       * Deactivate the listener.
+       *
+       * If the listener id doesn't exists or if the listener is already inactive, do nothing.
+       *
+       * If the listener is active, it will be deactivated and will be ignored ...
+       *
+       * @param listenerId The listener id
+       * @example ```ts
+       *
+       * // deactivate the listener "my-simple-search-listener"
+       * JMap.Event.SimpleSearch.deactivate("my-simple-search-listener")
+       * ```
+       */
+      function deactivate(listenerId: string): void
+
+      /**
+       * ***JMap.Event.SimpleSearch.remove***
+       *
+       * Remove the listener.
+       *
+       * If the listener doesn't exist, do nothing.
+       *
+       * Remove the listener from JMap Cloud NG Core library. The listener is deleted and never called again after that.
+       *
+       * @param listenerId The listener id
+       * @example ```ts
+       *
+       * // remove the listener "my-simple-search-listener"
+       * JMap.Event.SimpleSearch.remove("my-simple-search-listener")
+       * ```
+       */
+      function remove(listenerId: string): void
+    }
+
     namespace Server {
       /**
        * ***JMap.Event.Server.on***

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

@@ -0,0 +1,42 @@
+declare interface JSimpleSearchQueryString {
+  query: {
+    query_string: {
+      query: string
+    }
+  }
+}
+
+declare interface JSimpleSearchResult {
+  took: number
+  timedOut: boolean
+  shards: {
+    total: number
+    successful: number
+    skipped: number
+    failed: number
+  }
+  hits: {
+    total: {
+      value: number
+      relation: string
+    }
+    maxScore: number
+    hits: JSimpleSearchResultHit[]
+  }
+}
+
+declare interface JSimpleSearchResultHit {
+  _index: string
+  _source: { spatialDataSourceId: string } & { [attributeName: string]: any }
+  _id: JId
+  _score: number
+  highlight?: { [attributeName: string]: string[] }
+}
+
+declare interface JSimpleSearchSuccessEventParams {
+  result: JSimpleSearchResult
+}
+
+declare interface JSimpleSearchErrorEventParams {
+  error: any
+}