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

package/generators/utils/common.js

@@ -0,0 +1,286 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFlpId = exports.getSemanticObject = void 0;
+exports.getODataVersion = getODataVersion;
+exports.getAppId = getAppId;
+exports.buildSapClientParam = buildSapClientParam;
+exports.getRequiredOdataVersion = getRequiredOdataVersion;
+exports.getMinSupportedUI5Version = getMinSupportedUI5Version;
+exports.generateToolsId = generateToolsId;
+exports.getCdsUi5PluginInfo = getCdsUi5PluginInfo;
+exports.getCdsAnnotations = getCdsAnnotations;
+exports.isBTPHosted = isBTPHosted;
+exports.getReadMeDataSourceLabel = getReadMeDataSourceLabel;
+exports.getLaunchText = getLaunchText;
+exports.generateLaunchConfig = generateLaunchConfig;
+exports.convertCapRuntimeToCapProjectType = convertCapRuntimeToCapProjectType;
+exports.getAnnotations = getAnnotations;
+const annotation_converter_1 = require("@sap-ux/annotation-converter");
+const btp_utils_1 = require("@sap-ux/btp-utils");
+const cap_config_writer_1 = require("@sap-ux/cap-config-writer");
+const edmx_parser_1 = require("@sap-ux/edmx-parser");
+const fiori_elements_writer_1 = require("@sap-ux/fiori-elements-writer");
+const fiori_tools_settings_1 = require("@sap-ux/fiori-tools-settings");
+const launch_config_1 = require("@sap-ux/launch-config");
+const odata_service_inquirer_1 = require("@sap-ux/odata-service-inquirer");
+const project_access_1 = require("@sap-ux/project-access");
+const path_1 = require("path");
+const uuid_1 = require("uuid");
+const constants_1 = require("../types/constants");
+const external_1 = require("../types/external");
+const i18n_1 = require("./i18n");
+/**
+ * Parse the specified edmx string for validitiy and return the ODataVersion of the specified edmx string.
+ *
+ * @param edmx
+ * @returns ODataVersion, odata version
+ * @throws Error, if invalid edmx
+ */
+function getODataVersion(edmx) {
+    try {
+        const convertedMetadata = (0, annotation_converter_1.convert)((0, edmx_parser_1.parse)(edmx));
+        return convertedMetadata.version.startsWith('4') ? odata_service_inquirer_1.OdataVersion.v4 : odata_service_inquirer_1.OdataVersion.v2;
+    }
+    catch (error) {
+        throw Error((0, i18n_1.t)('error.appConfigUnparseableEdmx'));
+    }
+}
+/**
+ * Get AppId from provided namespace and name.
+ *
+ * @param name
+ * @param namespace
+ * @returns AppId
+ */
+function getAppId(name, namespace) {
+    const fullyQualifiedProjectName = [namespace, name].filter((x) => !!x).join('.');
+    return fullyQualifiedProjectName.replace(/[_-]/g, '');
+}
+/**
+ * Creates a value suitable for use as a semantic object for navigation intents.
+ * Removes specific characters that would break the navigation.
+ *
+ * @param appId
+ * @returns
+ */
+const getSemanticObject = (appId) => {
+    const semanticObject = appId.replace(/[-_.#]/g, '');
+    return semanticObject.length > 30 ? semanticObject.substring(0, 30) : semanticObject;
+};
+exports.getSemanticObject = getSemanticObject;
+const getFlpId = (appId, action) => {
+    return `${(0, exports.getSemanticObject)(appId)}${action ? '-' + action : ''}`;
+};
+exports.getFlpId = getFlpId;
+/**
+ * Builds the sap-client parameter for the URL.
+ * If sapClient is not provided, returns an empty string.
+ *
+ * @param sapClient
+ * @returns sap-client parameter
+ */
+function buildSapClientParam(sapClient) {
+    return sapClient ? `sap-client=${sapClient}` : '';
+}
+/**
+ * If a floorplan only supports single odata version, get that version.
+ * Otherwise returns undefined, indicating multiple versions are supported.
+ *
+ * @param floorplan a floorplan value
+ * @returns - array of supported odata versions or undefined if all are supported
+ */
+function getRequiredOdataVersion(floorplan) {
+    const supportedVers = external_1.FloorplanAttributes[floorplan].supportedODataVersion;
+    return supportedVers.length === 1 ? supportedVers[0] : undefined;
+}
+/**
+ * Gets the min supported version of UI5 for the floorplan and odata version specified.
+ *
+ * @param version - odata version
+ * @param floorplan - floorplan value
+ * @returns min supported version
+ */
+function getMinSupportedUI5Version(version, floorplan) {
+    let minUI5Version;
+    if (floorplan && floorplan !== external_1.FloorplanFF.FF_SIMPLE) {
+        const templateType = external_1.FloorplanAttributes[floorplan].templateType;
+        minUI5Version = fiori_elements_writer_1.TemplateTypeAttributes[templateType].minimumUi5Version[version];
+    }
+    return minUI5Version ?? (version === odata_service_inquirer_1.OdataVersion.v4 ? constants_1.minSupportedUi5VersionV4 : constants_1.minSupportedUi5Version);
+}
+/**
+ * Generates a v4 uuid. While not strictly necessary to wrap uuid it means we can enforce
+ * additional options or change implementation easily in future.
+ *
+ * @returns a uuid v4 string
+ */
+function generateToolsId() {
+    return (0, uuid_1.v4)();
+}
+/**
+ * Retrieves information related to cds version and checks if the CAP UI5 plugin is enabled.
+ *
+ * @param capProjectPath The path to the CAP project.
+ * @param fs The file system editor.
+ * @param cdsVersionInfo If provided will be used instead of parsing the package.json file to determine the cds version.
+ * @returns A promise that resolves to an object containing cdsinformation,
+ *          or `undefined` if the CAP UI5 plugin is not enabled.
+ */
+async function getCdsUi5PluginInfo(capProjectPath, fs, cdsVersionInfo) {
+    // If the project is a Java project, do not pass cdsVersionInfo.
+    // This ensures that hasMinCdsVersion is false for Java project, preventing getEnableNPMWorkspacesPrompt from being invoked for Java projects.
+    const cdsVersion = (await (0, project_access_1.isCapJavaProject)(capProjectPath)) ? undefined : cdsVersionInfo;
+    const capCdsInfo = await (0, cap_config_writer_1.checkCdsUi5PluginEnabled)(capProjectPath, fs, true, cdsVersion);
+    return capCdsInfo === false ? undefined : capCdsInfo;
+}
+/**
+ * Returns CDS annotations information.
+ *
+ * @param {CapService} capService - The CAP service object containing information about the service.
+ * @param {string} projectName - The name of the project, which is the module name.
+ * @returns {Promise<CdsAnnotationsInfo>} A promise that resolves to an object containing CDS annotations information.
+ */
+async function getCdsAnnotations(capService, projectName) {
+    const { appPath: capAppPath = 'app', projectPath, serviceCdsPath, serviceName } = capService;
+    if (serviceCdsPath) {
+        // Construct the annotation path and service cds URI
+        const annotationPath = (0, path_1.join)(capAppPath, projectName, 'annotation.cds').replace(/\\/g, '/');
+        const serviceCdsUri = await (0, project_access_1.toReferenceUri)(projectPath, annotationPath, serviceCdsPath);
+        // Create the contents of the annotation CDS file
+        const annotationCdsContents = `using ${serviceName} as service from '${serviceCdsUri}';`;
+        // Return an object with the necessary information for cds files
+        return {
+            cdsFileContents: annotationCdsContents,
+            projectPath: projectPath,
+            appPath: capAppPath,
+            projectName: projectName
+        };
+    }
+}
+/**
+ * Determine if the specified connected system is hosted on BTP.
+ * If a backend system uses service keys, or a destination is an ABAP environment on BTP, then it is considered to be hosted on BTP.
+ *
+ * @param connectedSystem - The connected system object.
+ * @returns {boolean} `true` if the connected system is hosted on BTP, otherwise `false`.
+ */
+function isBTPHosted(connectedSystem) {
+    return (!!connectedSystem?.backendSystem?.serviceKeys ||
+        (connectedSystem?.destination ? (0, btp_utils_1.isAbapEnvironmentOnBtp)(connectedSystem.destination) : false));
+}
+/**
+ * Retrieves the data source label.
+ *
+ * @param {DatasourceType} source - The data source type (`DatasourceType.sapSystem` or `DatasourceType.businessHub`).
+ * @param scp
+ * @param {ApiHubType} apiHubType - The API hub type for business hubs.
+ * @returns {string} The formatted data source label.
+ */
+function getReadMeDataSourceLabel(source, scp = false, apiHubType) {
+    let dataSourceLabel;
+    if (source === odata_service_inquirer_1.DatasourceType.sapSystem) {
+        const labelDatasourceType = (0, i18n_1.t)(`readme.label.datasourceType.${odata_service_inquirer_1.DatasourceType.sapSystem}`);
+        const labelSystemType = (0, i18n_1.t)(`readme.label.sapSystemType.${scp ? "abapOnBtp" /* SapSystemSourceType.SCP */ : "onPrem" /* SapSystemSourceType.ON_PREM */}`);
+        dataSourceLabel = `${labelDatasourceType} (${labelSystemType})`;
+    }
+    else if (source === odata_service_inquirer_1.DatasourceType.businessHub && apiHubType === "API_HUB_ENTERPRISE" /* ApiHubType.apiHubEnterprise */) {
+        dataSourceLabel = (0, i18n_1.t)('readme.label.datasourceType.apiBusinessHubEnterprise');
+    }
+    return dataSourceLabel ?? (0, i18n_1.t)(`readme.label.datasourceType.${source}`);
+}
+/**
+ * Generates the launch text for the application based on the CAP service information and project details.
+ *
+ * @param {CapServiceCdsInfo} capService - The CAP (Cloud Application Programming) service information.
+ * @param {string} name - The name of the project.
+ * @param {boolean} useNpmWorkspaceAppRef - For CAP projects, indicates whether (root CAP project) npm workspaces app ref should be used when launching.
+ * @param {string} namespace - The namespace of the project.
+ * @returns {string} The launch text for the application. If CAP service information is provided, it returns a custom launch text based on the CAP service type,
+ *  project name, and optionally the application ID if NPM workspaces or CDS UI5 plugin is enabled.
+ *  If CAP service information is not available, it returns a default launch text.
+ */
+async function getLaunchText(capService, name, useNpmWorkspaceAppRef, namespace) {
+    if (capService) {
+        const appId = capService?.cdsUi5PluginInfo?.isCdsUi5PluginEnabled || useNpmWorkspaceAppRef // May be a case where isCdsUi5PluginEnabled is false but we know it will be enabled by the time the app is launched
+            ? getAppId(name, namespace)
+            : undefined;
+        return (0, cap_config_writer_1.getAppLaunchText)(capService.capType ?? 'Node.js', name, appId);
+    }
+    return (0, i18n_1.t)('readme.texts.runInstruction');
+}
+/**
+ * Generates the launch configuration for a project based on the provided options.
+ *
+ * @param {GenerateLaunchConfigOptions} options - An object containing configuration options for the project.
+ * @param {OdataVersion} options.odataVersion - The version of the OData service (e.g. v2 or v4) used by the project.
+ * @param {DatasourceType} options.source - The type of data source the project uses (e.g. metadata file or OData source URL).
+ * @param {string} options.sapClientParam - The SAP client parameter.
+ * @param {string} options.targetFolder - The file path to the project where the launch configuration should be created.
+ * @param {string} options.projectName - The name of the project.
+ * @param {string} options.appId - The application ID for the project.
+ * @param {Editor} fs - The file system editor.
+ * @param {any} vscode - The Visual Studio Code object.
+ * @param {Logger} [log] - An optional logger instance.
+ * @param {boolean} [writeToAppOnly] - A flag indicating whether to write the configuration only to the app folder.
+ * @returns {void}
+ */
+async function generateLaunchConfig(options, fs, vscode, log, writeToAppOnly = false) {
+    try {
+        if (vscode) {
+            const addStartCmd = options.datasourceType !== odata_service_inquirer_1.DatasourceType.metadataFile;
+            const projectPath = (0, path_1.join)(options.targetFolder, options.projectName);
+            const debugOptions = {
+                vscode: vscode,
+                addStartCmd,
+                sapClientParam: options.sapClientParam,
+                flpAppId: options.flpAppId ?? '',
+                flpSandboxAvailable: true,
+                isAppStudio: (0, btp_utils_1.isAppStudio)(),
+                writeToAppOnly
+            };
+            if (options.odataVersion) {
+                debugOptions.odataVersion = options.odataVersion === odata_service_inquirer_1.OdataVersion.v2 ? '2.0' : '4.0';
+            }
+            const fioriOptions = {
+                name: (0, path_1.basename)(options.projectName),
+                projectRoot: projectPath,
+                debugOptions
+            };
+            await (0, launch_config_1.createLaunchConfig)(projectPath, fioriOptions, fs, log);
+            (0, fiori_tools_settings_1.writeApplicationInfoSettings)(projectPath);
+        }
+    }
+    catch (err) {
+        log?.error(`${(0, i18n_1.t)('error.errorWritingApplicationFiles')} : ${err}`);
+    }
+}
+/**
+ * Convert between the CAPProjectType project type from the `@sap-ux/project-access' package and the CAP Runtime type from the `@sap-ux/odata-service-inquirer' package.
+ *
+ * @param {CapRuntime} capRuntime - The CAP runtime type. Default is 'Node.js'.
+ * @returns {CapProjectType} The CAP project type.
+ */
+function convertCapRuntimeToCapProjectType(capRuntime = 'Node.js') {
+    return capRuntime === 'Java' ? 'CAPJava' : 'CAPNodejs';
+}
+/**
+ * Get the annotations for the project based on the provided CAP service or transforms the annotations to the correct type otherwise.
+ *
+ * @param {string} projectName - The name of the project for which annotations are being retrieved.
+ * @param {Annotations} annotations - The EDMX annotations object containing technical name and XML definitions.
+ * @param {CapService} capService - The CAP service instance used to retrieve CDS annotations.
+ * @returns {Promise<CdsAnnotationsInfo | EdmxAnnotationsInfo>} A promise that resolves to either CDS annotations info or EDMX annotations info.
+ */
+async function getAnnotations(projectName, annotations, capService) {
+    // Add annotations to fiori app
+    if (capService) {
+        return getCdsAnnotations(capService, projectName);
+    }
+    if (annotations) {
+        return {
+            technicalName: annotations.TechnicalName,
+            xml: annotations.Definitions
+        };
+    }
+}
+//# sourceMappingURL=common.js.map

package/generators/utils/eventHooks.d.ts

@@ -0,0 +1,29 @@
+import type { ILogWrapper } from '@sap-ux/fiori-generator-shared';
+export interface HookParameters {
+    fsPath: string;
+}
+export interface VSCodeInstance {
+    commands: {
+        executeCommand: (command: string, ...rest: any[]) => Promise<void>;
+    };
+}
+export declare const DEFAULT_POST_APP_GEN_COMMAND = "sap.ux.application.generated.handler";
+export interface GeneratorContext {
+    hookParameters: HookParameters;
+    vscodeInstance?: VSCodeInstance;
+    options?: {
+        followUpCommand?: string;
+        [key: string]: unknown;
+    };
+}
+export type Event = 'app-generated';
+/**
+ * Run the post generation events. This can be used to run any follow up commands.
+ *
+ * @param event The event to run
+ * @param context Additional information required to run the commands
+ * @param logger The logger to use
+ * @returns
+ */
+export declare function runHooks(event: Event, context: GeneratorContext, logger?: ILogWrapper): Promise<void>;
+//# sourceMappingURL=eventHooks.d.ts.map

package/generators/utils/eventHooks.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_POST_APP_GEN_COMMAND = void 0;
+exports.runHooks = runHooks;
+const i18n_1 = require("./i18n");
+exports.DEFAULT_POST_APP_GEN_COMMAND = 'sap.ux.application.generated.handler';
+/**
+ * Run the post generation events. This can be used to run any follow up commands.
+ *
+ * @param event The event to run
+ * @param context Additional information required to run the commands
+ * @param logger The logger to use
+ * @returns
+ */
+async function runHooks(event, context, logger) {
+    if (event === 'app-generated') {
+        return postGenerationHook(context, logger);
+    }
+    else {
+        return Promise.reject(new Error((0, i18n_1.t)('error.unsupportedPostGenerationEvent', { event })));
+    }
+}
+/**
+ * Run the commands defined by the GeneratorContext.
+ *
+ * @param context - information required to run the commands
+ * @param logger - the logger to use
+ */
+async function postGenerationHook(context, logger) {
+    if (context.vscodeInstance) {
+        try {
+            const command = context.options?.followUpCommand ?? exports.DEFAULT_POST_APP_GEN_COMMAND;
+            logger?.info((0, i18n_1.t)('logMessages.attemptingToExecutePostGenerationCommand', { command }));
+            await context.vscodeInstance.commands?.executeCommand?.(command, context.hookParameters);
+        }
+        catch (e) {
+            // Log if we can, can't handle exceptions here
+            try {
+                const warningMsg = e.toString().replace('Error: command', 'Command'); // remove 'Error' from this message
+                logger?.warn(warningMsg);
+            }
+            catch {
+                // }
+            }
+        }
+    }
+}
+//# sourceMappingURL=eventHooks.js.map

package/generators/utils/i18n.d.ts

@@ -0,0 +1,16 @@
+import type { TOptions } from 'i18next';
+export declare const fioriAppSubGeneratorNs = "fiori-app-sub-generator";
+export declare const defaultProjectNumber = 1;
+/**
+ * Initialize i18next with the translations for this module.
+ */
+export declare function initI18nFioriAppSubGenerator(): Promise<void>;
+/**
+ * Helper function facading the call to i18next. Unless a namespace option is provided the local namespace will be used.
+ *
+ * @param key i18n key
+ * @param options additional options
+ * @returns {string} localized string stored for the given key
+ */
+export declare function t(key: string, options?: TOptions): string;
+//# sourceMappingURL=i18n.d.ts.map

package/generators/utils/i18n.js

@@ -0,0 +1,54 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultProjectNumber = exports.fioriAppSubGeneratorNs = void 0;
+exports.initI18nFioriAppSubGenerator = initI18nFioriAppSubGenerator;
+exports.t = t;
+const i18next_1 = __importDefault(require("i18next"));
+const fioriAppSubGenerator_i18n_json_1 = __importDefault(require("../translations/fioriAppSubGenerator.i18n.json"));
+exports.fioriAppSubGeneratorNs = 'fiori-app-sub-generator';
+exports.defaultProjectNumber = 1;
+/**
+ * Initialize i18next with the translations for this module.
+ */
+async function initI18nFioriAppSubGenerator() {
+    await i18next_1.default.init({
+        resources: {
+            en: {
+                [exports.fioriAppSubGeneratorNs]: fioriAppSubGenerator_i18n_json_1.default
+            }
+        },
+        lng: 'en',
+        fallbackLng: 'en',
+        defaultNS: exports.fioriAppSubGeneratorNs,
+        ns: [exports.fioriAppSubGeneratorNs],
+        interpolation: {
+            format: function odataVersionFormatter(odataVersion) {
+                return odataVersion ? ` V${odataVersion}` : '';
+            },
+            defaultVariables: {
+                defaultProjectNumber: exports.defaultProjectNumber
+            }
+        },
+        missingInterpolationHandler: () => '' // Called when interpolation values are undefined, prevents outputting of `{{undefinedProperty}}`
+    });
+}
+/**
+ * Helper function facading the call to i18next. Unless a namespace option is provided the local namespace will be used.
+ *
+ * @param key i18n key
+ * @param options additional options
+ * @returns {string} localized string stored for the given key
+ */
+function t(key, options) {
+    if (!options?.ns) {
+        options = Object.assign(options ?? {}, { ns: exports.fioriAppSubGeneratorNs });
+    }
+    return i18next_1.default.t(key, options);
+}
+initI18nFioriAppSubGenerator().catch(() => {
+    // Needed for lint
+});
+//# sourceMappingURL=i18n.js.map

package/generators/utils/index.d.ts

@@ -0,0 +1,9 @@
+export * from './i18n';
+export * from './telemetry';
+export * from './common';
+export * from './stepsHelper';
+export * from './command-runner';
+export * from './eventHooks';
+export * from './sapuxLayer';
+export * from './appWizardCache';
+//# sourceMappingURL=index.d.ts.map

package/generators/utils/index.js

@@ -0,0 +1,25 @@
+"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("./i18n"), exports);
+__exportStar(require("./telemetry"), exports);
+__exportStar(require("./common"), exports);
+__exportStar(require("./stepsHelper"), exports);
+__exportStar(require("./command-runner"), exports);
+__exportStar(require("./eventHooks"), exports);
+__exportStar(require("./sapuxLayer"), exports);
+__exportStar(require("./appWizardCache"), exports);
+//# sourceMappingURL=index.js.map

package/generators/utils/sapuxLayer.d.ts

@@ -0,0 +1,15 @@
+import type { UI5FlexLayer } from '@sap-ux/project-access';
+/**
+ * Determines the SAP UX layer based on isCap enabled or not.
+ *
+ * If the project is a CAP project, this function will return `undefined`.
+ * For non-CAP projects, it checks whether internal features are enabled and returns the corresponding
+ * SAP UX layer:
+ * - `UI5FlexLayer.VENDOR` if internal features are enabled,
+ * - `UI5FlexLayer.CUSTOMER_BASE` if they are not.
+ *
+ * @param {boolean} isCap - Indicates if the project is a CAP project.
+ * @returns {UI5FlexLayer | undefined} - The assigned SAP UX layer or `undefined` for CAP projects.
+ */
+export declare function assignSapUxLayerValue(isCap?: boolean): UI5FlexLayer | undefined;
+//# sourceMappingURL=sapuxLayer.d.ts.map

package/generators/utils/sapuxLayer.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assignSapUxLayerValue = assignSapUxLayerValue;
+const feature_toggle_1 = require("@sap-ux/feature-toggle");
+/**
+ * Determines the SAP UX layer based on isCap enabled or not.
+ *
+ * If the project is a CAP project, this function will return `undefined`.
+ * For non-CAP projects, it checks whether internal features are enabled and returns the corresponding
+ * SAP UX layer:
+ * - `UI5FlexLayer.VENDOR` if internal features are enabled,
+ * - `UI5FlexLayer.CUSTOMER_BASE` if they are not.
+ *
+ * @param {boolean} isCap - Indicates if the project is a CAP project.
+ * @returns {UI5FlexLayer | undefined} - The assigned SAP UX layer or `undefined` for CAP projects.
+ */
+function assignSapUxLayerValue(isCap = false) {
+    if (isCap) {
+        // Skip for CAP projects
+        return undefined;
+    }
+    return (0, feature_toggle_1.isInternalFeaturesSettingEnabled)() ? 'VENDOR' : 'CUSTOMER_BASE';
+}
+//# sourceMappingURL=sapuxLayer.js.map

package/generators/utils/stepsHelper.d.ts

@@ -0,0 +1,47 @@
+import type { IPrompt as YeomanUiStep } from '@sap-devx/yeoman-ui-types';
+import { Prompts as YeomanUiSteps } from '@sap-devx/yeoman-ui-types';
+import type { FioriStep, YeomanUiStepConfig } from '../types/yeomanUiStepConfig';
+/**
+ * Update the dependent step in the active steps of the Yeoman UI steps. Ultimately this will result in a new step being added to the Application Wizard.
+ *
+ * @param currentStepName The name (title) of the step that is being toggled. Not the step key.
+ * @param stepConfigList
+ * @param action Add dependent step if true, remove if false.
+ * @param dependentStepName
+ */
+export declare function updateDependentStep(currentStepName: string, stepConfigList: YeomanUiStepConfig[], action: boolean, dependentStepName?: string): void;
+/**
+ * Check if a step is considered active in the Yeoman UI steps.
+ *
+ * @param stepName The name (title) of the step to check. Not the step key.
+ * @param yuiSteps
+ * @returns
+ */
+export declare function hasActiveStep(stepName: string, yuiSteps: YeomanUiSteps): boolean;
+/**
+ *  Check if a step is present in the steps array. Non-present steps are not added to the Application Wizard, essentially skipping them.
+ *
+ * @param steps
+ * @param stepKey
+ * @returns
+ */
+export declare function hasStep(steps: FioriStep[], stepKey: string): boolean;
+/**
+ * Get the Yeoman UI step configuration.
+ *
+ * @param stepsArr
+ * @returns
+ */
+export declare function getYeomanUiStepConfig(stepsArr: YeomanUiStep[]): YeomanUiStepConfig;
+/**
+ * Used in Inquirer prompt validators to dynamically add or remove dependent steps to the Application Wizard.
+ * For example, may be used when a user checks `addDeployConfig` to add that deployment config step to the wizard.
+ *
+ * @param addDependentStep
+ * @param currentStepName
+ * @param appGenStepConfigList
+ * @param dependentStepName
+ * @returns
+ */
+export declare function validateNextStep(addDependentStep: boolean, currentStepName: string, appGenStepConfigList?: YeomanUiStepConfig[], dependentStepName?: string): boolean;
+//# sourceMappingURL=stepsHelper.d.ts.map