@sap-ux/project-access 1.17.0 → 1.17.2

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 { getFilePaths } from './file';
-export { findAllApps, findCapProjects, findFioriArtifacts, findProjectRoot, getAppRootFromWebappPath, getAppProgrammingLanguage, getAppType, getCapCustomPaths, getCapEnvironment, getCapModelAndServices, getCapProjectType, getCdsFiles, getCdsRoots, getCdsServices, getI18nPropertiesPaths, getMtaPath, getNodeModulesPath, getProject, getProjectType, getWebappPath, isCapJavaProject, isCapNodeJsProject, loadModuleFromProject, readCapServiceMetadataEdmx, readUi5Yaml } from './project';
+export { createApplicationAccess, createProjectAccess, findAllApps, findCapProjects, findFioriArtifacts, findProjectRoot, getAppRootFromWebappPath, getAppProgrammingLanguage, getAppType, getCapCustomPaths, getCapEnvironment, getCapModelAndServices, getCapProjectType, getCdsFiles, getCdsRoots, getCdsServices, getCapI18nFolderNames, getI18nPropertiesPaths, 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,12 +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.readUi5Yaml = exports.readCapServiceMetadataEdmx = exports.loadModuleFromProject = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.getWebappPath = exports.getProjectType = exports.getProject = exports.getNodeModulesPath = exports.getMtaPath = exports.getI18nPropertiesPaths = 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.getFilePaths = 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.getI18nPropertiesPaths = 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; } });
@@ -34,6 +36,7 @@ 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, "getI18nPropertiesPaths", { enumerable: true, get: function () { return project_1.getI18nPropertiesPaths; } });
 Object.defineProperty(exports, "getMtaPath", { enumerable: true, get: function () { return project_1.getMtaPath; } });
 Object.defineProperty(exports, "getNodeModulesPath", { enumerable: true, get: function () { return project_1.getNodeModulesPath; } });

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/index.d.ts

@@ -1,2 +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

@@ -1,6 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getI18nPropertiesPaths = void 0;
+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

package/dist/project/i18n/read.js

@@ -0,0 +1,59 @@
+"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.getCapI18nFolderNames = exports.getI18nBundles = void 0;
+const i18n_1 = require("@sap-ux/i18n");
+const __1 = require("..");
+/**
+ * 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
+ */
+function getI18nBundles(root, i18nPropertiesPaths, projectType, fs) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const result = {
+            'sap.app': {},
+            models: {},
+            service: {}
+        };
+        result['sap.app'] = yield (0, i18n_1.getPropertiesI18nBundle)(i18nPropertiesPaths['sap.app'], fs);
+        for (const key of Object.keys(i18nPropertiesPaths.models)) {
+            result.models[key] = yield (0, i18n_1.getPropertiesI18nBundle)(i18nPropertiesPaths.models[key].path, fs);
+        }
+        if (projectType === 'CAPNodejs') {
+            const env = yield (0, __1.getCapEnvironment)(root);
+            const cdsFiles = yield (0, __1.getCdsFiles)(root, true);
+            result.service = yield (0, i18n_1.getCapI18nBundle)(root, env, cdsFiles, fs);
+        }
+        return result;
+    });
+}
+exports.getI18nBundles = getI18nBundles;
+/**
+ * Retrieves a list of potential folder names for i18n files.
+ *
+ * @param root Project root.
+ * @returns ii18n folder names
+ */
+function getCapI18nFolderNames(root) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const environment = yield (0, __1.getCapEnvironment)(root);
+        return (0, i18n_1.getI18nFolderNames)(environment);
+    });
+}
+exports.getCapI18nFolderNames = getCapI18nFolderNames;
+//# sourceMappingURL=read.js.map

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

@@ -0,0 +1,78 @@
+import type { NewI18nEntry } from '@sap-ux/i18n';
+import type { I18nPropertiesPaths } from '../../types';
+import type { Editor } from 'mem-fs-editor';
+/**
+ * Maintains new translation entries in CAP i18n files.
+ *
+ * @param root project root.
+ * @param filePath file in which the translation entry will be used.
+ * @param newI18nEntries translation entries to write in the i18n file.
+ * @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 boolean or exception
+ */
+export declare function createCapI18nEntries(root: string, filePath: string, newI18nEntries: NewI18nEntry[], fs?: Editor): Promise<boolean>;
+/**
+ * Maintains new translation entries in an existing i18n file or in a new i18n properties file if it does not exist.
+ *
+ * @param root project root
+ * @param manifestPath absolute path to `manifest.json` file
+ * @param i18nPropertiesPaths paths to `.properties` file`
+ * @param newEntries translation entries to write in the `.properties` file
+ * @param modelKey i18n model key
+ * @param fs optional `mem-fs-editor` instance. If provided, `mem-fs-editor` api is used instead of `fs` of node
+ * @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"
+ *              }
+ *          }
+ *      }
+ * }
+ * ```
+ */
+export declare function createUI5I18nEntries(root: string, manifestPath: string, i18nPropertiesPaths: I18nPropertiesPaths, newEntries: NewI18nEntry[], modelKey: string, fs?: Editor): Promise<boolean>;
+/**
+ * Maintains new translation entries in an existing i18n file or in a new i18n properties file if it does not exist.
+ *
+ * @param root project root
+ * @param manifestPath absolute path to `manifest.json` file
+ * @param i18nPropertiesPaths paths to `.properties` file`
+ * @param newEntries translation entries to write in the `.properties` file
+ * @param fs optional `mem-fs-editor` instance. If provided, `mem-fs-editor` api is used instead of `fs` of node
+ * @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"
+ *              }
+ *          }
+ *      }
+ * }
+ * ```
+ */
+export declare function createAnnotationI18nEntries(root: string, manifestPath: string, i18nPropertiesPaths: I18nPropertiesPaths, newEntries: NewI18nEntry[], fs?: Editor): Promise<boolean>;
+/**
+ * Maintains new translation entries in an existing i18n file or in a new i18n properties file if it does not exist.
+ *
+ * @param root project root
+ * @param i18nPropertiesPaths paths to `.properties` file`
+ * @param newEntries translation entries to write in the `.properties` file
+ * @param fs optional `mem-fs-editor` instance. If provided, `mem-fs-editor` api is used instead of `fs` of node
+ * @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.
+ */
+export declare function createManifestI18nEntries(root: string, i18nPropertiesPaths: I18nPropertiesPaths, newEntries: NewI18nEntry[], fs?: Editor): Promise<boolean>;
+//# sourceMappingURL=write.d.ts.map

package/dist/project/i18n/write.js

@@ -0,0 +1,160 @@
+"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.createManifestI18nEntries = exports.createAnnotationI18nEntries = exports.createUI5I18nEntries = exports.createCapI18nEntries = void 0;
+const i18n_1 = require("@sap-ux/i18n");
+const __1 = require("..");
+const path_1 = require("path");
+const file_1 = require("../../file");
+const promises_1 = require("fs/promises");
+/**
+ * Maintains new translation entries in CAP i18n files.
+ *
+ * @param root project root.
+ * @param filePath file in which the translation entry will be used.
+ * @param newI18nEntries translation entries to write in the i18n file.
+ * @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 boolean or exception
+ */
+function createCapI18nEntries(root, filePath, newI18nEntries, fs) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const env = yield (0, __1.getCapEnvironment)(root);
+        return (0, i18n_1.createCapI18nEntries)(root, filePath, newI18nEntries, env, fs);
+    });
+}
+exports.createCapI18nEntries = createCapI18nEntries;
+/**
+ * Maintains new translation entries in an existing i18n file or in a new i18n properties file if it does not exist for given model key.
+ *
+ * @param root project root
+ * @param manifestPath absolute path to `manifest.json` file
+ * @param i18nPropertiesPaths paths to `.properties` file`
+ * @param newEntries translation entries to write in the `.properties` file
+ * @param modelKey i18n model key,
+ * @param fs optional `mem-fs-editor` instance. If provided, `mem-fs-editor` api is used instead of `fs` of node
+ * @returns boolean or exception
+ */
+function createUI5I18nEntriesBase(root, manifestPath, i18nPropertiesPaths, newEntries, modelKey, fs) {
+    var _a, _b;
+    return __awaiter(this, void 0, void 0, function* () {
+        const defaultPath = 'i18n/i18n.properties';
+        const i18nFilePath = (_a = i18nPropertiesPaths.models[modelKey]) === null || _a === void 0 ? void 0 : _a.path;
+        if (i18nFilePath) {
+            // ensure folder for i18n exists
+            const dirPath = (0, path_1.dirname)(i18nFilePath);
+            if (!fs) {
+                // create directory when mem-fs-editor is not provided. when mem-fs-editor is provided, directory is created on using `.commit()` API
+                yield (0, promises_1.mkdir)(dirPath, { recursive: true });
+            }
+            return (0, i18n_1.createPropertiesI18nEntries)(i18nFilePath, newEntries, root, fs);
+        }
+        // update manifest.json entry
+        const manifest = yield (0, file_1.readJSON)(manifestPath);
+        const models = Object.assign({}, (_b = manifest['sap.ui5']) === null || _b === void 0 ? void 0 : _b.models);
+        models[modelKey] = { type: 'sap.ui.model.resource.ResourceModel', uri: defaultPath };
+        const newContent = Object.assign(Object.assign({}, manifest), { 'sap.ui5': Object.assign(Object.assign({}, manifest['sap.ui5']), { models }) });
+        yield (0, file_1.writeFile)(manifestPath, JSON.stringify(newContent, undefined, 4), fs);
+        // make sure i18n folder exists
+        const dirPath = (0, path_1.dirname)(defaultPath);
+        if (!fs) {
+            // create directory when mem-fs-editor is not provided. when mem-fs-editor is provided, directory is created on using `.commit()` API
+            yield (0, promises_1.mkdir)((0, path_1.join)(root, dirPath), { recursive: true });
+        }
+        return (0, i18n_1.createPropertiesI18nEntries)((0, path_1.join)(root, defaultPath), newEntries, root, fs);
+    });
+}
+/**
+ * Maintains new translation entries in an existing i18n file or in a new i18n properties file if it does not exist.
+ *
+ * @param root project root
+ * @param manifestPath absolute path to `manifest.json` file
+ * @param i18nPropertiesPaths paths to `.properties` file`
+ * @param newEntries translation entries to write in the `.properties` file
+ * @param modelKey i18n model key
+ * @param fs optional `mem-fs-editor` instance. If provided, `mem-fs-editor` api is used instead of `fs` of node
+ * @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"
+ *              }
+ *          }
+ *      }
+ * }
+ * ```
+ */
+function createUI5I18nEntries(root, manifestPath, i18nPropertiesPaths, newEntries, modelKey, fs) {
+    return __awaiter(this, void 0, void 0, function* () {
+        return createUI5I18nEntriesBase(root, manifestPath, i18nPropertiesPaths, newEntries, modelKey, fs);
+    });
+}
+exports.createUI5I18nEntries = createUI5I18nEntries;
+/**
+ * Maintains new translation entries in an existing i18n file or in a new i18n properties file if it does not exist.
+ *
+ * @param root project root
+ * @param manifestPath absolute path to `manifest.json` file
+ * @param i18nPropertiesPaths paths to `.properties` file`
+ * @param newEntries translation entries to write in the `.properties` file
+ * @param fs optional `mem-fs-editor` instance. If provided, `mem-fs-editor` api is used instead of `fs` of node
+ * @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"
+ *              }
+ *          }
+ *      }
+ * }
+ * ```
+ */
+function createAnnotationI18nEntries(root, manifestPath, i18nPropertiesPaths, newEntries, fs) {
+    return __awaiter(this, void 0, void 0, function* () {
+        return createUI5I18nEntriesBase(root, manifestPath, i18nPropertiesPaths, newEntries, '@i18n', fs);
+    });
+}
+exports.createAnnotationI18nEntries = createAnnotationI18nEntries;
+/**
+ * Maintains new translation entries in an existing i18n file or in a new i18n properties file if it does not exist.
+ *
+ * @param root project root
+ * @param i18nPropertiesPaths paths to `.properties` file`
+ * @param newEntries translation entries to write in the `.properties` file
+ * @param fs optional `mem-fs-editor` instance. If provided, `mem-fs-editor` api is used instead of `fs` of node
+ * @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.
+ */
+function createManifestI18nEntries(root, i18nPropertiesPaths, newEntries, fs) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const i18nFilePath = i18nPropertiesPaths['sap.app'];
+        // make sure i18n folder exists
+        const dirPath = (0, path_1.dirname)(i18nFilePath);
+        if (!fs) {
+            // create directory when mem-fs-editor is not provided. when mem-fs-editor is provided, directory is created on using `.commit()` API
+            yield (0, promises_1.mkdir)(dirPath, { recursive: true });
+        }
+        return (0, i18n_1.createPropertiesI18nEntries)(i18nFilePath, newEntries, root, fs);
+    });
+}
+exports.createManifestI18nEntries = createManifestI18nEntries;
+//# sourceMappingURL=write.js.map

package/dist/project/index.d.ts

@@ -1,9 +1,10 @@
 export { getCapCustomPaths, getCapModelAndServices, getCapProjectType, getCdsFiles, getCdsRoots, getCdsServices, isCapJavaProject, isCapNodeJsProject, getCapEnvironment, readCapServiceMetadataEdmx } from './cap';
 export { getNodeModulesPath } from './dependencies';
-export { getI18nPropertiesPaths } from './i18n';
+export { getCapI18nFolderNames, getI18nPropertiesPaths } from './i18n';
 export { getAppProgrammingLanguage, getAppType, getProject, getProjectType } from './info';
 export { loadModuleFromProject } from './module-loader';
 export { findAllApps, findCapProjects, findFioriArtifacts, findProjectRoot, getAppRootFromWebappPath } from './search';
 export { getWebappPath, readUi5Yaml } from './ui5-config';
 export { getMtaPath } from './mta';
+export { createApplicationAccess, createProjectAccess } from './access';
 //# sourceMappingURL=index.d.ts.map

package/dist/project/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getMtaPath = exports.readUi5Yaml = exports.getWebappPath = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findFioriArtifacts = exports.findCapProjects = exports.findAllApps = exports.loadModuleFromProject = exports.getProjectType = exports.getProject = exports.getAppType = exports.getAppProgrammingLanguage = exports.getI18nPropertiesPaths = exports.getNodeModulesPath = exports.readCapServiceMetadataEdmx = exports.getCapEnvironment = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.getCdsServices = exports.getCdsRoots = exports.getCdsFiles = exports.getCapProjectType = exports.getCapModelAndServices = exports.getCapCustomPaths = void 0;
+exports.createProjectAccess = exports.createApplicationAccess = exports.getMtaPath = exports.readUi5Yaml = exports.getWebappPath = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findFioriArtifacts = exports.findCapProjects = exports.findAllApps = exports.loadModuleFromProject = exports.getProjectType = exports.getProject = exports.getAppType = exports.getAppProgrammingLanguage = exports.getI18nPropertiesPaths = exports.getCapI18nFolderNames = exports.getNodeModulesPath = exports.readCapServiceMetadataEdmx = exports.getCapEnvironment = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.getCdsServices = exports.getCdsRoots = exports.getCdsFiles = exports.getCapProjectType = exports.getCapModelAndServices = exports.getCapCustomPaths = void 0;
 var cap_1 = require("./cap");
 Object.defineProperty(exports, "getCapCustomPaths", { enumerable: true, get: function () { return cap_1.getCapCustomPaths; } });
 Object.defineProperty(exports, "getCapModelAndServices", { enumerable: true, get: function () { return cap_1.getCapModelAndServices; } });
@@ -15,6 +15,7 @@ Object.defineProperty(exports, "readCapServiceMetadataEdmx", { enumerable: true,
 var dependencies_1 = require("./dependencies");
 Object.defineProperty(exports, "getNodeModulesPath", { enumerable: true, get: function () { return dependencies_1.getNodeModulesPath; } });
 var i18n_1 = require("./i18n");
+Object.defineProperty(exports, "getCapI18nFolderNames", { enumerable: true, get: function () { return i18n_1.getCapI18nFolderNames; } });
 Object.defineProperty(exports, "getI18nPropertiesPaths", { enumerable: true, get: function () { return i18n_1.getI18nPropertiesPaths; } });
 var info_1 = require("./info");
 Object.defineProperty(exports, "getAppProgrammingLanguage", { enumerable: true, get: function () { return info_1.getAppProgrammingLanguage; } });
@@ -34,4 +35,7 @@ Object.defineProperty(exports, "getWebappPath", { enumerable: true, get: functio
 Object.defineProperty(exports, "readUi5Yaml", { enumerable: true, get: function () { return ui5_config_1.readUi5Yaml; } });
 var mta_1 = require("./mta");
 Object.defineProperty(exports, "getMtaPath", { enumerable: true, get: function () { return mta_1.getMtaPath; } });
+var access_1 = require("./access");
+Object.defineProperty(exports, "createApplicationAccess", { enumerable: true, get: function () { return access_1.createApplicationAccess; } });
+Object.defineProperty(exports, "createProjectAccess", { enumerable: true, get: function () { return access_1.createProjectAccess; } });
 //# sourceMappingURL=index.js.map

package/dist/project/module-loader.js

@@ -49,14 +49,13 @@ const dependencies_1 = require("./dependencies");
  */
 function loadModuleFromProject(projectRoot, moduleName) {
     return __awaiter(this, void 0, void 0, function* () {
-        var _a;
         let module;
         try {
             if (!(0, dependencies_1.getNodeModulesPath)(projectRoot, moduleName)) {
                 throw Error('Path to module not found.');
             }
             const modulePath = require.resolve(moduleName, { paths: [projectRoot] });
-            module = (yield (_a = modulePath, Promise.resolve().then(() => __importStar(require(_a)))));
+            module = (yield Promise.resolve(`${modulePath}`).then(s => __importStar(require(s))));
         }
         catch (error) {
             throw Error(`Module '${moduleName}' not installed in project '${projectRoot}'.\n${error.toString()}`);

package/dist/types/access/index.d.ts

@@ -0,0 +1,25 @@
+import type { I18nBundles } from '../i18n';
+import type { NewI18nEntry } from '@sap-ux/i18n';
+import type { ApplicationStructure, I18nPropertiesPaths, Project, ProjectType } from '../info';
+interface BaseAccess {
+    readonly project: Project;
+    readonly root: string;
+    readonly projectType: ProjectType;
+}
+export interface ApplicationAccess extends BaseAccess {
+    readonly app: ApplicationStructure;
+    createAnnotationI18nEntries(newEntries: NewI18nEntry[]): Promise<boolean>;
+    createUI5I18nEntries(newEntries: NewI18nEntry[], modelKey?: string): Promise<boolean>;
+    createManifestI18nEntries(newEntries: NewI18nEntry[]): Promise<boolean>;
+    createCapI18nEntries(filePath: string, newI18nEntries: NewI18nEntry[]): Promise<boolean>;
+    getAppId(): string;
+    getAppRoot(): string;
+    getI18nBundles(): Promise<I18nBundles>;
+    getI18nPropertiesPaths(): Promise<I18nPropertiesPaths>;
+}
+export interface ProjectAccess extends BaseAccess {
+    getApplicationIds: () => string[];
+    getApplication: (appId: string) => ApplicationAccess;
+}
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/types/access/index.js

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

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

@@ -0,0 +1,18 @@
+import type { I18nBundle } from '@sap-ux/i18n';
+export interface I18nBundles {
+    /**
+     * i18n bundle for `i18n` of `"sap.app"` namespace in `manifest.json` file
+     */
+    'sap.app': I18nBundle;
+    /**
+     * i18n bundle for `models` entry of `sap.ui5` namespace in `manifest.json` file with type `sap.ui.model.resource.ResourceModel`
+     */
+    models: {
+        [modelKey: string]: I18nBundle;
+    };
+    /**
+     * i18n bundle for cap services
+     */
+    service: I18nBundle;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/types/i18n/index.js

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

package/dist/types/index.d.ts

@@ -1,4 +1,6 @@
+export * from './access';
 export * from './cap';
+export * from './i18n';
 export * from './find';
 export * from './info';
 export * from './package';

package/dist/types/index.js

@@ -14,7 +14,9 @@ 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 });
+__exportStar(require("./access"), exports);
 __exportStar(require("./cap"), exports);
+__exportStar(require("./i18n"), exports);
 __exportStar(require("./find"), exports);
 __exportStar(require("./info"), exports);
 __exportStar(require("./package"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap-ux/project-access",
-  "version": "1.17.0",
+  "version": "1.17.2",
   "description": "Library to access SAP Fiori tools projects",
   "repository": {
     "type": "git",
@@ -27,6 +27,7 @@
     "findit2": "2.2.3",
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",
+    "@sap-ux/i18n": "0.0.3",
     "@sap-ux/ui5-config": "0.21.0"
   },
   "devDependencies": {
@@ -34,7 +35,7 @@
     "@types/mem-fs-editor": "7.0.1",
     "@ui5/manifest": "1.61.0",
     "vscode-uri": "3.0.7",
-    "@sap-ux/logger": "0.4.0"
+    "@sap-ux/logger": "0.5.0"
   },
   "scripts": {
     "build": "tsc --build",