@sap/ux-specification 1.120.36 → 1.120.38

package/dist/schemas/v2/ApplicationV2.json

@@ -31,7 +31,7 @@
         },
         "flexibleColumnLayout": {
           "$ref": "#/definitions/FlexibleColumnLayout",
-          "description": "The flexible column layout allows users to see more details on the page, and to expand and collapse the screen areas. For the overview page, this layout is not relevant."
+          "description": "The flexible column layout allows users to see more details on the page, and to expand and collapse the screen areas."
         },
         "tableColumnVerticalAlignment": {
           "$ref": "#/definitions/TableColumnVerticalAlignment",
@@ -68,6 +68,7 @@
       "additionalProperties": false
     },
     "FlexibleColumnLayout": {
+      "descriptionSrcURL": "https://ui5.sap.com/sdk/#/topic/e762257125b34513b0859faa1610b09e",
       "type": "object",
       "properties": {
         "defaultTwoColumnLayoutType": {

package/dist/schemas/v2/ListReportNewConfig.json

@@ -0,0 +1,16 @@
+{
+  "type": "object",
+  "properties": {
+    "fitContent": {
+      "description": "Set fitContent to true to optimize the dynamic page responsiveness on small screens and behavior when the DynamicPageHeader is expanded or collapsed.",
+      "type": "boolean",
+      "artifactType": "FlexChange",
+      "controlType": "sap.f.DynamicPage"
+    },
+    "$schema": {
+      "type": "string"
+    }
+  },
+  "additionalProperties": false,
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/dist/schemas/v4/ApplicationV4.json

@@ -27,7 +27,7 @@
       "properties": {
         "flexibleColumnLayout": {
           "$ref": "#/definitions/FlexibleColumnLayoutV4",
-          "description": "The flexible column layout allows users to see more details on the page, and to expand and collapse the screen areas. For the overview page, this layout is not relevant."
+          "description": "The flexible column layout allows users to see more details on the page, and to expand and collapse the screen areas."
         },
         "path": {
           "description": "Represents a prefix that is prepended in front of the viewName",
@@ -68,6 +68,7 @@
       "additionalProperties": false
     },
     "FlexibleColumnLayoutV4": {
+      "descriptionSrcURL": "https://ui5.sap.com/sdk/#/topic/e762257125b34513b0859faa1610b09e",
       "type": "object",
       "properties": {
         "limitFCLToTwoColumns": {
@@ -229,6 +230,10 @@
         "entityType": {
           "type": "string"
         },
+        "template": {
+          "description": "Full template name from `manifest.json`.",
+          "type": "string"
+        },
         "name": {
           "type": "string"
         },

package/dist/schemas/v4/ListReportConfig.json

@@ -375,6 +375,9 @@
       "type": "object",
       "additionalProperties": {
         "anyOf": [
+          {
+            "$ref": "#/definitions/ViewToolBarActionGroup"
+          },
           {
             "$ref": "#/definitions/ViewToolBarAction"
           },
@@ -388,6 +391,12 @@
         ]
       }
     },
+    "ViewToolBarActionGroup": {
+      "type": "object",
+      "additionalProperties": {
+        "$ref": "#/definitions/ViewToolBarAction"
+      }
+    },
     "ViewToolBarAction": {
       "description": "Action",
       "isViewNode": true,
@@ -647,6 +656,9 @@
           {
             "$ref": "#/definitions/ToolBarAction"
           },
+          {
+            "$ref": "#/definitions/ToolBarActionGroup"
+          },
           {
             "$ref": "#/definitions/CustomTableAction"
           }
@@ -671,6 +683,12 @@
       },
       "additionalProperties": false
     },
+    "ToolBarActionGroup": {
+      "type": "object",
+      "additionalProperties": {
+        "$ref": "#/definitions/ToolBarAction"
+      }
+    },
     "CustomTableAction": {
       "type": "object",
       "properties": {

package/dist/schemas/v4/ObjectPageConfig.json

@@ -73,6 +73,9 @@
           },
           {
             "$ref": "#/definitions/RelatedApps"
+          },
+          {
+            "$ref": "#/definitions/ObjectPageHeaderActionGroup"
           }
         ]
       }
@@ -257,6 +260,12 @@
         "type": "string"
       }
     },
+    "ObjectPageHeaderActionGroup": {
+      "type": "object",
+      "additionalProperties": {
+        "$ref": "#/definitions/ObjectPageHeaderAction"
+      }
+    },
     "HeaderSections": {
       "description": "Header Sections",
       "isViewNode": true,
@@ -696,6 +705,9 @@
           },
           {
             "$ref": "#/definitions/CustomTableActionOP"
+          },
+          {
+            "$ref": "#/definitions/ObjectPageToolBarActionGroup"
           }
         ]
       }
@@ -806,6 +818,12 @@
         "placement"
       ]
     },
+    "ObjectPageToolBarActionGroup": {
+      "type": "object",
+      "additionalProperties": {
+        "$ref": "#/definitions/ObjectPageToolBarAction"
+      }
+    },
     "TableCreationModeOP": {
       "type": "object",
       "properties": {
@@ -1391,6 +1409,9 @@
           },
           {
             "$ref": "#/definitions/FormAction"
+          },
+          {
+            "$ref": "#/definitions/ObjectPageFormActionGroup"
           }
         ]
       }
@@ -1485,6 +1506,12 @@
       },
       "additionalProperties": false
     },
+    "ObjectPageFormActionGroup": {
+      "type": "object",
+      "additionalProperties": {
+        "$ref": "#/definitions/FormAction"
+      }
+    },
     "ObjectPageSectionDataPoint": {
       "type": "object",
       "properties": {

package/dist/specification/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sap/ux-specification",
-    "version": "1.120.36",
+    "version": "1.120.38",
     "displayName": "SAP Fiori tools - Specification",
     "description": "SAP Fiori tools - Specification",
     "files": [
@@ -10,7 +10,7 @@
     ],
     "main": "dist/index-min.js",
     "engines": {
-        "node": ">= 18.0.0 < 19.0.0 || >= 20.0.0 < 21.0.0 || >= 22.0.0",
+        "node": ">=20.0.0 <21.0.0 || >=22.0.0 <23.0.0 || >=24.0.0 <25.0.0 || >=26.0.0",
         "yarn": ">=1.22.19 < 2"
     },
     "scripts": {
@@ -49,13 +49,13 @@
     "publisher": "SAPSE",
     "license": "SEE LICENSE IN LICENSE",
     "dependencies": {
-        "@sap-ux/fe-fpm-writer": "0.33.28",
-        "@sap-ux/vocabularies-types": "0.12.0"
+        "@sap-ux/fe-fpm-writer": "0.35.5",
+        "@sap-ux/vocabularies-types": "0.13.0"
     },
     "devDependencies": {
         "@sap-ux/annotation-converter": "0.10.3",
         "@sap-ux/edmx-parser": "0.8.2",
-        "@sap/ux-specification-types": "1.120.36",
+        "@sap/ux-specification-types": "1.120.38",
         "@sapui5/types": "latest-1.120",
         "@types/d3": "7.4.3",
         "@types/jquery": "3.5.32",
@@ -63,7 +63,7 @@
         "@ui5/flexibility-utils": "0.1.3",
         "@xml-tools/ast": "5.0.5",
         "@xml-tools/parser": "1.0.11",
-        "axios": "1.9.0",
+        "axios": "1.10.0",
         "copyfiles": "2.4.1",
         "d3": "7.9.0",
         "deepmerge": "4.3.1",

package/dist/specification/scripts/documentation/components/TreeDiagram.d.ts

@@ -1,10 +1,31 @@
 import type { TreeData } from './types';
+/**
+ * TreeDiagram class that handles the visualization and interaction of tree data.
+ *
+ */
 export declare class TreeDiagram {
     private TreeUI;
     private treeData;
     constructor();
+    /**
+     * Displays the tree diagram in the specified container.
+     *
+     * @param container - The ID of the container element to render the tree.
+     * @param data - The tree data to display.
+     * @param icon - The icon to use for the tree nodes.
+     */
     show(container: string, data: TreeData, icon: string): void;
+    /**
+     * Sends a message to the parent window.
+     *
+     * @param message - The message to send.
+     */
     private sendMessage;
+    /**
+     * Handles incoming messages from the parent window.
+     *
+     * @param event - The message event containing the data.
+     */
     messageHandler(event: MessageEvent): void;
 }
 //# sourceMappingURL=TreeDiagram.d.ts.map

package/dist/specification/scripts/documentation/components/TreeDiagram.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TreeDiagram.d.ts","sourceRoot":"","sources":["../../../../../scripts/documentation/components/TreeDiagram.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAY,QAAQ,EAAE,MAAM,SAAS,CAAC;AAGlD,qBAAa,WAAW;IACpB,OAAO,CAAC,MAAM,CAAwB;IACtC,OAAO,CAAC,QAAQ,CAAW;;IAIpB,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM;IAI3D,OAAO,CAAC,WAAW;IAGZ,cAAc,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI;CA6BnD"}
+{"version":3,"file":"TreeDiagram.d.ts","sourceRoot":"","sources":["../../../../../scripts/documentation/components/TreeDiagram.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAY,QAAQ,EAAE,MAAM,SAAS,CAAC;AAGlD;;;GAGG;AACH,qBAAa,WAAW;IACpB,OAAO,CAAC,MAAM,CAAwB;IACtC,OAAO,CAAC,QAAQ,CAAW;;IAI3B;;;;;;OAMG;IACI,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM;IAI3D;;;;OAIG;IACH,OAAO,CAAC,WAAW;IAGnB;;;;OAIG;IACI,cAAc,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI;CA6BnD"}

package/dist/specification/scripts/documentation/components/TreeDiagram.js

@@ -4,18 +4,39 @@ exports.TreeDiagram = void 0;
 const filter_1 = require("./filter");
 const types_1 = require("./types");
 const ui_1 = require("./ui");
+/**
+ * TreeDiagram class that handles the visualization and interaction of tree data.
+ *
+ */
 class TreeDiagram {
     constructor() {
         this.TreeUI = new ui_1.TreeUI();
         window.addEventListener('message', (event) => this.messageHandler(event));
     }
+    /**
+     * Displays the tree diagram in the specified container.
+     *
+     * @param container - The ID of the container element to render the tree.
+     * @param data - The tree data to display.
+     * @param icon - The icon to use for the tree nodes.
+     */
     show(container, data, icon) {
         this.treeData = data;
         this.TreeUI.render(container, data, icon);
     }
+    /**
+     * Sends a message to the parent window.
+     *
+     * @param message - The message to send.
+     */
     sendMessage(message) {
         window.postMessage(message, document.location.origin);
     }
+    /**
+     * Handles incoming messages from the parent window.
+     *
+     * @param event - The message event containing the data.
+     */
     messageHandler(event) {
         const { data = {} } = event;
         const { type } = data;

package/dist/specification/scripts/documentation/components/TreeDiagram.js.map

@@ -1 +1 @@
-{"version":3,"file":"TreeDiagram.js","sourceRoot":"","sources":["../../../../../scripts/documentation/components/TreeDiagram.ts"],"names":[],"mappings":";;;AAAA,qCAAkC;AAElC,mCAAiD;AACjD,6BAA8B;AAC9B,MAAa,WAAW;IAGpB;QAFQ,WAAM,GAAW,IAAI,WAAM,EAAE,CAAC;QAGlC,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;IAC9E,CAAC;IACM,IAAI,CAAC,SAAiB,EAAE,IAAc,EAAE,IAAY;QACvD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAC9C,CAAC;IACO,WAAW,CAAC,OAAiB;QACjC,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC1D,CAAC;IACM,cAAc,CAAC,KAAmB;QACrC,MAAM,EAAE,IAAI,GAAG,EAAE,EAAE,GAAG,KAAK,CAAC;QAC5B,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;QACtB,QAAQ,IAAI,EAAE,CAAC;YACX,KAAK,0BAA0B,CAAC,CAAC,CAAC;gBAC9B,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;gBAC/B,MAAM,gBAAgB,GAAG,IAAA,eAAM,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;gBACtD,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,gBAAgB,EAAE,KAAK,KAAK,EAAE,CAAC,CAAC;gBACxD,MAAM;YACV,CAAC;YACD,KAAK,0BAA0B,CAAC,CAAC,CAAC;gBAC9B,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;gBAChC,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;gBACpC,MAAM;YACV,CAAC;YACD,KAAK,wBAAwB,CAAC,CAAC,CAAC;gBAC5B,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;gBACvC,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;gBACrD,IAAI,QAAQ,KAAK,KAAK,EAAE,CAAC;oBACrB,sBAAsB;oBACtB,IAAI,CAAC,WAAW,CAAC;wBACb,IAAI,EAAE,8BAAsB;wBAC5B,KAAK,EAAE,QAAQ;qBAClB,CAAC,CAAC;gBACP,CAAC;gBACD,MAAM;YACV,CAAC;QACL,CAAC;IACL,CAAC;CACJ;AA1CD,kCA0CC"}
+{"version":3,"file":"TreeDiagram.js","sourceRoot":"","sources":["../../../../../scripts/documentation/components/TreeDiagram.ts"],"names":[],"mappings":";;;AAAA,qCAAkC;AAElC,mCAAiD;AACjD,6BAA8B;AAC9B;;;GAGG;AACH,MAAa,WAAW;IAGpB;QAFQ,WAAM,GAAW,IAAI,WAAM,EAAE,CAAC;QAGlC,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;IAC9E,CAAC;IACD;;;;;;OAMG;IACI,IAAI,CAAC,SAAiB,EAAE,IAAc,EAAE,IAAY;QACvD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAC9C,CAAC;IACD;;;;OAIG;IACK,WAAW,CAAC,OAAiB;QACjC,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC1D,CAAC;IACD;;;;OAIG;IACI,cAAc,CAAC,KAAmB;QACrC,MAAM,EAAE,IAAI,GAAG,EAAE,EAAE,GAAG,KAAK,CAAC;QAC5B,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;QACtB,QAAQ,IAAI,EAAE,CAAC;YACX,KAAK,0BAA0B,CAAC,CAAC,CAAC;gBAC9B,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;gBAC/B,MAAM,gBAAgB,GAAG,IAAA,eAAM,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;gBACtD,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,gBAAgB,EAAE,KAAK,KAAK,EAAE,CAAC,CAAC;gBACxD,MAAM;YACV,CAAC;YACD,KAAK,0BAA0B,CAAC,CAAC,CAAC;gBAC9B,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;gBAChC,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;gBACpC,MAAM;YACV,CAAC;YACD,KAAK,wBAAwB,CAAC,CAAC,CAAC;gBAC5B,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;gBACvC,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;gBACrD,IAAI,QAAQ,KAAK,KAAK,EAAE,CAAC;oBACrB,sBAAsB;oBACtB,IAAI,CAAC,WAAW,CAAC;wBACb,IAAI,EAAE,8BAAsB;wBAC5B,KAAK,EAAE,QAAQ;qBAClB,CAAC,CAAC;gBACP,CAAC;gBACD,MAAM;YACV,CAAC;QACL,CAAC;IACL,CAAC;CACJ;AA3DD,kCA2DC"}

package/dist/specification/scripts/documentation/components/filter.d.ts

@@ -1,5 +1,12 @@
 import type { TreeData } from './types';
 type SearchTreeData = TreeData;
+/**
+ * Filters a tree structure based on a search term.
+ *
+ * @param input - The root of the tree structure to filter.
+ * @param searchTerm - The term to search for in the tree nodes.
+ * @returns The filtered tree structure if matches are found, otherwise undefined.
+ */
 export declare function filter(input: TreeData, searchTerm: string): SearchTreeData | undefined;
 export {};
 //# sourceMappingURL=filter.d.ts.map

package/dist/specification/scripts/documentation/components/filter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"filter.d.ts","sourceRoot":"","sources":["../../../../../scripts/documentation/components/filter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAExC,KAAK,cAAc,GAAG,QAAQ,CAAC;AAsC/B,wBAAgB,MAAM,CAAC,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS,CAWtF"}
+{"version":3,"file":"filter.d.ts","sourceRoot":"","sources":["../../../../../scripts/documentation/components/filter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAExC,KAAK,cAAc,GAAG,QAAQ,CAAC;AA6D/B;;;;;;GAMG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS,CAWtF"}

package/dist/specification/scripts/documentation/components/filter.js

@@ -1,10 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.filter = filter;
+/**
+ * Checks if a tree node matches the given search term.
+ *
+ * @param child - The tree node to check.
+ * @param searchTerm - The term to search for in the node's name.
+ * @returns True if the node matches the search term, otherwise false.
+ */
 function isNodeMatching(child, searchTerm) {
     const { name } = child;
     return name.toLowerCase().includes(searchTerm);
 }
+/**
+ * Filters a tree node and its children based on the search term.
+ *
+ * @param result - The array to store the filtered nodes.
+ * @param innerChild - The current tree node being checked.
+ * @param searchTerm - The term to search for in the node's name.
+ * @returns True if the node or any of its children match the search term, otherwise false.
+ */
 function filterNode(result, innerChild, searchTerm) {
     let found = false;
     let childClone = { ...innerChild, children: [] };
@@ -25,6 +40,14 @@ function filterNode(result, innerChild, searchTerm) {
     }
     return found;
 }
+/**
+ * Filters the children of a tree node based on the search term.
+ *
+ * @param result - The array to store the filtered nodes.
+ * @param child - The current tree node whose children are being checked.
+ * @param searchTerm - The term to search for in the children's names.
+ * @returns True if any of the children match the search term, otherwise false.
+ */
 function filterNodes(result, child, searchTerm) {
     let found = false;
     for (const innerChild of child.children) {
@@ -32,6 +55,13 @@ function filterNodes(result, child, searchTerm) {
     }
     return found;
 }
+/**
+ * Filters a tree structure based on a search term.
+ *
+ * @param input - The root of the tree structure to filter.
+ * @param searchTerm - The term to search for in the tree nodes.
+ * @returns The filtered tree structure if matches are found, otherwise undefined.
+ */
 function filter(input, searchTerm) {
     const resultNodes = [];
     // Case insensitive search

package/dist/specification/scripts/documentation/components/filter.js.map

@@ -1 +1 @@
-{"version":3,"file":"filter.js","sourceRoot":"","sources":["../../../../../scripts/documentation/components/filter.ts"],"names":[],"mappings":";;AAwCA,wBAWC;AA/CD,SAAS,cAAc,CAAC,KAAe,EAAE,UAAkB;IACvD,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC;IACvB,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;AACnD,CAAC;AAED,SAAS,UAAU,CAAC,MAAwB,EAAE,UAAoB,EAAE,UAAkB;IAClF,IAAI,KAAK,GAAG,KAAK,CAAC;IAClB,IAAI,UAAU,GAAmB,EAAE,GAAG,UAAU,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;IAEjE,MAAM,aAAa,GAAG,cAAc,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IAC7D,IAAI,aAAa,EAAE,CAAC;QAChB,KAAK,GAAG,IAAI,CAAC;IACjB,CAAC;IAED,MAAM,UAAU,GAAG,WAAW,CAAC,UAAU,CAAC,QAAQ,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;IAC5E,IAAI,UAAU,EAAE,CAAC;QACb,KAAK,GAAG,IAAI,CAAC;QACb,UAAU,GAAG;YACT,GAAG,UAAU;YACb,QAAQ,EAAE,UAAU,CAAC,QAAQ;SAChC,CAAC;IACN,CAAC;IACD,IAAI,aAAa,IAAI,UAAU,EAAE,CAAC;QAC9B,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC5B,CAAC;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAED,SAAS,WAAW,CAAC,MAAwB,EAAE,KAAe,EAAE,UAAkB;IAC9E,IAAI,KAAK,GAAG,KAAK,CAAC;IAClB,KAAK,MAAM,UAAU,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;QACtC,KAAK,GAAG,UAAU,CAAC,MAAM,EAAE,UAAU,EAAE,UAAU,CAAC,IAAI,KAAK,CAAC;IAChE,CAAC;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAED,SAAgB,MAAM,CAAC,KAAe,EAAE,UAAkB;IACtD,MAAM,WAAW,GAAqB,EAAE,CAAC;IACzC,0BAA0B;IAC1B,UAAU,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAChE,IAAI,CAAC,UAAU,EAAE,CAAC;QACd,eAAe;QACf,OAAO,SAAS,CAAC;IACrB,CAAC;IACD,eAAe;IACf,MAAM,KAAK,GAAG,UAAU,CAAC,WAAW,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;IACzD,OAAO,KAAK,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AAC9C,CAAC"}
+{"version":3,"file":"filter.js","sourceRoot":"","sources":["../../../../../scripts/documentation/components/filter.ts"],"names":[],"mappings":";;AAsEA,wBAWC;AA7ED;;;;;;GAMG;AACH,SAAS,cAAc,CAAC,KAAe,EAAE,UAAkB;IACvD,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC;IACvB,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;AACnD,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,UAAU,CAAC,MAAwB,EAAE,UAAoB,EAAE,UAAkB;IAClF,IAAI,KAAK,GAAG,KAAK,CAAC;IAClB,IAAI,UAAU,GAAmB,EAAE,GAAG,UAAU,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;IAEjE,MAAM,aAAa,GAAG,cAAc,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IAC7D,IAAI,aAAa,EAAE,CAAC;QAChB,KAAK,GAAG,IAAI,CAAC;IACjB,CAAC;IAED,MAAM,UAAU,GAAG,WAAW,CAAC,UAAU,CAAC,QAAQ,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;IAC5E,IAAI,UAAU,EAAE,CAAC;QACb,KAAK,GAAG,IAAI,CAAC;QACb,UAAU,GAAG;YACT,GAAG,UAAU;YACb,QAAQ,EAAE,UAAU,CAAC,QAAQ;SAChC,CAAC;IACN,CAAC;IACD,IAAI,aAAa,IAAI,UAAU,EAAE,CAAC;QAC9B,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC5B,CAAC;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,WAAW,CAAC,MAAwB,EAAE,KAAe,EAAE,UAAkB;IAC9E,IAAI,KAAK,GAAG,KAAK,CAAC;IAClB,KAAK,MAAM,UAAU,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;QACtC,KAAK,GAAG,UAAU,CAAC,MAAM,EAAE,UAAU,EAAE,UAAU,CAAC,IAAI,KAAK,CAAC;IAChE,CAAC;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,MAAM,CAAC,KAAe,EAAE,UAAkB;IACtD,MAAM,WAAW,GAAqB,EAAE,CAAC;IACzC,0BAA0B;IAC1B,UAAU,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAChE,IAAI,CAAC,UAAU,EAAE,CAAC;QACd,eAAe;QACf,OAAO,SAAS,CAAC;IACrB,CAAC;IACD,eAAe;IACf,MAAM,KAAK,GAAG,UAAU,CAAC,WAAW,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;IACzD,OAAO,KAAK,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AAC9C,CAAC"}

package/dist/specification/scripts/documentation/components/ui/TreeUI.d.ts

@@ -22,20 +22,90 @@ export declare class TreeUI {
     private zoomListener;
     private canvasOffset;
     constructor();
+    /**
+     * Renders the tree in the specified container with the provided data and icon.
+     *
+     * @param container - The CSS selector for the container element where the tree will be rendered.
+     * @param data - The hierarchical tree data to be rendered.
+     * @param icon - The icon to be displayed for the root node.
+     */
     render(container: string, data: TreeData, icon: string): void;
+    /**
+     * Toggles the expand/collapse state of all nodes in the tree.
+     *
+     * @param expand - A boolean indicating whether to expand (true) or collapse (false) all nodes in the tree.
+     */
     toggleExpandAll(expand: boolean): void;
+    /**
+     * Applies the filter to the tree based on the updated tree data.
+     *
+     * @param updatedTreeData - The updated hierarchical tree data to apply the filter.
+     * @param clear - A boolean indicating whether to clear the filter (true) or not (false).
+     */
     applyFilter(updatedTreeData: TreeData, clear: boolean): void;
+    /**
+     * Zooms the tree based on the zoom event.
+     *
+     * @param event - The zoom event containing transformation details.
+     */
     private zoom;
+    /**
+     * Zooms the tree to a specified scale value and optionally centers it.
+     *
+     * @param value - The zoom scale value. If 0, fits the tree to the canvas.
+     * @param center - Whether to center the tree after zooming.
+     * @returns The applied zoom scale value.
+     */
     zoomTree(value: number, center?: boolean): number;
+    /**
+     * Fits the tree to the canvas by adjusting the zoom scale and position.
+     *
+     * @returns The applied zoom scale value.
+     */
     private fitToCanvas;
+    /**
+     * Centers the tree or a specific node in the tree.
+     *
+     * @param source - The source node to center in the tree.
+     * @param ratio - The ratio used to calculate the position for centering the node.
+     */
     private centerNode;
     private centerTree;
     private updateCanvasSize;
+    /**
+     * Creates the root hierarchy for the tree structure based on the provided tree data.
+     *
+     * @param rootData - The hierarchical tree data used to create the root hierarchy.
+     * @returns The root hierarchy node of the tree.
+     */
     private createRootHierarchy;
     private setupEventListeners;
+    /**
+     * Attaches event listeners to a node element and invokes a callback on specific events.
+     *
+     * @param element - The D3 selection of the node element to attach events to.
+     * @param cb - The callback function to execute on click or keydown events.
+     * @returns The updated D3 selection with event listeners attached.
+     */
     private handleEventOnNode;
+    /**
+     * Updates the tree structure and repositions nodes and links based on the provided source node.
+     *
+     * @param source - The source node from which the tree update starts.
+     */
     private updateTree;
+    /**
+     * Calculates and returns the content height of the tree based on the number of levels.
+     *
+     * @returns The calculated content height in pixels.
+     */
     private getContentHeight;
+    /**
+     * Toggles the expand or collapse state of a tree node based on the event.
+     *
+     * @param event - The event triggering the toggle action (e.g., click or keydown).
+     * @param d - The tree node to be toggled.
+     */
     private toggleExpandOrCollapse;
 }
 //# sourceMappingURL=TreeUI.d.ts.map

package/dist/specification/scripts/documentation/components/ui/TreeUI.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TreeUI.d.ts","sourceRoot":"","sources":["../../../../../../scripts/documentation/components/ui/TreeUI.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAc,kBAAkB,EAAsB,aAAa,EAAE,SAAS,EAAE,MAAM,IAAI,CAAC;AACvG,OAAO,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAsB,MAAM,UAAU,CAAC;AAOvE,qBAAa,MAAM;IACf,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,cAAc,CAAS;IAC/B,OAAO,CAAC,UAAU,CAAW;IAC7B,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,QAAQ,CAAS;IAEzB,OAAO,CAAC,WAAW,CAAW;IACvB,IAAI,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAC;IAC9B,QAAQ,EAAE,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IAC9C,OAAO,CAAC,QAAQ,CAAS;IAEzB,OAAO,CAAC,qBAAqB,CAAc;IAC3C,OAAO,CAAC,eAAe,CAAc;IAE9B,gBAAgB,EAAE,SAAS,CAAC,aAAa,EAAE,QAAQ,EAAE,WAAW,EAAE,EAAE,CAAC,CAAC;IACtE,YAAY,EAAE,SAAS,CAAC,WAAW,EAAE,QAAQ,EAAE,WAAW,EAAE,EAAE,CAAC,CAAC;IACvE,OAAO,CAAC,OAAO,CAAuD;IACtE,OAAO,CAAC,UAAU,CAAuB;IAEzC,OAAO,CAAC,KAAK,CAAiC;IAC9C,OAAO,CAAC,KAAK,CAAiC;IAE9C,OAAO,CAAC,YAAY,CAA2C;IAE/D,OAAO,CAAC,YAAY,CAGlB;;IAWK,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM;IA4CtD,eAAe,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI;IAetC,WAAW,CAAC,eAAe,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI;IAuBnE,OAAO,CAAC,IAAI;IAKL,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,MAAM;IAYxD,OAAO,CAAC,WAAW;IAmCnB,OAAO,CAAC,UAAU;IAalB,OAAO,CAAC,UAAU;IAUlB,OAAO,CAAC,gBAAgB;IAWxB,OAAO,CAAC,mBAAmB;IA2B3B,OAAO,CAAC,mBAAmB;IAiC3B,OAAO,CAAC,iBAAiB;IAazB,OAAO,CAAC,UAAU;IA2PlB,OAAO,CAAC,gBAAgB;IAOxB,OAAO,CAAC,sBAAsB;CAUjC"}
+{"version":3,"file":"TreeUI.d.ts","sourceRoot":"","sources":["../../../../../../scripts/documentation/components/ui/TreeUI.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAc,kBAAkB,EAAsB,aAAa,EAAE,SAAS,EAAE,MAAM,IAAI,CAAC;AACvG,OAAO,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAsB,MAAM,UAAU,CAAC;AAOvE,qBAAa,MAAM;IACf,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,cAAc,CAAS;IAC/B,OAAO,CAAC,UAAU,CAAW;IAC7B,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,QAAQ,CAAS;IAEzB,OAAO,CAAC,WAAW,CAAW;IACvB,IAAI,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAC;IAC9B,QAAQ,EAAE,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IAC9C,OAAO,CAAC,QAAQ,CAAS;IAEzB,OAAO,CAAC,qBAAqB,CAAc;IAC3C,OAAO,CAAC,eAAe,CAAc;IAE9B,gBAAgB,EAAE,SAAS,CAAC,aAAa,EAAE,QAAQ,EAAE,WAAW,EAAE,EAAE,CAAC,CAAC;IACtE,YAAY,EAAE,SAAS,CAAC,WAAW,EAAE,QAAQ,EAAE,WAAW,EAAE,EAAE,CAAC,CAAC;IACvE,OAAO,CAAC,OAAO,CAAuD;IACtE,OAAO,CAAC,UAAU,CAAuB;IAEzC,OAAO,CAAC,KAAK,CAAiC;IAC9C,OAAO,CAAC,KAAK,CAAiC;IAE9C,OAAO,CAAC,YAAY,CAA2C;IAE/D,OAAO,CAAC,YAAY,CAGlB;;IAWF;;;;;;OAMG;IACI,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM;IA4C7D;;;;OAIG;IACI,eAAe,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI;IAc7C;;;;;OAKG;IACI,WAAW,CAAC,eAAe,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI;IAuBnE;;;;OAIG;IACH,OAAO,CAAC,IAAI;IAKZ;;;;;;OAMG;IACI,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,MAAM;IAYxD;;;;OAIG;IACH,OAAO,CAAC,WAAW;IAkCnB;;;;;OAKG;IACH,OAAO,CAAC,UAAU;IAalB,OAAO,CAAC,UAAU;IAUlB,OAAO,CAAC,gBAAgB;IAWxB;;;;;OAKG;IACH,OAAO,CAAC,mBAAmB;IA2B3B,OAAO,CAAC,mBAAmB;IAiC3B;;;;;;OAMG;IACH,OAAO,CAAC,iBAAiB;IAazB;;;;OAIG;IACH,OAAO,CAAC,UAAU;IA2PlB;;;;OAIG;IACH,OAAO,CAAC,gBAAgB;IAMxB;;;;;OAKG;IACH,OAAO,CAAC,sBAAsB;CAUjC"}

package/dist/specification/scripts/documentation/components/ui/TreeUI.js

@@ -23,6 +23,13 @@ class TreeUI {
         this.buttonContainer = document.querySelector('#button-container');
         window.addEventListener('resize', () => this.updateCanvasSize());
     }
+    /**
+     * Renders the tree in the specified container with the provided data and icon.
+     *
+     * @param container - The CSS selector for the container element where the tree will be rendered.
+     * @param data - The hierarchical tree data to be rendered.
+     * @param icon - The icon to be displayed for the root node.
+     */
     render(container, data, icon) {
         this.countID = 0;
         this.rawTreeData = data;
@@ -62,6 +69,11 @@ class TreeUI {
             this.updateCanvasSize();
         }
     }
+    /**
+     * Toggles the expand/collapse state of all nodes in the tree.
+     *
+     * @param expand - A boolean indicating whether to expand (true) or collapse (false) all nodes in the tree.
+     */
     toggleExpandAll(expand) {
         let ratio;
         if (expand) {
@@ -76,7 +88,12 @@ class TreeUI {
         this.updateTree(this.rootNode);
         this.centerNode(this.rootNode, ratio);
     }
-    // function to filter the items in search list
+    /**
+     * Applies the filter to the tree based on the updated tree data.
+     *
+     * @param updatedTreeData - The updated hierarchical tree data to apply the filter.
+     * @param clear - A boolean indicating whether to clear the filter (true) or not (false).
+     */
     applyFilter(updatedTreeData, clear) {
         this.countID = 0;
         const originalDuration = this.duration;
@@ -101,10 +118,22 @@ class TreeUI {
         this.centerNode(this.rootNode, ratio);
         this.duration = originalDuration;
     }
+    /**
+     * Zooms the tree based on the zoom event.
+     *
+     * @param event - The zoom event containing transformation details.
+     */
     zoom(event) {
         this.svgTreeGroup.attr('transform', event.transform);
         (0, tooltip_1.removeTooltip)(this.toolTip);
     }
+    /**
+     * Zooms the tree to a specified scale value and optionally centers it.
+     *
+     * @param value - The zoom scale value. If 0, fits the tree to the canvas.
+     * @param center - Whether to center the tree after zooming.
+     * @returns The applied zoom scale value.
+     */
     zoomTree(value, center) {
         if (value === 0) {
             return this.fitToCanvas();
@@ -117,6 +146,11 @@ class TreeUI {
         }
         return value;
     }
+    /**
+     * Fits the tree to the canvas by adjusting the zoom scale and position.
+     *
+     * @returns The applied zoom scale value.
+     */
     fitToCanvas() {
         const offset = 100;
         let scaleFactor = 1;
@@ -145,7 +179,12 @@ class TreeUI {
             .call(this.zoomListener.transform, d3_1.zoomIdentity.translate(newX, newY).scale(scaleFactor));
         return scaleFactor;
     }
-    // function to center the tree or specific node
+    /**
+     * Centers the tree or a specific node in the tree.
+     *
+     * @param source - The source node to center in the tree.
+     * @param ratio - The ratio used to calculate the position for centering the node.
+     */
     centerNode(source, ratio) {
         const r = ratio || 2, node = (0, d3_1.zoomTransform)(this.svgTreeContainer.node());
         let x = -source.data.y0, y = -source.data.x0;
@@ -175,6 +214,12 @@ class TreeUI {
             this.svgTreeContainer.attr('height', this.innerHeight);
         }
     }
+    /**
+     * Creates the root hierarchy for the tree structure based on the provided tree data.
+     *
+     * @param rootData - The hierarchical tree data used to create the root hierarchy.
+     * @returns The root hierarchy node of the tree.
+     */
     createRootHierarchy(rootData) {
         const stringifyedData = JSON.parse(JSON.stringify(rootData));
         // assigns and calculates the data required for the nodes and links
@@ -225,6 +270,13 @@ class TreeUI {
             }
         });
     }
+    /**
+     * Attaches event listeners to a node element and invokes a callback on specific events.
+     *
+     * @param element - The D3 selection of the node element to attach events to.
+     * @param cb - The callback function to execute on click or keydown events.
+     * @returns The updated D3 selection with event listeners attached.
+     */
     handleEventOnNode(element, cb) {
         return element
             .on('click', (event, d) => {
@@ -234,6 +286,11 @@ class TreeUI {
             cb(event, d);
         });
     }
+    /**
+     * Updates the tree structure and repositions nodes and links based on the provided source node.
+     *
+     * @param source - The source node from which the tree update starts.
+     */
     updateTree(source) {
         this.treeLayout.size([this.getContentHeight(), this.innerWidth])(this.rootNode);
         // assign the nodes and links
@@ -462,12 +519,22 @@ class TreeUI {
             d.data.y0 = d.y;
         });
     }
+    /**
+     * Calculates and returns the content height of the tree based on the number of levels.
+     *
+     * @returns The calculated content height in pixels.
+     */
     getContentHeight() {
         this.levelWidth = [1];
         (0, utils_1.childCount)(this.levelWidth, 0, this.rootNode);
         return (0, d3_1.max)(this.levelWidth) >= 10 ? (0, d3_1.max)(this.levelWidth) * 60 : (0, d3_1.max)(this.levelWidth) * 45; // pixels per line
     }
-    // toggle children on toggleExpandOrCollapse
+    /**
+     * Toggles the expand or collapse state of a tree node based on the event.
+     *
+     * @param event - The event triggering the toggle action (e.g., click or keydown).
+     * @param d - The tree node to be toggled.
+     */
     toggleExpandOrCollapse(event, d) {
         // toggleExpandOrCollapse suppressed
         if (event.defaultPrevented) {