@sap-ux/repo-app-import-sub-generator 0.2.6 → 0.2.8

package/generators/app/index.js

@@ -94,7 +94,7 @@ class default_1 extends yeoman_generator_1.default {
      */
     async prompting() {
         const quickDeployedAppConfig = this.options?.data?.quickDeployedAppConfig;
-        const questions = await (0, prompts_1.getPrompts)(this.appRootPath, quickDeployedAppConfig);
+        const questions = await (0, prompts_1.getPrompts)(this.appRootPath, quickDeployedAppConfig, this.appWizard);
         const answers = await this.prompt(questions);
         const { targetFolder } = answers;
         if (quickDeployedAppConfig?.appId) {
@@ -117,40 +117,33 @@ class default_1 extends yeoman_generator_1.default {
      * Writes the configuration files for the project, including deployment config, and README.
      */
     async writing() {
-        // Extract downloaded app
-        const archive = prompt_state_1.PromptState.downloadedAppPackage;
-        await (0, download_utils_1.extractZip)(this.extractedProjectPath, archive, this.fs);
+        await (0, download_utils_1.extractZip)(this.extractedProjectPath, this.fs);
         // Check if the qfa.json file
         const qfaJsonFilePath = (0, path_1.join)(this.extractedProjectPath, constants_1.qfaJsonFileName);
-        if (this.fs.exists(qfaJsonFilePath)) {
-            const qfaJson = (0, file_helpers_1.makeValidJson)(qfaJsonFilePath, this.fs);
-            // Generate project files
-            (0, validators_1.validateQfaJsonFile)(qfaJson);
-            // Generate app config
-            const config = await (0, app_config_1.getAppConfig)(this.answers.selectedApp, this.extractedProjectPath, qfaJson, this.fs);
-            await (0, fiori_elements_writer_1.generate)(this.projectPath, config, this.fs);
-            // Generate deploy config
-            const deployConfig = (0, app_config_1.getAbapDeployConfig)(this.answers.selectedApp, qfaJson);
-            await (0, abap_deploy_config_writer_1.generate)(this.projectPath, deployConfig, undefined, this.fs);
-            if (this.vscode) {
-                // Generate Fiori launch config
-                const fioriOptions = this._getLaunchConfig(config);
-                // Create launch configuration
-                await (0, launch_config_1.createLaunchConfig)(this.projectPath, fioriOptions, this.fs, logger_1.default.logger);
-                (0, fiori_tools_settings_1.writeApplicationInfoSettings)(this.projectPath);
-            }
-            // Generate README
-            const readMeConfig = this._getReadMeConfig(config);
-            (0, fiori_generator_shared_1.generateReadMe)(this.projectPath, readMeConfig, this.fs);
-            // Replace webapp files with downloaded app files
-            await (0, updates_1.replaceWebappFiles)(this.projectPath, this.extractedProjectPath, this.fs);
-            await (0, updates_1.validateAndUpdateManifestUI5Version)((0, path_1.join)(this.projectPath, project_access_1.DirName.Webapp, project_access_1.FileName.Manifest), this.fs);
-            // Clean up extracted project files
-            this.fs.delete(this.extractedProjectPath);
-        }
-        else {
-            logger_1.default.logger?.error((0, i18n_1.t)('error.qfaJsonNotFound', { jsonFileName: constants_1.qfaJsonFileName }));
+        const qfaJson = (0, file_helpers_1.makeValidJson)(qfaJsonFilePath, this.fs);
+        // Generate project files
+        (0, validators_1.validateQfaJsonFile)(qfaJson);
+        // Generate app config
+        const config = await (0, app_config_1.getAppConfig)(this.answers.selectedApp, this.extractedProjectPath, qfaJson, this.fs);
+        await (0, fiori_elements_writer_1.generate)(this.projectPath, config, this.fs);
+        // Generate deploy config
+        const deployConfig = (0, app_config_1.getAbapDeployConfig)(this.answers.selectedApp, qfaJson);
+        await (0, abap_deploy_config_writer_1.generate)(this.projectPath, deployConfig, undefined, this.fs);
+        if (this.vscode) {
+            // Generate Fiori launch config
+            const fioriOptions = this._getLaunchConfig(config);
+            // Create launch configuration
+            await (0, launch_config_1.createLaunchConfig)(this.projectPath, fioriOptions, this.fs, logger_1.default.logger);
+            (0, fiori_tools_settings_1.writeApplicationInfoSettings)(this.projectPath);
         }
+        // Generate README
+        const readMeConfig = this._getReadMeConfig(config);
+        (0, fiori_generator_shared_1.generateReadMe)(this.projectPath, readMeConfig, this.fs);
+        // Replace webapp files with downloaded app files
+        await (0, updates_1.replaceWebappFiles)(this.projectPath, this.extractedProjectPath, this.fs);
+        await (0, updates_1.validateAndUpdateManifestUI5Version)((0, path_1.join)(this.projectPath, project_access_1.DirName.Webapp, project_access_1.FileName.Manifest), this.fs);
+        // Clean up extracted project files
+        this.fs.delete(this.extractedProjectPath);
     }
     /**
      * Returns the configuration for the README file.
@@ -281,13 +274,13 @@ class default_1 extends yeoman_generator_1.default {
     async end() {
         try {
             this.appWizard.showInformation((0, i18n_1.t)('info.repoAppDownloadCompleteMsg'), yeoman_ui_types_1.MessageType.notification);
+            await this._handlePostAppGeneration();
             await (0, fiori_generator_shared_1.sendTelemetry)(telemetryEvents_1.EventName.GENERATION_SUCCESS, fiori_generator_shared_1.TelemetryHelper.createTelemetryData({
                 appType: 'repo-app-import-sub-generator',
                 ...this.options.telemetryData
             }) ?? {}).catch((error) => {
                 logger_1.default.logger?.error((0, i18n_1.t)('error.telemetry', { error: error.message }));
             });
-            await this._handlePostAppGeneration();
         }
         catch (error) {
             logger_1.default.logger?.error((0, i18n_1.t)('error.endPhase', { error: error.message }));

package/generators/prompts/prompt-state.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="node" />
 import type { SystemSelectionAnswers } from '../app/types';
+import AdmZip from 'adm-zip';
 /**
  * Much of the values returned by the app downloader prompting are derived from prompt answers and are not direct answer values.
  * Since inquirer does not provide a way to return values that are not direct answers from prompts, this class will maintain the derived values
@@ -8,7 +9,7 @@ import type { SystemSelectionAnswers } from '../app/types';
  */
 export declare class PromptState {
     private static _systemSelection;
-    private static _downloadedAppPackage?;
+    private static _admZipInstance?;
     /**
      * Returns the current state of the service config.
      *
@@ -24,13 +25,13 @@ export declare class PromptState {
     /**
      * Set the downloaded app package.
      */
-    static set downloadedAppPackage(archive: Buffer);
+    static set admZip(archive: Buffer);
     /**
-     * Returns the downloaded app package.
+     * Returns the AdmZip instance created from the downloaded archive.
      *
-     * @returns {Buffer} downloaded app package
+     * @returns {admZip | undefined} admZip instance
      */
-    static get downloadedAppPackage(): Buffer;
+    static get admZip(): AdmZip | undefined;
     /**
      * Get the baseURL from the connected system's service provider defaults.
      *

package/generators/prompts/prompt-state.js

@@ -1,6 +1,10 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PromptState = void 0;
+const adm_zip_1 = __importDefault(require("adm-zip"));
 /**
  * Much of the values returned by the app downloader prompting are derived from prompt answers and are not direct answer values.
  * Since inquirer does not provide a way to return values that are not direct answers from prompts, this class will maintain the derived values
@@ -9,7 +13,7 @@ exports.PromptState = void 0;
  */
 class PromptState {
     static _systemSelection = {};
-    static _downloadedAppPackage;
+    static _admZipInstance;
     /**
      * Returns the current state of the service config.
      *
@@ -29,16 +33,16 @@ class PromptState {
     /**
      * Set the downloaded app package.
      */
-    static set downloadedAppPackage(archive) {
-        this._downloadedAppPackage = archive;
+    static set admZip(archive) {
+        this._admZipInstance = new adm_zip_1.default(archive);
     }
     /**
-     * Returns the downloaded app package.
+     * Returns the AdmZip instance created from the downloaded archive.
      *
-     * @returns {Buffer} downloaded app package
+     * @returns {admZip | undefined} admZip instance
      */
-    static get downloadedAppPackage() {
-        return this._downloadedAppPackage ?? Buffer.alloc(0);
+    static get admZip() {
+        return this._admZipInstance;
     }
     /**
      * Get the baseURL from the connected system's service provider defaults.
@@ -58,7 +62,7 @@ class PromptState {
     }
     static reset() {
         PromptState.systemSelection = {};
-        PromptState._downloadedAppPackage = undefined;
+        PromptState._admZipInstance = undefined;
     }
 }
 exports.PromptState = PromptState;

package/generators/prompts/prompts.d.ts

@@ -1,10 +1,12 @@
 import type { RepoAppDownloadQuestions, QuickDeployedAppConfig } from '../app/types';
+import type { AppWizard } from '@sap-devx/yeoman-ui-types';
 /**
  * Retrieves prompts for selecting a system, app list, and target folder where the app will be generated.
  *
  * @param {string} [appRootPath] - The root path of the application.
  * @param {QuickDeployedAppConfig} [quickDeployedAppConfig] - The quick deployed app configuration.
+ * @param {AppWizard} [appWizard] - The app wizard instance.
  * @returns {Promise<RepoAppDownloadQuestions[]>} A list of prompts for user interaction.
  */
-export declare function getPrompts(appRootPath?: string, quickDeployedAppConfig?: QuickDeployedAppConfig): Promise<RepoAppDownloadQuestions[]>;
+export declare function getPrompts(appRootPath?: string, quickDeployedAppConfig?: QuickDeployedAppConfig, appWizard?: AppWizard): Promise<RepoAppDownloadQuestions[]>;
 //# sourceMappingURL=prompts.d.ts.map

package/generators/prompts/prompts.js

@@ -48,9 +48,10 @@ const getTargetFolderPrompt = (appRootPath, appId) => {
  *
  * @param {string} [appRootPath] - The root path of the application.
  * @param {QuickDeployedAppConfig} [quickDeployedAppConfig] - The quick deployed app configuration.
+ * @param {AppWizard} [appWizard] - The app wizard instance.
  * @returns {Promise<RepoAppDownloadQuestions[]>} A list of prompts for user interaction.
  */
-async function getPrompts(appRootPath, quickDeployedAppConfig) {
+async function getPrompts(appRootPath, quickDeployedAppConfig, appWizard) {
     try {
         prompt_state_1.PromptState.reset();
         const systemQuestions = await (0, odata_service_inquirer_1.getSystemSelectionQuestions)({
@@ -76,7 +77,7 @@ async function getPrompts(appRootPath, quickDeployedAppConfig) {
                 },
                 message: (0, i18n_1.t)('prompts.appSelection.message'),
                 choices: () => (appList.length ? (0, prompt_helpers_1.formatAppChoices)(appList) : []),
-                validate: async (answers) => (0, validators_1.validateAppSelection)(answers, appList, quickDeployedAppConfig)
+                validate: async (answers) => (0, validators_1.validateAppSelection)(answers, appList, quickDeployedAppConfig, appWizard)
             }
         ];
         const targetFolderPrompts = getTargetFolderPrompt(appRootPath, quickDeployedAppConfig?.appId);

package/generators/translations/repo-app-import-sub-generator.i18n.json

@@ -1,7 +1,7 @@
 {
     "error": {
         "telemetry": "Failed to send telemetry data after downloading the application from the SAPUI5 ABAP Repository. {{- error}}",
-        "qfaJsonNotFound": "{{- jsonFileName }} not found in the downloaded application. Check the file exists.",
+        "qfaJsonNotFound": "{{- jsonFileName }} not found in the downloaded application. Ensure the downloaded application is properly deployed to the ABAP repository.",
         "replaceWebappFilesError": "An error occurred when replacing files in the downloaded application: {{- error}}. For more information, view the logs.",
         "requiredFieldsMissing": "Required fields are missing for the {{- app }} application. Check if the application is deployed correctly.",
         "applicationListFetchError": "An error occurred when fetching the application list: {{- error}}. Check if your application is available in the system.",

package/generators/utils/download-utils.d.ts

@@ -1,13 +1,18 @@
-/// <reference types="node" />
 import type { Editor } from 'mem-fs-editor';
+/**
+ * Checks whether the ZIP archive contains an entry named qfa.json
+ * and verifies that a file named qfa.json exists  in the archive.
+ *
+ * @returns {boolean} true qfa.json file exists, otherwise false.
+ */
+export declare function hasQfaJson(): boolean;
 /**
  * Extracts a ZIP archive to a temporary directory.
  *
  * @param {string} extractedProjectPath - The path where the archive should be extracted.
- * @param {Buffer} archive - The ZIP archive buffer.
  * @param {Editor} fs - The file system editor.
  */
-export declare function extractZip(extractedProjectPath: string, archive: Buffer, fs: Editor): Promise<void>;
+export declare function extractZip(extractedProjectPath: string, fs: Editor): Promise<void>;
 /**
  * Downloads application files from the ABAP repository.
  *

package/generators/utils/download-utils.js

@@ -3,23 +3,32 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.downloadApp = exports.extractZip = void 0;
-const adm_zip_1 = __importDefault(require("adm-zip"));
+exports.downloadApp = exports.extractZip = exports.hasQfaJson = void 0;
 const path_1 = require("path");
 const prompt_state_1 = require("../prompts/prompt-state");
 const i18n_1 = require("./i18n");
 const logger_1 = __importDefault(require("../utils/logger"));
+const constants_1 = require("./constants");
+/**
+ * Checks whether the ZIP archive contains an entry named qfa.json
+ * and verifies that a file named qfa.json exists  in the archive.
+ *
+ * @returns {boolean} true qfa.json file exists, otherwise false.
+ */
+function hasQfaJson() {
+    const qfaEntries = prompt_state_1.PromptState.admZip?.getEntries().filter((entry) => entry.entryName === constants_1.qfaJsonFileName);
+    return qfaEntries?.length === 1;
+}
+exports.hasQfaJson = hasQfaJson;
 /**
  * Extracts a ZIP archive to a temporary directory.
  *
  * @param {string} extractedProjectPath - The path where the archive should be extracted.
- * @param {Buffer} archive - The ZIP archive buffer.
  * @param {Editor} fs - The file system editor.
  */
-async function extractZip(extractedProjectPath, archive, fs) {
+async function extractZip(extractedProjectPath, fs) {
     try {
-        const zip = new adm_zip_1.default(archive);
-        zip.getEntries().forEach(function (zipEntry) {
+        prompt_state_1.PromptState.admZip?.getEntries().forEach(function (zipEntry) {
             if (!zipEntry.isDirectory) {
                 // Extract the file content
                 const fileContent = zipEntry.getData().toString('utf8');
@@ -42,7 +51,7 @@ async function downloadApp(repoName) {
     const serviceProvider = prompt_state_1.PromptState.systemSelection?.connectedSystem?.serviceProvider;
     const downloadedAppPackage = await serviceProvider.getUi5AbapRepository().downloadFiles(repoName);
     // store downloaded package in prompt state
-    prompt_state_1.PromptState.downloadedAppPackage = downloadedAppPackage;
+    prompt_state_1.PromptState.admZip = downloadedAppPackage;
 }
 exports.downloadApp = downloadApp;
 //# sourceMappingURL=download-utils.js.map

package/generators/utils/validators.d.ts

@@ -1,6 +1,7 @@
 import type { AppIndex } from '@sap-ux/axios-extension';
 import type { ValidationLink } from '@sap-ux/inquirer-common';
 import type { AppInfo, QuickDeployedAppConfig, QfaJsonConfig } from '../app/types';
+import type { AppWizard } from '@sap-devx/yeoman-ui-types';
 /**
  * Validates the entire app configuration.
  *
@@ -22,7 +23,8 @@ export declare const isValidPromptState: (targetFolder: string, appId?: string)
  * @param answers - The selected app information.
  * @param appList - The list of available apps.
  * @param quickDeployedAppConfig - The quick deployed app configuration.
+ * @param appWizard - The app wizard instance.
  * @returns A promise resolving to a boolean or a validation error message.
  */
-export declare function validateAppSelection(answers: AppInfo, appList: AppIndex, quickDeployedAppConfig?: QuickDeployedAppConfig): Promise<string | boolean | ValidationLink>;
+export declare function validateAppSelection(answers: AppInfo, appList: AppIndex, quickDeployedAppConfig?: QuickDeployedAppConfig, appWizard?: AppWizard): Promise<string | boolean | ValidationLink>;
 //# sourceMappingURL=validators.d.ts.map

package/generators/utils/validators.js

@@ -10,6 +10,8 @@ const prompt_state_1 = require("../prompts/prompt-state");
 const guided_answers_helper_1 = require("@sap-ux/guided-answers-helper");
 const inquirer_common_1 = require("@sap-ux/inquirer-common");
 const download_utils_1 = require("../utils/download-utils");
+const yeoman_ui_types_1 = require("@sap-devx/yeoman-ui-types");
+const constants_1 = require("../utils/constants");
 /**
  * Validates the metadata section of the app configuration.
  *
@@ -108,9 +110,10 @@ async function generateAppNotFoundHelpLink() {
  * @param answers - The selected app information.
  * @param appList - The list of available apps.
  * @param quickDeployedAppConfig - The quick deployed app configuration.
+ * @param appWizard - The app wizard instance.
  * @returns A promise resolving to a boolean or a validation error message.
  */
-async function validateAppSelection(answers, appList, quickDeployedAppConfig) {
+async function validateAppSelection(answers, appList, quickDeployedAppConfig, appWizard) {
     // Quick deploy config exists but no apps found
     if (quickDeployedAppConfig?.appId && appList.length === 0) {
         return await generateAppNotFoundHelpLink();
@@ -123,7 +126,11 @@ async function validateAppSelection(answers, appList, quickDeployedAppConfig) {
     if (answers?.appId) {
         try {
             await (0, download_utils_1.downloadApp)(answers.repoName);
-            return true;
+            const isQfaJsonPresent = (0, download_utils_1.hasQfaJson)();
+            if (!isQfaJsonPresent) {
+                appWizard?.showError((0, i18n_1.t)('error.qfaJsonNotFound', { jsonFileName: constants_1.qfaJsonFileName }), yeoman_ui_types_1.MessageType.notification);
+            }
+            return isQfaJsonPresent;
         }
         catch (error) {
             return (0, i18n_1.t)('error.appDownloadErrors.appDownloadFailure', { error: error.message });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/repo-app-import-sub-generator",
   "description": "Generator to download LROP Fiori applications deployed from an ABAP repository.",
-  "version": "0.2.6",
+  "version": "0.2.8",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -28,7 +28,7 @@
     "@sap-ux/fiori-generator-shared": "0.11.2",
     "@sap-ux/inquirer-common": "0.6.39",
     "@sap-ux/project-access": "1.29.21",
-    "@sap-ux/odata-service-inquirer": "2.3.3",
+    "@sap-ux/odata-service-inquirer": "2.3.4",
     "@sap-ux/fiori-elements-writer": "2.3.2",
     "@sap-ux/logger": "0.6.0",
     "@sap-ux/project-input-validator": "0.5.4",