@sap-ux/ui5-application-writer 1.5.8 → 1.5.10

package/dist/index.js

@@ -12,6 +12,7 @@ const project_access_1 = require("@sap-ux/project-access");
 const data_1 = require("./data");
 const ui5Libs_1 = require("./data/ui5Libs");
 const options_1 = require("./options");
+const utils_1 = require("./utils");
 /**
  * Writes the template to the memfs editor instance.
  *
@@ -43,9 +44,13 @@ async function generate(basePath, ui5AppConfig, fs) {
         ...ui5App,
         ui5ResourceUrl
     };
-    fs.copyTpl((0, path_1.join)(tmplPath, 'core', '**/*.*'), (0, path_1.join)(basePath), templateOptions, undefined, {
-        globOptions: { dot: true, ignore },
-        processDestinationPath: (filePath) => filePath.replace(/gitignore.tmpl/g, '.gitignore')
+    (0, utils_1.copyTemplates)({
+        fs,
+        basePath,
+        tmplPath,
+        templateOptions,
+        ignore,
+        ui5Version: ui5App.ui5?.version
     });
     // ui5.yaml
     const ui5ConfigPath = (0, path_1.join)(basePath, 'ui5.yaml');
@@ -162,12 +167,12 @@ 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; } });
+var utils_2 = require("./utils");
+Object.defineProperty(exports, "compareUI5VersionGte", { enumerable: true, get: function () { return utils_2.compareUI5VersionGte; } });
+Object.defineProperty(exports, "ui5LtsVersion_1_120", { enumerable: true, get: function () { return utils_2.ui5LtsVersion_1_120; } });
+Object.defineProperty(exports, "ui5LtsVersion_1_71", { enumerable: true, get: function () { return utils_2.ui5LtsVersion_1_71; } });
+Object.defineProperty(exports, "processDestinationPath", { enumerable: true, get: function () { return utils_2.processDestinationPath; } });
+Object.defineProperty(exports, "getTemplateVersionPath", { enumerable: true, get: function () { return utils_2.getTemplateVersionPath; } });
 var defaults_1 = require("./data/defaults");
 Object.defineProperty(exports, "getManifestVersion", { enumerable: true, get: function () { return defaults_1.getManifestVersion; } });
 //# sourceMappingURL=index.js.map

package/dist/types.d.ts

@@ -158,6 +158,16 @@ export interface AppOptions {
      */
     useVirtualPreviewEndpoints?: boolean;
 }
+/**
+ * Options for template generation.
+ */
+export type TemplateOptions = {
+    app: App;
+    appOptions: Partial<AppOptions>;
+    ui5: UI5;
+    package: Package;
+    ui5ResourceUrl: string;
+};
 export interface Ui5App {
     app: App;
     appOptions?: Partial<AppOptions>;

package/dist/utils.d.ts

@@ -1,4 +1,5 @@
-import { type UI5 } from './types';
+import { type UI5, type TemplateOptions } from './types';
+import type { Editor } from 'mem-fs-editor';
 export declare const ui5LtsVersion_1_71 = "1.71.0";
 export declare const ui5LtsVersion_1_120 = "1.120.0";
 /**
@@ -23,4 +24,23 @@ export declare function getTemplateVersionPath(ui5: UI5): string;
  * @returns {string} - The processed file path.
  */
 export declare function processDestinationPath(filePath: string): string;
+/**
+ * Copies UI5 project template files and common files to the target base path.
+ *
+ * @param options - Options for copying template files
+ * @param options.fs - The mem-fs editor instance
+ * @param options.basePath - The target base path
+ * @param options.tmplPath - The template root path
+ * @param options.templateOptions - Template variables for file rendering
+ * @param options.ignore - Glob patterns to ignore during copy
+ * @param options.ui5Version - Optional UI5 version to determine template version
+ */
+export declare function copyTemplates(options: {
+    fs: Editor;
+    basePath: string;
+    tmplPath: string;
+    templateOptions: TemplateOptions;
+    ignore: string[];
+    ui5Version?: string;
+}): void;
 //# sourceMappingURL=utils.d.ts.map

package/dist/utils.js

@@ -4,7 +4,10 @@ exports.ui5LtsVersion_1_120 = exports.ui5LtsVersion_1_71 = void 0;
 exports.compareUI5VersionGte = compareUI5VersionGte;
 exports.getTemplateVersionPath = getTemplateVersionPath;
 exports.processDestinationPath = processDestinationPath;
+exports.copyTemplates = copyTemplates;
 const semver_1 = require("semver");
+const path_1 = require("path");
+const project_access_1 = require("@sap-ux/project-access");
 exports.ui5LtsVersion_1_71 = '1.71.0';
 exports.ui5LtsVersion_1_120 = '1.120.0';
 /**
@@ -49,4 +52,32 @@ function getTemplateVersionPath(ui5) {
 function processDestinationPath(filePath) {
     return filePath.replace('/1.120.0', '').replace('/1.71.0', '');
 }
+/**
+ * Copies UI5 project template files and common files to the target base path.
+ *
+ * @param options - Options for copying template files
+ * @param options.fs - The mem-fs editor instance
+ * @param options.basePath - The target base path
+ * @param options.tmplPath - The template root path
+ * @param options.templateOptions - Template variables for file rendering
+ * @param options.ignore - Glob patterns to ignore during copy
+ * @param options.ui5Version - Optional UI5 version to determine template version
+ */
+function copyTemplates(options) {
+    const { fs, basePath, tmplPath, templateOptions, ignore, ui5Version } = options;
+    const remainingCoreFiles = ['gitignore.tmpl', project_access_1.FileName.Package, project_access_1.FileName.Ui5LocalYaml, project_access_1.FileName.Ui5Yaml];
+    const resolvedUi5Version = ui5Version ?? exports.ui5LtsVersion_1_120;
+    const templateUi5Version = compareUI5VersionGte(resolvedUi5Version, exports.ui5LtsVersion_1_120)
+        ? exports.ui5LtsVersion_1_120
+        : exports.ui5LtsVersion_1_71;
+    // Copy version-specific template files
+    fs.copyTpl((0, path_1.join)(tmplPath, 'core', templateUi5Version, '**/*.*'), (0, path_1.join)(basePath), templateOptions, undefined, {
+        globOptions: { dot: true, ignore }
+    });
+    // Copy remaining common files
+    fs.copyTpl(remainingCoreFiles.map((fileName) => (0, path_1.join)(tmplPath, 'core', fileName)), (0, path_1.join)(basePath), templateOptions, undefined, {
+        globOptions: { dot: true, ignore },
+        processDestinationPath: (filePath) => filePath.replace(/gitignore.tmpl/g, '.gitignore')
+    });
+}
 //# 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.5.8",
+  "version": "1.5.10",
   "license": "Apache-2.0",
   "main": "dist/index.js",
   "files": [
@@ -20,7 +20,7 @@
     "!dist/**/*.map"
   ],
   "dependencies": {
-    "@ui5/manifest": "1.66.0",
+    "@ui5/manifest": "1.76.0",
     "ejs": "3.1.10",
     "i18next": "25.3.0",
     "lodash": "4.17.21",
@@ -38,7 +38,7 @@
     "@types/semver": "7.5.2",
     "fs-extra": "10.0.0",
     "@sap-ux/eslint-plugin-fiori-tools": "0.6.0",
-    "@sap-ux/project-access": "1.30.6"
+    "@sap-ux/project-access": "1.30.8"
   },
   "engines": {
     "node": ">=20.x"

package/templates/core/1.120.0/webapp/index.html

@@ -0,0 +1,35 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <title><%= app.title %></title>
+    <style>
+        html, body, body > div, #container, #container-uiarea {
+            height: 100%;
+        }
+    </style>
+    <script
+        id="sap-ui-bootstrap"
+        src="<%- locals.ui5ResourceUrl %>"
+        data-sap-ui-theme="<%- ui5.ui5Theme %>"
+        data-sap-ui-resource-roots='{
+            "<%- app.id %>": "./"
+        }'
+        data-sap-ui-on-init="module:sap/ui/core/ComponentSupport"
+        data-sap-ui-compat-version="edge"
+        data-sap-ui-async="true"
+        data-sap-ui-frame-options="trusted"
+    ></script>
+</head>
+<body class="sapUiBody sapUiSizeCompact" id="content">
+    <div
+        data-sap-ui-component
+        data-name="<%- app.id %>"
+        data-id="container"
+        data-settings='{"id" : "<%- app.id %>"}'
+        data-handle-validation="true"
+    ></div>
+</body>
+</html>

package/templates/core/1.71.0/webapp/Component.js

@@ -0,0 +1,25 @@
+sap.ui.define(
+    ["<%- app.baseComponent %>"],
+    function (UIComponent) {
+        "use strict";
+
+        return UIComponent.extend("<%- app.id %>.Component", {
+            metadata: {
+                manifest: "json"
+            },
+
+            /**
+             * The component is initialized by UI5 automatically during the startup of the app and calls the init method once.
+             * @public
+             * @override
+             */
+            init: function () {
+                // call the base component's init function
+                UIComponent.prototype.init.apply(this, arguments);
+
+                // enable routing
+                this.getRouter().initialize();
+            }
+        });
+    }
+);

package/templates/core/1.71.0/webapp/i18n/i18n.properties

@@ -0,0 +1,9 @@
+# This is the resource bundle for <%- app.id %>
+
+#Texts for manifest.json
+
+#XTIT: Application name
+appTitle=<%- app.title %>
+
+#YDES: Application description
+appDescription=<%- app.description %>

package/templates/core/1.71.0/webapp/manifest.json

@@ -0,0 +1,64 @@
+{
+    "_version": "<%- ui5.descriptorVersion %>",
+    "sap.app": {
+        "id": "<%- app.id %>",
+      "type": "application",
+      "i18n": "i18n/i18n.properties",
+      "applicationVersion": {
+        "version": "<%- app.version %>"
+      },
+      "title": "{{appTitle}}",
+      "description": "{{appDescription}}",
+      "resources": "resources.json",
+      "sourceTemplate": {
+          "id": "<%= app.sourceTemplate.id %>",
+          "version": "<%= app.sourceTemplate.version %>"<% if (app.sourceTemplate.toolsId) { %>,
+          "toolsId": "<%= app.sourceTemplate.toolsId %>"<% } %>
+      }
+    },
+    "sap.ui": {
+      "technology": "UI5",
+      "icons": {
+        "icon": "",
+        "favIcon": "",
+        "phone": "",
+        "phone@2": "",
+        "tablet": "",
+        "tablet@2": ""
+      },
+      "deviceTypes": {
+        "desktop": true,
+        "tablet": true,
+        "phone": true
+      }
+    },
+    "sap.ui5": {
+      "flexEnabled": true,
+      "dependencies": {
+        "minUI5Version": "<%- ui5.minUI5Version %>",
+        "libs": {<% (ui5.manifestLibs?.length ? ui5.manifestLibs : ui5.ui5Libs).concat(ui5.customUi5Libs ?? []).forEach((ui5Lib, idx, libs) => {%>
+          <%- `"${ui5Lib}": {}${idx+1 < libs.length ? ',' : ''}` %><% }); %>
+        }
+      },
+      "contentDensities": {
+        "compact": true,
+        "cozy": true
+      },
+      "models": {
+        "i18n": {
+          "type": "sap.ui.model.resource.ResourceModel",
+          "settings": {
+            "bundleName": "<%- app.id %>.i18n.i18n"
+          }
+        }
+      },
+      "resources": {
+        "css": []
+      },
+      "routing": {
+        "config": {},
+        "routes": [],
+        "targets": {}
+      }
+    }
+  }