@docusaurus/plugin-content-docs 2.0.0-beta.2 → 2.0.0-beta.22

package/lib/slug.js

@@ -8,33 +8,43 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("@docusaurus/utils");
 const numberPrefix_1 = require("./numberPrefix");
-function getSlug({ baseID, frontmatterSlug, dirName, stripDirNumberPrefixes = true, numberPrefixParser = numberPrefix_1.DefaultNumberPrefixParser, }) {
-    const baseSlug = frontmatterSlug || baseID;
-    let slug;
-    if (baseSlug.startsWith('/')) {
-        slug = baseSlug;
-    }
-    else {
+const docs_1 = require("./docs");
+function getSlug({ baseID, frontMatterSlug, source, sourceDirName, stripDirNumberPrefixes = true, numberPrefixParser = numberPrefix_1.DefaultNumberPrefixParser, }) {
+    function getDirNameSlug() {
         const dirNameStripped = stripDirNumberPrefixes
-            ? numberPrefix_1.stripPathNumberPrefixes(dirName, numberPrefixParser)
-            : dirName;
-        const resolveDirname = dirName === '.'
+            ? (0, numberPrefix_1.stripPathNumberPrefixes)(sourceDirName, numberPrefixParser)
+            : sourceDirName;
+        const resolveDirname = sourceDirName === '.'
             ? '/'
-            : utils_1.addLeadingSlash(utils_1.addTrailingSlash(dirNameStripped));
-        slug = utils_1.resolvePathname(baseSlug, resolveDirname);
+            : (0, utils_1.addLeadingSlash)((0, utils_1.addTrailingSlash)(dirNameStripped));
+        return resolveDirname;
+    }
+    function computeSlug() {
+        if (frontMatterSlug?.startsWith('/')) {
+            return frontMatterSlug;
+        }
+        const dirNameSlug = getDirNameSlug();
+        if (!frontMatterSlug &&
+            (0, docs_1.isCategoryIndex)((0, docs_1.toCategoryIndexMatcherParam)({ source, sourceDirName }))) {
+            return dirNameSlug;
+        }
+        const baseSlug = frontMatterSlug ?? baseID;
+        return (0, utils_1.resolvePathname)(baseSlug, getDirNameSlug());
     }
-    if (!utils_1.isValidPathname(slug)) {
-        throw new Error(`We couldn't compute a valid slug for document with id "${baseID}" in "${dirName}" directory.
+    function ensureValidSlug(slug) {
+        if (!(0, utils_1.isValidPathname)(slug)) {
+            throw new Error(`We couldn't compute a valid slug for document with ID "${baseID}" in "${sourceDirName}" directory.
 The slug we computed looks invalid: ${slug}.
-Maybe your slug frontmatter is incorrect or you use weird chars in the file path?
-By using the slug frontmatter, you should be able to fix this error, by using the slug of your choice:
+Maybe your slug front matter is incorrect or there are special characters in the file path?
+By using front matter to set a custom slug, you should be able to fix this error:
 
-Example =>
 ---
 slug: /my/customDocPath
 ---
 `);
+        }
+        return slug;
     }
-    return slug;
+    return ensureValidSlug(computeSlug());
 }
 exports.default = getSlug;

package/{src/__tests__/__fixtures__/sidebars/sidebars-first-level-not-category.js → lib/tags.d.ts}

@@ -4,17 +4,6 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-
-module.exports = {
-  docs: [
-    {
-      type: 'category',
-      label: 'Getting Started',
-      items: ['greeting'],
-    },
-    {
-      type: 'doc',
-      id: 'api',
-    },
-  ],
-};
+import type { VersionTags } from './types';
+import type { DocMetadata } from '@docusaurus/plugin-content-docs';
+export declare function getVersionTags(docs: DocMetadata[]): VersionTags;

package/lib/tags.js

@@ -0,0 +1,21 @@
+"use strict";
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getVersionTags = void 0;
+const tslib_1 = require("tslib");
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
+const utils_1 = require("@docusaurus/utils");
+function getVersionTags(docs) {
+    const groups = (0, utils_1.groupTaggedItems)(docs, (doc) => doc.tags);
+    return lodash_1.default.mapValues(groups, (group) => ({
+        label: group.tag.label,
+        docIds: group.items.map((item) => item.id),
+        permalink: group.tag.permalink,
+    }));
+}
+exports.getVersionTags = getVersionTags;

package/lib/translations.d.ts

@@ -4,7 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { LoadedContent } from './types';
-import { TranslationFile, TranslationFiles } from '@docusaurus/types';
-export declare function getLoadedContentTranslationFiles(loadedContent: LoadedContent): TranslationFiles;
+import type { LoadedContent } from '@docusaurus/plugin-content-docs';
+import type { TranslationFile } from '@docusaurus/types';
+export declare function getLoadedContentTranslationFiles(loadedContent: LoadedContent): TranslationFile[];
 export declare function translateLoadedContent(loadedContent: LoadedContent, translationFiles: TranslationFile[]): LoadedContent;

package/lib/translations.js

@@ -7,19 +7,18 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.translateLoadedContent = exports.getLoadedContentTranslationFiles = void 0;
-const lodash_1 = require("lodash");
-const sidebars_1 = require("./sidebars");
+const tslib_1 = require("tslib");
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const utils_1 = require("@docusaurus/utils");
 const constants_1 = require("./constants");
+const utils_2 = require("./sidebars/utils");
 function getVersionFileName(versionName) {
     if (versionName === constants_1.CURRENT_VERSION_NAME) {
         return versionName;
     }
-    else {
-        // I don't like this "version-" prefix,
-        // but it's for consistency with site/versioned_docs
-        return `version-${versionName}`;
-    }
+    // I don't like this "version-" prefix,
+    // but it's for consistency with site/versioned_docs
+    return `version-${versionName}`;
 }
 // TODO legacy, the sidebar name is like "version-2.0.0-alpha.66/docs"
 // input: "version-2.0.0-alpha.66/docs"
@@ -31,87 +30,104 @@ function getNormalizedSidebarName({ versionName, sidebarName, }) {
     const [, ...rest] = sidebarName.split('/');
     return rest.join('/');
 }
-/*
-// Do we need to translate doc metadatas?
-// It seems translating frontmatter labels is good enough
-function getDocTranslations(doc: DocMetadata): TranslationFileContent {
-  return {
-    [`${doc.unversionedId}.title`]: {
-      message: doc.title,
-      description: `The title for doc with id=${doc.unversionedId}`,
-    },
-    ...(doc.sidebar_label
-      ? {
-          [`${doc.unversionedId}.sidebar_label`]: {
-            message: doc.sidebar_label,
-            description: `The sidebar label for doc with id=${doc.unversionedId}`,
-          },
-        }
-      : undefined),
-  };
-}
-function translateDoc(
-  doc: DocMetadata,
-  docsTranslations: TranslationFileContent,
-): DocMetadata {
-  return {
-    ...doc,
-    title: docsTranslations[`${doc.unversionedId}.title`]?.message ?? doc.title,
-    sidebar_label:
-      docsTranslations[`${doc.unversionedId}.sidebar_label`]?.message ??
-      doc.sidebar_label,
-  };
-}
-
-function getDocsTranslations(version: LoadedVersion): TranslationFileContent {
-  return mergeTranslations(version.docs.map(getDocTranslations));
-}
-function translateDocs(
-  docs: DocMetadata[],
-  docsTranslations: TranslationFileContent,
-): DocMetadata[] {
-  return docs.map((doc) => translateDoc(doc, docsTranslations));
-}
- */
 function getSidebarTranslationFileContent(sidebar, sidebarName) {
-    const categories = sidebars_1.collectSidebarCategories(sidebar);
-    const categoryContent = lodash_1.chain(categories)
-        .keyBy((category) => `sidebar.${sidebarName}.category.${category.label}`)
-        .mapValues((category) => ({
-        message: category.label,
-        description: `The label for category ${category.label} in sidebar ${sidebarName}`,
-    }))
-        .value();
-    const links = sidebars_1.collectSidebarLinks(sidebar);
-    const linksContent = lodash_1.chain(links)
-        .keyBy((link) => `sidebar.${sidebarName}.link.${link.label}`)
-        .mapValues((link) => ({
-        message: link.label,
-        description: `The label for link ${link.label} in sidebar ${sidebarName}, linking to ${link.href}`,
-    }))
-        .value();
-    return utils_1.mergeTranslations([categoryContent, linksContent]);
+    const categories = (0, utils_2.collectSidebarCategories)(sidebar);
+    const categoryContent = Object.fromEntries(categories.flatMap((category) => {
+        const entries = [];
+        entries.push([
+            `sidebar.${sidebarName}.category.${category.label}`,
+            {
+                message: category.label,
+                description: `The label for category ${category.label} in sidebar ${sidebarName}`,
+            },
+        ]);
+        if (category.link?.type === 'generated-index') {
+            if (category.link.title) {
+                entries.push([
+                    `sidebar.${sidebarName}.category.${category.label}.link.generated-index.title`,
+                    {
+                        message: category.link.title,
+                        description: `The generated-index page title for category ${category.label} in sidebar ${sidebarName}`,
+                    },
+                ]);
+            }
+            if (category.link.description) {
+                entries.push([
+                    `sidebar.${sidebarName}.category.${category.label}.link.generated-index.description`,
+                    {
+                        message: category.link.description,
+                        description: `The generated-index page description for category ${category.label} in sidebar ${sidebarName}`,
+                    },
+                ]);
+            }
+        }
+        return entries;
+    }));
+    const links = (0, utils_2.collectSidebarLinks)(sidebar);
+    const linksContent = Object.fromEntries(links.map((link) => [
+        `sidebar.${sidebarName}.link.${link.label}`,
+        {
+            message: link.label,
+            description: `The label for link ${link.label} in sidebar ${sidebarName}, linking to ${link.href}`,
+        },
+    ]));
+    const docs = (0, utils_2.collectSidebarDocItems)(sidebar)
+        .concat((0, utils_2.collectSidebarRefs)(sidebar))
+        .filter((item) => item.translatable);
+    const docLinksContent = Object.fromEntries(docs.map((doc) => [
+        `sidebar.${sidebarName}.doc.${doc.label}`,
+        {
+            message: doc.label,
+            description: `The label for the doc item ${doc.label} in sidebar ${sidebarName}, linking to the doc ${doc.id}`,
+        },
+    ]));
+    return (0, utils_1.mergeTranslations)([categoryContent, linksContent, docLinksContent]);
 }
 function translateSidebar({ sidebar, sidebarName, sidebarsTranslations, }) {
-    return sidebars_1.transformSidebarItems(sidebar, (item) => {
-        var _a, _b, _c, _d;
+    function transformSidebarCategoryLink(category) {
+        if (!category.link) {
+            return undefined;
+        }
+        if (category.link.type === 'generated-index') {
+            const title = sidebarsTranslations[`sidebar.${sidebarName}.category.${category.label}.link.generated-index.title`]?.message ?? category.link.title;
+            const description = sidebarsTranslations[`sidebar.${sidebarName}.category.${category.label}.link.generated-index.description`]?.message ?? category.link.description;
+            return {
+                ...category.link,
+                title,
+                description,
+            };
+        }
+        return category.link;
+    }
+    return (0, utils_2.transformSidebarItems)(sidebar, (item) => {
         if (item.type === 'category') {
+            const link = transformSidebarCategoryLink(item);
             return {
                 ...item,
-                label: (_b = (_a = sidebarsTranslations[`sidebar.${sidebarName}.category.${item.label}`]) === null || _a === void 0 ? void 0 : _a.message) !== null && _b !== void 0 ? _b : item.label,
+                label: sidebarsTranslations[`sidebar.${sidebarName}.category.${item.label}`]
+                    ?.message ?? item.label,
+                ...(link && { link }),
             };
         }
         if (item.type === 'link') {
             return {
                 ...item,
-                label: (_d = (_c = sidebarsTranslations[`sidebar.${sidebarName}.link.${item.label}`]) === null || _c === void 0 ? void 0 : _c.message) !== null && _d !== void 0 ? _d : item.label,
+                label: sidebarsTranslations[`sidebar.${sidebarName}.link.${item.label}`]
+                    ?.message ?? item.label,
+            };
+        }
+        if ((item.type === 'doc' || item.type === 'ref') && item.translatable) {
+            return {
+                ...item,
+                label: sidebarsTranslations[`sidebar.${sidebarName}.doc.${item.label}`]
+                    ?.message ?? item.label,
             };
         }
         return item;
     });
 }
 function getSidebarsTranslations(version) {
-    return utils_1.mergeTranslations(Object.entries(version.sidebars).map(([sidebarName, sidebar]) => {
+    return (0, utils_1.mergeTranslations)(Object.entries(version.sidebars).map(([sidebarName, sidebar]) => {
         const normalizedSidebarName = getNormalizedSidebarName({
             sidebarName,
             versionName: version.versionName,
@@ -120,49 +136,40 @@ function getSidebarsTranslations(version) {
     }));
 }
 function translateSidebars(version, sidebarsTranslations) {
-    return lodash_1.mapValues(version.sidebars, (sidebar, sidebarName) => {
-        return translateSidebar({
-            sidebar,
-            sidebarName: getNormalizedSidebarName({
-                sidebarName,
-                versionName: version.versionName,
-            }),
-            sidebarsTranslations,
-        });
-    });
+    return lodash_1.default.mapValues(version.sidebars, (sidebar, sidebarName) => translateSidebar({
+        sidebar,
+        sidebarName: getNormalizedSidebarName({
+            sidebarName,
+            versionName: version.versionName,
+        }),
+        sidebarsTranslations,
+    }));
 }
 function getVersionTranslationFiles(version) {
     const versionTranslations = {
         'version.label': {
-            message: version.versionLabel,
+            message: version.label,
             description: `The label for version ${version.versionName}`,
         },
     };
     const sidebarsTranslations = getSidebarsTranslations(version);
-    // const docsTranslations: TranslationFileContent = getDocsTranslations(version);
     return [
         {
             path: getVersionFileName(version.versionName),
-            content: utils_1.mergeTranslations([
-                versionTranslations,
-                sidebarsTranslations,
-                // docsTranslations,
-            ]),
+            content: (0, utils_1.mergeTranslations)([versionTranslations, sidebarsTranslations]),
         },
     ];
 }
 function translateVersion(version, translationFiles) {
-    var _a;
     const versionTranslations = translationFiles[getVersionFileName(version.versionName)].content;
     return {
         ...version,
-        versionLabel: (_a = versionTranslations['version.label']) === null || _a === void 0 ? void 0 : _a.message,
+        label: versionTranslations['version.label']?.message ?? version.label,
         sidebars: translateSidebars(version, versionTranslations),
-        // docs: translateDocs(version.docs, versionTranslations),
     };
 }
 function getVersionsTranslationFiles(versions) {
-    return lodash_1.flatten(versions.map(getVersionTranslationFiles));
+    return versions.flatMap(getVersionTranslationFiles);
 }
 function translateVersions(versions, translationFiles) {
     return versions.map((version) => translateVersion(version, translationFiles));
@@ -172,7 +179,7 @@ function getLoadedContentTranslationFiles(loadedContent) {
 }
 exports.getLoadedContentTranslationFiles = getLoadedContentTranslationFiles;
 function translateLoadedContent(loadedContent, translationFiles) {
-    const translationFilesMap = lodash_1.keyBy(translationFiles, (f) => f.path);
+    const translationFilesMap = lodash_1.default.keyBy(translationFiles, (f) => f.path);
     return {
         loadedVersions: translateVersions(loadedContent.loadedVersions, translationFilesMap),
     };

package/lib/types.d.ts

@@ -4,205 +4,33 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { RemarkAndRehypePluginOptions } from '@docusaurus/mdx-loader';
-import { BrokenMarkdownLink as IBrokenMarkdownLink, ContentPaths } from '@docusaurus/utils/lib/markdownLinks';
+import type { BrokenMarkdownLink, Tag } from '@docusaurus/utils';
+import type { VersionMetadata, LoadedVersion, CategoryGeneratedIndexMetadata } from '@docusaurus/plugin-content-docs';
+import type { SidebarsUtils } from './sidebars/utils';
 export declare type DocFile = {
     contentPath: string;
     filePath: string;
     source: string;
     content: string;
-    lastUpdate: LastUpdateData;
-};
-export declare type VersionName = string;
-export declare type VersionMetadata = ContentPaths & {
-    versionName: VersionName;
-    versionLabel: string;
-    versionPath: string;
-    versionEditUrl?: string | undefined;
-    versionEditUrlLocalized?: string | undefined;
-    versionBanner: VersionBanner;
-    isLast: boolean;
-    sidebarFilePath: string | false | undefined;
-    routePriority: number | undefined;
-};
-export declare type EditUrlFunction = (editUrlParams: {
-    version: string;
-    versionDocsDirPath: string;
-    docPath: string;
-    permalink: string;
-    locale: string;
-}) => string | undefined;
-export declare type MetadataOptions = {
-    routeBasePath: string;
-    homePageId?: string;
-    editUrl?: string | EditUrlFunction;
-    editCurrentVersion: boolean;
-    editLocalizedFiles: boolean;
-    showLastUpdateTime?: boolean;
-    showLastUpdateAuthor?: boolean;
-    numberPrefixParser: NumberPrefixParser;
-};
-export declare type PathOptions = {
-    path: string;
-    sidebarPath?: string | false | undefined;
-};
-export declare type VersionBanner = 'none' | 'unreleased' | 'unmaintained';
-export declare type VersionOptions = {
-    path?: string;
-    label?: string;
-    banner?: VersionBanner;
-};
-export declare type VersionsOptions = {
-    lastVersion?: string;
-    versions: Record<string, VersionOptions>;
-    onlyIncludeVersions?: string[];
-};
-export declare type PluginOptions = MetadataOptions & PathOptions & VersionsOptions & RemarkAndRehypePluginOptions & {
-    id: string;
-    include: string[];
-    docLayoutComponent: string;
-    docItemComponent: string;
-    admonitions: Record<string, unknown>;
-    disableVersioning: boolean;
-    includeCurrentVersion: boolean;
-    sidebarItemsGenerator: SidebarItemsGeneratorOption;
-};
-export declare type SidebarItemBase = {
-    customProps?: Record<string, unknown>;
-};
-export declare type SidebarItemDoc = SidebarItemBase & {
-    type: 'doc' | 'ref';
-    label?: string;
-    id: string;
-};
-export declare type SidebarItemLink = SidebarItemBase & {
-    type: 'link';
-    href: string;
-    label: string;
-};
-export declare type SidebarItemCategory = SidebarItemBase & {
-    type: 'category';
-    label: string;
-    items: SidebarItem[];
-    collapsed: boolean;
-};
-export declare type UnprocessedSidebarItemAutogenerated = {
-    type: 'autogenerated';
-    dirName: string;
-};
-export declare type UnprocessedSidebarItemCategory = SidebarItemBase & {
-    type: 'category';
-    label: string;
-    items: UnprocessedSidebarItem[];
-    collapsed: boolean;
-};
-export declare type UnprocessedSidebarItem = SidebarItemDoc | SidebarItemLink | UnprocessedSidebarItemCategory | UnprocessedSidebarItemAutogenerated;
-export declare type UnprocessedSidebar = UnprocessedSidebarItem[];
-export declare type UnprocessedSidebars = Record<string, UnprocessedSidebar>;
-export declare type SidebarItem = SidebarItemDoc | SidebarItemLink | SidebarItemCategory;
-export declare type Sidebar = SidebarItem[];
-export declare type SidebarItemType = SidebarItem['type'];
-export declare type Sidebars = Record<string, Sidebar>;
-export declare type SidebarItemsGeneratorDoc = Pick<DocMetadataBase, 'id' | 'frontMatter' | 'source' | 'sourceDirName' | 'sidebarPosition'>;
-export declare type SidebarItemsGeneratorVersion = Pick<VersionMetadata, 'versionName' | 'contentPath'>;
-export declare type SidebarItemsGeneratorArgs = {
-    item: UnprocessedSidebarItemAutogenerated;
-    version: SidebarItemsGeneratorVersion;
-    docs: SidebarItemsGeneratorDoc[];
-    numberPrefixParser: NumberPrefixParser;
-};
-export declare type SidebarItemsGenerator = (generatorArgs: SidebarItemsGeneratorArgs) => Promise<SidebarItem[]>;
-export declare type SidebarItemsGeneratorOptionArgs = {
-    defaultSidebarItemsGenerator: SidebarItemsGenerator;
-} & SidebarItemsGeneratorArgs;
-export declare type SidebarItemsGeneratorOption = (generatorArgs: SidebarItemsGeneratorOptionArgs) => Promise<SidebarItem[]>;
-export declare type OrderMetadata = {
-    previous?: string;
-    next?: string;
-    sidebar?: string;
-};
-export declare type LastUpdateData = {
-    lastUpdatedAt?: number;
-    formattedLastUpdatedAt?: string;
-    lastUpdatedBy?: string;
-};
-export declare type DocFrontMatter = {
-    id?: string;
-    title?: string;
-    hide_title?: boolean;
-    hide_table_of_contents?: boolean;
-    keywords?: string[];
-    image?: string;
-    description?: string;
-    slug?: string;
-    sidebar_label?: string;
-    sidebar_position?: number;
-    pagination_label?: string;
-    custom_edit_url?: string | null;
-    parse_number_prefixes?: boolean;
-};
-export declare type DocMetadataBase = LastUpdateData & {
-    version: VersionName;
-    unversionedId: string;
-    id: string;
-    isDocsHomePage: boolean;
-    title: string;
-    description: string;
-    source: string;
-    sourceDirName: string;
-    slug: string;
-    permalink: string;
-    sidebarPosition?: number;
-    editUrl?: string | null;
-    frontMatter: DocFrontMatter & Record<string, unknown>;
-};
-export declare type DocNavLink = {
-    title: string;
-    permalink: string;
-};
-export declare type DocMetadata = DocMetadataBase & {
-    sidebar?: string;
-    previous?: DocNavLink;
-    next?: DocNavLink;
 };
 export declare type SourceToPermalink = {
     [source: string]: string;
 };
-export declare type LoadedVersion = VersionMetadata & {
-    versionPath: string;
-    mainDocId: string;
-    docs: DocMetadata[];
-    sidebars: Sidebars;
-    permalinkToSidebar: Record<string, string>;
-};
-export declare type LoadedContent = {
-    loadedVersions: LoadedVersion[];
+export declare type VersionTag = Tag & {
+    /** All doc ids having this tag. */
+    docIds: string[];
 };
-export declare type GlobalDoc = {
-    id: string;
-    path: string;
-    sidebar: string | undefined;
+export declare type VersionTags = {
+    [permalink: string]: VersionTag;
 };
-export declare type GlobalVersion = {
-    name: VersionName;
-    label: string;
-    isLast: boolean;
-    path: string;
-    mainDocId: string;
-    docs: GlobalDoc[];
+export declare type FullVersion = LoadedVersion & {
+    sidebarsUtils: SidebarsUtils;
+    categoryGeneratedIndices: CategoryGeneratedIndexMetadata[];
 };
-export declare type GlobalPluginData = {
-    path: string;
-    versions: GlobalVersion[];
-};
-export declare type BrokenMarkdownLink = IBrokenMarkdownLink<VersionMetadata>;
+export declare type DocBrokenMarkdownLink = BrokenMarkdownLink<VersionMetadata>;
 export declare type DocsMarkdownOption = {
     versionsMetadata: VersionMetadata[];
     siteDir: string;
     sourceToPermalink: SourceToPermalink;
-    onBrokenMarkdownLink: (brokenMarkdownLink: BrokenMarkdownLink) => void;
-};
-export declare type NumberPrefixParser = (filename: string) => {
-    filename: string;
-    numberPrefix?: number;
+    onBrokenMarkdownLink: (brokenMarkdownLink: DocBrokenMarkdownLink) => void;
 };

package/lib/versions/files.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import type { PluginOptions, VersionMetadata } from '@docusaurus/plugin-content-docs';
+import type { VersionContext } from './index';
+/** `[siteDir]/community_versioned_docs/version-1.0.0` */
+export declare function getVersionDocsDirPath(siteDir: string, pluginId: string, versionName: string): string;
+/** `[siteDir]/community_versioned_sidebars/version-1.0.0-sidebars.json` */
+export declare function getVersionSidebarsPath(siteDir: string, pluginId: string, versionName: string): string;
+export declare function getDocsDirPathLocalized({ localizationDir, pluginId, versionName, }: {
+    localizationDir: string;
+    pluginId: string;
+    versionName: string;
+}): string;
+/** `community` => `[siteDir]/community_versions.json` */
+export declare function getVersionsFilePath(siteDir: string, pluginId: string): string;
+/**
+ * Reads the plugin's respective `versions.json` file, and returns its content.
+ *
+ * @throws Throws if validation fails, i.e. `versions.json` doesn't contain an
+ * array of valid version names.
+ */
+export declare function readVersionsFile(siteDir: string, pluginId: string): Promise<string[] | null>;
+/**
+ * Reads the `versions.json` file, and returns an ordered list of version names.
+ *
+ * - If `disableVersioning` is turned on, it will return `["current"]` (requires
+ * `includeCurrentVersion` to be true);
+ * - If `includeCurrentVersion` is turned on, "current" will be inserted at the
+ * beginning, if not already there.
+ *
+ * You need to use {@link filterVersions} after this.
+ *
+ * @throws Throws an error if `disableVersioning: true` but `versions.json`
+ * doesn't exist (i.e. site is not versioned)
+ * @throws Throws an error if versions list is empty (empty `versions.json` or
+ * `disableVersioning` is true, and not including current version)
+ */
+export declare function readVersionNames(siteDir: string, options: PluginOptions): Promise<string[]>;
+/**
+ * Gets the path-related version metadata.
+ *
+ * @throws Throws if the resolved docs folder or sidebars file doesn't exist.
+ * Does not throw if a versioned sidebar is missing (since we don't create empty
+ * files).
+ */
+export declare function getVersionMetadataPaths({ versionName, context, options, }: VersionContext): Promise<Pick<VersionMetadata, 'contentPath' | 'contentPathLocalized' | 'sidebarFilePath'>>;