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 Project's

packages/adp-tooling/src/index.ts

@@ -2,4 +2,6 @@ export * from './types';
 export * from './preview/adp-preview';
 export { generate } from './writer';
 export { generateChange } from './writer/editors';
+export { generateEnv } from './writer/s4hana';
+export { generateCf } from './writer/cf';
 export { promptGeneratorInput, PromptDefaults } from './base/prompt';

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,23 +35,40 @@ 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[];
+    };
+    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;
+        isRunningInBAS?: boolean;
+        isCloudProject?: boolean;
     };
 }
 
+export interface language {
+    sap: string;
+    i18n: string;
+}
+
 export interface ManifestAppdescr {
     fileName: string;
     layer: string;
@@ -347,3 +364,49 @@ export interface AdpProjectData {
     reference: string;
     id: string;
 }
+
+export interface AdpCustomConfig {
+    adp?: {
+        safeMode: boolean;
+    };
+}
+
+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;
+}

packages/adp-tooling/src/writer/cf.ts

@@ -0,0 +1,51 @@
+import { join } from 'path';
+import { create as createStorage } from 'mem-fs';
+import type { Editor } from 'mem-fs-editor';
+import { create } from 'mem-fs-editor';
+import type { CfWriterConfig, ManifestAppdescr } from '../types';
+
+/**
+ * Writes the adp-project template to the mem-fs-editor instance.
+ *
+ * @param basePath - the base path
+ * @param config - the writer configuration
+ * @param fs - the memfs editor instance
+ * @returns the updated memfs editor instance
+ */
+export async function generateCf(basePath: string, config: CfWriterConfig, fs?: Editor): Promise<Editor> {
+    if (!fs) {
+        fs = create(createStorage());
+    }
+    const tmplPath = join(__dirname, '../../templates/projects/cf');
+
+    fs.copyTpl(join(tmplPath, '**/*.*'), join(basePath), config.app, undefined, {
+        globOptions: { dot: true, ignore: ['**/xs-security.json', '**/approuter/*.*', '**/manifest.appdescr_variant'] },
+        processDestinationPath: (filePath: string) =>
+            filePath
+                .replace(/gitignore.tmpl/g, '.gitignore')
+                .replace(/i18n\/i18n.properties/g, 'webapp/i18n/i18n.properties')
+    });
+
+    // manifest.appdescr_variant
+    const appdescrTplPath = join(tmplPath, 'manifest.appdescr_variant');
+    const appdescrPath = join(basePath, 'webapp/manifest.appdescr_variant');
+    const baseAppdescrContent: ManifestAppdescr = JSON.parse(fs.read(appdescrTplPath));
+    config.appdescr.content = [...baseAppdescrContent.content, ...config.appdescr.content];
+    Object.assign(baseAppdescrContent, config.appdescr);
+    fs.writeJSON(appdescrPath, baseAppdescrContent);
+    // .adp/config.json
+    const adpConfigPath = join(basePath, '.adp/config.json');
+    fs.writeJSON(adpConfigPath, config.adpConfig);
+    // approuter
+    if (config.app.addStandaloneApprouter) {
+        fs.copyTpl(join(tmplPath, 'approuter/*.*'), join(basePath, 'approuter'), config.app);
+    }
+    // xs-security.json
+    if (!fs.exists(join(config.app.projectPath, 'xs-security.json'))) {
+        fs.copyTpl(join(tmplPath, 'xs-security.json'), join(config.app.projectPath, 'xs-security.json'), {
+            projectName: config.app.xsSecurityProjectName
+        });
+    }
+
+    return fs;
+}

packages/adp-tooling/src/writer/index.ts

@@ -18,7 +18,9 @@ function setDefaults(config: AdpWriterConfig): AdpWriterConfig {
         target: { ...config.target },
         ui5: { ...config.ui5 },
         deploy: config.deploy ? { ...config.deploy } : undefined,
-        options: { ...config.options }
+        options: { ...config.options },
+        flp: config.flp ? { ...config.flp } : undefined,
+        customConfig: { ...config.customConfig }
     };
     configWithDefaults.app.title ??= `Adaptation of ${config.app.reference}`;
     configWithDefaults.app.layer ??= 'CUSTOMER_BASE';
@@ -42,11 +44,11 @@ export async function generate(basePath: string, config: AdpWriterConfig, fs?: E
     if (!fs) {
         fs = create(createStorage());
     }
-    const tmplPath = join(__dirname, '../../templates/project');
+    const tmplPath = join(__dirname, '../../templates/projects/abap');
     const fullConfig = setDefaults(config);
 
     fs.copyTpl(join(tmplPath, '**/*.*'), join(basePath), fullConfig, undefined, {
-        globOptions: { dot: true },
+        globOptions: { dot: true, ignore: config.options?.isRunningInBAS ? [] : ['**/pom.xml'] },
         processDestinationPath: (filePath: string) => filePath.replace(/gitignore.tmpl/g, '.gitignore')
     });
 

packages/adp-tooling/src/writer/options.ts

@@ -1,4 +1,4 @@
-import type { CustomMiddleware, UI5Config } from '@sap-ux/ui5-config';
+import type { CustomMiddleware, UI5Config, CustomTask, AbapTarget } from '@sap-ux/ui5-config';
 import type { AdpWriterConfig } from '../types';
 
 /**
@@ -9,7 +9,17 @@ import type { AdpWriterConfig } from '../types';
  */
 export function enhanceUI5Yaml(ui5Config: UI5Config, config: AdpWriterConfig) {
     const middlewares = config.options?.fioriTools ? getFioriToolsMiddlwares(config) : getOpenSourceMiddlewares(config);
+    ui5Config.setConfiguration({ propertiesFileSourceEncoding: 'UTF-8' });
     ui5Config.addCustomMiddleware(middlewares);
+
+    if (config.customConfig?.adp) {
+        ui5Config.addCustomConfiguration('adp', config.customConfig.adp);
+    }
+    if (config.options?.isRunningInBAS && config.options?.isCloudProject && config.ui5?.ui5Version) {
+        ui5Config.addUI5Framework('SAPUI5', config.ui5.ui5Version, []);
+        const tasks = getAdpCloudCustomTasks(config);
+        ui5Config.addCustomTasks(tasks);
+    }
 }
 
 /**
@@ -61,8 +71,9 @@ function getFioriToolsMiddlwares(config: AdpWriterConfig): CustomMiddleware<unkn
             configuration: {
                 ignoreCertErrors: false,
                 ui5: {
+                    version: config?.ui5?.minVersion,
                     path: ['/resources', '/test-resources'],
-                    url: 'https://ui5.sap.com'
+                    url: config?.ui5?.ui5EndpointUrl
                 },
                 backend: [
                     {
@@ -120,3 +131,36 @@ function getOpenSourceMiddlewares(config: AdpWriterConfig): CustomMiddleware<obj
         }
     ];
 }
+
+/**
+ * Get a list of required custom tasks using the Fiori tools.
+ *
+ * @param config full project configuration
+ * @returns list of required tasks.
+ */
+function getAdpCloudCustomTasks(config: AdpWriterConfig & { target: AbapTarget }): CustomTask[] {
+    const user = 'env:ABAP_USERNAME';
+    const pass = 'env:ABAP_PASSWORD';
+
+    return [
+        {
+            name: 'app-variant-bundler-build',
+            beforeTask: 'escapeNonAsciiCharacters',
+            configuration: {
+                type: 'abap',
+                destination: config.target?.destination,
+                appName: config?.flp?.bspName,
+                languages: config?.flp?.languages?.map((language: { sap: string; i18n: string }) => {
+                    return {
+                        sap: language.sap,
+                        i18n: language.i18n
+                    };
+                }),
+                credentials: {
+                    username: user,
+                    password: pass
+                }
+            }
+        }
+    ];
+}

packages/adp-tooling/src/writer/s4hana.ts

@@ -0,0 +1,22 @@
+import { join } from 'path';
+import { create as createStorage } from 'mem-fs';
+import type { Editor } from 'mem-fs-editor';
+import { create } from 'mem-fs-editor';
+
+/**
+ * Writes the s4hana env file to the mem-fs-editor instance.
+ *
+ * @param basePath - the base path
+ * @param data - personal data intended to be exposed as env variables
+ * @param fs - the memfs editor instance
+ * @returns the updated memfs editor instance
+ */
+export async function generateEnv(basePath: string, data: string, fs?: Editor): Promise<Editor> {
+    if (!fs) {
+        fs = create(createStorage());
+    }
+
+    fs.write(join(basePath, '.env'), data);
+
+    return fs;
+}

packages/adp-tooling/templates/projects/abap/package.json

@@ -0,0 +1,58 @@
+{
+    "name": "<%= package.name %>",
+    "version": "0.1.0",<% if (locals.options?.isRunningInBAS && locals.options?.isCloudProject) { %>
+    "main": "index.js",<% } %> 
+    "private": true,
+    "description": "<%= package.description %>",
+    "keywords": [
+        "ui5",
+        "sapui5",
+        "adaptation-project"
+    ],<% if (locals.options?.isRunningInBAS && locals.options?.isCloudProject) { %>
+	"repository": {
+		"type": "git",
+		"build": "ui5.js build --verbose --include-task generateCachebusterInfo"
+	},
+	"author": "",
+	"license": "ISC",
+	"ui5": {
+		"dependencies": ["@sap/ui5-builder-webide-extension", "@ui5/task-adaptation"]
+	},<% } %>
+    "devDependencies": {
+        <%if (locals.options?.fioriTools) {%>"@sap/ux-ui5-tooling": "^1.11.4"<%} else {%>"@sap-ux/backend-proxy-middleware": "^0.7.5",
+        "@sap-ux/preview-middleware": "^0.11.1",
+        "@sap-ux/ui5-proxy-middleware": "^1.3.0",
+        "@sap-ux/deploy-tooling": "^0.11.7"<%}%>,<% if (locals.options?.isRunningInBAS && locals.options?.isCloudProject) { %>
+        "@sap/ui5-builder-webide-extension": "1.0.x",
+        "@sapui5/ts-types": "^1.85.1",
+        "@types/js-yaml": "^4.0.5",
+        "@types/semver": "^7.3.13",
+        "@ui5/task-adaptation": "^1.0.10",
+        "bestzip": "2.1.4",
+        "rimraf": "3.0.2",<% } %>
+        "@ui5/cli": "^3.6.0"
+    },<% if (locals.options?.isRunningInBAS && locals.options?.isCloudProject) { %>
+    "dependencies": {
+        "dotenv": "^16.0.3",
+        "inquirer": "^8.2.5",
+        "json-diff": "^1.0.6",
+        "prompt-sync": "^4.2.0",
+        "prompts": "^2.4.2",
+        "xml-js": "^1.6.11"
+    },<% } %>
+    "scripts": {<% if (locals.options?.isCloudProject) { %>
+        "build": "ui5 build --include-task=generateCachebusterInfo && npm run zip",
+        "prebuild": "npm run clean",
+        "zip": "cd dist && npx bestzip ../<%= package.name %>.zip *",
+        "clean": "npx rimraf <%= package.name %>.zip dist",
+        "build-ui5": "npm explore @ui5/task-adaptation && npm run rollup",
+        "deploy": "npm run build && fiori deploy --config ui5-deploy.yaml && rimraf archive.zip",
+        "undeploy": "fiori undeploy --config ui5-deploy.yaml",
+        "deploy-test": "npm run build && fiori deploy --config ui5-deploy.yaml --testMode true"<% } else { %>
+        "build": "ui5 build --exclude-task generateFlexChangesBundle generateComponentPreload --clean-dest",
+        "start": "<%= locals.options?.fioriTools ? 'fiori run' : 'ui5 serve' %> --open /test/flp.html#app-preview",
+        "start-editor": "<%= locals.options?.fioriTools ? 'fiori run' : 'ui5 serve' %> --open /test/adaptation-editor.html"<%if (locals.deploy) {%>,
+        "deploy": "ui5 build --config ui5-deploy.yaml --exclude-task <%= locals.options?.fioriTools ? 'deploy-to-abap' : 'abap-deploy-task' %> generateFlexChangesBundle generateComponentPreload --clean-dest && <%= locals.options?.fioriTools ? 'fiori deploy' : 'deploy' %> --config ui5-deploy.yaml",
+        "undeploy": "<%= locals.options?.fioriTools ? 'fiori undeploy' : 'undeploy' %> --config ui5-deploy.yaml --lrep \"apps/<%= app.reference %>/appVariants/<%= app.id %>/\""<%}%><% } %>
+    }
+}