@sap-ux/preview-middleware 0.12.13 → 0.12.15

package/dist/client/cpe/documentation.js

@@ -1,166 +1,166 @@
-"use strict";
-
-sap.ui.define(["./utils", "sap/base/Log"], function (___utils, Log) {
-  "use strict";
-
-  const getLibrary = ___utils["getLibrary"];
-  /**
-   * 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';
-    return fetch(libUrl).then(res => res.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);
-        }
-      });
-    }).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}`;
-      }
-    }
-    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
-          };
-        });
-      }
-    }
-    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);
-    }
-    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;
-    }
-  }
-
-  /**
-   * 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 (err) {
-      Log.error(`Error in getting documentation for ${contLibName}`);
-    }
-    return doc;
-  }
-  var __exports = {
-    __esModule: true
-  };
-  __exports.getUi5ApiDtMetadata = getUi5ApiDtMetadata;
-  __exports.loadDefaultLibraries = loadDefaultLibraries;
-  __exports.getDocumentation = getDocumentation;
-  return __exports;
+"use strict";
+
+sap.ui.define(["./utils", "sap/base/Log"], function (___utils, Log) {
+  "use strict";
+
+  const getLibrary = ___utils["getLibrary"];
+  /**
+   * 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';
+    return fetch(libUrl).then(res => res.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);
+        }
+      });
+    }).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}`;
+      }
+    }
+    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
+          };
+        });
+      }
+    }
+    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);
+    }
+    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;
+    }
+  }
+
+  /**
+   * 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 (err) {
+      Log.error(`Error in getting documentation for ${contLibName}`);
+    }
+    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

@@ -7,18 +7,24 @@ sap.ui.define([
     './documentation',
     'sap/base/Log',
     './logger',
-    './ui5-utils'
-], function (___sap_ux_private_control_property_editor_common, ___outline_index, ___selection, ___changes_service, ___documentation, Log, ___logger, ___ui5_utils) {
+    './ui5-utils',
+    '../flp/WorkspaceConnector'
+], function (___sap_ux_private_control_property_editor_common, ___outline_index, ___selection, ___changes_service, ___documentation, Log, ___logger, ___ui5_utils, __workspaceConnector) {
     'use strict';
+    function _interopRequireDefault(obj) {
+        return obj && obj.__esModule && typeof obj.default !== 'undefined' ? obj.default : obj;
+    }
     const startPostMessageCommunication = ___sap_ux_private_control_property_editor_common['startPostMessageCommunication'];
     const iconsLoaded = ___sap_ux_private_control_property_editor_common['iconsLoaded'];
     const enableTelemetry = ___sap_ux_private_control_property_editor_common['enableTelemetry'];
+    const storageFileChanged = ___sap_ux_private_control_property_editor_common['storageFileChanged'];
     const initOutline = ___outline_index['initOutline'];
     const SelectionService = ___selection['SelectionService'];
     const ChangeService = ___changes_service['ChangeService'];
     const loadDefaultLibraries = ___documentation['loadDefaultLibraries'];
     const logger = ___logger['logger'];
     const getIcons = ___ui5_utils['getIcons'];
+    const workspaceConnector = _interopRequireDefault(__workspaceConnector);
     function init(rta) {
         Log.info('Initializing Control Property Editor');
         const flexSettings = rta.getFlexSettings();
@@ -51,6 +57,11 @@ sap.ui.define([
             }
             initOutline(rta, sendAction).catch(error => Log.error('Error during initialization of Control Property Editor', error));
             const icons = getIcons();
+            workspaceConnector.storage.fileChangeRequestNotifier = (fileName, kind, changeType) => {
+                if (changeType && changeType !== 'appdescr_fe_changePageConfiguration' || kind === 'delete') {
+                    sendAction(storageFileChanged(fileName?.replace('sap.ui.fl.', '')));
+                }
+            };
             sendAction(iconsLoaded(icons));
         } catch (error) {
             Log.error('Error during initialization of Control Property Editor', error);

package/dist/client/cpe/init.ts

@@ -2,7 +2,8 @@ import type { ExternalAction } from '@sap-ux-private/control-property-editor-com
 import {
     startPostMessageCommunication,
     iconsLoaded,
-    enableTelemetry
+    enableTelemetry,
+    storageFileChanged
 } from '@sap-ux-private/control-property-editor-common';
 import type RuntimeAuthoring from 'sap/ui/rta/RuntimeAuthoring';
 
@@ -14,6 +15,7 @@ import { loadDefaultLibraries } from './documentation';
 import Log from 'sap/base/Log';
 import { logger } from './logger';
 import { getIcons } from './ui5-utils';
+import workspaceConnector from '../flp/WorkspaceConnector';
 
 export default function init(rta: RuntimeAuthoring): Promise<void> {
     Log.info('Initializing Control Property Editor');
@@ -62,6 +64,18 @@ export default function init(rta: RuntimeAuthoring): Promise<void> {
             Log.error('Error during initialization of Control Property Editor', error)
         );
         const icons = getIcons();
+
+        // hook the file deletion listener to the UI5 workspace connector
+        workspaceConnector.storage.fileChangeRequestNotifier = (
+            fileName: string,
+            kind: 'delete' | 'create',
+            changeType?: string
+        ) => {
+            if ((changeType && changeType !== 'appdescr_fe_changePageConfiguration') || kind === 'delete') {
+                sendAction(storageFileChanged(fileName?.replace('sap.ui.fl.', '')));
+            }
+        };
+
         sendAction(iconsLoaded(icons));
     } catch (error) {
         Log.error('Error during initialization of Control Property Editor', error);

package/dist/client/cpe/logger.js

@@ -1,32 +1,32 @@
-"use strict";
-
-sap.ui.define(["sap/base/Log"], function (Log) {
-  "use strict";
-
-  function getString(message) {
-    if (typeof message === 'object') {
-      return message.toString();
-    }
-    return message;
-  }
-  const logger = {
-    info: message => {
-      Log.info(getString(message));
-    },
-    debug: message => {
-      Log.debug(getString(message));
-    },
-    warn: message => {
-      Log.warning(getString(message));
-    },
-    error: message => {
-      Log.error(getString(message));
-    }
-  };
-  var __exports = {
-    __esModule: true
-  };
-  __exports.logger = logger;
-  return __exports;
+"use strict";
+
+sap.ui.define(["sap/base/Log"], function (Log) {
+  "use strict";
+
+  function getString(message) {
+    if (typeof message === 'object') {
+      return message.toString();
+    }
+    return message;
+  }
+  const logger = {
+    info: message => {
+      Log.info(getString(message));
+    },
+    debug: message => {
+      Log.debug(getString(message));
+    },
+    warn: message => {
+      Log.warning(getString(message));
+    },
+    error: message => {
+      Log.error(getString(message));
+    }
+  };
+  var __exports = {
+    __esModule: true
+  };
+  __exports.logger = logger;
+  return __exports;
 });
 //# sourceMappingURL=logger.js.map

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

@@ -1,86 +1,86 @@
-"use strict";
-
-sap.ui.define(["./utils"], function (___utils) {
-  "use strict";
-
-  const isEditable = ___utils["isEditable"];
-  /**
-   * Retrieves additional data for a given control ID.
-   *
-   * @param id The control ID for which to retrieve additional data
-   * @returns An object containing additional data, including an optional 'text' property
-   */
-  function getAdditionalData(id) {
-    const control = sap.ui.getCore().byId(id);
-    if (control?.getMetadata().getProperty('text')) {
-      const text = control.getProperty('text');
-      if (typeof text === 'string' && text.trim() !== '') {
-        return {
-          text
-        };
-      }
-    }
-    return {};
-  }
-
-  /**
-   * Gets the children nodes of an aggregation type node.
-   *
-   * @param current The current node to retrieve children from
-   * @returns An array of children nodes, or an empty array if none are found
-   */
-  function getChildren(current) {
-    return (current.elements ?? []).flatMap(element => element.type === 'aggregation' ? element.elements ?? [] : []);
-  }
-
-  /**
-   * Transform node.
-   *
-   * @param input outline view node
-   * @param scenario type of project
-   * @returns Promise<OutlineNode[]>
-   */
-  async function transformNodes(input, scenario) {
-    const stack = [...input];
-    const items = [];
-    while (stack.length) {
-      const current = stack.shift();
-      const editable = await isEditable(current?.id);
-      if (current?.type === 'element') {
-        const children = getChildren(current);
-        const {
-          text
-        } = getAdditionalData(current.id);
-        const technicalName = current.technicalName.split('.').slice(-1)[0];
-        const node = {
-          controlId: current.id,
-          controlType: current.technicalName,
-          name: text ?? technicalName,
-          editable,
-          visible: current.visible ?? true,
-          children: await transformNodes(children, scenario)
-        };
-        items.push(node);
-      }
-      if (scenario === 'ADAPTATION_PROJECT' && current?.type === 'extensionPoint') {
-        const node = {
-          controlId: current.id,
-          controlType: current.technicalName,
-          name: current.name,
-          editable,
-          visible: current.visible ?? true,
-          children: [],
-          icon: current.icon
-        };
-        items.push(node);
-      }
-    }
-    return items;
-  }
-  var __exports = {
-    __esModule: true
-  };
-  __exports.transformNodes = transformNodes;
-  return __exports;
+"use strict";
+
+sap.ui.define(["./utils"], function (___utils) {
+  "use strict";
+
+  const isEditable = ___utils["isEditable"];
+  /**
+   * Retrieves additional data for a given control ID.
+   *
+   * @param id The control ID for which to retrieve additional data
+   * @returns An object containing additional data, including an optional 'text' property
+   */
+  function getAdditionalData(id) {
+    const control = sap.ui.getCore().byId(id);
+    if (control?.getMetadata().getProperty('text')) {
+      const text = control.getProperty('text');
+      if (typeof text === 'string' && text.trim() !== '') {
+        return {
+          text
+        };
+      }
+    }
+    return {};
+  }
+
+  /**
+   * Gets the children nodes of an aggregation type node.
+   *
+   * @param current The current node to retrieve children from
+   * @returns An array of children nodes, or an empty array if none are found
+   */
+  function getChildren(current) {
+    return (current.elements ?? []).flatMap(element => element.type === 'aggregation' ? element.elements ?? [] : []);
+  }
+
+  /**
+   * Transform node.
+   *
+   * @param input outline view node
+   * @param scenario type of project
+   * @returns Promise<OutlineNode[]>
+   */
+  async function transformNodes(input, scenario) {
+    const stack = [...input];
+    const items = [];
+    while (stack.length) {
+      const current = stack.shift();
+      const editable = await isEditable(current?.id);
+      if (current?.type === 'element') {
+        const children = getChildren(current);
+        const {
+          text
+        } = getAdditionalData(current.id);
+        const technicalName = current.technicalName.split('.').slice(-1)[0];
+        const node = {
+          controlId: current.id,
+          controlType: current.technicalName,
+          name: text ?? technicalName,
+          editable,
+          visible: current.visible ?? true,
+          children: await transformNodes(children, scenario)
+        };
+        items.push(node);
+      }
+      if (scenario === 'ADAPTATION_PROJECT' && current?.type === 'extensionPoint') {
+        const node = {
+          controlId: current.id,
+          controlType: current.technicalName,
+          name: current.name,
+          editable,
+          visible: current.visible ?? true,
+          children: [],
+          icon: current.icon
+        };
+        items.push(node);
+      }
+    }
+    return items;
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.transformNodes = transformNodes;
+  return __exports;
 });
 //# sourceMappingURL=nodes.js.map