@sap/ux-specification 1.124.32 → 1.124.34

package/dist/specification/src/sync/v4/sync-rules/AppSchema.js

@@ -0,0 +1,384 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AppSchema = void 0;
+const ux_specification_types_1 = require("@sap/ux-specification-types");
+const common_1 = require("../../common");
+/**
+ * Central manager for application schema lifecycle and operations.
+ * Encapsulates all schema structure knowledge and provides clean APIs for schema manipulation.
+ */
+class AppSchema {
+    /**
+     * Constructor for AppSchema.
+     *
+     * @param genericSchema - The initial generic schema object
+     */
+    constructor(genericSchema) {
+        this.schema = JSON.parse(JSON.stringify(genericSchema));
+    }
+    /**
+     * Validates a property path array.
+     *
+     * @param propertyPath - The path to validate
+     * @returns true if valid, false otherwise
+     */
+    isValidPropertyPath(propertyPath) {
+        return (Array.isArray(propertyPath) &&
+            propertyPath.length > 0 &&
+            propertyPath.every((key) => typeof key === 'string' && key.length > 0));
+    }
+    /**
+     * Resolves a $ref to its actual definition.
+     *
+     * @param ref - The $ref string (e.g., "#/definitions/MyDefinition")
+     * @returns The resolved definition or undefined
+     */
+    resolveRef(ref) {
+        if (typeof ref !== 'string' || !ref.startsWith(common_1.DEFINITION_LINK_PREFIX)) {
+            return undefined;
+        }
+        const definitionName = ref.substring(common_1.DEFINITION_LINK_PREFIX.length);
+        return this.getDefinition(definitionName);
+    }
+    /**
+     * Navigates through an object using a property path and returns the value at that path.
+     * Automatically resolves $ref references when encountered.
+     *
+     * @param root - The root object to navigate from
+     * @param propertyPath - Array of keys forming the path
+     * @param createIntermediates - Whether to create intermediate objects if they don't exist
+     * @param resolveRefs - Whether to resolve $ref references during navigation (default: true)
+     * @returns The value at the path, or undefined if not found
+     */
+    navigatePropertyPath(root, propertyPath, createIntermediates = false, resolveRefs = true) {
+        if (!root || !this.isValidPropertyPath(propertyPath)) {
+            return undefined;
+        }
+        let current = root;
+        for (let i = 0; i < propertyPath.length; i++) {
+            const key = propertyPath[i];
+            const isLastKey = i === propertyPath.length - 1;
+            if (current[key] === undefined || current[key] === null) {
+                if (createIntermediates) {
+                    current[key] = {};
+                }
+                else {
+                    return undefined;
+                }
+            }
+            // Check if the current value has a $ref and resolve it
+            // When we resolve a $ref, we navigate into the resolved definition
+            // without modifying the original object
+            // Don't resolve on the last key to allow reading properties that contain $ref
+            // Only resolve if $ref is the ONLY property (pure reference)
+            if (!createIntermediates && resolveRefs && !isLastKey && current[key]?.$ref) {
+                const keys = Object.keys(current[key]);
+                const isPureRef = keys.length === 1 && keys[0] === '$ref';
+                if (isPureRef) {
+                    const resolved = this.resolveRef(current[key].$ref);
+                    if (resolved) {
+                        // Navigate into the resolved definition without mutating original
+                        current = resolved;
+                        continue;
+                    }
+                }
+            }
+            if (typeof current[key] !== 'object') {
+                return createIntermediates ? undefined : current[key];
+            }
+            current = current[key];
+        }
+        return current;
+    }
+    /**
+     * Sets a value at a property path within an object, creating intermediate objects as needed.
+     *
+     * @param root - The root object to navigate from
+     * @param propertyPath - Array of keys forming the path
+     * @param value - The value to set
+     * @returns true if successful, false otherwise
+     */
+    setPropertyPath(root, propertyPath, value) {
+        if (!root || !this.isValidPropertyPath(propertyPath)) {
+            return false;
+        }
+        let current = root;
+        for (let i = 0; i < propertyPath.length - 1; i++) {
+            const key = propertyPath[i];
+            if (!current[key] || typeof current[key] !== 'object') {
+                current[key] = {};
+            }
+            current = current[key];
+        }
+        const finalKey = propertyPath[propertyPath.length - 1];
+        current[finalKey] = value;
+        return true;
+    }
+    /**
+     * Gets the current schema definition.
+     *
+     * @returns The schema definition
+     */
+    getSchema() {
+        return this.schema;
+    }
+    /**
+     * Gets a specific definition from the schema by name.
+     *
+     * @param name - The name of the definition
+     * @returns The definition or undefined if not found
+     */
+    getDefinition(name) {
+        if (typeof name !== 'string') {
+            return name;
+        }
+        return this.schema.definitions?.[name];
+    }
+    /**
+     * Sets a definition in the schema.
+     *
+     * @param name - The name of the definition
+     * @param definition - The definition to set
+     */
+    setDefinition(name, definition) {
+        if (!this.schema.definitions) {
+            this.schema.definitions = {};
+        }
+        this.schema.definitions[name] = definition;
+    }
+    /**
+     * Deletes a definition from the schema.
+     *
+     * @param name - The name of the definition to delete
+     */
+    deleteDefinition(name) {
+        if (this.schema.definitions?.[name]) {
+            delete this.schema.definitions[name];
+        }
+    }
+    /**
+     * Gets a root level property by path.
+     *
+     * @param propertyPath - Array of property names forming the path
+     * @returns The property definition or undefined
+     */
+    getRootProperty(propertyPath) {
+        if (!this.schema.properties || !this.isValidPropertyPath(propertyPath)) {
+            return undefined;
+        }
+        return this.navigatePropertyPath(this.schema.properties, propertyPath);
+    }
+    /**
+     * Gets a property in a definition by path.
+     *
+     * @param definition - The definition object
+     * @param propertyPath - Array of property names forming the path
+     * @returns The property definition or undefined
+     */
+    getProperty(definition, propertyPath) {
+        // If no property path is provided, return the entire definition
+        if (!propertyPath) {
+            return definition;
+        }
+        // If property path is invalid, return undefined
+        if (!this.isValidPropertyPath(propertyPath)) {
+            return undefined;
+        }
+        return this.navigatePropertyPath(definition, propertyPath);
+    }
+    /**
+     * Sets a property in a definition using a path.
+     *
+     * @param definition - The definition name (string) or definition object
+     * @param propertyPath - The path to the property (optional)
+     * @param value - The value to set
+     */
+    setProperty(definition, propertyPath, value) {
+        if (typeof definition === 'string') {
+            definition = this.getDefinition(definition);
+        }
+        this.setPropertyPath(definition, propertyPath, value);
+    }
+    /**
+     * Removes a property in a definition using a path.
+     *
+     * @param definition - The definition object
+     * @param value - The value to set
+     */
+    removeProperty(definition, value) {
+        if (!definition) {
+            return;
+        }
+        delete definition[value];
+    }
+    /**
+     * Sets a schema tag on a definition.
+     *
+     * @param definitionName - The name of the definition
+     * @param tag - The schema tag to set
+     * @param value - The value for the tag
+     */
+    setDefinitionTag(definitionName, tag, value) {
+        const definition = this.getDefinition(definitionName);
+        if (definition) {
+            definition[tag] = value;
+        }
+    }
+    /**
+     * Sets a schema tag on a property using a path.
+     *
+     * @param definitionOrString - The definition or name of the definition that should contain the property
+     * @param tagOrProperty - The tag info or property path
+     * @param tag - The tag info (if property path is provided)
+     */
+    setPropertyTag(definitionOrString, tagOrProperty, tag) {
+        const definition = this.getDefinition(definitionOrString);
+        let property = definition;
+        if (tag && tagOrProperty instanceof Array) {
+            // called with propertyPath
+            property = this.getProperty(definition, tagOrProperty);
+        }
+        const tagInfo = tag ? tag : tagOrProperty;
+        if (property && typeof property === 'object') {
+            property[tagInfo.name] = tagInfo.value;
+        }
+    }
+    /**
+     * Hides a property or definition by setting the hidden tag.
+     *
+     * @param definition - The definition or name of the definition that should contain the property
+     * @param propertyPath - The path to the property (optional)
+     */
+    hide(definition, propertyPath) {
+        this.setPropertyTag(definition, propertyPath, { name: ux_specification_types_1.SchemaTag.hidden, value: true });
+    }
+    /**
+     * Creates a reference to a definition.
+     *
+     * @param definitionName - The name of the definition to reference
+     * @returns The $ref string
+     */
+    createDefinitionRef(definitionName) {
+        return `${common_1.DEFINITION_LINK_PREFIX}${definitionName}`;
+    }
+    /**
+     * Sets a property to reference a definition using a path.
+     *
+     * @param definitionOrString - The definition or name of the definition that should contain the property
+     * @param propertyPath - The path to the property
+     * @param targetDefinitionName - The name of the definition to reference
+     */
+    setPropertyRef(definitionOrString, propertyPath, targetDefinitionName) {
+        this.setPropertyTag(definitionOrString, propertyPath, {
+            name: '$ref',
+            value: this.createDefinitionRef(targetDefinitionName)
+        });
+    }
+    /**
+     * Sets a reference for a definition without a path.
+     *
+     * @param definitionOrString - The definition or name of the definition that should contain the property
+     * @param targetDefinitionName - The name of the definition to reference
+     */
+    setDefinitionRef(definitionOrString, targetDefinitionName) {
+        this.setPropertyTag(definitionOrString, {
+            name: '$ref',
+            value: this.createDefinitionRef(targetDefinitionName)
+        });
+    }
+    /**
+     * Adds an enum to a definition property using a path.
+     * If there is only one enum value, adds a 'const' property instead of 'enum'.
+     *
+     * @param definitionName - The name of the definition
+     * @param propertyPath - Array of property names forming the path
+     * @param enumValues - Array of enum values to add
+     */
+    addEnumToSchema(definitionName, propertyPath, enumValues) {
+        const definition = this.getDefinition(definitionName);
+        if (!definition || !this.isValidPropertyPath(propertyPath) || enumValues.length === 0) {
+            return;
+        }
+        // Determine whether to use 'const' (single value) or 'enum' (multiple values)
+        const propertyName = enumValues.length === 1 ? 'const' : 'enum';
+        const propertyValue = enumValues.length === 1 ? enumValues[0] : enumValues;
+        // If the path ends with 'enum', set the value directly at that path
+        // Otherwise, navigate to the property and add enum/const to it
+        if (propertyPath[propertyPath.length - 1] === 'enum') {
+            // Path ends with 'enum', set it directly
+            let current = definition;
+            for (let i = 0; i < propertyPath.length - 1; i++) {
+                const key = propertyPath[i];
+                if (!current[key]) {
+                    current[key] = {};
+                }
+                current = current[key];
+            }
+            current[propertyName] = propertyValue;
+        }
+        else {
+            // Path doesn't end with 'enum', navigate to the property and add enum/const to it
+            let current = definition;
+            for (const key of propertyPath) {
+                if (!current[key]) {
+                    current[key] = {};
+                }
+                current = current[key];
+            }
+            current[propertyName] = propertyValue;
+        }
+    }
+    /**
+     * Clones a definition with a new name.
+     *
+     * @param sourceName - The name of the source definition to clone
+     * @param targetName - The name for the cloned definition
+     * @returns The cloned definition or undefined if source doesn't exist
+     */
+    cloneDefinition(sourceName, targetName) {
+        const source = this.getDefinition(sourceName);
+        if (source) {
+            const clone = structuredClone(source);
+            this.setDefinition(targetName, clone);
+            return clone;
+        }
+        return undefined;
+    }
+    /**
+     * Updates property indices for ordering.
+     *
+     * @param order - Array of property names in the desired order
+     * @param definitionName - Optional definition name (if not provided, updates root schema properties)
+     */
+    updatePropertyIndices(order, definitionName) {
+        const definition = definitionName ? this.getDefinition(definitionName) : this.getSchema();
+        if (!definition?.properties) {
+            return;
+        }
+        order.forEach((propertyName, index) => {
+            const property = definition.properties[propertyName];
+            if (property && typeof property === 'object') {
+                property[ux_specification_types_1.SchemaTag.propertyIndex] = index;
+            }
+        });
+    }
+    /**
+     * Performs cleanup operations on the schema.
+     *
+     * @param definitionsToDelete - Array of definition names to delete
+     */
+    cleanup(definitionsToDelete) {
+        definitionsToDelete.forEach((name) => this.deleteDefinition(name));
+    }
+    /**
+     * Finalizes and returns the schema.
+     * This method can be used as the final step in schema generation.
+     *
+     * @returns The finalized schema definition
+     */
+    finalize() {
+        return this.schema;
+    }
+}
+exports.AppSchema = AppSchema;
+//# sourceMappingURL=AppSchema.js.map

package/dist/specification/src/sync/v4/sync-rules/AppSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AppSchema.js","sourceRoot":"","sources":["../../../../../../src/sync/v4/sync-rules/AppSchema.ts"],"names":[],"mappings":";;;AACA,wEAAwE;AACxE,yCAAsD;AAOtD;;;GAGG;AACH,MAAa,SAAS;IAGlB;;;;OAIG;IACH,YAAY,aAAqB;QAC7B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAe,CAAC;IAC1E,CAAC;IAED;;;;;OAKG;IACK,mBAAmB,CAAC,YAAkC;QAC1D,OAAO,CACH,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC;YAC3B,YAAY,CAAC,MAAM,GAAG,CAAC;YACvB,YAAY,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CACzE,CAAC;IACN,CAAC;IAED;;;;;OAKG;IACK,UAAU,CAAC,GAAW;QAC1B,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,+BAAsB,CAAC,EAAE,CAAC;YACrE,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,MAAM,cAAc,GAAG,GAAG,CAAC,SAAS,CAAC,+BAAsB,CAAC,MAAM,CAAC,CAAC;QACpE,OAAO,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;;;;OASG;IACK,oBAAoB,CACxB,IAAgB,EAChB,YAAsB,EACtB,sBAA+B,KAAK,EACpC,cAAuB,IAAI;QAE3B,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC,EAAE,CAAC;YACnD,OAAO,SAAS,CAAC;QACrB,CAAC;QAED,IAAI,OAAO,GAAG,IAAI,CAAC;QACnB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC3C,MAAM,GAAG,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;YAC5B,MAAM,SAAS,GAAG,CAAC,KAAK,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC;YAEhD,IAAI,OAAO,CAAC,GAAG,CAAC,KAAK,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC;gBACtD,IAAI,mBAAmB,EAAE,CAAC;oBACtB,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;gBACtB,CAAC;qBAAM,CAAC;oBACJ,OAAO,SAAS,CAAC;gBACrB,CAAC;YACL,CAAC;YAED,uDAAuD;YACvD,mEAAmE;YACnE,wCAAwC;YACxC,8EAA8E;YAC9E,6DAA6D;YAC7D,IAAI,CAAC,mBAAmB,IAAI,WAAW,IAAI,CAAC,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,CAAC;gBAC1E,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;gBACvC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC;gBAE1D,IAAI,SAAS,EAAE,CAAC;oBACZ,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;oBACpD,IAAI,QAAQ,EAAE,CAAC;wBACX,kEAAkE;wBAClE,OAAO,GAAG,QAAQ,CAAC;wBACnB,SAAS;oBACb,CAAC;gBACL,CAAC;YACL,CAAC;YAED,IAAI,OAAO,OAAO,CAAC,GAAG,CAAC,KAAK,QAAQ,EAAE,CAAC;gBACnC,OAAO,mBAAmB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAC1D,CAAC;YAED,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;QAC3B,CAAC;QAED,OAAO,OAAO,CAAC;IACnB,CAAC;IAED;;;;;;;OAOG;IACK,eAAe,CACnB,IAAgB,EAChB,YAAkC,EAClC,KAAmC;QAEnC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC,EAAE,CAAC;YACnD,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,IAAI,OAAO,GAAG,IAAI,CAAC;QACnB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YAC/C,MAAM,GAAG,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;YAE5B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,OAAO,OAAO,CAAC,GAAG,CAAC,KAAK,QAAQ,EAAE,CAAC;gBACpD,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;YACtB,CAAC;YAED,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;QAC3B,CAAC;QAED,MAAM,QAAQ,GAAG,YAAY,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QACvD,OAAO,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC;QAC1B,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACH,SAAS;QACL,OAAO,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;IAED;;;;;OAKG;IACH,aAAa,CAAC,IAAyB;QACnC,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC3B,OAAO,IAAI,CAAC;QAChB,CAAC;QACD,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,IAAI,CAA2B,CAAC;IACrE,CAAC;IAED;;;;;OAKG;IACH,aAAa,CAAC,IAAY,EAAE,UAAsB;QAC9C,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;YAC3B,IAAI,CAAC,MAAM,CAAC,WAAW,GAAG,EAAE,CAAC;QACjC,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC;IAC/C,CAAC;IAED;;;;OAIG;IACH,gBAAgB,CAAC,IAAY;QACzB,IAAI,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YAClC,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACzC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,eAAe,CAAC,YAAsB;QAClC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC,EAAE,CAAC;YACrE,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,OAAO,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;;OAMG;IACH,WAAW,CAAC,UAAsB,EAAE,YAAuB;QACvD,gEAAgE;QAChE,IAAI,CAAC,YAAY,EAAE,CAAC;YAChB,OAAO,UAAU,CAAC;QACtB,CAAC;QACD,gDAAgD;QAChD,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC,EAAE,CAAC;YAC1C,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,OAAO,IAAI,CAAC,oBAAoB,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;OAMG;IACH,WAAW,CACP,UAA+B,EAC/B,YAAkC,EAClC,KAAmC;QAEnC,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;YACjC,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAChD,CAAC;QACD,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE,YAAY,EAAE,KAAK,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;OAKG;IACH,cAAc,CAAC,UAAsB,EAAE,KAAa;QAChD,IAAI,CAAC,UAAU,EAAE,CAAC;YACd,OAAO;QACX,CAAC;QACD,OAAO,UAAU,CAAC,KAAK,CAAC,CAAC;IAC7B,CAAC;IAED;;;;;;OAMG;IACH,gBAAgB,CAAC,cAAsB,EAAE,GAAc,EAAE,KAAiB;QACtE,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;QACtD,IAAI,UAAU,EAAE,CAAC;YACb,UAAU,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QAC5B,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,cAAc,CAAC,kBAAuC,EAAE,aAAiC,EAAE,GAAa;QACpG,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,CAAC;QAC1D,IAAI,QAAQ,GAAG,UAAU,CAAC;QAC1B,IAAI,GAAG,IAAI,aAAa,YAAY,KAAK,EAAE,CAAC;YACxC,2BAA2B;YAC3B,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC;QAC3D,CAAC;QACD,MAAM,OAAO,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAE,aAAyB,CAAC;QACvD,IAAI,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAC3C,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC;QAC3C,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,IAAI,CAAC,UAA+B,EAAE,YAAuB;QACzD,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE,YAAY,EAAE,EAAE,IAAI,EAAE,kCAAS,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;OAKG;IACK,mBAAmB,CAAC,cAAsB;QAC9C,OAAO,GAAG,+BAAsB,GAAG,cAAc,EAAE,CAAC;IACxD,CAAC;IAED;;;;;;OAMG;IACH,cAAc,CACV,kBAAuC,EACvC,YAAsB,EACtB,oBAA4B;QAE5B,IAAI,CAAC,cAAc,CAAC,kBAAkB,EAAE,YAAY,EAAE;YAClD,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,IAAI,CAAC,mBAAmB,CAAC,oBAAoB,CAAC;SACxD,CAAC,CAAC;IACP,CAAC;IAED;;;;;OAKG;IACH,gBAAgB,CAAC,kBAAuC,EAAE,oBAA4B;QAClF,IAAI,CAAC,cAAc,CAAC,kBAAkB,EAAE;YACpC,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,IAAI,CAAC,mBAAmB,CAAC,oBAAoB,CAAC;SACxD,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;OAOG;IACH,eAAe,CAAC,cAAsB,EAAE,YAAsB,EAAE,UAAoB;QAChF,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;QACtD,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACpF,OAAO;QACX,CAAC;QAED,8EAA8E;QAC9E,MAAM,YAAY,GAAG,UAAU,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;QAChE,MAAM,aAAa,GAAQ,UAAU,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC;QAEhF,oEAAoE;QACpE,+DAA+D;QAC/D,IAAI,YAAY,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,MAAM,EAAE,CAAC;YACnD,yCAAyC;YACzC,IAAI,OAAO,GAAQ,UAAU,CAAC;YAC9B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC/C,MAAM,GAAG,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;gBAC5B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;oBAChB,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;gBACtB,CAAC;gBACD,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;YAC3B,CAAC;YACD,OAAO,CAAC,YAAY,CAAC,GAAG,aAAa,CAAC;QAC1C,CAAC;aAAM,CAAC;YACJ,kFAAkF;YAClF,IAAI,OAAO,GAAQ,UAAU,CAAC;YAC9B,KAAK,MAAM,GAAG,IAAI,YAAY,EAAE,CAAC;gBAC7B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;oBAChB,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;gBACtB,CAAC;gBACD,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;YAC3B,CAAC;YACD,OAAO,CAAC,YAAY,CAAC,GAAG,aAAa,CAAC;QAC1C,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,eAAe,CAAC,UAAkB,EAAE,UAAkB;QAClD,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAC9C,IAAI,MAAM,EAAE,CAAC;YACT,MAAM,KAAK,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;YACtC,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;YACtC,OAAO,KAAK,CAAC;QACjB,CAAC;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;IAED;;;;;OAKG;IACH,qBAAqB,CAAC,KAAe,EAAE,cAAuB;QAC1D,MAAM,UAAU,GAAG,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;QAC1F,IAAI,CAAC,UAAU,EAAE,UAAU,EAAE,CAAC;YAC1B,OAAO;QACX,CAAC;QAED,KAAK,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,KAAK,EAAE,EAAE;YAClC,MAAM,QAAQ,GAAG,UAAU,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;YACrD,IAAI,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBAC3C,QAAQ,CAAC,kCAAS,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC;YAC9C,CAAC;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,mBAA6B;QACjC,mBAAmB,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC;IACvE,CAAC;IAED;;;;;OAKG;IACH,QAAQ;QACJ,OAAO,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;CACJ;AA5aD,8BA4aC"}

package/dist/specification/src/sync/v4/sync-rules/DecoratorClass.d.ts

@@ -0,0 +1,172 @@
+import type { Definition } from 'typescript-json-schema';
+export interface Base {
+    name: string;
+    definition: Definition;
+}
+export declare class BaseClass {
+    private appSchema;
+    private base;
+    /**
+     * Creates an instance of BaseClass.
+     *
+     * @param appSchema - The application schema definition
+     */
+    constructor(appSchema?: Definition);
+    /**
+     * Gets the class name.
+     *
+     * @returns The name of the class
+     */
+    getClassName(): string;
+    /**
+     * Gets the base name.
+     *
+     * @returns The base name
+     */
+    getBaseName(): string;
+    /**
+     * Gets the base definition.
+     *
+     * @returns The base definition
+     */
+    getBase(): Definition;
+    /**
+     * Sets the base definition and name.
+     *
+     * @param base - The base object containing name and definition
+     */
+    setBase(base: Base): void;
+    /**
+     * Gets the definitions from the app schema.
+     *
+     * @returns The definitions object or undefined
+     */
+    getDefinitions(): Definition | undefined;
+    /**
+     * Creates an annotation path for schema based on entity type, term, and qualifier.
+     *
+     * @param entityTypeName - Entity type name.
+     * @param term - Annotation term.
+     * @param qualifier - Annotation qualifier (optional).
+     * @returns Annotation path based on received params
+     */
+    createAnnotationPath(entityTypeName: string, term: string, qualifier?: string): string | undefined;
+}
+export declare class Decorator extends BaseClass {
+    /**
+     * Reference to the parent decorator instance.
+     * Used by @dependsOn decorator to support parent property access via '../' syntax.
+     */
+    private __parent__?;
+    /**
+     * Sets the parent decorator instance for this object.
+     * This enables nested decorators to access parent properties using the '../' prefix in @dependsOn.
+     *
+     * @param parent - The parent Decorator instance
+     * @returns this (for method chaining)
+     */
+    setParent(parent: Decorator): this;
+    /**
+     * Gets the parent decorator instance if it exists.
+     *
+     * @returns The parent Decorator instance or undefined
+     */
+    getParent(): Decorator | undefined;
+    /**
+     * Helper method to get property value from an object using a property path.
+     * Supports simple property names (e.g., 'visualFilters'), nested paths (e.g., 'settings.enabled'),
+     * and parent traversal (e.g., '../type' to access parent object's type property).
+     *
+     * @param syncInstance - The object instance to retrieve the property value from
+     * @param propertyPath - The property path (e.g., 'visualFilters', 'settings.enabled', or '../type')
+     * @returns Object containing the final key and its value, or undefined if not found
+     */
+    private getPropertyKeyValue;
+    /**
+     * Evaluates a single dependency condition.
+     *
+     * @param condition - The single condition to evaluate
+     * @param condition.path - The property path to check
+     * @param condition.dependsOn - Optional custom condition function
+     * @param condition.expectedValue - Optional expected value for equality check
+     * @param syncRuleProviderInstance - The sync rule provider instance
+     * @returns Object containing whether condition passed and the dependency value
+     */
+    private evaluateSingleCondition;
+    /**
+     * Helper method to add a message to the schema property based on value condition.
+     *
+     * @param condition - EnumValueCondition object containing condition details
+     * @param syncRuleProviderInstance - The instance of the sync rule provider
+     * @param definition - The schema property definition
+     * @param i18nProperties - i18n properties for message translation
+     * @param i18nProperties.propertyName - The property name for the message
+     * @param i18nProperties.context - The context for the message
+     */
+    private addConditionalMessage;
+    /**
+     * Gets the context message from evaluation results.
+     *
+     * @param results - The evaluation results
+     * @returns The context message string
+     */
+    private getContextForMessage;
+    /**
+     * Applies the dependsOn decorator to the schema definition.
+     *
+     * @param schemaDefinition - The schema definition to apply the decorator to
+     * @param syncRuleProviderInstance - The sync rule provider instance
+     */
+    private applyDependsOnDecorator;
+    /**
+     * Gets the validity metadata for a property.
+     *
+     * @param target - The target object
+     * @param propertyName - The property name
+     * @returns The validity metadata or undefined
+     */
+    private getValidityMetadata;
+    /**
+     * Applies the validity decorator to the schema definition based on the sync rule provider instance and minimum UI5 version.
+     *
+     * @param schemaDefinition The schema definition to apply the validity decorator to
+     * @param syncRuleProviderInstance The instance of the sync rule provider
+     * @param minUI5Version The minimum UI5 version to consider for validity checks
+     */
+    private applyValidityDecorator;
+    /**
+     * Applies the isViewNode decorator to the schema definition based on the target and property name.
+     *
+     * @param schemaDefinition The schema definition to apply the isViewNode decorator to
+     * @param target The target object or function
+     * @param propertyName The property name (optional)
+     */
+    private applyIsViewNodeDecorator;
+    /**
+     * Applies the description decorator to the schema definition.
+     *
+     * @param schemaDefinition - The schema definition to apply the decorator to
+     * @param target - The target object or function
+     * @param propertyName - The property name (optional)
+     */
+    private applyDescriptionDecorator;
+    /**
+     * Applies the hidden decorator to the schema definition.
+     *
+     * @param schemaDefinition - The schema definition to apply the decorator to
+     * @param target - The target object or function
+     * @param propertyName - The property name (optional)
+     */
+    private applyHiddenDecorator;
+    /**
+     * Applies all decorators to the schema definition.
+     *
+     * @param minUi5Version - The minimum UI5 version (optional)
+     * @param propertyName - The property name (optional)
+     * @returns Object containing the definition
+     */
+    applyDecorators(minUi5Version?: string, propertyName?: string): {
+        definition: Definition;
+    };
+}
+//# sourceMappingURL=DecoratorClass.d.ts.map

package/dist/specification/src/sync/v4/sync-rules/DecoratorClass.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DecoratorClass.d.ts","sourceRoot":"","sources":["../../../../../../src/sync/v4/sync-rules/DecoratorClass.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAgCzD,MAAM,WAAW,IAAI;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,UAAU,CAAC;CAC1B;AAQD,qBAAa,SAAS;IAClB,OAAO,CAAC,SAAS,CAAa;IAC9B,OAAO,CAAC,IAAI,CAAO;IAEnB;;;;OAIG;gBACS,SAAS,CAAC,EAAE,UAAU;IAqBlC;;;;OAIG;IACH,YAAY,IAAI,MAAM;IAItB;;;;OAIG;IACH,WAAW,IAAI,MAAM;IAIrB;;;;OAIG;IACH,OAAO,IAAI,UAAU;IAIrB;;;;OAIG;IACH,OAAO,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;IAIzB;;;;OAIG;IACH,cAAc,IAAI,UAAU,GAAG,SAAS;IAIxC;;;;;;;OAOG;IACH,oBAAoB,CAAC,cAAc,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;CAWrG;AAED,qBAAa,SAAU,SAAQ,SAAS;IACpC;;;OAGG;IACH,OAAO,CAAC,UAAU,CAAC,CAAY;IAE/B;;;;;;OAMG;IACH,SAAS,CAAC,MAAM,EAAE,SAAS,GAAG,IAAI;IAKlC;;;;OAIG;IACH,SAAS,IAAI,SAAS,GAAG,SAAS;IAIlC;;;;;;;;OAQG;IACH,OAAO,CAAC,mBAAmB;IA4B3B;;;;;;;;;OASG;IACH,OAAO,CAAC,uBAAuB;IAsB/B;;;;;;;;;OASG;IACH,OAAO,CAAC,qBAAqB;IAa7B;;;;;OAKG;IACH,OAAO,CAAC,oBAAoB;IAO5B;;;;;OAKG;IACH,OAAO,CAAC,uBAAuB;IA6C/B;;;;;;OAMG;IACH,OAAO,CAAC,mBAAmB;IAQ3B;;;;;;OAMG;IACH,OAAO,CAAC,sBAAsB;IA2D9B;;;;;;OAMG;IACH,OAAO,CAAC,wBAAwB;IAYhC;;;;;;OAMG;IACH,OAAO,CAAC,yBAAyB;IAWjC;;;;;;OAMG;IACH,OAAO,CAAC,oBAAoB;IAkB5B;;;;;;OAMG;IACH,eAAe,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG;QAAE,UAAU,EAAE,UAAU,CAAA;KAAE;CAwB7F"}