docgen-tool 5.3.0 → 6.0.2

package/dist/cli.js

@@ -1,1253 +0,0 @@
-#!/usr/bin/env node
-import { program } from 'commander';
-import pico from 'picocolors';
-import path, { join } from 'path';
-import { promises } from 'fs';
-import fs from 'fs-extra';
-import schemaValidator from 'z-schema';
-import * as cheerio from 'cheerio';
-import MarkdownIt from 'markdown-it';
-import markdownItAdmon from 'markdown-it-admon';
-import React, { Fragment } from 'react';
-import ReactPDF, { Image, Text, View, StyleSheet, Page as Page$2, Document } from '@react-pdf/renderer';
-import Html from 'react-pdf-html';
-import pkg from 'lodash';
-import ReactDOMServer from 'react-dom/server';
-
-const readFile = async (filePath) => {
-  const normalized = path.normalize(filePath);
-  try {
-    return (await promises.readFile(normalized, { encoding: "utf8" }))?.replace(
-      /^\uFEFF/,
-      ""
-    );
-  } catch (error) {
-    console.log(pico.red("Error reading file: " + normalized));
-  }
-};
-const writeFile = async (filePath, data) => {
-  const normalized = path.normalize(filePath);
-  try {
-    await promises.writeFile(normalized, data, { encoding: "utf8" });
-  } catch (error) {
-    console.log(pico.red("Error writing file: " + normalized));
-  }
-};
-const copyDirectory = async (source, destination, verbose) => {
-  const normalizedSource = path.normalize(source);
-  const normalizedDestination = path.normalize(destination);
-  try {
-    await fs.copySync(normalizedSource, normalizedDestination);
-  } catch (error) {
-    console.log(
-      pico.red(
-        "Error copying directory: " + normalizedSource + " to " + normalizedDestination
-      )
-    );
-    if (verbose === true) {
-      console.log(pico.red(error));
-    }
-  }
-};
-const cleanDirectory = async (directoryPath, verbose) => {
-  const normalized = path.normalize(directoryPath);
-  try {
-    await fs.removeSync(normalized);
-    await fs.mkdirpSync(normalized);
-  } catch (error) {
-    console.log(pico.red("Error recreating directory: " + normalized));
-    if (verbose === true) {
-      console.log(pico.red(error));
-    }
-  }
-};
-
-const schemas = {
-  parameters: {
-    title: "DocGen Parameters Schema",
-    type: "object",
-    required: [
-      "title",
-      "name",
-      "version",
-      "date",
-      "organization",
-      "author",
-      "owner",
-      "contributors",
-      "website",
-      "module",
-      "id",
-      "summary",
-      "marking",
-      "legalese"
-    ],
-    properties: {
-      title: { type: "string" },
-      name: { type: "string" },
-      version: { type: "string" },
-      date: { type: "string" },
-      organization: {
-        type: "object",
-        required: ["name", "url"],
-        properties: {
-          name: { type: "string" },
-          url: { type: "string" }
-        }
-      },
-      author: {
-        type: "object",
-        required: ["name", "url"],
-        properties: {
-          name: { type: "string" },
-          url: { type: "string" }
-        }
-      },
-      owner: {
-        type: "object",
-        required: ["name", "url"],
-        properties: {
-          name: { type: "string" },
-          url: { type: "string" }
-        }
-      },
-      contributors: {
-        type: "array",
-        items: {
-          oneOf: [
-            {
-              type: "object",
-              required: ["name", "url"],
-              properties: {
-                name: { type: "string" },
-                url: { type: "string" }
-              }
-            }
-          ]
-        }
-      },
-      website: {
-        type: "object",
-        required: ["name", "url"],
-        properties: {
-          name: { type: "string" },
-          url: { type: "string" }
-        }
-      },
-      sponsorLink: {
-        type: "object",
-        required: ["name", "url", "logo"],
-        properties: {
-          name: { type: "string" },
-          url: { type: "string" },
-          logo: { type: "string" }
-        }
-      },
-      backlink: {
-        type: "object",
-        required: ["name", "url"],
-        properties: {
-          name: { type: "string" },
-          url: { type: "string" }
-        }
-      },
-      module: { type: "string" },
-      id: { type: "string" },
-      summary: { type: "string" },
-      marking: { type: "string" },
-      legalese: { type: "string" },
-      logoPath: { type: "string" }
-    }
-  },
-  contents: {
-    title: "DocGen Table of Contents Schema",
-    type: "array",
-    items: {
-      oneOf: [
-        {
-          type: "object",
-          required: ["heading", "column", "pages"],
-          properties: {
-            name: { type: "string" },
-            column: { type: "integer", minimum: 1, maximum: 4 },
-            pages: {
-              type: "array",
-              items: {
-                oneOf: [
-                  {
-                    type: "object",
-                    required: ["title", "source"],
-                    properties: {
-                      title: { type: "string" },
-                      source: { type: "string" },
-                      hideAutomaticPageHeading: { type: "boolean" }
-                    }
-                  }
-                ]
-              }
-            }
-          }
-        }
-      ]
-    }
-  }
-};
-const validateJSON = ({ key, data, verbose }) => {
-  let schema = schemas[key];
-  let validator = new schemaValidator({});
-  let valid = validator.validate(data, schema);
-  if (!valid) {
-    console.log(
-      pico.red(
-        `Error parsing required file: ${key}.json (failed schema validation)`
-      )
-    );
-    if (verbose === true) {
-      console.log(pico.red(validator.getLastError().message));
-    }
-  }
-  return valid;
-};
-
-const loadMeta = async ({
-  inputPath,
-  verbose,
-  mainProcess
-}) => {
-  const meta = {
-    parameters: null,
-    contents: null
-  };
-  console.log(pico.green("Loading required JSON metadata files"));
-  try {
-    let files = {
-      parameters: await readFile(inputPath + "/parameters.json"),
-      contents: await readFile(inputPath + "/contents.json")
-    };
-    for (let key in files) {
-      if (files.hasOwnProperty(key)) {
-        try {
-          let file = JSON.parse(files[key]);
-          if (validateJSON({ key, data: file, verbose })) {
-            meta[key] = file;
-          } else {
-            mainProcess.exit(1);
-          }
-        } catch (error) {
-          console.log(
-            pico.red(
-              "Error parsing required file: " + key + ".json (invalid JSON)"
-            )
-          );
-          if (verbose === true) {
-            console.log(pico.red(error));
-          }
-          mainProcess.exit(1);
-        }
-      }
-    }
-    const extra = {
-      heading: "Extra",
-      column: 5,
-      pages: [{ title: "Release notes", source: "release-notes.md" }]
-    };
-    meta.contents.push(extra);
-    return {
-      rawParameters: meta.parameters,
-      contents: meta.contents
-    };
-  } catch (error) {
-    console.log(pico.red("Error loading required JSON metadata files"));
-    if (verbose === true) {
-      console.log(pico.red(error));
-    }
-    mainProcess.exit(1);
-  }
-};
-
-const packageAbsolutePath = import.meta.dirname;
-
-const loadTemplates = async ({
-  options,
-  mainProcess
-}) => {
-  const templates = {};
-  console.log(pico.green("Loading templates"));
-  try {
-    let files = {
-      main: await readFile(
-        join(packageAbsolutePath, "include/templates/main.html")
-      ),
-      redirect: await readFile(
-        join(packageAbsolutePath, "include/templates/redirect.html")
-      )
-    };
-    for (let key in files) {
-      if (files.hasOwnProperty(key)) {
-        let file = files[key];
-        let dom = cheerio.load(file);
-        templates[key] = dom;
-      }
-    }
-    return templates;
-  } catch (error) {
-    console.log(pico.red("Error loading templates"));
-    if (options.verbose === true) {
-      console.log(pico.red(error));
-    }
-    mainProcess.exit(1);
-  }
-};
-
-const markdown = new MarkdownIt("commonmark").enable("table").use(markdownItAdmon);
-markdown.validateLink = () => {
-  return true;
-};
-const loadMarkdown = async ({ contents, options, mainProcess }) => {
-  console.log(pico.green("Loading src files"));
-  const pages = {};
-  try {
-    let keys = [];
-    let files = [];
-    contents.forEach((section) => {
-      section.pages.forEach((page) => {
-        keys.push(page);
-        files.push(options.input + "/" + page.source);
-      });
-    });
-    keys.push("ownership");
-    files.push(options.input + "/release-notes.md");
-    files = await Promise.all(files.map((f) => readFile(f)));
-    files.forEach((page, index) => {
-      let key = keys[index];
-      try {
-        let html = markdown.render(page);
-        pages[key.source] = html;
-      } catch (error) {
-        console.log(pico.red("Error parsing Markdown file: " + key.source));
-        if (options.verbose === true) {
-          console.log(pico.red(error));
-        }
-        mainProcess.exit(1);
-      }
-    });
-    return pages;
-  } catch (error) {
-    console.log(error);
-    console.log(pico.red("Error loading src files"));
-    if (options.verbose === true) {
-      console.log(pico.red(error));
-    }
-    mainProcess.exit(1);
-  }
-};
-
-const ColorBackgroundSuccess = "#e8f5e9";
-const ColorBackgroundError = "#ffebee";
-const ColorBackgroundWarning = "#fff8e1";
-const ColorBackgroundInfo = "rgb(222, 232, 252)";
-const ColorBackgroundNeutral = "#f5f5f5";
-const ColorBorder = "#999";
-const ColorBorderSuccess = "#4caf50";
-const ColorBorderError = "#f44336";
-const ColorBorderWarning = "#ff9800";
-const ColorBorderInfo = "#81a7f4";
-const ColorBorderNeutral = "#9e9e9e";
-const ColorText = "rgb(1, 3, 4)";
-const ColorTableBackgroundHeaderFooterPdf = "#eee";
-const SizeBorderWidthPdf = "0.8pt";
-const SizeFontH1Pdf = "24pt";
-const SizeFontH2Pdf = "20pt";
-const SizeFontH3Pdf = "18pt";
-const SizeFontH4Pdf = "16pt";
-const SizeFontH5Pdf = "14pt";
-const SizeFontH6Pdf = "12pt";
-const SizeTableCellPaddingPdf = "2mm 2mm";
-const SizeContentBlockMarginPdf = "2mm 0";
-const SizeContentBlockPaddingPdf = "1mm 4mm";
-const SizeAdmonitionBorderLeftPdf = "1mm";
-const SizeAdmonitionTitleMarginPdf = "3mm 0 0";
-
-const docsStyleSheet = {
-  // Features cards
-  [".features"]: {
-    padding: 0,
-    width: "100%",
-    display: "flex",
-    flexDirection: "row",
-    flexWrap: "wrap",
-    justifyContent: "flex-start",
-    gap: 20,
-    margin: "0 0 0.5cm"
-  },
-  [".features li"]: {
-    listStyleType: "none",
-    verticalAlign: "top",
-    display: "flex",
-    flexDirection: "column",
-    alignItems: "flex-start",
-    width: "5cm",
-    margin: "0.5cm 0.5cm 0 0"
-  },
-  [".features li p"]: {
-    margin: 0,
-    padding: "0 0 0.4cm 0",
-    textAlign: "left"
-  },
-  [".features li img"]: {
-    alignSelf: "flex-start",
-    height: "1cm",
-    objectFit: "contain",
-    // preserve aspect ratio
-    marginBottom: "0.4cm"
-  },
-  // Feature details container
-  [".featureDetailsContainer"]: {
-    display: "flex",
-    flexDirection: "row",
-    justifyContent: "flex-start",
-    alignItems: "flex-start",
-    gap: "0.5cm",
-    padding: "0.5cm 0"
-  },
-  [".featureDetails"]: {
-    display: "flex",
-    flexDirection: "column",
-    width: "7cm"
-  },
-  // How it works cards
-  [".dgCardContainer"]: {
-    display: "flex",
-    flexDirection: "row",
-    flexWrap: "wrap",
-    justifyContent: "flex-start",
-    gap: "0.5cm"
-  },
-  [".dgCard"]: {
-    display: "flex",
-    flexDirection: "column",
-    alignItems: "center",
-    textAlign: "left",
-    maxWidth: "5.5cm"
-  },
-  [".dgCard img"]: {
-    width: "5.5cm",
-    height: "auto",
-    borderRadius: "0.1cm"
-  },
-  [".dgCard p"]: {
-    marginTop: "0.5cm",
-    wordWrap: "break-word"
-  },
-  // Sponsor cards
-  [".inkitSponsor"]: {
-    display: "flex",
-    flexDirection: "row",
-    padding: "10 0"
-  },
-  [".inkitText"]: {
-    flex: 1,
-    justifyContent: "left"
-  },
-  [".inkitImage"]: {
-    flex: 1,
-    alignItems: "left"
-  },
-  [".inkitImage img"]: {
-    width: 200,
-    borderRadius: 8
-  }
-};
-
-const admonitionBaseStyle = {
-  padding: SizeContentBlockPaddingPdf,
-  margin: SizeContentBlockMarginPdf
-};
-const pdfAdmonitionsStyles = {
-  blockquote: {
-    ...admonitionBaseStyle,
-    backgroundColor: ColorBackgroundNeutral,
-    borderLeft: `${SizeAdmonitionBorderLeftPdf} solid ${ColorBorderNeutral}`,
-    color: ColorBorderNeutral,
-    fontStyle: "italic"
-  },
-  [".admonition"]: admonitionBaseStyle,
-  [".admonition-title"]: {
-    margin: SizeAdmonitionTitleMarginPdf,
-    fontWeight: "bold"
-  },
-  [".admonition.information"]: {
-    backgroundColor: ColorBackgroundInfo,
-    borderLeft: `${SizeAdmonitionBorderLeftPdf} solid ${ColorBorderInfo}`
-  },
-  [".admonition.success"]: {
-    backgroundColor: ColorBackgroundSuccess,
-    borderLeft: `${SizeAdmonitionBorderLeftPdf} solid ${ColorBorderSuccess}`
-  },
-  [".admonition.warning"]: {
-    backgroundColor: ColorBackgroundWarning,
-    borderLeft: `${SizeAdmonitionBorderLeftPdf} solid ${ColorBorderWarning}`
-  },
-  [".admonition.error"]: {
-    backgroundColor: ColorBackgroundError,
-    borderLeft: `${SizeAdmonitionBorderLeftPdf} solid ${ColorBorderError}`
-  }
-};
-
-const tableCellStyle = {
-  padding: SizeTableCellPaddingPdf,
-  border: `${SizeBorderWidthPdf} solid ${ColorBorder}`
-};
-const tableHeaderFooterStyle = {
-  ...tableCellStyle,
-  backgroundColor: ColorTableBackgroundHeaderFooterPdf,
-  fontWeight: "bold"
-};
-const pdfTableStyles = {
-  table: {
-    border: "1px solid #ccc"
-  },
-  td: tableCellStyle,
-  th: tableHeaderFooterStyle,
-  ["tfoot td"]: tableHeaderFooterStyle
-};
-
-const fontSize = 10;
-const pdfStyleSheet = {
-  page: {
-    paddingTop: 35,
-    paddingBottom: 65,
-    paddingHorizontal: 35,
-    fontSize
-  }
-};
-const em = (em2, relativeSize = fontSize) => em2 * relativeSize;
-const htmlStyleSheet = {
-  "h1, h2, h3, h4, h5, h6": {
-    fontWeight: "bold"
-  },
-  h1: {
-    fontSize: SizeFontH1Pdf,
-    marginVertical: em(0.67, em(2))
-  },
-  h2: {
-    fontSize: SizeFontH2Pdf,
-    marginVertical: em(0.83, em(1.5))
-  },
-  h3: {
-    fontSize: SizeFontH3Pdf,
-    marginVertical: em(1, em(1.17))
-  },
-  h4: {
-    fontSize: SizeFontH4Pdf,
-    marginVertical: em(1.33, em(1))
-  },
-  h5: {
-    fontSize: SizeFontH5Pdf,
-    marginVertical: em(1.67, em(0.83))
-  },
-  h6: {
-    fontSize: SizeFontH6Pdf,
-    marginVertical: em(2.33, em(0.67))
-  },
-  p: {
-    color: ColorText,
-    fontSize: em(1),
-    marginVertical: em(1)
-  },
-  hr: {
-    marginVertical: em(0.5),
-    borderBottomWidth: 1,
-    borderBottomColor: "#000"
-  },
-  address: {
-    fontStyle: "italic"
-  },
-  pre: {
-    fontSize: "10pt",
-    fontFamily: "Courier",
-    backgroundColor: "#f5f5f5",
-    color: "#333333",
-    borderRadius: "4pt",
-    padding: "8pt",
-    borderLeft: "4pt solid #cccccc",
-    marginVertical: em(1),
-    whiteSpace: "pre-wrap"
-  },
-  b: {
-    fontWeight: "bold"
-  },
-  strong: {
-    fontWeight: "bold"
-  },
-  i: {
-    fontStyle: "italic"
-  },
-  em: {
-    fontStyle: "italic"
-  },
-  s: {
-    textDecoration: "line-through"
-  },
-  u: {
-    textDecoration: "underline"
-  },
-  cite: {
-    fontStyle: "italic"
-  },
-  code: {
-    // fontFamily: 'monospace',
-  },
-  a: {
-    textDecoration: "underline"
-  },
-  ul: {
-    marginVertical: em(1)
-  },
-  ol: {
-    marginVertical: em(1)
-  },
-  li: {
-    display: "flex",
-    flexDirection: "row"
-  },
-  li_bullet: {
-    width: 30,
-    textAlign: "right",
-    flexShrink: 0,
-    flexGrow: 0,
-    paddingRight: 5
-  },
-  li_content: {
-    textAlign: "left",
-    flexGrow: 1,
-    flexBasis: 1
-  },
-  table: {
-    display: "flex",
-    flexDirection: "column",
-    flexShrink: 1,
-    borderCollapse: "collapse"
-  },
-  thead: {
-    display: "flex",
-    flexDirection: "column"
-  },
-  tbody: {
-    display: "flex",
-    flexDirection: "column"
-  },
-  tr: {
-    display: "flex",
-    flexDirection: "row",
-    flexShrink: 1
-  },
-  td: {
-    flexGrow: 1,
-    flexShrink: 1
-  },
-  th: {
-    flexGrow: 1,
-    flexShrink: 1,
-    fontWeight: "bold"
-  },
-  [".button"]: {
-    textAlign: "center"
-  },
-  ...pdfAdmonitionsStyles,
-  ...pdfTableStyles,
-  ...docsStyleSheet
-};
-
-const customRenderers = ({ options }) => ({
-  div: (payload) => {
-    const { children, style, element } = payload;
-    const classNames = element.classList.toString();
-    if (classNames.includes("dgPDFPageBreak")) {
-      return /* @__PURE__ */ React.createElement(View, { break: true, style }, children);
-    }
-    return /* @__PURE__ */ React.createElement(View, { style }, children);
-  },
-  pre: (payload) => {
-    const { children, element, style } = payload;
-    const $ = cheerio.load(element.content.join());
-    const code = $("code");
-    if (code.length) {
-      return /* @__PURE__ */ React.createElement(Text, { style }, code.text().trim());
-    }
-    return /* @__PURE__ */ React.createElement(Text, { style }, children);
-  },
-  img: (payload) => {
-    const { element, style } = payload;
-    const relativeSource = element.attributes.src;
-    const source = path.join(options.input, relativeSource);
-    return /* @__PURE__ */ React.createElement(Image, { style, source });
-  }
-});
-
-const PdfHtmlBlock = ({
-  page,
-  options
-}) => {
-  return /* @__PURE__ */ React.createElement(
-    Html,
-    {
-      style: { fontSize },
-      stylesheet: htmlStyleSheet,
-      renderers: customRenderers({ options })
-    },
-    page
-  );
-};
-
-const styles = StyleSheet.create({
-  footer: {
-    position: "absolute",
-    bottom: 5,
-    left: 30,
-    right: 30,
-    height: 50,
-    flexDirection: "row",
-    justifyContent: "space-between",
-    borderTopWidth: 1,
-    borderTopColor: "black",
-    paddingTop: 10
-  },
-  column: {
-    width: "33%",
-    textAlign: "center",
-    fontSize: 10
-  }
-});
-const PdfFooter = ({ parameters }) => /* @__PURE__ */ React.createElement(View, { style: styles.footer, fixed: true }, /* @__PURE__ */ React.createElement(Text, { style: styles.column }, parameters.title), /* @__PURE__ */ React.createElement(Text, { style: styles.column }, `\xA9 ${parameters.year} ${parameters.name}`), /* @__PURE__ */ React.createElement(
-  Text,
-  {
-    style: styles.column,
-    render: ({ pageNumber, totalPages }) => `${pageNumber} / ${totalPages}`
-  }
-));
-
-const reactPdfStyles = StyleSheet.create(pdfStyleSheet);
-const PdfPage = ({
-  page,
-  parameters,
-  options
-}) => {
-  return /* @__PURE__ */ React.createElement(Page$2, { size: "A4", style: reactPdfStyles.page }, /* @__PURE__ */ React.createElement(View, null, /* @__PURE__ */ React.createElement(PdfHtmlBlock, { page, options })), /* @__PURE__ */ React.createElement(PdfFooter, { parameters }));
-};
-
-const Pdf = ({
-  parameters,
-  options,
-  pages,
-  sortedPages
-}) => {
-  for (let key in sortedPages) {
-    if (sortedPages.hasOwnProperty(key)) {
-      sortedPages[key].forEach((section) => {
-        section.pages.forEach((page) => {
-          page.source;
-        });
-      });
-    }
-  }
-  return /* @__PURE__ */ React.createElement(Document, null, Object.values(pages).map((page, i) => /* @__PURE__ */ React.createElement(
-    PdfPage,
-    {
-      key: i,
-      page,
-      parameters,
-      options
-    }
-  )));
-};
-
-const generatePdf = ({
-  pages,
-  options,
-  parameters,
-  sortedPages,
-  mainProcess
-}) => {
-  const excludedPages = ["release-notes.md", void 0];
-  const filteredPages = Object.fromEntries(
-    Object.entries(pages).filter(([key]) => key !== "undefined" && !excludedPages.includes(key))
-  );
-  const pdfName = parameters.name.toLowerCase() + ".pdf";
-  const pdfPath = path.normalize(`${options.output}/${pdfName}`);
-  console.log(pico.green("Generating the PDF"));
-  ReactPDF.render(
-    /* @__PURE__ */ React.createElement(
-      Pdf,
-      {
-        options,
-        pages: filteredPages,
-        sortedPages,
-        parameters
-      }
-    ),
-    pdfPath
-  );
-};
-
-const scaffold$1 = async ({ outputDirectory, verbose }) => {
-  console.log(pico.green("Creating scaffold template directory"));
-  await copyDirectory(
-    join(packageAbsolutePath, "include/example"),
-    outputDirectory,
-    verbose
-  );
-};
-
-const sortPages = ({ contents }) => {
-  return contents.reduce(
-    (acc, section) => {
-      const { column } = section;
-      return {
-        ...acc,
-        [column]: [...acc[column] || [], section]
-      };
-    },
-    { 1: [], 2: [], 3: [], 4: [], 5: [] }
-  );
-};
-
-const deriveParameters = ({
-  rawParameters,
-  setVersion,
-  setReleaseDate,
-  homeLink
-}) => {
-  const version = setVersion || rawParameters.version;
-  const releaseDate = setReleaseDate || rawParameters.date;
-  const homePagePath = `${homeLink.source.slice(
-    0,
-    homeLink.source.lastIndexOf(".")
-  )}.html`;
-  const currentDate = /* @__PURE__ */ new Date();
-  const date = currentDate.toLocaleDateString("en-GB");
-  const time = currentDate.toLocaleTimeString("en-US", { hour12: false });
-  const year = currentDate.getFullYear().toString();
-  const attribution = `Created by DocGen ${version} on ${date} at ${time}.`;
-  const webFooter = `Version ${version} released on ${releaseDate}`;
-  return {
-    ...rawParameters,
-    attribution,
-    year,
-    webFooter,
-    version,
-    releaseDate,
-    homePagePath
-  };
-};
-
-const Copyright = ({
-  parameters
-}) => {
-  return /* @__PURE__ */ React.createElement("span", { id: "dg-copyright" }, "\xA9 ", parameters.year, "\xA0", parameters?.organization?.url ? /* @__PURE__ */ React.createElement("a", { href: parameters.organization.url }, parameters.organization.name) : parameters?.organization?.nmee ? /* @__PURE__ */ React.createElement("span", null, "parameters.organization.name") : null);
-};
-
-const Footer = ({
-  parameters
-}) => {
-  return /* @__PURE__ */ React.createElement(React.Fragment, null, /* @__PURE__ */ React.createElement("p", null, /* @__PURE__ */ React.createElement(Copyright, { parameters })), /* @__PURE__ */ React.createElement("p", null, /* @__PURE__ */ React.createElement("span", null, parameters.marking, " ", parameters.legalese, " ", parameters.attribution)));
-};
-const WebFooter = ({ parameters }) => {
-  return /* @__PURE__ */ React.createElement("footer", null, /* @__PURE__ */ React.createElement("div", null, /* @__PURE__ */ React.createElement("p", null, /* @__PURE__ */ React.createElement("span", { id: "dg-web-footer" }, parameters.webFooter))), /* @__PURE__ */ React.createElement("div", null, /* @__PURE__ */ React.createElement(Footer, { parameters })));
-};
-
-const Logo = ({ parameters }) => {
-  return parameters?.logoPath && /* @__PURE__ */ React.createElement(
-    "img",
-    {
-      style: {
-        marginRight: "25px"
-      },
-      src: parameters?.logoPath
-    }
-  );
-};
-const TopBar = ({ parameters }) => {
-  return /* @__PURE__ */ React.createElement("div", null, /* @__PURE__ */ React.createElement("div", { className: "topbar" }, /* @__PURE__ */ React.createElement("div", { className: "left" }, /* @__PURE__ */ React.createElement("a", { className: "dg-homelink", href: parameters.homePagePath }, /* @__PURE__ */ React.createElement(Logo, { parameters })), /* @__PURE__ */ React.createElement("div", { id: "headerLeftText" }, /* @__PURE__ */ React.createElement("a", { className: "dg-homelink", href: parameters.homePagePath }, /* @__PURE__ */ React.createElement("span", { id: "dg-title" }, parameters.title), /* @__PURE__ */ React.createElement("span", { id: "dg-web-title-version", style: { fontWeight: "normal" } }, "\xA0(", parameters.version, ")")), parameters?.sponsorLink?.name && /* @__PURE__ */ React.createElement("div", { id: "headerSponsor" }, /* @__PURE__ */ React.createElement("span", null, parameters.sponsorLink.name), /* @__PURE__ */ React.createElement("a", { href: parameters.sponsorLink.url }, /* @__PURE__ */ React.createElement(
-    "img",
-    {
-      id: "sponsorLogo",
-      src: parameters.sponsorLink.logo,
-      alt: "sponsor logo"
-    }
-  ))))), /* @__PURE__ */ React.createElement("div", { className: "right" }, /* @__PURE__ */ React.createElement("span", { id: "dg-backlink" }, parameters.backlink.url && /* @__PURE__ */ React.createElement("a", { className: "button inverted", href: parameters.backlink.url }, parameters.backlink.name)))));
-};
-
-const Page$1 = ({ page }) => {
-  const name = page.source.substring(0, page.source.lastIndexOf("."));
-  const path = name + ".html";
-  return /* @__PURE__ */ React.createElement("li", null, /* @__PURE__ */ React.createElement("a", { href: path }, page.title));
-};
-const SideBar = ({
-  name,
-  sortedPages,
-  pdfEnabled
-}) => {
-  const pages = Object.values(sortedPages).flat();
-  const pdfName = name.toLowerCase() + ".pdf";
-  return /* @__PURE__ */ React.createElement("div", { id: "dgSideBar", className: "dgSideBarCollapsed" }, /* @__PURE__ */ React.createElement("button", { id: "dgSideBarButton" }, /* @__PURE__ */ React.createElement("span", { className: "dgIcon", "data-name": "menu-2" })), /* @__PURE__ */ React.createElement("div", { id: "dgSideBarInnerWrapper" }, /* @__PURE__ */ React.createElement("div", { id: "dgSideBarInner" }, /* @__PURE__ */ React.createElement("div", { id: "dgSideBarContent" }, pages.filter((p) => p?.heading !== "Extra").map((page, i) => /* @__PURE__ */ React.createElement("div", { key: i }, /* @__PURE__ */ React.createElement("div", { className: "dgSideBarHeading" }, page.heading), /* @__PURE__ */ React.createElement("ul", null, page.pages.map((subPage, i2) => /* @__PURE__ */ React.createElement(Page$1, { key: i2, page: subPage }))))), /* @__PURE__ */ React.createElement("div", { className: "dgSideBarAttribution" }, /* @__PURE__ */ React.createElement("ul", null, /* @__PURE__ */ React.createElement("li", null, /* @__PURE__ */ React.createElement(
-    "span",
-    {
-      className: "dgIcon",
-      "data-name": "users",
-      title: "ownership"
-    }
-  ), /* @__PURE__ */ React.createElement("a", { href: "ownership.html" }, "Ownership")), /* @__PURE__ */ React.createElement("li", null, /* @__PURE__ */ React.createElement(
-    "span",
-    {
-      className: "dgIcon",
-      "data-name": "refresh",
-      title: "release notes"
-    }
-  ), /* @__PURE__ */ React.createElement("a", { href: "release-notes.html" }, "Release Notes")))), /* @__PURE__ */ React.createElement("div", { className: "dgSideBarPDFButton" }, pdfEnabled && /* @__PURE__ */ React.createElement(
-    "a",
-    {
-      className: "button",
-      style: { textDecoration: "none" },
-      href: pdfName
-    },
-    "PDF"
-  ))))));
-};
-
-const Page = ({ children }) => {
-  return /* @__PURE__ */ React.createElement(
-    "div",
-    {
-      className: "page"
-    },
-    children
-  );
-};
-
-const Main = ({
-  parameters,
-  sortedPages,
-  pdfEnabled,
-  children
-}) => {
-  const {
-    name
-  } = parameters;
-  return /* @__PURE__ */ React.createElement(React.Fragment, null, /* @__PURE__ */ React.createElement(
-    TopBar,
-    {
-      parameters
-    }
-  ), /* @__PURE__ */ React.createElement(
-    SideBar,
-    {
-      name,
-      sortedPages,
-      pdfEnabled
-    }
-  ), /* @__PURE__ */ React.createElement(Page, null, /* @__PURE__ */ React.createElement("section", { id: "dg-content" }, /* @__PURE__ */ React.createElement("div", { id: "dg-innerContent" }, children)), /* @__PURE__ */ React.createElement(WebFooter, { parameters })));
-};
-
-const Cover = ({
-  parameters
-}) => {
-  return /* @__PURE__ */ React.createElement("div", { className: "w-fixed-width" }, /* @__PURE__ */ React.createElement("div", { id: "dg-innerContent" }, /* @__PURE__ */ React.createElement(
-    "table",
-    {
-      id: "dg-coverInfo"
-    },
-    /* @__PURE__ */ React.createElement("thead", null, /* @__PURE__ */ React.createElement("tr", null, /* @__PURE__ */ React.createElement("th", { colSpan: 3, id: "dg-title" }, parameters.title))),
-    /* @__PURE__ */ React.createElement("tfoot", null),
-    /* @__PURE__ */ React.createElement("tbody", null, /* @__PURE__ */ React.createElement("tr", null, /* @__PURE__ */ React.createElement("td", null, /* @__PURE__ */ React.createElement("strong", null, "Owner: "), /* @__PURE__ */ React.createElement("span", { id: "dg-owner" }, parameters.owner?.url ? /* @__PURE__ */ React.createElement("a", { href: parameters.owner.url }, parameters.owner.name) : parameters.owner.name)), /* @__PURE__ */ React.createElement("td", null, /* @__PURE__ */ React.createElement("strong", null, "Version: "), /* @__PURE__ */ React.createElement("span", { id: "dg-version" }, parameters.version)), /* @__PURE__ */ React.createElement("td", null, /* @__PURE__ */ React.createElement("strong", null, "Released: "), /* @__PURE__ */ React.createElement("span", { id: "dg-release-date" }, parameters.releaseDate))), /* @__PURE__ */ React.createElement("tr", null, /* @__PURE__ */ React.createElement("td", null, /* @__PURE__ */ React.createElement("strong", null, "Author: "), /* @__PURE__ */ React.createElement("span", { id: "dg-author" }, parameters.author?.url ? /* @__PURE__ */ React.createElement("a", { href: parameters.author.url }, parameters.author.name) : parameters.author.name)), /* @__PURE__ */ React.createElement("td", { colSpan: 2 }, /* @__PURE__ */ React.createElement("strong", null, "Contributors: "), /* @__PURE__ */ React.createElement("span", { id: "dg-contributors" }, parameters.contributors.map((contributor, i) => /* @__PURE__ */ React.createElement(Fragment, { key: i }, contributor?.url ? /* @__PURE__ */ React.createElement("a", { href: contributor.url }, contributor.name) : contributor.name, i < parameters.contributors.length - 1 && ","))))), /* @__PURE__ */ React.createElement("tr", { className: "dg-finalRow" }, /* @__PURE__ */ React.createElement("td", null, /* @__PURE__ */ React.createElement("strong", null, "Module: "), /* @__PURE__ */ React.createElement("span", { id: "dg-module" }, parameters.module)), /* @__PURE__ */ React.createElement("td", null, /* @__PURE__ */ React.createElement("strong", null, "ID: "), /* @__PURE__ */ React.createElement("span", { id: "dg-id" }, parameters.id)), /* @__PURE__ */ React.createElement("td", null, /* @__PURE__ */ React.createElement("strong", null, "Link: "), /* @__PURE__ */ React.createElement("span", { id: "dg-website" }, parameters.website?.url ? /* @__PURE__ */ React.createElement("a", { href: parameters.website.url }, parameters.website.name) : parameters.website.name))))
-  ), /* @__PURE__ */ React.createElement("h1", null, "Summary"), /* @__PURE__ */ React.createElement("p", { id: "dg-summary" }, parameters.summary)));
-};
-
-const toHTML = (component) => {
-  return ReactDOMServer.renderToStaticMarkup(component);
-};
-
-const { cloneDeep } = pkg;
-const processTemplates = ({
-  parameters,
-  templates: rawTemplates
-}) => {
-  const templates = cloneDeep(rawTemplates);
-  for (let key in templates) {
-    if (templates.hasOwnProperty(key)) {
-      let $ = templates[key];
-      $("title").text(parameters.title);
-    }
-  }
-  return templates;
-};
-const processPages = async ({
-  templates,
-  pages: rawPages,
-  sortedPages,
-  parameters,
-  options,
-  contents
-}) => {
-  const hydratedTemplates = processTemplates({
-    parameters,
-    templates
-  });
-  const pages = cloneDeep(rawPages);
-  const pageTableOfContentsEnabled = options.pageToc;
-  const tableOfContents = contents;
-  const mainTemplate = hydratedTemplates.main;
-  const pdfEnabled = options.pdf;
-  console.log(pico.green("Generating the static web content"));
-  tableOfContents.forEach((section) => {
-    section.pages.forEach((page) => {
-      let $2 = cheerio.load(mainTemplate.html());
-      let key = page.source;
-      const htmlPage = toHTML(
-        /* @__PURE__ */ React.createElement(
-          Main,
-          {
-            parameters,
-            sortedPages,
-            pdfEnabled
-          }
-        )
-      );
-      $2("body").html(htmlPage);
-      const content = pages[key];
-      $2("#dg-innerContent").html(content);
-      let html = [], i = -1;
-      let headings = $2("h1, h2, h3, h4, h5, h6");
-      if (headings.length > 0) {
-        html[++i] = '<ul class="dg-pageToc">';
-      }
-      headings.each(function() {
-        let label = $2(this).text();
-        let anchor = label.toLowerCase().replace(/\s+/g, "-");
-        $2(this).attr("id", anchor);
-        html[++i] = '<li><a href="#' + anchor + '">' + label + "</a></li>";
-      });
-      if (headings.length > 0) {
-        html[++i] = "</ul>";
-      }
-      if (pageTableOfContentsEnabled === true && page.html !== true) {
-        $2("#dg-innerContent").prepend(html.join(""));
-      }
-      if (!page.hideAutomaticPageHeading) {
-        $2("#dg-innerContent").prepend(
-          '<h1 id="dg-autoTitle">' + page.title + "</h1>"
-        );
-        $2("#dg-autoTitle").addClass("dg-hiddenTitle");
-      }
-      pages[key] = $2.html();
-    });
-  });
-  const webCoverHtml = toHTML(
-    /* @__PURE__ */ React.createElement(
-      Main,
-      {
-        parameters,
-        sortedPages,
-        pdfEnabled
-      },
-      /* @__PURE__ */ React.createElement(
-        Cover,
-        {
-          parameters
-        }
-      )
-    )
-  );
-  let $ = cheerio.load(mainTemplate.html());
-  $("body").html(webCoverHtml);
-  return {
-    pages,
-    redirect: hydratedTemplates.redirect,
-    webCover: $.html()
-  };
-};
-
-const writePages = async ({
-  options,
-  hydratedPages,
-  contents,
-  mainProcess
-}) => {
-  console.log(pico.green("Writing the web page files"));
-  try {
-    const promises = contents.flatMap(
-      (section) => section.pages.map((page) => {
-        const key = page.source;
-        const name = key.substr(0, page.source.lastIndexOf("."));
-        const path = options.output + name + ".html";
-        const html = hydratedPages.pages[key];
-        return writeFile(path, html);
-      })
-    );
-    await Promise.all(promises);
-    await writeFile(options.output + "ownership.html", hydratedPages.webCover);
-    await copyDirectory(
-      join(packageAbsolutePath, "include/require"),
-      options.output + "require",
-      options.verbose
-    );
-    await copyDirectory(
-      options.input + "files",
-      options.output + "files",
-      options.verbose
-    );
-  } catch (error) {
-    console.log(pico.red("Error writing the web page files"));
-    if (options.verbose === true) {
-      console.log(pico.red(error));
-    }
-    mainProcess.exit(1);
-  }
-};
-
-let createRedirect = async ({ options, redirectPage, homePage }) => {
-  if (options.isRedirectEnabled) {
-    let parent = options.output.replace(/\/$/, "");
-    parent = parent.split(path.sep).slice(-1).pop();
-    let homepage = homePage;
-    homepage = homepage.source.substr(0, homepage.source.lastIndexOf(".")) + ".html";
-    let redirectLink = parent + "/" + homepage;
-    let $ = redirectPage;
-    $("a").attr("href", redirectLink);
-    $("meta[http-equiv=REFRESH]").attr("content", "0;url=" + redirectLink);
-    let file = options.output + "../index.html";
-    try {
-      await writeFile(file, $.html());
-    } catch (error) {
-      console.log(pico.red("Error writing redirect file: " + file));
-      if (options.verbose === true) {
-        console.log(pico.red(error));
-      }
-    }
-  }
-};
-
-var version = "5.2.0";
-
-function DocGen(process) {
-  let mainProcess = process;
-  let options;
-  this.getVersion = () => {
-    return version;
-  };
-  this.setOptions = (userOptions) => {
-    options = userOptions;
-    if (options.input) {
-      options.input = path.normalize(options.input + "/");
-    }
-    if (options.output) {
-      options.output = path.normalize(options.output + "/");
-    }
-  };
-  this.scaffold = async () => scaffold$1({
-    outputDirectory: options.output,
-    verbose: options.verbose === true
-  });
-  this.run = async () => {
-    console.log(pico.green(pico.bold("DocGen version " + version)));
-    await cleanDirectory(options.output, options.verbose);
-    const templates = await loadTemplates({
-      options,
-      mainProcess
-    });
-    const { contents, rawParameters } = await loadMeta({
-      inputPath: options.input,
-      verbose: options.verbose,
-      mainProcess
-    });
-    const sortedPages = sortPages({ contents });
-    const parameters = deriveParameters({
-      rawParameters,
-      setVersion: options.setVersion,
-      setReleaseDate: options.setReleaseDate,
-      homeLink: contents[0].pages[0]
-    });
-    const pages = await loadMarkdown({
-      options,
-      contents,
-      mainProcess
-    });
-    const hydratedPages = await processPages({
-      templates,
-      pages,
-      sortedPages,
-      parameters,
-      options,
-      contents
-    });
-    await writePages({
-      options,
-      contents,
-      hydratedPages,
-      mainProcess
-    });
-    await createRedirect({
-      options,
-      redirectPage: hydratedPages.redirect,
-      homePage: contents[0].pages[0]
-    });
-    if (options.pdf === true) {
-      generatePdf({
-        options,
-        pages,
-        parameters,
-        sortedPages,
-        mainProcess
-      });
-    } else {
-      console.log(pico.green(pico.bold("Done!")));
-    }
-  };
-}
-
-const generator = new DocGen(process);
-const scaffold = (command) => {
-  generator.setOptions(command);
-  generator.scaffold();
-};
-const run = (command) => {
-  generator.setOptions(command);
-  generator.run();
-};
-program.version(generator.getVersion()).usage("[command] [--option]");
-program.command("scaffold").usage("[--option]").description("create a template input directory").option(
-  "-o, --output [path]",
-  "path to the output directory (default: ./)",
-  "./"
-).option("-v, --verbose", "show verbose output including detailed errors").action((command) => {
-  scaffold(command);
-});
-program.command("run").usage("[--option]").description("create a static website from an input directory").option(
-  "-i, --input [path]",
-  "path to the input directory [default: ./]",
-  "./"
-).option(
-  "-o, --output [path]",
-  "path to the output directory [default: ./output]",
-  "./output"
-).option("-v, --verbose", "show verbose output including detailed errors").option(
-  "-t, --page-toc",
-  "show a page table of contents at the top of each web page"
-).option("-p, --pdf", "create a PDF document").option(
-  "-r, --redirect",
-  "create an index.html in the parent directory that redirects to the homepage"
-).option(
-  "-s, --set-version [version]",
-  "override parameters.version (useful for build tools) [default: false]",
-  false
-).option(
-  "-R, --set-release-date [date]",
-  "override parameters.date (useful for build tools) [default: false]",
-  false
-).action((command) => {
-  run(command);
-});
-program.parse(process.argv);
-if (!process.argv.slice(2).length) {
-  program.help();
-}