@sap-ux/ui5-application-writer 1.1.4 → 1.1.6

package/dist/data/defaults.js

@@ -90,6 +90,9 @@ function mergeUi5(ui5, options) {
         ui5.typesVersion ?? (options?.typescript ? ui5_config_1.getEsmTypesVersion : ui5_config_1.getTypesVersion)(merged.minUI5Version);
     merged.typesPackage = (0, ui5_config_1.getTypesPackage)(merged.typesVersion);
     merged.ui5Theme = ui5.ui5Theme ?? 'sap_fiori_3';
+    if (ui5.manifestLibs && ui5.manifestLibs.length > 0) {
+        merged.manifestLibs = (0, ui5Libs_1.getUI5Libs)(ui5.manifestLibs);
+    }
     merged.ui5Libs = (0, ui5Libs_1.getUI5Libs)(ui5.ui5Libs);
     return Object.assign({}, ui5, merged);
 }

package/dist/index.js

@@ -53,15 +53,10 @@ async function generate(basePath, ui5AppConfig, fs) {
         }
     });
     ui5Config.addFioriToolsAppReloadMiddleware();
-    // ui5-local.yaml
     if (isEdmxProjectType) {
         const ui5LocalConfigPath = (0, path_1.join)(basePath, 'ui5-local.yaml');
         // write ui5-local.yaml only for non-CAP applications
         const ui5LocalConfig = await ui5_config_1.UI5Config.newInstance(fs.read(ui5LocalConfigPath));
-        // default UI5 lib
-        if (!ui5App.ui5.ui5Libs.includes('sap.ushell')) {
-            ui5App.ui5.ui5Libs.push('sap.ushell');
-        }
         ui5LocalConfig.addUI5Framework(ui5App.ui5.framework, ui5App.ui5.localVersion, ui5App.ui5.ui5Libs, ui5App.ui5.ui5Theme);
         ui5LocalConfig.addFioriToolsAppReloadMiddleware();
         // Add optional features

package/dist/types.d.ts

@@ -49,17 +49,95 @@ export interface App {
     };
 }
 export type UI5Framework = 'SAPUI5' | 'OpenUI5';
+/**
+ * Configuration for a UI5 project.
+ */
 export interface UI5 {
+    /**
+     * The UI5 framework being used (e.g. OpenUI5, SAPUI5)
+     */
     framework: UI5Framework;
+    /**
+     * URL for UI5 framework.
+     */
     frameworkUrl: string;
+    /**
+     * The minimum required UI5 version for the project.
+     */
     minUI5Version: string;
+    /**
+     * The specific version of the UI5 framework being used in the project.
+     */
     version: string;
+    /**
+     * Local version of the UI5 application.
+     */
     localVersion: string;
+    /**
+     * Types version for UI5.
+     */
     typesVersion: string;
+    /**
+     * UI5 types package name.
+     */
     typesPackage: string;
+    /**
+     * The manifest descriptor version.
+     */
     descriptorVersion: string;
+    /**
+     * The UI5 libraries that are added as part of the project. (e.g. manifest.json, ui5-local.yaml, flpSandbox.html)
+     *
+     * ui5-local.yaml:
+     *
+     * @example
+     * ```yaml
+     * libraries:
+     *      -name: sap.m
+     *      -name: sap.ui.core
+     *      -name: sap.ushell
+     *      -name: sap.fe.templates
+     *```
+     * flpSandbox.html:
+     * @example
+     * ```HTML
+     * <script id="sap-ui-bootstrap"
+     *      data-sap-ui-libs="sap.m,sap.ui.core,sap.ushell,sap.fe.templates">
+     * </script>
+     * ```
+     */
     ui5Libs: string | string[];
+    /**
+     * (Optional) These libraries will be added to the manifest.json file as sap.ui5 dependencies.
+     * If `manifestLibs` not provided, `ui5Libs` libraries added to the manifest.json by default.
+     *
+     * manifest.json:
+     *
+     * @example
+     * ```json
+     * "sap.ui5": {
+     *  "flexEnabled": true,
+     *  "dependencies": {
+     *      "minUI5Version": "1.121.1",
+     *      "libs": {
+     *          "sap.m": {},
+     *          "sap.ui.core": {},
+     *          "sap.ushell": {},
+     *          "sap.fe.templates": {}
+     *      }
+     *  },
+     * }
+     * ```
+     */
+    manifestLibs?: string | string[];
+    /**
+     * The default UI5 theme to be used in the project (e.g. 'sap_fiori_3').
+     */
     ui5Theme: string;
+    /**
+     * (Optional) Custom UI5 libraries that are included in the project.
+     * Added with ui5 dependencies in the manifest.json.
+     */
     customUi5Libs?: string[];
 }
 export interface AppOptions {

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.1.4",
+  "version": "1.1.6",
   "license": "Apache-2.0",
   "main": "dist/index.js",
   "files": [
@@ -27,7 +27,7 @@
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",
     "semver": "7.5.4",
-    "@sap-ux/ui5-config": "0.24.0"
+    "@sap-ux/ui5-config": "0.24.1"
   },
   "devDependencies": {
     "@types/ejs": "3.1.2",
@@ -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.26.7"
+    "@sap-ux/project-access": "1.26.9"
   },
   "engines": {
     "node": ">=18.x"

package/templates/core/webapp/manifest.json

@@ -36,7 +36,7 @@
       "flexEnabled": true,
       "dependencies": {
         "minUI5Version": "<%- ui5.minUI5Version %>",
-        "libs": {<% ui5.ui5Libs.concat(ui5.customUi5Libs ?? []).forEach((ui5Lib, idx, libs) => { %>
+        "libs": {<% (ui5.manifestLibs?.length ? ui5.manifestLibs : ui5.ui5Libs).concat(ui5.customUi5Libs ?? []).forEach((ui5Lib, idx, libs) => {%>
           <%- `"${ui5Lib}": {}${idx+1 < libs.length ? ',' : ''}` %><% }); %>
         }
       },

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

@@ -227,10 +227,15 @@ sap.registerComponentDependencyPaths(manifestUri)
         } else {
             sap.ui.getCore().attachInit(function () {
                 registerSAPFonts();
-                // initialize the ushell sandbox component
-                sap.ushell.Container.createRenderer(true).then(function (component) {
-                    component.placeAt("content");
-                });
+                try {
+                    // initialize the ushell sandbox component in ui5 v2
+                    sap.ushell.Container.createRenderer(true).then(function (component) {
+                        component.placeAt("content");
+                    });
+                } catch {
+                    // support older versions of ui5 
+                    sap.ushell.Container.createRenderer().placeAt("content");
+                }
             });
         }
     });