@sap-ux/project-access 1.17.4 → 1.17.6

package/dist/constants.d.ts

@@ -2,6 +2,7 @@ export declare const FileName: {
     readonly AdaptationConfig: "config.json";
     readonly CapJavaApplicationYaml: "application.yaml";
     readonly ExtConfigJson: ".extconfig.json";
+    readonly Library: ".library";
     readonly Manifest: "manifest.json";
     readonly ManifestAppDescrVar: "manifest.appdescr_variant";
     readonly MtaYaml: "mta.yaml";

package/dist/constants.js

@@ -5,6 +5,7 @@ exports.FileName = {
     AdaptationConfig: 'config.json',
     CapJavaApplicationYaml: 'application.yaml',
     ExtConfigJson: '.extconfig.json',
+    Library: '.library',
     Manifest: 'manifest.json',
     ManifestAppDescrVar: 'manifest.appdescr_variant',
     MtaYaml: 'mta.yaml',

package/dist/project/access.js

@@ -125,7 +125,7 @@ class ApplicationAccessImp {
     /**
      * 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
+     * @returns i18n bundles or exception captured in optional errors object
      */
     getI18nBundles() {
         return (0, i18n_1.getI18nBundles)(this.project.root, this.app.i18n, this.project.projectType, this.fs);

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

@@ -9,7 +9,7 @@ import type { Editor } from 'mem-fs-editor';
  * @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
+ * @returns i18n bundles or exception captured in optional errors object
  */
 export declare function getI18nBundles(root: string, i18nPropertiesPaths: I18nPropertiesPaths, projectType?: ProjectType, fs?: Editor): Promise<I18nBundles>;
 /**

package/dist/project/i18n/read.js

@@ -12,6 +12,19 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getCapI18nFolderNames = exports.getI18nBundles = void 0;
 const i18n_1 = require("@sap-ux/i18n");
 const __1 = require("..");
+/**
+ * Add error to optional errors object.
+ *
+ * @param result i18n bundles
+ * @param key key to associate with the error
+ * @param error error to add
+ */
+function addToErrors(result, key, error) {
+    if (!result.errors) {
+        result.errors = {};
+    }
+    result.errors[key] = error;
+}
 /**
  * For a given app in project, retrieves i18n bundles for 'sap.app' namespace,`models` of `sap.ui5` namespace and service for cap services.
  *
@@ -21,7 +34,7 @@ const __1 = require("..");
  * @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
+ * @returns i18n bundles or exception captured in optional errors object
  */
 function getI18nBundles(root, i18nPropertiesPaths, projectType, fs) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -30,14 +43,31 @@ function getI18nBundles(root, i18nPropertiesPaths, projectType, fs) {
             models: {},
             service: {}
         };
-        result['sap.app'] = yield (0, i18n_1.getPropertiesI18nBundle)(i18nPropertiesPaths['sap.app'], fs);
+        try {
+            result['sap.app'] = yield (0, i18n_1.getPropertiesI18nBundle)(i18nPropertiesPaths['sap.app'], fs);
+        }
+        catch (error) {
+            addToErrors(result, 'sap.app', error);
+        }
         for (const key of Object.keys(i18nPropertiesPaths.models)) {
-            result.models[key] = yield (0, i18n_1.getPropertiesI18nBundle)(i18nPropertiesPaths.models[key].path, fs);
+            try {
+                result.models[key] = yield (0, i18n_1.getPropertiesI18nBundle)(i18nPropertiesPaths.models[key].path, fs);
+            }
+            catch (error) {
+                // add models key with empty model
+                result.models[key] = {};
+                addToErrors(result, `models.${key}`, error);
+            }
         }
         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);
+            try {
+                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);
+            }
+            catch (error) {
+                addToErrors(result, 'service', error);
+            }
         }
         return result;
     });

package/dist/project/search.js

@@ -23,10 +23,10 @@ const ui5_config_1 = require("./ui5-config");
  * functions.
  */
 const filterFileMap = {
-    applications: constants_1.FileName.Manifest,
-    adaptations: constants_1.FileName.ManifestAppDescrVar,
-    extensions: constants_1.FileName.ExtConfigJson,
-    libraries: constants_1.FileName.Manifest
+    applications: [constants_1.FileName.Manifest],
+    adaptations: [constants_1.FileName.ManifestAppDescrVar],
+    extensions: [constants_1.FileName.ExtConfigJson],
+    libraries: [constants_1.FileName.Library, constants_1.FileName.Manifest]
 };
 /**
  * Default folders to exclude from search.
@@ -337,6 +337,30 @@ function filterExtensions(pathMap) {
         return results;
     });
 }
+/**
+ * Find and filter libraries with only a `.library` and no `manifest.json`.
+ *
+ * @param pathMap - path to files
+ * @param manifestPaths - paths to manifest.json files
+ * @returns - results as array of found .library projects.
+ */
+function filterDotLibraries(pathMap, manifestPaths) {
+    var _a;
+    return __awaiter(this, void 0, void 0, function* () {
+        const dotLibraries = [];
+        const dotLibraryPaths = Object.keys(pathMap)
+            .filter((path) => (0, path_1.basename)(path) === constants_1.FileName.Library)
+            .map((path) => (0, path_1.dirname)(path))
+            .filter((path) => !manifestPaths.map((manifestPath) => (0, path_1.dirname)(manifestPath)).includes(path));
+        if (dotLibraryPaths) {
+            for (const libraryPath of dotLibraryPaths) {
+                const projectRoot = (0, path_1.dirname)((_a = (yield (0, file_1.findFileUp)(constants_1.FileName.Package, (0, path_1.dirname)(libraryPath)))) !== null && _a !== void 0 ? _a : libraryPath);
+                dotLibraries.push({ projectRoot, libraryPath });
+            }
+        }
+        return dotLibraries;
+    });
+}
 /**
  * Filter extensions projects from a list of files.
  *
@@ -348,6 +372,7 @@ function filterLibraries(pathMap) {
     return __awaiter(this, void 0, void 0, function* () {
         const results = [];
         const manifestPaths = Object.keys(pathMap).filter((path) => (0, path_1.basename)(path) === constants_1.FileName.Manifest);
+        results.push(...(yield filterDotLibraries(pathMap, manifestPaths)));
         for (const manifestPath of manifestPaths) {
             try {
                 (_a = pathMap[manifestPath]) !== null && _a !== void 0 ? _a : (pathMap[manifestPath] = yield (0, file_1.readJSON)(manifestPath));
@@ -377,7 +402,7 @@ function getFilterFileNames(artifacts) {
     const uniqueFilterFiles = new Set();
     for (const artifact of artifacts) {
         if (filterFileMap[artifact]) {
-            uniqueFilterFiles.add(filterFileMap[artifact]);
+            filterFileMap[artifact].forEach((artifactFile) => uniqueFilterFiles.add(artifactFile));
         }
     }
     return Array.from(uniqueFilterFiles);

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

@@ -8,13 +8,89 @@ interface BaseAccess {
 }
 export interface ApplicationAccess extends BaseAccess {
     readonly app: ApplicationStructure;
+    /**
+     * 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: NewI18nEntry[]): Promise<boolean>;
+    /**
+     * 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: NewI18nEntry[], modelKey?: string): Promise<boolean>;
+    /**
+     * 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: NewI18nEntry[]): Promise<boolean>;
+    /**
+     * 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: string, newI18nEntries: NewI18nEntry[]): Promise<boolean>;
+    /**
+     * 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(): string;
+    /**
+     * Return the absolute application root path.
+     *
+     * @returns - Application root path
+     */
     getAppRoot(): string;
+    /**
+     * 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(): Promise<I18nBundles>;
+    /**
+     * Return absolute paths to i18n.properties files from manifest.
+     *
+     * @returns absolute paths to i18n.properties
+     */
     getI18nPropertiesPaths(): Promise<I18nPropertiesPaths>;
 }
 export interface ProjectAccess extends BaseAccess {

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

@@ -129,6 +129,12 @@ interface Entity extends Struct {
     };
 }
 interface LinkedDefinition {
+    /**
+     * Checks if the definition is of the specified kind or has the 'Association' or 'Composition' kind.
+     *
+     * @param {kind | 'Association' | 'Composition'} kind - The kind to check for.
+     * @returns {boolean} - True if the definition is of the specified kind or has the 'Association' or 'Composition' kind, false otherwise.
+     */
     is(kind: kind | 'Association' | 'Composition'): boolean;
     name: string;
 }

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

@@ -70,12 +70,16 @@ export interface LibraryResults {
     /**
      * Path to the manifest.json of the library.
      */
-    manifestPath: string;
+    manifestPath?: string;
     /**
      * Parsed content of the manifest.json to avoid multiple reads when working with
      * the search results.
      */
-    manifest: Manifest;
+    manifest?: Manifest;
+    /**
+     * Path to the .library file of the library, if existing.
+     */
+    libraryPath?: string;
 }
 export interface FoundFioriArtifacts {
     applications?: AllAppResults[];

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

@@ -14,5 +14,9 @@ export interface I18nBundles {
      * i18n bundle for cap services
      */
     service: I18nBundle;
+    /**
+     * Optional errors object containing error records of i18n bundles
+     */
+    errors?: Record<string, Error>;
 }
 //# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap-ux/project-access",
-  "version": "1.17.4",
+  "version": "1.17.6",
   "description": "Library to access SAP Fiori tools projects",
   "repository": {
     "type": "git",