jmapcloud-ng-core-types 1.1.10 → 1.1.12

package/all-enums.ts

@@ -314,3 +314,12 @@ export const ALL_ROLES: ROLES[] = [
 ]
 
 export const ALL_MEMBER_ROLES: MEMBER_ROLES[] = [ROLES.ORG_ADMIN, ROLES.ORG_EDITOR, ROLES.ORG_VIEWER]
+
+export const ALL_TABLE_ATTRIBUTE_TYPES: JTABLE_ATTRIBUTE_TYPES[] = [
+  JTABLE_ATTRIBUTE_TYPES.BINARY,
+  JTABLE_ATTRIBUTE_TYPES.BOOLEAN,
+  JTABLE_ATTRIBUTE_TYPES.DATE,
+  JTABLE_ATTRIBUTE_TYPES.DATETIME,
+  JTABLE_ATTRIBUTE_TYPES.NUMBER,
+  JTABLE_ATTRIBUTE_TYPES.STRING
+]

package/index.ts

@@ -146,7 +146,7 @@ export interface JPhotoService {
 }
 
 export interface JFeatureService {
-  getById(layerId: JId, featureId: JId): Promise<GeoJSON.Feature>
+  getById(layerId: JId, featureId: JId, includeAllAttributes?: boolean): Promise<GeoJSON.Feature>
   getByIds(layerId: JId, featureIds: JId[]): Promise<GeoJSON.Feature[]>
   getByLayerId(layerId: JId, bbox: JBoundaryBox): Promise<GeoJSON.Feature[]>
   geometryUpdateById(params: JFeatureGeometryUpdateParams): Promise<GeoJSON.Feature>
@@ -566,8 +566,7 @@ export interface JServerState extends JServerInfo {
 export type JHistoryListener = (oldValue: string | undefined, newValue: string | undefined) => void
 
 export interface JFormJMCService {
-  getJsonForm(dataSourceId: string): Promise<JJsonFormSchemas>
-  getForm(layerId: string): Promise<JFormJMC>
+  getForm(dataSourceId: string): Promise<JFormJMC | null>
 }
 
 export interface JFormService {
@@ -892,16 +891,17 @@ export interface JLayerService {
   deleteLayer(layerId: JId): void
   hasInformationReport(layerId: JId): boolean
   openInformationReportInNewTab(layerId: JId, featureIds: JId[]): Promise<string>
-  getDataSourceAttributes(dataSourceId: JId): Promise<JAttribute[]>
+  getDataSourceAttributes(layerId: JId): Promise<JDataSourceAttribute[]>
 }
 
 export interface JTableService {
   getTables(): JTable[]
-  getTableData(dataSourceId: JId, params: JTableDataParams): Promise<JTableData>
+  getTableData(tableId: JId, params: JTableDataParams): Promise<JTableData>
   getById(tableId: JId): JTable
-  createRow(dataSourceId: JId, row: { [key: string]: any }): Promise<void>
-  updateRow(dataSourceId: JId, rowId: number, row: { [key: string]: any }): Promise<void>
-  deleteRow(dataSourceId: JId, rowId: number): Promise<void>
+  createRow(tableId: JId, row: { [key: string]: any }): Promise<void>
+  updateRow(tableId: JId, rowId: number, row: { [key: string]: any }): Promise<void>
+  deleteRow(tableId: JId, rowId: number): Promise<void>
+  getDataSourceAttributes(tableId: JId): Promise<JDataSourceAttribute[]>
 }
 
 export interface JLayerSearchService {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jmapcloud-ng-core-types",
-  "version": "1.1.10",
+  "version": "1.1.12",
   "description": "JMap Cloud specific version of JMap Cloud NG Core types and interfaces",
   "main": "index.js",
   "scripts": {
@@ -25,8 +25,7 @@
   },
   "homepage": "https://github.com/k2geospatial/jmapcloud-ng-core-types#readme",
   "devDependencies": {
-    "typedoc": "^0.25.13",
-    "patch-package": "^8.0.0"
+    "typedoc": "^0.25.13"
   },
   "dependencies": {
     "@auth0/auth0-spa-js": "^2.1.3",

package/public/core.d.ts

@@ -443,6 +443,7 @@ declare namespace JMap {
      *
      * @param layerId the JMap layer id
      * @param featureId the JMap feature id
+     * @param includeAllAttributes true to include all the attributes even the one not bounded to the layer
      * @throws if layer or feature not found
      * @example
      * ```ts
@@ -453,7 +454,7 @@ declare namespace JMap {
      *  .catch(error => console.error("An error occured", error))
      * ```
      */
-    function getById(layerId: JId, featureId: JId): Promise<GeoJSON.Feature>
+    function getById(layerId: JId, featureId: JId, includeAllAttributes?: boolean): Promise<GeoJSON.Feature>
 
     /**
      * **JMap.Feature.getByLayerId**
@@ -2421,18 +2422,18 @@ declare namespace JMap {
     /**
      * **JMap.Layer.getDataSourceAttributes**
      *
-     * Returns attributes, for a given dataSource.
+     * Returns the attributes of the associated datasource, for a given layer.
      *
-     * @param dataSourceId the JMap dataSource id
-     * @throws if dataSourceId not valid or dataSource not found
+     * @param layerId the JMap layer id
+     * @throws if layerId not valid or dataSource not found
      * @example
      * ```ts
-     * // Returns attributes, for dataSource id=3
+     * // Returns datasource attributes, for layer id=3
      * JMap.Layer
      *  .getDataSourceAttributes(3)
      * ```
      **/
-    function getDataSourceAttributes(dataSourceId: JId): Promise<JAttribute[]>
+    function getDataSourceAttributes(layerId: JId): Promise<JDataSourceAttribute[]>
   }
 
   /**
@@ -5745,8 +5746,8 @@ declare namespace JMap {
      *    .getAllProjects()
      *    .then(projects => {
      *      // Here you can start using the projects
-     *      console.log(`Projects count = "${projects.length}"`
-     *    }))
+     *      console.log(`Projects count = "${projects.length}"`)
+     *    })
      * ```
      */
     function getAllProjects(): Promise<JProject[]>
@@ -9990,45 +9991,24 @@ declare namespace JMap {
    * Here you'll find all form related methods
    */
   namespace FormJMC {
-    /**
-     * ***JMap.FormJMC.getJsonForm***
-     *
-     * Returns the jsonForm schema and uiSchema for a data source.
-     *
-     * fetch the attributes of a data source and then builds and returns the schema and uiSchema required for jsonForms. The schemas will be null if there is no attributes on the data source
-     *
-     * @param dataSourceId the JMap data source id
-     * @example
-     * ```ts
-     * // returns the schema and uiSchema for data source id=f47ac10b-58cc-4372-a567-0e02b2c3d479
-
-
-     * JMap.FormJMC
-     *  .getJsonForm("f47ac10b-58cc-4372-a567-0e02b2c3d479")
-     *  .then(schemas => console.log("jsonForms schemas of data source f47ac10b-58cc-4372-a567-0e02b2c3d479", schemas))
-     *  .catch(error => console.error("An error occurred when getting jsonForm schema", error))
-     * ```
-     */
-    function getJsonForm(dataSourceId: JId): Promise<JJsonFormSchemas>
-
     /**
      * ***JMap.FormJMC.getForm***
      *
-     * Returns the form for a layer.
+     * Returns the form for a data source.
      *
-     * @param layerId the JMap layer id
+     * @param dataSourceId the JMap data source id
      * @example
      * ```ts
-     * // returns the form for layer id=f47ac10b-58cc-4372-a567-0e02b2c3d479
+     * // returns the form for data source id=f47ac10b-58cc-4372-a567-0e02b2c3d479
 
 
      * JMap.FormJMC
      *  .getForm("f47ac10b-58cc-4372-a567-0e02b2c3d479")
-     *  .then(form => console.log("form  of layer f47ac10b-58cc-4372-a567-0e02b2c3d479", form))
-     *  .catch(error => console.error("An error occurred when getting the form for layer f47ac10b-58cc-4372-a567-0e02b2c3d479", error))
+     *  .then(form => console.log("form  of data source f47ac10b-58cc-4372-a567-0e02b2c3d479", form))
+     *  .catch(error => console.error("An error occurred when getting the form for data source f47ac10b-58cc-4372-a567-0e02b2c3d479", error))
      * ```
      */
-    function getForm(layerId: JId): Promise<JFormJMC>
+    function getForm(dataSourceId: JId): Promise<JFormJMC | null>
   }
   /**
    * **JMap.Form**
@@ -12493,11 +12473,11 @@ declare namespace JMap {
     /**
      * **JMap.Table.getTableData**
      *
-     * Asynchronously retrieves the JMap table data for a specified tabular data source ID.
+     * Asynchronously retrieves the JMap table data for a specified ID.
      *
      * @throws {Error} If no data source is found for the given ID.
      *
-     * @param {JId} dataSourceId - The ID of the JMap data source.
+     * @param {JId} tableId - The ID of the JMap Table.
      * @param {JTableDataParams} params - Includes the following optional parameters: startIndex, limit, filter, sort.
      * startIndex: The starting index for data retrieval (zero-based).
      * limit: The maximum number of records to retrieve.
@@ -12516,7 +12496,7 @@ declare namespace JMap {
      * });
      * ```
      */
-    function getTableData(dataSourceId: JId, params: JTableDataParams): Promise<JTableData>
+    function getTableData(tableId: JId, params: JTableDataParams): Promise<JTableData>
 
     /**
      * **JMap.Table.getById**
@@ -12538,7 +12518,7 @@ declare namespace JMap {
      *
      * Create a row from a table
      *
-     * @param {JId} dataSourceId - The Id of the data source.
+     * @param {JId} tableId - The Id of the table.
      * @param {{ [key: string]: any }} row - the data of the row to be updated.
      *
      * @returns {Promise<void>}
@@ -12549,14 +12529,14 @@ declare namespace JMap {
      * JMap.Table.createRow("be4552e1-d89d-48ec-a417-7b99d14b4d7b", {city: "Montreal", country: "Canada"});
      * ```
      */
-    function createRow(dataSourceId: JId, row: { [key: string]: any }): Promise<void>
+    function createRow(tableId: JId, row: { [key: string]: any }): Promise<void>
 
     /**
      * **JMap.Table.updateRow**
      *
      * Update a row from a table
      *
-     * @param {JId} dataSourceId - The ID of the data source.
+     * @param {JId} tableId - The ID of the table.
      * @param {number} rowId - Id of the row to be updated.
      * @param {{ [key: string]: any }} row - the data of the row to be updated.
      *
@@ -12568,15 +12548,15 @@ declare namespace JMap {
      * JMap.Table.updateRow("be4552e1-d89d-48ec-a417-7b99d14b4d7b", 3086627, {city: "Montreal", country: "Canada"});
      * ```
      */
-    function updateRow(dataSourceId: JId, rowId: number, row: { [key: string]: any }): Promise<void>
+    function updateRow(tableId: JId, rowId: number, row: { [key: string]: any }): Promise<void>
 
     /**
      * **JMap.Table.deleteRow**
      *
      * Delete a row from a table
      *
-     * @param {JId} dataSourceId - The ID of the JMap data source.
-     * @param {number} rowId - Id of the row to be updated.
+     * @param {JId} tableId - The ID of the table.
+     * @param {number} rowId - Id of the row to be deleted.
      *
      * @returns {Promise<void>}
      *
@@ -12586,6 +12566,21 @@ declare namespace JMap {
      * JMap.Table.deleteRow("be4552e1-d89d-48ec-a417-7b99d14b4d7b", 3086627);
      * ```
      */
-    function deleteRow(dataSourceId: JId, rowId: number): Promise<void>
+    function deleteRow(tableId: JId, rowId: number): Promise<void>
+
+    /**
+     * **JMap.Table.getDataSourceAttributes**
+     *
+     * Returns the attributes of the associated datasource, for a given table.
+     *
+     * @param tableId the table
+     * @throws if tableId not valid or dataSource not found
+     * @example
+     * ```ts
+     * // Returns datasource attributes, for table id="be4552e1-d89d-48ec-a417-7b99d14b4d7b"
+     * JMap.Table.getDataSourceAttributes("be4552e1-d89d-48ec-a417-7b99d14b4d7b")
+     * ```
+     **/
+    function getDataSourceAttributes(tableId: JId): Promise<JDataSourceAttribute[]>
   }
 }

package/public/jmap/datasource.ts

@@ -0,0 +1,8 @@
+declare interface JDataSourceAttribute {
+  id: string
+  name: string
+  type: ATTRIBUTE_TYPES
+  indexed: boolean
+  title: JLocaleTranslation
+  valueDomain?: JValueDomain[]
+}

package/public/jmap/formJMC.d.ts

@@ -18,7 +18,7 @@ declare interface JFormSchemaPropertyJMC {
   default?: any
   minimum?: number
   maximum?: number
-  oneOf?: Array<{ const: string; title: string }>
+  oneOf?: Array<{ const: string; title: string | undefined }>
 }
 
 declare const enum FORMSCHEMA_TYPES {
@@ -102,14 +102,14 @@ declare interface FormNodeLayout extends FormNodeBase {
 
 declare interface FormNodeVertical extends FormNodeLayout {
   type: "VerticalLayout"
-  designComponent: "VerticalLayout"
+  designComponent: "Column"
   isRoot?: boolean
   translations?: JFormTranslations
 }
 
 declare interface FormNodeHorizontal extends FormNodeLayout {
   type: "HorizontalLayout"
-  designComponent: "HorizontalLayout"
+  designComponent: "Row"
 }
 declare interface FormNodeGroup extends FormNodeLayout {
   type: "Group"

package/public/jmap/layer.d.ts

@@ -314,6 +314,7 @@ declare interface JLayer extends JLayerTreeElement {
   hasInformationReport: boolean
   informationReports: JLayerInformationReport[]
   spatialDataSourceId: string
+  spatialDataSourceAttributes: JDataSourceAttribute[] | null
   selectionStyleId: string
   dynamicFilter: JDynamicFilter
   allowClientSideEditing: boolean

package/public/jmap/table.d.ts

@@ -1,14 +1,40 @@
+// ALL_TABLE_ATTRIBUTE_TYPES in all-enum.ts
+declare const enum JTABLE_ATTRIBUTE_TYPES {
+  STRING = "string",
+  NUMBER = "number",
+  DATE = "date",
+  DATETIME = "datetime",
+  BOOLEAN = "boolean",
+  BINARY = "binary"
+}
+
+declare interface JServerTable extends Omit<JTable, "permissions"> {
+  permissions: keyof JTablePermissions
+}
+
 declare interface JTable {
   id: string
   organizationId: string
   projectId: string
   name: string
+  attributes: JTableAttribute[]
+  dataSourceAttributes: JDataSourceAttribute[] | null
+  listed: boolean
   description: JLocaleTranslation
   dataSourceId: string
   allowClientSideEditing: boolean
   permissions: JTablePermissions
 }
 
+declare interface JTableAttribute {
+  id: string
+  name: string
+  title: string
+  label: string
+  type: JTABLE_ATTRIBUTE_TYPES
+  indexed: boolean
+}
+
 declare interface JTableData {
   columns: string[]
   links: Array<{ href: string; rel: string; title: string; type: string }>