@docusaurus/theme-common 0.0.0-6001 → 0.0.0-6004

package/lib/contexts/docsPreferredVersion.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"docsPreferredVersion.d.ts","sourceRoot":"","sources":["../../src/contexts/docsPreferredVersion.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAc,EAMZ,KAAK,SAAS,EACf,MAAM,OAAO,CAAC;AACf,OAAO,EAIL,KAAK,aAAa,EACnB,MAAM,wCAAwC,CAAC;AAsJhD;;;GAGG;AACH,wBAAgB,mCAAmC,CAAC,EAClD,QAAQ,GACT,EAAE;IACD,QAAQ,EAAE,SAAS,CAAC;CACrB,GAAG,GAAG,CAAC,OAAO,CASd;AAUD;;;;;;GAMG;AACH,wBAAgB,uBAAuB,CACrC,QAAQ,GAAE,MAAM,GAAG,SAA6B,GAC/C;IACD,gBAAgB,EAAE,aAAa,GAAG,IAAI,CAAC;IACvC,wBAAwB,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,IAAI,CAAC;CACzD,CAmBA;AAED,wBAAgB,iCAAiC,IAAI;IACnD,CAAC,QAAQ,EAAE,MAAM,GAAG,aAAa,GAAG,IAAI,CAAC;CAC1C,CAkBA"}

package/lib/contexts/docsPreferredVersion.js

@@ -1,130 +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 React, { useContext, useEffect, useMemo, useState, useCallback, } from 'react';
-import { useAllDocsData, useDocsData, } from '@docusaurus/plugin-content-docs/client';
-import { DEFAULT_PLUGIN_ID } from '@docusaurus/constants';
-import { useThemeConfig, } from '../utils/useThemeConfig';
-import { isDocsPluginEnabled } from '../utils/docsUtils';
-import { ReactContextError } from '../utils/reactUtils';
-import { createStorageSlot } from '../utils/storageUtils';
-const storageKey = (pluginId) => `docs-preferred-version-${pluginId}`;
-const DocsPreferredVersionStorage = {
-    save: (pluginId, persistence, versionName) => {
-        createStorageSlot(storageKey(pluginId), { persistence }).set(versionName);
-    },
-    read: (pluginId, persistence) => createStorageSlot(storageKey(pluginId), { persistence }).get(),
-    clear: (pluginId, persistence) => {
-        createStorageSlot(storageKey(pluginId), { persistence }).del();
-    },
-};
-/**
- * Initial state is always null as we can't read local storage from node SSR
- */
-const getInitialState = (pluginIds) => Object.fromEntries(pluginIds.map((id) => [id, { preferredVersionName: null }]));
-/**
- * Read storage for all docs plugins, assigning each doc plugin a preferred
- * version (if found)
- */
-function readStorageState({ pluginIds, versionPersistence, allDocsData, }) {
-    /**
-     * The storage value we read might be stale, and belong to a version that does
-     * not exist in the site anymore. In such case, we remove the storage value to
-     * avoid downstream errors.
-     */
-    function restorePluginState(pluginId) {
-        const preferredVersionNameUnsafe = DocsPreferredVersionStorage.read(pluginId, versionPersistence);
-        const pluginData = allDocsData[pluginId];
-        const versionExists = pluginData.versions.some((version) => version.name === preferredVersionNameUnsafe);
-        if (versionExists) {
-            return { preferredVersionName: preferredVersionNameUnsafe };
-        }
-        DocsPreferredVersionStorage.clear(pluginId, versionPersistence);
-        return { preferredVersionName: null };
-    }
-    return Object.fromEntries(pluginIds.map((id) => [id, restorePluginState(id)]));
-}
-function useVersionPersistence() {
-    return useThemeConfig().docs.versionPersistence;
-}
-const Context = React.createContext(null);
-function useContextValue() {
-    const allDocsData = useAllDocsData();
-    const versionPersistence = useVersionPersistence();
-    const pluginIds = useMemo(() => Object.keys(allDocsData), [allDocsData]);
-    // Initial state is empty, as we can't read browser storage in node/SSR
-    const [state, setState] = useState(() => getInitialState(pluginIds));
-    // On mount, we set the state read from browser storage
-    useEffect(() => {
-        setState(readStorageState({ allDocsData, versionPersistence, pluginIds }));
-    }, [allDocsData, versionPersistence, pluginIds]);
-    // The API that we expose to consumer hooks (memo for constant object)
-    const api = useMemo(() => {
-        function savePreferredVersion(pluginId, versionName) {
-            DocsPreferredVersionStorage.save(pluginId, versionPersistence, versionName);
-            setState((s) => ({
-                ...s,
-                [pluginId]: { preferredVersionName: versionName },
-            }));
-        }
-        return {
-            savePreferredVersion,
-        };
-    }, [versionPersistence]);
-    return [state, api];
-}
-function DocsPreferredVersionContextProviderUnsafe({ children, }) {
-    const value = useContextValue();
-    return <Context.Provider value={value}>{children}</Context.Provider>;
-}
-/**
- * This is a maybe-layer. If the docs plugin is not enabled, this provider is a
- * simple pass-through.
- */
-export function DocsPreferredVersionContextProvider({ children, }) {
-    if (isDocsPluginEnabled) {
-        return (<DocsPreferredVersionContextProviderUnsafe>
-        {children}
-      </DocsPreferredVersionContextProviderUnsafe>);
-    }
-    return <>{children}</>;
-}
-function useDocsPreferredVersionContext() {
-    const value = useContext(Context);
-    if (!value) {
-        throw new ReactContextError('DocsPreferredVersionContextProvider');
-    }
-    return value;
-}
-/**
- * Returns a read-write interface to a plugin's preferred version. The
- * "preferred version" is defined as the last version that the user visited.
- * For example, if a user is using v3, even when v4 is later published, the user
- * would still be browsing v3 docs when she opens the website next time. Note,
- * the `preferredVersion` attribute will always be `null` before mount.
- */
-export function useDocsPreferredVersion(pluginId = DEFAULT_PLUGIN_ID) {
-    const docsData = useDocsData(pluginId);
-    const [state, api] = useDocsPreferredVersionContext();
-    const { preferredVersionName } = state[pluginId];
-    const preferredVersion = docsData.versions.find((version) => version.name === preferredVersionName) ?? null;
-    const savePreferredVersionName = useCallback((versionName) => {
-        api.savePreferredVersion(pluginId, versionName);
-    }, [api, pluginId]);
-    return { preferredVersion, savePreferredVersionName };
-}
-export function useDocsPreferredVersionByPluginId() {
-    const allDocsData = useAllDocsData();
-    const [state] = useDocsPreferredVersionContext();
-    function getPluginIdPreferredVersion(pluginId) {
-        const docsData = allDocsData[pluginId];
-        const { preferredVersionName } = state[pluginId];
-        return (docsData.versions.find((version) => version.name === preferredVersionName) ?? null);
-    }
-    const pluginIds = Object.keys(allDocsData);
-    return Object.fromEntries(pluginIds.map((id) => [id, getPluginIdPreferredVersion(id)]));
-}
-//# sourceMappingURL=docsPreferredVersion.js.map

package/lib/contexts/docsPreferredVersion.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"docsPreferredVersion.js","sourceRoot":"","sources":["../../src/contexts/docsPreferredVersion.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,EACZ,UAAU,EACV,SAAS,EACT,OAAO,EACP,QAAQ,EACR,WAAW,GAEZ,MAAM,OAAO,CAAC;AACf,OAAO,EACL,cAAc,EACd,WAAW,GAGZ,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAC,iBAAiB,EAAC,MAAM,uBAAuB,CAAC;AACxD,OAAO,EACL,cAAc,GAEf,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAC,mBAAmB,EAAC,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAC,iBAAiB,EAAC,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAC,iBAAiB,EAAC,MAAM,uBAAuB,CAAC;AAExD,MAAM,UAAU,GAAG,CAAC,QAAgB,EAAE,EAAE,CAAC,0BAA0B,QAAQ,EAAE,CAAC;AAE9E,MAAM,2BAA2B,GAAG;IAClC,IAAI,EAAE,CACJ,QAAgB,EAChB,WAAmC,EACnC,WAAmB,EACb,EAAE;QACR,iBAAiB,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,EAAC,WAAW,EAAC,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAC1E,CAAC;IAED,IAAI,EAAE,CACJ,QAAgB,EAChB,WAAmC,EACpB,EAAE,CACjB,iBAAiB,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,EAAC,WAAW,EAAC,CAAC,CAAC,GAAG,EAAE;IAE9D,KAAK,EAAE,CAAC,QAAgB,EAAE,WAAmC,EAAQ,EAAE;QACrE,iBAAiB,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,EAAC,WAAW,EAAC,CAAC,CAAC,GAAG,EAAE,CAAC;IAC/D,CAAC;CACF,CAAC;AAiBF;;GAEG;AACH,MAAM,eAAe,GAAG,CAAC,SAAmB,EAA6B,EAAE,CACzE,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAC,oBAAoB,EAAE,IAAI,EAAC,CAAC,CAAC,CAAC,CAAC;AAEhF;;;GAGG;AACH,SAAS,gBAAgB,CAAC,EACxB,SAAS,EACT,kBAAkB,EAClB,WAAW,GAKZ;IACC;;;;OAIG;IACH,SAAS,kBAAkB,CACzB,QAAgB;QAEhB,MAAM,0BAA0B,GAAG,2BAA2B,CAAC,IAAI,CACjE,QAAQ,EACR,kBAAkB,CACnB,CAAC;QACF,MAAM,UAAU,GAAG,WAAW,CAAC,QAAQ,CAAE,CAAC;QAC1C,MAAM,aAAa,GAAG,UAAU,CAAC,QAAQ,CAAC,IAAI,CAC5C,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,0BAA0B,CACzD,CAAC;QACF,IAAI,aAAa,EAAE,CAAC;YAClB,OAAO,EAAC,oBAAoB,EAAE,0BAA0B,EAAC,CAAC;QAC5D,CAAC;QACD,2BAA2B,CAAC,KAAK,CAAC,QAAQ,EAAE,kBAAkB,CAAC,CAAC;QAChE,OAAO,EAAC,oBAAoB,EAAE,IAAI,EAAC,CAAC;IACtC,CAAC;IACD,OAAO,MAAM,CAAC,WAAW,CACvB,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,kBAAkB,CAAC,EAAE,CAAC,CAAC,CAAC,CACpD,CAAC;AACJ,CAAC;AAED,SAAS,qBAAqB;IAC5B,OAAO,cAAc,EAAE,CAAC,IAAI,CAAC,kBAAkB,CAAC;AAClD,CAAC;AASD,MAAM,OAAO,GAAG,KAAK,CAAC,aAAa,CAAsB,IAAI,CAAC,CAAC;AAE/D,SAAS,eAAe;IACtB,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IACrC,MAAM,kBAAkB,GAAG,qBAAqB,EAAE,CAAC;IACnD,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;IAEzE,uEAAuE;IACvE,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,CAAC,GAAG,EAAE,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC;IAErE,uDAAuD;IACvD,SAAS,CAAC,GAAG,EAAE;QACb,QAAQ,CAAC,gBAAgB,CAAC,EAAC,WAAW,EAAE,kBAAkB,EAAE,SAAS,EAAC,CAAC,CAAC,CAAC;IAC3E,CAAC,EAAE,CAAC,WAAW,EAAE,kBAAkB,EAAE,SAAS,CAAC,CAAC,CAAC;IAEjD,sEAAsE;IACtE,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE;QACvB,SAAS,oBAAoB,CAAC,QAAgB,EAAE,WAAmB;YACjE,2BAA2B,CAAC,IAAI,CAC9B,QAAQ,EACR,kBAAkB,EAClB,WAAW,CACZ,CAAC;YACF,QAAQ,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;gBACf,GAAG,CAAC;gBACJ,CAAC,QAAQ,CAAC,EAAE,EAAC,oBAAoB,EAAE,WAAW,EAAC;aAChD,CAAC,CAAC,CAAC;QACN,CAAC;QAED,OAAO;YACL,oBAAoB;SACrB,CAAC;IACJ,CAAC,EAAE,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAEzB,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;AACtB,CAAC;AAED,SAAS,yCAAyC,CAAC,EACjD,QAAQ,GAGT;IACC,MAAM,KAAK,GAAG,eAAe,EAAE,CAAC;IAChC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;AACvE,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,mCAAmC,CAAC,EAClD,QAAQ,GAGT;IACC,IAAI,mBAAmB,EAAE,CAAC;QACxB,OAAO,CACL,CAAC,yCAAyC,CACxC;QAAA,CAAC,QAAQ,CACX;MAAA,EAAE,yCAAyC,CAAC,CAC7C,CAAC;IACJ,CAAC;IACD,OAAO,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC;AACzB,CAAC;AAED,SAAS,8BAA8B;IACrC,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IAClC,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,IAAI,iBAAiB,CAAC,qCAAqC,CAAC,CAAC;IACrE,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,uBAAuB,CACrC,WAA+B,iBAAiB;IAKhD,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC;IACvC,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,GAAG,8BAA8B,EAAE,CAAC;IAEtD,MAAM,EAAC,oBAAoB,EAAC,GAAG,KAAK,CAAC,QAAQ,CAAE,CAAC;IAEhD,MAAM,gBAAgB,GACpB,QAAQ,CAAC,QAAQ,CAAC,IAAI,CACpB,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,oBAAoB,CACnD,IAAI,IAAI,CAAC;IAEZ,MAAM,wBAAwB,GAAG,WAAW,CAC1C,CAAC,WAAmB,EAAE,EAAE;QACtB,GAAG,CAAC,oBAAoB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IAClD,CAAC,EACD,CAAC,GAAG,EAAE,QAAQ,CAAC,CAChB,CAAC;IAEF,OAAO,EAAC,gBAAgB,EAAE,wBAAwB,EAAC,CAAC;AACtD,CAAC;AAED,MAAM,UAAU,iCAAiC;IAG/C,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IACrC,MAAM,CAAC,KAAK,CAAC,GAAG,8BAA8B,EAAE,CAAC;IAEjD,SAAS,2BAA2B,CAAC,QAAgB;QACnD,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAE,CAAC;QACxC,MAAM,EAAC,oBAAoB,EAAC,GAAG,KAAK,CAAC,QAAQ,CAAE,CAAC;QAEhD,OAAO,CACL,QAAQ,CAAC,QAAQ,CAAC,IAAI,CACpB,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,oBAAoB,CACnD,IAAI,IAAI,CACV,CAAC;IACJ,CAAC;IACD,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAC3C,OAAO,MAAM,CAAC,WAAW,CACvB,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,2BAA2B,CAAC,EAAE,CAAC,CAAC,CAAC,CAC7D,CAAC;AACJ,CAAC"}

package/lib/contexts/docsSidebar.d.ts

@@ -1,26 +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 { type ReactNode } from 'react';
-import type { PropSidebar } from '@docusaurus/plugin-content-docs';
-type ContextValue = {
-    name: string;
-    items: PropSidebar;
-};
-/**
- * Provide the current sidebar to your children.
- */
-export declare function DocsSidebarProvider({ children, name, items, }: {
-    children: ReactNode;
-    name: string | undefined;
-    items: PropSidebar | undefined;
-}): JSX.Element;
-/**
- * Gets the sidebar that's currently displayed, or `null` if there isn't one
- */
-export declare function useDocsSidebar(): ContextValue | null;
-export {};
-//# sourceMappingURL=docsSidebar.d.ts.map

package/lib/contexts/docsSidebar.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"docsSidebar.d.ts","sourceRoot":"","sources":["../../src/contexts/docsSidebar.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAc,EAAsB,KAAK,SAAS,EAAC,MAAM,OAAO,CAAC;AAEjE,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,iCAAiC,CAAC;AAMjE,KAAK,YAAY,GAAG;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,WAAW,CAAA;CAAC,CAAC;AAMvD;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,EAClC,QAAQ,EACR,IAAI,EACJ,KAAK,GACN,EAAE;IACD,QAAQ,EAAE,SAAS,CAAC;IACpB,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,KAAK,EAAE,WAAW,GAAG,SAAS,CAAC;CAChC,GAAG,GAAG,CAAC,OAAO,CAMd;AAED;;GAEG;AACH,wBAAgB,cAAc,IAAI,YAAY,GAAG,IAAI,CAMpD"}

package/lib/contexts/docsSidebar.js

@@ -1,30 +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 React, { useMemo, useContext } from 'react';
-import { ReactContextError } from '../utils/reactUtils';
-// Using a Symbol because null is a valid context value (a doc with no sidebar)
-// Inspired by https://github.com/jamiebuilds/unstated-next/blob/master/src/unstated-next.tsx
-const EmptyContext = Symbol('EmptyContext');
-const Context = React.createContext(EmptyContext);
-/**
- * Provide the current sidebar to your children.
- */
-export function DocsSidebarProvider({ children, name, items, }) {
-    const stableValue = useMemo(() => (name && items ? { name, items } : null), [name, items]);
-    return <Context.Provider value={stableValue}>{children}</Context.Provider>;
-}
-/**
- * Gets the sidebar that's currently displayed, or `null` if there isn't one
- */
-export function useDocsSidebar() {
-    const value = useContext(Context);
-    if (value === EmptyContext) {
-        throw new ReactContextError('DocsSidebarProvider');
-    }
-    return value;
-}
-//# sourceMappingURL=docsSidebar.js.map

package/lib/contexts/docsSidebar.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"docsSidebar.js","sourceRoot":"","sources":["../../src/contexts/docsSidebar.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,EAAC,OAAO,EAAE,UAAU,EAAiB,MAAM,OAAO,CAAC;AACjE,OAAO,EAAC,iBAAiB,EAAC,MAAM,qBAAqB,CAAC;AAGtD,+EAA+E;AAC/E,6FAA6F;AAC7F,MAAM,YAAY,GAAkB,MAAM,CAAC,cAAc,CAAC,CAAC;AAI3D,MAAM,OAAO,GAAG,KAAK,CAAC,aAAa,CACjC,YAAY,CACb,CAAC;AAEF;;GAEG;AACH,MAAM,UAAU,mBAAmB,CAAC,EAClC,QAAQ,EACR,IAAI,EACJ,KAAK,GAKN;IACC,MAAM,WAAW,GAAwB,OAAO,CAC9C,GAAG,EAAE,CAAC,CAAC,IAAI,IAAI,KAAK,CAAC,CAAC,CAAC,EAAC,IAAI,EAAE,KAAK,EAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAC5C,CAAC,IAAI,EAAE,KAAK,CAAC,CACd,CAAC;IACF,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;AAC7E,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,cAAc;IAC5B,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IAClC,IAAI,KAAK,KAAK,YAAY,EAAE,CAAC;QAC3B,MAAM,IAAI,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;IACrD,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC"}

package/lib/contexts/docsVersion.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 { type ReactNode } from 'react';
-import type { PropVersionMetadata } from '@docusaurus/plugin-content-docs';
-/**
- * Provide the current version's metadata to your children.
- */
-export declare function DocsVersionProvider({ children, version, }: {
-    children: ReactNode;
-    version: PropVersionMetadata | null;
-}): JSX.Element;
-/**
- * Gets the version metadata of the current doc page.
- */
-export declare function useDocsVersion(): PropVersionMetadata;
-//# sourceMappingURL=docsVersion.d.ts.map

package/lib/contexts/docsVersion.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"docsVersion.d.ts","sourceRoot":"","sources":["../../src/contexts/docsVersion.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAc,EAAC,KAAK,SAAS,EAAa,MAAM,OAAO,CAAC;AAExD,OAAO,KAAK,EAAC,mBAAmB,EAAC,MAAM,iCAAiC,CAAC;AAIzE;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,EAClC,QAAQ,EACR,OAAO,GACR,EAAE;IACD,QAAQ,EAAE,SAAS,CAAC;IACpB,OAAO,EAAE,mBAAmB,GAAG,IAAI,CAAC;CACrC,GAAG,GAAG,CAAC,OAAO,CAEd;AAED;;GAEG;AACH,wBAAgB,cAAc,IAAI,mBAAmB,CAMpD"}

package/lib/contexts/docsVersion.js

@@ -1,26 +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 React, { useContext } from 'react';
-import { ReactContextError } from '../utils/reactUtils';
-const Context = React.createContext(null);
-/**
- * Provide the current version's metadata to your children.
- */
-export function DocsVersionProvider({ children, version, }) {
-    return <Context.Provider value={version}>{children}</Context.Provider>;
-}
-/**
- * Gets the version metadata of the current doc page.
- */
-export function useDocsVersion() {
-    const version = useContext(Context);
-    if (version === null) {
-        throw new ReactContextError('DocsVersionProvider');
-    }
-    return version;
-}
-//# sourceMappingURL=docsVersion.js.map

package/lib/contexts/docsVersion.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"docsVersion.js","sourceRoot":"","sources":["../../src/contexts/docsVersion.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,EAAiB,UAAU,EAAC,MAAM,OAAO,CAAC;AACxD,OAAO,EAAC,iBAAiB,EAAC,MAAM,qBAAqB,CAAC;AAGtD,MAAM,OAAO,GAAG,KAAK,CAAC,aAAa,CAA6B,IAAI,CAAC,CAAC;AAEtE;;GAEG;AACH,MAAM,UAAU,mBAAmB,CAAC,EAClC,QAAQ,EACR,OAAO,GAIR;IACC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;AACzE,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,cAAc;IAC5B,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IACpC,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;QACrB,MAAM,IAAI,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;IACrD,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/lib/utils/docsUtils.d.ts

@@ -1,108 +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 { type GlobalVersion, type GlobalSidebar, type GlobalDoc } from '@docusaurus/plugin-content-docs/client';
-import type { Props as DocRootProps } from '@theme/DocRoot';
-import type { PropSidebar, PropSidebarItem, PropSidebarItemCategory, PropVersionDoc, PropSidebarBreadcrumbsItem } from '@docusaurus/plugin-content-docs';
-export declare const isDocsPluginEnabled: boolean;
-/**
- * A null-safe way to access a doc's data by ID in the active version.
- */
-export declare function useDocById(id: string): PropVersionDoc;
-/**
- * A null-safe way to access a doc's data by ID in the active version.
- */
-export declare function useDocById(id: string | undefined): PropVersionDoc | undefined;
-/**
- * Pure function, similar to `Array#find`, but works on the sidebar tree.
- */
-export declare function findSidebarCategory(sidebar: PropSidebar, predicate: (category: PropSidebarItemCategory) => boolean): PropSidebarItemCategory | undefined;
-/**
- * Best effort to assign a link to a sidebar category. If the category doesn't
- * have a link itself, we link to the first sub item with a link.
- */
-export declare function findFirstSidebarItemCategoryLink(item: PropSidebarItemCategory): string | undefined;
-/**
- * Best effort to assign a link to a sidebar item.
- */
-export declare function findFirstSidebarItemLink(item: PropSidebarItem): string | undefined;
-/**
- * Gets the category associated with the current location. Should only be used
- * on category index pages.
- */
-export declare function useCurrentSidebarCategory(): PropSidebarItemCategory;
-/**
- * Checks if a sidebar item should be active, based on the active path.
- */
-export declare function isActiveSidebarItem(item: PropSidebarItem, activePath: string): boolean;
-export declare function isVisibleSidebarItem(item: PropSidebarItem, activePath: string): boolean;
-export declare function useVisibleSidebarItems(items: readonly PropSidebarItem[], activePath: string): PropSidebarItem[];
-/**
- * Gets the breadcrumbs of the current doc page, based on its sidebar location.
- * Returns `null` if there's no sidebar or breadcrumbs are disabled.
- */
-export declare function useSidebarBreadcrumbs(): PropSidebarBreadcrumbsItem[] | null;
-/**
- * "Version candidates" are mostly useful for the layout components, which must
- * be able to work on all pages. For example, if a user has `{ type: "doc",
- * docId: "intro" }` as a navbar item, which version does that refer to? We
- * believe that it could refer to at most three version candidates:
- *
- * 1. The **active version**, the one that the user is currently browsing. See
- * {@link useActiveDocContext}.
- * 2. The **preferred version**, the one that the user last visited. See
- * {@link useDocsPreferredVersion}.
- * 3. The **latest version**, the "default". See {@link useLatestVersion}.
- *
- * @param docsPluginId The plugin ID to get versions from.
- * @returns An array of 1~3 versions with priorities defined above, guaranteed
- * to be unique and non-sparse. Will be memoized, hence stable for deps array.
- */
-export declare function useDocsVersionCandidates(docsPluginId?: string): [GlobalVersion, ...GlobalVersion[]];
-/**
- * The layout components, like navbar items, must be able to work on all pages,
- * even on non-doc ones where there's no version context, so a sidebar ID could
- * be ambiguous. This hook would always return a sidebar to be linked to. See
- * also {@link useDocsVersionCandidates} for how this selection is done.
- *
- * @throws This hook throws if a sidebar with said ID is not found.
- */
-export declare function useLayoutDocsSidebar(sidebarId: string, docsPluginId?: string): GlobalSidebar;
-/**
- * The layout components, like navbar items, must be able to work on all pages,
- * even on non-doc ones where there's no version context, so a doc ID could be
- * ambiguous. This hook would always return a doc to be linked to. See also
- * {@link useDocsVersionCandidates} for how this selection is done.
- *
- * @throws This hook throws if a doc with said ID is not found.
- */
-export declare function useLayoutDoc(docId: string, docsPluginId?: string): GlobalDoc | null;
-/**
- * The docs plugin creates nested routes, with the top-level route providing the
- * version metadata, and the subroutes creating individual doc pages. This hook
- * will match the current location against all known sub-routes.
- *
- * @param props The props received by `@theme/DocRoot`
- * @returns The data of the relevant document at the current location, or `null`
- * if no document associated with the current location can be found.
- */
-export declare function useDocRootMetadata({ route }: DocRootProps): null | {
-    /** The element that should be rendered at the current location. */
-    docElement: JSX.Element;
-    /**
-     * The name of the sidebar associated with the current doc. `sidebarName` and
-     * `sidebarItems` correspond to the value of {@link useDocsSidebar}.
-     */
-    sidebarName: string | undefined;
-    /** The items of the sidebar associated with the current doc. */
-    sidebarItems: PropSidebar | undefined;
-};
-/**
- * Filter items we don't want to display on the doc card list view
- * @param items
- */
-export declare function filterDocCardListItems(items: PropSidebarItem[]): PropSidebarItem[];
-//# sourceMappingURL=docsUtils.d.ts.map

package/lib/utils/docsUtils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"docsUtils.d.ts","sourceRoot":"","sources":["../../src/utils/docsUtils.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAKH,OAAO,EAKL,KAAK,aAAa,EAClB,KAAK,aAAa,EAClB,KAAK,SAAS,EACf,MAAM,wCAAwC,CAAC;AAChD,OAAO,KAAK,EAAC,KAAK,IAAI,YAAY,EAAC,MAAM,gBAAgB,CAAC;AAM1D,OAAO,KAAK,EACV,WAAW,EACX,eAAe,EACf,uBAAuB,EACvB,cAAc,EACd,0BAA0B,EAC3B,MAAM,iCAAiC,CAAC;AAGzC,eAAO,MAAM,mBAAmB,EAAE,OAA0B,CAAC;AAE7D;;GAEG;AACH,wBAAgB,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,cAAc,CAAC;AACvD;;GAEG;AACH,wBAAgB,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,GAAG,cAAc,GAAG,SAAS,CAAC;AAa/E;;GAEG;AACH,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,WAAW,EACpB,SAAS,EAAE,CAAC,QAAQ,EAAE,uBAAuB,KAAK,OAAO,GACxD,uBAAuB,GAAG,SAAS,CAarC;AAED;;;GAGG;AACH,wBAAgB,gCAAgC,CAC9C,IAAI,EAAE,uBAAuB,GAC5B,MAAM,GAAG,SAAS,CAYpB;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CACtC,IAAI,EAAE,eAAe,GACpB,MAAM,GAAG,SAAS,CASpB;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,IAAI,uBAAuB,CAkBnE;AASD;;GAEG;AACH,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,eAAe,EACrB,UAAU,EAAE,MAAM,GACjB,OAAO,CAaT;AAED,wBAAgB,oBAAoB,CAClC,IAAI,EAAE,eAAe,EACrB,UAAU,EAAE,MAAM,GACjB,OAAO,CAaT;AAED,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,SAAS,eAAe,EAAE,EACjC,UAAU,EAAE,MAAM,GACjB,eAAe,EAAE,CAKnB;AAmDD;;;GAGG;AACH,wBAAgB,qBAAqB,IAAI,0BAA0B,EAAE,GAAG,IAAI,CAQ3E;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,wBAAwB,CACtC,YAAY,CAAC,EAAE,MAAM,GACpB,CAAC,aAAa,EAAE,GAAG,aAAa,EAAE,CAAC,CAWrC;AAED;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAClC,SAAS,EAAE,MAAM,EACjB,YAAY,CAAC,EAAE,MAAM,GACpB,aAAa,CAoBf;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAC1B,KAAK,EAAE,MAAM,EACb,YAAY,CAAC,EAAE,MAAM,GACpB,SAAS,GAAG,IAAI,CAuBlB;AAGD;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAAC,EAAC,KAAK,EAAC,EAAE,YAAY,GAAG,IAAI,GAAG;IAChE,mEAAmE;IACnE,UAAU,EAAE,GAAG,CAAC,OAAO,CAAC;IACxB;;;OAGG;IACH,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,gEAAgE;IAChE,YAAY,EAAE,WAAW,GAAG,SAAS,CAAC;CACvC,CAyBA;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,eAAe,EAAE,GACvB,eAAe,EAAE,CAQnB"}

package/lib/utils/docsUtils.js

@@ -1,276 +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 { useMemo } from 'react';
-import { matchPath, useLocation } from '@docusaurus/router';
-import renderRoutes from '@docusaurus/renderRoutes';
-import { useAllDocsData, useActivePlugin, useActiveDocContext, useLatestVersion, } from '@docusaurus/plugin-content-docs/client';
-import { useDocsPreferredVersion } from '../contexts/docsPreferredVersion';
-import { useDocsVersion } from '../contexts/docsVersion';
-import { useDocsSidebar } from '../contexts/docsSidebar';
-import { uniq } from './jsUtils';
-import { isSamePath } from './routesUtils';
-// TODO not ideal, see also "useDocs"
-export const isDocsPluginEnabled = !!useAllDocsData;
-export function useDocById(id) {
-    const version = useDocsVersion();
-    if (!id) {
-        return undefined;
-    }
-    const doc = version.docs[id];
-    if (!doc) {
-        throw new Error(`no version doc found by id=${id}`);
-    }
-    return doc;
-}
-/**
- * Pure function, similar to `Array#find`, but works on the sidebar tree.
- */
-export function findSidebarCategory(sidebar, predicate) {
-    for (const item of sidebar) {
-        if (item.type === 'category') {
-            if (predicate(item)) {
-                return item;
-            }
-            const subItem = findSidebarCategory(item.items, predicate);
-            if (subItem) {
-                return subItem;
-            }
-        }
-    }
-    return undefined;
-}
-/**
- * Best effort to assign a link to a sidebar category. If the category doesn't
- * have a link itself, we link to the first sub item with a link.
- */
-export function findFirstSidebarItemCategoryLink(item) {
-    if (item.href && !item.linkUnlisted) {
-        return item.href;
-    }
-    for (const subItem of item.items) {
-        const link = findFirstSidebarItemLink(subItem);
-        if (link) {
-            return link;
-        }
-    }
-    return undefined;
-}
-/**
- * Best effort to assign a link to a sidebar item.
- */
-export function findFirstSidebarItemLink(item) {
-    if (item.type === 'link' && !item.unlisted) {
-        return item.href;
-    }
-    if (item.type === 'category') {
-        return findFirstSidebarItemCategoryLink(item);
-    }
-    // Other items types, like "html"
-    return undefined;
-}
-/**
- * Gets the category associated with the current location. Should only be used
- * on category index pages.
- */
-export function useCurrentSidebarCategory() {
-    const { pathname } = useLocation();
-    const sidebar = useDocsSidebar();
-    if (!sidebar) {
-        throw new Error('Unexpected: cant find current sidebar in context');
-    }
-    const categoryBreadcrumbs = getSidebarBreadcrumbs({
-        sidebarItems: sidebar.items,
-        pathname,
-        onlyCategories: true,
-    });
-    const deepestCategory = categoryBreadcrumbs.slice(-1)[0];
-    if (!deepestCategory) {
-        throw new Error(`${pathname} is not associated with a category. useCurrentSidebarCategory() should only be used on category index pages.`);
-    }
-    return deepestCategory;
-}
-const isActive = (testedPath, activePath) => typeof testedPath !== 'undefined' && isSamePath(testedPath, activePath);
-const containsActiveSidebarItem = (items, activePath) => items.some((subItem) => isActiveSidebarItem(subItem, activePath));
-/**
- * Checks if a sidebar item should be active, based on the active path.
- */
-export function isActiveSidebarItem(item, activePath) {
-    if (item.type === 'link') {
-        return isActive(item.href, activePath);
-    }
-    if (item.type === 'category') {
-        return (isActive(item.href, activePath) ||
-            containsActiveSidebarItem(item.items, activePath));
-    }
-    return false;
-}
-export function isVisibleSidebarItem(item, activePath) {
-    switch (item.type) {
-        case 'category':
-            return (isActiveSidebarItem(item, activePath) ||
-                item.items.some((subItem) => isVisibleSidebarItem(subItem, activePath)));
-        case 'link':
-            // An unlisted item remains visible if it is active
-            return !item.unlisted || isActiveSidebarItem(item, activePath);
-        default:
-            return true;
-    }
-}
-export function useVisibleSidebarItems(items, activePath) {
-    return useMemo(() => items.filter((item) => isVisibleSidebarItem(item, activePath)), [items, activePath]);
-}
-/**
- * Get the sidebar the breadcrumbs for a given pathname
- * Ordered from top to bottom
- */
-function getSidebarBreadcrumbs({ sidebarItems, pathname, onlyCategories = false, }) {
-    const breadcrumbs = [];
-    function extract(items) {
-        for (const item of items) {
-            if ((item.type === 'category' &&
-                (isSamePath(item.href, pathname) || extract(item.items))) ||
-                (item.type === 'link' && isSamePath(item.href, pathname))) {
-                const filtered = onlyCategories && item.type !== 'category';
-                if (!filtered) {
-                    breadcrumbs.unshift(item);
-                }
-                return true;
-            }
-        }
-        return false;
-    }
-    extract(sidebarItems);
-    return breadcrumbs;
-}
-/**
- * Gets the breadcrumbs of the current doc page, based on its sidebar location.
- * Returns `null` if there's no sidebar or breadcrumbs are disabled.
- */
-export function useSidebarBreadcrumbs() {
-    const sidebar = useDocsSidebar();
-    const { pathname } = useLocation();
-    const breadcrumbsOption = useActivePlugin()?.pluginData.breadcrumbs;
-    if (breadcrumbsOption === false || !sidebar) {
-        return null;
-    }
-    return getSidebarBreadcrumbs({ sidebarItems: sidebar.items, pathname });
-}
-/**
- * "Version candidates" are mostly useful for the layout components, which must
- * be able to work on all pages. For example, if a user has `{ type: "doc",
- * docId: "intro" }` as a navbar item, which version does that refer to? We
- * believe that it could refer to at most three version candidates:
- *
- * 1. The **active version**, the one that the user is currently browsing. See
- * {@link useActiveDocContext}.
- * 2. The **preferred version**, the one that the user last visited. See
- * {@link useDocsPreferredVersion}.
- * 3. The **latest version**, the "default". See {@link useLatestVersion}.
- *
- * @param docsPluginId The plugin ID to get versions from.
- * @returns An array of 1~3 versions with priorities defined above, guaranteed
- * to be unique and non-sparse. Will be memoized, hence stable for deps array.
- */
-export function useDocsVersionCandidates(docsPluginId) {
-    const { activeVersion } = useActiveDocContext(docsPluginId);
-    const { preferredVersion } = useDocsPreferredVersion(docsPluginId);
-    const latestVersion = useLatestVersion(docsPluginId);
-    return useMemo(() => uniq([activeVersion, preferredVersion, latestVersion].filter(Boolean)), [activeVersion, preferredVersion, latestVersion]);
-}
-/**
- * The layout components, like navbar items, must be able to work on all pages,
- * even on non-doc ones where there's no version context, so a sidebar ID could
- * be ambiguous. This hook would always return a sidebar to be linked to. See
- * also {@link useDocsVersionCandidates} for how this selection is done.
- *
- * @throws This hook throws if a sidebar with said ID is not found.
- */
-export function useLayoutDocsSidebar(sidebarId, docsPluginId) {
-    const versions = useDocsVersionCandidates(docsPluginId);
-    return useMemo(() => {
-        const allSidebars = versions.flatMap((version) => version.sidebars ? Object.entries(version.sidebars) : []);
-        const sidebarEntry = allSidebars.find((sidebar) => sidebar[0] === sidebarId);
-        if (!sidebarEntry) {
-            throw new Error(`Can't find any sidebar with id "${sidebarId}" in version${versions.length > 1 ? 's' : ''} ${versions.map((version) => version.name).join(', ')}".
-Available sidebar ids are:
-- ${allSidebars.map((entry) => entry[0]).join('\n- ')}`);
-        }
-        return sidebarEntry[1];
-    }, [sidebarId, versions]);
-}
-/**
- * The layout components, like navbar items, must be able to work on all pages,
- * even on non-doc ones where there's no version context, so a doc ID could be
- * ambiguous. This hook would always return a doc to be linked to. See also
- * {@link useDocsVersionCandidates} for how this selection is done.
- *
- * @throws This hook throws if a doc with said ID is not found.
- */
-export function useLayoutDoc(docId, docsPluginId) {
-    const versions = useDocsVersionCandidates(docsPluginId);
-    return useMemo(() => {
-        const allDocs = versions.flatMap((version) => version.docs);
-        const doc = allDocs.find((versionDoc) => versionDoc.id === docId);
-        if (!doc) {
-            const isDraft = versions
-                .flatMap((version) => version.draftIds)
-                .includes(docId);
-            // Drafts should be silently filtered instead of throwing
-            if (isDraft) {
-                return null;
-            }
-            throw new Error(`Couldn't find any doc with id "${docId}" in version${versions.length > 1 ? 's' : ''} "${versions.map((version) => version.name).join(', ')}".
-Available doc ids are:
-- ${uniq(allDocs.map((versionDoc) => versionDoc.id)).join('\n- ')}`);
-        }
-        return doc;
-    }, [docId, versions]);
-}
-// TODO later read version/route directly from context
-/**
- * The docs plugin creates nested routes, with the top-level route providing the
- * version metadata, and the subroutes creating individual doc pages. This hook
- * will match the current location against all known sub-routes.
- *
- * @param props The props received by `@theme/DocRoot`
- * @returns The data of the relevant document at the current location, or `null`
- * if no document associated with the current location can be found.
- */
-export function useDocRootMetadata({ route }) {
-    const location = useLocation();
-    const versionMetadata = useDocsVersion();
-    const docRoutes = route.routes;
-    const currentDocRoute = docRoutes.find((docRoute) => matchPath(location.pathname, docRoute));
-    if (!currentDocRoute) {
-        return null;
-    }
-    // For now, the sidebarName is added as route config: not ideal!
-    const sidebarName = currentDocRoute.sidebar;
-    const sidebarItems = sidebarName
-        ? versionMetadata.docsSidebars[sidebarName]
-        : undefined;
-    const docElement = renderRoutes(docRoutes);
-    return {
-        docElement,
-        sidebarName,
-        sidebarItems,
-    };
-}
-/**
- * Filter items we don't want to display on the doc card list view
- * @param items
- */
-export function filterDocCardListItems(items) {
-    return items.filter((item) => {
-        const canHaveLink = item.type === 'category' || item.type === 'link';
-        if (canHaveLink) {
-            return !!findFirstSidebarItemLink(item);
-        }
-        return true;
-    });
-}
-//# sourceMappingURL=docsUtils.js.map