@sap/ux-specification 1.120.35 → 1.120.37

package/dist/specification/src/sync/v2/generate/listReport.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.addEnumForVariantPaths = addEnumForVariantPaths;
 exports.generateListReportSchemaV2 = generateListReportSchemaV2;
 const utils_1 = require("./utils");
+const manifestPropertyUtils_1 = require("./manifestPropertyUtils");
 const import_1 = require("../import");
 const common_1 = require("../../common");
 const i18next_1 = __importDefault(require("i18next"));
@@ -16,8 +17,9 @@ const types_2 = require("../../../../../types/src/common/types");
 const ROOT_PROPERTIES_ORDER = ['filterBar', 'table', 'footer'];
 const UIVOCABULARYDOT = ux_specification_types_1.UIVOCABULARYALPHADOT.substring(1); // reference to the ui vocabluary without leading '@' but with trailing'.'
 /**
- * Adds the enum types for QuickVariant and QuickVariantX, based on the entity type annotations
- * @param {EntityType} entityType
+ * Adds the enum types for QuickVariant and QuickVariantX, based on the entity type annotations.
+ *
+ * @param {EntityType} entityType - The entity type containing annotations to be processed
  * @param {EntitySet} entitySet - current entity set of the page or view
  * @param {Definition} appSchema - app specific JSON schema
  * @param {ConvertedMetadata} oDataServiceAVT - combined service metadata, as returned by annotation vocabularies tools
@@ -28,8 +30,9 @@ function addEnumForVariantPaths(entityType, entitySet, appSchema, oDataServiceAV
     (0, common_1.addEnumForVariantEntitySet)(oDataServiceAVT, appSchema, 'QuickVariantX');
 }
 /**
- * Adds an enum filled with existing UI annotations for annotationPath property in FilterBar
- * @param {EntityType} entityType
+ * Adds an enum filled with existing UI annotations for annotationPath property in FilterBar.
+ *
+ * @param entityType - The entity type containing annotations to be processed
  * @param appSchema - app specific JSOn schema
  * @param definitionName - name of the definition in the app schema
  */
@@ -42,7 +45,14 @@ function addEnumForFilterBarAnnotationPath(entityType, appSchema, definitionName
     ];
     (0, common_1.addEnumForValidAnnotations)(entityType, validAnnotations, annoPath);
 }
-// Helper function for getLineItemAnnotation which determines the presentation variant to be used. The parameters of both functions have identical meaning.
+/**
+ * Helper function for getLineItemAnnotation which determines the presentation variant to be used. The parameters of both functions have identical meaning.
+ *
+ * @param uIAnnotations - The UI annotations for the entity type.
+ * @param settings - Optional settings object, typically a piece of the manifest, containing an optional annotationPath property.
+ * @param logger - Optional logger instance for logging warnings or errors.
+ * @returns The determined PresentationVariant or undefined if none is found.
+ */
 function getPresentationVariantForLineItem(uIAnnotations, settings, logger) {
     let presentationVariant; // the presentation variant to be used to determine the LineItem
     const annotationPath = settings?.annotationPath;
@@ -89,12 +99,19 @@ function getPresentationVariantForLineItem(uIAnnotations, settings, logger) {
     }
     return presentationVariant;
 }
-// Determine the LineItemAnnotation to be used for the LR.
-// Reproduces logic from Fiori Elements LR implementation (function createWorkingContext in LR specific AnnotationHelper).
+/**
+ * Determine the LineItemAnnotation to be used for the LR.
+ * Reproduces logic from Fiori Elements LR implementation (function createWorkingContext in LR specific AnnotationHelper).
+ *
+ * @param uIAnnotations - The UI annotations for the entity type.
+ * @param settings - Optional settings object, typically a piece of the manifest, containing an optional annotationPath property.
+ * @param logger - Optional logger instance for logging warnings or errors.
+ * @returns The determined LineItem annotation or undefined if none is found.
+ */
 function getLineItemAnnotation(uIAnnotations, settings, // an object (actually a piece of the manifest) possessing an optional property annotationPath which would define the path to the PresentationVariant
 logger // used in case an error/warning is detected while determining the result
 ) {
-    if ((0, utils_1.hasPropertyTypeError)(settings, 'annotationPath', logger)) {
+    if ((0, manifestPropertyUtils_1.hasPropertyTypeError)(settings, 'annotationPath', logger)) {
         return undefined; // return undefined in case there is an error in the settings
     }
     const presentationVariant = getPresentationVariantForLineItem(uIAnnotations, settings, logger); // the presentation variant to be used to determine the LineItem (if there is one)
@@ -119,6 +136,7 @@ logger // used in case an error/warning is detected while determining the result
 /**
  * Generates an app specific schema for the FE V2 Listreport from the generic schema.
  * Generic types are replaced by information from the app specific annotations.
+ *
  * @param {GenerateAppSchemaParameters} generateParameters - list of API input parameters
  * @param {object} genericSchema - generic JSON schema of a list report
  * @returns appSchema - the application specific JSON schema

package/dist/specification/src/sync/v2/generate/listReport.js.map

@@ -1 +1 @@
-{"version":3,"file":"listReport.js","sourceRoot":"","sources":["../../../../../../src/sync/v2/generate/listReport.ts"],"names":[],"mappings":";;;;;AAsDA,wDASC;AA+GD,gEAsGC;AApRD,mCASiB;AACjB,sCAAiD;AACjD,yCAUsB;AACtB,sDAA8B;AAC9B,wEAOqC;AAGrC,8DAA+C;AAC/C,oCAA8C;AAQ9C,iEAAkE;AAElE,MAAM,qBAAqB,GAAuC,CAAC,WAAW,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;AACnG,MAAM,eAAe,GAAG,6CAAoB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,0EAA0E;AAErI;;;;;;GAMG;AACH,SAAgB,sBAAsB,CAClC,UAAsB,EACtB,SAAoB,EACpB,SAAqB,EACrB,eAAkC;IAElC,IAAA,mCAA0B,EAAC,UAAU,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC;IAClE,IAAA,kCAAyB,EAAC,SAAS,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC;IACjE,IAAA,mCAA0B,EAAC,eAAe,EAAE,SAAS,EAAE,eAAe,CAAC,CAAC;AAC5E,CAAC;AAED;;;;;GAKG;AACH,SAAS,iCAAiC,CACtC,UAAsB,EACtB,SAAqB,EACrB,cAAsB;IAEtB,MAAM,QAAQ,GAAI,SAAS,CAAC,WAAW,CAAC,cAAc,CAAgB,CAAC,UAAU,CAAC,cAA4B,CAAC;IAC/G,MAAM,gBAAgB,GAAG;;;;KAIxB,CAAC;IACF,IAAA,mCAA0B,EAAC,UAAU,EAAE,gBAAgB,EAAE,QAAQ,CAAC,CAAC;AACvE,CAAC;AAED,2JAA2J;AAC3J,SAAS,iCAAiC,CACtC,aAAuC,EACvC,QAAS,EACT,MAAwB;IAExB,IAAI,mBAAoD,CAAC,CAAC,gEAAgE;IAC1H,MAAM,cAAc,GAAG,QAAQ,EAAE,cAAoC,CAAC;IACtE,sKAAsK;IACtK,4KAA4K;IAC5K,IAAI,cAAc,EAAE,CAAC;QACjB,MAAM,KAAK,GAAG,cAAc,CAAC,QAAQ,gHAAgD,CAAC;QACtF,MAAM,IAAI,GAAG,CAAC,KAAK,IAAI,cAAc,CAAC,QAAQ,8FAAuC,CAAC;QACtF,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;YAChB,MAAM,QAAQ,GAAG,cAAc,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;YAC7D,MAAM,YAAY,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC,iEAAiE;YAC/G,IAAI,YAAY,EAAE,CAAC;gBACf,IAAI,IAAI,EAAE,CAAC;oBACP,mBAAmB,GAAG,YAAY,CAAC;gBACvC,CAAC;qBAAM,CAAC;oBACJ,WAAW;oBACX,mBAAmB,GAAG,YAAY,CAAC,iBAAS,CAAC,mBAAmB,CAAC,CAAC;oBAClE,IACI,mBAAmB;wBACnB,mBAAmB,CAAC,kBAAkB,CAAC,QAAQ,CAAC,iBAAS,CAAC,4BAA4B,CAAC,EACzF,CAAC;wBACC,mBAAmB,GAAG,aAAa,CAAC,iBAAS,CAAC,mBAAmB,CAAC,CAAC,CAAC,sFAAsF;oBAC9J,CAAC;gBACL,CAAC;YACL,CAAC;iBAAM,CAAC;gBACJ,2IAA2I;gBAC3I,IAAA,qBAAG,EAAC,MAAM,EAAE;oBACR,QAAQ,qCAAqB;oBAC7B,OAAO,EAAE,iBAAO,CAAC,CAAC,CAAC,qBAAqB,EAAE,EAAE,cAAc,EAAE,cAAc,EAAE,CAAC;iBAChF,CAAC,CAAC;gBACH,mIAAmI;gBACnI,IAAI,KAAK,EAAE,CAAC;oBACR,mBAAmB,GAAG,aAAa,CAAC,iBAAS,CAAC,mBAAmB,CAAC,CAAC;gBACvE,CAAC;YACL,CAAC;QACL,CAAC;aAAM,CAAC;YACJ,kJAAkJ;YAClJ,mBAAmB,GAAG,aAAa,CAAC,iBAAS,CAAC,mBAAmB,CAAC,CAAC,CAAC,iDAAiD;QACzH,CAAC;IACL,CAAC;SAAM,CAAC;QACJ,mBAAmB,GAAG,aAAa,CAAC,iBAAS,CAAC,mBAAmB,CAAC,CAAC;IACvE,CAAC;IACD,OAAO,mBAAmB,CAAC;AAC/B,CAAC;AAED,0DAA0D;AAC1D,0HAA0H;AAC1H,SAAS,qBAAqB,CAC1B,aAAuC,EACvC,QAAS,EAAE,qJAAqJ;AAChK,MAAwB,CAAC,yEAAyE;;IAElG,IAAI,IAAA,4BAAoB,EAAC,QAAQ,EAAE,gBAAgB,EAAE,MAAM,CAAC,EAAE,CAAC;QAC3D,OAAO,SAAS,CAAC,CAAC,6DAA6D;IACnF,CAAC;IACD,MAAM,mBAAmB,GAAG,iCAAiC,CAAC,aAAa,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC,kFAAkF;IAElL,uFAAuF;IACvF,MAAM,cAAc,GAChB,mBAAmB,EAAE,cAAc,IAAI,EAAE,CAAC;IAC9C,IAAI,YAAY,GAAW,EAAE,CAAC,CAAC,yEAAyE;IACxG,cAAc,CAAC,IAAI,CAAC,UAAU,aAAa;QACvC,YAAY,GAAG,IAAA,sDAA8C,EAAC,iBAAS,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;QACjG,OAAO,YAAY,CAAC,CAAC,2DAA2D;IACpF,CAAC,CAAC,CAAC;IACH,2IAA2I;IAC3I,YAAY,GAAG,YAAY,IAAI,iBAAS,CAAC,QAAQ,CAAC;IAClD,MAAM,QAAQ,GAAG,aAAa,CAAC,YAAY,CAAyB,CAAC;IACrE,IAAI,CAAC,QAAQ,EAAE,CAAC;QACZ,IAAA,qBAAG,EAAC,MAAM,EAAE;YACR,QAAQ,qCAAqB;YAC7B,OAAO,EAAE,iBAAO,CAAC,CAAC,CAAC,mBAAmB,EAAE,EAAE,cAAc,EAAE,YAAY,EAAE,CAAC;SAC5E,CAAC,CAAC;IACP,CAAC;IACD,OAAO,QAAQ,CAAC;AACpB,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,0BAA0B,CACtC,kBAA+C,EAC/C,aAAyB;IAEzB,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAe,CAAC;IAE1E,MAAM,WAAW,GAAG;QAChB,IAAI,EAAE,+BAAsB,GAAG,uCAAc,CAAC,SAAS;KAC1D,CAAC;IACF,MAAM,SAAS,GAAG,+BAAsB,GAAG,uCAAc,CAAC,SAAS,CAAC;IAEpE,0BAAkB,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,CAAC,EAAE,EAAE;QACxC,SAAS,CAAC,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,+BAAsB,GAAG,SAAS,CAAC;QAC/F,MAAM,YAAY,GAAG,SAAS,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;QAC1D,MAAM,kBAAkB,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC/F,kBAAkB,CAAC,UAAU,CAAC,OAAO,GAAG,WAAW,CAAC;QACpD,kBAAkB,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;QAC1D,SAAS,CAAC,WAAW,CAAC,SAAS,CAAC,GAAG,kBAAkB,CAAC;IAC1D,CAAC,CAAC,CAAC;IAEH,MAAM,EAAE,UAAU,EAAE,aAAa,EAAE,GAAG,IAAA,mCAA2B,EAAC,kBAAkB,CAAC,CAAC,CAAC,wDAAwD;IAC/I,IAAI,aAAa,EAAE,CAAC;QAChB,mCAAmC;QACnC,sDAAsD;QACtD,MAAM,QAAQ,GAAG,EAAE,CAAC;QACpB,MAAM,MAAM,GAAG,IAAA,6BAAoB,EAC/B,kBAAkB,CAAC,QAAQ,CAAC,wCAAe,CAAC,OAAO,CAAC,CAAC,KAA2B,EAChF,QAAQ,CACX,CAAC;QAEF,iCAAiC;QACjC,IAAA,gCAAwB,EAAC,SAAS,CAAC,CAAC;QACpC,mBAAmB;QACnB,MAAM,kBAAkB,GAAG,qBAAqB,CAC5C,aAAa,EACb,MAAM,EAAE,SAAS,EAAE,QAAQ,EAC3B,kBAAkB,CAAC,MAAM,CAC5B,CAAC;QACF,IAAI,kBAAkB,EAAE,CAAC;YACrB,MAAM,cAAc,GAAG,IAAA,6BAAoB,EACvC,UAAU,CAAC,kBAAkB,EAC7B,kBAAkB,CAAC,IAAI,EACvB,kBAAkB,CAAC,SAAS,CAC/B,CAAC;YACF,0BAAkB,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;gBACrC,SAAS,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,kCAAS,CAAC,cAAc,CAAC,GAAG,cAAc,CAAC;YAChF,CAAC,CAAC,CAAC;QACP,CAAC;QACD,IAAA,wBAAgB,EAAC,KAAK,EAAE,SAAS,EAAE,kBAAkB,EAAE,UAAU,CAAC,CAAC;QACnE,sBAAsB;QACtB,MAAM,wBAAwB,GAAG,aAAa,CAAC,eAAe,CAAC;QAC/D,IAAA,0BAAkB,EAAC,SAAS,EAAE,wBAAwB,EAAE,UAAU,CAAC,CAAC;QAEpE,0CAA0C;QAC1C,IAAA,sBAAa,EAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QAErC,0EAA0E;QACzE,SAAS,CAAC,WAAW,CAAC,SAAwB,CAAC,UAAU,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC;QAC/F,IAAA,iCAAyB,EACpB,SAAS,CAAC,WAAW,CAAC,SAAwB,CAAC,UAAU,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,EACzF,UAAU,CACb,CAAC;QAEF,IAAI,CAAC,MAAM,EAAE,CAAC;YACV,IAAA,qBAAG,EAAC,kBAAkB,CAAC,MAAM,EAAE;gBAC3B,QAAQ,iCAAmB;gBAC3B,OAAO,EAAE,iBAAO,CAAC,CAAC,CAAC,MAAM,CAAC;gBAC1B,QAAQ,EAAE;oBACN,IAAI,EAAE,qCAAY;oBAClB,KAAK,EAAE,CAAC,wCAAe,CAAC,OAAO,CAAC;iBACnC;aACJ,CAAC,CAAC;YACH,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,IAAA,gCAAwB,EACpB,SAAS,EACT,UAAU,EACV,MAAM,EACN,kBAAkB,CAAC,QAAQ,EAC3B,kBAAkB,CAAC,SAAS,CAC/B,CAAC;QAEF,sBAAsB,CAAC,UAAU,EAAE,kBAAkB,CAAC,SAAS,EAAE,SAAS,EAAE,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC3G,iCAAiC,CAAC,UAAU,EAAE,SAAS,EAAE,uCAAc,CAAC,mBAAmB,CAAC,CAAC;QAC7F,IAAA,wCAA+B,EAAC,UAAU,EAAE,SAAS,EAAE,uCAAc,CAAC,WAAW,CAAC,CAAC;QAEnF,4BAA4B;QAC5B,OAAO,SAAS,CAAC,WAAW,CAAC,8BAA8B,CAAC;QAC5D,OAAO,SAAS,CAAC,WAAW,CAAC,+BAA+B,CAAC;QAC7D,OAAO,SAAS,CAAC,WAAW,CAAC,SAAS,CAAC;QACvC,OAAO,SAAS,CAAC,WAAW,CAAC,eAAe,CAAC;QAC7C,OAAO,SAAS,CAAC,WAAW,CAAC,SAAS,CAAC;QACvC,OAAO,SAAS,CAAC,WAAW,CAAC,cAAc,CAAC;QAC5C,OAAO,SAAS,CAAC,WAAW,CAAC,iBAAiB,CAAC;QAC/C,OAAO,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC;QACrC,OAAO,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC;QACrC,OAAO,SAAS,CAAC,WAAW,CAAC,aAAa,CAAC;QAC3C,OAAO,SAAS,CAAC,WAAW,CAAC,SAAS,CAAC;QACvC,OAAO,SAAS,CAAC,WAAW,CAAC,KAAK,CAAC;IACvC,CAAC;IACD,IAAA,8BAAqB,EAAC,SAAS,EAAE,qBAAqB,CAAC,CAAC;IACxD,OAAO,SAAS,CAAC;AACrB,CAAC"}
+{"version":3,"file":"listReport.js","sourceRoot":"","sources":["../../../../../../src/sync/v2/generate/listReport.ts"],"names":[],"mappings":";;;;;AAuDA,wDASC;AA+HD,gEAsGC;AArSD,mCAQiB;AACjB,mEAA+D;AAC/D,sCAAiD;AACjD,yCAUsB;AACtB,sDAA8B;AAC9B,wEAOqC;AAGrC,8DAA+C;AAC/C,oCAA8C;AAQ9C,iEAAkE;AAElE,MAAM,qBAAqB,GAAuC,CAAC,WAAW,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;AACnG,MAAM,eAAe,GAAG,6CAAoB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,0EAA0E;AAErI;;;;;;;GAOG;AACH,SAAgB,sBAAsB,CAClC,UAAsB,EACtB,SAAoB,EACpB,SAAqB,EACrB,eAAkC;IAElC,IAAA,mCAA0B,EAAC,UAAU,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC;IAClE,IAAA,kCAAyB,EAAC,SAAS,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC;IACjE,IAAA,mCAA0B,EAAC,eAAe,EAAE,SAAS,EAAE,eAAe,CAAC,CAAC;AAC5E,CAAC;AAED;;;;;;GAMG;AACH,SAAS,iCAAiC,CACtC,UAAsB,EACtB,SAAqB,EACrB,cAAsB;IAEtB,MAAM,QAAQ,GAAI,SAAS,CAAC,WAAW,CAAC,cAAc,CAAgB,CAAC,UAAU,CAAC,cAA4B,CAAC;IAC/G,MAAM,gBAAgB,GAAG;;;;KAIxB,CAAC;IACF,IAAA,mCAA0B,EAAC,UAAU,EAAE,gBAAgB,EAAE,QAAQ,CAAC,CAAC;AACvE,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,iCAAiC,CACtC,aAAuC,EACvC,QAAS,EACT,MAAwB;IAExB,IAAI,mBAAoD,CAAC,CAAC,gEAAgE;IAC1H,MAAM,cAAc,GAAG,QAAQ,EAAE,cAAoC,CAAC;IACtE,sKAAsK;IACtK,4KAA4K;IAC5K,IAAI,cAAc,EAAE,CAAC;QACjB,MAAM,KAAK,GAAG,cAAc,CAAC,QAAQ,gHAAgD,CAAC;QACtF,MAAM,IAAI,GAAG,CAAC,KAAK,IAAI,cAAc,CAAC,QAAQ,8FAAuC,CAAC;QACtF,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;YAChB,MAAM,QAAQ,GAAG,cAAc,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;YAC7D,MAAM,YAAY,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC,iEAAiE;YAC/G,IAAI,YAAY,EAAE,CAAC;gBACf,IAAI,IAAI,EAAE,CAAC;oBACP,mBAAmB,GAAG,YAAY,CAAC;gBACvC,CAAC;qBAAM,CAAC;oBACJ,WAAW;oBACX,mBAAmB,GAAG,YAAY,CAAC,iBAAS,CAAC,mBAAmB,CAAC,CAAC;oBAClE,IACI,mBAAmB;wBACnB,mBAAmB,CAAC,kBAAkB,CAAC,QAAQ,CAAC,iBAAS,CAAC,4BAA4B,CAAC,EACzF,CAAC;wBACC,mBAAmB,GAAG,aAAa,CAAC,iBAAS,CAAC,mBAAmB,CAAC,CAAC,CAAC,sFAAsF;oBAC9J,CAAC;gBACL,CAAC;YACL,CAAC;iBAAM,CAAC;gBACJ,2IAA2I;gBAC3I,IAAA,qBAAG,EAAC,MAAM,EAAE;oBACR,QAAQ,qCAAqB;oBAC7B,OAAO,EAAE,iBAAO,CAAC,CAAC,CAAC,qBAAqB,EAAE,EAAE,cAAc,EAAE,cAAc,EAAE,CAAC;iBAChF,CAAC,CAAC;gBACH,mIAAmI;gBACnI,IAAI,KAAK,EAAE,CAAC;oBACR,mBAAmB,GAAG,aAAa,CAAC,iBAAS,CAAC,mBAAmB,CAAC,CAAC;gBACvE,CAAC;YACL,CAAC;QACL,CAAC;aAAM,CAAC;YACJ,kJAAkJ;YAClJ,mBAAmB,GAAG,aAAa,CAAC,iBAAS,CAAC,mBAAmB,CAAC,CAAC,CAAC,iDAAiD;QACzH,CAAC;IACL,CAAC;SAAM,CAAC;QACJ,mBAAmB,GAAG,aAAa,CAAC,iBAAS,CAAC,mBAAmB,CAAC,CAAC;IACvE,CAAC;IACD,OAAO,mBAAmB,CAAC;AAC/B,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,qBAAqB,CAC1B,aAAuC,EACvC,QAAS,EAAE,qJAAqJ;AAChK,MAAwB,CAAC,yEAAyE;;IAElG,IAAI,IAAA,4CAAoB,EAAC,QAAQ,EAAE,gBAAgB,EAAE,MAAM,CAAC,EAAE,CAAC;QAC3D,OAAO,SAAS,CAAC,CAAC,6DAA6D;IACnF,CAAC;IACD,MAAM,mBAAmB,GAAG,iCAAiC,CAAC,aAAa,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC,kFAAkF;IAElL,uFAAuF;IACvF,MAAM,cAAc,GAChB,mBAAmB,EAAE,cAAc,IAAI,EAAE,CAAC;IAC9C,IAAI,YAAY,GAAW,EAAE,CAAC,CAAC,yEAAyE;IACxG,cAAc,CAAC,IAAI,CAAC,UAAU,aAAa;QACvC,YAAY,GAAG,IAAA,sDAA8C,EAAC,iBAAS,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;QACjG,OAAO,YAAY,CAAC,CAAC,2DAA2D;IACpF,CAAC,CAAC,CAAC;IACH,2IAA2I;IAC3I,YAAY,GAAG,YAAY,IAAI,iBAAS,CAAC,QAAQ,CAAC;IAClD,MAAM,QAAQ,GAAG,aAAa,CAAC,YAAY,CAAyB,CAAC;IACrE,IAAI,CAAC,QAAQ,EAAE,CAAC;QACZ,IAAA,qBAAG,EAAC,MAAM,EAAE;YACR,QAAQ,qCAAqB;YAC7B,OAAO,EAAE,iBAAO,CAAC,CAAC,CAAC,mBAAmB,EAAE,EAAE,cAAc,EAAE,YAAY,EAAE,CAAC;SAC5E,CAAC,CAAC;IACP,CAAC;IACD,OAAO,QAAQ,CAAC;AACpB,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,0BAA0B,CACtC,kBAA+C,EAC/C,aAAyB;IAEzB,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAe,CAAC;IAE1E,MAAM,WAAW,GAAG;QAChB,IAAI,EAAE,+BAAsB,GAAG,uCAAc,CAAC,SAAS;KAC1D,CAAC;IACF,MAAM,SAAS,GAAG,+BAAsB,GAAG,uCAAc,CAAC,SAAS,CAAC;IAEpE,0BAAkB,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,CAAC,EAAE,EAAE;QACxC,SAAS,CAAC,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,+BAAsB,GAAG,SAAS,CAAC;QAC/F,MAAM,YAAY,GAAG,SAAS,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;QAC1D,MAAM,kBAAkB,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC/F,kBAAkB,CAAC,UAAU,CAAC,OAAO,GAAG,WAAW,CAAC;QACpD,kBAAkB,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;QAC1D,SAAS,CAAC,WAAW,CAAC,SAAS,CAAC,GAAG,kBAAkB,CAAC;IAC1D,CAAC,CAAC,CAAC;IAEH,MAAM,EAAE,UAAU,EAAE,aAAa,EAAE,GAAG,IAAA,mCAA2B,EAAC,kBAAkB,CAAC,CAAC,CAAC,wDAAwD;IAC/I,IAAI,aAAa,EAAE,CAAC;QAChB,mCAAmC;QACnC,sDAAsD;QACtD,MAAM,QAAQ,GAAG,EAAE,CAAC;QACpB,MAAM,MAAM,GAAG,IAAA,6BAAoB,EAC/B,kBAAkB,CAAC,QAAQ,CAAC,wCAAe,CAAC,OAAO,CAAC,CAAC,KAA2B,EAChF,QAAQ,CACX,CAAC;QAEF,iCAAiC;QACjC,IAAA,gCAAwB,EAAC,SAAS,CAAC,CAAC;QACpC,mBAAmB;QACnB,MAAM,kBAAkB,GAAG,qBAAqB,CAC5C,aAAa,EACb,MAAM,EAAE,SAAS,EAAE,QAAQ,EAC3B,kBAAkB,CAAC,MAAM,CAC5B,CAAC;QACF,IAAI,kBAAkB,EAAE,CAAC;YACrB,MAAM,cAAc,GAAG,IAAA,6BAAoB,EACvC,UAAU,CAAC,kBAAkB,EAC7B,kBAAkB,CAAC,IAAI,EACvB,kBAAkB,CAAC,SAAS,CAC/B,CAAC;YACF,0BAAkB,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;gBACrC,SAAS,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,kCAAS,CAAC,cAAc,CAAC,GAAG,cAAc,CAAC;YAChF,CAAC,CAAC,CAAC;QACP,CAAC;QACD,IAAA,wBAAgB,EAAC,KAAK,EAAE,SAAS,EAAE,kBAAkB,EAAE,UAAU,CAAC,CAAC;QACnE,sBAAsB;QACtB,MAAM,wBAAwB,GAAG,aAAa,CAAC,eAAe,CAAC;QAC/D,IAAA,0BAAkB,EAAC,SAAS,EAAE,wBAAwB,EAAE,UAAU,CAAC,CAAC;QAEpE,0CAA0C;QAC1C,IAAA,sBAAa,EAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QAErC,0EAA0E;QACzE,SAAS,CAAC,WAAW,CAAC,SAAwB,CAAC,UAAU,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC;QAC/F,IAAA,iCAAyB,EACpB,SAAS,CAAC,WAAW,CAAC,SAAwB,CAAC,UAAU,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,EACzF,UAAU,CACb,CAAC;QAEF,IAAI,CAAC,MAAM,EAAE,CAAC;YACV,IAAA,qBAAG,EAAC,kBAAkB,CAAC,MAAM,EAAE;gBAC3B,QAAQ,iCAAmB;gBAC3B,OAAO,EAAE,iBAAO,CAAC,CAAC,CAAC,MAAM,CAAC;gBAC1B,QAAQ,EAAE;oBACN,IAAI,EAAE,qCAAY;oBAClB,KAAK,EAAE,CAAC,wCAAe,CAAC,OAAO,CAAC;iBACnC;aACJ,CAAC,CAAC;YACH,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,IAAA,gCAAwB,EACpB,SAAS,EACT,UAAU,EACV,MAAM,EACN,kBAAkB,CAAC,QAAQ,EAC3B,kBAAkB,CAAC,SAAS,CAC/B,CAAC;QAEF,sBAAsB,CAAC,UAAU,EAAE,kBAAkB,CAAC,SAAS,EAAE,SAAS,EAAE,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC3G,iCAAiC,CAAC,UAAU,EAAE,SAAS,EAAE,uCAAc,CAAC,mBAAmB,CAAC,CAAC;QAC7F,IAAA,wCAA+B,EAAC,UAAU,EAAE,SAAS,EAAE,uCAAc,CAAC,WAAW,CAAC,CAAC;QAEnF,4BAA4B;QAC5B,OAAO,SAAS,CAAC,WAAW,CAAC,8BAA8B,CAAC;QAC5D,OAAO,SAAS,CAAC,WAAW,CAAC,+BAA+B,CAAC;QAC7D,OAAO,SAAS,CAAC,WAAW,CAAC,SAAS,CAAC;QACvC,OAAO,SAAS,CAAC,WAAW,CAAC,eAAe,CAAC;QAC7C,OAAO,SAAS,CAAC,WAAW,CAAC,SAAS,CAAC;QACvC,OAAO,SAAS,CAAC,WAAW,CAAC,cAAc,CAAC;QAC5C,OAAO,SAAS,CAAC,WAAW,CAAC,iBAAiB,CAAC;QAC/C,OAAO,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC;QACrC,OAAO,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC;QACrC,OAAO,SAAS,CAAC,WAAW,CAAC,aAAa,CAAC;QAC3C,OAAO,SAAS,CAAC,WAAW,CAAC,SAAS,CAAC;QACvC,OAAO,SAAS,CAAC,WAAW,CAAC,KAAK,CAAC;IACvC,CAAC;IACD,IAAA,8BAAqB,EAAC,SAAS,EAAE,qBAAqB,CAAC,CAAC;IACxD,OAAO,SAAS,CAAC;AACrB,CAAC"}

package/dist/specification/src/sync/v2/generate/manifestPropertyUtils.d.ts

@@ -0,0 +1,118 @@
+/**
+ * @file This file contains helper functions for generating page specific schemas that are used in the context of manifest properties.
+ * The functionality is implicitly tested by the more complex unit-tests for generic schema generation and generic import in test-folder unit/genericSchemaHandling.
+ */
+import type { Definition } from 'typescript-json-schema';
+import type { SyncRule, GenerateAppSchemaParameters, ProcessingRule, AccessorPath, SchemaHandlingParams, ReferenceAdaptationInfo } from '@sap/ux-specification-types';
+import type { ExtensionLogger } from '../../..';
+/**
+ * Type check for properties coming from the manifest.
+ *
+ * @param parent - the parent object in manifest which may contain the property.
+ * @param propertyName - name of the property name to be checked
+ * @param logger - a logger which may receive the error message in case a type error is detected
+ * @param expectedType - the expected type of the value of the property (if it is not undefined)
+ * @param mandatory - specifies handling of null and undefined: If parent is null this is always considered an error.
+ * undefined value for parent or its specified property is considered an error when parameter mandatory is true.
+ * null value for the specified property is considered an error when mandatory is true or the expected type is not 'object'.
+ * @returns the information whether a type error was detected.
+ */
+export declare function hasPropertyTypeError(parent: unknown, propertyName: string, logger?: ExtensionLogger, expectedType?: string, mandatory?: boolean): boolean;
+/**
+ * This symbol is used to indicate that a property is not allowed in the current context and that it should be hidden without any explanation.
+ */
+export declare const DISALLOWED_WITHOUT_EXPLANATION: unique symbol;
+/**
+ * An instance of this type describes whether a property is allowed in the current context or not.
+ * A faulty instance of this type expresses that the property is allowed in the current context.
+ * A non-faulty string instance expresses that the property is not allowed in the current context.
+ * Moreover, it contains the human readable reason why the property is not allowed.
+ * The special value DISALLOWED_WITHOUT_EXPLANATION indicates that the property is not allowed in the current context
+ * and that it should be hidden without any explanation.
+ */
+export type DisallowedSpecification = string | typeof DISALLOWED_WITHOUT_EXPLANATION;
+/**
+ * Helper function to be called within elementAdapters of syncRules.
+ * The function should be called when a property defined in the generic schema is not valid
+ * for the page the specific schema is currently generated for.
+ * We distinguish two cases:
+ * - The property is present in the manifest (although it should not)
+ * - The property is not present in the manifest (as expected)
+ * In the first case the corresponding property should still be present in the schema.
+ * However, a warning message is added to the schema in order to make the user aware of this inconsistency.
+ * In the second case the property should not be shown to the user. So, preferably we would
+ * remove the property from the schema.
+ * However, this is currently not possible due to a flaw in the undo/redo logic which results in schemas
+ * being used to process the export that do not exactly fit to the current state of the config.
+ * For these cases we need the manifest path which is stored with the definition of the property in the schema.
+ * Therefore, we set the hidden flag of the property to true. This will be changed as soon as the undo/redo logic has been refactored.
+ *
+ * @param disallowedReason - The truthy description how the disallowed property should be handled
+ * @param element - the element in the schema representing the property
+ * @param value - the value of the property in the manifest
+ * @param manifestPath - the path to the property in the manifest
+ * @returns the ProcessingRule for element, resp. undefined if the element should not be removed from the page specific schema.
+ * Note that the second case will only occur after the refactoring of the undo/redo logic.
+ */
+export declare function handleDisallowedProperty(disallowedReason: DisallowedSpecification, element: Definition, value: unknown, manifestPath: AccessorPath): ProcessingRule | undefined;
+/**
+ * Instances of this type are used during page specific schema generation. They specify how to deal with a specific manifest property.
+ * Instances of this type should be provided by instances of type ManifestAnalyzer (passed to function getSyncRuleForManifestProperty).
+ *
+ * @property manifestPath - specifies where the content for this property should be located within the manifest
+ * @property disallowedReason - faulty when the property is valid for the page. Otherwise describes how to deal with the disallowed property if it is present in the manifest.
+ */
+export type ManifestRule = {
+    manifestPath: AccessorPath;
+    disallowedReason?: DisallowedSpecification;
+};
+/**
+ * An instance of this type provides a possibility to obtain a ManifestRule. ManifestAnalyzers should be provided by users of function getSyncRuleForManifestProperty.
+ *
+ * @param element - the element in the schema representing the property to be analyzed
+ * @param schemaHandlingParams - information provided by the hierarchy level above of the schema generation process
+ * @param generateParameters - input parameters for the schema generation process
+ * @returns a ManifestRule which specifies how to deal with the manifest property
+ */
+export type ManifestAnalyzer = (element: Definition, schemaHandlingParams: SchemaHandlingParams, generateParameters: GenerateAppSchemaParameters) => ManifestRule;
+/**
+ * An instance of this type is called within an instance of type ElementAdapter.
+ * Thereby, the schema element it is working on represents a manifest property.
+ * The function is called with the same parameters as an instance of type ElementAdapter.
+ * The only difference is that the function is called with an additional parameter 'value' which contains the value of the property in the manifest.
+ * The task of this function is to adapt the schema element for the page specific schema (if such an adaptation is necessary).
+ *
+ * @param element - same as in type ElementAdapter. It represents a manifest property.
+ * @param schemaHandlingParams - same as in type ElementAdapter
+ * @param generateParameters - same as in type ElementAdapter
+ * @param value - the value of the property in the manifest
+ * @returns a ProcessingRule which specifies how to deal with the manifest property
+ */
+type ElementAdapterExtended = (element: Definition, schemaHandlingParams: SchemaHandlingParams, generateParameters: GenerateAppSchemaParameters, value: unknown) => void;
+/**
+ * An instance of this type is called within an instance of type ElementAdapter.
+ * Thereby, the schema element it is working on represents a manifest property.
+ * The function is called with the same parameters as an instance of type ElementAdapter.
+ * The only difference is that the parameter 'element' is not passed to the function.
+ * The task of this function is to provide the ReferenceAdaptationInfo which should be included
+ * in the ProcessingRule provided by the ElementAdapter (if an adaptation of the reference is necessary).
+ *
+ * @param schemaHandlingParams - same as in type ElementAdapter
+ * @param generateParameters - same as in type ElementAdapter
+ * @returns the ReferenceAdaptationInfo to be included in the ProcessingRule if necessary
+ */
+export type ReferenceAdaptationProvider = (schemaHandlingParams: SchemaHandlingParams, generateParameters: GenerateAppSchemaParameters) => ReferenceAdaptationInfo | undefined;
+/**
+ * This function can be used to generate a SyncRule for a manifest property that may be omitted in the page specific schema
+ * depending on the context of the page.
+ *
+ * @param property - the name of the property in the manifest the SyncRule should be generated for
+ * @param analyze - provides the ManifestRule for the property
+ * @param adapt - an optional function that can be used to adapt the schema element representing the manifest property
+ * @param provideReferenceAdaptation - an optional function that can be used to provide the ReferenceAdaptationInfo for the manifest property
+ * @param expectedType - the expected type of the value of the property (if it is not undefined)
+ * @returns the SyncRule for the manifest property
+ */
+export declare function getSyncRuleForManifestProperty(property: string, analyze: ManifestAnalyzer, adapt?: ElementAdapterExtended, provideReferenceAdaptation?: ReferenceAdaptationProvider, expectedType?: string): SyncRule;
+export {};
+//# sourceMappingURL=manifestPropertyUtils.d.ts.map

package/dist/specification/src/sync/v2/generate/manifestPropertyUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"manifestPropertyUtils.d.ts","sourceRoot":"","sources":["../../../../../../src/sync/v2/generate/manifestPropertyUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,KAAK,EACR,QAAQ,EACR,2BAA2B,EAC3B,cAAc,EACd,YAAY,EACZ,oBAAoB,EACpB,uBAAuB,EAC1B,MAAM,6BAA6B,CAAC;AAGrC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAKhD;;;;;;;;;;;GAWG;AACH,wBAAgB,oBAAoB,CAChC,MAAM,EAAE,OAAO,EACf,YAAY,EAAE,MAAM,EACpB,MAAM,CAAC,EAAE,eAAe,EACxB,YAAY,GAAE,MAAiB,EAC/B,SAAS,GAAE,OAAe,GAC3B,OAAO,CAqBT;AAED;;GAEG;AACH,eAAO,MAAM,8BAA8B,EAAE,OAAO,MAA6D,CAAC;AAElH;;;;;;;GAOG;AACH,MAAM,MAAM,uBAAuB,GAAG,MAAM,GAAG,OAAO,8BAA8B,CAAC;AAErF;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,wBAAwB,CACpC,gBAAgB,EAAE,uBAAuB,EACzC,OAAO,EAAE,UAAU,EACnB,KAAK,EAAE,OAAO,EACd,YAAY,EAAE,YAAY,GAC3B,cAAc,GAAG,SAAS,CAmB5B;AAED;;;;;;GAMG;AACH,MAAM,MAAM,YAAY,GAAG;IACvB,YAAY,EAAE,YAAY,CAAC;IAC3B,gBAAgB,CAAC,EAAE,uBAAuB,CAAC;CAC9C,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAC3B,OAAO,EAAE,UAAU,EACnB,oBAAoB,EAAE,oBAAoB,EAC1C,kBAAkB,EAAE,2BAA2B,KAC9C,YAAY,CAAC;AAElB;;;;;;;;;;;;GAYG;AACH,KAAK,sBAAsB,GAAG,CAC1B,OAAO,EAAE,UAAU,EACnB,oBAAoB,EAAE,oBAAoB,EAC1C,kBAAkB,EAAE,2BAA2B,EAC/C,KAAK,EAAE,OAAO,KACb,IAAI,CAAC;AAEV;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,2BAA2B,GAAG,CACtC,oBAAoB,EAAE,oBAAoB,EAC1C,kBAAkB,EAAE,2BAA2B,KAC9C,uBAAuB,GAAG,SAAS,CAAC;AAEzC;;;;;;;;;;GAUG;AACH,wBAAgB,8BAA8B,CAC1C,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,gBAAgB,EACzB,KAAK,CAAC,EAAE,sBAAsB,EAC9B,0BAA0B,CAAC,EAAE,2BAA2B,EACxD,YAAY,CAAC,EAAE,MAAM,GACtB,QAAQ,CAwCV"}

package/dist/specification/src/sync/v2/generate/manifestPropertyUtils.js

@@ -0,0 +1,151 @@
+"use strict";
+/**
+ * @file This file contains helper functions for generating page specific schemas that are used in the context of manifest properties.
+ * The functionality is implicitly tested by the more complex unit-tests for generic schema generation and generic import in test-folder unit/genericSchemaHandling.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DISALLOWED_WITHOUT_EXPLANATION = void 0;
+exports.hasPropertyTypeError = hasPropertyTypeError;
+exports.handleDisallowedProperty = handleDisallowedProperty;
+exports.getSyncRuleForManifestProperty = getSyncRuleForManifestProperty;
+const ux_specification_types_1 = require("@sap/ux-specification-types");
+const extensionLogger_1 = require("../../../extensionLogger");
+const i18next_1 = __importDefault(require("i18next"));
+const utils_1 = require("../utils");
+/**
+ * Type check for properties coming from the manifest.
+ *
+ * @param parent - the parent object in manifest which may contain the property.
+ * @param propertyName - name of the property name to be checked
+ * @param logger - a logger which may receive the error message in case a type error is detected
+ * @param expectedType - the expected type of the value of the property (if it is not undefined)
+ * @param mandatory - specifies handling of null and undefined: If parent is null this is always considered an error.
+ * undefined value for parent or its specified property is considered an error when parameter mandatory is true.
+ * null value for the specified property is considered an error when mandatory is true or the expected type is not 'object'.
+ * @returns the information whether a type error was detected.
+ */
+function hasPropertyTypeError(parent, propertyName, logger, expectedType = 'string', mandatory = false) {
+    let hasTypeError;
+    if (parent === undefined) {
+        hasTypeError = mandatory;
+    }
+    else if (parent === null || typeof parent !== 'object') {
+        hasTypeError = true;
+    }
+    else {
+        const propValue = parent[propertyName];
+        if (propValue === undefined) {
+            hasTypeError = mandatory;
+        }
+        else {
+            hasTypeError = typeof propValue !== expectedType || (propValue === null && mandatory);
+        }
+    }
+    if (hasTypeError) {
+        (0, extensionLogger_1.log)(logger, {
+            severity: "error" /* LogSeverity.Error */,
+            message: i18next_1.default.t('TYPEERROR', { propertyName: propertyName, expectedType: expectedType })
+        });
+    }
+    return hasTypeError;
+}
+/**
+ * This symbol is used to indicate that a property is not allowed in the current context and that it should be hidden without any explanation.
+ */
+exports.DISALLOWED_WITHOUT_EXPLANATION = Symbol('Property is suppressed without explanation');
+/**
+ * Helper function to be called within elementAdapters of syncRules.
+ * The function should be called when a property defined in the generic schema is not valid
+ * for the page the specific schema is currently generated for.
+ * We distinguish two cases:
+ * - The property is present in the manifest (although it should not)
+ * - The property is not present in the manifest (as expected)
+ * In the first case the corresponding property should still be present in the schema.
+ * However, a warning message is added to the schema in order to make the user aware of this inconsistency.
+ * In the second case the property should not be shown to the user. So, preferably we would
+ * remove the property from the schema.
+ * However, this is currently not possible due to a flaw in the undo/redo logic which results in schemas
+ * being used to process the export that do not exactly fit to the current state of the config.
+ * For these cases we need the manifest path which is stored with the definition of the property in the schema.
+ * Therefore, we set the hidden flag of the property to true. This will be changed as soon as the undo/redo logic has been refactored.
+ *
+ * @param disallowedReason - The truthy description how the disallowed property should be handled
+ * @param element - the element in the schema representing the property
+ * @param value - the value of the property in the manifest
+ * @param manifestPath - the path to the property in the manifest
+ * @returns the ProcessingRule for element, resp. undefined if the element should not be removed from the page specific schema.
+ * Note that the second case will only occur after the refactoring of the undo/redo logic.
+ */
+function handleDisallowedProperty(disallowedReason, element, value, manifestPath) {
+    delete element.$ref;
+    if (value === undefined || disallowedReason === exports.DISALLOWED_WITHOUT_EXPLANATION) {
+        element[ux_specification_types_1.SchemaTag.hidden] = true;
+    }
+    else {
+        if (typeof value === 'object') {
+            element.type = 'object';
+        }
+        element[ux_specification_types_1.SchemaTag.messages] = [
+            {
+                text: disallowedReason,
+                deletable: true,
+                type: ux_specification_types_1.PropertyMessageType.Warning
+            }
+        ];
+    }
+    return {
+        manifestPath
+    };
+}
+/**
+ * This function can be used to generate a SyncRule for a manifest property that may be omitted in the page specific schema
+ * depending on the context of the page.
+ *
+ * @param property - the name of the property in the manifest the SyncRule should be generated for
+ * @param analyze - provides the ManifestRule for the property
+ * @param adapt - an optional function that can be used to adapt the schema element representing the manifest property
+ * @param provideReferenceAdaptation - an optional function that can be used to provide the ReferenceAdaptationInfo for the manifest property
+ * @param expectedType - the expected type of the value of the property (if it is not undefined)
+ * @returns the SyncRule for the manifest property
+ */
+function getSyncRuleForManifestProperty(property, analyze, adapt, provideReferenceAdaptation, expectedType) {
+    return {
+        manifest: {},
+        elementAdapter: function (element, schemaHandlingParams, generateParameters) {
+            const { manifestPath, disallowedReason } = analyze(element, schemaHandlingParams, generateParameters);
+            if (disallowedReason === exports.DISALLOWED_WITHOUT_EXPLANATION) {
+                return; // Suppress the property even if it is present in the current manifest -> no further processing needed
+            }
+            // What is the state of the property in the current manifest?
+            const { value, parent } = (0, utils_1.getManifestPropertyByPath)(generateParameters.manifest, manifestPath, property);
+            if (disallowedReason) {
+                return handleDisallowedProperty(disallowedReason, element, value, manifestPath);
+            }
+            // The property is applicable.
+            // But it can still be that its current content does not have the correct type.
+            // Type errors are logged. Note that the user can also see these errors.
+            const hasTypeErrors = expectedType
+                ? hasPropertyTypeError(parent, property, generateParameters.logger, expectedType)
+                : false;
+            if (hasTypeErrors && (expectedType === 'object' || typeof value === 'object')) {
+                // either value in manifest is an object but should be scalar or it is scalar but should be an object.
+                // This inconsistency must be removed in the text file of the manifest -> do not provide this property at all
+                return;
+            }
+            if (adapt) {
+                adapt(element, schemaHandlingParams, generateParameters, value);
+            }
+            const referenceAdaptation = provideReferenceAdaptation
+                ? provideReferenceAdaptation(schemaHandlingParams, generateParameters)
+                : undefined;
+            return {
+                manifestPath,
+                referenceAdaptation
+            };
+        }
+    };
+}
+//# sourceMappingURL=manifestPropertyUtils.js.map

package/dist/specification/src/sync/v2/generate/manifestPropertyUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"manifestPropertyUtils.js","sourceRoot":"","sources":["../../../../../../src/sync/v2/generate/manifestPropertyUtils.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;AA8BH,oDA2BC;AAwCD,4DAwBC;AA4ED,wEA8CC;AAxOD,wEAA0F;AAG1F,8DAA+C;AAC/C,sDAA8B;AAC9B,oCAAqD;AAErD;;;;;;;;;;;GAWG;AACH,SAAgB,oBAAoB,CAChC,MAAe,EACf,YAAoB,EACpB,MAAwB,EACxB,eAAuB,QAAQ,EAC/B,YAAqB,KAAK;IAE1B,IAAI,YAAqB,CAAC;IAC1B,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACvB,YAAY,GAAG,SAAS,CAAC;IAC7B,CAAC;SAAM,IAAI,MAAM,KAAK,IAAI,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QACvD,YAAY,GAAG,IAAI,CAAC;IACxB,CAAC;SAAM,CAAC;QACJ,MAAM,SAAS,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC;QACvC,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC1B,YAAY,GAAG,SAAS,CAAC;QAC7B,CAAC;aAAM,CAAC;YACJ,YAAY,GAAG,OAAO,SAAS,KAAK,YAAY,IAAI,CAAC,SAAS,KAAK,IAAI,IAAI,SAAS,CAAC,CAAC;QAC1F,CAAC;IACL,CAAC;IACD,IAAI,YAAY,EAAE,CAAC;QACf,IAAA,qBAAG,EAAC,MAAM,EAAE;YACR,QAAQ,iCAAmB;YAC3B,OAAO,EAAE,iBAAO,CAAC,CAAC,CAAC,WAAW,EAAE,EAAE,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,CAAC;SAC9F,CAAC,CAAC;IACP,CAAC;IACD,OAAO,YAAY,CAAC;AACxB,CAAC;AAED;;GAEG;AACU,QAAA,8BAA8B,GAAkB,MAAM,CAAC,4CAA4C,CAAC,CAAC;AAYlH;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,SAAgB,wBAAwB,CACpC,gBAAyC,EACzC,OAAmB,EACnB,KAAc,EACd,YAA0B;IAE1B,OAAO,OAAO,CAAC,IAAI,CAAC;IACpB,IAAI,KAAK,KAAK,SAAS,IAAI,gBAAgB,KAAK,sCAA8B,EAAE,CAAC;QAC7E,OAAO,CAAC,kCAAS,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IACrC,CAAC;SAAM,CAAC;QACJ,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC5B,OAAO,CAAC,IAAI,GAAG,QAAQ,CAAC;QAC5B,CAAC;QACD,OAAO,CAAC,kCAAS,CAAC,QAAQ,CAAC,GAAG;YAC1B;gBACI,IAAI,EAAE,gBAAgB;gBACtB,SAAS,EAAE,IAAI;gBACf,IAAI,EAAE,4CAAmB,CAAC,OAAO;aACpC;SACJ,CAAC;IACN,CAAC;IACD,OAAO;QACH,YAAY;KACf,CAAC;AACN,CAAC;AAiED;;;;;;;;;;GAUG;AACH,SAAgB,8BAA8B,CAC1C,QAAgB,EAChB,OAAyB,EACzB,KAA8B,EAC9B,0BAAwD,EACxD,YAAqB;IAErB,OAAO;QACH,QAAQ,EAAE,EAAE;QACZ,cAAc,EAAE,UACZ,OAAmB,EACnB,oBAA0C,EAC1C,kBAA+C;YAE/C,MAAM,EAAE,YAAY,EAAE,gBAAgB,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,oBAAoB,EAAE,kBAAkB,CAAC,CAAC;YACtG,IAAI,gBAAgB,KAAK,sCAA8B,EAAE,CAAC;gBACtD,OAAO,CAAC,sGAAsG;YAClH,CAAC;YACD,6DAA6D;YAC7D,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,IAAA,iCAAyB,EAAC,kBAAkB,CAAC,QAAQ,EAAE,YAAY,EAAE,QAAQ,CAAC,CAAC;YACzG,IAAI,gBAAgB,EAAE,CAAC;gBACnB,OAAO,wBAAwB,CAAC,gBAAgB,EAAE,OAAO,EAAE,KAAK,EAAE,YAAY,CAAC,CAAC;YACpF,CAAC;YACD,8BAA8B;YAC9B,+EAA+E;YAC/E,wEAAwE;YACxE,MAAM,aAAa,GAAG,YAAY;gBAC9B,CAAC,CAAC,oBAAoB,CAAC,MAAM,EAAE,QAAQ,EAAE,kBAAkB,CAAC,MAAM,EAAE,YAAY,CAAC;gBACjF,CAAC,CAAC,KAAK,CAAC;YACZ,IAAI,aAAa,IAAI,CAAC,YAAY,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,CAAC,EAAE,CAAC;gBAC5E,sGAAsG;gBACtG,6GAA6G;gBAC7G,OAAO;YACX,CAAC;YACD,IAAI,KAAK,EAAE,CAAC;gBACR,KAAK,CAAC,OAAO,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,KAAK,CAAC,CAAC;YACpE,CAAC;YACD,MAAM,mBAAmB,GAAG,0BAA0B;gBAClD,CAAC,CAAC,0BAA0B,CAAC,oBAAoB,EAAE,kBAAkB,CAAC;gBACtE,CAAC,CAAC,SAAS,CAAC;YAChB,OAAO;gBACH,YAAY;gBACZ,mBAAmB;aACtB,CAAC;QACN,CAAC;KACJ,CAAC;AACN,CAAC"}

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

@@ -1,9 +1,9 @@
 import type { GenerateAppSchemaParameters } from '@sap/ux-specification-types';
 /**
  * Generates an app specific schema out of the generic schema.
- * @param {GenerateSchemaParameters} generateParameters - list of API input parameters
- * @param genericSchema - generic JSON schema of an object page
  *
+ * @param generateParameters - list of API input parameters
+ * @param genericSchema - generic JSON schema of an object page
  * @returns the app specific JSON schema
  */
 export declare function generateObjectPageSchemaV2(generateParameters: GenerateAppSchemaParameters, genericSchema: object): object;

package/dist/specification/src/sync/v2/generate/objectPage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"objectPage.d.ts","sourceRoot":"","sources":["../../../../../../src/sync/v2/generate/objectPage.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAKR,2BAA2B,EAE9B,MAAM,6BAA6B,CAAC;AA20BrC;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CACtC,kBAAkB,EAAE,2BAA2B,EAC/C,aAAa,EAAE,MAAM,GACtB,MAAM,CA8FR"}
+{"version":3,"file":"objectPage.d.ts","sourceRoot":"","sources":["../../../../../../src/sync/v2/generate/objectPage.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAKR,2BAA2B,EAE9B,MAAM,6BAA6B,CAAC;AA22BrC;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CACtC,kBAAkB,EAAE,2BAA2B,EAC/C,aAAa,EAAE,MAAM,GACtB,MAAM,CA8FR"}