@sap-ux/ui5-proxy-middleware 1.4.5 → 1.4.6

package/README.md

@@ -76,7 +76,7 @@ server:
 ### Loading UI5 sources directly from UI5 CDN
 If you don't load all UI5 source through the `ui5-proxy-middleware`, then you can set `directLoad: true`. This will inject the absolute UI5 URL in the bootstrap of your HTML file, thus loading the libraries directly from UI5 CDN.
 
-**NOTE: this works only for the default HTML files created by the [Fiori generator](https://www.npmjs.com/package/@sap/generator-fiori) when a project is generated. Hence index.html, flpSandbox.html and flpSandboxMockServer.html!**
+**NOTE: this does not work with virtualized html files provided by the `preview-middleware`. In that case, call `npx @sap-ux/create add html` to generate a physical copy of the virtualized files.**
 
 ```Yaml
 server:

package/dist/base/constants.d.ts

@@ -1,4 +1,3 @@
-export declare const HTML_MOUNT_PATHS: string[];
 export declare const BOOTSTRAP_LINK = "resources/sap-ui-core.js";
 export declare const BOOTSTRAP_REPLACE_REGEX: RegExp;
 export declare const SANDBOX_LINK = "test-resources/sap/ushell/bootstrap/sandbox.js";

package/dist/base/constants.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SANDBOX_REPLACE_REGEX = exports.SANDBOX_LINK = exports.BOOTSTRAP_REPLACE_REGEX = exports.BOOTSTRAP_LINK = exports.HTML_MOUNT_PATHS = void 0;
-exports.HTML_MOUNT_PATHS = ['/index.html', '/**/flpSandbox.html', '/**/flpSandboxMockServer.html'];
+exports.SANDBOX_REPLACE_REGEX = exports.SANDBOX_LINK = exports.BOOTSTRAP_REPLACE_REGEX = exports.BOOTSTRAP_LINK = void 0;
 exports.BOOTSTRAP_LINK = 'resources/sap-ui-core.js';
 exports.BOOTSTRAP_REPLACE_REGEX = /src="[.{0,2}\/]*resources\/sap-ui-core\.js"/;
 exports.SANDBOX_LINK = 'test-resources/sap/ushell/bootstrap/sandbox.js';

package/dist/base/utils.d.ts

@@ -1,3 +1,4 @@
+/// <reference path="../../../../types/ui5.d.ts" />
 /// <reference types="node" />
 /// <reference types="node" />
 import type { ClientRequest, IncomingMessage, ServerResponse } from 'http';
@@ -6,6 +7,7 @@ import { type Manifest } from '@sap-ux/project-access';
 import type { NextFunction, Request, Response } from 'express';
 import type { ProxyConfig } from './types';
 import type { Url } from 'url';
+import type { ReaderCollection } from '@ui5/fs';
 /**
  * Handler for the proxy response event.
  * Sets an Etag which will be used for re-validation of the cached UI5 sources.
@@ -85,11 +87,11 @@ export declare function resolveUI5Version(version?: string, log?: ToolsLogger, m
 /**
  * Injects the absolute UI5 urls into the html file, which is used to preview the application.
  *
- * @param htmlFilePath - path to the html file which is used for previwing the application
+ * @param originalHtml - the content of the html file
  * @param ui5Configs - the configuration of the ui5-proxy-middleware
  * @returns The modified html file content
  */
-export declare function injectUI5Url(htmlFilePath: string, ui5Configs: ProxyConfig[]): string | undefined;
+export declare function injectUI5Url(originalHtml: string, ui5Configs: ProxyConfig[]): string;
 /**
  * Injects scripts into the html file, which is used to preview the application.
  *
@@ -97,8 +99,9 @@ export declare function injectUI5Url(htmlFilePath: string, ui5Configs: ProxyConf
  * @param res - the http response object
  * @param next - the next function, used to forward the request to the next available handler
  * @param ui5Configs - the UI5 configuration of the ui5-proxy-middleware
+ * @param rootProject - the root project
  */
-export declare const injectScripts: (req: Request, res: Response, next: NextFunction, ui5Configs: ProxyConfig[]) => Promise<void>;
+export declare const injectScripts: (req: Request, res: Response, next: NextFunction, ui5Configs: ProxyConfig[], rootProject: ReaderCollection) => Promise<void>;
 /**
  * Filters comressed html files from UI5 CDN.
  * Avoid ERR_CONTENT_DECODING_FAILED on http request for gzip'd html files.

package/dist/base/utils.js

@@ -4,7 +4,6 @@ exports.proxyErrorHandler = exports.filterCompressedHtmlFiles = exports.injectSc
 const project_access_1 = require("@sap-ux/project-access");
 const ui5_config_1 = require("@sap-ux/ui5-config");
 const fs_1 = require("fs");
-const path_1 = require("path");
 const constants_1 = require("./constants");
 const i18n_1 = require("../i18n");
 /**
@@ -213,30 +212,25 @@ exports.resolveUI5Version = resolveUI5Version;
 /**
  * Injects the absolute UI5 urls into the html file, which is used to preview the application.
  *
- * @param htmlFilePath - path to the html file which is used for previwing the application
+ * @param originalHtml - the content of the html file
  * @param ui5Configs - the configuration of the ui5-proxy-middleware
  * @returns The modified html file content
  */
-function injectUI5Url(htmlFilePath, ui5Configs) {
-    if ((0, fs_1.existsSync)(htmlFilePath)) {
-        let html = (0, fs_1.readFileSync)(htmlFilePath, { encoding: 'utf8' });
-        for (const ui5Config of ui5Configs) {
-            const ui5Host = ui5Config.url.replace(/\/$/, '');
-            const ui5Url = ui5Config.version ? `${ui5Host}/${ui5Config.version}` : ui5Host;
-            if (ui5Config.path === '/resources') {
-                const resourcesUrl = `src="${ui5Url}/${constants_1.BOOTSTRAP_LINK}"`;
-                html = html.replace(constants_1.BOOTSTRAP_REPLACE_REGEX, resourcesUrl);
-            }
-            if (ui5Config.path === '/test-resources') {
-                const testResourcesUrl = `src="${ui5Url}/${constants_1.SANDBOX_LINK}"`;
-                html = html.replace(constants_1.SANDBOX_REPLACE_REGEX, testResourcesUrl);
-            }
+function injectUI5Url(originalHtml, ui5Configs) {
+    let html = originalHtml;
+    for (const ui5Config of ui5Configs) {
+        const ui5Host = ui5Config.url.replace(/\/$/, '');
+        const ui5Url = ui5Config.version ? `${ui5Host}/${ui5Config.version}` : ui5Host;
+        if (ui5Config.path === '/resources') {
+            const resourcesUrl = `src="${ui5Url}/${constants_1.BOOTSTRAP_LINK}"`;
+            html = html.replace(constants_1.BOOTSTRAP_REPLACE_REGEX, resourcesUrl);
+        }
+        if (ui5Config.path === '/test-resources') {
+            const testResourcesUrl = `src="${ui5Url}/${constants_1.SANDBOX_LINK}"`;
+            html = html.replace(constants_1.SANDBOX_REPLACE_REGEX, testResourcesUrl);
         }
-        return html;
-    }
-    else {
-        return undefined;
     }
+    return html;
 }
 exports.injectUI5Url = injectUI5Url;
 /**
@@ -246,22 +240,19 @@ exports.injectUI5Url = injectUI5Url;
  * @param res - the http response object
  * @param next - the next function, used to forward the request to the next available handler
  * @param ui5Configs - the UI5 configuration of the ui5-proxy-middleware
+ * @param rootProject - the root project
  */
-const injectScripts = async (req, res, next, ui5Configs) => {
+const injectScripts = async (req, res, next, ui5Configs, rootProject) => {
     try {
-        const projectRoot = process.cwd();
-        const args = process.argv;
-        const htmlFileName = (0, exports.getHtmlFile)(req.baseUrl);
-        const yamlFileName = (0, exports.getYamlFile)(args);
-        const ui5YamlPath = (0, path_1.join)(projectRoot, yamlFileName);
-        const webAppFolder = await (0, exports.getWebAppFolderFromYaml)(ui5YamlPath);
-        const htmlFilePath = (0, path_1.join)(projectRoot, webAppFolder, htmlFileName);
-        const html = injectUI5Url(htmlFilePath, ui5Configs);
-        if (html) {
-            (0, exports.setHtmlResponse)(res, html);
+        const htmlFileName = (0, exports.getHtmlFile)(req.url);
+        const files = await rootProject.byGlob(`**/${htmlFileName}`);
+        if (files.length === 0) {
+            next();
         }
         else {
-            next();
+            const originalHtml = await files[0].getString();
+            const html = injectUI5Url(originalHtml, ui5Configs);
+            (0, exports.setHtmlResponse)(res, html);
         }
     }
     catch (error) {

package/dist/ui5/middleware.js

@@ -96,16 +96,14 @@ module.exports = async ({ resources, options }) => {
     if (directLoad) {
         const directLoadProxy = (async (req, res, next) => {
             try {
-                await (0, base_1.injectScripts)(req, res, next, ui5Configs);
+                await (0, base_1.injectScripts)(req, res, next, ui5Configs, resources.rootProject);
             }
             catch (error) {
                 logger.error(error);
                 next(error);
             }
         });
-        base_1.HTML_MOUNT_PATHS.forEach((path) => {
-            routes.push({ route: path, handler: directLoadProxy });
-        });
+        routes.push({ route: '*.html', handler: directLoadProxy });
     }
     return createRequestHandler(routes);
 };

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%3Aui5-proxy-middleware"
   },
-  "version": "1.4.5",
+  "version": "1.4.6",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -26,8 +26,8 @@
     "https-proxy-agent": "5.0.1",
     "i18next": "20.6.1",
     "proxy-from-env": "1.1.0",
-    "@sap-ux/logger": "0.6.0",
-    "@sap-ux/ui5-config": "0.24.1"
+    "@sap-ux/ui5-config": "0.24.1",
+    "@sap-ux/logger": "0.6.0"
   },
   "devDependencies": {
     "@types/express": "4.17.21",
@@ -37,7 +37,7 @@
     "nock": "13.4.0",
     "supertest": "6.3.3",
     "yaml": "2.2.2",
-    "@sap-ux/project-access": "1.26.9"
+    "@sap-ux/project-access": "1.27.1"
   },
   "ui5": {
     "dependencies": []