@sap-ux/fiori-generator-shared 0.12.1 → 0.12.2

package/README.md

@@ -3,7 +3,7 @@
 Commonly used shared functionality to support the fiori generator.
 Add functionality that may be used by multiple generator modules.
 
-When adding additional templates, ensure the calling function (e.g., generateReadMe) remains at the src directory level to align with the template location pattern used during generator bundling.
+When adding additional templates, ensure the calling function (e.g., generateAppGenInfo) remains at the src directory level to align with the template location pattern used during generator bundling.
 
 ## License
 

package/dist/app-gen-info.d.ts

@@ -0,0 +1,12 @@
+import type { AppGenInfo } from './types';
+import type { Editor } from 'mem-fs-editor';
+/**
+ * Generates a README file and .appGenInfo.json at the specified destination path using the provided configuration and file system editor.
+ *
+ * @param {string} destPath - the desitination path where the info fileswill be created.
+ * @param {AppGenInfo} appGenInfo - the configuration object containing the details to be included in the info files.
+ * @param {Editor} fs - the file system editor instance used to write the info files.
+ * @returns {Editor} the file system editor instance used to write the info files.
+ */
+export declare function generateAppGenInfo(destPath: string, appGenInfo: AppGenInfo, fs: Editor): Editor;
+//# sourceMappingURL=app-gen-info.d.ts.map

package/dist/app-gen-info.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateAppGenInfo = generateAppGenInfo;
+const path_1 = require("path");
+/**
+ * Generates a README file and .appGenInfo.json at the specified destination path using the provided configuration and file system editor.
+ *
+ * @param {string} destPath - the desitination path where the info fileswill be created.
+ * @param {AppGenInfo} appGenInfo - the configuration object containing the details to be included in the info files.
+ * @param {Editor} fs - the file system editor instance used to write the info files.
+ * @returns {Editor} the file system editor instance used to write the info files.
+ */
+function generateAppGenInfo(destPath, appGenInfo, fs) {
+    // N.B. This function must stay at this level in the directory structure, i.e one level below 'templates'
+    // Apply the configuration to generate the README file
+    const templateSourcePath = (0, path_1.join)(__dirname, '../templates/README.md');
+    const templateDestPath = `${destPath}/README.md`;
+    const { externalParameters, ...appGenInfoCore } = appGenInfo;
+    // Write the README file
+    fs.copyTpl(templateSourcePath, templateDestPath, appGenInfoCore);
+    const appGenInfoJson = {
+        generationParameters: appGenInfoCore
+    };
+    if (externalParameters) {
+        appGenInfoJson.externalParameters = [...externalParameters];
+    }
+    // Write the .appGenInfo.json file
+    fs.writeJSON(`${destPath}/.appGenInfo.json`, appGenInfoJson);
+    return fs;
+}
+//# sourceMappingURL=app-gen-info.js.map

package/dist/index.d.ts

@@ -8,6 +8,6 @@ export * from './types';
 export { getPackageScripts } from './npm-package-scripts/getPackageScripts';
 export { getBootstrapResourceUrls } from './ui5/ui5';
 export { getDefaultTargetFolder, isExtensionInstalled } from './vscode-helpers/vscode-helpers';
-export { generateReadMe } from './read-me';
+export { generateAppGenInfo } from './app-gen-info';
 export { getHostEnvironment } from './environment';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getHostEnvironment = exports.generateReadMe = exports.isExtensionInstalled = exports.getDefaultTargetFolder = exports.getBootstrapResourceUrls = exports.getPackageScripts = void 0;
+exports.getHostEnvironment = exports.generateAppGenInfo = exports.isExtensionInstalled = exports.getDefaultTargetFolder = exports.getBootstrapResourceUrls = exports.getPackageScripts = void 0;
 __exportStar(require("./cap"), exports);
 __exportStar(require("./constants"), exports);
 __exportStar(require("./environment"), exports);
@@ -29,8 +29,8 @@ Object.defineProperty(exports, "getBootstrapResourceUrls", { enumerable: true, g
 var vscode_helpers_1 = require("./vscode-helpers/vscode-helpers");
 Object.defineProperty(exports, "getDefaultTargetFolder", { enumerable: true, get: function () { return vscode_helpers_1.getDefaultTargetFolder; } });
 Object.defineProperty(exports, "isExtensionInstalled", { enumerable: true, get: function () { return vscode_helpers_1.isExtensionInstalled; } });
-var read_me_1 = require("./read-me");
-Object.defineProperty(exports, "generateReadMe", { enumerable: true, get: function () { return read_me_1.generateReadMe; } });
+var app_gen_info_1 = require("./app-gen-info");
+Object.defineProperty(exports, "generateAppGenInfo", { enumerable: true, get: function () { return app_gen_info_1.generateAppGenInfo; } });
 var environment_1 = require("./environment");
 Object.defineProperty(exports, "getHostEnvironment", { enumerable: true, get: function () { return environment_1.getHostEnvironment; } });
 //# sourceMappingURL=index.js.map

package/dist/types/{read-me.d.ts → app-gen.d.ts}

@@ -1,17 +1,21 @@
 /**
- * Interface representing additional entries for the README file.
+ * Interface representing external parameters for the .appGenInfo.json file.
  */
-interface AdditionalEntries {
-    /** The label for the additional entry. */
-    label: string;
-    /** The value corresponding to the label of the additional entry. */
+export type ExternalParameters = {
+    [key: string]: string | object | object[];
+};
+/**
+ * Interface representing the configuration for entity-related information in AppGen.
+ */
+interface EntityRelatedConfig {
+    type: string;
     value: string;
 }
 /**
- * Interface representing the configuration for generating a README file.
- * Extends OptionalEntries to include dynamic properties along with the core properties.
+ * Interface representing the configuration for generating info files for AppGen i.e. README.md & .appGenInfo.json.
+ * Extendable with externalParameters - which will be used for writing to the .appGenInfo.json file.
  */
-export interface ReadMe {
+export interface AppGenInfo {
     /** The name of the application. */
     appName: string;
     /** The title of the application. */
@@ -50,8 +54,15 @@ export interface ReadMe {
     showMockDataInfo?: boolean;
     /** Text used to launch the application */
     launchText?: string;
-    /** Additional custom entries for the application. */
-    additionalEntries?: AdditionalEntries[];
+    /**
+     * An array used to store information on the various entities, e.g main, navigation entity, and filter entity type.
+     */
+    entityRelatedConfig?: EntityRelatedConfig[];
+    /**
+     * Additional external parameters.
+     * N.B. these will be added to the .appGenInfo.json file only
+     */
+    externalParameters?: ExternalParameters[];
 }
 export {};
-//# sourceMappingURL=read-me.d.ts.map
+//# sourceMappingURL=app-gen.d.ts.map

package/dist/types/{read-me.js → app-gen.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=read-me.js.map
+//# sourceMappingURL=app-gen.js.map

package/dist/types/index.d.ts

@@ -1,4 +1,4 @@
-export * from './read-me';
+export * from './app-gen';
 export * from './environment';
 export * from './headless';
 //# sourceMappingURL=index.d.ts.map

package/dist/types/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./read-me"), exports);
+__exportStar(require("./app-gen"), exports);
 __exportStar(require("./environment"), exports);
 __exportStar(require("./headless"), exports);
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/fiori-generator-shared",
   "description": "Commonly used shared functionality and types to support the fiori generator.",
-  "version": "0.12.1",
+  "version": "0.12.2",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -26,7 +26,7 @@
     "semver": "7.5.4",
     "@sap-ux/btp-utils": "1.1.0",
     "@sap-ux/project-access": "1.30.1",
-    "@sap-ux/telemetry": "0.6.1"
+    "@sap-ux/telemetry": "0.6.2"
   },
   "devDependencies": {
     "@types/mem-fs-editor": "7.0.1",

package/templates/README.md

@@ -16,8 +16,8 @@
 |**UI5 Version**<br><%= locals.ui5Version ? locals.ui5Version : '' %>|
 |**Enable Code Assist Libraries**<br><% if(locals.enableCodeAssist === true) { %><%= "True" %><% } else { %><%= "False" %><% }%>|
 |**Enable TypeScript**<br><% if(locals.enableTypeScript === true) { %><%= "True" %><% } else { %><%= "False" %><% }%>|
-|**Add Eslint configuration**<br><% if(locals.enableEslint === true) { %><%= "True, see https://www.npmjs.com/package/eslint-plugin-fiori-custom for the eslint rules." %><% } else { %><%= "False" %><% }%>|<% if (locals.additionalEntries) locals.additionalEntries.forEach(entry => { %>
-|**<%= entry.label %>**<br><%= entry.value %>|<%})%>
+|**Add Eslint configuration**<br><% if(locals.enableEslint === true) { %><%= "True, see https://www.npmjs.com/package/eslint-plugin-fiori-custom for the eslint rules." %><% } else { %><%= "False" %><% }%>|<% if (locals.entityRelatedConfig) locals.entityRelatedConfig.forEach(entry => { %>
+|**<%= entry.type %>**<br><%= entry.value %>|<%})%>
 
 ## <%= appName %>
 

package/dist/read-me.d.ts

@@ -1,12 +0,0 @@
-import type { ReadMe } from './types';
-import type { Editor } from 'mem-fs-editor';
-/**
- * Generates a README file at the specified destination path using the provided configuration and file system editor.
- *
- * @param {string} destPath - The desitination path where the README file will be created.
- * @param {ReadMe} readMe - The configuration object containing the details to be included in the README file.
- * @param {Editor} fs - The file system editor instance used to write the README file.
- * @returns {Editor} The file system editor instance used to write the README file.
- */
-export declare function generateReadMe(destPath: string, readMe: ReadMe, fs: Editor): Editor;
-//# sourceMappingURL=read-me.d.ts.map

package/dist/read-me.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateReadMe = generateReadMe;
-const path_1 = require("path");
-/**
- * Generates a README file at the specified destination path using the provided configuration and file system editor.
- *
- * @param {string} destPath - The desitination path where the README file will be created.
- * @param {ReadMe} readMe - The configuration object containing the details to be included in the README file.
- * @param {Editor} fs - The file system editor instance used to write the README file.
- * @returns {Editor} The file system editor instance used to write the README file.
- */
-function generateReadMe(destPath, readMe, fs) {
-    // N.B. This function must stay at this level in the directory structure, i.e one level below 'templates'
-    // Apply the configuration to generate the README file
-    const templateSourcePath = (0, path_1.join)(__dirname, '../templates/README.md');
-    const templateDestPath = `${destPath}/README.md`;
-    // copy template
-    fs.copyTpl(templateSourcePath, templateDestPath, readMe);
-    return fs;
-}
-//# sourceMappingURL=read-me.js.map