builder/lib/processors/jsdoc/apiIndexGenerator.js

  1. const resourceFactory = require("@ui5/fs").resourceFactory;
  2. const createIndex = require("./lib/createIndexFiles");
  4. /**
  5.  * Compiles API index resources from all <code>api.json</code> resources available in the given test resources directory
  6.  * as created by the [sdkTransformer]{@link module:@ui5/builder.processors.sdkTransformer} processor.
  7.  * The resulting index resources (e.g. <code>api-index.json</code>,  <code>api-index-deprecated.json</code>,
  8.  * <code>api-index-experimental.json</code> and <code>api-index-since.json</code>) are mainly to be used in the SDK.
  9.  *
  10.  * @public
  11.  * @alias module:@ui5/builder.processors.apiIndexGenerator
  12.  * @param {object} parameters Parameters
  13.  * @param {string} parameters.versionInfoPath Path to <code>sap-ui-version.json</code> resource
  14.  * @param {string} parameters.testResourcesRootPath Path to <code>/test-resources</code> root directory in the
  15.  *														given fs
  16.  * @param {string} parameters.targetApiIndexPath Path to create the generated API index JSON resource for
  17.  * @param {string} parameters.targetApiIndexDeprecatedPath Path to create the generated API index "deprecated" JSON
  18.  *															resource for
  19.  * @param {string} parameters.targetApiIndexExperimentalPath Path to create the generated API index "experimental" JSON
  20.  *																resource for
  21.  * @param {string} parameters.targetApiIndexSincePath Path to create the generated API index "since" JSON resource for
  22.  * @param {fs|module:@ui5/fs.fsInterface} parameters.fs Node fs or
  23.  * 				custom [fs interface]{@link module:resources/module:@ui5/fs.fsInterface} to use
  24.  * @returns {Promise<module:@ui5/fs.Resource[]>} Promise resolving with created resources <code>api-index.json</code>,
  25.  * <code>api-index-deprecated.json</code>, <code>api-index-experimental.json</code> and
  26.  * <code>api-index-since.json</code> (names depend on the supplied paths)
  27.  */
  28. const apiIndexGenerator = async function({
  29. 	versionInfoPath, testResourcesRootPath, targetApiIndexPath, targetApiIndexDeprecatedPath,
  30. 	targetApiIndexExperimentalPath, targetApiIndexSincePath, fs
  31. } = {}) {
  32. 	if (!versionInfoPath || !testResourcesRootPath || !targetApiIndexPath || !targetApiIndexDeprecatedPath ||
  33. 			!targetApiIndexExperimentalPath || !targetApiIndexSincePath || !fs) {
  34. 		throw new Error("[apiIndexGenerator]: One or more mandatory parameters not provided");
  35. 	}
  37. 	const resourceMap = await createIndex(versionInfoPath, testResourcesRootPath, targetApiIndexPath,
  38. 		targetApiIndexDeprecatedPath, targetApiIndexExperimentalPath, targetApiIndexSincePath, {
  39. 			fs,
  40. 			returnOutputFiles: true
  41. 		});
  43. 	return Object.keys(resourceMap).map((resPath) => {
  44. 		return resourceFactory.createResource({
  45. 			path: resPath,
  46. 			string: resourceMap[resPath]
  47. 		});
  48. 	});
  49. };
  51. module.exports = apiIndexGenerator;