builder/lib/processors/jsdoc/apiIndexGenerator.js

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