@sapui5/sap.fe.core 1.102.2 → 1.104.1

package/src/sap/fe/core/templating/PropertyHelper.ts

@@ -1,11 +1,10 @@
-import { Property } from "@sap-ux/annotation-converter";
-import { PathAnnotationExpression } from "@sap-ux/vocabularies-types";
+import type { PathAnnotationExpression, Property } from "@sap-ux/vocabularies-types";
 
 /**
  * Identify if the given property passed is a "Property" (has a _type).
  *
- * @param {Property} property A target property to evaluate
- * @returns {boolean} Validate that property is a Property
+ * @param property A target property to evaluate
+ * @returns Validate that property is a Property
  */
 export function isProperty(property: any): property is Property {
 	return property && (property as Property).hasOwnProperty("_type") && (property as Property)._type === "Property";
@@ -14,8 +13,8 @@ export function isProperty(property: any): property is Property {
 /**
  * Check whether the property has the Core.Computed annotation or not.
  *
- * @param {Property} oProperty The target property
- * @returns {boolean} `true` if the property is computed
+ * @param oProperty The target property
+ * @returns `true` if the property is computed
  */
 export const isComputed = function (oProperty: Property): boolean {
 	return !!oProperty.annotations?.Core?.Computed?.valueOf();
@@ -24,8 +23,8 @@ export const isComputed = function (oProperty: Property): boolean {
 /**
  * Check whether the property has the Core.Immutable annotation or not.
  *
- * @param {Property} oProperty The target property
- * @returns {boolean} `true` if it's immutable
+ * @param oProperty The target property
+ * @returns `true` if it's immutable
  */
 export const isImmutable = function (oProperty: Property): boolean {
 	return !!oProperty.annotations?.Core?.Immutable?.valueOf();
@@ -34,8 +33,8 @@ export const isImmutable = function (oProperty: Property): boolean {
 /**
  * Check whether the property is a key or not.
  *
- * @param {Property} oProperty The target property
- * @returns {boolean} `true` if it's a key
+ * @param oProperty The target property
+ * @returns `true` if it's a key
  */
 export const isKey = function (oProperty: Property): boolean {
 	return !!oProperty.isKey;
@@ -64,8 +63,8 @@ export const getLabel = function (oProperty: Property): string {
 /**
  * Check whether the property has a semantic object defined or not.
  *
- * @param {Property} oProperty The target property
- * @returns {boolean} `true` if it has a semantic object
+ * @param oProperty The target property
+ * @returns `true` if it has a semantic object
  */
 export const hasSemanticObject = function (oProperty: Property): boolean {
 	return !!oProperty.annotations?.Common?.SemanticObject;
@@ -84,8 +83,8 @@ export const isAnnotationPathExpression = function <T>(expression: any): express
 /**
  * Retrieves the timezone property associated to the property, if applicable.
  *
- * @param {Property} oProperty The target property
- * @returns {Property | undefined} The timezone property, if it exists
+ * @param oProperty The target property
+ * @returns The timezone property, if it exists
  */
 export const getAssociatedTimezoneProperty = function (oProperty: Property): Property | undefined {
 	return isPathExpression(oProperty?.annotations?.Common?.Timezone)
@@ -96,8 +95,8 @@ export const getAssociatedTimezoneProperty = function (oProperty: Property): Pro
 /**
  * Retrieves the unit property associated to the property, if applicable.
  *
- * @param {Property} oProperty The target property
- * @returns {Property | undefined} The unit property, if it exists
+ * @param oProperty The target property
+ * @returns The unit property, if it exists
  */
 export const getAssociatedUnitProperty = function (oProperty: Property): Property | undefined {
 	return isPathExpression(oProperty?.annotations?.Measures?.Unit)
@@ -112,8 +111,8 @@ export const getAssociatedUnitPropertyPath = function (oProperty: Property): str
 /**
  * Retrieves the associated currency property for that property if it exists.
  *
- * @param {Property} oProperty The target property
- * @returns {Property | undefined} The unit property, if it exists
+ * @param oProperty The target property
+ * @returns The unit property, if it exists
  */
 export const getAssociatedCurrencyProperty = function (oProperty: Property): Property | undefined {
 	return isPathExpression(oProperty?.annotations?.Measures?.ISOCurrency)
@@ -128,8 +127,8 @@ export const getAssociatedCurrencyPropertyPath = function (oProperty: Property):
 /**
  * Retrieves the Common.Text property path if it exists.
  *
- * @param {Property} oProperty The target property
- * @returns {string | undefined} The Common.Text property path or undefined if it does not exist
+ * @param oProperty The target property
+ * @returns The Common.Text property path or undefined if it does not exist
  */
 export const getAssociatedTextPropertyPath = function (oProperty: Property): string | undefined {
 	return isPathExpression(oProperty.annotations?.Common?.Text) ? oProperty.annotations?.Common?.Text.path : undefined;
@@ -150,8 +149,8 @@ export const getTargetValueOnDataPoint = function (oProperty: any): string | und
 /**
  * Check whether the property has a value help annotation defined or not.
  *
- * @param {Property} oProperty The target property
- * @returns {boolean} `true` if it has a value help
+ * @param oProperty The target property
+ * @returns `true` if it has a value help
  */
 export const hasValueHelp = function (oProperty: Property): boolean {
 	return (
@@ -165,8 +164,8 @@ export const hasValueHelp = function (oProperty: Property): boolean {
 /**
  * Check whether the property has a value help with fixed value annotation defined or not.
  *
- * @param {Property} oProperty The target property
- * @returns {boolean} `true` if it has a value help
+ * @param oProperty The target property
+ * @returns `true` if it has a value help
  */
 export const hasValueHelpWithFixedValues = function (oProperty: Property): boolean {
 	return !!oProperty?.annotations?.Common?.ValueListWithFixedValues?.valueOf();
@@ -175,8 +174,8 @@ export const hasValueHelpWithFixedValues = function (oProperty: Property): boole
 /**
  * Check whether the property has a value help for validation annotation defined or not.
  *
- * @param {Property} oProperty The target property
- * @returns {boolean} `true` if it has a value help
+ * @param oProperty The target property
+ * @returns `true` if it has a value help
  */
 export const hasValueListForValidation = function (oProperty: Property): boolean {
 	return oProperty.annotations?.Common?.ValueListForValidation !== undefined;