@docusaurus/theme-common 2.0.0-beta.1decd6f80 → 2.0.0-beta.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (250) hide show
  1. package/Details.d.ts +14 -0
  2. package/lib/components/Collapsible/index.d.ts +64 -0
  3. package/lib/components/Collapsible/index.d.ts.map +1 -0
  4. package/lib/components/Collapsible/index.js +152 -0
  5. package/lib/components/Collapsible/index.js.map +1 -0
  6. package/lib/components/Details/index.d.ts +17 -0
  7. package/lib/components/Details/index.d.ts.map +1 -0
  8. package/lib/components/Details/index.js +71 -0
  9. package/lib/components/Details/index.js.map +1 -0
  10. package/lib/components/Details/styles.module.css +62 -0
  11. package/lib/contexts/announcementBar.d.ts +22 -0
  12. package/lib/contexts/announcementBar.d.ts.map +1 -0
  13. package/lib/contexts/announcementBar.js +72 -0
  14. package/lib/contexts/announcementBar.js.map +1 -0
  15. package/lib/contexts/colorMode.d.ts +27 -0
  16. package/lib/contexts/colorMode.d.ts.map +1 -0
  17. package/lib/contexts/colorMode.js +132 -0
  18. package/lib/contexts/colorMode.js.map +1 -0
  19. package/lib/contexts/docSidebarItemsExpandedState.d.ts +31 -0
  20. package/lib/contexts/docSidebarItemsExpandedState.d.ts.map +1 -0
  21. package/lib/contexts/docSidebarItemsExpandedState.js +28 -0
  22. package/lib/contexts/docSidebarItemsExpandedState.js.map +1 -0
  23. package/lib/contexts/docsPreferredVersion.d.ts +31 -0
  24. package/lib/contexts/docsPreferredVersion.d.ts.map +1 -0
  25. package/lib/contexts/docsPreferredVersion.js +128 -0
  26. package/lib/contexts/docsPreferredVersion.js.map +1 -0
  27. package/lib/contexts/docsSidebar.d.ts +26 -0
  28. package/lib/contexts/docsSidebar.d.ts.map +1 -0
  29. package/lib/contexts/docsSidebar.js +30 -0
  30. package/lib/contexts/docsSidebar.js.map +1 -0
  31. package/lib/contexts/docsVersion.d.ts +20 -0
  32. package/lib/contexts/docsVersion.d.ts.map +1 -0
  33. package/lib/contexts/docsVersion.js +26 -0
  34. package/lib/contexts/docsVersion.js.map +1 -0
  35. package/lib/contexts/navbarMobileSidebar.d.ts +31 -0
  36. package/lib/contexts/navbarMobileSidebar.d.ts.map +1 -0
  37. package/lib/contexts/navbarMobileSidebar.js +56 -0
  38. package/lib/contexts/navbarMobileSidebar.js.map +1 -0
  39. package/lib/contexts/navbarSecondaryMenu/content.d.ts +37 -0
  40. package/lib/contexts/navbarSecondaryMenu/content.d.ts.map +1 -0
  41. package/lib/contexts/navbarSecondaryMenu/content.js +56 -0
  42. package/lib/contexts/navbarSecondaryMenu/content.js.map +1 -0
  43. package/lib/contexts/navbarSecondaryMenu/display.d.ts +24 -0
  44. package/lib/contexts/navbarSecondaryMenu/display.d.ts.map +1 -0
  45. package/lib/contexts/navbarSecondaryMenu/display.js +62 -0
  46. package/lib/contexts/navbarSecondaryMenu/display.js.map +1 -0
  47. package/lib/contexts/tabGroupChoice.d.ts +21 -0
  48. package/lib/contexts/tabGroupChoice.d.ts.map +1 -0
  49. package/lib/contexts/tabGroupChoice.js +49 -0
  50. package/lib/contexts/tabGroupChoice.js.map +1 -0
  51. package/lib/{utils/useChangeRoute.d.ts → hooks/styles.css} +4 -1
  52. package/lib/hooks/useBackToTopButton.d.ts +27 -0
  53. package/lib/hooks/useBackToTopButton.d.ts.map +1 -0
  54. package/lib/hooks/useBackToTopButton.js +50 -0
  55. package/lib/hooks/useBackToTopButton.js.map +1 -0
  56. package/lib/hooks/useCodeWordWrap.d.ts +14 -0
  57. package/lib/hooks/useCodeWordWrap.d.ts.map +1 -0
  58. package/lib/hooks/useCodeWordWrap.js +41 -0
  59. package/lib/hooks/useCodeWordWrap.js.map +1 -0
  60. package/lib/hooks/useHideableNavbar.d.ts +17 -0
  61. package/lib/hooks/useHideableNavbar.d.ts.map +1 -0
  62. package/lib/hooks/useHideableNavbar.js +60 -0
  63. package/lib/hooks/useHideableNavbar.js.map +1 -0
  64. package/lib/hooks/useKeyboardNavigation.d.ts +20 -0
  65. package/lib/hooks/useKeyboardNavigation.d.ts.map +1 -0
  66. package/lib/hooks/useKeyboardNavigation.js +39 -0
  67. package/lib/hooks/useKeyboardNavigation.js.map +1 -0
  68. package/lib/hooks/useLockBodyScroll.d.ts +12 -0
  69. package/lib/hooks/useLockBodyScroll.d.ts.map +1 -0
  70. package/lib/hooks/useLockBodyScroll.js +20 -0
  71. package/lib/hooks/useLockBodyScroll.js.map +1 -0
  72. package/lib/hooks/usePrismTheme.d.ts +13 -0
  73. package/lib/hooks/usePrismTheme.d.ts.map +1 -0
  74. package/lib/hooks/usePrismTheme.js +21 -0
  75. package/lib/hooks/usePrismTheme.js.map +1 -0
  76. package/lib/hooks/useSearchPage.d.ts +25 -0
  77. package/lib/hooks/useSearchPage.d.ts.map +1 -0
  78. package/lib/hooks/useSearchPage.js +43 -0
  79. package/lib/hooks/useSearchPage.js.map +1 -0
  80. package/lib/hooks/useSkipToContent.d.ts +25 -0
  81. package/lib/hooks/useSkipToContent.d.ts.map +1 -0
  82. package/lib/hooks/useSkipToContent.js +35 -0
  83. package/lib/hooks/useSkipToContent.js.map +1 -0
  84. package/lib/hooks/useTOCHighlight.d.ts +25 -0
  85. package/lib/hooks/useTOCHighlight.d.ts.map +1 -0
  86. package/lib/hooks/useTOCHighlight.js +130 -0
  87. package/lib/hooks/useTOCHighlight.js.map +1 -0
  88. package/lib/hooks/useWindowSize.d.ts +28 -0
  89. package/lib/hooks/useWindowSize.d.ts.map +1 -0
  90. package/lib/hooks/useWindowSize.js +59 -0
  91. package/lib/hooks/useWindowSize.js.map +1 -0
  92. package/lib/index.d.ts +39 -9
  93. package/lib/index.d.ts.map +1 -0
  94. package/lib/index.js +39 -8
  95. package/lib/index.js.map +1 -0
  96. package/lib/utils/ThemeClassNames.d.ts +47 -12
  97. package/lib/utils/ThemeClassNames.d.ts.map +1 -0
  98. package/lib/utils/ThemeClassNames.js +45 -4
  99. package/lib/utils/ThemeClassNames.js.map +1 -0
  100. package/lib/utils/codeBlockUtils.d.ts +63 -0
  101. package/lib/utils/codeBlockUtils.d.ts.map +1 -0
  102. package/lib/utils/codeBlockUtils.js +157 -3
  103. package/lib/utils/codeBlockUtils.js.map +1 -0
  104. package/lib/utils/docsUtils.d.ts +91 -0
  105. package/lib/utils/docsUtils.d.ts.map +1 -0
  106. package/lib/utils/docsUtils.js +217 -1
  107. package/lib/utils/docsUtils.js.map +1 -0
  108. package/lib/utils/footerUtils.d.ts +13 -0
  109. package/lib/utils/footerUtils.d.ts.map +1 -0
  110. package/lib/utils/footerUtils.js +14 -0
  111. package/lib/utils/footerUtils.js.map +1 -0
  112. package/lib/utils/generalUtils.d.ts +11 -1
  113. package/lib/utils/generalUtils.d.ts.map +1 -0
  114. package/lib/utils/generalUtils.js +9 -5
  115. package/lib/utils/generalUtils.js.map +1 -0
  116. package/lib/utils/historyUtils.d.ts +17 -0
  117. package/lib/utils/historyUtils.d.ts.map +1 -0
  118. package/lib/utils/historyUtils.js +38 -0
  119. package/lib/utils/historyUtils.js.map +1 -0
  120. package/lib/utils/jsUtils.d.ts +23 -0
  121. package/lib/utils/jsUtils.d.ts.map +1 -0
  122. package/lib/utils/jsUtils.js +29 -0
  123. package/lib/utils/jsUtils.js.map +1 -0
  124. package/lib/utils/metadataUtils.d.ts +38 -0
  125. package/lib/utils/metadataUtils.d.ts.map +1 -0
  126. package/lib/utils/metadataUtils.js +61 -0
  127. package/lib/utils/metadataUtils.js.map +1 -0
  128. package/lib/utils/navbarUtils.d.ts +21 -0
  129. package/lib/utils/navbarUtils.d.ts.map +1 -0
  130. package/lib/utils/navbarUtils.js +32 -0
  131. package/lib/utils/navbarUtils.js.map +1 -0
  132. package/lib/utils/reactUtils.d.ts +42 -0
  133. package/lib/utils/reactUtils.d.ts.map +1 -0
  134. package/lib/utils/reactUtils.js +64 -0
  135. package/lib/utils/reactUtils.js.map +1 -0
  136. package/lib/utils/regexpUtils.d.ts +12 -0
  137. package/lib/utils/regexpUtils.d.ts.map +1 -0
  138. package/lib/utils/regexpUtils.js +18 -0
  139. package/lib/utils/regexpUtils.js.map +1 -0
  140. package/lib/utils/routesUtils.d.ts +26 -0
  141. package/lib/utils/routesUtils.d.ts.map +1 -0
  142. package/lib/utils/routesUtils.js +54 -0
  143. package/lib/utils/routesUtils.js.map +1 -0
  144. package/lib/utils/scrollUtils.d.ts +83 -0
  145. package/lib/utils/scrollUtils.d.ts.map +1 -0
  146. package/lib/utils/scrollUtils.js +200 -0
  147. package/lib/utils/scrollUtils.js.map +1 -0
  148. package/lib/utils/searchUtils.d.ts +13 -0
  149. package/lib/utils/searchUtils.d.ts.map +1 -0
  150. package/lib/utils/searchUtils.js +37 -0
  151. package/lib/utils/searchUtils.js.map +1 -0
  152. package/lib/utils/storageUtils.d.ts +15 -7
  153. package/lib/utils/storageUtils.d.ts.map +1 -0
  154. package/lib/utils/storageUtils.js +58 -25
  155. package/lib/utils/storageUtils.js.map +1 -0
  156. package/lib/utils/tagsUtils.d.ts +18 -0
  157. package/lib/utils/tagsUtils.d.ts.map +1 -0
  158. package/lib/utils/tagsUtils.js +36 -0
  159. package/lib/utils/tagsUtils.js.map +1 -0
  160. package/lib/utils/tocUtils.d.ts +36 -0
  161. package/lib/utils/tocUtils.d.ts.map +1 -0
  162. package/lib/utils/tocUtils.js +84 -0
  163. package/lib/utils/tocUtils.js.map +1 -0
  164. package/lib/utils/useAlternatePageUtils.d.ts +21 -1
  165. package/lib/utils/useAlternatePageUtils.d.ts.map +1 -0
  166. package/lib/utils/useAlternatePageUtils.js +9 -4
  167. package/lib/utils/useAlternatePageUtils.js.map +1 -0
  168. package/lib/utils/useLocalPathname.d.ts +13 -0
  169. package/lib/utils/useLocalPathname.d.ts.map +1 -0
  170. package/lib/utils/useLocalPathname.js +19 -0
  171. package/lib/utils/useLocalPathname.js.map +1 -0
  172. package/lib/utils/useLocationChange.d.ts +17 -0
  173. package/lib/utils/useLocationChange.d.ts.map +1 -0
  174. package/lib/utils/useLocationChange.js +31 -0
  175. package/lib/utils/useLocationChange.js.map +1 -0
  176. package/lib/utils/usePluralForm.d.ts +12 -0
  177. package/lib/utils/usePluralForm.d.ts.map +1 -0
  178. package/lib/utils/usePluralForm.js +36 -37
  179. package/lib/utils/usePluralForm.js.map +1 -0
  180. package/lib/utils/useThemeConfig.d.ts +55 -23
  181. package/lib/utils/useThemeConfig.d.ts.map +1 -0
  182. package/lib/utils/useThemeConfig.js +4 -0
  183. package/lib/utils/useThemeConfig.js.map +1 -0
  184. package/package.json +26 -13
  185. package/src/components/Collapsible/index.tsx +265 -0
  186. package/src/components/Details/index.tsx +109 -0
  187. package/src/components/Details/styles.module.css +62 -0
  188. package/src/contexts/announcementBar.tsx +119 -0
  189. package/src/contexts/colorMode.tsx +199 -0
  190. package/src/contexts/docSidebarItemsExpandedState.tsx +55 -0
  191. package/src/contexts/docsPreferredVersion.tsx +253 -0
  192. package/src/contexts/docsSidebar.tsx +50 -0
  193. package/src/contexts/docsVersion.tsx +36 -0
  194. package/src/contexts/navbarMobileSidebar.tsx +99 -0
  195. package/src/contexts/navbarSecondaryMenu/content.tsx +110 -0
  196. package/src/contexts/navbarSecondaryMenu/display.tsx +102 -0
  197. package/src/contexts/tabGroupChoice.tsx +85 -0
  198. package/{lib/utils/pathUtils.d.ts → src/hooks/styles.css} +4 -1
  199. package/src/hooks/useBackToTopButton.ts +73 -0
  200. package/src/hooks/useCodeWordWrap.ts +56 -0
  201. package/src/hooks/useHideableNavbar.ts +75 -0
  202. package/src/hooks/useKeyboardNavigation.ts +45 -0
  203. package/src/hooks/useLockBodyScroll.ts +21 -0
  204. package/src/hooks/usePrismTheme.ts +24 -0
  205. package/src/hooks/useSearchPage.ts +79 -0
  206. package/src/hooks/useSkipToContent.ts +58 -0
  207. package/src/hooks/useTOCHighlight.ts +192 -0
  208. package/src/hooks/useWindowSize.ts +72 -0
  209. package/src/index.ts +136 -18
  210. package/src/types.d.ts +0 -2
  211. package/src/utils/ThemeClassNames.ts +51 -5
  212. package/src/utils/codeBlockUtils.ts +239 -2
  213. package/src/utils/docsUtils.tsx +334 -0
  214. package/src/utils/footerUtils.ts +18 -0
  215. package/src/utils/generalUtils.ts +9 -5
  216. package/src/utils/historyUtils.ts +45 -0
  217. package/src/utils/jsUtils.ts +36 -0
  218. package/src/utils/metadataUtils.tsx +115 -0
  219. package/src/utils/navbarUtils.tsx +45 -0
  220. package/src/utils/reactUtils.tsx +76 -0
  221. package/src/utils/regexpUtils.ts +24 -0
  222. package/src/utils/routesUtils.ts +75 -0
  223. package/src/utils/scrollUtils.tsx +308 -0
  224. package/src/utils/searchUtils.ts +51 -0
  225. package/src/utils/storageUtils.ts +59 -26
  226. package/src/utils/tagsUtils.ts +50 -0
  227. package/src/utils/tocUtils.ts +119 -0
  228. package/src/utils/useAlternatePageUtils.ts +28 -7
  229. package/src/utils/useLocalPathname.ts +22 -0
  230. package/src/utils/useLocationChange.ts +41 -0
  231. package/src/utils/usePluralForm.ts +49 -39
  232. package/src/utils/useThemeConfig.ts +54 -25
  233. package/lib/.tsbuildinfo +0 -4115
  234. package/lib/utils/docsPreferredVersion/DocsPreferredVersionProvider.d.ts +0 -21
  235. package/lib/utils/docsPreferredVersion/DocsPreferredVersionProvider.js +0 -94
  236. package/lib/utils/docsPreferredVersion/DocsPreferredVersionStorage.d.ts +0 -13
  237. package/lib/utils/docsPreferredVersion/DocsPreferredVersionStorage.js +0 -20
  238. package/lib/utils/docsPreferredVersion/useDocsPreferredVersion.d.ts +0 -5
  239. package/lib/utils/docsPreferredVersion/useDocsPreferredVersion.js +0 -41
  240. package/lib/utils/pathUtils.js +0 -13
  241. package/lib/utils/useChangeRoute.js +0 -18
  242. package/src/utils/__tests__/codeBlockUtils.test.ts +0 -54
  243. package/src/utils/__tests__/pathUtils.test.ts +0 -32
  244. package/src/utils/docsPreferredVersion/DocsPreferredVersionProvider.tsx +0 -165
  245. package/src/utils/docsPreferredVersion/DocsPreferredVersionStorage.ts +0 -34
  246. package/src/utils/docsPreferredVersion/useDocsPreferredVersion.ts +0 -66
  247. package/src/utils/docsUtils.ts +0 -11
  248. package/src/utils/pathUtils.ts +0 -17
  249. package/src/utils/useChangeRoute.ts +0 -21
  250. package/tsconfig.json +0 -10
@@ -0,0 +1 @@
1
+ {"version":3,"file":"storageUtils.d.ts","sourceRoot":"","sources":["../../src/utils/storageUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,QAAA,MAAM,YAAY,qDAAsD,CAAC;AAEzE,oBAAY,WAAW,GAAG,OAAO,YAAY,CAAC,MAAM,CAAC,CAAC;AA+CtD,oBAAY,WAAW,GAAG;IACxB,GAAG,EAAE,MAAM,MAAM,GAAG,IAAI,CAAC;IACzB,GAAG,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAC7B,GAAG,EAAE,MAAM,IAAI,CAAC;CACjB,CAAC;AAuBF;;;;;;;;;GASG;AACH,wBAAgB,iBAAiB,CAC/B,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE;IAAC,WAAW,CAAC,EAAE,WAAW,CAAA;CAAC,GACpC,WAAW,CAmCb;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAC7B,WAAW,GAAE,WAAgC,GAC5C,MAAM,EAAE,CAcV"}
@@ -6,34 +6,37 @@
6
6
  */
7
7
  const StorageTypes = ['localStorage', 'sessionStorage', 'none'];
8
8
  const DefaultStorageType = 'localStorage';
9
- // Will return null browser storage is unavailable (like running Docusaurus in iframe)
10
- // See https://github.com/facebook/docusaurus/pull/4501
9
+ /**
10
+ * Will return `null` if browser storage is unavailable (like running Docusaurus
11
+ * in an iframe). This should NOT be called in SSR.
12
+ *
13
+ * @see https://github.com/facebook/docusaurus/pull/4501
14
+ */
11
15
  function getBrowserStorage(storageType = DefaultStorageType) {
12
16
  if (typeof window === 'undefined') {
13
- throw new Error('Browser storage is not available on NodeJS / Docusaurus SSR process');
17
+ throw new Error('Browser storage is not available on Node.js/Docusaurus SSR process.');
14
18
  }
15
19
  if (storageType === 'none') {
16
20
  return null;
17
21
  }
18
- else {
19
- try {
20
- return window[storageType];
21
- }
22
- catch (e) {
23
- logOnceBrowserStorageNotAvailableWarning(e);
24
- return null;
25
- }
22
+ try {
23
+ return window[storageType];
24
+ }
25
+ catch (err) {
26
+ logOnceBrowserStorageNotAvailableWarning(err);
27
+ return null;
26
28
  }
27
29
  }
30
+ let hasLoggedBrowserStorageNotAvailableWarning = false;
28
31
  /**
29
- * Poor man's memoization to avoid logging multiple times the same warning
30
- * Sometimes, localStorage/sessionStorage is unavailable due to browser policies
32
+ * Poor man's memoization to avoid logging multiple times the same warning.
33
+ * Sometimes, `localStorage`/`sessionStorage` is unavailable due to browser
34
+ * policies.
31
35
  */
32
- let hasLoggedBrowserStorageNotAvailableWarning = false;
33
36
  function logOnceBrowserStorageNotAvailableWarning(error) {
34
37
  if (!hasLoggedBrowserStorageNotAvailableWarning) {
35
38
  console.warn(`Docusaurus browser storage is not available.
36
- Possible reasons: running Docusaurus in an Iframe, in an Incognito browser session, or using too strict browser privacy settings.`, error);
39
+ Possible reasons: running Docusaurus in an iframe, in an incognito browser session, or using too strict browser privacy settings.`, error);
37
40
  hasLoggedBrowserStorageNotAvailableWarning = true;
38
41
  }
39
42
  }
@@ -42,10 +45,10 @@ const NoopStorageSlot = {
42
45
  set: () => { },
43
46
  del: () => { },
44
47
  };
45
- // Fail-fast, as storage APIs should not be used during the SSR process
48
+ // Fail-fast, as storage APIs should not be used during the SSR process
46
49
  function createServerStorageSlot(key) {
47
50
  function throwError() {
48
- throw new Error(`Illegal storage API usage for storage key=${key}.
51
+ throw new Error(`Illegal storage API usage for storage key "${key}".
49
52
  Docusaurus storage APIs are not supposed to be called on the server-rendering process.
50
53
  Please only call storage APIs in effects and event handlers.`);
51
54
  }
@@ -56,24 +59,53 @@ Please only call storage APIs in effects and event handlers.`);
56
59
  };
57
60
  }
58
61
  /**
59
- * Creates an object for accessing a particular key in localStorage.
62
+ * Creates an interface to work on a particular key in the storage model.
63
+ * Note that this function only initializes the interface, but doesn't allocate
64
+ * anything by itself (i.e. no side-effects).
65
+ *
66
+ * The API is fail-safe, since usage of browser storage should be considered
67
+ * unreliable. Local storage might simply be unavailable (iframe + browser
68
+ * security) or operations might fail individually. Please assume that using
69
+ * this API can be a no-op. See also https://github.com/facebook/docusaurus/issues/6036
60
70
  */
61
- export const createStorageSlot = (key, options) => {
71
+ export function createStorageSlot(key, options) {
62
72
  if (typeof window === 'undefined') {
63
73
  return createServerStorageSlot(key);
64
74
  }
65
- const browserStorage = getBrowserStorage(options === null || options === void 0 ? void 0 : options.persistence);
75
+ const browserStorage = getBrowserStorage(options?.persistence);
66
76
  if (browserStorage === null) {
67
77
  return NoopStorageSlot;
68
78
  }
69
79
  return {
70
- get: () => browserStorage.getItem(key),
71
- set: (value) => browserStorage.setItem(key, value),
72
- del: () => browserStorage.removeItem(key),
80
+ get: () => {
81
+ try {
82
+ return browserStorage.getItem(key);
83
+ }
84
+ catch (err) {
85
+ console.error(`Docusaurus storage error, can't get key=${key}`, err);
86
+ return null;
87
+ }
88
+ },
89
+ set: (value) => {
90
+ try {
91
+ browserStorage.setItem(key, value);
92
+ }
93
+ catch (err) {
94
+ console.error(`Docusaurus storage error, can't set ${key}=${value}`, err);
95
+ }
96
+ },
97
+ del: () => {
98
+ try {
99
+ browserStorage.removeItem(key);
100
+ }
101
+ catch (err) {
102
+ console.error(`Docusaurus storage error, can't delete key=${key}`, err);
103
+ }
104
+ },
73
105
  };
74
- };
106
+ }
75
107
  /**
76
- * Returns a list of all the keys currently stored in browser storage
108
+ * Returns a list of all the keys currently stored in browser storage,
77
109
  * or an empty list if browser storage can't be accessed.
78
110
  */
79
111
  export function listStorageKeys(storageType = DefaultStorageType) {
@@ -90,3 +122,4 @@ export function listStorageKeys(storageType = DefaultStorageType) {
90
122
  }
91
123
  return keys;
92
124
  }
125
+ //# sourceMappingURL=storageUtils.js.map
@@ -0,0 +1 @@
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;;;;;GAKG;AACH,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,IAAI,0CAA0C,GAAG,KAAK,CAAC;AACvD;;;;GAIG;AACH,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,uEAAuE;AACvE,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;;;;;;;;;GASG;AACH,MAAM,UAAU,iBAAiB,CAC/B,GAAW,EACX,OAAqC;IAErC,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE;QACjC,OAAO,uBAAuB,CAAC,GAAG,CAAC,CAAC;KACrC;IACD,MAAM,cAAc,GAAG,iBAAiB,CAAC,OAAO,EAAE,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;AAED;;;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"}
@@ -0,0 +1,18 @@
1
+ /**
2
+ * Copyright (c) Facebook, Inc. and its affiliates.
3
+ *
4
+ * This source code is licensed under the MIT license found in the
5
+ * LICENSE file in the root directory of this source tree.
6
+ */
7
+ import type { TagsListItem } from '@docusaurus/utils';
8
+ export declare const translateTagsPageTitle: () => string;
9
+ export declare type TagLetterEntry = {
10
+ letter: string;
11
+ tags: TagsListItem[];
12
+ };
13
+ /**
14
+ * Takes a list of tags (as provided by the content plugins), and groups them by
15
+ * their initials.
16
+ */
17
+ export declare function listTagsByLetters(tags: readonly TagsListItem[]): TagLetterEntry[];
18
+ //# sourceMappingURL=tagsUtils.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"tagsUtils.d.ts","sourceRoot":"","sources":["../../src/utils/tagsUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,mBAAmB,CAAC;AAEpD,eAAO,MAAM,sBAAsB,QAAO,MAKtC,CAAC;AAEL,oBAAY,cAAc,GAAG;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,YAAY,EAAE,CAAA;CAAC,CAAC;AAMpE;;;GAGG;AACH,wBAAgB,iBAAiB,CAC/B,IAAI,EAAE,SAAS,YAAY,EAAE,GAC5B,cAAc,EAAE,CAoBlB"}
@@ -0,0 +1,36 @@
1
+ /**
2
+ * Copyright (c) Facebook, Inc. and its affiliates.
3
+ *
4
+ * This source code is licensed under the MIT license found in the
5
+ * LICENSE file in the root directory of this source tree.
6
+ */
7
+ import { translate } from '@docusaurus/Translate';
8
+ export const translateTagsPageTitle = () => translate({
9
+ id: 'theme.tags.tagsPageTitle',
10
+ message: 'Tags',
11
+ description: 'The title of the tag list page',
12
+ });
13
+ function getTagLetter(tag) {
14
+ return tag[0].toUpperCase();
15
+ }
16
+ /**
17
+ * Takes a list of tags (as provided by the content plugins), and groups them by
18
+ * their initials.
19
+ */
20
+ export function listTagsByLetters(tags) {
21
+ const groups = {};
22
+ Object.values(tags).forEach((tag) => {
23
+ const initial = getTagLetter(tag.label);
24
+ groups[initial] ?? (groups[initial] = []);
25
+ groups[initial].push(tag);
26
+ });
27
+ return (Object.entries(groups)
28
+ // Sort letters
29
+ .sort(([letter1], [letter2]) => letter1.localeCompare(letter2))
30
+ .map(([letter, letterTags]) => {
31
+ // Sort tags inside a letter
32
+ const sortedTags = letterTags.sort((tag1, tag2) => tag1.label.localeCompare(tag2.label));
33
+ return { letter, tags: sortedTags };
34
+ }));
35
+ }
36
+ //# sourceMappingURL=tagsUtils.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"tagsUtils.js","sourceRoot":"","sources":["../../src/utils/tagsUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAC,SAAS,EAAC,MAAM,uBAAuB,CAAC;AAGhD,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;AAIL,SAAS,YAAY,CAAC,GAAW;IAC/B,OAAO,GAAG,CAAC,CAAC,CAAE,CAAC,WAAW,EAAE,CAAC;AAC/B,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAC/B,IAA6B;IAE7B,MAAM,MAAM,GAAwC,EAAE,CAAC;IACvD,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;QAClC,MAAM,OAAO,GAAG,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACxC,MAAM,CAAC,OAAO,MAAd,MAAM,CAAC,OAAO,IAAM,EAAE,EAAC;QACvB,MAAM,CAAC,OAAO,CAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC7B,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,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CACrC,CAAC;QACF,OAAO,EAAC,MAAM,EAAE,IAAI,EAAE,UAAU,EAAC,CAAC;IACpC,CAAC,CAAC,CACL,CAAC;AACJ,CAAC"}
@@ -0,0 +1,36 @@
1
+ /**
2
+ * Copyright (c) Facebook, Inc. and its affiliates.
3
+ *
4
+ * This source code is licensed under the MIT license found in the
5
+ * LICENSE file in the root directory of this source tree.
6
+ */
7
+ import type { TOCItem } from '@docusaurus/mdx-loader';
8
+ export declare type TOCTreeNode = {
9
+ readonly value: string;
10
+ readonly id: string;
11
+ readonly level: number;
12
+ readonly children: readonly TOCTreeNode[];
13
+ };
14
+ /**
15
+ * Takes a flat TOC list (from the MDX loader) and treeifies it into what the
16
+ * TOC components expect. Memoized for performance.
17
+ */
18
+ export declare function useTreeifiedTOC(toc: TOCItem[]): readonly TOCTreeNode[];
19
+ /**
20
+ * Takes a flat TOC list (from the MDX loader) and treeifies it into what the
21
+ * TOC components expect, applying the `minHeadingLevel` and `maxHeadingLevel`.
22
+ * Memoized for performance.
23
+ *
24
+ * **Important**: this is not the same as `useTreeifiedTOC(toc.filter(...))`,
25
+ * because we have to filter the TOC after it has been treeified. This is mostly
26
+ * to ensure that weird TOC structures preserve their semantics. For example, an
27
+ * h3-h2-h4 sequence should not be treeified as an "h3 > h4" hierarchy with
28
+ * min=3, max=4, but should rather be "[h3, h4]" (since the h2 heading has split
29
+ * the two headings and they are not parent-children)
30
+ */
31
+ export declare function useFilteredAndTreeifiedTOC({ toc, minHeadingLevel, maxHeadingLevel, }: {
32
+ toc: readonly TOCItem[];
33
+ minHeadingLevel: number;
34
+ maxHeadingLevel: number;
35
+ }): readonly TOCTreeNode[];
36
+ //# sourceMappingURL=tocUtils.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"tocUtils.d.ts","sourceRoot":"","sources":["../../src/utils/tocUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,wBAAwB,CAAC;AAEpD,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;;;GAGG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,SAAS,WAAW,EAAE,CAEtE;AAiCD;;;;;;;;;;;GAWG;AACH,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,CAKzB"}
@@ -0,0 +1,84 @@
1
+ /**
2
+ * Copyright (c) Facebook, Inc. and its affiliates.
3
+ *
4
+ * This source code is licensed under the MIT license found in the
5
+ * LICENSE file in the root directory of this source tree.
6
+ */
7
+ import { useMemo } from 'react';
8
+ function treeifyTOC(flatTOC) {
9
+ const headings = flatTOC.map((heading) => ({
10
+ ...heading,
11
+ parentIndex: -1,
12
+ children: [],
13
+ }));
14
+ // Keep track of which previous index would be the current heading's direct
15
+ // parent. Each entry <i> is the last index of the `headings` array at heading
16
+ // level <i>. We will modify these indices as we iterate through all headings.
17
+ // e.g. if an ### H3 was last seen at index 2, then prevIndexForLevel[3] === 2
18
+ // indices 0 and 1 will remain unused.
19
+ const prevIndexForLevel = Array(7).fill(-1);
20
+ headings.forEach((curr, currIndex) => {
21
+ // Take the last seen index for each ancestor level. the highest index will
22
+ // be the direct ancestor of the current heading.
23
+ const ancestorLevelIndexes = prevIndexForLevel.slice(2, curr.level);
24
+ curr.parentIndex = Math.max(...ancestorLevelIndexes);
25
+ // Mark that curr.level was last seen at the current index.
26
+ prevIndexForLevel[curr.level] = currIndex;
27
+ });
28
+ const rootNodes = [];
29
+ // For a given parentIndex, add each Node into that parent's `children` array
30
+ headings.forEach((heading) => {
31
+ const { parentIndex, ...rest } = heading;
32
+ if (parentIndex >= 0) {
33
+ headings[parentIndex].children.push(rest);
34
+ }
35
+ else {
36
+ rootNodes.push(rest);
37
+ }
38
+ });
39
+ return rootNodes;
40
+ }
41
+ /**
42
+ * Takes a flat TOC list (from the MDX loader) and treeifies it into what the
43
+ * TOC components expect. Memoized for performance.
44
+ */
45
+ export function useTreeifiedTOC(toc) {
46
+ return useMemo(() => treeifyTOC(toc), [toc]);
47
+ }
48
+ function filterTOC({ toc, minHeadingLevel, maxHeadingLevel, }) {
49
+ function isValid(item) {
50
+ return item.level >= minHeadingLevel && item.level <= maxHeadingLevel;
51
+ }
52
+ return toc.flatMap((item) => {
53
+ const filteredChildren = filterTOC({
54
+ toc: item.children,
55
+ minHeadingLevel,
56
+ maxHeadingLevel,
57
+ });
58
+ if (isValid(item)) {
59
+ return [
60
+ {
61
+ ...item,
62
+ children: filteredChildren,
63
+ },
64
+ ];
65
+ }
66
+ return filteredChildren;
67
+ });
68
+ }
69
+ /**
70
+ * Takes a flat TOC list (from the MDX loader) and treeifies it into what the
71
+ * TOC components expect, applying the `minHeadingLevel` and `maxHeadingLevel`.
72
+ * Memoized for performance.
73
+ *
74
+ * **Important**: this is not the same as `useTreeifiedTOC(toc.filter(...))`,
75
+ * because we have to filter the TOC after it has been treeified. This is mostly
76
+ * to ensure that weird TOC structures preserve their semantics. For example, an
77
+ * h3-h2-h4 sequence should not be treeified as an "h3 > h4" hierarchy with
78
+ * min=3, max=4, but should rather be "[h3, h4]" (since the h2 heading has split
79
+ * the two headings and they are not parent-children)
80
+ */
81
+ export function useFilteredAndTreeifiedTOC({ toc, minHeadingLevel, maxHeadingLevel, }) {
82
+ return useMemo(() => filterTOC({ toc: treeifyTOC(toc), minHeadingLevel, maxHeadingLevel }), [toc, minHeadingLevel, maxHeadingLevel]);
83
+ }
84
+ //# sourceMappingURL=tocUtils.js.map
@@ -0,0 +1 @@
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,2EAA2E;QAC3E,iDAAiD;QACjD,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,2DAA2D;QAC3D,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,CAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SAC5C;aAAM;YACL,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SACtB;IACH,CAAC,CAAC,CAAC;IACH,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;GAGG;AACH,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;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,0BAA0B,CAAC,EACzC,GAAG,EACH,eAAe,EACf,eAAe,GAKhB;IACC,OAAO,OAAO,CACZ,GAAG,EAAE,CAAC,SAAS,CAAC,EAAC,GAAG,EAAE,UAAU,CAAC,GAAG,CAAC,EAAE,eAAe,EAAE,eAAe,EAAC,CAAC,EACzE,CAAC,GAAG,EAAE,eAAe,EAAE,eAAe,CAAC,CACxC,CAAC;AACJ,CAAC"}
@@ -4,9 +4,29 @@
4
4
  * This source code is licensed under the MIT license found in the
5
5
  * LICENSE file in the root directory of this source tree.
6
6
  */
7
+ /**
8
+ * Permits to obtain the url of the current page in another locale, useful to
9
+ * generate hreflang meta headers etc...
10
+ *
11
+ * @see https://developers.google.com/search/docs/advanced/crawling/localized-versions
12
+ */
7
13
  export declare function useAlternatePageUtils(): {
8
- createUrl: ({ locale, fullyQualified, }: {
14
+ /**
15
+ * Everything (pathname, base URL, etc.) is read from the context. Just tell
16
+ * it which locale to link to and it will give you the alternate link for the
17
+ * current page.
18
+ */
19
+ createUrl: ({
20
+ /** The locale name to link to. */
21
+ locale,
22
+ /**
23
+ * For hreflang SEO headers, we need it to be fully qualified (full
24
+ * protocol/domain/path...); but for locale dropdowns, using a pathname is
25
+ * good enough.
26
+ */
27
+ fullyQualified, }: {
9
28
  locale: string;
10
29
  fullyQualified: boolean;
11
30
  }) => string;
12
31
  };
32
+ //# sourceMappingURL=useAlternatePageUtils.d.ts.map
@@ -0,0 +1 @@
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"}
@@ -6,9 +6,12 @@
6
6
  */
7
7
  import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
8
8
  import { useLocation } from '@docusaurus/router';
9
- // Permits to obtain the url of the current page in another locale
10
- // Useful to generate hreflang meta headers etc...
11
- // See https://developers.google.com/search/docs/advanced/crawling/localized-versions
9
+ /**
10
+ * Permits to obtain the url of the current page in another locale, useful to
11
+ * generate hreflang meta headers etc...
12
+ *
13
+ * @see https://developers.google.com/search/docs/advanced/crawling/localized-versions
14
+ */
12
15
  export function useAlternatePageUtils() {
13
16
  const { siteConfig: { baseUrl, url }, i18n: { defaultLocale, currentLocale }, } = useDocusaurusContext();
14
17
  const { pathname } = useLocation();
@@ -21,9 +24,11 @@ export function useAlternatePageUtils() {
21
24
  ? `${baseUrlUnlocalized}`
22
25
  : `${baseUrlUnlocalized}${locale}/`;
23
26
  }
24
- // TODO support correct alternate url when localized site is deployed on another domain
27
+ // TODO support correct alternate url when localized site is deployed on
28
+ // another domain
25
29
  function createUrl({ locale, fullyQualified, }) {
26
30
  return `${fullyQualified ? url : ''}${getLocalizedBaseUrl(locale)}${pathnameSuffix}`;
27
31
  }
28
32
  return { createUrl };
29
33
  }
34
+ //# sourceMappingURL=useAlternatePageUtils.js.map
@@ -0,0 +1 @@
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"}
@@ -0,0 +1,13 @@
1
+ /**
2
+ * Copyright (c) Facebook, Inc. and its affiliates.
3
+ *
4
+ * This source code is licensed under the MIT license found in the
5
+ * LICENSE file in the root directory of this source tree.
6
+ */
7
+ /**
8
+ * Get the pathname of current route, without the optional site baseUrl.
9
+ * - `/docs/myDoc` => `/docs/myDoc`
10
+ * - `/baseUrl/docs/myDoc` => `/docs/myDoc`
11
+ */
12
+ export declare function useLocalPathname(): string;
13
+ //# sourceMappingURL=useLocalPathname.d.ts.map
@@ -0,0 +1 @@
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"}
@@ -0,0 +1,19 @@
1
+ /**
2
+ * Copyright (c) Facebook, Inc. and its affiliates.
3
+ *
4
+ * This source code is licensed under the MIT license found in the
5
+ * LICENSE file in the root directory of this source tree.
6
+ */
7
+ import { useLocation } from '@docusaurus/router';
8
+ import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
9
+ /**
10
+ * Get the pathname of current route, without the optional site baseUrl.
11
+ * - `/docs/myDoc` => `/docs/myDoc`
12
+ * - `/baseUrl/docs/myDoc` => `/docs/myDoc`
13
+ */
14
+ export function useLocalPathname() {
15
+ const { siteConfig: { baseUrl }, } = useDocusaurusContext();
16
+ const { pathname } = useLocation();
17
+ return pathname.replace(baseUrl, '/');
18
+ }
19
+ //# sourceMappingURL=useLocalPathname.js.map
@@ -0,0 +1 @@
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"}
@@ -0,0 +1,17 @@
1
+ /**
2
+ * Copyright (c) Facebook, Inc. and its affiliates.
3
+ *
4
+ * This source code is licensed under the MIT license found in the
5
+ * LICENSE file in the root directory of this source tree.
6
+ */
7
+ import type { Location } from 'history';
8
+ /**
9
+ * Fires an effect when the location changes (which includes hash, query, etc.).
10
+ * Importantly, doesn't fire when there's no previous location: see
11
+ * https://github.com/facebook/docusaurus/pull/6696
12
+ */
13
+ export declare function useLocationChange(onLocationChange: (locationChangeEvent: {
14
+ location: Location;
15
+ previousLocation: Location | undefined;
16
+ }) => void): void;
17
+ //# sourceMappingURL=useLocationChange.d.ts.map
@@ -0,0 +1 @@
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;AAGtC;;;;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"}
@@ -0,0 +1,31 @@
1
+ /**
2
+ * Copyright (c) Facebook, Inc. and its affiliates.
3
+ *
4
+ * This source code is licensed under the MIT license found in the
5
+ * LICENSE file in the root directory of this source tree.
6
+ */
7
+ import { useEffect } from 'react';
8
+ import { useLocation } from '@docusaurus/router';
9
+ import { useDynamicCallback, usePrevious } from './reactUtils';
10
+ /**
11
+ * Fires an effect when the location changes (which includes hash, query, etc.).
12
+ * Importantly, doesn't fire when there's no previous location: see
13
+ * https://github.com/facebook/docusaurus/pull/6696
14
+ */
15
+ export function useLocationChange(onLocationChange) {
16
+ const location = useLocation();
17
+ const previousLocation = usePrevious(location);
18
+ const onLocationChangeDynamic = useDynamicCallback(onLocationChange);
19
+ useEffect(() => {
20
+ if (!previousLocation) {
21
+ return;
22
+ }
23
+ if (location !== previousLocation) {
24
+ onLocationChangeDynamic({
25
+ location,
26
+ previousLocation,
27
+ });
28
+ }
29
+ }, [onLocationChangeDynamic, location, previousLocation]);
30
+ }
31
+ //# sourceMappingURL=useLocationChange.js.map
@@ -0,0 +1 @@
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,kBAAkB,EAAE,WAAW,EAAC,MAAM,cAAc,CAAC;AAE7D;;;;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,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"}
@@ -4,6 +4,18 @@
4
4
  * This source code is licensed under the MIT license found in the
5
5
  * LICENSE file in the root directory of this source tree.
6
6
  */
7
+ /**
8
+ * Reads the current locale and returns an interface very similar to
9
+ * `Intl.PluralRules`.
10
+ */
7
11
  export declare function usePluralForm(): {
12
+ /**
13
+ * Give it a `count` and it will select the relevant message from
14
+ * `pluralMessages`. `pluralMessages` should be separated by `|`, and in the
15
+ * order of "zero", "one", "two", "few", "many", "other". The actual selection
16
+ * is done by `Intl.PluralRules`, which tells us all plurals the locale has
17
+ * and which plural we should use for `count`.
18
+ */
8
19
  selectMessage: (count: number, pluralMessages: string) => string;
9
20
  };
21
+ //# sourceMappingURL=usePluralForm.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"usePluralForm.d.ts","sourceRoot":"","sources":["../../src/utils/usePluralForm.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAsGH;;;GAGG;AACH,wBAAgB,aAAa,IAAI;IAC/B;;;;;;OAMG;IACH,aAAa,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,KAAK,MAAM,CAAC;CAClE,CAMA"}
@@ -34,36 +34,33 @@ function createLocalePluralForms(locale) {
34
34
  select: (count) => pluralRules.select(count),
35
35
  };
36
36
  }
37
- // Poor man's PluralSelector implementation, using an english fallback.
38
- // We want a lightweight, future-proof and good-enough solution.
39
- // We don't want a perfect and heavy solution.
40
- //
41
- // Docusaurus classic theme has only 2 deeply nested labels requiring complex plural rules
42
- // We don't want to use Intl + PluralRules polyfills + full ICU syntax (react-intl) just for that.
43
- //
44
- // Notes:
45
- // - 2021: 92+% Browsers support Intl.PluralRules, and support will increase in the future
46
- // - NodeJS >= 13 has full ICU support by default
47
- // - In case of "mismatch" between SSR and Browser ICU support, React keeps working!
37
+ /**
38
+ * Poor man's `PluralSelector` implementation, using an English fallback. We
39
+ * want a lightweight, future-proof and good-enough solution. We don't want a
40
+ * perfect and heavy solution.
41
+ *
42
+ * Docusaurus classic theme has only 2 deeply nested labels requiring complex
43
+ * plural rules. We don't want to use `Intl` + `PluralRules` polyfills + full
44
+ * ICU syntax (react-intl) just for that.
45
+ *
46
+ * Notes:
47
+ * - 2021: 92+% Browsers support `Intl.PluralRules`, and support will increase
48
+ * in the future
49
+ * - NodeJS >= 13 has full ICU support by default
50
+ * - In case of "mismatch" between SSR and Browser ICU support, React keeps
51
+ * working!
52
+ */
48
53
  function useLocalePluralForms() {
49
54
  const { i18n: { currentLocale }, } = useDocusaurusContext();
50
55
  return useMemo(() => {
51
- // @ts-expect-error checking Intl.PluralRules in case browser doesn't have it (e.g Safari 12-)
52
- if (Intl.PluralRules) {
53
- try {
54
- return createLocalePluralForms(currentLocale);
55
- }
56
- catch (e) {
57
- console.error(`Failed to use Intl.PluralRules for locale=${currentLocale}.
58
- Docusaurus will fallback to a default/fallback (English) Intl.PluralRules implementation.
59
- `);
60
- return EnglishPluralForms;
61
- }
56
+ try {
57
+ return createLocalePluralForms(currentLocale);
62
58
  }
63
- else {
64
- console.error(`Intl.PluralRules not available!
65
- Docusaurus will fallback to a default/fallback (English) Intl.PluralRules implementation.
66
- `);
59
+ catch (err) {
60
+ console.error(`Failed to use Intl.PluralRules for locale "${currentLocale}".
61
+ Docusaurus will fallback to the default (English) implementation.
62
+ Error: ${err.message}
63
+ `);
67
64
  return EnglishPluralForms;
68
65
  }
69
66
  }, [currentLocale]);
@@ -74,21 +71,23 @@ function selectPluralMessage(pluralMessages, count, localePluralForms) {
74
71
  if (parts.length === 1) {
75
72
  return parts[0];
76
73
  }
77
- else {
78
- if (parts.length > localePluralForms.pluralForms.length) {
79
- 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} `);
80
- }
81
- const pluralForm = localePluralForms.select(count);
82
- const pluralFormIndex = localePluralForms.pluralForms.indexOf(pluralForm);
83
- // In case of not enough plural form messages, we take the last one (other) instead of returning undefined
84
- return parts[Math.min(pluralFormIndex, parts.length - 1)];
74
+ if (parts.length > localePluralForms.pluralForms.length) {
75
+ console.error(`For locale=${localePluralForms.locale}, a maximum of ${localePluralForms.pluralForms.length} plural forms are expected (${localePluralForms.pluralForms}), but the message contains ${parts.length}: ${pluralMessages}`);
85
76
  }
77
+ const pluralForm = localePluralForms.select(count);
78
+ const pluralFormIndex = localePluralForms.pluralForms.indexOf(pluralForm);
79
+ // In case of not enough plural form messages, we take the last one (other)
80
+ // instead of returning undefined
81
+ return parts[Math.min(pluralFormIndex, parts.length - 1)];
86
82
  }
83
+ /**
84
+ * Reads the current locale and returns an interface very similar to
85
+ * `Intl.PluralRules`.
86
+ */
87
87
  export function usePluralForm() {
88
88
  const localePluralForm = useLocalePluralForms();
89
89
  return {
90
- selectMessage: (count, pluralMessages) => {
91
- return selectPluralMessage(pluralMessages, count, localePluralForm);
92
- },
90
+ selectMessage: (count, pluralMessages) => selectPluralMessage(pluralMessages, count, localePluralForm),
93
91
  };
94
92
  }
93
+ //# sourceMappingURL=usePluralForm.js.map
@@ -0,0 +1 @@
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,kBAAkB,iBAAiB,CAAC,WAAW,CAAC,MAAM,+BAA+B,iBAAiB,CAAC,WAAW,+BAA+B,KAAK,CAAC,MAAM,KAAK,cAAc,EAAE,CACzN,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"}