fs/lib/ResourceFacade.js

  1. import posixPath from "node:path/posix";
  3. /**
  4.  * A {@link @ui5/fs/Resource Resource} with a different path than it's original
  5.  *
  6.  * @public
  7.  * @class
  8.  * @alias @ui5/fs/ResourceFacade
  9.  */
  10. class ResourceFacade {
  11. 	#path;
  12. 	#name;
  13. 	#resource;
  15. 	/**
  16. 	 *
  17. 	 * @public
  18. 	 * @param {object} parameters Parameters
  19. 	 * @param {string} parameters.path Virtual path of the facade resource
  20. 	 * @param {@ui5/fs/Resource} parameters.resource Resource to conceal
  21. 	 */
  22. 	constructor({path, resource}) {
  23. 		if (!path) {
  24. 			throw new Error("Unable to create ResourceFacade: Missing parameter 'path'");
  25. 		}
  26. 		if (!resource) {
  27. 			throw new Error("Unable to create ResourceFacade: Missing parameter 'resource'");
  28. 		}
  29. 		path = posixPath.normalize(path);
  30. 		if (!posixPath.isAbsolute(path)) {
  31. 			throw new Error(`Unable to create ResourceFacade: Parameter 'path' must be absolute: ${path}`);
  32. 		}
  33. 		this.#path = path;
  34. 		this.#name = posixPath.basename(path);
  35. 		this.#resource = resource;
  36. 	}
  38. 	/**
  39. 	 * Gets the resources path
  40. 	 *
  41. 	 * @public
  42. 	 * @returns {string} (Virtual) path of the resource
  43. 	 */
  44. 	getPath() {
  45. 		return this.#path;
  46. 	}
  48. 	/**
  49. 	 * Gets the resource name
  50. 	 *
  51. 	 * @public
  52. 	 * @returns {string} Name of the resource
  53. 	 */
  54. 	getName() {
  55. 		return this.#name;
  56. 	}
  58. 	/**
  59. 	 * Sets the resources path
  60. 	 *
  61. 	 * @public
  62. 	 * @param {string} path (Virtual) path of the resource
  63. 	 */
  64. 	setPath(path) {
  65. 		throw new Error(`The path of a ResourceFacade can't be changed`);
  66. 	}
  68. 	/**
  69. 	 * Returns a clone of the resource. The clones content is independent from that of the original resource.
  70. 	 * A ResourceFacade becomes a Resource
  71. 	 *
  72. 	 * @public
  73. 	 * @returns {Promise<@ui5/fs/Resource>} Promise resolving with the clone
  74. 	 */
  75. 	async clone() {
  76. 		// Cloning resolves the facade
  77. 		const resourceClone = await this.#resource.clone();
  78. 		resourceClone.setPath(this.getPath());
  79. 		return resourceClone;
  80. 	}
  82. 	/**
  83. 	 * ======================================================================
  84. 	 * Call through functions to original resource
  85. 	 * ======================================================================
  86. 	 */
  87. 	/**
  88. 	 * Gets a buffer with the resource content.
  89. 	 *
  90. 	 * @public
  91. 	 * @returns {Promise<Buffer>} Promise resolving with a buffer of the resource content.
  92. 	 */
  93. 	async getBuffer() {
  94. 		return this.#resource.getBuffer();
  95. 	}
  97. 	/**
  98. 	 * Sets a Buffer as content.
  99. 	 *
  100. 	 * @public
  101. 	 * @param {Buffer} buffer Buffer instance
  102. 	 */
  103. 	setBuffer(buffer) {
  104. 		return this.#resource.setBuffer(buffer);
  105. 	}
  107. 	/**
  108. 	 * Gets a string with the resource content.
  109. 	 *
  110. 	 * @public
  111. 	 * @returns {Promise<string>} Promise resolving with the resource content.
  112. 	 */
  113. 	getString() {
  114. 		return this.#resource.getString();
  115. 	}
  117. 	/**
  118. 	 * Sets a String as content
  119. 	 *
  120. 	 * @public
  121. 	 * @param {string} string Resource content
  122. 	 */
  123. 	setString(string) {
  124. 		return this.#resource.setString(string);
  125. 	}
  127. 	/**
  128. 	 * Gets a readable stream for the resource content.
  129. 	 *
  130. 	 * Repetitive calls of this function are only possible if new content has been set in the meantime (through
  131. 	 * [setStream]{@link @ui5/fs/Resource#setStream}, [setBuffer]{@link @ui5/fs/Resource#setBuffer}
  132. 	 * or [setString]{@link @ui5/fs/Resource#setString}). This
  133. 	 * is to prevent consumers from accessing drained streams.
  134. 	 *
  135. 	 * @public
  136. 	 * @returns {stream.Readable} Readable stream for the resource content.
  137. 	 */
  138. 	getStream() {
  139. 		return this.#resource.getStream();
  140. 	}
  142. 	/**
  143. 	 * Sets a readable stream as content.
  144. 	 *
  145. 	 * @public
  146. 	 * @param {stream.Readable|@ui5/fs/Resource~createStream} stream Readable stream of the resource content or
  147. 															callback for dynamic creation of a readable stream
  148. 	 */
  149. 	setStream(stream) {
  150. 		return this.#resource.setStream(stream);
  151. 	}
  153. 	/**
  154. 	 * Gets the resources stat info.
  155. 	 * Note that a resources stat information is not updated when the resource is being modified.
  156. 	 * Also, depending on the used adapter, some fields might be missing which would be present for a
  157. 	 * [fs.Stats]{@link https://nodejs.org/api/fs.html#fs_class_fs_stats} instance.
  158. 	 *
  159. 	 * @public
  160. 	 * @returns {fs.Stats|object} Instance of [fs.Stats]{@link https://nodejs.org/api/fs.html#fs_class_fs_stats}
  161. 	 *								or similar object
  162. 	 */
  163. 	getStatInfo() {
  164. 		return this.#resource.getStatInfo();
  165. 	}
  167. 	/**
  168. 	 * Size in bytes allocated by the underlying buffer.
  169. 	 *
  170. 	 * @see {TypedArray#byteLength}
  171. 	 * @returns {Promise<number>} size in bytes, <code>0</code> if there is no content yet
  172. 	 */
  173. 	async getSize() {
  174. 		return this.#resource.getSize();
  175. 	}
  177. 	/**
  178. 	 * Adds a resource collection name that was involved in locating this resource.
  179. 	 *
  180. 	 * @param {string} name Resource collection name
  181. 	 */
  182. 	pushCollection(name) {
  183. 		return this.#resource.pushCollection(name);
  184. 	}
  186. 	/**
  187. 	 * Tracing: Get tree for printing out trace
  188. 	 *
  189. 	 * @returns {object} Trace tree
  190. 	 */
  191. 	getPathTree() {
  192. 		return this.#resource.getPathTree();
  193. 	}
  195. 	/**
  196. 	 * Retrieve the project assigned to the resource
  197. 	 * <br/>
  198. 	 * <b>Note for UI5 Tooling extensions (i.e. custom tasks, custom middleware):</b>
  199. 	 * In order to ensure compatibility across UI5 Tooling versions, consider using the
  200. 	 * <code>getProject(resource)</code> method provided by
  201. 	 * [TaskUtil]{@link module:@ui5/project/build/helpers/TaskUtil} and
  202. 	 * [MiddlewareUtil]{@link module:@ui5/server.middleware.MiddlewareUtil}, which will
  203. 	 * return a Specification Version-compatible Project interface.
  204. 	 *
  205. 	 * @public
  206. 	 * @returns {@ui5/project/specifications/Project} Project this resource is associated with
  207. 	 */
  208. 	getProject() {
  209. 		return this.#resource.getProject();
  210. 	}
  212. 	/**
  213. 	 * Assign a project to the resource
  214. 	 *
  215. 	 * @public
  216. 	 * @param {@ui5/project/specifications/Project} project Project this resource is associated with
  217. 	 */
  218. 	setProject(project) {
  219. 		return this.#resource.setProject(project);
  220. 	}
  222. 	/**
  223. 	 * Check whether a project has been assigned to the resource
  224. 	 *
  225. 	 * @public
  226. 	 * @returns {boolean} True if the resource is associated with a project
  227. 	 */
  228. 	hasProject() {
  229. 		return this.#resource.hasProject();
  230. 	}
  231. 	/**
  232. 	 * Check whether the content of this resource has been changed during its life cycle
  233. 	 *
  234. 	 * @public
  235. 	 * @returns {boolean} True if the resource's content has been changed
  236. 	 */
  237. 	isModified() {
  238. 		return this.#resource.isModified();
  239. 	}
  241. 	/**
  242. 	 * Returns source metadata if any where provided during the creation of this resource.
  243. 	 * Typically set by an adapter to store information for later retrieval.
  244. 	 *
  245. 	 * @returns {object|null}
  246. 	 */
  247. 	getSourceMetadata() {
  248. 		return this.#resource.getSourceMetadata();
  249. 	}
  252. 	/**
  253. 	 * Returns the resource concealed by this facade
  254. 	 *
  255. 	 * @returns {@ui5/fs/Resource}
  256. 	 */
  257. 	getConcealedResource() {
  258. 		return this.#resource;
  259. 	}
  260. }
  262. export default ResourceFacade;