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

package/lib/utils/storageUtils.js

@@ -6,23 +6,21 @@
  */
 const StorageTypes = ['localStorage', 'sessionStorage', 'none'];
 const DefaultStorageType = 'localStorage';
-// Will return null browser storage is unavailable (like running Docusaurus in iframe)
-// See https://github.com/facebook/docusaurus/pull/4501
+// Will return null browser storage is unavailable (like running Docusaurus in
+// iframe) See https://github.com/facebook/docusaurus/pull/4501
 function getBrowserStorage(storageType = DefaultStorageType) {
     if (typeof window === 'undefined') {
-        throw new Error('Browser storage is not available on NodeJS / Docusaurus SSR process');
+        throw new Error('Browser storage is not available on Node.js/Docusaurus SSR process.');
     }
     if (storageType === 'none') {
         return null;
     }
-    else {
-        try {
-            return window[storageType];
-        }
-        catch (e) {
-            logOnceBrowserStorageNotAvailableWarning(e);
-            return null;
-        }
+    try {
+        return window[storageType];
+    }
+    catch (err) {
+        logOnceBrowserStorageNotAvailableWarning(err);
+        return null;
     }
 }
 /**
@@ -33,7 +31,7 @@ let hasLoggedBrowserStorageNotAvailableWarning = false;
 function logOnceBrowserStorageNotAvailableWarning(error) {
     if (!hasLoggedBrowserStorageNotAvailableWarning) {
         console.warn(`Docusaurus browser storage is not available.
-Possible reasons: running Docusaurus in an Iframe, in an Incognito browser session, or using too strict browser privacy settings.`, error);
+Possible reasons: running Docusaurus in an iframe, in an incognito browser session, or using too strict browser privacy settings.`, error);
         hasLoggedBrowserStorageNotAvailableWarning = true;
     }
 }
@@ -45,7 +43,7 @@ const NoopStorageSlot = {
 //  Fail-fast, as storage APIs should not be used during the SSR process
 function createServerStorageSlot(key) {
     function throwError() {
-        throw new Error(`Illegal storage API usage for storage key=${key}.
+        throw new Error(`Illegal storage API usage for storage key "${key}".
 Docusaurus storage APIs are not supposed to be called on the server-rendering process.
 Please only call storage APIs in effects and event handlers.`);
     }
@@ -57,6 +55,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 +69,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 (err) {
+                console.error(`Docusaurus storage error, can't get key=${key}`, err);
+                return null;
+            }
+        },
+        set: (value) => {
+            try {
+                browserStorage.setItem(key, value);
+            }
+            catch (err) {
+                console.error(`Docusaurus storage error, can't set ${key}=${value}`, err);
+            }
+        },
+        del: () => {
+            try {
+                browserStorage.removeItem(key);
+            }
+            catch (err) {
+                console.error(`Docusaurus storage error, can't delete key=${key}`, err);
+            }
+        },
     };
 };
 /**
@@ -90,3 +114,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,8EAA8E;AAC9E,+DAA+D;AAC/D,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;IACD,IAAI;QACF,OAAO,MAAM,CAAC,WAAW,CAAC,CAAC;KAC5B;IAAC,OAAO,GAAG,EAAE;QACZ,wCAAwC,CAAC,GAAY,CAAC,CAAC;QACvD,OAAO,IAAI,CAAC;KACb;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,GAAG,EAAE;gBACZ,OAAO,CAAC,KAAK,CAAC,2CAA2C,GAAG,EAAE,EAAE,GAAG,CAAC,CAAC;gBACrE,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,GAAG,EAAE;gBACZ,OAAO,CAAC,KAAK,CACX,uCAAuC,GAAG,IAAI,KAAK,EAAE,EACrD,GAAG,CACJ,CAAC;aACH;QACH,CAAC;QACD,GAAG,EAAE,GAAG,EAAE;YACR,IAAI;gBACF,cAAc,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;aAChC;YAAC,OAAO,GAAG,EAAE;gBACZ,OAAO,CAAC,KAAK,CAAC,8CAA8C,GAAG,EAAE,EAAE,GAAG,CAAC,CAAC;aACzE;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/tabGroupChoiceUtils.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.
+ */
+import { type ReactNode } from 'react';
+declare type TabGroupChoiceContextValue = {
+    readonly tabGroupChoices: {
+        readonly [groupId: string]: string;
+    };
+    readonly setTabGroupChoices: (groupId: string, newChoice: string) => void;
+};
+export declare function TabGroupChoiceProvider({ children, }: {
+    children: ReactNode;
+}): JSX.Element;
+export declare function useTabGroupChoice(): TabGroupChoiceContextValue;
+export {};
+//# sourceMappingURL=tabGroupChoiceUtils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"tabGroupChoiceUtils.d.ts","sourceRoot":"","sources":["../../src/utils/tabGroupChoiceUtils.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAc,EAOZ,KAAK,SAAS,EACf,MAAM,OAAO,CAAC;AAKf,aAAK,0BAA0B,GAAG;IAChC,QAAQ,CAAC,eAAe,EAAE;QAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAAA;KAAC,CAAC;IAC/D,QAAQ,CAAC,kBAAkB,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,KAAK,IAAI,CAAC;CAC3E,CAAC;AAsCF,wBAAgB,sBAAsB,CAAC,EACrC,QAAQ,GACT,EAAE;IACD,QAAQ,EAAE,SAAS,CAAC;CACrB,GAAG,GAAG,CAAC,OAAO,CAcd;AAED,wBAAgB,iBAAiB,IAAI,0BAA0B,CAQ9D"}

package/lib/utils/tabGroupChoiceUtils.js

@@ -0,0 +1,54 @@
+/**
+ * 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, createContext, useMemo, useContext, } from 'react';
+import { createStorageSlot, listStorageKeys } from './storageUtils';
+const TAB_CHOICE_PREFIX = 'docusaurus.tab.';
+const TabGroupChoiceContext = createContext(undefined);
+function useTabGroupChoiceContextValue() {
+    const [tabGroupChoices, setChoices] = useState({});
+    const setChoiceSyncWithLocalStorage = useCallback((groupId, newChoice) => {
+        createStorageSlot(`${TAB_CHOICE_PREFIX}${groupId}`).set(newChoice);
+    }, []);
+    useEffect(() => {
+        try {
+            const localStorageChoices = {};
+            listStorageKeys().forEach((storageKey) => {
+                if (storageKey.startsWith(TAB_CHOICE_PREFIX)) {
+                    const groupId = storageKey.substring(TAB_CHOICE_PREFIX.length);
+                    localStorageChoices[groupId] = createStorageSlot(storageKey).get();
+                }
+            });
+            setChoices(localStorageChoices);
+        }
+        catch (err) {
+            console.error(err);
+        }
+    }, []);
+    return {
+        tabGroupChoices,
+        setTabGroupChoices: (groupId, newChoice) => {
+            setChoices((oldChoices) => ({ ...oldChoices, [groupId]: newChoice }));
+            setChoiceSyncWithLocalStorage(groupId, newChoice);
+        },
+    };
+}
+export function TabGroupChoiceProvider({ children, }) {
+    const { tabGroupChoices, setTabGroupChoices } = useTabGroupChoiceContextValue();
+    const contextValue = useMemo(() => ({
+        tabGroupChoices,
+        setTabGroupChoices,
+    }), [tabGroupChoices, setTabGroupChoices]);
+    return (React.createElement(TabGroupChoiceContext.Provider, { value: contextValue }, children));
+}
+export function useTabGroupChoice() {
+    const context = useContext(TabGroupChoiceContext);
+    if (context == null) {
+        throw new Error('"useUserPreferencesContext" is used outside of "Layout" component.');
+    }
+    return context;
+}
+//# sourceMappingURL=tabGroupChoiceUtils.js.map

package/lib/utils/tabGroupChoiceUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tabGroupChoiceUtils.js","sourceRoot":"","sources":["../../src/utils/tabGroupChoiceUtils.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,EACZ,QAAQ,EACR,WAAW,EACX,SAAS,EACT,aAAa,EACb,OAAO,EACP,UAAU,GAEX,MAAM,OAAO,CAAC;AACf,OAAO,EAAC,iBAAiB,EAAE,eAAe,EAAC,MAAM,gBAAgB,CAAC;AAElE,MAAM,iBAAiB,GAAG,iBAAiB,CAAC;AAO5C,MAAM,qBAAqB,GAAG,aAAa,CAEzC,SAAS,CAAC,CAAC;AAEb,SAAS,6BAA6B;IACpC,MAAM,CAAC,eAAe,EAAE,UAAU,CAAC,GAAG,QAAQ,CAE3C,EAAE,CAAC,CAAC;IACP,MAAM,6BAA6B,GAAG,WAAW,CAAC,CAAC,OAAO,EAAE,SAAS,EAAE,EAAE;QACvE,iBAAiB,CAAC,GAAG,iBAAiB,GAAG,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACrE,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,SAAS,CAAC,GAAG,EAAE;QACb,IAAI;YACF,MAAM,mBAAmB,GAA2B,EAAE,CAAC;YACvD,eAAe,EAAE,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;gBACvC,IAAI,UAAU,CAAC,UAAU,CAAC,iBAAiB,CAAC,EAAE;oBAC5C,MAAM,OAAO,GAAG,UAAU,CAAC,SAAS,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;oBAC/D,mBAAmB,CAAC,OAAO,CAAC,GAAG,iBAAiB,CAAC,UAAU,CAAC,CAAC,GAAG,EAAG,CAAC;iBACrE;YACH,CAAC,CAAC,CAAC;YACH,UAAU,CAAC,mBAAmB,CAAC,CAAC;SACjC;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;SACpB;IACH,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO;QACL,eAAe;QACf,kBAAkB,EAAE,CAAC,OAAe,EAAE,SAAiB,EAAE,EAAE;YACzD,UAAU,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,EAAC,GAAG,UAAU,EAAE,CAAC,OAAO,CAAC,EAAE,SAAS,EAAC,CAAC,CAAC,CAAC;YACpE,6BAA6B,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QACpD,CAAC;KACF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,EACrC,QAAQ,GAGT;IACC,MAAM,EAAC,eAAe,EAAE,kBAAkB,EAAC,GAAG,6BAA6B,EAAE,CAAC;IAC9E,MAAM,YAAY,GAAG,OAAO,CAC1B,GAAG,EAAE,CAAC,CAAC;QACL,eAAe;QACf,kBAAkB;KACnB,CAAC,EACF,CAAC,eAAe,EAAE,kBAAkB,CAAC,CACtC,CAAC;IACF,OAAO,CACL,oBAAC,qBAAqB,CAAC,QAAQ,IAAC,KAAK,EAAE,YAAY,IAChD,QAAQ,CACsB,CAClC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,iBAAiB;IAC/B,MAAM,OAAO,GAAG,UAAU,CAAC,qBAAqB,CAAC,CAAC;IAClD,IAAI,OAAO,IAAI,IAAI,EAAE;QACnB,MAAM,IAAI,KAAK,CACb,oEAAoE,CACrE,CAAC;KACH;IACD,OAAO,OAAO,CAAC;AACjB,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,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 type { TOCItem } from '@docusaurus/types';
+export declare type TOCTreeNode = {
+    readonly value: string;
+    readonly id: string;
+    readonly level: number;
+    readonly children: readonly TOCTreeNode[];
+};
+export declare function useTreeifiedTOC(toc: TOCItem[]): readonly TOCTreeNode[];
+export declare function useFilteredAndTreeifiedTOC({ toc, minHeadingLevel, maxHeadingLevel, }: {
+    toc: readonly TOCItem[];
+    minHeadingLevel: number;
+    maxHeadingLevel: number;
+}): readonly TOCTreeNode[];
+//# 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,KAAK,EAAC,OAAO,EAAC,MAAM,mBAAmB,CAAC;AAE/C,oBAAY,WAAW,GAAG;IACxB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,QAAQ,EAAE,SAAS,WAAW,EAAE,CAAC;CAC3C,CAAC;AAuCF,wBAAgB,eAAe,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,SAAS,WAAW,EAAE,CAEtE;AAiCD,wBAAgB,0BAA0B,CAAC,EACzC,GAAG,EACH,eAAe,EACf,eAAe,GAChB,EAAE;IACD,GAAG,EAAE,SAAS,OAAO,EAAE,CAAC;IACxB,eAAe,EAAE,MAAM,CAAC;IACxB,eAAe,EAAE,MAAM,CAAC;CACzB,GAAG,SAAS,WAAW,EAAE,CAUzB"}

package/lib/utils/tocUtils.js

@@ -0,0 +1,73 @@
+/**
+ * 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';
+function treeifyTOC(flatTOC) {
+    const headings = flatTOC.map((heading) => ({
+        ...heading,
+        parentIndex: -1,
+        children: [],
+    }));
+    // Keep track of which previous index would be the current heading's direct
+    // parent. Each entry <i> is the last index of the `headings` array at heading
+    // level <i>. We will modify these indices as we iterate through all headings.
+    // e.g. if an ### H3 was last seen at index 2, then prevIndexForLevel[3] === 2
+    // indices 0 and 1 will remain unused.
+    const prevIndexForLevel = Array(7).fill(-1);
+    headings.forEach((curr, currIndex) => {
+        // take the last seen index for each ancestor level. the highest
+        // index will be the direct ancestor of the current heading.
+        const ancestorLevelIndexes = prevIndexForLevel.slice(2, curr.level);
+        curr.parentIndex = Math.max(...ancestorLevelIndexes);
+        // mark that curr.level was last seen at the current index
+        prevIndexForLevel[curr.level] = currIndex;
+    });
+    const rootNodes = [];
+    // For a given parentIndex, add each Node into that parent's `children` array
+    headings.forEach((heading) => {
+        const { parentIndex, ...rest } = heading;
+        if (parentIndex >= 0) {
+            headings[parentIndex].children.push(rest);
+        }
+        else {
+            rootNodes.push(rest);
+        }
+    });
+    return rootNodes;
+}
+export function useTreeifiedTOC(toc) {
+    return useMemo(() => treeifyTOC(toc), [toc]);
+}
+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,
+                },
+            ];
+        }
+        return filteredChildren;
+    });
+}
+export function useFilteredAndTreeifiedTOC({ toc, minHeadingLevel, maxHeadingLevel, }) {
+    return useMemo(() => 
+    // Note: we have to filter the TOC after it has been treeified. This is
+    // mostly to ensure that weird TOC structures preserve their semantics.
+    // For example, an h3-h2-h4 sequence should not be treeified as an h3 > h4
+    // hierarchy with min=3, max=4, but should rather be [h3, h4]
+    filterTOC({ toc: treeifyTOC(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;AAU9B,SAAS,UAAU,CAAC,OAA2B;IAC7C,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QACzC,GAAG,OAAO;QACV,WAAW,EAAE,CAAC,CAAC;QACf,QAAQ,EAAE,EAAmB;KAC9B,CAAC,CAAC,CAAC;IAEJ,2EAA2E;IAC3E,8EAA8E;IAC9E,8EAA8E;IAC9E,8EAA8E;IAC9E,sCAAsC;IACtC,MAAM,iBAAiB,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAE5C,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,SAAS,EAAE,EAAE;QACnC,gEAAgE;QAChE,4DAA4D;QAC5D,MAAM,oBAAoB,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QACpE,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,oBAAoB,CAAC,CAAC;QACrD,0DAA0D;QAC1D,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;IAC5C,CAAC,CAAC,CAAC;IAEH,MAAM,SAAS,GAAkB,EAAE,CAAC;IAEpC,6EAA6E;IAC7E,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC3B,MAAM,EAAC,WAAW,EAAE,GAAG,IAAI,EAAC,GAAG,OAAO,CAAC;QACvC,IAAI,WAAW,IAAI,CAAC,EAAE;YACpB,QAAQ,CAAC,WAAW,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SAC3C;aAAM;YACL,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SACtB;IACH,CAAC,CAAC,CAAC;IACH,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,GAAc;IAC5C,OAAO,OAAO,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;AAC/C,CAAC;AAED,SAAS,SAAS,CAAC,EACjB,GAAG,EACH,eAAe,EACf,eAAe,GAKhB;IACC,SAAS,OAAO,CAAC,IAAiB;QAChC,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;QACD,OAAO,gBAAgB,CAAC;IAC1B,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,EACzC,GAAG,EACH,eAAe,EACf,eAAe,GAKhB;IACC,OAAO,OAAO,CACZ,GAAG,EAAE;IACH,uEAAuE;IACvE,uEAAuE;IACvE,0EAA0E;IAC1E,6DAA6D;IAC7D,SAAS,CAAC,EAAC,GAAG,EAAE,UAAU,CAAC,GAAG,CAAC,EAAE,eAAe,EAAE,eAAe,EAAC,CAAC,EACrE,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,CAqCA"}

package/lib/utils/useAlternatePageUtils.js

@@ -21,9 +21,11 @@ export function useAlternatePageUtils() {
             ? `${baseUrlUnlocalized}`
             : `${baseUrlUnlocalized}${locale}/`;
     }
-    // TODO support correct alternate url when localized site is deployed on another domain
+    // TODO support correct alternate url when localized site is deployed on
+    // another domain
     function createUrl({ locale, fullyQualified, }) {
         return `${fullyQualified ? url : ''}${getLocalizedBaseUrl(locale)}${pathnameSuffix}`;
     }
     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,wEAAwE;IACxE,iBAAiB;IACjB,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;AAUH,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 '@docusaurus/plugin-content-docs/client';
+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 want to use their 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,EACL,cAAc,EACd,yBAAyB,GAC1B,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAC,iCAAiC,EAAC,MAAM,gDAAgD,CAAC;AACjG,OAAO,EAAC,mBAAmB,EAAE,kBAAkB,EAAC,MAAM,eAAe,CAAC;AACtE,OAAO,oBAAoB,MAAM,kCAAkC,CAAC;AAOpE,uEAAuE;AACvE,8EAA8E;AAC9E,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"}

package/lib/utils/useLocalPathname.d.ts

@@ -0,0 +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 function useLocalPathname(): string;
+//# sourceMappingURL=useLocalPathname.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useLocalPathname.d.ts","sourceRoot":"","sources":["../../src/utils/useLocalPathname.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAQH,wBAAgB,gBAAgB,IAAI,MAAM,CAMzC"}

package/lib/utils/useLocalPathname.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.
+ */
+import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
+import { useLocation } from '@docusaurus/router';
+// Get the pathname of current route, without the optional site baseUrl
+// - /docs/myDoc => /docs/myDoc
+// - /baseUrl/docs/myDoc => /docs/myDoc
+export function useLocalPathname() {
+    const { siteConfig: { baseUrl }, } = useDocusaurusContext();
+    const { pathname } = useLocation();
+    return pathname.replace(baseUrl, '/');
+}
+//# sourceMappingURL=useLocalPathname.js.map

package/lib/utils/useLocalPathname.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useLocalPathname.js","sourceRoot":"","sources":["../../src/utils/useLocalPathname.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,oBAAoB,MAAM,kCAAkC,CAAC;AACpE,OAAO,EAAC,WAAW,EAAC,MAAM,oBAAoB,CAAC;AAE/C,uEAAuE;AACvE,+BAA+B;AAC/B,uCAAuC;AACvC,MAAM,UAAU,gBAAgB;IAC9B,MAAM,EACJ,UAAU,EAAE,EAAC,OAAO,EAAC,GACtB,GAAG,oBAAoB,EAAE,CAAC;IAC3B,MAAM,EAAC,QAAQ,EAAC,GAAG,WAAW,EAAE,CAAC;IACjC,OAAO,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;AACxC,CAAC"}

package/lib/utils/useLocationChange.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 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 } from 'history';
+declare type LocationChangeEvent = {
+    location: Location;
+    previousLocation: Location | undefined;
+};
+declare type OnLocationChange = (locationChangeEvent: LocationChangeEvent) => void;
+export declare function useLocationChange(onLocationChange: OnLocationChange): void;
+export {};
+//# sourceMappingURL=useLocationChange.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useLocationChange.d.ts","sourceRoot":"","sources":["../../src/utils/useLocationChange.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH,OAAO,KAAK,EAAC,QAAQ,EAAC,MAAM,SAAS,CAAC;AAItC,aAAK,mBAAmB,GAAG;IACzB,QAAQ,EAAE,QAAQ,CAAC;IACnB,gBAAgB,EAAE,QAAQ,GAAG,SAAS,CAAC;CACxC,CAAC;AAEF,aAAK,gBAAgB,GAAG,CAAC,mBAAmB,EAAE,mBAAmB,KAAK,IAAI,CAAC;AAE3E,wBAAgB,iBAAiB,CAAC,gBAAgB,EAAE,gBAAgB,GAAG,IAAI,CAkB1E"}

package/lib/utils/useLocationChange.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 { useEffect } from 'react';
+import { useLocation } from '@docusaurus/router';
+import { usePrevious } from './usePrevious';
+import { useDynamicCallback } from './reactUtils';
+export function useLocationChange(onLocationChange) {
+    const location = useLocation();
+    const previousLocation = usePrevious(location);
+    const onLocationChangeDynamic = useDynamicCallback(onLocationChange);
+    useEffect(() => {
+        if (!previousLocation) {
+            return;
+        }
+        if (location !== previousLocation) {
+            onLocationChangeDynamic({
+                location,
+                previousLocation,
+            });
+        }
+    }, [onLocationChangeDynamic, location, previousLocation]);
+}
+//# sourceMappingURL=useLocationChange.js.map

package/lib/utils/useLocationChange.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useLocationChange.js","sourceRoot":"","sources":["../../src/utils/useLocationChange.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAC,SAAS,EAAC,MAAM,OAAO,CAAC;AAChC,OAAO,EAAC,WAAW,EAAC,MAAM,oBAAoB,CAAC;AAE/C,OAAO,EAAC,WAAW,EAAC,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAC,kBAAkB,EAAC,MAAM,cAAc,CAAC;AAShD,MAAM,UAAU,iBAAiB,CAAC,gBAAkC;IAClE,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAC;IAC/B,MAAM,gBAAgB,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC;IAE/C,MAAM,uBAAuB,GAAG,kBAAkB,CAAC,gBAAgB,CAAC,CAAC;IAErE,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,CAAC,gBAAgB,EAAE;YACrB,OAAO;SACR;QAED,IAAI,QAAQ,KAAK,gBAAgB,EAAE;YACjC,uBAAuB,CAAC;gBACtB,QAAQ;gBACR,gBAAgB;aACjB,CAAC,CAAC;SACJ;IACH,CAAC,EAAE,CAAC,uBAAuB,EAAE,QAAQ,EAAE,gBAAgB,CAAC,CAAC,CAAC;AAC5D,CAAC"}

package/lib/utils/usePluralForm.d.ts

@@ -7,3 +7,4 @@
 export declare function usePluralForm(): {
     selectMessage: (count: number, pluralMessages: string) => string;
 };
+//# sourceMappingURL=usePluralForm.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"usePluralForm.d.ts","sourceRoot":"","sources":["../../src/utils/usePluralForm.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AA8GH,wBAAgB,aAAa,IAAI;IAC/B,aAAa,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,KAAK,MAAM,CAAC;CAClE,CAMA"}

package/lib/utils/usePluralForm.js

@@ -34,27 +34,33 @@ function createLocalePluralForms(locale) {
         select: (count) => pluralRules.select(count),
     };
 }
-// Poor man's PluralSelector implementation, using an english fallback.
-// We want a lightweight, future-proof and good-enough solution.
-// We don't want a perfect and heavy solution.
-//
-// Docusaurus classic theme has only 2 deeply nested labels requiring complex plural rules
-// We don't want to use Intl + PluralRules polyfills + full ICU syntax (react-intl) just for that.
-//
-// Notes:
-// - 2021: 92+% Browsers support Intl.PluralRules, and support will increase in the future
-// - NodeJS >= 13 has full ICU support by default
-// - In case of "mismatch" between SSR and Browser ICU support, React keeps working!
+/**
+ * Poor man's PluralSelector implementation, using an english fallback. We want
+ * a lightweight, future-proof and good-enough solution. We don't want a perfect
+ * and heavy solution.
+ *
+ * Docusaurus classic theme has only 2 deeply nested labels requiring complex
+ * plural rules. We don't want to use Intl + PluralRules polyfills + full ICU
+ * syntax (react-intl) just for that.
+ *
+ * Notes:
+ * - 2021: 92+% Browsers support Intl.PluralRules, and support will increase in
+ * the future
+ * - NodeJS >= 13 has full ICU support by default
+ * - In case of "mismatch" between SSR and Browser ICU support, React keeps
+ * working!
+ */
 function useLocalePluralForms() {
     const { i18n: { currentLocale }, } = useDocusaurusContext();
     return useMemo(() => {
-        // @ts-expect-error checking Intl.PluralRules in case browser doesn't have it (e.g Safari 12-)
+        // @ts-expect-error checking Intl.PluralRules in case browser doesn't
+        // have it (e.g Safari 12-)
         if (Intl.PluralRules) {
             try {
                 return createLocalePluralForms(currentLocale);
             }
-            catch (e) {
-                console.error(`Failed to use Intl.PluralRules for locale=${currentLocale}.
+            catch {
+                console.error(`Failed to use Intl.PluralRules for locale "${currentLocale}".
 Docusaurus will fallback to a default/fallback (English) Intl.PluralRules implementation.
 `);
                 return EnglishPluralForms;
@@ -74,21 +80,19 @@ function selectPluralMessage(pluralMessages, count, localePluralForms) {
     if (parts.length === 1) {
         return parts[0];
     }
-    else {
-        if (parts.length > localePluralForms.pluralForms.length) {
-            console.error(`For locale=${localePluralForms.locale}, a maximum of ${localePluralForms.pluralForms.length} plural forms are expected (${localePluralForms.pluralForms}), but the message contains ${parts.length} plural forms: ${pluralMessages} `);
-        }
-        const pluralForm = localePluralForms.select(count);
-        const pluralFormIndex = localePluralForms.pluralForms.indexOf(pluralForm);
-        // In case of not enough plural form messages, we take the last one (other) instead of returning undefined
-        return parts[Math.min(pluralFormIndex, parts.length - 1)];
+    if (parts.length > localePluralForms.pluralForms.length) {
+        console.error(`For locale=${localePluralForms.locale}, a maximum of ${localePluralForms.pluralForms.length} plural forms are expected (${localePluralForms.pluralForms}), but the message contains ${parts.length} plural forms: ${pluralMessages} `);
     }
+    const pluralForm = localePluralForms.select(count);
+    const pluralFormIndex = localePluralForms.pluralForms.indexOf(pluralForm);
+    // In case of not enough plural form messages, we take the last one (other)
+    // instead of returning undefined
+    return parts[Math.min(pluralFormIndex, parts.length - 1)];
 }
 export function usePluralForm() {
     const localePluralForm = useLocalePluralForms();
     return {
-        selectMessage: (count, pluralMessages) => {
-            return selectPluralMessage(pluralMessages, count, localePluralForm);
-        },
+        selectMessage: (count, pluralMessages) => selectPluralMessage(pluralMessages, count, localePluralForm),
     };
 }
+//# sourceMappingURL=usePluralForm.js.map