@sap/ux-ui5-tooling 1.24.0 → 1.25.0

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

@@ -200,14 +200,217 @@ interface NewControlData {
     newValue: unknown;
 }
 
+type PropertyDocumentation = {
+    defaultValue: string;
+    description: string;
+    propertyName: string;
+    type?: string;
+    propertyType?: string;
+};
+
+interface ProcessedProperty {
+    analyzedType: AnalyzedType;
+    isEnabled: boolean;
+    value: unknown;
+    propertyType: PropertyType;
+    docu?: PropertyDocumentation;
+}
+
+/**
+ * Build the documentation object for a configuration (manifest) property.
+ *
+ * @param property - manifest property
+ * @returns PropertyDocumentation
+ */
+function buildConfigPropertyDocumentation(property: MergedSetting): PropertyDocumentation {
+    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: MergedSetting, control: ManagedObject): ProcessedProperty | undefined {
+    const analyzedType = analyzeManifestProperty(property);
+    if (
+        !analyzedType ||
+        (property?.restrictedTo?.length &&
+            !property?.restrictedTo?.includes(getV4PageType(control) as TemplateType))
+    ) {
+        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: ManagedObjectMetadataProperties,
+    control: ManagedObject,
+    hasStableId: boolean,
+    controlProperties: Record<string, { ignore: boolean }> | undefined,
+    controlOverlay: ElementOverlay | undefined
+): ProcessedProperty | undefined {
+    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: NewControlData = {
+        id: control.getId(),
+        name: property.name,
+        newValue: control.getProperty(property.name)
+    };
+    const bindingInfo: { bindingString?: string } = control.getBindingInfo(controlNewData.name) as {
+        bindingString?: string;
+    };
+    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: ManagedObjectMetadataProperties | MergedSetting,
+    processed: ProcessedProperty,
+    selectedControlName: string
+): ControlProperty | undefined {
+    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: { key: string; text: string }[] = 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 as string,
+                isEnabled,
+                ui5Type,
+                options,
+                ...docuSpread
+            };
+        }
+        case 'string':
+            return {
+                type: STRING_VALUE_TYPE,
+                editor: INPUT_EDITOR_TYPE,
+                propertyType,
+                name: property.name,
+                readableName,
+                value: value as string,
+                isEnabled,
+                isIcon,
+                ui5Type,
+                ...docuSpread
+            };
+        case 'int':
+            return {
+                type: INTEGER_VALUE_TYPE,
+                editor: INPUT_EDITOR_TYPE,
+                propertyType,
+                name: property.name,
+                readableName,
+                value: value as number,
+                isEnabled,
+                ui5Type,
+                ...docuSpread
+            };
+        case 'float':
+            return {
+                type: FLOAT_VALUE_TYPE,
+                editor: INPUT_EDITOR_TYPE,
+                propertyType,
+                name: property.name,
+                readableName,
+                value: value as number,
+                isEnabled,
+                ui5Type,
+                ...docuSpread
+            };
+        case 'boolean':
+            return {
+                type: BOOLEAN_VALUE_TYPE,
+                editor: CHECKBOX_EDITOR_TYPE,
+                propertyType,
+                name: property.name,
+                readableName,
+                value: value as boolean,
+                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
  */
 export function buildControlData(
     control: ManagedObject,
@@ -218,182 +421,37 @@ export function buildControlData(
     const selectedControlName = controlMetadata.getName();
     const hasStableId = Utils.checkControlId(control);
     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() as unknown as {
             [name: string]: ManagedObjectMetadataProperties;
         }),
         ...manifestProperties
     };
-    let propertyType;
-    const propertyNames = Object.keys(allProperties);
+
     const properties: ControlProperty[] = [];
-    for (const propertyName of propertyNames) {
+    for (const propertyName of Object.keys(allProperties)) {
         const property = allProperties[propertyName];
-        let analyzedType;
-        let isEnabled: boolean;
-        let value: unknown;
-        if (property && 'configuration' in property) {
-            propertyType = PropertyType.Configuration;
-            analyzedType = analyzeManifestProperty(property);
-            if (
-                !analyzedType ||
-                (property?.restrictedTo?.length &&
-                    !property?.restrictedTo?.includes(getV4PageType(control) as TemplateType))
-            ) {
-                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: NewControlData = {
-                id: control.getId(),
-                name: property.name,
-                newValue: control.getProperty(property.name)
-            };
-            const bindingInfo: { bindingString?: string } = control.getBindingInfo(controlNewData.name) as {
-                bindingString?: string;
-            };
-            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);
+        const processed =
+            property && 'configuration' in property
+                ? processConfigProperty(property, control)
+                : processControlProperty(property, control, hasStableId, controlProperties, controlOverlay);
 
-            value = normalizeObjectPropertyValue(controlNewData.newValue);
+        if (!processed) {
+            continue;
         }
-        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:
-            | {
-                  defaultValue: string;
-                  description: string;
-                  propertyName: string;
-                  type?: string;
-                  propertyType?: string;
-              }
-            | undefined;
-        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 || '-'
-            };
-        }
-        switch (analyzedType.primitiveType) {
-            case 'enum': {
-                const values = analyzedType.enumValues ?? {};
-                const options: { key: string; text: string }[] = 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 as string,
-                    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 as string,
-                    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 as number,
-                    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 as number,
-                    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 as boolean,
-                    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
+        id: control.getId(),
+        type: selectedControlName,
         properties: [...properties].sort((a, b) => (a.name > b.name ? 1 : -1)),
         name: selectedControlName
     };

package/dist/preview-middleware/dist/client/flp/init.js

@@ -150,9 +150,9 @@ sap.ui.define(["sap/base/Log", "open/ux/preview/client/thirdparty/@sap-ux-privat
   async function registerComponentDependencyPaths(appUrls, urlParams) {
     const libs = await getManifestLibs(appUrls);
     if (libs && libs.length > 0) {
-      let url = '/sap/bc/ui2/app_index/ui5_app_info?id=' + libs;
+      let url = '/sap/bc/ui2/app_index/ui5_app_info?id=' + encodeURIComponent(libs);
       const sapClient = urlParams.get('sap-client');
-      if (sapClient?.length === 3) {
+      if (sapClient?.length === 3 && /^\d+$/.test(sapClient)) {
         url = url + '&sap-client=' + sapClient;
       }
       const response = await fetch(url);

package/dist/preview-middleware/dist/client/flp/init.ts

@@ -185,9 +185,9 @@ export async function resetAppState(container: typeof sap.ushell.Container): Pro
 export async function registerComponentDependencyPaths(appUrls: string[], urlParams: URLSearchParams): Promise<void> {
     const libs = await getManifestLibs(appUrls);
     if (libs && libs.length > 0) {
-        let url = '/sap/bc/ui2/app_index/ui5_app_info?id=' + libs;
+        let url = '/sap/bc/ui2/app_index/ui5_app_info?id=' + encodeURIComponent(libs);
         const sapClient = urlParams.get('sap-client');
-        if (sapClient?.length === 3) {
+        if (sapClient?.length === 3 && /^\d+$/.test(sapClient)) {
             url = url + '&sap-client=' + sapClient;
         }
         const response = await fetch(url);

package/dist/preview-middleware/dist/client/messagebundle.properties

@@ -67,6 +67,8 @@ ADP_CREATE_CONTROLLER_EXTENSION_TITLE = Create Controller Extension
 ADP_CREATE_CONTROLLER_EXTENSION_DESCRIPTION = Controller extension with name ''{0}'' was created.
 ADP_ODATA_HEALTH_CHECK_TITLE = OData Service Health Check
 ADP_ODATA_SERVICE_DOWN_DESCRIPTION = The OData service with the {0} endpoint is down. Error: {1}.
+ADP_ORPHANED_CHANGE_ERROR_TITLE = Missing File Detected
+ADP_ORPHANED_FILE_DESCRIPTION = The "{0}" file referenced by the "{1}" change was not found. To resolve this error, delete the change file.
 ADP_ADD_ACTION_DIALOG_ACTION_ID_LABEL = Action ID
 ADP_ADD_ACTION_DIALOG_BUTTON_TEXT_LABEL = Button Text
 ADP_ADD_ACTION_DIALOG_HANDLER_METHOD_LABEL = Handler Method