project/lib/ui5Framework/Openui5Resolver.js

  1. const path = require("path");
  3. const AbstractResolver = require("./AbstractResolver");
  4. const Installer = require("./npm/Installer");
  6. const OPENUI5_CORE_PACKAGE = "@openui5/sap.ui.core";
  9. /**
  10.  * Resolver for the OpenUI5 framework
  11.  *
  12.  * @public
  13.  * @memberof module:@ui5/project.ui5Framework
  14.  * @augments  module:@ui5/project.ui5Framework.AbstractResolver
  15.  */
  16. class Openui5Resolver extends AbstractResolver {
  17. 	/**
  18. 	 * @param {*} options options
  19. 	 * @param {string} options.version OpenUI5 version to use
  20. 	 * @param {string} [options.cwd=process.cwd()] Working directory to resolve configurations like .npmrc
  21. 	 * @param {string} [options.ui5HomeDir="~/.ui5"] UI5 home directory location. This will be used to store packages,
  22. 	 * metadata and configuration used by the resolvers. Relative to `process.cwd()`
  23. 	 */
  24. 	constructor(options) {
  25. 		super(options);
  27. 		this._installer = new Installer({
  28. 			cwd: this._cwd,
  29. 			ui5HomeDir: this._ui5HomeDir
  30. 		});
  31. 		this._loadLibraryMetadata = {};
  32. 	}
  33. 	static _getNpmPackageName(libraryName) {
  34. 		return "@openui5/" + libraryName;
  35. 	}
  36. 	static _getLibaryName(pkgName) {
  37. 		return pkgName.replace(/^@openui5\//, "");
  38. 	}
  39. 	getLibraryMetadata(libraryName) {
  40. 		if (!this._loadLibraryMetadata[libraryName]) {
  41. 			this._loadLibraryMetadata[libraryName] = Promise.resolve().then(async () => {
  42. 				// Trigger manifest request to gather transitive dependencies
  43. 				const pkgName = Openui5Resolver._getNpmPackageName(libraryName);
  44. 				const libraryManifest = await this._installer.fetchPackageManifest({pkgName, version: this._version});
  45. 				let dependencies = [];
  46. 				if (libraryManifest.dependencies) {
  47. 					const depNames = Object.keys(libraryManifest.dependencies);
  48. 					dependencies = depNames.map(Openui5Resolver._getLibaryName);
  49. 				}
  51. 				// npm devDependencies are handled as "optionalDependencies"
  52. 				// in terms of the UI5 framework metadata structure
  53. 				let optionalDependencies = [];
  54. 				if (libraryManifest.devDependencies) {
  55. 					const devDepNames = Object.keys(libraryManifest.devDependencies);
  56. 					optionalDependencies = devDepNames.map(Openui5Resolver._getLibaryName);
  57. 				}
  59. 				return {
  60. 					id: pkgName,
  61. 					version: this._version,
  62. 					dependencies,
  63. 					optionalDependencies
  64. 				};
  65. 			});
  66. 		}
  67. 		return this._loadLibraryMetadata[libraryName];
  68. 	}
  69. 	async handleLibrary(libraryName) {
  70. 		const pkgName = Openui5Resolver._getNpmPackageName(libraryName);
  71. 		return {
  72. 			// Trigger metadata request
  73. 			metadata: this.getLibraryMetadata(libraryName),
  74. 			// Also trigger installation of package
  75. 			install: this._installer.installPackage({
  76. 				pkgName,
  77. 				version: this._version
  78. 			})
  79. 		};
  80. 	}
  81. 	static async fetchAllVersions({ui5HomeDir, cwd} = {}) {
  82. 		const installer = new Installer({
  83. 			cwd: cwd ? path.resolve(cwd) : process.cwd(),
  84. 			ui5HomeDir:
  85. 				ui5HomeDir ? path.resolve(ui5HomeDir) :
  86. 					path.join(require("os").homedir(), ".ui5")
  87. 		});
  88. 		return await installer.fetchPackageVersions({pkgName: OPENUI5_CORE_PACKAGE});
  89. 	}
  90. }
  92. module.exports = Openui5Resolver;