@sap-ux/flp-config-sub-generator 0.4.13 → 1.0.1

package/generators/app/index.d.ts

@@ -1,7 +1,7 @@
 import Generator from 'yeoman-generator';
 import { promptNames } from '@sap-ux/flp-config-inquirer';
 import type { FLPConfigPromptOptions } from '@sap-ux/flp-config-inquirer';
-import type { FlpConfigOptions } from './types';
+import type { FlpConfigOptions } from './types.js';
 /**
  * FLP config generator adds an inbound navigation config to an existing manifest.json.
  */

package/generators/app/index.js

@@ -1,30 +1,23 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.promptNames = void 0;
-const node_path_1 = require("node:path");
-const yeoman_generator_1 = __importDefault(require("yeoman-generator"));
-const logger_1 = __importDefault(require("../utils/logger"));
-const yeoman_ui_types_1 = require("@sap-devx/yeoman-ui-types");
-const deploy_config_generator_shared_1 = require("@sap-ux/deploy-config-generator-shared");
-const flp_config_inquirer_1 = require("@sap-ux/flp-config-inquirer");
-Object.defineProperty(exports, "promptNames", { enumerable: true, get: function () { return flp_config_inquirer_1.promptNames; } });
-const app_config_writer_1 = require("@sap-ux/app-config-writer");
-const project_access_1 = require("@sap-ux/project-access");
-const i18n_1 = require("@sap-ux/i18n");
-const feature_toggle_1 = require("@sap-ux/feature-toggle");
-const fiori_generator_shared_1 = require("@sap-ux/fiori-generator-shared");
-const inquirer_common_1 = require("@sap-ux/inquirer-common");
-const constants_1 = require("../utils/constants");
-const utils_1 = require("../utils");
-const telemetryEvents_1 = require("../telemetryEvents");
+import { join } from 'node:path';
+import Generator from 'yeoman-generator';
+import FlpGenLogger from '../utils/logger.js';
+import { AppWizard, Prompts, MessageType } from '@sap-devx/yeoman-ui-types';
+import { handleErrorMessage, getExtensionGenPromptOpts } from '@sap-ux/deploy-config-generator-shared';
+import { getPrompts, promptNames } from '@sap-ux/flp-config-inquirer';
+import { generateInboundNavigationConfig } from '@sap-ux/app-config-writer';
+import { FileName, getWebappPath, getI18nPropertiesPaths } from '@sap-ux/project-access';
+import { createPropertiesI18nEntries } from '@sap-ux/i18n';
+import { isInternalFeaturesSettingEnabled } from '@sap-ux/feature-toggle';
+import { sendTelemetry, TelemetryHelper, isExtensionInstalled, YUI_EXTENSION_ID, YUI_MIN_VER_FILES_GENERATED_MSG, setYeomanEnvConflicterForce } from '@sap-ux/fiori-generator-shared';
+import { extendWithOptions } from '@sap-ux/inquirer-common';
+import { generatorTitle, i18nKeySubTitle, i18nKeyTitle } from '../utils/constants.js';
+import { t, getPromptOptions, getYUIDetails } from '../utils/index.js';
+import { EventName } from '../telemetryEvents/index.js';
 const flpConfigSubGenNamespace = '@sap-ux/flp-config-sub-generator';
 /**
  * FLP config generator adds an inbound navigation config to an existing manifest.json.
  */
-class default_1 extends yeoman_generator_1.default {
+export default class extends Generator {
     appWizard;
     vscode;
     launchFlpConfigAsSubGenerator;
@@ -46,17 +39,17 @@ class default_1 extends yeoman_generator_1.default {
      */
     constructor(args, opts) {
         super(args, opts);
-        this.appWizard = opts.appWizard ?? yeoman_ui_types_1.AppWizard.create(opts);
+        this.appWizard = opts.appWizard ?? AppWizard.create(opts);
         this.vscode = opts.vscode;
         this.launchFlpConfigAsSubGenerator = opts.launchFlpConfigAsSubGenerator ?? false;
         this.appRootPath = opts.data?.appRootPath ?? opts?.appRootPath ?? this.destinationRoot();
         this.promptOptions = this.options?.inquirerPromptOptions;
         this.options = opts;
-        logger_1.default.configureLogging(this.rootGeneratorName(), this.log, this.options.logWrapper, this.options.logLevel, this.options.logger, this.vscode);
+        FlpGenLogger.configureLogging(this.rootGeneratorName(), this.log, this.options.logWrapper, this.options.logLevel, this.options.logger, this.vscode);
         // If launched standalone, set the header, title and description
         if (!this.launchFlpConfigAsSubGenerator) {
-            this.appWizard.setHeaderTitle(constants_1.generatorTitle);
-            this.prompts = new yeoman_ui_types_1.Prompts((0, utils_1.getYUIDetails)(this.appRootPath));
+            this.appWizard.setHeaderTitle(generatorTitle);
+            this.prompts = new Prompts(getYUIDetails(this.appRootPath));
             this.setPromptsCallback = (fn) => {
                 if (this.prompts) {
                     this.prompts.setCallback(fn);
@@ -66,28 +59,28 @@ class default_1 extends yeoman_generator_1.default {
         }
     }
     async initializing() {
-        (0, fiori_generator_shared_1.setYeomanEnvConflicterForce)(this.env, this.options.force);
-        const extensionPromptOpts = await (0, deploy_config_generator_shared_1.getExtensionGenPromptOpts)(this.env.create.bind(this.env), flpConfigSubGenNamespace, this.vscode);
+        setYeomanEnvConflicterForce(this.env, this.options.force);
+        const extensionPromptOpts = await getExtensionGenPromptOpts(this.env.create.bind(this.env), flpConfigSubGenNamespace, this.vscode);
         this.promptOptions = {
             ...extensionPromptOpts,
             ...this.promptOptions
         };
-        await fiori_generator_shared_1.TelemetryHelper.initTelemetrySettings({
+        await TelemetryHelper.initTelemetrySettings({
             consumerModule: {
                 name: flpConfigSubGenNamespace,
                 version: this.rootGeneratorVersion()
             },
-            internalFeature: (0, feature_toggle_1.isInternalFeaturesSettingEnabled)(),
+            internalFeature: isInternalFeaturesSettingEnabled(),
             watchTelemetrySettingStore: false
         });
         if (this.existingApp) {
-            this.manifestPath = (0, node_path_1.join)(await (0, project_access_1.getWebappPath)(this.appRootPath), project_access_1.FileName.Manifest);
+            this.manifestPath = join(await getWebappPath(this.appRootPath), FileName.Manifest);
             this.manifest = this.fs.readJSON(this.manifestPath);
             if (!this.manifest) {
-                (0, deploy_config_generator_shared_1.handleErrorMessage)(this.appWizard, { errorMsg: (0, utils_1.t)('error.noManifest', { path: this.manifestPath }) });
+                handleErrorMessage(this.appWizard, { errorMsg: t('error.noManifest', { path: this.manifestPath }) });
             }
             if (!this.manifest['sap.app']) {
-                (0, deploy_config_generator_shared_1.handleErrorMessage)(this.appWizard, { errorMsg: (0, utils_1.t)('error.sapNotDefined') });
+                handleErrorMessage(this.appWizard, { errorMsg: t('error.sapNotDefined') });
             }
         }
     }
@@ -113,12 +106,12 @@ class default_1 extends yeoman_generator_1.default {
             inbounds = this.manifest?.['sap.app']?.crossNavigation?.inbounds;
         }
         const silentOverwrite = this.options.overwrite;
-        let questions = (await (0, flp_config_inquirer_1.getPrompts)(inbounds, {
+        let questions = (await getPrompts(inbounds, {
             silentOverwrite,
-            ...(0, utils_1.getPromptOptions)(this.promptOptions)
+            ...getPromptOptions(this.promptOptions)
         }));
         if (this.promptOptions) {
-            questions = (0, inquirer_common_1.extendWithOptions)(questions, this.promptOptions);
+            questions = extendWithOptions(questions, this.promptOptions);
         }
         this.answers = {};
         const answers = await this.prompt(questions);
@@ -157,11 +150,11 @@ class default_1 extends yeoman_generator_1.default {
                 subTitle
             });
         }
-        await (0, app_config_writer_1.generateInboundNavigationConfig)(this.appRootPath, {
+        await generateInboundNavigationConfig(this.appRootPath, {
             semanticObject,
             action,
-            title: keysAdded ? `{{${semanticObject}-${action}.${constants_1.i18nKeyTitle}}}` : title,
-            subTitle: keysAdded && subTitle ? `{{${semanticObject}-${action}.${constants_1.i18nKeySubTitle}}}` : subTitle
+            title: keysAdded ? `{{${semanticObject}-${action}.${i18nKeyTitle}}}` : title,
+            subTitle: keysAdded && subTitle ? `{{${semanticObject}-${action}.${i18nKeySubTitle}}}` : subTitle
         }, true, this.fs);
     }
     /**
@@ -178,21 +171,21 @@ class default_1 extends yeoman_generator_1.default {
      */
     async _updateI18n(manifestPath, manifest, { semanticObject, action, title, subTitle }) {
         let createProps = false;
-        const { 'sap.app': i18nPath } = await (0, project_access_1.getI18nPropertiesPaths)(manifestPath, manifest);
+        const { 'sap.app': i18nPath } = await getI18nPropertiesPaths(manifestPath, manifest);
         try {
-            const i18nEntries = [{ key: `${semanticObject}-${action}.${constants_1.i18nKeyTitle}`, value: title }];
+            const i18nEntries = [{ key: `${semanticObject}-${action}.${i18nKeyTitle}`, value: title }];
             if (subTitle) {
                 i18nEntries.push({
-                    key: `${semanticObject}-${action}.${constants_1.i18nKeySubTitle}`,
+                    key: `${semanticObject}-${action}.${i18nKeySubTitle}`,
                     value: subTitle
                 });
             }
-            createProps = await (0, i18n_1.createPropertiesI18nEntries)(i18nPath, i18nEntries, this.appRootPath, this.fs);
+            createProps = await createPropertiesI18nEntries(i18nPath, i18nEntries, this.appRootPath, this.fs);
         }
         catch (error) {
-            const errorMsg = (0, utils_1.t)('warning.updatei18n', { path: i18nPath });
-            this.appWizard.showWarning(errorMsg, yeoman_ui_types_1.MessageType.notification);
-            logger_1.default.logger?.error(errorMsg);
+            const errorMsg = t('warning.updatei18n', { path: i18nPath });
+            this.appWizard.showWarning(errorMsg, MessageType.notification);
+            FlpGenLogger.logger?.error(errorMsg);
         }
         return createProps;
     }
@@ -202,26 +195,26 @@ class default_1 extends yeoman_generator_1.default {
         }
         // The app would not have been generated until after the writing phase due to the current ordering of the composeWith from Fiori generators
         if (this.abort === false && !this.existingApp) {
-            this.manifestPath = (0, node_path_1.join)(await (0, project_access_1.getWebappPath)(this.appRootPath), project_access_1.FileName.Manifest);
+            this.manifestPath = join(await getWebappPath(this.appRootPath), FileName.Manifest);
             this.manifest = this.fs.readJSON(this.manifestPath);
             await this._updateFiles(this.answers);
         }
         try {
             if (!this.options.launchFlpConfigAsSubGenerator &&
-                (0, fiori_generator_shared_1.isExtensionInstalled)(this.vscode, fiori_generator_shared_1.YUI_EXTENSION_ID, fiori_generator_shared_1.YUI_MIN_VER_FILES_GENERATED_MSG)) {
-                this.appWizard?.showInformation((0, utils_1.t)('info.filesGenerated'), yeoman_ui_types_1.MessageType.notification);
+                isExtensionInstalled(this.vscode, YUI_EXTENSION_ID, YUI_MIN_VER_FILES_GENERATED_MSG)) {
+                this.appWizard?.showInformation(t('info.filesGenerated'), MessageType.notification);
             }
-            (0, fiori_generator_shared_1.sendTelemetry)(telemetryEvents_1.EventName.GENERATION_SUCCESS, fiori_generator_shared_1.TelemetryHelper.createTelemetryData({
+            sendTelemetry(EventName.GENERATION_SUCCESS, TelemetryHelper.createTelemetryData({
                 appType: 'flp-config',
                 ...this.options.telemetryData
             }) ?? {}).catch((error) => {
-                logger_1.default.logger.error((0, utils_1.t)('error.telemetry', { error }));
+                FlpGenLogger.logger.error(t('error.telemetry', { error }));
             });
         }
         catch (error) {
-            logger_1.default.logger?.error((0, utils_1.t)('error.endPhase', { error }));
+            FlpGenLogger.logger?.error(t('error.endPhase', { error }));
         }
     }
 }
-exports.default = default_1;
+export { promptNames };
 //# sourceMappingURL=index.js.map

package/generators/app/types.js

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

package/generators/telemetryEvents/index.js

@@ -1,11 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EventName = void 0;
 /**
  * Event names for telemetry for the FLP config generator
  */
-var EventName;
+export var EventName;
 (function (EventName) {
     EventName["GENERATION_SUCCESS"] = "GENERATION_SUCCESS";
-})(EventName || (exports.EventName = EventName = {}));
+})(EventName || (EventName = {}));
 //# sourceMappingURL=index.js.map

package/generators/utils/constants.js

@@ -1,7 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generatorTitle = exports.i18nKeySubTitle = exports.i18nKeyTitle = void 0;
-exports.i18nKeyTitle = 'flpTitle';
-exports.i18nKeySubTitle = 'flpSubtitle';
-exports.generatorTitle = 'Fiori Launchpad Configuration Generator';
+export const i18nKeyTitle = 'flpTitle';
+export const i18nKeySubTitle = 'flpSubtitle';
+export const generatorTitle = 'Fiori Launchpad Configuration Generator';
 //# sourceMappingURL=constants.js.map

package/generators/utils/i18n.js

@@ -1,25 +1,17 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.i18n = void 0;
-exports.initI18n = initI18n;
-exports.t = t;
-const i18next_1 = __importDefault(require("i18next"));
-const flp_config_sub_generator_i18n_json_1 = __importDefault(require("../translations/flp-config-sub-generator.i18n.json"));
+import i18next from 'i18next';
+import translations from '../translations/flp-config-sub-generator.i18n.json' with { type: 'json' };
 const flpConfigGeneratorNs = 'flp-config-generator';
-exports.i18n = i18next_1.default.createInstance();
+export const i18n = i18next.createInstance();
 /**
  * Initialize i18next with the translations for this module.
  */
-async function initI18n() {
-    await exports.i18n.init({
+export async function initI18n() {
+    await i18n.init({
         lng: 'en',
         fallbackLng: 'en',
         showSupportNotice: false
     });
-    exports.i18n.addResourceBundle('en', flpConfigGeneratorNs, flp_config_sub_generator_i18n_json_1.default);
+    i18n.addResourceBundle('en', flpConfigGeneratorNs, translations);
 }
 /**
  * Helper function facading the call to i18next. Unless a namespace option is provided the local namespace will be used.
@@ -28,13 +20,11 @@ async function initI18n() {
  * @param options additional options
  * @returns {string} localized string stored for the given key
  */
-function t(key, options) {
+export function t(key, options) {
     if (!options?.ns) {
         options = Object.assign(options ?? {}, { ns: flpConfigGeneratorNs });
     }
-    return exports.i18n.t(key, options);
+    return i18n.t(key, options);
 }
-initI18n().catch(() => {
-    // Needed for lint
-});
+void initI18n().catch(() => undefined);
 //# sourceMappingURL=i18n.js.map

package/generators/utils/index.d.ts

@@ -1,3 +1,3 @@
-export * from './i18n';
-export { getYUIDetails, getPromptOptions } from './prompts';
+export * from './i18n.js';
+export { getYUIDetails, getPromptOptions } from './prompts.js';
 //# sourceMappingURL=index.d.ts.map

package/generators/utils/index.js

@@ -1,22 +1,3 @@
-"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.getPromptOptions = exports.getYUIDetails = void 0;
-__exportStar(require("./i18n"), exports);
-var prompts_1 = require("./prompts");
-Object.defineProperty(exports, "getYUIDetails", { enumerable: true, get: function () { return prompts_1.getYUIDetails; } });
-Object.defineProperty(exports, "getPromptOptions", { enumerable: true, get: function () { return prompts_1.getPromptOptions; } });
+export * from './i18n.js';
+export { getYUIDetails, getPromptOptions } from './prompts.js';
 //# sourceMappingURL=index.js.map

package/generators/utils/logger.js

@@ -1,11 +1,9 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const fiori_generator_shared_1 = require("@sap-ux/fiori-generator-shared");
+import { DefaultLogger, LogWrapper } from '@sap-ux/fiori-generator-shared';
 /**
  * Static logger prevents passing of logger references through all functions, as this is a cross-cutting concern.
  */
-class FlpGenLogger {
-    static _logger = fiori_generator_shared_1.DefaultLogger;
+export default class FlpGenLogger {
+    static _logger = DefaultLogger;
     /**
      * Get the logger.
      *
@@ -33,9 +31,8 @@ class FlpGenLogger {
      * @param vscode - the vscode instance
      */
     static configureLogging(loggerName, yoLogger, logWrapper, logLevel, vscLogger, vscode) {
-        const logger = logWrapper ?? new fiori_generator_shared_1.LogWrapper(loggerName, yoLogger, logLevel, vscLogger, vscode);
+        const logger = logWrapper ?? new LogWrapper(loggerName, yoLogger, logLevel, vscLogger, vscode);
         FlpGenLogger.logger = logger;
     }
 }
-exports.default = FlpGenLogger;
 //# sourceMappingURL=logger.js.map

package/generators/utils/prompts.js

@@ -1,20 +1,16 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getYUIDetails = getYUIDetails;
-exports.getPromptOptions = getPromptOptions;
-const node_path_1 = require("node:path");
-const flp_config_inquirer_1 = require("@sap-ux/flp-config-inquirer");
+import { basename } from 'node:path';
+import { promptNames } from '@sap-ux/flp-config-inquirer';
 /**
  * Returns the details for the YUI prompt.
  *
  * @param appRootPath - path to the application to be displayed in YUI step description
  * @returns step details
  */
-function getYUIDetails(appRootPath) {
+export function getYUIDetails(appRootPath) {
     return [
         {
             name: 'Fiori Launchpad Configuration',
-            description: `Configure Fiori Launchpad settings - ${(0, node_path_1.basename)(appRootPath)}`
+            description: `Configure Fiori Launchpad settings - ${basename(appRootPath)}`
         }
     ];
 }
@@ -24,14 +20,14 @@ function getYUIDetails(appRootPath) {
  * @param promptOptions - FLP configuration prompt options
  * @returns - FLP configuration prompt options with defaults applied
  */
-function getPromptOptions(promptOptions) {
+export function getPromptOptions(promptOptions) {
     return {
         ...promptOptions,
-        [flp_config_inquirer_1.promptNames.inboundId]: { hide: true, ...promptOptions?.inboundId },
-        [flp_config_inquirer_1.promptNames.existingFlpConfigInfo]: { hide: true, ...promptOptions?.existingFlpConfigInfo },
-        [flp_config_inquirer_1.promptNames.icon]: { hide: true, ...promptOptions?.icon },
-        [flp_config_inquirer_1.promptNames.additionalParameters]: { hide: true, ...promptOptions?.additionalParameters },
-        [flp_config_inquirer_1.promptNames.confirmReplace]: { hide: true, ...promptOptions?.confirmReplace }
+        [promptNames.inboundId]: { hide: true, ...promptOptions?.inboundId },
+        [promptNames.existingFlpConfigInfo]: { hide: true, ...promptOptions?.existingFlpConfigInfo },
+        [promptNames.icon]: { hide: true, ...promptOptions?.icon },
+        [promptNames.additionalParameters]: { hide: true, ...promptOptions?.additionalParameters },
+        [promptNames.confirmReplace]: { hide: true, ...promptOptions?.confirmReplace }
     };
 }
 //# sourceMappingURL=prompts.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/flp-config-sub-generator",
   "description": "Generator for creating Fiori Launcpad configuration",
-  "version": "0.4.13",
+  "version": "1.0.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -10,6 +10,7 @@
   "bugs": {
     "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue"
   },
+  "type": "module",
   "license": "Apache-2.0",
   "main": "generators/app/index.js",
   "files": [
@@ -23,16 +24,17 @@
     "i18next": "25.10.10",
     "inquirer": "8.2.7",
     "yeoman-generator": "5.10.0",
-    "@sap-ux/app-config-writer": "0.7.6",
-    "@sap-ux/deploy-config-generator-shared": "0.2.6",
-    "@sap-ux/feature-toggle": "0.4.0",
-    "@sap-ux/fiori-generator-shared": "0.15.6",
-    "@sap-ux/flp-config-inquirer": "0.5.11",
-    "@sap-ux/i18n": "0.4.0",
-    "@sap-ux/inquirer-common": "0.13.6",
-    "@sap-ux/project-access": "1.38.1"
+    "@sap-ux/app-config-writer": "1.0.1",
+    "@sap-ux/deploy-config-generator-shared": "1.0.1",
+    "@sap-ux/feature-toggle": "1.0.0",
+    "@sap-ux/fiori-generator-shared": "1.0.1",
+    "@sap-ux/flp-config-inquirer": "1.0.1",
+    "@sap-ux/i18n": "1.0.0",
+    "@sap-ux/inquirer-common": "1.0.1",
+    "@sap-ux/project-access": "2.0.1"
   },
   "devDependencies": {
+    "@jest/globals": "30.3.0",
     "@jest/types": "30.3.0",
     "@types/inquirer": "8.2.6",
     "@types/mem-fs": "1.1.2",
@@ -48,7 +50,7 @@
     "rimraf": "6.1.3",
     "unionfs": "4.6.0",
     "yeoman-test": "6.3.0",
-    "@sap-ux/nodejs-utils": "0.3.2"
+    "@sap-ux/nodejs-utils": "1.0.0"
   },
   "engines": {
     "node": ">=22.x"
@@ -59,8 +61,8 @@
     "watch": "tsc --watch",
     "lint": "eslint",
     "lint:fix": "eslint --fix",
-    "test": "jest --ci --forceExit --detectOpenHandles --colors",
-    "test-u": "jest --ci --forceExit --detectOpenHandles --colors -u",
+    "test": "cross-env NODE_OPTIONS='--experimental-vm-modules' jest --ci --forceExit --detectOpenHandles --colors",
+    "test-u": "cross-env NODE_OPTIONS='--experimental-vm-modules' jest --ci --forceExit --detectOpenHandles --colors -u",
     "link": "pnpm link --global",
     "unlink": "pnpm unlink --global"
   }