@sap-ux/fiori-app-sub-generator 0.0.2

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

@@ -0,0 +1,105 @@
+"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 path_1 = require("path");
+const utils_1 = require("../utils");
+/**
+ * Save API Hub key to the store.
+ *
+ * @param apiKey - API key to save
+ * @param logger - optional logger
+ * @returns - true if the API key was saved successfully, false otherwise
+ */
+async function saveApiHubApiKey(apiKey, logger) {
+    let result;
+    if (!(0, btp_utils_1.isAppStudio)()) {
+        const apiHubStore = (await (0, store_1.getService)({
+            logger,
+            entityName: 'api-hub'
+        }));
+        const apiHubSettings = new store_1.ApiHubSettings({ apiKey });
+        result = await apiHubStore.write(apiHubSettings);
+    }
+    return Boolean(result);
+}
+/**
+ * Run post generation hooks: delegates to `runHooks` with `'app-generated'` as the event name.
+ *
+ * @param projectPath
+ * @param logger
+ * @param vscode
+ * @param followUpCommand
+ */
+async function runPostGenHooks(projectPath, logger, vscode, followUpCommand) {
+    await (0, utils_1.runHooks)('app-generated', {
+        hookParameters: { fsPath: projectPath },
+        vscodeInstance: vscode,
+        options: { followUpCommand }
+    }, logger);
+}
+/**
+ * FioriBaseGeneratror end phase related functionality.
+ *
+ * @param state
+ * @param state.service
+ * @param state.service.backendSystem
+ * @param state.service.capService
+ * @param state.service.sapClient
+ * @param state.service.odataVersion
+ * @param state.service.datasourceType
+ * @param state.service.apiHubConfig
+ * @param state.project
+ * @param state.project.targetFolder
+ * @param state.project.name
+ * @param state.project.flpAppId
+ * @param fs - the file system editor
+ * @param logger - the logger
+ * @param vscode - the vscode instance
+ * @param appWizard - the app wizard instance
+ * @param followUpCommand - the follow up command
+ * @returns {Promise<void>}
+ */
+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)({
+            targetFolder: project.targetFolder,
+            projectName: project.name,
+            flpAppId: project.flpAppId,
+            sapClientParam: service.sapClient ? (0, utils_1.buildSapClientParam)(service.sapClient) : undefined,
+            odataVersion: service.odataVersion,
+            datasourceType: service.datasourceType
+        }, 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)({
+            logger: logger,
+            entityName: 'system'
+        });
+        // No need to await, we cannot recover anyway
+        // eslint-disable-next-line @typescript-eslint/no-floating-promises
+        storeService.write(service.backendSystem);
+    }
+    // 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);
+    }
+    if (hostEnv !== fiori_generator_shared_1.hostEnvironment.bas && service.apiHubConfig?.apiHubType === "API_HUB" /* 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, path_1.join)(project.targetFolder, project.name);
+    logger.info((0, utils_1.t)('logMessages.applicationGenerationSuccess', {
+        targetFolder: projectPath
+    }));
+    await (0, fiori_generator_shared_1.sendTelemetry)('GENERATION_SUCCESS', fiori_generator_shared_1.TelemetryHelper.telemetryData, projectPath);
+    await runPostGenHooks(projectPath, logger, vscode, followUpCommand);
+}
+//# sourceMappingURL=end.js.map

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

@@ -0,0 +1,45 @@
+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';
+export declare const APP_GENERATOR_MODULE = "@sap/generator-fiori";
+/**
+ * The root generator for Fiori Elements and Fiori Freestyle generators.
+ * All common functionality is implemented here.
+ */
+export declare class FioriAppGenerator extends Generator {
+    private readonly vscode;
+    private generationTime0;
+    private appWizard;
+    protected state: State;
+    private static _logger;
+    protected generatorVersion: string;
+    private yeomanUiStepConfig;
+    private readonly setPromptsCallback;
+    private prompts;
+    protected fioriSteps: FioriStep[];
+    /**
+     *
+     * @param args
+     * @param opts
+     */
+    constructor(args: string | string[], opts: FioriAppGeneratorOptions);
+    /**
+     * Static getter for the logger.
+     *
+     * @returns {ILogWrapper & Logger}
+     */
+    static get logger(): ILogWrapper & Logger;
+    initializing(): Promise<void>;
+    prompting(): Promise<void>;
+    writing(): Promise<void>;
+    install(): Promise<void>;
+    end(): Promise<void>;
+    /**
+     *
+     * @param error
+     */
+    private _exitOnError;
+}
+//# sourceMappingURL=fioriAppGenerator.d.ts.map

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

@@ -0,0 +1,319 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FioriAppGenerator = exports.APP_GENERATOR_MODULE = void 0;
+const yeoman_ui_types_1 = require("@sap-devx/yeoman-ui-types");
+const btp_utils_1 = require("@sap-ux/btp-utils");
+const feature_toggle_1 = require("@sap-ux/feature-toggle");
+const fiori_elements_writer_1 = require("@sap-ux/fiori-elements-writer");
+const fiori_freestyle_writer_1 = require("@sap-ux/fiori-freestyle-writer");
+const fiori_generator_shared_1 = require("@sap-ux/fiori-generator-shared");
+const odata_service_inquirer_1 = require("@sap-ux/odata-service-inquirer");
+const telemetry_1 = require("@sap-ux/telemetry");
+const ui5_info_1 = require("@sap-ux/ui5-info");
+const path_1 = require("path");
+const yeoman_generator_1 = __importDefault(require("yeoman-generator"));
+const types_1 = require("../types");
+const utils_1 = require("../utils");
+const end_1 = require("./end");
+const install_1 = require("./install");
+const prompting_1 = require("./prompting");
+const subgenHelpers_1 = require("./subgenHelpers");
+const transforms_1 = require("./transforms");
+const writing_1 = require("./writing");
+exports.APP_GENERATOR_MODULE = '@sap/generator-fiori';
+/**
+ * The root generator for Fiori Elements and Fiori Freestyle generators.
+ * All common functionality is implemented here.
+ */
+class FioriAppGenerator extends yeoman_generator_1.default {
+    vscode;
+    // Performance measurement
+    generationTime0; // start of writing phase millisecond timestamp
+    appWizard;
+    state;
+    // The logger is static to allow convenient access from everywhere, cross-cutting concern
+    static _logger = fiori_generator_shared_1.DefaultLogger;
+    // Generator name for use in telemetry, readmes etc.
+    generatorVersion = this.rootGeneratorVersion();
+    // The configuration of steps in YUI and their interdependence
+    yeomanUiStepConfig;
+    setPromptsCallback;
+    prompts;
+    fioriSteps;
+    /**
+     *
+     * @param args
+     * @param opts
+     */
+    constructor(args, opts) {
+        super(args, opts, {
+            unique: 'namespace'
+        });
+        this.vscode = opts['vscode'];
+        FioriAppGenerator._logger = this.options.logWrapper ?? fiori_generator_shared_1.DefaultLogger;
+        // Init the generator state
+        this.state = opts.state ?? { project: {}, service: {} };
+    }
+    /**
+     * Static getter for the logger.
+     *
+     * @returns {ILogWrapper & Logger}
+     */
+    static get logger() {
+        return FioriAppGenerator._logger;
+    }
+    async initializing() {
+        // Ensure i18n bundles are loaded, default loading is unreliable
+        await (0, utils_1.initI18nFioriAppSubGenerator)();
+        // When running in YUI context back navigation is supported and state may be cached.
+        if (this.options.appWizard) {
+            this.appWizard = this.options.appWizard;
+            (0, utils_1.initAppWizardCache)(FioriAppGenerator._logger, this.options.appWizard);
+        }
+        await (0, telemetry_1.initTelemetrySettings)({
+            consumerModule: { name: exports.APP_GENERATOR_MODULE, version: this.rootGeneratorVersion() },
+            internalFeature: (0, feature_toggle_1.isInternalFeaturesSettingEnabled)(),
+            watchTelemetrySettingStore: false
+        });
+        fiori_generator_shared_1.TelemetryHelper.createTelemetryData({
+            ...this.options.telemetryData
+        });
+        /**
+         * Preloading UI5 versions to be retreived from cache later in generation flow
+         * Not required when version is already in project state e.g S4
+         */
+        if (!this.state.project?.ui5Version) {
+            const filterOptions = {
+                useCache: true
+            };
+            // do not await as this is pre-loading the cache
+            // eslint-disable-next-line @typescript-eslint/no-floating-promises
+            (0, ui5_info_1.getUI5Versions)(filterOptions);
+        }
+        // Floorplans, externally configured either via adapters or headless config
+        if (this.options.floorplan) {
+            this.state.floorplan = this.options.floorplan;
+        }
+        // Configuration of steps in YUI and their interdependance
+        this.fioriSteps = this.options.fioriSteps ?? types_1.FIORI_STEPS;
+        this.yeomanUiStepConfig = this.options.yeomanUiStepConfig;
+        this.prompts = this.yeomanUiStepConfig?.activeSteps;
+    }
+    async prompting() {
+        try {
+            const generatorOptions = this.options;
+            const isFioriFreestyleTemplate = this.state.floorplan === types_1.FloorplanFF.FF_SIMPLE;
+            if ((0, utils_1.hasStep)(this.fioriSteps, types_1.STEP_DATASOURCE_AND_SERVICE)) {
+                const cachedService = (0, utils_1.getFromCache)(this.appWizard, 'service', FioriAppGenerator.logger);
+                const options = {
+                    capService: cachedService?.capService ?? this.state.service?.capService,
+                    requiredOdataVersion: (0, utils_1.getRequiredOdataVersion)(this.state.floorplan),
+                    allowNoDatasource: isFioriFreestyleTemplate,
+                    promptOptions: generatorOptions.promptSettings,
+                    showCollabDraftWarning: generatorOptions.showCollabDraftWarning,
+                    workspaceFolders: generatorOptions.workspaceFolders
+                };
+                let serviceAnswers = await (0, prompting_1.promptOdataServiceAnswers)(options, FioriAppGenerator.logger, this.env.adapter);
+                /** Back button issue temp fix */
+                // Persist derived state to facilitate backwards navigation
+                if ((0, fiori_generator_shared_1.getHostEnvironment)() !== fiori_generator_shared_1.hostEnvironment.cli) {
+                    if (serviceAnswers.source === odata_service_inquirer_1.DatasourceType.none || serviceAnswers.edmx) {
+                        (0, utils_1.addToCache)(this.appWizard, { service: serviceAnswers }, FioriAppGenerator.logger);
+                    }
+                    else {
+                        serviceAnswers =
+                            (0, utils_1.getFromCache)(this.appWizard, 'service', FioriAppGenerator.logger) ?? serviceAnswers;
+                    }
+                    if (!(serviceAnswers.source === odata_service_inquirer_1.DatasourceType.none || serviceAnswers.edmx)) {
+                        FioriAppGenerator.logger?.error((0, utils_1.t)('error.fatalError'));
+                    }
+                }
+                /** END: Back button temp fix */
+                this.state.service = { ...this.state?.service, ...serviceAnswers };
+            }
+            // Freestyle templates require a view name
+            if (isFioriFreestyleTemplate) {
+                const viewNameAnswer = await this.prompt([(0, prompting_1.getViewQuestion)()]);
+                this.state.viewName = viewNameAnswer.viewName;
+            }
+            else if (this.state.service.edmx) {
+                // Fiori Elements templates require entity and related settings
+                const entityQuestions = (0, odata_service_inquirer_1.getEntityRelatedPrompts)(this.state.service.edmx, (0, transforms_1.getTemplateType)(this.state.floorplan), !!this.state.service.capService, {
+                    defaultMainEntityName: generatorOptions.preselectedEntityName,
+                    useAutoComplete: (0, fiori_generator_shared_1.getHostEnvironment)() === fiori_generator_shared_1.hostEnvironment.cli,
+                    hideTableLayoutPrompts: generatorOptions.showLayoutPrompts === false // Defaults to show layout prompts
+                }, this.state.service.annotations?.[0], FioriAppGenerator.logger, (0, fiori_generator_shared_1.getHostEnvironment)() !== fiori_generator_shared_1.hostEnvironment.cli);
+                const entityRelatedAnswers = await this.prompt(entityQuestions);
+                // Some state may have been assigned by adaptors, and then certain prompts hidden, so we must merge the answers
+                this.state.entityRelatedConfig = Object.assign(this.state.entityRelatedConfig ?? {}, entityRelatedAnswers);
+            }
+            else {
+                // Not Freestyle and no entity related config is an error and we cannot proceed
+                FioriAppGenerator.logger.error((0, utils_1.t)('error.edmxNotFound'));
+                this._exitOnError((0, utils_1.t)('error.edmxNotFound'));
+            }
+            // Pre-load the CAP project and get all relevant info in one call,
+            // this prevents re-reading from disc and parsing multiple times later
+            if (this.state.service.capService && !this.state.service.capService.cdsUi5PluginInfo) {
+                this.state.service.capService.cdsUi5PluginInfo = await (0, utils_1.getCdsUi5PluginInfo)(this.state.service.capService.projectPath, this.fs, this.state.service.capService.cdsVersionInfo);
+            }
+            // get project information
+            if ((0, utils_1.hasStep)(this.fioriSteps, types_1.STEP_PROJECT_ATTRIBUTES)) {
+                const { ui5AppAnswers, localUI5Version } = await (0, prompting_1.promptUI5ApplicationAnswers)({
+                    projectName: this.state.project?.name,
+                    targetFolder: this.state.project?.targetFolder,
+                    service: this.state.service,
+                    floorplan: this.state.floorplan,
+                    hideUI5VersionPrompt: generatorOptions.hideUI5VersionPrompt,
+                    promptSettings: generatorOptions.promptSettings,
+                    promptExtension: generatorOptions.extensions
+                }, [this.yeomanUiStepConfig], this.env.adapter);
+                this.state.project = Object.assign(this.state.project ?? {}, ui5AppAnswers, {
+                    ui5Version: ui5AppAnswers?.ui5Version || localUI5Version,
+                    localUI5Version,
+                    flpAppId: (0, utils_1.getFlpId)((0, utils_1.getAppId)(ui5AppAnswers.namespace ?? '', ui5AppAnswers?.name), this.state.floorplan === types_1.FloorplanFF.FF_SIMPLE ? types_1.defaultNavActionDisplay : types_1.defaultNavActionTile)
+                });
+            }
+            if (this.state.project?.addDeployConfig) {
+                // Allows back nav where we have iinterdependent steps
+                // Re-add dependant steps on back nav
+                if ((0, utils_1.hasStep)(this.fioriSteps, types_1.STEP_DEPLOY_CONFIG) &&
+                    !(0, utils_1.hasActiveStep)((0, utils_1.t)('steps.deployConfig.title'), this.yeomanUiStepConfig.activeSteps)) {
+                    (0, utils_1.updateDependentStep)((0, utils_1.t)('steps.projectAttributesConfig.title'), [this.yeomanUiStepConfig], true, (0, utils_1.t)('steps.deployConfig.title'));
+                }
+                (0, subgenHelpers_1.addDeployGen)({
+                    service: this.state.service,
+                    projectName: this.state.project.name,
+                    targetFolder: this.state.project.targetFolder,
+                    applicationType: 'FF' // Telemetry data
+                }, this.composeWith.bind(this), FioriAppGenerator.logger, this.appWizard);
+            }
+            if (this.state.project?.addFlpConfig) {
+                // Allows back nav where we have interdependent steps
+                // Re-add dependant steps on back nav
+                if ((0, utils_1.hasStep)(this.fioriSteps, types_1.STEP_FLP_CONFIG) &&
+                    !(0, utils_1.hasActiveStep)((0, utils_1.t)('steps.flpConfig.title'), this.yeomanUiStepConfig.activeSteps)) {
+                    (0, utils_1.updateDependentStep)((0, utils_1.t)('steps.projectAttributesConfig.title'), [this.yeomanUiStepConfig], true, (0, utils_1.t)('steps.flpConfig.title'));
+                }
+                (0, subgenHelpers_1.addFlpGen)({
+                    projectName: this.state.project.name,
+                    targetFolder: this.state.project.targetFolder,
+                    title: this.state.project.title,
+                    skipPrompt: !(0, utils_1.hasStep)(this.fioriSteps, types_1.STEP_FLP_CONFIG)
+                }, this.composeWith.bind(this), FioriAppGenerator.logger, generatorOptions.vscode, this.appWizard);
+            }
+        }
+        catch (error) {
+            // Fatal prompting error
+            FioriAppGenerator.logger.error(`${(0, utils_1.t)('error.fatalError')} : ${error}`);
+            this._exitOnError(error);
+        }
+    }
+    async writing() {
+        try {
+            this.generationTime0 = performance.now();
+            fiori_generator_shared_1.TelemetryHelper.markAppGenStartTime();
+            const { service, project, floorplan } = this.state;
+            FioriAppGenerator.logger.info((0, utils_1.t)('logMessages.copyingTemplateFiles', { templateName: this.state.floorplan }));
+            // Set the template folder
+            // this.sourceRoot(join(__dirname, '..', '..', 'templates')); // Path must match webpacked template paths
+            const destRoot = this.destinationRoot((0, path_1.join)(project.targetFolder, project.name));
+            const t1 = performance.now();
+            let appConfig;
+            // Determine which type of app to generate based on the selected floorplan (template type)
+            if (this.state.floorplan === types_1.FloorplanFF.FF_SIMPLE) {
+                const ffApp = await (0, transforms_1.transformState)(this.state, !!service.capService || this.options.generateIndexHtml);
+                await (0, fiori_freestyle_writer_1.generate)(destRoot, ffApp, this.fs);
+                appConfig = ffApp;
+            }
+            else {
+                const feApp = await (0, transforms_1.transformState)(this.state, !!service.capService || this.options.generateIndexHtml);
+                await (0, fiori_elements_writer_1.generate)(destRoot, feApp, this.fs);
+                appConfig = feApp;
+            }
+            const t2 = performance.now();
+            FioriAppGenerator.logger.debug(`Writing Fiori application files from template took ${Math.round(t2 - t1)} milliseconds.`);
+            fiori_generator_shared_1.TelemetryHelper.createTelemetryData({
+                Template: (0, utils_1.t)(`floorplans.label.${floorplan}`, {
+                    odataVersion: service.version
+                }),
+                DataSource: service.source,
+                UI5Version: project.ui5Version || ui5_info_1.latestVersionString,
+                Theme: project.ui5Theme,
+                AppGenVersion: this.generatorVersion,
+                AppGenSourceType: service.source,
+                AppGenSapSystemType: service.source === odata_service_inquirer_1.DatasourceType.sapSystem && service.connectedSystem
+                    ? (0, utils_1.getTelemetrySapSystemType)(service.connectedSystem)
+                    : 'n/a',
+                AppGenBusinessHubType: (0, utils_1.getTelemetryBusinessHubType)(service.apiHubConfig?.apiHubType),
+                EnableEslint: project.enableEslint,
+                EnableTypeScript: project.enableTypeScript,
+                EnableCodeAssist: project.enableCodeAssist,
+                ToolsId: appConfig.app.sourceTemplate?.toolsId
+            });
+            if (service.apiHubConfig && (0, btp_utils_1.isAppStudio)()) {
+                (0, writing_1.writeAPIHubKeyFiles)(this.fs, destRoot, service.apiHubConfig);
+            }
+            // Write after app, using values from the transformed state so defaults have been applied
+            const readMeUpdated = { ui5Version: appConfig.ui5?.minUI5Version };
+            await (0, writing_1.writeReadMe)(this.state, types_1.generatorName, this.generatorVersion, destRoot, this.fs, readMeUpdated);
+        }
+        catch (error) {
+            FioriAppGenerator.logger.fatal(`${(0, utils_1.t)('error.errorWritingApplicationFiles')} : ${error}`);
+            this._exitOnError(error);
+        }
+    }
+    async install() {
+        if (!this.options.skipInstall) {
+            await (0, install_1.installDependencies)({
+                appPackagePath: this.destinationPath(),
+                capService: this.state.service.capService,
+                enableCodeAssist: this.state.project?.enableCodeAssist ?? false,
+                // Assumption that npm workspaces will be enabled if cds ui5 plugin is a depenedency
+                useNpmWorkspaces: !!(this.state.service.capService?.cdsUi5PluginInfo?.isCdsUi5PluginEnabled ||
+                    this.state.service.capService?.cdsUi5PluginInfo?.hasCdsUi5Plugin ||
+                    this.state.service.capService?.cdsUi5PluginInfo?.isWorkspaceEnabled),
+                ui5Version: this.state.project?.ui5Version
+            }, FioriAppGenerator.logger);
+        }
+        else {
+            FioriAppGenerator.logger.info((0, utils_1.t)('logMessages.installSkippedOptionSpecified'));
+        }
+    }
+    async end() {
+        (0, utils_1.deleteCache)(this.appWizard, FioriAppGenerator.logger);
+        await (0, end_1.runPostGenerationTasks)({
+            service: {
+                backendSystem: this.state.service.connectedSystem?.backendSystem,
+                capService: this.state.service.capService,
+                sapClient: this.state.service.client,
+                odataVersion: this.state.service.version,
+                datasourceType: this.state.service.source
+            },
+            project: {
+                targetFolder: this.state.project.targetFolder,
+                name: this.state.project.name,
+                flpAppId: this.state.project.flpAppId
+            }
+        }, this.fs, FioriAppGenerator.logger, this.vscode, this.appWizard, this.options.followUpCommand);
+        const generationTime02 = performance.now();
+        FioriAppGenerator.logger.info(`Total time taken: ${Math.round((generationTime02 - this.generationTime0) / 1000)} seconds.`);
+    }
+    /**
+     *
+     * @param error
+     */
+    _exitOnError(error) {
+        // eslint-disable-next-line @typescript-eslint/no-floating-promises
+        (0, fiori_generator_shared_1.sendTelemetry)('GENERATION_WRITING_FAIL', fiori_generator_shared_1.TelemetryHelper.telemetryData);
+        if ((0, fiori_generator_shared_1.getHostEnvironment)() !== fiori_generator_shared_1.hostEnvironment.cli) {
+            this.appWizard?.showError(`${(0, utils_1.t)('error.fatalError')} : ${error}`, yeoman_ui_types_1.MessageType.notification);
+        }
+        throw new Error(`${(0, utils_1.t)('error.fatalError')} : ${error}`);
+    }
+}
+exports.FioriAppGenerator = FioriAppGenerator;
+//# sourceMappingURL=fioriAppGenerator.js.map

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

@@ -0,0 +1,94 @@
+import type { AppWizard, Severity } from '@sap-devx/yeoman-ui-types';
+import type Generator from 'yeoman-generator';
+import type { FioriGeneratorSettings, FioriStep, Floorplan, PromptExtension, FioriAppGeneratorPromptSettings, State, YeomanUiStepConfig } from '../types';
+/**
+ * Fiori generator specific options, for internal use only.
+ * todo: Split this into FioriGenerator options (e.g. disableS4, disableGeneratorExtensions, data) that are explicitly root generator options
+ * and FioriAppGenerator options which should be considered internal (passed from Fiori generator to FioriAppGenerator)
+ */
+export interface FioriAppGeneratorOptions extends Generator.GeneratorOptions, FioriGeneratorSettings {
+    /**
+     * Disables loading of S4 generator steps even if its found.
+     * todo: External -> FioriGeneratorOptions
+     */
+    disableS4?: boolean;
+    /**
+     * Disables loading of generator extensions even if they are found
+     * todo: External -> FioriGeneratorOptions
+     */
+    disableGeneratorExtensions?: boolean;
+    /**
+     * Additional (non-specified option) data may be passed using this property. e.g. Adaptor data
+     * todo: External -> FioriGeneratorOptions
+     */
+    data?: Object;
+    /**
+     * Customer provided extensions used to customize existing questions
+     */
+    extensions?: PromptExtension;
+    /**
+     * The floorplan (app type) that will be created
+     */
+    floorplan?: Floorplan;
+    /**
+     * Prompt settings to control visibility and default values of prompts
+     */
+    promptSettings?: FioriAppGeneratorPromptSettings;
+    /**
+     * Changes the launch config writing behaviour from detecting and creating/updating workspace files to only creating with the app target folder
+     *
+     * @default false
+     */
+    writeLaunchConfigstoAppOnly?: boolean;
+    /**
+     * Show template selection step even if only one template. In some cases callers of the generator may want users to be able to confirm the selected floorplan even if theres only one.
+     *
+     * @default false
+     */
+    showTemplateSelectionStepIfOnlyOne?: boolean;
+    /**
+     * Wizard messages may be shown on the first step adjacent to the navigation buttons using this option.
+     * This enables callers of App Gen to set end-user messages specific to the context of the caller, for example BAS Storyboard flows.
+     */
+    wizardMessage?: {
+        /**
+         * The text of the message to show
+         */
+        text: string;
+        /**
+         * The severity of the notification. Default is `Severity.information`.
+         */
+        severity?: Severity;
+        /**
+         * A link may be included. Currently not supported by YUI.
+         */
+        link?: string;
+    };
+    /**
+     * State set by composing generator i.e `@sap/fiori-generator`
+     */
+    state?: State;
+    /**
+     * App Wizard reference
+     */
+    appWizard?: AppWizard;
+    /**
+     * The telemetry data to be sent along with any telemetry events
+     */
+    telemetryData?: Record<string, unknown>;
+    /**
+     * Defined the steps configuration to be used in the Fiori generator. Skip steps by omitting them from the array.
+     * Note that these should be aligned with `yeomanUiStepConfig`.
+     */
+    fioriSteps?: FioriStep[];
+    /**
+     * Defines the steps configuration to be used in the YUI generator.
+     * Not applicable to CLI usage.
+     */
+    yeomanUiStepConfig?: YeomanUiStepConfig;
+    /**
+     * VSCode Workspace folders
+     */
+    workspaceFolders?: string[];
+}
+//# sourceMappingURL=fioriAppGeneratorOptions.d.ts.map

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

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

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

@@ -0,0 +1,3 @@
+export * from './fioriAppGenerator';
+export * from './fioriAppGeneratorOptions';
+//# sourceMappingURL=index.d.ts.map

package/generators/fiori-app-generator/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("./fioriAppGenerator"), exports);
+__exportStar(require("./fioriAppGeneratorOptions"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1,34 @@
+import type { CapService } from '@sap-ux/cap-config-writer';
+import { type ILogWrapper } from '@sap-ux/fiori-generator-shared';
+/**
+ * Defines the options used to install deps to a CAP project.
+ */
+export type CapInstallOptions = {
+    ui5Version?: string;
+    codeAssist?: boolean;
+    rootPath?: string;
+    depsInstallPath?: string;
+    useWorkspaces?: boolean;
+};
+/**
+ * Perform the installation of dependencies for the specified project.
+ * If a CAP service is provided AND `useNpmWorkspaces` is false, the dependencies will be installed to the CAP root project,
+ * otherwise they will be installed to the specified app `packagePath`.
+ *
+ * @param param0
+ * @param param0.appPackagePath
+ * @param param0.capService
+ * @param param0.enableCodeAssist
+ * @param param0.useNpmWorkspaces
+ * @param param0.ui5Version
+ * @param logger The logger to use for output
+ * @returns Promise<void>
+ */
+export declare function installDependencies({ appPackagePath, capService, enableCodeAssist, useNpmWorkspaces, ui5Version }: {
+    appPackagePath: string;
+    capService?: CapService;
+    enableCodeAssist: boolean;
+    useNpmWorkspaces: boolean;
+    ui5Version: string;
+}, logger: ILogWrapper): Promise<void>;
+//# sourceMappingURL=install.d.ts.map