@sap-ux/fiori-generator-shared 0.3.13 → 0.3.15

package/dist/environment.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Determine if the current prompting environment is cli .
+ *
+ * @returns true if it is a cli environment, false otherwise
+ */
+export declare function isCli(): boolean;
+//# sourceMappingURL=environment.d.ts.map

package/dist/environment.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isCli = void 0;
+/**
+ * Determine if the current prompting environment is cli .
+ *
+ * @returns true if it is a cli environment, false otherwise
+ */
+function isCli() {
+    if (process.argv[1]?.includes('yo') || process.stdin.isTTY) {
+        return true;
+    }
+    else {
+        return false;
+    }
+}
+exports.isCli = isCli;
+//# sourceMappingURL=environment.js.map

package/dist/index.d.ts

@@ -1,4 +1,6 @@
 export * from './cap';
+export * from './environment';
 export { getBootstrapResourceUrls } from './helpers';
 export { generateReadMe } from './read-me';
+export * from './system-utils';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -16,8 +16,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateReadMe = exports.getBootstrapResourceUrls = void 0;
 __exportStar(require("./cap"), exports);
+__exportStar(require("./environment"), exports);
 var helpers_1 = require("./helpers");
 Object.defineProperty(exports, "getBootstrapResourceUrls", { enumerable: true, get: function () { return helpers_1.getBootstrapResourceUrls; } });
 var read_me_1 = require("./read-me");
 Object.defineProperty(exports, "generateReadMe", { enumerable: true, get: function () { return read_me_1.generateReadMe; } });
+__exportStar(require("./system-utils"), exports);
 //# sourceMappingURL=index.js.map

package/dist/system-utils.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Relevant values for display extended system properties to the UI
+ */
+export declare enum Suffix {
+    S4HC = "S4HC",
+    BTP = "BTP"
+}
+/**
+ * Get the system display name.
+ *
+ * @param systemName - system name
+ * @param displayUsername - display username
+ * @param isBtp - is BTP
+ * @param isS4HC - is S/4 Hana Cloud
+ * @returns system display name
+ */
+export declare function getSystemDisplayName(systemName: string, displayUsername?: string, isBtp?: boolean, isS4HC?: boolean): string;
+//# sourceMappingURL=system-utils.d.ts.map

package/dist/system-utils.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSystemDisplayName = exports.Suffix = void 0;
+/**
+ * Relevant values for display extended system properties to the UI
+ */
+var Suffix;
+(function (Suffix) {
+    Suffix["S4HC"] = "S4HC";
+    Suffix["BTP"] = "BTP";
+})(Suffix || (exports.Suffix = Suffix = {}));
+/**
+ * Escape any special RegExp character that we want to use literally.
+ *
+ * @param str string input
+ * @returns string a cleansed version of the input
+ */
+function escapeRegExp(str) {
+    return str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string
+}
+/**
+ * Trim, cleanse and return a system name appended with the appropriate suffix i.e. BTP | S4HC.
+ *
+ * @param systemName name of the system
+ * @param suffix the appropriate suffix appended, BTP | S4HC
+ * @returns string return an escaped string, appended with the appropriate suffix
+ */
+function addSuffix(systemName, suffix) {
+    const suffixStr = ` (${suffix})`;
+    return RegExp(`${escapeRegExp(suffixStr)}$`).exec(systemName.trim()) ? systemName : `${systemName} (${suffix})`;
+}
+/**
+ * Get the system display name.
+ *
+ * @param systemName - system name
+ * @param displayUsername - display username
+ * @param isBtp - is BTP
+ * @param isS4HC - is S/4 Hana Cloud
+ * @returns system display name
+ */
+function getSystemDisplayName(systemName, displayUsername, isBtp = false, isS4HC = false) {
+    const userDisplayName = displayUsername ? ` [${displayUsername}]` : '';
+    let systemDisplayName;
+    if (isBtp) {
+        systemDisplayName = addSuffix(systemName, Suffix.BTP);
+    }
+    else if (isS4HC) {
+        systemDisplayName = addSuffix(systemName, Suffix.S4HC);
+    }
+    else {
+        systemDisplayName = systemName;
+    }
+    return `${systemDisplayName}${userDisplayName}`;
+}
+exports.getSystemDisplayName = getSystemDisplayName;
+//# sourceMappingURL=system-utils.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.3.13",
+  "version": "0.3.15",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -19,6 +19,7 @@
   "dependencies": {
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",
+    "@sap-ux/btp-utils": "0.15.1",
     "@sap-ux/project-access": "1.26.8"
   },
   "devDependencies": {