@sap-ux/adp-tooling 0.12.104 → 0.12.105

package/dist/base/abap/manifest-service.d.ts

@@ -2,7 +2,7 @@ import type { ToolsLogger } from '@sap-ux/logger';
 import type { Manifest, ManifestNamespace } from '@sap-ux/project-access';
 import { type AbapServiceProvider } from '@sap-ux/axios-extension';
 import type { DescriptorVariant } from '../../types';
-type DataSources = Record<string, ManifestNamespace.DataSource>;
+export type DataSources = Record<string, ManifestNamespace.DataSource>;
 /**
  * Retrieves the inbound navigation configurations from the project's manifest.
  *
@@ -99,5 +99,4 @@ export declare class ManifestService {
      */
     getDataSourceMetadata(dataSourceId: string): Promise<string>;
 }
-export {};
 //# sourceMappingURL=manifest-service.d.ts.map

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

@@ -18,7 +18,7 @@ interface InboundChange extends ManifestChangeProperties {
  * @param {Editor} fs - The `mem-fs-editor` instance used for file operations.
  * @returns {void}
  */
-export declare function writeAnnotationChange(projectPath: string, timestamp: number, annotation: AnnotationsData['annotation'], change: ManifestChangeProperties, fs: Editor): void;
+export declare function writeAnnotationChange(projectPath: string, timestamp: number, annotation: AnnotationsData['annotation'], change: ManifestChangeProperties | undefined, 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

@@ -27,11 +27,14 @@ const ejs_1 = require("ejs");
  */
 function writeAnnotationChange(projectPath, timestamp, annotation, change, fs) {
     try {
-        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, changeFileName);
         const annotationsFolderPath = path_1.default.join(changesFolderPath, project_access_1.DirName.Annotations);
-        writeChangeToFile(changeFilePath, change, fs);
+        if (change) {
+            const changeFileName = `id_${timestamp}_addAnnotationsToOData.change`;
+            const changeFilePath = path_1.default.join(changesFolderPath, changeFileName);
+            change.fileName = `${change.fileName}_addAnnotationsToOData`;
+            writeChangeToFile(changeFilePath, change, fs);
+        }
         if (!annotation.filePath) {
             const annotationsTemplate = path_1.default.join(__dirname, '..', '..', 'templates', 'changes', "annotation.xml" /* TemplateFileName.Annotation */);
             const { namespaces, serviceUrl } = annotation;

package/dist/preview/adp-preview.d.ts

@@ -12,7 +12,8 @@ declare global {
 export declare const enum ApiRoutes {
     FRAGMENT = "/adp/api/fragment",
     CONTROLLER = "/adp/api/controller",
-    CODE_EXT = "/adp/api/code_ext/:controllerName"
+    CODE_EXT = "/adp/api/code_ext/:controllerName",
+    ANNOTATION = "/adp/api/annotation"
 }
 /**
  * Instance of an adaptation project handling requests and data transformation.

package/dist/preview/adp-preview.js

@@ -171,6 +171,8 @@ class AdpPreview {
         router.get("/adp/api/controller" /* ApiRoutes.CONTROLLER */, this.routesHandler.handleReadAllControllers);
         router.post("/adp/api/controller" /* ApiRoutes.CONTROLLER */, this.routesHandler.handleWriteControllerExt);
         router.get("/adp/api/code_ext/:controllerName" /* ApiRoutes.CODE_EXT */, this.routesHandler.handleGetControllerExtensionData);
+        router.post("/adp/api/annotation" /* ApiRoutes.ANNOTATION */, this.routesHandler.handleCreateAnnotationFile);
+        router.get("/adp/api/annotation" /* ApiRoutes.ANNOTATION */, this.routesHandler.handleGetAllAnnotationFilesMappedByDataSource);
     }
     /**
      * Handles different types of change requests to project files.
@@ -192,6 +194,9 @@ class AdpPreview {
                 if ((0, change_handler_1.isAddXMLChange)(change)) {
                     (0, change_handler_1.addXmlFragment)(this.util.getProject().getSourcePath(), change, fs, logger);
                 }
+                if ((0, change_handler_1.isAddAnnotationChange)(change)) {
+                    await (0, change_handler_1.addAnnotationFile)(this.util.getProject().getSourcePath(), this.util.getProject().getRootPath(), change, fs, logger);
+                }
                 break;
             default:
                 // no need to handle delete changes

package/dist/preview/change-handler.d.ts

@@ -1,5 +1,5 @@
 import type { Editor } from 'mem-fs-editor';
-import type { AddXMLChange, CommonChangeProperties } from '../types';
+import type { AddXMLChange, CommonChangeProperties, AnnotationFileChange } from '../types';
 import type { Logger } from '@sap-ux/logger';
 /**
  * A mapping object that defines how to extract change content data from changes based on their type.
@@ -29,6 +29,14 @@ export declare function tryFixChange(change: CommonChangeProperties, logger: Log
  *          indicating the change is of type `AddXMLChange`.
  */
 export declare function isAddXMLChange(change: CommonChangeProperties): change is AddXMLChange;
+/**
+ * Determines whether a given change is of type `AnnotationFileChange`.
+ *
+ * @param {CommonChangeProperties} change - The change object to check.
+ * @returns {boolean} `true` if the `changeType` is either 'appdescr_app_addAnnotationsToOData',
+ *          indicating the change is of type `AnnotationFileChange`.
+ */
+export declare function isAddAnnotationChange(change: CommonChangeProperties): change is AnnotationFileChange;
 /**
  * Asynchronously adds an XML fragment to the project if it doesn't already exist.
  *
@@ -38,4 +46,14 @@ export declare function isAddXMLChange(change: CommonChangeProperties): change i
  * @param {Logger} logger - The logging instance.
  */
 export declare function addXmlFragment(basePath: string, change: AddXMLChange, fs: Editor, logger: Logger): void;
+/**
+ * Asynchronously adds an XML fragment to the project if it doesn't already exist.
+ *
+ * @param {string} basePath - The base path of the project.
+ * @param {string} projectRoot - The root path of the project.
+ * @param {AddXMLChange} change - The change data, including the fragment path.
+ * @param {Editor} fs - The mem-fs-editor instance.
+ * @param {Logger} logger - The logging instance.
+ */
+export declare function addAnnotationFile(basePath: string, projectRoot: string, change: AnnotationFileChange, fs: Editor, logger: Logger): Promise<void>;
 //# sourceMappingURL=change-handler.d.ts.map

package/dist/preview/change-handler.js

@@ -3,11 +3,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.moduleNameContentMap = void 0;
 exports.tryFixChange = tryFixChange;
 exports.isAddXMLChange = isAddXMLChange;
+exports.isAddAnnotationChange = isAddAnnotationChange;
 exports.addXmlFragment = addXmlFragment;
+exports.addAnnotationFile = addAnnotationFile;
 const path_1 = require("path");
 const project_access_1 = require("@sap-ux/project-access");
 const ejs_1 = require("ejs");
 const crypto_1 = require("crypto");
+const manifest_service_1 = require("../base/abap/manifest-service");
+const helper_1 = require("../base/helper");
+const system_access_1 = require("@sap-ux/system-access");
+const odata_service_writer_1 = require("@sap-ux/odata-service-writer");
+const editors_1 = require("../writer/editors");
 const OBJECT_PAGE_CUSTOM_SECTION = 'OBJECT_PAGE_CUSTOM_SECTION';
 const CUSTOM_ACTION = 'CUSTOM_ACTION';
 const OBJECT_PAGE_HEADER_FIELD = 'OBJECT_PAGE_HEADER_FIELD';
@@ -156,6 +163,16 @@ function tryFixChange(change, logger) {
 function isAddXMLChange(change) {
     return change.changeType === 'addXML' || change.changeType === 'addXMLAtExtensionPoint';
 }
+/**
+ * Determines whether a given change is of type `AnnotationFileChange`.
+ *
+ * @param {CommonChangeProperties} change - The change object to check.
+ * @returns {boolean} `true` if the `changeType` is either 'appdescr_app_addAnnotationsToOData',
+ *          indicating the change is of type `AnnotationFileChange`.
+ */
+function isAddAnnotationChange(change) {
+    return change.changeType === 'appdescr_app_addAnnotationsToOData';
+}
 /**
  * Asynchronously adds an XML fragment to the project if it doesn't already exist.
  *
@@ -187,4 +204,52 @@ function addXmlFragment(basePath, change, fs, logger) {
         logger.error(`Failed to create XML Fragment "${fragmentPath}": ${error}`);
     }
 }
+/**
+ * Asynchronously adds an XML fragment to the project if it doesn't already exist.
+ *
+ * @param {string} basePath - The base path of the project.
+ * @param {string} projectRoot - The root path of the project.
+ * @param {AddXMLChange} change - The change data, including the fragment path.
+ * @param {Editor} fs - The mem-fs-editor instance.
+ * @param {Logger} logger - The logging instance.
+ */
+async function addAnnotationFile(basePath, projectRoot, change, fs, logger) {
+    const { dataSourceId, annotations, dataSource } = change.content;
+    const annotationDataSourceKey = annotations[0];
+    const annotationUriSegments = dataSource[annotationDataSourceKey].uri.split('/');
+    annotationUriSegments.shift();
+    const fullPath = (0, path_1.join)(basePath, project_access_1.DirName.Changes, ...annotationUriSegments);
+    try {
+        const manifestService = await getManifestService(projectRoot, logger);
+        const metadata = await manifestService.getDataSourceMetadata(dataSourceId);
+        const datasoruces = await manifestService.getManifestDataSources();
+        const namespaces = (0, odata_service_writer_1.getAnnotationNamespaces)({ metadata });
+        await (0, editors_1.generateChange)(projectRoot, "appdescr_app_addAnnotationsToOData" /* ChangeType.ADD_ANNOTATIONS_TO_ODATA */, {
+            annotation: {
+                dataSource: dataSourceId,
+                namespaces,
+                serviceUrl: datasoruces[dataSourceId].uri,
+                fileName: (0, path_1.basename)(dataSource[annotationDataSourceKey].uri)
+            },
+            variant: (0, helper_1.getVariant)(projectRoot),
+            isCommand: false
+        }, fs);
+    }
+    catch (error) {
+        logger.error(`Failed to create Local Annotation File "${fullPath}": ${error}`);
+    }
+}
+/**
+ * Returns manifest service.
+ *
+ * @param {string} basePath - The base path of the project.
+ * @param {Logger} logger - The logging instance.
+ * @returns Promise<ManifestService>
+ */
+async function getManifestService(basePath, logger) {
+    const variant = (0, helper_1.getVariant)(basePath);
+    const { target, ignoreCertErrors = false } = await (0, helper_1.getAdpConfig)(basePath, (0, path_1.join)(basePath, project_access_1.FileName.Ui5Yaml));
+    const provider = await (0, system_access_1.createAbapServiceProvider)(target, { ignoreCertErrors }, true, logger);
+    return await manifest_service_1.ManifestService.initMergedManifest(provider, basePath, variant, logger);
+}
 //# sourceMappingURL=change-handler.js.map

package/dist/preview/routes-handler.d.ts

@@ -73,5 +73,35 @@ export default class RoutesHandler {
      * @param next Next Function
      */
     handleWriteControllerExt: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    /**
+     * Handler for writing an annotation file to the workspace.
+     *
+     * @param req Request
+     * @param res Response
+     * @param next Next Function
+     */
+    handleCreateAnnotationFile: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    /**
+     * Handler for mapping annotation files with datasoruce.
+     *
+     * @param _req Request
+     * @param res Response
+     * @param next Next Function
+     */
+    handleGetAllAnnotationFilesMappedByDataSource: (_req: Request, res: Response, next: NextFunction) => Promise<void>;
+    /**
+     * Add local annotation details to api response.
+     *
+     * @param dataSources DataSources
+     * @param dataSourceId string
+     * @param apiResponse AnnotationDataSourceMap
+     */
+    private fillAnnotationDataSourceMap;
+    /**
+     * Returns manifest service.
+     *
+     * @returns Promise<ManifestService>
+     */
+    private getManifestService;
 }
 //# sourceMappingURL=routes-handler.d.ts.map

package/dist/preview/routes-handler.js

@@ -33,6 +33,11 @@ const ejs_1 = require("ejs");
 const sanitize_filename_1 = __importDefault(require("sanitize-filename"));
 const btp_utils_1 = require("@sap-ux/btp-utils");
 const project_access_1 = require("@sap-ux/project-access");
+const editors_1 = require("../writer/editors");
+const manifest_service_1 = require("../base/abap/manifest-service");
+const helper_1 = require("../base/helper");
+const odata_service_writer_1 = require("@sap-ux/odata-service-writer");
+const system_access_1 = require("@sap-ux/system-access");
 /**
  * @description Handles API Routes
  */
@@ -231,6 +236,125 @@ class RoutesHandler {
             next(e);
         }
     };
+    /**
+     * Handler for writing an annotation file to the workspace.
+     *
+     * @param req Request
+     * @param res Response
+     * @param next Next Function
+     */
+    handleCreateAnnotationFile = async (req, res, next) => {
+        try {
+            const { dataSource, serviceUrl } = req.body;
+            if (!dataSource) {
+                res.status(400 /* HttpStatusCodes.BAD_REQUEST */).send('No datasource found in manifest!');
+                this.logger.debug('Bad request. Could not find a datasource in manifest!');
+                return;
+            }
+            const project = this.util.getProject();
+            const projectRoot = project.getRootPath();
+            const manifestService = await this.getManifestService();
+            const metadata = await manifestService.getDataSourceMetadata(dataSource);
+            const namespaces = (0, odata_service_writer_1.getAnnotationNamespaces)({ metadata });
+            const fsEditor = await (0, editors_1.generateChange)(projectRoot, "appdescr_app_addAnnotationsToOData" /* ChangeType.ADD_ANNOTATIONS_TO_ODATA */, {
+                annotation: {
+                    dataSource,
+                    namespaces,
+                    serviceUrl: serviceUrl
+                },
+                variant: (0, helper_1.getVariant)(projectRoot),
+                isCommand: false
+            });
+            fsEditor.commit((err) => this.logger.error(err));
+            const message = 'Annotation file created!';
+            res.status(201 /* HttpStatusCodes.CREATED */).send(message);
+        }
+        catch (e) {
+            const sanitizedMsg = (0, sanitize_filename_1.default)(e.message);
+            this.logger.error(sanitizedMsg);
+            res.status(500 /* HttpStatusCodes.INTERNAL_SERVER_ERROR */).send(sanitizedMsg);
+            next(e);
+        }
+    };
+    /**
+     * Handler for mapping annotation files with datasoruce.
+     *
+     * @param _req Request
+     * @param res Response
+     * @param next Next Function
+     */
+    handleGetAllAnnotationFilesMappedByDataSource = async (_req, res, next) => {
+        try {
+            const isRunningInBAS = (0, btp_utils_1.isAppStudio)();
+            const manifestService = await this.getManifestService();
+            const dataSources = manifestService.getManifestDataSources();
+            const apiResponse = {};
+            for (const dataSourceId in dataSources) {
+                if (dataSources[dataSourceId].type === 'OData') {
+                    apiResponse[dataSourceId] = {
+                        annotationDetails: {
+                            annotationExistsInWS: false
+                        },
+                        serviceUrl: dataSources[dataSourceId].uri,
+                        isRunningInBAS: isRunningInBAS
+                    };
+                }
+                this.fillAnnotationDataSourceMap(dataSources, dataSourceId, apiResponse);
+            }
+            this.sendFilesResponse(res, apiResponse);
+        }
+        catch (e) {
+            this.handleErrorMessage(res, next, e);
+        }
+    };
+    /**
+     * Add local annotation details to api response.
+     *
+     * @param dataSources DataSources
+     * @param dataSourceId string
+     * @param apiResponse AnnotationDataSourceMap
+     */
+    fillAnnotationDataSourceMap(dataSources, dataSourceId, apiResponse) {
+        const project = this.util.getProject();
+        const getPath = (projectPath, relativePath) => path.join(projectPath, project_access_1.DirName.Changes, relativePath).split(path.sep).join(path.posix.sep);
+        const annotations = dataSources[dataSourceId].settings?.annotations
+            ? [...dataSources[dataSourceId].settings.annotations].reverse()
+            : [];
+        for (const annotation of annotations) {
+            const annotationSetting = dataSources[annotation];
+            if (annotationSetting.type === 'ODataAnnotation') {
+                const ui5NamespaceUri = `ui5://${project.getNamespace()}`;
+                if (annotationSetting.uri.startsWith(ui5NamespaceUri)) {
+                    const localAnnotationUri = annotationSetting.uri.replace(ui5NamespaceUri, '');
+                    const annotationPath = getPath(project.getSourcePath(), localAnnotationUri);
+                    const annotationPathFromRoot = getPath(project.getName(), localAnnotationUri);
+                    const annotationExists = fs.existsSync(annotationPath);
+                    apiResponse[dataSourceId].annotationDetails = {
+                        fileName: path.parse(localAnnotationUri).base,
+                        annotationPath: os.platform() === 'win32' ? `/${annotationPath}` : annotationPath,
+                        annotationPathFromRoot,
+                        annotationExistsInWS: annotationExists
+                    };
+                }
+                if (apiResponse[dataSourceId].annotationDetails.annotationExistsInWS) {
+                    break;
+                }
+            }
+        }
+    }
+    /**
+     * Returns manifest service.
+     *
+     * @returns Promise<ManifestService>
+     */
+    async getManifestService() {
+        const project = this.util.getProject();
+        const basePath = project.getRootPath();
+        const variant = (0, helper_1.getVariant)(basePath);
+        const { target, ignoreCertErrors = false } = await (0, helper_1.getAdpConfig)(basePath, path.join(basePath, project_access_1.FileName.Ui5Yaml));
+        const provider = await (0, system_access_1.createAbapServiceProvider)(target, { ignoreCertErrors }, true, this.logger);
+        return await manifest_service_1.ManifestService.initMergedManifest(provider, basePath, variant, this.logger);
+    }
 }
 exports.default = RoutesHandler;
 //# sourceMappingURL=routes-handler.js.map

package/dist/types.d.ts

@@ -181,6 +181,21 @@ export interface CodeExtChange extends CommonChangeProperties {
         controllerName: string;
     };
 }
+export interface AnnotationFileChange extends CommonChangeProperties {
+    changeType: 'appdescr_app_addAnnotationsToOData';
+    creation: string;
+    content: {
+        dataSourceId: string;
+        annotations: string[];
+        annotationsInsertPosition: 'END';
+        dataSource: {
+            [fileName: string]: {
+                uri: string;
+                type: 'ODataAnnotation';
+            };
+        };
+    };
+}
 export interface ParamCheck {
     shouldApply: boolean;
     value: string | undefined;
@@ -311,6 +326,8 @@ 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 {
     variant: DescriptorVariant;
+    /** Flag for differentiating the annotation creation call from CLI and from CPE */
+    isCommand: boolean;
     annotation: {
         /** Optional name of the annotation file. */
         fileName?: string;

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

@@ -89,7 +89,11 @@ class AnnotationsWriter {
         }
         const content = this.constructContent(data);
         const timestamp = Date.now();
-        const change = (0, change_utils_1.getChange)(variant, timestamp, content, "appdescr_app_addAnnotationsToOData" /* ChangeType.ADD_ANNOTATIONS_TO_ODATA */);
+        let change;
+        // When created via command change need to be created else change is created via RTA.
+        if (data.isCommand) {
+            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.annotation, change, this.fs);
     }
 }

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.104",
+  "version": "0.12.105",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -40,6 +40,7 @@
     "@sap-ux/project-input-validator": "0.3.4",
     "@sap-ux/system-access": "0.5.25",
     "@sap-ux/ui5-config": "0.26.0",
+    "@sap-ux/odata-service-writer": "0.25.1",
     "@sap-ux/i18n": "0.2.0"
   },
   "devDependencies": {