@sap-ux/fiori-elements-writer 0.23.2 → 1.0.0

package/dist/data/defaults.d.ts

@@ -1,6 +1,7 @@
 import { OdataVersion } from '@sap-ux/odata-service-writer';
 import type { FioriElementsApp, Template } from '../types';
 import { TemplateType } from '../types';
+import { type TemplateOptions } from './templateAttributes';
 /**
  * Updates the template settings to defaults if not provided.
  *
@@ -25,4 +26,13 @@ export declare function getUi5Libs(type: TemplateType, version: OdataVersion, ui
  * @returns Fiori elements app config with updated defaults for unspecified properties
  */
 export declare function setAppDefaults<T>(feApp: FioriElementsApp<T>): FioriElementsApp<T>;
+/**
+ * Generates template options on project type and version information.
+ *
+ * @param {boolean} isEdmxProjectType Indicates if the project type is 'EDMXBackend'.
+ * @param {string} serviceVersion The version of the service being used.
+ * @param {string} [ui5Version] The version of UI5 framework being used.
+ * @returns {TemplateOptions} An template objects containing options related to changes preview and loader.
+ */
+export declare function getTemplateOptions(isEdmxProjectType: boolean, serviceVersion: string, ui5Version?: string): TemplateOptions;
 //# sourceMappingURL=defaults.d.ts.map

package/dist/data/defaults.js

@@ -3,12 +3,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setAppDefaults = exports.getUi5Libs = exports.setDefaultTemplateSettings = void 0;
+exports.getTemplateOptions = exports.setAppDefaults = exports.getUi5Libs = exports.setDefaultTemplateSettings = void 0;
 const odata_service_writer_1 = require("@sap-ux/odata-service-writer");
 const read_pkg_up_1 = __importDefault(require("read-pkg-up"));
 const types_1 = require("../types");
 const templateAttributes_1 = require("./templateAttributes");
 const annotationCustomUi5Libs_1 = require("./annotationCustomUi5Libs");
+const semver_1 = __importDefault(require("semver"));
 const defaultModelName = 'mainModel'; // UI5 default model name is '' but some floorplans require a named default model
 /**
  * Updates the template settings to defaults if not provided.
@@ -120,4 +121,26 @@ function setAppDefaults(feApp) {
     return feApp;
 }
 exports.setAppDefaults = setAppDefaults;
+/**
+ * Generates template options on project type and version information.
+ *
+ * @param {boolean} isEdmxProjectType Indicates if the project type is 'EDMXBackend'.
+ * @param {string} serviceVersion The version of the service being used.
+ * @param {string} [ui5Version] The version of UI5 framework being used.
+ * @returns {TemplateOptions} An template objects containing options related to changes preview and loader.
+ */
+function getTemplateOptions(isEdmxProjectType, serviceVersion, ui5Version) {
+    const coercedUI5Version = semver_1.default.coerce(ui5Version);
+    // Determine if the changes preview should be enabled based on the project type and UI5 version
+    const changesPreview = isEdmxProjectType && ui5Version
+        ? semver_1.default.lt(coercedUI5Version, templateAttributes_1.changesPreviewToVersion) // Check if the coerced version is less than the required version
+        : false;
+    // Determine if the changes loader should be enabled based on the project type and service version
+    const changesLoader = isEdmxProjectType && serviceVersion === odata_service_writer_1.OdataVersion.v2;
+    return {
+        changesPreview,
+        changesLoader
+    };
+}
+exports.getTemplateOptions = getTemplateOptions;
 //# sourceMappingURL=defaults.js.map

package/dist/index.js

@@ -33,10 +33,10 @@ const templateAttributes_1 = require("./data/templateAttributes");
 Object.defineProperty(exports, "TemplateTypeAttributes", { enumerable: true, get: function () { return templateAttributes_1.TemplateTypeAttributes; } });
 Object.defineProperty(exports, "minSupportedUI5Version", { enumerable: true, get: function () { return templateAttributes_1.minSupportedUI5Version; } });
 Object.defineProperty(exports, "minSupportedUI5VersionV4", { enumerable: true, get: function () { return templateAttributes_1.minSupportedUI5VersionV4; } });
-const templateAttributes_2 = require("./data/templateAttributes");
 const manifestSettings_1 = require("./data/manifestSettings");
 const semver_1 = __importDefault(require("semver"));
 const i18n_1 = require("./i18n");
+const fiori_generator_shared_1 = require("@sap-ux/fiori-generator-shared");
 exports.V2_FE_TYPES_AVAILABLE = '1.108.0';
 /**
  * Get TypeScript Ignore Glob Pattern.
@@ -89,10 +89,6 @@ async function generate(basePath, data, fs) {
     (0, validate_1.validateApp)(feApp);
     await (0, odata_service_writer_1.generate)(basePath, feApp.service, fs);
     const coercedUI5Version = semver_1.default.coerce(feApp.ui5?.version);
-    const templateOptions = {
-        changesPreview: feApp.ui5?.version ? semver_1.default.lt(coercedUI5Version, templateAttributes_2.changesPreviewToVersion) : false,
-        changesLoader: feApp.service.version === odata_service_writer_1.OdataVersion.v2
-    };
     // Add new files from templates e.g.
     const rootTemplatesPath = (0, path_1.join)(__dirname, '..', 'templates');
     // Add templates common to all template types
@@ -101,10 +97,31 @@ async function generate(basePath, data, fs) {
     if (feApp.appOptions?.typescript === true) {
         ignore = getTypeScriptIgnoreGlob(feApp, coercedUI5Version);
     }
-    fs.copyTpl((0, path_1.join)(rootTemplatesPath, 'common', 'add', '**/*.*'), basePath, {
+    // Determine if the project type is 'EDMXBackend'.
+    const isEdmxProjectType = feApp.app.projectType === 'EDMXBackend';
+    // Get resource bootstrap URLs based on the project type
+    const { uShellBootstrapResourceUrl, uiBootstrapResourceUrl } = (0, fiori_generator_shared_1.getBootstrapResourceUrls)(isEdmxProjectType, feApp.ui5?.frameworkUrl, feApp.ui5?.version);
+    const ui5Libs = isEdmxProjectType ? feApp.ui5?.ui5Libs : undefined;
+    // Define template options with changes preview and loader settings based on project type
+    const templateOptions = (0, defaults_1.getTemplateOptions)(isEdmxProjectType, feApp.service.version, feApp.ui5?.version);
+    const appConfig = {
         ...feApp,
         templateOptions,
-        escapeFLPText: templateAttributes_2.escapeFLPText
+        uShellBootstrapResourceUrl,
+        uiBootstrapResourceUrl,
+        ui5Libs
+    };
+    // Copy templates with configuration
+    fs.copyTpl((0, path_1.join)(rootTemplatesPath, 'common', 'add', '**/*.*'), basePath, {
+        ...appConfig,
+        escapeFLPText: templateAttributes_1.escapeFLPText
+    }, undefined, {
+        globOptions: { ignore, dot: true }
+    });
+    fs.copyTpl((0, path_1.join)(rootTemplatesPath, 'common', 'add', '**/*.*'), basePath, {
+        ...appConfig,
+        templateOptions,
+        escapeFLPText: templateAttributes_1.escapeFLPText
     }, undefined, {
         globOptions: { ignore, dot: true }
     });
@@ -136,18 +153,27 @@ async function generate(basePath, data, fs) {
     const addTest = !!feApp.appOptions.addTests &&
         feApp.service?.version === odata_service_writer_1.OdataVersion.v4 &&
         (!!feApp.service?.metadata || feApp.service.type === odata_service_writer_1.ServiceType.CDS);
-    packageJson.scripts = Object.assign(packageJson.scripts ?? {}, {
-        ...(0, packageConfig_1.getPackageJsonTasks)({
-            localOnly: !feApp.service?.url,
-            addMock: !!feApp.service?.metadata,
-            addTest,
-            sapClient: feApp.service?.client,
-            flpAppId: feApp.app.flpAppId,
-            startFile: data?.app?.startFile,
-            localStartFile: data?.app?.localStartFile,
-            generateIndex: feApp.appOptions?.generateIndex
-        })
-    });
+    if (isEdmxProjectType) {
+        // Add scripts to package.json only for non-CAP projects
+        packageJson.scripts = Object.assign(packageJson.scripts ?? {}, {
+            ...(0, packageConfig_1.getPackageJsonTasks)({
+                localOnly: !feApp.service?.url,
+                addMock: !!feApp.service?.metadata,
+                addTest,
+                sapClient: feApp.service?.client,
+                flpAppId: feApp.app.flpAppId,
+                startFile: data?.app?.startFile,
+                localStartFile: data?.app?.localStartFile,
+                generateIndex: feApp.appOptions?.generateIndex
+            })
+        });
+    }
+    else {
+        // Add deploy-config script for CAP projects
+        packageJson.scripts = {
+            'deploy-config': 'npx -p @sap/ux-ui5-tooling fiori add deploy-config cf'
+        };
+    }
     fs.writeJSON(packagePath, packageJson);
     if (addTest) {
         (0, ui5_test_writer_1.generateOPAFiles)(basePath, {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/fiori-elements-writer",
   "description": "SAP Fiori elements application writer",
-  "version": "0.23.2",
+  "version": "1.0.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -27,11 +27,12 @@
     "mem-fs-editor": "9.4.0",
     "read-pkg-up": "7.0.1",
     "semver": "7.5.4",
-    "@sap-ux/odata-service-writer": "0.21.1",
-    "@sap-ux/ui5-application-writer": "0.27.2",
+    "@sap-ux/odata-service-writer": "0.22.0",
+    "@sap-ux/ui5-application-writer": "1.0.0",
     "@sap-ux/fe-fpm-writer": "0.25.0",
     "@sap-ux/ui5-config": "0.23.1",
-    "@sap-ux/ui5-test-writer": "0.4.0"
+    "@sap-ux/ui5-test-writer": "0.4.0",
+    "@sap-ux/fiori-generator-shared": "0.3.0"
   },
   "devDependencies": {
     "@types/ejs": "3.1.2",

package/templates/common/add/webapp/test/flpSandbox.html

@@ -55,11 +55,11 @@
         };
     </script>
 
-    <script src="../test-resources/sap/ushell/bootstrap/sandbox.js" id="sap-ushell-bootstrap"></script>
+    <script src="<%- locals.uShellBootstrapResourceUrl %>" id="sap-ushell-bootstrap"></script>
     <!-- Bootstrap the UI5 core library. 'data-sap-ui-frameOptions="allow"'' is a NON-SECURE setting for test environments -->
     <script id="sap-ui-bootstrap"
-        src="../resources/sap-ui-core.js"
-        data-sap-ui-libs="<%- ui5.ui5Libs %>"
+        src="<%- locals.uiBootstrapResourceUrl %>"
+        data-sap-ui-libs="<%= locals.ui5Libs %>"
         data-sap-ui-async="true"
         data-sap-ui-preload="async"
         data-sap-ui-theme="<%- ui5.ui5Theme %>"