@sap/ux-specification 1.124.19 → 1.124.21

package/dist/specification/src/sync/common/DataFieldStrategy.js

@@ -0,0 +1,357 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dataFieldStrategyContext = exports.DataFieldStrategyContext = exports.DataFieldStrategy = void 0;
+const utils_1 = require("./utils");
+const StableIdHelper_1 = require("../v4/utils/StableIdHelper");
+const objectPage_1 = require("./generate/objectPage");
+const utils_2 = require("../v4/utils/utils");
+class DataFieldStrategy {
+    /**
+     * Adds a new definition based on the provided parameters.
+     *
+     * @param {AddDefinitionParams} data - An object containing the parameters required to add the definition.
+     * @returns {void}
+     */
+    addDefinition(data) {
+        (0, objectPage_1.addDataFieldDefinition)(data);
+    }
+    /**
+     * Adds a new line item definition to the system based on the provided parameters.
+     *
+     * @param {AddLineItemDefinitionParams} data - The parameters used to define the new line item.
+     * @returns {void} Does not return a value.
+     */
+    addLineItemDefinition(data) {
+        (0, utils_2.addLineItemRecordToSchema)(data);
+    }
+}
+exports.DataFieldStrategy = DataFieldStrategy;
+class DataFieldForActionStrategy extends DataFieldStrategy {
+    /**
+     * Generates a stable identifier based on the given data field.
+     *
+     * @param {DataFieldForActionAbstractTypes} dataField - The data field used to generate the stable identifier.
+     * @returns {string} A stable identifier string derived from the provided data field.
+     */
+    generateStableId(dataField) {
+        return (0, StableIdHelper_1.prepareId)('DataFieldForAction::' + dataField.Action);
+    }
+    /**
+     * Generates a description for the provided data field based on its label and context.
+     *
+     * @param {DataFieldForActionAbstractTypes} dataField - The data field for which the description is generated.
+     * @param {EntityType} entityType - The type of the entity associated with the data field.
+     * @returns {string} The generated description for the specified data field.
+     */
+    generateDescription(dataField, entityType) {
+        const dataFieldLabel = (0, utils_1.getLabel)(dataField.Label, entityType);
+        return (0, utils_1.getDescriptionForActionBasedDataFields)(dataField, dataFieldLabel);
+    }
+    /**
+     * Adds a new definition for an action.
+     * This method processes the given data and integrates it into the action definition structure.
+     *
+     * @param {AddDefinitionParams} data - An object containing the necessary parameters for the action definition.
+     * @returns {void} This method does not return a value.
+     */
+    addDefinition(data) {
+        (0, objectPage_1.addDataFieldForActionAndActionGroupDefinition)(data);
+    }
+    /**
+     * Adds a line item definition to the schema based on the provided data.
+     * Determines the appropriate action based on the properties of the line item record.
+     *
+     * @param {object} data - The parameters for adding the line item definition.
+     * @param {object} data.lineItemRecord - The line item record object containing specific properties.
+     * @param {object} data.lineItemDefinition - The line item definition object.
+     * @returns {void} This method does not return a value.
+     */
+    addLineItemDefinition(data) {
+        (0, utils_2.addLineItemActionDefinition)(data);
+    }
+}
+class DataFieldForActionGroupStrategy extends DataFieldStrategy {
+    /**
+     * Generates a stable identifier for a given data field.
+     *
+     * @param {DataFieldForActionGroupTypes} dataField - The data field object containing necessary details for generating the stable ID.
+     * @returns {string} A stable identifier string based on the provided data field.
+     */
+    generateStableId(dataField) {
+        return (0, StableIdHelper_1.prepareId)('DataFieldForActionGroup::' + dataField.ID);
+    }
+    /**
+     * Generates a description based on the provided data field, entity type, and label.
+     *
+     * @param {DataFieldForActionGroupTypes} dataField - The data field object used to generate the description.
+     * @param {EntityType} entityType - The entity type associated with the data field.
+     * @returns {string} The generated description, which will be the data field's label, ID, or the provided default label.
+     */
+    generateDescription(dataField, entityType) {
+        const dataFieldLabel = (0, utils_1.getLabel)(dataField.Label, entityType);
+        return dataField.Label ?? dataField.ID ?? dataFieldLabel;
+    }
+    /**
+     * Adds a definition using the given data.
+     *
+     * @param {AddDefinitionParams} data - The data object containing the definition details to be added.
+     * @returns {void} Does not return a value.
+     */
+    addDefinition(data) {
+        (0, objectPage_1.addDataFieldForActionAndActionGroupDefinition)(data);
+    }
+    /**
+     * Adds a new line item definition to the schema.
+     *
+     * @param {AddLineItemDefinitionParams} data - The data for the line item definition to be added.
+     * @returns {void}
+     */
+    addLineItemDefinition(data) {
+        // Action definitions in the Macro table do not use references, so group actions are written directly to the schema
+        (0, utils_2.addGroupActionRecordToSchema)(data, !data.lineItemData?.isMacro);
+    }
+}
+class DataFieldForIntentBasedNavigationStrategy extends DataFieldStrategy {
+    /**
+     * Generates a stable ID for the given data field by concatenating a prefix with a part derived
+     * from the semantic object and action of the data field.
+     *
+     * @param {DataFieldForActionAbstractTypes} dataField - The data field for which the stable ID is to be generated.
+     * @returns {string} The generated stable ID as a string.
+     */
+    generateStableId(dataField) {
+        return 'DataFieldForIntentBasedNavigation::' + (0, StableIdHelper_1.getStableIdPartFromSemanticObjectAndAction)(dataField);
+    }
+    /**
+     * Generates a description for the given data field based on the provided entity type and label.
+     *
+     * @param {DataFieldForActionAbstractTypes} dataField - The data field for which the description is to be generated.
+     * @param {EntityType} entityType - The type of the entity associated with the data field.
+     * @returns {string} The generated description for the given data field.
+     */
+    generateDescription(dataField, entityType) {
+        const dataFieldLabel = (0, utils_1.getLabel)(dataField.Label, entityType);
+        return (0, utils_1.getDescriptionForActionBasedDataFields)(dataField, dataFieldLabel);
+    }
+    /**
+     * Adds a new definition based on the provided data.
+     *
+     * @param {AddDefinitionParams} data - The data used to create the new definition.
+     * @returns {void} - Does not return a value.
+     */
+    addDefinition(data) {
+        (0, objectPage_1.addDataFieldForActionAndActionGroupDefinition)(data);
+    }
+    /**
+     * Adds a line item definition to the schema based on the provided data.
+     * Determines the appropriate action based on the properties of the line item record.
+     *
+     * @param {object} data - The parameters for adding the line item definition.
+     * @param {object} data.lineItemRecord - The line item record object containing specific properties.
+     * @param {object} data.lineItemDefinition - The line item definition object.
+     * @returns {void} This method does not return a value.
+     */
+    addLineItemDefinition(data) {
+        (0, utils_2.addLineItemActionDefinition)(data);
+    }
+}
+class DataFieldForAnnotationStrategy extends DataFieldStrategy {
+    /**
+     * Generates a stable identifier for a given data field.
+     *
+     * @param {DataFieldForAnnotationTypes} dataField - The data field for which the stable identifier will be generated.
+     * This parameter includes information about annotations and target paths related to the field.
+     * @returns {string} The stable identifier created by combining specific parts of the data field's annotation path.
+     */
+    generateStableId(dataField) {
+        const annotationPath = dataField.Target?.$AnnotationPath ?? dataField.Target?.value ?? '';
+        return 'DataFieldForAnnotation::' + (0, StableIdHelper_1.prepareId)(annotationPath);
+    }
+    /**
+     * Generates a description for a given data field based on its label, common label, or target metadata.
+     *
+     * @param {DataFieldForAnnotationTypes} dataField - The data field object containing metadata for the data annotation.
+     * @param {EntityType} entityType - The entity type associated with the data field.
+     * @returns {string} A string representing the generated description based on the provided data field and entity type.
+     */
+    generateDescription(dataField, entityType) {
+        const propertyCommonLabel = (0, utils_1.getLabelForDataField)(dataField, entityType);
+        const dataFieldLabel = (0, utils_1.getLabel)(dataField.Label, entityType);
+        return (dataFieldLabel ||
+            propertyCommonLabel ||
+            dataField?.Target?.$target?.Title ||
+            dataField?.Target?.value?.split('UI.v1.')[1]);
+    }
+}
+class DataFieldWithActionStrategy extends DataFieldStrategy {
+    /**
+     * Generates a stable identifier for a given data field with action.
+     * The stable ID is constructed based on the Value property of the data field
+     * (if it exists) and the Action property of the data field.
+     *
+     * @param {DataFieldForActionAbstractTypes} dataField - The data field containing
+     * the action and optionally a value, used to generate the stable identifier.
+     * @returns {string} A stable identifier string constructed based on the data field's
+     * Value and Action properties.
+     */
+    generateStableId(dataField) {
+        let sIdPart = 'DataFieldWithAction::';
+        if ('Value' in dataField && dataField.Value) {
+            sIdPart += (0, StableIdHelper_1.getStableIdPartFromValue)(dataField.Value) + '::';
+        }
+        sIdPart += dataField.Action;
+        return (0, StableIdHelper_1.prepareId)(sIdPart);
+    }
+    /**
+     * Generates a description based on the provided data field, entity type, and data field label.
+     *
+     * @param {DataFieldForActionAbstractTypes} dataField - The data field for which the description is to be generated.
+     * @param {EntityType} entityType - The entity type that is associated with the data field.
+     * @returns {string} The generated description for the specified data field and entity type.
+     */
+    generateDescription(dataField, entityType) {
+        const dataFieldLabel = (0, utils_1.getLabel)(dataField.Label, entityType);
+        return (0, utils_1.getDescriptionForActionBasedDataFields)(dataField, dataFieldLabel);
+    }
+}
+class DataFieldStrategyDefault extends DataFieldStrategy {
+    /**
+     * Generates a stable identifier string for a provided data field.
+     *
+     * @param {DataField} dataField - The data field object containing the value to generate the stable identifier from.
+     * @returns {string} A stable identifier string derived from the data field value.
+     */
+    generateStableId(dataField) {
+        return (0, StableIdHelper_1.prepareId)('DataField::' + (0, StableIdHelper_1.getStableIdPartFromValue)(dataField.Value));
+    }
+    /**
+     * Generates a descriptive title for the given data field.
+     *
+     * @param {DataField} dataField - The data field for which the description will be generated.
+     * @param {EntityType} entityType - The entity type associated with the data field.
+     * @returns {string} The generated description for the data field.
+     */
+    generateDescription(dataField, entityType) {
+        const dataFieldLabel = (0, utils_1.getLabel)(dataField.Label, entityType);
+        return (0, utils_1.getTitleForDataField)(dataField, entityType, dataFieldLabel);
+    }
+}
+class DataFieldWithIntentBasedNavigationStrategy extends DataFieldStrategy {
+    /**
+     * Generates a stable ID for a given DataFieldWithIntentBasedNavigationTypes object.
+     *
+     * @param {DataFieldWithIntentBasedNavigationTypes} dataField - The data field object containing information for intent-based navigation.
+     * @returns {string} A stable ID string created based on the provided data field.
+     */
+    generateStableId(dataField) {
+        let sIdPart = 'DataFieldWithIntentBasedNavigation::';
+        sIdPart += (0, StableIdHelper_1.getStableIdPartFromValue)(dataField.Value) + '::';
+        sIdPart += (0, StableIdHelper_1.getStableIdPartFromSemanticObjectAndAction)(dataField);
+        return (0, StableIdHelper_1.prepareId)(sIdPart);
+    }
+    /**
+     * Generates a description for the given data field based on its intent-based navigation or common label.
+     *
+     * @param {DataFieldWithIntentBasedNavigationTypes} dataField - The data field for which the description is to be generated.
+     * @param {EntityType} entityType - The entity type to be used for retrieving the label of the data field.
+     * @returns {string} The generated description, either derived from the common label or the value path of the data field.
+     */
+    generateDescription(dataField, entityType) {
+        const propertyCommonLabel = (0, utils_1.getLabelForDataField)(dataField, entityType);
+        return propertyCommonLabel || dataField.Value.path;
+    }
+}
+class DataFieldWithNavigationPathStrategy extends DataFieldStrategy {
+    /**
+     * Generates a stable ID based on the given DataFieldWithNavigationPath object.
+     *
+     * @param {DataFieldWithNavigationPath} dataField - The data field from which the stable ID will be generated. It should include properties like Value and optionally Target with a $NavigationPropertyPath.
+     * @returns {string} The generated stable ID as a string.
+     */
+    generateStableId(dataField) {
+        let sIdPart = 'DataFieldWithNavigationPath::' + (0, StableIdHelper_1.getStableIdPartFromValue)(dataField.Value);
+        if (dataField.Target && dataField.Target['$NavigationPropertyPath']) {
+            sIdPart += '::' + dataField.Target['$NavigationPropertyPath'];
+        }
+        return (0, StableIdHelper_1.prepareId)(sIdPart);
+    }
+    /**
+     * Generates a description for a given data field based on the entity type and label provided.
+     *
+     * @param {DataField} dataField - The data field for which the description is being generated.
+     * @param {EntityType} entityType - The type of the entity associated with the data field.
+     * @returns {string} The generated description for the data field.
+     */
+    generateDescription(dataField, entityType) {
+        const dataFieldLabel = (0, utils_1.getLabel)(dataField.Label, entityType);
+        return (0, utils_1.getTitleForDataField)(dataField, entityType, dataFieldLabel);
+    }
+}
+class DataFieldWithUrlStrategy extends DataFieldStrategy {
+    /**
+     * Generates a stable ID based on the provided data field.
+     *
+     * @param {DataFieldWithUrl} dataField - An object containing the data field information, including a URL and a value used to generate the ID.
+     * @returns {string} A stable and unique string ID derived from the data field's value.
+     */
+    generateStableId(dataField) {
+        return (0, StableIdHelper_1.prepareId)('DataFieldWithUrl::' + (0, StableIdHelper_1.getStableIdPartFromValue)(dataField.Value));
+    }
+    /**
+     * Generates a description based on the provided data field, entity type, and label.
+     *
+     * @param {DataFieldWithUrl} dataField - The data field containing the information needed to generate the description.
+     * @param {EntityType} entityType - The type of entity associated with the data field.
+     * @returns {string} The generated description, which is determined by the provided label, the common label for the data field, or the data field's value.
+     */
+    generateDescription(dataField, entityType) {
+        const propertyCommonLabel = (0, utils_1.getLabelForDataField)(dataField, entityType);
+        const dataFieldLabel = (0, utils_1.getLabel)(dataField.Label, entityType);
+        return (dataFieldLabel ||
+            propertyCommonLabel ||
+            (typeof dataField.Value === 'string' ? dataField.Value : dataField.Value.path));
+    }
+}
+class DataFieldStrategyContext {
+    /**
+     * Constructor to initialize the strategies map with various UIAnnotationTypes and their corresponding strategies.
+     * It registers predefined strategies to handle different UI annotation types by mapping each type
+     * to the appropriate strategy instance.
+     *
+     * @returns {void} Initializes the strategies map with registered strategies. Does not return any value.
+     */
+    constructor() {
+        this.strategies = new Map();
+        this.registerStrategy("com.sap.vocabularies.UI.v1.DataFieldForAction" /* UIAnnotationTypes.DataFieldForAction */, new DataFieldForActionStrategy());
+        this.registerStrategy("com.sap.vocabularies.UI.v1.DataFieldForActionGroup" /* UIAnnotationTypes.DataFieldForActionGroup */, new DataFieldForActionGroupStrategy());
+        this.registerStrategy("com.sap.vocabularies.UI.v1.DataFieldForIntentBasedNavigation" /* UIAnnotationTypes.DataFieldForIntentBasedNavigation */, new DataFieldForIntentBasedNavigationStrategy());
+        this.registerStrategy("com.sap.vocabularies.UI.v1.DataFieldForAnnotation" /* UIAnnotationTypes.DataFieldForAnnotation */, new DataFieldForAnnotationStrategy());
+        this.registerStrategy("com.sap.vocabularies.UI.v1.DataFieldWithAction" /* UIAnnotationTypes.DataFieldWithAction */, new DataFieldWithActionStrategy());
+        this.registerStrategy("com.sap.vocabularies.UI.v1.DataField" /* UIAnnotationTypes.DataField */, new DataFieldStrategyDefault());
+        this.registerStrategy("com.sap.vocabularies.UI.v1.DataFieldWithIntentBasedNavigation" /* UIAnnotationTypes.DataFieldWithIntentBasedNavigation */, new DataFieldWithIntentBasedNavigationStrategy());
+        this.registerStrategy("com.sap.vocabularies.UI.v1.DataFieldWithNavigationPath" /* UIAnnotationTypes.DataFieldWithNavigationPath */, new DataFieldWithNavigationPathStrategy());
+        this.registerStrategy("com.sap.vocabularies.UI.v1.DataFieldWithUrl" /* UIAnnotationTypes.DataFieldWithUrl */, new DataFieldWithUrlStrategy());
+    }
+    /**
+     * Registers a strategy for a specific type of data field.
+     *
+     * @param {string} type - The type of data field to associate with the strategy.
+     * @param {DataFieldStrategy} strategy - The strategy to be registered for the specified type.
+     * @returns {void} This method does not return a value.
+     */
+    registerStrategy(type, strategy) {
+        this.strategies.set(type, strategy);
+    }
+    /**
+     * Retrieves the strategy associated with the given type.
+     *
+     * @param {string} type - The key representing the type of strategy to retrieve.
+     * @returns {DataFieldStrategy | undefined} The strategy corresponding to the provided type, or undefined if no strategy is found.
+     */
+    getStrategy(type) {
+        return this.strategies.get(type);
+    }
+}
+exports.DataFieldStrategyContext = DataFieldStrategyContext;
+exports.dataFieldStrategyContext = new DataFieldStrategyContext();
+//# sourceMappingURL=DataFieldStrategy.js.map

package/dist/specification/src/sync/common/DataFieldStrategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DataFieldStrategy.js","sourceRoot":"","sources":["../../../../../src/sync/common/DataFieldStrategy.ts"],"names":[],"mappings":";;;AAYA,mCAAuH;AACvH,+DAIoC;AACpC,sDAI+B;AAC/B,6CAK2B;AAE3B,MAAsB,iBAAiB;IAiBnC;;;;;OAKG;IACH,aAAa,CAAE,IAAyB;QACpC,IAAA,mCAAsB,EAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAED;;;;;OAKG;IACH,qBAAqB,CAAE,IAAiC;QACpD,IAAA,iCAAyB,EAAC,IAAI,CAAC,CAAC;IACpC,CAAC;CACJ;AApCD,8CAoCC;AAED,MAAM,0BAA2B,SAAQ,iBAAiB;IACtD;;;;;OAKG;IACH,gBAAgB,CAAC,SAA0C;QACvD,OAAO,IAAA,0BAAS,EAAC,sBAAsB,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;OAMG;IACH,mBAAmB,CAAC,SAA0C,EAAE,UAAsB;QAClF,MAAM,cAAc,GAAG,IAAA,gBAAQ,EAAC,SAAS,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QAC7D,OAAO,IAAA,8CAAsC,EAAC,SAAS,EAAE,cAAc,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;OAMG;IACH,aAAa,CAAC,IAAyB;QACnC,IAAA,0DAA6C,EAAC,IAAI,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;OAQG;IACH,qBAAqB,CAAE,IAAiC;QACpD,IAAA,mCAA2B,EAAC,IAAI,CAAC,CAAC;IACtC,CAAC;CACJ;AAED,MAAM,+BAAgC,SAAQ,iBAAiB;IAC3D;;;;;OAKG;IACH,gBAAgB,CAAC,SAAuC;QACpD,OAAO,IAAA,0BAAS,EAAC,2BAA2B,GAAG,SAAS,CAAC,EAAE,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;OAMG;IACH,mBAAmB,CAAC,SAAuC,EAAE,UAAsB;QAC/E,MAAM,cAAc,GAAG,IAAA,gBAAQ,EAAC,SAAS,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QAC7D,OAAQ,SAAS,CAAC,KAAgB,IAAK,SAAS,CAAC,EAAa,IAAI,cAAc,CAAC;IACrF,CAAC;IAED;;;;;OAKG;IACH,aAAa,CAAC,IAAyB;QACnC,IAAA,0DAA6C,EAAC,IAAI,CAAC,CAAC;IACxD,CAAC;IAED;;;;;OAKG;IACH,qBAAqB,CAAE,IAAiC;QACpD,mHAAmH;QACnH,IAAA,oCAA4B,EAAC,IAAI,EAAE,CAAC,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;CACJ;AAED,MAAM,yCAA0C,SAAQ,iBAAiB;IACrE;;;;;;OAMG;IACH,gBAAgB,CAAC,SAA0C;QACvD,OAAO,qCAAqC,GAAG,IAAA,2DAA0C,EAAC,SAAS,CAAC,CAAC;IACzG,CAAC;IAED;;;;;;OAMG;IACH,mBAAmB,CAAC,SAA0C,EAAE,UAAsB;QAClF,MAAM,cAAc,GAAG,IAAA,gBAAQ,EAAC,SAAS,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QAC7D,OAAO,IAAA,8CAAsC,EAAC,SAAS,EAAE,cAAc,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;OAKG;IACH,aAAa,CAAC,IAAyB;QACnC,IAAA,0DAA6C,EAAC,IAAI,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;OAQG;IACH,qBAAqB,CAAE,IAAiC;QACpD,IAAA,mCAA2B,EAAC,IAAI,CAAC,CAAC;IACtC,CAAC;CACJ;AAED,MAAM,8BAA+B,SAAQ,iBAAiB;IAC1D;;;;;;OAMG;IACH,gBAAgB,CAAC,SAAsC;QACnD,MAAM,cAAc,GAAI,SAAS,CAAC,MAAc,EAAE,eAAe,IAAI,SAAS,CAAC,MAAM,EAAE,KAAK,IAAI,EAAE,CAAC;QACnG,OAAO,0BAA0B,GAAG,IAAA,0BAAS,EAAC,cAAc,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;OAMG;IACH,mBAAmB,CAAC,SAAsC,EAAE,UAAsB;QAC9E,MAAM,mBAAmB,GAAG,IAAA,4BAAoB,EAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QACxE,MAAM,cAAc,GAAG,IAAA,gBAAQ,EAAC,SAAS,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QAC7D,OAAO,CACH,cAAc;YACd,mBAAmB;YAClB,SAAS,EAAE,MAAM,EAAE,OAAe,EAAE,KAAK;YAC1C,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAC/C,CAAC;IACN,CAAC;CACJ;AAED,MAAM,2BAA4B,SAAQ,iBAAiB;IACvD;;;;;;;;;OASG;IACH,gBAAgB,CAAC,SAA0C;QACvD,IAAI,OAAO,GAAG,uBAAuB,CAAC;QACtC,IAAI,OAAO,IAAI,SAAS,IAAI,SAAS,CAAC,KAAK,EAAE,CAAC;YAC1C,OAAO,IAAI,IAAA,yCAAwB,EAAC,SAAS,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;QAChE,CAAC;QACD,OAAO,IAAI,SAAS,CAAC,MAAM,CAAC;QAC5B,OAAO,IAAA,0BAAS,EAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;;OAMG;IACH,mBAAmB,CAAC,SAA0C,EAAE,UAAsB;QAClF,MAAM,cAAc,GAAG,IAAA,gBAAQ,EAAC,SAAS,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QAC7D,OAAO,IAAA,8CAAsC,EAAC,SAAS,EAAE,cAAc,CAAC,CAAC;IAC7E,CAAC;CACJ;AAED,MAAM,wBAAyB,SAAQ,iBAAiB;IACpD;;;;;OAKG;IACH,gBAAgB,CAAC,SAAoB;QACjC,OAAO,IAAA,0BAAS,EAAC,aAAa,GAAG,IAAA,yCAAwB,EAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;OAMG;IACH,mBAAmB,CAAC,SAAoB,EAAE,UAAsB;QAC5D,MAAM,cAAc,GAAG,IAAA,gBAAQ,EAAC,SAAS,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QAC7D,OAAO,IAAA,4BAAoB,EAAC,SAAS,EAAE,UAAU,EAAE,cAAc,CAAC,CAAC;IACvE,CAAC;CACJ;AAED,MAAM,0CAA2C,SAAQ,iBAAiB;IACtE;;;;;OAKG;IACH,gBAAgB,CAAC,SAAkD;QAC/D,IAAI,OAAO,GAAG,sCAAsC,CAAC;QACrD,OAAO,IAAI,IAAA,yCAAwB,EAAC,SAAS,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;QAC5D,OAAO,IAAI,IAAA,2DAA0C,EAAC,SAAS,CAAC,CAAC;QACjE,OAAO,IAAA,0BAAS,EAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;;OAMG;IACH,mBAAmB,CAAC,SAAkD,EAAE,UAAsB;QAC1F,MAAM,mBAAmB,GAAG,IAAA,4BAAoB,EAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QACxE,OAAO,mBAAmB,IAAI,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC;IACvD,CAAC;CACJ;AAED,MAAM,mCAAoC,SAAQ,iBAAiB;IAC/D;;;;;OAKG;IACH,gBAAgB,CAAC,SAAsC;QACnD,IAAI,OAAO,GAAG,+BAA+B,GAAG,IAAA,yCAAwB,EAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAC1F,IAAI,SAAS,CAAC,MAAM,IAAI,SAAS,CAAC,MAAM,CAAC,yBAAyB,CAAC,EAAE,CAAC;YAClE,OAAO,IAAI,IAAI,GAAG,SAAS,CAAC,MAAM,CAAC,yBAAyB,CAAC,CAAC;QAClE,CAAC;QACD,OAAO,IAAA,0BAAS,EAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;;OAMG;IACH,mBAAmB,CAAC,SAAoB,EAAE,UAAsB;QAC5D,MAAM,cAAc,GAAG,IAAA,gBAAQ,EAAC,SAAS,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QAC7D,OAAO,IAAA,4BAAoB,EAAC,SAAS,EAAE,UAAU,EAAE,cAAc,CAAC,CAAC;IACvE,CAAC;CACJ;AAED,MAAM,wBAAyB,SAAQ,iBAAiB;IACpD;;;;;OAKG;IACH,gBAAgB,CAAC,SAA2B;QACxC,OAAO,IAAA,0BAAS,EAAC,oBAAoB,GAAG,IAAA,yCAAwB,EAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;IACvF,CAAC;IAED;;;;;;OAMG;IACH,mBAAmB,CAAC,SAA2B,EAAE,UAAsB;QACnE,MAAM,mBAAmB,GAAG,IAAA,4BAAoB,EAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QACxE,MAAM,cAAc,GAAG,IAAA,gBAAQ,EAAC,SAAS,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QAC7D,OAAO,CACH,cAAc;YACd,mBAAmB;YACnB,CAAC,OAAO,SAAS,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CACjF,CAAC;IACN,CAAC;CACJ;AAED,MAAa,wBAAwB;IAGjC;;;;;;OAMG;IACH;QACI,IAAI,CAAC,UAAU,GAAG,IAAI,GAAG,EAAE,CAAC;QAE5B,IAAI,CAAC,gBAAgB,6FAAuC,IAAI,0BAA0B,EAAE,CAAC,CAAC;QAC9F,IAAI,CAAC,gBAAgB,uGAA4C,IAAI,+BAA+B,EAAE,CAAC,CAAC;QACxG,IAAI,CAAC,gBAAgB,2HAEjB,IAAI,yCAAyC,EAAE,CAClD,CAAC;QACF,IAAI,CAAC,gBAAgB,qGAA2C,IAAI,8BAA8B,EAAE,CAAC,CAAC;QACtG,IAAI,CAAC,gBAAgB,+FAAwC,IAAI,2BAA2B,EAAE,CAAC,CAAC;QAChG,IAAI,CAAC,gBAAgB,2EAA8B,IAAI,wBAAwB,EAAE,CAAC,CAAC;QACnF,IAAI,CAAC,gBAAgB,6HAEjB,IAAI,0CAA0C,EAAE,CACnD,CAAC;QACF,IAAI,CAAC,gBAAgB,+GAAgD,IAAI,mCAAmC,EAAE,CAAC,CAAC;QAChH,IAAI,CAAC,gBAAgB,yFAAqC,IAAI,wBAAwB,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;OAMG;IACH,gBAAgB,CAAC,IAAuB,EAAE,QAA2B;QACjE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED;;;;;OAKG;IACH,WAAW,CAAC,IAAuB;QAC/B,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC;CACJ;AAlDD,4DAkDC;AAEY,QAAA,wBAAwB,GAAG,IAAI,wBAAwB,EAAE,CAAC"}

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

@@ -1,8 +1,38 @@
 import type { ConvertedMetadata, EntitySet, EntityType } from '@sap-ux/vocabularies-types';
-import type { FacetConfig, GenerateAppSchemaParameters } from '@sap/ux-specification-types';
+import type { DataFieldAbstractTypes } from '@sap-ux/vocabularies-types/vocabularies/UI';
+import type { FacetConfig, GenerateAppSchemaParameters, SchemaDefinition } from '@sap/ux-specification-types';
 import { FioriElementsVersion, SectionType, v2 } from '@sap/ux-specification-types';
 import type { Definition } from 'typescript-json-schema';
 import type { SapUiAppPageV4 } from '@sap/ux-specification-types/src/v4';
+type DefinitionsProperties = {
+    [key: string]: SchemaDefinition;
+};
+export interface AddDefinitionParams {
+    appSchema: Definition;
+    withActions: boolean;
+    sectionType: SectionType;
+    field: DataFieldAbstractTypes;
+    targetID: string;
+    containersSchema: FieldsContainerSchema;
+    key: string;
+    version: FioriElementsVersion;
+    section: FacetConfig;
+    entityTypeName: string;
+}
+interface FieldsContainerSchema {
+    fields?: DefinitionsProperties;
+    actions?: DefinitionsProperties;
+}
+/**
+ * Retrieves the modified field reference based on the specified Fiori Elements version
+ * and the provided field reference identifier.
+ *
+ * @param {FioriElementsVersion} version - The Fiori Elements version (e.g., v2, v4).
+ * @param {string} fieldReferenceId - The identifier for the field reference to be processed.
+ * @returns {string} The transformed field reference if the version is v2 and the identifier contains '::',
+ *                   otherwise returns the original field reference identifier.
+ */
+export declare function getFieldReference(version: FioriElementsVersion, fieldReferenceId: string): string;
 /**
  * Adds definitions for forms in object page sections to the app schema.
  *
@@ -71,4 +101,35 @@ export declare function addCommonHeaderSchema(appSchema: Definition, entityType:
  * @returns the entity set as defined in AVT, if found
  */
 export declare function determineEntitySetOfEntityType(entityType: EntityType, serviceAVT: ConvertedMetadata): EntitySet | undefined;
+/**
+ * Adds a data field definition to the application schema based on the provided parameters.
+ *
+ * @param {AddDefinitionParams} data - An object containing the parameters necessary to define and add the data field.
+ * This includes:
+ * - `appSchema`: The application schema to which the definition is added
+ * - `section`: The section in which the field resides
+ * - `sectionType`: The type of the section
+ * - `field`: The specific field to be added
+ * - `targetID`: The target identifier for the field
+ * - `containersSchema`: The schema container for fields
+ * - `key`: The key that determines the order of the field
+ * - `version`: The version of the schema
+ */
+export declare function addDataFieldDefinition(data: AddDefinitionParams): void;
+/**
+ * Adds a data field to the schema definition for action and action group configurations.
+ *
+ * @param {AddDefinitionParams} data - The input data required to add the data field, including:
+ * - appSchema: The application schema to be updated.
+ * - withActions: A flag indicating whether actions are included.
+ * - sectionType: The type of the section (e.g., Section).
+ * - field: The data field to be added.
+ * - targetID: The identifier of the target.
+ * - containersSchema: The schema containing action and action groups configurations.
+ * - key: The key used for the property's index.
+ * - version: The schema version information.
+ * @returns {void} The function does not return a value.
+ */
+export declare function addDataFieldForActionAndActionGroupDefinition(data: AddDefinitionParams): void;
+export {};
 //# sourceMappingURL=objectPage.d.ts.map

package/dist/specification/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,EAAoB,MAAM,6BAA6B,CAAC;AAC9G,OAAO,EAGH,oBAAoB,EAIpB,WAAW,EAEX,EAAE,EACL,MAAM,6BAA6B,CAAC;AAUrC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAEzD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AAyazE;;;;;;;;;;GAUG;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;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,oBAAoB,EAAE,MAAM,EAAE,eAAe,EAAE,iBAAiB,GAAG,MAAM,CAarG;AAED;;;;;;GAMG;AACH,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;AAuBD;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAC5B,SAAS,EAAE,UAAU,EACrB,kBAAkB,EAAE,2BAA2B,EAC/C,OAAO,EAAE,oBAAoB,EAC7B,uBAAuB,KAAA,EACvB,KAAK,CAAC,EAAE,EAAE,CAAC,eAAe,GAC3B,IAAI,CA6CN;AAED;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAC5B,SAAS,EAAE,UAAU,EACrB,UAAU,EAAE,UAAU,EACtB,kBAAkB,EAAE,2BAA2B,EAC/C,uBAAuB,KAAA,EACvB,IAAI,CAAC,EAAE,cAAc,EACrB,IAAI,UAAQ,GACb,IAAI,CAkCN;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,GAAG,IAAI,CAWzF;AAED;;;;;;GAMG;AACH,wBAAgB,8BAA8B,CAC1C,UAAU,EAAE,UAAU,EACtB,UAAU,EAAE,iBAAiB,GAC9B,SAAS,GAAG,SAAS,CAIvB"}
+{"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;AAC3F,OAAO,KAAK,EACR,sBAAsB,EAGzB,MAAM,4CAA4C,CAAC;AAGpD,OAAO,KAAK,EAAE,WAAW,EAAE,2BAA2B,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAC9G,OAAO,EAGH,oBAAoB,EAIpB,WAAW,EAEX,EAAE,EACL,MAAM,6BAA6B,CAAC;AAWrC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAEzD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AAIzE,KAAK,qBAAqB,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,gBAAgB,CAAA;CAAE,CAAC;AACjE,MAAM,WAAW,mBAAmB;IAChC,SAAS,EAAE,UAAU,CAAC;IACtB,WAAW,EAAE,OAAO,CAAC;IACrB,WAAW,EAAE,WAAW,CAAC;IACzB,KAAK,EAAE,sBAAsB,CAAC;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,gBAAgB,EAAE,qBAAqB,CAAC;IACxC,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,oBAAoB,CAAC;IAC9B,OAAO,EAAE,WAAW,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;CAC1B;AAED,UAAU,qBAAqB;IAC3B,MAAM,CAAC,EAAE,qBAAqB,CAAC;IAC/B,OAAO,CAAC,EAAE,qBAAqB,CAAC;CACnC;AAiPD;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,UAIxF;AAmID;;;;;;;;;;GAUG;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;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,oBAAoB,EAAE,MAAM,EAAE,eAAe,EAAE,iBAAiB,GAAG,MAAM,CAarG;AAED;;;;;;GAMG;AACH,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;AAuBD;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAC5B,SAAS,EAAE,UAAU,EACrB,kBAAkB,EAAE,2BAA2B,EAC/C,OAAO,EAAE,oBAAoB,EAC7B,uBAAuB,KAAA,EACvB,KAAK,CAAC,EAAE,EAAE,CAAC,eAAe,GAC3B,IAAI,CA6CN;AAED;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAC5B,SAAS,EAAE,UAAU,EACrB,UAAU,EAAE,UAAU,EACtB,kBAAkB,EAAE,2BAA2B,EAC/C,uBAAuB,KAAA,EACvB,IAAI,CAAC,EAAE,cAAc,EACrB,IAAI,UAAQ,GACb,IAAI,CAkCN;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,UAAU,GAAG,IAAI,CAWzF;AAED;;;;;;GAMG;AACH,wBAAgB,8BAA8B,CAC1C,UAAU,EAAE,UAAU,EACtB,UAAU,EAAE,iBAAiB,GAC9B,SAAS,GAAG,SAAS,CAIvB;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,mBAAmB,QAuB/D;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,6CAA6C,CAAC,IAAI,EAAE,mBAAmB,QAwBtF"}