@sap-ux/deploy-config-generator-shared 0.0.10 → 0.0.12

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 export { DeploymentGenerator } from './base/generator';
-export { initI18n, bail, handleErrorMessage, showOverwriteQuestion, ErrorMessages, ConnectedSystem } from './utils';
+export { initI18n, bail, handleErrorMessage, showOverwriteQuestion, ErrorHandler, ERROR_TYPE, ConnectedSystem, mtaExecutable } from './utils';
 export { getConfirmConfigUpdatePrompt } from './prompts';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getConfirmConfigUpdatePrompt = exports.ErrorMessages = exports.showOverwriteQuestion = exports.handleErrorMessage = exports.bail = exports.initI18n = exports.DeploymentGenerator = void 0;
+exports.getConfirmConfigUpdatePrompt = exports.mtaExecutable = exports.ERROR_TYPE = exports.ErrorHandler = exports.showOverwriteQuestion = exports.handleErrorMessage = exports.bail = exports.initI18n = exports.DeploymentGenerator = void 0;
 var generator_1 = require("./base/generator");
 Object.defineProperty(exports, "DeploymentGenerator", { enumerable: true, get: function () { return generator_1.DeploymentGenerator; } });
 var utils_1 = require("./utils");
@@ -8,7 +8,9 @@ Object.defineProperty(exports, "initI18n", { enumerable: true, get: function ()
 Object.defineProperty(exports, "bail", { enumerable: true, get: function () { return utils_1.bail; } });
 Object.defineProperty(exports, "handleErrorMessage", { enumerable: true, get: function () { return utils_1.handleErrorMessage; } });
 Object.defineProperty(exports, "showOverwriteQuestion", { enumerable: true, get: function () { return utils_1.showOverwriteQuestion; } });
-Object.defineProperty(exports, "ErrorMessages", { enumerable: true, get: function () { return utils_1.ErrorMessages; } });
+Object.defineProperty(exports, "ErrorHandler", { enumerable: true, get: function () { return utils_1.ErrorHandler; } });
+Object.defineProperty(exports, "ERROR_TYPE", { enumerable: true, get: function () { return utils_1.ERROR_TYPE; } });
+Object.defineProperty(exports, "mtaExecutable", { enumerable: true, get: function () { return utils_1.mtaExecutable; } });
 var prompts_1 = require("./prompts");
 Object.defineProperty(exports, "getConfirmConfigUpdatePrompt", { enumerable: true, get: function () { return prompts_1.getConfirmConfigUpdatePrompt; } });
 //# sourceMappingURL=index.js.map

package/dist/translations/deploy-config-generator-shared.i18n.json

@@ -5,24 +5,15 @@
         }
     },
     "errors": {
-        "abortSignal": "ABORT_SIGNAL",
-        "cannotReadUi5Config": "Cannot read ui5.yaml: {{- reason}}",
+        "abortSignal": "Generator aborted",
         "capDeploymentNoMta": "The SAP Fiori application is within a CAP project and deployment should be configured as part of the CAP project. Please ensure you have a mta.yaml file defined for this project.",
         "fileDoesNotExist": "File does not exist: {{- filePath}}",
         "folderDoesNotExist": "Folder path does not exist: {{- filePath}}",
-        "invalidClient": "[{{- client}}] is invalid. Enter blank or a value between 000-999",
-        "invalidMtaId": "The ID can only contain letters, numbers, dashes, periods and underscores (but no spaces).",
-        "invalidURL": "Invalid URL: [{{- input}}]",
-        "mtaIdAlreadyExists": "A folder with same name already exist at {{- destinationRoot}}",
         "noAppName": "Could not determine app name from manifest",
-        "noUi5Config": "Error: could not read ui5.yaml",
         "noBinary": "Cannot find the \"{{bin}}\" executable. Please add it to the path or use \"npm i -g {{pkg}}\" to install it.",
         "noManifest": "Error: could not read webapp/manifest.json",
-        "noMta": "MTA ID cannot be empty",
-        "noMtaId": "MTA ID cannot be empty",
-        "noMtaInRoot": "Error: no {{mtaFileName}} in {{- root}}",
-        "noPath": "Cannot find \"path\" in backend configuration in ui5.yaml",
-        "unrecognizedTarget": "Unrecognized target: {{target}}"
+        "unrecognizedTarget": "Unrecognized target: {{target}}",
+        "unknownError": "Unknown error"
     },
     "debug": {
         "loggerInitialised": "LogWrapper initialized for DeploymentGenerator"

package/dist/utils/error-handler.d.ts

@@ -1,28 +1,29 @@
 import { type AppWizard } from '@sap-devx/yeoman-ui-types';
+export declare enum ERROR_TYPE {
+    ABORT_SIGNAL = "ABORT_SIGNAL",
+    NO_MANIFEST = "NO_MANIFEST",
+    NO_APP_NAME = "NO_APP_NAME",
+    NO_UI5_CONFIG = "NO_UI5_CONFIG",
+    NO_CDS_BIN = "NO_CDS_BIN",
+    NO_MTA_BIN = "NO_MTA_BIN",
+    CAP_DEPLOYMENT_NO_MTA = "CAP_DEPLOYMENT_NO_MTA"
+}
 /**
  * Error messages for the deploy configuration generator.
  */
-export declare class ErrorMessages {
+export declare class ErrorHandler {
     private static readonly cannotFindBinary;
-    static readonly abortSignal: string;
-    static readonly noManifest: string;
-    static readonly noAppName: string;
-    static readonly noUI5Config: string;
-    static readonly noCdsBin: string;
-    static readonly noMtaBin: string;
-    static readonly noMta: string;
-    static readonly noPath: string;
-    static readonly noMtaId: string;
-    static readonly invalidMtaId: string;
-    static readonly capDeploymentnoMta: string;
-    static readonly mtaIdAlreadyExist: (destinationRoot: string) => string;
-    static readonly noMtaInRoot: (root: string) => string;
+    /**
+     * Get the error message for the specified error type.
+     *
+     * @param errorType The error type for which the message may be returned
+     * @returns The error message for the specified error type
+     */
+    static getErrorMsgFromType(errorType?: ERROR_TYPE): string;
+    private static readonly _errorTypeToMsg;
     static readonly unrecognizedTarget: (target: string) => string;
-    static readonly cannotReadUi5Config: (reason: string) => string;
     static readonly fileDoesNotExist: (filePath: string) => string;
     static readonly folderDoesNotExist: (filePath: string) => string;
-    static readonly invalidClient: (client: string) => string;
-    static readonly invalidURL: (input: string) => string;
 }
 /**
  * Bail out with an error message.
@@ -34,7 +35,12 @@ export declare function bail(errorMessage: string): void;
  * Handle error message, display it in the UI or throws an error in CLI.
  *
  * @param appWizard - AppWizard instance
- * @param errorMsg - Error message to be displayed
+ * @param error - error type or message
+ * @param error.errorType - error type
+ * @param error.errorMsg - error message
  */
-export declare function handleErrorMessage(appWizard: AppWizard, errorMsg: string): void;
+export declare function handleErrorMessage(appWizard: AppWizard, { errorType, errorMsg }: {
+    errorType?: ERROR_TYPE;
+    errorMsg?: string;
+}): void;
 //# sourceMappingURL=error-handler.d.ts.map

package/dist/utils/error-handler.js

@@ -1,37 +1,52 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.handleErrorMessage = exports.bail = exports.ErrorMessages = void 0;
+exports.handleErrorMessage = exports.bail = exports.ErrorHandler = exports.ERROR_TYPE = void 0;
 const fiori_generator_shared_1 = require("@sap-ux/fiori-generator-shared");
 const generator_1 = require("../base/generator");
 const i18n_1 = require("./i18n");
 const constants_1 = require("./constants");
 const yeoman_ui_types_1 = require("@sap-devx/yeoman-ui-types");
+var ERROR_TYPE;
+(function (ERROR_TYPE) {
+    ERROR_TYPE["ABORT_SIGNAL"] = "ABORT_SIGNAL";
+    ERROR_TYPE["NO_MANIFEST"] = "NO_MANIFEST";
+    ERROR_TYPE["NO_APP_NAME"] = "NO_APP_NAME";
+    ERROR_TYPE["NO_UI5_CONFIG"] = "NO_UI5_CONFIG";
+    ERROR_TYPE["NO_CDS_BIN"] = "NO_CDS_BIN";
+    ERROR_TYPE["NO_MTA_BIN"] = "NO_MTA_BIN";
+    ERROR_TYPE["CAP_DEPLOYMENT_NO_MTA"] = "CAP_DEPLOYMENT_NO_MTA";
+})(ERROR_TYPE || (exports.ERROR_TYPE = ERROR_TYPE = {}));
 /**
  * Error messages for the deploy configuration generator.
  */
-class ErrorMessages {
+class ErrorHandler {
     static cannotFindBinary = (bin, pkg) => (0, i18n_1.t)('errors.noBinary', { bin, pkg });
-    static abortSignal = (0, i18n_1.t)('errors.abortSignal');
-    static noManifest = (0, i18n_1.t)('errors.noManifest');
-    static noAppName = (0, i18n_1.t)('errors.noAppName');
-    static noUI5Config = (0, i18n_1.t)('errors.noUi5Config');
-    static noCdsBin = this.cannotFindBinary(constants_1.cdsExecutable, constants_1.cdsPkg);
-    static noMtaBin = this.cannotFindBinary(constants_1.mtaExecutable, constants_1.mtaPkg);
-    static noMta = (0, i18n_1.t)('errors.noMta');
-    static noPath = (0, i18n_1.t)('errors.noPath');
-    static noMtaId = (0, i18n_1.t)('errors.noMtaId');
-    static invalidMtaId = (0, i18n_1.t)('errors.invalidMtaId');
-    static capDeploymentnoMta = (0, i18n_1.t)('errors.capDeploymentNoMta');
-    static mtaIdAlreadyExist = (destinationRoot) => (0, i18n_1.t)('errors.mtaIdAlreadyExists', { destinationRoot });
-    static noMtaInRoot = (root) => (0, i18n_1.t)('errors.noMtaInRoot', { mtaFileName: constants_1.mtaYaml, root });
+    /**
+     * Get the error message for the specified error type.
+     *
+     * @param errorType The error type for which the message may be returned
+     * @returns The error message for the specified error type
+     */
+    static getErrorMsgFromType(errorType) {
+        if (errorType) {
+            return ErrorHandler._errorTypeToMsg[errorType]();
+        }
+        return (0, i18n_1.t)('errors.unknownError');
+    }
+    static _errorTypeToMsg = {
+        [ERROR_TYPE.ABORT_SIGNAL]: () => (0, i18n_1.t)('errors.abortSignal'),
+        [ERROR_TYPE.NO_MANIFEST]: () => (0, i18n_1.t)('errors.noManifest'),
+        [ERROR_TYPE.NO_APP_NAME]: () => (0, i18n_1.t)('errors.noAppName'),
+        [ERROR_TYPE.NO_UI5_CONFIG]: () => (0, i18n_1.t)('errors.noUi5Config'),
+        [ERROR_TYPE.NO_CDS_BIN]: () => ErrorHandler.cannotFindBinary(constants_1.cdsExecutable, constants_1.cdsPkg),
+        [ERROR_TYPE.NO_MTA_BIN]: () => ErrorHandler.cannotFindBinary(constants_1.mtaExecutable, constants_1.mtaPkg),
+        [ERROR_TYPE.CAP_DEPLOYMENT_NO_MTA]: () => (0, i18n_1.t)('errors.capDeploymentNoMta')
+    };
     static unrecognizedTarget = (target) => (0, i18n_1.t)('errors.unrecognizedTarget', { target });
-    static cannotReadUi5Config = (reason) => (0, i18n_1.t)('errors.cannotReadUi5Config', { reason });
     static fileDoesNotExist = (filePath) => (0, i18n_1.t)('errors.fileDoesNotExist', { filePath });
     static folderDoesNotExist = (filePath) => (0, i18n_1.t)('errors.folderDoesNotExist', { filePath });
-    static invalidClient = (client) => (0, i18n_1.t)('errors.invalidClient', { client });
-    static invalidURL = (input) => (0, i18n_1.t)('errors.invalidURL', { input });
 }
-exports.ErrorMessages = ErrorMessages;
+exports.ErrorHandler = ErrorHandler;
 /**
  * Bail out with an error message.
  *
@@ -45,15 +60,18 @@ exports.bail = bail;
  * Handle error message, display it in the UI or throws an error in CLI.
  *
  * @param appWizard - AppWizard instance
- * @param errorMsg - Error message to be displayed
+ * @param error - error type or message
+ * @param error.errorType - error type
+ * @param error.errorMsg - error message
  */
-function handleErrorMessage(appWizard, errorMsg) {
+function handleErrorMessage(appWizard, { errorType, errorMsg }) {
+    const error = errorMsg ?? ErrorHandler.getErrorMsgFromType(errorType);
     if ((0, fiori_generator_shared_1.getHostEnvironment)() === fiori_generator_shared_1.hostEnvironment.cli) {
-        bail(errorMsg);
+        bail(error);
     }
     else {
-        generator_1.DeploymentGenerator.logger?.debug(errorMsg);
-        appWizard?.showError(errorMsg, yeoman_ui_types_1.MessageType.notification);
+        generator_1.DeploymentGenerator.logger?.debug(error);
+        appWizard?.showError(error, yeoman_ui_types_1.MessageType.notification);
     }
 }
 exports.handleErrorMessage = handleErrorMessage;

package/dist/utils/index.d.ts

@@ -1,5 +1,6 @@
 export { t, initI18n } from './i18n';
 export { showOverwriteQuestion } from './conditions';
-export { ErrorMessages, bail, handleErrorMessage } from './error-handler';
+export { ErrorHandler, ERROR_TYPE, bail, handleErrorMessage } from './error-handler';
+export { mtaExecutable } from './constants';
 export * from './types';
 //# sourceMappingURL=index.d.ts.map

package/dist/utils/index.js

@@ -14,15 +14,18 @@ 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.handleErrorMessage = exports.bail = exports.ErrorMessages = exports.showOverwriteQuestion = exports.initI18n = exports.t = void 0;
+exports.mtaExecutable = exports.handleErrorMessage = exports.bail = exports.ERROR_TYPE = exports.ErrorHandler = exports.showOverwriteQuestion = exports.initI18n = exports.t = void 0;
 var i18n_1 = require("./i18n");
 Object.defineProperty(exports, "t", { enumerable: true, get: function () { return i18n_1.t; } });
 Object.defineProperty(exports, "initI18n", { enumerable: true, get: function () { return i18n_1.initI18n; } });
 var conditions_1 = require("./conditions");
 Object.defineProperty(exports, "showOverwriteQuestion", { enumerable: true, get: function () { return conditions_1.showOverwriteQuestion; } });
 var error_handler_1 = require("./error-handler");
-Object.defineProperty(exports, "ErrorMessages", { enumerable: true, get: function () { return error_handler_1.ErrorMessages; } });
+Object.defineProperty(exports, "ErrorHandler", { enumerable: true, get: function () { return error_handler_1.ErrorHandler; } });
+Object.defineProperty(exports, "ERROR_TYPE", { enumerable: true, get: function () { return error_handler_1.ERROR_TYPE; } });
 Object.defineProperty(exports, "bail", { enumerable: true, get: function () { return error_handler_1.bail; } });
 Object.defineProperty(exports, "handleErrorMessage", { enumerable: true, get: function () { return error_handler_1.handleErrorMessage; } });
+var constants_1 = require("./constants");
+Object.defineProperty(exports, "mtaExecutable", { enumerable: true, get: function () { return constants_1.mtaExecutable; } });
 __exportStar(require("./types"), exports);
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/deploy-config-generator-shared",
   "description": "Commonly used shared functionality and types to support the deploy config generator.",
-  "version": "0.0.10",
+  "version": "0.0.12",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -20,7 +20,7 @@
     "@vscode-logging/logger": "2.0.0",
     "i18next": "20.6.1",
     "yeoman-generator": "5.10.0",
-    "@sap-ux/fiori-generator-shared": "0.7.19",
+    "@sap-ux/fiori-generator-shared": "0.7.20",
     "@sap-ux/nodejs-utils": "0.1.4"
   },
   "devDependencies": {