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

.changeset/famous-panthers-occur.md

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

packages/adp-tooling/src/types.ts

@@ -1,8 +1,8 @@
 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 { Editor } from 'mem-fs-editor';
+import type { Adp, BspApp } from '@sap-ux/ui5-config';
 import type { OperationsType } from '@sap-ux/axios-extension';
+import type { Editor } from 'mem-fs-editor';
 
 export interface DescriptorVariant {
     layer: UI5FlexLayer;
@@ -26,13 +26,30 @@ export interface AdpPreviewConfig {
     ignoreCertErrors?: boolean;
 }
 
+export interface OnpremApp {
+    /** Application variant id. */
+    id: string;
+    /** Reference associated with the ID of the base application. */
+    reference: string;
+    layer?: UI5FlexLayer;
+    title?: string;
+    /** Optional: Application variant change content. */
+    content?: Content[];
+}
+
+export interface CloudApp extends OnpremApp {
+    /** bspName associated with the ABAP Cloud repository name of the base application. */
+    bspName: string;
+    /** Cloud app active languages. */
+    languages: Language[];
+}
+
+export type App = OnpremApp | CloudApp;
+
+export type DeployConfig = Adp | BspApp;
+
 export interface AdpWriterConfig {
-    app: {
-        id: string;
-        reference: string;
-        layer?: UI5FlexLayer;
-        title?: string;
-    };
+    app: App;
     target: AbapTarget;
     ui5?: {
         minVersion?: string;
@@ -43,11 +60,12 @@ export interface AdpWriterConfig {
         name?: string;
         description?: string;
     };
-    customConfig?: AdpCustomConfig;
+    flp?: FlpConfig;
+    customConfig?: CustomConfig;
     /**
      * Optional: configuration for deployment to ABAP
      */
-    deploy?: Adp;
+    deploy?: DeployConfig;
     options?: {
         /**
          * Optional: if set to true then the generated project will be recognized by the SAP Fiori tools
@@ -56,6 +74,42 @@ export interface AdpWriterConfig {
     };
 }
 
+export interface ChangeInboundNavigation {
+    /** Identifier for the inbound navigation. */
+    inboundId: string;
+    /** Title associated with the inbound navigation. */
+    title?: string;
+    /** Subtitle associated with the inbound navigation. */
+    subTitle?: string;
+}
+
+export interface NewInboundNavigation {
+    /** Represent business entities that reflect a specific scenario. */
+    semanticObject: string;
+    /** Operations which can be performed on a semantic object. */
+    action: string;
+    //** Defined instance of the semantic object (e.g. by specifying the employee ID). */
+    additionalParameters?: object;
+    /** Title associated with the inbound navigation. */
+    title: string;
+    /** Optional: Subtitle associated with the inbound navigation. */
+    subTitle?: string;
+}
+
+export interface InternalInboundNavigation extends NewInboundNavigation {
+    /** Identifier for the inbound navigation. */
+    inboundId: string;
+    /** Flag indicating if the new inbound navigation should be added. */
+    addInboundId: boolean;
+}
+
+export type FlpConfig = ChangeInboundNavigation | NewInboundNavigation;
+
+export interface Language {
+    sap: string;
+    i18n: string;
+}
+
 export interface ManifestAppdescr {
     fileName: string;
     layer: string;
@@ -175,6 +229,7 @@ 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 interface IWriter<T> {
     /**
      * Writes the provided data to the project.
@@ -345,9 +400,57 @@ export interface AdpProjectData {
     id: string;
 }
 
-export interface AdpCustomConfig {
+export interface CustomConfig {
     adp: {
         safeMode: boolean;
         environment: OperationsType;
     };
-}
+}
+
+export interface InboundChangeContentAddInboundId {
+    inbound: {
+        [inboundId: string]: AddInboundModel;
+    };
+}
+export interface AddInboundModel {
+    /** Represent business entities that reflect a specific scenario. */
+    semanticObject: string;
+    /** Operations which can be performed on a semantic object. */
+    action: string;
+    /** Title associated with the inbound navigation data. */
+    title: string;
+    /** Optional: Subtitle associated with the inbound navigation data. */
+    subTitle?: string;
+    signature: AddInboundSignitureModel;
+}
+export interface AddInboundSignitureModel {
+    parameters: InboundParameters;
+    //** Defined instance of the semantic object (e.g. by specifying the employee ID). */
+    additionalParameters: string;
+}
+export interface InboundParameters {
+    'sap-appvar-id'?: object;
+    'sap-priority'?: object;
+}
+
+export interface InboundChange {
+    inbound: {
+        [key: string]: {
+            /** Represent business entities that reflect a specific scenario. */
+            semanticObject: string;
+            /** Operations which can be performed on a semantic object. */
+            action: string;
+            /** Icon associated with the inbound navigation data. */
+            icon: string;
+            /** Title associated with the inbound navigation data. */
+            title: string;
+            /** Subtitle associated with the inbound navigation data. */
+            subTitle: string;
+            signature: {
+                parameters: object | string;
+                //** Defined instance of the semantic object (e.g. by specifying the employee ID). */
+                additionalParameters: 'allowed';
+            };
+        };
+    };
+}

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

@@ -1,8 +1,8 @@
 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 { AdpWriterConfig } from '../types';
+import { create, type Editor } from 'mem-fs-editor';
+import type { AdpWriterConfig, InternalInboundNavigation } from '../types';
+import { enhanceManifestChangeContentWithFlpConfig } from './options';
 import { writeTemplateToFolder, writeUI5Yaml, writeUI5DeployYaml } from './project-utils';
 
 const tmplPath = join(__dirname, '../../templates/project');
@@ -14,12 +14,13 @@ const tmplPath = join(__dirname, '../../templates/project');
  * @returns enhanced configuration with default values
  */
 function setDefaults(config: AdpWriterConfig): AdpWriterConfig {
-    const configWithDefaults: AdpWriterConfig = {
+    const configWithDefaults: AdpWriterConfig & { flp?: InternalInboundNavigation } = {
         app: { ...config.app },
         target: { ...config.target },
         ui5: { ...config.ui5 },
         deploy: config.deploy ? { ...config.deploy } : undefined,
         options: { ...config.options },
+        flp: config.flp ? ({ ...config.flp } as InternalInboundNavigation) : undefined,
         customConfig: config.customConfig ? { ...config.customConfig } : undefined
     };
     configWithDefaults.app.title ??= `Adaptation of ${config.app.reference}`;
@@ -29,6 +30,11 @@ function setDefaults(config: AdpWriterConfig): AdpWriterConfig {
     configWithDefaults.package.name ??= config.app.id.toLowerCase().replace(/\./g, '-');
     configWithDefaults.package.description ??= configWithDefaults.app.title;
 
+    if (configWithDefaults.flp && !configWithDefaults.flp.inboundId) {
+        configWithDefaults.flp.addInboundId = true;
+        configWithDefaults.flp.inboundId = `${configWithDefaults.app.id}.InboundID`;
+    }
+
     return configWithDefaults;
 }
 
@@ -44,8 +50,16 @@ export async function generate(basePath: string, config: AdpWriterConfig, fs?: E
     if (!fs) {
         fs = create(createStorage());
     }
+
     const fullConfig = setDefaults(config);
 
+    if (fullConfig.customConfig?.adp.environment === 'C' && fullConfig.flp) {
+        enhanceManifestChangeContentWithFlpConfig(
+            fullConfig.flp as InternalInboundNavigation,
+            fullConfig.app.id,
+            fullConfig.app.content
+        );
+    }
     writeTemplateToFolder(join(tmplPath, '**/*.*'), join(basePath), fullConfig, fs);
     await writeUI5DeployYaml(basePath, fullConfig, fs);
     await writeUI5Yaml(basePath, fullConfig, fs);
@@ -61,7 +75,6 @@ export async function generate(basePath: string, config: AdpWriterConfig, fs?: E
  * @param fs - the memfs editor instance
  * @returns the updated memfs editor instance
  */
-
 export async function migrate(basePath: string, config: AdpWriterConfig, fs?: Editor): Promise<Editor> {
     if (!fs) {
         fs = create(createStorage());