@sap-ux/project-access 1.13.8 → 1.15.0

package/dist/index.d.ts

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

package/dist/index.js

@@ -14,7 +14,7 @@ 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.getNodeModulesPath = exports.getMtaPath = exports.getCapProjectType = exports.getCapModelAndServices = exports.getCapEnvironment = exports.getCapCustomPaths = exports.getAppProgrammingLanguage = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findFioriArtifacts = exports.findCapProjects = exports.findAllApps = exports.FileName = void 0;
+exports.getFilePaths = exports.readUi5Yaml = exports.readCapServiceMetadataEdmx = exports.loadModuleFromProject = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.getWebappPath = exports.getNodeModulesPath = exports.getMtaPath = exports.getCdsServices = exports.getCdsRoots = exports.getCdsFiles = exports.getCapProjectType = exports.getCapModelAndServices = exports.getCapEnvironment = exports.getCapCustomPaths = exports.getAppProgrammingLanguage = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findFioriArtifacts = exports.findCapProjects = exports.findAllApps = exports.FileName = void 0;
 var constants_1 = require("./constants");
 Object.defineProperty(exports, "FileName", { enumerable: true, get: function () { return constants_1.FileName; } });
 var project_1 = require("./project");
@@ -28,6 +28,9 @@ Object.defineProperty(exports, "getCapCustomPaths", { enumerable: true, get: fun
 Object.defineProperty(exports, "getCapEnvironment", { enumerable: true, get: function () { return project_1.getCapEnvironment; } });
 Object.defineProperty(exports, "getCapModelAndServices", { enumerable: true, get: function () { return project_1.getCapModelAndServices; } });
 Object.defineProperty(exports, "getCapProjectType", { enumerable: true, get: function () { return project_1.getCapProjectType; } });
+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, "getMtaPath", { enumerable: true, get: function () { return project_1.getMtaPath; } });
 Object.defineProperty(exports, "getNodeModulesPath", { enumerable: true, get: function () { return project_1.getNodeModulesPath; } });
 Object.defineProperty(exports, "getWebappPath", { enumerable: true, get: function () { return project_1.getWebappPath; } });

package/dist/project/cap.d.ts

@@ -1,7 +1,8 @@
-import type { CapCustomPaths, CapProjectType, CdsEnvironment, csn, Package } from '../types';
+import type { CapCustomPaths, CapProjectType, CdsEnvironment, csn, Package, ServiceDefinitions } from '../types';
 interface ServiceInfo {
     name: string;
     urlPath: string;
+    runtime?: string;
 }
 /**
  * Returns true if the project is a CAP Node.js project.
@@ -42,6 +43,31 @@ export declare function getCapModelAndServices(projectRoot: string): Promise<{
     model: csn;
     services: ServiceInfo[];
 }>;
+/**
+ * Returns a list of cds file paths (layers). By default return list of all, but you can also restrict it to one envRoot.
+ *
+ * @param projectRoot - root of the project, where the package.json is
+ * @param [ignoreErrors] - optionally, default is false; if set to true the thrown error will be checked for CDS file paths in model and returned
+ * @param [envRoot] - optionally, the root folder or CDS file to get the layer files
+ * @returns - array of strings containing cds file paths
+ */
+export declare function getCdsFiles(projectRoot: string, ignoreErrors?: boolean, envRoot?: string | string[]): Promise<string[]>;
+/**
+ * Returns a list of filepaths to CDS files in root folders. Same what is done if you execute cds.resolve('*') on command line in a project.
+ *
+ * @param projectRoot - root of the project, where the package.json is
+ * @param [clearCache] - optionally, clear the cache, default false
+ * @returns - array of root paths
+ */
+export declare function getCdsRoots(projectRoot: string, clearCache?: boolean): Promise<string[]>;
+/**
+ * Return a list of services in a CAP project.
+ *
+ * @param projectRoot - root of the CAP project, where the package.json is
+ * @param ignoreErrors - in case loading the cds model throws an error, try to use the model from the exception object
+ * @returns - array of service definitions
+ */
+export declare function getCdsServices(projectRoot: string, ignoreErrors?: boolean): Promise<ServiceDefinitions[]>;
 /**
  * Return the EDMX string of a CAP service.
  *

package/dist/project/cap.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toReferenceUri = exports.toAbsoluteUri = exports.getCapEnvironment = exports.readCapServiceMetadataEdmx = exports.getCapModelAndServices = exports.getCapCustomPaths = exports.getCapProjectType = exports.isCapJavaProject = exports.isCapNodeJsProject = void 0;
+exports.toReferenceUri = exports.toAbsoluteUri = exports.getCapEnvironment = exports.readCapServiceMetadataEdmx = exports.getCdsServices = exports.getCdsRoots = exports.getCdsFiles = exports.getCapModelAndServices = exports.getCapCustomPaths = exports.getCapProjectType = exports.isCapJavaProject = exports.isCapNodeJsProject = void 0;
 const child_process_1 = require("child_process");
 const path_1 = require("path");
 const constants_1 = require("../constants");
@@ -120,7 +120,8 @@ function getCapModelAndServices(projectRoot) {
             services = services.map((value) => {
                 return {
                     name: value.name,
-                    urlPath: uniformUrl(value.urlPath)
+                    urlPath: uniformUrl(value.urlPath),
+                    runtime: value.runtime
                 };
             });
         }
@@ -131,6 +132,133 @@ function getCapModelAndServices(projectRoot) {
     });
 }
 exports.getCapModelAndServices = getCapModelAndServices;
+/**
+ * Returns a list of cds file paths (layers). By default return list of all, but you can also restrict it to one envRoot.
+ *
+ * @param projectRoot - root of the project, where the package.json is
+ * @param [ignoreErrors] - optionally, default is false; if set to true the thrown error will be checked for CDS file paths in model and returned
+ * @param [envRoot] - optionally, the root folder or CDS file to get the layer files
+ * @returns - array of strings containing cds file paths
+ */
+function getCdsFiles(projectRoot, ignoreErrors = false, envRoot) {
+    var _a, _b;
+    return __awaiter(this, void 0, void 0, function* () {
+        let cdsFiles = [];
+        try {
+            let csn;
+            envRoot !== null && envRoot !== void 0 ? envRoot : (envRoot = yield getCdsRoots(projectRoot));
+            try {
+                const cds = yield loadCdsModuleFromProject(projectRoot);
+                csn = yield cds.load(envRoot);
+                cdsFiles = [...((_a = csn['$sources']) !== null && _a !== void 0 ? _a : [])];
+            }
+            catch (e) {
+                if (ignoreErrors && ((_b = e.model) === null || _b === void 0 ? void 0 : _b.sources) && typeof e.model.sources === 'object') {
+                    cdsFiles.push(...extractCdsFilesFromMessage(e.model.sources));
+                }
+                else {
+                    throw e;
+                }
+            }
+        }
+        catch (error) {
+            throw Error(`Error while retrieving the list of cds files for project ${projectRoot}, envRoot ${envRoot}. Error was: ${error}`);
+        }
+        return cdsFiles;
+    });
+}
+exports.getCdsFiles = getCdsFiles;
+/**
+ * Returns a list of filepaths to CDS files in root folders. Same what is done if you execute cds.resolve('*') on command line in a project.
+ *
+ * @param projectRoot - root of the project, where the package.json is
+ * @param [clearCache] - optionally, clear the cache, default false
+ * @returns - array of root paths
+ */
+function getCdsRoots(projectRoot, clearCache = false) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const roots = [];
+        const capCustomPaths = yield getCapCustomPaths(projectRoot);
+        const cdsEnvRoots = [capCustomPaths.db, capCustomPaths.srv, capCustomPaths.app, 'schema', 'services'];
+        // clear cache is enforced to also resolve newly created cds file at design time
+        const cds = yield loadCdsModuleFromProject(projectRoot);
+        if (clearCache) {
+            cds.resolve.cache = {};
+        }
+        for (const cdsEnvRoot of cdsEnvRoots) {
+            const resolvedRoots = cds.resolve((0, path_1.join)(projectRoot, cdsEnvRoot), {
+                skipModelCache: true
+            }) || [];
+            for (const resolvedRoot of resolvedRoots) {
+                roots.push(resolvedRoot);
+            }
+        }
+        return roots;
+    });
+}
+exports.getCdsRoots = getCdsRoots;
+/**
+ * Return a list of services in a CAP project.
+ *
+ * @param projectRoot - root of the CAP project, where the package.json is
+ * @param ignoreErrors - in case loading the cds model throws an error, try to use the model from the exception object
+ * @returns - array of service definitions
+ */
+function getCdsServices(projectRoot, ignoreErrors = true) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let cdsServices = [];
+        try {
+            const cds = yield loadCdsModuleFromProject(projectRoot);
+            const roots = yield getCdsRoots(projectRoot);
+            let model;
+            try {
+                model = yield cds.load(roots);
+            }
+            catch (e) {
+                if (ignoreErrors && e.model) {
+                    model = e.model;
+                }
+                else {
+                    throw e;
+                }
+            }
+            const linked = cds.linked(model);
+            if (Array.isArray(linked.services)) {
+                cdsServices = linked.services;
+            }
+            else {
+                Object.keys(linked.services).forEach((service) => {
+                    cdsServices.push(linked.services[service]);
+                });
+            }
+        }
+        catch (error) {
+            throw Error(`Error while resolving cds roots for '${projectRoot}'. ${error}`);
+        }
+        return cdsServices;
+    });
+}
+exports.getCdsServices = getCdsServices;
+/**
+ * When an error occurs while trying to read cds files, the error object contains the source file
+ * information. This function extracts this file paths.
+ *
+ * @param sources - map containing the file name
+ * @returns - array of strings containing cds file paths
+ */
+function extractCdsFilesFromMessage(sources) {
+    const cdsFiles = [];
+    for (const source in sources) {
+        let filename = sources[source].filename;
+        if (typeof filename === 'string' && !filename.startsWith(path_1.sep)) {
+            filename = (0, path_1.join)(path_1.sep, filename);
+        }
+        if (filename) {
+            cdsFiles.push(filename);
+        }
+    }
+    return cdsFiles;
+}
 /**
  * Remove rogue '\\' - cds windows if needed.
  * Replaces all backslashes with forward slashes, removes double slashes, and trailing slashes.

package/dist/project/index.d.ts

@@ -1,4 +1,4 @@
-export { getCapCustomPaths, getCapModelAndServices, getCapProjectType, isCapJavaProject, isCapNodeJsProject, getCapEnvironment, readCapServiceMetadataEdmx } from './cap';
+export { getCapCustomPaths, getCapModelAndServices, getCapProjectType, getCdsFiles, getCdsRoots, getCdsServices, isCapJavaProject, isCapNodeJsProject, getCapEnvironment, readCapServiceMetadataEdmx } from './cap';
 export { getNodeModulesPath } from './dependencies';
 export { getAppProgrammingLanguage } from './info';
 export { loadModuleFromProject } from './module-loader';

package/dist/project/index.js

@@ -1,10 +1,13 @@
 "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.getAppProgrammingLanguage = exports.getNodeModulesPath = exports.readCapServiceMetadataEdmx = exports.getCapEnvironment = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.getCapProjectType = exports.getCapModelAndServices = exports.getCapCustomPaths = void 0;
+exports.getMtaPath = exports.readUi5Yaml = exports.getWebappPath = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findFioriArtifacts = exports.findCapProjects = exports.findAllApps = exports.loadModuleFromProject = exports.getAppProgrammingLanguage = 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; } });
 Object.defineProperty(exports, "getCapProjectType", { enumerable: true, get: function () { return cap_1.getCapProjectType; } });
+Object.defineProperty(exports, "getCdsFiles", { enumerable: true, get: function () { return cap_1.getCdsFiles; } });
+Object.defineProperty(exports, "getCdsRoots", { enumerable: true, get: function () { return cap_1.getCdsRoots; } });
+Object.defineProperty(exports, "getCdsServices", { enumerable: true, get: function () { return cap_1.getCdsServices; } });
 Object.defineProperty(exports, "isCapJavaProject", { enumerable: true, get: function () { return cap_1.isCapJavaProject; } });
 Object.defineProperty(exports, "isCapNodeJsProject", { enumerable: true, get: function () { return cap_1.isCapNodeJsProject; } });
 Object.defineProperty(exports, "getCapEnvironment", { enumerable: true, get: function () { return cap_1.getCapEnvironment; } });

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

@@ -81,6 +81,7 @@ export interface CSN {
     extensions?: Definition[];
     $sources?: string[];
 }
+export type ServiceDefinitions = Definitions & ((namespace: string) => Definitions) & any[];
 interface DefinitionRegistry {
     type: Type;
     struct: Struct;
@@ -127,6 +128,12 @@ interface Entity extends Struct {
         [name: string]: Definition;
     };
 }
+interface LinkedDefinition {
+    is(kind: kind | 'Association' | 'Composition'): boolean;
+    name: string;
+}
+type Filter = string | ((def: Definition) => boolean);
+type Visitor = (def: Definition, name: string, parent: Definition, defs: Definitions) => void;
 interface Association extends Type {
     type: 'cds.Association' | 'cds.Composition';
     /** The fully-qualified name of the Association's target entity */
@@ -142,5 +149,73 @@ interface Association extends Type {
     /** The optionally specified keys in case of managed Associations */
     keys?: column_expr[];
 }
+export interface LinkedModel extends CSN {
+    /**
+     * Fetches definitions matching the given filter, returning an iterator on them.
+     *
+     * @example
+     * 		let m = cds.reflect (aParsedModel)
+     *      for (let d of m.each('entity'))  console.log (d.kind, d.name)
+     *      let entities = [...m.each('entity')]  //> capture all
+     *      let entities = m.all('entity')          //> equivalent shortcut
+     */
+    each(x: Filter, defs?: Definitions): IterableIterator<LinkedDefinition>;
+    /**
+     * Fetches definitions matching the given filter, returning them in an array.
+     * Convenience shortcut for `[...reflect.each('entity')]`
+     */
+    all(x: Filter, defs?: Definitions): LinkedDefinition[];
+    /**
+     * Fetches definitions matching the given filter, returning the first match, if any.
+     *
+     * @example
+     *      let service = model.find('service')
+     * @param {Filter} [x]  the filter
+     * @param {Definitions} [defs]  the definitions to fetch in, default: `this.definitions`
+     */
+    find(x: Filter, defs?: Definitions): LinkedDefinition;
+    /**
+     * Calls the visitor for each definition matching the given filter.
+     *
+     * @see [capire](https://github.wdf.sap.corp/pages/cap/node.js/api#cds-reflect-foreach)
+     */
+    foreach(x?: Filter, visitor?: Visitor, defs?: Definitions): this;
+    /**
+     * Same as foreach but recursively visits each element definition
+     *
+     * @see [capire](https://github.wdf.sap.corp/pages/cap/node.js/api#cds-reflect-foreach)
+     */
+    forall(x?: Filter, visitor?: Visitor, defs?: Definitions): this;
+    /**
+     * Fetches definitions declared as children of a given parent context or service.
+     * It fetches all definitions whose fully-qualified names start with the parent's name.
+     * Returns the found definitions as an object with the local names as keys.
+     *
+     * @example
+     *      let service = model.find ('service')
+     *      let entities = m.childrenOf (service)
+     * @param parent  either the parent itself or its fully-qualified name
+     * @param filter  an optional filter to apply before picking a child
+     */
+    childrenOf(parent: LinkedDefinition | string, filter?: (def: Definition) => boolean): Definitions;
+    /**
+     * Provides convenient access to the model's top-level definitions.
+     * For example, you can use it in an es6-import-like fashion to avoid
+     * working with fully-qualified names as follows:
+     *
+     * @example
+     * let model = cds.reflect (cds.parse(`
+     *     namespace our.lovely.bookshop;
+     *     entity Books {...}
+     *     entity Authors {...}
+     * `))
+     * const {Books,Authors} = model.exports
+     * SELECT.from (Books) .where ({ID:11})
+     */
+    exports: Definitions & ((namespace: string) => Definitions);
+    entities: Definitions & ((namespace: string) => Definitions);
+    services: Definitions & ((namespace: string) => Definitions);
+    definitions: Definitions;
+}
 export {};
 //# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap-ux/project-access",
-  "version": "1.13.8",
+  "version": "1.15.0",
   "description": "Library to access SAP Fiori tools projects",
   "repository": {
     "type": "git",
@@ -21,13 +21,13 @@
   ],
   "engines": {
     "pnpm": ">=6.26.1 < 7.0.0 || >=7.1.0",
-    "node": ">= 14.16.0 < 15.0.0 || >=16.1.0 < 17.0.0 || >=18.0.0 < 19.0.0"
+    "node": ">=18.x"
   },
   "dependencies": {
     "findit2": "2.2.3",
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",
-    "@sap-ux/ui5-config": "0.19.5"
+    "@sap-ux/ui5-config": "0.20.0"
   },
   "devDependencies": {
     "@types/mem-fs": "1.1.2",