@sap-ux/ui5-application-writer 0.27.2 → 1.0.0

package/dist/data/defaults.d.ts

@@ -4,9 +4,10 @@ import type { App, AppOptions, Package, UI5 } from '../types';
  *
  * @param {string} [version] - the package version
  * @param {string} [description] - the package description
+ * @param {boolean} [isEdmxProjectType] - whether the project type is Edmx or CAP
  * @returns {Partial<Package>} the package instance
  */
-export declare function packageDefaults(version?: string, description?: string): Partial<Package>;
+export declare function packageDefaults(version?: string, description?: string, isEdmxProjectType?: boolean): Partial<Package>;
 /**
  * Returns an app instance merged with default properties.
  *

package/dist/data/defaults.js

@@ -15,22 +15,33 @@ const mergeWith_1 = __importDefault(require("lodash/mergeWith"));
  *
  * @param {string} [version] - the package version
  * @param {string} [description] - the package description
+ * @param {boolean} [isEdmxProjectType] - whether the project type is Edmx or CAP
  * @returns {Partial<Package>} the package instance
  */
-function packageDefaults(version, description) {
-    return {
+function packageDefaults(version, description, isEdmxProjectType) {
+    const defaults = {
         version: version || '0.0.1',
         description: description || '',
         devDependencies: {
             '@ui5/cli': '^3.0.0',
             '@sap/ux-ui5-tooling': '1'
-        },
-        scripts: {
-            start: 'ui5 serve --config=ui5.yaml --open index.html',
-            'start-local': 'ui5 serve --config=ui5-local.yaml --open index.html',
-            build: 'ui5 build --config=ui5.yaml --clean-dest --dest dist'
         }
     };
+    if (isEdmxProjectType) {
+        // Add scripts for non-CAP projects
+        return {
+            ...defaults,
+            scripts: {
+                start: 'ui5 serve --config=ui5.yaml --open index.html',
+                'start-local': 'ui5 serve --config=ui5-local.yaml --open index.html',
+                build: 'ui5 build --config=ui5.yaml --clean-dest --dest dist'
+            }
+        };
+    }
+    return {
+        ...defaults,
+        scripts: {}
+    };
 }
 exports.packageDefaults = packageDefaults;
 /**

package/dist/data/index.js

@@ -20,8 +20,11 @@ function mergeWithDefaults(ui5App) {
         ui5App.appOptions.codeAssist = false;
     }
     ui5App.ui5 = (0, defaults_1.mergeUi5)(ui5App.ui5 || {}, ui5App.appOptions);
-    ui5App.package = (0, ui5_config_1.mergeObjects)((0, defaults_1.packageDefaults)(ui5App.package.version, ui5App.app.description), ui5App.package);
-    if (ui5App.appOptions.sapux) {
+    // 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);
     }

package/dist/index.js

@@ -26,7 +26,20 @@ async function generate(basePath, ui5AppConfig, fs) {
     if (ui5AppConfig.appOptions?.generateIndex === false) {
         ignore.push('**/webapp/index.html');
     }
-    fs.copyTpl((0, path_1.join)(tmplPath, 'core', '**/*.*'), (0, path_1.join)(basePath), ui5App, undefined, {
+    const isEdmxProjectType = ui5AppConfig.app.projectType === 'EDMXBackend';
+    if (!isEdmxProjectType) {
+        // ignore the ui5-local.yaml file for CAP applications
+        ignore.push('**/ui5-local.yaml');
+        // ignore the .gitignore.tmpl file for CAP applications
+        ignore.push('**/gitignore.tmpl');
+    }
+    // Determine the UI5 resource URL based on project type and UI5 framework details
+    const ui5ResourceUrl = (0, options_1.getTemplateOptions)(isEdmxProjectType, ui5App.ui5?.frameworkUrl, ui5App.ui5?.version);
+    const templateOptions = {
+        ...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')
     });
@@ -40,15 +53,23 @@ async function generate(basePath, ui5AppConfig, fs) {
     });
     ui5Config.addFioriToolsAppReloadMiddleware();
     // ui5-local.yaml
-    const ui5LocalConfigPath = (0, path_1.join)(basePath, 'ui5-local.yaml');
-    const ui5LocalConfig = await ui5_config_1.UI5Config.newInstance(fs.read(ui5LocalConfigPath));
-    ui5LocalConfig.addUI5Framework(ui5App.ui5.framework, ui5App.ui5.localVersion, ui5App.ui5.ui5Libs, ui5App.ui5.ui5Theme);
-    ui5LocalConfig.addFioriToolsAppReloadMiddleware();
-    // Add optional features
-    await (0, options_1.applyOptionalFeatures)(ui5App, fs, basePath, tmplPath, [ui5Config, ui5LocalConfig]);
-    // write ui5 yamls
+    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));
+        ui5LocalConfig.addUI5Framework(ui5App.ui5.framework, ui5App.ui5.localVersion, ui5App.ui5.ui5Libs, ui5App.ui5.ui5Theme);
+        ui5LocalConfig.addFioriToolsAppReloadMiddleware();
+        // Add optional features
+        await (0, options_1.applyOptionalFeatures)(ui5App, fs, basePath, tmplPath, [ui5Config, ui5LocalConfig]);
+        // write ui5 local yaml
+        fs.write(ui5LocalConfigPath, ui5LocalConfig.toString());
+    }
+    else {
+        // Add optional features
+        await (0, options_1.applyOptionalFeatures)(ui5App, fs, basePath, tmplPath, [ui5Config]);
+    }
+    // write ui5 yaml
     fs.write(ui5ConfigPath, ui5Config.toString());
-    fs.write(ui5LocalConfigPath, ui5LocalConfig.toString());
     return fs;
 }
 exports.generate = generate;

package/dist/options.d.ts

@@ -1,6 +1,7 @@
 import type { Editor } from 'mem-fs-editor';
 import type { Ui5App } from './types';
 import type { UI5Config } from '@sap-ux/ui5-config';
+import type { ProjectType } from '@sap-ux/project-access';
 /**
  * Input required to enable optional features.
  */
@@ -9,6 +10,7 @@ export interface FeatureInput {
         app: {
             id: string;
             baseComponent?: string;
+            projectType?: ProjectType;
         };
     };
     fs: Editor;
@@ -39,4 +41,13 @@ export declare function enableNpmPackageConsumption(input: FeatureInput): Promis
  * @param ui5Configs available UI5 configs
  */
 export declare function applyOptionalFeatures(ui5App: Ui5App, fs: Editor, basePath: string, tmplPath: string, ui5Configs: UI5Config[]): Promise<void>;
+/**
+ * Generates the resource URL based on the project type and ui5 framework details.
+ *
+ * @param {boolean} isEdmxProjectType Indicates if the project type is Edmx or CAP.
+ * @param {string} [frameworkUrl] URL of the ui5 framework.
+ * @param {string} [version] version of the ui5 framework.
+ * @returns {string} - The constructed resource URL based on project type.
+ */
+export declare function getTemplateOptions(isEdmxProjectType: boolean, frameworkUrl?: string, version?: string): string;
 //# sourceMappingURL=options.d.ts.map

package/dist/options.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.applyOptionalFeatures = exports.enableNpmPackageConsumption = exports.enableTypescript = void 0;
+exports.getTemplateOptions = exports.applyOptionalFeatures = exports.enableNpmPackageConsumption = exports.enableTypescript = void 0;
 const path_1 = require("path");
 const ejs_1 = require("ejs");
 const project_access_1 = require("@sap-ux/project-access");
@@ -43,7 +43,11 @@ const factories = {
     codeAssist: async (input) => await copyTemplates('codeAssist', input),
     eslint: async (input) => await copyTemplates('eslint', input),
     loadReuseLibs: async (input) => await copyTemplates('loadReuseLibs', input),
-    sapux: async (input) => await copyTemplates('sapux', input),
+    sapux: async (input) => {
+        if (input.ui5App.app.projectType === 'EDMXBackend') {
+            await copyTemplates('sapux', input);
+        }
+    },
     typescript: async (input) => await enableTypescript(input),
     npmPackageConsumption: async (input) => await enableNpmPackageConsumption(input)
 };
@@ -101,4 +105,29 @@ async function applyOptionalFeatures(ui5App, fs, basePath, tmplPath, ui5Configs)
     }
 }
 exports.applyOptionalFeatures = applyOptionalFeatures;
+/**
+ * Generates the resource URL based on the project type and ui5 framework details.
+ *
+ * @param {boolean} isEdmxProjectType Indicates if the project type is Edmx or CAP.
+ * @param {string} [frameworkUrl] URL of the ui5 framework.
+ * @param {string} [version] version of the ui5 framework.
+ * @returns {string} - The constructed resource URL based on project type.
+ */
+function getTemplateOptions(isEdmxProjectType, frameworkUrl, version) {
+    const resourcePath = 'resources/sap-ui-core.js';
+    if (isEdmxProjectType || !frameworkUrl) {
+        // Use relative path for Edmx projects or if frameworkUrl is not available
+        return resourcePath;
+    }
+    else {
+        // return the full URL for CAP projects
+        let url = frameworkUrl;
+        if (version) {
+            url += `/${version}`;
+        }
+        url += `/${resourcePath}`;
+        return url;
+    }
+}
+exports.getTemplateOptions = getTemplateOptions;
 //# sourceMappingURL=options.js.map

package/dist/types.d.ts

@@ -1,3 +1,4 @@
+import type { ProjectType } from '@sap-ux/project-access';
 export interface Package {
     name: string;
     version?: string;
@@ -11,6 +12,18 @@ export interface Package {
 }
 export interface App {
     id: string;
+    /**
+     * The type of project being processed.
+     * For projects of type 'CAPJava' or 'CAPNodejs':
+     *  - Exclude `ui5-local.yaml` and `.gitignore` from the template.
+     *  - Update `package.json` to include only the script `deploy-config`.
+     *  - Use full URLs to determine resource URLs in `webapp/index.html` and `flpSandbox.html`.
+     * For projects of type 'EDMXBackend':
+     *  - Include `ui5-local.yaml` and `.gitignore` in the template.
+     *  - Update `package.json` to include the following scripts: start, start-local, build, start-noflp, start-mock, int-test, deploy, and sap-ux.
+     *  - Include relative URLs to determine resource URLs in `webapp/index.html` and `flpSandbox.html`.
+     */
+    projectType: ProjectType;
     version?: string;
     title?: string;
     description?: 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": "0.27.2",
+  "version": "1.0.0",
   "license": "Apache-2.0",
   "main": "dist/index.js",
   "files": [
@@ -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.25.3"
+    "@sap-ux/project-access": "1.25.4"
   },
   "engines": {
     "node": ">=18.x"

package/templates/core/webapp/index.html

@@ -12,7 +12,7 @@
     </style>
     <script
         id="sap-ui-bootstrap"
-        src="resources/sap-ui-core.js"
+        src="<%- locals.ui5ResourceUrl %>"
         data-sap-ui-theme="<%- ui5.ui5Theme %>"
         data-sap-ui-resourceroots='{
             "<%- app.id %>": "./"