@sap/ux-specification 1.144.0 → 1.144.2

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

@@ -1,303 +1,2 @@
-import type { Definition } from 'typescript-json-schema';
-import type { ExtensionLogger } from '@sap/ux-specification-types';
-import type { App } from './App';
-import type { Page } from './Page';
-import type { AppSchema } from './AppSchema';
-export type GeneralSettings<PageWithConfig extends Page = Page> = {
-    appSchema: AppSchema;
-    app: App;
-    page: PageWithConfig;
-    logger?: ExtensionLogger;
-};
-export declare class BaseConstruct {
-    protected readonly appSchema: AppSchema;
-    protected readonly app: App;
-    protected readonly page: Page;
-    protected readonly logger?: ExtensionLogger;
-    /**
-     * Constructor for BaseConstruct.
-     *
-     * @param settings - General settings including appSchema, app, page, and logger
-     */
-    constructor(settings?: GeneralSettings);
-    /**
-     * Gets the general settings.
-     *
-     * @returns The general settings object
-     */
-    getSettings(): GeneralSettings;
-}
-export interface Base {
-    name: string;
-    definition: Definition;
-}
-export declare class BaseClass extends BaseConstruct {
-    private readonly base;
-    /**
-     * Creates an instance of BaseClass.
-     *
-     * @param settings - General settings including appSchema, app, page, and logger
-     */
-    constructor(settings?: GeneralSettings);
-    /**
-     * 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;
-    /**
-     * 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 {
-    /**
-     * Context for decorator condition evaluation.
-     * Contains 'config' (auto-injected from page.config) and any custom context sources.
-     * Defined as non-enumerable to hide from serialization.
-     */
-    private decoratorContext;
-    /**
-     * Creates an instance of Decorator.
-     *
-     * @param settings - General settings including appSchema, app, page, and logger
-     */
-    constructor(settings?: GeneralSettings);
-    /**
-     * Initializes the decorator by applying all decorators to the schema definition.
-     *
-     * The decorator context is structured as:
-     * - `app`: The App configuration (from `this.app.config`, includes manifest)
-     * - `page`: The Page configuration (from `this.page.config`)
-     * - `custom`: Custom context provided by the caller.
-     *
-     * @param customContext - Optional custom context for decorator conditions.
-     *   Use this for runtime-specific conditions like table state, section state, etc.
-     * @param definition - Optional custom definition to apply decorators to.
-     *   If provided, decorators are applied to this definition instead of the one from appSchema.
-     * @example
-     * ```typescript
-     * // Basic initialization (app and page auto-injected)
-     * decorator.init();
-     *
-     * // With custom context for table-specific conditions
-     * decorator.init({
-     *     table: { type: 'GridTable', views: [] }
-     * });
-     *
-     * // With custom definition (for dynamically created definitions)
-     * decorator.init({ table: { type: 'GridTable' } }, customTableDefinition);
-     * ```
-     */
-    init(customContext?: Record<string, unknown>, definition?: Definition): void;
-    /**
-     * Gets property value from the decorator context using a property path.
-     *
-     * The path must include an explicit source prefix ('app', 'page', or 'custom').
-     *
-     * @param propertyPath - The property path with explicit source prefix - supports full jsonpath syntax
-     * @returns Object containing the final key and its value, or undefined if not found
-     * @example
-     * ```typescript
-     * // With decoratorContext = {
-     * //   app: { manifest: { 'sap.ui5': { routing: {...} } } },
-     * //   page: { isALP: true },
-     * //   custom: { type: 'GridTable', items: [{ name: 'Item1' }, { name: 'Item2' }] }
-     * // }
-     * getPropertyKeyValue('page.isALP')                    // { key: 'isALP', value: true }
-     * getPropertyKeyValue('custom.items[0]')               // { key: '0', value: { name: 'Item1' } }
-     * getPropertyKeyValue('custom.items[1].name')          // { key: 'name', value: 'Item2' }
-     * getPropertyKeyValue('app.manifest["sap.ui5"]')       // Access property with dot in name
-     * getPropertyKeyValue('$.app.manifest["sap.ui5"].routing') // JSONPath with root reference
-     * getPropertyKeyValue('$app["manifest"]["sap.ui5"]')   // Alternative JSONPath format
-     * ```
-     */
-    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 condition.negate - Optional flag to invert the condition result
-     * @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 - DecoratorMetadata or 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;
-    /**
-     * Resolves PathNode values in message params to their actual values from the decorator context.
-     *
-     * @param params - The message params potentially containing PathNode values
-     * @returns The params with PathNode values resolved to actual values
-     */
-    private resolveMessageParams;
-    /**
-     * Gets the context message from evaluation results.
-     *
-     * @param results - The evaluation results
-     * @returns The context message string
-     */
-    private getContextForMessage;
-    /**
-     * Evaluates an AND condition item which can be either a single condition or a nested OR group.
-     *
-     * @param conditionItem - The condition item to evaluate
-     * @returns Object containing whether condition passed and evaluation details
-     */
-    private evaluateAndConditionItem;
-    /**
-     * Evaluates OR conditions (at least one condition must match).
-     * Supports both single conditions and nested AND groups.
-     *
-     * @param orConditions - Array of condition items (single conditions or AND groups)
-     * @returns Object containing whether any condition passed and evaluation details
-     */
-    private evaluateOrConditions;
-    /**
-     * Evaluates AND conditions (all conditions must match).
-     * Supports both single conditions and nested OR groups.
-     *
-     * @param andConditions - Array of condition items (single conditions or OR groups)
-     * @returns Object containing whether all conditions passed and evaluation details
-     */
-    private evaluateAndConditions;
-    /**
-     * Evaluates condition metadata and returns whether the condition is met and the context.
-     *
-     * @param conditionInfo - The condition metadata
-     * @returns Object with passed (boolean) and context (string)
-     */
-    private evaluateCondition;
-    /**
-     * Iterates over schema properties and yields property info for decorator processing.
-     * Centralizes the guard clause and property iteration logic.
-     *
-     * @param schemaDefinition - The schema definition to process
-     * @param target - The target object (used for guard clause validation)
-     * @yields Property name and definition for each property in the schema
-     */
-    private iterateProperties;
-    /**
-     * Applies the hide decorator to the schema definition.
-     * Hides properties when their condition evaluates to true, but only if
-     * the message decorator did not add any messages to the property.
-     *
-     * @param schemaDefinition - The schema definition to apply the decorator to
-     * @param syncRuleProviderInstance - The sync rule provider instance
-     */
-    private applyHideDecorator;
-    /**
-     * Applies the message decorator to the schema definition.
-     * Shows messages when their condition evaluates to true.
-     *
-     * @param schemaDefinition - The schema definition to apply the decorator to
-     * @param syncRuleProviderInstance - The sync rule provider instance
-     */
-    private applyMessageDecorator;
-    /**
-     * Applies the readonly decorator to the schema definition.
-     * Marks properties as readonly when their condition evaluates to true.
-     *
-     * @param schemaDefinition - The schema definition to apply the decorator to
-     * @param syncRuleProviderInstance - The sync rule provider instance
-     */
-    private applyReadonlyDecorator;
-    /**
-     * Applies the enums decorator to the schema definition.
-     * Restricts enum values when their condition evaluates to true.
-     * If multiple @enums decorators exist on the same property, the first matching condition wins.
-     *
-     * @param schemaDefinition - The schema definition to apply the decorator to
-     * @param syncRuleProviderInstance - The sync rule provider instance
-     */
-    private applyEnumsDecorator;
-    /**
-     * 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;
-    /**
-     * Resolves an enum array from a property definition.
-     * Handles both inline enums and $ref to enum definitions.
-     *
-     * @param property - The property definition
-     * @returns The enum array or undefined if not found
-     */
-    private resolveEnumFromProperty;
-    /**
-     * Applies filtered enum values to a property.
-     * For $ref properties, inlines the filtered enum, copies the type from the referenced definition, and removes the $ref.
-     * For inline enum properties, updates the enum directly.
-     *
-     * @param property - The property definition to update
-     * @param filteredEnum - The filtered enum values
-     */
-    private applyFilteredEnumToProperty;
-    /**
-     * 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 all decorators to the schema definition.
-     *
-     * @param minUi5Version - The minimum UI5 version (optional)
-     * @param propertyName - The property name (optional)
-     * @param customDefinition - Optional custom definition to apply decorators to (overrides getBase())
-     * @returns Object containing the definition
-     */
-    applyDecorators(minUi5Version?: string, propertyName?: string, customDefinition?: Definition): {
-        definition: Definition;
-    };
-}
+export {};
 //# sourceMappingURL=DecoratorClass.d.ts.map

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

@@ -1 +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;AACzD,OAAO,KAAK,EAGR,eAAe,EAKlB,MAAM,6BAA6B,CAAC;AAmBrC,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AACjC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAqB7C,MAAM,MAAM,eAAe,CAAC,cAAc,SAAS,IAAI,GAAG,IAAI,IAAI;IAC9D,SAAS,EAAE,SAAS,CAAC;IACrB,GAAG,EAAE,GAAG,CAAC;IACT,IAAI,EAAE,cAAc,CAAC;IACrB,MAAM,CAAC,EAAE,eAAe,CAAC;CAC5B,CAAC;AAEF,qBAAa,aAAa;IACtB,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IACxC,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC;IAC5B,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IAC9B,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,eAAe,CAAC;IAE5C;;;;OAIG;gBACS,QAAQ,CAAC,EAAE,eAAe;IA6BtC;;;;OAIG;IACH,WAAW,IAAI,eAAe;CAQjC;AAED,MAAM,WAAW,IAAI;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,UAAU,CAAC;CAC1B;AAQD,qBAAa,SAAU,SAAQ,aAAa;IACxC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAO;IAE5B;;;;OAIG;gBACS,QAAQ,CAAC,EAAE,eAAe;IAYtC;;;;OAIG;IACH,YAAY,IAAI,MAAM;IAItB;;;;OAIG;IACH,WAAW,IAAI,MAAM;IAIrB;;;;OAIG;IACH,OAAO,IAAI,UAAU;IAIrB;;;;;;;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;;;;OAIG;IACH,OAAO,CAAC,gBAAgB,CAAuB;IAE/C;;;;OAIG;gBACS,QAAQ,CAAC,EAAE,eAAe;IAWtC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,IAAI,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,CAAC,EAAE,UAAU;IAWrE;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,OAAO,CAAC,mBAAmB;IAmC3B;;;;;;;;;OASG;IACH,OAAO,CAAC,uBAAuB;IA+B/B;;;;;;;;;OASG;IACH,OAAO,CAAC,qBAAqB;IAmC7B;;;;;OAKG;IACH,OAAO,CAAC,oBAAoB;IAkB5B;;;;;OAKG;IACH,OAAO,CAAC,oBAAoB;IAO5B;;;;;OAKG;IACH,OAAO,CAAC,wBAAwB;IAehC;;;;;;OAMG;IACH,OAAO,CAAC,oBAAoB;IA2C5B;;;;;;OAMG;IACH,OAAO,CAAC,qBAAqB;IAoB7B;;;;;OAKG;IACH,OAAO,CAAC,iBAAiB;IAyBzB;;;;;;;OAOG;IACH,OAAO,CAAE,iBAAiB;IAc1B;;;;;;;OAOG;IACH,OAAO,CAAC,kBAAkB;IAiB1B;;;;;;OAMG;IACH,OAAO,CAAC,qBAAqB;IAkB7B;;;;;;OAMG;IACH,OAAO,CAAC,sBAAsB;IAa9B;;;;;;;OAOG;IACH,OAAO,CAAC,mBAAmB;IAyB3B;;;;;;OAMG;IACH,OAAO,CAAC,mBAAmB;IAQ3B;;;;;;OAMG;IACH,OAAO,CAAC,uBAAuB;IAmB/B;;;;;;;OAOG;IACH,OAAO,CAAC,2BAA2B;IAqBnC;;;;;;OAMG;IACH,OAAO,CAAC,sBAAsB;IAkE9B;;;;;;OAMG;IACH,OAAO,CAAC,wBAAwB;IAYhC;;;;;;OAMG;IACH,OAAO,CAAC,yBAAyB;IAWjC;;;;;;;OAOG;IACH,eAAe,CACX,aAAa,CAAC,EAAE,MAAM,EACtB,YAAY,CAAC,EAAE,MAAM,EACrB,gBAAgB,CAAC,EAAE,UAAU,GAC9B;QAAE,UAAU,EAAE,UAAU,CAAA;KAAE;CAgChC"}
+{"version":3,"file":"DecoratorClass.d.ts","sourceRoot":"","sources":["../../../../../../src/sync/v4/sync-rules/DecoratorClass.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC"}