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

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

'use strict';

function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
const path = require('node:path');
const server = require('@docusaurus/plugin-content-docs/server');
const utils = require('@docusaurus/utils');
const _interopDefault = e => e && e.__esModule ? e : {
  default: e
};
const path__default = /*#__PURE__*/_interopDefault(path);

// BASED ON: https://github.com/facebook/docusaurus/blob/main/packages/docusaurus-plugin-content-docs/src/versions.ts

function getVersionedDocsDirPath(siteDir, pluginId) {
  return path__default.default.join(siteDir, pluginId === utils.DEFAULT_PLUGIN_ID ? server.VERSIONED_DOCS_DIR : `${pluginId}_${server.VERSIONED_DOCS_DIR}`);
}
function getDefaultLastVersionName(versionNames) {
  if (versionNames.length === 1) {
    return versionNames[0];
  }
  return versionNames.find(versionName => versionName !== server.CURRENT_VERSION_NAME) ?? '';
}
function createVersionMetadata({
  versionName,
  versionNames,
  lastVersionName,
  context,
  options
}) {
  const isLast = versionName === lastVersionName;
  const versionOptions = options.versions[versionName] ?? {};
  const versionLabel = versionOptions.label ?? versionName === server.CURRENT_VERSION_NAME ? 'Next' : versionName;
  let versionPathPart = versionOptions.path ?? versionName === server.CURRENT_VERSION_NAME ? 'next' : versionName;
  if (isLast) {
    versionPathPart = '';
  }
  const versionPath = utils.normalizeUrl([context.siteConfig.baseUrl, options.routeBasePath ?? 'api', versionPathPart]);
  return {
    isLast: versionName === lastVersionName,
    routePriority: versionPathPart === '' ? -1 : undefined,
    versionBadge: versionOptions?.badge ?? versionNames.length !== 1,
    versionBanner: server.getDefaultVersionBanner({
      context,
      lastVersionName,
      // @ts-expect-error Ignore internal options
      options,
      versionName,
      versionNames
    }),
    versionClassName: versionOptions?.className ?? `api-version-${versionName}`,
    versionLabel,
    versionName,
    versionPath
  };
}
async function readVersionsMetadata(context, options) {
  // Docusaurus internals require *every* option, but the versioning
  // does not actually use them. We are casting the types here to
  // ignore all the missing properties.
  const specialOptions = options;
  const versionNamesUnfiltered = await server.readVersionNames(context.siteDir, _objectSpread(_objectSpread({}, specialOptions), {}, {
    disableVersioning: options.disableVersioning ?? false,
    id: options.id ?? 'default',
    includeCurrentVersion: options.includeCurrentVersion ?? true
  }));
  const versionNames = server.filterVersions(versionNamesUnfiltered, _objectSpread(_objectSpread({}, specialOptions), {}, {
    onlyIncludeVersions: options.onlyIncludeVersions && options.onlyIncludeVersions.length > 0 ? options.onlyIncludeVersions : undefined
  }));
  const lastVersionName = options.lastVersion ? options.lastVersion : getDefaultLastVersionName(versionNames);
  return versionNames.map(versionName => createVersionMetadata({
    context,
    lastVersionName,
    options,
    versionName,
    versionNames
  }));
}
exports.getVersionedDocsDirPath = getVersionedDocsDirPath;
exports.readVersionsMetadata = readVersionsMetadata;
//# sourceMappingURL=version.js.map