@sap-ux/adp-tooling 0.12.12 → 0.12.13

package/dist/base/abap.d.ts

@@ -1,4 +1,4 @@
-import type { Manifest } from '@sap-ux/project-access';
+import type { Manifest, ManifestNamespace } from '@sap-ux/project-access';
 import type { ToolsLogger } from '@sap-ux/logger';
 import type { AdpPreviewConfig } from '../types';
 /**
@@ -10,4 +10,15 @@ import type { AdpPreviewConfig } from '../types';
  * @returns {Promise<Manifest>} The manifest.
  */
 export declare function getManifest(appId: string, adpConfig: AdpPreviewConfig, logger: ToolsLogger): Promise<Manifest>;
+type DataSources = Record<string, ManifestNamespace.DataSource>;
+/**
+ * Returns the adaptation project configuration, throws an error if not found.
+ *
+ * @param {string} reference - The base application id.
+ * @param {AdpPreviewConfig} adpConfig - The adaptation project configuration.
+ * @param {ToolsLogger} logger - The logger.
+ * @returns {Promise<DataSources>} data sources from base application manifest
+ */
+export declare function getManifestDataSources(reference: string, adpConfig: AdpPreviewConfig, logger: ToolsLogger): Promise<DataSources>;
+export {};
 //# sourceMappingURL=abap.d.ts.map

package/dist/base/abap.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getManifest = void 0;
+exports.getManifestDataSources = exports.getManifest = void 0;
 const system_access_1 = require("@sap-ux/system-access");
 const axios_extension_1 = require("@sap-ux/axios-extension");
 /**
@@ -36,4 +36,21 @@ async function getManifest(appId, adpConfig, logger) {
     }
 }
 exports.getManifest = getManifest;
+/**
+ * Returns the adaptation project configuration, throws an error if not found.
+ *
+ * @param {string} reference - The base application id.
+ * @param {AdpPreviewConfig} adpConfig - The adaptation project configuration.
+ * @param {ToolsLogger} logger - The logger.
+ * @returns {Promise<DataSources>} data sources from base application manifest
+ */
+async function getManifestDataSources(reference, adpConfig, logger) {
+    const manifest = await exports.getManifest(reference, adpConfig, logger);
+    const dataSources = manifest['sap.app'].dataSources;
+    if (!dataSources) {
+        throw new Error('No data sources found in the manifest');
+    }
+    return dataSources;
+}
+exports.getManifestDataSources = getManifestDataSources;
 //# sourceMappingURL=abap.js.map

package/dist/base/cf.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Check if the project is a CF project.
+ *
+ * @param {string} basePath - The path to the adaptation project.
+ * @returns {boolean} true if the project is a CF project, false otherwise
+ */
+export declare function isCFEnvironment(basePath: string): boolean;
+//# sourceMappingURL=cf.d.ts.map

package/dist/base/cf.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isCFEnvironment = void 0;
+const path_1 = require("path");
+const fs_1 = require("fs");
+/**
+ * Check if the project is a CF project.
+ *
+ * @param {string} basePath - The path to the adaptation project.
+ * @returns {boolean} true if the project is a CF project, false otherwise
+ */
+function isCFEnvironment(basePath) {
+    const configJsonPath = (0, path_1.join)(basePath, '.adp', 'config.json');
+    if ((0, fs_1.existsSync)(configJsonPath)) {
+        const config = JSON.parse((0, fs_1.readFileSync)(configJsonPath, 'utf-8'));
+        if (config.environment === 'CF') {
+            return true;
+        }
+    }
+    return false;
+}
+exports.isCFEnvironment = isCFEnvironment;
+//# sourceMappingURL=cf.js.map

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

@@ -1,5 +1,5 @@
 import type { Editor } from 'mem-fs-editor';
-import type { AnnotationsData, ChangeType, DescriptorVariant, InboundContent, ManifestChangeProperties, PropertyValueType } from '../types';
+import { type AnnotationsData, type ChangeType, type DescriptorVariant, type InboundContent, type ManifestChangeProperties, type PropertyValueType } from '../types';
 export type ChangeMetadata = Pick<DescriptorVariant, 'id' | 'layer' | 'namespace'>;
 type InboundChangeData = {
     filePath: string;
@@ -12,12 +12,13 @@ interface InboundChange extends ManifestChangeProperties {
  * Writes annotation changes to the specified project path using the provided `mem-fs-editor` instance.
  *
  * @param {string} projectPath - The root path of the project.
+ * @param {number} timestamp - The timestamp of the change.
  * @param {AnnotationsData} data - The data object containing information about the annotation change.
  * @param {ManifestChangeProperties} change - The annotation data change that will be written.
  * @param {Editor} fs - The `mem-fs-editor` instance used for file operations.
  * @returns {void}
  */
-export declare function writeAnnotationChange(projectPath: string, data: AnnotationsData, change: ManifestChangeProperties, fs: Editor): void;
+export declare function writeAnnotationChange(projectPath: string, timestamp: number, data: AnnotationsData, change: ManifestChangeProperties, fs: Editor): void;
 /**
  * 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

@@ -11,27 +11,28 @@ const project_access_1 = require("@sap-ux/project-access");
  * Writes annotation changes to the specified project path using the provided `mem-fs-editor` instance.
  *
  * @param {string} projectPath - The root path of the project.
+ * @param {number} timestamp - The timestamp of the change.
  * @param {AnnotationsData} data - The data object containing information about the annotation change.
  * @param {ManifestChangeProperties} change - The annotation data change that will be written.
  * @param {Editor} fs - The `mem-fs-editor` instance used for file operations.
  * @returns {void}
  */
-function writeAnnotationChange(projectPath, data, change, fs) {
+function writeAnnotationChange(projectPath, timestamp, data, change, fs) {
     try {
-        const { timestamp, annotation } = data;
+        const { fileName, answers } = data;
         const changeFileName = `id_${timestamp}_addAnnotationsToOData.change`;
         const changesFolderPath = path_1.default.join(projectPath, project_access_1.DirName.Webapp, project_access_1.DirName.Changes);
         const changeFilePath = path_1.default.join(changesFolderPath, project_access_1.DirName.Manifest, changeFileName);
         const annotationsFolderPath = path_1.default.join(changesFolderPath, project_access_1.DirName.Annotations);
         writeChangeToFile(changeFilePath, change, fs);
-        if (!annotation.filePath) {
-            fs.write(path_1.default.join(annotationsFolderPath, annotation.fileName ?? ''), '');
+        if (!answers.filePath) {
+            const annotationsTemplate = path_1.default.join(__dirname, '..', '..', 'templates', 'changes', "annotation.xml" /* TemplateFileName.Annotation */);
+            fs.copy(annotationsTemplate, path_1.default.join(annotationsFolderPath, fileName ?? ''));
         }
         else {
-            const { filePath, fileName } = annotation;
-            const selectedDir = path_1.default.dirname(filePath);
+            const selectedDir = path_1.default.dirname(answers.filePath);
             if (selectedDir !== annotationsFolderPath) {
-                fs.copy(filePath, path_1.default.join(annotationsFolderPath, fileName ?? ''));
+                fs.copy(answers.filePath, path_1.default.join(annotationsFolderPath, fileName ?? ''));
             }
         }
     }

package/dist/base/helper.d.ts

@@ -1,15 +1,17 @@
+import type { DescriptorVariant, AdpPreviewConfig } from '../types';
 /**
- * Checks if the input is a non-empty string.
+ * Get the app descriptor variant.
  *
- * @param input - input to check
- * @returns true if the input is a non-empty string
+ * @param {string} basePath - The path to the adaptation project.
+ * @returns {DescriptorVariant} The app descriptor variant.
  */
-export declare function isNotEmptyString(input: string | undefined): boolean;
+export declare function getVariant(basePath: string): DescriptorVariant;
 /**
- * Checks if the input is a valid SAP client.
+ * Returns the adaptation project configuration, throws an error if not found.
  *
- * @param input - input to check
- * @returns true if the input is a valid SAP client
+ * @param {string} basePath - The path to the adaptation project.
+ * @param {string} yamlPath - The path to yaml configuration file.
+ * @returns {Promise<AdpPreviewConfig>} the adp configuration
  */
-export declare function isValidSapClient(input: string | undefined): boolean;
+export declare function getAdpConfig(basePath: string, yamlPath: string): Promise<AdpPreviewConfig>;
 //# sourceMappingURL=helper.d.ts.map

package/dist/base/helper.js

@@ -1,24 +1,36 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isValidSapClient = exports.isNotEmptyString = void 0;
+exports.getAdpConfig = exports.getVariant = void 0;
+const fs_1 = require("fs");
+const path_1 = require("path");
+const ui5_config_1 = require("@sap-ux/ui5-config");
 /**
- * Checks if the input is a non-empty string.
+ * Get the app descriptor variant.
  *
- * @param input - input to check
- * @returns true if the input is a non-empty string
+ * @param {string} basePath - The path to the adaptation project.
+ * @returns {DescriptorVariant} The app descriptor variant.
  */
-function isNotEmptyString(input) {
-    return typeof input === 'string' && input.trim().length > 0;
+function getVariant(basePath) {
+    return JSON.parse((0, fs_1.readFileSync)((0, path_1.join)(basePath, 'webapp', 'manifest.appdescr_variant'), 'utf-8'));
 }
-exports.isNotEmptyString = isNotEmptyString;
+exports.getVariant = getVariant;
 /**
- * Checks if the input is a valid SAP client.
+ * Returns the adaptation project configuration, throws an error if not found.
  *
- * @param input - input to check
- * @returns true if the input is a valid SAP client
+ * @param {string} basePath - The path to the adaptation project.
+ * @param {string} yamlPath - The path to yaml configuration file.
+ * @returns {Promise<AdpPreviewConfig>} the adp configuration
  */
-function isValidSapClient(input) {
-    return !input || (input.length < 4 && !!new RegExp(/^\d*$/).exec(input));
+async function getAdpConfig(basePath, yamlPath) {
+    const ui5ConfigPath = (0, path_1.isAbsolute)(yamlPath) ? yamlPath : (0, path_1.join)(basePath, yamlPath);
+    const ui5Conf = await ui5_config_1.UI5Config.newInstance((0, fs_1.readFileSync)(ui5ConfigPath, 'utf-8'));
+    const customMiddlerware = ui5Conf.findCustomMiddleware('fiori-tools-preview') ??
+        ui5Conf.findCustomMiddleware('preview-middleware');
+    const adp = customMiddlerware?.configuration?.adp;
+    if (!adp) {
+        throw new Error('No system configuration found in ui5.yaml');
+    }
+    return adp;
 }
-exports.isValidSapClient = isValidSapClient;
+exports.getAdpConfig = getAdpConfig;
 //# sourceMappingURL=helper.js.map

package/dist/base/prompt.js

@@ -6,8 +6,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.promptTarget = exports.promptGeneratorInput = void 0;
 const prompts_1 = __importDefault(require("prompts"));
 const system_access_1 = require("@sap-ux/system-access");
+const validators_1 = require("./validators");
 const uuid_1 = require("uuid");
-const helper_1 = require("./helper");
 const project_utils_1 = require("../writer/project-utils");
 /**
  * Prompt the user for the required properties for an adaptation project.
@@ -114,7 +114,7 @@ async function promptTarget(defaults, logger) {
                     name: 'url',
                     message: 'Target system url:',
                     initial: target.url,
-                    validate: helper_1.isNotEmptyString,
+                    validate: validators_1.isNotEmptyString,
                     format: (input) => input.trim()
                 },
                 {
@@ -122,7 +122,7 @@ async function promptTarget(defaults, logger) {
                     name: 'client',
                     message: 'Client (optional):',
                     initial: target.client,
-                    validate: helper_1.isValidSapClient
+                    validate: validators_1.isValidSapClient
                 }
             ]);
             const systemInfo = await fetchSystemInformation(target, defaults.ignoreCertErrors, logger);

package/dist/base/validators.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Checks if the input is a non-empty string.
+ *
+ * @param input - input to check
+ * @returns true if the input is a non-empty string
+ */
+export declare function isNotEmptyString(input: string | undefined): boolean;
+/**
+ * Checks if the input is a valid SAP client.
+ *
+ * @param input - input to check
+ * @returns true if the input is a valid SAP client
+ */
+export declare function isValidSapClient(input: string | undefined): boolean;
+//# sourceMappingURL=validators.d.ts.map

package/dist/base/validators.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isValidSapClient = exports.isNotEmptyString = void 0;
+/**
+ * Checks if the input is a non-empty string.
+ *
+ * @param input - input to check
+ * @returns true if the input is a non-empty string
+ */
+function isNotEmptyString(input) {
+    return typeof input === 'string' && input.trim().length > 0;
+}
+exports.isNotEmptyString = isNotEmptyString;
+/**
+ * Checks if the input is a valid SAP client.
+ *
+ * @param input - input to check
+ * @returns true if the input is a valid SAP client
+ */
+function isValidSapClient(input) {
+    return !input || (input.length < 4 && !!new RegExp(/^\d*$/).exec(input));
+}
+exports.isValidSapClient = isValidSapClient;
+//# sourceMappingURL=validators.js.map

package/dist/index.d.ts

@@ -1,8 +1,11 @@
 export * from './types';
 export * from './prompts';
 export * from './preview/adp-preview';
+export * from './base/helper';
+export * from './base/validators';
+export * from './base/abap';
 export { generate, migrate } from './writer';
 export { generateChange } from './writer/editors';
 export { promptGeneratorInput, PromptDefaults } from './base/prompt';
-export { getManifest } from './base/abap';
+export { isCFEnvironment } from './base/cf';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -14,10 +14,13 @@ 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.getManifest = exports.promptGeneratorInput = exports.generateChange = exports.migrate = exports.generate = void 0;
+exports.isCFEnvironment = exports.promptGeneratorInput = exports.generateChange = exports.migrate = exports.generate = void 0;
 __exportStar(require("./types"), exports);
 __exportStar(require("./prompts"), exports);
 __exportStar(require("./preview/adp-preview"), exports);
+__exportStar(require("./base/helper"), exports);
+__exportStar(require("./base/validators"), exports);
+__exportStar(require("./base/abap"), exports);
 var writer_1 = require("./writer");
 Object.defineProperty(exports, "generate", { enumerable: true, get: function () { return writer_1.generate; } });
 Object.defineProperty(exports, "migrate", { enumerable: true, get: function () { return writer_1.migrate; } });
@@ -25,6 +28,6 @@ var editors_1 = require("./writer/editors");
 Object.defineProperty(exports, "generateChange", { enumerable: true, get: function () { return editors_1.generateChange; } });
 var prompt_1 = require("./base/prompt");
 Object.defineProperty(exports, "promptGeneratorInput", { enumerable: true, get: function () { return prompt_1.promptGeneratorInput; } });
-var abap_1 = require("./base/abap");
-Object.defineProperty(exports, "getManifest", { enumerable: true, get: function () { return abap_1.getManifest; } });
+var cf_1 = require("./base/cf");
+Object.defineProperty(exports, "isCFEnvironment", { enumerable: true, get: function () { return cf_1.isCFEnvironment; } });
 //# sourceMappingURL=index.js.map

package/dist/prompts/add-annotations-to-odata/index.d.ts

@@ -0,0 +1,12 @@
+import type { YUIQuestion } from '@sap-ux/inquirer-common';
+import type { ManifestNamespace } from '@sap-ux/project-access';
+import { type AddAnnotationsAnswers } from '../../types';
+/**
+ * Gets the prompts for adding annotations to OData service.
+ *
+ * @param {string} basePath - The base path of the project.
+ * @param {Record<string, ManifestNamespace.DataSource>} dataSources - Data sources from the manifest.
+ * @returns {YUIQuestion<AddAnnotationsAnswers>[]} The questions/prompts.
+ */
+export declare function getPrompts(basePath: string, dataSources: Record<string, ManifestNamespace.DataSource>): YUIQuestion<AddAnnotationsAnswers>[];
+//# sourceMappingURL=index.d.ts.map

package/dist/prompts/add-annotations-to-odata/index.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPrompts = void 0;
+const i18n_1 = require("../../i18n");
+const project_access_1 = require("@sap-ux/project-access");
+const fs_1 = require("fs");
+const validators_1 = require("../../base/validators");
+const path_1 = require("path");
+/**
+ * Gets the prompts for adding annotations to OData service.
+ *
+ * @param {string} basePath - The base path of the project.
+ * @param {Record<string, ManifestNamespace.DataSource>} dataSources - Data sources from the manifest.
+ * @returns {YUIQuestion<AddAnnotationsAnswers>[]} The questions/prompts.
+ */
+function getPrompts(basePath, dataSources) {
+    const dataSourceIds = Object.keys((0, project_access_1.filterDataSourcesByType)(dataSources, 'OData'));
+    const annotationFileSelectOptions = [
+        { name: (0, i18n_1.t)('choices.annotationFile.selectFromWorkspace'), value: 1 /* AnnotationFileSelectType.ExistingFile */ },
+        { name: (0, i18n_1.t)('choices.annotationFile.createEmptyFile'), value: 2 /* AnnotationFileSelectType.NewEmptyFile */ }
+    ];
+    return [
+        {
+            type: 'list',
+            name: 'id',
+            message: (0, i18n_1.t)('prompts.oDataSourceLabel'),
+            choices: dataSourceIds,
+            default: dataSourceIds[0],
+            store: false,
+            guiOptions: {
+                mandatory: true,
+                hint: (0, i18n_1.t)('prompts.addAnnotationOdataSourceTooltip')
+            }
+        },
+        {
+            type: 'list',
+            name: 'fileSelectOption',
+            message: (0, i18n_1.t)('prompts.fileSelectOptionLabel'),
+            choices: annotationFileSelectOptions,
+            default: 0,
+            guiOptions: {
+                mandatory: true,
+                hint: (0, i18n_1.t)('prompts.fileSelectOptionTooltip')
+            },
+            when: (answers) => answers.id !== ''
+        },
+        {
+            type: 'input',
+            name: 'filePath',
+            message: (0, i18n_1.t)('prompts.filePathLabel'),
+            guiType: 'file-browser',
+            guiOptions: {
+                mandatory: true,
+                hint: (0, i18n_1.t)('prompts.filePathTooltip')
+            },
+            default: '',
+            when: (answers) => answers.id !== '' && answers.fileSelectOption === 1 /* AnnotationFileSelectType.ExistingFile */,
+            validate: (value) => {
+                if (!(0, validators_1.isNotEmptyString)(value)) {
+                    return (0, i18n_1.t)('validators.inputCannotBeEmpty');
+                }
+                const filePath = (0, path_1.isAbsolute)(value) ? value : (0, path_1.join)(basePath, value);
+                if (!(0, fs_1.existsSync)(filePath)) {
+                    return (0, i18n_1.t)('validators.fileDoesNotExist');
+                }
+                const fileName = filePath.split(path_1.sep).pop();
+                if ((0, fs_1.existsSync)((0, path_1.join)(basePath, 'webapp', 'changes', 'annotations', fileName))) {
+                    return (0, i18n_1.t)('validators.annotationFileAlreadyExists');
+                }
+                return true;
+            }
+        }
+    ];
+}
+exports.getPrompts = getPrompts;
+//# sourceMappingURL=index.js.map

package/dist/prompts/change-data-source/index.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getPrompts = void 0;
 const i18n_1 = require("../../i18n");
 const project_access_1 = require("@sap-ux/project-access");
-const helper_1 = require("../../base/helper");
+const validators_1 = require("../../base/validators");
 /**
  * Gets the prompts for changing the data source.
  *
@@ -33,7 +33,7 @@ function getPrompts(dataSources) {
                 mandatory: true,
                 hint: (0, i18n_1.t)('prompts.oDataSourceURITooltip')
             },
-            validate: helper_1.isNotEmptyString,
+            validate: validators_1.isNotEmptyString,
             when: !!dataSourceIds.length,
             store: false
         },

package/dist/prompts/index.d.ts

@@ -1,2 +1,3 @@
 export { getPrompts as getPromptsForChangeDataSource } from './change-data-source';
+export { getPrompts as getPromptsForAddAnnotationsToOData } from './add-annotations-to-odata';
 //# sourceMappingURL=index.d.ts.map

package/dist/prompts/index.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getPromptsForChangeDataSource = void 0;
+exports.getPromptsForAddAnnotationsToOData = exports.getPromptsForChangeDataSource = void 0;
 var change_data_source_1 = require("./change-data-source");
 Object.defineProperty(exports, "getPromptsForChangeDataSource", { enumerable: true, get: function () { return change_data_source_1.getPrompts; } });
+var add_annotations_to_odata_1 = require("./add-annotations-to-odata");
+Object.defineProperty(exports, "getPromptsForAddAnnotationsToOData", { enumerable: true, get: function () { return add_annotations_to_odata_1.getPrompts; } });
 //# sourceMappingURL=index.js.map

package/dist/translations/adp-tooling.i18n.json

@@ -8,13 +8,21 @@
         "maxAgeTooltip": "(Optional) Enter the time in seconds it takes for a cached response of the service to expire.",
         "oDataAnnotationSourceURILabel": "OData Annotation Data Source URI",
         "oDataAnnotationSourceURITooltip": "Server side annotations have been detected for the selected OData service. If needed, enter new annotation data source URI  for the changed service",
-        "oDataURIInfoLabel": "Have in mind that common OData Service path prefixes are '{{- v2Prefix}}' or '{{- v4Prefix}}'",
-        "isInSafeModeLabel": "Making manifest changes is not upgrade safe and the project will be set in advanced mode. Please continue if you are sure you want to have your project in advanced mode.",
-        "oDataURIV2InfoLabel": "Have in mind that you are trying to replace OData {{versionOne}} Service with OData {{versionTwo}} Service"
+        "addAnnotationOdataSourceTooltip": "Select the annotation file from your workspace",
+        "fileSelectOptionLabel": "Annotation XML",
+        "fileSelectOptionTooltip": "Select the annotation file source",
+        "filePathLabel": "Annotation File path",
+        "filePathTooltip": "Select the annotation file from your workspace"
+    },
+    "choices": {
+        "annotationFile": {
+            "selectFromWorkspace": "Select annotation file from workspace",
+            "createEmptyFile": "Create an empty annotation file"
+        }
     },
     "validators": {
-        "manifestContainsNoODataServices": "Manifest contains no OData Services.",
-        "inputCannotBeEmpty": "{{input}} cannot be empty.",
-        "inpuCannotHaveSpaces": "{{input}} cannot contain spaces."
+        "inputCannotBeEmpty": "Input cannot be empty.",
+        "fileDoesNotExist": "The file doesn't exist",
+        "annotationFileAlreadyExists": "There is already an annotation file with the same name, please choose another file or rename the file and select it again"
     }
 }

package/dist/types.d.ts

@@ -172,9 +172,11 @@ export interface CodeExtChange extends CommonChangeProperties {
         controllerName: string;
     };
 }
+export declare const CUSTOMER_BASE = "CUSTOMER_BASE";
 export declare const enum TemplateFileName {
     Fragment = "fragment.xml",
-    Controller = "controller.ejs"
+    Controller = "controller.ejs",
+    Annotation = "annotation.xml"
 }
 export declare const enum HttpStatusCodes {
     OK = 200,
@@ -238,18 +240,13 @@ export declare const enum ChangeType {
  */
 export type GeneratorData<T extends ChangeType> = T extends ChangeType.ADD_ANNOTATIONS_TO_ODATA ? AnnotationsData : T extends ChangeType.ADD_COMPONENT_USAGES ? ComponentUsagesData : T extends ChangeType.ADD_LIBRARY_REFERENCE ? ComponentUsagesData : T extends ChangeType.ADD_NEW_MODEL ? NewModelData : T extends ChangeType.CHANGE_DATA_SOURCE ? DataSourceData : T extends ChangeType.CHANGE_INBOUND ? InboundData : never;
 export interface AnnotationsData {
-    projectData: AdpProjectData;
-    timestamp: number;
-    /** Indicates whether the annotation is for internal use only. */
-    isInternalUsage: boolean;
-    annotation: {
-        /** Optional name of the annotation file. */
-        fileName?: string;
-        /** Data source associated with the annotation. */
-        dataSource: string;
-        /** Path to the annotation file. */
-        filePath: string;
-    };
+    fileName?: string;
+    variant: DescriptorVariant;
+    answers: AddAnnotationsAnswers;
+}
+export declare const enum AnnotationFileSelectType {
+    ExistingFile = 1,
+    NewEmptyFile = 2
 }
 export interface ComponentUsagesData {
     projectData: AdpProjectData;
@@ -359,6 +356,14 @@ export interface ChangeDataSourceAnswers {
     /** Data Source Annotation URI */
     annotationUri?: string;
 }
+export interface AddAnnotationsAnswers {
+    /** Data Source identifier  */
+    id: string;
+    /** Selected option for Annotation File */
+    fileSelectOption: number;
+    /** Annotation File path */
+    filePath?: string;
+}
 export type DataSource = ManifestNamespace.DataSource & {
     dataSourceName: string;
     annotations: string[];

package/dist/types.js

@@ -1,3 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.CUSTOMER_BASE = void 0;
+exports.CUSTOMER_BASE = 'CUSTOMER_BASE';
 //# sourceMappingURL=types.js.map

package/dist/writer/changes/writers/annotations-writer.d.ts

@@ -1,5 +1,5 @@
 import type { Editor } from 'mem-fs-editor';
-import type { IWriter, AnnotationsData } from '../../../types';
+import { type IWriter, type AnnotationsData } from '../../../types';
 /**
  * Handles the creation and writing of annotations data changes for a project.
  */

package/dist/writer/changes/writers/annotations-writer.js

@@ -1,10 +1,31 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AnnotationsWriter = void 0;
-const path_1 = __importDefault(require("path"));
+const path_1 = __importStar(require("path"));
+const types_1 = require("../../../types");
 const change_utils_1 = require("../../../base/change-utils");
 /**
  * Handles the creation and writing of annotations data changes for a project.
@@ -27,13 +48,13 @@ class AnnotationsWriter {
      * @returns {object} The constructed content object for the annotation change.
      */
     constructContent(data) {
-        const { isInternalUsage, annotation: { dataSource, fileName } } = data;
+        const { variant: { layer }, fileName, answers: { id } } = data;
         const annotationFileNameWithoutExtension = fileName?.toLocaleLowerCase().replace('.xml', '');
-        const annotationNameSpace = isInternalUsage
-            ? `annotation.${annotationFileNameWithoutExtension}`
-            : `customer.annotation.${annotationFileNameWithoutExtension}`;
+        const annotationNameSpace = layer === types_1.CUSTOMER_BASE
+            ? `customer.annotation.${annotationFileNameWithoutExtension}`
+            : `annotation.${annotationFileNameWithoutExtension}`;
         return {
-            dataSourceId: `${dataSource}`,
+            dataSourceId: `${id}`,
             annotations: [annotationNameSpace],
             annotationsInsertPosition: 'END',
             dataSource: {
@@ -50,8 +71,8 @@ class AnnotationsWriter {
      * @param {AnnotationsData} data - The answers object containing user choices.
      * @returns {string | undefined} The determined filename for the annotation file.
      */
-    getAnnotationFileName({ annotation }) {
-        return annotation.filePath ? path_1.default.basename(annotation.filePath) : `annotation_${Date.now()}.xml`;
+    getAnnotationFileName({ answers }) {
+        return answers.filePath ? path_1.default.basename(answers.filePath) : `annotation_${Date.now()}.xml`;
     }
     /**
      * Writes the annotation change to the project based on the provided data.
@@ -60,10 +81,17 @@ class AnnotationsWriter {
      * @returns {Promise<void>} A promise that resolves when the change writing process is completed.
      */
     async write(data) {
-        data.annotation.fileName = this.getAnnotationFileName(data);
+        const { variant } = data;
+        data.fileName = this.getAnnotationFileName(data);
+        if (data.answers.filePath) {
+            data.answers.filePath = (0, path_1.isAbsolute)(data.answers.filePath)
+                ? data.answers.filePath
+                : path_1.default.join(this.projectPath, data.answers.filePath);
+        }
         const content = this.constructContent(data);
-        const change = (0, change_utils_1.getChange)(data.projectData, data.timestamp, content, "appdescr_app_addAnnotationsToOData" /* ChangeType.ADD_ANNOTATIONS_TO_ODATA */);
-        (0, change_utils_1.writeAnnotationChange)(this.projectPath, data, change, this.fs);
+        const timestamp = Date.now();
+        const change = (0, change_utils_1.getChange)(variant, timestamp, content, "appdescr_app_addAnnotationsToOData" /* ChangeType.ADD_ANNOTATIONS_TO_ODATA */);
+        (0, change_utils_1.writeAnnotationChange)(this.projectPath, timestamp, data, change, this.fs);
     }
 }
 exports.AnnotationsWriter = AnnotationsWriter;

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.12.12",
+  "version": "0.12.13",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",

package/templates/changes/annotation.xml

@@ -0,0 +1,15 @@
+<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">
+    <edmx:Reference Uri="https://sap.github.io/odata-vocabularies/vocabularies/Common.xml">
+        <edmx:Include Namespace="com.sap.vocabularies.Common.v1" Alias="Common"/>
+    </edmx:Reference>
+    <edmx:Reference Uri="https://sap.github.io/odata-vocabularies/vocabularies/UI.xml">
+        <edmx:Include Namespace="com.sap.vocabularies.UI.v1" Alias="UI"/>
+    </edmx:Reference>
+    <edmx:Reference Uri="https://sap.github.io/odata-vocabularies/vocabularies/Communication.xml">
+        <edmx:Include Namespace="com.sap.vocabularies.Communication.v1" Alias="Communication"/>
+    </edmx:Reference>
+    <edmx:DataServices>
+        <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="local">
+        </Schema>
+    </edmx:DataServices>
+</edmx:Edmx>