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

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

@@ -0,0 +1,278 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTemplateType = getTemplateType;
+exports.transformTemplateType = transformTemplateType;
+exports.transformState = transformState;
+const btp_utils_1 = require("@sap-ux/btp-utils");
+const fiori_elements_writer_1 = require("@sap-ux/fiori-elements-writer");
+const fiori_freestyle_writer_1 = require("@sap-ux/fiori-freestyle-writer");
+const odata_service_inquirer_1 = require("@sap-ux/odata-service-inquirer");
+const odata_service_writer_1 = require("@sap-ux/odata-service-writer");
+const store_1 = require("@sap-ux/store");
+const ui5_info_1 = require("@sap-ux/ui5-info");
+const types_1 = require("../types");
+const utils_1 = require("../utils");
+const fiori_generator_shared_1 = require("@sap-ux/fiori-generator-shared");
+/**
+ * Get the writer template type from the Fiori App floorplan.
+ *
+ * @param floorplan
+ * @returns {TemplateTypeFE | TemplateTypeFF} - The template type
+ */
+function getTemplateType(floorplan) {
+    const templateMap = {
+        [types_1.FloorplanFE.FE_ALP]: 'alp',
+        [types_1.FloorplanFE.FE_FEOP]: 'feop',
+        [types_1.FloorplanFE.FE_LROP]: 'lrop',
+        [types_1.FloorplanFE.FE_OVP]: 'ovp',
+        [types_1.FloorplanFE.FE_WORKLIST]: 'worklist',
+        [types_1.FloorplanFE.FE_FPM]: 'fpm',
+        [types_1.FloorplanFF.FF_SIMPLE]: 'basic'
+    };
+    return templateMap[floorplan];
+}
+/**
+ * Transform the Fiori App floorplan to the type required by the open source ux-tools writer modules.
+ *
+ * @param floorplan
+ * @param entityRelatedConfig
+ * @param viewName
+ * @returns {Template} - The template configuration
+ */
+function transformTemplateType(floorplan, entityRelatedConfig, viewName) {
+    if (floorplan === types_1.FloorplanFF.FF_SIMPLE) {
+        return {
+            type: fiori_freestyle_writer_1.TemplateType.Basic, // We only support one template type now so it can be hardcoded
+            settings: {
+                viewName
+            }
+        };
+    }
+    // Since we have already returned the FF template type, we can safely cast the template type to TemplateTypeFE
+    const templateType = getTemplateType(floorplan);
+    let _entityConfig;
+    if (entityRelatedConfig?.mainEntity) {
+        _entityConfig = {
+            mainEntityName: entityRelatedConfig.mainEntity.entitySetName
+        };
+        if (entityRelatedConfig?.navigationEntity?.navigationPropertyName) {
+            _entityConfig.navigationEntity = {
+                EntitySet: entityRelatedConfig.navigationEntity?.entitySetName,
+                Name: entityRelatedConfig.navigationEntity?.navigationPropertyName
+            };
+        }
+    }
+    const templateSettingsMap = {
+        [fiori_elements_writer_1.TemplateType.ListReportObjectPage]: {
+            entityConfig: _entityConfig,
+            tableType: entityRelatedConfig?.tableType,
+            hierarchyQualifier: entityRelatedConfig?.hierarchyQualifier
+        },
+        [fiori_elements_writer_1.TemplateType.AnalyticalListPage]: {
+            entityConfig: _entityConfig,
+            selectionMode: entityRelatedConfig?.tableSelectionMode,
+            tableType: entityRelatedConfig?.tableType,
+            hierarchyQualifier: entityRelatedConfig?.hierarchyQualifier,
+            autoHide: entityRelatedConfig?.tableAutoHide,
+            multiSelect: entityRelatedConfig?.tableMultiSelect,
+            qualifier: !entityRelatedConfig?.presentationQualifier
+                ? undefined
+                : entityRelatedConfig?.presentationQualifier,
+            smartVariantManagement: entityRelatedConfig?.smartVariantManagement
+        },
+        [fiori_elements_writer_1.TemplateType.FormEntryObjectPage]: {
+            entityConfig: _entityConfig
+        },
+        [fiori_elements_writer_1.TemplateType.OverviewPage]: {
+            filterEntityType: entityRelatedConfig?.filterEntityType?.entitySetName
+        },
+        [fiori_elements_writer_1.TemplateType.Worklist]: {
+            entityConfig: _entityConfig,
+            tableType: entityRelatedConfig?.tableType,
+            hierarchyQualifier: entityRelatedConfig?.hierarchyQualifier
+        },
+        [fiori_elements_writer_1.TemplateType.FlexibleProgrammingModel]: {
+            entityConfig: _entityConfig,
+            pageName: types_1.FPM_DEFAULT_PAGE_NAME
+        }
+    };
+    const fewTemplate = {
+        type: templateType,
+        settings: templateSettingsMap[templateType]
+    };
+    return fewTemplate;
+}
+/**
+ * Check if the template supports open test generation from the generators perspective.
+ *
+ * @param templateType
+ * @returns {boolean} - true if the template supports open test generation from the generators perspective
+ */
+function canGenerateTests(templateType) {
+    return ([
+        fiori_elements_writer_1.TemplateType.FormEntryObjectPage,
+        fiori_elements_writer_1.TemplateType.AnalyticalListPage,
+        fiori_elements_writer_1.TemplateType.ListReportObjectPage,
+        fiori_elements_writer_1.TemplateType.Worklist,
+        fiori_elements_writer_1.TemplateType.FlexibleProgrammingModel
+    ].includes(templateType) || templateType === fiori_freestyle_writer_1.TemplateType.Basic);
+}
+/**
+ * Get the ui5 uri used in yaml and index files.
+ *
+ * @returns {string} - The UI5 URI
+ */
+function getUI5Uri() {
+    // Remove any trailing '/' 2083 is the max length of a URL for some supported browsers
+    const envSetUI5CdnUrl = process.env.UI5_CDN_URL?.replace(/\/{1,2083}$/, '');
+    return envSetUI5CdnUrl ?? types_1.UI5_VERSION_PROPS.OFFICIAL_URL;
+}
+/**
+ * Transform Fiori Tools State to the type required by the open source ux-tools module.
+ * Process inputs to set correct defaults.
+ *
+ * @param param0
+ * @param param0.project
+ * @param param0.service
+ * @param param0.floorplan
+ * @param param0.entityRelatedConfig
+ * @param param0.viewName
+ * @param generateIndexHtml
+ * @returns {FioriElementsApp<T>} - The app configuration
+ */
+async function transformState({ project, service, floorplan, entityRelatedConfig, viewName }, generateIndexHtml = true) {
+    const appConfig = getBaseAppConfig({ project, service, floorplan, entityRelatedConfig, viewName }, generateIndexHtml);
+    if (service.source !== odata_service_inquirer_1.DatasourceType.none) {
+        appConfig.service = {
+            url: service.host ?? (service.edmx ? undefined : types_1.DEFAULT_HOST),
+            path: service.servicePath || types_1.DEFAULT_SERVICE_PATH,
+            type: service.capService ? odata_service_writer_1.ServiceType.CDS : odata_service_writer_1.ServiceType.EDMX,
+            version: service.version ?? fiori_elements_writer_1.OdataVersion.v4, // Wont be set for FF no datasource template flow so default to v4 for now as the service wont be written
+            metadata: service.edmx && !service.capService ? service.edmx : undefined,
+            name: types_1.MAIN_DATASOURCE_NAME,
+            client: service.client,
+            model: appConfig.template?.type === fiori_elements_writer_1.TemplateType.OverviewPage ? types_1.MAIN_MODEL_NAME : '', // OVP requires a named default model
+            previewSettings: {},
+            annotations: project.skipAnnotations !== true
+                ? await (0, utils_1.getAnnotations)(project.name, service.annotations?.[0], service?.capService)
+                : undefined
+        };
+        const destinationName = service.destinationName ?? service.connectedSystem?.destination?.Name;
+        if (destinationName) {
+            appConfig.service.destination = {
+                name: destinationName
+            };
+        }
+        if (service.capService) {
+            const { cdsUi5PluginInfo, ...capServiceInfo } = service.capService;
+            appConfig.service.capService = {
+                ...capServiceInfo,
+                cdsUi5PluginInfo
+            };
+        }
+        if (service.destinationAuthType === btp_utils_1.Authentication.SAML_ASSERTION ||
+            service.connectedSystem?.destination?.Authentication === btp_utils_1.Authentication.SAML_ASSERTION ||
+            store_1.AuthenticationType.ReentranceTicket === service.connectedSystem?.backendSystem?.authenticationType) {
+            appConfig.service.previewSettings = { authenticationType: store_1.AuthenticationType.ReentranceTicket };
+        }
+        else if (service.connectedSystem?.backendSystem?.serviceKeys ||
+            // If 'cloud' write `scp` property to yamls to enable preview on VSCode (using oAuth)
+            ((0, fiori_generator_shared_1.getHostEnvironment)() === fiori_generator_shared_1.hostEnvironment.vscode &&
+                service.connectedSystem?.destination &&
+                (0, btp_utils_1.isAbapEnvironmentOnBtp)(service.connectedSystem?.destination))) {
+            appConfig.service.previewSettings = { scp: true };
+        }
+        else if (service.apiHubConfig) {
+            appConfig.service.previewSettings = { apiHub: true };
+        }
+    }
+    return appConfig;
+}
+/**
+ * Apply the default values for UI5 version if not specified. This should probably be done in the writers directly.
+ *
+ * @param floorplan
+ * @param ui5Version
+ * @param odataVersion
+ * @returns the default ui5 version to be applied when calling the writers
+ */
+function getUI5VersionDefault(floorplan, ui5Version, odataVersion) {
+    if (!ui5Version || ui5Version === ui5_info_1.latestVersionString) {
+        const minUI5Version = (0, utils_1.getMinSupportedUI5Version)(odataVersion ?? fiori_elements_writer_1.OdataVersion.v4, floorplan);
+        // If the UI5 version is not specified, we should use the minimum supported version for the given OData version as the manifest `minUI5Version`
+        // `ui5Version` should not be specified as this allows the writers to use the correct version and generate ui5 bootstrap code without specifying the version
+        return {
+            minUI5Version
+        };
+    }
+    return {
+        minUI5Version: ui5Version,
+        ui5Version
+    };
+}
+/**
+ * Get the base app configuration for the Fiori Elements or Freestyle app.
+ * Which type of app is generated is determined by the template type derived from the floorplan specified.
+ * This does not assign the service configuration.
+ *
+ * @param state
+ * @param state.project
+ * @param state.service
+ * @param state.floorplan
+ * @param state.entityRelatedConfig
+ * @param state.viewName
+ * @param generateIndexHtml
+ * @returns
+ */
+function getBaseAppConfig({ project, service, floorplan, entityRelatedConfig, viewName }, generateIndexHtml) {
+    const appId = (0, utils_1.getAppId)(project.name, project.namespace);
+    const backendType = service.capService
+        ? (0, utils_1.convertCapRuntimeToCapProjectType)(service.capService.capType)
+        : 'EDMXBackend';
+    // FE or FF template settings
+    const template = transformTemplateType(floorplan, entityRelatedConfig, viewName);
+    const { minUI5Version, ui5Version } = getUI5VersionDefault(floorplan, project.ui5Version, service.version);
+    const appConfig = {
+        app: {
+            id: appId,
+            title: project.title,
+            description: project.description,
+            flpAppId: (0, utils_1.getFlpId)(appId, floorplan === types_1.FloorplanFF.FF_SIMPLE ? types_1.defaultNavActionDisplay : types_1.defaultNavActionTile),
+            sourceTemplate: {
+                toolsId: (0, utils_1.generateToolsId)()
+            },
+            projectType: backendType
+        },
+        package: {
+            name: project.name,
+            description: project.description,
+            version: '0.0.1',
+            sapuxLayer: (0, utils_1.assignSapUxLayerValue)(false)
+        },
+        ui5: {
+            version: ui5Version,
+            // descriptorVersion: project.manifestVersion, // The generator never sets this so no need to pass it
+            ui5Theme: project.ui5Theme,
+            localVersion: project.localUI5Version,
+            minUI5Version: minUI5Version,
+            frameworkUrl: service.capService ? types_1.UI5_VERSION_PROPS.BCP_OFFICIAL_URL : getUI5Uri(),
+            // These 2 properties should be removed when: https://github.com/SAP/open-ux-tools/issues/2304 is implemented
+            manifestLibs: floorplan === types_1.FloorplanFF.FF_SIMPLE ? ['sap.m', 'sap.ui.core'] : undefined,
+            ui5Libs: []
+        },
+        appOptions: {
+            codeAssist: project.enableCodeAssist,
+            eslint: project.enableEslint,
+            typescript: project.enableTypeScript,
+            sapux: project.sapux,
+            loadReuseLibs: !service.capService,
+            // Striclty speaking we should not need to guard here. If a template is not supported for OPA test generation then nothing should be generated.
+            addTests: canGenerateTests(template.type),
+            generateIndex: generateIndexHtml,
+            addAnnotations: entityRelatedConfig?.addFEOPAnnotations || entityRelatedConfig?.addLineItemAnnotations
+        },
+        template: template
+    };
+    return appConfig;
+}
+//# sourceMappingURL=transforms.js.map

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

@@ -0,0 +1,27 @@
+import type { ReadMe } from '@sap-ux/fiori-generator-shared';
+import type { Editor } from 'mem-fs-editor';
+import type { ApiHubConfig, State } from '../types';
+/**
+ * Writes a README.md file based on project, service, and additional readme properties.
+ *
+ * @param state
+ * @param state.project
+ * @param state.service
+ * @param state.floorplan
+ * @param state.entityRelatedConfig
+ * @param generatorName
+ * @param generatorVersion
+ * @param targetPath
+ * @param fs
+ * @param readMe
+ */
+export declare function writeReadMe({ project, service, floorplan, entityRelatedConfig }: State, generatorName: string, generatorVersion: string, targetPath: string, fs: Editor, readMe?: Partial<ReadMe>): Promise<void>;
+/**
+ * Create the files for apiHub integration.
+ *
+ * @param fs
+ * @param destPath
+ * @param apiHubConfig
+ */
+export declare function writeAPIHubKeyFiles(fs: Editor, destPath: string, apiHubConfig: ApiHubConfig): void;
+//# sourceMappingURL=writing.d.ts.map

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

@@ -0,0 +1,94 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.writeReadMe = writeReadMe;
+exports.writeAPIHubKeyFiles = writeAPIHubKeyFiles;
+const fiori_generator_shared_1 = require("@sap-ux/fiori-generator-shared");
+const path_1 = require("path");
+const types_1 = require("../types");
+const utils_1 = require("../utils");
+/**
+ * Writes a README.md file based on project, service, and additional readme properties.
+ *
+ * @param state
+ * @param state.project
+ * @param state.service
+ * @param state.floorplan
+ * @param state.entityRelatedConfig
+ * @param generatorName
+ * @param generatorVersion
+ * @param targetPath
+ * @param fs
+ * @param readMe
+ */
+async function writeReadMe({ project, service, floorplan, entityRelatedConfig }, generatorName, generatorVersion, targetPath, fs, readMe) {
+    const templateLabel = (0, utils_1.t)(`floorplans.label.${floorplan}`, {
+        odataVersion: service.version
+    });
+    const datasourceLabel = (0, utils_1.getReadMeDataSourceLabel)(service.source, (0, utils_1.isBTPHosted)(service.connectedSystem), service.apiHubConfig?.apiHubType);
+    // Assign any custom overriding properties that may be provided via headless, adaptors
+    const readMeCustom = Object.assign({
+        generatorName,
+        generatorVersion,
+        template: templateLabel,
+        serviceType: datasourceLabel,
+        serviceUrl: `${service.capService ? types_1.DEFAULT_CAP_HOST : service.host ?? ''}${service.servicePath ?? ''}` ||
+            (0, utils_1.t)('texts.notApplicable')
+    }, readMe);
+    readMeCustom.additionalEntries ??= [];
+    if (entityRelatedConfig?.mainEntity) {
+        readMeCustom.additionalEntries.push({
+            label: (0, utils_1.t)('readme.label.mainEntity'),
+            value: entityRelatedConfig.mainEntity.entitySetName
+        });
+    }
+    if (entityRelatedConfig?.navigationEntity) {
+        readMeCustom.additionalEntries.push({
+            label: (0, utils_1.t)('readme.label.navigationEntity'),
+            value: entityRelatedConfig.navigationEntity.navigationPropertyName || 'None'
+        });
+    }
+    if (entityRelatedConfig?.filterEntityType) {
+        readMeCustom.additionalEntries.push({
+            label: (0, utils_1.t)('readme.label.filterEntityType'),
+            value: entityRelatedConfig.filterEntityType.entitySetName
+        });
+    }
+    const launchText = await (0, utils_1.getLaunchText)(service.capService, project.name, !!project.enableTypeScript, project.namespace);
+    const readme = {
+        generationDate: readMeCustom?.generationDate ?? new Date().toString(),
+        generatorPlatform: readMeCustom?.generatorPlatform ?? (0, fiori_generator_shared_1.getHostEnvironment)().name,
+        serviceType: readMeCustom?.serviceType,
+        metadataFilename: service.localEdmxFilePath ? (0, path_1.basename)(service.localEdmxFilePath) : '',
+        serviceUrl: readMeCustom?.serviceUrl,
+        appName: project.name,
+        appTitle: project.title,
+        appDescription: project.description,
+        appNamespace: project.namespace ?? '',
+        ui5Theme: project.ui5Theme,
+        ui5Version: readMeCustom?.ui5Version || project.manifestMinUI5Version || project.ui5Version,
+        enableCodeAssist: project.enableCodeAssist,
+        enableEslint: project.enableEslint,
+        enableTypeScript: project.enableTypeScript,
+        showMockDataInfo: !!service.edmx && !service.capService,
+        generatorVersion: readMeCustom?.generatorVersion ?? '',
+        template: readMeCustom?.template ?? '',
+        generatorName: readMeCustom?.generatorName ?? '',
+        additionalEntries: readMeCustom?.additionalEntries ?? [],
+        launchText
+    };
+    (0, fiori_generator_shared_1.generateReadMe)(targetPath, readme, fs);
+}
+/**
+ * Create the files for apiHub integration.
+ *
+ * @param fs
+ * @param destPath
+ * @param apiHubConfig
+ */
+function writeAPIHubKeyFiles(fs, destPath, apiHubConfig) {
+    const envFilePath = (0, path_1.join)(destPath, '.env');
+    const envContent = `API_HUB_API_KEY=${apiHubConfig.apiHubKey}\nAPI_HUB_TYPE=${apiHubConfig.apiHubType}`;
+    // Create .env to store apiHub integration.
+    fs.write(envFilePath, envContent);
+}
+//# sourceMappingURL=writing.js.map

package/generators/index.d.ts

@@ -0,0 +1,6 @@
+export * from './types';
+export * from './app';
+export * from './app-headless';
+export * from './utils';
+export * from './fiori-app-generator';
+//# sourceMappingURL=index.d.ts.map

package/generators/index.js

@@ -0,0 +1,22 @@
+"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("./types"), exports);
+__exportStar(require("./app"), exports);
+__exportStar(require("./app-headless"), exports);
+__exportStar(require("./utils"), exports);
+__exportStar(require("./fiori-app-generator"), exports);
+//# sourceMappingURL=index.js.map

package/generators/translations/fioriAppSubGenerator.i18n.json

@@ -0,0 +1,119 @@
+{
+    "floorplans": {
+        "label": {
+            "basic": "Basic{{odataVersion, odataVersionFormatter}}",
+            "fpm": "Custom Page{{odataVersion, odataVersionFormatter}}",
+            "lrop": "List Report Page{{odataVersion, odataVersionFormatter}}",
+            "worklist": "Worklist Page{{odataVersion, odataVersionFormatter}}",
+            "alp": "Analytical List Page{{odataVersion, odataVersionFormatter}}",
+            "ovp": "Overview Page{{odataVersion, odataVersionFormatter}}",
+            "feop": "Form Entry Object Page{{odataVersion, odataVersionFormatter}}"
+        },
+        "description": {
+            "basic": "Create a freestyle application, starting with an empty page.",
+            "fpm": "Create an SAP Fiori elements application containing a custom page based on the flexible programming model.",
+            "lrop": "Create an SAP Fiori elements application containing a list report and an object page.",
+            "worklist": "Create an SAP Fiori elements application containing a worklist and an object page.",
+            "alp": "Create an SAP Fiori elements application containing an analytical list and an object page.",
+            "ovp": "Create an SAP Fiori elements application containing an overview page.",
+            "feop": "Create an SAP Fiori elements application containing an object page optimized for data entry."
+        }
+    },
+    "defaults": {
+        "projectName": "project{{defaultProjectNumber}}",
+        "projectTitle": "App Title",
+        "projectDescription": "An SAP Fiori application."
+    },
+    "readme": {
+        "label": {
+            "mainEntity": "Main Entity",
+            "filterEntityType": "Filter Entity Type",
+            "navigationEntity": "Navigation Entity",
+            "sapSystemType": {
+                "abapOnBtp": "ABAP Environment on SAP Business Technology Platform",
+                "s4hc": "SAP S/4HANA Cloud Environment",
+                "onPrem": "ABAP On Premise"
+            },
+            "datasourceType": {
+                "sapSystem": "SAP System",
+                "buinessHub": "SAP Business Accelerator Hub",
+                "apiBusinessHubEnterprise": "SAP API Business Hub Enterprise",
+                "capProject": "Local Cap",
+                "odataServiceUrl": "OData Url",
+                "none": "None",
+                "metadataFile": "File",
+                "projectSpecificDestination": "MTA File"
+            }
+        },
+        "texts": {
+            "runInstruction": "In order to launch the generated app, simply run the following from the generated app root folder:\n\n```\n    npm start\n```"
+        }
+    },
+    "texts": {
+        "notApplicable": "N/A"
+    },
+    "steps": {
+        "templateSelection": {
+            "description": "Choose your application template.",
+            "title": "Template Selection"
+        },
+        "datasourceAndServiceSelection": {
+            "description": "Configure the data source and select a service.",
+            "title": "Data Source and Service Selection"
+        },
+        "entityOrViewConfig": {
+            "description": "Configure the selected service.",
+            "title": "Entity Selection"
+        },
+        "projectAttributesConfig": {
+            "description": "Configure the main project attributes.",
+            "title": "Project Attributes"
+        },
+        "deployConfig": {
+            "description": "Configure deployment settings.",
+            "title": "Deployment Configuration"
+        },
+        "flpConfig": {
+            "description": "Configure Fiori Launchpad settings{{appFolderName}}.",
+            "title": "Fiori Launchpad Configuration"
+        }
+    },
+    "logMessages": {
+        "installingDependencies": "Installing dependencies to package path: {{- path}}...",
+        "dependenciesInstalled": "Project dependencies installed in {{installTime}} seconds",
+        "errorInstallingDependencies": "Unknown error while installing project dependencies.",
+        "commandFailedWithError": "{{command}} failed with error code {{errorCode}}.",
+        "commandErrorCodeWithStack": "Error code {{errorCode}} returned from {{command}}. {{stack}}",
+        "applicationGenerationSuccess": "Application generated successfully, available at {{- targetFolder}}",
+        "copyingTemplateFiles": "Copying '{{templateName}}' template files...",
+        "generatingAppWithVersion": "Generating application with {{- generatorName}} {{generatorVersion}}",
+        "warningCachingNotSupported": "Warning: caching is not supported",
+        "attemptingToExecutePostGenerationCommand": "Attempting to execute command after app generation: {{- command}}",
+        "installSkippedOptionSpecified": "Option `--skipInstall` was specified. Installation of dependencies will be skipped.",
+        "generatorExiting": "Application generation exiting due to error: {{error}}"
+    },
+    "error": {
+        "fatalError": "An error has occurred, please restart the generator",
+        "errorWritingApplicationFiles": "An error occurred writing application files",
+        "appConfigVersion": "Application config version must match a supported version: {{versions}}",
+        "appConfigUnparseableEdmx": "Application config property edmx cannot be parsed",
+        "appConfigMissingRequiredProperty": "Application config is missing a required property: {{propertyName}}",
+        "edmxNotFound": "Edmx (metadata) is required to continue with generation. Application generation exiting.",
+        "unsupportedPostGenerationEvent": "Unsupported post generation event: {{event}}",
+        "commandFailed": "Command failed with error",
+        "invalidYUIStepConfig": "Invalid Yeoman UI step config: First step cannot have dependency property"
+    },
+    "wizardMessages": {
+        "filesGenerated": "The files have been generated."
+    },
+    "prompts": {
+        "viewName": {
+            "message": "View name",
+            "validationMessages": {
+                "viewNameRequired": "You must provide a view name in order to continue.",
+                "viewNameTooLong": "View name cannot contain more than 120 characters",
+                "viewNameInvalid": "The view name must start with a letter and may contain letters, digits, dashes, and underscores."
+            }
+        }
+    }
+}

package/generators/types/common.d.ts

@@ -0,0 +1,46 @@
+import type { DatasourceType, OdataServicePromptOptions, OdataVersion, promptNames } from '@sap-ux/odata-service-inquirer';
+import type { UI5ApplicationPromptOptions } from '@sap-ux/ui5-application-inquirer';
+/**
+ * package.json script entries (commands and tasks)
+ */
+export type Script = {
+    name: string;
+    command: string;
+};
+/**
+ * workspace folder
+ */
+export type WorkspaceFolder = {
+    folderName: string;
+    path: string;
+};
+export type FioriAppGeneratorPromptSettings = UI5ApplicationPromptOptions & Pick<OdataServicePromptOptions, promptNames.systemSelection>;
+/**
+ * Custom environment type until yeoman-environment provides one
+ */
+export interface YeomanEnvironment {
+    conflicter: {
+        force: boolean;
+    };
+    adapter: {
+        actualAdapter: unknown;
+    };
+}
+/**
+ * Defines the options required for generating a launch configuration for a project.
+ */
+export interface GenerateLaunchConfigOptions {
+    /** The type of data source used by the project (e.g. metadata file or OData source URL). */
+    datasourceType: DatasourceType;
+    /** SAP client parameter. */
+    sapClientParam?: string;
+    /** The file path to the root directory of the project. */
+    targetFolder: string;
+    /** The name of the project. */
+    projectName: string;
+    /** The application ID for the project. */
+    flpAppId?: string;
+    /** Optional OData service version (e.g. v2 or v4). */
+    odataVersion?: OdataVersion;
+}
+//# sourceMappingURL=common.d.ts.map

package/generators/types/common.js

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

package/generators/types/constants.d.ts

@@ -0,0 +1,60 @@
+import type { FioriStep } from './yeomanUiStepConfig';
+export declare const LEGACY_CAP_TYPE_NODE = "capNode";
+export declare const LEGACY_CAP_TYPE_JAVA = "capJava";
+export declare const enum SapSystemSourceType {
+    SCP = "abapOnBtp",
+    ON_PREM = "onPrem",
+    S4HC = "s4hc"
+}
+export declare const PLATFORMS: {
+    VSCODE: {
+        name: string;
+        technical: string;
+    };
+    SBAS: {
+        name: string;
+        technical: string;
+    };
+    CLI: {
+        name: string;
+        technical: string;
+    };
+};
+export declare const UI5_VERSION_PROPS: {
+    OFFICIAL_URL: string;
+    BCP_OFFICIAL_URL: string;
+    SNAPSHOT_URL: string;
+    VERSIONS_FILE: string;
+};
+export declare const SAP_CLIENT_KEY = "sap-client";
+export declare const API_HUB_API_KEY = "API_HUB_API_KEY";
+export declare const API_HUB_TYPE = "API_HUB_TYPE";
+export declare const enum ApiHubType {
+    apiHub = "API_HUB",
+    apiHubEnterprise = "API_HUB_ENTERPRISE"
+}
+export declare const STEP_FLOORPLAN = "FLOORPLAN";
+export declare const STEP_DATASOURCE_AND_SERVICE = "DATASOURCE_AND_SERVICE";
+export declare const STEP_ENTITY = "ENTITY";
+export declare const STEP_PROJECT_ATTRIBUTES = "PROJECT_ATTRIBUTES";
+export declare const STEP_DEPLOY_CONFIG = "DEPLOY_CONFIG";
+export declare const STEP_FLP_CONFIG = "FLP_CONFIG";
+export declare const FIORI_STEPS: FioriStep[];
+export declare const DEFAULT_HOST = "http://localhost";
+export declare const DEFAULT_CAP_HOST = "http://localhost:4004";
+export declare const DEFAULT_SERVICE_PATH = "/sap/opu/odata";
+export declare const MAIN_DATASOURCE_NAME = "mainService";
+export declare const MAIN_MODEL_NAME = "mainModel";
+export declare const generatorName = "SAP Fiori Application Generator";
+export declare const FPM_DEFAULT_PAGE_NAME = "Main";
+export declare const minSupportedUi5Version = "1.65.0";
+export declare const minSupportedUi5VersionV4 = "1.84.0";
+export declare const defaultNavActionTile = "tile";
+export declare const defaultNavActionDisplay = "display";
+/**
+ * Represents a list of App Generator specific feature toggles.
+ */
+export declare enum Features {
+    enableGAIntegration = "enableGAIntegration"
+}
+//# sourceMappingURL=constants.d.ts.map