jmapcloud-ng-core-types 2.0.12 → 2.0.13-qa.10

package/index.d.ts

@@ -4,7 +4,7 @@ import { JAttribute, JDataSource, JDataSourceType, JForm as JFormJMC, JRelations
 import type * as maplibregl from "maplibre-gl"
 import { Action, Store } from "redux"
 import { JDataSourceData, JDataSourceDataParams, JDataSourcePermissions } from "./public/jmap/datasource.ts"
-import type { JCoreState } from "./public/state.d.ts"
+import type { JCoreState, JMapLegendMode } from "./public/state.d.ts"
 
 export type { JCoreOptions } from "./public/jmap/startup-options.d.ts"
 export type {
@@ -12,9 +12,11 @@ export type {
   JFormState,
   JGeocodingState,
   JGeolocationState,
+  JLegendState,
   JLanguageState,
   JLayerState,
   JMapContextState,
+  JMapLegendMode,
   JMapState,
   JProjectState,
   JServerState,
@@ -23,7 +25,7 @@ export type {
   JUIState,
   JUserState
 } from "./public/state.d.ts"
-export type { JAppConfirmMessage, JAppMessage, JAppMessageOptions, JAppMessageService, JAppMessageState, JAppOverlayMessage } from "./public/jmap/message.d.ts"
+export type { JAppConfirmMessage, JAppMessage, JAppMessageOptions, JAppMessageService, JAppMessageState, JAppOverlayMessage, JAppRenderableMessage } from "./public/jmap/message.d.ts"
 export type { JAppUserAction } from "./public/jmap/user.d.ts"
 
 export interface JCoreService extends JCoreMainService {
@@ -521,6 +523,7 @@ export interface JMapService {
   Selection: JMapSelectionService
   Basemap: JMapBasemapService
   Attribution: JMapAttributionService
+  Legend: JMapLegendService
   getMap(): maplibregl.Map
   getMapJSLib(): any
   getDomContainerId(): string
@@ -610,6 +613,14 @@ export interface JMapService {
   getPixelRatio(): number
 }
 
+export interface JMapLegendService {
+  getVisible(): boolean
+  isControlVisible(): boolean
+  setControlVisibility(isVisible: boolean): void
+  setMode(mode: JMapLegendMode): void
+  setVisible(isVisible: boolean): void
+}
+
 export interface JMapBasemapService {
   getAllIds(): string[]
   isActive(): boolean

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "jmapcloud-ng-core-types",
-  "version": "2.0.12",
+  "version": "2.0.13-qa.10",
   "description": "JMap Cloud specific version of JMap Cloud NG Core types and interfaces",
   "main": "index.js",
   "types": "ambient.d.ts",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "update-types-bridge": "node build/codemod-export-globals.js && node build/auto-add-imports.js && node build/generate-ambient.js && npx prettier --write public/global-aliases.d.ts ambient.d.ts",
+    "update-types-bridge": "node build/codemod-export-globals.js && node build/auto-add-imports.js && node build/generate-ambient.js && node ../../../node_modules/prettier/bin/prettier.cjs --write public/global-aliases.d.ts ambient.d.ts",
     "pub-github": "npm run update-types-bridge && node build/buildfile.js publish-github;",
     "doc-test": "npm run update-types-bridge && node build/buildfile.js doc-test;"
   },

package/public/core.d.ts

@@ -128,7 +128,7 @@ import type { JSimpleSearchErrorEventParams, JSimpleSearchSuccessEventParams } f
 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"
-import type { JCoreState } from "./state.d.ts"
+import type { JCoreState, JMapLegendMode } from "./state.d.ts"
 export {}
 /**
  * This is the JMap Cloud NG Core library API documentation.
@@ -4356,6 +4356,74 @@ export namespace JMap {
      *
      */
     function getPixelRatio(): number
+    /**
+     * **JMap.Map.Legend**
+     *
+     * This section contains map legend related methods.
+     */
+    namespace Legend {
+      /**
+       * **JMap.Map.Legend.getVisible**
+       *
+       * Returns whether the map legend is currently visible.
+       *
+       * @example
+       * ```ts
+       * JMap.Map.Legend.getVisible()
+       * ```
+       */
+      function getVisible(): boolean
+      /**
+       * **JMap.Map.Legend.isControlVisible**
+       *
+       * Returns true if the legend button is visible on the map.
+       *
+       * @example
+       * ```ts
+       * JMap.Map.Legend.isControlVisible()
+       * ```
+       */
+      function isControlVisible(): boolean
+      /**
+       * **JMap.Map.Legend.setControlVisibility**
+       *
+       * Changes the legend button visibility on the map.
+       *
+       * @param isVisible true to display the legend button, false to hide
+       * @example
+       * ```ts
+       * JMap.Map.Legend.setControlVisibility(true)
+       * JMap.Map.Legend.setControlVisibility(false)
+       * ```
+       */
+      function setControlVisibility(isVisible: boolean): void
+      /**
+       * **JMap.Map.Legend.setMode**
+       *
+       * Changes the map legend mode.
+       *
+       * @param mode `"dynamic"` to only show what is currently visible on the map, `"static"` to always show all legend-enabled layers
+       * @example
+       * ```ts
+       * JMap.Map.Legend.setMode("dynamic")
+       * JMap.Map.Legend.setMode("static")
+       * ```
+       */
+      function setMode(mode: JMapLegendMode): void
+      /**
+       * **JMap.Map.Legend.setVisible**
+       *
+       * Changes the map legend visibility.
+       *
+       * @param isVisible true to display the legend, false to hide it
+       * @example
+       * ```ts
+       * JMap.Map.Legend.setVisible(true)
+       * JMap.Map.Legend.setVisible(false)
+       * ```
+       */
+      function setVisible(isVisible: boolean): void
+    }
     /**
      * **JMap.Map.resetRasterLayerTransparency**
      *

package/public/global-aliases.d.ts

@@ -364,6 +364,7 @@ declare global {
   /** @internal */ const MESSAGE_ACTION_TYPES: typeof message.MESSAGE_ACTION_TYPES
   /** @internal */ type JAppMessage = message.JAppMessage
   /** @internal */ type JAppOverlayMessage = message.JAppOverlayMessage
+  /** @internal */ type JAppRenderableMessage = message.JAppRenderableMessage
   /** @internal */ type JAppConfirmMessage = message.JAppConfirmMessage
   /** @internal */ type JAppMessageOptions = message.JAppMessageOptions
   /** @internal */ type JAppMessageState = message.JAppMessageState

package/public/jmap/layer.d.ts

@@ -330,6 +330,7 @@ export interface JLayer extends JLayerTreeElement {
   // TODO JMAP8-3266 : use a localized type instad of a graphQL one
   dynamicFilters: JDynamicFilterGraphQL[]
   allowClientSideEditing: boolean
+  includeInLegend: boolean
   baseFilter?: JAnyFilterCondition
 }
 

package/public/jmap/map.d.ts

@@ -397,6 +397,18 @@ export interface JCoreMapOptions {
    * ```
    */
   navigationHistoryControlVisible?: boolean
+  /**
+   * By default the legend button is visible on the map.
+   *
+   * But if ***legendControlVisible*** is false, it will be hidden on the map.
+   */
+  legendControlVisible?: boolean
+  /**
+   * By default the legend panel is hidden.
+   *
+   * But if ***legendVisible*** is true, it will be displayed on startup.
+   */
+  legendVisible?: boolean
   /**
    * By default the scale control panel is visible.
    *

package/public/jmap/message.d.ts

@@ -1,4 +1,5 @@
 import type { JLOCALES } from "./language.d.ts"
+import type { ReactNode } from "react"
 export {}
 
 // ALL_APP_MESSAGE_SEVERITIES in all-enums.ts
@@ -33,8 +34,59 @@ export interface JAppOverlayMessage {
   text: string
 }
 
+/**
+ * Explicit message content modes for NG.
+ *
+ * Three explicit content modes are supported:
+ *
+ * 1. Plain text
+ *    `{ kind: "text", value: "Delete project foo?" }`
+ *    Render as inert text with no HTML interpretation.
+ *
+ * 2. Sanitized HTML
+ *    `{ kind: "html", value: "Delete <b>foo</b>?<br>Please confirm.", policy: "dialog" }`
+ *    Use only when intentionally rendering an HTML string. The renderer must
+ *    sanitize the string before display. This is especially useful for
+ *    translated rich messages, for example:
+ *    `{ kind: "html", value: JMap.Language.translate("project.delete.message", { projectName: "<b>My project</b>" }), policy: "dialog" }`
+ *
+ * 3. React node / JSX
+ *    `{ kind: "node", value: <>Delete <strong>{project.name}</strong>?</> }`
+ *    Preferred when formatting is needed, because React escapes interpolated
+ *    values automatically and avoids raw HTML string construction.
+ */
+export type JAppRenderableMessage =
+  | {
+      kind: "html"
+      policy?: "dialog" | "presentation"
+      value: string
+    }
+  | {
+      kind: "node"
+      value: ReactNode
+    }
+  | {
+      kind: "text"
+      value: string
+    }
+
 export interface JAppConfirmMessage {
-  message: string
+  /**
+   * Bare `string` means plain text by default.
+   *
+   * Explicit rich-content forms are:
+   * - `{ kind: "text", value }` for plain text
+   * - `{ kind: "html", value, policy }` for intentionally rich HTML that must
+   *   be sanitized by the renderer, for example a rich message produced by
+   *   `JMap.Language.translate(...)`
+   * - `{ kind: "node", value }` for JSX / ReactNode content
+   *
+   * Guidance:
+   * - default to plain text
+   * - prefer `node` when formatting is needed
+   * - use `html` only for legacy / translated HTML-string flows
+   */
+  message: JAppRenderableMessage | string
   title: string
   isInputMessage?: boolean
   isInputOptional?: boolean
@@ -58,6 +110,20 @@ export interface JAppMessageState {
 }
 
 export interface JAppMessageService {
+  /**
+   * Confirm message content supports three intended modes:
+   *
+   * - plain text:
+   *   `message: "Delete project foo?"`
+   *
+   * - sanitized HTML string:
+   *   `message: { kind: "html", value: "Delete <b>foo</b>?", policy: "dialog" }`
+   *
+   * - JSX / ReactNode:
+   *   `message: { kind: "node", value: <>Delete <strong>{project.name}</strong>?</> }`
+   *
+   * Plain text is the default.
+   */
   error(message: string, options?: JAppMessageOptions): void
   warning(message: string, options?: JAppMessageOptions): void
   info(message: string, options?: JAppMessageOptions): void

package/public/state.d.ts

@@ -19,6 +19,7 @@ export interface JCoreState {
   map: JMapState
   project: JProjectState
   layer: JLayerState
+  legend: JLegendState
   table: JTableState
   user: JUserState
   language: JLanguageState
@@ -98,6 +99,16 @@ export interface JGeolocationState {
   currentLocation: JLocation | undefined
 }
 
+export type JMapLegendMode = "dynamic" | "static"
+
+export interface JLegendState {
+  height: string
+  mode: JMapLegendMode
+  position: JLocation
+  visible: boolean
+  width: string
+}
+
 export interface JMapState {
   pitch: number
   rotation: number
@@ -122,6 +133,7 @@ export interface JMapState {
   isTerrainActive: boolean
   isScaleControlVisible: boolean
   isInitialExtentControlVisible: boolean
+  isLegendControlVisible: boolean
   isMapRotationControlVisible: boolean
   isTerrainControlVisible: boolean
   isMapInfoControlVisible: boolean