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

package/generators/types/telemetryEvents.d.ts

@@ -0,0 +1,61 @@
+import type { TelemetryEvent, TelemetryMeasurements, TelemetryProperties } from '@sap-ux/telemetry';
+import type { DatasourceType } from '@sap-ux/odata-service-inquirer';
+export type EventName = 'GENERATION_SUCCESS' | 'GENERATION_INSTALL_FAIL' | 'GENERATION_WRITING_FAIL';
+export type LaunchSource = 'Headless' | 'CapServiceAdaptor' | 'MtaLaunchAdaptor' | 'LCAPServiceAdaptor' | 'ServiceCenterAdaptor';
+export type TelemetrySapSystemType = 'SCP' | 'CF' | 'ABAP';
+export type TelemetryBusinessHubType = 'BusinessAcceleratorHub' | 'BusinessHubEnterprise';
+export interface AppGenEventProperties extends TelemetryProperties {
+    Template: string;
+    DataSource: DatasourceType;
+    UI5Version: string;
+    Theme: string;
+    AppGenVersion: string;
+    /**
+     * Use enum in app-generator/common
+     */
+    AppGenSourceType: DatasourceType;
+    /**
+     * Use enum in app-generator/common
+     */
+    AppGenSapSystemType: TelemetrySapSystemType;
+    EnableEslint: boolean;
+    EnableCodeAssist: boolean;
+    AppGenLaunchSource: LaunchSource;
+    /**
+     * Version of the module which launches the generator
+     */
+    AppGenLaunchSourceVersion: string;
+    installFailure: boolean;
+    ToolsId: string;
+}
+export interface AppGenEventMeasurements extends TelemetryMeasurements {
+    GenerationTime: number;
+}
+/**
+ * Telemetry event generated on successful completion
+ * of Fiori project generation
+ */
+export interface AppGenSuccessEvent extends TelemetryEvent {
+    eventName: 'GENERATION_SUCCESS';
+    properties: AppGenEventProperties;
+    measurements: AppGenEventMeasurements;
+}
+/**
+ * Telemetry event generated on failure of running npm install
+ * during Fiori project generation
+ */
+export interface AppGenInstallFailEvent extends TelemetryEvent {
+    eventName: 'GENERATION_INSTALL_FAIL';
+    properties: AppGenEventProperties;
+    measurements: AppGenEventMeasurements;
+}
+/**
+ * Telemetry event generated on failure of writing
+ * project files to file system during Fiori project generation
+ */
+export interface AppGenWritingFailEvent extends TelemetryEvent {
+    eventName: 'GENERATION_WRITING_FAIL';
+    properties: AppGenEventProperties;
+    measurements: AppGenEventMeasurements;
+}
+//# sourceMappingURL=telemetryEvents.d.ts.map

package/generators/types/telemetryEvents.js

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

package/generators/types/yeomanUiStepConfig.d.ts

@@ -0,0 +1,13 @@
+import type { Prompts as YeomanUiSteps, IPrompt as YeomanUiStep } from '@sap-devx/yeoman-ui-types';
+export interface YeomanUiStepConfig {
+    activeSteps: YeomanUiSteps;
+    dependentMap: {
+        [key: string]: YeomanUiStep[];
+    };
+}
+export interface FioriStep extends YeomanUiStep {
+    key: string;
+    order: number;
+    dependency?: string;
+}
+//# sourceMappingURL=yeomanUiStepConfig.d.ts.map

package/generators/types/yeomanUiStepConfig.js

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

package/generators/utils/appWizardCache.d.ts

@@ -0,0 +1,40 @@
+import { type ILogWrapper } from '@sap-ux/fiori-generator-shared';
+import type { State } from '../types';
+import type { AppWizard } from '@sap-devx/yeoman-ui-types';
+declare const FIORI_CACHE = "$fiori-cache";
+export type AppWizardCache = AppWizard & {
+    [FIORI_CACHE]?: Partial<State>;
+};
+/**
+ * Initialize the cache object in the appWizard object. N.B. this will update the passed reference.
+ *
+ * @param logger
+ * @param appWizard
+ */
+export declare function initAppWizardCache(logger: ILogWrapper, appWizard?: AppWizardCache): void;
+/**
+ * Adds the specificed partial state to the app wizard cache. N.B. this will update the passed app wizard reference.
+ *
+ * @param appWizard
+ * @param state
+ * @param logger
+ */
+export declare function addToCache(appWizard: AppWizardCache | undefined, state: Partial<State>, logger: ILogWrapper): void;
+/**
+ * Gets the cached state from the app wizard object based on the specified key where the key is a propert of the State type.
+ *
+ * @param appWizard
+ * @param stateKey
+ * @param logger
+ * @returns
+ */
+export declare function getFromCache<T>(appWizard: AppWizardCache | undefined, stateKey: keyof State, logger: ILogWrapper): T | undefined;
+/**
+ * Deletes the cache object from the app wizard object. N.B. this will update the passed app wizard reference.
+ *
+ * @param appWizard
+ * @param logger
+ */
+export declare function deleteCache(appWizard: AppWizardCache | undefined, logger: ILogWrapper): void;
+export {};
+//# sourceMappingURL=appWizardCache.d.ts.map

package/generators/utils/appWizardCache.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initAppWizardCache = initAppWizardCache;
+exports.addToCache = addToCache;
+exports.getFromCache = getFromCache;
+exports.deleteCache = deleteCache;
+const fiori_generator_shared_1 = require("@sap-ux/fiori-generator-shared");
+const i18n_1 = require("./i18n");
+const FIORI_CACHE = '$fiori-cache';
+const hostEnv = (0, fiori_generator_shared_1.getHostEnvironment)();
+/**
+ * Initialize the cache object in the appWizard object. N.B. this will update the passed reference.
+ *
+ * @param logger
+ * @param appWizard
+ */
+function initAppWizardCache(logger, appWizard) {
+    if (appWizard && !appWizard[FIORI_CACHE]) {
+        appWizard[FIORI_CACHE] = {};
+        logger.debug('AppWizard based cache initialized.');
+    }
+}
+/**
+ * Adds the specificed partial state to the app wizard cache. N.B. this will update the passed app wizard reference.
+ *
+ * @param appWizard
+ * @param state
+ * @param logger
+ */
+function addToCache(appWizard, state, logger) {
+    logIfCacheMissing(appWizard, logger);
+    if (appWizard?.[FIORI_CACHE]) {
+        Object.assign(appWizard[FIORI_CACHE], state);
+    }
+}
+/**
+ * Gets the cached state from the app wizard object based on the specified key where the key is a propert of the State type.
+ *
+ * @param appWizard
+ * @param stateKey
+ * @param logger
+ * @returns
+ */
+function getFromCache(appWizard, stateKey, logger) {
+    logIfCacheMissing(appWizard, logger);
+    return appWizard?.[FIORI_CACHE]?.[stateKey];
+}
+/**
+ * Deletes the cache object from the app wizard object. N.B. this will update the passed app wizard reference.
+ *
+ * @param appWizard
+ * @param logger
+ */
+function deleteCache(appWizard, logger) {
+    logIfCacheMissing(appWizard, logger);
+    if (appWizard?.[FIORI_CACHE]) {
+        delete appWizard[FIORI_CACHE];
+    }
+}
+/**
+ * Logs a warning message if the cache object is missing from the app wizard object.
+ *
+ * @param appWizard
+ * @param logger
+ */
+function logIfCacheMissing(appWizard, logger) {
+    // YUI cache only available in vscode
+    if (hostEnv === fiori_generator_shared_1.hostEnvironment.vscode && !appWizard?.[FIORI_CACHE]) {
+        logger.info((0, i18n_1.t)('logMessages.warningCachingNotSupported'));
+    }
+}
+//# sourceMappingURL=appWizardCache.js.map

package/generators/utils/command-runner.d.ts

@@ -0,0 +1,30 @@
+import type { ILogWrapper } from '@sap-ux/fiori-generator-shared';
+import type { SpawnOptionsWithoutStdio } from 'child_process';
+/**
+ *
+ */
+export declare class CommandRunner {
+    private readonly log;
+    /**
+     *
+     * @param log
+     */
+    constructor(log: ILogWrapper);
+    /**
+     *
+     * @param prefix
+     * @param {...any} args
+     */
+    formatLog(prefix?: string, ...args: string[]): void;
+    /**
+     * Runs a command.
+     *
+     * @param cmd
+     * @param args
+     * @param opts
+     * @param enableLog
+     * @returns
+     */
+    run(cmd: string, args?: string[], opts?: SpawnOptionsWithoutStdio, enableLog?: boolean): Promise<string | void>;
+}
+//# sourceMappingURL=command-runner.d.ts.map

package/generators/utils/command-runner.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommandRunner = void 0;
+const i18n_1 = require("./i18n");
+const child_process_1 = require("child_process");
+/**
+ *
+ */
+class CommandRunner {
+    log;
+    /**
+     *
+     * @param log
+     */
+    constructor(log) {
+        this.log = log;
+    }
+    /**
+     *
+     * @param prefix
+     * @param {...any} args
+     */
+    formatLog(prefix, ...args) {
+        const out = args
+            .map((a) => a.toString().trim())
+            .join(' ')
+            .trim();
+        this.log?.info(prefix ? prefix + out : out);
+    }
+    /**
+     * Runs a command.
+     *
+     * @param cmd
+     * @param args
+     * @param opts
+     * @param enableLog
+     * @returns
+     */
+    run(cmd, args = [], opts = {}, enableLog = false) {
+        return new Promise((resolve, reject) => {
+            const optsLocal = { ...opts };
+            const stack = [];
+            const command = `\`${cmd} ${args.join(' ')}\``;
+            if (process.platform === 'win32') {
+                optsLocal.shell = true;
+            }
+            const spawnedCmd = (0, child_process_1.spawn)(cmd, args, optsLocal);
+            let response;
+            if (enableLog) {
+                this.formatLog('Running: ', command);
+            }
+            spawnedCmd.stdout.on('data', (data) => {
+                if (enableLog) {
+                    this.formatLog(undefined, data);
+                }
+                stack.push(data.toString());
+                response = data.toString();
+            });
+            spawnedCmd.stderr.on('data', (data) => {
+                if (enableLog) {
+                    this.formatLog(undefined, data);
+                }
+                stack.push(data.toString());
+            });
+            spawnedCmd.on('error', (error) => {
+                reject(new Error(`${(0, i18n_1.t)('error.commandFailed')}: ${error.message}`));
+            });
+            spawnedCmd.on('close', (errorCode, signal) => {
+                if (signal) {
+                    const signalCode = -1;
+                    if (enableLog) {
+                        this.formatLog((0, i18n_1.t)('logMessages.commandFailedWithError', { command, signalCode }));
+                    }
+                    return reject(new Error((0, i18n_1.t)('logMessages.commandErrorCodeWithStack', { command, signalCode, stack: stack.join(', ') })));
+                }
+                if (errorCode !== 0) {
+                    if (enableLog) {
+                        this.formatLog((0, i18n_1.t)('logMessages.commandFailedWithError', { command, errorCode }));
+                    }
+                    return reject(new Error((0, i18n_1.t)('logMessages.commandErrorCodeWithStack', { command, errorCode, stack: stack.join(', ') })));
+                }
+                resolve(response);
+            });
+        });
+    }
+}
+exports.CommandRunner = CommandRunner;
+//# sourceMappingURL=command-runner.js.map

package/generators/utils/common.d.ts

@@ -0,0 +1,147 @@
+import type { Annotations } from '@sap-ux/axios-extension';
+import type { CapRuntime, CapService } from '@sap-ux/cap-config-writer';
+import type { Logger } from '@sap-ux/logger';
+import { DatasourceType, OdataVersion } from '@sap-ux/odata-service-inquirer';
+import type { CdsAnnotationsInfo, EdmxAnnotationsInfo } from '@sap-ux/odata-service-writer';
+import type { CapProjectType, CdsUi5PluginInfo, CdsVersionInfo } from '@sap-ux/project-access';
+import type { Editor } from 'mem-fs-editor';
+import type { GenerateLaunchConfigOptions, Service } from '../types';
+import { ApiHubType } from '../types';
+import { type Floorplan } from '../types/external';
+/**
+ * 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
+ */
+export declare function getODataVersion(edmx: string): OdataVersion;
+/**
+ * Get AppId from provided namespace and name.
+ *
+ * @param name
+ * @param namespace
+ * @returns AppId
+ */
+export declare function getAppId(name: string, namespace?: string): string;
+/**
+ * Creates a value suitable for use as a semantic object for navigation intents.
+ * Removes specific characters that would break the navigation.
+ *
+ * @param appId
+ * @returns
+ */
+export declare const getSemanticObject: (appId: string) => string;
+export declare const getFlpId: (appId: string, action?: string | undefined) => string;
+/**
+ * Builds the sap-client parameter for the URL.
+ * If sapClient is not provided, returns an empty string.
+ *
+ * @param sapClient
+ * @returns sap-client parameter
+ */
+export declare function buildSapClientParam(sapClient: string): string;
+/**
+ * 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
+ */
+export declare function getRequiredOdataVersion(floorplan: Floorplan): OdataVersion | 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
+ */
+export declare function getMinSupportedUI5Version(version: OdataVersion, floorplan: Floorplan): string;
+/**
+ * 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
+ */
+export declare function generateToolsId(): string;
+/**
+ * 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.
+ */
+export declare function getCdsUi5PluginInfo(capProjectPath: string, fs: Editor, cdsVersionInfo?: CdsVersionInfo): Promise<CdsUi5PluginInfo | undefined>;
+/**
+ * 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.
+ */
+export declare function getCdsAnnotations(capService: CapService, projectName: string): Promise<CdsAnnotationsInfo | undefined>;
+/**
+ * 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`.
+ */
+export declare function isBTPHosted(connectedSystem?: Service['connectedSystem']): boolean;
+/**
+ * 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.
+ */
+export declare function getReadMeDataSourceLabel(source: DatasourceType, scp?: boolean, apiHubType?: ApiHubType): string;
+/**
+ * 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.
+ */
+export declare function getLaunchText(capService: Service['capService'], name: string, useNpmWorkspaceAppRef: boolean, namespace?: string): Promise<string>;
+/**
+ * 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}
+ */
+export declare function generateLaunchConfig(options: GenerateLaunchConfigOptions, fs: Editor, vscode?: any, log?: Logger, writeToAppOnly?: boolean): Promise<void>;
+/**
+ * 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.
+ */
+export declare function convertCapRuntimeToCapProjectType(capRuntime?: CapRuntime): CapProjectType;
+/**
+ * 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.
+ */
+export declare function getAnnotations(projectName: string, annotations?: Annotations, capService?: CapService): Promise<CdsAnnotationsInfo | EdmxAnnotationsInfo | undefined>;
+//# sourceMappingURL=common.d.ts.map