@docusaurus/theme-common 2.0.0-beta.fc64c12e4 → 2.0.0

package/lib/utils/useAlternatePageUtils.d.ts

@@ -4,9 +4,29 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
+/**
+ * Permits to obtain the url of the current page in another locale, useful to
+ * generate hreflang meta headers etc...
+ *
+ * @see https://developers.google.com/search/docs/advanced/crawling/localized-versions
+ */
 export declare function useAlternatePageUtils(): {
-    createUrl: ({ locale, fullyQualified, }: {
+    /**
+     * Everything (pathname, base URL, etc.) is read from the context. Just tell
+     * it which locale to link to and it will give you the alternate link for the
+     * current page.
+     */
+    createUrl: ({ 
+    /** The locale name to link to. */
+    locale, 
+    /**
+     * For hreflang SEO headers, we need it to be fully qualified (full
+     * protocol/domain/path...); but for locale dropdowns, using a pathname is
+     * good enough.
+     */
+    fullyQualified, }: {
         locale: string;
         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;AAKH;;;;;GAKG;AACH,wBAAgB,qBAAqB,IAAI;IACvC;;;;OAIG;IACH,SAAS,EAAE,CAAC;IACV,kCAAkC;IAClC,MAAM;IACN;;;;OAIG;IACH,cAAc,GACf,EAAE;QACD,MAAM,EAAE,MAAM,CAAC;QACf,cAAc,EAAE,OAAO,CAAC;KACzB,KAAK,MAAM,CAAC;CACd,CAmCA"}

package/lib/utils/useAlternatePageUtils.js

@@ -6,9 +6,12 @@
  */
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
 import { useLocation } from '@docusaurus/router';
-// Permits to obtain the url of the current page in another locale
-// Useful to generate hreflang meta headers etc...
-// See https://developers.google.com/search/docs/advanced/crawling/localized-versions
+/**
+ * Permits to obtain the url of the current page in another locale, useful to
+ * generate hreflang meta headers etc...
+ *
+ * @see https://developers.google.com/search/docs/advanced/crawling/localized-versions
+ */
 export function useAlternatePageUtils() {
     const { siteConfig: { baseUrl, url }, i18n: { defaultLocale, currentLocale }, } = useDocusaurusContext();
     const { pathname } = useLocation();
@@ -21,9 +24,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;;;;;GAKG;AACH,MAAM,UAAU,qBAAqB;IAoBnC,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,GAIf;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/useLocalPathname.d.ts

@@ -4,4 +4,10 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
+/**
+ * Get the pathname of current route, without the optional site baseUrl.
+ * - `/docs/myDoc` => `/docs/myDoc`
+ * - `/baseUrl/docs/myDoc` => `/docs/myDoc`
+ */
 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;AAKH;;;;GAIG;AACH,wBAAgB,gBAAgB,IAAI,MAAM,CAMzC"}

package/lib/utils/useLocalPathname.js

@@ -4,13 +4,16 @@
  * 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
+import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
+/**
+ * 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,EAAC,WAAW,EAAC,MAAM,oBAAoB,CAAC;AAC/C,OAAO,oBAAoB,MAAM,kCAAkC,CAAC;AAEpE;;;;GAIG;AACH,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

@@ -4,11 +4,14 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { Location } from '@docusaurus/history';
-declare type LocationChangeEvent = {
+import type { Location } from 'history';
+/**
+ * Fires an effect when the location changes (which includes hash, query, etc.).
+ * Importantly, doesn't fire when there's no previous location: see
+ * https://github.com/facebook/docusaurus/pull/6696
+ */
+export declare function useLocationChange(onLocationChange: (locationChangeEvent: {
     location: Location;
     previousLocation: Location | undefined;
-};
-declare type OnLocationChange = (locationChangeEvent: LocationChangeEvent) => void;
-export declare function useLocationChange(onLocationChange: OnLocationChange): void;
-export {};
+}) => void): void;
+//# 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;AAKH,OAAO,KAAK,EAAC,QAAQ,EAAC,MAAM,SAAS,CAAC;AAEtC;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC/B,gBAAgB,EAAE,CAAC,mBAAmB,EAAE;IACtC,QAAQ,EAAE,QAAQ,CAAC;IACnB,gBAAgB,EAAE,QAAQ,GAAG,SAAS,CAAC;CACxC,KAAK,IAAI,GACT,IAAI,CAkBN"}

package/lib/utils/useLocationChange.js

@@ -4,22 +4,28 @@
  * 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 { useEffect } from 'react';
 import { useLocation } from '@docusaurus/router';
-import { usePrevious } from './usePrevious';
+import { useEvent, usePrevious } from './reactUtils';
+/**
+ * Fires an effect when the location changes (which includes hash, query, etc.).
+ * Importantly, doesn't fire when there's no previous location: see
+ * https://github.com/facebook/docusaurus/pull/6696
+ */
 export function useLocationChange(onLocationChange) {
     const location = useLocation();
     const previousLocation = usePrevious(location);
-    const isFirst = useRef(true);
+    const onLocationChangeDynamic = useEvent(onLocationChange);
     useEffect(() => {
-        // Prevent first effect to trigger the listener on mount
-        if (isFirst.current) {
-            isFirst.current = false;
+        if (!previousLocation) {
             return;
         }
-        onLocationChange({
-            location,
-            previousLocation,
-        });
-    }, [location]);
+        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;AAC/C,OAAO,EAAC,QAAQ,EAAE,WAAW,EAAC,MAAM,cAAc,CAAC;AAGnD;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAC/B,gBAGU;IAEV,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAC;IAC/B,MAAM,gBAAgB,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC;IAE/C,MAAM,uBAAuB,GAAG,QAAQ,CAAC,gBAAgB,CAAC,CAAC;IAE3D,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

@@ -4,6 +4,18 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
+/**
+ * Reads the current locale and returns an interface very similar to
+ * `Intl.PluralRules`.
+ */
 export declare function usePluralForm(): {
+    /**
+     * Give it a `count` and it will select the relevant message from
+     * `pluralMessages`. `pluralMessages` should be separated by `|`, and in the
+     * order of "zero", "one", "two", "few", "many", "other". The actual selection
+     * is done by `Intl.PluralRules`, which tells us all plurals the locale has
+     * and which plural we should use for `count`.
+     */
     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;AA0GH;;;GAGG;AACH,wBAAgB,aAAa,IAAI;IAC/B;;;;;;OAMG;IACH,aAAa,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,KAAK,MAAM,CAAC;CAClE,CAMA"}

package/lib/utils/usePluralForm.js

@@ -34,36 +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-)
-        if (Intl.PluralRules) {
-            try {
-                return createLocalePluralForms(currentLocale);
-            }
-            catch (e) {
-                console.error(`Failed to use Intl.PluralRules for locale "${currentLocale}".
-Docusaurus will fallback to a default/fallback (English) Intl.PluralRules implementation.
-`);
-                return EnglishPluralForms;
-            }
+        try {
+            return createLocalePluralForms(currentLocale);
         }
-        else {
-            console.error(`Intl.PluralRules not available!
-Docusaurus will fallback to a default/fallback (English) Intl.PluralRules implementation.
-        `);
+        catch (err) {
+            console.error(`Failed to use Intl.PluralRules for locale "${currentLocale}".
+Docusaurus will fallback to the default (English) implementation.
+Error: ${err.message}
+`);
             return EnglishPluralForms;
         }
     }, [currentLocale]);
@@ -74,21 +71,23 @@ 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.join(',')}), but the message contains ${parts.length}: ${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)];
 }
+/**
+ * Reads the current locale and returns an interface very similar to
+ * `Intl.PluralRules`.
+ */
 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

package/lib/utils/usePluralForm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"usePluralForm.js","sourceRoot":"","sources":["../../src/utils/usePluralForm.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAC,OAAO,EAAC,MAAM,OAAO,CAAC;AAC9B,OAAO,oBAAoB,MAAM,kCAAkC,CAAC;AAEpE,6DAA6D;AAC7D,mEAAmE;AACnE,qEAAqE;AACrE,MAAM,kBAAkB,GAA0B;IAChD,MAAM;IACN,KAAK;IACL,KAAK;IACL,KAAK;IACL,MAAM;IACN,OAAO;CACR,CAAC;AACF,SAAS,eAAe,CACtB,WAAkC;IAElC,OAAO,kBAAkB,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;AACrE,CAAC;AAQD,4CAA4C;AAC5C,MAAM,kBAAkB,GAAsB;IAC5C,MAAM,EAAE,IAAI;IACZ,WAAW,EAAE,eAAe,CAAC,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAC9C,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC;CACnD,CAAC;AAEF,SAAS,uBAAuB,CAAC,MAAc;IAC7C,MAAM,WAAW,GAAG,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IACjD,OAAO;QACL,MAAM;QACN,WAAW,EAAE,eAAe,CAC1B,WAAW,CAAC,eAAe,EAAE,CAAC,gBAAgB,CAC/C;QACD,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC;KAC7C,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,SAAS,oBAAoB;IAC3B,MAAM,EACJ,IAAI,EAAE,EAAC,aAAa,EAAC,GACtB,GAAG,oBAAoB,EAAE,CAAC;IAC3B,OAAO,OAAO,CAAC,GAAG,EAAE;QAClB,IAAI;YACF,OAAO,uBAAuB,CAAC,aAAa,CAAC,CAAC;SAC/C;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO,CAAC,KAAK,CAAC,8CAA8C,aAAa;;SAErE,GAAa,CAAC,OAAO;CAC9B,CAAC,CAAC;YACG,OAAO,kBAAkB,CAAC;SAC3B;IACH,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC;AACtB,CAAC;AAED,SAAS,mBAAmB,CAC1B,cAAsB,EACtB,KAAa,EACb,iBAAoC;IAEpC,MAAM,SAAS,GAAG,GAAG,CAAC;IACtB,MAAM,KAAK,GAAG,cAAc,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IAE9C,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;QACtB,OAAO,KAAK,CAAC,CAAC,CAAE,CAAC;KAClB;IACD,IAAI,KAAK,CAAC,MAAM,GAAG,iBAAiB,CAAC,WAAW,CAAC,MAAM,EAAE;QACvD,OAAO,CAAC,KAAK,CACX,cAAc,iBAAiB,CAAC,MAAM,kBACpC,iBAAiB,CAAC,WAAW,CAAC,MAChC,+BAA+B,iBAAiB,CAAC,WAAW,CAAC,IAAI,CAC/D,GAAG,CACJ,+BAA+B,KAAK,CAAC,MAAM,KAAK,cAAc,EAAE,CAClE,CAAC;KACH;IACD,MAAM,UAAU,GAAG,iBAAiB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACnD,MAAM,eAAe,GAAG,iBAAiB,CAAC,WAAW,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAC1E,2EAA2E;IAC3E,iCAAiC;IACjC,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,eAAe,EAAE,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAE,CAAC;AAC7D,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,aAAa;IAU3B,MAAM,gBAAgB,GAAG,oBAAoB,EAAE,CAAC;IAChD,OAAO;QACL,aAAa,EAAE,CAAC,KAAa,EAAE,cAAsB,EAAU,EAAE,CAC/D,mBAAmB,CAAC,cAAc,EAAE,KAAK,EAAE,gBAAgB,CAAC;KAC/D,CAAC;AACJ,CAAC"}

package/lib/utils/useThemeConfig.d.ts

@@ -1,21 +1,35 @@
-import { PrismTheme } from 'prism-react-renderer';
-import { CSSProperties } from 'react';
+/**
+ * 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 { PrismTheme } from 'prism-react-renderer';
+import type { DeepPartial } from 'utility-types';
+import type { MagicCommentConfig } from './codeBlockUtils';
 export declare type DocsVersionPersistence = 'localStorage' | 'none';
 export declare type NavbarItem = {
     type?: string | undefined;
     items?: NavbarItem[];
     label?: string;
     position?: 'left' | 'right';
+} & {
+    [key: string]: unknown;
 };
-export declare type NavbarLogo = {
+declare type BaseLogo = {
+    alt?: string;
     src: string;
     srcDark?: string;
     href?: string;
+    width?: string | number;
+    height?: string | number;
     target?: string;
-    alt?: string;
+    style?: object;
+    className?: string;
 };
+export declare type NavbarLogo = BaseLogo;
 export declare type Navbar = {
-    style: 'dark' | 'primary';
+    style?: 'dark' | 'primary';
     hideOnScroll: boolean;
     title?: string;
     items: NavbarItem[];
@@ -25,12 +39,6 @@ export declare type ColorModeConfig = {
     defaultMode: 'light' | 'dark';
     disableSwitch: boolean;
     respectPrefersColorScheme: boolean;
-    switchConfig: {
-        darkIcon: string;
-        darkIconStyle: CSSProperties;
-        lightIcon: string;
-        lightIconStyle: CSSProperties;
-    };
 };
 export declare type AnnouncementBarConfig = {
     id: string;
@@ -40,10 +48,11 @@ export declare type AnnouncementBarConfig = {
     isCloseable: boolean;
 };
 export declare type PrismConfig = {
-    theme?: PrismTheme;
+    theme: PrismTheme;
     darkTheme?: PrismTheme;
     defaultLanguage?: string;
-    additionalLanguages?: string[];
+    additionalLanguages: string[];
+    magicComments: MagicCommentConfig[];
 };
 export declare type FooterLinkItem = {
     label?: string;
@@ -51,34 +60,52 @@ export declare type FooterLinkItem = {
     href?: string;
     html?: string;
     prependBaseUrlToHref?: string;
+} & {
+    [key: string]: unknown;
 };
-export declare type FooterLinks = {
-    title?: string;
-    items: FooterLinkItem[];
-};
-export declare type Footer = {
+export declare type FooterLogo = BaseLogo;
+export declare type FooterBase = {
     style: 'light' | 'dark';
-    logo?: {
-        alt?: string;
-        src?: string;
-        srcDark?: string;
-        href?: string;
-    };
+    logo?: FooterLogo;
     copyright?: string;
-    links: FooterLinks[];
+};
+export declare type MultiColumnFooter = FooterBase & {
+    links: {
+        title: string | null;
+        items: FooterLinkItem[];
+    }[];
+};
+export declare type SimpleFooter = FooterBase & {
+    links: FooterLinkItem[];
+};
+export declare type Footer = MultiColumnFooter | SimpleFooter;
+export declare type TableOfContents = {
+    minHeadingLevel: number;
+    maxHeadingLevel: number;
 };
 export declare type ThemeConfig = {
     docs: {
         versionPersistence: DocsVersionPersistence;
+        sidebar: {
+            hideable: boolean;
+            autoCollapseCategories: boolean;
+        };
     };
     navbar: Navbar;
     colorMode: ColorModeConfig;
     announcementBar?: AnnouncementBarConfig;
     prism: PrismConfig;
     footer?: Footer;
-    hideableSidebar: boolean;
-    image: string;
-    metadatas: Array<Record<string, string>>;
-    sidebarCollapsible: boolean;
+    image?: string;
+    metadata: {
+        [key: string]: string;
+    }[];
+    tableOfContents: TableOfContents;
 };
+export declare type UserThemeConfig = DeepPartial<ThemeConfig>;
+/**
+ * A convenient/more semantic way to get theme config from context.
+ */
 export declare function useThemeConfig(): ThemeConfig;
+export {};
+//# sourceMappingURL=useThemeConfig.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useThemeConfig.d.ts","sourceRoot":"","sources":["../../src/utils/useThemeConfig.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,sBAAsB,CAAC;AACrD,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,eAAe,CAAC;AAC/C,OAAO,KAAK,EAAC,kBAAkB,EAAC,MAAM,kBAAkB,CAAC;AAEzD,oBAAY,sBAAsB,GAAG,cAAc,GAAG,MAAM,CAAC;AAG7D,oBAAY,UAAU,GAAG;IACvB,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,KAAK,CAAC,EAAE,UAAU,EAAE,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CAC7B,GAAG;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAAC,CAAC;AAE7B,aAAK,QAAQ,GAAG;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,oBAAY,UAAU,GAAG,QAAQ,CAAC;AAGlC,oBAAY,MAAM,GAAG;IACnB,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,YAAY,EAAE,OAAO,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,UAAU,EAAE,CAAC;IACpB,IAAI,CAAC,EAAE,UAAU,CAAC;CACnB,CAAC;AAEF,oBAAY,eAAe,GAAG;IAC5B,WAAW,EAAE,OAAO,GAAG,MAAM,CAAC;IAC9B,aAAa,EAAE,OAAO,CAAC;IACvB,yBAAyB,EAAE,OAAO,CAAC;CACpC,CAAC;AAEF,oBAAY,qBAAqB,GAAG;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,MAAM,CAAC;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF,oBAAY,WAAW,GAAG;IACxB,KAAK,EAAE,UAAU,CAAC;IAClB,SAAS,CAAC,EAAE,UAAU,CAAC;IACvB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAC9B,aAAa,EAAE,kBAAkB,EAAE,CAAC;CACrC,CAAC;AAEF,oBAAY,cAAc,GAAG;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B,GAAG;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAAC,CAAC;AAE7B,oBAAY,UAAU,GAAG,QAAQ,CAAC;AAElC,oBAAY,UAAU,GAAG;IACvB,KAAK,EAAE,OAAO,GAAG,MAAM,CAAC;IACxB,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,oBAAY,iBAAiB,GAAG,UAAU,GAAG;IAC3C,KAAK,EAAE;QACL,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QACrB,KAAK,EAAE,cAAc,EAAE,CAAC;KACzB,EAAE,CAAC;CACL,CAAC;AAEF,oBAAY,YAAY,GAAG,UAAU,GAAG;IACtC,KAAK,EAAE,cAAc,EAAE,CAAC;CACzB,CAAC;AAEF,oBAAY,MAAM,GAAG,iBAAiB,GAAG,YAAY,CAAC;AAEtD,oBAAY,eAAe,GAAG;IAC5B,eAAe,EAAE,MAAM,CAAC;IACxB,eAAe,EAAE,MAAM,CAAC;CACzB,CAAC;AAGF,oBAAY,WAAW,GAAG;IACxB,IAAI,EAAE;QACJ,kBAAkB,EAAE,sBAAsB,CAAC;QAC3C,OAAO,EAAE;YACP,QAAQ,EAAE,OAAO,CAAC;YAClB,sBAAsB,EAAE,OAAO,CAAC;SACjC,CAAC;KACH,CAAC;IAOF,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,eAAe,CAAC;IAC3B,eAAe,CAAC,EAAE,qBAAqB,CAAC;IACxC,KAAK,EAAE,WAAW,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAC,EAAE,CAAC;IACpC,eAAe,EAAE,eAAe,CAAC;CAClC,CAAC;AAGF,oBAAY,eAAe,GAAG,WAAW,CAAC,WAAW,CAAC,CAAC;AAEvD;;GAEG;AACH,wBAAgB,cAAc,IAAI,WAAW,CAE5C"}

package/lib/utils/useThemeConfig.js

@@ -5,6 +5,10 @@
  * LICENSE file in the root directory of this source tree.
  */
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
+/**
+ * A convenient/more semantic way to get theme config from context.
+ */
 export function useThemeConfig() {
     return useDocusaurusContext().siteConfig.themeConfig;
 }
+//# sourceMappingURL=useThemeConfig.js.map

package/lib/utils/useThemeConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useThemeConfig.js","sourceRoot":"","sources":["../../src/utils/useThemeConfig.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,oBAAoB,MAAM,kCAAkC,CAAC;AA0HpE;;GAEG;AACH,MAAM,UAAU,cAAc;IAC5B,OAAO,oBAAoB,EAAE,CAAC,UAAU,CAAC,WAA0B,CAAC;AACtE,CAAC"}

package/package.json

@@ -1,12 +1,24 @@
 {
   "name": "@docusaurus/theme-common",
-  "version": "2.0.0-beta.fc64c12e4",
+  "version": "2.0.0",
   "description": "Common code for Docusaurus themes.",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
+  "sideEffects": [
+    "lib/components/Details/*",
+    "*.css"
+  ],
+  "exports": {
+    ".": "./lib/index.js",
+    "./internal": "./lib/internal.js",
+    "./Details": "./lib/components/Details/index.js"
+  },
   "scripts": {
-    "build": "node copyUntypedFiles.js && tsc",
-    "watch": "node copyUntypedFiles.js && tsc --watch"
+    "build": "tsc && node ../../admin/scripts/copyUntypedFiles.js",
+    "watch": "run-p -c copy:watch build:watch",
+    "build:watch": "tsc --watch",
+    "copy:watch": "node ../../admin/scripts/copyUntypedFiles.js --watch",
+    "removeThemeInternalReexport": "node removeThemeInternalReexport.mjs"
   },
   "publishConfig": {
     "access": "public"
@@ -18,25 +30,33 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "2.0.0-beta.fc64c12e4",
-    "@docusaurus/plugin-content-blog": "2.0.0-beta.fc64c12e4",
-    "@docusaurus/plugin-content-docs": "2.0.0-beta.fc64c12e4",
-    "@docusaurus/plugin-content-pages": "2.0.0-beta.fc64c12e4",
-    "@docusaurus/types": "2.0.0-beta.fc64c12e4",
-    "clsx": "^1.1.1",
-    "fs-extra": "^10.0.0",
-    "tslib": "^2.1.0"
+    "@docusaurus/mdx-loader": "2.0.0",
+    "@docusaurus/module-type-aliases": "2.0.0",
+    "@docusaurus/plugin-content-blog": "2.0.0",
+    "@docusaurus/plugin-content-docs": "2.0.0",
+    "@docusaurus/plugin-content-pages": "2.0.0",
+    "@docusaurus/utils": "2.0.0",
+    "@types/history": "^4.7.11",
+    "@types/react": "*",
+    "@types/react-router-config": "*",
+    "clsx": "^1.2.1",
+    "parse-numeric-range": "^1.3.0",
+    "prism-react-renderer": "^1.3.5",
+    "tslib": "^2.4.0",
+    "utility-types": "^3.10.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "2.0.0-beta.fc64c12e4"
+    "@docusaurus/core": "2.0.0",
+    "@docusaurus/types": "2.0.0",
+    "fs-extra": "^10.1.0",
+    "lodash": "^4.17.21"
   },
   "peerDependencies": {
-    "prism-react-renderer": "^1.2.1",
     "react": "^16.8.4 || ^17.0.0",
     "react-dom": "^16.8.4 || ^17.0.0"
   },
   "engines": {
-    "node": ">=12.13.0"
+    "node": ">=16.14"
   },
-  "gitHead": "830d9e29a94866f19318e19565b9e177af06b964"
+  "gitHead": "2a9e8f5ec807e49a973fc72326f1ef26092e977e"
 }