@docusaurus/theme-common 2.0.0-beta.15d451942 → 2.0.0-beta.16

package/lib/utils/colorModeUtils.js

@@ -0,0 +1,106 @@
+/**
+ * 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, { useState, useCallback, useEffect, useContext, useMemo, } from 'react';
+import ExecutionEnvironment from '@docusaurus/ExecutionEnvironment';
+import { createStorageSlot } from './storageUtils';
+import { useThemeConfig } from './useThemeConfig';
+const ThemeStorageKey = 'theme';
+const ThemeStorage = createStorageSlot(ThemeStorageKey);
+const themes = {
+    light: 'light',
+    dark: 'dark',
+};
+// Ensure to always return a valid theme even if input is invalid
+const coerceToTheme = (theme) => theme === themes.dark ? themes.dark : themes.light;
+const getInitialTheme = (defaultMode) => {
+    if (!ExecutionEnvironment.canUseDOM) {
+        return coerceToTheme(defaultMode);
+    }
+    return coerceToTheme(document.documentElement.getAttribute('data-theme'));
+};
+const storeTheme = (newTheme) => {
+    ThemeStorage.set(coerceToTheme(newTheme));
+};
+function useColorModeContextValue() {
+    const { colorMode: { defaultMode, disableSwitch, respectPrefersColorScheme }, } = useThemeConfig();
+    const [theme, setTheme] = useState(getInitialTheme(defaultMode));
+    const setLightTheme = useCallback(() => {
+        setTheme(themes.light);
+        storeTheme(themes.light);
+    }, []);
+    const setDarkTheme = useCallback(() => {
+        setTheme(themes.dark);
+        storeTheme(themes.dark);
+    }, []);
+    useEffect(() => {
+        document.documentElement.setAttribute('data-theme', coerceToTheme(theme));
+    }, [theme]);
+    useEffect(() => {
+        if (disableSwitch) {
+            return undefined;
+        }
+        const onChange = (e) => {
+            if (e.key !== ThemeStorageKey) {
+                return;
+            }
+            try {
+                const storedTheme = ThemeStorage.get();
+                if (storedTheme !== null) {
+                    setTheme(coerceToTheme(storedTheme));
+                }
+            }
+            catch (err) {
+                console.error(err);
+            }
+        };
+        window.addEventListener('storage', onChange);
+        return () => {
+            window.removeEventListener('storage', onChange);
+        };
+    }, [disableSwitch, setTheme]);
+    // PCS is coerced to light mode when printing, which causes the color mode to
+    // be reset to dark when exiting print mode, disregarding user settings. When
+    // the listener fires only because of a print/screen switch, we don't change
+    // color mode. See https://github.com/facebook/docusaurus/pull/6490
+    const previousMediaIsPrint = React.useRef(false);
+    useEffect(() => {
+        if (disableSwitch && !respectPrefersColorScheme) {
+            return undefined;
+        }
+        const mql = window.matchMedia('(prefers-color-scheme: dark)');
+        const onChange = ({ matches }) => {
+            if (window.matchMedia('print').matches || previousMediaIsPrint.current) {
+                previousMediaIsPrint.current = window.matchMedia('print').matches;
+                return;
+            }
+            setTheme(matches ? themes.dark : themes.light);
+        };
+        mql.addListener(onChange);
+        return () => {
+            mql.removeListener(onChange);
+        };
+    }, [disableSwitch, respectPrefersColorScheme]);
+    return {
+        isDarkTheme: theme === themes.dark,
+        setLightTheme,
+        setDarkTheme,
+    };
+}
+const ColorModeContext = React.createContext(undefined);
+export function ColorModeProvider({ children, }) {
+    const { isDarkTheme, setLightTheme, setDarkTheme } = useColorModeContextValue();
+    const contextValue = useMemo(() => ({ isDarkTheme, setLightTheme, setDarkTheme }), [isDarkTheme, setLightTheme, setDarkTheme]);
+    return (React.createElement(ColorModeContext.Provider, { value: contextValue }, children));
+}
+export function useColorMode() {
+    const context = useContext(ColorModeContext);
+    if (context == null) {
+        throw new Error('"useColorMode()" is used outside of "Layout" component. Please see https://docusaurus.io/docs/api/themes/configuration#use-color-mode.');
+    }
+    return context;
+}
+//# sourceMappingURL=colorModeUtils.js.map

package/lib/utils/colorModeUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"colorModeUtils.js","sourceRoot":"","sources":["../../src/utils/colorModeUtils.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,KAAK,EAAE,EACZ,QAAQ,EACR,WAAW,EACX,SAAS,EACT,UAAU,EACV,OAAO,GACR,MAAM,OAAO,CAAC;AAEf,OAAO,oBAAoB,MAAM,kCAAkC,CAAC;AACpE,OAAO,EAAC,iBAAiB,EAAC,MAAM,gBAAgB,CAAC;AACjD,OAAO,EAAC,cAAc,EAAC,MAAM,kBAAkB,CAAC;AAQhD,MAAM,eAAe,GAAG,OAAO,CAAC;AAChC,MAAM,YAAY,GAAG,iBAAiB,CAAC,eAAe,CAAC,CAAC;AAExD,MAAM,MAAM,GAAG;IACb,KAAK,EAAE,OAAO;IACd,IAAI,EAAE,MAAM;CACJ,CAAC;AAIX,iEAAiE;AACjE,MAAM,aAAa,GAAG,CAAC,KAAqB,EAAU,EAAE,CACtD,KAAK,KAAK,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;AAErD,MAAM,eAAe,GAAG,CAAC,WAA+B,EAAU,EAAE;IAClE,IAAI,CAAC,oBAAoB,CAAC,SAAS,EAAE;QACnC,OAAO,aAAa,CAAC,WAAW,CAAC,CAAC;KACnC;IACD,OAAO,aAAa,CAAC,QAAQ,CAAC,eAAe,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC;AAC5E,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,QAAgB,EAAE,EAAE;IACtC,YAAY,CAAC,GAAG,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC;AAC5C,CAAC,CAAC;AAEF,SAAS,wBAAwB;IAC/B,MAAM,EACJ,SAAS,EAAE,EAAC,WAAW,EAAE,aAAa,EAAE,yBAAyB,EAAC,GACnE,GAAG,cAAc,EAAE,CAAC;IACrB,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC,CAAC;IAEjE,MAAM,aAAa,GAAG,WAAW,CAAC,GAAG,EAAE;QACrC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACvB,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC,EAAE,EAAE,CAAC,CAAC;IACP,MAAM,YAAY,GAAG,WAAW,CAAC,GAAG,EAAE;QACpC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACtB,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,SAAS,CAAC,GAAG,EAAE;QACb,QAAQ,CAAC,eAAe,CAAC,YAAY,CAAC,YAAY,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;IAC5E,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;IAEZ,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,aAAa,EAAE;YACjB,OAAO,SAAS,CAAC;SAClB;QACD,MAAM,QAAQ,GAAG,CAAC,CAAe,EAAE,EAAE;YACnC,IAAI,CAAC,CAAC,GAAG,KAAK,eAAe,EAAE;gBAC7B,OAAO;aACR;YACD,IAAI;gBACF,MAAM,WAAW,GAAG,YAAY,CAAC,GAAG,EAAE,CAAC;gBACvC,IAAI,WAAW,KAAK,IAAI,EAAE;oBACxB,QAAQ,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC;iBACtC;aACF;YAAC,OAAO,GAAG,EAAE;gBACZ,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;aACpB;QACH,CAAC,CAAC;QACF,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAC7C,OAAO,GAAG,EAAE;YACV,MAAM,CAAC,mBAAmB,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAClD,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC,CAAC;IAE9B,6EAA6E;IAC7E,6EAA6E;IAC7E,4EAA4E;IAC5E,mEAAmE;IACnE,MAAM,oBAAoB,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAEjD,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,aAAa,IAAI,CAAC,yBAAyB,EAAE;YAC/C,OAAO,SAAS,CAAC;SAClB;QACD,MAAM,GAAG,GAAG,MAAM,CAAC,UAAU,CAAC,8BAA8B,CAAC,CAAC;QAC9D,MAAM,QAAQ,GAAG,CAAC,EAAC,OAAO,EAAsB,EAAE,EAAE;YAClD,IAAI,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,OAAO,IAAI,oBAAoB,CAAC,OAAO,EAAE;gBACtE,oBAAoB,CAAC,OAAO,GAAG,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC;gBAClE,OAAO;aACR;YACD,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACjD,CAAC,CAAC;QACF,GAAG,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAC1B,OAAO,GAAG,EAAE;YACV,GAAG,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAC/B,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,aAAa,EAAE,yBAAyB,CAAC,CAAC,CAAC;IAE/C,OAAO;QACL,WAAW,EAAE,KAAK,KAAK,MAAM,CAAC,IAAI;QAClC,aAAa;QACb,YAAY;KACb,CAAC;AACJ,CAAC;AAED,MAAM,gBAAgB,GAAG,KAAK,CAAC,aAAa,CAC1C,SAAS,CACV,CAAC;AAEF,MAAM,UAAU,iBAAiB,CAAC,EAChC,QAAQ,GAGT;IACC,MAAM,EAAC,WAAW,EAAE,aAAa,EAAE,YAAY,EAAC,GAAG,wBAAwB,EAAE,CAAC;IAC9E,MAAM,YAAY,GAAG,OAAO,CAC1B,GAAG,EAAE,CAAC,CAAC,EAAC,WAAW,EAAE,aAAa,EAAE,YAAY,EAAC,CAAC,EAClD,CAAC,WAAW,EAAE,aAAa,EAAE,YAAY,CAAC,CAC3C,CAAC;IACF,OAAO,CACL,oBAAC,gBAAgB,CAAC,QAAQ,IAAC,KAAK,EAAE,YAAY,IAC3C,QAAQ,CACiB,CAC7B,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,YAAY;IAC1B,MAAM,OAAO,GAAG,UAAU,CACxB,gBAAgB,CACjB,CAAC;IACF,IAAI,OAAO,IAAI,IAAI,EAAE;QACnB,MAAM,IAAI,KAAK,CACb,wIAAwI,CACzI,CAAC;KACH;IACD,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/lib/utils/docSidebarItemsExpandedState.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 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';
+declare type DocSidebarItemsExpandedState = {
+    expandedItem: number | null;
+    setExpandedItem: (a: number | null) => void;
+};
+export declare function DocSidebarItemsExpandedStateProvider({ children, }: {
+    children: ReactNode;
+}): JSX.Element;
+export declare function useDocSidebarItemsExpandedState(): DocSidebarItemsExpandedState;
+export {};
+//# sourceMappingURL=docSidebarItemsExpandedState.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"docSidebarItemsExpandedState.d.ts","sourceRoot":"","sources":["../../src/utils/docSidebarItemsExpandedState.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAc,EAAC,KAAK,SAAS,EAAgC,MAAM,OAAO,CAAC;AAM3E,aAAK,4BAA4B,GAAG;IAClC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,eAAe,EAAE,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI,KAAK,IAAI,CAAC;CAC7C,CAAC;AAEF,wBAAgB,oCAAoC,CAAC,EACnD,QAAQ,GACT,EAAE;IACD,QAAQ,EAAE,SAAS,CAAC;CACrB,GAAG,GAAG,CAAC,OAAO,CAQd;AAED,wBAAgB,+BAA+B,IAAI,4BAA4B,CAQ9E"}

package/lib/utils/docSidebarItemsExpandedState.js

@@ -0,0 +1,22 @@
+/**
+ * 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, useState, useContext } from 'react';
+const EmptyContext = Symbol('EmptyContext');
+const Context = React.createContext(EmptyContext);
+export function DocSidebarItemsExpandedStateProvider({ children, }) {
+    const [expandedItem, setExpandedItem] = useState(null);
+    const contextValue = useMemo(() => ({ expandedItem, setExpandedItem }), [expandedItem]);
+    return React.createElement(Context.Provider, { value: contextValue }, children);
+}
+export function useDocSidebarItemsExpandedState() {
+    const contextValue = useContext(Context);
+    if (contextValue === EmptyContext) {
+        throw new Error('This hook requires usage of <DocSidebarItemsExpandedStateProvider>');
+    }
+    return contextValue;
+}
+//# sourceMappingURL=docSidebarItemsExpandedState.js.map

package/lib/utils/docSidebarItemsExpandedState.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"docSidebarItemsExpandedState.js","sourceRoot":"","sources":["../../src/utils/docSidebarItemsExpandedState.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,EAAiB,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAC,MAAM,OAAO,CAAC;AAE3E,MAAM,YAAY,GAAkB,MAAM,CAAC,cAAc,CAAC,CAAC;AAC3D,MAAM,OAAO,GAAG,KAAK,CAAC,aAAa,CAEjC,YAAY,CAAC,CAAC;AAMhB,MAAM,UAAU,oCAAoC,CAAC,EACnD,QAAQ,GAGT;IACC,MAAM,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,QAAQ,CAAgB,IAAI,CAAC,CAAC;IACtE,MAAM,YAAY,GAAG,OAAO,CAC1B,GAAG,EAAE,CAAC,CAAC,EAAC,YAAY,EAAE,eAAe,EAAC,CAAC,EACvC,CAAC,YAAY,CAAC,CACf,CAAC;IAEF,OAAO,oBAAC,OAAO,CAAC,QAAQ,IAAC,KAAK,EAAE,YAAY,IAAG,QAAQ,CAAoB,CAAC;AAC9E,CAAC;AAED,MAAM,UAAU,+BAA+B;IAC7C,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IACzC,IAAI,YAAY,KAAK,YAAY,EAAE;QACjC,MAAM,IAAI,KAAK,CACb,oEAAoE,CACrE,CAAC;KACH;IACD,OAAO,YAAY,CAAC;AACtB,CAAC"}

package/lib/utils/docsPreferredVersion/DocsPreferredVersionProvider.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 { ReactNode } from 'react';
+/// <reference types="react" />
 declare type DocsPreferredVersionName = string | null;
 declare type DocsPreferredVersionPluginState = {
     preferredVersionName: DocsPreferredVersionName;
@@ -15,7 +15,8 @@ declare function useContextValue(): readonly [DocsPreferredVersionState, {
 }];
 declare type DocsPreferredVersionContextValue = ReturnType<typeof useContextValue>;
 export declare function DocsPreferredVersionContextProvider({ children, }: {
-    children: ReactNode;
+    children: JSX.Element;
 }): JSX.Element;
 export declare function useDocsPreferredVersionContext(): DocsPreferredVersionContextValue;
 export {};
+//# sourceMappingURL=DocsPreferredVersionProvider.d.ts.map

package/lib/utils/docsPreferredVersion/DocsPreferredVersionProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DocsPreferredVersionProvider.d.ts","sourceRoot":"","sources":["../../../src/utils/docsPreferredVersion/DocsPreferredVersionProvider.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;;AAoBH,aAAK,wBAAwB,GAAG,MAAM,GAAG,IAAI,CAAC;AAG9C,aAAK,+BAA+B,GAAG;IACrC,oBAAoB,EAAE,wBAAwB,CAAC;CAChD,CAAC;AAKF,aAAK,yBAAyB,GAAG,MAAM,CACrC,MAAM,EACN,+BAA+B,CAChC,CAAC;AAyDF,iBAAS,eAAe;qCAeoB,MAAM,eAAe,MAAM;GAkBtE;AAED,aAAK,gCAAgC,GAAG,UAAU,CAAC,OAAO,eAAe,CAAC,CAAC;AAI3E,wBAAgB,mCAAmC,CAAC,EAClD,QAAQ,GACT,EAAE;IACD,QAAQ,EAAE,GAAG,CAAC,OAAO,CAAC;CACvB,GAAG,GAAG,CAAC,OAAO,CASd;AAWD,wBAAgB,8BAA8B,IAAI,gCAAgC,CAQjF"}

package/lib/utils/docsPreferredVersion/DocsPreferredVersionProvider.js

@@ -7,9 +7,9 @@
 import React, { createContext, useContext, useEffect, useMemo, useState, } from 'react';
 import { useThemeConfig } from '../useThemeConfig';
 import { isDocsPluginEnabled } from '../docsUtils';
-import { useAllDocsData } from '@theme/hooks/useDocs';
+import { useAllDocsData, } from '@docusaurus/plugin-content-docs/client';
 import DocsPreferredVersionStorage from './DocsPreferredVersionStorage';
-// Initial state is always null as we can't read localstorage from node SSR
+// Initial state is always null as we can't read local storage from node SSR
 function getInitialState(pluginIds) {
     const initialState = {};
     pluginIds.forEach((pluginId) => {
@@ -32,10 +32,8 @@ function readStorageState({ pluginIds, versionPersistence, allDocsData, }) {
         if (versionExists) {
             return { preferredVersionName: preferredVersionNameUnsafe };
         }
-        else {
-            DocsPreferredVersionStorage.clear(pluginId, versionPersistence);
-            return { preferredVersionName: null };
-        }
+        DocsPreferredVersionStorage.clear(pluginId, versionPersistence);
+        return { preferredVersionName: null };
     }
     const initialState = {};
     pluginIds.forEach((pluginId) => {
@@ -69,7 +67,7 @@ function useContextValue() {
         return {
             savePreferredVersion,
         };
-    }, [setState]);
+    }, [versionPersistence]);
     return [state, api];
 }
 const Context = createContext(null);
@@ -77,9 +75,7 @@ export function DocsPreferredVersionContextProvider({ children, }) {
     if (isDocsPluginEnabled) {
         return (React.createElement(DocsPreferredVersionContextProviderUnsafe, null, children));
     }
-    else {
-        return React.createElement(React.Fragment, null, children);
-    }
+    return children;
 }
 function DocsPreferredVersionContextProviderUnsafe({ children, }) {
     const contextValue = useContextValue();
@@ -88,7 +84,8 @@ function DocsPreferredVersionContextProviderUnsafe({ children, }) {
 export function useDocsPreferredVersionContext() {
     const value = useContext(Context);
     if (!value) {
-        throw new Error("Can't find docs preferred context, maybe you forgot to use the DocsPreferredVersionContextProvider ?");
+        throw new Error('Can\'t find docs preferred context, maybe you forgot to use the "DocsPreferredVersionContextProvider"?');
     }
     return value;
 }
+//# sourceMappingURL=DocsPreferredVersionProvider.js.map

package/lib/utils/docsPreferredVersion/DocsPreferredVersionProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DocsPreferredVersionProvider.js","sourceRoot":"","sources":["../../../src/utils/docsPreferredVersion/DocsPreferredVersionProvider.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,EACZ,aAAa,EAEb,UAAU,EACV,SAAS,EACT,OAAO,EACP,QAAQ,GACT,MAAM,OAAO,CAAC;AACf,OAAO,EAAC,cAAc,EAA8B,MAAM,mBAAmB,CAAC;AAC9E,OAAO,EAAC,mBAAmB,EAAC,MAAM,cAAc,CAAC;AAEjD,OAAO,EACL,cAAc,GAEf,MAAM,wCAAwC,CAAC;AAEhD,OAAO,2BAA2B,MAAM,+BAA+B,CAAC;AAiBxE,4EAA4E;AAC5E,SAAS,eAAe,CAAC,SAAmB;IAC1C,MAAM,YAAY,GAA8B,EAAE,CAAC;IACnD,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;QAC7B,YAAY,CAAC,QAAQ,CAAC,GAAG;YACvB,oBAAoB,EAAE,IAAI;SAC3B,CAAC;IACJ,CAAC,CAAC,CAAC;IACH,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,oCAAoC;AACpC,2DAA2D;AAC3D,SAAS,gBAAgB,CAAC,EACxB,SAAS,EACT,kBAAkB,EAClB,WAAW,GAKZ;IACC,4CAA4C;IAC5C,kEAAkE;IAClE,uEAAuE;IACvE,SAAS,kBAAkB,CACzB,QAAgB;QAEhB,MAAM,0BAA0B,GAAG,2BAA2B,CAAC,IAAI,CACjE,QAAQ,EACR,kBAAkB,CACnB,CAAC;QACF,MAAM,UAAU,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC;QACzC,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;YACjB,OAAO,EAAC,oBAAoB,EAAE,0BAA0B,EAAC,CAAC;SAC3D;QACD,2BAA2B,CAAC,KAAK,CAAC,QAAQ,EAAE,kBAAkB,CAAC,CAAC;QAChE,OAAO,EAAC,oBAAoB,EAAE,IAAI,EAAC,CAAC;IACtC,CAAC;IAED,MAAM,YAAY,GAA8B,EAAE,CAAC;IACnD,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;QAC7B,YAAY,CAAC,QAAQ,CAAC,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IACH,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,SAAS,qBAAqB;IAC5B,OAAO,cAAc,EAAE,CAAC,IAAI,CAAC,kBAAkB,CAAC;AAClD,CAAC;AAED,8DAA8D;AAC9D,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,wEAAwE;IACxE,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,CAAU,CAAC;AAC/B,CAAC;AAID,MAAM,OAAO,GAAG,aAAa,CAA0C,IAAI,CAAC,CAAC;AAE7E,MAAM,UAAU,mCAAmC,CAAC,EAClD,QAAQ,GAGT;IACC,IAAI,mBAAmB,EAAE;QACvB,OAAO,CACL,oBAAC,yCAAyC,QACvC,QAAQ,CACiC,CAC7C,CAAC;KACH;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,yCAAyC,CAAC,EACjD,QAAQ,GAGT;IACC,MAAM,YAAY,GAAG,eAAe,EAAE,CAAC;IACvC,OAAO,oBAAC,OAAO,CAAC,QAAQ,IAAC,KAAK,EAAE,YAAY,IAAG,QAAQ,CAAoB,CAAC;AAC9E,CAAC;AAED,MAAM,UAAU,8BAA8B;IAC5C,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IAClC,IAAI,CAAC,KAAK,EAAE;QACV,MAAM,IAAI,KAAK,CACb,wGAAwG,CACzG,CAAC;KACH;IACD,OAAO,KAAK,CAAC;AACf,CAAC"}

package/lib/utils/docsPreferredVersion/DocsPreferredVersionStorage.d.ts

@@ -4,10 +4,11 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { DocsVersionPersistence } from '../useThemeConfig';
+import type { DocsVersionPersistence } from '../useThemeConfig';
 declare const DocsPreferredVersionStorage: {
     save: (pluginId: string, persistence: DocsVersionPersistence, versionName: string) => void;
     read: (pluginId: string, persistence: DocsVersionPersistence) => string | null;
     clear: (pluginId: string, persistence: DocsVersionPersistence) => void;
 };
 export default DocsPreferredVersionStorage;
+//# sourceMappingURL=DocsPreferredVersionStorage.d.ts.map

package/lib/utils/docsPreferredVersion/DocsPreferredVersionStorage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DocsPreferredVersionStorage.d.ts","sourceRoot":"","sources":["../../../src/utils/docsPreferredVersion/DocsPreferredVersionStorage.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,KAAK,EAAC,sBAAsB,EAAC,MAAM,mBAAmB,CAAC;AAI9D,QAAA,MAAM,2BAA2B;qBAEnB,MAAM,eACH,sBAAsB,eACtB,MAAM,KAClB,IAAI;qBAKK,MAAM,eACH,sBAAsB,KAClC,MAAM,GAAG,IAAI;sBAGE,MAAM,eAAe,sBAAsB,KAAG,IAAI;CAGrE,CAAC;AAEF,eAAe,2BAA2B,CAAC"}

package/lib/utils/docsPreferredVersion/DocsPreferredVersionStorage.js

@@ -10,11 +10,10 @@ const DocsPreferredVersionStorage = {
     save: (pluginId, persistence, versionName) => {
         createStorageSlot(storageKey(pluginId), { persistence }).set(versionName);
     },
-    read: (pluginId, persistence) => {
-        return createStorageSlot(storageKey(pluginId), { persistence }).get();
-    },
+    read: (pluginId, persistence) => createStorageSlot(storageKey(pluginId), { persistence }).get(),
     clear: (pluginId, persistence) => {
         createStorageSlot(storageKey(pluginId), { persistence }).del();
     },
 };
 export default DocsPreferredVersionStorage;
+//# sourceMappingURL=DocsPreferredVersionStorage.js.map

package/lib/utils/docsPreferredVersion/DocsPreferredVersionStorage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DocsPreferredVersionStorage.js","sourceRoot":"","sources":["../../../src/utils/docsPreferredVersion/DocsPreferredVersionStorage.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAC,iBAAiB,EAAC,MAAM,iBAAiB,CAAC;AAGlD,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;AAEF,eAAe,2BAA2B,CAAC"}

package/lib/utils/docsPreferredVersion/useDocsPreferredVersion.d.ts

@@ -1,5 +1,14 @@
+/**
+ * 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.
+ */
+/// <reference types="@docusaurus/plugin-content-docs" />
+import { type GlobalVersion } from '@docusaurus/plugin-content-docs/client';
 export declare function useDocsPreferredVersion(pluginId?: string | undefined): {
-    readonly preferredVersion: any;
-    readonly savePreferredVersionName: (versionName: string) => void;
+    preferredVersion: GlobalVersion | null | undefined;
+    savePreferredVersionName: (versionName: string) => void;
 };
-export declare function useDocsPreferredVersionByPluginId(): Record<string, any>;
+export declare function useDocsPreferredVersionByPluginId(): Record<string, GlobalVersion | null | undefined>;
+//# sourceMappingURL=useDocsPreferredVersion.d.ts.map

package/lib/utils/docsPreferredVersion/useDocsPreferredVersion.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useDocsPreferredVersion.d.ts","sourceRoot":"","sources":["../../../src/utils/docsPreferredVersion/useDocsPreferredVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;;AAIH,OAAO,EAGL,KAAK,aAAa,EACnB,MAAM,wCAAwC,CAAC;AAKhD,wBAAgB,uBAAuB,CACrC,QAAQ,GAAE,MAAM,GAAG,SAA6B,GAC/C;IACD,gBAAgB,EAAE,aAAa,GAAG,IAAI,GAAG,SAAS,CAAC;IACnD,wBAAwB,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,IAAI,CAAC;CACzD,CAkBA;AAED,wBAAgB,iCAAiC,IAAI,MAAM,CACzD,MAAM,EACN,aAAa,GAAG,IAAI,GAAG,SAAS,CACjC,CAuBA"}

package/lib/utils/docsPreferredVersion/useDocsPreferredVersion.js

@@ -6,9 +6,8 @@
  */
 import { useCallback } from 'react';
 import { useDocsPreferredVersionContext } from './DocsPreferredVersionProvider';
-import { useAllDocsData, useDocsData } from '@theme/hooks/useDocs';
+import { useAllDocsData, useDocsData, } from '@docusaurus/plugin-content-docs/client';
 import { DEFAULT_PLUGIN_ID } from '@docusaurus/constants';
-// TODO improve typing
 // Note, the preferredVersion attribute will always be null before mount
 export function useDocsPreferredVersion(pluginId = DEFAULT_PLUGIN_ID) {
     const docsData = useDocsData(pluginId);
@@ -19,7 +18,7 @@ export function useDocsPreferredVersion(pluginId = DEFAULT_PLUGIN_ID) {
         : null;
     const savePreferredVersionName = useCallback((versionName) => {
         api.savePreferredVersion(pluginId, versionName);
-    }, [api]);
+    }, [api, pluginId]);
     return { preferredVersion, savePreferredVersionName };
 }
 export function useDocsPreferredVersionByPluginId() {
@@ -39,3 +38,4 @@ export function useDocsPreferredVersionByPluginId() {
     });
     return result;
 }
+//# sourceMappingURL=useDocsPreferredVersion.js.map

package/lib/utils/docsPreferredVersion/useDocsPreferredVersion.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useDocsPreferredVersion.js","sourceRoot":"","sources":["../../../src/utils/docsPreferredVersion/useDocsPreferredVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAC,WAAW,EAAC,MAAM,OAAO,CAAC;AAClC,OAAO,EAAC,8BAA8B,EAAC,MAAM,gCAAgC,CAAC;AAC9E,OAAO,EACL,cAAc,EACd,WAAW,GAEZ,MAAM,wCAAwC,CAAC;AAEhD,OAAO,EAAC,iBAAiB,EAAC,MAAM,uBAAuB,CAAC;AAExD,wEAAwE;AACxE,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,CAAC,CAAC;IAE/C,MAAM,gBAAgB,GAAG,oBAAoB;QAC3C,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,oBAAoB,CAAC;QAC5E,CAAC,CAAC,IAAI,CAAC;IAET,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,EAAU,CAAC;AAC/D,CAAC;AAED,MAAM,UAAU,iCAAiC;IAI/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,CAAC,CAAC;QACvC,MAAM,EAAC,oBAAoB,EAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;QAE/C,OAAO,oBAAoB;YACzB,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CACpB,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,oBAAoB,CACnD;YACH,CAAC,CAAC,IAAI,CAAC;IACX,CAAC;IAED,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAE3C,MAAM,MAAM,GAAqD,EAAE,CAAC;IACpE,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;QAC7B,MAAM,CAAC,QAAQ,CAAC,GAAG,2BAA2B,CAAC,QAAQ,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/lib/utils/docsUtils.d.ts

@@ -4,4 +4,30 @@
  * 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, PropSidebarItem, PropSidebarItemCategory, PropVersionDoc, PropVersionMetadata, PropSidebarBreadcrumbsItem } from '@docusaurus/plugin-content-docs';
 export declare const isDocsPluginEnabled: boolean;
+declare const EmptyContextValue: unique symbol;
+export declare function DocsVersionProvider({ children, version, }: {
+    children: ReactNode;
+    version: PropVersionMetadata | typeof EmptyContextValue;
+}): JSX.Element;
+export declare function useDocsVersion(): PropVersionMetadata;
+export declare function useDocById(id: string): PropVersionDoc;
+export declare function useDocById(id: string | undefined): PropVersionDoc | undefined;
+export declare function DocsSidebarProvider({ children, sidebar, }: {
+    children: ReactNode;
+    sidebar: PropSidebar | null;
+}): JSX.Element;
+export declare function useDocsSidebar(): PropSidebar | null;
+export declare function findSidebarCategory(sidebar: PropSidebar, predicate: (category: PropSidebarItemCategory) => boolean): PropSidebarItemCategory | undefined;
+export declare function findFirstCategoryLink(item: PropSidebarItemCategory): string | undefined;
+export declare function useCurrentSidebarCategory(): PropSidebarItemCategory;
+export declare function isActiveSidebarItem(item: PropSidebarItem, activePath: string): boolean;
+export declare function getBreadcrumbs({ sidebar, pathname, }: {
+    sidebar: PropSidebar;
+    pathname: string;
+}): PropSidebarBreadcrumbsItem[];
+export declare function useSidebarBreadcrumbs(): PropSidebarBreadcrumbsItem[] | null;
+export {};
+//# sourceMappingURL=docsUtils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"docsUtils.d.ts","sourceRoot":"","sources":["../../src/utils/docsUtils.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAc,EAAgB,KAAK,SAAS,EAAa,MAAM,OAAO,CAAC;AAKvE,OAAO,KAAK,EACV,WAAW,EACX,eAAe,EACf,uBAAuB,EACvB,cAAc,EACd,mBAAmB,EACnB,0BAA0B,EAC3B,MAAM,iCAAiC,CAAC;AAKzC,eAAO,MAAM,mBAAmB,EAAE,OAA0B,CAAC;AAI7D,QAAA,MAAM,iBAAiB,EAAE,OAAO,MAA+B,CAAC;AAMhE,wBAAgB,mBAAmB,CAAC,EAClC,QAAQ,EACR,OAAO,GACR,EAAE;IACD,QAAQ,EAAE,SAAS,CAAC;IACpB,OAAO,EAAE,mBAAmB,GAAG,OAAO,iBAAiB,CAAC;CACzD,GAAG,GAAG,CAAC,OAAO,CAMd;AAED,wBAAgB,cAAc,IAAI,mBAAmB,CAMpD;AAED,wBAAgB,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,cAAc,CAAC;AACvD,wBAAgB,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,GAAG,cAAc,GAAG,SAAS,CAAC;AAiB/E,wBAAgB,mBAAmB,CAAC,EAClC,QAAQ,EACR,OAAO,GACR,EAAE;IACD,QAAQ,EAAE,SAAS,CAAC;IACpB,OAAO,EAAE,WAAW,GAAG,IAAI,CAAC;CAC7B,GAAG,GAAG,CAAC,OAAO,CAMd;AAED,wBAAgB,cAAc,IAAI,WAAW,GAAG,IAAI,CAMnD;AAID,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,WAAW,EACpB,SAAS,EAAE,CAAC,QAAQ,EAAE,uBAAuB,KAAK,OAAO,GACxD,uBAAuB,GAAG,SAAS,CAarC;AAGD,wBAAgB,qBAAqB,CACnC,IAAI,EAAE,uBAAuB,GAC5B,MAAM,GAAG,SAAS,CAsBpB;AAED,wBAAgB,yBAAyB,IAAI,uBAAuB,CAgBnE;AASD,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,eAAe,EACrB,UAAU,EAAE,MAAM,GACjB,OAAO,CAeT;AAED,wBAAgB,cAAc,CAAC,EAC7B,OAAO,EACP,QAAQ,GACT,EAAE;IACD,OAAO,EAAE,WAAW,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;CAClB,GAAG,0BAA0B,EAAE,CAuB/B;AAED,wBAAgB,qBAAqB,IAAI,0BAA0B,EAAE,GAAG,IAAI,CAU3E"}

package/lib/utils/docsUtils.js

@@ -4,6 +4,141 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { useAllDocsData } from '@theme/hooks/useDocs';
+import React, { createContext, useContext } from 'react';
+import { useActivePlugin, useAllDocsData, } from '@docusaurus/plugin-content-docs/client';
+import { isSamePath } from './pathUtils';
+import { useLocation } from '@docusaurus/router';
 // TODO not ideal, see also "useDocs"
 export const isDocsPluginEnabled = !!useAllDocsData;
+// 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 EmptyContextValue = Symbol('EmptyContext');
+const DocsVersionContext = createContext(EmptyContextValue);
+export function DocsVersionProvider({ children, version, }) {
+    return (React.createElement(DocsVersionContext.Provider, { value: version }, children));
+}
+export function useDocsVersion() {
+    const version = useContext(DocsVersionContext);
+    if (version === EmptyContextValue) {
+        throw new Error('This hook requires usage of <DocsVersionProvider>');
+    }
+    return version;
+}
+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;
+}
+const DocsSidebarContext = createContext(EmptyContextValue);
+export function DocsSidebarProvider({ children, sidebar, }) {
+    return (React.createElement(DocsSidebarContext.Provider, { value: sidebar }, children));
+}
+export function useDocsSidebar() {
+    const sidebar = useContext(DocsSidebarContext);
+    if (sidebar === EmptyContextValue) {
+        throw new Error('This hook requires usage of <DocsSidebarProvider>');
+    }
+    return sidebar;
+}
+// Use the components props and the sidebar in context
+// to get back the related sidebar category that we want to render
+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;
+}
+// If a category card has no link => link to the first subItem having a link
+export function findFirstCategoryLink(item) {
+    if (item.href) {
+        return item.href;
+    }
+    for (const subItem of item.items) {
+        if (subItem.type === 'link') {
+            return subItem.href;
+        }
+        else if (subItem.type === 'category') {
+            const categoryLink = findFirstCategoryLink(subItem);
+            if (categoryLink) {
+                return categoryLink;
+            }
+        }
+        else if (subItem.type === 'html') {
+            // skip
+        }
+        else {
+            throw new Error(`Unexpected category item type for ${JSON.stringify(subItem)}`);
+        }
+    }
+    return undefined;
+}
+export function useCurrentSidebarCategory() {
+    const { pathname } = useLocation();
+    const sidebar = useDocsSidebar();
+    if (!sidebar) {
+        throw new Error('Unexpected: cant find current sidebar in context');
+    }
+    const category = findSidebarCategory(sidebar, (item) => isSamePath(item.href, pathname));
+    if (!category) {
+        throw new Error(`Unexpected: sidebar category could not be found for pathname='${pathname}'.
+Hook useCurrentSidebarCategory() should only be used on Category pages`);
+    }
+    return category;
+}
+function containsActiveSidebarItem(items, activePath) {
+    return items.some((subItem) => isActiveSidebarItem(subItem, activePath));
+}
+export function isActiveSidebarItem(item, activePath) {
+    const isActive = (testedPath) => typeof testedPath !== 'undefined' && isSamePath(testedPath, activePath);
+    if (item.type === 'link') {
+        return isActive(item.href);
+    }
+    if (item.type === 'category') {
+        return (isActive(item.href) || containsActiveSidebarItem(item.items, activePath));
+    }
+    return false;
+}
+export function getBreadcrumbs({ sidebar, pathname, }) {
+    const breadcrumbs = [];
+    function extract(items) {
+        for (const item of items) {
+            if (item.type === 'category' &&
+                (isSamePath(item.href, pathname) || extract(item.items))) {
+                breadcrumbs.push(item);
+                return true;
+            }
+            else if (item.type === 'link' && isSamePath(item.href, pathname)) {
+                breadcrumbs.push(item);
+                return true;
+            }
+        }
+        return false;
+    }
+    extract(sidebar);
+    return breadcrumbs.reverse();
+}
+export function useSidebarBreadcrumbs() {
+    var _a;
+    const sidebar = useDocsSidebar();
+    const { pathname } = useLocation();
+    const breadcrumbsOption = (_a = useActivePlugin()) === null || _a === void 0 ? void 0 : _a.pluginData.breadcrumbs;
+    if (breadcrumbsOption === false || !sidebar) {
+        return null;
+    }
+    return getBreadcrumbs({ sidebar, pathname });
+}
+//# sourceMappingURL=docsUtils.js.map

package/lib/utils/docsUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"docsUtils.js","sourceRoot":"","sources":["../../src/utils/docsUtils.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,EAAC,aAAa,EAAkB,UAAU,EAAC,MAAM,OAAO,CAAC;AACvE,OAAO,EACL,eAAe,EACf,cAAc,GACf,MAAM,wCAAwC,CAAC;AAShD,OAAO,EAAC,UAAU,EAAC,MAAM,aAAa,CAAC;AACvC,OAAO,EAAC,WAAW,EAAC,MAAM,oBAAoB,CAAC;AAE/C,qCAAqC;AACrC,MAAM,CAAC,MAAM,mBAAmB,GAAY,CAAC,CAAC,cAAc,CAAC;AAE7D,+EAA+E;AAC/E,6FAA6F;AAC7F,MAAM,iBAAiB,GAAkB,MAAM,CAAC,cAAc,CAAC,CAAC;AAEhE,MAAM,kBAAkB,GAAG,aAAa,CAEtC,iBAAiB,CAAC,CAAC;AAErB,MAAM,UAAU,mBAAmB,CAAC,EAClC,QAAQ,EACR,OAAO,GAIR;IACC,OAAO,CACL,oBAAC,kBAAkB,CAAC,QAAQ,IAAC,KAAK,EAAE,OAAO,IACxC,QAAQ,CACmB,CAC/B,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,cAAc;IAC5B,MAAM,OAAO,GAAG,UAAU,CAAC,kBAAkB,CAAC,CAAC;IAC/C,IAAI,OAAO,KAAK,iBAAiB,EAAE;QACjC,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;KACtE;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAID,MAAM,UAAU,UAAU,CAAC,EAAsB;IAC/C,MAAM,OAAO,GAAG,cAAc,EAAE,CAAC;IACjC,IAAI,CAAC,EAAE,EAAE;QACP,OAAO,SAAS,CAAC;KAClB;IACD,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC7B,IAAI,CAAC,GAAG,EAAE;QACR,MAAM,IAAI,KAAK,CAAC,8BAA8B,EAAE,EAAE,CAAC,CAAC;KACrD;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,kBAAkB,GAAG,aAAa,CAEtC,iBAAiB,CAAC,CAAC;AAErB,MAAM,UAAU,mBAAmB,CAAC,EAClC,QAAQ,EACR,OAAO,GAIR;IACC,OAAO,CACL,oBAAC,kBAAkB,CAAC,QAAQ,IAAC,KAAK,EAAE,OAAO,IACxC,QAAQ,CACmB,CAC/B,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,cAAc;IAC5B,MAAM,OAAO,GAAG,UAAU,CAAC,kBAAkB,CAAC,CAAC;IAC/C,IAAI,OAAO,KAAK,iBAAiB,EAAE;QACjC,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;KACtE;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,sDAAsD;AACtD,kEAAkE;AAClE,MAAM,UAAU,mBAAmB,CACjC,OAAoB,EACpB,SAAyD;IAEzD,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE;QAC1B,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU,EAAE;YAC5B,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE;gBACnB,OAAO,IAAI,CAAC;aACb;YACD,MAAM,OAAO,GAAG,mBAAmB,CAAC,IAAI,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;YAC3D,IAAI,OAAO,EAAE;gBACX,OAAO,OAAO,CAAC;aAChB;SACF;KACF;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,4EAA4E;AAC5E,MAAM,UAAU,qBAAqB,CACnC,IAA6B;IAE7B,IAAI,IAAI,CAAC,IAAI,EAAE;QACb,OAAO,IAAI,CAAC,IAAI,CAAC;KAClB;IAED,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,KAAK,EAAE;QAChC,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE;YAC3B,OAAO,OAAO,CAAC,IAAI,CAAC;SACrB;aAAM,IAAI,OAAO,CAAC,IAAI,KAAK,UAAU,EAAE;YACtC,MAAM,YAAY,GAAG,qBAAqB,CAAC,OAAO,CAAC,CAAC;YACpD,IAAI,YAAY,EAAE;gBAChB,OAAO,YAAY,CAAC;aACrB;SACF;aAAM,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE;YAClC,OAAO;SACR;aAAM;YACL,MAAM,IAAI,KAAK,CACb,qCAAqC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAC/D,CAAC;SACH;KACF;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,MAAM,UAAU,yBAAyB;IACvC,MAAM,EAAC,QAAQ,EAAC,GAAG,WAAW,EAAE,CAAC;IACjC,MAAM,OAAO,GAAG,cAAc,EAAE,CAAC;IACjC,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;KACrE;IACD,MAAM,QAAQ,GAAG,mBAAmB,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE,CACrD,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAChC,CAAC;IACF,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,IAAI,KAAK,CACb,iEAAiE,QAAQ;uEACR,CAClE,CAAC;KACH;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,yBAAyB,CAChC,KAAwB,EACxB,UAAkB;IAElB,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,mBAAmB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC;AAC3E,CAAC;AAED,MAAM,UAAU,mBAAmB,CACjC,IAAqB,EACrB,UAAkB;IAElB,MAAM,QAAQ,GAAG,CAAC,UAA8B,EAAE,EAAE,CAClD,OAAO,UAAU,KAAK,WAAW,IAAI,UAAU,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IAE1E,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE;QACxB,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;KAC5B;IAED,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU,EAAE;QAC5B,OAAO,CACL,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,yBAAyB,CAAC,IAAI,CAAC,KAAK,EAAE,UAAU,CAAC,CACzE,CAAC;KACH;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,EAC7B,OAAO,EACP,QAAQ,GAIT;IACC,MAAM,WAAW,GAAiC,EAAE,CAAC;IAErD,SAAS,OAAO,CAAC,KAAkB;QACjC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,IACE,IAAI,CAAC,IAAI,KAAK,UAAU;gBACxB,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EACxD;gBACA,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACvB,OAAO,IAAI,CAAC;aACb;iBAAM,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE;gBAClE,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACvB,OAAO,IAAI,CAAC;aACb;SACF;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,CAAC,OAAO,CAAC,CAAC;IAEjB,OAAO,WAAW,CAAC,OAAO,EAAE,CAAC;AAC/B,CAAC;AAED,MAAM,UAAU,qBAAqB;;IACnC,MAAM,OAAO,GAAG,cAAc,EAAE,CAAC;IACjC,MAAM,EAAC,QAAQ,EAAC,GAAG,WAAW,EAAE,CAAC;IACjC,MAAM,iBAAiB,GAAG,MAAA,eAAe,EAAE,0CAAE,UAAU,CAAC,WAAW,CAAC;IAEpE,IAAI,iBAAiB,KAAK,KAAK,IAAI,CAAC,OAAO,EAAE;QAC3C,OAAO,IAAI,CAAC;KACb;IAED,OAAO,cAAc,CAAC,EAAC,OAAO,EAAE,QAAQ,EAAC,CAAC,CAAC;AAC7C,CAAC"}

package/lib/utils/generalUtils.d.ts

@@ -1 +1,8 @@
+/**
+ * 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.
+ */
 export declare const useTitleFormatter: (title?: string | undefined) => string;
+//# sourceMappingURL=generalUtils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"generalUtils.d.ts","sourceRoot":"","sources":["../../src/utils/generalUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH,eAAO,MAAM,iBAAiB,WAAY,MAAM,GAAG,SAAS,KAAG,MAM9D,CAAC"}

package/lib/utils/generalUtils.js

@@ -6,9 +6,10 @@
  */
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
 export const useTitleFormatter = (title) => {
-    const { siteConfig = {} } = useDocusaurusContext();
-    const { title: siteTitle, titleDelimiter = '|' } = siteConfig;
+    const { siteConfig } = useDocusaurusContext();
+    const { title: siteTitle, titleDelimiter } = siteConfig;
     return title && title.trim().length
         ? `${title.trim()} ${titleDelimiter} ${siteTitle}`
         : siteTitle;
 };
+//# sourceMappingURL=generalUtils.js.map

package/lib/utils/generalUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generalUtils.js","sourceRoot":"","sources":["../../src/utils/generalUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,oBAAoB,MAAM,kCAAkC,CAAC;AAEpE,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,KAA0B,EAAU,EAAE;IACtE,MAAM,EAAC,UAAU,EAAC,GAAG,oBAAoB,EAAE,CAAC;IAC5C,MAAM,EAAC,KAAK,EAAE,SAAS,EAAE,cAAc,EAAC,GAAG,UAAU,CAAC;IACtD,OAAO,KAAK,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM;QACjC,CAAC,CAAC,GAAG,KAAK,CAAC,IAAI,EAAE,IAAI,cAAc,IAAI,SAAS,EAAE;QAClD,CAAC,CAAC,SAAS,CAAC;AAChB,CAAC,CAAC"}

package/lib/utils/historyUtils.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 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 { Location, Action } from 'history';
+declare type HistoryBlockHandler = (location: Location, action: Action) => void | false;
+/**
+ * Permits to register a handler that will be called on history actions (pop,
+ * push, replace) If the handler returns false, the navigation transition will
+ * be blocked/cancelled
+ */
+export declare function useHistoryActionHandler(handler: HistoryBlockHandler): void;
+/**
+ * Permits to register a handler that will be called on history pop navigation
+ * (backward/forward) If the handler returns false, the backward/forward
+ * transition will be blocked. Unfortunately there's no good way to detect the
+ * "direction" (backward/forward) of the POP event.
+ */
+export declare function useHistoryPopHandler(handler: HistoryBlockHandler): void;
+export {};
+//# sourceMappingURL=historyUtils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"historyUtils.d.ts","sourceRoot":"","sources":["../../src/utils/historyUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH,OAAO,KAAK,EAAC,QAAQ,EAAE,MAAM,EAAC,MAAM,SAAS,CAAC;AAE9C,aAAK,mBAAmB,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,KAAK,IAAI,GAAG,KAAK,CAAC;AAEhF;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,mBAAmB,GAAG,IAAI,CAe1E;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,mBAAmB,GAAG,IAAI,CASvE"}

package/lib/utils/historyUtils.js

@@ -0,0 +1,41 @@
+/**
+ * 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 { useEffect, useRef } from 'react';
+import { useHistory } from '@docusaurus/router';
+/**
+ * Permits to register a handler that will be called on history actions (pop,
+ * push, replace) If the handler returns false, the navigation transition will
+ * be blocked/cancelled
+ */
+export function useHistoryActionHandler(handler) {
+    const { block } = useHistory();
+    // Avoid stale closure issues without triggering useless re-renders
+    const lastHandlerRef = useRef(handler);
+    useEffect(() => {
+        lastHandlerRef.current = handler;
+    }, [handler]);
+    useEffect(() => 
+    // See https://github.com/remix-run/history/blob/main/docs/blocking-transitions.md
+    block((location, action) => lastHandlerRef.current(location, action)), [block, lastHandlerRef]);
+}
+/**
+ * Permits to register a handler that will be called on history pop navigation
+ * (backward/forward) If the handler returns false, the backward/forward
+ * transition will be blocked. Unfortunately there's no good way to detect the
+ * "direction" (backward/forward) of the POP event.
+ */
+export function useHistoryPopHandler(handler) {
+    useHistoryActionHandler((location, action) => {
+        if (action === 'POP') {
+            // Eventually block navigation if handler returns false
+            return handler(location, action);
+        }
+        // Don't block other navigation actions
+        return undefined;
+    });
+}
+//# sourceMappingURL=historyUtils.js.map