rx-player 4.0.0-beta.1 → 4.0.0-beta.2

package/scripts/doc-generator/generate_page_list_html.js

@@ -1,92 +0,0 @@
-const { encode } = require("html-entities");
-const path = require("path");
-const {
-  getGithubSvg,
-  toUriCompatibleRelativePath,
-} = require("./utils");
-
-/**
- * Construct exhaustive list of documentation links as an HTML string.
- * @param {Array.<Object>} links
- * @param {number} currentLinkIdx
- * @param {Array.<number>} currentPageIndexes
- * @param {string} currentPath
- * @returns {string}
- */
-function generatePageListHtml(
-  links,
-  currentLinkIdx,
-  currentPageIndexes,
-  currentPath
-) {
-  const currentDir = path.dirname(currentPath);
-  const linksHtml = links.map((l, linkIdx) => {
-    switch (l.type) {
-      case "local-doc": {
-        const isActiveCat = linkIdx === currentLinkIdx;
-        const catActiveClasses = isActiveCat ? " opened active" : "";
-
-        const catHtml = `<li class="page-list-item">` +
-          `<div class="page-list-group${catActiveClasses}">` +
-          encode(l.displayName) +
-          `</div><ul class="page-list-cat-group">`;
-
-        return catHtml + l.pages.map((currentPage, pageidx) => {
-          const isPageActive = isActiveCat && pageidx === currentPageIndexes[0];
-          const { displayName, outputFile } = currentPage;
-          if (!currentPage.isPageGroup) {
-            const pageActiveClasses = isPageActive ? " active" : "";
-            const relativeUri = toUriCompatibleRelativePath(outputFile, currentDir);
-            return `<li class="page-list-item${pageActiveClasses}">` +
-              `<a href="${encode(relativeUri)}">` +
-              encode(displayName) +
-              `</a></li>`;
-          }
-          const pageActiveClasses = isPageActive ? " opened active" : "";
-          const pageGroupHtml = `<li>` +
-            `<div class="page-list-item page-list-group${pageActiveClasses}">` +
-            encode(displayName) +
-            `</div><ul class="page-list-group-group">`;
-          return pageGroupHtml + currentPage.pages.map((currentSubPage, spIdx) => {
-            const spActiveClasses = isPageActive && spIdx === currentPageIndexes[1] ?
-              " active" : "";
-            const { displayName, outputFile } = currentSubPage;
-            const relativeUri = toUriCompatibleRelativePath(outputFile, currentDir);
-            return `<li class="page-list-item${spActiveClasses}">` +
-              `<a href="${encode(relativeUri)}">` +
-              encode(displayName) +
-              `</a></li>`;
-          }).join("\n") + "</ul></li>";
-        }).join("\n") + "</ul></li>";
-      }
-
-      case "external-link": {
-        const cleanedHref = encode(l.link);
-        return `<li class="page-list-item">` +
-          `<a href="${cleanedHref}">` +
-          encode(l.displayName) +
-          "</a></li>";
-      }
-
-      case "github-link":
-        const cleanedHref = encode(l.link);
-        return `<li class="page-list-item">` +
-          `<a aria-label="Link to repository" href="${cleanedHref}">` +
-            getGithubSvg() +
-            "</a></li>";
-
-      case "search":
-        return "";
-
-      case "version":
-        // TODO?
-        return "";
-    }
-  }).join("\n");
-
-  return `<ul class="page-list-wrapper">` +
-    linksHtml +
-    "</ul>";
-};
-
-module.exports = generatePageListHtml;

package/scripts/doc-generator/generate_sidebar_html.js

@@ -1,85 +0,0 @@
-const path = require("path");
-const { encode } = require("html-entities");
-const { toUriCompatibleRelativePath } = require("./utils");
-
-/**
- * Construct HTML element, as a string, which corresponds to the sidebar for
- * the chosen documentation page.
- * @param {Array.<Object>} pages
- * @param {Array.<number>} currentPageIndexes
- * @param {string} currentPath
- * @param {Object} logoInfo
- * @returns {string}
- */
-function generateSidebarHtml(
-  pages,
-  currentPageIndexes,
-  currentPath,
-  logoInfo
-) {
-  const sidebarHeaderHtml = constructSidebarHeaderHtml(logoInfo);
-  const links = pages.map((p, i) => {
-    const isActive = i === currentPageIndexes[0];
-    if (!p.isPageGroup) {
-      return generateLiForPage(p, isActive);
-    } else {
-      const lis = p.pages.map((sp, j) => {
-        const isActiveSubPage = isActive && j === currentPageIndexes[1];
-        return generateLiForPage(sp, isActiveSubPage);
-      }).join("");
-      return `<li class="sidebar-item">` +
-        `<div class="sidebar-item sidebar-item-group${isActive ? " active opened" : ""}">` +
-        encode(p.displayName) +
-        "</div>" +
-        `<ul>${lis}</ul>` +
-        "</li>";
-
-    }
-  }).join("");
-  return `<aside class="sidebar-parent">` +
-    sidebarHeaderHtml +
-    `<div class="sidebar-wrapper">` +
-    `<div class="sidebar-items">${links}</div>` +
-    "</div>" +
-    "</aside>";
-
-  function generateLiForPage(p, isActive) {
-    const relativeUri = toUriCompatibleRelativePath(
-      p.outputFile,
-      path.dirname(currentPath)
-    );
-    const activeClass = isActive ? " active" : "";
-    const cleanedHref = encode(relativeUri);
-    return "<li class=\"sidebar-item\">" +
-      `<a class="sidebar-link${activeClass}" href="` +
-      cleanedHref +
-      `">${encode(p.displayName)}</a>` +
-      "</li>";
-  }
-}
-
-/**
- * @param {Object} logoInfo
- * @returns {string}
- */
-function constructSidebarHeaderHtml(logoInfo) {
-  let sidebarHeaderHtml = `<div class="sidebar-header">`;
-  if (logoInfo !== undefined) {
-    let hasLink = false;
-    if (typeof logoInfo.link === "string") {
-      hasLink = true;
-      sidebarHeaderHtml += `<a href="${encode(logoInfo.link)}">`;
-    }
-    if (typeof logoInfo.url === "string") {
-      sidebarHeaderHtml += `<img alt="logo" class="sidebar-header-logo"` +
-        ` src="${encode(logoInfo.url)}" />`;
-    }
-    if (hasLink) {
-      sidebarHeaderHtml += "</a>";
-    }
-  }
-  sidebarHeaderHtml += `</div>`;
-  return sidebarHeaderHtml;
-}
-
-module.exports = generateSidebarHtml;

package/scripts/doc-generator/get_search_data_for_content.js

@@ -1,137 +0,0 @@
-const cheerio = require("cheerio");
-
-/**
- * Generate search data linked to the given content.
- * @param {string} contentHtml
- * @returns {Array.<Object>}
- */
-function getSearchDataForContent(contentHtml) {
-  const indexForFile = [];
-  const $ = cheerio.load(contentHtml);
-  const children = $("body").children().toArray();
-
-  let currentH1;
-  let currentH2;
-  let currentH3;
-  let currentH1Anchor;
-  let currentH2Anchor;
-  let currentH3Anchor;
-  let currentBody = [];
-  let currentLevel;
-  for (var i = 0; i < children.length; i++) {
-    const child = children[i];
-    switch (child.name.toLowerCase()) {
-      case "h1":
-        anounceLastElement();
-        currentH1 = $(child).text();
-
-        // TODO We know that's the anchor's link is in the previous element.
-        // That's pretty ugly but it works for now.
-        // Find better solution
-        currentH1Anchor = getAnchorName(children[i - 1]);
-        currentH2 = undefined;
-        currentH2Anchor = undefined;
-        currentH3 = undefined;
-        currentH3Anchor = undefined;
-        currentLevel = "h1";
-        break;
-      case "h2":
-        anounceLastElement();
-        currentH2 = $(child).text();
-
-        // TODO We know that's the anchor's link is in the previous element.
-        // That's pretty ugly but it works for now.
-        // Find better solution
-        currentH2Anchor = getAnchorName(children[i - 1]);
-        currentH3 = undefined;
-        currentH3Anchor = undefined;
-        currentLevel = "h2";
-        break;
-      case "h3":
-        anounceLastElement();
-
-        // TODO We know that's the anchor's link is in the previous element.
-        // That's pretty ugly but it works for now.
-        // Find better solution
-        getAnchorName(children[i - 1]);
-        currentH3 = $(child).text();
-        currentH3Anchor = getAnchorName(children[i - 1]);
-        currentLevel = "h3";
-        break;
-
-      // case "pre":
-      //   // code - do nothing?
-      //   break;
-
-      default:
-        const text = $(child).text().replace(/\n/g, " ");
-        if (text !== undefined && text.length > 0) {
-          currentBody.push(text);
-        }
-        break;
-    }
-  }
-  anounceLastElement();
-  return indexForFile;
-
-  function anounceLastElement() {
-    if (currentLevel === "h3") {
-      const body = currentBody.length > 0 ?
-        currentBody.join(" ") :
-        "";
-      indexForFile.push({
-        h1: currentH1,
-        h2: currentH2,
-        h3: currentH3,
-        body,
-        anchorH1: currentH1Anchor,
-        anchorH2: currentH2Anchor,
-        anchorH3: currentH3Anchor,
-      });
-    } else if (currentLevel === "h2") {
-      const body = currentBody.length > 0 ?
-        currentBody.join(" ") :
-        "";
-      indexForFile.push({
-        h1: currentH1,
-        h2: currentH2,
-        body,
-        anchorH1: currentH1Anchor,
-        anchorH2: currentH2Anchor,
-      });
-    } else if (currentLevel === "h1") {
-      const body = currentBody.length > 0 ?
-        currentBody.join(" ") :
-        "";
-      indexForFile.push({
-        h1: currentH1,
-        body,
-        anchorH1: currentH1Anchor,
-      });
-    }
-    currentBody.length = 0;
-  }
-
-  function getAnchorName(elt) {
-    if (elt === undefined) {
-      return;
-    }
-
-    const children = $(elt).children();
-    if (children.length !== 1) {
-      return;
-    }
-
-    const child = children.toArray()[0];
-    if (child.name !== "a") {
-      return;
-    }
-
-    const name = $(child).attr("name");
-    if (name !== undefined && name.length > 0) {
-      return name;
-    }
-  }
-}
-
-module.exports = getSearchDataForContent;

package/scripts/doc-generator/index.js

@@ -1,34 +0,0 @@
-const process = require("process");
-const path = require("path");
-const createDocumentation = require("./create_documentation.js");
-
-if (process.argv.length < 4) {
-  /* eslint-disable no-console */
-  console.error(
-    "Error: The documentation generator needs at least two arguments: " +
-    "the input directory and the output directory"
-  );
-  /* eslint-enable no-console */
-  process.exit(1);
-}
-
-// TODO better args
-const inDir = process.argv[2];
-const outDir = process.argv[3];
-const version = process.argv[4];
-
-async function main() {
-  createDocumentation(inDir, outDir, {
-    css: [
-      path.join(__dirname, "styles/style.css"),
-      path.join(__dirname, "styles/code.css")
-    ],
-
-    // Add suffix to each page title
-    getPageTitle: originalTitle => originalTitle + " - RxPlayer Documentation",
-
-    version,
-  });
-}
-
-main();

package/scripts/doc-generator/parse_doc_configs.js

@@ -1,327 +0,0 @@
-const process = require("process");
-const { promisify } = require("util");
-const fs = require("fs");
-const path = require("path");
-
-module.exports = async function parseDocConfigs(
-  baseInDir,
-  baseOutDir,
-  version
-) {
-  const rootConfigFileName = path.join(baseInDir, ".docConfig.json");
-  const rootConfig = await parseAndCheckRootConfigFile(rootConfigFileName);
-  const ret = {
-    versionInfo: undefined,
-    logo: undefined,
-    favicon: undefined,
-    links: [],
-    linksRightIndex: -1,
-  };
-
-  if (typeof version === "string") {
-    ret.versionInfo = { version };
-    if (typeof rootConfig.otherVersionsLink === "string") {
-      ret.versionInfo.link = rootConfig.otherVersionsLink;
-    }
-  }
-
-  if (typeof rootConfig.logo === "object") {
-    ret.logo = rootConfig.logo;
-  }
-
-  if (typeof rootConfig.favicon === "object") {
-    ret.favicon = rootConfig.favicon;
-  }
-
-  const linksLeft = rootConfig.linksLeft ?? [];
-  const linksRight = rootConfig.linksRight ?? [];
-  const categoryLinks = linksLeft.concat(linksRight);
-  if (linksRight.length > 0) {
-    ret.linksRightIndex = linksLeft.length;
-  }
-
-  for (let i = 0; i < categoryLinks.length; i++) {
-    const category = categoryLinks[i];
-
-    let parsedCategory;
-    switch (category.type) {
-      case "local-doc":
-        parsedCategory = await parseLocalDocCategory(category, baseInDir, baseOutDir);
-        break;
-      case "version":
-        parsedCategory = { type: "version" };
-        break;
-      case "link":
-        parsedCategory = {
-          type: "external-link",
-          link: category.link,
-          displayName: category.displayName
-        };
-        break;
-      case "github-link":
-        parsedCategory = {
-          type: "github-link",
-          link: category.link,
-        };
-        break;
-      case "search":
-        parsedCategory = { type: "search" };
-        break;
-    }
-    ret.links.push(parsedCategory);
-  }
-  return ret;
-};
-
-async function parseLocalDocCategory(
-  category,
-  baseInDir,
-  baseOutDir
-) {
-  const categoryPath = path.join(baseInDir, category.path);
-  const categoryOutPath = path.join(baseOutDir, category.path);
-  const parsedCategory = {
-    type: "local-doc",
-    displayName: category.displayName,
-    description: category.description,
-    firstPage: "",
-    pages: [],
-  };
-  const catCfgFileName = path.join(categoryPath, ".docConfig.json");
-  const categoryConfig = await parseAndCheckSubConfigFile(catCfgFileName);
-  for (const page of categoryConfig.pages) {
-    const pagePath = path.join(categoryPath, page.path);
-    let pageStat;
-    try {
-      pageStat = await promisify(fs.stat)(pagePath);
-    } catch (err) {
-      const srcMessage = (err ?? {}).message ?? "Unknown error";
-      console.error(`Error: Cannot run stat on "${pagePath}": ${srcMessage}`);
-      process.exit(1);
-    }
-
-    if (pageStat.isDirectory()) {
-      const parsedPage = {
-        isPageGroup: true,
-        displayName: page.displayName,
-        description: path.description,
-        pages: [],
-      };
-      parsedCategory.pages.push(parsedPage);
-      const pageCfgFileName = path.join(pagePath, ".docConfig.json");
-      const pageGroupConfig = await parseAndCheckSubConfigFile(pageCfgFileName);
-      for (const subPage of pageGroupConfig.pages) {
-        const subPagePath = path.join(pagePath, subPage.path);
-        const subPageOutPath = path.join(categoryOutPath, page.path, subPage.path);
-        let subPageState;
-        try {
-          subPageState = await promisify(fs.stat)(subPagePath);
-        } catch (err) {
-          const srcMessage = (err ?? {}).message ?? "Unknown error";
-          console.error(`Error: Cannot run stat on "${subPagePath}": ${srcMessage}`);
-          process.exit(1);
-        }
-
-        if (subPageState.isDirectory()) {
-          console.error(
-            "Error: Category page depth cannot exceed 2 yet \"" +
-              subPagePath + "\" is a directory."
-          );
-          process.exit(1);
-        }
-        const outputFile = path.join(path.dirname(subPageOutPath),
-                                     path.basename(subPagePath, ".md") + ".html");
-        parsedPage.pages.push({
-          isPageGroup: false,
-          displayName: subPage.displayName,
-          description: subPage.description,
-          inputFile: path.normalize(path.resolve(subPagePath)),
-          outputFile: path.normalize(path.resolve(outputFile)),
-        });
-      }
-    } else if(pageStat.isFile()) {
-      const outputFile =
-        path.join(categoryOutPath, path.basename(pagePath, ".md") + ".html");
-      parsedCategory.pages.push({
-        isPageGroup: false,
-        displayName: page.displayName,
-        description: page.description,
-        inputFile: path.normalize(path.resolve(pagePath)),
-        outputFile: path.normalize(path.resolve(outputFile)),
-      });
-    }
-  }
-
-  // Retrieve landing page for category == first page available
-  if (parsedCategory.pages.length > 0) {
-    if (!parsedCategory.pages[0].isPageGroup) {
-      parsedCategory.firstPage = parsedCategory.pages[0].outputFile;
-    } else if (parsedCategory.pages[0].pages.length > 0) {
-      parsedCategory.firstPage = parsedCategory.pages[0].pages[0].outputFile;
-    }
-  }
-  return parsedCategory;
-}
-
-/**
- * Parse root config file into a JS object and check that all properties are in
- * the right format.
- * Exit with a meaningful error if that's not the case.
- * @param {string} rootConfigFileName
- * @returns {Promise.<Object>}
- */
-async function parseAndCheckRootConfigFile(rootConfigFileName) {
-  let configStr;
-  try {
-    configStr = await promisify(fs.readFile)(rootConfigFileName, "utf8");
-  } catch (err) {
-    const srcMessage = (err ?? {}).message ?? "Unknown error";
-    console.error(
-      "Error: Impossible to read Root .docConfig.json file (\"" +
-        rootConfigFileName +
-        "\"): " +
-      srcMessage
-    );
-    process.exit(1);
-  }
-
-  let config;
-  try {
-    config = JSON.parse(configStr);
-  } catch (err) {
-    const srcMessage = (err ?? {}).message ?? "Unknown error";
-    exitWithInvalidRootConfig(srcMessage);
-  }
-
-  if (typeof config !== "object" || config === null) {
-    exitWithInvalidRootConfig("Should be under an object form.");
-  }
-
-  if (config.logo !== undefined) {
-    if (typeof config.logo !== "object" || config.logo === null) {
-      exitWithInvalidRootConfig(
-        `The "logo" property, if defined, should contain an object.`
-      );
-    }
-
-    if (typeof config.logo.srcPath !== "string") {
-      exitWithInvalidRootConfig(
-        `The "logo" property, if defined, should contain a "srcPath" ` +
-          "property set as a string."
-      );
-    }
-
-    if (config.logo.link !== undefined && typeof config.logo.link !== "string") {
-      exitWithInvalidRootConfig(
-        `The "logo.link" property, if defined, should be set as a string.`
-      );
-    }
-  }
-
-  if (config.favicon !== undefined) {
-    if (typeof config.favicon.srcPath !== "string") {
-      exitWithInvalidRootConfig(
-        `The "favicon" property, if defined, should contain a "srcPath" `+
-         "property set as a string."
-      );
-    }
-  }
-
-  if (
-    config.otherVersionsLink !== undefined &&
-    typeof config.otherVersionsLink !== "string"
-  ) {
-    exitWithInvalidRootConfig(
-      `The "otherVersionsLink" property, if defined, should be set as a string.`
-    );
-  }
-
-  if (
-    typeof config.linksLeft !== undefined &&
-    !Array.isArray(config.linksLeft)
-  ) {
-    exitWithInvalidRootConfig(
-      `The "linksLeft" property, if defined, should be set as an Array.`
-    );
-  }
-
-  if (
-    typeof config.linksRight !== undefined &&
-    !Array.isArray(config.linksRight)
-  ) {
-    exitWithInvalidRootConfig(
-      `The "linksRight" property, if defined, should be set as an Array.`
-    );
-  }
-
-  return config;
-
-  function exitWithInvalidRootConfig(reason) {
-    console.error(
-      `Error: Root .docConfig.json file ("${rootConfigFileName}") is invalid: ${reason}`
-    );
-    process.exit(1);
-  }
-}
-
-/**
- * @param {string} filename
- * @returns {Promise.<Object>}
- */
-async function parseAndCheckSubConfigFile(filename) {
-  let configStr;
-  try {
-    configStr = await promisify(fs.readFile)(filename, "utf8");
-  } catch (err) {
-    const srcMessage = (err ?? {}).message ?? "Unknown error";
-    console.error(`Error: Impossible to read "${filename}" config file: ${srcMessage}`);
-    process.exit(1);
-  }
-
-  let config;
-  try {
-    config = JSON.parse(configStr);
-  } catch (err) {
-    const srcMessage = (err ?? {}).message ?? "Unknown error";
-    console.error(`Error: "${filename}" config file is invalid: ${srcMessage}`);
-    process.exit(1);
-  }
-
-  if (typeof config !== "object" || config === null) {
-    console.error(
-      `Error: "${filename}" config file is invalid: ` +
-        `Should be under an object form.`
-    );
-    process.exit(1);
-  }
-
-  if (
-    !Array.isArray(config.pages) ||
-    config.pages.length === 0
-  ) {
-    console.error(
-      `Error: "${filename}" config file is invalid: ` +
-        `Should have a "pages" property with at least one entry.`
-    );
-    process.exit(1);
-  }
-
-  for (const page of config.pages) {
-    if (typeof page.path !== "string") {
-      console.error(
-        `Error: "${filename}" config file is invalid: ` +
-          `One of the element in "pages" has an invalid "path" property ` +
-          "(should be a string)."
-      );
-      process.exit(1);
-    } else if (typeof page.displayName !== "string") {
-      console.error(
-        `Error: "${filename}" config file is invalid: ` +
-          `One of the element in "pages" has an invalid "displayName" property ` +
-          "(should be a string)."
-      );
-      process.exit(1);
-    }
-  }
-  return config;
-}