@sap-ux/fiori-app-sub-generator 0.15.20 → 1.0.0

package/generators/app/index.d.ts

@@ -1,3 +1,3 @@
-import { FioriAppGenerator } from '../fiori-app-generator';
+import { FioriAppGenerator } from '../fiori-app-generator/index.js';
 export default FioriAppGenerator;
 //# sourceMappingURL=index.d.ts.map

package/generators/app/index.js

@@ -1,5 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const fiori_app_generator_1 = require("../fiori-app-generator");
-exports.default = fiori_app_generator_1.FioriAppGenerator;
+import { FioriAppGenerator } from '../fiori-app-generator/index.js';
+export default FioriAppGenerator;
 //# sourceMappingURL=index.js.map

package/generators/app-headless/index.d.ts

@@ -1,5 +1,5 @@
-import type { FioriAppGeneratorOptions } from '../fiori-app-generator';
-import { FioriAppGenerator } from '../fiori-app-generator';
+import type { FioriAppGeneratorOptions } from '../fiori-app-generator/index.js';
+import { FioriAppGenerator } from '../fiori-app-generator/index.js';
 /**
  * Generator that allows the creation of a Fiori applications without prompting based on a provided app config.
  */

package/generators/app-headless/index.js

@@ -1,16 +1,13 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FioriAppGeneratorHeadless = void 0;
-const feature_toggle_1 = require("@sap-ux/feature-toggle");
-const fiori_generator_shared_1 = require("@sap-ux/fiori-generator-shared");
-const fiori_app_generator_1 = require("../fiori-app-generator");
-const i18n_1 = require("../utils/i18n");
-const transforms_1 = require("./transforms");
-const resolve_1 = require("./resolve");
+import { isInternalFeaturesSettingEnabled } from '@sap-ux/feature-toggle';
+import { TelemetryHelper } from '@sap-ux/fiori-generator-shared';
+import { APP_GENERATOR_MODULE, FioriAppGenerator } from '../fiori-app-generator/index.js';
+import { initI18nFioriAppSubGenerator, t } from '../utils/i18n.js';
+import { transformExtState } from './transforms.js';
+import { resolveExternalServices } from './resolve.js';
 /**
  * Generator that allows the creation of a Fiori applications without prompting based on a provided app config.
  */
-class FioriAppGeneratorHeadless extends fiori_app_generator_1.FioriAppGenerator {
+export class FioriAppGeneratorHeadless extends FioriAppGenerator {
     /**
      *
      * @param args
@@ -18,34 +15,34 @@ class FioriAppGeneratorHeadless extends fiori_app_generator_1.FioriAppGenerator
      */
     constructor(args, opts) {
         super(args, opts);
-        this.log((0, i18n_1.t)('logMessages.generatingAppWithVersion', {
+        this.log(t('logMessages.generatingAppWithVersion', {
             generatorName: '@sap-ux/fiori-app-sub-generator:headless',
             generatorVersion: this.rootGeneratorVersion()
         }));
         try {
             const appConfig = this.options.appConfig;
             if (appConfig.service?.externalServices) {
-                appConfig.service.externalServices = (0, resolve_1.resolveExternalServices)(appConfig.service.externalServices);
+                appConfig.service.externalServices = resolveExternalServices(appConfig.service.externalServices);
             }
-            this.state = (0, transforms_1.transformExtState)(appConfig);
+            this.state = transformExtState(appConfig);
         }
         catch (error) {
-            this.log((0, i18n_1.t)('logMessages.generatorExiting'));
+            this.log(t('logMessages.generatorExiting'));
             this.env.error(error);
         }
     }
     async initializing() {
         // Ensure texts used in locally generated files, e.g. log messages, readme.md labels, etc. are available
-        await (0, i18n_1.initI18nFioriAppSubGenerator)();
-        await fiori_generator_shared_1.TelemetryHelper.initTelemetrySettings({
+        await initI18nFioriAppSubGenerator();
+        await TelemetryHelper.initTelemetrySettings({
             consumerModule: {
-                name: fiori_app_generator_1.APP_GENERATOR_MODULE,
+                name: APP_GENERATOR_MODULE,
                 version: this.rootGeneratorVersion()
             },
-            internalFeature: (0, feature_toggle_1.isInternalFeaturesSettingEnabled)(),
+            internalFeature: isInternalFeaturesSettingEnabled(),
             watchTelemetrySettingStore: false
         });
-        fiori_generator_shared_1.TelemetryHelper.createTelemetryData({
+        TelemetryHelper.createTelemetryData({
             AppGenLaunchSource: this.options.appConfig.telemetryData?.generationSourceName ?? 'Headless',
             AppGenLaunchSourceVersion: this.options.appConfig.telemetryData?.generationSourceVersion ?? 'Not Provided'
         });
@@ -75,6 +72,5 @@ class FioriAppGeneratorHeadless extends fiori_app_generator_1.FioriAppGenerator
         await super.end();
     }
 }
-exports.FioriAppGeneratorHeadless = FioriAppGeneratorHeadless;
-exports.default = FioriAppGeneratorHeadless;
+export default FioriAppGeneratorHeadless;
 //# sourceMappingURL=index.js.map

package/generators/app-headless/resolve.js

@@ -1,25 +1,20 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveMetadata = resolveMetadata;
-exports.resolveEntityData = resolveEntityData;
-exports.resolveExternalServices = resolveExternalServices;
-const node_fs_1 = require("node:fs");
-const node_path_1 = require("node:path");
+import { existsSync, readFileSync } from 'node:fs';
+import { isAbsolute, resolve } from 'node:path';
 /**
  * Returns inline XML, or reads and returns the contents of the file at the given path.
  *
  * @param metadata The metadata XML string or the path to the metadata file.
  */
-function resolveMetadata(metadata) {
+export function resolveMetadata(metadata) {
     if (metadata.trimStart().startsWith('<')) {
         return metadata;
     }
-    const filePath = (0, node_path_1.isAbsolute)(metadata) ? metadata : (0, node_path_1.resolve)(process.cwd(), metadata);
-    if (!(0, node_fs_1.existsSync)(filePath)) {
+    const filePath = isAbsolute(metadata) ? metadata : resolve(process.cwd(), metadata);
+    if (!existsSync(filePath)) {
         throw new Error(`Metadata file not found: ${filePath}`);
     }
     try {
-        return (0, node_fs_1.readFileSync)(filePath, 'utf-8');
+        return readFileSync(filePath, 'utf-8');
     }
     catch (error) {
         throw new Error(`Failed to read metadata file: ${filePath}. ${error instanceof Error ? error.message : error}`);
@@ -30,16 +25,16 @@ function resolveMetadata(metadata) {
  *
  * @param entityData The entity data array or the path to the JSON file.
  */
-function resolveEntityData(entityData) {
+export function resolveEntityData(entityData) {
     if (Array.isArray(entityData)) {
         return entityData;
     }
-    const filePath = (0, node_path_1.isAbsolute)(entityData) ? entityData : (0, node_path_1.resolve)(process.cwd(), entityData);
-    if (!(0, node_fs_1.existsSync)(filePath)) {
+    const filePath = isAbsolute(entityData) ? entityData : resolve(process.cwd(), entityData);
+    if (!existsSync(filePath)) {
         throw new Error(`Entity data file not found: ${filePath}`);
     }
     try {
-        return JSON.parse((0, node_fs_1.readFileSync)(filePath, 'utf-8'));
+        return JSON.parse(readFileSync(filePath, 'utf-8'));
     }
     catch (error) {
         throw new Error(`Failed to read or parse entity data file: ${filePath}. ${error instanceof Error ? error.message : error}`);
@@ -50,7 +45,7 @@ function resolveEntityData(entityData) {
  *
  * @param services External service configurations.
  */
-function resolveExternalServices(services) {
+export function resolveExternalServices(services) {
     return services.map((entry) => ({
         ...entry,
         metadata: resolveMetadata(entry.metadata),

package/generators/app-headless/transforms.d.ts

@@ -1,4 +1,4 @@
-import type { FEAppConfig, FFAppConfig, State } from '../types';
+import type { FEAppConfig, FFAppConfig, State } from '../types/index.js';
 /**
  * Transforms the external state to its internal representation.
  *

package/generators/app-headless/transforms.js

@@ -1,14 +1,11 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.transformExtState = transformExtState;
-const fiori_elements_writer_1 = require("@sap-ux/fiori-elements-writer");
-const fiori_generator_shared_1 = require("@sap-ux/fiori-generator-shared");
-const odata_service_inquirer_1 = require("@sap-ux/odata-service-inquirer");
-const ui5_application_inquirer_1 = require("@sap-ux/ui5-application-inquirer");
-const ui5_info_1 = require("@sap-ux/ui5-info");
-const node_path_1 = require("node:path");
-const types_1 = require("../types");
-const utils_1 = require("../utils");
+import { OdataVersion } from '@sap-ux/fiori-elements-writer';
+import { getCapFolderPathsSync } from '@sap-ux/fiori-generator-shared';
+import { DatasourceType } from '@sap-ux/odata-service-inquirer';
+import { promptNames } from '@sap-ux/ui5-application-inquirer';
+import { getDefaultUI5Theme, supportedUi5VersionFallbacks } from '@sap-ux/ui5-info';
+import { join } from 'node:path';
+import { ApiHubType, FloorplanFE, FloorplanFF, capTypeConversion, defaultPromptValues } from '../types/index.js';
+import { getODataVersion, t } from '../utils/index.js';
 const APP_CONFIG_CURRENT_VERSION = '0.2';
 /**
  * Transforms the external state to its internal representation.
@@ -16,18 +13,18 @@ const APP_CONFIG_CURRENT_VERSION = '0.2';
  * @param appConfig - defines the application to be generated
  * @returns the internal state representation
  */
-function transformExtState(appConfig) {
+export function transformExtState(appConfig) {
     if (appConfig.version !== APP_CONFIG_CURRENT_VERSION) {
-        throw Error((0, utils_1.t)('error.appConfigVersion', { versions: APP_CONFIG_CURRENT_VERSION }));
+        throw Error(t('error.appConfigVersion', { versions: APP_CONFIG_CURRENT_VERSION }));
     }
     const { project: projectConfig, service: serviceConfig, floorplan } = appConfig;
     const state = {
         project: _setProjectDefaults(projectConfig),
         service: _setServiceDefaults(floorplan, serviceConfig),
-        floorplan: types_1.FloorplanFE[floorplan] ?? types_1.FloorplanFF[floorplan]
+        floorplan: FloorplanFE[floorplan] ?? FloorplanFF[floorplan]
     };
     if (state.service.capService) {
-        state.project.targetFolder = (0, node_path_1.join)(state.service.capService.projectPath, state.service.capService.appPath ?? '');
+        state.project.targetFolder = join(state.service.capService.projectPath, state.service.capService.appPath ?? '');
     }
     // FE specific state properties
     if (floorplan !== 'FF_SIMPLE' && appConfig.entityConfig) {
@@ -95,19 +92,19 @@ function _setEntityRelatedConfig(feAppConfig) {
  */
 function _setProjectDefaults(project) {
     // Use latest fallback (offline) version if none specified
-    const ui5Version = project.ui5Version || ui5_info_1.supportedUi5VersionFallbacks[0].version;
+    const ui5Version = project.ui5Version || supportedUi5VersionFallbacks[0].version;
     return {
-        name: project.name ?? (0, utils_1.t)('defaults.projectName'),
+        name: project.name ?? t('defaults.projectName'),
         targetFolder: project.targetFolder ?? process.cwd(),
         namespace: project.namespace ?? '',
-        title: project.title ?? (0, utils_1.t)('defaults.projectTitle'),
-        description: project.description ?? (0, utils_1.t)('default.projectDescription'),
+        title: project.title ?? t('defaults.projectTitle'),
+        description: project.description ?? t('default.projectDescription'),
         ui5Version: ui5Version,
         localUI5Version: project.localUI5Version ?? ui5Version,
-        ui5Theme: project.ui5Theme ?? (0, ui5_info_1.getDefaultUI5Theme)(ui5Version),
-        skipAnnotations: project.skipAnnotations ?? types_1.defaultPromptValues[ui5_application_inquirer_1.promptNames.skipAnnotations],
-        enableEslint: project.enableEslint ?? types_1.defaultPromptValues[ui5_application_inquirer_1.promptNames.enableEslint],
-        enableTypeScript: project.enableTypeScript ?? types_1.defaultPromptValues[ui5_application_inquirer_1.promptNames.enableTypeScript],
+        ui5Theme: project.ui5Theme ?? getDefaultUI5Theme(ui5Version),
+        skipAnnotations: project.skipAnnotations ?? defaultPromptValues[promptNames.skipAnnotations],
+        enableEslint: project.enableEslint ?? defaultPromptValues[promptNames.enableEslint],
+        enableTypeScript: project.enableTypeScript ?? defaultPromptValues[promptNames.enableTypeScript],
         sapux: project.sapux || false,
         enableVirtualEndpoints: project.enableVirtualEndpoints ?? true,
         flpAppId: '' // Mandatory property, will be generated in the writing phase transforms and overwritten
@@ -124,15 +121,15 @@ function _setProjectDefaults(project) {
 function _setServiceDefaults(floorplan, service) {
     let version;
     if (service?.edmx) {
-        version = (0, utils_1.getODataVersion)(service.edmx);
+        version = getODataVersion(service.edmx);
     }
     else if (floorplan !== 'FF_SIMPLE' && !service?.capService?.projectPath) {
-        throw Error((0, utils_1.t)('error.appConfigMissingRequiredProperty', { propertyName: 'edmx' }));
+        throw Error(t('error.appConfigMissingRequiredProperty', { propertyName: 'edmx' }));
     }
     else if (floorplan === 'FF_SIMPLE') {
         // FF_SIMPLE with no datasource
         return {
-            source: odata_service_inquirer_1.DatasourceType.none
+            source: DatasourceType.none
         };
     }
     const serviceDefaults = {
@@ -145,41 +142,41 @@ function _setServiceDefaults(floorplan, service) {
     };
     if (service?.destination) {
         serviceDefaults.destinationName = service.destination;
-        serviceDefaults.source = odata_service_inquirer_1.DatasourceType.sapSystem;
+        serviceDefaults.source = DatasourceType.sapSystem;
         return serviceDefaults;
     }
     // Only support non-enterprise api hub currently from headless generator
     if (service?.apiHubApiKey) {
         serviceDefaults.apiHubConfig = {
             apiHubKey: service.apiHubApiKey,
-            apiHubType: "API_HUB" /* ApiHubType.apiHub */
+            apiHubType: ApiHubType.apiHub
         };
-        serviceDefaults.source = odata_service_inquirer_1.DatasourceType.businessHub;
+        serviceDefaults.source = DatasourceType.businessHub;
     }
     // Setting of DatasourceType has only partial relevance for the writing phase.
     // Only FILE and CAP are checked during the writing phase, but these references should be (eventually) removed
     // and replaced with generic checks for servicePath + edmx and cap service name respectively - then there is no need to set here
     else if (service?.capService?.projectPath) {
         if (!service.capService.serviceName) {
-            throw Error((0, utils_1.t)('error.appConfigMissingRequiredProperty', {
+            throw Error(t('error.appConfigMissingRequiredProperty', {
                 propertyName: 'capService.serviceName'
             }));
         }
         serviceDefaults.capService = _setCAPServicePaths(service.capService);
-        serviceDefaults.version = fiori_elements_writer_1.OdataVersion.v4; // CAP is always odata 4
-        serviceDefaults.source = odata_service_inquirer_1.DatasourceType.capProject;
+        serviceDefaults.version = OdataVersion.v4; // CAP is always odata 4
+        serviceDefaults.source = DatasourceType.capProject;
     }
     else if (!service?.servicePath && service?.edmx) {
-        serviceDefaults.source = odata_service_inquirer_1.DatasourceType.metadataFile;
+        serviceDefaults.source = DatasourceType.metadataFile;
     }
     else if (!service?.edmx) {
-        serviceDefaults.source = odata_service_inquirer_1.DatasourceType.none;
+        serviceDefaults.source = DatasourceType.none;
     }
     else if (service?.scp) {
-        serviceDefaults.source = odata_service_inquirer_1.DatasourceType.sapSystem;
+        serviceDefaults.source = DatasourceType.sapSystem;
     }
     else {
-        serviceDefaults.source = odata_service_inquirer_1.DatasourceType.odataServiceUrl;
+        serviceDefaults.source = DatasourceType.odataServiceUrl;
     }
     return serviceDefaults;
 }
@@ -190,7 +187,7 @@ function _setServiceDefaults(floorplan, service) {
  * @returns
  */
 function _setCAPServicePaths(capService) {
-    const capCustomPaths = (0, fiori_generator_shared_1.getCapFolderPathsSync)(capService.projectPath);
+    const capCustomPaths = getCapFolderPathsSync(capService.projectPath);
     return {
         // Use target folder for testing as capService.projectPath is an absolute path
         projectPath: capService.projectPath,
@@ -198,7 +195,7 @@ function _setCAPServicePaths(capService) {
         serviceCdsPath: capService.serviceCdsPath,
         // targetFolder ends in /app so step-up 1 dir
         appPath: capCustomPaths?.app,
-        capType: (0, types_1.capTypeConversion)(capService.capType)
+        capType: capTypeConversion(capService.capType)
     };
 }
 //# sourceMappingURL=transforms.js.map

package/generators/fiori-app-generator/end.d.ts

@@ -6,7 +6,7 @@ import type { Logger } from '@sap-ux/logger';
 import type { DatasourceType } from '@sap-ux/odata-service-inquirer';
 import { type BackendSystem } from '@sap-ux/store';
 import type { Editor } from 'mem-fs-editor';
-import type { ApiHubConfig } from '../types';
+import type { ApiHubConfig } from '../types/index.js';
 /**
  * FioriBaseGeneratror end phase related functionality.
  *

package/generators/fiori-app-generator/end.js

@@ -1,12 +1,10 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.runPostGenerationTasks = runPostGenerationTasks;
-const yeoman_ui_types_1 = require("@sap-devx/yeoman-ui-types");
-const btp_utils_1 = require("@sap-ux/btp-utils");
-const fiori_generator_shared_1 = require("@sap-ux/fiori-generator-shared");
-const store_1 = require("@sap-ux/store");
-const node_path_1 = require("node:path");
-const utils_1 = require("../utils");
+import { MessageType } from '@sap-devx/yeoman-ui-types';
+import { isAppStudio } from '@sap-ux/btp-utils';
+import { getHostEnvironment, hostEnvironment, sendTelemetry, TelemetryHelper } from '@sap-ux/fiori-generator-shared';
+import { ApiHubSettings, getService } from '@sap-ux/store';
+import { join } from 'node:path';
+import { ApiHubType } from '../types/index.js';
+import { buildSapClientParam, generateLaunchConfig, runHooks, t } from '../utils/index.js';
 /**
  * Save API Hub key to the store.
  *
@@ -16,12 +14,12 @@ const utils_1 = require("../utils");
  */
 async function saveApiHubApiKey(apiKey, logger) {
     let result;
-    if (!(0, btp_utils_1.isAppStudio)()) {
-        const apiHubStore = (await (0, store_1.getService)({
+    if (!isAppStudio()) {
+        const apiHubStore = (await getService({
             logger,
             entityName: 'api-hub'
         }));
-        const apiHubSettings = new store_1.ApiHubSettings({ apiKey });
+        const apiHubSettings = new ApiHubSettings({ apiKey });
         result = await apiHubStore.write(apiHubSettings);
     }
     return Boolean(result);
@@ -37,7 +35,7 @@ async function saveApiHubApiKey(apiKey, logger) {
  * @param followUpCommand.cmdParams - options params for the command
  */
 async function runPostGenHooks(projectPath, logger, vscode, followUpCommand) {
-    await (0, utils_1.runHooks)('app-generated', {
+    await runHooks('app-generated', {
         hookParameters: { fsPath: projectPath, ...followUpCommand?.cmdParams },
         vscodeInstance: vscode,
         options: { command: followUpCommand?.cmdName }
@@ -68,29 +66,29 @@ async function runPostGenHooks(projectPath, logger, vscode, followUpCommand) {
  * @param followUpCommand.cmdParams - options params for the command
  * @returns {Promise<void>}
  */
-async function runPostGenerationTasks({ service, project }, fs, logger, vscode, appWizard, followUpCommand) {
+export async function runPostGenerationTasks({ service, project }, fs, logger, vscode, appWizard, followUpCommand) {
     // Add launch config for non-cap projects
     if (!service.capService) {
-        await (0, utils_1.generateLaunchConfig)({
+        await generateLaunchConfig({
             targetFolder: project.targetFolder,
             projectName: project.name,
             flpAppId: project.flpAppId,
-            sapClientParam: service.sapClient ? (0, utils_1.buildSapClientParam)(service.sapClient) : undefined,
+            sapClientParam: service.sapClient ? buildSapClientParam(service.sapClient) : undefined,
             odataVersion: service.odataVersion,
             datasourceType: service.datasourceType,
             enableVirtualEndpoints: project.enableVirtualEndpoints
         }, fs, vscode, logger);
     }
     // Persist backend system connection information
-    const hostEnv = (0, fiori_generator_shared_1.getHostEnvironment)();
-    if (service.backendSystem && hostEnv !== fiori_generator_shared_1.hostEnvironment.bas && service.backendSystem.newOrUpdated) {
-        const storeService = await (0, store_1.getService)({
+    const hostEnv = getHostEnvironment();
+    if (service.backendSystem && hostEnv !== hostEnvironment.bas && service.backendSystem.newOrUpdated) {
+        const storeService = await getService({
             logger: logger,
             entityName: 'system'
         });
         // No need to await, we cannot recover anyway
         storeService.write(service.backendSystem, { force: true }).catch((error) => {
-            logger.error((0, utils_1.t)('logMessages.backendSystemSaveError', {
+            logger.error(t('logMessages.backendSystemSaveError', {
                 system: service.backendSystem?.name,
                 error: error.message
             }));
@@ -99,17 +97,17 @@ async function runPostGenerationTasks({ service, project }, fs, logger, vscode,
     // Display info message if using a cap service as it is not otherwise shown when a top level dir is not created
     if (service.capService && appWizard) {
         // this info message needs to be shown for cap projects as it is not shown when a top level dir is not created
-        appWizard.showInformation((0, utils_1.t)('wizardMessages.filesGenerated'), yeoman_ui_types_1.MessageType.notification);
+        appWizard.showInformation(t('wizardMessages.filesGenerated'), MessageType.notification);
     }
-    if (hostEnv !== fiori_generator_shared_1.hostEnvironment.bas && service.apiHubConfig?.apiHubType === "API_HUB" /* ApiHubType.apiHub */) {
+    if (hostEnv !== hostEnvironment.bas && service.apiHubConfig?.apiHubType === ApiHubType.apiHub) {
         await saveApiHubApiKey(service.apiHubConfig.apiHubKey, logger);
     }
     // If we got here, the generation was successful and so targetFolder and name must be defined
-    const projectPath = (0, node_path_1.join)(project.targetFolder, project.name);
-    logger.info((0, utils_1.t)('logMessages.applicationGenerationSuccess', {
+    const projectPath = join(project.targetFolder, project.name);
+    logger.info(t('logMessages.applicationGenerationSuccess', {
         targetFolder: projectPath
     }));
-    await (0, fiori_generator_shared_1.sendTelemetry)('GENERATION_SUCCESS', fiori_generator_shared_1.TelemetryHelper.telemetryData, projectPath);
+    await sendTelemetry('GENERATION_SUCCESS', TelemetryHelper.telemetryData, projectPath);
     await runPostGenHooks(projectPath, logger, vscode, followUpCommand);
 }
 //# sourceMappingURL=end.js.map

package/generators/fiori-app-generator/fioriAppGenerator.d.ts

@@ -1,8 +1,8 @@
 import { type ILogWrapper } from '@sap-ux/fiori-generator-shared';
 import type { Logger } from '@sap-ux/logger';
 import Generator from 'yeoman-generator';
-import type { FioriStep, State } from '../types';
-import type { FioriAppGeneratorOptions } from './fioriAppGeneratorOptions';
+import type { FioriStep, State } from '../types/index.js';
+import type { FioriAppGeneratorOptions } from './fioriAppGeneratorOptions.js';
 export declare const APP_GENERATOR_MODULE = "@sap/generator-fiori";
 /**
  * The root generator for Fiori Elements and Fiori Freestyle generators.