@sap/ux-ui5-tooling 1.24.0 → 1.25.0

package/dist/preview-middleware/dist/client/cpe/control-data.js

@@ -169,14 +169,188 @@ sap.ui.define(["open/ux/preview/client/thirdparty/@sap-ux-private/control-proper
       return rawValue;
     }
   }
+  /**
+   * Build the documentation object for a configuration (manifest) property.
+   *
+   * @param property - manifest property
+   * @returns PropertyDocumentation
+   */
+  function buildConfigPropertyDocumentation(property) {
+    const defValue = ['undefined', 'null'].includes(String(property.defaultValue)) ? '-' : String(property.defaultValue);
+    return {
+      description: property.description,
+      propertyName: property.id,
+      type: property.type,
+      defaultValue: defValue || '-'
+    };
+  }
+
+  /**
+   * Process a manifest configuration property.
+   *
+   * @param property - manifest property
+   * @param control - ui5 control
+   * @returns ProcessedProperty or undefined if the property should be skipped
+   */
+  function processConfigProperty(property, control) {
+    const analyzedType = analyzeManifestProperty(property);
+    if (!analyzedType || property?.restrictedTo?.length && !property?.restrictedTo?.includes(getV4PageType(control))) {
+      return undefined;
+    }
+    return {
+      analyzedType,
+      isEnabled: true,
+      value: property.value,
+      propertyType: PropertyType.Configuration,
+      docu: buildConfigPropertyDocumentation(property)
+    };
+  }
+
+  /**
+   * Process a UI5 control property.
+   *
+   * @param property - control metadata property
+   * @param control - ui5 control
+   * @param hasStableId - whether the control has a stable ID
+   * @param controlProperties - overlay design-time property config
+   * @param controlOverlay - element overlay
+   * @returns ProcessedProperty or undefined if the property should be skipped
+   */
+  function processControlProperty(property, control, hasStableId, controlProperties, controlOverlay) {
+    const analyzedType = analyzePropertyType(property);
+    if (!analyzedType) {
+      return undefined;
+    }
+    const ignore = controlProperties?.[property.name]?.ignore ?? false;
+
+    //updating i18n text for the control if bindingInfo has bindingString
+    const controlNewData = {
+      id: control.getId(),
+      name: property.name,
+      newValue: control.getProperty(property.name)
+    };
+    const bindingInfo = control.getBindingInfo(controlNewData.name);
+    if (bindingInfo?.bindingString !== undefined) {
+      controlNewData.newValue = bindingInfo.bindingString;
+    }
+
+    // A property is enabled if:
+    // 1. The property supports changes
+    // 2. The control has stable ID
+    // 3. It is not configured to be ignored in design time
+    // 4. And control overlay is selectable
+    return {
+      analyzedType,
+      isEnabled: isControlEnabled(analyzedType, hasStableId, ignore, controlOverlay),
+      value: normalizeObjectPropertyValue(controlNewData.newValue),
+      propertyType: PropertyType.ControlProperty
+    };
+  }
+
+  /**
+   * Build a ControlProperty entry from an analyzed property.
+   *
+   * @param property - the raw property (manifest or control metadata)
+   * @param processed - the processed property data
+   * @param selectedControlName - name of the UI5 control class
+   * @returns ControlProperty or undefined if the type is not supported
+   */
+  function buildPropertyEntry(property, processed, selectedControlName) {
+    const {
+      analyzedType,
+      isEnabled,
+      value,
+      propertyType,
+      docu
+    } = processed;
+    const isIcon = testIconPattern(property.name) && selectedControlName !== 'sap.m.Image' && analyzedType.ui5Type === 'sap.ui.core.URI';
+    const ui5Type = analyzedType.ui5Type || undefined;
+    const readableName = convertCamelCaseToPascalCase(property.name);
+    const docuSpread = docu ? {
+      documentation: docu
+    } : {};
+    switch (analyzedType.primitiveType) {
+      case 'enum':
+        {
+          const values = analyzedType.enumValues ?? {};
+          const options = Object.keys(values).map(key => ({
+            key,
+            text: values[key]
+          }));
+          return {
+            type: STRING_VALUE_TYPE,
+            editor: DROPDOWN_EDITOR_TYPE,
+            propertyType,
+            name: property.name,
+            readableName,
+            value: value,
+            isEnabled,
+            ui5Type,
+            options,
+            ...docuSpread
+          };
+        }
+      case 'string':
+        return {
+          type: STRING_VALUE_TYPE,
+          editor: INPUT_EDITOR_TYPE,
+          propertyType,
+          name: property.name,
+          readableName,
+          value: value,
+          isEnabled,
+          isIcon,
+          ui5Type,
+          ...docuSpread
+        };
+      case 'int':
+        return {
+          type: INTEGER_VALUE_TYPE,
+          editor: INPUT_EDITOR_TYPE,
+          propertyType,
+          name: property.name,
+          readableName,
+          value: value,
+          isEnabled,
+          ui5Type,
+          ...docuSpread
+        };
+      case 'float':
+        return {
+          type: FLOAT_VALUE_TYPE,
+          editor: INPUT_EDITOR_TYPE,
+          propertyType,
+          name: property.name,
+          readableName,
+          value: value,
+          isEnabled,
+          ui5Type,
+          ...docuSpread
+        };
+      case 'boolean':
+        return {
+          type: BOOLEAN_VALUE_TYPE,
+          editor: CHECKBOX_EDITOR_TYPE,
+          propertyType,
+          name: property.name,
+          readableName,
+          value: value,
+          isEnabled,
+          ui5Type,
+          ...docuSpread
+        };
+      default:
+        return undefined;
+    }
+  }
+
   /**
    * Build control data.
    *
    * @param control - ui5 control
    * @param changeService - Changeservice for change stack event handling.
    * @param controlOverlay - element overlay
-   * @param includeDocumentation - include documentation flag
-   * @returns Promise<Control>
+   * @returns Control
    */
   function buildControlData(control, changeService, controlOverlay) {
     const controlMetadata = control.getMetadata();
@@ -185,174 +359,25 @@ sap.ui.define(["open/ux/preview/client/thirdparty/@sap-ux-private/control-proper
     const overlayData = controlOverlay?.getDesignTimeMetadata().getData();
     const controlProperties = controlOverlay ? overlayData?.properties : undefined;
     const manifestProperties = getManifestProperties(control, changeService, controlOverlay);
-    // Add the control's properties/manifest properties
     const allProperties = {
       ...controlMetadata.getAllProperties(),
       ...manifestProperties
     };
-    let propertyType;
-    const propertyNames = Object.keys(allProperties);
     const properties = [];
-    for (const propertyName of propertyNames) {
+    for (const propertyName of Object.keys(allProperties)) {
       const property = allProperties[propertyName];
-      let analyzedType;
-      let isEnabled;
-      let value;
-      if (property && 'configuration' in property) {
-        propertyType = PropertyType.Configuration;
-        analyzedType = analyzeManifestProperty(property);
-        if (!analyzedType || property?.restrictedTo?.length && !property?.restrictedTo?.includes(getV4PageType(control))) {
-          continue;
-        }
-        isEnabled = true;
-        value = property.value;
-      } else {
-        propertyType = PropertyType.ControlProperty;
-        // the default behavior is that the property is enabled
-        // meaning it's not ignored during design time
-        analyzedType = analyzePropertyType(property);
-        if (!analyzedType) {
-          continue;
-        }
-        let ignore = false;
-        if (controlProperties?.[property.name]) {
-          // check whether the property should be ignored in design time or not
-          // if it's 'undefined' then it's not considered when building isEnabled because it's 'true'
-          ignore = controlProperties[property.name].ignore;
-        }
-
-        //updating i18n text for the control if bindingInfo has bindingString
-        const controlNewData = {
-          id: control.getId(),
-          name: property.name,
-          newValue: control.getProperty(property.name)
-        };
-        const bindingInfo = control.getBindingInfo(controlNewData.name);
-        if (bindingInfo?.bindingString !== undefined) {
-          controlNewData.newValue = bindingInfo.bindingString;
-        }
-
-        // A property is enabled if:
-        // 1. The property supports changes
-        // 2. The control has stable ID
-        // 3. It is not configured to be ignored in design time
-        // 4. And control overlay is selectable
-        isEnabled = isControlEnabled(analyzedType, hasStableId, ignore, controlOverlay);
-        value = normalizeObjectPropertyValue(controlNewData.newValue);
-      }
-      const isIcon = testIconPattern(property.name) && selectedControlName !== 'sap.m.Image' && analyzedType.ui5Type === 'sap.ui.core.URI';
-      const ui5Type = analyzedType.ui5Type || undefined;
-      const readableName = convertCamelCaseToPascalCase(property.name);
-      let docu;
-      if ('configuration' in property) {
-        const defValue = ['undefined', 'null'].includes(String(property.defaultValue)) ? '-' : String(property.defaultValue);
-        docu = {
-          description: property.description,
-          propertyName: property.id,
-          type: property.type,
-          defaultValue: defValue || '-'
-        };
+      const processed = property && 'configuration' in property ? processConfigProperty(property, control) : processControlProperty(property, control, hasStableId, controlProperties, controlOverlay);
+      if (!processed) {
+        continue;
       }
-      switch (analyzedType.primitiveType) {
-        case 'enum':
-          {
-            const values = analyzedType.enumValues ?? {};
-            const options = Object.keys(values).map(key => ({
-              key,
-              text: values[key]
-            }));
-            properties.push({
-              type: STRING_VALUE_TYPE,
-              editor: DROPDOWN_EDITOR_TYPE,
-              propertyType,
-              name: property.name,
-              readableName,
-              value: value,
-              isEnabled,
-              ui5Type,
-              options,
-              ...(docu && {
-                documentation: docu
-              })
-            });
-            break;
-          }
-        case 'string':
-          {
-            properties.push({
-              type: STRING_VALUE_TYPE,
-              editor: INPUT_EDITOR_TYPE,
-              propertyType,
-              name: property.name,
-              readableName,
-              value: value,
-              isEnabled,
-              isIcon,
-              ui5Type,
-              ...(docu && {
-                documentation: docu
-              })
-            });
-            break;
-          }
-        case 'int':
-          {
-            properties.push({
-              type: INTEGER_VALUE_TYPE,
-              editor: INPUT_EDITOR_TYPE,
-              propertyType,
-              name: property.name,
-              readableName,
-              value: value,
-              isEnabled,
-              ui5Type,
-              ...(docu && {
-                documentation: docu
-              })
-            });
-            break;
-          }
-        case 'float':
-          {
-            properties.push({
-              type: FLOAT_VALUE_TYPE,
-              editor: INPUT_EDITOR_TYPE,
-              propertyType,
-              name: property.name,
-              readableName,
-              value: value,
-              isEnabled,
-              ui5Type,
-              ...(docu && {
-                documentation: docu
-              })
-            });
-            break;
-          }
-        case 'boolean':
-          {
-            properties.push({
-              type: BOOLEAN_VALUE_TYPE,
-              editor: CHECKBOX_EDITOR_TYPE,
-              propertyType,
-              name: property.name,
-              readableName,
-              value: value,
-              isEnabled,
-              ui5Type,
-              ...(docu && {
-                documentation: docu
-              })
-            });
-            break;
-          }
+      const entry = buildPropertyEntry(property, processed, selectedControlName);
+      if (entry) {
+        properties.push(entry);
       }
     }
     return {
       id: control.getId(),
-      //the id of the underlying control/aggregation
       type: selectedControlName,
-      //the name of the ui5 class of the control/aggregation
       properties: [...properties].sort((a, b) => a.name > b.name ? 1 : -1),
       name: selectedControlName
     };