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

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/guided-answers/guided-answers-icon_svg_base64.d.ts

@@ -0,0 +1,2 @@
+export declare const GUIDED_ANSWERS_ICON = "data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMTIiIGhlaWdodD0iMTIiIHZpZXdCb3g9IjAgMCAxMiAxMiIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPGcgY2xpcC1wYXRoPSJ1cmwoI2NsaXAwXzM0NTRfMTc4MDUpIj4KPHBhdGggZmlsbC1ydWxlPSJldmVub2RkIiBjbGlwLXJ1bGU9ImV2ZW5vZGQiIGQ9Ik0xMSA3LjI0MjIzVjkuNUMxMSA5LjY4OTM5IDEwLjg5MyA5Ljg2MjUyIDEwLjcyMzYgOS45NDcyMUw3LjcyMzYxIDExLjQ0NzJDNy41OTkyNSAxMS41MDk0IDcuNDU0NjIgMTEuNTE3IDcuMzI0NDQgMTEuNDY4MkwzLjQ5MDE4IDEwLjAzMDNMMC42NTgxMTQgMTAuOTc0M0MwLjUwNTY0IDExLjAyNTIgMC4zMzgwMjkgMTAuOTk5NiAwLjIwNzY0NSAxMC45MDU2QzAuMDc3MjYwNiAxMC44MTE2IDAgMTAuNjYwNyAwIDEwLjVWMi41QzAgMi4yODQ3OCAwLjEzNzcxNSAyLjA5MzcyIDAuMzQxODg2IDIuMDI1NjZMMy4zNDE4OSAxLjAyNTY2QzMuNDQ3OTcgMC45OTAyOTYgMy41NjI4NiAwLjk5MTUxNyAzLjY2ODE3IDEuMDI5MTNMNC41NDkyNSAxLjM0MzhDNC4zOTAxOSAxLjYzNDYzIDQuMjYyMyAxLjk0NDk0IDQuMTcwMDkgMi4yNzAyNUw0IDIuMjA5NVY5LjE1MzVMNyAxMC4yNzg1VjcuNzQzOTRDNy4zMTg0MSA3Ljg1NjQ4IDcuNjUzMjcgNy45MzQyMSA4IDcuOTcyNTRWMTAuMTkxTDEwIDkuMTkwOThWNy43NDM5NEMxMC4zNTYgNy42MTgxIDEwLjY5MTUgNy40NDg3MyAxMSA3LjI0MjIzWk0xIDkuODA2MjlWMi44NjAzOEwzIDIuMTkzNzFWOS4xMzk2MkwxIDkuODA2MjlaIiBmaWxsPSIjQzVDNUM1Ii8+CjxwYXRoIGZpbGwtcnVsZT0iZXZlbm9kZCIgY2xpcC1ydWxlPSJldmVub2RkIiBkPSJNNSAzLjQ2NjIyQzUgNC4yNTM4IDUuMjYyNjcgNC45ODAwMyA1LjcwNTE4IDUuNTYyMDlMNS4zNzc1OCA3LjQyTDcuMjg0NzEgNi43MjU4NkM3LjY1MzQ1IDYuODU5NTUgOC4wNTEzMiA2LjkzMjQ0IDguNDY2MjIgNi45MzI0NEMxMC4zODA2IDYuOTMyNDQgMTEuOTMyNCA1LjM4MDU2IDExLjkzMjQgMy40NjYyMkMxMS45MzI0IDEuNTUxODggMTAuMzgwNiAwIDguNDY2MjIgMEM2LjU1MTg4IDAgNSAxLjU1MTg4IDUgMy40NjYyMlpNOCAxLjVDOCAxLjIyMzg2IDguMjIzODYgMSA4LjUgMUM4Ljc3NjE0IDEgOSAxLjIyMzg2IDkgMS41QzkgMS43NzYxNCA4Ljc3NjE0IDIgOC41IDJDOC4yMjM4NiAyIDggMS43NzYxNCA4IDEuNVpNOC41IDNDOC4yMjM4NiAzIDggMy4yMjM4NiA4IDMuNVY1LjVDOCA1Ljc3NjE0IDguMjIzODYgNiA4LjUgNkM4Ljc3NjE0IDYgOSA1Ljc3NjE0IDkgNS41VjMuNUM5IDMuMjIzODYgOC43NzYxNCAzIDguNSAzWiIgZmlsbD0iI0M1QzVDNSIvPgo8L2c+CjxkZWZzPgo8Y2xpcFBhdGggaWQ9ImNsaXAwXzM0NTRfMTc4MDUiPgo8cmVjdCB3aWR0aD0iMTIiIGhlaWdodD0iMTIiIGZpbGw9IndoaXRlIi8+CjwvY2xpcFBhdGg+CjwvZGVmcz4KPC9zdmc+Cg==";
+//# sourceMappingURL=guided-answers-icon_svg_base64.d.ts.map

package/dist/guided-answers/guided-answers-icon_svg_base64.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GUIDED_ANSWERS_ICON = void 0;
+exports.GUIDED_ANSWERS_ICON = 'data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMTIiIGhlaWdodD0iMTIiIHZpZXdCb3g9IjAgMCAxMiAxMiIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPGcgY2xpcC1wYXRoPSJ1cmwoI2NsaXAwXzM0NTRfMTc4MDUpIj4KPHBhdGggZmlsbC1ydWxlPSJldmVub2RkIiBjbGlwLXJ1bGU9ImV2ZW5vZGQiIGQ9Ik0xMSA3LjI0MjIzVjkuNUMxMSA5LjY4OTM5IDEwLjg5MyA5Ljg2MjUyIDEwLjcyMzYgOS45NDcyMUw3LjcyMzYxIDExLjQ0NzJDNy41OTkyNSAxMS41MDk0IDcuNDU0NjIgMTEuNTE3IDcuMzI0NDQgMTEuNDY4MkwzLjQ5MDE4IDEwLjAzMDNMMC42NTgxMTQgMTAuOTc0M0MwLjUwNTY0IDExLjAyNTIgMC4zMzgwMjkgMTAuOTk5NiAwLjIwNzY0NSAxMC45MDU2QzAuMDc3MjYwNiAxMC44MTE2IDAgMTAuNjYwNyAwIDEwLjVWMi41QzAgMi4yODQ3OCAwLjEzNzcxNSAyLjA5MzcyIDAuMzQxODg2IDIuMDI1NjZMMy4zNDE4OSAxLjAyNTY2QzMuNDQ3OTcgMC45OTAyOTYgMy41NjI4NiAwLjk5MTUxNyAzLjY2ODE3IDEuMDI5MTNMNC41NDkyNSAxLjM0MzhDNC4zOTAxOSAxLjYzNDYzIDQuMjYyMyAxLjk0NDk0IDQuMTcwMDkgMi4yNzAyNUw0IDIuMjA5NVY5LjE1MzVMNyAxMC4yNzg1VjcuNzQzOTRDNy4zMTg0MSA3Ljg1NjQ4IDcuNjUzMjcgNy45MzQyMSA4IDcuOTcyNTRWMTAuMTkxTDEwIDkuMTkwOThWNy43NDM5NEMxMC4zNTYgNy42MTgxIDEwLjY5MTUgNy40NDg3MyAxMSA3LjI0MjIzWk0xIDkuODA2MjlWMi44NjAzOEwzIDIuMTkzNzFWOS4xMzk2MkwxIDkuODA2MjlaIiBmaWxsPSIjQzVDNUM1Ii8+CjxwYXRoIGZpbGwtcnVsZT0iZXZlbm9kZCIgY2xpcC1ydWxlPSJldmVub2RkIiBkPSJNNSAzLjQ2NjIyQzUgNC4yNTM4IDUuMjYyNjcgNC45ODAwMyA1LjcwNTE4IDUuNTYyMDlMNS4zNzc1OCA3LjQyTDcuMjg0NzEgNi43MjU4NkM3LjY1MzQ1IDYuODU5NTUgOC4wNTEzMiA2LjkzMjQ0IDguNDY2MjIgNi45MzI0NEMxMC4zODA2IDYuOTMyNDQgMTEuOTMyNCA1LjM4MDU2IDExLjkzMjQgMy40NjYyMkMxMS45MzI0IDEuNTUxODggMTAuMzgwNiAwIDguNDY2MjIgMEM2LjU1MTg4IDAgNSAxLjU1MTg4IDUgMy40NjYyMlpNOCAxLjVDOCAxLjIyMzg2IDguMjIzODYgMSA4LjUgMUM4Ljc3NjE0IDEgOSAxLjIyMzg2IDkgMS41QzkgMS43NzYxNCA4Ljc3NjE0IDIgOC41IDJDOC4yMjM4NiAyIDggMS43NzYxNCA4IDEuNVpNOC41IDNDOC4yMjM4NiAzIDggMy4yMjM4NiA4IDMuNVY1LjVDOCA1Ljc3NjE0IDguMjIzODYgNiA4LjUgNkM4Ljc3NjE0IDYgOSA1Ljc3NjE0IDkgNS41VjMuNUM5IDMuMjIzODYgOC43NzYxNCAzIDguNSAzWiIgZmlsbD0iI0M1QzVDNSIvPgo8L2c+CjxkZWZzPgo8Y2xpcFBhdGggaWQ9ImNsaXAwXzM0NTRfMTc4MDUiPgo8cmVjdCB3aWR0aD0iMTIiIGhlaWdodD0iMTIiIGZpbGw9IndoaXRlIi8+CjwvY2xpcFBhdGg+CjwvZGVmcz4KPC9zdmc+Cg==';
+//# sourceMappingURL=guided-answers-icon_svg_base64.js.map

package/dist/guided-answers/help-topics.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Mapping of human readable help topic to implementation specific ids
+ * Help items are nodes under a root tree item. A node may have n additonal nodes.
+ *
+ */
+export declare const enum HELP_TREE {
+    FIORI_TOOLS = 3046
+}
+/**
+ * Individual help topics which are mapped to node ids
+ */
+export declare const HELP_NODES: {
+    FIORI_TOOLS: number;
+    DEV_PLATFORM: number;
+    FIORI_APP_GENERATOR: number;
+    BAS_CATALOG_SERVICES_REQUEST_FAILED: number;
+    APPLICATION_PREVIEW: number;
+    CERTIFICATE_ERROR: number;
+    DESTINATION_MISCONFIGURED: number;
+    DESTINATION_UNAVAILABLE: number;
+    DESTINATION_NOT_FOUND: number;
+    BAD_GATEWAY: number;
+    DESTINATION_BAD_GATEWAY_503: number;
+    NO_V4_SERVICES: number;
+    NO_ADT_SERVICE_AUTH: number;
+};
+export declare const GUIDED_ANSWERS_EXTENSION_ID = "saposs.sap-guided-answers-extension";
+export declare const GUIDED_ANSWERS_LAUNCH_CMD_ID = "sap.ux.guidedAnswer.openGuidedAnswer";
+/**
+ * Creates a help url for the specified tree and node ids. If node ids are not specified the root tree path
+ * will be returned, which may not be a valid help page.
+ *
+ * @param treeId - the tree id
+ * @param nodeIds - the node ids
+ * @returns - the help url
+ */
+export declare function getHelpUrl(treeId: number, nodeIds: number[]): string;
+//# sourceMappingURL=help-topics.d.ts.map

package/dist/guided-answers/help-topics.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getHelpUrl = exports.GUIDED_ANSWERS_LAUNCH_CMD_ID = exports.GUIDED_ANSWERS_EXTENSION_ID = exports.HELP_NODES = void 0;
+/**
+ * Individual help topics which are mapped to node ids
+ */
+exports.HELP_NODES = {
+    FIORI_TOOLS: 45995, // The root of all Fiori Tools help
+    DEV_PLATFORM: 45996, // Environment specific selection, vscode or BAS
+    FIORI_APP_GENERATOR: 48363, // Fiori application generator
+    BAS_CATALOG_SERVICES_REQUEST_FAILED: 48366, // BAS specific catalog service request failure
+    APPLICATION_PREVIEW: 52881, // App preview failure
+    CERTIFICATE_ERROR: 53643,
+    DESTINATION_MISCONFIGURED: 54336, // Missing additional property
+    DESTINATION_UNAVAILABLE: 51208, // Launchpad service is not subscribed to
+    DESTINATION_NOT_FOUND: 51208, // Destination URL is returning an empty response
+    BAD_GATEWAY: 48366, // Bad gateway 502
+    DESTINATION_BAD_GATEWAY_503: 52526, // Destination Service Unavailable 503
+    NO_V4_SERVICES: 57573, // No V4 OData services available
+    NO_ADT_SERVICE_AUTH: 57266 //Users does not have authorizations to use ADT services
+};
+exports.GUIDED_ANSWERS_EXTENSION_ID = 'saposs.sap-guided-answers-extension';
+exports.GUIDED_ANSWERS_LAUNCH_CMD_ID = 'sap.ux.guidedAnswer.openGuidedAnswer';
+const GUIDED_ANSWERS_SUPPORT_BASE_URL = 'https://ga.support.sap.com/dtp/viewer/index.html';
+/**
+ * Creates a help url for the specified tree and node ids. If node ids are not specified the root tree path
+ * will be returned, which may not be a valid help page.
+ *
+ * @param treeId - the tree id
+ * @param nodeIds - the node ids
+ * @returns - the help url
+ */
+function getHelpUrl(treeId, nodeIds) {
+    let actions = '';
+    if (nodeIds.length > 0) {
+        actions = `/actions/${nodeIds.join(':')}`;
+    }
+    return `${GUIDED_ANSWERS_SUPPORT_BASE_URL}#/tree/${treeId}${actions}`;
+}
+exports.getHelpUrl = getHelpUrl;
+//# sourceMappingURL=help-topics.js.map

package/dist/guided-answers/index.d.ts

@@ -0,0 +1,3 @@
+export * from './guided-answers-icon_svg_base64';
+export * from './help-topics';
+//# sourceMappingURL=index.d.ts.map

package/dist/guided-answers/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./guided-answers-icon_svg_base64"), exports);
+__exportStar(require("./help-topics"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.d.ts

@@ -1,4 +1,7 @@
 export * from './cap';
+export * from './environment';
+export * from './guided-answers';
 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,11 @@ 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);
+__exportStar(require("./guided-answers"), 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.14",
   "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": {