feat(generator-adp): Developer taking over Key-User changes

.changeset/two-dragons-smoke.md

@@ -0,0 +1,7 @@
+---
+'@sap-ux/generator-adp': minor
+'@sap-ux/axios-extension': patch
+'@sap-ux/adp-tooling': patch
+---
+
+feat(generator-adp): Developer taking over Key-User changes

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

@@ -5,14 +5,16 @@ import { existsSync, readFileSync, readdirSync } from 'node:fs';
 
 import { DirName, getWebappPath } from '@sap-ux/project-access';
 import {
+    FlexLayer,
     TemplateFileName,
     type AnnotationsData,
     type ChangeType,
     type DescriptorVariant,
     type InboundContent,
     type ManifestChangeProperties,
     type PropertyValueType,
-    ChangeTypeMap
+    ChangeTypeMap,
+    type AdpWriterConfig
 } from '../types';
 import { renderFile } from 'ejs';
 
@@ -76,6 +78,68 @@ export async function writeAnnotationChange(
     }
 }
 
+/**
+ * Writes key-user change payloads to the generated adaptation project. Transforms key-user changes to a developer adaptation format.
+ *
+ * @param projectPath - Project root path.
+ * @param config - The writer configuration.
+ * @param fs - Yeoman mem-fs editor.
+ */
+export async function writeKeyUserChanges(projectPath: string, config: AdpWriterConfig, fs: Editor): Promise<void> {
+    const changes = config.keyUserChanges;
+    if (!changes?.length) {
+        return;
+    }
+
+    for (const entry of changes) {
+        if (!entry?.content) {
+            continue;
+        }
+
+        const change = { ...(entry.content as Record<string, unknown>) };
+        if (!change['fileName']) {
+            continue;
+        }
+
+        const transformedChange = transformKeyUserChangeForAdp(change, config.app.id, config.app.layer);
+
+        await writeChangeToFolder(projectPath, transformedChange as unknown as ManifestChangeProperties, fs);
+    }
+}
+
+/**
+ * Transforms a key-user change to a developer adaptation format.
+ *
+ * @param change - The key-user change from the backend.
+ * @param appId - The ID of the newly created Adaptation Project.
+ * @param layer - The layer of the change.
+ * @returns {Record<string, unknown>} The transformed change object.
+ */
+export function transformKeyUserChangeForAdp(
+    change: Record<string, unknown>,
+    appId: string,
+    layer: FlexLayer | undefined
+): Record<string, unknown> {
+    const transformed = { ...change };
+
+    transformed.layer = layer ?? FlexLayer.CUSTOMER_BASE;
+    transformed.reference = appId;
+    transformed.namespace = path.posix.join('apps', appId, DirName.Changes, '/');
+    if (transformed.projectId) {
+        transformed.projectId = appId;
+    }
+    transformed.support ??= {};
+    const supportObject = transformed.support as Record<string, unknown>;
+    supportObject.generator = 'adp-key-user-converter';
+
+    delete transformed.adaptationId;
+    delete transformed.version;
+    delete transformed.context;
+    delete transformed.versionId;
+
+    return transformed;
+}
+
 /**
  * Writes a given change object to a file within a specified folder in the project's 'changes' directory.
  * If an additional subdirectory is specified, the change file is written there.

packages/adp-tooling/src/index.ts

@@ -10,6 +10,7 @@ export * from './base/helper';
 export * from './base/constants';
 export * from './base/project-builder';
 export * from './base/abap/manifest-service';
+export { writeKeyUserChanges } from './base/change-utils';
 export { promptGeneratorInput, PromptDefaults } from './base/prompt';
 export * from './preview/adp-preview';
 export * from './writer/cf';

packages/adp-tooling/src/types.ts

@@ -1,7 +1,7 @@
 import type { UI5FlexLayer, ManifestNamespace, Manifest, Package } from '@sap-ux/project-access';
 import type { DestinationAbapTarget, UrlAbapTarget } from '@sap-ux/system-access';
 import type { Adp, BspApp } from '@sap-ux/ui5-config';
-import type { AxiosRequestConfig, OperationsType } from '@sap-ux/axios-extension';
+import type { AxiosRequestConfig, KeyUserChangeContent, OperationsType } from '@sap-ux/axios-extension';
 import type { Editor } from 'mem-fs-editor';
 import type { Destination } from '@sap-ux/btp-utils';
 import type { YUIQuestion } from '@sap-ux/inquirer-common';
@@ -109,6 +109,10 @@ export interface AdpWriterConfig {
          */
         templatePathOverwrite?: string;
     };
+    /**
+     * Optional: Key-user changes to be written to the project.
+     */
+    keyUserChanges?: KeyUserChangeContent[];
 }
 
 /**
@@ -133,6 +137,7 @@ export interface AttributesAnswers {
     enableTypeScript: boolean;
     addDeployConfig?: boolean;
     addFlpConfig?: boolean;
+    importKeyUserChanges?: boolean;
 }
 
 export interface SourceApplication {

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

@@ -7,6 +7,7 @@ import { getI18nDescription, getI18nModels, writeI18nModels } from './i18n';
 import { writeTemplateToFolder, writeUI5Yaml, writeUI5DeployYaml } from './project-utils';
 import { FlexLayer, type AdpWriterConfig, type InternalInboundNavigation } from '../types';
 import { getApplicationType } from '../source';
+import { writeKeyUserChanges } from '../base/change-utils';
 
 const baseTmplPath = join(__dirname, '../../templates');
 
@@ -23,7 +24,8 @@ function setDefaults(config: AdpWriterConfig): AdpWriterConfig {
         ui5: { ...config.ui5 },
         deploy: config.deploy ? { ...config.deploy } : undefined,
         options: { ...config.options },
-        customConfig: config.customConfig ? { ...config.customConfig } : undefined
+        customConfig: config.customConfig ? { ...config.customConfig } : undefined,
+        keyUserChanges: config.keyUserChanges
     };
     configWithDefaults.app.title ??= `Adaptation of ${config.app.reference}`;
     configWithDefaults.app.layer ??= FlexLayer.CUSTOMER_BASE;
@@ -67,6 +69,7 @@ export async function generate(basePath: string, config: AdpWriterConfig, fs?: E
     writeTemplateToFolder(templatePath, join(basePath), fullConfig, fs);
     await writeUI5DeployYaml(basePath, fullConfig, fs);
     await writeUI5Yaml(basePath, fullConfig, fs);
+    await writeKeyUserChanges(basePath, fullConfig, fs);
 
     return fs;
 }

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

@@ -2,7 +2,7 @@ import { join } from 'node:path';
 
 import type { ToolsLogger } from '@sap-ux/logger';
 import type { Manifest, Package } from '@sap-ux/project-access';
-import type { AbapServiceProvider } from '@sap-ux/axios-extension';
+import type { AbapServiceProvider, KeyUserChangeContent } from '@sap-ux/axios-extension';
 
 import type {
     AdpWriterConfig,
@@ -68,6 +68,10 @@ export interface ConfigOptions {
      * The tools ID.
      */
     toolsId: string;
+    /**
+     * Optional: Key-user changes to be written to the project.
+     */
+    keyUserChanges?: KeyUserChangeContent[];
 }
 
 /**
@@ -94,7 +98,8 @@ export async function getConfig(options: ConfigOptions): Promise<AdpWriterConfig
         publicVersions,
         systemVersion,
         manifest,
-        toolsId
+        toolsId,
+        keyUserChanges
     } = options;
 
     const ato = await provider.getAtoInfo();
@@ -155,7 +160,8 @@ export async function getConfig(options: ConfigOptions): Promise<AdpWriterConfig
         options: {
             fioriTools: true,
             enableTypeScript
-        }
+        },
+        keyUserChanges
     };
 }