@sap-ux/preview-middleware 0.13.8 → 0.13.10

package/dist/base/flp.d.ts

@@ -121,6 +121,17 @@ export declare class FlpSandbox {
      * Create required routes for flex.
      */
     private createFlexHandler;
+    /**
+     * Send a response with the given content type, status and body.
+     * Ensure compliance with common APIs in express and connect.
+     *
+     * @param res the response object
+     * @param contentType the content type
+     * @param status the response status
+     * @param body the response body
+     * @private
+     */
+    private sendResponse;
     /**
      * Add routes for html and scripts required for a local test FLP.
      *

package/dist/base/flp.js

@@ -222,7 +222,7 @@ class FlpSandbox {
                         scenario,
                         livereloadPort
                     });
-                    res.status(200).contentType('html').send(html);
+                    this.sendResponse(res, 'text/html', 200, html);
                 });
                 let path = (0, path_1.dirname)(editor.path);
                 if (!path.endsWith('/')) {
@@ -232,7 +232,7 @@ class FlpSandbox {
             }
             this.router.get(previewUrl, (_req, res) => {
                 const html = this.generateSandboxForEditor(rta, editor).replace('</body>', `</body>\n<!-- livereload disabled for editor </body>-->`);
-                res.status(200).contentType('html').send(html);
+                this.sendResponse(res, 'text/html', 200, html);
             });
         }
     }
@@ -251,7 +251,7 @@ class FlpSandbox {
             }
             const template = (0, fs_1.readFileSync)((0, path_1.join)(__dirname, '../../templates/flp/sandbox.html'), 'utf-8');
             const html = (0, ejs_1.render)(template, this.templateConfig);
-            res.status(200).contentType('html').send(html);
+            this.sendResponse(res, 'text/html', 200, html);
         })));
     }
     /**
@@ -324,39 +324,54 @@ class FlpSandbox {
         const api = `${PREVIEW_URL.api}/changes`;
         this.router.use(api, (0, express_1.json)());
         this.router.get(api, ((_req, res) => __awaiter(this, void 0, void 0, function* () {
-            res.status(200)
-                .contentType('application/json')
-                .send(yield (0, flex_1.readChanges)(this.project, this.logger));
+            this.sendResponse(res, 'application/json', 200, JSON.stringify(yield (0, flex_1.readChanges)(this.project, this.logger)));
         })));
         this.router.post(api, ((req, res) => __awaiter(this, void 0, void 0, function* () {
             try {
                 const { success, message } = (0, flex_1.writeChange)(req.body, this.utils.getProject().getSourcePath(), this.logger);
                 if (success) {
-                    res.status(200).send(message);
+                    this.sendResponse(res, 'text/plain', 200, message !== null && message !== void 0 ? message : '');
                 }
                 else {
-                    res.status(400).send('INVALID_DATA');
+                    this.sendResponse(res, 'text/plain', 400, 'INVALID_DATA');
                 }
             }
             catch (error) {
-                res.status(500).send(error.message);
+                this.sendResponse(res, 'text/plain', 500, error.message);
             }
         })));
         this.router.delete(api, ((req, res) => __awaiter(this, void 0, void 0, function* () {
             try {
                 const { success, message } = (0, flex_1.deleteChange)(req.body, this.utils.getProject().getSourcePath(), this.logger);
                 if (success) {
-                    res.status(200).send(message);
+                    this.sendResponse(res, 'text/plain', 200, message !== null && message !== void 0 ? message : '');
                 }
                 else {
-                    res.status(400).send('INVALID_DATA');
+                    this.sendResponse(res, 'text/plain', 400, 'INVALID_DATA');
                 }
             }
             catch (error) {
-                res.status(500).send(error.message);
+                this.sendResponse(res, 'text/plain', 500, error.message);
             }
         })));
     }
+    /**
+     * Send a response with the given content type, status and body.
+     * Ensure compliance with common APIs in express and connect.
+     *
+     * @param res the response object
+     * @param contentType the content type
+     * @param status the response status
+     * @param body the response body
+     * @private
+     */
+    sendResponse(res, contentType, status, body) {
+        res.writeHead(status, {
+            'Content-Type': contentType
+        });
+        res.write(body);
+        res.end();
+    }
     /**
      * Add routes for html and scripts required for a local test FLP.
      *
@@ -387,7 +402,7 @@ class FlpSandbox {
                         initPath: `${ns}${config.init.replace('.js', '')}`
                     };
                     const html = (0, ejs_1.render)(htmlTemplate, templateConfig);
-                    res.status(200).contentType('html').send(html);
+                    this.sendResponse(res, 'text/html', 200, html);
                 }
             })));
             if (testConfig.init !== undefined) {
@@ -406,8 +421,8 @@ class FlpSandbox {
                 else {
                     const testFiles = yield this.project.byGlob(config.pattern);
                     const templateConfig = { tests: (0, test_1.generateImportList)(ns, testFiles) };
-                    const html = (0, ejs_1.render)(initTemplate, templateConfig);
-                    res.status(200).contentType('application/javascript').send(html);
+                    const js = (0, ejs_1.render)(initTemplate, templateConfig);
+                    this.sendResponse(res, 'application/javascript', 200, js);
                 }
             })));
         }

package/dist/client/adp/api-handler.ts

@@ -75,7 +75,7 @@ export async function request<T>(endpoint: ApiEndpoints, method: RequestMethod,
 
         switch (method) {
             case RequestMethod.GET:
-                return response.json();
+                return response.json() as T;
             case RequestMethod.POST:
                 /**
                  * Since POST usually creates something
@@ -83,7 +83,7 @@ export async function request<T>(endpoint: ApiEndpoints, method: RequestMethod,
                  */
                 return response.text() as T;
             default:
-                return response.json();
+                return response.json() as T;
         }
     } catch (e) {
         throw new Error(e.message);

package/dist/client/adp/controllers/ExtensionPoint.controller.js

@@ -86,9 +86,9 @@ sap.ui.define(["sap/m/MessageToast", "sap/ui/model/json/JSONModel", "../api-hand
         MessageToast.show(e.message);
         throw new Error(e.message);
       }
-      await this.createExtensionPointFragmentChange(fragmentName);
+      this.createExtensionPointFragmentChange(fragmentName);
     },
-    createExtensionPointFragmentChange: async function _createExtensionPointFragmentChange(fragmentName) {
+    createExtensionPointFragmentChange: function _createExtensionPointFragmentChange(fragmentName) {
       const extensionPointName = this.model.getProperty('/extensionPointName');
       const modifiedValue = {
         fragmentPath: `fragments/${fragmentName}.fragment.xml`,

package/dist/client/adp/controllers/ExtensionPoint.controller.ts

@@ -142,7 +142,7 @@ export default class ExtensionPoint extends BaseDialog {
             throw new Error(e.message);
         }
 
-        await this.createExtensionPointFragmentChange(fragmentName);
+        this.createExtensionPointFragmentChange(fragmentName);
     }
 
     /**
@@ -150,7 +150,7 @@ export default class ExtensionPoint extends BaseDialog {
      *
      * @param fragmentName Fragment name
      */
-    private async createExtensionPointFragmentChange(fragmentName: string): Promise<void> {
+    private createExtensionPointFragmentChange(fragmentName: string): void {
         const extensionPointName = this.model.getProperty('/extensionPointName');
         const modifiedValue = {
             fragmentPath: `fragments/${fragmentName}.fragment.xml`,

package/dist/client/adp/init.js

@@ -52,7 +52,7 @@ sap.ui.define([
             const extPointService = new ExtensionPointService(rta);
             extPointService.init(subscribe);
         }
-        init(rta);
+        await init(rta);
         const ui5VersionValidationMsg = getUI5VersionValidationMessage(version);
         if (ui5VersionValidationMsg) {
             sendAction(showMessage(ui5VersionValidationMsg));

package/dist/client/adp/init.ts

@@ -51,7 +51,7 @@ export default async function (rta: RuntimeAuthoring) {
     }
 
     // also initialize the editor
-    init(rta);
+    await init(rta);
 
     const ui5VersionValidationMsg = getUI5VersionValidationMessage(version);
 

package/dist/client/cpe/changes/service.ts

@@ -120,6 +120,7 @@ export class ChangeService {
                     if (control) {
                         name = control.getMetadata().getName();
                     }
+                    // eslint-disable-next-line  @typescript-eslint/no-unsafe-call
                     const modifiedMessage = modifyRTAErrorMessage(exception?.toString(), id, name);
                     const errorMessage =
                         modifiedMessage || `RTA Exception applying expression "${action.payload.value}"`;
@@ -379,9 +380,10 @@ export class ChangeService {
     private getCommandSelectorId(command: FlexCommand): string | undefined {
         return this.retryOperations([
             () => command.getSelector().id,
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-return
             () => command.getElement().getProperty('persistencyKey'),
             () => command.getElement().getId(),
             () => command.getParent()?.getElement().getId()
-        ]);
+        ]) as string | undefined;
     }
 }

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

@@ -102,6 +102,7 @@ function analyzePropertyType(property: ManagedObjectMetadataProperties): Analyze
         if (propertyDataType && !(propertyDataType instanceof DataType)) {
             return analyzedType;
         }
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-call
         const name = Object.getPrototypeOf(propertyDataType).getName();
         if (!name) {
             analyzedType.primitiveType = 'enum';

package/dist/client/cpe/documentation.ts

@@ -1,5 +1,5 @@
 import { getLibrary } from './utils';
-import type { SchemaForApiJsonFiles, Ui5Property } from './api-json';
+import type { SchemaForApiJsonFiles, Ui5Metadata, Ui5Property } from './api-json';
 import type { Properties } from './utils';
 import Log from 'sap/base/Log';
 import { PropertiesInfo } from '@sap-ux-private/control-property-editor-common';
@@ -18,7 +18,7 @@ export interface ControlMetadata {
  */
 export async function getUi5ApiDtMetadata(libName: string): Promise<SchemaForApiJsonFiles> {
     const libUrl = '/test-resources/' + libName.split('.').join('/') + '/designtime/api.json';
-    return fetch(libUrl).then((res) => res.json());
+    return fetch(libUrl).then((res) => res.json() as unknown as SchemaForApiJsonFiles);
 }
 
 /**
@@ -85,7 +85,9 @@ function parseControlMetaModel(controlLibMetadata: SchemaForApiJsonFiles, contro
         // base type info of control is available on property 'extends'
         controlInfo.baseType = selectedControlMetadata.extends;
         controlInfo.doc = selectedControlMetadata.description ?? '';
-        const properties = selectedControlMetadata['ui5-metadata'].properties;
+        const properties: (Ui5Property & PropertiesInfo)[] | undefined = (
+            selectedControlMetadata['ui5-metadata'] as Ui5Metadata
+        ).properties as (Ui5Property & PropertiesInfo)[] | undefined;
         if (properties) {
             properties.forEach((prop: Ui5Property & PropertiesInfo) => {
                 prop.description = formatHtmlText(prop.description || '');

package/dist/client/cpe/logger.js

@@ -5,7 +5,7 @@ sap.ui.define(["sap/base/Log"], function (Log) {
 
   function getString(message) {
     if (typeof message === 'object') {
-      return message.toString();
+      return JSON.stringify(message).toString();
     }
     return message;
   }

package/dist/client/cpe/logger.ts

@@ -4,7 +4,7 @@ import { Logger } from '@sap-ux-private/control-property-editor-common';
 
 function getString(message: string | object): string {
     if (typeof message === 'object') {
-        return message.toString();
+        return JSON.stringify(message).toString();
     }
     return message;
 }

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

@@ -45,7 +45,7 @@ sap.ui.define(["./utils"], function (___utils) {
     const items = [];
     while (stack.length) {
       const current = stack.shift();
-      const editable = await isEditable(current?.id);
+      const editable = isEditable(current?.id);
       if (current?.type === 'element') {
         const children = getChildren(current);
         const {

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

@@ -48,7 +48,7 @@ export async function transformNodes(input: OutlineViewNode[], scenario: Scenari
     const items: OutlineNode[] = [];
     while (stack.length) {
         const current = stack.shift();
-        const editable = await isEditable(current?.id);
+        const editable = isEditable(current?.id);
         if (current?.type === 'element') {
             const children = getChildren(current);
             const { text } = getAdditionalData(current.id);

package/dist/client/cpe/selection.js

@@ -54,7 +54,7 @@ sap.ui.define([
         constructor(rta) {
             this.rta = rta;
         }
-        async init(sendAction, subscribe) {
+        init(sendAction, subscribe) {
             const eventOrigin = new Set();
             const onselectionChange = this.createOnSelectionChangeHandler(sendAction, eventOrigin);
             this.rta.attachSelectionChange(event => {

package/dist/client/cpe/selection.ts

@@ -101,7 +101,7 @@ export class SelectionService implements Service {
      * @param sendAction action sender function
      * @param subscribe subscriber function
      */
-    public async init(sendAction: ActionSenderFunction, subscribe: SubscribeFunction): Promise<void> {
+    public init(sendAction: ActionSenderFunction, subscribe: SubscribeFunction): void {
         const eventOrigin: Set<string> = new Set();
         const onselectionChange = this.createOnSelectionChangeHandler(sendAction, eventOrigin);
         this.rta.attachSelectionChange((event) => {
@@ -185,8 +185,10 @@ export class SelectionService implements Service {
                         const isOutline = eventOrigin.has('outline');
                         const name = controlName.toLowerCase().startsWith('sap') ? controlName : 'Other Control Types';
                         if (isOutline) {
+                            // eslint-disable-next-line @typescript-eslint/no-floating-promises
                             reportTelemetry({ category: 'Outline Selection', controlName: name });
                         } else {
+                            // eslint-disable-next-line @typescript-eslint/no-floating-promises
                             reportTelemetry({ category: 'Overlay Selection', controlName: name });
                         }
                     } catch (error) {

package/dist/client/flp/WorkspaceConnector.ts

@@ -18,7 +18,7 @@ const connector = merge({}, ObjectStorageConnector, {
 
             if (typeof this.fileChangeRequestNotifier === 'function' && change.fileName) {
                 try {
-                    this.fileChangeRequestNotifier(change.fileName, 'create',  change.changeType);
+                    this.fileChangeRequestNotifier(change.fileName, 'create', change.changeType);
                 } catch (e) {
                     // exceptions in the listener call are ignored
                 }
@@ -62,7 +62,7 @@ const connector = merge({}, ObjectStorageConnector, {
                     'content-type': 'application/json'
                 }
             });
-            const changes = await response.json();
+            const changes = await response.json() as unknown as FlexChange[];
             return changes;
         }
     } as typeof ObjectStorageConnector.storage,

package/dist/client/flp/common.ts

@@ -18,11 +18,11 @@ export const CHANGES_API_PATH = '/preview/api/changes';
  * @returns {FlexSettings | undefined} The parsed Flex settings if available, otherwise undefined.
  */
 export function getFlexSettings(): FlexSettings | undefined {
-    let result;
+    let result: FlexSettings | undefined;
     const bootstrapConfig = document.getElementById('sap-ui-bootstrap');
     const flexSetting = bootstrapConfig?.getAttribute('data-open-ux-preview-flex-settings');
     if (flexSetting) {
-        result = JSON.parse(flexSetting);
+        result = JSON.parse(flexSetting) as FlexSettings;
     }
     return result;
 }

package/package.json

@@ -9,7 +9,7 @@
   "bugs": {
     "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Apreview-middleware"
   },
-  "version": "0.13.8",
+  "version": "0.13.10",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -23,9 +23,9 @@
   ],
   "dependencies": {
     "ejs": "3.1.9",
-    "@sap-ux/adp-tooling": "0.9.10",
-    "@sap-ux/control-property-editor-sources": "npm:@sap-ux/control-property-editor@0.4.17",
     "@sap-ux/logger": "0.5.1",
+    "@sap-ux/adp-tooling": "0.9.11",
+    "@sap-ux/control-property-editor-sources": "npm:@sap-ux/control-property-editor@0.4.17",
     "@sap-ux/project-access": "1.19.6"
   },
   "devDependencies": {
@@ -40,8 +40,8 @@
     "supertest": "6.3.3",
     "@sap-ux-private/playwright": "0.0.3",
     "dotenv": "16.3.1",
-    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.9.4",
-    "@sap-ux/axios-extension": "1.11.5",
+    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.9.5",
+    "@sap-ux/axios-extension": "1.11.6",
     "@sap-ux/store": "0.5.0",
     "@sap-ux/i18n": "0.0.5"
   },