@docusaurus/theme-common 2.0.0-beta.1 → 2.0.0-beta.10

package/lib/utils/docsUtils.js

@@ -4,6 +4,112 @@
  * 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, useContext } from 'react';
 import { useAllDocsData } from '@theme/hooks/useDocs';
+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 can have 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) {
+    // eslint-disable-next-line no-restricted-syntax
+    for (const item of sidebar) {
+        if (item.type === 'category') {
+            if (predicate(item)) {
+                return item;
+            }
+            else {
+                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;
+    }
+    // eslint-disable-next-line no-restricted-syntax
+    for (const subItem of item.items) {
+        if (subItem.type === 'link') {
+            return subItem.href;
+        }
+        if (subItem.type === 'category') {
+            const categoryLink = findFirstCategoryLink(subItem);
+            if (categoryLink) {
+                return categoryLink;
+            }
+        }
+        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;
+}

package/lib/utils/generalUtils.d.ts

@@ -1 +1,7 @@
+/**
+ * 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;

package/lib/utils/generalUtils.js

@@ -6,8 +6,8 @@
  */
 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;

package/lib/utils/historyUtils.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.
+ */
+import type { Location, Action } from '@docusaurus/history';
+declare type HistoryBlockHandler = (location: Location, action: Action) => void | false;
+export declare function useHistoryActionHandler(handler: HistoryBlockHandler): void;
+export declare function useHistoryPopHandler(handler: HistoryBlockHandler): void;
+export {};

package/lib/utils/historyUtils.js

@@ -0,0 +1,39 @@
+/**
+ * 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;
+    });
+}

package/lib/utils/jsUtils.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.
+ */
+/**
+ * Gets the duplicate values in an array.
+ * @param arr The array.
+ * @param comparator Compares two values and returns `true` if they are equal (duplicated).
+ * @returns Value of the elements `v` that have a preceding element `u` where `comparator(u, v) === true`. Values within the returned array are not guaranteed to be unique.
+ */
+export declare function duplicates<T>(arr: readonly T[], comparator?: (a: T, b: T) => boolean): T[];
+/**
+ * Remove duplicate array items (similar to _.uniq)
+ * @param arr The array.
+ * @returns An array with duplicate elements removed by reference comparison.
+ */
+export declare function uniq<T>(arr: T[]): T[];

package/lib/utils/jsUtils.js

@@ -0,0 +1,25 @@
+/**
+ * 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.
+ */
+// A replacement of lodash in client code
+/**
+ * Gets the duplicate values in an array.
+ * @param arr The array.
+ * @param comparator Compares two values and returns `true` if they are equal (duplicated).
+ * @returns Value of the elements `v` that have a preceding element `u` where `comparator(u, v) === true`. Values within the returned array are not guaranteed to be unique.
+ */
+export function duplicates(arr, comparator = (a, b) => a === b) {
+    return arr.filter((v, vIndex) => arr.findIndex((u) => comparator(u, v)) !== vIndex);
+}
+/**
+ * Remove duplicate array items (similar to _.uniq)
+ * @param arr The array.
+ * @returns An array with duplicate elements removed by reference comparison.
+ */
+export function uniq(arr) {
+    // Note: had problems with [...new Set()]: https://github.com/facebook/docusaurus/issues/4972#issuecomment-863895061
+    return Array.from(new Set(arr));
+}

package/lib/utils/mobileSecondaryMenu.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 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 { ReactNode, ComponentType } from 'react';
+declare type ExtraProps = {
+    toggleSidebar: () => void;
+};
+export declare type MobileSecondaryMenuComponent<Props> = ComponentType<Props & ExtraProps>;
+export declare function MobileSecondaryMenuProvider({ children, }: {
+    children: ReactNode;
+}): JSX.Element;
+export declare function useMobileSecondaryMenuRenderer(): (extraProps: ExtraProps) => ReactNode | undefined;
+export declare function MobileSecondaryMenuFiller<Props extends Record<string, unknown>>({ component, props, }: {
+    component: MobileSecondaryMenuComponent<Props & ExtraProps>;
+    props: Props;
+}): JSX.Element | null;
+export {};

package/lib/utils/mobileSecondaryMenu.js

@@ -0,0 +1,49 @@
+/**
+ * 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, useContext, createContext, useEffect, useMemo, } from 'react';
+function useContextValue() {
+    return useState(null);
+}
+const Context = createContext(null);
+export function MobileSecondaryMenuProvider({ children, }) {
+    return (React.createElement(Context.Provider, { value: useContextValue() }, children));
+}
+function useMobileSecondaryMenuContext() {
+    const value = useContext(Context);
+    if (value === null) {
+        throw new Error('MobileSecondaryMenuProvider was not used correctly, context value is null');
+    }
+    return value;
+}
+export function useMobileSecondaryMenuRenderer() {
+    const [state] = useMobileSecondaryMenuContext();
+    if (state) {
+        const Comp = state.component;
+        return function render(extraProps) {
+            return React.createElement(Comp, { ...state.props, ...extraProps });
+        };
+    }
+    return () => undefined;
+}
+function useShallowMemoizedObject(obj) {
+    return useMemo(() => obj, 
+    // Is this safe?
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    [...Object.keys(obj), ...Object.values(obj)]);
+}
+// Fill the secondary menu placeholder with some real content
+export function MobileSecondaryMenuFiller({ component, props, }) {
+    const [, setState] = useMobileSecondaryMenuContext();
+    // To avoid useless context re-renders, props are memoized shallowly
+    const memoizedProps = useShallowMemoizedObject(props);
+    useEffect(() => {
+        // @ts-expect-error: context is not 100% typesafe but it's ok
+        setState({ component, props: memoizedProps });
+    }, [setState, component, memoizedProps]);
+    useEffect(() => () => setState(null), [setState]);
+    return null;
+}

package/lib/utils/pathUtils.js

@@ -6,8 +6,6 @@
  */
 // 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);
 };

package/lib/utils/reactUtils.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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;

package/lib/utils/reactUtils.js

@@ -0,0 +1,26 @@
+/**
+ * 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), []);
+}

package/lib/utils/regexpUtils.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.
+ */
+/**
+ * Utility to convert an optional string into a Regex case sensitive and global
+ */
+export declare function isRegexpStringMatch(regexAsString?: string, valueToTest?: string): boolean;

package/lib/utils/regexpUtils.js

@@ -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.
+ */
+/**
+ * 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);
+}

package/lib/utils/scrollUtils.d.ts

@@ -0,0 +1,52 @@
+/**
+ * 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 {};

package/lib/utils/scrollUtils.js

@@ -0,0 +1,135 @@
+/**
+ * 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,
+    };
+}

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;

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);
+            }
+        },
     };
 };
 /**

package/lib/utils/tagsUtils.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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 {};