@sap-ux/project-access 1.23.0 → 1.24.0

package/dist/command/index.d.ts

@@ -0,0 +1,2 @@
+export { execNpmCommand } from './npm-command';
+//# sourceMappingURL=index.d.ts.map

package/dist/command/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.execNpmCommand = void 0;
+var npm_command_1 = require("./npm-command");
+Object.defineProperty(exports, "execNpmCommand", { enumerable: true, get: function () { return npm_command_1.execNpmCommand; } });
+//# sourceMappingURL=index.js.map

package/dist/command/npm-command.d.ts

@@ -0,0 +1,15 @@
+import type { Logger } from '@sap-ux/logger';
+/**
+ * Execute an npm command.
+ *
+ * @param commandArguments - command arguments as array, e.g. ['install', '@sap/ux-specification@1.2.3']
+ * @param [options] - optional options
+ * @param [options.cwd] - optional current working directory
+ * @param [options.logger] - optional logger instance
+ * @returns - stdout of the command
+ */
+export declare function execNpmCommand(commandArguments: string[], options?: {
+    cwd?: string;
+    logger?: Logger;
+}): Promise<string>;
+//# sourceMappingURL=npm-command.d.ts.map

package/dist/command/npm-command.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.execNpmCommand = void 0;
+const child_process_1 = require("child_process");
+/**
+ * Execute an npm command.
+ *
+ * @param commandArguments - command arguments as array, e.g. ['install', '@sap/ux-specification@1.2.3']
+ * @param [options] - optional options
+ * @param [options.cwd] - optional current working directory
+ * @param [options.logger] - optional logger instance
+ * @returns - stdout of the command
+ */
+async function execNpmCommand(commandArguments, options) {
+    return new Promise((resolve, reject) => {
+        const isWin = process.platform.startsWith('win');
+        // Command to execute npm is platform specific, 'npm.cmd' on windows, 'npm' otherwise
+        const npmCommand = isWin ? 'npm.cmd' : 'npm';
+        // Platform specific spawn options, 'windowsVerbatimArguments' and 'shell' true on windows
+        const defaultSpawnOptions = isWin ? { windowsVerbatimArguments: true, shell: true } : {};
+        const logger = options?.logger;
+        const cwd = options?.cwd;
+        const spawnOptions = typeof cwd === 'string' ? { ...defaultSpawnOptions, cwd } : defaultSpawnOptions;
+        const spawnProcess = (0, child_process_1.spawn)(npmCommand, commandArguments, spawnOptions);
+        let stdOut = '';
+        let stdErr = '';
+        spawnProcess.stdout.on('data', (data) => {
+            stdOut += data.toString();
+        });
+        spawnProcess.stderr.on('data', (data) => {
+            stdErr += data.toString();
+        });
+        spawnProcess.on('exit', () => {
+            if (logger) {
+                const commandString = `${npmCommand} ${commandArguments.join(' ')}`;
+                if (stdErr) {
+                    logger.error(`Command '${commandString}' not successful, stderr: ${stdErr}`);
+                }
+                if (stdOut) {
+                    logger.info(`Command '${commandString}' successful, stdout: ${stdOut}`);
+                }
+            }
+            resolve(stdOut);
+        });
+        spawnProcess.on('error', (error) => {
+            logger?.error(`Error executing npm command '${npmCommand} ${commandArguments.join(' ')}': ${error}`);
+            reject(error);
+        });
+    });
+}
+exports.execNpmCommand = execNpmCommand;
+//# sourceMappingURL=npm-command.js.map

package/dist/constants.d.ts

@@ -8,6 +8,7 @@ export declare const FileName: {
     readonly MtaYaml: "mta.yaml";
     readonly Package: "package.json";
     readonly Pom: "pom.xml";
+    readonly SpecificationDistTags: "specification-dist-tags.json";
     readonly Tsconfig: "tsconfig.json";
     readonly Ui5Yaml: "ui5.yaml";
     readonly Ui5LocalYaml: "ui5-local.yaml";
@@ -16,6 +17,7 @@ export declare const FileName: {
 };
 export declare const DirName: {
     readonly Changes: "changes";
+    readonly ModuleCache: "module-cache";
     readonly Schemas: ".schemas";
     readonly Pages: "pages";
     readonly Webapp: "webapp";
@@ -44,4 +46,12 @@ export declare const FioriToolsSettings: {
 export declare const SchemaName: {
     readonly Ftfs: "ftfs";
 };
+/**
+ * Directory where fiori tools settings are stored
+ */
+export declare const fioriToolsDirectory: string;
+/**
+ * Directory where modules are cached
+ */
+export declare const moduleCacheRoot: string;
 //# sourceMappingURL=constants.d.ts.map

package/dist/constants.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SchemaName = exports.FioriToolsSettings = exports.DirName = exports.FileName = void 0;
+exports.moduleCacheRoot = exports.fioriToolsDirectory = exports.SchemaName = exports.FioriToolsSettings = exports.DirName = exports.FileName = void 0;
+const os_1 = require("os");
+const path_1 = require("path");
 exports.FileName = {
     AdaptationConfig: 'config.json',
     CapJavaApplicationYaml: 'application.yaml',
@@ -11,6 +13,7 @@ exports.FileName = {
     MtaYaml: 'mta.yaml',
     Package: 'package.json',
     Pom: 'pom.xml',
+    SpecificationDistTags: 'specification-dist-tags.json',
     Tsconfig: 'tsconfig.json',
     Ui5Yaml: 'ui5.yaml',
     Ui5LocalYaml: 'ui5-local.yaml',
@@ -19,6 +22,7 @@ exports.FileName = {
 };
 exports.DirName = {
     Changes: 'changes',
+    ModuleCache: 'module-cache',
     Schemas: '.schemas',
     Pages: 'pages',
     Webapp: 'webapp',
@@ -47,4 +51,12 @@ exports.FioriToolsSettings = {
 exports.SchemaName = {
     Ftfs: 'ftfs'
 };
+/**
+ * Directory where fiori tools settings are stored
+ */
+exports.fioriToolsDirectory = (0, path_1.join)((0, os_1.homedir)(), exports.FioriToolsSettings.dir);
+/**
+ * Directory where modules are cached
+ */
+exports.moduleCacheRoot = (0, path_1.join)(exports.fioriToolsDirectory, exports.DirName.ModuleCache);
 //# sourceMappingURL=constants.js.map

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 export { FileName, DirName, FioriToolsSettings } from './constants';
 export { getFilePaths } from './file';
-export { addPackageDevDependency, createApplicationAccess, createProjectAccess, findAllApps, findCapProjects, findFioriArtifacts, findProjectRoot, getAppRootFromWebappPath, getAppProgrammingLanguage, getAppType, getCapCustomPaths, getCapEnvironment, getCapModelAndServices, getCapProjectType, getCdsFiles, getCdsRoots, getCdsServices, getCapI18nFolderNames, getI18nPropertiesPaths, getMinUI5VersionFromManifest, getMinUI5VersionAsArray, getMinimumUI5Version, getMtaPath, getNodeModulesPath, getProject, getProjectType, getWebappPath, isCapProject, isCapJavaProject, isCapNodeJsProject, loadModuleFromProject, readCapServiceMetadataEdmx, readUi5Yaml, toReferenceUri, filterDataSourcesByType, clearCdsModuleCache, updatePackageScript } from './project';
+export { addPackageDevDependency, clearCdsModuleCache, createApplicationAccess, createProjectAccess, findAllApps, findCapProjects, findFioriArtifacts, findProjectRoot, getAppRootFromWebappPath, getAppProgrammingLanguage, getAppType, getCapCustomPaths, getCapEnvironment, getCapModelAndServices, getCapProjectType, getCdsFiles, getCdsRoots, getCdsServices, getCapI18nFolderNames, getSpecification, getI18nPropertiesPaths, getMinUI5VersionFromManifest, getMinUI5VersionAsArray, getMinimumUI5Version, getMtaPath, getNodeModulesPath, getProject, getProjectType, getWebappPath, isCapProject, isCapJavaProject, isCapNodeJsProject, loadModuleFromProject, readCapServiceMetadataEdmx, readUi5Yaml, refreshSpecificationDistTags, toReferenceUri, filterDataSourcesByType, updatePackageScript } from './project';
 export * from './types';
 export * from './library';
 //# 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.updatePackageScript = exports.clearCdsModuleCache = exports.filterDataSourcesByType = exports.toReferenceUri = exports.readUi5Yaml = exports.readCapServiceMetadataEdmx = exports.loadModuleFromProject = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.isCapProject = exports.getWebappPath = exports.getProjectType = exports.getProject = exports.getNodeModulesPath = exports.getMtaPath = exports.getMinimumUI5Version = exports.getMinUI5VersionAsArray = exports.getMinUI5VersionFromManifest = 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.addPackageDevDependency = exports.getFilePaths = exports.FioriToolsSettings = exports.DirName = exports.FileName = void 0;
+exports.updatePackageScript = exports.filterDataSourcesByType = exports.toReferenceUri = exports.refreshSpecificationDistTags = exports.readUi5Yaml = exports.readCapServiceMetadataEdmx = exports.loadModuleFromProject = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.isCapProject = exports.getWebappPath = exports.getProjectType = exports.getProject = exports.getNodeModulesPath = exports.getMtaPath = exports.getMinimumUI5Version = exports.getMinUI5VersionAsArray = exports.getMinUI5VersionFromManifest = exports.getI18nPropertiesPaths = exports.getSpecification = 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.clearCdsModuleCache = exports.addPackageDevDependency = exports.getFilePaths = exports.FioriToolsSettings = exports.DirName = exports.FileName = void 0;
 var constants_1 = require("./constants");
 Object.defineProperty(exports, "FileName", { enumerable: true, get: function () { return constants_1.FileName; } });
 Object.defineProperty(exports, "DirName", { enumerable: true, get: function () { return constants_1.DirName; } });
@@ -23,6 +23,7 @@ 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, "addPackageDevDependency", { enumerable: true, get: function () { return project_1.addPackageDevDependency; } });
+Object.defineProperty(exports, "clearCdsModuleCache", { enumerable: true, get: function () { return project_1.clearCdsModuleCache; } });
 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; } });
@@ -40,6 +41,7 @@ Object.defineProperty(exports, "getCdsFiles", { enumerable: true, get: function
 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, "getSpecification", { enumerable: true, get: function () { return project_1.getSpecification; } });
 Object.defineProperty(exports, "getI18nPropertiesPaths", { enumerable: true, get: function () { return project_1.getI18nPropertiesPaths; } });
 Object.defineProperty(exports, "getMinUI5VersionFromManifest", { enumerable: true, get: function () { return project_1.getMinUI5VersionFromManifest; } });
 Object.defineProperty(exports, "getMinUI5VersionAsArray", { enumerable: true, get: function () { return project_1.getMinUI5VersionAsArray; } });
@@ -55,9 +57,9 @@ 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; } });
+Object.defineProperty(exports, "refreshSpecificationDistTags", { enumerable: true, get: function () { return project_1.refreshSpecificationDistTags; } });
 Object.defineProperty(exports, "toReferenceUri", { enumerable: true, get: function () { return project_1.toReferenceUri; } });
 Object.defineProperty(exports, "filterDataSourcesByType", { enumerable: true, get: function () { return project_1.filterDataSourcesByType; } });
-Object.defineProperty(exports, "clearCdsModuleCache", { enumerable: true, get: function () { return project_1.clearCdsModuleCache; } });
 Object.defineProperty(exports, "updatePackageScript", { enumerable: true, get: function () { return project_1.updatePackageScript; } });
 __exportStar(require("./types"), exports);
 __exportStar(require("./library"), exports);

package/dist/project/access.d.ts

@@ -1,4 +1,4 @@
-import type { ApplicationAccess, ProjectAccess } from '../types';
+import type { ApplicationAccess, ApplicationAccessOptions, ProjectAccess, ProjectAccessOptions } from '../types';
 import type { Editor } from 'mem-fs-editor';
 /**
  * Create an instance of ApplicationAccess that contains information about the application, like paths and services.
@@ -9,12 +9,13 @@ import type { Editor } from '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>;
+export declare function createApplicationAccess(appRoot: string, fs?: Editor | ApplicationAccessOptions): Promise<ApplicationAccess>;
 /**
  * Create an instance of ProjectAccess that contains information about the project, like applications, paths, services.
  *
  * @param root - Project root path
+ * @param options - optional options, e.g. logger instance.
  * @returns - Instance of ProjectAccess that contains information about the project
  */
-export declare function createProjectAccess(root: string): Promise<ProjectAccess>;
+export declare function createProjectAccess(root: string, options?: ProjectAccessOptions): Promise<ProjectAccess>;
 //# sourceMappingURL=access.d.ts.map

package/dist/project/access.js

@@ -7,24 +7,26 @@ const info_1 = require("./info");
 const search_1 = require("./search");
 const file_1 = require("../file");
 const constants_1 = require("../constants");
+const specification_1 = require("./specification");
 /**
  *
  */
 class ApplicationAccessImp {
     _project;
     appId;
-    fs;
+    options;
     /**
      * Constructor for ApplicationAccess.
      *
      * @param _project - Project structure
      * @param appId - Application ID
-     * @param fs optional `mem-fs-editor` instance.
+     * @param options - optional options, see below
+     * @param options.fs - optional `mem-fs-editor` instance
      */
-    constructor(_project, appId, fs) {
+    constructor(_project, appId, options) {
         this._project = _project;
         this.appId = appId;
-        this.fs = fs;
+        this.options = options;
     }
     /**
      * Returns the application structure.
@@ -55,7 +57,7 @@ class ApplicationAccessImp {
      * ```
      */
     createAnnotationI18nEntries(newEntries) {
-        return (0, i18n_1.createAnnotationI18nEntries)(this.project.root, this.app.manifest, this.app.i18n, newEntries, this.fs);
+        return (0, i18n_1.createAnnotationI18nEntries)(this.project.root, this.app.manifest, this.app.i18n, newEntries, this.options?.fs);
     }
     /**
      * Maintains new translation entries in an existing i18n file or in a new i18n properties file if it does not exist.
@@ -79,7 +81,7 @@ class ApplicationAccessImp {
      * ```
      */
     createUI5I18nEntries(newEntries, modelKey = 'i18n') {
-        return (0, i18n_1.createUI5I18nEntries)(this.project.root, this.app.manifest, this.app.i18n, newEntries, modelKey, this.fs);
+        return (0, i18n_1.createUI5I18nEntries)(this.project.root, this.app.manifest, this.app.i18n, newEntries, modelKey, this.options?.fs);
     }
     /**
      * Maintains new translation entries in an existing i18n file or in a new i18n properties file if it does not exist.
@@ -89,7 +91,7 @@ class ApplicationAccessImp {
      * @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);
+        return (0, i18n_1.createManifestI18nEntries)(this.project.root, this.app.i18n, newEntries, this.options?.fs);
     }
     /**
      * Maintains new translation entries in CAP i18n files.
@@ -99,7 +101,7 @@ class ApplicationAccessImp {
      * @returns boolean or exception
      */
     createCapI18nEntries(filePath, newI18nEntries) {
-        return (0, i18n_1.createCapI18nEntries)(this.project.root, filePath, newI18nEntries, this.fs);
+        return (0, i18n_1.createCapI18nEntries)(this.project.root, filePath, newI18nEntries, this.options?.fs);
     }
     /**
      * Return the application id of this app, which is the relative path from the project root
@@ -124,7 +126,7 @@ class ApplicationAccessImp {
      * @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);
+        return (0, i18n_1.getI18nBundles)(this.project.root, this.app.i18n, this.project.projectType, this.options?.fs);
     }
     /**
      * Return absolute paths to i18n.properties files from manifest.
@@ -134,6 +136,14 @@ class ApplicationAccessImp {
     getI18nPropertiesPaths() {
         return (0, i18n_1.getI18nPropertiesPaths)(this.app.manifest);
     }
+    /**
+     * Return an instance of @sap/ux-specification specific to the application version.
+     *
+     * @returns - instance of @sap/ux-specification
+     */
+    async getSpecification() {
+        return (0, specification_1.getSpecification)(this.app.appRoot);
+    }
     /**
      * Updates package.json file asynchronously by keeping the previous indentation.
      *
@@ -183,13 +193,16 @@ class ApplicationAccessImp {
  */
 class ProjectAccessImp {
     _project;
+    options;
     /**
      * Constructor for ProjectAccess.
      *
      * @param _project - Project structure
+     * @param options - optional options, like logger
      */
-    constructor(_project) {
+    constructor(_project, options) {
         this._project = _project;
+        this.options = options;
     }
     /**
      * Returns list of application IDs.
@@ -209,7 +222,7 @@ class ProjectAccessImp {
         if (!this.project.apps[appId]) {
             throw new Error(`Could not find app with id ${appId}`);
         }
-        return new ApplicationAccessImp(this.project, appId);
+        return new ApplicationAccessImp(this.project, appId, this.options);
     }
     /**
      * Project structure.
@@ -236,6 +249,15 @@ class ProjectAccessImp {
         return this.project.root;
     }
 }
+/**
+ * Type guard for Editor or ApplicationAccessOptions.
+ *
+ * @param argument - argument to check
+ * @returns true if argument is Editor, false if it is ApplicationAccessOptions
+ */
+function isEditor(argument) {
+    return argument.commit !== undefined;
+}
 /**
  * Create an instance of ApplicationAccess that contains information about the application, like paths and services.
  *
@@ -254,7 +276,11 @@ async function createApplicationAccess(appRoot, fs) {
         }
         const project = await (0, info_1.getProject)(app.projectRoot);
         const appId = (0, path_1.relative)(project.root, appRoot);
-        return new ApplicationAccessImp(project, appId, fs);
+        let options;
+        if (fs) {
+            options = isEditor(fs) ? { fs } : fs;
+        }
+        return new ApplicationAccessImp(project, appId, options);
     }
     catch (error) {
         throw Error(`Error when creating application access for ${appRoot}: ${error}`);
@@ -265,12 +291,13 @@ exports.createApplicationAccess = createApplicationAccess;
  * Create an instance of ProjectAccess that contains information about the project, like applications, paths, services.
  *
  * @param root - Project root path
+ * @param options - optional options, e.g. logger instance.
  * @returns - Instance of ProjectAccess that contains information about the project
  */
-async function createProjectAccess(root) {
+async function createProjectAccess(root, options) {
     try {
         const project = await (0, info_1.getProject)(root);
-        const projectAccess = new ProjectAccessImp(project);
+        const projectAccess = new ProjectAccessImp(project, options);
         return projectAccess;
     }
     catch (error) {

package/dist/project/index.d.ts

@@ -9,4 +9,5 @@ export { getWebappPath, readUi5Yaml } from './ui5-config';
 export { getMtaPath } from './mta';
 export { createApplicationAccess, createProjectAccess } from './access';
 export { updatePackageScript } from './script';
+export { getSpecification, refreshSpecificationDistTags } from './specification';
 //# sourceMappingURL=index.d.ts.map

package/dist/project/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.updatePackageScript = 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.getMinimumUI5Version = exports.getMinUI5VersionAsArray = exports.getMinUI5VersionFromManifest = exports.getAppType = exports.getAppProgrammingLanguage = exports.getI18nPropertiesPaths = exports.getCapI18nFolderNames = exports.getNodeModulesPath = exports.addPackageDevDependency = exports.filterDataSourcesByType = exports.clearCdsModuleCache = exports.toReferenceUri = exports.readCapServiceMetadataEdmx = exports.getCapEnvironment = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.isCapProject = exports.getCdsServices = exports.getCdsRoots = exports.getCdsFiles = exports.getCapProjectType = exports.getCapModelAndServices = exports.getCapCustomPaths = void 0;
+exports.refreshSpecificationDistTags = exports.getSpecification = exports.updatePackageScript = 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.getMinimumUI5Version = exports.getMinUI5VersionAsArray = exports.getMinUI5VersionFromManifest = exports.getAppType = exports.getAppProgrammingLanguage = exports.getI18nPropertiesPaths = exports.getCapI18nFolderNames = exports.getNodeModulesPath = exports.addPackageDevDependency = exports.filterDataSourcesByType = exports.clearCdsModuleCache = exports.toReferenceUri = exports.readCapServiceMetadataEdmx = exports.getCapEnvironment = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.isCapProject = 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; } });
@@ -49,4 +49,7 @@ Object.defineProperty(exports, "createApplicationAccess", { enumerable: true, ge
 Object.defineProperty(exports, "createProjectAccess", { enumerable: true, get: function () { return access_1.createProjectAccess; } });
 var script_1 = require("./script");
 Object.defineProperty(exports, "updatePackageScript", { enumerable: true, get: function () { return script_1.updatePackageScript; } });
+var specification_1 = require("./specification");
+Object.defineProperty(exports, "getSpecification", { enumerable: true, get: function () { return specification_1.getSpecification; } });
+Object.defineProperty(exports, "refreshSpecificationDistTags", { enumerable: true, get: function () { return specification_1.refreshSpecificationDistTags; } });
 //# sourceMappingURL=index.js.map

package/dist/project/module-loader.d.ts

@@ -1,3 +1,4 @@
+import type { Logger } from '@sap-ux/logger';
 /**
  * Load module from project or app. Throws error if module is not installed.
  *
@@ -12,4 +13,23 @@
  * @returns - loaded module.
  */
 export declare function loadModuleFromProject<T>(projectRoot: string, moduleName: string): Promise<T>;
+/**
+ * Get a module, if it is not cached it will be installed and returned.
+ *
+ * @param module - name of the module
+ * @param version - version of the module
+ * @param options - optional options
+ * @param options.logger - optional logger instance
+ * @returns - module
+ */
+export declare function getModule<T>(module: string, version: string, options?: {
+    logger?: Logger;
+}): Promise<T>;
+/**
+ * Delete a module from cache.
+ *
+ * @param module - name of the module
+ * @param version - version of the module
+ */
+export declare function deleteModule(module: string, version: string): Promise<void>;
 //# sourceMappingURL=module-loader.d.ts.map

package/dist/project/module-loader.js

@@ -23,8 +23,13 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadModuleFromProject = void 0;
+exports.deleteModule = exports.getModule = exports.loadModuleFromProject = void 0;
+const fs_1 = require("fs");
+const promises_1 = require("fs/promises");
+const path_1 = require("path");
 const dependencies_1 = require("./dependencies");
+const constants_1 = require("../constants");
+const command_1 = require("../command");
 /**
  * Load module from project or app. Throws error if module is not installed.
  *
@@ -53,4 +58,39 @@ async function loadModuleFromProject(projectRoot, moduleName) {
     return module;
 }
 exports.loadModuleFromProject = loadModuleFromProject;
+/**
+ * Get a module, if it is not cached it will be installed and returned.
+ *
+ * @param module - name of the module
+ * @param version - version of the module
+ * @param options - optional options
+ * @param options.logger - optional logger instance
+ * @returns - module
+ */
+async function getModule(module, version, options) {
+    const logger = options?.logger;
+    const moduleDirectory = (0, path_1.join)(constants_1.moduleCacheRoot, module, version);
+    if (!(0, fs_1.existsSync)((0, path_1.join)(moduleDirectory, constants_1.FileName.Package))) {
+        if ((0, fs_1.existsSync)(moduleDirectory)) {
+            await (0, promises_1.rm)(moduleDirectory, { recursive: true });
+        }
+        await (0, promises_1.mkdir)(moduleDirectory, { recursive: true });
+        await (0, command_1.execNpmCommand)(['install', `${module}@${version}`], { cwd: moduleDirectory, logger });
+    }
+    return loadModuleFromProject(moduleDirectory, module);
+}
+exports.getModule = getModule;
+/**
+ * Delete a module from cache.
+ *
+ * @param module - name of the module
+ * @param version - version of the module
+ */
+async function deleteModule(module, version) {
+    const moduleDirectory = (0, path_1.join)(constants_1.moduleCacheRoot, module, version);
+    if ((0, fs_1.existsSync)(moduleDirectory)) {
+        await (0, promises_1.rm)(moduleDirectory, { recursive: true });
+    }
+}
+exports.deleteModule = deleteModule;
 //# sourceMappingURL=module-loader.js.map

package/dist/project/specification.d.ts

@@ -0,0 +1,24 @@
+import type { Logger } from '@sap-ux/logger';
+/**
+ * Loads and return specification from project or cache.
+ * 1. if package.json contains devDependency to specification, attempts to load from project.
+ * 2. if not in package.json of project, attempts to load from cache.
+ *
+ * @param root - root path of the project/app
+ * @param [options] - optional options
+ * @param [options.logger] - logger instance
+ * @returns - specification instance
+ */
+export declare function getSpecification<T>(root: string, options?: {
+    logger?: Logger;
+}): Promise<T>;
+/**
+ * Refreshes the specification dist-tags cache. Also cleans specification modules in cache that are not required anymore.
+ *
+ * @param [options] - optional options, like logger
+ * @param [options.logger] - logger instance
+ */
+export declare function refreshSpecificationDistTags(options?: {
+    logger?: Logger;
+}): Promise<void>;
+//# sourceMappingURL=specification.d.ts.map

package/dist/project/specification.js

@@ -0,0 +1,129 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.refreshSpecificationDistTags = exports.getSpecification = void 0;
+const fs_1 = require("fs");
+const promises_1 = require("fs/promises");
+const path_1 = require("path");
+const semver_1 = require("semver");
+const module_loader_1 = require("./module-loader");
+const ui5_config_1 = require("./ui5-config");
+const info_1 = require("./info");
+const constants_1 = require("../constants");
+const file_1 = require("../file");
+const command_1 = require("../command");
+const specificationDistTagPath = (0, path_1.join)(constants_1.fioriToolsDirectory, constants_1.FileName.SpecificationDistTags);
+/**
+ * Loads and return specification from project or cache.
+ * 1. if package.json contains devDependency to specification, attempts to load from project.
+ * 2. if not in package.json of project, attempts to load from cache.
+ *
+ * @param root - root path of the project/app
+ * @param [options] - optional options
+ * @param [options.logger] - logger instance
+ * @returns - specification instance
+ */
+async function getSpecification(root, options) {
+    let specification;
+    const logger = options?.logger;
+    try {
+        const packageJson = await (0, file_1.readJSON)((0, path_1.join)(root, constants_1.FileName.Package));
+        if (packageJson.devDependencies?.['@sap/ux-specification']) {
+            logger?.debug(`Specification found in devDependencies of project '${root}', trying to load`);
+            // Early return with load module from project. If it throws an error it is not handled here.
+            return (0, module_loader_1.loadModuleFromProject)(root, '@sap/ux-specification');
+        }
+    }
+    catch {
+        logger?.debug(`Specification not found in project '${root}', trying to load from cache`);
+    }
+    let distTag = 'latest';
+    try {
+        const webappPath = await (0, ui5_config_1.getWebappPath)(root);
+        const manifest = await (0, file_1.readJSON)((0, path_1.join)(webappPath, constants_1.FileName.Manifest));
+        const minUI5Version = (0, info_1.getMinimumUI5Version)(manifest);
+        if (minUI5Version && (0, semver_1.valid)(minUI5Version)) {
+            const [mayor, minor] = minUI5Version.split('.');
+            distTag = `UI5-${mayor}.${minor}`;
+        }
+    }
+    catch (error) {
+        logger?.error(`Failed to get minimum UI5 version from manifest: ${error} using 'latest'`);
+    }
+    try {
+        specification = await getSpecificationByDistTag(distTag, { logger });
+        logger?.debug(`Specification loaded from cache using dist-tag '${distTag}'`);
+    }
+    catch (error) {
+        logger?.error(`Failed to load specification: ${error}`);
+        throw new Error(`Failed to load specification: ${error}`);
+    }
+    return specification;
+}
+exports.getSpecification = getSpecification;
+/**
+ * Refreshes the specification dist-tags cache. Also cleans specification modules in cache that are not required anymore.
+ *
+ * @param [options] - optional options, like logger
+ * @param [options.logger] - logger instance
+ */
+async function refreshSpecificationDistTags(options) {
+    const logger = options?.logger;
+    try {
+        const distTagsString = await (0, command_1.execNpmCommand)(['view', '@sap/ux-specification', 'dist-tags', '--json'], {
+            logger
+        });
+        const distTags = JSON.parse(distTagsString);
+        await (0, file_1.writeFile)(specificationDistTagPath, JSON.stringify(distTags, null, 4));
+        const uniqueVersions = new Set(Object.values(distTags));
+        // Check if we have cached versions that are not required anymore
+        const specificationCachePath = (0, path_1.join)(constants_1.moduleCacheRoot, '@sap/ux-specification');
+        const removeExistingVersions = (0, fs_1.existsSync)(specificationCachePath)
+            ? (await (0, promises_1.readdir)(specificationCachePath, { withFileTypes: true }))
+                .filter((d) => d.isDirectory())
+                .filter((d) => !uniqueVersions.has(d.name))
+                .map((d) => d.name)
+            : [];
+        // Delete cached versions that are not required anymore
+        for (const version of removeExistingVersions) {
+            await (0, module_loader_1.deleteModule)('@sap/ux-specification', version);
+            logger?.debug(`Deleted unused specification module '@sap/ux-specification@${version}' from cache`);
+        }
+    }
+    catch (error) {
+        logger?.error(`Error refreshing specification dist-tags: ${error}`);
+    }
+}
+exports.refreshSpecificationDistTags = refreshSpecificationDistTags;
+/**
+ * Loads and return specification from cache by dist-tag.
+ *
+ * @param distTag - dist-tag of the specification, like 'latest' or 'UI5-1.71'
+ * @param [options] - optional options
+ * @param [options.logger] - optional logger instance
+ * @returns - specification instance
+ */
+async function getSpecificationByDistTag(distTag, options) {
+    const logger = options?.logger;
+    const version = await convertDistTagToVersion(distTag, { logger });
+    const specification = await (0, module_loader_1.getModule)('@sap/ux-specification', version, { logger });
+    return specification;
+}
+/**
+ * Converts dist-tag to version.
+ *
+ * @param distTag - dist-tag of the specification, like 'latest' or 'UI5-1.71'
+ * @param [options] - optional options
+ * @param [options.logger] - optional logger instance
+ * @returns - version for given dist-tag
+ */
+async function convertDistTagToVersion(distTag, options) {
+    const logger = options?.logger;
+    if (!(0, fs_1.existsSync)(specificationDistTagPath)) {
+        logger?.debug(`Specification dist-tags not found at '${specificationDistTagPath}'. Trying to refresh.`);
+        await refreshSpecificationDistTags({ logger });
+    }
+    const specificationDistTags = await (0, file_1.readJSON)(specificationDistTagPath);
+    const version = specificationDistTags[distTag] ?? specificationDistTags.latest;
+    return version;
+}
+//# sourceMappingURL=specification.js.map

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

@@ -1,5 +1,6 @@
-import type { I18nBundles } from '../i18n';
+import type { Logger } from '@sap-ux/logger';
 import type { NewI18nEntry } from '@sap-ux/i18n';
+import type { I18nBundles } from '../i18n';
 import type { ApplicationStructure, I18nPropertiesPaths, Project, ProjectType } from '../info';
 import type { Editor } from 'mem-fs-editor';
 import type { Package } from '../package';
@@ -9,6 +10,9 @@ interface BaseAccess {
     readonly root: string;
     readonly projectType: ProjectType;
 }
+export interface ApplicationAccessOptions extends ProjectAccessOptions {
+    fs?: Editor;
+}
 export interface ApplicationAccess extends BaseAccess {
     readonly app: ApplicationStructure;
     /**
@@ -95,6 +99,10 @@ export interface ApplicationAccess extends BaseAccess {
      * @returns absolute paths to i18n.properties
      */
     getI18nPropertiesPaths(): Promise<I18nPropertiesPaths>;
+    /**
+     * Returns an instance of @sap/ux-specification for the application.
+     */
+    getSpecification<T>(): Promise<T>;
     /**
      * Updates package.json file asynchronously by keeping the previous indentation.
      *
@@ -110,6 +118,9 @@ export interface ApplicationAccess extends BaseAccess {
      */
     updateManifestJSON(manifest: Manifest, memFs?: Editor): Promise<void>;
 }
+export interface ProjectAccessOptions {
+    logger?: Logger;
+}
 export interface ProjectAccess extends BaseAccess {
     getApplicationIds: () => string[];
     getApplication: (appId: string) => ApplicationAccess;

package/package.json

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