@sap/ux-specification 1.71.45 → 1.71.49

package/dist/schemas/v2/OverviewPageConfig.json

@@ -143,10 +143,6 @@
       "type": "object",
       "additionalProperties": {},
       "properties": {
-        "entitySet": {
-          "description": "Represents the dominant entity set that will be displayed in the given card.",
-          "type": "string"
-        },
         "itemText": {
           "description": "Represents the user defined string in placeholder card.",
           "type": "string"
@@ -293,6 +289,10 @@
             }
           ]
         },
+        "entitySet": {
+          "description": "Represents the dominant entity set that will be displayed in the given card.",
+          "type": "string"
+        },
         "title": {
           "description": "The language-dependent title of the card, used in the card header.",
           "i18nClassification": "TIT: Title of the card, used in the card header",
@@ -361,8 +361,25 @@
           ]
         },
         "requireAppAuthorization": {
-          "description": "Define an authorization check at card level",
+          "description": "Define an authorization check at card level.",
           "type": "string"
+        },
+        "tabs": {
+          "description": "Represents the card with view switch control.",
+          "type": "array",
+          "items": [
+            {
+              "$ref": "#/definitions/TabSetting"
+            }
+          ],
+          "minItems": 1,
+          "additionalItems": {
+            "$ref": "#/definitions/TabSetting"
+          }
+        },
+        "addODataSelect": {
+          "description": "add $Select parameter in data fetch URL",
+          "type": "boolean"
         }
       },
       "required": [
@@ -408,6 +425,70 @@
       },
       "additionalProperties": false
     },
+    "TabSetting": {
+      "type": "object",
+      "additionalProperties": {},
+      "properties": {
+        "annotationPath": {
+          "description": "Represents the annotation path.",
+          "type": "string"
+        },
+        "selectionAnnotationPath": {
+          "description": "Represents the selection annotation path.",
+          "type": "string"
+        },
+        "chartAnnotationPath": {
+          "description": "Represents the chart annotation path.",
+          "type": "string"
+        },
+        "presentationAnnotationPath": {
+          "description": "Represents the presentation annotation path.",
+          "type": "string"
+        },
+        "dataPointAnnotationPath": {
+          "description": "Represents the data point annotation path.",
+          "type": "string"
+        },
+        "identificationAnnotationPath": {
+          "description": "Represents the identification annotation path.",
+          "type": "string"
+        },
+        "dynamicSubtitleAnnotationPath": {
+          "description": "Represents the dynamic subtitle annotation path",
+          "type": "string"
+        },
+        "value": {
+          "description": "Represents the drop down value to be shown",
+          "type": "string"
+        },
+        "chartProperties": {
+          "description": "This property is responsible for setting specific chart settings.",
+          "type": "object",
+          "properties": {
+            "plotArea": {
+              "$ref": "#/definitions/PlotAreaDef"
+            }
+          },
+          "additionalProperties": false
+        },
+        "colorPalette": {
+          "description": "Represents the configuration to customize the column stacked chart.",
+          "anyOf": [
+            {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "additionalProperties": {}
+              }
+            },
+            {
+              "type": "object",
+              "additionalProperties": {}
+            }
+          ]
+        }
+      }
+    },
     "ListCard": {
       "description": "List Card",
       "isViewNode": true,
@@ -431,20 +512,6 @@
           "$ref": "#/definitions/ListCardSettings",
           "description": "Represents the properties that are passed to the list card.",
           "artifactType": "Manifest"
-        },
-        "tabs": {
-          "description": "Represents the List Card with view switch control.",
-          "type": "array",
-          "items": [
-            {
-              "$ref": "#/definitions/TabSetting"
-            }
-          ],
-          "minItems": 1,
-          "additionalItems": {
-            "$ref": "#/definitions/TabSetting"
-          },
-          "artifactType": "Manifest"
         }
       },
       "additionalProperties": false,
@@ -458,10 +525,6 @@
       "displayName": "settings",
       "type": "object",
       "properties": {
-        "entitySet": {
-          "description": "Represents the dominant entity set that will be displayed in the given card.",
-          "type": "string"
-        },
         "listFlavor": {
           "$ref": "#/definitions/ListFlavorType",
           "description": "Represents the flavor of the list to use in this card. The flavor can be bar chart, carousel or standard."
@@ -486,27 +549,18 @@
           "$ref": "#/definitions/SortOrderType",
           "description": "Defines the sort order."
         },
-        "addODataSelect": {
-          "description": "add $Select parameter in data fetch URL",
-          "type": "boolean"
-        },
-        "tabs": {
-          "description": "Represents the card with view switch control.\nThis property doesn't exist in the app descriptor json schema for settings, but is there on the card level next to the template.\nHowever, in the reference application it is in the settings of a sap.ovp.cards.list.",
-          "type": "array",
-          "items": [
-            {
-              "$ref": "#/definitions/TabSetting"
-            }
-          ],
-          "minItems": 1,
-          "additionalItems": {
-            "$ref": "#/definitions/TabSetting"
-          }
-        },
         "dataPointAnnotationPath": {
           "description": "Represents the data point annotation path.",
           "type": "string"
         },
+        "showLineItemDetail": {
+          "description": "Flag for show line item detail in list and table card.",
+          "type": "boolean"
+        },
+        "entitySet": {
+          "description": "Represents the dominant entity set that will be displayed in the given card.",
+          "type": "string"
+        },
         "title": {
           "description": "The language-dependent title of the card, used in the card header.",
           "i18nClassification": "TIT: Title of the card, used in the card header",
@@ -575,13 +629,29 @@
           ]
         },
         "requireAppAuthorization": {
-          "description": "Define an authorization check at card level",
+          "description": "Define an authorization check at card level.",
           "type": "string"
+        },
+        "tabs": {
+          "description": "Represents the card with view switch control.",
+          "type": "array",
+          "items": [
+            {
+              "$ref": "#/definitions/TabSetting"
+            }
+          ],
+          "minItems": 1,
+          "additionalItems": {
+            "$ref": "#/definitions/TabSetting"
+          }
+        },
+        "addODataSelect": {
+          "description": "add $Select parameter in data fetch URL",
+          "type": "boolean"
         }
       },
       "additionalProperties": false,
       "required": [
-        "entitySet",
         "title"
       ]
     },
@@ -607,70 +677,6 @@
       ],
       "type": "string"
     },
-    "TabSetting": {
-      "type": "object",
-      "additionalProperties": {},
-      "properties": {
-        "annotationPath": {
-          "description": "Represents the annotation path.",
-          "type": "string"
-        },
-        "selectionAnnotationPath": {
-          "description": "Represents the selection annotation path.",
-          "type": "string"
-        },
-        "chartAnnotationPath": {
-          "description": "Represents the chart annotation path.",
-          "type": "string"
-        },
-        "presentationAnnotationPath": {
-          "description": "Represents the presentation annotation path.",
-          "type": "string"
-        },
-        "dataPointAnnotationPath": {
-          "description": "Represents the data point annotation path.",
-          "type": "string"
-        },
-        "identificationAnnotationPath": {
-          "description": "Represents the identification annotation path.",
-          "type": "string"
-        },
-        "dynamicSubtitleAnnotationPath": {
-          "description": "Represents the dynamic subtitle annotation path",
-          "type": "string"
-        },
-        "value": {
-          "description": "Represents the drop down value to be shown",
-          "type": "string"
-        },
-        "chartProperties": {
-          "description": "This property is responsible for setting specific chart settings.",
-          "type": "object",
-          "properties": {
-            "plotArea": {
-              "$ref": "#/definitions/PlotAreaDef"
-            }
-          },
-          "additionalProperties": false
-        },
-        "colorPalette": {
-          "description": "Represents the configuration to customize the column stacked chart.",
-          "anyOf": [
-            {
-              "type": "array",
-              "items": {
-                "type": "object",
-                "additionalProperties": {}
-              }
-            },
-            {
-              "type": "object",
-              "additionalProperties": {}
-            }
-          ]
-        }
-      }
-    },
     "StackCard": {
       "description": "Stack Card",
       "isViewNode": true,
@@ -707,10 +713,6 @@
       "displayName": "settings",
       "type": "object",
       "properties": {
-        "entitySet": {
-          "description": "Represents the dominant entity set that will be displayed in the given card.",
-          "type": "string"
-        },
         "itemText": {
           "description": "Represents the user defined string in placeholder card.",
           "type": "string"
@@ -734,6 +736,10 @@
           },
           "additionalProperties": false
         },
+        "entitySet": {
+          "description": "Represents the dominant entity set that will be displayed in the given card.",
+          "type": "string"
+        },
         "title": {
           "description": "The language-dependent title of the card, used in the card header.",
           "i18nClassification": "TIT: Title of the card, used in the card header",
@@ -802,13 +808,29 @@
           ]
         },
         "requireAppAuthorization": {
-          "description": "Define an authorization check at card level",
+          "description": "Define an authorization check at card level.",
           "type": "string"
+        },
+        "tabs": {
+          "description": "Represents the card with view switch control.",
+          "type": "array",
+          "items": [
+            {
+              "$ref": "#/definitions/TabSetting"
+            }
+          ],
+          "minItems": 1,
+          "additionalItems": {
+            "$ref": "#/definitions/TabSetting"
+          }
+        },
+        "addODataSelect": {
+          "description": "add $Select parameter in data fetch URL",
+          "type": "boolean"
         }
       },
       "additionalProperties": false,
       "required": [
-        "entitySet",
         "title"
       ]
     },
@@ -847,20 +869,6 @@
       "displayName": "settings",
       "type": "object",
       "properties": {
-        "entitySet": {
-          "description": "entitySet represents the entity set that will be displayed in this card.",
-          "type": "string"
-        },
-        "title": {
-          "description": "title represents the language-dependent title of the card, as used in the card header.",
-          "i18nClassification": "TIT: Title of the card, used in the card header",
-          "type": "string"
-        },
-        "subTitle": {
-          "description": "YOu can define the language-dependent subtitle of the card, as used in the card header.",
-          "i18nClassification": "TIT: Subtitle of the card, used in the card header",
-          "type": "string"
-        },
         "targetUri": {
           "description": "The targetUri is a URI defining the link to a quick view, related application or external resource.",
           "type": "string"
@@ -881,8 +889,45 @@
           "description": "headerAnnotationPath represents the path to a HeaderInfo annotation.",
           "type": "string"
         },
+        "staticContent": {
+          "description": "staticContent represents the static content of a static link list card.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/StaticContent"
+          }
+        },
+        "annotationPath": {
+          "description": "Represents the annotation path.",
+          "type": "string"
+        },
+        "entitySet": {
+          "description": "Represents the dominant entity set that will be displayed in the given card.",
+          "type": "string"
+        },
+        "title": {
+          "description": "The language-dependent title of the card, used in the card header.",
+          "i18nClassification": "TIT: Title of the card, used in the card header",
+          "type": "string"
+        },
+        "subTitle": {
+          "description": "The language-dependent subtitle of the card, used in the card header.",
+          "i18nClassification": "TIT: Subtitle of the card, used in the card header",
+          "type": "string"
+        },
         "identificationAnnotationPath": {
-          "description": "identificationAnnotationPath represents the path to an Identification annotation.",
+          "description": "Represents the identification annotation path.",
+          "type": "string"
+        },
+        "selectionAnnotationPath": {
+          "description": "Represents the selection annotation path.",
+          "type": "string"
+        },
+        "presentationAnnotationPath": {
+          "description": "Represents the presentation annotation path.",
+          "type": "string"
+        },
+        "category": {
+          "description": "The category of the card, as used in the card header.",
           "type": "string"
         },
         "defaultSpan": {
@@ -926,20 +971,26 @@
             }
           ]
         },
-        "staticContent": {
-          "description": "staticContent represents the static content of a static link list card.",
-          "type": "array",
-          "items": {
-            "$ref": "#/definitions/StaticContent"
-          }
-        },
         "requireAppAuthorization": {
-          "description": "Define an authorization check at card level",
+          "description": "Define an authorization check at card level.",
           "type": "string"
         },
-        "annotationPath": {
-          "description": "Represents the annotation path.",
-          "type": "string"
+        "tabs": {
+          "description": "Represents the card with view switch control.",
+          "type": "array",
+          "items": [
+            {
+              "$ref": "#/definitions/TabSetting"
+            }
+          ],
+          "minItems": 1,
+          "additionalItems": {
+            "$ref": "#/definitions/TabSetting"
+          }
+        },
+        "addODataSelect": {
+          "description": "add $Select parameter in data fetch URL",
+          "type": "boolean"
         }
       },
       "additionalProperties": false,
@@ -1022,20 +1073,6 @@
           "description": "Represents the properties that are passed to the table card.",
           "artifactType": "Manifest"
         },
-        "tabs": {
-          "description": "Represents the card with view switch control.",
-          "type": "array",
-          "items": [
-            {
-              "$ref": "#/definitions/TabSetting"
-            }
-          ],
-          "minItems": 1,
-          "additionalItems": {
-            "$ref": "#/definitions/TabSetting"
-          },
-          "artifactType": "Manifest"
-        },
         "disableTableCardFlexibility": {
           "description": "If you set disableTableCardFlexibility to true, then at runtime, DataField records are sorted according to the importance set in the com.sap.vocabularies.UI.v1.ImportanceType annotation, and their order of entry.\nIf you set disableTableCardFlexibility to false, then at runtime, table columns are sorted according to the importance set in the com.sap.vocabularies.UI.v1.ImportanceType annotation, and their order of entry.",
           "type": "boolean",
@@ -1053,10 +1090,6 @@
       "displayName": "settings",
       "type": "object",
       "properties": {
-        "entitySet": {
-          "description": "Represents the dominant entity set that will be displayed in the given card.",
-          "type": "string"
-        },
         "annotationPath": {
           "description": "Represents the annotation path.",
           "type": "string"
@@ -1089,18 +1122,13 @@
           "$ref": "#/definitions/SortOrderType",
           "description": "Defines the sort order."
         },
-        "tabs": {
-          "description": "Represents the card with view switch control.",
-          "type": "array",
-          "items": [
-            {
-              "$ref": "#/definitions/TabSetting"
-            }
-          ],
-          "minItems": 1,
-          "additionalItems": {
-            "$ref": "#/definitions/TabSetting"
-          }
+        "showLineItemDetail": {
+          "description": "Flag for show line item detail in list and table card.",
+          "type": "boolean"
+        },
+        "entitySet": {
+          "description": "Represents the dominant entity set that will be displayed in the given card.",
+          "type": "string"
         },
         "title": {
           "description": "The language-dependent title of the card, used in the card header.",
@@ -1170,13 +1198,29 @@
           ]
         },
         "requireAppAuthorization": {
-          "description": "Define an authorization check at card level",
+          "description": "Define an authorization check at card level.",
           "type": "string"
+        },
+        "tabs": {
+          "description": "Represents the card with view switch control.",
+          "type": "array",
+          "items": [
+            {
+              "$ref": "#/definitions/TabSetting"
+            }
+          ],
+          "minItems": 1,
+          "additionalItems": {
+            "$ref": "#/definitions/TabSetting"
+          }
+        },
+        "addODataSelect": {
+          "description": "add $Select parameter in data fetch URL",
+          "type": "boolean"
         }
       },
       "additionalProperties": false,
       "required": [
-        "entitySet",
         "title"
       ]
     },
@@ -1203,20 +1247,6 @@
           "$ref": "#/definitions/AnalyticalCardSettings",
           "description": "Represents the properties that are passed to the analytical card.",
           "artifactType": "Manifest"
-        },
-        "tabs": {
-          "description": "Represents the Analytical Card with view switch control.",
-          "type": "array",
-          "items": [
-            {
-              "$ref": "#/definitions/TabSetting"
-            }
-          ],
-          "minItems": 1,
-          "additionalItems": {
-            "$ref": "#/definitions/TabSetting"
-          },
-          "artifactType": "Manifest"
         }
       },
       "additionalProperties": false,
@@ -1229,10 +1259,6 @@
       "displayName": "settings",
       "type": "object",
       "properties": {
-        "entitySet": {
-          "description": "Represents the dominant entity set that will be displayed in the given card.",
-          "type": "string"
-        },
         "chartAnnotationPath": {
           "description": "Represents the chart annotation path.",
           "type": "string"
@@ -1245,6 +1271,10 @@
           "description": "Represents things like people, number of items.",
           "type": "string"
         },
+        "entitySet": {
+          "description": "Represents the dominant entity set that will be displayed in the given card.",
+          "type": "string"
+        },
         "title": {
           "description": "The language-dependent title of the card, used in the card header.",
           "i18nClassification": "TIT: Title of the card, used in the card header",
@@ -1313,13 +1343,29 @@
           ]
         },
         "requireAppAuthorization": {
-          "description": "Define an authorization check at card level",
+          "description": "Define an authorization check at card level.",
           "type": "string"
+        },
+        "tabs": {
+          "description": "Represents the card with view switch control.",
+          "type": "array",
+          "items": [
+            {
+              "$ref": "#/definitions/TabSetting"
+            }
+          ],
+          "minItems": 1,
+          "additionalItems": {
+            "$ref": "#/definitions/TabSetting"
+          }
+        },
+        "addODataSelect": {
+          "description": "add $Select parameter in data fetch URL",
+          "type": "boolean"
         }
       },
       "additionalProperties": false,
       "required": [
-        "entitySet",
         "title"
       ]
     }

package/dist/scripts/extractDocu.js

@@ -25,6 +25,8 @@ const excel = __importStar(require("excel4node"));
  * @param reference - Content for the $ref property
  * @param output - Array of descriptions with assigned hierarchy elements, all separated by ';' (csv like)
  * @param definition - The current hierarchy element (list of path parts separated by ';')
+ * @param description - The description of the current hierarchy element
+ * @param additionalMetadata - Additional information about the current hierarchy element, separated by ';'
  */
 function dereference(schema, reference, output, definition, description, additionalMetadata) {
     const currentDefinition = reference.split('#/definitions/')[1];
@@ -39,7 +41,7 @@ function dereference(schema, reference, output, definition, description, additio
  * Handles one property of a sub-schema
  * @param schema - Object representing the whole generic schema
  * @param subSchema - Object representing the current sub-structure of the schema
- * @param property - Name of the property ithin the subSchema
+ * @param property - Name of the property within the subSchema
  * @param output  - Array of descriptions with assigned hierarchy elements, all separated by ';' (csv like)
  * @param definition - The current hierarchy element (list of path parts separated by ';')
  */
@@ -80,7 +82,7 @@ function processElement(schema, subSchema, property, output, definition) {
             return;
         }
         else if (element['anyOf']) {
-            handleAnyOf(schema, element['anyOf'], output, definition, element['description']);
+            handleAnyOf(schema, element['anyOf'], output, definition, element['description'], element, additionalMetadata);
             return;
         }
         if (element['type'] && element['items']) {
@@ -112,20 +114,26 @@ function processElement(schema, subSchema, property, output, definition) {
     }
 }
 /**
- * Special handing of anyOf elements of a JSON schema
+ * Special handling of anyOf elements of a JSON schema
  * @param schema - Object representing the whole generic schema
  * @param anyOfSchema - Object representing the current sub-structure of the schema
  * @param output - Array of descriptions with assigned hierarchy elements, all separated by ';' (csv like)
  * @param definition - The current hierarchy element (list of path parts separated by ';')
+ * @param description - The description of the current hierarchy element
+ * @param element - Object representing the sub-structure of the current hierarchy element
+ * @param additionalMetadata - Additional information about the current hierarchy element, separated by ';' (e.g. artifactType)
  */
-function handleAnyOf(schema, anyOfSchema, output, definition, description) {
+function handleAnyOf(schema, anyOfSchema, output, definition, description, element, additionalMetadata) {
     for (let index = 0; index < anyOfSchema.length; index++) {
-        const element = anyOfSchema[index];
-        if (Object.keys(element)[0] === '$ref') {
-            dereference(schema, element['$ref'], output, definition);
+        const anyOfSchemaElement = anyOfSchema[index];
+        if ((element === null || element === void 0 ? void 0 : element['pattern']) && anyOfSchemaElement['type'] === 'string') {
+            return;
+        }
+        if (Object.keys(anyOfSchemaElement)[0] === '$ref') {
+            dereference(schema, anyOfSchemaElement['$ref'], output, definition, description, additionalMetadata);
         }
         else {
-            parseSchema(schema, element, output, definition, description);
+            parseSchema(schema, anyOfSchemaElement, output, definition, description, additionalMetadata);
         }
     }
 }
@@ -135,6 +143,8 @@ function handleAnyOf(schema, anyOfSchema, output, definition, description) {
  * @param subSchema - Object representing the current sub-structure of the schema
  * @param output - Array of descriptions with assigned hierarchy elements, all separated by ';' (csv like)
  * @param definition - The current hierarchy element (list of path parts separated by ';')
+ * @param description - The description of the current hierarchy element
+ * @param additionalMetadata - Additional information about the current hierarchy element, separated by ';' (e.g. artifactType)
  */
 function parseSchema(schema, subSchema, output, definition, description, additionalMetadata) {
     if (Object.keys(subSchema) && Object.keys(subSchema)[0] === 'anyOf') {