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

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,16 @@
+# @sap-ux/repo-app-import-sub-generator
+
+## Features
+
+The SAP App download sub-generator enables users to download a basic LROP App from an ABAP repository. The sub-generator will download the app from the repository and add it to the workspace.
+
+## Installation
+
+The SAP App download sub-generator is installed as part of the [@sap/generator-fiori](https://www.npmjs.com/package/@sap/generator-fiori) generator and cannot be used stand alone.
+
+## Launch the SAP Reuse Library sub-generator
+
+Open the Command Palette in MS Visual Studio Code ( CMD/CTRL + Shift + P ) and execute the Fiori: Download ADT deployed app from an UI5 ABAP repository.
+
+## Keywords
+SAP Fiori Generator

package/generators/app/app-config.d.ts

@@ -0,0 +1,25 @@
+import { type FioriElementsApp, type LROPSettings } from '@sap-ux/fiori-elements-writer';
+import type { Editor } from 'mem-fs-editor';
+import type { AppInfo, QfaJsonConfig } from '../app/types';
+import type { AbapDeployConfig } from '@sap-ux/ui5-config';
+/**
+ * Generates the deployment configuration for an ABAP application.
+ *
+ * @param {AppInfo} app - Application info containing `url` and `repoName`.
+ * @param {QfaJsonConfig} qfaJson - The QFA JSON configuration containing app details.
+ * @returns {AbapDeployConfig} The deployment configuration containing `target` and `app` info.
+ */
+export declare const getAbapDeployConfig: (app: AppInfo, qfaJson: QfaJsonConfig) => AbapDeployConfig;
+/**
+ * Gets the application configuration based on the provided user answers and manifest data.
+ * This configuration will be used to initialize a new Fiori application.
+ *
+ * @param {AppInfo} app - Selected app information.
+ * @param {string} extractedProjectPath - Path where the app files are extracted.
+ * @param {QfaJsonConfig} qfaJson - The QFA JSON configuration containing app details.
+ * @param {Editor} fs - The file system editor to manipulate project files.
+ * @returns {Promise<FioriElementsApp<LROPSettings>>} - A promise resolving to the generated app configuration.
+ * @throws {Error} - Throws an error if there are issues generating the configuration.
+ */
+export declare function getAppConfig(app: AppInfo, extractedProjectPath: string, qfaJson: QfaJsonConfig, fs: Editor): Promise<FioriElementsApp<LROPSettings>>;
+//# sourceMappingURL=app-config.d.ts.map

package/generators/app/app-config.js

@@ -0,0 +1,122 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAppConfig = exports.getAbapDeployConfig = void 0;
+const fiori_elements_writer_1 = require("@sap-ux/fiori-elements-writer");
+const odata_service_inquirer_1 = require("@sap-ux/odata-service-inquirer");
+const i18n_1 = require("../utils/i18n");
+const file_helpers_1 = require("../utils/file-helpers");
+const constants_1 = require("../utils/constants");
+const prompt_state_1 = require("../prompts/prompt-state");
+const logger_1 = __importDefault(require("../utils/logger"));
+const project_access_1 = require("@sap-ux/project-access");
+const path_1 = require("path");
+/**
+ * Generates the deployment configuration for an ABAP application.
+ *
+ * @param {AppInfo} app - Application info containing `url` and `repoName`.
+ * @param {QfaJsonConfig} qfaJson - The QFA JSON configuration containing app details.
+ * @returns {AbapDeployConfig} The deployment configuration containing `target` and `app` info.
+ */
+const getAbapDeployConfig = (app, qfaJson) => {
+    return {
+        target: {
+            url: prompt_state_1.PromptState.baseURL,
+            client: prompt_state_1.PromptState.sapClient,
+            destination: app.repoName
+        },
+        app: {
+            name: qfaJson.deploymentDetails.repositoryName,
+            package: qfaJson.metadata.package,
+            description: qfaJson.deploymentDetails.repositoryDescription,
+            transport: 'REPLACE_WITH_TRANSPORT'
+        }
+    };
+};
+exports.getAbapDeployConfig = getAbapDeployConfig;
+/**
+ * Fetches the metadata of a given service from the provided ABAP service provider.
+ *
+ * @param {AbapServiceProvider} provider - The ABAP service provider instance.
+ * @param {string} serviceUrl - The URL of the service to retrieve metadata for.
+ * @returns {Promise<any>} - A promise resolving to the service metadata.
+ */
+const fetchServiceMetadata = async (provider, serviceUrl) => {
+    try {
+        return await provider.service(serviceUrl).metadata();
+    }
+    catch (err) {
+        logger_1.default.logger?.error((0, i18n_1.t)('error.metadataFetchError', { error: err.message }));
+    }
+};
+/**
+ * Gets the application configuration based on the provided user answers and manifest data.
+ * This configuration will be used to initialize a new Fiori application.
+ *
+ * @param {AppInfo} app - Selected app information.
+ * @param {string} extractedProjectPath - Path where the app files are extracted.
+ * @param {QfaJsonConfig} qfaJson - The QFA JSON configuration containing app details.
+ * @param {Editor} fs - The file system editor to manipulate project files.
+ * @returns {Promise<FioriElementsApp<LROPSettings>>} - A promise resolving to the generated app configuration.
+ * @throws {Error} - Throws an error if there are issues generating the configuration.
+ */
+async function getAppConfig(app, extractedProjectPath, qfaJson, fs) {
+    try {
+        const manifest = (0, file_helpers_1.readManifest)((0, path_1.join)(extractedProjectPath, project_access_1.FileName.Manifest), fs);
+        const serviceProvider = prompt_state_1.PromptState.systemSelection?.connectedSystem?.serviceProvider;
+        if (!manifest?.['sap.app']?.dataSources) {
+            logger_1.default.logger?.error((0, i18n_1.t)('error.dataSourcesNotFound'));
+        }
+        const odataVersion = manifest?.['sap.app']?.dataSources?.mainService?.settings?.odataVersion === '4.0'
+            ? odata_service_inquirer_1.OdataVersion.v4
+            : odata_service_inquirer_1.OdataVersion.v2;
+        // Fetch metadata for the service
+        const metadata = await fetchServiceMetadata(serviceProvider, manifest?.['sap.app']?.dataSources?.mainService.uri ?? '');
+        const appConfig = {
+            app: {
+                id: app.appId,
+                title: app.title,
+                description: app.description,
+                sourceTemplate: {
+                    id: constants_1.fioriAppSourcetemplateId
+                },
+                projectType: 'EDMXBackend',
+                flpAppId: `${app.appId.replace(/[-_.#]/g, '')}-tile`
+            },
+            package: {
+                name: app.appId,
+                description: app.description,
+                devDependencies: {},
+                scripts: {},
+                version: manifest?.['sap.app']?.applicationVersion?.version ?? '0.0.1'
+            },
+            template: {
+                type: fiori_elements_writer_1.TemplateType.ListReportObjectPage,
+                settings: {
+                    entityConfig: {
+                        mainEntityName: qfaJson.serviceBindingDetails.mainEntityName
+                    }
+                }
+            },
+            service: {
+                path: manifest?.['sap.app']?.dataSources?.mainService.uri,
+                version: odataVersion,
+                metadata: metadata,
+                url: serviceProvider.defaults.baseURL
+            },
+            appOptions: {
+                addAnnotations: odataVersion === odata_service_inquirer_1.OdataVersion.v4,
+                addTests: true
+            }
+        };
+        return appConfig;
+    }
+    catch (error) {
+        logger_1.default.logger?.error((0, i18n_1.t)('error.appConfigGenError', { error: error.message }));
+        throw error;
+    }
+}
+exports.getAppConfig = getAppConfig;
+//# sourceMappingURL=app-config.js.map

package/generators/app/index.d.ts

@@ -0,0 +1,72 @@
+import Generator from 'yeoman-generator';
+import type { RepoAppDownloadOptions } from './types';
+import { PromptNames } from './types';
+/**
+ * Generator class for downloading a basic app from a repository.
+ * This class handles the process of app selection, downloading the app and generating a fiori app from the downloaded app
+ */
+export default class extends Generator {
+    private readonly appWizard;
+    private readonly vscode?;
+    private readonly appRootPath;
+    private readonly prompts;
+    private readonly answers;
+    options: RepoAppDownloadOptions;
+    private projectPath;
+    private extractedProjectPath;
+    setPromptsCallback: (fn: object) => void;
+    /**
+     * Constructor for Downloading App.
+     *
+     * @param args - arguments passed to the generator
+     * @param opts - options passed to the generator
+     */
+    constructor(args: string | string[], opts: RepoAppDownloadOptions);
+    /**
+     * Initialises necessary settings and telemetry for the generator.
+     */
+    initializing(): Promise<void>;
+    /**
+     * Prompts the user for application details and downloads the app.
+     */
+    prompting(): Promise<void>;
+    /**
+     * Writes the configuration files for the project, including deployment config, and README.
+     */
+    writing(): Promise<void>;
+    /**
+     * Returns the configuration for the README file.
+     *
+     * @param config - The app configuration object.
+     * @returns {ReadMe} The configuration for generating the README.
+     */
+    private _getReadMeConfig;
+    /**
+     * Returns the configuration for launching the app with Fiori options.
+     *
+     * @param config - The app configuration object.
+     * @returns {FioriOptions} The launch configuration options.
+     */
+    private _getLaunchConfig;
+    /**
+     * Installs npm dependencies for the project.
+     */
+    install(): Promise<void>;
+    /**
+     * Runs npm install in the specified path.
+     *
+     * @param path - The path to run npm install.
+     */
+    private _runNpmInstall;
+    /**
+     * Responsible for updating workspace folders and running post-generation commands if defined.
+     */
+    private _handlePostAppGeneration;
+    /**
+     * Finalises the generator process by creating launch configurations and running post-generation hooks.
+     */
+    end(): Promise<void>;
+}
+export { PromptNames };
+export type { RepoAppDownloadOptions };
+//# sourceMappingURL=index.d.ts.map