feat: Switch Adaptation Project's generator/wizard to use Open Source writers

.changeset/famous-panthers-occur.md

@@ -0,0 +1,6 @@
+---
+'@sap-ux/adp-tooling': minor
+'@sap-ux/preview-middleware': patch
+---
+
+Adds writer functionality for generation of adaptation projects

packages/adp-tooling/package.json

@@ -36,6 +36,7 @@
     ],
     "dependencies": {
         "@sap-ux/axios-extension": "workspace:*",
+        "@sap-ux/btp-utils": "workspace:*",
         "@sap-ux/logger": "workspace:*",
         "@sap-ux/system-access": "workspace:*",
         "@sap-ux/ui5-config": "workspace:*",

packages/adp-tooling/src/base/project-utils.ts

@@ -0,0 +1,206 @@
+import { join } from 'path';
+import type { Editor } from 'mem-fs-editor';
+import { AdpWriterConfig, CfAdpConfig, CfModuleData, ManifestAppdescr, ProjectType } from '../types';
+import {
+    enhanceUI5DeployYaml,
+    enhanceUI5Yaml,
+    hasDeployConfig,
+    enhanceUI5YamlWithCustomConfig,
+    enhanceUI5YamlWithCustomTask
+} from '../writer/options';
+import { UI5Config } from '@sap-ux/ui5-config';
+
+/**
+ * Writes a given project template files within a specified folder in the project directory.
+ *
+ * @param {string} templatePath - The root path of the project template.
+ * @param {string} projectPath - The root path of the project.
+ * @param {CfModuleData | AdpWriterConfig} data - The data to be populated in the template file.
+ * @param {Editor} fs - The `mem-fs-editor` instance used for file operations.
+ * @param {string[]} exclude - Files to be ignored when writing.
+ * @returns {void}
+ */
+export function writeTemplateToFolder(
+    templatePath: string,
+    projectPath: string,
+    data: CfModuleData | AdpWriterConfig,
+    fs: Editor,
+    exclude: string[] | [] = []
+): void {
+    try {
+        fs.copyTpl(templatePath, projectPath, data, undefined, {
+            globOptions: { dot: true, ignore: exclude },
+            processDestinationPath: (filePath: string) => filePath.replace(/gitignore.tmpl/g, '.gitignore')
+        });
+    } catch (e) {
+        throw new Error(`Could not write template files to folder. Reason: ${e.message}`);
+    }
+}
+
+/**
+ * Writes a manifest.adpescr file within a specified folder in the project directory.
+ *
+ * @param {string} templatePath - The root path of the project template.
+ * @param {string} projectPath - The root path of the project.
+ * @param {ManifestAppdescr} data - The data to be populated in the template file.
+ * @param {Editor} fs - The `mem-fs-editor` instance used for file operations.
+ * @returns {void}
+ */
+export function writeManifestAppdecr(
+    templatePath: string,
+    projectPath: string,
+    data: ManifestAppdescr,
+    fs: Editor
+): void {
+    try {
+        const appdescrTplPath = join(templatePath, 'webapp/manifest.appdescr_variant');
+        const appdescrPath = join(projectPath, 'webapp/manifest.appdescr_variant');
+        const baseAppdescrContent: ManifestAppdescr = JSON.parse(fs.read(appdescrTplPath));
+        data.content = [...baseAppdescrContent.content, ...data.content];
+        Object.assign(baseAppdescrContent, data);
+
+        fs.writeJSON(appdescrPath, baseAppdescrContent);
+    } catch (e) {
+        throw new Error(`Could not write manifest.appdescr_variant file. Reason: ${e.message}`);
+    }
+}
+
+/**
+ * Writes a .apd/config.json file within a specified folder in the project directory.
+ *
+ * @param {string} projectPath - The root path of the project.
+ * @param {CfAdpConfig} data - The data to be populated in the template file.
+ * @param {Editor} fs - The `mem-fs-editor` instance used for file operations.
+ * @returns {void}
+ */
+export function writeAdpConfig(projectPath: string, data: CfAdpConfig, fs: Editor): void {
+    try {
+        const adpConfigPath = join(projectPath, '.adp/config.json');
+
+        fs.writeJSON(adpConfigPath, data);
+    } catch (e) {
+        throw new Error(`Could not write .adp/config.json file. Reason: ${e.message}`);
+    }
+}
+
+/**
+ * Writes a xs-security.json file within a specified folder in the project directory.
+ *
+ * @param {string} projectPath - The root path of the project.
+ * @param {CfModuleData} data - The data to be populated in the template file.
+ * @param {Editor} fs - The `mem-fs-editor` instance used for file operations.
+ * @returns {void}
+ */
+export function writeXsSecurity(templatePath: string, data: CfModuleData, fs: Editor): void {
+    try {
+        const projectPath = join(data.projectPath, 'xs-security.json');
+        if (!fs.exists(projectPath)) {
+            writeTemplateToFolder(
+                join(templatePath, 'xs-security.json'),
+                projectPath,
+                {
+                    projectName: data.xsSecurityProjectName
+                } as CfModuleData,
+                fs
+            );
+        }
+    } catch (e) {
+        throw new Error(`Could not write xs-security.json file. Reason: ${e.message}`);
+    }
+}
+
+/**
+ * Writes a given approuter template files within a specified folder in the project directory
+ *
+ * @param {string} templatePath - The root path of the project template.
+ * @param {string} projectPath - The root path of the project.
+ * @param {CfModuleData} data - The data to be populated in the template file.
+ * @param {Editor} fs - The `mem-fs-editor` instance used for file operations.
+ * @returns {void}
+ */
+export function writeApprouterTemplate(
+    templatePath: string,
+    projectPath: string,
+    data: CfModuleData,
+    fs: Editor
+): void {
+    try {
+        if (data.addStandaloneApprouter) {
+            const approuterProjectPath = join(projectPath, 'approuter');
+            const approuterTplPath = join(templatePath, 'approuter/*.*');
+
+            writeTemplateToFolder(approuterTplPath, approuterProjectPath, data, fs);
+        }
+    } catch (e) {
+        throw new Error(`Could not write approuter template files to folder. Reason: ${e.message}`);
+    }
+}
+
+/**
+ * Writes a ui5.yaml file within a specified folder in the project directory.
+ *
+ * @param {string} projectPath - The root path of the project.
+ * @param {AdpWriterConfig} data - The data to be populated in the template file.
+ * @param {Editor} fs - The `mem-fs-editor` instance used for file operations.
+ * @returns {void}
+ */
+export async function writeUI5Yaml(projectPath: string, data: AdpWriterConfig, fs: Editor): Promise<void> {
+    try {
+        const ui5ConfigPath = join(projectPath, 'ui5.yaml');
+        const baseUi5ConfigContent = fs.read(ui5ConfigPath);
+        const ui5Config = await UI5Config.newInstance(baseUi5ConfigContent);
+        enhanceUI5Yaml(ui5Config, data);
+        enhanceUI5YamlWithCustomConfig(ui5Config, data?.customConfig);
+        if (data.customConfig?.adp?.environment === ProjectType.S4) {
+            enhanceUI5YamlWithCustomTask(ui5Config, data);
+        }
+
+        fs.write(ui5ConfigPath, ui5Config.toString());
+    } catch (e) {
+        throw new Error(`Could not write ui5.yaml file. Reason: ${e.message}`);
+    }
+}
+
+/**
+ * Writes a ui5-deploy.yaml file within a specified folder in the project directory.
+ *
+ * @param {string} projectPath - The root path of the project.
+ * @param {AdpWriterConfig} data - The data to be populated in the template file.
+ * @param {Editor} fs - The `mem-fs-editor` instance used for file operations.
+ * @returns {void}
+ */
+export async function writeUI5DeployYaml(projectPath: string, data: AdpWriterConfig, fs: Editor): Promise<void> {
+    try {
+        if (hasDeployConfig(data)) {
+            const ui5ConfigPath = join(projectPath, 'ui5.yaml');
+            const baseUi5ConfigContent = fs.read(ui5ConfigPath);
+            const ui5DeployConfig = await UI5Config.newInstance(baseUi5ConfigContent);
+            enhanceUI5DeployYaml(ui5DeployConfig, data);
+
+            fs.write(join(projectPath, 'ui5-deploy.yaml'), ui5DeployConfig.toString());
+        }
+    } catch (e) {
+        throw new Error(`Could not write ui5-deploy.yaml file. Reason: ${e.message}`);
+    }
+}
+
+/**
+ * Writes a .env file within a specified folder in the project directory.
+ *
+ * @param {string} projectPath - The root path of the project.
+ * @param {AdpWriterConfig} data - The data to be populated in the template file.
+ * @param {Editor} fs - The `mem-fs-editor` instance used for file operations.
+ * @returns {void}
+ */
+export async function writeEnvFile(projectPath: string, data: AdpWriterConfig, fs: Editor): Promise<void> {
+    try {
+        if (data?.flp?.credentials) {
+            const templateModel = `ABAP_USERNAME: ${data.flp.credentials.username}
+			ABAP_PASSWORD: ${data.flp.credentials.password}`;
+
+            fs.write(join(projectPath, '.env'), templateModel);
+        }
+    } catch (e) {
+        throw new Error(`Could not write .env file. Reason: ${e.message}`);
+    }
+}

packages/adp-tooling/src/types.ts

@@ -1,6 +1,6 @@
 import type { UI5FlexLayer } from '@sap-ux/project-access';
 import type { DestinationAbapTarget, UrlAbapTarget } from '@sap-ux/system-access';
-import type { Adp } from '@sap-ux/ui5-config';
+import type { Adp, BspApp } from '@sap-ux/ui5-config';
 import type { Editor } from 'mem-fs-editor';
 
 export interface DescriptorVariant {
@@ -35,21 +35,41 @@ export interface AdpWriterConfig {
     target: AbapTarget;
     ui5?: {
         minVersion?: string;
+        ui5Version?: string;
+        ui5EndpointUrl?: string;
     };
     package?: {
         name?: string;
         description?: string;
     };
+    flp?: {
+        flpTitle?: string;
+        flpSubtitle?: string;
+        inboundId?: string;
+        bspName?: string;
+        languages?: Language[];
+        credentials?: {
+            username: string;
+            password: string;
+        };
+    };
+    customConfig?: AdpCustomConfig;
     /**
      * Optional: configuration for deployment to ABAP
      */
-    deploy?: Adp;
+    deploy?: Adp | BspApp;
     options?: {
         /**
          * Optional: if set to true then the generated project will be recognized by the SAP Fiori tools
          */
         fioriTools?: boolean;
     };
+    appdescr?: ManifestAppdescr;
+}
+
+export interface Language {
+    sap: string;
+    i18n: string;
 }
 
 export interface ManifestAppdescr {
@@ -178,6 +198,14 @@ export type IWriterData<T extends ChangeType> = IWriter<GeneratorData<T>>;
  *
  * @template T - The specific type of data the writer will handle, determined by the associated ChangeType.
  */
+export type IProjectWriterData<T extends ProjectType> = IWriter<ProjectGeneratorData<T>>;
+
+/**
+ * Defines a generic interface for writer classes, specialized by the type of data they handle.
+ *
+ * @template T - The specific type of data the writer will handle, determined by the associated ChangeType.
+ */
+
 export interface IWriter<T> {
     /**
      * Writes the provided data to the project.
@@ -199,6 +227,29 @@ export const enum ChangeType {
     CHANGE_INBOUND = 'appdescr_app_changeInbound'
 }
 
+/**
+ * Enumerates the types of projects that can be made, each representing a specific kind of project structure.
+ */
+export const enum ProjectType {
+    ON_PREM = 'OnPrem',
+    S4 = 'S4',
+    CF = 'CF'
+}
+
+/**
+ * Maps a ChangeType to the corresponding data structure needed for that type of change.
+ * This conditional type ensures type safety by linking each change type with its relevant data model.
+ *
+ * @template T - A subtype of ChangeType indicating the specific type of change.
+ */
+export type ProjectGeneratorData<T extends ProjectType> = T extends ProjectType.ON_PREM
+    ? AdpWriterConfig
+    : T extends ProjectType.S4
+    ? AdpWriterConfig
+    : T extends ProjectType.CF
+    ? CfWriterConfig
+    : never;
+
 /**
  * Maps a ChangeType to the corresponding data structure needed for that type of change.
  * This conditional type ensures type safety by linking each change type with its relevant data model.
@@ -347,3 +398,50 @@ export interface AdpProjectData {
     reference: string;
     id: string;
 }
+
+export interface AdpCustomConfig {
+    adp: {
+        safeMode: boolean;
+        environment: ProjectType;
+    };
+}
+
+export interface CfModuleData {
+    appHostId: string;
+    appName: string;
+    appVersion: string;
+    appId: string;
+    module: string;
+    moduleTitle: string;
+    appVariantId: string;
+    projectName: string;
+    i18nGuid: string;
+    projectPath: string;
+    addSecurity: string;
+    addStandaloneApprouter: boolean;
+    sapCloudService: string;
+    xsSecurityProjectName: string;
+    org: string;
+    space: string;
+    html5RepoRuntime: string;
+}
+
+export interface CfAdpConfig {
+    componentname: string;
+    safeMode: boolean;
+    appvariant: string;
+    layer: string;
+    isOVPApp: boolean;
+    isFioriElement: boolean;
+    environment: string;
+    ui5Version: string;
+    cfSpace: string;
+    cfOrganization: string;
+    cfApiUrl: string;
+}
+
+export interface CfWriterConfig {
+    app: CfModuleData;
+    appdescr: ManifestAppdescr;
+    adpConfig: CfAdpConfig;
+}