jmapcloud-ng-core-types 1.0.52 → 1.0.54

package/index.ts

@@ -14,7 +14,6 @@ export interface JCoreService extends JCoreMainService {
   MouseOver: JMouseOverService
   Form: JFormService
   FormJMC: JFormJMCService
-  Query: JQueryService
   Event: JEventService
   History: JHistoryService
   Extension: JExtensionService
@@ -184,17 +183,6 @@ export interface JGeolocationService {
   goToMyLocation(options?: JPanAndZoomOptions): Promise<JLocation>
 }
 
-export interface JQueryService {
-  getAllGroups(): JQueryGroup[]
-  groupExist(groupId: JId): boolean
-  getQueriesByLayerId(layerId: JId): JQuery[]
-  getQueryByLayerId(layerId: JId, queryId: string): JQuery
-  getQueriesByGroupId(groupId: JId): JQuery[]
-  getQueryByGroupId(groupId: JId, queryId: string): JQuery
-  queryExist(groupId: JId, queryId: string): boolean
-  fetchFeatures(layerId: JId, queryId: string, data: any): Promise<Feature[]>
-}
-
 export interface JAjaxService {
   get(config: JRequestConfig): Promise<any>
   post(config: JRequestConfig): Promise<any>
@@ -219,7 +207,6 @@ export interface JEventService {
   MouseOver: JMouseOverEventModule
   MapContext: JMapContextEventModule
   Server: JServerEventModule
-  Query: JQueryEventModule
 }
 
 export type JEventFunction = (params?: any) => void | Promise<any>
@@ -245,15 +232,6 @@ export interface JEventModule {
   remove(listenerId: string): void
 }
 
-export interface JQueryEventModule extends JEventModule {
-  on: {
-    queryFormLoad(listenerId: string, fn: (params: JQueryQueryFormHasLoadedEventParams) => void): void
-    beforeSubmit(listenerId: string, fn: (params: JQueryBeforeEventParams) => void): void
-    success(listenerId: string, fn: (params: JQuerySuccessEventParams) => void): void
-    error(listenerId: string, fn: (params: JQueryErrorEventParams) => void): void
-  }
-}
-
 export interface JServerEventModule extends JEventModule {
   on: {
     infoReady(listenerId: string, fn: (params: JServerInfoReadyEventParams) => void): void
@@ -418,7 +396,6 @@ export interface JCoreState {
   user: JUserState
   language: JLanguageState
   photo: JPhotoState
-  query: JQueryState
   geocoding: JGeocodingState
   simpleSearch: JSimpleSearchState
   geolocation: JGeolocationState
@@ -557,11 +534,6 @@ export interface JPhotoState {
   isDownloading: boolean
 }
 
-export interface JQueryState {
-  groups: JQueryGroup[]
-  queriesByLayerId: { [key in JId]: JQuery[] }
-}
-
 export interface JUserState extends JTokenInfo {
   isAnonymous: boolean
   anonymousOrganizationId: string
@@ -920,6 +892,7 @@ export interface JLayerService {
   deleteLayer(layerId: JId): void
   hasInformationReport(layerId: JId): boolean
   openInformationReportInNewTab(layerId: JId, featureIds: JId[]): Promise<string>
+  getDataSourceAttributes(dataSourceId: JId): Promise<JAttribute[]>
 }
 
 export interface JTableService {

package/package.json

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

package/public/core.d.ts

@@ -2417,6 +2417,22 @@ declare namespace JMap {
      * ```
      **/
     function openInformationReportInNewTab(layerId: JId, featureIds: JId[]): Promise<string>
+
+    /**
+     * **JMap.Layer.getDataSourceAttributes**
+     *
+     * Returns attributes, for a given dataSource.
+     *
+     * @param dataSourceId the JMap dataSource id
+     * @throws if dataSourceId not valid or dataSource not found
+     * @example
+     * ```ts
+     * // Returns attributes, for dataSource id=3
+     * JMap.Layer
+     *  .getDataSourceAttributes(3)
+     * ```
+     **/
+    function getDataSourceAttributes(dataSourceId: JId): Promise<JAttribute[]>
   }
 
   /**
@@ -7114,170 +7130,6 @@ declare namespace JMap {
     function getInvalidQueryStringCharacters(): string
   }
 
-  /**
-   * **JMap.Query**
-   *
-   * A feature query mecanism has been set in JMap to get filtered features.
-   *
-   * By example we can get all features that have an attribute equals to a given value.
-   *
-   * A query concerns a single layer, and it set a data form that will be filled by users to make a search.
-   *
-   * For a given project, a JMap administrator can create query groups and put inside
-   * all queries he wants, not depending on a particular layers.
-   *
-   * You can get queries definitions (including the form definition) and process a query from this section.
-   */
-  namespace Query {
-    /**
-     * ***JMap.Query.initializeQueryFormById***
-     *
-     * By default attribute query forms are not fetched from server, because sometime it takes too much time.
-     *
-     * This method will fetch the query form.
-     *
-     * @param layerId the JMap layer id
-     * @param queryId the query id
-     * @example
-     * ```ts
-     * // initializes query id="layers/2/attribute-queries/3" form of layer id=2, then returns the filled query
-     * JMap.Query.initializeQueryFormById(2, "layers/2/attribute-queries/3")
-     *  .then(query => console.log("Query form has been loaded", query))
-     *  .catch(error => console.error("An error occured while loading query id='layers/2/attribute-queries/3'"))
-     * ```
-     */
-    function initializeQueryFormById(layerId: JId, queryId: string): Promise<JQuery>
-
-    /**
-     * ***JMap.Query.getAllGroups***
-     *
-     * Returns all query groups defined by JMap administrator.
-     *
-     * @example
-     * ```ts
-     * // returns all query groups defined by JMap administrator
-     * JMap.Query.getAllGroups()
-     * ```
-     */
-    function getAllGroups(): JQueryGroup[]
-
-    /**
-     * ***JMap.Query.groupExist***
-     *
-     * Returns true if group exists, else false, for the given group id.
-     *
-     * @throws if group id is not correct (invalid format or no resource exists)
-     * @param groupId The JMap query group id
-     * @example
-     * ```ts
-     * // returns true if group exists
-     * JMap.Query.groupExist(21)
-     * ```
-     */
-    function groupExist(groupId: JId): boolean
-
-    /**
-     * ***JMap.Query.queryExist***
-     *
-     * Returns true if the query exists for a given query group and a given query id.
-     *
-     * @param groupId The JMap query group id
-     * @param queryId The JMap query id
-     * @example
-     * ```ts
-     * // returns true if query id=5 of group id=10 exists
-     * JMap.Query.queryExist(10, 5)
-     * ```
-     */
-    function queryExist(groupId: JId, queryId: string): boolean
-
-    /**
-     * ***JMap.Query.getQueriesByLayerId***
-     *
-     * Returns all queries defined for a given layer id.
-     *
-     * @param layerId The JMap layer id
-     * @throws if layer id is not correct (invalid format or no resource exists)
-     * @example
-     * ```ts
-     * // returns all queries of layer id=12
-     * JMap.Query.getQueriesByLayerId(12)
-     * ```
-     */
-    function getQueriesByLayerId(layerId: JId): JQuery[]
-
-    /**
-     * ***JMap.Query.getQueryByLayerId***
-     *
-     * Returns a query for a given query id, and a given layer id.
-     *
-     * @throws if layer or query ids are not correct (invalid format or no resource exists)
-     * @param layerId The JMap layer id
-     * @param queryId The JMap query id
-     * @example
-     * ```ts
-     * // returns query id=3 of layer id=12
-     * JMap.Query.getQueryByLayerId(12, 3)
-     * ```
-     */
-    function getQueryByLayerId(layerId: JId, queryId: string): JQuery
-
-    /**
-     * ***JMap.Query.getQueriesByGroupId***
-     *
-     * Returns all queries for a given query group id.
-     *
-     * @throws if group id is not correct (invalid format or no resource exists)
-     * @param groupId The JMap query group id
-     * @example
-     * ```ts
-     * // returns all queries of group id=10
-     * JMap.Query.getQueriesByGroupId(10)
-     * ```
-     */
-    function getQueriesByGroupId(groupId: JId): JQuery[]
-
-    /**
-     * ***JMap.Query.getQueryByGroupId***
-     *
-     * Returns the query for a given query group and a given query id.
-     *
-     * @throws if group or query ids are not correct (invalid format or no resource exists)
-     * @param groupId The JMap query group id
-     * @param queryId The JMap query id
-     * @example
-     * ```ts
-     * // returns the query id=5 of group id=10
-     * JMap.Query.getQueryByGroupId(10, 5)
-     * ```
-     */
-    function getQueryByGroupId(groupId: JId, queryId: string): JQuery
-
-    /**
-     * ***JMap.Query.fetchFeatures***
-     *
-     * Process a query request to the JMap server, for given layer and query ids, and provided form data
-     *
-     * @throws if group or query ids are not correct (invalid format or no resource exists)
-     * @param layerId The JMap layer id
-     * @param queryId The JMap query id
-     * @param data The form data (values mapping the query form definition)
-     * @example
-     * ```ts
-     * // returns a promise that when resolved returns the result of the search,
-     * // an array of features, for layer id=3 and query id=5.
-     * JMap.Query
-     *   .fetchFeatures(3, 5, {
-     *    "$PARAM1": "test",
-     *    "$PARAM2": 35
-     *   })
-     *   .then(features => console.info(`Found ${features.length} features.`))
-     *   .catch(error => console.error("Error while processing query request.", error))
-     * ```
-     */
-    function fetchFeatures(layerId: JId, queryId: string, data: any): Promise<any[]> // features
-  }
-
   /**
    * **JMap.Event**
    *
@@ -7423,150 +7275,6 @@ declare namespace JMap {
       function remove(listenerId: string): void
     }
 
-    /**
-     * ***JMap.Event.Query***
-     *
-     * Here you can manage all query event listeners.
-     *
-     * Click to see all events available: ***{@link JMap.Event.Query.on}***.
-     */
-    namespace Query {
-      /**
-       * ***JMap.Event.Query.on***
-       *
-       * Here you have all JMap Cloud NG Core query events on which you can attach a listener.
-       */
-      namespace on {
-        /**
-         * ***JMap.Event.Query.on.queryFormLoad***
-         *
-         * This event is triggered when a query form has been loaded.
-         *
-         * @param listenerId Your listener id (must be unique)
-         * @param fn Your listener function
-         * @example
-         * ```ts
-         * // log a message in the console once a query form has been fetched from server.
-         * JMap.Event.Query.on.queryFormLoad(
-         *   "custom-query-form-load",
-         *   params => console.log("A query form has been loaded from server", params.query)
-         * )
-         * ```
-         */
-        function queryFormLoad(listenerId: string, fn: (params: JQueryQueryFormHasLoadedEventParams) => void): void
-
-        /**
-         * ***JMap.Event.Query.on.beforeSubmit***
-         *
-         * This event is triggered when a query is submitted, before the call to the server is made.
-         *
-         * @param listenerId Your listener id (must be unique)
-         * @param fn Your listener function
-         * @example
-         * ```ts
-         * // log a message in the console once the button submit is clicked.
-         * JMap.Event.Query.on.beforeSubmit(
-         *   "custom-query-before-submit",
-         *   params => console.log("A query to the server will be done", params)
-         * )
-         * ```
-         */
-        function beforeSubmit(listenerId: string, fn: (params: JQueryBeforeEventParams) => void): void
-
-        /**
-         * ***JMap.Event.Query.on.success***
-         *
-         * This event is triggered when a query has been processed, after the call to the server has been made.
-         *
-         * @param listenerId Your listener id (must be unique)
-         * @param fn Your listener function
-         * @example
-         * ```ts
-         * // log a message in the console once the server has responded
-         * JMap.Event.Query.on.success(
-         *   "custom-query-success",
-         *   params => console.log("A query to the server has been done", params)
-         * )
-         * ```
-         */
-        function success(listenerId: string, fn: (params: JQuerySuccessEventParams) => void): void
-
-        /**
-         * ***JMap.Event.Query.on.error***
-         *
-         * This event is triggered when a query has been processed, but an error occured.
-         *
-         * If the max result limit is reach, an error is thrown, and this event is triggered.
-         *
-         * @param listenerId Your listener id (must be unique)
-         * @param fn Your listener function
-         * @example
-         * ```ts
-         * // log a message in the console if a query error occured
-         * JMap.Event.Query.on.error(
-         *   "custom-query-error",
-         *   params => console.log("A query to the server has failed", params)
-         * )
-         * ```
-         */
-        function error(listenerId: string, fn: (params: JQueryErrorEventParams) => void): void
-      }
-
-      /**
-       * ***JMap.Event.Query.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-query-listener"
-       * JMap.Event.Query.activate("my-query-listener")
-       * ```
-       */
-      function activate(listenerId: string): void
-
-      /**
-       * ***JMap.Event.Query.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-query-listener"
-       * JMap.Event.Query.deactivate("my-query-listener")
-       * ```
-       */
-      function deactivate(listenerId: string): void
-
-      /**
-       * ***JMap.Event.Query.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-query-listener"
-       * JMap.Event.Query.remove("my-query-listener")
-       * ```
-       */
-      function remove(listenerId: string): void
-    }
-
     /**
      * ***JMap.Event.Geocoding***
      *

package/public/jmap/formJMC.d.ts

@@ -18,7 +18,7 @@ declare interface JFormSchemaPropertyJMC {
   default?: any
   minimum?: number
   maximum?: number
-  enum?: any[]
+  oneOf?: Array<{ const: string; title: string }>
 }
 
 declare const enum FORMSCHEMA_TYPES {
@@ -104,6 +104,7 @@ declare interface FormNodeVertical extends FormNodeLayout {
   type: "VerticalLayout"
   designComponent: "VerticalLayout"
   isRoot?: boolean
+  translations?: JFormTranslations
 }
 
 declare interface FormNodeHorizontal extends FormNodeLayout {
@@ -131,3 +132,7 @@ declare type FormNodesControl = FormNodeText | FormNodeNumber | FormNodeBoolean
 declare type FormNodesLayout = FormNodeVertical | FormNodeHorizontal | FormNodeGroup | FormNodeTabs | FormNodeTab
 
 declare type FormNode = FormNodesControl | FormNodesLayout | FormNodeLabel
+
+declare type JFormTranslations = {
+  [L in JLOCALES]: Record<string, string>
+}

package/public/jmap/layer.d.ts

@@ -302,7 +302,6 @@ declare interface JLayer extends JLayerTreeElement {
   styleRules: JLayerStyleRule[]
   defaultStyleRule: JLayerStyleRule | undefined
   thematics: JLayerThematic[]
-  queries: JQuery[]
   extent: JBoundaryBox | null
   permissions: JLayerPermissions
   hasAttributeForm: boolean
@@ -599,3 +598,38 @@ declare interface JLayerSetLayerGroupsExpansionParams {
   layerGroupId: JId
   open: boolean
 }
+
+declare interface JAttribute {
+  id: string
+  name: string
+  type: ATTRIBUTE_TYPES
+  indexed: boolean
+  title: JLocaleTranslation
+  valueDomain?: JValueDomain[]
+}
+
+declare enum ATTRIBUTE_TYPES {
+  TINYINT = "TINYINT",
+  SMALLINT = "SMALLINT",
+  INTEGER = "INTEGER",
+  BIGINT = "BIGINT",
+  FLOAT = "FLOAT",
+  REAL = "REAL",
+  DOUBLE = "DOUBLE",
+  NUMERIC = "NUMERIC",
+  DECIMAL = "DECIMAL",
+  CHAR = "CHAR",
+  VARCHAR = "VARCHAR",
+  LONGVARCHAR = "LONGVARCHAR",
+  DATE = "DATE",
+  TIME = "TIME",
+  TIMESTAMP = "TIMESTAMP",
+  ARRAY = "ARRAY",
+  BOOLEAN = "BOOLEAN"
+}
+
+declare interface JValueDomain {
+  value?: any
+  nullValue?: boolean
+  title: JLocaleTranslation
+}

package/public/jmap/project.d.ts

@@ -42,7 +42,6 @@ declare interface JProject {
     bing: string | null
     mapBox: string | null
   }
-  queryGroups: JQueryGroup[]
   defaultDistanceUnit: JMAP_DISTANCE_UNITS
   base64ImageThumbnail: string
   extensions: JProjectServerExtension[]

package/public/jmap/query.d.ts

@@ -1,47 +0,0 @@
-/**
- * @deprecated
- */
-declare interface JQueryGroup {
-  id: JId
-  name: string
-  queries: JQuery[]
-}
-
-/**
- * @deprecated
- */
-declare interface JQuery {
-  id: string // unique id, set by NG
-  jmapId: JId // non unique id, set by server, used to fetch query form (associate to layer id)
-  groupId: JId
-  name: string
-  layerId: JId
-  maxScale: number
-  maxResults: number
-  isInitialized: boolean
-  isLoading: boolean
-  hasLoadingError: boolean
-  formMetaData: JFormMetaData
-}
-
-declare interface JQueryBeforeEventParams {
-  id: string
-  groupId: string
-  name: string
-  layerId: JId
-  maxScale: number
-  maxResults: number
-  enteredData: any
-}
-
-declare interface JQuerySuccessEventParams extends JQueryBeforeEventParams {
-  returnedFeatures: GeoJSON.Feature[]
-}
-
-declare interface JQueryErrorEventParams extends JQueryBeforeEventParams {
-  error: string
-}
-
-declare interface JQueryQueryFormHasLoadedEventParams {
-  query: JQuery
-}