@sap-ux/adp-tooling 0.18.44 → 0.18.45

package/dist/base/change-utils.d.ts

@@ -1,5 +1,5 @@
 import type { Editor } from 'mem-fs-editor';
-import { type AnnotationsData, type ChangeType, type DescriptorVariant, type InboundContent, type ManifestChangeProperties, type PropertyValueType } from '../types';
+import { FlexLayer, type AnnotationsData, type ChangeType, type DescriptorVariant, type InboundContent, type ManifestChangeProperties, type PropertyValueType, type AdpWriterConfig } from '../types';
 export type ChangeMetadata = Pick<DescriptorVariant, 'id' | 'layer' | 'namespace'>;
 type InboundChangeData = {
     filePath: string;
@@ -20,6 +20,23 @@ interface InboundChange extends ManifestChangeProperties {
  * @returns {Promise<void>}
  */
 export declare function writeAnnotationChange(projectPath: string, timestamp: number, annotation: AnnotationsData['annotation'], change: ManifestChangeProperties | undefined, fs: Editor, templatesPath?: string): Promise<void>;
+/**
+ * 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 declare function writeKeyUserChanges(projectPath: string, config: AdpWriterConfig, fs: Editor): Promise<void>;
+/**
+ * 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 declare function transformKeyUserChangeForAdp(change: Record<string, unknown>, appId: string, layer: FlexLayer | undefined): Record<string, unknown>;
 /**
  * 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.

package/dist/base/change-utils.js

@@ -4,6 +4,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.writeAnnotationChange = writeAnnotationChange;
+exports.writeKeyUserChanges = writeKeyUserChanges;
+exports.transformKeyUserChangeForAdp = transformKeyUserChangeForAdp;
 exports.writeChangeToFolder = writeChangeToFolder;
 exports.writeChangeToFile = writeChangeToFile;
 exports.parseStringToObject = parseStringToObject;
@@ -61,6 +63,55 @@ async function writeAnnotationChange(projectPath, timestamp, annotation, change,
         throw new Error(`Could not write annotation changes. Reason: ${e.message}`);
     }
 }
+/**
+ * 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.
+ */
+async function writeKeyUserChanges(projectPath, config, fs) {
+    const changes = config.keyUserChanges;
+    if (!changes?.length) {
+        return;
+    }
+    for (const entry of changes) {
+        if (!entry?.content) {
+            continue;
+        }
+        const change = { ...entry.content };
+        if (!change['fileName']) {
+            continue;
+        }
+        const transformedChange = transformKeyUserChangeForAdp(change, config.app.id, config.app.layer);
+        await writeChangeToFolder(projectPath, transformedChange, 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.
+ */
+function transformKeyUserChangeForAdp(change, appId, layer) {
+    const transformed = { ...change };
+    transformed.layer = layer ?? "CUSTOMER_BASE" /* FlexLayer.CUSTOMER_BASE */;
+    transformed.reference = appId;
+    transformed.namespace = node_path_1.default.posix.join('apps', appId, project_access_1.DirName.Changes, '/');
+    if (transformed.projectId) {
+        transformed.projectId = appId;
+    }
+    transformed.support ??= {};
+    const supportObject = transformed.support;
+    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.

package/dist/index.d.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';

package/dist/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateInboundConfig = exports.generateChange = exports.migrate = exports.generate = exports.promptGeneratorInput = void 0;
+exports.generateInboundConfig = exports.generateChange = exports.migrate = exports.generate = exports.promptGeneratorInput = exports.writeKeyUserChanges = void 0;
 __exportStar(require("./types"), exports);
 __exportStar(require("./prompts"), exports);
 __exportStar(require("./common"), exports);
@@ -27,6 +27,8 @@ __exportStar(require("./base/helper"), exports);
 __exportStar(require("./base/constants"), exports);
 __exportStar(require("./base/project-builder"), exports);
 __exportStar(require("./base/abap/manifest-service"), exports);
+var change_utils_1 = require("./base/change-utils");
+Object.defineProperty(exports, "writeKeyUserChanges", { enumerable: true, get: function () { return change_utils_1.writeKeyUserChanges; } });
 var prompt_1 = require("./base/prompt");
 Object.defineProperty(exports, "promptGeneratorInput", { enumerable: true, get: function () { return prompt_1.promptGeneratorInput; } });
 __exportStar(require("./preview/adp-preview"), exports);

package/dist/types.d.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';
@@ -100,6 +100,10 @@ export interface AdpWriterConfig {
          */
         templatePathOverwrite?: string;
     };
+    /**
+     * Optional: Key-user changes to be written to the project.
+     */
+    keyUserChanges?: KeyUserChangeContent[];
 }
 /**
  * Interface representing the answers collected from the configuration prompts of Adaptation Project generator.
@@ -122,6 +126,7 @@ export interface AttributesAnswers {
     enableTypeScript: boolean;
     addDeployConfig?: boolean;
     addFlpConfig?: boolean;
+    importKeyUserChanges?: boolean;
 }
 export interface SourceApplication {
     id: string;

package/dist/writer/index.js

@@ -9,6 +9,7 @@ const manifest_1 = require("./manifest");
 const i18n_1 = require("./i18n");
 const project_utils_1 = require("./project-utils");
 const source_1 = require("../source");
+const change_utils_1 = require("../base/change-utils");
 const baseTmplPath = (0, node_path_1.join)(__dirname, '../../templates');
 /**
  * Set default values for optional properties.
@@ -23,7 +24,8 @@ function setDefaults(config) {
         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 ??= "CUSTOMER_BASE" /* FlexLayer.CUSTOMER_BASE */;
@@ -54,6 +56,7 @@ async function generate(basePath, config, fs) {
     (0, project_utils_1.writeTemplateToFolder)(templatePath, (0, node_path_1.join)(basePath), fullConfig, fs);
     await (0, project_utils_1.writeUI5DeployYaml)(basePath, fullConfig, fs);
     await (0, project_utils_1.writeUI5Yaml)(basePath, fullConfig, fs);
+    await (0, change_utils_1.writeKeyUserChanges)(basePath, fullConfig, fs);
     return fs;
 }
 /**

package/dist/writer/writer-config.d.ts

@@ -1,6 +1,6 @@
 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, AttributesAnswers, CfAdpWriterConfig, ConfigAnswers, CreateCfConfigParams, UI5Version } from '../types';
 import { FlexLayer } from '../types';
 export interface ConfigOptions {
@@ -44,6 +44,10 @@ export interface ConfigOptions {
      * The tools ID.
      */
     toolsId: string;
+    /**
+     * Optional: Key-user changes to be written to the project.
+     */
+    keyUserChanges?: KeyUserChangeContent[];
 }
 /**
  * Generates the configuration object for the Adaptation Project.

package/dist/writer/writer-config.js

@@ -22,7 +22,7 @@ const i18n_1 = require("../i18n");
  * @returns {Promise<AdpWriterConfig>} A promise that resolves to the generated ADP writer configuration.
  */
 async function getConfig(options) {
-    const { configAnswers, attributeAnswers, layer, logger, packageJson, provider, publicVersions, systemVersion, manifest, toolsId } = options;
+    const { configAnswers, attributeAnswers, layer, logger, packageJson, provider, publicVersions, systemVersion, manifest, toolsId, keyUserChanges } = options;
     const ato = await provider.getAtoInfo();
     const operationsType = ato.operationsType ?? 'P';
     const target = await (0, abap_1.getProviderConfig)(configAnswers.system, logger);
@@ -68,7 +68,8 @@ async function getConfig(options) {
         options: {
             fioriTools: true,
             enableTypeScript
-        }
+        },
+        keyUserChanges
     };
 }
 /**

package/package.json

@@ -9,7 +9,7 @@
   "bugs": {
     "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Aadp-tooling"
   },
-  "version": "0.18.44",
+  "version": "0.18.45",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -36,7 +36,7 @@
     "prompts": "2.4.2",
     "sanitize-filename": "1.6.3",
     "uuid": "10.0.0",
-    "@sap-ux/axios-extension": "1.25.6",
+    "@sap-ux/axios-extension": "1.25.7",
     "@sap-ux/btp-utils": "1.1.6",
     "@sap-ux/i18n": "0.3.7",
     "@sap-ux/inquirer-common": "0.10.17",
@@ -46,7 +46,7 @@
     "@sap-ux/project-access": "1.34.2",
     "@sap-ux/project-input-validator": "0.6.46",
     "@sap-ux/store": "1.5.1",
-    "@sap-ux/system-access": "0.6.42",
+    "@sap-ux/system-access": "0.6.43",
     "@sap-ux/ui5-config": "0.29.13",
     "@sap-ux/ui5-info": "0.13.8"
   },