@docusaurus/theme-common 2.0.0-beta.12faed89d → 2.0.0-beta.14

package/lib/utils/pathUtils.d.ts

@@ -5,3 +5,4 @@
  * LICENSE file in the root directory of this source tree.
  */
 export declare const isSamePath: (path1: string | undefined, path2: string | undefined) => boolean;
+//# sourceMappingURL=pathUtils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pathUtils.d.ts","sourceRoot":"","sources":["../../src/utils/pathUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,eAAO,MAAM,UAAU,UACd,MAAM,GAAG,SAAS,SAClB,MAAM,GAAG,SAAS,KACxB,OAIF,CAAC"}

package/lib/utils/pathUtils.js

@@ -6,8 +6,7 @@
  */
 // Compare the 2 paths, ignoring trailing /
 export const isSamePath = (path1, path2) => {
-    const normalize = (pathname) => {
-        return !pathname || (pathname === null || pathname === void 0 ? void 0 : pathname.endsWith('/')) ? pathname : `${pathname}/`;
-    };
+    const normalize = (pathname) => !pathname || (pathname === null || pathname === void 0 ? void 0 : pathname.endsWith('/')) ? pathname : `${pathname}/`;
     return normalize(path1) === normalize(path2);
 };
+//# sourceMappingURL=pathUtils.js.map

package/lib/utils/pathUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pathUtils.js","sourceRoot":"","sources":["../../src/utils/pathUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,2CAA2C;AAC3C,MAAM,CAAC,MAAM,UAAU,GAAG,CACxB,KAAyB,EACzB,KAAyB,EAChB,EAAE;IACX,MAAM,SAAS,GAAG,CAAC,QAA4B,EAAE,EAAE,CACjD,CAAC,QAAQ,KAAI,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,QAAQ,CAAC,GAAG,CAAC,CAAA,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,QAAQ,GAAG,CAAC;IACnE,OAAO,SAAS,CAAC,KAAK,CAAC,KAAK,SAAS,CAAC,KAAK,CAAC,CAAC;AAC/C,CAAC,CAAC"}

package/lib/utils/reactUtils.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 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 } from 'react';
+export declare const useIsomorphicLayoutEffect: typeof useEffect;
+export declare function useDynamicCallback<T extends (...args: never[]) => unknown>(callback: T): T;
+//# sourceMappingURL=reactUtils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"reactUtils.d.ts","sourceRoot":"","sources":["../../src/utils/reactUtils.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAc,SAAS,EAA0B,MAAM,OAAO,CAAC;AAMtE,eAAO,MAAM,yBAAyB,kBACuB,CAAC;AAQ9D,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,KAAK,EAAE,KAAK,OAAO,EACxE,QAAQ,EAAE,CAAC,GACV,CAAC,CASH"}

package/lib/utils/reactUtils.js

@@ -0,0 +1,27 @@
+/**
+ * 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 { useCallback, useEffect, useLayoutEffect, useRef } from 'react';
+// This hook is like useLayoutEffect, but without the SSR warning
+// It seems hacky but it's used in many React libs (Redux, Formik...)
+// Also mentioned here: https://github.com/facebook/react/issues/16956
+// It is useful when you need to update a ref as soon as possible after a React render (before useEffect)
+export const useIsomorphicLayoutEffect = typeof window !== 'undefined' ? useLayoutEffect : useEffect;
+// Permits to transform an unstable callback (like an arrow function provided as props)
+// to a "stable" callback that is safe to use in a useEffect dependency array
+// Useful to avoid React stale closure problems + avoid useless effect re-executions
+//
+// Workaround until the React team recommends a good solution, see https://github.com/facebook/react/issues/16956
+// This generally works has some potential drawbacks, such as https://github.com/facebook/react/issues/16956#issuecomment-536636418
+export function useDynamicCallback(callback) {
+    const ref = useRef(callback);
+    useIsomorphicLayoutEffect(() => {
+        ref.current = callback;
+    }, [callback]);
+    // @ts-expect-error: TODO, not sure how to fix this TS error
+    return useCallback((...args) => ref.current(...args), []);
+}
+//# sourceMappingURL=reactUtils.js.map

package/lib/utils/reactUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reactUtils.js","sourceRoot":"","sources":["../../src/utils/reactUtils.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAC,WAAW,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,EAAC,MAAM,OAAO,CAAC;AAEtE,iEAAiE;AACjE,qEAAqE;AACrE,sEAAsE;AACtE,yGAAyG;AACzG,MAAM,CAAC,MAAM,yBAAyB,GACpC,OAAO,MAAM,KAAK,WAAW,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC;AAE9D,uFAAuF;AACvF,6EAA6E;AAC7E,oFAAoF;AACpF,EAAE;AACF,iHAAiH;AACjH,mIAAmI;AACnI,MAAM,UAAU,kBAAkB,CAChC,QAAW;IAEX,MAAM,GAAG,GAAG,MAAM,CAAI,QAAQ,CAAC,CAAC;IAEhC,yBAAyB,CAAC,GAAG,EAAE;QAC7B,GAAG,CAAC,OAAO,GAAG,QAAQ,CAAC;IACzB,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEf,4DAA4D;IAC5D,OAAO,WAAW,CAAI,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;AAC/D,CAAC"}

package/lib/utils/regexpUtils.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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.
+ */
+/**
+ * Utility to convert an optional string into a Regex case sensitive and global
+ */
+export declare function isRegexpStringMatch(regexAsString?: string, valueToTest?: string): boolean;
+//# sourceMappingURL=regexpUtils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"regexpUtils.d.ts","sourceRoot":"","sources":["../../src/utils/regexpUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;GAEG;AACH,wBAAgB,mBAAmB,CACjC,aAAa,CAAC,EAAE,MAAM,EACtB,WAAW,CAAC,EAAE,MAAM,GACnB,OAAO,CAST"}

package/lib/utils/regexpUtils.js

@@ -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.
+ */
+/**
+ * Utility to convert an optional string into a Regex case sensitive and global
+ */
+export function isRegexpStringMatch(regexAsString, valueToTest) {
+    if (typeof regexAsString === 'undefined' ||
+        typeof valueToTest === 'undefined') {
+        return false;
+    }
+    return new RegExp(regexAsString, 'gi').test(valueToTest);
+}
+//# sourceMappingURL=regexpUtils.js.map

package/lib/utils/regexpUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"regexpUtils.js","sourceRoot":"","sources":["../../src/utils/regexpUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;GAEG;AACH,MAAM,UAAU,mBAAmB,CACjC,aAAsB,EACtB,WAAoB;IAEpB,IACE,OAAO,aAAa,KAAK,WAAW;QACpC,OAAO,WAAW,KAAK,WAAW,EAClC;QACA,OAAO,KAAK,CAAC;KACd;IAED,OAAO,IAAI,MAAM,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;AAC3D,CAAC"}

package/lib/utils/scrollUtils.d.ts

@@ -0,0 +1,53 @@
+/**
+ * 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, { ReactNode } from 'react';
+/**
+ * We need a way to update the scroll position while ignoring scroll events
+ * without affecting Navbar/BackToTop visibility
+ *
+ * This API permits to temporarily disable/ignore scroll events
+ * Motivated by https://github.com/facebook/docusaurus/pull/5618
+ */
+declare type ScrollController = {
+    /**
+     * A boolean ref tracking whether scroll events are enabled
+     */
+    scrollEventsEnabledRef: React.MutableRefObject<boolean>;
+    /**
+     * Enables scroll events in `useScrollPosition`
+     */
+    enableScrollEvents: () => void;
+    /**
+     * Disables scroll events in `useScrollPosition`
+     */
+    disableScrollEvents: () => void;
+};
+export declare function ScrollControllerProvider({ children, }: {
+    children: ReactNode;
+}): JSX.Element;
+export declare function useScrollController(): ScrollController;
+declare type ScrollPosition = {
+    scrollX: number;
+    scrollY: number;
+};
+export declare function useScrollPosition(effect: (position: ScrollPosition, lastPosition: ScrollPosition | null) => void, deps?: unknown[]): void;
+declare type UseScrollPositionBlockerReturn = {
+    blockElementScrollPositionUntilNextRender: (el: HTMLElement) => void;
+};
+/**
+ * This hook permits to "block" the scroll position of a dom element
+ * The idea is that we should be able to update DOM content above this element
+ * but the screen position of this element should not change
+ *
+ * Feature motivated by the Tabs groups:
+ * clicking on a tab may affect tabs of the same group upper in the tree
+ * Yet to avoid a bad UX, the clicked tab must remain under the user mouse!
+ * See GIF here: https://github.com/facebook/docusaurus/pull/5618
+ */
+export declare function useScrollPositionBlocker(): UseScrollPositionBlockerReturn;
+export {};
+//# sourceMappingURL=scrollUtils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"scrollUtils.d.ts","sourceRoot":"","sources":["../../src/utils/scrollUtils.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,EAEZ,SAAS,EAOV,MAAM,OAAO,CAAC;AAIf;;;;;;GAMG;AACH,aAAK,gBAAgB,GAAG;IACtB;;OAEG;IACH,sBAAsB,EAAE,KAAK,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACxD;;OAEG;IACH,kBAAkB,EAAE,MAAM,IAAI,CAAC;IAC/B;;OAEG;IACH,mBAAmB,EAAE,MAAM,IAAI,CAAC;CACjC,CAAC;AAuBF,wBAAgB,wBAAwB,CAAC,EACvC,QAAQ,GACT,EAAE;IACD,QAAQ,EAAE,SAAS,CAAC;CACrB,GAAG,GAAG,CAAC,OAAO,CAMd;AAED,wBAAgB,mBAAmB,IAAI,gBAAgB,CAQtD;AAUD,aAAK,cAAc,GAAG;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAC,CAAC;AAEzD,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,CACN,QAAQ,EAAE,cAAc,EACxB,YAAY,EAAE,cAAc,GAAG,IAAI,KAChC,IAAI,EACT,IAAI,GAAE,OAAO,EAAO,GACnB,IAAI,CAkCN;AA+CD,aAAK,8BAA8B,GAAG;IACpC,yCAAyC,EAAE,CAAC,EAAE,EAAE,WAAW,KAAK,IAAI,CAAC;CACtE,CAAC;AAEF;;;;;;;;;GASG;AACH,wBAAgB,wBAAwB,IAAI,8BAA8B,CAwCzE"}

package/lib/utils/scrollUtils.js

@@ -0,0 +1,136 @@
+/**
+ * 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, { createContext, useCallback, useContext, useEffect, useLayoutEffect, useMemo, useRef, } from 'react';
+import { useDynamicCallback } from './reactUtils';
+import ExecutionEnvironment from '@docusaurus/ExecutionEnvironment';
+function useScrollControllerContextValue() {
+    const scrollEventsEnabledRef = useRef(true);
+    return useMemo(() => ({
+        scrollEventsEnabledRef,
+        enableScrollEvents: () => {
+            scrollEventsEnabledRef.current = true;
+        },
+        disableScrollEvents: () => {
+            scrollEventsEnabledRef.current = false;
+        },
+    }), []);
+}
+const ScrollMonitorContext = createContext(undefined);
+export function ScrollControllerProvider({ children, }) {
+    return (React.createElement(ScrollMonitorContext.Provider, { value: useScrollControllerContextValue() }, children));
+}
+export function useScrollController() {
+    const context = useContext(ScrollMonitorContext);
+    if (context == null) {
+        throw new Error('"useScrollController" is used but no context provider was found in the React tree.');
+    }
+    return context;
+}
+const getScrollPosition = () => ExecutionEnvironment.canUseDOM
+    ? {
+        scrollX: window.pageXOffset,
+        scrollY: window.pageYOffset,
+    }
+    : null;
+export function useScrollPosition(effect, deps = []) {
+    const { scrollEventsEnabledRef } = useScrollController();
+    const lastPositionRef = useRef(getScrollPosition());
+    const dynamicEffect = useDynamicCallback(effect);
+    useEffect(() => {
+        const handleScroll = () => {
+            if (!scrollEventsEnabledRef.current) {
+                return;
+            }
+            const currentPosition = getScrollPosition();
+            if (dynamicEffect) {
+                dynamicEffect(currentPosition, lastPositionRef.current);
+            }
+            lastPositionRef.current = currentPosition;
+        };
+        const opts = {
+            passive: true,
+        };
+        handleScroll();
+        window.addEventListener('scroll', handleScroll, opts);
+        return () => window.removeEventListener('scroll', handleScroll, opts);
+    }, [
+        dynamicEffect,
+        scrollEventsEnabledRef,
+        // eslint-disable-next-line react-hooks/exhaustive-deps
+        ...deps,
+    ]);
+}
+function useScrollPositionSaver() {
+    const lastElementRef = useRef({
+        elem: null,
+        top: 0,
+    });
+    const save = useCallback((elem) => {
+        lastElementRef.current = {
+            elem,
+            top: elem.getBoundingClientRect().top,
+        };
+    }, []);
+    const restore = useCallback(() => {
+        const { current: { elem, top }, } = lastElementRef;
+        if (!elem) {
+            return { restored: false };
+        }
+        const newTop = elem.getBoundingClientRect().top;
+        const heightDiff = newTop - top;
+        if (heightDiff) {
+            window.scrollBy({ left: 0, top: heightDiff });
+        }
+        lastElementRef.current = { elem: null, top: 0 };
+        return { restored: heightDiff !== 0 };
+    }, []);
+    return useMemo(() => ({ save, restore }), [restore, save]);
+}
+/**
+ * This hook permits to "block" the scroll position of a dom element
+ * The idea is that we should be able to update DOM content above this element
+ * but the screen position of this element should not change
+ *
+ * Feature motivated by the Tabs groups:
+ * clicking on a tab may affect tabs of the same group upper in the tree
+ * Yet to avoid a bad UX, the clicked tab must remain under the user mouse!
+ * See GIF here: https://github.com/facebook/docusaurus/pull/5618
+ */
+export function useScrollPositionBlocker() {
+    const scrollController = useScrollController();
+    const scrollPositionSaver = useScrollPositionSaver();
+    const nextLayoutEffectCallbackRef = useRef(undefined);
+    const blockElementScrollPositionUntilNextRender = useCallback((el) => {
+        scrollPositionSaver.save(el);
+        scrollController.disableScrollEvents();
+        nextLayoutEffectCallbackRef.current = () => {
+            const { restored } = scrollPositionSaver.restore();
+            nextLayoutEffectCallbackRef.current = undefined;
+            // Restoring the former scroll position will trigger a scroll event
+            // We need to wait for next scroll event to happen
+            // before enabling again the scrollController events
+            if (restored) {
+                const handleScrollRestoreEvent = () => {
+                    scrollController.enableScrollEvents();
+                    window.removeEventListener('scroll', handleScrollRestoreEvent);
+                };
+                window.addEventListener('scroll', handleScrollRestoreEvent);
+            }
+            else {
+                scrollController.enableScrollEvents();
+            }
+        };
+    }, [scrollController, scrollPositionSaver]);
+    useLayoutEffect(() => {
+        var _a;
+        (_a = nextLayoutEffectCallbackRef.current) === null || _a === void 0 ? void 0 : _a.call(nextLayoutEffectCallbackRef);
+    });
+    return {
+        blockElementScrollPositionUntilNextRender,
+    };
+}
+//# sourceMappingURL=scrollUtils.js.map

package/lib/utils/scrollUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scrollUtils.js","sourceRoot":"","sources":["../../src/utils/scrollUtils.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,EACZ,aAAa,EAEb,WAAW,EACX,UAAU,EACV,SAAS,EACT,eAAe,EACf,OAAO,EACP,MAAM,GACP,MAAM,OAAO,CAAC;AACf,OAAO,EAAC,kBAAkB,EAAC,MAAM,cAAc,CAAC;AAChD,OAAO,oBAAoB,MAAM,kCAAkC,CAAC;AAwBpE,SAAS,+BAA+B;IACtC,MAAM,sBAAsB,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;IAE5C,OAAO,OAAO,CACZ,GAAG,EAAE,CAAC,CAAC;QACL,sBAAsB;QACtB,kBAAkB,EAAE,GAAG,EAAE;YACvB,sBAAsB,CAAC,OAAO,GAAG,IAAI,CAAC;QACxC,CAAC;QACD,mBAAmB,EAAE,GAAG,EAAE;YACxB,sBAAsB,CAAC,OAAO,GAAG,KAAK,CAAC;QACzC,CAAC;KACF,CAAC,EACF,EAAE,CACH,CAAC;AACJ,CAAC;AAED,MAAM,oBAAoB,GAAG,aAAa,CACxC,SAAS,CACV,CAAC;AAEF,MAAM,UAAU,wBAAwB,CAAC,EACvC,QAAQ,GAGT;IACC,OAAO,CACL,oBAAC,oBAAoB,CAAC,QAAQ,IAAC,KAAK,EAAE,+BAA+B,EAAE,IACpE,QAAQ,CACqB,CACjC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,mBAAmB;IACjC,MAAM,OAAO,GAAG,UAAU,CAAC,oBAAoB,CAAC,CAAC;IACjD,IAAI,OAAO,IAAI,IAAI,EAAE;QACnB,MAAM,IAAI,KAAK,CACb,oFAAoF,CACrF,CAAC;KACH;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,MAAM,iBAAiB,GAAG,GAA0B,EAAE,CACpD,oBAAoB,CAAC,SAAS;IAC5B,CAAC,CAAC;QACE,OAAO,EAAE,MAAM,CAAC,WAAW;QAC3B,OAAO,EAAE,MAAM,CAAC,WAAW;KAC5B;IACH,CAAC,CAAC,IAAI,CAAC;AAIX,MAAM,UAAU,iBAAiB,CAC/B,MAGS,EACT,OAAkB,EAAE;IAEpB,MAAM,EAAC,sBAAsB,EAAC,GAAG,mBAAmB,EAAE,CAAC;IACvD,MAAM,eAAe,GAAG,MAAM,CAAwB,iBAAiB,EAAE,CAAC,CAAC;IAE3E,MAAM,aAAa,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;IAEjD,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,YAAY,GAAG,GAAG,EAAE;YACxB,IAAI,CAAC,sBAAsB,CAAC,OAAO,EAAE;gBACnC,OAAO;aACR;YACD,MAAM,eAAe,GAAG,iBAAiB,EAAG,CAAC;YAE7C,IAAI,aAAa,EAAE;gBACjB,aAAa,CAAC,eAAe,EAAE,eAAe,CAAC,OAAO,CAAC,CAAC;aACzD;YAED,eAAe,CAAC,OAAO,GAAG,eAAe,CAAC;QAC5C,CAAC,CAAC;QAEF,MAAM,IAAI,GAAmD;YAC3D,OAAO,EAAE,IAAI;SACd,CAAC;QAEF,YAAY,EAAE,CAAC;QACf,MAAM,CAAC,gBAAgB,CAAC,QAAQ,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC;QAEtD,OAAO,GAAG,EAAE,CAAC,MAAM,CAAC,mBAAmB,CAAC,QAAQ,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC;IACxE,CAAC,EAAE;QACD,aAAa;QACb,sBAAsB;QACtB,uDAAuD;QACvD,GAAG,IAAI;KACR,CAAC,CAAC;AACL,CAAC;AAcD,SAAS,sBAAsB;IAC7B,MAAM,cAAc,GAAG,MAAM,CAA0C;QACrE,IAAI,EAAE,IAAI;QACV,GAAG,EAAE,CAAC;KACP,CAAC,CAAC;IAEH,MAAM,IAAI,GAAG,WAAW,CAAC,CAAC,IAAiB,EAAE,EAAE;QAC7C,cAAc,CAAC,OAAO,GAAG;YACvB,IAAI;YACJ,GAAG,EAAE,IAAI,CAAC,qBAAqB,EAAE,CAAC,GAAG;SACtC,CAAC;IACJ,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,MAAM,OAAO,GAAG,WAAW,CAAC,GAAG,EAAE;QAC/B,MAAM,EACJ,OAAO,EAAE,EAAC,IAAI,EAAE,GAAG,EAAC,GACrB,GAAG,cAAc,CAAC;QACnB,IAAI,CAAC,IAAI,EAAE;YACT,OAAO,EAAC,QAAQ,EAAE,KAAK,EAAC,CAAC;SAC1B;QACD,MAAM,MAAM,GAAG,IAAI,CAAC,qBAAqB,EAAE,CAAC,GAAG,CAAC;QAChD,MAAM,UAAU,GAAG,MAAM,GAAG,GAAG,CAAC;QAChC,IAAI,UAAU,EAAE;YACd,MAAM,CAAC,QAAQ,CAAC,EAAC,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,UAAU,EAAC,CAAC,CAAC;SAC7C;QACD,cAAc,CAAC,OAAO,GAAG,EAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,EAAC,CAAC;QAE9C,OAAO,EAAC,QAAQ,EAAE,UAAU,KAAK,CAAC,EAAC,CAAC;IACtC,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,EAAC,IAAI,EAAE,OAAO,EAAC,CAAC,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC;AAC3D,CAAC;AAMD;;;;;;;;;GASG;AACH,MAAM,UAAU,wBAAwB;IACtC,MAAM,gBAAgB,GAAG,mBAAmB,EAAE,CAAC;IAC/C,MAAM,mBAAmB,GAAG,sBAAsB,EAAE,CAAC;IAErD,MAAM,2BAA2B,GAAG,MAAM,CACxC,SAAS,CACV,CAAC;IAEF,MAAM,yCAAyC,GAAG,WAAW,CAC3D,CAAC,EAAe,EAAE,EAAE;QAClB,mBAAmB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC7B,gBAAgB,CAAC,mBAAmB,EAAE,CAAC;QACvC,2BAA2B,CAAC,OAAO,GAAG,GAAG,EAAE;YACzC,MAAM,EAAC,QAAQ,EAAC,GAAG,mBAAmB,CAAC,OAAO,EAAE,CAAC;YACjD,2BAA2B,CAAC,OAAO,GAAG,SAAS,CAAC;YAEhD,mEAAmE;YACnE,kDAAkD;YAClD,oDAAoD;YACpD,IAAI,QAAQ,EAAE;gBACZ,MAAM,wBAAwB,GAAG,GAAG,EAAE;oBACpC,gBAAgB,CAAC,kBAAkB,EAAE,CAAC;oBACtC,MAAM,CAAC,mBAAmB,CAAC,QAAQ,EAAE,wBAAwB,CAAC,CAAC;gBACjE,CAAC,CAAC;gBACF,MAAM,CAAC,gBAAgB,CAAC,QAAQ,EAAE,wBAAwB,CAAC,CAAC;aAC7D;iBAAM;gBACL,gBAAgB,CAAC,kBAAkB,EAAE,CAAC;aACvC;QACH,CAAC,CAAC;IACJ,CAAC,EACD,CAAC,gBAAgB,EAAE,mBAAmB,CAAC,CACxC,CAAC;IAEF,eAAe,CAAC,GAAG,EAAE;;QACnB,MAAA,2BAA2B,CAAC,OAAO,+CAAnC,2BAA2B,CAAY,CAAC;IAC1C,CAAC,CAAC,CAAC;IAEH,OAAO;QACL,yCAAyC;KAC1C,CAAC;AACJ,CAAC"}

package/lib/utils/searchUtils.d.ts

@@ -6,3 +6,4 @@
  */
 export declare const DEFAULT_SEARCH_TAG = "default";
 export declare function docVersionSearchTag(pluginId: string, versionName: string): string;
+//# sourceMappingURL=searchUtils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"searchUtils.d.ts","sourceRoot":"","sources":["../../src/utils/searchUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,kBAAkB,YAAY,CAAC;AAE5C,wBAAgB,mBAAmB,CACjC,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,MAAM,GAClB,MAAM,CAER"}

package/lib/utils/searchUtils.js

@@ -8,3 +8,4 @@ export const DEFAULT_SEARCH_TAG = 'default';
 export function docVersionSearchTag(pluginId, versionName) {
     return `docs-${pluginId}-${versionName}`;
 }
+//# sourceMappingURL=searchUtils.js.map

package/lib/utils/searchUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"searchUtils.js","sourceRoot":"","sources":["../../src/utils/searchUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,kBAAkB,GAAG,SAAS,CAAC;AAE5C,MAAM,UAAU,mBAAmB,CACjC,QAAgB,EAChB,WAAmB;IAEnB,OAAO,QAAQ,QAAQ,IAAI,WAAW,EAAE,CAAC;AAC3C,CAAC"}

package/lib/utils/storageUtils.d.ts

@@ -13,6 +13,10 @@ export interface StorageSlot {
 }
 /**
  * Creates an object for accessing a particular key in localStorage.
+ * The API is fail-safe, and usage of browser storage should be considered unreliable
+ * Local storage might simply be unavailable (iframe + browser security) or operations might fail individually
+ * Please assume that using this API can be a NO-OP
+ * See also https://github.com/facebook/docusaurus/issues/6036
  */
 export declare const createStorageSlot: (key: string, options?: {
     persistence?: "localStorage" | "none" | "sessionStorage" | undefined;
@@ -23,3 +27,4 @@ export declare const createStorageSlot: (key: string, options?: {
  */
 export declare function listStorageKeys(storageType?: StorageType): string[];
 export {};
+//# sourceMappingURL=storageUtils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"storageUtils.d.ts","sourceRoot":"","sources":["../../src/utils/storageUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,QAAA,MAAM,YAAY,qDAAsD,CAAC;AAEzE,oBAAY,WAAW,GAAG,OAAO,YAAY,CAAC,MAAM,CAAC,CAAC;AA2CtD,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,MAAM,GAAG,IAAI,CAAC;IACzB,GAAG,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAC7B,GAAG,EAAE,MAAM,IAAI,CAAC;CACjB;AAuBD;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,QACvB,MAAM;;kBAEV,WAgCF,CAAC;AAEF;;;GAGG;AACH,wBAAgB,eAAe,CAC7B,WAAW,GAAE,WAAgC,GAC5C,MAAM,EAAE,CAcV"}

package/lib/utils/storageUtils.js

@@ -57,6 +57,10 @@ Please only call storage APIs in effects and event handlers.`);
 }
 /**
  * Creates an object for accessing a particular key in localStorage.
+ * The API is fail-safe, and usage of browser storage should be considered unreliable
+ * Local storage might simply be unavailable (iframe + browser security) or operations might fail individually
+ * Please assume that using this API can be a NO-OP
+ * See also https://github.com/facebook/docusaurus/issues/6036
  */
 export const createStorageSlot = (key, options) => {
     if (typeof window === 'undefined') {
@@ -67,9 +71,31 @@ export const createStorageSlot = (key, options) => {
         return NoopStorageSlot;
     }
     return {
-        get: () => browserStorage.getItem(key),
-        set: (value) => browserStorage.setItem(key, value),
-        del: () => browserStorage.removeItem(key),
+        get: () => {
+            try {
+                return browserStorage.getItem(key);
+            }
+            catch (e) {
+                console.error(`Docusaurus storage error, can't get key=${key}`, e);
+                return null;
+            }
+        },
+        set: (value) => {
+            try {
+                browserStorage.setItem(key, value);
+            }
+            catch (e) {
+                console.error(`Docusaurus storage error, can't set ${key}=${value}`, e);
+            }
+        },
+        del: () => {
+            try {
+                browserStorage.removeItem(key);
+            }
+            catch (e) {
+                console.error(`Docusaurus storage error, can't delete key=${key}`, e);
+            }
+        },
     };
 };
 /**
@@ -90,3 +116,4 @@ export function listStorageKeys(storageType = DefaultStorageType) {
     }
     return keys;
 }
+//# sourceMappingURL=storageUtils.js.map

package/lib/utils/storageUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"storageUtils.js","sourceRoot":"","sources":["../../src/utils/storageUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,YAAY,GAAG,CAAC,cAAc,EAAE,gBAAgB,EAAE,MAAM,CAAU,CAAC;AAIzE,MAAM,kBAAkB,GAAgB,cAAc,CAAC;AAEvD,sFAAsF;AACtF,uDAAuD;AACvD,SAAS,iBAAiB,CACxB,cAA2B,kBAAkB;IAE7C,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE;QACjC,MAAM,IAAI,KAAK,CACb,qEAAqE,CACtE,CAAC;KACH;IACD,IAAI,WAAW,KAAK,MAAM,EAAE;QAC1B,OAAO,IAAI,CAAC;KACb;SAAM;QACL,IAAI;YACF,OAAO,MAAM,CAAC,WAAW,CAAC,CAAC;SAC5B;QAAC,OAAO,CAAC,EAAE;YACV,wCAAwC,CAAC,CAAU,CAAC,CAAC;YACrD,OAAO,IAAI,CAAC;SACb;KACF;AACH,CAAC;AAED;;;GAGG;AACH,IAAI,0CAA0C,GAAG,KAAK,CAAC;AACvD,SAAS,wCAAwC,CAAC,KAAY;IAC5D,IAAI,CAAC,0CAA0C,EAAE;QAC/C,OAAO,CAAC,IAAI,CACV;kIAC4H,EAC5H,KAAK,CACN,CAAC;QACF,0CAA0C,GAAG,IAAI,CAAC;KACnD;AACH,CAAC;AASD,MAAM,eAAe,GAAgB;IACnC,GAAG,EAAE,GAAG,EAAE,CAAC,IAAI;IACf,GAAG,EAAE,GAAG,EAAE,GAAE,CAAC;IACb,GAAG,EAAE,GAAG,EAAE,GAAE,CAAC;CACd,CAAC;AAEF,wEAAwE;AACxE,SAAS,uBAAuB,CAAC,GAAW;IAC1C,SAAS,UAAU;QACjB,MAAM,IAAI,KAAK,CAAC,8CAA8C,GAAG;;6DAER,CAAC,CAAC;IAC7D,CAAC;IAED,OAAO;QACL,GAAG,EAAE,UAAU;QACf,GAAG,EAAE,UAAU;QACf,GAAG,EAAE,UAAU;KAChB,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAC/B,GAAW,EACX,OAAqC,EACxB,EAAE;IACf,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE;QACjC,OAAO,uBAAuB,CAAC,GAAG,CAAC,CAAC;KACrC;IACD,MAAM,cAAc,GAAG,iBAAiB,CAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,WAAW,CAAC,CAAC;IAC/D,IAAI,cAAc,KAAK,IAAI,EAAE;QAC3B,OAAO,eAAe,CAAC;KACxB;IACD,OAAO;QACL,GAAG,EAAE,GAAG,EAAE;YACR,IAAI;gBACF,OAAO,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;aACpC;YAAC,OAAO,CAAC,EAAE;gBACV,OAAO,CAAC,KAAK,CAAC,2CAA2C,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC;gBACnE,OAAO,IAAI,CAAC;aACb;QACH,CAAC;QACD,GAAG,EAAE,CAAC,KAAK,EAAE,EAAE;YACb,IAAI;gBACF,cAAc,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;aACpC;YAAC,OAAO,CAAC,EAAE;gBACV,OAAO,CAAC,KAAK,CAAC,uCAAuC,GAAG,IAAI,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC;aACzE;QACH,CAAC;QACD,GAAG,EAAE,GAAG,EAAE;YACR,IAAI;gBACF,cAAc,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;aAChC;YAAC,OAAO,CAAC,EAAE;gBACV,OAAO,CAAC,KAAK,CAAC,8CAA8C,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC;aACvE;QACH,CAAC;KACF,CAAC;AACJ,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,UAAU,eAAe,CAC7B,cAA2B,kBAAkB;IAE7C,MAAM,cAAc,GAAG,iBAAiB,CAAC,WAAW,CAAC,CAAC;IACtD,IAAI,CAAC,cAAc,EAAE;QACnB,OAAO,EAAE,CAAC;KACX;IAED,MAAM,IAAI,GAAa,EAAE,CAAC;IAC1B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,cAAc,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE;QACjD,MAAM,GAAG,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAClC,IAAI,GAAG,KAAK,IAAI,EAAE;YAChB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SAChB;KACF;IACD,OAAO,IAAI,CAAC;AACd,CAAC"}

package/lib/utils/tagsUtils.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 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 translateTagsPageTitle: () => string;
+declare type TagsListItem = Readonly<{
+    name: string;
+    permalink: string;
+    count: number;
+}>;
+export declare type TagLetterEntry = Readonly<{
+    letter: string;
+    tags: TagsListItem[];
+}>;
+export declare function listTagsByLetters(tags: readonly TagsListItem[]): TagLetterEntry[];
+export {};
+//# sourceMappingURL=tagsUtils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"tagsUtils.d.ts","sourceRoot":"","sources":["../../src/utils/tagsUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH,eAAO,MAAM,sBAAsB,QAAO,MAKtC,CAAC;AAEL,aAAK,YAAY,GAAG,QAAQ,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAC,CAAC,CAAC;AAE/E,oBAAY,cAAc,GAAG,QAAQ,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,YAAY,EAAE,CAAA;CAAC,CAAC,CAAC;AAM9E,wBAAgB,iBAAiB,CAC/B,IAAI,EAAE,SAAS,YAAY,EAAE,GAC5B,cAAc,EAAE,CAqBlB"}

package/lib/utils/tagsUtils.js

@@ -0,0 +1,34 @@
+/**
+ * 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 { translate } from '@docusaurus/Translate';
+export const translateTagsPageTitle = () => translate({
+    id: 'theme.tags.tagsPageTitle',
+    message: 'Tags',
+    description: 'The title of the tag list page',
+});
+function getTagLetter(tag) {
+    return tag[0].toUpperCase();
+}
+export function listTagsByLetters(tags) {
+    // Group by letters
+    const groups = {};
+    Object.values(tags).forEach((tag) => {
+        var _a;
+        const letter = getTagLetter(tag.name);
+        groups[letter] = (_a = groups[letter]) !== null && _a !== void 0 ? _a : [];
+        groups[letter].push(tag);
+    });
+    return (Object.entries(groups)
+        // Sort letters
+        .sort(([letter1], [letter2]) => letter1.localeCompare(letter2))
+        .map(([letter, letterTags]) => {
+        // Sort tags inside a letter
+        const sortedTags = letterTags.sort((tag1, tag2) => tag1.name.localeCompare(tag2.name));
+        return { letter, tags: sortedTags };
+    }));
+}
+//# sourceMappingURL=tagsUtils.js.map

package/lib/utils/tagsUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tagsUtils.js","sourceRoot":"","sources":["../../src/utils/tagsUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAC,SAAS,EAAC,MAAM,uBAAuB,CAAC;AAEhD,MAAM,CAAC,MAAM,sBAAsB,GAAG,GAAW,EAAE,CACjD,SAAS,CAAC;IACR,EAAE,EAAE,0BAA0B;IAC9B,OAAO,EAAE,MAAM;IACf,WAAW,EAAE,gCAAgC;CAC9C,CAAC,CAAC;AAML,SAAS,YAAY,CAAC,GAAW;IAC/B,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;AAC9B,CAAC;AAED,MAAM,UAAU,iBAAiB,CAC/B,IAA6B;IAE7B,mBAAmB;IACnB,MAAM,MAAM,GAAmC,EAAE,CAAC;IAClD,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;;QAClC,MAAM,MAAM,GAAG,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACtC,MAAM,CAAC,MAAM,CAAC,GAAG,MAAA,MAAM,CAAC,MAAM,CAAC,mCAAI,EAAE,CAAC;QACtC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC3B,CAAC,CAAC,CAAC;IAEH,OAAO,CACL,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC;QACpB,eAAe;SACd,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;SAC9D,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,UAAU,CAAC,EAAE,EAAE;QAC5B,4BAA4B;QAC5B,MAAM,UAAU,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,CAChD,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CACnC,CAAC;QACF,OAAO,EAAC,MAAM,EAAE,IAAI,EAAE,UAAU,EAAC,CAAC;IACpC,CAAC,CAAC,CACL,CAAC;AACJ,CAAC"}

package/lib/utils/tocUtils.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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 { TOCItem } from '@docusaurus/types';
+declare type FilterTOCParam = {
+    toc: readonly TOCItem[];
+    minHeadingLevel: number;
+    maxHeadingLevel: number;
+};
+export declare function filterTOC({ toc, minHeadingLevel, maxHeadingLevel, }: FilterTOCParam): TOCItem[];
+export declare function useTOCFilter({ toc, minHeadingLevel, maxHeadingLevel, }: FilterTOCParam): readonly TOCItem[];
+export {};
+//# sourceMappingURL=tocUtils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"tocUtils.d.ts","sourceRoot":"","sources":["../../src/utils/tocUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAC,OAAO,EAAC,MAAM,mBAAmB,CAAC;AAE1C,aAAK,cAAc,GAAG;IACpB,GAAG,EAAE,SAAS,OAAO,EAAE,CAAC;IACxB,eAAe,EAAE,MAAM,CAAC;IACxB,eAAe,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,wBAAgB,SAAS,CAAC,EACxB,GAAG,EACH,eAAe,EACf,eAAe,GAChB,EAAE,cAAc,GAAG,OAAO,EAAE,CAsB5B;AAGD,wBAAgB,YAAY,CAAC,EAC3B,GAAG,EACH,eAAe,EACf,eAAe,GAChB,EAAE,cAAc,GAAG,SAAS,OAAO,EAAE,CAKrC"}

package/lib/utils/tocUtils.js

@@ -0,0 +1,35 @@
+/**
+ * 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';
+export function filterTOC({ toc, minHeadingLevel, maxHeadingLevel, }) {
+    function isValid(item) {
+        return item.level >= minHeadingLevel && item.level <= maxHeadingLevel;
+    }
+    return toc.flatMap((item) => {
+        const filteredChildren = filterTOC({
+            toc: item.children,
+            minHeadingLevel,
+            maxHeadingLevel,
+        });
+        if (isValid(item)) {
+            return [
+                {
+                    ...item,
+                    children: filteredChildren,
+                },
+            ];
+        }
+        else {
+            return filteredChildren;
+        }
+    });
+}
+// Memoize potentially expensive filtering logic
+export function useTOCFilter({ toc, minHeadingLevel, maxHeadingLevel, }) {
+    return useMemo(() => filterTOC({ toc, minHeadingLevel, maxHeadingLevel }), [toc, minHeadingLevel, maxHeadingLevel]);
+}
+//# sourceMappingURL=tocUtils.js.map

package/lib/utils/tocUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tocUtils.js","sourceRoot":"","sources":["../../src/utils/tocUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAC,OAAO,EAAC,MAAM,OAAO,CAAC;AAS9B,MAAM,UAAU,SAAS,CAAC,EACxB,GAAG,EACH,eAAe,EACf,eAAe,GACA;IACf,SAAS,OAAO,CAAC,IAAa;QAC5B,OAAO,IAAI,CAAC,KAAK,IAAI,eAAe,IAAI,IAAI,CAAC,KAAK,IAAI,eAAe,CAAC;IACxE,CAAC;IAED,OAAO,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QAC1B,MAAM,gBAAgB,GAAG,SAAS,CAAC;YACjC,GAAG,EAAE,IAAI,CAAC,QAAQ;YAClB,eAAe;YACf,eAAe;SAChB,CAAC,CAAC;QACH,IAAI,OAAO,CAAC,IAAI,CAAC,EAAE;YACjB,OAAO;gBACL;oBACE,GAAG,IAAI;oBACP,QAAQ,EAAE,gBAAgB;iBAC3B;aACF,CAAC;SACH;aAAM;YACL,OAAO,gBAAgB,CAAC;SACzB;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAED,gDAAgD;AAChD,MAAM,UAAU,YAAY,CAAC,EAC3B,GAAG,EACH,eAAe,EACf,eAAe,GACA;IACf,OAAO,OAAO,CACZ,GAAG,EAAE,CAAC,SAAS,CAAC,EAAC,GAAG,EAAE,eAAe,EAAE,eAAe,EAAC,CAAC,EACxD,CAAC,GAAG,EAAE,eAAe,EAAE,eAAe,CAAC,CACxC,CAAC;AACJ,CAAC"}

package/lib/utils/useAlternatePageUtils.d.ts

@@ -10,3 +10,4 @@ export declare function useAlternatePageUtils(): {
         fullyQualified: boolean;
     }) => string;
 };
+//# sourceMappingURL=useAlternatePageUtils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useAlternatePageUtils.d.ts","sourceRoot":"","sources":["../../src/utils/useAlternatePageUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAQH,wBAAgB,qBAAqB,IAAI;IACvC,SAAS,EAAE,CAAC,EACV,MAAM,EACN,cAAc,GACf,EAAE;QACD,MAAM,EAAE,MAAM,CAAC;QACf,cAAc,EAAE,OAAO,CAAC;KACzB,KAAK,MAAM,CAAC;CACd,CAoCA"}

package/lib/utils/useAlternatePageUtils.js

@@ -27,3 +27,4 @@ export function useAlternatePageUtils() {
     }
     return { createUrl };
 }
+//# sourceMappingURL=useAlternatePageUtils.js.map

package/lib/utils/useAlternatePageUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useAlternatePageUtils.js","sourceRoot":"","sources":["../../src/utils/useAlternatePageUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,oBAAoB,MAAM,kCAAkC,CAAC;AACpE,OAAO,EAAC,WAAW,EAAC,MAAM,oBAAoB,CAAC;AAE/C,kEAAkE;AAClE,kDAAkD;AAClD,qFAAqF;AACrF,MAAM,UAAU,qBAAqB;IASnC,MAAM,EACJ,UAAU,EAAE,EAAC,OAAO,EAAE,GAAG,EAAC,EAC1B,IAAI,EAAE,EAAC,aAAa,EAAE,aAAa,EAAC,GACrC,GAAG,oBAAoB,EAAE,CAAC;IAC3B,MAAM,EAAC,QAAQ,EAAC,GAAG,WAAW,EAAE,CAAC;IAEjC,MAAM,kBAAkB,GACtB,aAAa,KAAK,aAAa;QAC7B,CAAC,CAAC,OAAO;QACT,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,aAAa,GAAG,EAAE,GAAG,CAAC,CAAC;IAEjD,MAAM,cAAc,GAAG,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IAErD,SAAS,mBAAmB,CAAC,MAAc;QACzC,OAAO,MAAM,KAAK,aAAa;YAC7B,CAAC,CAAC,GAAG,kBAAkB,EAAE;YACzB,CAAC,CAAC,GAAG,kBAAkB,GAAG,MAAM,GAAG,CAAC;IACxC,CAAC;IAED,uFAAuF;IACvF,SAAS,SAAS,CAAC,EACjB,MAAM,EACN,cAAc,GAMf;QACC,OAAO,GAAG,cAAc,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,mBAAmB,CACvD,MAAM,CACP,GAAG,cAAc,EAAE,CAAC;IACvB,CAAC;IAED,OAAO,EAAC,SAAS,EAAC,CAAC;AACrB,CAAC"}

package/lib/utils/useContextualSearchFilters.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 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 type useContextualSearchFiltersReturns = {
+    locale: string;
+    tags: string[];
+};
+export declare function useContextualSearchFilters(): useContextualSearchFiltersReturns;
+//# sourceMappingURL=useContextualSearchFilters.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useContextualSearchFilters.d.ts","sourceRoot":"","sources":["../../src/utils/useContextualSearchFilters.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAOH,oBAAY,iCAAiC,GAAG;IAC9C,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB,CAAC;AAIF,wBAAgB,0BAA0B,IAAI,iCAAiC,CA8B9E"}

package/lib/utils/useContextualSearchFilters.js

@@ -0,0 +1,37 @@
+/**
+ * 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 { useAllDocsData, useActivePluginAndVersion } from '@theme/hooks/useDocs';
+import { useDocsPreferredVersionByPluginId } from './docsPreferredVersion/useDocsPreferredVersion';
+import { docVersionSearchTag, DEFAULT_SEARCH_TAG } from './searchUtils';
+import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
+// We may want to support multiple search engines, don't couple that to Algolia/DocSearch
+// Maybe users will want to use its own search engine solution
+export function useContextualSearchFilters() {
+    const { i18n } = useDocusaurusContext();
+    const allDocsData = useAllDocsData();
+    const activePluginAndVersion = useActivePluginAndVersion();
+    const docsPreferredVersionByPluginId = useDocsPreferredVersionByPluginId();
+    function getDocPluginTags(pluginId) {
+        var _a, _b;
+        const activeVersion = ((_a = activePluginAndVersion === null || activePluginAndVersion === void 0 ? void 0 : activePluginAndVersion.activePlugin) === null || _a === void 0 ? void 0 : _a.pluginId) === pluginId
+            ? activePluginAndVersion.activeVersion
+            : undefined;
+        const preferredVersion = docsPreferredVersionByPluginId[pluginId];
+        const latestVersion = allDocsData[pluginId].versions.find((v) => v.isLast);
+        const version = (_b = activeVersion !== null && activeVersion !== void 0 ? activeVersion : preferredVersion) !== null && _b !== void 0 ? _b : latestVersion;
+        return docVersionSearchTag(pluginId, version.name);
+    }
+    const tags = [
+        DEFAULT_SEARCH_TAG,
+        ...Object.keys(allDocsData).map(getDocPluginTags),
+    ];
+    return {
+        locale: i18n.currentLocale,
+        tags,
+    };
+}
+//# sourceMappingURL=useContextualSearchFilters.js.map

package/lib/utils/useContextualSearchFilters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useContextualSearchFilters.js","sourceRoot":"","sources":["../../src/utils/useContextualSearchFilters.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAC,cAAc,EAAE,yBAAyB,EAAC,MAAM,sBAAsB,CAAC;AAC/E,OAAO,EAAC,iCAAiC,EAAC,MAAM,gDAAgD,CAAC;AACjG,OAAO,EAAC,mBAAmB,EAAE,kBAAkB,EAAC,MAAM,eAAe,CAAC;AACtE,OAAO,oBAAoB,MAAM,kCAAkC,CAAC;AAOpE,yFAAyF;AACzF,8DAA8D;AAC9D,MAAM,UAAU,0BAA0B;IACxC,MAAM,EAAC,IAAI,EAAC,GAAG,oBAAoB,EAAE,CAAC;IACtC,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IACrC,MAAM,sBAAsB,GAAG,yBAAyB,EAAE,CAAC;IAC3D,MAAM,8BAA8B,GAAG,iCAAiC,EAAE,CAAC;IAE3E,SAAS,gBAAgB,CAAC,QAAgB;;QACxC,MAAM,aAAa,GACjB,CAAA,MAAA,sBAAsB,aAAtB,sBAAsB,uBAAtB,sBAAsB,CAAE,YAAY,0CAAE,QAAQ,MAAK,QAAQ;YACzD,CAAC,CAAC,sBAAsB,CAAC,aAAa;YACtC,CAAC,CAAC,SAAS,CAAC;QAEhB,MAAM,gBAAgB,GAAG,8BAA8B,CAAC,QAAQ,CAAC,CAAC;QAElE,MAAM,aAAa,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAE,CAAC;QAE5E,MAAM,OAAO,GAAG,MAAA,aAAa,aAAb,aAAa,cAAb,aAAa,GAAI,gBAAgB,mCAAI,aAAa,CAAC;QAEnE,OAAO,mBAAmB,CAAC,QAAQ,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IACrD,CAAC;IAED,MAAM,IAAI,GAAG;QACX,kBAAkB;QAClB,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,gBAAgB,CAAC;KAClD,CAAC;IAEF,OAAO;QACL,MAAM,EAAE,IAAI,CAAC,aAAa;QAC1B,IAAI;KACL,CAAC;AACJ,CAAC"}