jmapcloud-ng-core-types 2.0.17-qa.3 → 2.0.17-qa.5

package/index.d.ts

@@ -89,9 +89,10 @@ export interface JUIService {
 }
 
 export interface JSimpleSearchService {
-  getInvalidQueryStringCharacters(): string
+  getSelectedLayerIds(): JId[]
+  setSelectedLayerIds(layerIds: JId[]): void
   setQueryString(queryString: string): void
-  getMinimumQueryStringLength(): number
+  search(queryString: string, options?: JSimpleSearchOptions): Promise<JSimpleSearchResult[]>
 }
 
 export interface JLibraryService {
@@ -251,7 +252,6 @@ export interface JEventService {
   Language: JLanguageEventModule
   Map: JMapEventModule
   Geocoding: JGeocodingEventModule
-  SimpleSearch: JSimpleSearchEventModule
   Project: JProjectEventModule
   User: JUserEventModule
   Feature: JFeatureEventModule
@@ -330,13 +330,6 @@ 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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jmapcloud-ng-core-types",
-  "version": "2.0.17-qa.3",
+  "version": "2.0.17-qa.5",
   "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

@@ -113,7 +113,6 @@ import type { JMouseOverAfterEventParams, JMouseOverBeforeEventParams, JMouseOve
 import type { JProject, JProjectAllEventParams, JProjectEventParams, JProjectLoadThumbnailsParams } from "./jmap/project.d.ts"
 import type { JMapSelectionParams, JSelectionSetLayersSelectionParams } from "./jmap/selection.d.ts"
 import type { JServerAnyIdentityProvider, JServerIdentityProviderById, JServerInfo, JServerInfoReadyEventParams, JServerVersion } from "./jmap/server.d.ts"
-import type { JSimpleSearchErrorEventParams, JSimpleSearchSuccessEventParams } from "./jmap/simple-search.d.ts"
 import type { JTable, JTableData, JTableDataParams } from "./jmap/table.d.ts"
 import type { JIFramePopupParams } from "./jmap/ui.d.ts"
 import type { JJMapPasswordPolicyCompliance, JOrganization, JSessionData, JUserEventSessionChangedParams, JUserInfo } from "./jmap/user.d.ts"
@@ -7003,14 +7002,23 @@ export namespace JMap {
    *
    */
   namespace SimpleSearch {
+    /** Returns a copy of the selected layer IDs. Selection lasts until the project changes. */
+    function getSelectedLayerIds(): JId[]
+    /**
+     * Selects indexed layers and all indexed siblings sharing their data sources.
+     * Unknown IDs are ignored. An empty list disables search, including table searches.
+     * The mounted NG search UI re-runs an active query immediately; indexed tables remain included when any layer is selected.
+     * @throws if no project is active or layerIds is not an array.
+     */
+    function setSelectedLayerIds(layerIds: JId[]): void
     /**
      * ***JMap.SimpleSearch.setQueryString***
      *
-     * 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.
+     * Updates the simple-search input. While the NG search UI is mounted, it debounces changes for 500ms and searches the selected indexed layers and indexed tables of the current project. 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 an array of result object indicating all matches found.
+     * This method only updates state. Requests require the NG search UI to be mounted; results and request status are managed by its React Query hook.
      *
      * @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
@@ -7020,31 +7028,21 @@ export namespace JMap {
      */
     function setQueryString(queryString: string): void
     /**
-     * **JMap.SimpleSearch.getMinimumQueryStringLength**
+     * ***JMap.SimpleSearch.search***
      *
-     * Returns the query string length required to trigger a simple search
+     * Runs one search and resolves with the results, one entry per data source. The input and the
+     * layer selection are not touched.
      *
-     * @example
-     * ```ts
-     * // returns the minimum search string length
-     * JMap.SimpleSearch.getMinimumQueryStringLength()
-     * // 1
-     * ```
-     */
-    function getMinimumQueryStringLength(): number
-    /**
-     * **JMap.SimpleSearch.getInvalidQueryStringCharacters**
-     *
-     * Returns a string composed of all forbidden characters in simple search strings.
+     * `options.layerIds` restricts the search to those indexed layers; indexed tables are always
+     * included. Omit it to search the whole project. An empty list resolves with no results.
      *
+     * @throws if no project is loaded, if queryString is not a string or contains invalid characters, or if options.layerIds is not an array.
      * @example
      * ```ts
-     * // returns the invalid characters
-     * JMap.SimpleSearch.getInvalidQueryStringCharacters()
-     * // "<>"
+     * JMap.SimpleSearch.search("montreal", { layerIds: JMap.SimpleSearch.getSelectedLayerIds() }).then(results => console.log(results))
      * ```
      */
-    function getInvalidQueryStringCharacters(): string
+    function search(queryString: string, options?: JSimpleSearchOptions): Promise<JSimpleSearchResult[]>
   }
   /**
    * **JMap.Draw**
@@ -7823,107 +7821,6 @@ export 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/global-aliases.d.ts

@@ -318,10 +318,9 @@ declare global {
   /** @internal */ type JServerVersion = server.JServerVersion
   /** @internal */ type JServerInfoReadyEventParams = server.JServerInfoReadyEventParams
   /** @internal */ type JSimpleSearchQueryString = simplesearch.JSimpleSearchQueryString
+  /** @internal */ type JSimpleSearchOptions = simplesearch.JSimpleSearchOptions
   /** @internal */ type JSimpleSearchResult = simplesearch.JSimpleSearchResult
   /** @internal */ type JSimpleSearchResultHit = simplesearch.JSimpleSearchResultHit
-  /** @internal */ type JSimpleSearchSuccessEventParams = simplesearch.JSimpleSearchSuccessEventParams
-  /** @internal */ type JSimpleSearchErrorEventParams = simplesearch.JSimpleSearchErrorEventParams
   /** @internal */ type JWindow = startupoptions.JWindow
   /** @internal */ type JCoreOptions = startupoptions.JCoreOptions
   /** @internal */ type JTABLE_ATTRIBUTE_TYPES = table.JTABLE_ATTRIBUTE_TYPES

package/public/jmap/layer.d.ts

@@ -354,6 +354,7 @@ export interface JLayerAttribute {
   id: string
   name: string
   label: string
+  indexed: boolean
   type: JLAYER_ATTRIBUTE_TYPES
 }
 

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

@@ -8,6 +8,10 @@ export interface JSimpleSearchQueryString {
   }
 }
 
+export interface JSimpleSearchOptions {
+  layerIds?: JId[]
+}
+
 export interface JSimpleSearchResult {
   took: number
   timedOut: boolean
@@ -39,11 +43,3 @@ export interface JSimpleSearchResultHit {
     [attributeName: string]: string[]
   }
 }
-
-export interface JSimpleSearchSuccessEventParams {
-  result: JSimpleSearchResult[]
-}
-
-export interface JSimpleSearchErrorEventParams {
-  error: any
-}

package/public/state.d.ts

@@ -69,12 +69,13 @@ export interface JGeocodingState {
   results: JGeocodingResult[]
 }
 
+/**
+ * User intent only. The mounted NG search UI manages request state and results with React Query.
+ */
 export interface JSimpleSearchState {
-  isLoadPending: boolean
-  isLoading: boolean
-  hasLoadingError: boolean
+  /** The string as typed, updated on every call to `JMap.SimpleSearch.setQueryString`. */
   queryString: string
-  results: JSimpleSearchResult[]
+  selectedLayerIds: JId[]
 }
 
 export interface JGeolocationState {