@sap/ux-specification 1.71.94 → 1.71.96

package/dist/schemas/v2/OverviewPageConfig.json

@@ -217,19 +217,8 @@
           "type": "boolean"
         },
         "objectStreamCardsSettings": {
-          "description": "Represents the Object Stream properties - properties that are passed to the Object Stream cards.",
-          "type": "object",
-          "properties": {
-            "showFirstActionInFooter": {
-              "description": "If this flag is set to true, the first action on the footer of the quick view card will be a navigation action.\nIf the flag is set to false, the navigation action on the footer of the quick view card isn't displayed. Other actions are shown instead.\nThe default value of the flag is false.",
-              "type": "boolean"
-            },
-            "annotationPath": {
-              "description": "Represents the annotation path.",
-              "type": "string"
-            }
-          },
-          "additionalProperties": false
+          "$ref": "#/definitions/ObjectStreamCardsSettingsDef",
+          "description": "Represents the Object Stream properties - properties that are passed to the Object Stream cards."
         },
         "enableLocaleCurrencyFormatting": {
           "description": "Represents the flag to indicate the use of object number/smart field.",
@@ -269,6 +258,9 @@
           "properties": {
             "plotArea": {
               "$ref": "#/definitions/PlotAreaDef"
+            },
+            "timeAxis": {
+              "$ref": "#/definitions/TimeAxisDef"
             }
           },
           "additionalProperties": false
@@ -326,23 +318,23 @@
               "type": "object",
               "properties": {
                 "cols": {
-                  "description": "Represents the number of the number of grid columns.",
+                  "description": "Represents the number of the number of grid columns",
                   "type": "number"
                 },
                 "rows": {
-                  "description": "Represents the number of the number of grid rows.",
+                  "description": "Represents the number of the number of grid rows",
                   "type": "number"
                 },
                 "showOnlyHeader": {
-                  "description": "Represents if user wants to show only header part of card in resizable layout.",
+                  "description": "Represents if user wants to show only header part of card in resizable layout",
                   "type": "boolean"
                 },
                 "minimumTitleRow": {
-                  "description": "If the user wants to show more text in title then he or she can configure no of lines to be shown in title(Maximum allowed 3 lines).",
+                  "description": "If user wants to show more text in title then he/she can configure no of lines to be shown in title(Maximum allowed 3 lines)",
                   "type": "number"
                 },
                 "minimumSubTitleRow": {
-                  "description": "If the user wants to show more text in title then he or she can configure no of lines to be shown in sub-title(Maximum allowed 2 lines).",
+                  "description": "If user wants to show more text in title then he/she can configure no of lines to be shown in sub-title(Maximum allowed 2 lines)",
                   "type": "number"
                 }
               },
@@ -384,6 +376,49 @@
         "title"
       ]
     },
+    "ObjectStreamCardsSettingsDef": {
+      "description": "Represents the Object Stream properties - properties that are passed to the Object Stream cards",
+      "type": "object",
+      "additionalProperties": {},
+      "properties": {
+        "showFirstActionInFooter": {
+          "description": "Represents the flag to show first action in footer of the Quickview cards",
+          "type": "boolean"
+        },
+        "customActions": {
+          "description": "Represents the custom actions in the Quick View Cards",
+          "minItems": 1,
+          "type": "array",
+          "items": [
+            {
+              "$ref": "#/definitions/CustomActionsSetting"
+            }
+          ],
+          "additionalItems": {
+            "$ref": "#/definitions/CustomActionsSetting"
+          }
+        }
+      }
+    },
+    "CustomActionsSetting": {
+      "description": "Represents the properties for the custom actions in the Quick View Cards",
+      "type": "object",
+      "additionalProperties": {},
+      "properties": {
+        "text": {
+          "description": "Text displayed for extended actions in Quick View",
+          "type": "string"
+        },
+        "press": {
+          "description": "Name of the press handler for extended actions in Quick View",
+          "type": "string"
+        },
+        "position": {
+          "description": "Position of extended actions in Quick View",
+          "type": "number"
+        }
+      }
+    },
     "CustomCardNavigationType": {
       "enum": [
         "chartNav",
@@ -394,23 +429,23 @@
       "type": "string"
     },
     "PlotAreaDef": {
-      "description": "Plot area is a parent property which defines multiple other properties for smoothness and marker size.",
+      "description": "Plot area is a parent property which defines multiple other properties for smoothness and marker size",
       "type": "object",
       "properties": {
         "isSmoothed": {
-          "description": "isSmoothed represents whether smoother curves are required or not.",
+          "description": "Represents whether smoother curves are required or not",
           "type": "boolean"
         },
         "markerSize": {
-          "description": "markerSize represents the size of the markers in scatter plots.",
+          "description": "Represents the size of the markers in scatter plots",
           "type": "number"
         },
         "dataLabel": {
-          "description": "dataLabel is a parent property that defines other properties for type.",
+          "description": "dataLabel is a parent property that defines other properties for type",
           "type": "object",
           "properties": {
             "type": {
-              "description": "The data label type defines whether to display percentage values or actual counts in the donut chart.",
+              "description": "Defines whether to display percentage values or actual counts in the donut chart",
               "enum": [
                 "percentage",
                 "value"
@@ -423,32 +458,45 @@
       },
       "additionalProperties": false
     },
+    "TimeAxisDef": {
+      "description": "Represents the configuration to customize the time axis",
+      "type": "object",
+      "additionalProperties": {},
+      "properties": {
+        "levels": {
+          "description": "Plot area is a parent property which defines multiple other properties for smoothness and marker size",
+          "type": "array",
+          "items": {}
+        }
+      }
+    },
     "TabSetting": {
+      "description": "Represents the tab specific properties - properties that are passed to a particular tab in a card",
       "type": "object",
       "additionalProperties": {},
       "properties": {
         "annotationPath": {
-          "description": "Represents the annotation path.",
+          "description": "Represents the annotation path",
           "type": "string"
         },
         "selectionAnnotationPath": {
-          "description": "Represents the selection annotation path.",
+          "description": "Represents the selection annotation path",
           "type": "string"
         },
         "chartAnnotationPath": {
-          "description": "Represents the chart annotation path.",
+          "description": "Represents the chart annotation path",
           "type": "string"
         },
         "presentationAnnotationPath": {
-          "description": "Represents the presentation annotation path.",
+          "description": "Represents the presentation annotation path",
           "type": "string"
         },
         "dataPointAnnotationPath": {
-          "description": "Represents the data point annotation path.",
+          "description": "Represents the data point annotation path",
           "type": "string"
         },
         "identificationAnnotationPath": {
-          "description": "Represents the identification annotation path.",
+          "description": "Represents the identification annotation path",
           "type": "string"
         },
         "dynamicSubtitleAnnotationPath": {
@@ -460,17 +508,20 @@
           "type": "string"
         },
         "chartProperties": {
-          "description": "This property is responsible for setting specific chart settings.",
+          "description": "This property is responsible for setting specific chart settings",
           "type": "object",
           "properties": {
             "plotArea": {
               "$ref": "#/definitions/PlotAreaDef"
+            },
+            "timeAxis": {
+              "$ref": "#/definitions/TimeAxisDef"
             }
           },
           "additionalProperties": false
         },
         "colorPalette": {
-          "description": "Represents the configuration to customize the column stacked chart.",
+          "description": "Represents the configuration to customize the column stacked chart",
           "anyOf": [
             {
               "type": "array",
@@ -590,23 +641,23 @@
               "type": "object",
               "properties": {
                 "cols": {
-                  "description": "Represents the number of the number of grid columns.",
+                  "description": "Represents the number of the number of grid columns",
                   "type": "number"
                 },
                 "rows": {
-                  "description": "Represents the number of the number of grid rows.",
+                  "description": "Represents the number of the number of grid rows",
                   "type": "number"
                 },
                 "showOnlyHeader": {
-                  "description": "Represents if user wants to show only header part of card in resizable layout.",
+                  "description": "Represents if user wants to show only header part of card in resizable layout",
                   "type": "boolean"
                 },
                 "minimumTitleRow": {
-                  "description": "If the user wants to show more text in title then he or she can configure no of lines to be shown in title(Maximum allowed 3 lines).",
+                  "description": "If user wants to show more text in title then he/she can configure no of lines to be shown in title(Maximum allowed 3 lines)",
                   "type": "number"
                 },
                 "minimumSubTitleRow": {
-                  "description": "If the user wants to show more text in title then he or she can configure no of lines to be shown in sub-title(Maximum allowed 2 lines).",
+                  "description": "If user wants to show more text in title then he/she can configure no of lines to be shown in sub-title(Maximum allowed 2 lines)",
                   "type": "number"
                 }
               },
@@ -714,19 +765,8 @@
           "type": "string"
         },
         "objectStreamCardsSettings": {
-          "description": "Configures additional settings for the cards displayed in the object stream.",
-          "type": "object",
-          "properties": {
-            "showFirstActionInFooter": {
-              "description": "If this flag is set to true, the first action on the footer of the quick view card will be a navigation action.\nIf the flag is set to false, the navigation action on the footer of the quick view card isn't displayed. Other actions are shown instead.\nThe default value of the flag is false.",
-              "type": "boolean"
-            },
-            "annotationPath": {
-              "description": "Represents the annotation path.",
-              "type": "string"
-            }
-          },
-          "additionalProperties": false
+          "$ref": "#/definitions/ObjectStreamCardsSettingsDef",
+          "description": "Configures additional settings for the cards displayed in the object stream."
         },
         "entitySet": {
           "description": "Represents the dominant entity set that will be displayed in the given card.",
@@ -765,23 +805,23 @@
               "type": "object",
               "properties": {
                 "cols": {
-                  "description": "Represents the number of the number of grid columns.",
+                  "description": "Represents the number of the number of grid columns",
                   "type": "number"
                 },
                 "rows": {
-                  "description": "Represents the number of the number of grid rows.",
+                  "description": "Represents the number of the number of grid rows",
                   "type": "number"
                 },
                 "showOnlyHeader": {
-                  "description": "Represents if user wants to show only header part of card in resizable layout.",
+                  "description": "Represents if user wants to show only header part of card in resizable layout",
                   "type": "boolean"
                 },
                 "minimumTitleRow": {
-                  "description": "If the user wants to show more text in title then he or she can configure no of lines to be shown in title(Maximum allowed 3 lines).",
+                  "description": "If user wants to show more text in title then he/she can configure no of lines to be shown in title(Maximum allowed 3 lines)",
                   "type": "number"
                 },
                 "minimumSubTitleRow": {
-                  "description": "If the user wants to show more text in title then he or she can configure no of lines to be shown in sub-title(Maximum allowed 2 lines).",
+                  "description": "If user wants to show more text in title then he/she can configure no of lines to be shown in sub-title(Maximum allowed 2 lines)",
                   "type": "number"
                 }
               },
@@ -925,23 +965,23 @@
               "type": "object",
               "properties": {
                 "cols": {
-                  "description": "Represents the number of the number of grid columns.",
+                  "description": "Represents the number of the number of grid columns",
                   "type": "number"
                 },
                 "rows": {
-                  "description": "Represents the number of the number of grid rows.",
+                  "description": "Represents the number of the number of grid rows",
                   "type": "number"
                 },
                 "showOnlyHeader": {
-                  "description": "Represents if user wants to show only header part of card in resizable layout.",
+                  "description": "Represents if user wants to show only header part of card in resizable layout",
                   "type": "boolean"
                 },
                 "minimumTitleRow": {
-                  "description": "If the user wants to show more text in title then he or she can configure no of lines to be shown in title(Maximum allowed 3 lines).",
+                  "description": "If user wants to show more text in title then he/she can configure no of lines to be shown in title(Maximum allowed 3 lines)",
                   "type": "number"
                 },
                 "minimumSubTitleRow": {
-                  "description": "If the user wants to show more text in title then he or she can configure no of lines to be shown in sub-title(Maximum allowed 2 lines).",
+                  "description": "If user wants to show more text in title then he/she can configure no of lines to be shown in sub-title(Maximum allowed 2 lines)",
                   "type": "number"
                 }
               },
@@ -1147,23 +1187,23 @@
               "type": "object",
               "properties": {
                 "cols": {
-                  "description": "Represents the number of the number of grid columns.",
+                  "description": "Represents the number of the number of grid columns",
                   "type": "number"
                 },
                 "rows": {
-                  "description": "Represents the number of the number of grid rows.",
+                  "description": "Represents the number of the number of grid rows",
                   "type": "number"
                 },
                 "showOnlyHeader": {
-                  "description": "Represents if user wants to show only header part of card in resizable layout.",
+                  "description": "Represents if user wants to show only header part of card in resizable layout",
                   "type": "boolean"
                 },
                 "minimumTitleRow": {
-                  "description": "If the user wants to show more text in title then he or she can configure no of lines to be shown in title(Maximum allowed 3 lines).",
+                  "description": "If user wants to show more text in title then he/she can configure no of lines to be shown in title(Maximum allowed 3 lines)",
                   "type": "number"
                 },
                 "minimumSubTitleRow": {
-                  "description": "If the user wants to show more text in title then he or she can configure no of lines to be shown in sub-title(Maximum allowed 2 lines).",
+                  "description": "If user wants to show more text in title then he/she can configure no of lines to be shown in sub-title(Maximum allowed 2 lines)",
                   "type": "number"
                 }
               },
@@ -1288,23 +1328,23 @@
               "type": "object",
               "properties": {
                 "cols": {
-                  "description": "Represents the number of the number of grid columns.",
+                  "description": "Represents the number of the number of grid columns",
                   "type": "number"
                 },
                 "rows": {
-                  "description": "Represents the number of the number of grid rows.",
+                  "description": "Represents the number of the number of grid rows",
                   "type": "number"
                 },
                 "showOnlyHeader": {
-                  "description": "Represents if user wants to show only header part of card in resizable layout.",
+                  "description": "Represents if user wants to show only header part of card in resizable layout",
                   "type": "boolean"
                 },
                 "minimumTitleRow": {
-                  "description": "If the user wants to show more text in title then he or she can configure no of lines to be shown in title(Maximum allowed 3 lines).",
+                  "description": "If user wants to show more text in title then he/she can configure no of lines to be shown in title(Maximum allowed 3 lines)",
                   "type": "number"
                 },
                 "minimumSubTitleRow": {
-                  "description": "If the user wants to show more text in title then he or she can configure no of lines to be shown in sub-title(Maximum allowed 2 lines).",
+                  "description": "If user wants to show more text in title then he/she can configure no of lines to be shown in sub-title(Maximum allowed 2 lines)",
                   "type": "number"
                 }
               },

package/dist/src/sync/common/generate/objectPage.d.ts

@@ -1,6 +1,6 @@
 import type { ConvertedMetadata, EntitySet, EntityType } from '@sap-ux/vocabularies-types';
 import type { FacetConfig, GenerateAppSchemaParameters } from '@sap/ux-specification-types';
-import { FioriElementsVersion, SectionType } from '@sap/ux-specification-types';
+import { FioriElementsVersion, SectionType, v2 } from '@sap/ux-specification-types';
 import type { Definition } from 'typescript-json-schema';
 /**
  * Adds definitions for forms in object page sections to the app schema
@@ -34,17 +34,18 @@ export declare function getActionNameAndId(item: any, oDataServiceAVT: Converted
  * Add Object Page Footer Action Buttons to app-specific schema
  *
  * @param {object} appSchema Schema of the app
- * @param {EntityType} entityType - current entity type
- * @param {ConvertedMetadata} oDataServiceAVT - complete service information, as returned by annotation vocabularies tool
+ * @param {GenerateAppSchemaParameters} generateParameters - Schema parameters
+ * @param {FioriElementsVersion} version - Fiori elements versions
+ * @param {SapUiAppPagesV2} pages - pages found in manifest
  */
-export declare function addFooterActions(appSchema: Definition, generateParameters: GenerateAppSchemaParameters): void;
+export declare function addFooterActions(appSchema: Definition, generateParameters: GenerateAppSchemaParameters, version?: FioriElementsVersion, pages?: v2.SapUiAppPagesV2): void;
 /**
  * Add Object Page Header Action Buttons to app-specific schema
  * @param {object} appSchema Schema of the app
  * @param {EntityType} entityType - current entity type
  * @param {ConvertedMetadata} oDataServiceAVT - complete service information, as returned by annotation vocabularies tool
  */
-export declare function addHeaderActions(appSchema: Definition, entityType: EntityType, oDataServiceAVT: ConvertedMetadata, addHeaderActionCallBack: any): void;
+export declare function addHeaderActions(appSchema: Definition, entityType: EntityType, oDataServiceAVT: ConvertedMetadata, addHeaderActionCallBack: any, isV2?: boolean): void;
 /**
  * Adds common Object Page Header definitions to the app schema
  * @param appSchema - app-specific JSOn schema

package/dist/src/sync/common/generate/objectPage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"objectPage.d.ts","sourceRoot":"","sources":["../../../../../src/sync/common/generate/objectPage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAI3F,OAAO,KAAK,EAAE,WAAW,EAAE,2BAA2B,EAAE,MAAM,6BAA6B,CAAC;AAE5F,OAAO,EAGH,oBAAoB,EAGpB,WAAW,EAEd,MAAM,6BAA6B,CAAC;AAUrC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AA4WzD;;;;;;;;;GASG;AACH,wBAAgB,UAAU,CACtB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,WAAW,EACpB,gBAAgB,EAAE,UAAU,EAC5B,SAAS,EAAE,UAAU,EACrB,OAAO,EAAE,oBAAoB,EAC7B,QAAQ,EAAE,MAAM,GACjB,MAAM,GAAG,SAAS,CAwDpB;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,oBAAoB,EAAE,MAAM,EAAE,eAAe,EAAE,iBAAiB,GAAG,MAAM,CAarG;AAED;;;;GAIG;AAEH,wBAAgB,kBAAkB,CAC9B,IAAI,EAAE,GAAG,EACT,eAAe,EAAE,iBAAiB,GACnC;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,CA0B7D;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,UAAU,EAAE,kBAAkB,EAAE,2BAA2B,GAAG,IAAI,CA+D7G;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAC5B,SAAS,EAAE,UAAU,EACrB,UAAU,EAAE,UAAU,EACtB,eAAe,EAAE,iBAAiB,EAClC,uBAAuB,KAAA,GACxB,IAAI,CAoCN;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,GAAG,IAAI,CAUzF;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,CAAC,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,iBAAiB,GAAG,SAAS,GAAG,SAAS,CAMlH"}
+{"version":3,"file":"objectPage.d.ts","sourceRoot":"","sources":["../../../../../src/sync/common/generate/objectPage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAI3F,OAAO,KAAK,EAAE,WAAW,EAAE,2BAA2B,EAAE,MAAM,6BAA6B,CAAC;AAC5F,OAAO,EAGH,oBAAoB,EAIpB,WAAW,EAEX,EAAE,EACL,MAAM,6BAA6B,CAAC;AAUrC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AA6WzD;;;;;;;;;GASG;AACH,wBAAgB,UAAU,CACtB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,WAAW,EACpB,gBAAgB,EAAE,UAAU,EAC5B,SAAS,EAAE,UAAU,EACrB,OAAO,EAAE,oBAAoB,EAC7B,QAAQ,EAAE,MAAM,GACjB,MAAM,GAAG,SAAS,CAwDpB;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,oBAAoB,EAAE,MAAM,EAAE,eAAe,EAAE,iBAAiB,GAAG,MAAM,CAarG;AAED;;;;GAIG;AAEH,wBAAgB,kBAAkB,CAC9B,IAAI,EAAE,GAAG,EACT,eAAe,EAAE,iBAAiB,GACnC;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,CA0B7D;AAsBD;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAC5B,SAAS,EAAE,UAAU,EACrB,kBAAkB,EAAE,2BAA2B,EAC/C,OAAO,CAAC,EAAE,oBAAoB,EAC9B,KAAK,CAAC,EAAE,EAAE,CAAC,eAAe,GAC3B,IAAI,CAsEN;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAC5B,SAAS,EAAE,UAAU,EACrB,UAAU,EAAE,UAAU,EACtB,eAAe,EAAE,iBAAiB,EAClC,uBAAuB,KAAA,EACvB,IAAI,UAAQ,GACb,IAAI,CAsCN;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,GAAG,IAAI,CAYzF;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,CAAC,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,iBAAiB,GAAG,SAAS,GAAG,SAAS,CAMlH"}