@sap-ux/repo-app-import-sub-generator 0.0.0

package/generators/utils/updates.d.ts

@@ -0,0 +1,23 @@
+import type { Editor } from 'mem-fs-editor';
+/**
+ * Validates and updates the UI5 version in the manifest.
+ *
+ * - If the minUI5Version in the manifest is not found in the list of released UI5 versions,
+ *   it updates the manifest with the closest released version.
+ * - If internal features are enabled, it sets the minUI5Version to '${sap.ui5.dist.version}'.
+ *
+ * @param {string} manifestFilePath - The manifest file path.
+ * @param {Editor} fs - The file system editor instance.
+ * @returns {Promise<Manifest>} - The updated manifest object.
+ * @throws {Error} - Throws an error if the manifest structure is invalid or no fallback version is available.
+ */
+export declare function validateAndUpdateManifestUI5Version(manifestFilePath: string, fs: Editor): Promise<void>;
+/**
+ * Replaces the specified files in the `webapp` directory with the corresponding files from the `extractedPath`.
+ *
+ * @param {string} projectPath - The path to the downloaded App.
+ * @param {string} extractedPath - The path from which files will be copied.
+ * @param {Editor} fs - The file system editor instance to modify files in memory.
+ */
+export declare function replaceWebappFiles(projectPath: string, extractedPath: string, fs: Editor): Promise<void>;
+//# sourceMappingURL=updates.d.ts.map

package/generators/utils/updates.js

@@ -0,0 +1,90 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.replaceWebappFiles = exports.validateAndUpdateManifestUI5Version = void 0;
+const path_1 = require("path");
+const project_access_1 = require("@sap-ux/project-access");
+const i18n_1 = require("./i18n");
+const logger_1 = __importDefault(require("./logger"));
+const feature_toggle_1 = require("@sap-ux/feature-toggle");
+const ui5_info_1 = require("@sap-ux/ui5-info");
+const file_helpers_1 = require("./file-helpers");
+const constants_1 = require("./constants");
+/**
+ * Validates and updates the UI5 version in the manifest.
+ *
+ * - If the minUI5Version in the manifest is not found in the list of released UI5 versions,
+ *   it updates the manifest with the closest released version.
+ * - If internal features are enabled, it sets the minUI5Version to '${sap.ui5.dist.version}'.
+ *
+ * @param {string} manifestFilePath - The manifest file path.
+ * @param {Editor} fs - The file system editor instance.
+ * @returns {Promise<Manifest>} - The updated manifest object.
+ * @throws {Error} - Throws an error if the manifest structure is invalid or no fallback version is available.
+ */
+async function validateAndUpdateManifestUI5Version(manifestFilePath, fs) {
+    const manifestJson = (0, file_helpers_1.readManifest)(manifestFilePath, fs);
+    if (!manifestJson?.['sap.ui5']?.dependencies || !manifestJson?.['sap.app']?.sourceTemplate) {
+        // Check if the manifest structure is valid) {
+        throw new Error((0, i18n_1.t)('error.readManifestErrors.invalidManifestStructureError'));
+    }
+    const manifestUi5Version = manifestJson['sap.ui5']?.dependencies?.minUI5Version;
+    const availableUI5Versions = await (0, ui5_info_1.getUI5Versions)({ includeMaintained: true });
+    // Check if the manifest version exists in the list of released versions
+    const ui5VersionAvailable = availableUI5Versions.find((ui5Version) => ui5Version.version === manifestUi5Version);
+    if (ui5VersionAvailable) {
+        // Return the manifest as it is if the version is valid
+        // No changes needed
+    }
+    else if ((0, feature_toggle_1.isInternalFeaturesSettingEnabled)()) {
+        // Handle internal features setting
+        manifestJson['sap.ui5'].dependencies.minUI5Version = '${sap.ui5.dist.version}';
+    }
+    else {
+        // Handle fallback to the closest released version
+        const closestAvailableUi5Version = availableUI5Versions[0]?.version;
+        manifestJson['sap.ui5'].dependencies.minUI5Version = closestAvailableUi5Version;
+    }
+    manifestJson['sap.app'].sourceTemplate.id = constants_1.fioriAppSourcetemplateId;
+    // update manifest at extracted path
+    fs.writeJSON(manifestFilePath, manifestJson, undefined, 2);
+}
+exports.validateAndUpdateManifestUI5Version = validateAndUpdateManifestUI5Version;
+/**
+ * Replaces the specified files in the `webapp` directory with the corresponding files from the `extractedPath`.
+ *
+ * @param {string} projectPath - The path to the downloaded App.
+ * @param {string} extractedPath - The path from which files will be copied.
+ * @param {Editor} fs - The file system editor instance to modify files in memory.
+ */
+async function replaceWebappFiles(projectPath, extractedPath, fs) {
+    try {
+        const webappPath = (0, path_1.join)(projectPath, project_access_1.DirName.Webapp);
+        // Define the paths of the files to be replaced
+        const filesToReplace = [
+            { webappFile: project_access_1.FileName.Manifest, extractedFile: project_access_1.FileName.Manifest },
+            { webappFile: (0, path_1.join)('i18n', 'i18n.properties'), extractedFile: (0, path_1.join)('i18n', 'i18n.properties') },
+            { webappFile: 'index.html', extractedFile: 'index.html' },
+            { webappFile: 'Component.js', extractedFile: 'component.js' }
+        ];
+        // Loop through each file and perform the replacement
+        for (const { webappFile, extractedFile } of filesToReplace) {
+            const webappFilePath = (0, path_1.join)(webappPath, webappFile);
+            const extractedFilePath = (0, path_1.join)(extractedPath, extractedFile);
+            // Check if the extracted file exists before replacing
+            if (fs.exists(extractedFilePath)) {
+                fs.copy(extractedFilePath, webappFilePath);
+            }
+            else {
+                logger_1.default.logger?.warn((0, i18n_1.t)('warn.extractedFileNotFound', { extractedFilePath }));
+            }
+        }
+    }
+    catch (error) {
+        logger_1.default.logger?.error((0, i18n_1.t)('error.replaceWebappFilesError', { error }));
+    }
+}
+exports.replaceWebappFiles = replaceWebappFiles;
+//# sourceMappingURL=updates.js.map

package/generators/utils/validators.d.ts

@@ -0,0 +1,17 @@
+import type { QfaJsonConfig } from '../app/types';
+/**
+ * Validates the entire app configuration.
+ *
+ * @param {QfaJsonConfig} config - The QFA JSON configuration containing app details.
+ * @returns {boolean} - Returns true if the configuration is valid, false otherwise.
+ */
+export declare const validateQfaJsonFile: (config: QfaJsonConfig) => boolean;
+/**
+ * Validates the prompt state for the app download process.
+ *
+ * @param {string} targetFolder - The target folder for the app download.
+ * @param {string} [appId] - The selected app id.
+ * @returns {boolean} - Returns true if the prompt state is valid, false otherwise.
+ */
+export declare const isValidPromptState: (targetFolder: string, appId?: string) => boolean;
+//# sourceMappingURL=validators.d.ts.map

package/generators/utils/validators.js

@@ -0,0 +1,94 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isValidPromptState = exports.validateQfaJsonFile = void 0;
+const i18n_1 = require("../utils/i18n");
+const logger_1 = __importDefault(require("../utils/logger"));
+const prompt_state_1 = require("../prompts/prompt-state");
+/**
+ * Validates the metadata section of the app configuration.
+ *
+ * @param {QfaJsonConfig['metadata']} metadata - The metadata object.
+ * @returns {boolean} - Returns true if valid, false otherwise.
+ */
+const validateMetadata = (metadata) => {
+    if (!metadata.package || typeof metadata.package !== 'string') {
+        logger_1.default.logger?.error((0, i18n_1.t)('error.invalidMetadataPackage'));
+        return false;
+    }
+    return true;
+};
+/**
+ * Validates the service binding details section of the app configuration.
+ *
+ * @param {QfaJsonConfig['serviceBindingDetails']} serviceBinding - The service binding details object.
+ * @returns {boolean} - Returns true if valid, false otherwise.
+ */
+const validateServiceBindingDetails = (serviceBinding) => {
+    if (!serviceBinding.serviceName || typeof serviceBinding.serviceName !== 'string') {
+        logger_1.default.logger?.error((0, i18n_1.t)('error.invalidServiceName'));
+        return false;
+    }
+    if (!serviceBinding.serviceVersion || typeof serviceBinding.serviceVersion !== 'string') {
+        logger_1.default.logger?.error((0, i18n_1.t)('error.invalidServiceVersion'));
+        return false;
+    }
+    if (!serviceBinding.mainEntityName || typeof serviceBinding.mainEntityName !== 'string') {
+        logger_1.default.logger?.error((0, i18n_1.t)('error.invalidMainEntityName'));
+        return false;
+    }
+    return true;
+};
+/**
+ * Validates the project attribute section of the app configuration.
+ *
+ * @param {QfaJsonConfig['projectAttribute']} projectAttribute - The project attribute object.
+ * @returns {boolean} - Returns true if valid, false otherwise.
+ */
+const validateProjectAttribute = (projectAttribute) => {
+    if (!projectAttribute.moduleName || typeof projectAttribute.moduleName !== 'string') {
+        logger_1.default.logger?.error((0, i18n_1.t)('error.invalidModuleName'));
+        return false;
+    }
+    return true;
+};
+/**
+ * Validates the deployment details section of the app configuration.
+ *
+ * @param {QfaJsonConfig['deploymentDetails']} deploymentDetails - The deployment details object.
+ * @returns {boolean} - Returns true if valid, false otherwise.
+ */
+const validateDeploymentDetails = (deploymentDetails) => {
+    if (!deploymentDetails.repositoryName) {
+        logger_1.default.logger?.error((0, i18n_1.t)('error.invalidRepositoryName'));
+        return false;
+    }
+    return true;
+};
+/**
+ * Validates the entire app configuration.
+ *
+ * @param {QfaJsonConfig} config - The QFA JSON configuration containing app details.
+ * @returns {boolean} - Returns true if the configuration is valid, false otherwise.
+ */
+const validateQfaJsonFile = (config) => {
+    return (validateMetadata(config.metadata) &&
+        validateServiceBindingDetails(config.serviceBindingDetails) &&
+        validateProjectAttribute(config.projectAttribute) &&
+        validateDeploymentDetails(config.deploymentDetails));
+};
+exports.validateQfaJsonFile = validateQfaJsonFile;
+/**
+ * Validates the prompt state for the app download process.
+ *
+ * @param {string} targetFolder - The target folder for the app download.
+ * @param {string} [appId] - The selected app id.
+ * @returns {boolean} - Returns true if the prompt state is valid, false otherwise.
+ */
+const isValidPromptState = (targetFolder, appId) => {
+    return !!(prompt_state_1.PromptState.systemSelection.connectedSystem?.serviceProvider && appId && targetFolder);
+};
+exports.isValidPromptState = isValidPromptState;
+//# sourceMappingURL=validators.js.map

package/package.json

@@ -0,0 +1,84 @@
+{
+  "name": "@sap-ux/repo-app-import-sub-generator",
+  "description": "Generator to download LROP Fiori applications deployed from an ABAP repository.",
+  "version": "0.0.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/SAP/open-ux-tools.git",
+    "directory": "packages/repo-app-import-sub-generator"
+  },
+  "bugs": {
+    "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue"
+  },
+  "license": "Apache-2.0",
+  "main": "generators/app/index.js",
+  "files": [
+    "LICENSE",
+    "generators",
+    "!generators/*.map",
+    "!generators/**/*.map"
+  ],
+  "dependencies": {
+    "@sap-devx/yeoman-ui-types": "1.14.4",
+    "adm-zip": "0.5.10",
+    "i18next": "23.5.1",
+    "inquirer": "8.2.6",
+    "yeoman-generator": "5.10.0",
+    "@sap-ux/feature-toggle": "0.2.3",
+    "@sap-ux/fiori-generator-shared": "0.10.2",
+    "@sap-ux/inquirer-common": "0.6.35",
+    "@sap-ux/project-access": "1.29.18",
+    "@sap-ux/odata-service-inquirer": "2.2.33",
+    "@sap-ux/fiori-elements-writer": "2.1.38",
+    "@sap-ux/logger": "0.6.0",
+    "@sap-ux/project-input-validator": "0.5.0",
+    "@sap-ux/launch-config": "0.8.1",
+    "@sap-ux/abap-deploy-config-writer": "0.0.103",
+    "@sap-ux/btp-utils": "1.0.3",
+    "@sap-ux/ui5-info": "0.9.1",
+    "@sap-ux/fiori-tools-settings": "0.1.0",
+    "@sap-ux/axios-extension": "1.20.0",
+    "@sap-ux/store": "1.0.0"
+  },
+  "devDependencies": {
+    "@jest/types": "29.6.3",
+    "@types/inquirer": "8.2.6",
+    "@types/mem-fs": "1.1.2",
+    "@types/mem-fs-editor": "7.0.1",
+    "@types/yeoman-generator": "5.2.11",
+    "@types/yeoman-environment": "2.10.11",
+    "inquirer-autocomplete-prompt": "2.0.1",
+    "@types/inquirer-autocomplete-prompt": "2.0.1",
+    "@types/yeoman-test": "4.0.6",
+    "@types/fs-extra": "9.0.13",
+    "fs-extra": "10.0.0",
+    "@vscode-logging/logger": "2.0.0",
+    "@types/adm-zip": "0.5.5",
+    "memfs": "3.4.13",
+    "mem-fs-editor": "9.4.0",
+    "lodash": "4.17.21",
+    "@types/lodash": "4.14.202",
+    "rimraf": "5.0.5",
+    "typescript": "5.3.3",
+    "unionfs": "4.4.0",
+    "yeoman-test": "6.3.0",
+    "yo": "4",
+    "@sap-ux/nodejs-utils": "0.1.9",
+    "@sap-ux/store": "1.0.0",
+    "@sap-ux/ui5-config": "0.26.5"
+  },
+  "engines": {
+    "node": ">=18.x"
+  },
+  "scripts": {
+    "build": "tsc --build",
+    "clean": "rimraf --glob generators test/test-output coverage *.tsbuildinfo",
+    "watch": "tsc --watch",
+    "lint": "eslint . --ext .ts",
+    "lint:fix": "eslint . --ext .ts --fix",
+    "test": "jest --ci --forceExit --detectOpenHandles --colors --passWithNoTests",
+    "test-u": "jest --ci --forceExit --detectOpenHandles --colors -u",
+    "link": "pnpm link --global",
+    "unlink": "pnpm unlink --global"
+  }
+}