@sap-ux/fiori-freestyle-writer 2.0.20 → 2.1.1

package/dist/generateOPATests.d.ts

@@ -0,0 +1,17 @@
+import type { Package } from '@sap-ux/ui5-application-writer';
+import type { FreestyleApp } from './types';
+import type { Logger } from '@sap-ux/logger';
+import type { Editor } from 'mem-fs-editor';
+/**
+ * Generates OPA tests for a freestyle application.
+ *
+ * @param {string} basePath - The base directory path.
+ * @param {FreestyleApp} ffApp - The freestyle application configuration.
+ * @param {boolean} addMock - Whether to include the UI5 mock YAML configuration.
+ * @param {Package} packageJson - The package.json object to update.
+ * @param {Editor} [fs] - Optional file system editor instance.
+ * @param {Logger} [log] - Optional logger instance.
+ * @returns {Promise<Editor>} - The modified file system editor.
+ */
+export declare function generateOPATests<T>(basePath: string, ffApp: FreestyleApp<T>, addMock: boolean, packageJson: Package, fs?: Editor, log?: Logger): Promise<void>;
+//# sourceMappingURL=generateOPATests.d.ts.map

package/dist/generateOPATests.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateOPATests = generateOPATests;
+const ui5_test_writer_1 = require("@sap-ux/ui5-test-writer");
+/**
+ * Adds test scripts to the package.json object.
+ *
+ * @param {Package} packageJson - The package.json object to update.
+ * @param {boolean} addMock - Whether to include the UI5 mock YAML configuration.
+ */
+function addTestScripts(packageJson, addMock) {
+    // Note: 'ui5MockYamlScript' is empty when no data source is selected.
+    const ui5MockYamlScript = addMock ? '--config ./ui5-mock.yaml ' : '';
+    packageJson.scripts = {
+        ...packageJson.scripts,
+        'unit-test': `fiori run ${ui5MockYamlScript}--open 'test/unit/unitTests.qunit.html'`,
+        'int-test': `fiori run ${ui5MockYamlScript}--open 'test/integration/opaTests.qunit.html'`
+    };
+}
+/**
+ * Generates OPA tests for a freestyle application.
+ *
+ * @param {string} basePath - The base directory path.
+ * @param {FreestyleApp} ffApp - The freestyle application configuration.
+ * @param {boolean} addMock - Whether to include the UI5 mock YAML configuration.
+ * @param {Package} packageJson - The package.json object to update.
+ * @param {Editor} [fs] - Optional file system editor instance.
+ * @param {Logger} [log] - Optional logger instance.
+ * @returns {Promise<Editor>} - The modified file system editor.
+ */
+async function generateOPATests(basePath, ffApp, addMock, packageJson, fs, log) {
+    addTestScripts(packageJson, addMock);
+    const config = {
+        appId: ffApp.app.id,
+        applicationDescription: ffApp.app.description,
+        applicationTitle: ffApp.app.title,
+        viewName: ffApp.template.settings.viewName,
+        ui5Theme: ffApp.ui5?.ui5Theme,
+        ui5Version: ffApp.ui5?.version,
+        enableTypeScript: ffApp.appOptions?.typescript
+    };
+    await (0, ui5_test_writer_1.generateFreestyleOPAFiles)(basePath, config, fs, log);
+}
+//# sourceMappingURL=generateOPATests.js.map

package/dist/index.d.ts

@@ -1,14 +1,16 @@
 import type { Editor } from 'mem-fs-editor';
 import { FreestyleApp } from './types';
+import type { Logger } from '@sap-ux/logger';
 /**
  * Generate a UI5 application based on the specified Fiori Freestyle floorplan template.
  *
  * @param basePath - the absolute target path where the application will be generated
  * @param data - configuration to generate the freestyle application
  * @param fs - an optional reference to a mem-fs editor
+ * @param log - optional logger
  * @returns Reference to a mem-fs-editor
  */
-declare function generate<T>(basePath: string, data: FreestyleApp<T>, fs?: Editor): Promise<Editor>;
+declare function generate<T>(basePath: string, data: FreestyleApp<T>, fs?: Editor, log?: Logger): Promise<Editor>;
 export { generate, FreestyleApp };
 export { WorklistSettings, ListDetailSettings, TemplateType, Template, OdataVersion } from './types';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -17,15 +17,17 @@ const i18n_1 = require("./i18n");
 const fiori_generator_shared_1 = require("@sap-ux/fiori-generator-shared");
 const utils_1 = require("./utils");
 const cap_config_writer_1 = require("@sap-ux/cap-config-writer");
+const generateOPATests_1 = require("./generateOPATests");
 /**
  * Generate a UI5 application based on the specified Fiori Freestyle floorplan template.
  *
  * @param basePath - the absolute target path where the application will be generated
  * @param data - configuration to generate the freestyle application
  * @param fs - an optional reference to a mem-fs editor
+ * @param log - optional logger
  * @returns Reference to a mem-fs-editor
  */
-async function generate(basePath, data, fs) {
+async function generate(basePath, data, fs, log) {
     // Load i18n translations asynchronously to ensure proper initialization.
     // This addresses occasional issues where i18n is not initialized in time, causing tests to fail.
     await (0, i18n_1.initI18n)();
@@ -81,21 +83,27 @@ async function generate(basePath, data, fs) {
     const packagePath = (0, path_1.join)(basePath, 'package.json');
     // extend package.json with scripts for non-CAP projects
     fs.extendJSON(packagePath, JSON.parse((0, ejs_1.render)(fs.read((0, path_1.join)(tmplPath, 'common', 'extend', 'package.json')), ffApp, {})));
+    const addTests = ffApp.appOptions?.addTests;
     const packageJson = JSON.parse(fs.read(packagePath));
     if (isEdmxProjectType) {
+        const addMock = !!ffApp.service?.metadata;
         // Add scripts for non-CAP applications
         packageJson.scripts = {
             ...packageJson.scripts,
             ...(0, fiori_generator_shared_1.getPackageScripts)({
                 localOnly: !!ffApp.service && !ffApp.service?.url,
-                addMock: !!ffApp.service?.metadata,
+                addMock,
                 sapClient: ffApp.service?.client,
                 flpAppId: ffApp.app.flpAppId,
                 startFile: data?.app?.startFile,
                 localStartFile: data?.app?.localStartFile,
-                generateIndex: ffApp.appOptions?.generateIndex
+                generateIndex: ffApp.appOptions?.generateIndex,
+                addTest: addTests
             })
         };
+        if (addTests) {
+            await (0, generateOPATests_1.generateOPATests)(basePath, ffApp, addMock, packageJson, fs, log);
+        }
     }
     else {
         // Add deploy-config for CAP applications

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import type { Ui5App, App } from '@sap-ux/ui5-application-writer';
+import type { Ui5App, App, AppOptions } from '@sap-ux/ui5-application-writer';
 import type { OdataService } from '@sap-ux/odata-service-writer';
 import type { CapServiceCdsInfo } from '@sap-ux/cap-config-writer';
 export declare const TemplateType: {
@@ -37,6 +37,13 @@ export interface FreestyleApp<T> extends Ui5App {
         capService?: CapServiceCdsInfo;
     };
     app: FioriApp;
+    appOptions?: Partial<AppOptions> & {
+        /**
+         * Generate OPA based tests, for Simple template.
+         * This will eventually move up to {@link Ui5App.appOptions}
+         */
+        addTests?: boolean;
+    };
 }
 export { OdataVersion } from '@sap-ux/odata-service-writer';
 //# sourceMappingURL=types.d.ts.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/fiori-freestyle-writer",
   "description": "SAP Fiori freestyle application writer",
-  "version": "2.0.20",
+  "version": "2.1.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -29,9 +29,11 @@
     "semver": "7.5.4",
     "@sap-ux/odata-service-writer": "0.26.3",
     "@sap-ux/ui5-application-writer": "1.2.10",
+    "@sap-ux/fiori-generator-shared": "0.9.0",
+    "@sap-ux/cap-config-writer": "0.9.11",
+    "@sap-ux/ui5-test-writer": "0.5.1",
     "@sap-ux/ui5-config": "0.26.2",
-    "@sap-ux/fiori-generator-shared": "0.8.1",
-    "@sap-ux/cap-config-writer": "0.9.10"
+    "@sap-ux/logger": "0.6.0"
   },
   "devDependencies": {
     "@types/ejs": "3.1.2",

package/templates/basic/extend/1.120.0/webapp/manifest.json

@@ -3,7 +3,8 @@
         "rootView": {
             "viewName": "<%- app.id %>.view.App",
             "type": "XML",
-            "id": "App"
+            "id": "App",
+            "async": true
         },
         "resources": {
             "css": [
@@ -20,7 +21,9 @@
                 "transition": "slide",
                 "type": "View",
                 "viewType": "XML",
-                "path": "<%- app.id %>.view"
+                "path": "<%- app.id %>.view",
+                "async": true,
+                "viewPath": "<%- app.id %>.view"
             },
             "routes": [
                 {