generate.mjs

'use strict';

import { readFile, writeFile } from 'node:fs/promises';
import { join } from 'node:path';

import getConfig from '../../utils/configuration/index.mjs';
import { minifyHTML } from '../../utils/html-minifier.mjs';
import { getRemarkRehype } from '../../utils/remark.mjs';
import { replaceTemplateValues } from '../legacy-html/utils/replaceTemplateValues.mjs';
import tableOfContents from '../legacy-html/utils/tableOfContents.mjs';

/**
 * Generates the `all.html` file from the `legacy-html` generator
 *
 * @type {import('./types').Generator['generate']}
 */
export async function generate(input) {
  const config = getConfig('legacy-html-all');

  // Gets a Remark Processor that parses Markdown to minified HTML
  const remarkWithRehype = getRemarkRehype();

  // Reads the API template.html file to be used as a base for the HTML files
  const apiTemplate = await readFile(config.templatePath, 'utf-8');

  // Filter out index entries and extract needed properties
  const entries = input.filter(entry => entry.api !== 'index');

  // Aggregates all individual Table of Contents into one giant string
  const aggregatedToC = entries.map(entry => entry.toc).join('\n');

  // Aggregates all individual content into one giant string
  const aggregatedContent = entries.map(entry => entry.content).join('\n');

  // Creates a "mimic" of an `MetadataEntry` which fulfils the requirements
  // for generating the `tableOfContents` with the `tableOfContents.parseNavigationNode` parser
  const sideNavigationFromValues = entries.map(entry => ({
    api: entry.api,
    heading: { data: { depth: 1, name: entry.section } },
  }));

  // Generates the global Table of Contents (Sidebar Navigation)
  const parsedSideNav = remarkWithRehype.processSync(
    tableOfContents(sideNavigationFromValues, {
      maxDepth: 1,
      parser: tableOfContents.parseNavigationNode,
    })
  );

  const templateValues = {
    api: 'all',
    path: 'all',
    added: '',
    section: 'All',
    version: `v${config.version.version}`,
    toc: aggregatedToC,
    nav: String(parsedSideNav),
    content: aggregatedContent,
  };

  let result = replaceTemplateValues(apiTemplate, templateValues, config, {
    skipGitHub: true,
    skipGtocPicker: true,
  });

  if (config.minify) {
    result = await minifyHTML(result);
  }

  if (config.output) {
    await writeFile(join(config.output, 'all.html'), result);
  }

  return result;
}