@sap/ux-specification 1.102.14 → 1.102.15

package/dist/package.json

@@ -1,10 +1,11 @@
 {
     "name": "@sap/ux-specification",
-    "version": "1.102.14",
+    "version": "1.102.15",
     "displayName": "SAP Fiori tools - Specification",
     "description": "SAP Fiori tools - Specification",
     "files": [
-        "dist"
+        "dist",
+        "!dist/scripts"
     ],
     "main": "dist/index-min.js",
     "engines": {
@@ -43,17 +44,18 @@
         "iXiaSoftV2": "ts-node ./scripts/extractDocu.ts --version=v2 --format=iXiaSoft",
         "iXiaSoftV4": "ts-node ./scripts/extractDocu.ts --version=v4 --format=iXiaSoft",
         "htmlV2": "ts-node ./scripts/extractDocu.ts --version=v2 --format=html",
-        "htmlV4": "ts-node ./scripts/extractDocu.ts --version=v4 --format=html"
+        "htmlV4": "ts-node ./scripts/extractDocu.ts --version=v4 --format=html",
+        "deleteSnapshots": "rimraf **/_file_snapshots_"
     },
     "publisher": "SAPSE",
     "license": "SEE LICENSE IN LICENSE",
     "dependencies": {
-        "@sap-ux/fe-fpm-writer": "0.17.8",
+        "@sap-ux/fe-fpm-writer": "0.18.3",
         "@sap-ux/vocabularies-types": "0.6.8"
     },
     "devDependencies": {
         "@sap-ux/annotation-converter": "0.5.20",
-        "@sap/ux-specification-types": "1.102.14",
+        "@sap/ux-specification-types": "1.102.15",
         "@sap-ux/edmx-parser": "0.5.13",
         "@sapui5/ts-types-esm": "1.100.2",
         "@types/d3": "7.1.0",
@@ -79,7 +81,6 @@
         "reflect-metadata": "0.1.13",
         "sax": "1.2.4",
         "semver": "7.3.5",
-        "ts-json-schema-generator": "0.96.0",
         "typescript-json-schema": "0.53.0",
         "xml-js": "1.6.11"
     },

package/dist/schemas/v2/ApplicationV2.json

@@ -129,7 +129,7 @@
       "type": "object",
       "properties": {
         "pageType": {
-          "$ref": "#/definitions/PageType"
+          "$ref": "#/definitions/PageTypeV2"
         },
         "name": {
           "type": "string"
@@ -137,6 +137,9 @@
         "entitySet": {
           "type": "string"
         },
+        "contextPath": {
+          "type": "string"
+        },
         "navigationProperty": {
           "type": "string"
         },
@@ -167,7 +170,7 @@
       },
       "additionalProperties": false
     },
-    "PageType": {
+    "PageTypeV2": {
       "enum": [
         "AnalyticalListPage",
         "CustomPage",

package/dist/schemas/v2/ListReportConfig.json

@@ -88,11 +88,6 @@
           "type": "boolean",
           "artifactType": "Manifest"
         },
-        "showDraftToggle": {
-          "description": "In the list report and on the object page, you can enable buttons to display and hide draft values. By default, these buttons are hidden. To enable them, set the showDraftToggle flag to true.",
-          "type": "boolean",
-          "artifactType": "Manifest"
-        },
         "createWithParameterDialog": {
           "$ref": "#/definitions/Fields4Dialog",
           "description": "You can enable the creation of objects that have a maximum of 8 data fields through a dialog in the list report page.",
@@ -666,11 +661,6 @@
           "type": "boolean",
           "artifactType": "Manifest"
         },
-        "showDraftToggle": {
-          "description": "In the list report and on the object page, you can enable buttons to display and hide draft values. By default, these buttons are hidden. To enable them, set the showDraftToggle flag to true.",
-          "type": "boolean",
-          "artifactType": "Manifest"
-        },
         "createWithParameterDialog": {
           "$ref": "#/definitions/Fields4Dialog",
           "description": "You can enable the creation of objects that have a maximum of 8 data fields through a dialog in the list report page.",
@@ -765,11 +755,6 @@
           "type": "boolean",
           "artifactType": "Manifest"
         },
-        "showDraftToggle": {
-          "description": "In the list report and on the object page, you can enable buttons to display and hide draft values. By default, these buttons are hidden. To enable them, set the showDraftToggle flag to true.",
-          "type": "boolean",
-          "artifactType": "Manifest"
-        },
         "createWithParameterDialog": {
           "$ref": "#/definitions/Fields4Dialog",
           "description": "You can enable the creation of objects that have a maximum of 8 data fields through a dialog in the list report page.",
@@ -889,11 +874,6 @@
           "description": "createWithFilters adds a new create action that uses the filter settings as input.",
           "artifactType": "Manifest"
         },
-        "showDraftToggle": {
-          "description": "In the list report and on the object page, you can enable buttons to display and hide draft values. By default, these buttons are hidden. To enable them, set the showDraftToggle flag to true.",
-          "type": "boolean",
-          "artifactType": "Manifest"
-        },
         "growingThreshold": {
           "description": "growingThreshold defines the number of items to be requested from the model for each grow. This property can only be used if the growing property is set to true.",
           "type": "number",
@@ -1059,11 +1039,6 @@
           "description": "createWithFilters adds a new create action that uses the filter settings as input.",
           "artifactType": "Manifest"
         },
-        "showDraftToggle": {
-          "description": "In the list report and on the object page, you can enable buttons to display and hide draft values. By default, these buttons are hidden. To enable them, set the showDraftToggle flag to true.",
-          "type": "boolean",
-          "artifactType": "Manifest"
-        },
         "growingThreshold": {
           "description": "growingThreshold defines the number of items to be requested from the model for each grow. This property can only be used if the growing property is set to true.",
           "type": "number",

package/dist/schemas/v2/ObjectPageConfig.json

@@ -105,7 +105,7 @@
           "controlType": "sap.f.Avatar"
         },
         "actions": {
-          "$ref": "#/definitions/HeaderActions",
+          "$ref": "#/definitions/ObjectPageHeaderActions",
           "description": "Set properties of actions on Object Page Header"
         }
       },
@@ -118,13 +118,13 @@
       ],
       "type": "string"
     },
-    "HeaderActions": {
+    "ObjectPageHeaderActions": {
       "type": "object",
       "additionalProperties": {
-        "$ref": "#/definitions/HeaderAction"
+        "$ref": "#/definitions/ObjectPageHeaderAction"
       }
     },
-    "HeaderAction": {
+    "ObjectPageHeaderAction": {
       "description": "Header Action",
       "isViewNode": true,
       "type": "object",

package/dist/schemas/v4/ApplicationV4.json

@@ -126,15 +126,18 @@
     "PageV4": {
       "type": "object",
       "properties": {
-        "pageType": {
-          "$ref": "#/definitions/PageTypeV4"
-        },
         "view": {
           "$ref": "#/definitions/PageView"
         },
         "controlAggregation": {
           "$ref": "#/definitions/FlexibleColumnLayoutAggregations"
         },
+        "pageType": {
+          "$ref": "#/definitions/PageTypeV4"
+        },
+        "contextPath": {
+          "type": "string"
+        },
         "name": {
           "type": "string"
         },
@@ -171,16 +174,6 @@
       },
       "additionalProperties": false
     },
-    "PageTypeV4": {
-      "enum": [
-        "AnalyticalListPage",
-        "CustomPage",
-        "FPMCustomPage",
-        "ListReport",
-        "ObjectPage"
-      ],
-      "type": "string"
-    },
     "PageView": {
       "type": "object",
       "properties": {
@@ -214,6 +207,16 @@
       ],
       "type": "string"
     },
+    "PageTypeV4": {
+      "enum": [
+        "AnalyticalListPage",
+        "CustomPage",
+        "FPMCustomPage",
+        "ListReport",
+        "ObjectPage"
+      ],
+      "type": "string"
+    },
     "PageConfig": {
       "type": "object",
       "properties": {

package/dist/schemas/v4/BuildingBlocksConfig.json

@@ -83,7 +83,7 @@
       }
     },
     "sap.fe.macros.Chart": {
-      "description": "Building block used to create a chart based on the metadata provided by OData V4.\n\nUsually, a contextPath and metaPath is expected.Usage example:\n\n<macro:Chart id=\"Mychart\" contextPath=\"/RootEntity\" metaPath=\"@com.sap.vocabularies.UI.v1.Chart\" />\n\n",
+      "description": "Building block used to create a chart based on the metadata provided by OData V4.\n\nUsually, a contextPath and metaPath is expected.\nUsage example:\n\n<macro:Chart id=\"Mychart\" contextPath=\"/RootEntity\" metaPath=\"@com.sap.vocabularies.UI.v1.Chart\" />\n\n",
       "isViewNode": true,
       "type": "object",
       "properties": {
@@ -151,7 +151,7 @@
       }
     },
     "sap.fe.macros.Field": {
-      "description": "Building block for creating a field based on the metadata provided by OData V4.\n\nUsually, a DataField or DataPoint annotation is expected, but the field can also be used to display a property from the entity type.Usage example:\n\n<macro:Field id=\"MyField\" metaPath=\"MyProperty\" />\n\n",
+      "description": "Building block for creating a field based on the metadata provided by OData V4.\n\nUsually, a DataField or DataPoint annotation is expected, but the field can also be used to display a property from the entity type.\nUsage example:\n\n<macro:Field id=\"MyField\" metaPath=\"MyProperty\" />\n\n",
       "isViewNode": true,
       "type": "object",
       "properties": {
@@ -186,7 +186,7 @@
         },
         "readOnly": {
           "type": "boolean",
-          "description": "An expression that allows you to control the read-only state of the field.If you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine the current state.\n",
+          "description": "An expression that allows you to control the read-only state of the field.\nIf you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine the current state.\n",
           "metadata": {
             "type": "Property"
           }
@@ -213,7 +213,7 @@
       }
     },
     "sap.fe.macros.FilterBar": {
-      "description": "Building block for creating a FilterBar based on the metadata provided by OData V4.\n\nUsually, a SelectionFields annotation is expected.Usage example:\n\n<macro:FilterBar id=\"MyFilterBar\" metaPath=\"@com.sap.vocabularies.UI.v1.SelectionFields\" />\n\n",
+      "description": "Building block for creating a FilterBar based on the metadata provided by OData V4.\n\nUsually, a SelectionFields annotation is expected.\nUsage example:\n\n<macro:FilterBar id=\"MyFilterBar\" metaPath=\"@com.sap.vocabularies.UI.v1.SelectionFields\" />\n\n",
       "isViewNode": true,
       "type": "object",
       "properties": {
@@ -238,6 +238,17 @@
             "type": "Property"
           }
         },
+        "filterFields": {
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "#/definitions/sap.fe.macros.FilterField"
+          },
+          "isViewNode": true,
+          "metadata": {
+            "path": [],
+            "type": "Aggregation"
+          }
+        },
         "filterChanged": {
           "type": "string",
           "description": "This event is fired after either a filter value or the visibility of a filter item has been changed. The event contains conditions that will be used as filters.",
@@ -260,7 +271,7 @@
       }
     },
     "sap.fe.macros.Form": {
-      "description": "Building block for creating a Form based on the metadata provided by OData V4.\n\nIt is designed to work based on a FieldGroup annotation but can also work if you provide a ReferenceFacet or a CollectionFacetUsage example:\n\n<macro:Form id=\"MyForm\" metaPath=\"@com.sap.vocabularies.UI.v1.FieldGroup#GeneralInformation\" />\n\n",
+      "description": "Building block for creating a Form based on the metadata provided by OData V4.\n\nIt is designed to work based on a FieldGroup annotation but can also work if you provide a ReferenceFacet or a CollectionFacet\nUsage example:\n\n<macro:Form id=\"MyForm\" metaPath=\"@com.sap.vocabularies.UI.v1.FieldGroup#GeneralInformation\" />\n\n",
       "isViewNode": true,
       "type": "object",
       "properties": {
@@ -300,7 +311,7 @@
       }
     },
     "sap.fe.macros.Table": {
-      "description": "Building block used to create a table based on the metadata provided by OData V4.\n\nUsually, a LineItem or PresentationVariant annotation is expected, but the Table building block can also be used to display an EntitySet.Usage example:\n\n<macro:Table id=\"MyTable\" metaPath=\"@com.sap.vocabularies.UI.v1.LineItem\" />\n\n",
+      "description": "Building block used to create a table based on the metadata provided by OData V4.\n\nUsually, a LineItem or PresentationVariant annotation is expected, but the Table building block can also be used to display an EntitySet.\nUsage example:\n\n<macro:Table id=\"MyTable\" metaPath=\"@com.sap.vocabularies.UI.v1.LineItem\" />\n\n",
       "isViewNode": true,
       "type": "object",
       "properties": {
@@ -404,35 +415,35 @@
               "type": "string"
             }
           ],
-          "description": "Controls which options should be enabled for the table personalization dialog.If it is set to `true`, all possible options for this kind of table are enabled.\nIf it is set to `false`, personalization is disabled.\n\nYou can also provide a more granular control for the personalization by providing a comma-separated list with the options you want to be available.\nAvailable options are:\n - Sort\n - Column\n - Filter\n",
+          "description": "Controls which options should be enabled for the table personalization dialog.\nIf it is set to `true`, all possible options for this kind of table are enabled.\n\nIf it is set to `false`, personalization is disabled.\n\n\n\nYou can also provide a more granular control for the personalization by providing a comma-separated list with the options you want to be available.\n\nAvailable options are:\n\n - Sort\n\n - Column\n\n - Filter\n\n",
           "metadata": {
             "type": "Property"
           }
         },
         "readOnly": {
           "type": "boolean",
-          "description": "An expression that allows you to control the 'read-only' state of the table.If you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine the current state.\n",
+          "description": "An expression that allows you to control the 'read-only' state of the table.\nIf you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine the current state.\n",
           "metadata": {
             "type": "Property"
           }
         },
         "selectionMode": {
           "type": "string",
-          "description": "Defines the selection mode to be used by the table.Allowed values are `None`, `Single`, `Multi` or `Auto`\n",
+          "description": "Defines the selection mode to be used by the table.\nAllowed values are `None`, `Single`, `Multi` or `Auto`\n",
           "metadata": {
             "type": "Property"
           }
         },
         "type": {
           "type": "string",
-          "description": "Defines the type of table that will be used by the building block to render the data.Allowed values are `GridTable` and `ResponsiveTable`\n",
+          "description": "Defines the type of table that will be used by the building block to render the data.\nAllowed values are `GridTable` and `ResponsiveTable`\n",
           "metadata": {
             "type": "Property"
           }
         },
         "variantManagement": {
           "type": "string",
-          "description": "Controls the kind of variant management that should be enabled for the table.Allowed values are `Page`, `Control` and `None`.\nIf the table is used within a SAP Fiori elements template, the default value will be taken from the current page variant management.\nOtherwise it's `None`.\n",
+          "description": "Controls the kind of variant management that should be enabled for the table.\nAllowed values are `Page`, `Control` and `None`.\n\nIf the table is used within a SAP Fiori elements template, the default value will be taken from the current page variant management.\n\nOtherwise it's `None`.\n",
           "metadata": {
             "type": "Property"
           }
@@ -445,7 +456,6 @@
           }
         },
         "actions": {
-          "description": "actions",
           "type": "object",
           "additionalProperties": {
             "$ref": "#/definitions/sap.fe.macros.table.Action"
@@ -457,7 +467,6 @@
           }
         },
         "columns": {
-          "description": "columns",
           "type": "object",
           "additionalProperties": {
             "$ref": "#/definitions/sap.fe.macros.table.Column"
@@ -470,7 +479,7 @@
         },
         "rowPress": {
           "type": "string",
-          "description": "An event triggered when the user chooses a row; the event contains information about which row was chosen.You can set this in order to handle the navigation manually.\n",
+          "description": "An event triggered when the user chooses a row; the event contains information about which row was chosen.\nYou can set this in order to handle the navigation manually.\n",
           "metadata": {
             "type": "Event"
           }
@@ -516,7 +525,6 @@
           }
         },
         "actions": {
-          "description": "actions",
           "type": "object",
           "additionalProperties": {
             "$ref": "#/definitions/sap.fe.macros.table.Action"
@@ -541,42 +549,42 @@
       "properties": {
         "displayMode": {
           "type": "string",
-          "description": " Defines how the field value and associated text will be displayed together. Allowed values are \"Value\", \"Description\", \"ValueDescription\" and \"DescriptionValue\"\n",
+          "description": " Defines how the field value and associated text will be displayed together.\n\n Allowed values are \"Value\", \"Description\", \"ValueDescription\" and \"DescriptionValue\"\n",
           "metadata": {
             "type": "Property"
           }
         },
         "measureDisplayMode": {
           "type": "string",
-          "description": "Defines if and how the field measure will be displayed.Allowed values are \"Hidden\" and \"ReadOnly\"\n",
+          "description": "Defines if and how the field measure will be displayed.\n\nAllowed values are \"Hidden\" and \"ReadOnly\"\n",
           "metadata": {
             "type": "Property"
           }
         },
         "textExpandBehaviorDisplay": {
           "type": "string",
-          "description": "Defines how the full text will be displayed.Allowed values are \"InPlace\" and \"Popover\"\n",
+          "description": "Defines how the full text will be displayed.\n\nAllowed values are \"InPlace\" and \"Popover\"\n",
           "metadata": {
             "type": "Property"
           }
         },
         "textLinesEdit": {
           "type": "number",
-          "description": "Maximum number of lines for multiline texts in edit mode.",
+          "description": "Maximum number of lines for multiline texts in edit mode.\n",
           "metadata": {
             "type": "Property"
           }
         },
         "textMaxCharactersDisplay": {
           "type": "number",
-          "description": "Maximum number of characters from the beginning of the text field that are shown initially.",
+          "description": "Maximum number of characters from the beginning of the text field that are shown initially.\n",
           "metadata": {
             "type": "Property"
           }
         },
         "textMaxLines": {
           "type": "number",
-          "description": "Maximum number of lines that multiline texts in edit mode can grow to.",
+          "description": "Maximum number of lines that multiline texts in edit mode can grow to.\n",
           "metadata": {
             "type": "Property"
           }
@@ -589,7 +597,7 @@
       }
     },
     "sap.fe.macros.FilterField": {
-      "description": "Definition of a custom filter to be used inside the FilterBar.The template for the FilterField has to be provided as the default aggregation\n",
+      "description": "Definition of a custom filter to be used inside the FilterBar.\nThe template for the FilterField has to be provided as the default aggregation\n",
       "isViewNode": true,
       "type": "object",
       "properties": {
@@ -623,10 +631,14 @@
         },
         "placement": {
           "type": "string",
-          "description": "Defines where this filter should be placed relative to the defined anchorAllowed values are `Before` and `After`\n",
+          "description": "Defines where this filter should be placed relative to the defined anchor\nAllowed values are `Before` and `After`\n",
           "metadata": {
             "type": "Property"
-          }
+          },
+          "enum": [
+            "After",
+            "Before"
+          ]
         },
         "showMessages": {
           "type": "boolean",
@@ -677,10 +689,14 @@
         },
         "placement": {
           "type": "string",
-          "description": "Defines where this action should be placed relative to the defined anchorAllowed values are `Before` and `After`\n",
+          "description": "Defines where this action should be placed relative to the defined anchor\nAllowed values are `Before` and `After`\n",
           "metadata": {
             "type": "Property"
-          }
+          },
+          "enum": [
+            "After",
+            "Before"
+          ]
         },
         "press": {
           "type": "string",
@@ -711,7 +727,7 @@
       }
     },
     "sap.fe.macros.table.Column": {
-      "description": "Definition of a custom column to be used inside the table.The template for the column has to be provided as the default aggregation\n",
+      "description": "Definition of a custom column to be used inside the table.\nThe template for the column has to be provided as the default aggregation\n",
       "isViewNode": true,
       "type": "object",
       "properties": {
@@ -731,7 +747,7 @@
         },
         "importance": {
           "type": "string",
-          "description": "Defines the column importanceYou can define which columns should be automatically moved to the pop-in area based on their importance\n",
+          "description": "Defines the column importance\nYou can define which columns should be automatically moved to the pop-in area based on their importance\n",
           "metadata": {
             "type": "Property"
           }
@@ -745,10 +761,14 @@
         },
         "placement": {
           "type": "string",
-          "description": "Defines where this column should be placed relative to the defined anchorAllowed values are `Before` and `After`\n",
+          "description": "Defines where this column should be placed relative to the defined anchor\nAllowed values are `Before` and `After`\n",
           "metadata": {
             "type": "Property"
-          }
+          },
+          "enum": [
+            "After",
+            "Before"
+          ]
         }
       },
       "additionalProperties": false,