@sap-ux/deploy-config-generator-shared 0.0.3 → 0.0.5

package/dist/base/generator.d.ts

@@ -12,6 +12,7 @@ export declare abstract class DeploymentGenerator extends Generator {
      * @param options - options passed to the generator
      */
     constructor(args: string | string[], options: Generator.GeneratorOptions);
+    initializing(): Promise<void>;
     /**
      * Get the logger instance.
      *

package/dist/base/generator.js

@@ -25,7 +25,9 @@ class DeploymentGenerator extends yeoman_generator_1.default {
         DeploymentGenerator._logger =
             this.options.logWrapper ??
                 this._configureLogging(this.options.logLevel, this.options.logger, this.options.vscode);
-        DeploymentGenerator.logger?.debug((0, utils_1.t)('debug.loggerInitialised'));
+    }
+    async initializing() {
+        await (0, utils_1.initI18n)();
     }
     /**
      * Get the logger instance.

package/dist/index.d.ts

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

package/dist/index.js

@@ -1,10 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.handleErrorMessage = exports.bail = exports.ErrorMessages = exports.DeploymentGenerator = void 0;
+exports.ErrorMessages = 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");
-Object.defineProperty(exports, "ErrorMessages", { enumerable: true, get: function () { return utils_1.ErrorMessages; } });
+Object.defineProperty(exports, "initI18n", { enumerable: true, get: function () { return utils_1.initI18n; } });
 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; } });
 //# sourceMappingURL=index.js.map

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

@@ -1,20 +1,21 @@
 {
     "errors": {
         "abortSignal": "ABORT_SIGNAL",
-        "cannotReadUi5Config": "Cannot read ui5.yaml: {{reason}}",
+        "cannotReadUi5Config": "Cannot read ui5.yaml: {{- reason}}",
         "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",
+        "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}}",
+        "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}}",
+        "noMtaInRoot": "Error: no {{mtaFileName}} in {{- root}}",
         "noPath": "Cannot find \"path\" in backend configuration in ui5.yaml",
         "unrecognizedTarget": "Unrecognized target: {{target}}"
     },

package/dist/utils/conditions.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Show overwrite question if certain conditions are met.
+ *
+ * @param configExists - if the config file already exists
+ * @param launchDeployConfigAsSubGenerator - if the generator is launched as a subgenerator
+ * @param launchStandaloneFromYui - if the generator is launched as a standalone generator in YUI
+ * @param overwriteOption - if the overwrite option is set
+ * @returns - if the overwrite question should be shown
+ */
+export declare function showOverwriteQuestion(configExists: boolean, launchDeployConfigAsSubGenerator?: boolean, launchStandaloneFromYui?: boolean, overwriteOption?: boolean): boolean;
+//# sourceMappingURL=conditions.d.ts.map

package/dist/utils/conditions.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.showOverwriteQuestion = void 0;
+/**
+ * Show overwrite question if certain conditions are met.
+ *
+ * @param configExists - if the config file already exists
+ * @param launchDeployConfigAsSubGenerator - if the generator is launched as a subgenerator
+ * @param launchStandaloneFromYui - if the generator is launched as a standalone generator in YUI
+ * @param overwriteOption - if the overwrite option is set
+ * @returns - if the overwrite question should be shown
+ */
+function showOverwriteQuestion(configExists, launchDeployConfigAsSubGenerator = true, launchStandaloneFromYui, overwriteOption) {
+    // Don't show this question in wrapper generator
+    const showQuestion = launchDeployConfigAsSubGenerator && !launchStandaloneFromYui ? false : Boolean(!overwriteOption);
+    return showQuestion && configExists;
+}
+exports.showOverwriteQuestion = showOverwriteQuestion;
+//# sourceMappingURL=conditions.js.map

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

@@ -7,6 +7,7 @@ export declare class ErrorMessages {
     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;

package/dist/utils/error-handler.js

@@ -14,6 +14,7 @@ class ErrorMessages {
     static abortSignal = (0, i18n_1.t)('errors.abortSignal'); // check this one, is ABORT_SIGNAL signifcant? or can we just throw an error?
     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');

package/dist/utils/i18n.d.ts

@@ -1,4 +1,8 @@
 import type { TOptions } from 'i18next';
+/**
+ * Initialize i18next with the translations for this module.
+ */
+export declare function initI18n(): Promise<void>;
 /**
  * Helper function facading the call to i18next. Unless a namespace option is provided the local namespace will be used.
  *

package/dist/utils/i18n.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.t = void 0;
+exports.t = exports.initI18n = void 0;
 const i18next_1 = __importDefault(require("i18next"));
 const deploy_config_generator_shared_i18n_json_1 = __importDefault(require("../translations/deploy-config-generator-shared.i18n.json"));
 const deployConfigGenShared = 'deploy-config-generator-shared';
@@ -13,6 +13,7 @@ const deployConfigGenShared = 'deploy-config-generator-shared';
 async function initI18n() {
     await i18next_1.default.init({ lng: 'en', fallbackLng: 'en' }, () => i18next_1.default.addResourceBundle('en', deployConfigGenShared, deploy_config_generator_shared_i18n_json_1.default));
 }
+exports.initI18n = initI18n;
 /**
  * Helper function facading the call to i18next. Unless a namespace option is provided the local namespace will be used.
  *

package/dist/utils/index.d.ts

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

package/dist/utils/index.js

@@ -1,10 +1,28 @@
 "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 });
-exports.handleErrorMessage = exports.bail = exports.ErrorMessages = exports.t = void 0;
+exports.handleErrorMessage = exports.bail = exports.ErrorMessages = 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, "bail", { enumerable: true, get: function () { return error_handler_1.bail; } });
 Object.defineProperty(exports, "handleErrorMessage", { enumerable: true, get: function () { return error_handler_1.handleErrorMessage; } });
+__exportStar(require("./types"), exports);
 //# sourceMappingURL=index.js.map

package/dist/utils/types.d.ts

@@ -0,0 +1,9 @@
+import type { ServiceProvider } from '@sap-ux/axios-extension';
+import type { Destination } from '@sap-ux/btp-utils';
+import type { BackendSystem } from '@sap-ux/store';
+export interface ConnectedSystem {
+    serviceProvider?: ServiceProvider;
+    backendSystem?: BackendSystem;
+    destination?: Destination;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/utils/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.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.3",
+  "version": "0.0.5",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -20,11 +20,14 @@
     "@vscode-logging/logger": "2.0.0",
     "i18next": "20.6.1",
     "yeoman-generator": "5.10.0",
-    "@sap-ux/fiori-generator-shared": "0.7.12"
+    "@sap-ux/fiori-generator-shared": "0.7.14"
   },
   "devDependencies": {
     "@types/yeoman-generator": "5.2.11",
-    "typescript": "5.3.3"
+    "typescript": "5.3.3",
+    "@sap-ux/axios-extension": "1.17.7",
+    "@sap-ux/btp-utils": "0.17.1",
+    "@sap-ux/store": "0.9.3"
   },
   "engines": {
     "node": ">=18.x"