builder/lib/tasks/jsdoc/executeJsdocSdkTransformation.js

  1. import {getLogger} from "@ui5/logger";
  2. const log = getLogger("builder:tasks:jsdoc:executeJsdocSdkTransformation");
  3. import ReaderCollectionPrioritized from "@ui5/fs/ReaderCollectionPrioritized";
  4. import fsInterface from "@ui5/fs/fsInterface";
  5. import sdkTransformer from "../../processors/jsdoc/sdkTransformer.js";
  7. /**
  8.  * @public
  9.  * @module @ui5/builder/tasks/jsdoc/executeJsdocSdkTransformation
  10.  */
  12. /**
  13.  * Task to transform the api.json file as created by the
  14.  * [generateJsdoc]{@link @ui5/builder/tasks/jsdoc/generateJsdoc} task into a pre-processed api.json
  15.  * file suitable for the SDK.
  16.  *
  17.  * @public
  18.  * @function default
  19.  * @static
  20.  *
  21.  * @param {object} parameters Parameters
  22.  * @param {@ui5/fs/DuplexCollection} parameters.workspace DuplexCollection to read and write files
  23.  * @param {@ui5/fs/AbstractReader} parameters.dependencies Reader or Collection to read dependency files
  24.  * @param {object} parameters.options Options
  25.  * @param {string|Array} parameters.options.dotLibraryPattern Pattern to locate the .library resource to be processed
  26.  * @param {string} parameters.options.projectName Project name
  27.  * @returns {Promise<undefined>} Promise resolving with <code>undefined</code> once data has been written
  28.  */
  29. const executeJsdocSdkTransformation = async function(
  30. 	{workspace, dependencies, options: {projectName, dotLibraryPattern}} = {}
  31. ) {
  32. 	if (!projectName || !dotLibraryPattern) {
  33. 		throw new Error("[executeJsdocSdkTransformation]: One or more mandatory options not provided");
  34. 	}
  36. 	const [apiJsons, dotLibraries, depApiJsons] = await Promise.all([
  37. 		workspace.byGlob("/test-resources/**/designtime/api.json"),
  38. 		workspace.byGlob(dotLibraryPattern),
  39. 		dependencies.byGlob("/test-resources/**/designtime/api.json")
  40. 	]);
  41. 	if (!apiJsons.length) {
  42. 		log.info(`Failed to locate api.json resource for project ${projectName}. ` +
  43. 			`Skipping SDK Transformation...`);
  44. 		return;
  45. 	} else if (apiJsons.length > 1) {
  46. 		throw new Error(`[executeJsdocSdkTransformation]: Found more than one api.json resources for project ` +
  47. 			`${projectName}.`);
  48. 	}
  49. 	if (!dotLibraries.length) {
  50. 		throw new Error(`[executeJsdocSdkTransformation]: Failed to locate .library resource for project ` +
  51. 			`${projectName}.`);
  52. 	} else if (dotLibraries.length > 1) {
  53. 		throw new Error(`[executeJsdocSdkTransformation]: Found more than one .library resources for project ` +
  54. 			`${projectName}.`);
  55. 	}
  57. 	const combo = new ReaderCollectionPrioritized({
  58. 		name: `executeJsdocSdkTransformation - custom workspace + dependencies FS: ${projectName}`,
  59. 		readers: [workspace, dependencies]
  60. 	});
  62. 	const apiJsonPath = apiJsons[0].getPath();
  63. 	const dotLibraryPath = dotLibraries[0].getPath();
  64. 	const dependencyApiJsonPaths = depApiJsons.map((res) => {
  65. 		return res.getPath();
  66. 	});
  68. 	// Target path is typically "/test-resources/${options.namespace}/designtime/apiref/api.json"
  69. 	const targetApiJsonPath = apiJsonPath.replace(/\/api\.json$/i, "/apiref/api.json");
  71. 	const createdResources = await sdkTransformer({
  72. 		apiJsonPath,
  73. 		dotLibraryPath,
  74. 		dependencyApiJsonPaths,
  75. 		targetApiJsonPath,
  76. 		fs: fsInterface(combo)
  77. 	});
  79. 	await Promise.all(createdResources.map((resource) => {
  80. 		return workspace.write(resource);
  81. 	}));
  82. };
  84. export default executeJsdocSdkTransformation;