@sap/ux-specification 1.84.112 → 1.84.114

package/dist/specification/src/sync/v2/export/exportPageGeneric.js

@@ -0,0 +1,307 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.exportPage = exportPage;
+const ux_specification_types_1 = require("@sap/ux-specification-types");
+const utils_1 = require("../utils");
+const common_1 = require("../../common");
+/**
+ * This function is called for every property in the page specific schema with artifactType FlexChange.
+ * Thereby, we assume that such a property always corresponds to a control property (with same name) that can be changed via a flex change
+ * The function will derive the information about the flex change that should be created (or the information that no flex change is needed)
+ * for this property and add it to the list.
+ *
+ * @param propertyDefinition - definition of the property in the page specific schema
+ * @param value - the value for the property according to the config object that is currently exported
+ * @param propertyName - name of the property
+ * @param flexList - the list to be enhanced
+ */
+function addFlexChangeInfoToList(propertyDefinition, value, propertyName, flexList) {
+    const newValue = value === undefined ? null : value; // special logic for control properties which are not changed by flex
+    // TODO: Add conversion exit logic
+    const isBinding = typeof newValue === 'string' && newValue.startsWith('{');
+    flexList.push({
+        controlId: propertyDefinition[ux_specification_types_1.SchemaTag.controlId],
+        controlType: propertyDefinition[ux_specification_types_1.SchemaTag.controlType],
+        propertyName,
+        newValue,
+        isBinding
+    });
+}
+/**
+ * Returns how a value from the config should be passed to the manifest.
+ * This function will be called for all properties with artifactType 'Manifest'.
+ * In case the property has type 'object' it will also be recursively be called for all children of the object.
+ *
+ * @param value - the value for the property in the config currently processed (undefined if the property is not present in the config)
+ * @param oldValue - current value for the property in the manifest (resp. undefined if the property is not in the current manifest)
+ * @param propertyDefinition - definition of the property in the current schema
+ * @param globalTypeDefinitions - global type definitions that may be referred from within propertyDefinition
+ * @returns the value for the property in the modified manifest, resp. undefined when the property should be removed from the manifest.
+ */
+function getValueForManifest(value, oldValue, propertyDefinition, globalTypeDefinitions) {
+    // Special logic for string arrays. Note that the opposite logic is implemented in function getConfigRep in import.importPage.ts
+    if (propertyDefinition.type === 'array' && propertyDefinition.items?.['type'] === 'string') {
+        if (!Array.isArray(value) || value.length === 0) {
+            return oldValue === '' || typeof oldValue !== 'string' ? oldValue : undefined;
+        }
+        return value.join(',');
+    }
+    if (value === oldValue || propertyDefinition.type !== 'object' || !propertyDefinition.properties) {
+        return value; // unchanged entries will not be modified. Moreover, only objects with properties need special care
+    }
+    // In case an object is to be returned this return object is built as follows:
+    // Take (a shallow copy of) oldValue as a starting point (resp. an empty object if oldValue was not a valid object) and
+    // replace its values for 'known' properties (i.e. the properties defined in the schema) by the corresponding property value from newValue.
+    // If this would set the property value to undefined remove the property instead.
+    // Note that this procedure guarantees that the values for unknown properties stay as they are in oldValue.
+    const returnObject = typeof oldValue === 'object' && oldValue !== null ? { ...oldValue } : {};
+    let hasNewValueDefinedChildProperty = false;
+    let hasOldValueDefinedChildProperty = false;
+    for (const childProperty in propertyDefinition.properties) {
+        let childPropertyDefinition = propertyDefinition.properties[childProperty];
+        if (!(0, utils_1.isDefinition)(childPropertyDefinition)) {
+            continue; // ignore properties defined as boolean (should not appear in our schemas anyway)
+        }
+        const refType = (0, common_1.getRefType)(childPropertyDefinition);
+        childPropertyDefinition = (refType && globalTypeDefinitions[refType]) || childPropertyDefinition;
+        const oldChildValue = returnObject[childProperty];
+        hasOldValueDefinedChildProperty = hasOldValueDefinedChildProperty || oldChildValue !== undefined;
+        const newChildValue = getValueForManifest(value ? value[childProperty] : undefined, oldChildValue, childPropertyDefinition, globalTypeDefinitions);
+        if (newChildValue === undefined) {
+            delete returnObject[childProperty];
+        }
+        else {
+            returnObject[childProperty] = newChildValue;
+            hasNewValueDefinedChildProperty = true;
+        }
+    }
+    // If the object which was built in the way described above has at least one known property value we can safely return it as the new value
+    if (hasNewValueDefinedChildProperty) {
+        return returnObject;
+    }
+    // When we reach this point newValue does not contain a value for any known property. If the same was true for oldValue we can safely return the oldValue as
+    // no changes have been applied to this object.
+    if (!hasOldValueDefinedChildProperty) {
+        return oldValue;
+    }
+    // When we reach this point then newValue contains the information that all known properties should be removed from the oldValue
+    // and that this has happened for at least one property. We still distinguish two cases:
+    // - oldValues contains no unknown properties. As all known properties have been removed, returnObject has been stripped to be an empty object.
+    //   In this case we return undefined to indicate that the object should be removed from the manifest as well.
+    // - oldValue contains at least one unknown property. In this case we want to keep the object alive, now containing only the unknown properties.
+    //   This is, what we get from returnObject.
+    return Object.keys(oldValue).every((oldValueKey) => (0, utils_1.isDefinition)(propertyDefinition.properties[oldValueKey]))
+        ? undefined
+        : returnObject;
+}
+/**
+ * Returns whether two java script instances should be considered as different manifest entries.
+ *
+ * @param obj1 the first instance
+ * @param obj2 the second instance
+ * @returns whether obj1 and obj2 should be considered different.
+ */
+function isDifferent(obj1, obj2) {
+    if (typeof obj1 !== 'object' || typeof obj2 !== 'object' || obj1 === null || obj2 === null) {
+        return obj1 !== obj2;
+    }
+    // This if-block is probably superfluous, since manifests of v2 apps should not contain any
+    // arrays. We leave it in for completeness.
+    if (Array.isArray(obj1) || Array.isArray(obj2)) {
+        if (Array.isArray(obj1) && Array.isArray(obj2)) {
+            return (obj1.length !== obj2.length ||
+                obj1.some(function (entry1, i) {
+                    return isDifferent(entry1, obj2[i]);
+                }));
+        }
+        return true;
+    }
+    const keys1 = Object.keys(obj1).filter((key) => obj1[key] !== undefined);
+    const keys2 = Object.keys(obj2).filter((key) => obj2[key] !== undefined);
+    return (keys1.length !== keys2.length ||
+        keys1.some(function (key) {
+            return isDifferent(obj1[key], obj2[key]);
+        }));
+}
+/**
+ * Returns whether an object should be considered as an empty object (and thus normally should be removed from the manifest).
+ *
+ * @param obj - the object to be checked
+ * @returns whether the object should be considered empty
+ */
+function isEmpty(obj) {
+    return !obj || !Object.keys(obj).some((key) => obj[key] !== undefined);
+}
+/**
+ * This function is called by transferConfigPropertyToExportResults (see below) for schema properties that have artifactType 'Manifest'.
+ * It is responsible for transferring the config value of this property to the manifest and the fragments (not implemented yet).
+ *
+ * @param fullManifestPath - the path in the manifest (ending with the name of the property itself) the value should be passed to
+ * @param value - content of the property according to the config, resp. undefined if the property is not present in the config.
+ * In the later case the property should (normally) be removed from the manifest.
+ * @param target - the results of the export to be updated
+ * @param propertyDefinition - definition of the property in the page specific schema
+ * @param globalTypeDefinitions - global type definitions that may be referred from within propertyDefinition
+ */
+function applyManifestChange(fullManifestPath, value, target, propertyDefinition, globalTypeDefinitions) {
+    let manifestSection = target.manifest; // will be used to step down in the hierarchy of the manifest to the parent of the target property
+    const lengthToParent = fullManifestPath.length - 1;
+    const finalProperty = fullManifestPath[lengthToParent]; // name of the property which should be updated
+    const backPath = []; // Will be set to contain the (not null) objects in the current manifest which lie on the path to the parent of the target property
+    // Step down in the manifest to the parent of the target property. Stop if an entry on that path is missing (or not an object).
+    fullManifestPath.some(function (property, i) {
+        if (i === lengthToParent) {
+            // as we only want to navigate to the parent, stop now
+            return true;
+        }
+        const nextSection = manifestSection[property];
+        if (typeof nextSection !== 'object' || nextSection === null) {
+            return true; // do not step down to something which is not an object (normally that means that we reached undefined, but incorrect manifests may also contain other values where an object is expected)
+        }
+        // Safely step down to the object on the next level
+        manifestSection = nextSection;
+        backPath.push(manifestSection);
+    });
+    // If the length of backPath is lengthToParent the parent object already exists in the manifest (and is an object). So we (potentially) have an old value for the target property
+    const oldValue = backPath.length === lengthToParent ? manifestSection[finalProperty] : undefined;
+    const newValue = getValueForManifest(value, oldValue, propertyDefinition, globalTypeDefinitions);
+    if (!isDifferent(newValue, oldValue)) {
+        return; // nothing to do
+    }
+    // newValue and oldValue are different
+    if (newValue === undefined) {
+        // Note: As newValue and oldValue are different, oldValue cannot be undefined as well. Hence, backPath.length === lengthToParent according to the definition of oldValue
+        target.manifestChangeIndicator = ux_specification_types_1.ChangeIndicator.Deleted;
+        // Remove the specified property from its parent. Then loop the object hierarchy upwards and delete all objects which have been made empty by this process.
+        for (let i = lengthToParent; i > 0; i--) {
+            const candidateForRemove = backPath[i]; // will be undefined in the first run
+            if (!isEmpty(candidateForRemove)) {
+                break; // stop the process when finding an object that is not empty after deleting the specified entry. Will not happen in the first run.
+            }
+            // As the object is empty: Remove it from its parent. Will be executed at least once, thereby removing the specified property from its parent.
+            const parent = backPath[i - 1];
+            const prop = fullManifestPath[i];
+            delete parent[prop];
+        }
+    }
+    else {
+        // Create a path of empty objects to the parent of target, if the manifest is not structured deep enough yet
+        for (let i = backPath.length; i < lengthToParent; i++) {
+            const newEmptyObject = {};
+            manifestSection[fullManifestPath[i]] = newEmptyObject;
+            manifestSection = newEmptyObject;
+        }
+        // Now manifestSection is the parent object of the property to be set -> update it with the new value
+        manifestSection[finalProperty] = newValue;
+        target.manifestChangeIndicator = oldValue === undefined ? ux_specification_types_1.ChangeIndicator.Created : ux_specification_types_1.ChangeIndicator.Updated;
+    }
+}
+/**
+ * This function is called by function transferConfigToExportResults (see below) for all properties contained in the
+ * schema element processed by this function.
+ * It is responsible for transferring the content of the config for this property to the export results.
+ *
+ * @param source - the section of the config that potentially contains the property
+ * @param target - the results of the export to be updated
+ * @param property - name of the property to be handled
+ * @param propertyDefinition - definition of the property in the page specific schema
+ * @param globalTypeDefinitions - global type definitions that may be referred from within propertyDefinition
+ */
+function transferConfigPropertyToExportResults(source, target, property, propertyDefinition, globalTypeDefinitions) {
+    const sourcePart = source?.[property];
+    const artifactType = propertyDefinition[ux_specification_types_1.SchemaTag.artifactType];
+    // We distinguish three cases:
+    // - current property is handled by flex
+    // - current property can be mapped onto a manifest property (or a section within the manifest)
+    // - property is still complex and points to a global type which describes how the content should be processed
+    // Note that the inline definition of a complex type is not yet supported.
+    if (artifactType === ux_specification_types_1.ArtifactType.FlexChange) {
+        // Case 1
+        addFlexChangeInfoToList(propertyDefinition, sourcePart, property, target.flexList);
+    }
+    else if (artifactType === ux_specification_types_1.ArtifactType.Manifest && propertyDefinition[ux_specification_types_1.SchemaTag.manifestPath]) {
+        // Case 2
+        let manifestPath;
+        // propertyDefinition.manifestPath is an instance of AccessorSpec that describes how to find
+        // the place in the manifest representing the property.
+        // We will use this definition to build the full path (including the property name itself) -> this is manifestPath
+        const accessorSpec = propertyDefinition[ux_specification_types_1.SchemaTag.manifestPath];
+        if (Array.isArray(accessorSpec)) {
+            manifestPath = accessorSpec.concat([property]);
+        }
+        else {
+            manifestPath = accessorSpec.path;
+            if (accessorSpec.addTargetPropertyToPath) {
+                manifestPath = manifestPath.concat([property]);
+            }
+        }
+        applyManifestChange(manifestPath, sourcePart, target, propertyDefinition, globalTypeDefinitions);
+    }
+    else {
+        // Note: inline type definitions currently not supported
+        const refType = (0, common_1.getRefType)(propertyDefinition);
+        const refTypeDefinition = refType ? globalTypeDefinitions[refType] : undefined;
+        if ((0, utils_1.isDefinition)(refTypeDefinition)) {
+            transferConfigToExportResults(sourcePart, target, refTypeDefinition, globalTypeDefinitions);
+        }
+    }
+}
+/**
+ * This function is used by function exportPage (see below).
+ * It (recursively) transfers the content of the config or one of its sub-objects to the export results.
+ * Note that the process is driven by the structure of the schema and not by the structure of the current config.
+ * This means that we will finally process all properties defined directly or indirectly within the given schema element, even if they are not contained in the config
+ * (which means that no change for the corresponding property should be there).
+ * This ensures that properties which have been removed from the config are handled correctly as well (for manifest based properties this means that they are removed from the manifest,
+ * for flex changes this means that a flex change with value null is created).
+ *
+ * @param source - the section of the config to be transferred
+ * @param target - the results of the export to be updated
+ * @param definition - schema element describing the section of the config currently processed
+ * @param globalTypeDefinitions - global type definitions that may be referred from within definition
+ */
+function transferConfigToExportResults(source, target, definition, globalTypeDefinitions) {
+    const properties = definition.properties || {};
+    // Perform the update for all available properties
+    for (const property in properties) {
+        // propertyDefinition tells us how to handle the property
+        const propertyDefinition = definition.properties[property];
+        if ((0, utils_1.isDefinition)(propertyDefinition)) {
+            // ignore properties that are null or boolean (should not occur in our schemas anyway)
+            transferConfigPropertyToExportResults(source, target, property, propertyDefinition, globalTypeDefinitions);
+        }
+    }
+}
+/**
+ * This function implements the generic export for a page.
+ * More precisely it takes the current state of the app (manifest, flex changes, fragments), the page specific schema for a page within the app, and the
+ * config for this page. It returns the information how the app should be adapted.
+ * Thereby, we assume that the config was created by function getConfigForPage (in importPage.ts) from the current state of the page
+ * and then potentially modified (e.g. by user interaction).
+ *
+ * @param inParameters - an object containing all information relevant for the export process
+ * @returns the information about the updated state of the app
+ */
+function exportPage(inParameters) {
+    const config = inParameters.config;
+    const globalTypeDefinitions = inParameters.jsonSchema.definitions;
+    // As a starting point create a return object representing the current state of the app
+    const fragmentResults = (inParameters.fragments || []).map(function (fragment) {
+        const result = {
+            ...fragment,
+            changeIndicator: ux_specification_types_1.ChangeIndicator.NoChange
+        };
+        return result;
+    });
+    // TODO: Check whether property 'views' needs to be initialized as well
+    const returnObject = {
+        manifest: structuredClone(inParameters.manifest),
+        manifestChangeIndicator: ux_specification_types_1.ChangeIndicator.NoChange,
+        flexList: [],
+        fragments: fragmentResults
+    };
+    // Adapt returnObject according to the state of the config. This is driven by the page specific schema.
+    transferConfigToExportResults(config, returnObject, inParameters.jsonSchema, globalTypeDefinitions);
+    return returnObject;
+}
+//# sourceMappingURL=exportPageGeneric.js.map

package/dist/specification/src/sync/v2/export/exportPageGeneric.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"exportPageGeneric.js","sourceRoot":"","sources":["../../../../../../src/sync/v2/export/exportPageGeneric.ts"],"names":[],"mappings":";;AAuYA,gCAuBC;AA9YD,wEAAuF;AAEvF,oCAAwC;AACxC,yCAA0C;AAwD1C;;;;;;;;;;GAUG;AACH,SAAS,uBAAuB,CAC5B,kBAA8B,EAC9B,KAAc,EACd,YAAoB,EACpB,QAAoB;IAEpB,MAAM,QAAQ,GAAG,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,qEAAqE;IAC1H,kCAAkC;IAClC,MAAM,SAAS,GAAG,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IAC3E,QAAQ,CAAC,IAAI,CAAC;QACV,SAAS,EAAE,kBAAkB,CAAC,kCAAS,CAAC,SAAS,CAAC;QAClD,WAAW,EAAE,kBAAkB,CAAC,kCAAS,CAAC,WAAW,CAAC;QACtD,YAAY;QACZ,QAAQ;QACR,SAAS;KACZ,CAAC,CAAC;AACP,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAS,mBAAmB,CACxB,KAAc,EACd,QAAiB,EACjB,kBAA8B,EAC9B,qBAAoD;IAEpD,gIAAgI;IAChI,IAAI,kBAAkB,CAAC,IAAI,KAAK,OAAO,IAAI,kBAAkB,CAAC,KAAK,EAAE,CAAC,MAAM,CAAC,KAAK,QAAQ,EAAE,CAAC;QACzF,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC9C,OAAO,QAAQ,KAAK,EAAE,IAAI,OAAO,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;QAClF,CAAC;QACD,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC3B,CAAC;IACD,IAAI,KAAK,KAAK,QAAQ,IAAI,kBAAkB,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,kBAAkB,CAAC,UAAU,EAAE,CAAC;QAC/F,OAAO,KAAK,CAAC,CAAC,mGAAmG;IACrH,CAAC;IACD,8EAA8E;IAC9E,uHAAuH;IACvH,2IAA2I;IAC3I,iFAAiF;IACjF,2GAA2G;IAC3G,MAAM,YAAY,GAAG,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAC9F,IAAI,+BAA+B,GAAG,KAAK,CAAC;IAC5C,IAAI,+BAA+B,GAAG,KAAK,CAAC;IAC5C,KAAK,MAAM,aAAa,IAAI,kBAAkB,CAAC,UAAU,EAAE,CAAC;QACxD,IAAI,uBAAuB,GAAG,kBAAkB,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;QAC3E,IAAI,CAAC,IAAA,oBAAY,EAAC,uBAAuB,CAAC,EAAE,CAAC;YACzC,SAAS,CAAC,iFAAiF;QAC/F,CAAC;QACD,MAAM,OAAO,GAAG,IAAA,mBAAU,EAAC,uBAAuB,CAAC,CAAC;QACpD,uBAAuB,GAAG,CAAC,OAAO,IAAI,qBAAqB,CAAC,OAAO,CAAC,CAAC,IAAI,uBAAuB,CAAC;QACjG,MAAM,aAAa,GAAG,YAAY,CAAC,aAAa,CAAC,CAAC;QAClD,+BAA+B,GAAG,+BAA+B,IAAI,aAAa,KAAK,SAAS,CAAC;QACjG,MAAM,aAAa,GAAG,mBAAmB,CACrC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,SAAS,EACxC,aAAa,EACb,uBAAuB,EACvB,qBAAqB,CACxB,CAAC;QACF,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;YAC9B,OAAO,YAAY,CAAC,aAAa,CAAC,CAAC;QACvC,CAAC;aAAM,CAAC;YACJ,YAAY,CAAC,aAAa,CAAC,GAAG,aAAa,CAAC;YAC5C,+BAA+B,GAAG,IAAI,CAAC;QAC3C,CAAC;IACL,CAAC;IACD,0IAA0I;IAC1I,IAAI,+BAA+B,EAAE,CAAC;QAClC,OAAO,YAAY,CAAC;IACxB,CAAC;IACD,4JAA4J;IAC5J,+CAA+C;IAC/C,IAAI,CAAC,+BAA+B,EAAE,CAAC;QACnC,OAAO,QAAQ,CAAC;IACpB,CAAC;IACD,gIAAgI;IAChI,wFAAwF;IACxF,+IAA+I;IAC/I,8GAA8G;IAC9G,gJAAgJ;IAChJ,4CAA4C;IAC5C,OAAO,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,IAAA,oBAAY,EAAC,kBAAkB,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC;QACzG,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,YAAY,CAAC;AACvB,CAAC;AAED;;;;;;GAMG;AACH,SAAS,WAAW,CAAC,IAAa,EAAE,IAAa;IAC7C,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QACzF,OAAO,IAAI,KAAK,IAAI,CAAC;IACzB,CAAC;IACD,2FAA2F;IAC3F,2CAA2C;IAC3C,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QAC7C,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7C,OAAO,CACH,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM;gBAC3B,IAAI,CAAC,IAAI,CAAC,UAAU,MAAM,EAAE,CAAC;oBACzB,OAAO,WAAW,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;gBACxC,CAAC,CAAC,CACL,CAAC;QACN,CAAC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC,CAAC;IACzE,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC,CAAC;IACzE,OAAO,CACH,KAAK,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM;QAC7B,KAAK,CAAC,IAAI,CAAC,UAAU,GAAG;YACpB,OAAO,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QAC7C,CAAC,CAAC,CACL,CAAC;AACN,CAAC;AAED;;;;;GAKG;AACH,SAAS,OAAO,CAAC,GAAuB;IACpC,OAAO,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC,CAAC;AAC3E,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAS,mBAAmB,CACxB,gBAA8B,EAC9B,KAAc,EACd,MAAyB,EACzB,kBAA8B,EAC9B,qBAAoD;IAEpD,IAAI,eAAe,GAAW,MAAM,CAAC,QAAQ,CAAC,CAAC,kGAAkG;IACjJ,MAAM,cAAc,GAAG,gBAAgB,CAAC,MAAM,GAAG,CAAC,CAAC;IACnD,MAAM,aAAa,GAAG,gBAAgB,CAAC,cAAc,CAAC,CAAC,CAAC,+CAA+C;IACvG,MAAM,QAAQ,GAAa,EAAE,CAAC,CAAC,mIAAmI;IAClK,+HAA+H;IAC/H,gBAAgB,CAAC,IAAI,CAAC,UAAU,QAAQ,EAAE,CAAC;QACvC,IAAI,CAAC,KAAK,cAAc,EAAE,CAAC;YACvB,sDAAsD;YACtD,OAAO,IAAI,CAAC;QAChB,CAAC;QACD,MAAM,WAAW,GAAG,eAAe,CAAC,QAAQ,CAAC,CAAC;QAC9C,IAAI,OAAO,WAAW,KAAK,QAAQ,IAAI,WAAW,KAAK,IAAI,EAAE,CAAC;YAC1D,OAAO,IAAI,CAAC,CAAC,0LAA0L;QAC3M,CAAC;QACD,mDAAmD;QACnD,eAAe,GAAG,WAAW,CAAC;QAC9B,QAAQ,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACnC,CAAC,CAAC,CAAC;IACH,iLAAiL;IACjL,MAAM,QAAQ,GAAG,QAAQ,CAAC,MAAM,KAAK,cAAc,CAAC,CAAC,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACjG,MAAM,QAAQ,GAAG,mBAAmB,CAAC,KAAK,EAAE,QAAQ,EAAE,kBAAkB,EAAE,qBAAqB,CAAC,CAAC;IACjG,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,CAAC;QACnC,OAAO,CAAC,gBAAgB;IAC5B,CAAC;IACD,sCAAsC;IACtC,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QACzB,wKAAwK;QACxK,MAAM,CAAC,uBAAuB,GAAG,wCAAe,CAAC,OAAO,CAAC;QACzD,2JAA2J;QAC3J,KAAK,IAAI,CAAC,GAAG,cAAc,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YACtC,MAAM,kBAAkB,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,qCAAqC;YAC7E,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE,CAAC;gBAC/B,MAAM,CAAC,kIAAkI;YAC7I,CAAC;YACD,8IAA8I;YAC9I,MAAM,MAAM,GAAG,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAC/B,MAAM,IAAI,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC;YACjC,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC;QACxB,CAAC;IACL,CAAC;SAAM,CAAC;QACJ,4GAA4G;QAC5G,KAAK,IAAI,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,GAAG,cAAc,EAAE,CAAC,EAAE,EAAE,CAAC;YACpD,MAAM,cAAc,GAAG,EAAE,CAAC;YAC1B,eAAe,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC;YACtD,eAAe,GAAG,cAAc,CAAC;QACrC,CAAC;QACD,qGAAqG;QACrG,eAAe,CAAC,aAAa,CAAC,GAAG,QAAQ,CAAC;QAC1C,MAAM,CAAC,uBAAuB,GAAG,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,wCAAe,CAAC,OAAO,CAAC,CAAC,CAAC,wCAAe,CAAC,OAAO,CAAC;IAChH,CAAC;AACL,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAS,qCAAqC,CAC1C,MAAe,EACf,MAAyB,EACzB,QAAgB,EAChB,kBAA8B,EAC9B,qBAAoD;IAEpD,MAAM,UAAU,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,CAAC;IACtC,MAAM,YAAY,GAAW,kBAAkB,CAAC,kCAAS,CAAC,YAAY,CAAC,CAAC;IACxE,8BAA8B;IAC9B,wCAAwC;IACxC,+FAA+F;IAC/F,8GAA8G;IAC9G,0EAA0E;IAC1E,IAAI,YAAY,KAAK,qCAAY,CAAC,UAAU,EAAE,CAAC;QAC3C,SAAS;QACT,uBAAuB,CAAC,kBAAkB,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;IACvF,CAAC;SAAM,IAAI,YAAY,KAAK,qCAAY,CAAC,QAAQ,IAAI,kBAAkB,CAAC,kCAAS,CAAC,YAAY,CAAC,EAAE,CAAC;QAC9F,SAAS;QACT,IAAI,YAA0B,CAAC;QAC/B,4FAA4F;QAC5F,uDAAuD;QACvD,kHAAkH;QAClH,MAAM,YAAY,GAAG,kBAAkB,CAAC,kCAAS,CAAC,YAAY,CAAiB,CAAC;QAChF,IAAI,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;YAC9B,YAAY,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;QACnD,CAAC;aAAM,CAAC;YACJ,YAAY,GAAG,YAAY,CAAC,IAAI,CAAC;YACjC,IAAI,YAAY,CAAC,uBAAuB,EAAE,CAAC;gBACvC,YAAY,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;YACnD,CAAC;QACL,CAAC;QACD,mBAAmB,CAAC,YAAY,EAAE,UAAU,EAAE,MAAM,EAAE,kBAAkB,EAAE,qBAAqB,CAAC,CAAC;IACrG,CAAC;SAAM,CAAC;QACJ,wDAAwD;QACxD,MAAM,OAAO,GAAG,IAAA,mBAAU,EAAC,kBAAkB,CAAC,CAAC;QAC/C,MAAM,iBAAiB,GAAG,OAAO,CAAC,CAAC,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC/E,IAAI,IAAA,oBAAY,EAAC,iBAAiB,CAAC,EAAE,CAAC;YAClC,6BAA6B,CAAC,UAAU,EAAE,MAAM,EAAE,iBAAiB,EAAE,qBAAqB,CAAC,CAAC;QAChG,CAAC;IACL,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,SAAS,6BAA6B,CAClC,MAAe,EACf,MAAyB,EACzB,UAAsB,EACtB,qBAAoD;IAEpD,MAAM,UAAU,GAAG,UAAU,CAAC,UAAU,IAAI,EAAE,CAAC;IAC/C,kDAAkD;IAClD,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE,CAAC;QAChC,yDAAyD;QACzD,MAAM,kBAAkB,GAAG,UAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAC3D,IAAI,IAAA,oBAAY,EAAC,kBAAkB,CAAC,EAAE,CAAC;YACnC,sFAAsF;YACtF,qCAAqC,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,kBAAkB,EAAE,qBAAqB,CAAC,CAAC;QAC/G,CAAC;IACL,CAAC;AACL,CAAC;AAED;;;;;;;;;GASG;AACH,SAAgB,UAAU,CAAC,YAAoC;IAC3D,MAAM,MAAM,GAAG,YAAY,CAAC,MAAM,CAAC;IACnC,MAAM,qBAAqB,GAAG,YAAY,CAAC,UAAU,CAAC,WAA4C,CAAC;IAEnG,uFAAuF;IACvF,MAAM,eAAe,GAAG,CAAC,YAAY,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,UAAU,QAAQ;QACzE,MAAM,MAAM,GAAmB;YAC3B,GAAG,QAAQ;YACX,eAAe,EAAE,wCAAe,CAAC,QAAQ;SAC5C,CAAC;QACF,OAAO,MAAM,CAAC;IAClB,CAAC,CAAC,CAAC;IAEH,uEAAuE;IACvE,MAAM,YAAY,GAAG;QACjB,QAAQ,EAAE,eAAe,CAAC,YAAY,CAAC,QAAQ,CAAC;QAChD,uBAAuB,EAAE,wCAAe,CAAC,QAAQ;QACjD,QAAQ,EAAE,EAAgB;QAC1B,SAAS,EAAE,eAAe;KAC7B,CAAC;IACF,uGAAuG;IACvG,6BAA6B,CAAC,MAAM,EAAE,YAAY,EAAE,YAAY,CAAC,UAAU,EAAE,qBAAqB,CAAC,CAAC;IACpG,OAAO,YAAY,CAAC;AACxB,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/schemaAdaptation.d.ts

@@ -1,8 +1,8 @@
 /**
- * This file provides a function that generically creates a page specific schema out of a generic schema for a page
+ * @file This file provides a function that generically creates a page specific schema out of a generic schema for a page
  * of a FE v2 app (function getAdaptedSchema).
  * In addition to that it exposes some generic helper functions that can be used to configure the generation process.
- * Unit tests for this class are located in test.unit.genericSchemaHandling.schemaAdaptation.test.ts
+ * Unit tests for this class are located in test.unit.genericSchemaHandling.schemaAdaptation.test.ts.
  */
 import type { Definition } from 'typescript-json-schema';
 import type { AccessorPath, ExtensionLogger, FileData, Manifest } from '@sap/ux-specification-types';