@sap/ux-specification 1.96.26 → 1.96.27

package/dist/schemas/v2/ObjectPageConfig.json

@@ -35,7 +35,7 @@
       "artifactType": "Manifest"
     },
     "header": {
-      "$ref": "#/definitions/ObjectPageHeader<GenericActions>"
+      "$ref": "#/definitions/ObjectPageHeader"
     },
     "layout": {
       "$ref": "#/definitions/ObjectPageLayout"
@@ -70,7 +70,7 @@
       },
       "additionalProperties": false
     },
-    "ObjectPageHeader<GenericActions>": {
+    "ObjectPageHeader": {
       "description": "Header",
       "isViewNode": true,
       "type": "object",
@@ -105,7 +105,7 @@
           "controlType": "sap.f.Avatar"
         },
         "actions": {
-          "$ref": "#/definitions/GenericActions",
+          "$ref": "#/definitions/HeaderActions",
           "description": "Set properties of actions on Object Page Header"
         }
       },
@@ -118,7 +118,7 @@
       ],
       "type": "string"
     },
-    "GenericActions": {
+    "HeaderActions": {
       "type": "object",
       "additionalProperties": {
         "$ref": "#/definitions/HeaderAction"

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,39 @@
       },
       "additionalProperties": false
     },
-    "GenericActions": {
+    "HeaderActions": {
       "type": "object",
       "additionalProperties": {
-        "type": "object",
-        "properties": {},
-        "additionalProperties": true
+        "$ref": "#/definitions/HeaderActionV4"
       }
     },
+    "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 +371,7 @@
             "$ref": "#/definitions/ObjectPageToolBarAction"
           },
           {
-            "$ref": "#/definitions/CustomActionOP"
+            "$ref": "#/definitions/CustomTableActionOP"
           }
         ]
       }
@@ -371,7 +396,7 @@
       ],
       "type": "string"
     },
-    "CustomActionOP": {
+    "CustomTableActionOP": {
       "type": "object",
       "properties": {
         "position": {
@@ -379,6 +404,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 +420,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": [
@@ -595,11 +620,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 +633,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 +748,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 +815,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 +840,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 +1022,35 @@
     "ObjectPageFooterActions": {
       "type": "object",
       "additionalProperties": {
-        "type": "object",
-        "properties": {},
-        "additionalProperties": true
+        "$ref": "#/definitions/FooterActionV4"
       }
+    },
+    "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/src/api.js

@@ -175,7 +175,7 @@ exports.importProjectSchema = importProjectSchema;
 function getApiVersion() {
     return {
         version: '5',
-        fpmWriter: '4'
+        fpmWriter: '5'
     };
 }
 exports.getApiVersion = getApiVersion;

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

@@ -5,13 +5,14 @@ import type { Definition } from 'typescript-json-schema';
 /**
  * Adds definitions for forms in object page sections to the app schema
  * @param {SectionType} sectionType - prefix to distinguish Section and HeaderSection
- * @param {FacetConfig} section - facet or section in the FE core model
+ * @param {FacetConfig} section - section definition, as prepared from the annotations
  * @param {object} appSchemaSection - current definition of facet or section in the JSON schema
  * @param {object} appSchema - app specific schema that gets enhanced
  * @param {FioriElementsVersion} version - Fiori Elements version
+ * @param {string} facetKey - facet key
  * @returns {string | undefined} target id of form
  */
-export declare function handleForm(sectionType: SectionType, section: FacetConfig, appSchemaSection: Definition, appSchema: Definition, version: FioriElementsVersion, withActions?: boolean): string | undefined;
+export declare function handleForm(sectionType: SectionType, section: FacetConfig, appSchemaSection: Definition, appSchema: Definition, version: FioriElementsVersion, facetKey: string): string | undefined;
 /**
  * Replaces an alias in an annotation ID or reference, based on the AVT references' list
  * @param annotationIdentifier - annotation ID or reference
@@ -25,23 +26,26 @@ export declare function replaceAlias(annotationIdentifier: string, oDataServiceA
  * @param entityType - entity type by AVT
  * @returns an object comprising action name and action id
  */
-export declare function getActionNameAndId(action: string, entityType: EntityType): {
+export declare function getActionNameAndId(item: any, entityType: EntityType, oDataServiceAVT: ConvertedMetadata): {
     actionName: string;
     actionId: string;
+    namespace: string;
 };
 /**
  * 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 {function} addFooterActionCallBack - Callback function, either V2 or V4
  */
-export declare function addFooterActions(appSchema: Definition, generateParameters: GenerateAppSchemaParameters): void;
+export declare function addFooterActions(appSchema: Definition, generateParameters: GenerateAppSchemaParameters, version: FioriElementsVersion, addFooterActionCallBack: any): 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
+ * @param {function} addHeaderActionCallBack - Callback function, either V2 or V4
  */
 export declare function addHeaderActions(appSchema: Definition, entityType: EntityType, oDataServiceAVT: ConvertedMetadata, addHeaderActionCallBack: any): void;
 /**

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;AAC5F,OAAO,EAGH,oBAAoB,EAGpB,WAAW,EAEd,MAAM,6BAA6B,CAAC;AASrC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AA8JzD;;;;;;;;GAQG;AACH,wBAAgB,UAAU,CACtB,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,WAAW,EACpB,gBAAgB,EAAE,UAAU,EAC5B,SAAS,EAAE,UAAU,EACrB,OAAO,EAAE,oBAAoB,EAC7B,WAAW,UAAO,GACnB,MAAM,GAAG,SAAS,CA0EpB;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,oBAAoB,EAAE,MAAM,EAAE,eAAe,EAAE,iBAAiB,GAAG,MAAM,CAarG;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,GAAG;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAenH;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;AAE5F,OAAO,EAGH,oBAAoB,EAGpB,WAAW,EAEd,MAAM,6BAA6B,CAAC;AASrC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAmTzD;;;;;;;;;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;;;;;GAKG;AAEH,wBAAgB,kBAAkB,CAC9B,IAAI,EAAE,GAAG,EACT,UAAU,EAAE,UAAU,EACtB,eAAe,EAAE,iBAAiB,GACnC;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,CA0B7D;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAC5B,SAAS,EAAE,UAAU,EACrB,kBAAkB,EAAE,2BAA2B,EAC/C,OAAO,EAAE,oBAAoB,EAC7B,uBAAuB,KAAA,GACxB,IAAI,CAuCN;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAC5B,SAAS,EAAE,UAAU,EACrB,UAAU,EAAE,UAAU,EACtB,eAAe,EAAE,iBAAiB,EAClC,uBAAuB,KAAA,GACxB,IAAI,CAkCN;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"}