@docusaurus/plugin-content-docs 2.0.0-beta.fbdeefcac → 2.0.0-rc.1

package/lib/sidebarItemsGenerator.js

@@ -1,211 +0,0 @@
-"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.DefaultSidebarItemsGenerator = exports.CategoryMetadataFilenamePattern = exports.CategoryMetadataFilenameBase = void 0;
-const tslib_1 = require("tslib");
-const lodash_1 = require("lodash");
-const utils_1 = require("@docusaurus/utils");
-const utils_validation_1 = require("@docusaurus/utils-validation");
-const chalk_1 = tslib_1.__importDefault(require("chalk"));
-const path_1 = tslib_1.__importDefault(require("path"));
-const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
-const js_yaml_1 = tslib_1.__importDefault(require("js-yaml"));
-const sidebars_1 = require("./sidebars");
-const BreadcrumbSeparator = '/';
-exports.CategoryMetadataFilenameBase = '_category_';
-exports.CategoryMetadataFilenamePattern = '_category_.{json,yml,yaml}';
-const CategoryMetadatasFileSchema = utils_validation_1.Joi.object({
-    label: utils_validation_1.Joi.string(),
-    position: utils_validation_1.Joi.number(),
-    collapsed: utils_validation_1.Joi.boolean(),
-});
-// TODO I now believe we should read all the category metadata files ahead of time: we may need this metadata to customize docs metadata
-// Example use-case being able to disable number prefix parsing at the folder level, or customize the default route path segment for an intermediate directory...
-// TODO later if there is `CategoryFolder/index.md`, we may want to read the metadata as yaml on it
-// see https://github.com/facebook/docusaurus/issues/3464#issuecomment-818670449
-async function readCategoryMetadatasFile(categoryDirPath) {
-    var _a, _b;
-    function validateCategoryMetadataFile(content) {
-        return utils_validation_1.Joi.attempt(content, CategoryMetadatasFileSchema);
-    }
-    async function tryReadFile(fileNameWithExtension, parse) {
-        // Simpler to use only posix paths for mocking file metadatas in tests
-        const filePath = utils_1.posixPath(path_1.default.join(categoryDirPath, fileNameWithExtension));
-        if (await fs_extra_1.default.pathExists(filePath)) {
-            const contentString = await fs_extra_1.default.readFile(filePath, { encoding: 'utf8' });
-            const unsafeContent = parse(contentString);
-            try {
-                return validateCategoryMetadataFile(unsafeContent);
-            }
-            catch (e) {
-                console.error(chalk_1.default.red(`The docs sidebar category metadata file looks invalid!\nPath: ${filePath}`));
-                throw e;
-            }
-        }
-        return null;
-    }
-    return ((_b = (_a = (await tryReadFile(`${exports.CategoryMetadataFilenameBase}.json`, JSON.parse))) !== null && _a !== void 0 ? _a : (await tryReadFile(`${exports.CategoryMetadataFilenameBase}.yml`, js_yaml_1.default.load))) !== null && _b !== void 0 ? _b : 
-    // eslint-disable-next-line no-return-await
-    (await tryReadFile(`${exports.CategoryMetadataFilenameBase}.yaml`, js_yaml_1.default.load)));
-}
-// [...parents, tail]
-function parseBreadcrumb(breadcrumb) {
-    return {
-        parents: lodash_1.take(breadcrumb, breadcrumb.length - 1),
-        tail: lodash_1.last(breadcrumb),
-    };
-}
-// Comment for this feature: https://github.com/facebook/docusaurus/issues/3464#issuecomment-818670449
-const DefaultSidebarItemsGenerator = async function defaultSidebarItemsGenerator({ item, docs: allDocs, version, numberPrefixParser, }) {
-    // Doc at the root of the autogenerated sidebar dir
-    function isRootDoc(doc) {
-        return doc.sourceDirName === item.dirName;
-    }
-    // Doc inside a subfolder of the autogenerated sidebar dir
-    function isCategoryDoc(doc) {
-        if (isRootDoc(doc)) {
-            return false;
-        }
-        return (
-        // autogen dir is . and doc is in subfolder
-        item.dirName === '.' ||
-            // autogen dir is not . and doc is in subfolder
-            // "api/myDoc" startsWith "api/" (note "api2/myDoc" is not included)
-            doc.sourceDirName.startsWith(utils_1.addTrailingSlash(item.dirName)));
-    }
-    function isInAutogeneratedDir(doc) {
-        return isRootDoc(doc) || isCategoryDoc(doc);
-    }
-    // autogenDir=a/b and docDir=a/b/c/d => returns c/d
-    // autogenDir=a/b and docDir=a/b => returns .
-    function getDocDirRelativeToAutogenDir(doc) {
-        if (!isInAutogeneratedDir(doc)) {
-            throw new Error('getDocDirRelativeToAutogenDir() can only be called for subdocs of the sidebar autogen dir.');
-        }
-        // Is there a node API to compare 2 relative paths more easily?
-        // path.relative() does not give good results
-        if (item.dirName === '.') {
-            return doc.sourceDirName;
-        }
-        else if (item.dirName === doc.sourceDirName) {
-            return '.';
-        }
-        else {
-            return doc.sourceDirName.replace(utils_1.addTrailingSlash(item.dirName), '');
-        }
-    }
-    // Get only docs in the autogen dir
-    // Sort by folder+filename at once
-    const docs = lodash_1.sortBy(allDocs.filter(isInAutogeneratedDir), (d) => d.source);
-    if (docs.length === 0) {
-        console.warn(chalk_1.default.yellow(`No docs found in dir ${item.dirName}: can't auto-generate a sidebar.`));
-    }
-    function createDocSidebarItem(doc) {
-        return {
-            type: 'doc',
-            id: doc.id,
-            ...(doc.frontMatter.sidebar_label && {
-                label: doc.frontMatter.sidebar_label,
-            }),
-            ...(typeof doc.sidebarPosition !== 'undefined' && {
-                position: doc.sidebarPosition,
-            }),
-        };
-    }
-    async function createCategorySidebarItem({ breadcrumb, }) {
-        var _a, _b, _c;
-        const categoryDirPath = path_1.default.join(version.contentPath, item.dirName, // fix https://github.com/facebook/docusaurus/issues/4638
-        breadcrumb.join(BreadcrumbSeparator));
-        const categoryMetadatas = await readCategoryMetadatasFile(categoryDirPath);
-        const { tail } = parseBreadcrumb(breadcrumb);
-        const { filename, numberPrefix } = numberPrefixParser(tail);
-        const position = (_a = categoryMetadatas === null || categoryMetadatas === void 0 ? void 0 : categoryMetadatas.position) !== null && _a !== void 0 ? _a : numberPrefix;
-        return {
-            type: 'category',
-            label: (_b = categoryMetadatas === null || categoryMetadatas === void 0 ? void 0 : categoryMetadatas.label) !== null && _b !== void 0 ? _b : filename,
-            items: [],
-            collapsed: (_c = categoryMetadatas === null || categoryMetadatas === void 0 ? void 0 : categoryMetadatas.collapsed) !== null && _c !== void 0 ? _c : sidebars_1.DefaultCategoryCollapsedValue,
-            ...(typeof position !== 'undefined' && { position }),
-        };
-    }
-    // Not sure how to simplify this algorithm :/
-    async function autogenerateSidebarItems() {
-        const sidebarItems = []; // mutable result
-        const categoriesByBreadcrumb = {}; // mutable cache of categories already created
-        async function getOrCreateCategoriesForBreadcrumb(breadcrumb) {
-            if (breadcrumb.length === 0) {
-                return null;
-            }
-            const { parents } = parseBreadcrumb(breadcrumb);
-            const parentCategory = await getOrCreateCategoriesForBreadcrumb(parents);
-            const existingCategory = categoriesByBreadcrumb[breadcrumb.join(BreadcrumbSeparator)];
-            if (existingCategory) {
-                return existingCategory;
-            }
-            else {
-                const newCategory = await createCategorySidebarItem({
-                    breadcrumb,
-                });
-                if (parentCategory) {
-                    parentCategory.items.push(newCategory);
-                }
-                else {
-                    sidebarItems.push(newCategory);
-                }
-                categoriesByBreadcrumb[breadcrumb.join(BreadcrumbSeparator)] = newCategory;
-                return newCategory;
-            }
-        }
-        // Get the category breadcrumb of a doc (relative to the dir of the autogenerated sidebar item)
-        function getRelativeBreadcrumb(doc) {
-            const relativeDirPath = getDocDirRelativeToAutogenDir(doc);
-            if (relativeDirPath === '.') {
-                return [];
-            }
-            else {
-                return relativeDirPath.split(BreadcrumbSeparator);
-            }
-        }
-        async function handleDocItem(doc) {
-            const breadcrumb = getRelativeBreadcrumb(doc);
-            const category = await getOrCreateCategoriesForBreadcrumb(breadcrumb);
-            const docSidebarItem = createDocSidebarItem(doc);
-            if (category) {
-                category.items.push(docSidebarItem);
-            }
-            else {
-                sidebarItems.push(docSidebarItem);
-            }
-        }
-        // async process made sequential on purpose! order matters
-        for (const doc of docs) {
-            // eslint-disable-next-line no-await-in-loop
-            await handleDocItem(doc);
-        }
-        return sidebarItems;
-    }
-    const sidebarItems = await autogenerateSidebarItems();
-    return sortSidebarItems(sidebarItems);
-};
-exports.DefaultSidebarItemsGenerator = DefaultSidebarItemsGenerator;
-// Recursively sort the categories/docs + remove the "position" attribute from final output
-// Note: the "position" is only used to sort "inside" a sidebar slice
-// It is not used to sort across multiple consecutive sidebar slices (ie a whole Category composed of multiple autogenerated items)
-function sortSidebarItems(sidebarItems) {
-    const processedSidebarItems = sidebarItems.map((item) => {
-        if (item.type === 'category') {
-            return {
-                ...item,
-                items: sortSidebarItems(item.items),
-            };
-        }
-        return item;
-    });
-    const sortedSidebarItems = lodash_1.orderBy(processedSidebarItems, (item) => item.position, ['asc']);
-    return sortedSidebarItems.map(({ position: _removed, ...item }) => item);
-}

package/lib/sidebars.d.ts

@@ -1,43 +0,0 @@
-/**
- * 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 { Sidebars, SidebarItem, SidebarItemLink, SidebarItemDoc, Sidebar, SidebarItemCategory, UnprocessedSidebars, UnprocessedSidebar, DocMetadataBase, VersionMetadata, SidebarItemsGeneratorDoc, SidebarItemsGeneratorVersion, NumberPrefixParser, SidebarItemsGeneratorOption, PluginOptions } from './types';
-export declare const DefaultCategoryCollapsedValue = true;
-export declare const DefaultSidebars: UnprocessedSidebars;
-export declare const DisabledSidebars: UnprocessedSidebars;
-export declare function resolveSidebarPathOption(siteDir: string, sidebarPathOption: PluginOptions['sidebarPath']): PluginOptions['sidebarPath'];
-export declare function loadSidebars(sidebarFilePath: string | false | undefined): UnprocessedSidebars;
-export declare function toSidebarItemsGeneratorDoc(doc: DocMetadataBase): SidebarItemsGeneratorDoc;
-export declare function toSidebarItemsGeneratorVersion(version: VersionMetadata): SidebarItemsGeneratorVersion;
-export declare function processSidebar({ sidebarItemsGenerator, numberPrefixParser, unprocessedSidebar, docs, version, }: {
-    sidebarItemsGenerator: SidebarItemsGeneratorOption;
-    numberPrefixParser: NumberPrefixParser;
-    unprocessedSidebar: UnprocessedSidebar;
-    docs: DocMetadataBase[];
-    version: VersionMetadata;
-}): Promise<Sidebar>;
-export declare function processSidebars({ sidebarItemsGenerator, numberPrefixParser, unprocessedSidebars, docs, version, }: {
-    sidebarItemsGenerator: SidebarItemsGeneratorOption;
-    numberPrefixParser: NumberPrefixParser;
-    unprocessedSidebars: UnprocessedSidebars;
-    docs: DocMetadataBase[];
-    version: VersionMetadata;
-}): Promise<Sidebars>;
-export declare function collectSidebarDocItems(sidebar: Sidebar): SidebarItemDoc[];
-export declare function collectSidebarCategories(sidebar: Sidebar): SidebarItemCategory[];
-export declare function collectSidebarLinks(sidebar: Sidebar): SidebarItemLink[];
-export declare function transformSidebarItems(sidebar: Sidebar, updateFn: (item: SidebarItem) => SidebarItem): Sidebar;
-export declare function collectSidebarsDocIds(sidebars: Sidebars): Record<string, string[]>;
-export declare function createSidebarsUtils(sidebars: Sidebars): {
-    getFirstDocIdOfFirstSidebar: () => string | undefined;
-    getSidebarNameByDocId: (docId: string) => string | undefined;
-    getDocNavigation: (docId: string) => {
-        sidebarName: string | undefined;
-        previousId: string | undefined;
-        nextId: string | undefined;
-    };
-    checkSidebarsDocIds: (validDocIds: string[], sidebarFilePath: string) => void;
-};

package/lib/sidebars.js

@@ -1,320 +0,0 @@
-"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.createSidebarsUtils = exports.collectSidebarsDocIds = exports.transformSidebarItems = exports.collectSidebarLinks = exports.collectSidebarCategories = exports.collectSidebarDocItems = exports.processSidebars = exports.processSidebar = exports.toSidebarItemsGeneratorVersion = exports.toSidebarItemsGeneratorDoc = exports.loadSidebars = exports.resolveSidebarPathOption = exports.DisabledSidebars = exports.DefaultSidebars = exports.DefaultCategoryCollapsedValue = void 0;
-const tslib_1 = require("tslib");
-const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
-const import_fresh_1 = tslib_1.__importDefault(require("import-fresh"));
-const lodash_1 = require("lodash");
-const utils_1 = require("@docusaurus/utils");
-const combine_promises_1 = tslib_1.__importDefault(require("combine-promises"));
-const sidebarItemsGenerator_1 = require("./sidebarItemsGenerator");
-const path_1 = tslib_1.__importDefault(require("path"));
-function isCategoryShorthand(item) {
-    return typeof item !== 'string' && !item.type;
-}
-// categories are collapsed by default, unless user set collapsed = false
-exports.DefaultCategoryCollapsedValue = true;
-/**
- * Convert {category1: [item1,item2]} shorthand syntax to long-form syntax
- */
-function normalizeCategoryShorthand(sidebar) {
-    return Object.entries(sidebar).map(([label, items]) => ({
-        type: 'category',
-        collapsed: exports.DefaultCategoryCollapsedValue,
-        label,
-        items,
-    }));
-}
-/**
- * Check that item contains only allowed keys.
- */
-function assertItem(item, keys) {
-    const unknownKeys = Object.keys(item).filter(
-    // @ts-expect-error: key is always string
-    (key) => !keys.includes(key) && key !== 'type');
-    if (unknownKeys.length) {
-        throw new Error(`Unknown sidebar item keys: ${unknownKeys}. Item: ${JSON.stringify(item)}`);
-    }
-}
-function assertIsCategory(item) {
-    assertItem(item, ['items', 'label', 'collapsed', 'customProps']);
-    if (typeof item.label !== 'string') {
-        throw new Error(`Error loading ${JSON.stringify(item)}: "label" must be a string.`);
-    }
-    if (!Array.isArray(item.items)) {
-        throw new Error(`Error loading ${JSON.stringify(item)}: "items" must be an array.`);
-    }
-    // "collapsed" is an optional property
-    if (typeof item.collapsed !== 'undefined' &&
-        typeof item.collapsed !== 'boolean') {
-        throw new Error(`Error loading ${JSON.stringify(item)}: "collapsed" must be a boolean.`);
-    }
-}
-function assertIsAutogenerated(item) {
-    assertItem(item, ['dirName', 'customProps']);
-    if (typeof item.dirName !== 'string') {
-        throw new Error(`Error loading ${JSON.stringify(item)}: "dirName" must be a string.`);
-    }
-    if (item.dirName.startsWith('/') || item.dirName.endsWith('/')) {
-        throw new Error(`Error loading ${JSON.stringify(item)}: "dirName" must be a dir path relative to the docs folder root, and should not start or end with slash`);
-    }
-}
-function assertIsDoc(item) {
-    assertItem(item, ['id', 'label', 'customProps']);
-    if (typeof item.id !== 'string') {
-        throw new Error(`Error loading ${JSON.stringify(item)}: "id" must be a string.`);
-    }
-    if (item.label && typeof item.label !== 'string') {
-        throw new Error(`Error loading ${JSON.stringify(item)}: "label" must be a string.`);
-    }
-}
-function assertIsLink(item) {
-    assertItem(item, ['href', 'label', 'customProps']);
-    if (typeof item.href !== 'string') {
-        throw new Error(`Error loading ${JSON.stringify(item)}: "href" must be a string.`);
-    }
-    if (typeof item.label !== 'string') {
-        throw new Error(`Error loading ${JSON.stringify(item)}: "label" must be a string.`);
-    }
-}
-/**
- * Normalizes recursively item and all its children. Ensures that at the end
- * each item will be an object with the corresponding type.
- */
-function normalizeItem(item) {
-    if (typeof item === 'string') {
-        return [
-            {
-                type: 'doc',
-                id: item,
-            },
-        ];
-    }
-    if (isCategoryShorthand(item)) {
-        return lodash_1.flatMap(normalizeCategoryShorthand(item), normalizeItem);
-    }
-    switch (item.type) {
-        case 'category':
-            assertIsCategory(item);
-            return [
-                {
-                    collapsed: exports.DefaultCategoryCollapsedValue,
-                    ...item,
-                    items: lodash_1.flatMap(item.items, normalizeItem),
-                },
-            ];
-        case 'autogenerated':
-            assertIsAutogenerated(item);
-            return [item];
-        case 'link':
-            assertIsLink(item);
-            return [item];
-        case 'ref':
-        case 'doc':
-            assertIsDoc(item);
-            return [item];
-        default: {
-            const extraMigrationError = item.type === 'subcategory'
-                ? 'Docusaurus v2: "subcategory" has been renamed as "category".'
-                : '';
-            throw new Error(`Unknown sidebar item type "${item.type}". Sidebar item is ${JSON.stringify(item)}.\n${extraMigrationError}`);
-        }
-    }
-}
-function normalizeSidebar(sidebar) {
-    const normalizedSidebar = Array.isArray(sidebar)
-        ? sidebar
-        : normalizeCategoryShorthand(sidebar);
-    return lodash_1.flatMap(normalizedSidebar, normalizeItem);
-}
-function normalizeSidebars(sidebars) {
-    return lodash_1.mapValues(sidebars, normalizeSidebar);
-}
-exports.DefaultSidebars = {
-    defaultSidebar: [
-        {
-            type: 'autogenerated',
-            dirName: '.',
-        },
-    ],
-};
-exports.DisabledSidebars = {};
-// If a path is provided, make it absolute
-// use this before loadSidebars()
-function resolveSidebarPathOption(siteDir, sidebarPathOption) {
-    return sidebarPathOption
-        ? path_1.default.resolve(siteDir, sidebarPathOption)
-        : sidebarPathOption;
-}
-exports.resolveSidebarPathOption = resolveSidebarPathOption;
-// TODO refactor: make async
-// Note: sidebarFilePath must be absolute, use resolveSidebarPathOption
-function loadSidebars(sidebarFilePath) {
-    // false => no sidebars
-    if (sidebarFilePath === false) {
-        return exports.DisabledSidebars;
-    }
-    // undefined => defaults to autogenerated sidebars
-    if (typeof sidebarFilePath === 'undefined') {
-        return exports.DefaultSidebars;
-    }
-    // unexisting sidebars file: no sidebars
-    // Note: this edge case can happen on versioned docs, not current version
-    // We avoid creating empty versioned sidebars file with the CLI
-    if (!fs_extra_1.default.existsSync(sidebarFilePath)) {
-        return exports.DisabledSidebars;
-    }
-    // We don't want sidebars to be cached because of hot reloading.
-    const sidebarJson = import_fresh_1.default(sidebarFilePath);
-    return normalizeSidebars(sidebarJson);
-}
-exports.loadSidebars = loadSidebars;
-function toSidebarItemsGeneratorDoc(doc) {
-    return lodash_1.pick(doc, [
-        'id',
-        'frontMatter',
-        'source',
-        'sourceDirName',
-        'sidebarPosition',
-    ]);
-}
-exports.toSidebarItemsGeneratorDoc = toSidebarItemsGeneratorDoc;
-function toSidebarItemsGeneratorVersion(version) {
-    return lodash_1.pick(version, ['versionName', 'contentPath']);
-}
-exports.toSidebarItemsGeneratorVersion = toSidebarItemsGeneratorVersion;
-// Handle the generation of autogenerated sidebar items
-async function processSidebar({ sidebarItemsGenerator, numberPrefixParser, unprocessedSidebar, docs, version, }) {
-    // Just a minor lazy transformation optimization
-    const getSidebarItemsGeneratorDocsAndVersion = lodash_1.memoize(() => ({
-        docs: docs.map(toSidebarItemsGeneratorDoc),
-        version: toSidebarItemsGeneratorVersion(version),
-    }));
-    async function processRecursive(item) {
-        if (item.type === 'category') {
-            return [
-                {
-                    ...item,
-                    items: (await Promise.all(item.items.map(processRecursive))).flat(),
-                },
-            ];
-        }
-        if (item.type === 'autogenerated') {
-            return sidebarItemsGenerator({
-                item,
-                numberPrefixParser,
-                defaultSidebarItemsGenerator: sidebarItemsGenerator_1.DefaultSidebarItemsGenerator,
-                ...getSidebarItemsGeneratorDocsAndVersion(),
-            });
-        }
-        return [item];
-    }
-    return (await Promise.all(unprocessedSidebar.map(processRecursive))).flat();
-}
-exports.processSidebar = processSidebar;
-async function processSidebars({ sidebarItemsGenerator, numberPrefixParser, unprocessedSidebars, docs, version, }) {
-    return combine_promises_1.default(lodash_1.mapValues(unprocessedSidebars, (unprocessedSidebar) => processSidebar({
-        sidebarItemsGenerator,
-        numberPrefixParser,
-        unprocessedSidebar,
-        docs,
-        version,
-    })));
-}
-exports.processSidebars = processSidebars;
-function collectSidebarItemsOfType(type, sidebar) {
-    function collectRecursive(item) {
-        const currentItemsCollected = item.type === type ? [item] : [];
-        const childItemsCollected = item.type === 'category' ? lodash_1.flatten(item.items.map(collectRecursive)) : [];
-        return [...currentItemsCollected, ...childItemsCollected];
-    }
-    return lodash_1.flatten(sidebar.map(collectRecursive));
-}
-function collectSidebarDocItems(sidebar) {
-    return collectSidebarItemsOfType('doc', sidebar);
-}
-exports.collectSidebarDocItems = collectSidebarDocItems;
-function collectSidebarCategories(sidebar) {
-    return collectSidebarItemsOfType('category', sidebar);
-}
-exports.collectSidebarCategories = collectSidebarCategories;
-function collectSidebarLinks(sidebar) {
-    return collectSidebarItemsOfType('link', sidebar);
-}
-exports.collectSidebarLinks = collectSidebarLinks;
-function transformSidebarItems(sidebar, updateFn) {
-    function transformRecursive(item) {
-        if (item.type === 'category') {
-            return updateFn({
-                ...item,
-                items: item.items.map(transformRecursive),
-            });
-        }
-        return updateFn(item);
-    }
-    return sidebar.map(transformRecursive);
-}
-exports.transformSidebarItems = transformSidebarItems;
-function collectSidebarsDocIds(sidebars) {
-    return lodash_1.mapValues(sidebars, (sidebar) => {
-        return collectSidebarDocItems(sidebar).map((docItem) => docItem.id);
-    });
-}
-exports.collectSidebarsDocIds = collectSidebarsDocIds;
-function createSidebarsUtils(sidebars) {
-    const sidebarNameToDocIds = collectSidebarsDocIds(sidebars);
-    function getFirstDocIdOfFirstSidebar() {
-        var _a;
-        return (_a = Object.values(sidebarNameToDocIds)[0]) === null || _a === void 0 ? void 0 : _a[0];
-    }
-    function getSidebarNameByDocId(docId) {
-        // TODO lookup speed can be optimized
-        const entry = Object.entries(sidebarNameToDocIds).find(([_sidebarName, docIds]) => docIds.includes(docId));
-        return entry === null || entry === void 0 ? void 0 : entry[0];
-    }
-    function getDocNavigation(docId) {
-        const sidebarName = getSidebarNameByDocId(docId);
-        if (sidebarName) {
-            const docIds = sidebarNameToDocIds[sidebarName];
-            const currentIndex = docIds.indexOf(docId);
-            const { previous, next } = utils_1.getElementsAround(docIds, currentIndex);
-            return {
-                sidebarName,
-                previousId: previous,
-                nextId: next,
-            };
-        }
-        else {
-            return {
-                sidebarName: undefined,
-                previousId: undefined,
-                nextId: undefined,
-            };
-        }
-    }
-    function checkSidebarsDocIds(validDocIds, sidebarFilePath) {
-        const allSidebarDocIds = lodash_1.flatten(Object.values(sidebarNameToDocIds));
-        const invalidSidebarDocIds = lodash_1.difference(allSidebarDocIds, validDocIds);
-        if (invalidSidebarDocIds.length > 0) {
-            throw new Error(`Invalid sidebar file at "${utils_1.toMessageRelativeFilePath(sidebarFilePath)}".
-These sidebar document ids do not exist:
-- ${invalidSidebarDocIds.sort().join('\n- ')}
-
-Available document ids are:
-- ${validDocIds.sort().join('\n- ')}`);
-        }
-    }
-    return {
-        getFirstDocIdOfFirstSidebar,
-        getSidebarNameByDocId,
-        getDocNavigation,
-        checkSidebarsDocIds,
-    };
-}
-exports.createSidebarsUtils = createSidebarsUtils;

package/lib/theme/hooks/useDocs.d.ts

@@ -1,20 +0,0 @@
-/**
- * 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 { GlobalPluginData, GlobalVersion } from '../../types';
-import { ActivePlugin, ActiveDocContext, DocVersionSuggestions, GetActivePluginOptions } from '../../client/docsClientUtils';
-export declare const useAllDocsData: () => Record<string, GlobalPluginData>;
-export declare const useDocsData: (pluginId: string | undefined) => GlobalPluginData;
-export declare const useActivePlugin: (options?: GetActivePluginOptions) => ActivePlugin | undefined;
-export declare const useActivePluginAndVersion: (options?: GetActivePluginOptions) => {
-    activePlugin: ActivePlugin;
-    activeVersion: GlobalVersion | undefined;
-} | undefined;
-export declare const useVersions: (pluginId: string | undefined) => GlobalVersion[];
-export declare const useLatestVersion: (pluginId: string | undefined) => GlobalVersion;
-export declare const useActiveVersion: (pluginId: string | undefined) => GlobalVersion | undefined;
-export declare const useActiveDocContext: (pluginId: string | undefined) => ActiveDocContext;
-export declare const useDocVersionSuggestions: (pluginId: string | undefined) => DocVersionSuggestions;

package/lib/theme/hooks/useDocs.js

@@ -1,75 +0,0 @@
-"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.useDocVersionSuggestions = exports.useActiveDocContext = exports.useActiveVersion = exports.useLatestVersion = exports.useVersions = exports.useActivePluginAndVersion = exports.useActivePlugin = exports.useDocsData = exports.useAllDocsData = void 0;
-const tslib_1 = require("tslib");
-const router_1 = require("@docusaurus/router");
-const useGlobalData_1 = tslib_1.__importStar(require("@docusaurus/useGlobalData"));
-const docsClientUtils_1 = require("../../client/docsClientUtils");
-// Important to use a constant object to avoid React useEffect executions etc...,
-// see https://github.com/facebook/docusaurus/issues/5089
-const StableEmptyObject = {};
-// Not using useAllPluginInstancesData() because in blog-only mode, docs hooks are still used by the theme
-// We need a fail-safe fallback when the docs plugin is not in use
-const useAllDocsData = () => { var _a; 
-// useAllPluginInstancesData('docusaurus-plugin-content-docs');
-return (_a = useGlobalData_1.default()['docusaurus-plugin-content-docs']) !== null && _a !== void 0 ? _a : StableEmptyObject; };
-exports.useAllDocsData = useAllDocsData;
-const useDocsData = (pluginId) => useGlobalData_1.usePluginData('docusaurus-plugin-content-docs', pluginId);
-exports.useDocsData = useDocsData;
-const useActivePlugin = (options = {}) => {
-    const data = exports.useAllDocsData();
-    const { pathname } = router_1.useLocation();
-    return docsClientUtils_1.getActivePlugin(data, pathname, options);
-};
-exports.useActivePlugin = useActivePlugin;
-const useActivePluginAndVersion = (options = {}) => {
-    const activePlugin = exports.useActivePlugin(options);
-    const { pathname } = router_1.useLocation();
-    if (activePlugin) {
-        const activeVersion = docsClientUtils_1.getActiveVersion(activePlugin.pluginData, pathname);
-        return {
-            activePlugin,
-            activeVersion,
-        };
-    }
-    return undefined;
-};
-exports.useActivePluginAndVersion = useActivePluginAndVersion;
-// versions are returned ordered (most recent first)
-const useVersions = (pluginId) => {
-    const data = exports.useDocsData(pluginId);
-    return data.versions;
-};
-exports.useVersions = useVersions;
-const useLatestVersion = (pluginId) => {
-    const data = exports.useDocsData(pluginId);
-    return docsClientUtils_1.getLatestVersion(data);
-};
-exports.useLatestVersion = useLatestVersion;
-// Note: return undefined on doc-unrelated pages,
-// because there's no version currently considered as active
-const useActiveVersion = (pluginId) => {
-    const data = exports.useDocsData(pluginId);
-    const { pathname } = router_1.useLocation();
-    return docsClientUtils_1.getActiveVersion(data, pathname);
-};
-exports.useActiveVersion = useActiveVersion;
-const useActiveDocContext = (pluginId) => {
-    const data = exports.useDocsData(pluginId);
-    const { pathname } = router_1.useLocation();
-    return docsClientUtils_1.getActiveDocContext(data, pathname);
-};
-exports.useActiveDocContext = useActiveDocContext;
-// Useful to say "hey, you are not on the latest docs version, please switch"
-const useDocVersionSuggestions = (pluginId) => {
-    const data = exports.useDocsData(pluginId);
-    const { pathname } = router_1.useLocation();
-    return docsClientUtils_1.getDocVersionSuggestions(data, pathname);
-};
-exports.useDocVersionSuggestions = useDocVersionSuggestions;