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

package/dist/data/defaults.d.ts

@@ -1,4 +1,5 @@
-import type { App, AppOptions, Package, UI5 } from '../types';
+import type { App, AppOptions, UI5 } from '../types';
+import type { Package } from '@sap-ux/project-access';
 /**
  * Returns a package instance with default properties.
  *
@@ -25,11 +26,4 @@ export declare const defaultUI5Libs: string[];
  * @returns {UI5} the updated copy of UI5 instance (does not change `ui5`)
  */
 export declare function mergeUi5(ui5: Partial<UI5>, options?: Partial<AppOptions>): UI5;
-/**
- * Retrieve the tag version of the @sap/ux-specification based on the given version.
- *
- * @param ui5Version UI5 version used in the project
- * @returns version tag
- */
-export declare function getSpecTagVersion(ui5Version: string | undefined): string;
 //# sourceMappingURL=defaults.d.ts.map

package/dist/data/defaults.js

@@ -3,7 +3,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSpecTagVersion = exports.mergeUi5 = exports.defaultUI5Libs = exports.mergeApp = exports.packageDefaults = void 0;
+exports.defaultUI5Libs = void 0;
+exports.packageDefaults = packageDefaults;
+exports.mergeApp = mergeApp;
+exports.mergeUi5 = mergeUi5;
 const ui5_config_1 = require("@sap-ux/ui5-config");
 const mapping_json_1 = __importDefault(require("@ui5/manifest/mapping.json")); // from https://github.com/SAP/ui5-manifest/blob/master/mapping.json
 const ui5Libs_1 = require("./ui5Libs");
@@ -43,7 +46,6 @@ function packageDefaults(version, description, isEdmxProjectType) {
         scripts: {}
     };
 }
-exports.packageDefaults = packageDefaults;
 /**
  * Returns an app instance merged with default properties.
  *
@@ -63,7 +65,6 @@ function mergeApp(app) {
         }
     }, app);
 }
-exports.mergeApp = mergeApp;
 // Required default libs
 exports.defaultUI5Libs = ['sap.m', 'sap.ui.core'];
 /**
@@ -96,7 +97,6 @@ function mergeUi5(ui5, options) {
     merged.ui5Libs = (0, ui5Libs_1.getUI5Libs)(ui5.ui5Libs);
     return Object.assign({}, ui5, merged);
 }
-exports.mergeUi5 = mergeUi5;
 /**
  * Gets the miminum UI5 version based on the specified version.
  *
@@ -190,23 +190,4 @@ function getLocalVersion({ framework, version, localVersion }) {
         return minVersion;
     }
 }
-/**
- * Retrieve the tag version of the @sap/ux-specification based on the given version.
- *
- * @param ui5Version UI5 version used in the project
- * @returns version tag
- */
-function getSpecTagVersion(ui5Version) {
-    if (ui5Version) {
-        if (semver_1.default.valid(ui5Version)) {
-            return `UI5-${semver_1.default.major(ui5Version)}.${semver_1.default.minor(ui5Version)}`;
-        }
-        else if (ui5Version.includes('snapshot') && ui5Version.includes('.')) {
-            const snaphotVersion = ui5Version.split('snapshot-')[1];
-            return `UI5-${snaphotVersion}`;
-        }
-    }
-    return 'latest';
-}
-exports.getSpecTagVersion = getSpecTagVersion;
 //# sourceMappingURL=defaults.js.map

package/dist/data/index.d.ts

@@ -1,4 +1,5 @@
-import type { App, UI5, AppOptions, Package, Ui5App } from '../types';
+import type { App, UI5, AppOptions, Ui5App } from '../types';
+import type { Package } from '@sap-ux/project-access';
 /**
  * Merges Ui5App instance with default properties.
  * Replaces undefined mandatory properties with default values.

package/dist/data/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mergeWithDefaults = void 0;
+exports.mergeWithDefaults = mergeWithDefaults;
 const ui5_config_1 = require("@sap-ux/ui5-config");
 const defaults_1 = require("./defaults");
 const validators_1 = require("./validators");
@@ -23,12 +23,10 @@ function mergeWithDefaults(ui5App) {
     // Determine if the project type is 'EDMXBackend'.
     const isEdmxProjectType = ui5App.app.projectType === 'EDMXBackend';
     ui5App.package = (0, ui5_config_1.mergeObjects)((0, defaults_1.packageDefaults)(ui5App.package.version, ui5App.app.description, isEdmxProjectType), ui5App.package);
-    if (ui5App.appOptions.sapux && isEdmxProjectType) {
-        // Add @sap/ux-specification to devDependencies only for non-CAP projects
-        ui5App.package.devDependencies = ui5App.package.devDependencies || {};
-        ui5App.package.devDependencies['@sap/ux-specification'] = (0, defaults_1.getSpecTagVersion)(ui5App.ui5.version);
+    if (!isEdmxProjectType) {
+        // sapuxLayer is not defined for cap projects
+        ui5App.package.sapuxLayer = undefined;
     }
     return ui5App;
 }
-exports.mergeWithDefaults = mergeWithDefaults;
 //# sourceMappingURL=index.js.map

package/dist/data/validators.js

@@ -3,7 +3,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validate = exports.validateUI5Version = exports.validateAppId = void 0;
+exports.validateAppId = validateAppId;
+exports.validateUI5Version = validateUI5Version;
+exports.validate = validate;
 const semver_1 = __importDefault(require("semver"));
 const i18n_1 = require("../i18n");
 /**
@@ -23,7 +25,6 @@ function validateAppId(appId) {
     }
     return true;
 }
-exports.validateAppId = validateAppId;
 /**
  * Validates by throwing if the specified version does not have a coercible semantic version.
  * Currently we have special handling for empty string and undefined otherwise see: https://github.com/npm/node-semver#coercion.
@@ -38,7 +39,6 @@ function validateUI5Version(version) {
     }
     return true;
 }
-exports.validateUI5Version = validateUI5Version;
 /**
  * Validates the specified ui5App.
  *
@@ -52,5 +52,4 @@ function validate(ui5App) {
         validateUI5Version(ui5App.ui5?.localVersion) &&
         validateUI5Version(ui5App.ui5?.minUI5Version));
 }
-exports.validate = validate;
 //# sourceMappingURL=validators.js.map

package/dist/i18n.js

@@ -3,7 +3,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.t = exports.initI18n = void 0;
+exports.initI18n = initI18n;
+exports.t = t;
 const i18next_1 = __importDefault(require("i18next"));
 const ui5_application_writer_i18n_json_1 = __importDefault(require("./translations/ui5-application-writer.i18n.json"));
 const NS = 'ui5-application-writer';
@@ -23,7 +24,6 @@ async function initI18n() {
         ns: [NS]
     });
 }
-exports.initI18n = initI18n;
 /**
  * Helper function facading the call to i18next.
  *
@@ -34,7 +34,6 @@ exports.initI18n = initI18n;
 function t(key, options) {
     return i18next_1.default.t(key, options);
 }
-exports.t = t;
 initI18n().catch(() => {
     // Ignore any errors since the write will still work
 });

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import type { Editor } from 'mem-fs-editor';
-import type { App, AppOptions, Package, UI5 } from './types';
+import type { App, AppOptions, UI5 } from './types';
+import { type Package } from '@sap-ux/project-access';
 import { Ui5App } from './types';
 /**
  * Writes the template to the memfs editor instance.

package/dist/index.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isTypescriptEnabled = exports.enableTypescript = exports.generate = void 0;
+exports.generate = generate;
+exports.enableTypescript = enableTypescript;
+exports.isTypescriptEnabled = isTypescriptEnabled;
 const path_1 = require("path");
 const mem_fs_1 = require("mem-fs");
 const mem_fs_editor_1 = require("mem-fs-editor");
@@ -54,6 +56,8 @@ async function generate(basePath, ui5AppConfig, fs) {
     });
     ui5Config.addFioriToolsAppReloadMiddleware();
     if (isEdmxProjectType) {
+        // add preview middleware to ui5Config
+        ui5Config.addFioriToolsPreviewMiddleware(ui5App.app.id, ui5App.ui5?.ui5Theme);
         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));
@@ -61,6 +65,8 @@ async function generate(basePath, ui5AppConfig, fs) {
         ui5LocalConfig.addFioriToolsAppReloadMiddleware();
         // Add optional features
         await (0, options_1.applyOptionalFeatures)(ui5App, fs, basePath, tmplPath, [ui5Config, ui5LocalConfig]);
+        // add preview middleware to ui5LocalConfig
+        ui5LocalConfig.addFioriToolsPreviewMiddleware(ui5App.app.id, ui5App.ui5?.ui5Theme);
         // write ui5 local yaml
         fs.write(ui5LocalConfigPath, ui5LocalConfig.toString());
     }
@@ -72,7 +78,6 @@ async function generate(basePath, ui5AppConfig, fs) {
     fs.write(ui5ConfigPath, ui5Config.toString());
     return fs;
 }
-exports.generate = generate;
 /**
  * Check if Typescript is enabled for the given path.
  *
@@ -94,7 +99,6 @@ async function isTypescriptEnabled(basePath, fs) {
     }
     return true;
 }
-exports.isTypescriptEnabled = isTypescriptEnabled;
 /**
  * Enable typescript in an existing valid UI5 project.
  *
@@ -131,5 +135,4 @@ async function enableTypescript(basePath, fs) {
     fs.write(ui5ConfigPath, ui5Config.toString());
     return fs;
 }
-exports.enableTypescript = enableTypescript;
 //# sourceMappingURL=index.js.map

package/dist/options.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getTemplateOptions = exports.applyOptionalFeatures = exports.enableNpmPackageConsumption = exports.enableTypescript = void 0;
+exports.enableTypescript = enableTypescript;
+exports.enableNpmPackageConsumption = enableNpmPackageConsumption;
+exports.applyOptionalFeatures = applyOptionalFeatures;
+exports.getTemplateOptions = getTemplateOptions;
 const path_1 = require("path");
 const ejs_1 = require("ejs");
 const project_access_1 = require("@sap-ux/project-access");
@@ -72,7 +75,6 @@ async function enableTypescript(input, keepOldComponent = false) {
         input.fs.delete(compPath);
     }
 }
-exports.enableTypescript = enableTypescript;
 /**
  * Enable npm module import for the given input.
  *
@@ -85,7 +87,6 @@ async function enableNpmPackageConsumption(input) {
         ui5Config.addCustomTasks([ui5Libs_1.ui5NPMSupport.task]);
     });
 }
-exports.enableNpmPackageConsumption = enableNpmPackageConsumption;
 /**
  * Check if the ui5 app config requires optional features to be enabled and if yes, enable them.
  *
@@ -104,7 +105,6 @@ async function applyOptionalFeatures(ui5App, fs, basePath, tmplPath, ui5Configs)
         }
     }
 }
-exports.applyOptionalFeatures = applyOptionalFeatures;
 /**
  * Generates the resource URL based on the project type and ui5 framework details.
  *
@@ -129,5 +129,4 @@ function getTemplateOptions(isEdmxProjectType, frameworkUrl, version) {
         return url;
     }
 }
-exports.getTemplateOptions = getTemplateOptions;
 //# sourceMappingURL=options.js.map

package/dist/types.d.ts

@@ -1,15 +1,4 @@
-import type { ProjectType } from '@sap-ux/project-access';
-export interface Package {
-    name: string;
-    version?: string;
-    description?: string;
-    scripts?: Record<string, string>;
-    dependencies?: Record<string, string>;
-    devDependencies?: Record<string, string>;
-    ui5?: {
-        dependencies?: string[];
-    };
-}
+import type { ProjectType, Package } from '@sap-ux/project-access';
 export interface App {
     id: string;
     /**

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.6",
+  "version": "1.2.1",
   "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.1"
+    "@sap-ux/ui5-config": "0.25.0"
   },
   "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.9"
+    "@sap-ux/project-access": "1.28.2"
   },
   "engines": {
     "node": ">=18.x"

package/templates/core/package.json

@@ -9,6 +9,9 @@
     ],
     "main": "webapp/index.html",
     "dependencies": {},
-    "devDependencies": <%- JSON.stringify(package.devDependencies, null, 8) -%>,
-    "scripts": <%- JSON.stringify(package.scripts, null, 4) -%>
-}
+    "devDependencies": <%- JSON.stringify(package.devDependencies, null, 8).trim() -%>,
+    "scripts": <%- JSON.stringify(package.scripts, null, 4).trim() -%>
+    <% if (package.sapuxLayer) { %>
+    ,"sapuxLayer": "<%= package.sapuxLayer %>"
+    <% } %>
+}