@sap/ux-specification 1.142.2 → 1.142.3

package/dist/specification/src/sync/common/decoration/decorators.d.ts

@@ -1,12 +1,19 @@
 import 'reflect-metadata';
-import type { SyncRule, PageLayoutInformation, ValidityInformation, SyncRuleProvider, Validity, BooleanCondition, DependsOnCondition, DependsOnMessage, MultiDependsOnCondition } from '@sap/ux-specification-types';
+import type { SyncRule, PageLayoutInformation, ValidityInformation, SyncRuleProvider, Validity, DependsOnCondition } from '@sap/ux-specification-types';
+import { type ConditionInput, type MessageConfig } from './decorator-paths';
+/**
+ * Metadata keys for schema post-processing.
+ * Used by decorators to store metadata that is processed during schema generation.
+ */
 export declare const metadataKeys: {
     description: symbol;
-    hidden: symbol;
     isViewNode: symbol;
     syncRule: symbol;
-    dependsOn: symbol;
     validity: symbol;
+    hide: symbol;
+    message: symbol;
+    readonly: symbol;
+    enums: symbol;
 };
 export declare const syncRule: (propSpec: SyncRule) => any;
 /**
@@ -54,39 +61,158 @@ export declare function isViewNode(target: Function): void;
  */
 export declare function description(text: string): (target: Function) => void;
 /**
- * Decorator to conditionally hide a property in the schema based on a condition function.
- * The condition function is evaluated during schema generation with the appropriate context.
+ * Internal metadata structure stored by decorators.
+ * Extends DependsOnCondition with optional message configuration.
+ */
+export interface DecoratorMetadata extends DependsOnCondition {
+    messageConfig?: MessageConfig;
+}
+/**
+ * Decorator to conditionally hide a property based on conditions.
+ * The property will be hidden if the condition(s) are NOT met (inverted logic).
+ *
+ * @example
+ * ```typescript
+ * import { page, custom, when, and, or } from './decorator-paths';
+ *
+ * // Truthy check - hide if page.isALP is falsy
+ * @hide(page.isALP)
  *
- * @param condition - A function that takes context and returns boolean indicating if property should be hidden
- * @returns PropertyDecorator or ClassDecorator depending on usage
+ * // Equality check - hide if page.type !== 'GridTable'
+ * @hide(when(page.type, 'GridTable'))
+ *
+ * // Custom function - hide if type === 'GridTable'
+ * @hide(when(page.type, (type) => type !== 'GridTable'))
+ *
+ * // Always hide
+ * @hide(true)
+ *
+ * // AND logic - hide if not (isALP AND type === 'GridTable')
+ * @hide(and(page.isALP, when(page.type, 'GridTable')))
+ *
+ * // OR logic - hide if not (actionType === 'Bound' OR actionType === 'Custom')
+ * @hide(or(when(page.actionType, 'Bound'), when(page.actionType, 'Custom')))
+ * ```
+ * @param condition - The condition to evaluate
+ * @returns PropertyDecorator
  */
-export declare function hidden(condition?: BooleanCondition): PropertyDecorator & ClassDecorator;
+export declare function hide(condition: ConditionInput): PropertyDecorator;
 /**
- * Helper function to create a DependsOnMessage object.
+ * Retrieves the hide metadata associated with a specific property of a target object.
+ *
+ * @param target - The object containing the property.
+ * @param propertyName - The name of the property whose hide metadata is to be retrieved.
+ * @returns The hide information of the property, or undefined if no metadata is found.
+ */
+export declare function getHideMetadata(target: object, propertyName: string): DecoratorMetadata | undefined;
+/**
+ * Decorator to conditionally display a message based on conditions.
+ * A message will be shown when the condition(s) are met.
+ * Multiple @message decorators can be applied to the same property - all matching conditions will show their messages.
+ *
+ * @param condition - The condition to evaluate
+ * @param messageConfig - The message configuration (use msg() helper)
+ * @returns PropertyDecorator
+ * @example
+ * ```typescript
+ * import { page, when, msg } from './decorator-paths';
+ *
+ * // Simple message
+ * @message(page.betaFeature, msg('BETA_WARNING'))
+ *
+ * // Message with parameters
+ * @message(when(page.type, 'GridTable'), msg('TABLE_WARNING', { type: 'GridTable' }))
+ *
+ * // Deletable message
+ * @message(page.deprecated, msg('DEPRECATED', { since: '1.96' }, { deletable: true }))
+ *
+ * // With AND/OR conditions
+ * @message(and(page.isALP, when(page.type, 'GridTable')), msg('ALP_GRID_INFO'))
  *
- * @param text - The message text (can be true for default i18n message, a string, or a function)
- * @param deletable - Whether the message can be deleted/dismissed in the UI
- * @returns A DependsOnMessage object
+ * // Multiple messages on same property
+ * @message(when(page.type, 'AnalyticalTable'), msg('ANALYTICAL_WARNING'))
+ * @message(when(page.mode, 'edit'), msg('EDIT_MODE_WARNING'))
+ * ```
  */
-export declare const dependsOnMessage: (text?: DependsOnMessage["text"], deletable?: boolean) => DependsOnMessage;
+export declare function message(condition: ConditionInput, messageConfig: MessageConfig): PropertyDecorator;
 /**
- * Decorator to conditionally show/hide a property based on one or more property values.
- * The decorated property will be hidden if the dependency condition(s) are not met.
+ * Retrieves the message metadata associated with a specific property of a target object.
+ * Returns an array of DecoratorMetadata since multiple @message decorators can be applied.
+ *
+ * @param target - The object containing the property.
+ * @param propertyName - The name of the property whose message metadata is to be retrieved.
+ * @returns An array of message metadata, or undefined if no metadata is found.
+ */
+export declare function getMessageMetadata(target: object, propertyName: string): DecoratorMetadata[] | undefined;
+/**
+ * Decorator to conditionally mark a property as readonly based on conditions.
+ * The property will be readonly when the condition(s) are met.
+ *
+ * @example
+ * ```typescript
+ * import { page, custom, when } from './decorator-paths';
+ *
+ * // Truthy check - readonly if page.isLocked is truthy
+ * @readonly(page.isLocked)
+ *
+ * // Equality check - readonly if mode === 'view'
+ * @readonly(when(page.mode, 'view'))
+ *
+ * // Custom function - readonly if role is 'viewer'
+ * @readonly(when(custom.user.role, (role) => role === 'viewer'))
+ * ```
+ * @param condition - The condition to evaluate
+ * @returns PropertyDecorator
+ */
+export declare function readonly(condition: ConditionInput): PropertyDecorator;
+/**
+ * Retrieves the readonly metadata associated with a specific property of a target object.
+ *
+ * @param target - The object containing the property.
+ * @param propertyName - The name of the property whose readonly metadata is to be retrieved.
+ * @returns The readonly information of the property, or undefined if no metadata is found.
+ */
+export declare function getReadonlyMetadata(target: object, propertyName: string): DecoratorMetadata | undefined;
+/**
+ * Metadata structure for the @enums decorator.
+ * Extends DecoratorMetadata with the list of allowed enum values.
+ */
+export interface EnumsDecoratorMetadata extends DecoratorMetadata {
+    /** The allowed enum values when the condition is met */
+    allowedValues: string[];
+}
+/**
+ * Decorator to conditionally restrict enum values based on conditions.
+ * When the condition is met, only the specified allowedValues will be available.
+ * If multiple @enums decorators exist on the same property, the first matching condition wins.
+ *
+ * @example
+ * ```typescript
+ * import { custom, when } from './decorator-paths';
+ *
+ * // Restrict to specific values when table type is TreeTable
+ * @enums(when(custom.table.type, 'TreeTable'), ['Inline', 'NewPage', 'CreationDialog'])
+ *
+ * // Different values for other table types
+ * @enums(when(custom.table.type, 'ResponsiveTable'), ['Inline', 'InlineCreationRows', 'NewPage', 'CreationDialog', 'External'])
  *
- * @param pathOrConditions - A string property path or an array of condition objects (all must be met)
- * @param conditionOrValueOrMessage - Single condition: condition/expected value/message; Multi-condition: message parameter
- * @param message - Optional message parameter (only for single condition with condition/value)
+ * // Default values when no other condition matches
+ * @enums(true, ['NewPage', 'CreationDialog'])
+ * ```
+ * @param condition - The condition to evaluate
+ * @param allowedValues - Array of allowed enum values when condition is met
  * @returns PropertyDecorator
  */
-export declare function dependsOn(pathOrConditions: string | MultiDependsOnCondition, conditionOrValueOrMessage?: BooleanCondition | any | DependsOnMessage, message?: DependsOnMessage): PropertyDecorator;
+export declare function enums(condition: ConditionInput, allowedValues: string[]): PropertyDecorator;
 /**
- * Retrieves the dependsOn metadata associated with a specific property of a target object.
+ * Retrieves the enums metadata associated with a specific property of a target object.
+ * Returns an array of EnumsDecoratorMetadata since multiple @enums decorators can be applied.
  *
  * @param target - The object containing the property.
- * @param propertyName - The name of the property whose dependsOn metadata is to be retrieved.
- * @returns The dependsOn information of the property, or undefined if no metadata is found.
+ * @param propertyName - The name of the property whose enums metadata is to be retrieved.
+ * @returns An array of enums metadata, or undefined if no metadata is found.
  */
-export declare function getDependsOnMetadata(target: object, propertyName: string): DependsOnCondition | undefined;
+export declare function getEnumsMetadata(target: object, propertyName: string): EnumsDecoratorMetadata[] | undefined;
 /**
  * Generates a deprecation message for a given key, optionally including additional validity information.
  *

package/dist/specification/src/sync/common/decoration/decorators.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"decorators.d.ts","sourceRoot":"","sources":["../../../../../../src/sync/common/decoration/decorators.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EACR,QAAQ,EACR,qBAAqB,EACrB,mBAAmB,EACnB,gBAAgB,EAChB,QAAQ,EACR,gBAAgB,EAChB,kBAAkB,EAClB,gBAAgB,EAChB,uBAAuB,EAC1B,MAAM,6BAA6B,CAAC;AAGrC,eAAO,MAAM,YAAY;;;;;;;CAOxB,CAAC;AAEF,eAAO,MAAM,QAAQ,GAAI,UAAU,QAAQ,KAAG,GAE7C,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,CAM7F;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,gBAAgB,GAAG,QAAQ,GAAG,SAAS,CAMlF;AAED,eAAO,MAAM,qBAAqB,GAC7B,UAAU,qBAAqB,MAC/B,aAAa,QAAQ,KAAG,IAExB,CAAC;AAGN,eAAO,MAAM,OAAO,GAAI,IAAI,MAAM,KAAG,GAEpC,CAAC;AAEF,eAAO,MAAM,UAAU,GAAI,QAAQ,GAAG,EAAE,cAAc,MAAM,KAAG,MAE9D,CAAC;AAEF,eAAO,MAAM,wBAAwB,GAAI,QAAQ,GAAG,KAAG,qBAEtD,CAAC;AAKF,eAAO,MAAM,yBAAyB,eAA8B,CAAC;AACrE,eAAO,MAAM,iBAAiB,GAAI,IAAI,MAAM,KAAG,GAE9C,CAAC;AACF,eAAO,MAAM,oBAAoB,GAAI,QAAQ,GAAG,EAAE,cAAc,MAAM,KAAG,MAExE,CAAC;AAMF,eAAO,MAAM,QAAQ,GAAI,UAAU,QAAQ,KAAG,GAE7C,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,mBAAmB,GAAG,SAAS,CAMzG;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,QAAQ,GAAG,IAAI,CAEjD;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,QAAQ,KAAK,IAAI,CAIpE;AAED;;;;;;GAMG;AACH,wBAAgB,MAAM,CAAC,SAAS,CAAC,EAAE,gBAAgB,GAAG,iBAAiB,GAAG,cAAc,CAUvF;AAED;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,GAAI,OAAM,gBAAgB,CAAC,MAAM,CAAQ,EAAE,mBAAgB,KAAG,gBAGzF,CAAC;AAEH;;;;;;;;GAQG;AACH,wBAAgB,SAAS,CACrB,gBAAgB,EAAE,MAAM,GAAG,uBAAuB,EAClD,yBAAyB,CAAC,EAAE,gBAAgB,GAAG,GAAG,GAAG,gBAAgB,EACrE,OAAO,CAAC,EAAE,gBAAgB,GAC3B,iBAAiB,CA6BnB;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,kBAAkB,GAAG,SAAS,CAMzG;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,EAAE,mBAAmB,CAAC,EAAE,mBAAmB,GAAG,MAAM,CAQnG"}
+{"version":3,"file":"decorators.d.ts","sourceRoot":"","sources":["../../../../../../src/sync/common/decoration/decorators.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EACR,QAAQ,EACR,qBAAqB,EACrB,mBAAmB,EACnB,gBAAgB,EAChB,QAAQ,EACR,kBAAkB,EAIrB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAQH,KAAK,cAAc,EAEnB,KAAK,aAAa,EAErB,MAAM,mBAAmB,CAAC;AAM3B;;;GAGG;AACH,eAAO,MAAM,YAAY;;;;;;;;;CASxB,CAAC;AAMF,eAAO,MAAM,QAAQ,GAAI,UAAU,QAAQ,KAAG,GAE7C,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,CAM7F;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,gBAAgB,GAAG,QAAQ,GAAG,SAAS,CAMlF;AAMD,eAAO,MAAM,qBAAqB,GAC7B,UAAU,qBAAqB,MAC/B,aAAa,QAAQ,KAAG,IAExB,CAAC;AAGN,eAAO,MAAM,OAAO,GAAI,IAAI,MAAM,KAAG,GAEpC,CAAC;AAEF,eAAO,MAAM,UAAU,GAAI,QAAQ,GAAG,EAAE,cAAc,MAAM,KAAG,MAE9D,CAAC;AAEF,eAAO,MAAM,wBAAwB,GAAI,QAAQ,GAAG,KAAG,qBAEtD,CAAC;AAMF,eAAO,MAAM,yBAAyB,eAA8B,CAAC;AACrE,eAAO,MAAM,iBAAiB,GAAI,IAAI,MAAM,KAAG,GAE9C,CAAC;AACF,eAAO,MAAM,oBAAoB,GAAI,QAAQ,GAAG,EAAE,cAAc,MAAM,KAAG,MAExE,CAAC;AAMF,eAAO,MAAM,QAAQ,GAAI,UAAU,QAAQ,KAAG,GAE7C,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,mBAAmB,GAAG,SAAS,CAMzG;AAMD;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,QAAQ,GAAG,IAAI,CAEjD;AAMD;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,QAAQ,KAAK,IAAI,CAIpE;AA2KD;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,kBAAkB;IACzD,aAAa,CAAC,EAAE,aAAa,CAAC;CACjC;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAgB,IAAI,CAAC,SAAS,EAAE,cAAc,GAAG,iBAAiB,CAKjE;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,iBAAiB,GAAG,SAAS,CAMnG;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAgB,OAAO,CAAC,SAAS,EAAE,cAAc,EAAE,aAAa,EAAE,aAAa,GAAG,iBAAiB,CAUlG;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,iBAAiB,EAAE,GAAG,SAAS,CAKxG;AAMD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,QAAQ,CAAC,SAAS,EAAE,cAAc,GAAG,iBAAiB,CAKrE;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,iBAAiB,GAAG,SAAS,CAMvG;AAMD;;;GAGG;AACH,MAAM,WAAW,sBAAuB,SAAQ,iBAAiB;IAC7D,wDAAwD;IACxD,aAAa,EAAE,MAAM,EAAE,CAAC;CAC3B;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,KAAK,CAAC,SAAS,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,iBAAiB,CAY3F;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,sBAAsB,EAAE,GAAG,SAAS,CAK3G;AAMD;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,EAAE,mBAAmB,CAAC,EAAE,mBAAmB,GAAG,MAAM,CAQnG"}