docusaurus-plugin-typedoc-api/lib/plugin/sidebar.js

Docusaurus plugin that provides source code API documentation powered by TypeDoc.

'use strict';

const utils = require('@docusaurus/utils');
const links = require('../utils/links.js');
const data = require('./data.js');
function groupSidebarItems(map, groups) {
  const items = [];
  const sortedGroups = groups.sort((a, b) => a.title.localeCompare(b.title));
  function getLastItemInGroup(index) {
    const length = sortedGroups[index]?.children?.length;
    return length ? sortedGroups[index]?.children?.[length - 1] : undefined;
  }
  sortedGroups.forEach((group, groupIndex) => {
    const children = group.children;
    if (!children || children.length === 0) {
      return;
    }
    items.push({
      collapsed: true,
      collapsible: true,
      items: children.map((id, index) => {
        const child = map[id];

        // We map previous/next from here since the sidebar is grouped by type,
        // and we only want to link based on this order.
        const previousId = index === 0 ? getLastItemInGroup(groupIndex - 1) : children[index - 1];
        const nextId = index === children.length - 1 ? groups[groupIndex + 1]?.children?.[0] : children[index + 1];
        if (previousId) {
          child.previousId = previousId;
        }
        if (nextId) {
          child.nextId = nextId;
        }
        return {
          href: child.permalink,
          label: child.name,
          type: 'link'
        };
      }),
      label: group.title,
      type: 'category'
    });
  });
  return items;
}
function extractReflectionSidebar(pkg) {
  return pkg.groups ? groupSidebarItems(data.createReflectionMap(pkg.children), pkg.groups) : [];
}
function extractSidebar(packages, scopes, changelogs, sortSidebar) {
  if (packages.length === 0) {
    return [];
  }
  const items = packages.map(pkg => {
    let subItems = [];
    pkg.entryPoints.forEach(entry => {
      // Index entry point should always bubble up reflection groups
      if (entry.index) {
        subItems.push(...extractReflectionSidebar(entry.reflection));
        // Otherwise nest non-index entry points behind categories
      } else {
        subItems.push({
          collapsed: true,
          collapsible: true,
          items: extractReflectionSidebar(entry.reflection),
          label: entry.label,
          type: 'category'
        });
      }
    });

    // Always include the overview as the 1st item
    const indexHref = pkg.entryPoints.find(entry => entry.index)?.reflection.permalink ?? '';
    subItems = subItems.sort((a, d) => sortSidebar('label' in a ? a.label : '', 'label' in d ? d.label : ''));
    subItems.unshift({
      href: indexHref,
      label: 'Overview',
      type: 'link'
    });
    if (pkg.changelogPath && changelogs) {
      subItems.push({
        href: utils.normalizeUrl([indexHref, 'changelog']),
        label: 'Changelog',
        type: 'link'
      });
    }
    return {
      collapsed: true,
      collapsible: true,
      items: subItems,
      label: links.removeScopes(pkg.packageName, scopes),
      type: 'category'
    };
  });
  const sidebar = items.filter(item => 'items' in item && items.length > 0);

  // Collapse sidebar when only 1 package
  if (packages.length === 1 && sidebar.length === 1 && sidebar[0].type === 'category') {
    return sidebar[0].items;
  }
  return sidebar;
}
exports.extractReflectionSidebar = extractReflectionSidebar;
exports.extractSidebar = extractSidebar;
exports.groupSidebarItems = groupSidebarItems;
//# sourceMappingURL=sidebar.js.map