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

package/lib/utils/codeBlockUtils.js

@@ -4,8 +4,128 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
+import rangeParser from 'parse-numeric-range';
 const codeBlockTitleRegex = /title=(["'])(.*?)\1/;
+const highlightLinesRangeRegex = /{([\d,-]+)}/;
+const commentTypes = ['js', 'jsBlock', 'jsx', 'python', 'html'];
+// Supported types of highlight comments
+const commentPatterns = {
+    js: {
+        start: '\\/\\/',
+        end: '',
+    },
+    jsBlock: {
+        start: '\\/\\*',
+        end: '\\*\\/',
+    },
+    jsx: {
+        start: '\\{\\s*\\/\\*',
+        end: '\\*\\/\\s*\\}',
+    },
+    python: {
+        start: '#',
+        end: '',
+    },
+    html: {
+        start: '<!--',
+        end: '-->',
+    },
+};
+const magicCommentDirectives = [
+    'highlight-next-line',
+    'highlight-start',
+    'highlight-end',
+];
+const getMagicCommentDirectiveRegex = (languages = commentTypes) => {
+    // to be more reliable, the opening and closing comment must match
+    const commentPattern = languages
+        .map((lang) => {
+        const { start, end } = commentPatterns[lang];
+        return `(?:${start}\\s*(${magicCommentDirectives.join('|')})\\s*${end})`;
+    })
+        .join('|');
+    // white space is allowed, but otherwise it should be on it's own line
+    return new RegExp(`^\\s*(?:${commentPattern})\\s*$`);
+};
+// select comment styles based on language
+const magicCommentDirectiveRegex = (lang) => {
+    switch (lang) {
+        case 'js':
+        case 'javascript':
+        case 'ts':
+        case 'typescript':
+            return getMagicCommentDirectiveRegex(['js', 'jsBlock']);
+        case 'jsx':
+        case 'tsx':
+            return getMagicCommentDirectiveRegex(['js', 'jsBlock', 'jsx']);
+        case 'html':
+            return getMagicCommentDirectiveRegex(['js', 'jsBlock', 'html']);
+        case 'python':
+        case 'py':
+            return getMagicCommentDirectiveRegex(['python']);
+        default:
+            // all comment types
+            return getMagicCommentDirectiveRegex();
+    }
+};
 export function parseCodeBlockTitle(metastring) {
     var _a, _b;
     return (_b = (_a = metastring === null || metastring === void 0 ? void 0 : metastring.match(codeBlockTitleRegex)) === null || _a === void 0 ? void 0 : _a[2]) !== null && _b !== void 0 ? _b : '';
 }
+export function parseLanguage(className) {
+    const languageClassName = className === null || className === void 0 ? void 0 : className.split(' ').find((str) => str.startsWith('language-'));
+    return languageClassName === null || languageClassName === void 0 ? void 0 : languageClassName.replace(/language-/, '');
+}
+/**
+ * @param metastring The highlight range declared here starts at 1
+ * @returns Note: all line numbers start at 0, not 1
+ */
+export function parseLines(content, metastring, language) {
+    let code = content.replace(/\n$/, '');
+    // Highlighted lines specified in props: don't parse the content
+    if (metastring && highlightLinesRangeRegex.test(metastring)) {
+        const highlightLinesRange = metastring.match(highlightLinesRangeRegex)[1];
+        const highlightLines = rangeParser(highlightLinesRange)
+            .filter((n) => n > 0)
+            .map((n) => n - 1);
+        return { highlightLines, code };
+    }
+    if (language === undefined) {
+        return { highlightLines: [], code };
+    }
+    const directiveRegex = magicCommentDirectiveRegex(language);
+    // go through line by line
+    const lines = code.split('\n');
+    let highlightBlockStart;
+    let highlightRange = '';
+    // loop through lines
+    for (let lineNumber = 0; lineNumber < lines.length;) {
+        const line = lines[lineNumber];
+        const match = line.match(directiveRegex);
+        if (match !== null) {
+            const directive = match.slice(1).find((item) => item !== undefined);
+            switch (directive) {
+                case 'highlight-next-line':
+                    highlightRange += `${lineNumber},`;
+                    break;
+                case 'highlight-start':
+                    highlightBlockStart = lineNumber;
+                    break;
+                case 'highlight-end':
+                    highlightRange += `${highlightBlockStart}-${lineNumber - 1},`;
+                    break;
+                default:
+                    break;
+            }
+            lines.splice(lineNumber, 1);
+        }
+        else {
+            // lines without directives are unchanged
+            lineNumber += 1;
+        }
+    }
+    const highlightLines = rangeParser(highlightRange);
+    code = lines.join('\n');
+    return { highlightLines, code };
+}
+//# sourceMappingURL=codeBlockUtils.js.map

package/lib/utils/codeBlockUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"codeBlockUtils.js","sourceRoot":"","sources":["../../src/utils/codeBlockUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,WAAW,MAAM,qBAAqB,CAAC;AAG9C,MAAM,mBAAmB,GAAG,qBAAqB,CAAC;AAClD,MAAM,wBAAwB,GAAG,aAAa,CAAC;AAE/C,MAAM,YAAY,GAAG,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,CAAU,CAAC;AAQzE,wCAAwC;AACxC,MAAM,eAAe,GAAwC;IAC3D,EAAE,EAAE;QACF,KAAK,EAAE,QAAQ;QACf,GAAG,EAAE,EAAE;KACR;IACD,OAAO,EAAE;QACP,KAAK,EAAE,QAAQ;QACf,GAAG,EAAE,QAAQ;KACd;IACD,GAAG,EAAE;QACH,KAAK,EAAE,eAAe;QACtB,GAAG,EAAE,eAAe;KACrB;IACD,MAAM,EAAE;QACN,KAAK,EAAE,GAAG;QACV,GAAG,EAAE,EAAE;KACR;IACD,IAAI,EAAE;QACJ,KAAK,EAAE,MAAM;QACb,GAAG,EAAE,KAAK;KACX;CACF,CAAC;AAEF,MAAM,sBAAsB,GAAG;IAC7B,qBAAqB;IACrB,iBAAiB;IACjB,eAAe;CAChB,CAAC;AAEF,MAAM,6BAA6B,GAAG,CACpC,YAAoC,YAAY,EAChD,EAAE;IACF,kEAAkE;IAClE,MAAM,cAAc,GAAG,SAAS;SAC7B,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACZ,MAAM,EAAC,KAAK,EAAE,GAAG,EAAC,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;QAC3C,OAAO,MAAM,KAAK,QAAQ,sBAAsB,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,GAAG,GAAG,CAAC;IAC3E,CAAC,CAAC;SACD,IAAI,CAAC,GAAG,CAAC,CAAC;IACb,sEAAsE;IACtE,OAAO,IAAI,MAAM,CAAC,WAAW,cAAc,QAAQ,CAAC,CAAC;AACvD,CAAC,CAAC;AAEF,0CAA0C;AAC1C,MAAM,0BAA0B,GAAG,CAAC,IAAY,EAAE,EAAE;IAClD,QAAQ,IAAI,EAAE;QACZ,KAAK,IAAI,CAAC;QACV,KAAK,YAAY,CAAC;QAClB,KAAK,IAAI,CAAC;QACV,KAAK,YAAY;YACf,OAAO,6BAA6B,CAAC,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;QAE1D,KAAK,KAAK,CAAC;QACX,KAAK,KAAK;YACR,OAAO,6BAA6B,CAAC,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC;QAEjE,KAAK,MAAM;YACT,OAAO,6BAA6B,CAAC,CAAC,IAAI,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;QAElE,KAAK,QAAQ,CAAC;QACd,KAAK,IAAI;YACP,OAAO,6BAA6B,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;QAEnD;YACE,oBAAoB;YACpB,OAAO,6BAA6B,EAAE,CAAC;KAC1C;AACH,CAAC,CAAC;AAEF,MAAM,UAAU,mBAAmB,CAAC,UAAmB;;IACrD,OAAO,MAAA,MAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,KAAK,CAAC,mBAAmB,CAAC,0CAAG,CAAC,CAAC,mCAAI,EAAE,CAAC;AAC3D,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,SAAkB;IAC9C,MAAM,iBAAiB,GAAG,SAAS,aAAT,SAAS,uBAAT,SAAS,CAC/B,KAAK,CAAC,GAAG,EACV,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC;IAC9C,OAAO,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAE,OAAO,CAAC,WAAW,EAAE,EAAE,CAAyB,CAAC;AAC7E,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,UAAU,CACxB,OAAe,EACf,UAAmB,EACnB,QAAmB;IAKnB,IAAI,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IACtC,gEAAgE;IAChE,IAAI,UAAU,IAAI,wBAAwB,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE;QAC3D,MAAM,mBAAmB,GAAG,UAAU,CAAC,KAAK,CAAC,wBAAwB,CAAE,CAAC,CAAC,CAAC,CAAC;QAC3E,MAAM,cAAc,GAAG,WAAW,CAAC,mBAAmB,CAAC;aACpD,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC;aACpB,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QACrB,OAAO,EAAC,cAAc,EAAE,IAAI,EAAC,CAAC;KAC/B;IACD,IAAI,QAAQ,KAAK,SAAS,EAAE;QAC1B,OAAO,EAAC,cAAc,EAAE,EAAE,EAAE,IAAI,EAAC,CAAC;KACnC;IACD,MAAM,cAAc,GAAG,0BAA0B,CAAC,QAAQ,CAAC,CAAC;IAC5D,0BAA0B;IAC1B,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC/B,IAAI,mBAA2B,CAAC;IAChC,IAAI,cAAc,GAAG,EAAE,CAAC;IACxB,qBAAqB;IACrB,KAAK,IAAI,UAAU,GAAG,CAAC,EAAE,UAAU,GAAG,KAAK,CAAC,MAAM,GAAI;QACpD,MAAM,IAAI,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;QAC/B,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QACzC,IAAI,KAAK,KAAK,IAAI,EAAE;YAClB,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;YACpE,QAAQ,SAAS,EAAE;gBACjB,KAAK,qBAAqB;oBACxB,cAAc,IAAI,GAAG,UAAU,GAAG,CAAC;oBACnC,MAAM;gBAER,KAAK,iBAAiB;oBACpB,mBAAmB,GAAG,UAAU,CAAC;oBACjC,MAAM;gBAER,KAAK,eAAe;oBAClB,cAAc,IAAI,GAAG,mBAAoB,IAAI,UAAU,GAAG,CAAC,GAAG,CAAC;oBAC/D,MAAM;gBAER;oBACE,MAAM;aACT;YACD,KAAK,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;SAC7B;aAAM;YACL,yCAAyC;YACzC,UAAU,IAAI,CAAC,CAAC;SACjB;KACF;IACD,MAAM,cAAc,GAAG,WAAW,CAAC,cAAc,CAAC,CAAC;IACnD,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACxB,OAAO,EAAC,cAAc,EAAE,IAAI,EAAC,CAAC;AAChC,CAAC"}

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

@@ -4,7 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { ReactNode } from 'react';
+/// <reference types="react" />
 declare type DocsPreferredVersionName = string | null;
 declare type DocsPreferredVersionPluginState = {
     preferredVersionName: DocsPreferredVersionName;
@@ -15,7 +15,8 @@ declare function useContextValue(): readonly [DocsPreferredVersionState, {
 }];
 declare type DocsPreferredVersionContextValue = ReturnType<typeof useContextValue>;
 export declare function DocsPreferredVersionContextProvider({ children, }: {
-    children: ReactNode;
+    children: JSX.Element;
 }): JSX.Element;
 export declare function useDocsPreferredVersionContext(): DocsPreferredVersionContextValue;
 export {};
+//# sourceMappingURL=DocsPreferredVersionProvider.d.ts.map

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

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

package/lib/utils/docsPreferredVersion/DocsPreferredVersionProvider.js

@@ -69,7 +69,7 @@ function useContextValue() {
         return {
             savePreferredVersion,
         };
-    }, [setState]);
+    }, [versionPersistence]);
     return [state, api];
 }
 const Context = createContext(null);
@@ -78,7 +78,7 @@ export function DocsPreferredVersionContextProvider({ children, }) {
         return (React.createElement(DocsPreferredVersionContextProviderUnsafe, null, children));
     }
     else {
-        return React.createElement(React.Fragment, null, children);
+        return children;
     }
 }
 function DocsPreferredVersionContextProviderUnsafe({ children, }) {
@@ -92,3 +92,4 @@ export function useDocsPreferredVersionContext() {
     }
     return value;
 }
+//# sourceMappingURL=DocsPreferredVersionProvider.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DocsPreferredVersionProvider.js","sourceRoot":"","sources":["../../../src/utils/docsPreferredVersion/DocsPreferredVersionProvider.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,EACZ,aAAa,EAEb,UAAU,EACV,SAAS,EACT,OAAO,EACP,QAAQ,GACT,MAAM,OAAO,CAAC;AACf,OAAO,EAAC,cAAc,EAAyB,MAAM,mBAAmB,CAAC;AACzE,OAAO,EAAC,mBAAmB,EAAC,MAAM,cAAc,CAAC;AAEjD,OAAO,EAAC,cAAc,EAAmB,MAAM,sBAAsB,CAAC;AAEtE,OAAO,2BAA2B,MAAM,+BAA+B,CAAC;AAiBxE,2EAA2E;AAC3E,SAAS,eAAe,CAAC,SAAmB;IAC1C,MAAM,YAAY,GAA8B,EAAE,CAAC;IACnD,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;QAC7B,YAAY,CAAC,QAAQ,CAAC,GAAG;YACvB,oBAAoB,EAAE,IAAI;SAC3B,CAAC;IACJ,CAAC,CAAC,CAAC;IACH,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,oCAAoC;AACpC,2DAA2D;AAC3D,SAAS,gBAAgB,CAAC,EACxB,SAAS,EACT,kBAAkB,EAClB,WAAW,GAKZ;IACC,4CAA4C;IAC5C,kEAAkE;IAClE,uEAAuE;IACvE,SAAS,kBAAkB,CACzB,QAAgB;QAEhB,MAAM,0BAA0B,GAAG,2BAA2B,CAAC,IAAI,CACjE,QAAQ,EACR,kBAAkB,CACnB,CAAC;QACF,MAAM,UAAU,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC;QACzC,MAAM,aAAa,GAAG,UAAU,CAAC,QAAQ,CAAC,IAAI,CAC5C,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,0BAA0B,CACzD,CAAC;QACF,IAAI,aAAa,EAAE;YACjB,OAAO,EAAC,oBAAoB,EAAE,0BAA0B,EAAC,CAAC;SAC3D;aAAM;YACL,2BAA2B,CAAC,KAAK,CAAC,QAAQ,EAAE,kBAAkB,CAAC,CAAC;YAChE,OAAO,EAAC,oBAAoB,EAAE,IAAI,EAAC,CAAC;SACrC;IACH,CAAC;IAED,MAAM,YAAY,GAA8B,EAAE,CAAC;IACnD,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;QAC7B,YAAY,CAAC,QAAQ,CAAC,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IACH,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,SAAS,qBAAqB;IAC5B,OAAO,cAAc,EAAE,CAAC,IAAI,CAAC,kBAAkB,CAAC;AAClD,CAAC;AAED,8DAA8D;AAC9D,SAAS,eAAe;IACtB,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IACrC,MAAM,kBAAkB,GAAG,qBAAqB,EAAE,CAAC;IACnD,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;IAEzE,wEAAwE;IACxE,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,CAAC,GAAG,EAAE,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC;IAErE,uDAAuD;IACvD,SAAS,CAAC,GAAG,EAAE;QACb,QAAQ,CAAC,gBAAgB,CAAC,EAAC,WAAW,EAAE,kBAAkB,EAAE,SAAS,EAAC,CAAC,CAAC,CAAC;IAC3E,CAAC,EAAE,CAAC,WAAW,EAAE,kBAAkB,EAAE,SAAS,CAAC,CAAC,CAAC;IAEjD,sEAAsE;IACtE,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE;QACvB,SAAS,oBAAoB,CAAC,QAAgB,EAAE,WAAmB;YACjE,2BAA2B,CAAC,IAAI,CAC9B,QAAQ,EACR,kBAAkB,EAClB,WAAW,CACZ,CAAC;YACF,QAAQ,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;gBACf,GAAG,CAAC;gBACJ,CAAC,QAAQ,CAAC,EAAE,EAAC,oBAAoB,EAAE,WAAW,EAAC;aAChD,CAAC,CAAC,CAAC;QACN,CAAC;QAED,OAAO;YACL,oBAAoB;SACrB,CAAC;IACJ,CAAC,EAAE,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAEzB,OAAO,CAAC,KAAK,EAAE,GAAG,CAAU,CAAC;AAC/B,CAAC;AAID,MAAM,OAAO,GAAG,aAAa,CAA0C,IAAI,CAAC,CAAC;AAE7E,MAAM,UAAU,mCAAmC,CAAC,EAClD,QAAQ,GAGT;IACC,IAAI,mBAAmB,EAAE;QACvB,OAAO,CACL,oBAAC,yCAAyC,QACvC,QAAQ,CACiC,CAC7C,CAAC;KACH;SAAM;QACL,OAAO,QAAQ,CAAC;KACjB;AACH,CAAC;AAED,SAAS,yCAAyC,CAAC,EACjD,QAAQ,GAGT;IACC,MAAM,YAAY,GAAG,eAAe,EAAE,CAAC;IACvC,OAAO,oBAAC,OAAO,CAAC,QAAQ,IAAC,KAAK,EAAE,YAAY,IAAG,QAAQ,CAAoB,CAAC;AAC9E,CAAC;AAED,MAAM,UAAU,8BAA8B;IAC5C,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IAClC,IAAI,CAAC,KAAK,EAAE;QACV,MAAM,IAAI,KAAK,CACb,wGAAwG,CACzG,CAAC;KACH;IACD,OAAO,KAAK,CAAC;AACf,CAAC"}

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

@@ -11,3 +11,4 @@ declare const DocsPreferredVersionStorage: {
     clear: (pluginId: string, persistence: DocsVersionPersistence) => void;
 };
 export default DocsPreferredVersionStorage;
+//# sourceMappingURL=DocsPreferredVersionStorage.d.ts.map

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

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

package/lib/utils/docsPreferredVersion/DocsPreferredVersionStorage.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"DocsPreferredVersionStorage.js","sourceRoot":"","sources":["../../../src/utils/docsPreferredVersion/DocsPreferredVersionStorage.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAC,iBAAiB,EAAC,MAAM,iBAAiB,CAAC;AAGlD,MAAM,UAAU,GAAG,CAAC,QAAgB,EAAE,EAAE,CAAC,0BAA0B,QAAQ,EAAE,CAAC;AAE9E,MAAM,2BAA2B,GAAG;IAClC,IAAI,EAAE,CACJ,QAAgB,EAChB,WAAmC,EACnC,WAAmB,EACb,EAAE;QACR,iBAAiB,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,EAAC,WAAW,EAAC,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAC1E,CAAC;IAED,IAAI,EAAE,CACJ,QAAgB,EAChB,WAAmC,EACpB,EAAE,CACjB,iBAAiB,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,EAAC,WAAW,EAAC,CAAC,CAAC,GAAG,EAAE;IAE9D,KAAK,EAAE,CAAC,QAAgB,EAAE,WAAmC,EAAQ,EAAE;QACrE,iBAAiB,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,EAAC,WAAW,EAAC,CAAC,CAAC,GAAG,EAAE,CAAC;IAC/D,CAAC;CACF,CAAC;AAEF,eAAe,2BAA2B,CAAC"}

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

@@ -1,5 +1,14 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+/// <reference types="@docusaurus/plugin-content-docs" />
+import { GlobalVersion } from '@theme/hooks/useDocs';
 export declare function useDocsPreferredVersion(pluginId?: string | undefined): {
-    readonly preferredVersion: any;
-    readonly savePreferredVersionName: (versionName: string) => void;
+    preferredVersion: GlobalVersion | null | undefined;
+    savePreferredVersionName: (versionName: string) => void;
 };
-export declare function useDocsPreferredVersionByPluginId(): Record<string, any>;
+export declare function useDocsPreferredVersionByPluginId(): Record<string, GlobalVersion | null | undefined>;
+//# sourceMappingURL=useDocsPreferredVersion.d.ts.map

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

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

package/lib/utils/docsPreferredVersion/useDocsPreferredVersion.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"useDocsPreferredVersion.js","sourceRoot":"","sources":["../../../src/utils/docsPreferredVersion/useDocsPreferredVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAC,WAAW,EAAC,MAAM,OAAO,CAAC;AAClC,OAAO,EAAC,8BAA8B,EAAC,MAAM,gCAAgC,CAAC;AAC9E,OAAO,EAAC,cAAc,EAAE,WAAW,EAAgB,MAAM,sBAAsB,CAAC;AAEhF,OAAO,EAAC,iBAAiB,EAAC,MAAM,uBAAuB,CAAC;AAExD,wEAAwE;AACxE,MAAM,UAAU,uBAAuB,CACrC,WAA+B,iBAAiB;IAKhD,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC;IACvC,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,GAAG,8BAA8B,EAAE,CAAC;IAEtD,MAAM,EAAC,oBAAoB,EAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;IAE/C,MAAM,gBAAgB,GAAG,oBAAoB;QAC3C,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,oBAAoB,CAAC;QAC5E,CAAC,CAAC,IAAI,CAAC;IAET,MAAM,wBAAwB,GAAG,WAAW,CAC1C,CAAC,WAAmB,EAAE,EAAE;QACtB,GAAG,CAAC,oBAAoB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IAClD,CAAC,EACD,CAAC,GAAG,EAAE,QAAQ,CAAC,CAChB,CAAC;IAEF,OAAO,EAAC,gBAAgB,EAAE,wBAAwB,EAAU,CAAC;AAC/D,CAAC;AAED,MAAM,UAAU,iCAAiC;IAI/C,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IACrC,MAAM,CAAC,KAAK,CAAC,GAAG,8BAA8B,EAAE,CAAC;IAEjD,SAAS,2BAA2B,CAAC,QAAgB;QACnD,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC;QACvC,MAAM,EAAC,oBAAoB,EAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;QAE/C,OAAO,oBAAoB;YACzB,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CACpB,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,oBAAoB,CACnD;YACH,CAAC,CAAC,IAAI,CAAC;IACX,CAAC;IAED,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAE3C,MAAM,MAAM,GAAqD,EAAE,CAAC;IACpE,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;QAC7B,MAAM,CAAC,QAAQ,CAAC,GAAG,2BAA2B,CAAC,QAAQ,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/lib/utils/docsUtils.d.ts

@@ -4,4 +4,25 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
+import { ReactNode } from 'react';
+import { PropSidebar, PropSidebarItem, PropSidebarItemCategory, PropVersionDoc, PropVersionMetadata } from '@docusaurus/plugin-content-docs';
 export declare const isDocsPluginEnabled: boolean;
+declare const EmptyContextValue: unique symbol;
+export declare function DocsVersionProvider({ children, version, }: {
+    children: ReactNode;
+    version: PropVersionMetadata | typeof EmptyContextValue;
+}): JSX.Element;
+export declare function useDocsVersion(): PropVersionMetadata;
+export declare function useDocById(id: string): PropVersionDoc;
+export declare function useDocById(id: string | undefined): PropVersionDoc | undefined;
+export declare function DocsSidebarProvider({ children, sidebar, }: {
+    children: ReactNode;
+    sidebar: PropSidebar | null;
+}): JSX.Element;
+export declare function useDocsSidebar(): PropSidebar | null;
+export declare function findSidebarCategory(sidebar: PropSidebar, predicate: (category: PropSidebarItemCategory) => boolean): PropSidebarItemCategory | undefined;
+export declare function findFirstCategoryLink(item: PropSidebarItemCategory): string | undefined;
+export declare function useCurrentSidebarCategory(): PropSidebarItemCategory;
+export declare function isActiveSidebarItem(item: PropSidebarItem, activePath: string): boolean;
+export {};
+//# sourceMappingURL=docsUtils.d.ts.map

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

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

package/lib/utils/docsUtils.js

@@ -4,6 +4,113 @@
  * 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;
+}
+//# sourceMappingURL=docsUtils.js.map

package/lib/utils/docsUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"docsUtils.js","sourceRoot":"","sources":["../../src/utils/docsUtils.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,EAAC,aAAa,EAAa,UAAU,EAAC,MAAM,OAAO,CAAC;AAClE,OAAO,EAAC,cAAc,EAAC,MAAM,sBAAsB,CAAC;AAQpD,OAAO,EAAC,UAAU,EAAC,MAAM,aAAa,CAAC;AACvC,OAAO,EAAC,WAAW,EAAC,MAAM,oBAAoB,CAAC;AAE/C,qCAAqC;AACrC,MAAM,CAAC,MAAM,mBAAmB,GAAY,CAAC,CAAC,cAAc,CAAC;AAE7D,mFAAmF;AACnF,6FAA6F;AAC7F,MAAM,iBAAiB,GAAkB,MAAM,CAAC,cAAc,CAAC,CAAC;AAEhE,MAAM,kBAAkB,GAAG,aAAa,CAEtC,iBAAiB,CAAC,CAAC;AAErB,MAAM,UAAU,mBAAmB,CAAC,EAClC,QAAQ,EACR,OAAO,GAIR;IACC,OAAO,CACL,oBAAC,kBAAkB,CAAC,QAAQ,IAAC,KAAK,EAAE,OAAO,IACxC,QAAQ,CACmB,CAC/B,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,cAAc;IAC5B,MAAM,OAAO,GAAG,UAAU,CAAC,kBAAkB,CAAC,CAAC;IAC/C,IAAI,OAAO,KAAK,iBAAiB,EAAE;QACjC,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;KACtE;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAID,MAAM,UAAU,UAAU,CAAC,EAAsB;IAC/C,MAAM,OAAO,GAAG,cAAc,EAAE,CAAC;IACjC,IAAI,CAAC,EAAE,EAAE;QACP,OAAO,SAAS,CAAC;KAClB;IACD,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC7B,IAAI,CAAC,GAAG,EAAE;QACR,MAAM,IAAI,KAAK,CAAC,8BAA8B,EAAE,EAAE,CAAC,CAAC;KACrD;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,kBAAkB,GAAG,aAAa,CAEtC,iBAAiB,CAAC,CAAC;AAErB,MAAM,UAAU,mBAAmB,CAAC,EAClC,QAAQ,EACR,OAAO,GAIR;IACC,OAAO,CACL,oBAAC,kBAAkB,CAAC,QAAQ,IAAC,KAAK,EAAE,OAAO,IACxC,QAAQ,CACmB,CAC/B,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,cAAc;IAC5B,MAAM,OAAO,GAAG,UAAU,CAAC,kBAAkB,CAAC,CAAC;IAC/C,IAAI,OAAO,KAAK,iBAAiB,EAAE;QACjC,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;KACtE;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,sDAAsD;AACtD,kEAAkE;AAClE,MAAM,UAAU,mBAAmB,CACjC,OAAoB,EACpB,SAAyD;IAEzD,gDAAgD;IAChD,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE;QAC1B,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU,EAAE;YAC5B,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE;gBACnB,OAAO,IAAI,CAAC;aACb;iBAAM;gBACL,MAAM,OAAO,GAAG,mBAAmB,CAAC,IAAI,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;gBAC3D,IAAI,OAAO,EAAE;oBACX,OAAO,OAAO,CAAC;iBAChB;aACF;SACF;KACF;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,4EAA4E;AAC5E,MAAM,UAAU,qBAAqB,CACnC,IAA6B;IAE7B,IAAI,IAAI,CAAC,IAAI,EAAE;QACb,OAAO,IAAI,CAAC,IAAI,CAAC;KAClB;IAED,gDAAgD;IAChD,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,KAAK,EAAE;QAChC,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE;YAC3B,OAAO,OAAO,CAAC,IAAI,CAAC;SACrB;QACD,IAAI,OAAO,CAAC,IAAI,KAAK,UAAU,EAAE;YAC/B,MAAM,YAAY,GAAG,qBAAqB,CAAC,OAAO,CAAC,CAAC;YACpD,IAAI,YAAY,EAAE;gBAChB,OAAO,YAAY,CAAC;aACrB;SACF;aAAM;YACL,MAAM,IAAI,KAAK,CACb,qCAAqC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAC/D,CAAC;SACH;KACF;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,MAAM,UAAU,yBAAyB;IACvC,MAAM,EAAC,QAAQ,EAAC,GAAG,WAAW,EAAE,CAAC;IACjC,MAAM,OAAO,GAAG,cAAc,EAAE,CAAC;IACjC,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;KACrE;IACD,MAAM,QAAQ,GAAG,mBAAmB,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE,CACrD,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAChC,CAAC;IACF,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,IAAI,KAAK,CACb,iEAAiE,QAAQ;uEACR,CAClE,CAAC;KACH;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,yBAAyB,CAChC,KAAwB,EACxB,UAAkB;IAElB,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,mBAAmB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC;AAC3E,CAAC;AAED,MAAM,UAAU,mBAAmB,CACjC,IAAqB,EACrB,UAAkB;IAElB,MAAM,QAAQ,GAAG,CAAC,UAA8B,EAAE,EAAE,CAClD,OAAO,UAAU,KAAK,WAAW,IAAI,UAAU,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IAE1E,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE;QACxB,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;KAC5B;IAED,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU,EAAE;QAC5B,OAAO,CACL,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,yBAAyB,CAAC,IAAI,CAAC,KAAK,EAAE,UAAU,CAAC,CACzE,CAAC;KACH;IAED,OAAO,KAAK,CAAC;AACf,CAAC"}

package/lib/utils/generalUtils.d.ts

@@ -1 +1,8 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
 export declare const useTitleFormatter: (title?: string | undefined) => string;
+//# sourceMappingURL=generalUtils.d.ts.map

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

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

package/lib/utils/generalUtils.js

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

package/lib/utils/generalUtils.js.map

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

package/lib/utils/historyUtils.d.ts

@@ -0,0 +1,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.
+ */
+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 {};
+//# sourceMappingURL=historyUtils.d.ts.map

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

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

package/lib/utils/historyUtils.js

@@ -0,0 +1,40 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { useEffect, useRef } from 'react';
+import { useHistory } from '@docusaurus/router';
+/*
+Permits to register a handler that will be called on history actions (pop,push,replace)
+If the handler returns false, the navigation transition will be blocked/cancelled
+ */
+export function useHistoryActionHandler(handler) {
+    const { block } = useHistory();
+    // Avoid stale closure issues without triggering useless re-renders
+    const lastHandlerRef = useRef(handler);
+    useEffect(() => {
+        lastHandlerRef.current = handler;
+    }, [handler]);
+    useEffect(() => 
+    // See https://github.com/remix-run/history/blob/main/docs/blocking-transitions.md
+    block((location, action) => lastHandlerRef.current(location, action)), [block, lastHandlerRef]);
+}
+/*
+Permits to register a handler that will be called on history pop navigation (backward/forward)
+If the handler returns false, the backward/forward transition will be blocked
+
+Unfortunately there's no good way to detect the "direction" (backward/forward) of the POP event.
+ */
+export function useHistoryPopHandler(handler) {
+    useHistoryActionHandler((location, action) => {
+        if (action === 'POP') {
+            // Eventually block navigation if handler returns false
+            return handler(location, action);
+        }
+        // Don't block other navigation actions
+        return undefined;
+    });
+}
+//# sourceMappingURL=historyUtils.js.map

package/lib/utils/historyUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"historyUtils.js","sourceRoot":"","sources":["../../src/utils/historyUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAC,SAAS,EAAE,MAAM,EAAC,MAAM,OAAO,CAAC;AACxC,OAAO,EAAC,UAAU,EAAC,MAAM,oBAAoB,CAAC;AAK9C;;;GAGG;AACH,MAAM,UAAU,uBAAuB,CAAC,OAA4B;IAClE,MAAM,EAAC,KAAK,EAAC,GAAG,UAAU,EAAE,CAAC;IAE7B,mEAAmE;IACnE,MAAM,cAAc,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;IACvC,SAAS,CAAC,GAAG,EAAE;QACb,cAAc,CAAC,OAAO,GAAG,OAAO,CAAC;IACnC,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IAEd,SAAS,CACP,GAAG,EAAE;IACH,kFAAkF;IAClF,KAAK,CAAC,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,CAAC,cAAc,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,EACvE,CAAC,KAAK,EAAE,cAAc,CAAC,CACxB,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CAAC,OAA4B;IAC/D,uBAAuB,CAAC,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE;QAC3C,IAAI,MAAM,KAAK,KAAK,EAAE;YACpB,uDAAuD;YACvD,OAAO,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;SAClC;QACD,uCAAuC;QACvC,OAAO,SAAS,CAAC;IACnB,CAAC,CAAC,CAAC;AACL,CAAC"}

package/lib/utils/jsUtils.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.
+ */
+/**
+ * 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[];
+//# sourceMappingURL=jsUtils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"jsUtils.d.ts","sourceRoot":"","sources":["../../src/utils/jsUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAC1B,GAAG,EAAE,SAAS,CAAC,EAAE,EACjB,UAAU,GAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,OAA2B,GACtD,CAAC,EAAE,CAIL;AAED;;;;GAIG;AACH,wBAAgB,IAAI,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,CAGrC"}

package/lib/utils/jsUtils.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.
+ */
+// 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));
+}
+//# sourceMappingURL=jsUtils.js.map

package/lib/utils/jsUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsUtils.js","sourceRoot":"","sources":["../../src/utils/jsUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,yCAAyC;AAEzC;;;;;GAKG;AACH,MAAM,UAAU,UAAU,CACxB,GAAiB,EACjB,aAAsC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC;IAEvD,OAAO,GAAG,CAAC,MAAM,CACf,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,MAAM,CACjE,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,IAAI,CAAI,GAAQ;IAC9B,oHAAoH;IACpH,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;AAClC,CAAC"}

package/lib/utils/mobileSecondaryMenu.d.ts

@@ -8,8 +8,8 @@ import { ReactNode, ComponentType } from 'react';
 declare type ExtraProps = {
     toggleSidebar: () => void;
 };
-export declare type MobileSecondaryMenuComponent<Props extends unknown> = ComponentType<Props & ExtraProps>;
-export declare function MobileSecondaryMenuProvider({ children }: {
+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;
@@ -18,3 +18,4 @@ export declare function MobileSecondaryMenuFiller<Props extends Record<string, u
     props: Props;
 }): JSX.Element | null;
 export {};
+//# sourceMappingURL=mobileSecondaryMenu.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"mobileSecondaryMenu.d.ts","sourceRoot":"","sources":["../../src/utils/mobileSecondaryMenu.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAc,EAEZ,SAAS,EAIT,aAAa,EAEd,MAAM,OAAO,CAAC;AAYf,aAAK,UAAU,GAAG;IAChB,aAAa,EAAE,MAAM,IAAI,CAAC;CAC3B,CAAC;AAEF,oBAAY,4BAA4B,CAAC,KAAK,IAAI,aAAa,CAC7D,KAAK,GAAG,UAAU,CACnB,CAAC;AAeF,wBAAgB,2BAA2B,CAAC,EAC1C,QAAQ,GACT,EAAE;IACD,QAAQ,EAAE,SAAS,CAAC;CACrB,GAAG,GAAG,CAAC,OAAO,CAId;AAYD,wBAAgB,8BAA8B,IAAI,CAChD,UAAU,EAAE,UAAU,KACnB,SAAS,GAAG,SAAS,CASzB;AAYD,wBAAgB,yBAAyB,CACvC,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACrC,EACA,SAAS,EACT,KAAK,GACN,EAAE;IACD,SAAS,EAAE,4BAA4B,CAAC,KAAK,GAAG,UAAU,CAAC,CAAC;IAC5D,KAAK,EAAE,KAAK,CAAC;CACd,GAAG,GAAG,CAAC,OAAO,GAAG,IAAI,CAcrB"}

package/lib/utils/mobileSecondaryMenu.js

@@ -9,7 +9,7 @@ function useContextValue() {
     return useState(null);
 }
 const Context = createContext(null);
-export function MobileSecondaryMenuProvider({ children }) {
+export function MobileSecondaryMenuProvider({ children, }) {
     return (React.createElement(Context.Provider, { value: useContextValue() }, children));
 }
 function useMobileSecondaryMenuContext() {
@@ -32,6 +32,7 @@ export function useMobileSecondaryMenuRenderer() {
 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
@@ -43,8 +44,7 @@ export function MobileSecondaryMenuFiller({ component, props, }) {
         // @ts-expect-error: context is not 100% typesafe but it's ok
         setState({ component, props: memoizedProps });
     }, [setState, component, memoizedProps]);
-    useEffect(() => {
-        return () => setState(null);
-    }, [setState]);
+    useEffect(() => () => setState(null), [setState]);
     return null;
 }
+//# sourceMappingURL=mobileSecondaryMenu.js.map

package/lib/utils/mobileSecondaryMenu.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mobileSecondaryMenu.js","sourceRoot":"","sources":["../../src/utils/mobileSecondaryMenu.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,EACZ,QAAQ,EAER,UAAU,EACV,aAAa,EACb,SAAS,EAET,OAAO,GACR,MAAM,OAAO,CAAC;AAyBf,SAAS,eAAe;IACtB,OAAO,QAAQ,CAAQ,IAAI,CAAC,CAAC;AAC/B,CAAC;AAID,MAAM,OAAO,GAAG,aAAa,CAAsB,IAAI,CAAC,CAAC;AAEzD,MAAM,UAAU,2BAA2B,CAAC,EAC1C,QAAQ,GAGT;IACC,OAAO,CACL,oBAAC,OAAO,CAAC,QAAQ,IAAC,KAAK,EAAE,eAAe,EAAE,IAAG,QAAQ,CAAoB,CAC1E,CAAC;AACJ,CAAC;AAED,SAAS,6BAA6B;IACpC,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IAClC,IAAI,KAAK,KAAK,IAAI,EAAE;QAClB,MAAM,IAAI,KAAK,CACb,2EAA2E,CAC5E,CAAC;KACH;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,UAAU,8BAA8B;IAG5C,MAAM,CAAC,KAAK,CAAC,GAAG,6BAA6B,EAAE,CAAC;IAChD,IAAI,KAAK,EAAE;QACT,MAAM,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC;QAC7B,OAAO,SAAS,MAAM,CAAC,UAAU;YAC/B,OAAO,oBAAC,IAAI,OAAK,KAAK,CAAC,KAAK,KAAM,UAAU,GAAI,CAAC;QACnD,CAAC,CAAC;KACH;IACD,OAAO,GAAG,EAAE,CAAC,SAAS,CAAC;AACzB,CAAC;AAED,SAAS,wBAAwB,CAAoC,GAAM;IACzE,OAAO,OAAO,CACZ,GAAG,EAAE,CAAC,GAAG;IACT,gBAAgB;IAChB,uDAAuD;IACvD,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAC7C,CAAC;AACJ,CAAC;AAED,6DAA6D;AAC7D,MAAM,UAAU,yBAAyB,CAEvC,EACA,SAAS,EACT,KAAK,GAIN;IACC,MAAM,CAAC,EAAE,QAAQ,CAAC,GAAG,6BAA6B,EAAE,CAAC;IAErD,oEAAoE;IACpE,MAAM,aAAa,GAAG,wBAAwB,CAAC,KAAK,CAAC,CAAC;IAEtD,SAAS,CAAC,GAAG,EAAE;QACb,6DAA6D;QAC7D,QAAQ,CAAC,EAAC,SAAS,EAAE,KAAK,EAAE,aAAa,EAAC,CAAC,CAAC;IAC9C,CAAC,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC,CAAC;IAEzC,SAAS,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;IAElD,OAAO,IAAI,CAAC;AACd,CAAC"}