@sap/ux-specification 1.96.26 → 1.96.28

package/dist/schemas/v4/ListReportConfig.json

@@ -132,6 +132,10 @@
           "$ref": "#/definitions/SelectType",
           "description": "Enables single selection for a bound action",
           "artifactType": "Manifest"
+        },
+        "afterExecution": {
+          "$ref": "#/definitions/ActionAfterExecutionConfigurationToolBarLR",
+          "description": "Settings that are only relevant for actions (associated with a UI.DataFieldForAction annotation)"
         }
       },
       "additionalProperties": false
@@ -143,6 +147,22 @@
       ],
       "type": "string"
     },
+    "ActionAfterExecutionConfigurationToolBarLR": {
+      "type": "object",
+      "properties": {
+        "navigateToInstance": {
+          "description": "By default, a navigation is automatically triggered after an action execution. If applications want to disable the navigation, they can do so using the manifest setting “navigateToInstance”.",
+          "type": "boolean",
+          "artifactType": "Manifest"
+        },
+        "enableAutoScroll": {
+          "description": "The \"enableAutoScroll\" allows you to scroll to the newly created or changed item after execution of an action",
+          "type": "boolean",
+          "artifactType": "Manifest"
+        }
+      },
+      "additionalProperties": false
+    },
     "ViewTableCustomAction": {
       "type": "object",
       "properties": {
@@ -151,6 +171,11 @@
           "description": "Defines the position of the action relative to other actions.",
           "artifactType": "Manifest"
         },
+        "requiresSelection": {
+          "description": "Indicates whether the action requires a selection of items.",
+          "artifactType": "Manifest",
+          "type": "boolean"
+        },
         "text": {
           "description": "The text that is displayed on the button (typically a binding to an i18n entry).",
           "i18nClassification": "COL: Custom action text",
@@ -162,11 +187,6 @@
           "artifactType": "Manifest",
           "type": "string"
         },
-        "requiresSelection": {
-          "description": "Indicates whether the action requires a selection of items.",
-          "artifactType": "Manifest",
-          "type": "boolean"
-        },
         "visible": {
           "pattern": "^(false|true)$|^{[A-Za-z0-9{}&$!@#%? _|,<>'()[\\]\\/:=.]+}$",
           "anyOf": [
@@ -371,7 +391,7 @@
             "$ref": "#/definitions/ToolBarAction"
           },
           {
-            "$ref": "#/definitions/CustomAction"
+            "$ref": "#/definitions/CustomTableAction"
           }
         ]
       }
@@ -385,15 +405,23 @@
           "$ref": "#/definitions/SelectType",
           "description": "Enables single selection for a bound action",
           "artifactType": "Manifest"
+        },
+        "afterExecution": {
+          "$ref": "#/definitions/ActionAfterExecutionConfigurationToolBarLR",
+          "description": "Settings that are only relevant for actions (associated with a UI.DataFieldForAction annotation)",
+          "artifactType": "Manifest"
         }
       },
       "additionalProperties": false
     },
-    "CustomAction": {
-      "description": "Action",
-      "isViewNode": true,
+    "CustomTableAction": {
       "type": "object",
       "properties": {
+        "requiresSelection": {
+          "description": "Indicates whether the action requires a selection of items.",
+          "artifactType": "Manifest",
+          "type": "boolean"
+        },
         "text": {
           "description": "The text that is displayed on the button (typically a binding to an i18n entry).",
           "i18nClassification": "COL: Custom action text",
@@ -410,11 +438,6 @@
           "artifactType": "Manifest",
           "type": "string"
         },
-        "requiresSelection": {
-          "description": "Indicates whether the action requires a selection of items.",
-          "artifactType": "Manifest",
-          "type": "boolean"
-        },
         "visible": {
           "pattern": "^(false|true)$|^{[A-Za-z0-9{}&$!@#%? _|,<>'()[\\]\\/:=.]+}$",
           "anyOf": [
@@ -547,7 +570,7 @@
           "artifactType": "Manifest"
         },
         "enableAutoScroll": {
-          "description": "The \"enableAutoScroll\" allows you to scroll to the newly created or change item after execution of an action",
+          "description": "The \"enableAutoScroll\" allows you to scroll to the newly created or changed item after execution of an action",
           "type": "boolean",
           "artifactType": "Manifest"
         }

package/dist/schemas/v4/ObjectPageConfig.json

@@ -2,7 +2,7 @@
   "type": "object",
   "properties": {
     "header": {
-      "$ref": "#/definitions/ObjectPageHeader<GenericActions>"
+      "$ref": "#/definitions/ObjectPageHeader"
     },
     "layout": {
       "$ref": "#/definitions/ObjectPageLayout"
@@ -31,7 +31,7 @@
   },
   "additionalProperties": false,
   "definitions": {
-    "ObjectPageHeader<GenericActions>": {
+    "ObjectPageHeader": {
       "description": "Header",
       "isViewNode": true,
       "type": "object",
@@ -57,7 +57,7 @@
           "artifactType": "Manifest"
         },
         "actions": {
-          "$ref": "#/definitions/GenericActions"
+          "$ref": "#/definitions/HeaderActions"
         },
         "sections": {
           "$ref": "#/definitions/HeaderSections"
@@ -65,14 +65,134 @@
       },
       "additionalProperties": false
     },
-    "GenericActions": {
+    "HeaderActions": {
       "type": "object",
       "additionalProperties": {
-        "type": "object",
-        "properties": {},
-        "additionalProperties": true
+        "anyOf": [
+          {
+            "$ref": "#/definitions/CustomHeaderActionOP"
+          },
+          {
+            "$ref": "#/definitions/HeaderActionV4"
+          }
+        ]
       }
     },
+    "CustomHeaderActionOP": {
+      "type": "object",
+      "properties": {
+        "position": {
+          "$ref": "#/definitions/CustomHeaderActionPositionOP",
+          "description": "Defines the position of the action relative to other actions.",
+          "artifactType": "Manifest"
+        },
+        "text": {
+          "description": "The text that is displayed on the button (typically a binding to an i18n entry).",
+          "i18nClassification": "COL: Custom action text",
+          "artifactType": "Manifest",
+          "type": "string"
+        },
+        "press": {
+          "description": "Relevant for extension actions; allows the definition of a target action handler.",
+          "artifactType": "Manifest",
+          "type": "string"
+        },
+        "visible": {
+          "pattern": "^(false|true)$|^{[A-Za-z0-9{}&$!@#%? _|,<>'()[\\]\\/:=.]+}$",
+          "anyOf": [
+            {
+              "enum": [
+                false,
+                true,
+                "{ui>/editable}",
+                "{= !${ui>/editable}}"
+              ]
+            },
+            {
+              "type": "string"
+            }
+          ],
+          "description": "Whether the action button should be visible on the screen.",
+          "artifactType": "Manifest"
+        },
+        "enabled": {
+          "pattern": "^(false|true)$|^{[A-Za-z0-9{}&$!@#%? _|,<>'()[\\]\\/:=.]+}$",
+          "anyOf": [
+            {
+              "enum": [
+                false,
+                true,
+                "{ui>/editable}",
+                "{= !${ui>/editable}}"
+              ]
+            },
+            {
+              "type": "string"
+            }
+          ],
+          "description": "Whether the action button should be enabled. Default value is `true`.",
+          "artifactType": "Manifest"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "press",
+        "text"
+      ]
+    },
+    "CustomHeaderActionPositionOP": {
+      "type": "object",
+      "properties": {
+        "anchor": {
+          "description": "The key of another action to be used as placement anchor.",
+          "artifactType": "Manifest",
+          "type": "string"
+        },
+        "placement": {
+          "$ref": "#/definitions/ActionPlacement",
+          "description": "Define the placement, either before or after the anchor action.",
+          "artifactType": "Manifest"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "placement"
+      ]
+    },
+    "ActionPlacement": {
+      "enum": [
+        "After",
+        "Before"
+      ],
+      "type": "string"
+    },
+    "HeaderActionV4": {
+      "type": "object",
+      "properties": {
+        "afterExecution": {
+          "$ref": "#/definitions/ActionAfterExecutionConfigurationHeader",
+          "description": "Settings that are only relevant for actions (associated with a UI.DataFieldForAction annotation)",
+          "artifactType": "Manifest"
+        }
+      },
+      "additionalProperties": false
+    },
+    "ActionAfterExecutionConfigurationHeader": {
+      "type": "object",
+      "properties": {
+        "navigateToInstance": {
+          "description": "By default, a navigation is automatically triggered after an action execution. If applications want to disable the navigation, they can do so using the manifest setting “navigateToInstance”.",
+          "type": "boolean",
+          "artifactType": "Manifest"
+        },
+        "enableAutoScroll": {
+          "description": "The \"enableAutoScroll\" allows you to scroll to the newly created or changed item after execution of an action",
+          "type": "boolean",
+          "artifactType": "Manifest"
+        }
+      },
+      "additionalProperties": false
+    },
     "HeaderSections": {
       "description": "Header Sections",
       "isViewNode": true,
@@ -346,7 +466,7 @@
             "$ref": "#/definitions/ObjectPageToolBarAction"
           },
           {
-            "$ref": "#/definitions/CustomActionOP"
+            "$ref": "#/definitions/CustomTableActionOP"
           }
         ]
       }
@@ -371,7 +491,7 @@
       ],
       "type": "string"
     },
-    "CustomActionOP": {
+    "CustomTableActionOP": {
       "type": "object",
       "properties": {
         "position": {
@@ -379,6 +499,11 @@
           "description": "Defines the position of the action relative to other actions.",
           "artifactType": "Manifest"
         },
+        "requiresSelection": {
+          "description": "Indicates whether the action requires a selection of items.",
+          "artifactType": "Manifest",
+          "type": "boolean"
+        },
         "text": {
           "description": "The text that is displayed on the button (typically a binding to an i18n entry).",
           "i18nClassification": "COL: Custom action text",
@@ -390,11 +515,6 @@
           "artifactType": "Manifest",
           "type": "string"
         },
-        "requiresSelection": {
-          "description": "Indicates whether the action requires a selection of items.",
-          "artifactType": "Manifest",
-          "type": "boolean"
-        },
         "visible": {
           "pattern": "^(false|true)$|^{[A-Za-z0-9{}&$!@#%? _|,<>'()[\\]\\/:=.]+}$",
           "anyOf": [
@@ -457,13 +577,6 @@
         "placement"
       ]
     },
-    "ActionPlacement": {
-      "enum": [
-        "After",
-        "Before"
-      ],
-      "type": "string"
-    },
     "TableCreationModeOP": {
       "type": "object",
       "properties": {
@@ -595,11 +708,6 @@
       "isViewNode": true,
       "type": "object",
       "properties": {
-        "afterExecution": {
-          "$ref": "#/definitions/ActionAfterExecutionConfigurationOP",
-          "description": "Settings that are only relevant for actions (associated with a UI.DataFieldForAction annotation)",
-          "artifactType": "Manifest"
-        },
         "width": {
           "description": "A string type that represents CSS size values.\nRefer to https://openui5.hana.ondemand.com/api/sap.ui.core.CSSSize.",
           "type": "string",
@@ -613,22 +721,6 @@
       },
       "additionalProperties": false
     },
-    "ActionAfterExecutionConfigurationOP": {
-      "type": "object",
-      "properties": {
-        "navigateToInstance": {
-          "description": "By default, a navigation is automatically triggered after an action execution. If applications want to disable the navigation, they can do so using the manifest setting “navigateToInstance”.",
-          "type": "boolean",
-          "artifactType": "Manifest"
-        },
-        "enableAutoScroll": {
-          "description": "The \"enableAutoScroll\" allows you to scroll to the newly created or change item after execution of an action",
-          "type": "boolean",
-          "artifactType": "Manifest"
-        }
-      },
-      "additionalProperties": false
-    },
     "TableCustomColumnOP": {
       "type": "object",
       "properties": {
@@ -744,27 +836,55 @@
       "isViewNode": true,
       "type": "object",
       "properties": {
+        "fields": {
+          "$ref": "#/definitions/ObjectPageFormFields"
+        },
         "actions": {
-          "$ref": "#/definitions/FormCustomActionsOP"
+          "$ref": "#/definitions/ObjectPageFormActions"
         }
       },
       "additionalProperties": false
     },
-    "FormCustomActionsOP": {
+    "ObjectPageFormFields": {
       "type": "object",
       "additionalProperties": {
-        "$ref": "#/definitions/FormCustomActionOP"
+        "type": "object",
+        "properties": {},
+        "additionalProperties": true
       }
     },
-    "FormCustomActionOP": {
+    "ObjectPageFormActions": {
+      "type": "object",
+      "additionalProperties": {
+        "anyOf": [
+          {
+            "$ref": "#/definitions/CustomFormActionOP"
+          },
+          {
+            "$ref": "#/definitions/FormAction"
+          }
+        ]
+      }
+    },
+    "CustomFormActionOP": {
       "type": "object",
       "properties": {
+        "position": {
+          "$ref": "#/definitions/CustomActionPositionOP",
+          "description": "Defines the position of the action relative to other actions.",
+          "artifactType": "Manifest"
+        },
         "text": {
           "description": "The text that is displayed on the button (typically a binding to an i18n entry).",
           "i18nClassification": "COL: Custom action text",
           "artifactType": "Manifest",
           "type": "string"
         },
+        "press": {
+          "description": "Relevant for extension actions; allows the definition of a target action handler.",
+          "artifactType": "Manifest",
+          "type": "string"
+        },
         "visible": {
           "pattern": "^(false|true)$|^{[A-Za-z0-9{}&$!@#%? _|,<>'()[\\]\\/:=.]+}$",
           "anyOf": [
@@ -783,16 +903,6 @@
           "description": "Whether the action button should be visible on the screen.",
           "artifactType": "Manifest"
         },
-        "position": {
-          "$ref": "#/definitions/CustomActionPositionOP",
-          "description": "Defines the position of the action relative to other actions.",
-          "artifactType": "Manifest"
-        },
-        "press": {
-          "description": "Relevant for extension actions; allows the definition of a target action handler.",
-          "artifactType": "Manifest",
-          "type": "string"
-        },
         "enabled": {
           "pattern": "^(false|true)$|^{[A-Za-z0-9{}&$!@#%? _|,<>'()[\\]\\/:=.]+}$",
           "anyOf": [
@@ -818,6 +928,33 @@
         "text"
       ]
     },
+    "FormAction": {
+      "type": "object",
+      "properties": {
+        "afterExecution": {
+          "$ref": "#/definitions/ActionAfterExecutionConfigurationForm",
+          "description": "Settings that are only relevant for actions (associated with a UI.DataFieldForAction annotation)",
+          "artifactType": "Manifest"
+        }
+      },
+      "additionalProperties": false
+    },
+    "ActionAfterExecutionConfigurationForm": {
+      "type": "object",
+      "properties": {
+        "navigateToInstance": {
+          "description": "By default, a navigation is automatically triggered after an action execution. If applications want to disable the navigation, they can do so using the manifest setting “navigateToInstance”.",
+          "type": "boolean",
+          "artifactType": "Manifest"
+        },
+        "enableAutoScroll": {
+          "description": "The \"enableAutoScroll\" allows you to scroll to the newly created or changed item after execution of an action",
+          "type": "boolean",
+          "artifactType": "Manifest"
+        }
+      },
+      "additionalProperties": false
+    },
     "ObjectPageSectionDataPoint": {
       "type": "object",
       "properties": {
@@ -973,10 +1110,123 @@
     "ObjectPageFooterActions": {
       "type": "object",
       "additionalProperties": {
-        "type": "object",
-        "properties": {},
-        "additionalProperties": true
+        "anyOf": [
+          {
+            "$ref": "#/definitions/CustomFooterActionOP"
+          },
+          {
+            "$ref": "#/definitions/FooterActionV4"
+          }
+        ]
       }
+    },
+    "CustomFooterActionOP": {
+      "type": "object",
+      "properties": {
+        "position": {
+          "$ref": "#/definitions/CustomFooterActionPositionOP",
+          "description": "Defines the position of the action relative to other actions.",
+          "artifactType": "Manifest"
+        },
+        "text": {
+          "description": "The text that is displayed on the button (typically a binding to an i18n entry).",
+          "i18nClassification": "COL: Custom action text",
+          "artifactType": "Manifest",
+          "type": "string"
+        },
+        "press": {
+          "description": "Relevant for extension actions; allows the definition of a target action handler.",
+          "artifactType": "Manifest",
+          "type": "string"
+        },
+        "visible": {
+          "pattern": "^(false|true)$|^{[A-Za-z0-9{}&$!@#%? _|,<>'()[\\]\\/:=.]+}$",
+          "anyOf": [
+            {
+              "enum": [
+                false,
+                true,
+                "{ui>/editable}",
+                "{= !${ui>/editable}}"
+              ]
+            },
+            {
+              "type": "string"
+            }
+          ],
+          "description": "Whether the action button should be visible on the screen.",
+          "artifactType": "Manifest"
+        },
+        "enabled": {
+          "pattern": "^(false|true)$|^{[A-Za-z0-9{}&$!@#%? _|,<>'()[\\]\\/:=.]+}$",
+          "anyOf": [
+            {
+              "enum": [
+                false,
+                true,
+                "{ui>/editable}",
+                "{= !${ui>/editable}}"
+              ]
+            },
+            {
+              "type": "string"
+            }
+          ],
+          "description": "Whether the action button should be enabled. Default value is `true`.",
+          "artifactType": "Manifest"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "press",
+        "text"
+      ]
+    },
+    "CustomFooterActionPositionOP": {
+      "type": "object",
+      "properties": {
+        "anchor": {
+          "description": "The key of another action to be used as placement anchor.",
+          "artifactType": "Manifest",
+          "type": "string"
+        },
+        "placement": {
+          "$ref": "#/definitions/ActionPlacement",
+          "description": "Define the placement, either before or after the anchor action.",
+          "artifactType": "Manifest"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "placement"
+      ]
+    },
+    "FooterActionV4": {
+      "type": "object",
+      "properties": {
+        "afterExecution": {
+          "$ref": "#/definitions/ActionAfterExecutionConfigurationFooter",
+          "description": "Settings that are only relevant for actions (associated with a UI.DataFieldForAction annotation)",
+          "artifactType": "Manifest"
+        }
+      },
+      "additionalProperties": false
+    },
+    "ActionAfterExecutionConfigurationFooter": {
+      "type": "object",
+      "properties": {
+        "navigateToInstance": {
+          "description": "By default, a navigation is automatically triggered after an action execution. If applications want to disable the navigation, they can do so using the manifest setting “navigateToInstance”.",
+          "type": "boolean",
+          "artifactType": "Manifest"
+        },
+        "enableAutoScroll": {
+          "description": "The \"enableAutoScroll\" allows you to scroll to the newly created or changed item after execution of an action",
+          "type": "boolean",
+          "artifactType": "Manifest"
+        }
+      },
+      "additionalProperties": false
     }
   },
   "$schema": "http://json-schema.org/draft-07/schema#"

package/dist/scripts/macros/api.d.ts

@@ -0,0 +1,9 @@
+import type { MacrosAPI } from './types';
+/**
+ * Method returns "sap.fe.macros" api for passed specification version.
+ * @param {string} specVersion Specification version.
+ * @param {boolean} [useNightlyBuild] If true, then dev/nightly build version will be retrieved.
+ * @returns {Promise<MacrosAPI | undefined>} Promise to "sap.fe.macros" api.
+ */
+export declare function getMacrosAPI(specVersion: string, useNightlyBuild?: boolean, overwriteCache?: boolean): Promise<MacrosAPI | undefined>;
+//# sourceMappingURL=api.d.ts.map

package/dist/scripts/macros/api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../../scripts/macros/api.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAqIzC;;;;;GAKG;AACH,wBAAsB,YAAY,CAC9B,WAAW,EAAE,MAAM,EACnB,eAAe,UAAQ,EACvB,cAAc,UAAQ,GACvB,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC,CA+BhC"}