@sap-ux/preview-middleware 0.3.0 → 0.3.1

package/dist/base/flex.d.ts

@@ -1,5 +1,18 @@
 import type { Logger } from '@sap-ux/logger';
 import type { ReaderCollection } from '@ui5/fs';
+/**
+ * Structure of a flex change.
+ */
+export interface FlexChange {
+    [key: string]: string | object | undefined;
+    changeType: string;
+    reference: string;
+    moduleName?: string;
+    content?: {
+        codeRef?: string;
+        fragmentPath?: string;
+    };
+}
 /**
  * Read changes from the file system and return them.
  *
@@ -7,7 +20,7 @@ import type { ReaderCollection } from '@ui5/fs';
  * @param logger logger instance
  * @returns object with the file name as key and the file content as value
  */
-export declare function readChanges(project: ReaderCollection, logger: Logger): Promise<Record<string, unknown>>;
+export declare function readChanges(project: ReaderCollection, logger: Logger): Promise<Record<string, FlexChange>>;
 /**
  * Writes flex changes to the user's workspace.
  *

package/dist/base/flex.js

@@ -12,6 +12,28 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.deleteChange = exports.writeChange = exports.readChanges = void 0;
 const fs_1 = require("fs");
 const path_1 = require("path");
+/**
+ * Map of change type specific correction functions.
+ */
+const moduleNameContentMap = {
+    codeExt: (change) => { var _a, _b; return ((_b = (_a = change.content) === null || _a === void 0 ? void 0 : _a.codeRef) !== null && _b !== void 0 ? _b : '').replace('.js', ''); },
+    addXML: (change) => { var _a, _b; return (_b = (_a = change.content) === null || _a === void 0 ? void 0 : _a.fragmentPath) !== null && _b !== void 0 ? _b : ''; }
+};
+/**
+ * Sets the moduleName property of the provided change to also support old changes with newer UI5 versions.
+ *
+ * @param change change to be fixed
+ * @param logger logger instance
+ */
+function tryFixChange(change, logger) {
+    try {
+        const prefix = change.reference.replace(/\./g, '/');
+        change.moduleName = `${prefix}/changes/${moduleNameContentMap[change.changeType](change)}`;
+    }
+    catch (error) {
+        logger.warn('Could not fix missing module name.');
+    }
+}
 /**
  * Read changes from the file system and return them.
  *
@@ -25,7 +47,11 @@ function readChanges(project, logger) {
         const files = yield project.byGlob('/**/changes/*.*');
         for (const file of files) {
             try {
-                changes[`sap.ui.fl.${(0, path_1.parse)(file.getName()).name}`] = JSON.parse(yield file.getString());
+                const change = JSON.parse(yield file.getString());
+                if (moduleNameContentMap[change.changeType] && !change.moduleName) {
+                    tryFixChange(change, logger);
+                }
+                changes[`sap.ui.fl.${(0, path_1.parse)(file.getName()).name}`] = change;
                 logger.debug(`Read change from ${file.getPath()}`);
             }
             catch (error) {

package/dist/types/index.d.ts

@@ -1,5 +1,8 @@
 import type { AdpPreviewConfig } from '@sap-ux/adp-tooling';
 import type { UI5FlexLayer } from '@sap-ux/project-access';
+/**
+ * Intent object consisting of an object and an action.
+ */
 interface Intent {
     object: string;
     action: string;

package/dist/ui5/middleware.js

@@ -24,8 +24,8 @@ function initAdp(rootProject, config, flp, logger) {
     return __awaiter(this, void 0, void 0, function* () {
         const files = yield rootProject.byGlob('/manifest.appdescr_variant');
         if (files.length === 1) {
-            const adp = new adp_tooling_1.AdpPreview(config, logger);
-            const layer = yield adp.init(JSON.parse(yield files[0].getString()), yield rootProject.byGlob('**/*.*'));
+            const adp = new adp_tooling_1.AdpPreview(config, rootProject, logger);
+            const layer = yield adp.init(JSON.parse(yield files[0].getString()));
             flp.config.rta = { layer };
             yield flp.init(adp.descriptor.manifest, adp.descriptor.name, adp.resources);
             flp.router.use(adp.descriptor.url, adp.proxy.bind(adp));

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.3.0",
+  "version": "0.3.1",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -24,7 +24,7 @@
   "dependencies": {
     "ejs": "3.1.7",
     "@sap-ux/logger": "0.3.7",
-    "@sap-ux/adp-tooling": "0.1.0"
+    "@sap-ux/adp-tooling": "0.1.1"
   },
   "devDependencies": {
     "@types/ejs": "3.1.0",