@sap-ux/adp-tooling 0.12.76 → 0.12.78

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

@@ -0,0 +1,96 @@
+import type { Manifest, ManifestNamespace } from '@sap-ux/project-access';
+import type { ToolsLogger } from '@sap-ux/logger';
+import type { AdpPreviewConfig, DescriptorVariant } from '../../types';
+type DataSources = Record<string, ManifestNamespace.DataSource>;
+/**
+ * Service class for handling operations related to the manifest of a UI5 application.
+ * The class supports operations for both base and merged manifests.
+ * It provides methods to fetch the manifest, data sources and metadata of a data source.
+ *
+ */
+export declare class ManifestService {
+    private readonly provider;
+    private readonly logger;
+    private manifest;
+    private appInfo;
+    /**
+     * Private constructor to initialize the ManifestService.
+     *
+     * @param provider - The ABAP service provider.
+     * @param logger - The logger instance.
+     */
+    private constructor();
+    /**
+     * Initializes the ManifestService with the given ADP configuration and logger.
+     *
+     * @param adpConfig - The ADP preview configuration.
+     * @param logger - The logger instance.
+     * @returns A promise that resolves to an instance of ManifestService.
+     */
+    private static init;
+    /**
+     * Creates an instance of the ManifestService and fetches the base manifest of the application.
+     *
+     * @param appId - The application ID.
+     * @param adpConfig - The ADP preview configuration.
+     * @param logger - The logger instance.
+     * @returns A promise that resolves to an instance of ManifestService.
+     */
+    static initBaseManifest(appId: string, adpConfig: AdpPreviewConfig, logger: ToolsLogger): Promise<ManifestService>;
+    /**
+     * Creates an instance of the ManifestService and fetches the merged manifest of the application.
+     *
+     * @param basePath - The base path of the application.
+     * @param variant - The descriptor variant.
+     * @param adpConfig - The ADP preview configuration.
+     * @param logger - The logger instance.
+     * @returns A promise that resolves to an instance of ManifestService.
+     */
+    static initMergedManifest(basePath: string, variant: DescriptorVariant, adpConfig: AdpPreviewConfig, logger: ToolsLogger): Promise<ManifestService>;
+    /**
+     * Fetches the base manifest for a given application ID.
+     *
+     * @param appId - The application ID.
+     * @returns A promise that resolves when the base manifest is fetched.
+     * @throws Error if the manifest URL is not found or fetching/parsing fails.
+     */
+    private fetchBaseManifest;
+    /**
+     * Fetches the application information for a given application ID.
+     *
+     * @param appId - The application ID.
+     * @returns A promise that resolves when the application information is fetched.
+     */
+    private fetchAppInfo;
+    /**
+     * Returns the manifest fetched by the service during initialization.
+     *
+     * @returns The current manifest.
+     */
+    getManifest(): Manifest;
+    /**
+     * Fetches the merged manifest for a given application.
+     *
+     * @param basePath - The base path of the application.
+     * @param descriptorVariantId - The descriptor variant ID.
+     * @returns A promise that resolves to the merged manifest.
+     */
+    private fetchMergedManifest;
+    /**
+     * Returns the data sources from the manifest.
+     *
+     * @returns The data sources from the manifest.
+     * @throws Error if no data sources are found in the manifest.
+     */
+    getManifestDataSources(): DataSources;
+    /**
+     * Returns the metadata of a data source.
+     *
+     * @param dataSourceId - The ID of the data source.
+     * @returns A promise that resolves to the metadata of the data source.
+     * @throws Error if no metadata path is found in the manifest or fetching fails.
+     */
+    getDataSourceMetadata(dataSourceId: string): Promise<string>;
+}
+export {};
+//# sourceMappingURL=manifest-service.d.ts.map

package/dist/base/abap/manifest-service.js

@@ -0,0 +1,187 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ManifestService = void 0;
+const adm_zip_1 = __importDefault(require("adm-zip"));
+const axios_extension_1 = require("@sap-ux/axios-extension");
+const system_access_1 = require("@sap-ux/system-access");
+const helper_1 = require("../helper");
+/**
+ * Service class for handling operations related to the manifest of a UI5 application.
+ * The class supports operations for both base and merged manifests.
+ * It provides methods to fetch the manifest, data sources and metadata of a data source.
+ *
+ */
+class ManifestService {
+    provider;
+    logger;
+    manifest;
+    appInfo;
+    /**
+     * Private constructor to initialize the ManifestService.
+     *
+     * @param provider - The ABAP service provider.
+     * @param logger - The logger instance.
+     */
+    constructor(provider, logger) {
+        this.provider = provider;
+        this.logger = logger;
+    }
+    /**
+     * Initializes the ManifestService with the given ADP configuration and logger.
+     *
+     * @param adpConfig - The ADP preview configuration.
+     * @param logger - The logger instance.
+     * @returns A promise that resolves to an instance of ManifestService.
+     */
+    static async init(adpConfig, logger) {
+        const provider = await (0, system_access_1.createAbapServiceProvider)(adpConfig.target, {
+            ignoreCertErrors: adpConfig.ignoreCertErrors ?? false
+        }, true, logger);
+        return new ManifestService(provider, logger);
+    }
+    /**
+     * Creates an instance of the ManifestService and fetches the base manifest of the application.
+     *
+     * @param appId - The application ID.
+     * @param adpConfig - The ADP preview configuration.
+     * @param logger - The logger instance.
+     * @returns A promise that resolves to an instance of ManifestService.
+     */
+    static async initBaseManifest(appId, adpConfig, logger) {
+        const manifestService = await this.init(adpConfig, logger);
+        await manifestService.fetchBaseManifest(appId);
+        return manifestService;
+    }
+    /**
+     * Creates an instance of the ManifestService and fetches the merged manifest of the application.
+     *
+     * @param basePath - The base path of the application.
+     * @param variant - The descriptor variant.
+     * @param adpConfig - The ADP preview configuration.
+     * @param logger - The logger instance.
+     * @returns A promise that resolves to an instance of ManifestService.
+     */
+    static async initMergedManifest(basePath, variant, adpConfig, logger) {
+        const manifestService = await this.init(adpConfig, logger);
+        await manifestService.fetchMergedManifest(basePath, variant.id);
+        await manifestService.fetchAppInfo(variant.reference);
+        return manifestService;
+    }
+    /**
+     * Fetches the base manifest for a given application ID.
+     *
+     * @param appId - The application ID.
+     * @returns A promise that resolves when the base manifest is fetched.
+     * @throws Error if the manifest URL is not found or fetching/parsing fails.
+     */
+    async fetchBaseManifest(appId) {
+        await this.fetchAppInfo(appId);
+        const manifestUrl = this.appInfo.manifestUrl ?? this.appInfo.manifest;
+        if (!manifestUrl) {
+            throw new Error('Manifest URL not found');
+        }
+        try {
+            const response = await this.provider.get(manifestUrl);
+            this.manifest = JSON.parse(response.data);
+        }
+        catch (error) {
+            if ((0, axios_extension_1.isAxiosError)(error)) {
+                this.logger.error('Manifest fetching failed');
+            }
+            else {
+                this.logger.error('Manifest parsing error: Manifest is not in expected format.');
+            }
+            this.logger.debug(error);
+            throw error;
+        }
+    }
+    /**
+     * Fetches the application information for a given application ID.
+     *
+     * @param appId - The application ID.
+     * @returns A promise that resolves when the application information is fetched.
+     */
+    async fetchAppInfo(appId) {
+        this.appInfo = (await this.provider.getAppIndex().getAppInfo(appId))[appId];
+    }
+    /**
+     * Returns the manifest fetched by the service during initialization.
+     *
+     * @returns The current manifest.
+     */
+    getManifest() {
+        return this.manifest;
+    }
+    /**
+     * Fetches the merged manifest for a given application.
+     *
+     * @param basePath - The base path of the application.
+     * @param descriptorVariantId - The descriptor variant ID.
+     * @returns A promise that resolves to the merged manifest.
+     */
+    async fetchMergedManifest(basePath, descriptorVariantId) {
+        const zip = new adm_zip_1.default();
+        const files = (0, helper_1.getWebappFiles)(basePath);
+        for (const file of files) {
+            zip.addFile(file.relativePath, Buffer.from(file.content, 'utf-8'));
+        }
+        const buffer = zip.toBuffer();
+        const lrep = this.provider.getLayeredRepository();
+        await lrep.getCsrfToken();
+        const response = await lrep.mergeAppDescriptorVariant(buffer);
+        this.manifest = response[descriptorVariantId].manifest;
+    }
+    /**
+     * Returns the data sources from the manifest.
+     *
+     * @returns The data sources from the manifest.
+     * @throws Error if no data sources are found in the manifest.
+     */
+    getManifestDataSources() {
+        const dataSources = this.manifest['sap.app'].dataSources;
+        if (!dataSources) {
+            throw new Error('No data sources found in the manifest');
+        }
+        return dataSources;
+    }
+    /**
+     * Returns the metadata of a data source.
+     *
+     * @param dataSourceId - The ID of the data source.
+     * @returns A promise that resolves to the metadata of the data source.
+     * @throws Error if no metadata path is found in the manifest or fetching fails.
+     */
+    async getDataSourceMetadata(dataSourceId) {
+        const dataSource = this.manifest?.['sap.app']?.dataSources?.[dataSourceId];
+        if (!dataSource) {
+            throw new Error('No metadata path found in the manifest');
+        }
+        const baseUrl = new URL(this.appInfo.url, this.provider.defaults.baseURL);
+        const metadataUrl = new URL(`${dataSource.uri}$metadata`, baseUrl.toString());
+        try {
+            const response = await this.provider.get(metadataUrl.toString());
+            return response.data;
+        }
+        catch (error) {
+            if (dataSource?.settings?.localUri) {
+                this.logger.warn('Metadata fetching failed. Fallback to local metadata');
+                try {
+                    const fallbackUrl = new URL(dataSource?.settings.localUri, `${baseUrl.toString().endsWith('/') ? baseUrl.toString() : baseUrl.toString() + '/'}`);
+                    const response = await this.provider.get(fallbackUrl.toString());
+                    return response.data;
+                }
+                catch (fallbackError) {
+                    this.logger.error('Local metadata fallback fetching failed');
+                    throw fallbackError;
+                }
+            }
+            this.logger.error('Metadata fetching failed');
+            throw error;
+        }
+    }
+}
+exports.ManifestService = ManifestService;
+//# sourceMappingURL=manifest-service.js.map

package/dist/base/change-utils.js

@@ -14,6 +14,7 @@ exports.getChange = getChange;
 const path_1 = __importDefault(require("path"));
 const fs_1 = require("fs");
 const project_access_1 = require("@sap-ux/project-access");
+const ejs_1 = require("ejs");
 /**
  * Writes annotation changes to the specified project path using the provided `mem-fs-editor` instance.
  *
@@ -33,7 +34,13 @@ function writeAnnotationChange(projectPath, timestamp, annotation, change, fs) {
         writeChangeToFile(changeFilePath, change, fs);
         if (!annotation.filePath) {
             const annotationsTemplate = path_1.default.join(__dirname, '..', '..', 'templates', 'changes', "annotation.xml" /* TemplateFileName.Annotation */);
-            fs.copy(annotationsTemplate, path_1.default.join(annotationsFolderPath, annotation.fileName ?? ''));
+            const { namespaces, serviceUrl } = annotation;
+            (0, ejs_1.renderFile)(annotationsTemplate, { namespaces, path: serviceUrl }, {}, (err, str) => {
+                if (err) {
+                    throw new Error('Error rendering template: ' + err.message);
+                }
+                fs.write(path_1.default.join(annotationsFolderPath, annotation.fileName ?? ''), str);
+            });
         }
         else {
             const selectedDir = path_1.default.dirname(annotation.filePath);

package/dist/base/helper.d.ts

@@ -14,4 +14,14 @@ export declare function getVariant(basePath: string): DescriptorVariant;
  * @returns {Promise<AdpPreviewConfig>} the adp configuration
  */
 export declare function getAdpConfig(basePath: string, yamlPath: string): Promise<AdpPreviewConfig>;
+/**
+ * Get all files in the webapp folder.
+ *
+ * @param {string} basePath - The path to the adaptation project.
+ * @returns {Array<{ relativePath: string; content: string }>} The files in the webapp folder.
+ */
+export declare function getWebappFiles(basePath: string): {
+    relativePath: string;
+    content: string;
+}[];
 //# sourceMappingURL=helper.d.ts.map

package/dist/base/helper.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getVariant = getVariant;
 exports.getAdpConfig = getAdpConfig;
+exports.getWebappFiles = getWebappFiles;
 const fs_1 = require("fs");
 const path_1 = require("path");
 const ui5_config_1 = require("@sap-ux/ui5-config");
@@ -32,4 +33,30 @@ async function getAdpConfig(basePath, yamlPath) {
     }
     return adp;
 }
+/**
+ * Get all files in the webapp folder.
+ *
+ * @param {string} basePath - The path to the adaptation project.
+ * @returns {Array<{ relativePath: string; content: string }>} The files in the webapp folder.
+ */
+function getWebappFiles(basePath) {
+    const dir = (0, path_1.join)(basePath, 'webapp');
+    const files = [];
+    const getFilesRecursivelySync = (directory) => {
+        const dirents = (0, fs_1.readdirSync)(directory, { withFileTypes: true });
+        for (const dirent of dirents) {
+            const fullPath = (0, path_1.join)(directory, dirent.name);
+            if (dirent.isFile()) {
+                const content = (0, fs_1.readFileSync)(fullPath, 'utf-8');
+                const relativePath = (0, path_1.relative)(dir, fullPath);
+                files.push({ relativePath, content });
+            }
+            else if (dirent.isDirectory()) {
+                getFilesRecursivelySync(fullPath);
+            }
+        }
+    };
+    getFilesRecursivelySync(dir);
+    return files;
+}
 //# sourceMappingURL=helper.js.map

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 export * from './types';
 export * from './prompts';
 export * from './base/cf';
-export * from './base/abap';
+export * from './base/abap/manifest-service';
 export * from './base/helper';
 export * from './preview/adp-preview';
 export { generate, migrate } from './writer';

package/dist/index.js

@@ -18,7 +18,7 @@ exports.promptGeneratorInput = exports.generateChange = exports.migrate = export
 __exportStar(require("./types"), exports);
 __exportStar(require("./prompts"), exports);
 __exportStar(require("./base/cf"), exports);
-__exportStar(require("./base/abap"), exports);
+__exportStar(require("./base/abap/manifest-service"), exports);
 __exportStar(require("./base/helper"), exports);
 __exportStar(require("./preview/adp-preview"), exports);
 var writer_1 = require("./writer");

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

@@ -17,7 +17,7 @@ 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 */ }
+        { name: (0, i18n_1.t)('choices.annotationFile.createTemplateFile'), value: 2 /* AnnotationFileSelectType.NewEmptyFile */ }
     ];
     return [
         {

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

@@ -74,7 +74,7 @@
         "false": "false",
         "annotationFile": {
             "selectFromWorkspace": "Select annotation file from workspace",
-            "createEmptyFile": "Create an empty annotation file"
+            "createTemplateFile": "Create a template annotation file"
         }
     }
 }

package/dist/types.d.ts

@@ -261,6 +261,11 @@ export interface AnnotationsData {
         dataSource: string;
         /** Optional path to the annotation file. */
         filePath?: string;
+        namespaces?: {
+            namespace: string;
+            alias: string;
+        }[];
+        serviceUrl?: string;
     };
 }
 export declare const enum AnnotationFileSelectType {

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.76",
+  "version": "0.12.78",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -32,14 +32,14 @@
     "prompts": "2.4.2",
     "sanitize-filename": "1.6.3",
     "uuid": "10.0.0",
-    "@sap-ux/axios-extension": "1.17.2",
+    "@sap-ux/axios-extension": "1.17.3",
     "@sap-ux/btp-utils": "0.16.0",
-    "@sap-ux/inquirer-common": "0.5.0",
+    "@sap-ux/inquirer-common": "0.5.1",
     "@sap-ux/logger": "0.6.0",
-    "@sap-ux/project-access": "1.28.6",
+    "@sap-ux/project-access": "1.28.7",
     "@sap-ux/project-input-validator": "0.3.3",
-    "@sap-ux/system-access": "0.5.17",
-    "@sap-ux/ui5-config": "0.25.1"
+    "@sap-ux/system-access": "0.5.18",
+    "@sap-ux/ui5-config": "0.25.2"
   },
   "devDependencies": {
     "@types/adm-zip": "0.5.5",

package/templates/changes/annotation.xml

@@ -7,6 +7,9 @@
     </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:Reference Uri="<%- path %>$metadata"><% namespaces.forEach(function(namespace){ %>
+        <edmx:Include Namespace="<%- namespace.namespace %>"<% if (namespace.alias) { %> Alias="<%- namespace.alias %>"<% } %>/><% }); %>
     </edmx:Reference>
     <edmx:DataServices>
         <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="local">

package/dist/base/abap.d.ts

@@ -1,24 +0,0 @@
-import type { Manifest, ManifestNamespace } from '@sap-ux/project-access';
-import type { ToolsLogger } from '@sap-ux/logger';
-import type { AdpPreviewConfig } from '../types';
-/**
- * Get the application manifest.
- *
- * @param {string} appId - The application id.
- * @param {AdpPreviewConfig} adpConfig - The ADP configuration.
- * @param {ToolsLogger} logger - The logger.
- * @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,55 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getManifest = getManifest;
-exports.getManifestDataSources = getManifestDataSources;
-const system_access_1 = require("@sap-ux/system-access");
-const axios_extension_1 = require("@sap-ux/axios-extension");
-/**
- * Get the application manifest.
- *
- * @param {string} appId - The application id.
- * @param {AdpPreviewConfig} adpConfig - The ADP configuration.
- * @param {ToolsLogger} logger - The logger.
- * @returns {Promise<Manifest>} The manifest.
- */
-async function getManifest(appId, adpConfig, logger) {
-    const provider = await (0, system_access_1.createAbapServiceProvider)(adpConfig.target, {
-        ignoreCertErrors: adpConfig.ignoreCertErrors ?? false
-    }, true, logger);
-    const appInfo = (await provider.getAppIndex().getAppInfo(appId))[appId];
-    const manifestUrl = appInfo.manifestUrl ?? appInfo.manifest;
-    if (!manifestUrl) {
-        throw new Error('Manifest URL not found');
-    }
-    try {
-        const response = await provider.get(manifestUrl);
-        return JSON.parse(response.data);
-    }
-    catch (error) {
-        if ((0, axios_extension_1.isAxiosError)(error)) {
-            logger.error('Manifest fetching failed');
-        }
-        else {
-            logger.error('Manifest parsing error: Manifest is not in expected format.');
-        }
-        logger.debug(error);
-        throw error;
-    }
-}
-/**
- * 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;
-}
-//# sourceMappingURL=abap.js.map