@sap-ux/ui5-application-writer 1.2.1 → 1.2.2

package/dist/index.d.ts

@@ -29,4 +29,5 @@ declare function isTypescriptEnabled(basePath: string, fs?: Editor): Promise<boo
 declare function enableTypescript(basePath: string, fs?: Editor): Promise<Editor>;
 export { Ui5App, generate, enableTypescript, isTypescriptEnabled };
 export { App, Package, UI5, AppOptions };
+export { compareUI5VersionGte, ui5LtsVersion_1_120, ui5LtsVersion_1_71, processDestinationPath, getTemplateVersionPath } from './utils';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTemplateVersionPath = exports.processDestinationPath = exports.ui5LtsVersion_1_71 = exports.ui5LtsVersion_1_120 = exports.compareUI5VersionGte = void 0;
 exports.generate = generate;
 exports.enableTypescript = enableTypescript;
 exports.isTypescriptEnabled = isTypescriptEnabled;
@@ -135,4 +136,10 @@ async function enableTypescript(basePath, fs) {
     fs.write(ui5ConfigPath, ui5Config.toString());
     return fs;
 }
+var utils_1 = require("./utils");
+Object.defineProperty(exports, "compareUI5VersionGte", { enumerable: true, get: function () { return utils_1.compareUI5VersionGte; } });
+Object.defineProperty(exports, "ui5LtsVersion_1_120", { enumerable: true, get: function () { return utils_1.ui5LtsVersion_1_120; } });
+Object.defineProperty(exports, "ui5LtsVersion_1_71", { enumerable: true, get: function () { return utils_1.ui5LtsVersion_1_71; } });
+Object.defineProperty(exports, "processDestinationPath", { enumerable: true, get: function () { return utils_1.processDestinationPath; } });
+Object.defineProperty(exports, "getTemplateVersionPath", { enumerable: true, get: function () { return utils_1.getTemplateVersionPath; } });
 //# sourceMappingURL=index.js.map

package/dist/options.d.ts

@@ -1,5 +1,5 @@
 import type { Editor } from 'mem-fs-editor';
-import type { Ui5App } from './types';
+import type { UI5, Ui5App } from './types';
 import type { UI5Config } from '@sap-ux/ui5-config';
 import type { ProjectType } from '@sap-ux/project-access';
 /**
@@ -12,6 +12,7 @@ export interface FeatureInput {
             baseComponent?: string;
             projectType?: ProjectType;
         };
+        ui5?: Partial<UI5>;
     };
     fs: Editor;
     basePath: string;

package/dist/options.js

@@ -9,6 +9,7 @@ const ejs_1 = require("ejs");
 const project_access_1 = require("@sap-ux/project-access");
 const ui5Libs_1 = require("./data/ui5Libs");
 const ui5_config_1 = require("@sap-ux/ui5-config");
+const utils_1 = require("./utils");
 /**
  * Copy all template files into the target project.
  *
@@ -20,7 +21,11 @@ const ui5_config_1 = require("@sap-ux/ui5-config");
  * @param input.tmplPath template basepath
  */
 async function copyTemplates(name, { ui5App, fs, basePath, tmplPath }) {
-    const optTmplDirPath = (0, path_1.join)(tmplPath, 'optional', `${name}`);
+    let optTmplDirPath = (0, path_1.join)(tmplPath, 'optional', `${name}`);
+    const optionPath = (0, utils_1.getTemplateVersionPath)(ui5App.ui5);
+    if (name === 'loadReuseLibs') {
+        optTmplDirPath = (0, path_1.join)(optTmplDirPath, optionPath);
+    }
     const optTmplFilePaths = await (0, project_access_1.getFilePaths)(optTmplDirPath);
     optTmplFilePaths.forEach((optTmplFilePath) => {
         const relPath = optTmplFilePath.replace(optTmplDirPath, '');
@@ -28,7 +33,8 @@ async function copyTemplates(name, { ui5App, fs, basePath, tmplPath }) {
         // Extend or add
         if (!fs.exists(outPath)) {
             fs.copyTpl(optTmplFilePath, outPath, ui5App, undefined, {
-                globOptions: { dot: true }
+                globOptions: { dot: true },
+                processDestinationPath: utils_1.processDestinationPath
             });
         }
         else {

package/dist/utils.d.ts

@@ -0,0 +1,26 @@
+import { type UI5 } from './types';
+export declare const ui5LtsVersion_1_71 = "1.71.0";
+export declare const ui5LtsVersion_1_120 = "1.120.0";
+/**
+ * Compares two UI5 versions to determine if the first is greater than or equal to the second.
+ *
+ * @param {string} ui5VersionA - The first UI5 version to compare.
+ * @param {string} ui5VersionB - The second UI5 version to compare.
+ * @returns {boolean} - True if the first version is greater than or equal to the second, false otherwise.
+ */
+export declare function compareUI5VersionGte(ui5VersionA: string, ui5VersionB: string): boolean;
+/**
+ * Gets the template version path based on the UI5 version and template type.
+ *
+ * @param {UI5} ui5 - The UI5 configuration.
+ * @returns {string} - The template version path.
+ */
+export declare function getTemplateVersionPath(ui5: UI5): string;
+/**
+ * Processes the destination path by removing specific version segments.
+ *
+ * @param {string} filePath - The file path to process.
+ * @returns {string} - The processed file path.
+ */
+export declare function processDestinationPath(filePath: string): string;
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ui5LtsVersion_1_120 = exports.ui5LtsVersion_1_71 = void 0;
+exports.compareUI5VersionGte = compareUI5VersionGte;
+exports.getTemplateVersionPath = getTemplateVersionPath;
+exports.processDestinationPath = processDestinationPath;
+const semver_1 = require("semver");
+exports.ui5LtsVersion_1_71 = '1.71.0';
+exports.ui5LtsVersion_1_120 = '1.120.0';
+/**
+ * Compares two UI5 versions to determine if the first is greater than or equal to the second.
+ *
+ * @param {string} ui5VersionA - The first UI5 version to compare.
+ * @param {string} ui5VersionB - The second UI5 version to compare.
+ * @returns {boolean} - True if the first version is greater than or equal to the second, false otherwise.
+ */
+function compareUI5VersionGte(ui5VersionA, ui5VersionB) {
+    if (ui5VersionA === '') {
+        // latest version
+        return true;
+    }
+    else {
+        return (0, semver_1.gte)(ui5VersionA, ui5VersionB, { loose: true });
+    }
+}
+/**
+ * Gets the template version path based on the UI5 version and template type.
+ *
+ * @param {UI5} ui5 - The UI5 configuration.
+ * @returns {string} - The template version path.
+ */
+function getTemplateVersionPath(ui5) {
+    let templateVersionPath = '';
+    const ui5Version = ui5?.minUI5Version ?? ui5?.version ?? '';
+    if (ui5Version && compareUI5VersionGte(ui5Version, exports.ui5LtsVersion_1_120)) {
+        templateVersionPath = exports.ui5LtsVersion_1_120;
+    }
+    else {
+        templateVersionPath = exports.ui5LtsVersion_1_71;
+    }
+    return templateVersionPath;
+}
+/**
+ * Processes the destination path by removing specific version segments.
+ *
+ * @param {string} filePath - The file path to process.
+ * @returns {string} - The processed file path.
+ */
+function processDestinationPath(filePath) {
+    return filePath.replace('/1.120.0', '').replace('/1.71.0', '');
+}
+//# sourceMappingURL=utils.js.map

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-application-writer"
   },
-  "version": "1.2.1",
+  "version": "1.2.2",
   "license": "Apache-2.0",
   "main": "dist/index.js",
   "files": [
@@ -38,7 +38,7 @@
     "@types/semver": "7.5.2",
     "fs-extra": "10.0.0",
     "@sap-ux/eslint-plugin-fiori-tools": "0.5.0",
-    "@sap-ux/project-access": "1.28.2"
+    "@sap-ux/project-access": "1.28.4"
   },
   "engines": {
     "node": ">=18.x"

package/templates/optional/loadReuseLibs/1.120.0/webapp/test/locate-reuse-libs.js

@@ -0,0 +1,267 @@
+(function (sap) {
+    var fioriToolsGetManifestLibs = function (manifestPath) {
+        var url = manifestPath;
+        var result = "";
+        // SAPUI5 delivered namespaces from https://ui5.sap.com/#/api/sap
+        var ui5Libs = [
+            "sap.apf",
+            "sap.base",
+            "sap.chart",
+            "sap.collaboration",
+            "sap.f",
+            "sap.fe",
+            "sap.fileviewer",
+            "sap.gantt",
+            "sap.landvisz",
+            "sap.m",
+            "sap.ndc",
+            "sap.ovp",
+            "sap.rules",
+            "sap.suite",
+            "sap.tnt",
+            "sap.ui",
+            "sap.uiext",
+            "sap.ushell",
+            "sap.uxap",
+            "sap.viz",
+            "sap.webanalytics",
+            "sap.zen"
+        ];
+        var getKeys = function (libOrComp, libOrCompKeysString) {
+            var libOrCompKeysStringTmp = libOrCompKeysString;
+            Object.keys(libOrComp).forEach(function (libOrCompKey) {
+                // ignore libs or Components that start with SAPUI5 delivered namespaces
+                if (!ui5Libs.some(function (substring) { return libOrCompKey === substring || libOrCompKey.startsWith(substring + "."); })) {
+                    if (libOrCompKeysStringTmp.length > 0) {
+                        libOrCompKeysStringTmp = libOrCompKeysStringTmp + "," + libOrCompKey;
+                    } else {
+                        libOrCompKeysStringTmp = libOrCompKey;
+                    }
+                }
+            });
+            return libOrCompKeysStringTmp;
+        }
+        var getComponentUsageNames = function (compUsages, libOrCompKeysString) {
+            var libOrCompKeysStringTmp = libOrCompKeysString;
+            var compNames = Object.keys(compUsages).map(function (compUsageKey) {
+                return compUsages[compUsageKey].name;
+            });
+            compNames.forEach(function (compName) {
+                // ignore libs or Components that start with SAPUI5 delivered namespaces
+                if (!ui5Libs.some(function (substring) { return compName === substring || compName.startsWith(substring + "."); })) {
+                    if (libOrCompKeysStringTmp.length > 0) {
+                        libOrCompKeysStringTmp = libOrCompKeysStringTmp + "," + compName;
+                    } else {
+                        libOrCompKeysStringTmp = compName;
+                    }
+                }
+            });
+            return libOrCompKeysStringTmp;
+        }
+        return new Promise(function (resolve, reject) {
+
+            sap.ui.require(["sap/ui/thirdparty/jquery"], function (localJQuery) {  
+                localJQuery.ajax(url)
+                    .done(function (manifest) {
+                        if (manifest) {
+                            if (
+                                manifest["sap.ui5"] &&
+                                manifest["sap.ui5"].dependencies
+                            ) {
+                                if (manifest["sap.ui5"].dependencies.libs) {
+                                    result = getKeys(manifest["sap.ui5"].dependencies.libs, result);
+                                }
+                                if (manifest["sap.ui5"].dependencies.components) {
+                                    result = getKeys(manifest["sap.ui5"].dependencies.components, result);
+                                }
+                            }
+                            if (
+                                manifest["sap.ui5"] &&
+                                manifest["sap.ui5"].componentUsages
+                            ) {
+                                result = getComponentUsageNames(manifest["sap.ui5"].componentUsages, result);
+                            }
+                        }
+                        resolve(result);
+                    })
+                    .fail(function () {
+                        reject(new Error("Could not fetch manifest at '" + manifestPath));
+                    });
+            });
+        });
+    };
+    var registerModules = function (dataFromAppIndex) {
+        Object.keys(dataFromAppIndex).forEach(function (moduleDefinitionKey) {
+            var moduleDefinition = dataFromAppIndex[moduleDefinitionKey];
+            if (moduleDefinition && moduleDefinition.dependencies) {
+                moduleDefinition.dependencies.forEach(function (dependency) {
+                    if (dependency.url && dependency.url.length > 0 && dependency.type === "UI5LIB") {
+                        sap.ui.require(["sap/base/Log"], function (Log) {
+                            Log.info("Registering Library " +
+                                dependency.componentId +
+                                " from server " +
+                                dependency.url);
+                        });
+                        var compId = dependency.componentId.replace(/\./g, "/");
+                        var config = {
+                            paths: {
+                            }
+                        };
+                        config.paths[compId] = dependency.url;
+                        sap.ui.loader.config(config);
+                    }
+                });
+            }
+        });
+    }
+    /**
+     * Registers the module paths for dependencies of the given component.
+     * @param {string} manifestPath The the path to the app manifest path
+     * for which the dependencies should be registered.
+     * @returns {Promise} A promise which is resolved when the ajax request for
+     * the app-index was successful and the module paths were registered.
+     */
+    var registerComponentDependencyPaths = function (manifestPath) {
+
+        return fioriToolsGetManifestLibs(manifestPath).then(function (libs) {
+            if (libs && libs.length > 0) {
+                var url = "/sap/bc/ui2/app_index/ui5_app_info?id=" + libs;
+                var sapClient = "";
+
+                return new Promise(
+                    function (resolve) {
+                        sapClient = new URLSearchParams(window.location.search).get("sap-client");
+                        if (sapClient && sapClient.length === 3) {
+                            url = url + "&sap-client=" + sapClient;
+                        }
+                        resolve(url);
+                    }).then(function (url2) {
+                        sap.ui.require(["sap/ui/thirdparty/jquery"], function (localJQuery) {  
+                            return localJQuery.ajax(url2)
+                                .done(function (data) {
+                                    if (data) {
+                                        registerModules(data);
+                                    }
+                                });
+                        });
+                    });
+            } else {
+                return undefined;
+            }
+        });
+    };
+
+    var registerSAPFonts = function () {  
+        sap.ui.require(["sap/ui/core/IconPool"], function (IconPool) {  
+        //Fiori Theme font family and URI
+        var fioriTheme = {
+            fontFamily: "SAP-icons-TNT",
+            fontURI: sap.ui.require.toUrl("sap/tnt/themes/base/fonts/")
+        };
+        //Registering to the icon pool
+        IconPool.registerFont(fioriTheme);
+        //SAP Business Suite Theme font family and URI
+        var bSuiteTheme = {
+            fontFamily: "BusinessSuiteInAppSymbols",
+            fontURI: sap.ui.require.toUrl("sap/ushell/themes/base/fonts/")
+        };
+        //Registering to the icon pool
+        IconPool.registerFont(bSuiteTheme);
+        });
+    }
+    
+    /*eslint-disable fiori-custom/sap-browser-api-warning, fiori-custom/sap-no-dom-access*/
+    var currentScript = document.getElementById("locate-reuse-libs");
+    if (!currentScript) {
+        currentScript = document.currentScript;
+    }
+    var manifestUri = currentScript.getAttribute("data-sap-ui-manifest-uri");
+    var componentName = currentScript.getAttribute("data-sap-ui-componentName");
+    var useMockserver = currentScript.getAttribute("data-sap-ui-use-mockserver");
+    
+    // Patch (KW): resourceRoot is needed to load the correct ResourceBundles
+    var resourceRoot = manifestUri.substring(0, manifestUri.lastIndexOf('/')+1);
+    
+    
+    return registerComponentDependencyPaths(manifestUri)
+        .catch(function (error) {
+            sap.ui.require(["sap/base/Log"], function (Log) {
+                Log.error(error);
+            });
+        })
+        .finally(function () {
+    
+            // setting the app title with internationalization 
+            sap.ui.require(["sap/ui/core/Core"], async function(Core) {
+                Core.ready(() => {
+                   sap.ui.require(["sap/base/i18n/Localization"], function (Localization) {
+                        sap.ui.require(["sap/base/i18n/ResourceBundle"], function (ResourceBundle) {
+                            var oResourceBundle = ResourceBundle.create({
+                                // Patch (KW): resourceRoot is needed to load the correct ResourceBundles
+                                url: resourceRoot + "i18n/i18n.properties",
+                                locale: Localization.getLanguage()
+                            });
+                            document.title = oResourceBundle.getText("appTitle");
+                        });
+                    });
+                });
+            });        
+    
+           if (componentName && componentName.length > 0) {
+                if (useMockserver && useMockserver === "true") {
+                    sap.ui.require(["sap/ui/core/Core"], async function(Core) {
+                        Core.ready(() => {
+                            registerSAPFonts();
+                            sap.ui.require([componentName.replace(/\./g, "/") + "/localService/mockserver"], function (server) {
+                                // set up test service for local testing
+                                server.init();
+                                // initialize the ushell sandbox component
+                                sap.ui.require(["sap/ushell/Container"], async function (Container) {
+                                    Container.createRenderer(true).then(function (component) {
+                                        component.placeAt("content");
+                                    });
+                                });
+                            });
+                        });        
+                    });
+                } else {
+                    // Requiring the ComponentSupport module automatically executes the component initialisation for all declaratively defined components
+                    sap.ui.require(["sap/ui/core/ComponentSupport"]);
+    
+                    // setting the app title with the i18n text 
+                    sap.ui.require(["sap/ui/core/Core"], async function(Core) {
+                        Core.ready(() => {
+                            registerSAPFonts();
+                            sap.ui.require(["sap/base/i18n/Localization"], function (Localization) {
+                                sap.ui.require(["sap/base/i18n/ResourceBundle"], function (ResourceBundle) {
+                                    var oResourceBundle = ResourceBundle.create({
+                                        // Patch (KW): resourceRoot is needed to load the correct ResourceBundles
+                                        url: resourceRoot + "i18n/i18n.properties",
+                                        locale: Localization.getLanguage()
+                                    });
+                                    document.title = oResourceBundle.getText("appTitle");
+                                });
+                            });
+                        });
+                    });        
+                }
+            } else {
+                sap.ui.require(["sap/ui/core/Core"], async function(Core) {
+                    Core.ready(() => {
+                        registerSAPFonts();
+                        // initialize the ushell sandbox component
+                        sap.ui.require(["sap/ushell/Container"], async function (Container) {
+                            try {
+                            Container.createRenderer(true).then(function (component) {
+                                component.placeAt("content");
+                            });
+                            } catch (error) {
+                                // support older versions of ui5 
+                                Container.createRenderer().placeAt("content");
+                            }
+                        });
+                    });
+                });
+            }
+        });
+})(sap);