@sap-ux/project-access 1.16.3 → 1.17.1

package/dist/constants.d.ts

@@ -13,4 +13,7 @@ export declare const FileName: {
     readonly Ui5MockYaml: "ui5-mock.yaml";
     readonly UI5DeployYaml: "ui5-deploy.yaml";
 };
+export declare const DirName: {
+    readonly Changes: "changes";
+};
 //# sourceMappingURL=constants.d.ts.map

package/dist/constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FileName = void 0;
+exports.DirName = exports.FileName = void 0;
 exports.FileName = {
     AdaptationConfig: 'config.json',
     CapJavaApplicationYaml: 'application.yaml',
@@ -16,4 +16,7 @@ exports.FileName = {
     Ui5MockYaml: 'ui5-mock.yaml',
     UI5DeployYaml: 'ui5-deploy.yaml'
 };
+exports.DirName = {
+    Changes: 'changes'
+};
 //# sourceMappingURL=constants.js.map

package/dist/file/file-access.d.ts

@@ -15,6 +15,15 @@ export declare function readFile(path: string, memFs?: Editor): Promise<string>;
  * @returns - file content as object of type T
  */
 export declare function readJSON<T>(path: string, memFs?: Editor): Promise<T>;
+/**
+ * Read file asynchronously. Throws error if file does not exist.
+ *
+ * @param path - path to file
+ * @param content - content to write to a file
+ * @param memFs - optional mem-fs-editor instance
+ * @returns - file content as string
+ */
+export declare function writeFile(path: string, content: string, memFs?: Editor): Promise<string | void>;
 /**
  * Checks if the provided file exists in the file system.
  *

package/dist/file/file-access.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fileExists = exports.readJSON = exports.readFile = void 0;
+exports.fileExists = exports.writeFile = exports.readJSON = exports.readFile = void 0;
 const fs_1 = require("fs");
 /**
  * Read file asynchronously. Throws error if file does not exist.
@@ -47,6 +47,23 @@ function readJSON(path, memFs) {
     });
 }
 exports.readJSON = readJSON;
+/**
+ * Read file asynchronously. Throws error if file does not exist.
+ *
+ * @param path - path to file
+ * @param content - content to write to a file
+ * @param memFs - optional mem-fs-editor instance
+ * @returns - file content as string
+ */
+function writeFile(path, content, memFs) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (memFs) {
+            return memFs.write(path, content);
+        }
+        return fs_1.promises.writeFile(path, content, { encoding: 'utf8' });
+    });
+}
+exports.writeFile = writeFile;
 /**
  * Checks if the provided file exists in the file system.
  *

package/dist/file/index.d.ts

@@ -1,3 +1,3 @@
-export { fileExists, readFile, readJSON } from './file-access';
+export { fileExists, readFile, readJSON, writeFile } from './file-access';
 export { findBy, findFiles, findFilesByExtension, findFileUp, getFilePaths } from './file-search';
 //# sourceMappingURL=index.d.ts.map

package/dist/file/index.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getFilePaths = exports.findFileUp = exports.findFilesByExtension = exports.findFiles = exports.findBy = exports.readJSON = exports.readFile = exports.fileExists = void 0;
+exports.getFilePaths = exports.findFileUp = exports.findFilesByExtension = exports.findFiles = exports.findBy = exports.writeFile = exports.readJSON = exports.readFile = exports.fileExists = void 0;
 var file_access_1 = require("./file-access");
 Object.defineProperty(exports, "fileExists", { enumerable: true, get: function () { return file_access_1.fileExists; } });
 Object.defineProperty(exports, "readFile", { enumerable: true, get: function () { return file_access_1.readFile; } });
 Object.defineProperty(exports, "readJSON", { enumerable: true, get: function () { return file_access_1.readJSON; } });
+Object.defineProperty(exports, "writeFile", { enumerable: true, get: function () { return file_access_1.writeFile; } });
 var file_search_1 = require("./file-search");
 Object.defineProperty(exports, "findBy", { enumerable: true, get: function () { return file_search_1.findBy; } });
 Object.defineProperty(exports, "findFiles", { enumerable: true, get: function () { return file_search_1.findFiles; } });

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 export { FileName } from './constants';
-export { findAllApps, findCapProjects, findFioriArtifacts, findProjectRoot, getAppRootFromWebappPath, getAppProgrammingLanguage, getAppType, getCapCustomPaths, getCapEnvironment, getCapModelAndServices, getCapProjectType, getCdsFiles, getCdsRoots, getCdsServices, getMtaPath, getNodeModulesPath, getProjectType, getWebappPath, isCapJavaProject, isCapNodeJsProject, loadModuleFromProject, readCapServiceMetadataEdmx, readUi5Yaml } from './project';
 export { getFilePaths } from './file';
+export { createApplicationAccess, createProjectAccess, findAllApps, findCapProjects, findFioriArtifacts, findProjectRoot, getAppRootFromWebappPath, getAppProgrammingLanguage, getAppType, getCapCustomPaths, getCapEnvironment, getCapModelAndServices, getCapProjectType, getCdsFiles, getCdsRoots, getCdsServices, getCapI18nFolderNames, getMtaPath, getNodeModulesPath, getProject, getProjectType, getWebappPath, isCapJavaProject, isCapNodeJsProject, loadModuleFromProject, readCapServiceMetadataEdmx, readUi5Yaml } from './project';
 export * from './types';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -14,10 +14,14 @@ 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.getFilePaths = exports.readUi5Yaml = exports.readCapServiceMetadataEdmx = exports.loadModuleFromProject = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.getWebappPath = exports.getProjectType = exports.getNodeModulesPath = exports.getMtaPath = exports.getCdsServices = exports.getCdsRoots = exports.getCdsFiles = exports.getCapProjectType = exports.getCapModelAndServices = exports.getCapEnvironment = exports.getCapCustomPaths = exports.getAppType = exports.getAppProgrammingLanguage = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findFioriArtifacts = exports.findCapProjects = exports.findAllApps = exports.FileName = void 0;
+exports.readUi5Yaml = exports.readCapServiceMetadataEdmx = exports.loadModuleFromProject = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.getWebappPath = exports.getProjectType = exports.getProject = exports.getNodeModulesPath = exports.getMtaPath = exports.getCapI18nFolderNames = exports.getCdsServices = exports.getCdsRoots = exports.getCdsFiles = exports.getCapProjectType = exports.getCapModelAndServices = exports.getCapEnvironment = exports.getCapCustomPaths = exports.getAppType = exports.getAppProgrammingLanguage = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findFioriArtifacts = exports.findCapProjects = exports.findAllApps = exports.createProjectAccess = exports.createApplicationAccess = exports.getFilePaths = exports.FileName = void 0;
 var constants_1 = require("./constants");
 Object.defineProperty(exports, "FileName", { enumerable: true, get: function () { return constants_1.FileName; } });
+var file_1 = require("./file");
+Object.defineProperty(exports, "getFilePaths", { enumerable: true, get: function () { return file_1.getFilePaths; } });
 var project_1 = require("./project");
+Object.defineProperty(exports, "createApplicationAccess", { enumerable: true, get: function () { return project_1.createApplicationAccess; } });
+Object.defineProperty(exports, "createProjectAccess", { enumerable: true, get: function () { return project_1.createProjectAccess; } });
 Object.defineProperty(exports, "findAllApps", { enumerable: true, get: function () { return project_1.findAllApps; } });
 Object.defineProperty(exports, "findCapProjects", { enumerable: true, get: function () { return project_1.findCapProjects; } });
 Object.defineProperty(exports, "findFioriArtifacts", { enumerable: true, get: function () { return project_1.findFioriArtifacts; } });
@@ -32,8 +36,10 @@ Object.defineProperty(exports, "getCapProjectType", { enumerable: true, get: fun
 Object.defineProperty(exports, "getCdsFiles", { enumerable: true, get: function () { return project_1.getCdsFiles; } });
 Object.defineProperty(exports, "getCdsRoots", { enumerable: true, get: function () { return project_1.getCdsRoots; } });
 Object.defineProperty(exports, "getCdsServices", { enumerable: true, get: function () { return project_1.getCdsServices; } });
+Object.defineProperty(exports, "getCapI18nFolderNames", { enumerable: true, get: function () { return project_1.getCapI18nFolderNames; } });
 Object.defineProperty(exports, "getMtaPath", { enumerable: true, get: function () { return project_1.getMtaPath; } });
 Object.defineProperty(exports, "getNodeModulesPath", { enumerable: true, get: function () { return project_1.getNodeModulesPath; } });
+Object.defineProperty(exports, "getProject", { enumerable: true, get: function () { return project_1.getProject; } });
 Object.defineProperty(exports, "getProjectType", { enumerable: true, get: function () { return project_1.getProjectType; } });
 Object.defineProperty(exports, "getWebappPath", { enumerable: true, get: function () { return project_1.getWebappPath; } });
 Object.defineProperty(exports, "isCapJavaProject", { enumerable: true, get: function () { return project_1.isCapJavaProject; } });
@@ -41,7 +47,5 @@ Object.defineProperty(exports, "isCapNodeJsProject", { enumerable: true, get: fu
 Object.defineProperty(exports, "loadModuleFromProject", { enumerable: true, get: function () { return project_1.loadModuleFromProject; } });
 Object.defineProperty(exports, "readCapServiceMetadataEdmx", { enumerable: true, get: function () { return project_1.readCapServiceMetadataEdmx; } });
 Object.defineProperty(exports, "readUi5Yaml", { enumerable: true, get: function () { return project_1.readUi5Yaml; } });
-var file_1 = require("./file");
-Object.defineProperty(exports, "getFilePaths", { enumerable: true, get: function () { return file_1.getFilePaths; } });
 __exportStar(require("./types"), exports);
 //# sourceMappingURL=index.js.map

package/dist/project/access.d.ts

@@ -0,0 +1,20 @@
+import type { ApplicationAccess, ProjectAccess } from '../types';
+import type { Editor } from 'mem-fs-editor';
+/**
+ * Create an instance of ApplicationAccess that contains information about the application, like paths and services.
+ *
+ * @param appRoot - Application root path
+ * @param fs optional `mem-fs-editor` instance. If provided, `mem-fs-editor` api is used instead of `fs` of node.
+ * In case of CAP project, some CDS APIs are used internally which depends on `fs` of node and not `mem-fs-editor`.
+ * When calling this function, adding or removing a CDS file in memory or changing CDS configuration will not be considered until present on real file system.
+ * @returns - Instance of ApplicationAccess that contains information about the application, like paths and services
+ */
+export declare function createApplicationAccess(appRoot: string, fs?: Editor): Promise<ApplicationAccess>;
+/**
+ * Create an instance of ProjectAccess that contains information about the project, like applications, paths, services.
+ *
+ * @param root - Project root path
+ * @returns - Instance of ProjectAccess that contains information about the project
+ */
+export declare function createProjectAccess(root: string): Promise<ProjectAccess>;
+//# sourceMappingURL=access.d.ts.map

package/dist/project/access.js

@@ -0,0 +1,270 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createProjectAccess = exports.createApplicationAccess = void 0;
+const path_1 = require("path");
+const i18n_1 = require("./i18n");
+const info_1 = require("./info");
+const search_1 = require("./search");
+/**
+ *
+ */
+class ApplicationAccessImp {
+    /**
+     * Constructor for ApplicationAccess.
+     *
+     * @param _project - Project structure
+     * @param appId - Application ID
+     * @param fs optional `mem-fs-editor` instance.
+     */
+    constructor(_project, appId, fs) {
+        this._project = _project;
+        this.appId = appId;
+        this.fs = fs;
+    }
+    /**
+     * Returns the application structure.
+     *
+     * @returns ApplicationStructure
+     */
+    get app() {
+        return this.project.apps[this.appId];
+    }
+    /**
+     * Maintains new translation entries in an existing i18n file or in a new i18n properties file if it does not exist.
+     *
+     * @param newEntries - translation entries to write in the `.properties` file
+     * @returns - boolean or exception
+     * @description It also update `manifest.json` file if `@i18n` entry is missing from `"sap.ui5":{"models": {}}`
+     * as
+     * ```JSON
+     * {
+     *      "sap.ui5": {
+     *          "models": {
+     *              "@i18n": {
+     *                  "type": "sap.ui.model.resource.ResourceModel",
+     *                  "uri": "i18n/i18n.properties"
+     *              }
+     *          }
+     *      }
+     * }
+     * ```
+     */
+    createAnnotationI18nEntries(newEntries) {
+        return (0, i18n_1.createAnnotationI18nEntries)(this.project.root, this.app.manifest, this.app.i18n, newEntries, this.fs);
+    }
+    /**
+     * Maintains new translation entries in an existing i18n file or in a new i18n properties file if it does not exist.
+     *
+     * @param newEntries - translation entries to write in the `.properties` file
+     * @param modelKey - i18n model key. Default key is `i18n`
+     * @returns boolean or exception
+     * @description It also update `manifest.json` file if `<modelKey>` entry is missing from `"sap.ui5":{"models": {}}`
+     * as
+     * ```JSON
+     * {
+     *      "sap.ui5": {
+     *          "models": {
+     *              "<modelKey>": {
+     *                  "type": "sap.ui.model.resource.ResourceModel",
+     *                  "uri": "i18n/i18n.properties"
+     *              }
+     *          }
+     *      }
+     * }
+     * ```
+     */
+    createUI5I18nEntries(newEntries, modelKey = 'i18n') {
+        return (0, i18n_1.createUI5I18nEntries)(this.project.root, this.app.manifest, this.app.i18n, newEntries, modelKey, this.fs);
+    }
+    /**
+     * Maintains new translation entries in an existing i18n file or in a new i18n properties file if it does not exist.
+     *
+     * @param newEntries translation entries to write in the `.properties` file
+     * @returns boolean or exception
+     * @description If `i18n` entry is missing from `"sap.app":{}`, default `i18n/i18n.properties` is used. Update of `manifest.json` file is not needed.
+     */
+    createManifestI18nEntries(newEntries) {
+        return (0, i18n_1.createManifestI18nEntries)(this.project.root, this.app.i18n, newEntries, this.fs);
+    }
+    /**
+     * Maintains new translation entries in CAP i18n files.
+     *
+     * @param filePath file in which the translation entry will be used.
+     * @param newI18nEntries translation entries to write in the i18n file.
+     * @returns boolean or exception
+     */
+    createCapI18nEntries(filePath, newI18nEntries) {
+        return (0, i18n_1.createCapI18nEntries)(this.project.root, filePath, newI18nEntries, this.fs);
+    }
+    /**
+     * Return the application id of this app, which is the relative path from the project root
+     * to the app root.
+     *
+     * @returns - Application root path
+     */
+    getAppId() {
+        return this.appId;
+    }
+    /**
+     * Return the absolute application root path.
+     *
+     * @returns - Application root path
+     */
+    getAppRoot() {
+        return this.app.appRoot;
+    }
+    /**
+     * For a given app in project, retrieves i18n bundles for 'sap.app' namespace,`models` of `sap.ui5` namespace and service for cap services.
+     *
+     * @returns i18n bundles or exception
+     */
+    getI18nBundles() {
+        return (0, i18n_1.getI18nBundles)(this.project.root, this.app.i18n, this.project.projectType, this.fs);
+    }
+    /**
+     * Return absolute paths to i18n.properties files from manifest.
+     *
+     * @returns absolute paths to i18n.properties
+     */
+    getI18nPropertiesPaths() {
+        return (0, i18n_1.getI18nPropertiesPaths)(this.app.manifest);
+    }
+    /**
+     * Project structure.
+     *
+     * @returns - Project structure
+     */
+    get project() {
+        return this._project;
+    }
+    /**
+     * Project type.
+     *
+     * @returns - Project type, like EDMXBackend, CAPJava, or CAPNodejs
+     */
+    get projectType() {
+        return this.project.projectType;
+    }
+    /**
+     * Project root path.
+     *
+     * @returns - Project root path
+     */
+    get root() {
+        return this.project.root;
+    }
+}
+/**
+ * Class that implements ProjectAccess interface.
+ * It can be used to retrieve information about the project, like applications, paths, services.
+ */
+class ProjectAccessImp {
+    /**
+     * Constructor for ProjectAccess.
+     *
+     * @param _project - Project structure
+     */
+    constructor(_project) {
+        this._project = _project;
+    }
+    /**
+     * Returns list of application IDs.
+     *
+     * @returns - array of application IDs. For single application projects it will return ['']
+     */
+    getApplicationIds() {
+        return Object.keys(this._project.apps);
+    }
+    /**
+     * Returns an instance of an application for a given application ID. The contains information about the application, like paths and services.
+     *
+     * @param appId - application ID
+     * @returns - Instance of ApplicationAccess that contains information about the application, like paths and services
+     */
+    getApplication(appId) {
+        if (!this.project.apps[appId]) {
+            throw new Error(`Could not find app with id ${appId}`);
+        }
+        return new ApplicationAccessImp(this.project, appId);
+    }
+    /**
+     * Project structure.
+     *
+     * @returns - Project structure
+     */
+    get project() {
+        return this._project;
+    }
+    /**
+     * Project type.
+     *
+     * @returns - Project type, like EDMXBackend, CAPJava, or CAPNodejs
+     */
+    get projectType() {
+        return this.project.projectType;
+    }
+    /**
+     * Project root path.
+     *
+     * @returns - Project root path
+     */
+    get root() {
+        return this.project.root;
+    }
+}
+/**
+ * Create an instance of ApplicationAccess that contains information about the application, like paths and services.
+ *
+ * @param appRoot - Application root path
+ * @param fs optional `mem-fs-editor` instance. If provided, `mem-fs-editor` api is used instead of `fs` of node.
+ * In case of CAP project, some CDS APIs are used internally which depends on `fs` of node and not `mem-fs-editor`.
+ * When calling this function, adding or removing a CDS file in memory or changing CDS configuration will not be considered until present on real file system.
+ * @returns - Instance of ApplicationAccess that contains information about the application, like paths and services
+ */
+function createApplicationAccess(appRoot, fs) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const apps = yield (0, search_1.findAllApps)([appRoot]);
+            const app = apps.find((app) => app.appRoot === appRoot);
+            if (!app) {
+                throw new Error(`Could not find app with root ${appRoot}`);
+            }
+            const project = yield (0, info_1.getProject)(app.projectRoot);
+            const appId = (0, path_1.relative)(project.root, appRoot);
+            return new ApplicationAccessImp(project, appId, fs);
+        }
+        catch (error) {
+            throw Error(`Error when creating application access for ${appRoot}: ${error}`);
+        }
+    });
+}
+exports.createApplicationAccess = createApplicationAccess;
+/**
+ * Create an instance of ProjectAccess that contains information about the project, like applications, paths, services.
+ *
+ * @param root - Project root path
+ * @returns - Instance of ProjectAccess that contains information about the project
+ */
+function createProjectAccess(root) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const project = yield (0, info_1.getProject)(root);
+            const projectAccess = new ProjectAccessImp(project);
+            return projectAccess;
+        }
+        catch (error) {
+            throw Error(`Error when creating project access for ${root}: ${error}`);
+        }
+    });
+}
+exports.createProjectAccess = createProjectAccess;
+//# sourceMappingURL=access.js.map

package/dist/project/i18n/i18n.d.ts

@@ -0,0 +1,18 @@
+import type { I18nPropertiesPaths, Manifest } from '../../types';
+/**
+ * Return absolute paths to i18n.properties files from manifest.
+ *
+ * @param manifestPath - path to manifest.json; used to parse manifest.json if not provided as second argument and to resolve absolute paths
+ * @param manifest - optionally, parsed content of manifest.json, pass to avoid reading it again.
+ * @returns - absolute paths to i18n.properties
+ */
+export declare function getI18nPropertiesPaths(manifestPath: string, manifest?: Manifest): Promise<I18nPropertiesPaths>;
+/**
+ * Return paths to i18n.properties files from manifest,
+ * relative to the manifest.json.
+ *
+ * @param manifest - parsed content of manifest.json
+ * @returns - paths to i18n.properties files from sap.app and models
+ */
+export declare function getRelativeI18nPropertiesPaths(manifest: Manifest): I18nPropertiesPaths;
+//# sourceMappingURL=i18n.d.ts.map

package/dist/project/i18n/i18n.js

@@ -0,0 +1,127 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRelativeI18nPropertiesPaths = exports.getI18nPropertiesPaths = void 0;
+const path_1 = require("path");
+const file_1 = require("../../file");
+/**
+ * Return absolute paths to i18n.properties files from manifest.
+ *
+ * @param manifestPath - path to manifest.json; used to parse manifest.json if not provided as second argument and to resolve absolute paths
+ * @param manifest - optionally, parsed content of manifest.json, pass to avoid reading it again.
+ * @returns - absolute paths to i18n.properties
+ */
+function getI18nPropertiesPaths(manifestPath, manifest) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const parsedManifest = manifest !== null && manifest !== void 0 ? manifest : (yield (0, file_1.readJSON)(manifestPath));
+        const manifestFolder = (0, path_1.dirname)(manifestPath);
+        const relativeI18nPropertiesPaths = getRelativeI18nPropertiesPaths(parsedManifest);
+        const i18nPropertiesPaths = {
+            'sap.app': (0, path_1.join)(manifestFolder, relativeI18nPropertiesPaths['sap.app']),
+            models: {}
+        };
+        for (const modelKey in relativeI18nPropertiesPaths.models) {
+            i18nPropertiesPaths.models[modelKey] = {
+                path: (0, path_1.join)(manifestFolder, relativeI18nPropertiesPaths.models[modelKey].path)
+            };
+        }
+        return i18nPropertiesPaths;
+    });
+}
+exports.getI18nPropertiesPaths = getI18nPropertiesPaths;
+/**
+ * Return paths to i18n.properties files from manifest,
+ * relative to the manifest.json.
+ *
+ * @param manifest - parsed content of manifest.json
+ * @returns - paths to i18n.properties files from sap.app and models
+ */
+function getRelativeI18nPropertiesPaths(manifest) {
+    return {
+        'sap.app': getI18nAppPath(manifest),
+        models: getI18nModelPaths(manifest)
+    };
+}
+exports.getRelativeI18nPropertiesPaths = getRelativeI18nPropertiesPaths;
+/**
+ * Get the i18n path from sap.app.i18n part of the manifest.
+ *
+ * 1. from `sap.app.i18n` if `i18n` is string
+ * 2. from `sap.app.bundleName` as `bundleName` wins over `bundleUrl`
+ * 3. from `sap.app.bundleUrl`
+ * 4. default which is `'i18n/i18n.properties'`
+ *
+ * @param manifest - parsed content of manifest.json
+ * @returns - path to i18n.properties file
+ */
+function getI18nAppPath(manifest) {
+    var _a, _b;
+    const defaultPath = (0, path_1.join)('i18n/i18n.properties');
+    if (typeof ((_a = manifest === null || manifest === void 0 ? void 0 : manifest['sap.app']) === null || _a === void 0 ? void 0 : _a.i18n) === 'string') {
+        return (0, path_1.join)(manifest['sap.app'].i18n);
+    }
+    if (typeof ((_b = manifest === null || manifest === void 0 ? void 0 : manifest['sap.app']) === null || _b === void 0 ? void 0 : _b.i18n) === 'object') {
+        // bundleName wins over `bundleUrl`
+        if ('bundleName' in manifest['sap.app'].i18n) {
+            // module name is in dot notation
+            const withoutAppId = manifest['sap.app'].i18n.bundleName.replace(manifest['sap.app'].id, '');
+            const i18nPath = `${(0, path_1.join)(...withoutAppId.split('.'))}.properties`;
+            return (0, path_1.join)(i18nPath);
+        }
+        if ('bundleUrl' in manifest['sap.app'].i18n) {
+            return (0, path_1.join)(manifest['sap.app'].i18n.bundleUrl);
+        }
+    }
+    // default
+    return defaultPath;
+}
+/**
+ * Get the i18n path from UI5 resource models declared in sap.ui5.models part of the manifest.
+ * By default the model used for internationalization in the UI is 'i18n'. For
+ * internationalization of annotations the model is '@18n'.
+ *
+ * for For `sap.ui5` namespace
+ * 1. from `sap.ui5.models.{resource model key}.bundleName` as `bundleName` wins over `bundleUrl`
+ * 2. from `sap.ui5.models.{resource model key}.bundleUrl`
+ * 3. from `sap.ui5.models.{resource model key}.uri`
+ *
+ * @param manifest - parsed content of manifest.json
+ * @returns - paths to i18n.properties file from models
+ */
+function getI18nModelPaths(manifest) {
+    var _a, _b;
+    const result = {};
+    const models = (_b = (_a = manifest === null || manifest === void 0 ? void 0 : manifest['sap.ui5']) === null || _a === void 0 ? void 0 : _a.models) !== null && _b !== void 0 ? _b : {};
+    const resourceModelKeys = Object.keys(models).filter((key) => models[key].type === 'sap.ui.model.resource.ResourceModel');
+    for (const modelKey of resourceModelKeys) {
+        const i18nModel = models[modelKey];
+        // settings wins over `uri`
+        if (i18nModel.settings) {
+            // bundleName wins over `bundleUrl`
+            if (i18nModel.settings.bundleName) {
+                // module name is in dot notation
+                const withoutAppId = i18nModel.settings.bundleName.replace(manifest['sap.app'].id, '');
+                const i18nPath = `${(0, path_1.join)(...withoutAppId.split('.'))}.properties`;
+                result[modelKey] = { path: (0, path_1.join)(i18nPath) };
+                continue;
+            }
+            if (i18nModel.settings.bundleUrl) {
+                result[modelKey] = { path: (0, path_1.join)(i18nModel.settings.bundleUrl) };
+                continue;
+            }
+        }
+        if (i18nModel.uri) {
+            result[modelKey] = { path: (0, path_1.join)(i18nModel.uri) };
+        }
+    }
+    return result;
+}
+//# sourceMappingURL=i18n.js.map

package/dist/project/i18n/index.d.ts

@@ -0,0 +1,4 @@
+export { getI18nPropertiesPaths } from './i18n';
+export { getCapI18nFolderNames, getI18nBundles } from './read';
+export { createManifestI18nEntries, createUI5I18nEntries, createAnnotationI18nEntries, createCapI18nEntries } from './write';
+//# sourceMappingURL=index.d.ts.map

package/dist/project/i18n/index.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createCapI18nEntries = exports.createAnnotationI18nEntries = exports.createUI5I18nEntries = exports.createManifestI18nEntries = exports.getI18nBundles = exports.getCapI18nFolderNames = exports.getI18nPropertiesPaths = void 0;
+var i18n_1 = require("./i18n");
+Object.defineProperty(exports, "getI18nPropertiesPaths", { enumerable: true, get: function () { return i18n_1.getI18nPropertiesPaths; } });
+var read_1 = require("./read");
+Object.defineProperty(exports, "getCapI18nFolderNames", { enumerable: true, get: function () { return read_1.getCapI18nFolderNames; } });
+Object.defineProperty(exports, "getI18nBundles", { enumerable: true, get: function () { return read_1.getI18nBundles; } });
+var write_1 = require("./write");
+Object.defineProperty(exports, "createManifestI18nEntries", { enumerable: true, get: function () { return write_1.createManifestI18nEntries; } });
+Object.defineProperty(exports, "createUI5I18nEntries", { enumerable: true, get: function () { return write_1.createUI5I18nEntries; } });
+Object.defineProperty(exports, "createAnnotationI18nEntries", { enumerable: true, get: function () { return write_1.createAnnotationI18nEntries; } });
+Object.defineProperty(exports, "createCapI18nEntries", { enumerable: true, get: function () { return write_1.createCapI18nEntries; } });
+//# sourceMappingURL=index.js.map

package/dist/project/i18n/read.d.ts

@@ -0,0 +1,22 @@
+import type { I18nBundles, I18nPropertiesPaths, ProjectType } from '../../types';
+import type { Editor } from 'mem-fs-editor';
+/**
+ * For a given app in project, retrieves i18n bundles for 'sap.app' namespace,`models` of `sap.ui5` namespace and service for cap services.
+ *
+ * @param root project root
+ * @param i18nPropertiesPaths paths to `.properties` file`
+ * @param projectType optional type of project
+ * @param fs optional `mem-fs-editor` instance. If provided, `mem-fs-editor` api is used instead of `fs` of node.
+ * In case of CAP project, some CDS APIs are used internally which depends on `fs` of node and not `mem-fs-editor`.
+ * When calling this function, adding or removing a CDS file in memory or changing CDS configuration will not be considered until present on real file system.
+ * @returns i18n bundles or exception
+ */
+export declare function getI18nBundles(root: string, i18nPropertiesPaths: I18nPropertiesPaths, projectType?: ProjectType, fs?: Editor): Promise<I18nBundles>;
+/**
+ * Retrieves a list of potential folder names for i18n files.
+ *
+ * @param root Project root.
+ * @returns ii18n folder names
+ */
+export declare function getCapI18nFolderNames(root: string): Promise<string[]>;
+//# sourceMappingURL=read.d.ts.map