@sap-ux/preview-middleware 0.23.48 → 0.23.50

package/dist/client/cpe/documentation.js

@@ -1,134 +1,191 @@
-'use strict';
-sap.ui.define([
-    './utils',
-    'sap/base/Log',
-    'open/ux/preview/client/thirdparty/@sap-ux-private/control-property-editor-common',
-    '../utils/info-center-message',
-    '../utils/error'
-], function (___utils, Log, ___sap_ux_private_control_property_editor_common, ___utils_info_center_message, ___utils_error) {
-    'use strict';
-    const getLibrary = ___utils['getLibrary'];
-    const MessageBarType = ___sap_ux_private_control_property_editor_common['MessageBarType'];
-    const sendInfoCenterMessage = ___utils_info_center_message['sendInfoCenterMessage'];
-    const FetchError = ___utils_error['FetchError'];
-    async function getUi5ApiDtMetadata(libName) {
-        const libUrl = '/test-resources/' + libName.split('.').join('/') + '/designtime/api.json';
-        const response = await fetch(libUrl);
-        if (!response.ok) {
-            throw new FetchError(response);
-        }
-        return response.json();
-    }
-    const ui5ApiDtMetadata = new Map();
-    function loadDefaultLibraries() {
-        const allData = Promise.all([
-            getUi5ApiDtMetadata('sap.m'),
-            getUi5ApiDtMetadata('sap.ui.comp'),
-            getUi5ApiDtMetadata('sap.ui.core'),
-            getUi5ApiDtMetadata('sap.f')
-        ]);
-        allData.then(res => {
-            res.forEach(api => {
-                if (api.library) {
-                    ui5ApiDtMetadata.set(api.library, api);
-                }
-            });
-        }).catch(reason => {
-            Log.error('Loading Library Failed: ' + reason);
-        });
+"use strict";
+
+sap.ui.define(["./utils", "sap/base/Log", "open/ux/preview/client/thirdparty/@sap-ux-private/control-property-editor-common", "../utils/info-center-message", "../utils/error"], function (___utils, Log, ___sap_ux_private_control_property_editor_common, ___utils_info_center_message, ___utils_error) {
+  "use strict";
+
+  const getLibrary = ___utils["getLibrary"];
+  const MessageBarType = ___sap_ux_private_control_property_editor_common["MessageBarType"];
+  const sendInfoCenterMessage = ___utils_info_center_message["sendInfoCenterMessage"];
+  const FetchError = ___utils_error["FetchError"];
+  /**
+   * Get ui5 metadata of given library name.
+   *
+   * @param libName library name for eg: sap.m
+   * @returns Promise<SchemaForApiJsonFiles>
+   */
+  async function getUi5ApiDtMetadata(libName) {
+    const libUrl = '/test-resources/' + libName.split('.').join('/') + '/designtime/api.json';
+    const response = await fetch(libUrl);
+    if (!response.ok) {
+      throw new FetchError(response);
     }
-    function formatHtmlText(sHtml) {
-        const parts = (sHtml || '').split('<');
-        let result = '';
-        for (const part of parts) {
-            if (!result) {
-                result = part;
-            } else {
-                const indexClosingBracket = part.indexOf('>');
-                result += indexClosingBracket >= 0 ? part.substring(indexClosingBracket + 1) : `<${ part }`;
-            }
+    return response.json();
+  }
+
+  /**
+   * load ui5 controls design time metadata api.json for following libraries
+   * sap.m, sap.ui.comp, sap.f, sap.ui.core
+   * loading libraries(more in file size) in parallel during initialization.
+   * Others (less in file size) are loaded dynamically in getControlMetadata method
+   */
+  const ui5ApiDtMetadata = new Map();
+  function loadDefaultLibraries() {
+    const allData = Promise.all([getUi5ApiDtMetadata('sap.m'), getUi5ApiDtMetadata('sap.ui.comp'), getUi5ApiDtMetadata('sap.ui.core'), getUi5ApiDtMetadata('sap.f')]);
+    allData.then(res => {
+      res.forEach(api => {
+        if (api.library) {
+          ui5ApiDtMetadata.set(api.library, api);
         }
-        return result;
+      });
+    }).catch(reason => {
+      Log.error('Loading Library Failed: ' + reason);
+    });
+  }
+
+  /**
+   * Format html text.
+   *
+   * @param sHtml - html string
+   * @returns string
+   */
+  function formatHtmlText(sHtml) {
+    // replaced "sHtml.replace(new RegExp('<[^>]*>', 'g')" due to regex runtime vulnerability
+    const parts = (sHtml || '').split('<');
+    let result = '';
+    for (const part of parts) {
+      if (!result) {
+        result = part;
+      } else {
+        const indexClosingBracket = part.indexOf('>');
+        result += indexClosingBracket >= 0 ? part.substring(indexClosingBracket + 1) : `<${part}`;
+      }
     }
-    function parseControlMetaModel(controlLibMetadata, controlName) {
-        const controlInfo = {
-            baseType: '',
-            doc: '',
-            properties: {}
-        };
-        const selectedControlMetadata = (controlLibMetadata.symbols ?? []).find(control => control.name === controlName);
-        if (selectedControlMetadata) {
-            controlInfo.baseType = selectedControlMetadata.extends;
-            controlInfo.doc = selectedControlMetadata.description ?? '';
-            const properties = selectedControlMetadata['ui5-metadata'].properties;
-            if (properties) {
-                properties.forEach(prop => {
-                    prop.description = formatHtmlText(prop.description || '');
-                    prop.propertyName = prop.name;
-                    prop.propertyType = prop.type;
-                    if (prop.defaultValue === null || prop.defaultValue === '') {
-                        prop.defaultValue = '-';
-                    }
-                    controlInfo.properties[prop.name] = { ...prop };
-                });
-            }
-        }
-        return controlInfo;
+    return result;
+  }
+
+  /**
+   * Method to parse ui5 control metadata.
+   *
+   * @param controlLibMetadata control library metadata
+   * @param controlName name of the control
+   * @returns ControlMetadata
+   */
+  function parseControlMetaModel(controlLibMetadata, controlName) {
+    const controlInfo = {
+      baseType: '',
+      doc: '',
+      properties: {}
+    };
+    const selectedControlMetadata = (controlLibMetadata.symbols ?? []).find(control => control.name === controlName);
+    if (selectedControlMetadata) {
+      // base type info of control is available on property 'extends'
+      controlInfo.baseType = selectedControlMetadata.extends;
+      controlInfo.doc = selectedControlMetadata.description ?? '';
+      const properties = selectedControlMetadata['ui5-metadata'].properties;
+      if (properties) {
+        properties.forEach(prop => {
+          prop.description = formatHtmlText(prop.description || '');
+          prop.propertyName = prop.name;
+          prop.propertyType = prop.type;
+          if (prop.defaultValue === null || prop.defaultValue === '') {
+            prop.defaultValue = '-';
+          }
+          controlInfo.properties[prop.name] = {
+            ...prop
+          };
+        });
+      }
     }
-    async function getControlMetadata(controlName, contLibName) {
-        let result;
-        let controlLibMetadata = ui5ApiDtMetadata.get(contLibName);
-        if (controlLibMetadata) {
-            result = parseControlMetaModel(controlLibMetadata, controlName);
-        } else {
-            controlLibMetadata = await getUi5ApiDtMetadata(contLibName);
-            ui5ApiDtMetadata.set(contLibName, controlLibMetadata);
-            result = parseControlMetaModel(controlLibMetadata, controlName);
-        }
-        return result;
+    return controlInfo;
+  }
+
+  /**
+   * Get control metadata for a given control.
+   *
+   * @param controlName name of the control
+   * @param contLibName library name of the control
+   * @returns Promise<ControlMetadata | undefined>
+   */
+  async function getControlMetadata(controlName, contLibName) {
+    let result;
+    let controlLibMetadata = ui5ApiDtMetadata.get(contLibName);
+    if (controlLibMetadata) {
+      result = parseControlMetaModel(controlLibMetadata, controlName);
+    } else {
+      controlLibMetadata = await getUi5ApiDtMetadata(contLibName);
+      ui5ApiDtMetadata.set(contLibName, controlLibMetadata);
+      result = parseControlMetaModel(controlLibMetadata, controlName);
     }
-    async function getControlPropertyDocumentation(controlName, contLibName) {
-        const doc = await getControlMetadata(controlName, contLibName);
-        if (doc) {
-            const baseControlType = doc.baseType;
-            if (baseControlType) {
-                const baseContLibName = await getLibrary(baseControlType);
-                if (baseContLibName) {
-                    const baseControlProps = await getControlPropertyDocumentation(baseControlType, baseContLibName);
-                    return {
-                        ...baseControlProps,
-                        ...doc.properties
-                    };
-                }
-            }
-            return { ...doc.properties };
-        } else {
-            return undefined;
+    return result;
+  }
+
+  /**
+   * Get Control Property Documentation for a give control name and control library.
+   *
+   * @param controlName name of the control
+   * @param contLibName library name of the control
+   * @returns Promise<Properties | undefined>
+   */
+  async function getControlPropertyDocumentation(controlName, contLibName) {
+    const doc = await getControlMetadata(controlName, contLibName);
+    if (doc) {
+      const baseControlType = doc.baseType;
+      if (baseControlType) {
+        const baseContLibName = await getLibrary(baseControlType);
+        if (baseContLibName) {
+          const baseControlProps = await getControlPropertyDocumentation(baseControlType, baseContLibName);
+          return {
+            ...baseControlProps,
+            ...doc.properties
+          };
         }
+      }
+      return {
+        ...doc.properties
+      };
+    } else {
+      return undefined;
     }
-    async function getDocumentation(controlName, contLibName) {
-        let doc;
-        try {
-            doc = await getControlPropertyDocumentation(controlName, contLibName);
-        } catch (error) {
-            Log.error(`Error in getting documentation for ${ contLibName }`);
-            if (error instanceof FetchError && error.status === 404) {
-                return undefined;
-            }
-            await sendInfoCenterMessage({
-                title: { key: 'DOCUMENTATION_ERROR_TITLE' },
-                description: {
-                    key: 'DOCUMENTATION_ERROR_DESCRIPTION',
-                    params: [contLibName]
-                },
-                type: MessageBarType.error
-            });
-        }
-        return doc;
+  }
+
+  /**
+   * Get documentation of a given control of a ui5 library.
+   *
+   * @param controlName name of the control.
+   * @param contLibName library name of the control
+   * @returns Promise<Properties | undefined>
+   */
+  async function getDocumentation(controlName, contLibName) {
+    let doc;
+    try {
+      doc = await getControlPropertyDocumentation(controlName, contLibName);
+    } catch (error) {
+      Log.error(`Error in getting documentation for ${contLibName}`);
+      // For some UI5 components we do not have an api.json provided instead 404, not found,
+      // response is retuned from the server. For such components we do not want to
+      // flood the info center with errors.
+      if (error instanceof FetchError && error.status === 404) {
+        return undefined;
+      }
+      await sendInfoCenterMessage({
+        title: {
+          key: 'DOCUMENTATION_ERROR_TITLE'
+        },
+        description: {
+          key: 'DOCUMENTATION_ERROR_DESCRIPTION',
+          params: [contLibName]
+        },
+        type: MessageBarType.error
+      });
     }
-    var __exports = { __esModule: true };
-    __exports.getUi5ApiDtMetadata = getUi5ApiDtMetadata;
-    __exports.loadDefaultLibraries = loadDefaultLibraries;
-    __exports.getDocumentation = getDocumentation;
-    return __exports;
-});
+    return doc;
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.getUi5ApiDtMetadata = getUi5ApiDtMetadata;
+  __exports.loadDefaultLibraries = loadDefaultLibraries;
+  __exports.getDocumentation = getDocumentation;
+  return __exports;
+});
+//# sourceMappingURL=documentation.js.map

package/dist/client/cpe/init.js

@@ -1,76 +1,70 @@
-'use strict';
-sap.ui.define([
-    'sap/base/Log',
-    'open/ux/preview/client/thirdparty/@sap-ux-private/control-property-editor-common',
-    '../utils/error',
-    './changes/service',
-    './communication-service',
-    './connector-service',
-    './context-menu-service',
-    './documentation',
-    './outline/service',
-    './quick-actions/quick-action-service',
-    './rta-service',
-    './selection',
-    './ui5-utils'
-], function (Log, ___sap_ux_private_control_property_editor_common, ___utils_error, ___changes_service, ___communication_service, ___connector_service, ___context_menu_service, ___documentation, ___outline_service, ___quick_actions_quick_action_service, ___rta_service, ___selection, ___ui5_utils) {
-    'use strict';
-    const appLoaded = ___sap_ux_private_control_property_editor_common['appLoaded'];
-    const enableTelemetry = ___sap_ux_private_control_property_editor_common['enableTelemetry'];
-    const iconsLoaded = ___sap_ux_private_control_property_editor_common['iconsLoaded'];
-    const getError = ___utils_error['getError'];
-    const ChangeService = ___changes_service['ChangeService'];
-    const CommunicationService = ___communication_service['CommunicationService'];
-    const WorkspaceConnectorService = ___connector_service['WorkspaceConnectorService'];
-    const ContextMenuService = ___context_menu_service['ContextMenuService'];
-    const loadDefaultLibraries = ___documentation['loadDefaultLibraries'];
-    const OutlineService = ___outline_service['OutlineService'];
-    const QuickActionService = ___quick_actions_quick_action_service['QuickActionService'];
-    const RtaService = ___rta_service['RtaService'];
-    const SelectionService = ___selection['SelectionService'];
-    const getIcons = ___ui5_utils['getIcons'];
-    function init(rta) {
-        let registries = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
-        Log.info('Initializing Control Property Editor');
-        const flexSettings = rta.getFlexSettings();
-        if (flexSettings.telemetry === true) {
-            enableTelemetry();
-        }
-        function subscribe(handler) {
-            CommunicationService.subscribe(handler);
-        }
-        const rtaService = new RtaService(rta);
-        const changesService = new ChangeService({ rta });
-        const selectionService = new SelectionService(rta, changesService);
-        const connectorService = new WorkspaceConnectorService();
-        const contextMenuService = new ContextMenuService(rta);
-        const outlineService = new OutlineService(rta, changesService);
-        const quickActionService = new QuickActionService(rta, outlineService, registries, changesService);
-        const services = [
-            connectorService,
-            selectionService,
-            changesService,
-            contextMenuService,
-            outlineService,
-            rtaService,
-            quickActionService
-        ];
-        try {
-            loadDefaultLibraries();
-            const allPromises = services.map(service => {
-                return service.init(CommunicationService.sendAction, subscribe)?.catch(error => {
-                    Log.error('Service Initialization Failed: ', getError(error));
-                });
-            });
-            Promise.all(allPromises).then(() => {
-                CommunicationService.sendAction(appLoaded());
-            }).catch(Log.error);
-            const icons = getIcons();
-            CommunicationService.sendAction(iconsLoaded(icons));
-        } catch (error) {
-            Log.error('Error during initialization of Control Property Editor', getError(error));
-        }
-        return Promise.resolve();
+"use strict";
+
+sap.ui.define(["sap/base/Log", "open/ux/preview/client/thirdparty/@sap-ux-private/control-property-editor-common", "../utils/error", "./changes/service", "./communication-service", "./connector-service", "./context-menu-service", "./documentation", "./outline/service", "./quick-actions/quick-action-service", "./rta-service", "./selection", "./ui5-utils"], function (Log, ___sap_ux_private_control_property_editor_common, ___utils_error, ___changes_service, ___communication_service, ___connector_service, ___context_menu_service, ___documentation, ___outline_service, ___quick_actions_quick_action_service, ___rta_service, ___selection, ___ui5_utils) {
+  "use strict";
+
+  const appLoaded = ___sap_ux_private_control_property_editor_common["appLoaded"];
+  const enableTelemetry = ___sap_ux_private_control_property_editor_common["enableTelemetry"];
+  const iconsLoaded = ___sap_ux_private_control_property_editor_common["iconsLoaded"];
+  const getError = ___utils_error["getError"];
+  const ChangeService = ___changes_service["ChangeService"];
+  const CommunicationService = ___communication_service["CommunicationService"];
+  const WorkspaceConnectorService = ___connector_service["WorkspaceConnectorService"];
+  const ContextMenuService = ___context_menu_service["ContextMenuService"];
+  const loadDefaultLibraries = ___documentation["loadDefaultLibraries"];
+  const OutlineService = ___outline_service["OutlineService"];
+  const QuickActionService = ___quick_actions_quick_action_service["QuickActionService"];
+  const RtaService = ___rta_service["RtaService"];
+  const SelectionService = ___selection["SelectionService"];
+  const getIcons = ___ui5_utils["getIcons"];
+  function init(rta) {
+    let registries = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
+    Log.info('Initializing Control Property Editor');
+
+    // enable telemetry if requested
+    const flexSettings = rta.getFlexSettings();
+    if (flexSettings.telemetry === true) {
+      enableTelemetry();
     }
-    return init;
-});
+
+    /**
+     *
+     * @param handler action handler
+     */
+    function subscribe(handler) {
+      CommunicationService.subscribe(handler);
+    }
+    const rtaService = new RtaService(rta);
+    const changesService = new ChangeService({
+      rta
+    });
+    const selectionService = new SelectionService(rta, changesService);
+    const connectorService = new WorkspaceConnectorService();
+    const contextMenuService = new ContextMenuService(rta);
+    const outlineService = new OutlineService(rta, changesService);
+    const quickActionService = new QuickActionService(rta, outlineService, registries, changesService);
+    const services = [connectorService, selectionService, changesService, contextMenuService, outlineService, rtaService, quickActionService];
+    try {
+      loadDefaultLibraries();
+      const allPromises = services.map(service => {
+        return service.init(CommunicationService.sendAction, subscribe)?.catch(error => {
+          Log.error('Service Initialization Failed: ', getError(error));
+        });
+      });
+      Promise.all(allPromises).then(() => {
+        CommunicationService.sendAction(appLoaded());
+      })
+      // eslint-disable-next-line @typescript-eslint/unbound-method
+      .catch(Log.error);
+      const icons = getIcons();
+      CommunicationService.sendAction(iconsLoaded(icons));
+    } catch (error) {
+      Log.error('Error during initialization of Control Property Editor', getError(error));
+    }
+
+    //  * This is returned immediately to avoid promise deadlock, preventing services from waiting indefinitely.
+    return Promise.resolve();
+  }
+  return init;
+});
+//# sourceMappingURL=init.js.map

package/dist/client/cpe/outline/service.js

@@ -1,47 +1,62 @@
-'use strict';
-sap.ui.define([
-    'sap/base/Log',
-    'open/ux/preview/client/thirdparty/@sap-ux-private/control-property-editor-common',
-    '../../utils/error',
-    './nodes'
-], function (Log, ___sap_ux_private_control_property_editor_common, ____utils_error, ___nodes) {
-    'use strict';
-    const outlineChanged = ___sap_ux_private_control_property_editor_common['outlineChanged'];
-    const getError = ____utils_error['getError'];
-    const transformNodes = ___nodes['transformNodes'];
-    const OUTLINE_CHANGE_EVENT = 'OUTLINE_CHANGED';
-    class OutlineService extends EventTarget {
-        constructor(rta, changeService) {
-            super();
-            this.rta = rta;
-            this.changeService = changeService;
-        }
-        async init(sendAction) {
-            const outline = await this.rta.getService('outline');
-            const {scenario} = this.rta.getFlexSettings();
-            const syncOutline = async () => {
-                try {
-                    const viewNodes = await outline.get();
-                    const controlIndex = {};
-                    const configPropertyIdMap = new Map();
-                    const outlineNodes = await transformNodes(viewNodes, scenario, controlIndex, this.changeService, configPropertyIdMap);
-                    const event = new CustomEvent(OUTLINE_CHANGE_EVENT, { detail: { controlIndex } });
-                    this.dispatchEvent(event);
-                    sendAction(outlineChanged(outlineNodes));
-                    await this.changeService.updateConfigurationProps(configPropertyIdMap);
-                } catch (error) {
-                    Log.error('Outline sync failed!', getError(error));
-                }
-            };
-            await syncOutline();
-            outline.attachEvent('update', syncOutline);
-        }
-        onOutlineChange(handler) {
-            this.addEventListener(OUTLINE_CHANGE_EVENT, handler);
+"use strict";
+
+sap.ui.define(["sap/base/Log", "open/ux/preview/client/thirdparty/@sap-ux-private/control-property-editor-common", "../../utils/error", "./nodes"], function (Log, ___sap_ux_private_control_property_editor_common, ____utils_error, ___nodes) {
+  "use strict";
+
+  const outlineChanged = ___sap_ux_private_control_property_editor_common["outlineChanged"];
+  const getError = ____utils_error["getError"];
+  const transformNodes = ___nodes["transformNodes"];
+  const OUTLINE_CHANGE_EVENT = 'OUTLINE_CHANGED';
+  /**
+   * A Class of WorkspaceConnectorService
+   */
+  class OutlineService extends EventTarget {
+    constructor(rta, changeService) {
+      super();
+      this.rta = rta;
+      this.changeService = changeService;
+    }
+
+    /**
+     * Initializes connector service.
+     *
+     * @param sendAction action sender function
+     */
+    async init(sendAction) {
+      const outline = await this.rta.getService('outline');
+      const {
+        scenario
+      } = this.rta.getFlexSettings();
+      const syncOutline = async () => {
+        try {
+          const viewNodes = await outline.get();
+          const controlIndex = {};
+          const configPropertyIdMap = new Map();
+          const outlineNodes = await transformNodes(viewNodes, scenario, controlIndex, this.changeService, configPropertyIdMap);
+          const event = new CustomEvent(OUTLINE_CHANGE_EVENT, {
+            detail: {
+              controlIndex
+            }
+          });
+          this.dispatchEvent(event);
+          sendAction(outlineChanged(outlineNodes));
+          await this.changeService.updateConfigurationProps(configPropertyIdMap);
+        } catch (error) {
+          Log.error('Outline sync failed!', getError(error));
         }
+      };
+      await syncOutline();
+      outline.attachEvent('update', syncOutline);
+    }
+    onOutlineChange(handler) {
+      this.addEventListener(OUTLINE_CHANGE_EVENT, handler);
     }
-    var __exports = { __esModule: true };
-    __exports.OUTLINE_CHANGE_EVENT = OUTLINE_CHANGE_EVENT;
-    __exports.OutlineService = OutlineService;
-    return __exports;
-});
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.OUTLINE_CHANGE_EVENT = OUTLINE_CHANGE_EVENT;
+  __exports.OutlineService = OutlineService;
+  return __exports;
+});
+//# sourceMappingURL=service.js.map

package/dist/client/cpe/quick-actions/quick-action-definition.js

@@ -1,6 +1,2 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
 //# sourceMappingURL=quick-action-definition.js.map