jmapcloud-ng-core-types 2.0.19 → 2.0.20-qa.2

package/all-enums.ts

@@ -67,6 +67,7 @@ export const ALL_LAYER_GEOMETRIES: JLAYER_GEOMETRIES[] = [
   JLAYER_GEOMETRIES.NONE
 ]
 
+/** @deprecated Legacy categories. New consumers read the SQL `type` (AttributeType) of JLayer.attributes. */
 export const ALL_LAYER_ATTRIBUTE_TYPES: JLAYER_ATTRIBUTE_TYPES[] = [
   JLAYER_ATTRIBUTE_TYPES.STRING,
   JLAYER_ATTRIBUTE_TYPES.NUMBER,
@@ -178,6 +179,7 @@ export const ALL_MEMBER_ROLES: MEMBER_ROLES[] = [ROLES.ORG_ADMIN, ROLES.ORG_EDIT
 
 export const ALL_APP_MESSAGE_SEVERITIES: JAPP_MESSAGE_SEVERITIES[] = [JAPP_MESSAGE_SEVERITIES.SUCCESS, JAPP_MESSAGE_SEVERITIES.INFO, JAPP_MESSAGE_SEVERITIES.WARNING, JAPP_MESSAGE_SEVERITIES.ERROR]
 
+/** @deprecated Legacy categories. New consumers read the SQL `type` (AttributeType) of JTable.attributes. */
 export const ALL_TABLE_ATTRIBUTE_TYPES: JTABLE_ATTRIBUTE_TYPES[] = [
   JTABLE_ATTRIBUTE_TYPES.BINARY,
   JTABLE_ATTRIBUTE_TYPES.BOOLEAN,

package/index.d.ts

@@ -1,7 +1,7 @@
 /// <reference path="./public/global-aliases.d.ts" />
 import type { JLocalDynamicFilter, JLocalDynamicFilterCreateParams, JLocalDynamicFilterUpdateParams } from "./public/jmap/dynamic-filter.d.ts"
 import { Feature, FeatureCollection, LineString, MultiLineString, Point, Polygon } from "geojson"
-import { JAttribute, JDataSource, JDataSourceType, JForm, JRelationship } from "jmapcloud-types"
+import { DataSourceAttribute, JDataSource, JDataSourceType, JForm, JRelationship } from "jmapcloud-types"
 import type * as maplibregl from "maplibre-gl"
 import { Action, Store } from "redux"
 import { JDataSourceData, JDataSourceDataParams, JDataSourcePermissions } from "./public/jmap/datasource.ts"
@@ -686,7 +686,9 @@ export interface JLayerService {
   setLayersMapOrder(layerIds: JId[]): void
   getVectorLayers(): JLayer[]
   getVectorLayerIds(): JId[]
+  /** @deprecated Returns legacy views. Use the layer's attributes for the shared model. */
   getLayerAttributes(layerId: JId): JLayerAttribute[]
+  /** @deprecated Returns a legacy view. Use the layer's attributes for the shared model. */
   getLayerAttribute(layerId: JId, attributeName: string): JLayerAttribute
   exists(layerId: JId): boolean
   attributeExists(layerId: JId, attributeName: string): boolean
@@ -708,11 +710,11 @@ export interface JLayerService {
   setLayerGroupExpansion(layerGroupId: JId, isExpanded: boolean): void
   setLayerGroupsExpansion(params: JLayerSetLayerGroupsExpansionParams[]): void
   deleteLayer(layerId: JId): void
-  getDataSourceAttributes(layerId: JId): Promise<JAttribute[]>
+  getDataSourceAttributes(layerId: JId): Promise<DataSourceAttribute[]>
 }
 
 export interface JDataSourceService {
-  getAttributes(dataSourceId: JId, dataSourceOrganizationId: string): Promise<JAttribute[]>
+  getAttributes(dataSourceId: JId, dataSourceOrganizationId: string): Promise<DataSourceAttribute[]>
   getById(dataSourceId: JId, dataSourceOrganizationId: string): Promise<JDataSource>
   getData(dataSourceId: JId, dataSourceOrganizationId: string, params: JDataSourceDataParams, dataSourceType?: JDataSourceType): Promise<JDataSourceData>
   getPermissions(dataSourceId: JId, dataSourceOrganizationId: string): Promise<JDataSourcePermissions>
@@ -734,7 +736,7 @@ export interface JTableService {
   createRow(tableId: JId, row: { [key: string]: any }): Promise<{ id: JId; links: Array<any> }>
   updateRow(tableId: JId, rowId: number, row: { [key: string]: any }): Promise<void>
   deleteRow(tableId: JId, rowId: number): Promise<void>
-  getDataSourceAttributes(tableId: JId): Promise<JAttribute[]>
+  getDataSourceAttributes(tableId: JId): Promise<DataSourceAttribute[]>
   /** @deprecated Use DynamicFilter.setIsActive instead. */
   setDynamicFilterActive(tableId: JId, filterId: string, isActive: boolean): void
 }

package/package.json

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

@@ -1,5 +1,5 @@
 import type { JLocalDynamicFilter, JLocalDynamicFilterCreateParams, JLocalDynamicFilterUpdateParams } from "./jmap/dynamic-filter.d.ts"
-import { JAttribute, JDataSource, JRelationship } from "jmapcloud-types"
+import { DataSourceAttribute, JDataSource, JRelationship } from "jmapcloud-types"
 import type { Action, Store } from "redux"
 import type { JRequestConfig } from "./jmap/ajax.d.ts"
 import type { JAttachment, JAttachmentFile, JCreateAttachmentParams, JUpdateAttachmentParams } from "./jmap/attachment.d.ts"
@@ -1017,10 +1017,11 @@ export namespace JMap {
        *   if (!layer) {
        *     return
        *   }
-       *   const layerAttribute = layer.attributes.find(la => la.name === "nom_qr")
-       *   if (!layerAttribute) {
+       *   if (!layer.attributes.some(la => la.name === "nom_qr")) {
        *     return
        *   }
+       *   // condition expressions take the legacy attribute view, not a layer.attributes element
+       *   const layerAttribute = JMap.Layer.getLayerAttribute(layer.id, "nom_qr")
        *   const layerId = layer.id
        *   const styles = []
        *   const condition1StyleId = "8ae59ba6-0b0b-4a5e-8f8e-5b138bd53767"
@@ -1701,6 +1702,7 @@ export namespace JMap {
      *  // returns the layer attribute descriptor
      *  JMap.Layer.getLayerAttribute(4, "SPECIES")
      * ```
+     * @deprecated Returns a legacy compatibility view. Use getById(layerId)'s attributes for the shared model.
      */
     function getLayerAttribute(layerId: JId, attributeName: string): JLayerAttribute
     /**
@@ -1714,6 +1716,7 @@ export namespace JMap {
      * ```ts
      *  JMap.Layer.getLayerAttributes(4)
      * ```
+     * @deprecated Returns legacy compatibility views. Use getById(layerId)'s attributes for the shared model.
      */
     function getLayerAttributes(layerId: JId): JLayerAttribute[]
     /**
@@ -2067,7 +2070,7 @@ export namespace JMap {
      *  .getDataSourceAttributes(3)
      * ```
      **/
-    function getDataSourceAttributes(layerId: JId): Promise<JAttribute[]>
+    function getDataSourceAttributes(layerId: JId): Promise<DataSourceAttribute[]>
   }
   /**
    * **JMap.Geometry**
@@ -9619,7 +9622,7 @@ export namespace JMap {
      * JMap.DataSource.getAttributes("be4552e1-d89d-48ec-a417-7b99d14b4d7b")
      * ```
      **/
-    function getAttributes(dataSourceId: JId, dataSourceOrganizationId: string): Promise<JAttribute[]>
+    function getAttributes(dataSourceId: JId, dataSourceOrganizationId: string): Promise<DataSourceAttribute[]>
 
     /**
      * **JMap.DataSource.getById**
@@ -11304,7 +11307,7 @@ export namespace JMap {
      * JMap.Table.getDataSourceAttributes("be4552e1-d89d-48ec-a417-7b99d14b4d7b")
      * ```
      **/
-    function getDataSourceAttributes(tableId: JId): Promise<JAttribute[]>
+    function getDataSourceAttributes(tableId: JId): Promise<DataSourceAttribute[]>
     /**
      * **JMap.Table.DynamicFilter**
      *

package/public/jmap/layer.d.ts

@@ -1,5 +1,5 @@
 import type { JLocalDynamicFilter } from "./dynamic-filter.d.ts"
-import type { JAnyFilterCondition, JAttribute, UserMetadata } from "jmapcloud-types"
+import type { DataSourceAttribute, JAnyFilterCondition, LayerAttribute, UserMetadata } from "jmapcloud-types"
 import type { JBoundaryBox } from "./geometry.d.ts"
 import type { JId } from "./main.d.ts"
 import type { JMapMouseOver } from "./mouseover.d.ts"
@@ -45,6 +45,7 @@ export enum JLAYER_GEOMETRIES {
 }
 
 // ALL_LAYER_ATTRIBUTE_TYPES in all-enum.ts
+/** @deprecated Simplified legacy categories. New consumers read the SQL `type` (AttributeType) of JLayer.attributes. */
 export enum JLAYER_ATTRIBUTE_TYPES {
   STRING = "string",
   NUMBER = "number",
@@ -256,8 +257,8 @@ export interface JLayer extends JLayerTreeElement {
   defaultMetadatas: JLayerMetadata[]
   metadataSections: JLayerMetadataSection[]
   userMetadata: UserMetadata<string>[]
-  attributes: JLayerAttribute[]
-  JMCAttributes: JAttribute[]
+  /** Canonical target attributes, in configured order, including hidden attributes. Titles are localized. */
+  attributes: LayerAttribute<string>[]
   mouseOver: JMapMouseOver
   minimumZoom: number | undefined
   maximumZoom: number | undefined
@@ -274,7 +275,7 @@ export interface JLayer extends JLayerTreeElement {
   forms: JLayerForm[]
   spatialDataSourceId: string
   spatialDataSourceOrganizationId: string
-  spatialDataSourceAttributes: JAttribute[] | null
+  spatialDataSourceAttributes: DataSourceAttribute[] | null
   selectionStyleId: string
   dynamicFilters: JLocalDynamicFilter[]
   allowClientSideEditing: boolean
@@ -287,12 +288,14 @@ export interface JLayerForm {
   name: string
 }
 
+/** @deprecated Legacy public view; use the shared LayerAttribute model for new consumers. */
 export interface JLayerAttribute {
   id: string
   name: string
   label: string
   indexed: boolean
   type: JLAYER_ATTRIBUTE_TYPES
+  visible: boolean
 }
 
 export interface JLayerTreeElement {
@@ -415,6 +418,11 @@ export interface JLayerStyleRuleConditionExpression {
   id: string
   operator: JLAYER_STYLE_RULE_CONDITION_EXPRESSION_OPERATORS
   value: any
+  /**
+   * @deprecated Legacy style-rule input, retained for existing public callers.
+   * New metadata consumers should read LayerAttribute from JLayer.attributes;
+   * this input still requires the compatibility view returned by Layer.getLayerAttribute.
+   */
   attribute: JLayerAttribute
 }
 
@@ -528,6 +536,7 @@ export interface JLayerSetLayerGroupsExpansionParams {
   open: boolean
 }
 
+/** @deprecated Legacy SQL enum subset. Use the shared AttributeType SQL union for new consumers. */
 export enum ATTRIBUTE_TYPES {
   TINYINT = "TINYINT",
   SMALLINT = "SMALLINT",

package/public/jmap/table.d.ts

@@ -1,8 +1,9 @@
 import type { JLocalDynamicFilter } from "./dynamic-filter.d.ts"
-import type { JAnyFilterCondition, JAttribute, AttributeType } from "jmapcloud-types"
+import type { AttributeType, DataSourceAttribute, JAnyFilterCondition, TableAttribute } from "jmapcloud-types"
 import type { JLocaleTranslation } from "./language.d.ts"
 export {}
 // ALL_TABLE_ATTRIBUTE_TYPES in all-enum.ts
+/** @deprecated Simplified legacy categories. New consumers read the SQL `type` (AttributeType) of JTable.attributes. */
 export enum JTABLE_ATTRIBUTE_TYPES {
   STRING = "string",
   NUMBER = "number",
@@ -20,8 +21,9 @@ export interface JTable {
   id: string
   projectId: string
   name: string
-  attributes: JAttribute[]
-  dataSourceAttributes: JAttribute[] | null
+  /** Canonical target attributes, in configured order, including hidden attributes. Titles are localized. */
+  attributes: TableAttribute<string>[]
+  dataSourceAttributes: DataSourceAttribute[] | null
   listed: boolean
   description: JLocaleTranslation
   dataSourceId: string
@@ -32,6 +34,7 @@ export interface JTable {
   dynamicFilters: JLocalDynamicFilter[]
 }
 
+/** @deprecated Legacy public view; use the shared TableAttribute model for new consumers. */
 export interface JTableAttribute {
   id: string
   name: string
@@ -39,6 +42,7 @@ export interface JTableAttribute {
   label: string
   type: AttributeType
   indexed: boolean
+  visible: boolean
 }
 
 export interface JTableData {