@sap-ux/ui5-proxy-middleware 1.4.20 → 1.4.22

package/dist/base/utils.d.ts

@@ -1,7 +1,8 @@
 import type { ClientRequest, IncomingMessage, ServerResponse } from 'http';
 import type { ToolsLogger } from '@sap-ux/logger';
 import { type Manifest } from '@sap-ux/project-access';
-import type { NextFunction, Request, Response } from 'express';
+import type { RequestHandler, NextFunction, Request, Response } from 'express';
+import type http from 'http';
 import type { ProxyConfig } from './types';
 import type { Url } from 'url';
 import type { ReaderCollection } from '@ui5/fs';
@@ -67,11 +68,14 @@ export declare const getYamlFile: (args: string[]) => string;
 export declare const getWebAppFolderFromYaml: (ui5YamlPath: string) => Promise<string>;
 /**
  * Sends HTML content as a response.
+ * Ensure compliance with common APIs in express and connect.
  *
  * @param res - The http response object
  * @param html - The HTML content
  */
-export declare const setHtmlResponse: (res: any, html: string) => void;
+export declare const sendResponse: (res: (Response | http.ServerResponse) & {
+    _livereload?: boolean;
+}, html: string) => void;
 /**
  * Determines which UI5 version to use when previewing the application.
  *
@@ -124,4 +128,13 @@ export declare function proxyErrorHandler(err: Error & {
     next?: Function;
     originalUrl?: string;
 }, logger: ToolsLogger, _res?: ServerResponse, _target?: string | Partial<Url>): void;
+/**
+ * Adjust UI5 bootstrap URLs to load directly from UI5 CDN.
+ *
+ * @param ui5Configs the UI5 configuration of the ui5-proxy-middleware
+ * @param rootProject the project root
+ * @param logger logger to be used when running the middleware
+ * @returns RequestHandler to adjust bootstraps
+ */
+export declare function directLoadProxy(ui5Configs: ProxyConfig[], rootProject: ReaderCollection, logger: ToolsLogger): RequestHandler;
 //# sourceMappingURL=utils.d.ts.map

package/dist/base/utils.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.filterCompressedHtmlFiles = exports.injectScripts = exports.setHtmlResponse = exports.getWebAppFolderFromYaml = exports.getYamlFile = exports.getHtmlFile = exports.hideProxyCredentials = exports.getCorporateProxyServer = exports.proxyRequestHandler = exports.proxyResponseHandler = void 0;
+exports.filterCompressedHtmlFiles = exports.injectScripts = exports.sendResponse = exports.getWebAppFolderFromYaml = exports.getYamlFile = exports.getHtmlFile = exports.hideProxyCredentials = exports.getCorporateProxyServer = exports.proxyRequestHandler = exports.proxyResponseHandler = void 0;
 exports.updateProxyEnv = updateProxyEnv;
 exports.resolveUI5Version = resolveUI5Version;
 exports.injectUI5Url = injectUI5Url;
 exports.proxyErrorHandler = proxyErrorHandler;
+exports.directLoadProxy = directLoadProxy;
 const project_access_1 = require("@sap-ux/project-access");
 const ui5_config_1 = require("@sap-ux/ui5-config");
 const fs_1 = require("fs");
@@ -163,11 +164,12 @@ const getWebAppFolderFromYaml = async (ui5YamlPath) => {
 exports.getWebAppFolderFromYaml = getWebAppFolderFromYaml;
 /**
  * Sends HTML content as a response.
+ * Ensure compliance with common APIs in express and connect.
  *
  * @param res - The http response object
  * @param html - The HTML content
  */
-const setHtmlResponse = (res, html) => {
+const sendResponse = (res, html) => {
     if (res['_livereload']) {
         res.write(html);
         res.end();
@@ -180,7 +182,7 @@ const setHtmlResponse = (res, html) => {
         res.end();
     }
 };
-exports.setHtmlResponse = setHtmlResponse;
+exports.sendResponse = sendResponse;
 /**
  * Determines which UI5 version to use when previewing the application.
  *
@@ -259,7 +261,7 @@ const injectScripts = async (req, res, next, ui5Configs, rootProject) => {
         else {
             const originalHtml = await files[0].getString();
             const html = injectUI5Url(originalHtml, ui5Configs);
-            (0, exports.setHtmlResponse)(res, html);
+            (0, exports.sendResponse)(res, html);
         }
     }
     catch (error) {
@@ -307,4 +309,23 @@ function proxyErrorHandler(err, req, logger, _res, _target) {
         logger.debug((0, i18n_1.t)('error.noCodeError', { error: JSON.stringify(err, null, 2), request: req.originalUrl }));
     }
 }
+/**
+ * Adjust UI5 bootstrap URLs to load directly from UI5 CDN.
+ *
+ * @param ui5Configs the UI5 configuration of the ui5-proxy-middleware
+ * @param rootProject the project root
+ * @param logger logger to be used when running the middleware
+ * @returns RequestHandler to adjust bootstraps
+ */
+function directLoadProxy(ui5Configs, rootProject, logger) {
+    return async (req, res, next) => {
+        try {
+            await (0, exports.injectScripts)(req, res, next, ui5Configs, rootProject);
+        }
+        catch (error) {
+            logger.error(error);
+            next(error);
+        }
+    };
+}
 //# sourceMappingURL=utils.js.map

package/dist/index.d.ts

@@ -1,2 +1,2 @@
-export { ui5Proxy } from './base';
+export { ui5Proxy, directLoadProxy } from './base';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ui5Proxy = void 0;
+exports.directLoadProxy = exports.ui5Proxy = void 0;
 var base_1 = require("./base");
 Object.defineProperty(exports, "ui5Proxy", { enumerable: true, get: function () { return base_1.ui5Proxy; } });
+Object.defineProperty(exports, "directLoadProxy", { enumerable: true, get: function () { return base_1.directLoadProxy; } });
 //# sourceMappingURL=index.js.map

package/dist/ui5/middleware.js

@@ -94,16 +94,7 @@ module.exports = async ({ resources, options }) => {
         }
     }
     if (directLoad) {
-        const directLoadProxy = (async (req, res, next) => {
-            try {
-                await (0, base_1.injectScripts)(req, res, next, ui5Configs, resources.rootProject);
-            }
-            catch (error) {
-                logger.error(error);
-                next(error);
-            }
-        });
-        routes.push({ route: '*.html', handler: directLoadProxy });
+        routes.push({ route: '*.html', handler: (0, base_1.directLoadProxy)(ui5Configs, resources.rootProject, logger) });
     }
     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.20",
+  "version": "1.4.22",
   "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.26.5"
+    "@sap-ux/ui5-config": "0.26.5",
+    "@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.29.17"
+    "@sap-ux/project-access": "1.29.18"
   },
   "ui5": {
     "dependencies": []