react-cheminfo 0.64.1 → 0.65.0

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 (604) hide show
  1. package/README.md +282 -0
  2. package/lib/card/core/cardAddress.d.ts +70 -0
  3. package/lib/card/core/cardAddress.d.ts.map +1 -0
  4. package/lib/card/core/cardAddress.js +59 -0
  5. package/lib/card/core/cardAddress.js.map +1 -0
  6. package/lib/card/core/cardPageUrl.d.ts +49 -0
  7. package/lib/card/core/cardPageUrl.d.ts.map +1 -0
  8. package/lib/card/core/cardPageUrl.js +59 -0
  9. package/lib/card/core/cardPageUrl.js.map +1 -0
  10. package/lib/card/core/index.d.ts +7 -0
  11. package/lib/card/core/index.d.ts.map +1 -0
  12. package/lib/card/core/index.js +4 -0
  13. package/lib/card/core/index.js.map +1 -0
  14. package/lib/card/core/panelRoom.d.ts +40 -0
  15. package/lib/card/core/panelRoom.d.ts.map +1 -0
  16. package/lib/card/core/panelRoom.js +40 -0
  17. package/lib/card/core/panelRoom.js.map +1 -0
  18. package/lib/card/ui/CardDetailsButton.d.ts +38 -0
  19. package/lib/card/ui/CardDetailsButton.d.ts.map +1 -0
  20. package/lib/card/ui/CardDetailsButton.js +50 -0
  21. package/lib/card/ui/CardDetailsButton.js.map +1 -0
  22. package/lib/card/ui/CardFigure.d.ts +51 -0
  23. package/lib/card/ui/CardFigure.d.ts.map +1 -0
  24. package/lib/card/ui/CardFigure.js +27 -0
  25. package/lib/card/ui/CardFigure.js.map +1 -0
  26. package/lib/card/ui/CardFrame.d.ts +30 -0
  27. package/lib/card/ui/CardFrame.d.ts.map +1 -0
  28. package/lib/card/ui/CardFrame.js +20 -0
  29. package/lib/card/ui/CardFrame.js.map +1 -0
  30. package/lib/card/ui/CopyTableButton.d.ts +37 -0
  31. package/lib/card/ui/CopyTableButton.d.ts.map +1 -0
  32. package/lib/card/ui/CopyTableButton.js +19 -0
  33. package/lib/card/ui/CopyTableButton.js.map +1 -0
  34. package/lib/card/ui/cardTooltip.d.ts +14 -0
  35. package/lib/card/ui/cardTooltip.d.ts.map +1 -0
  36. package/lib/card/ui/cardTooltip.js +15 -0
  37. package/lib/card/ui/cardTooltip.js.map +1 -0
  38. package/lib/card/ui/embed.d.ts +15 -0
  39. package/lib/card/ui/embed.d.ts.map +1 -0
  40. package/lib/card/ui/embed.js +24 -0
  41. package/lib/card/ui/embed.js.map +1 -0
  42. package/lib/card/ui/fitCardToFrame.d.ts +31 -0
  43. package/lib/card/ui/fitCardToFrame.d.ts.map +1 -0
  44. package/lib/card/ui/fitCardToFrame.js +66 -0
  45. package/lib/card/ui/fitCardToFrame.js.map +1 -0
  46. package/lib/card/ui/holdRoomForPanels.d.ts +16 -0
  47. package/lib/card/ui/holdRoomForPanels.d.ts.map +1 -0
  48. package/lib/card/ui/holdRoomForPanels.js +76 -0
  49. package/lib/card/ui/holdRoomForPanels.js.map +1 -0
  50. package/lib/card/ui/index.d.ts +11 -0
  51. package/lib/card/ui/index.d.ts.map +1 -0
  52. package/lib/card/ui/index.js +7 -0
  53. package/lib/card/ui/index.js.map +1 -0
  54. package/lib/card/ui/openPanels.d.ts +25 -0
  55. package/lib/card/ui/openPanels.d.ts.map +1 -0
  56. package/lib/card/ui/openPanels.js +85 -0
  57. package/lib/card/ui/openPanels.js.map +1 -0
  58. package/lib/card.d.ts +13 -0
  59. package/lib/card.d.ts.map +1 -0
  60. package/lib/card.js +13 -0
  61. package/lib/card.js.map +1 -0
  62. package/lib/conformers.d.ts +1 -0
  63. package/lib/conformers.d.ts.map +1 -1
  64. package/lib/conformers.js +1 -0
  65. package/lib/conformers.js.map +1 -1
  66. package/lib/core.d.ts +4 -0
  67. package/lib/core.d.ts.map +1 -1
  68. package/lib/core.js +5 -0
  69. package/lib/core.js.map +1 -1
  70. package/lib/fetch/core/apiError.d.ts +56 -0
  71. package/lib/fetch/core/apiError.d.ts.map +1 -0
  72. package/lib/fetch/core/apiError.js +43 -0
  73. package/lib/fetch/core/apiError.js.map +1 -0
  74. package/lib/fetch/core/fetchJson.d.ts +47 -0
  75. package/lib/fetch/core/fetchJson.d.ts.map +1 -0
  76. package/lib/fetch/core/fetchJson.js +109 -0
  77. package/lib/fetch/core/fetchJson.js.map +1 -0
  78. package/lib/fetch/core/index.d.ts +5 -0
  79. package/lib/fetch/core/index.d.ts.map +1 -0
  80. package/lib/fetch/core/index.js +3 -0
  81. package/lib/fetch/core/index.js.map +1 -0
  82. package/lib/formula/core/formulaText.d.ts +46 -0
  83. package/lib/formula/core/formulaText.d.ts.map +1 -0
  84. package/lib/formula/core/formulaText.js +74 -0
  85. package/lib/formula/core/formulaText.js.map +1 -0
  86. package/lib/formula/core/index.d.ts +6 -0
  87. package/lib/formula/core/index.d.ts.map +1 -0
  88. package/lib/formula/core/index.js +4 -0
  89. package/lib/formula/core/index.js.map +1 -0
  90. package/lib/formula/core/normalizeFormula.d.ts +22 -0
  91. package/lib/formula/core/normalizeFormula.d.ts.map +1 -0
  92. package/lib/formula/core/normalizeFormula.js +46 -0
  93. package/lib/formula/core/normalizeFormula.js.map +1 -0
  94. package/lib/formula/core/readFormula.d.ts +73 -0
  95. package/lib/formula/core/readFormula.d.ts.map +1 -0
  96. package/lib/formula/core/readFormula.js +132 -0
  97. package/lib/formula/core/readFormula.js.map +1 -0
  98. package/lib/formula/ui/CopyableFormula.d.ts +31 -0
  99. package/lib/formula/ui/CopyableFormula.d.ts.map +1 -0
  100. package/lib/formula/ui/CopyableFormula.js +19 -0
  101. package/lib/formula/ui/CopyableFormula.js.map +1 -0
  102. package/lib/formula/ui/FormulaInput.d.ts +29 -0
  103. package/lib/formula/ui/FormulaInput.d.ts.map +1 -0
  104. package/lib/formula/ui/FormulaInput.js +16 -0
  105. package/lib/formula/ui/FormulaInput.js.map +1 -0
  106. package/lib/formula/ui/QuestionFormula.d.ts +14 -0
  107. package/lib/formula/ui/QuestionFormula.d.ts.map +1 -0
  108. package/lib/formula/ui/QuestionFormula.js +13 -0
  109. package/lib/formula/ui/QuestionFormula.js.map +1 -0
  110. package/lib/formula/ui/index.d.ts +7 -0
  111. package/lib/formula/ui/index.d.ts.map +1 -0
  112. package/lib/formula/ui/index.js +4 -0
  113. package/lib/formula/ui/index.js.map +1 -0
  114. package/lib/formula.d.ts +11 -0
  115. package/lib/formula.d.ts.map +1 -0
  116. package/lib/formula.js +11 -0
  117. package/lib/formula.js.map +1 -0
  118. package/lib/hooks/ui/index.d.ts +1 -0
  119. package/lib/hooks/ui/index.d.ts.map +1 -1
  120. package/lib/hooks/ui/index.js.map +1 -1
  121. package/lib/hooks/ui/keyTargets.d.ts +4 -2
  122. package/lib/hooks/ui/keyTargets.d.ts.map +1 -1
  123. package/lib/hooks/ui/keyTargets.js +5 -3
  124. package/lib/hooks/ui/keyTargets.js.map +1 -1
  125. package/lib/hooks/ui/useAsync.d.ts +20 -5
  126. package/lib/hooks/ui/useAsync.d.ts.map +1 -1
  127. package/lib/hooks/ui/useAsync.js +29 -14
  128. package/lib/hooks/ui/useAsync.js.map +1 -1
  129. package/lib/i18n/core/chromeCatalog.d.ts +1 -1
  130. package/lib/i18n/core/chromeCatalog.d.ts.map +1 -1
  131. package/lib/locales/de.json +37 -0
  132. package/lib/locales/en.json +37 -0
  133. package/lib/locales/es.json +37 -0
  134. package/lib/locales/fr.json +37 -0
  135. package/lib/locales/it.json +37 -0
  136. package/lib/moleculesClient/core/index.d.ts +5 -0
  137. package/lib/moleculesClient/core/index.d.ts.map +1 -0
  138. package/lib/moleculesClient/core/index.js +3 -0
  139. package/lib/moleculesClient/core/index.js.map +1 -0
  140. package/lib/moleculesClient/core/moleculesClient.d.ts +12 -0
  141. package/lib/moleculesClient/core/moleculesClient.d.ts.map +1 -0
  142. package/lib/moleculesClient/core/moleculesClient.js +105 -0
  143. package/lib/moleculesClient/core/moleculesClient.js.map +1 -0
  144. package/lib/moleculesClient/core/moleculesClientApi.d.ts +100 -0
  145. package/lib/moleculesClient/core/moleculesClientApi.d.ts.map +1 -0
  146. package/lib/moleculesClient/core/moleculesClientApi.js +20 -0
  147. package/lib/moleculesClient/core/moleculesClientApi.js.map +1 -0
  148. package/lib/moleculesClient/core/moleculesTypes.d.ts +154 -0
  149. package/lib/moleculesClient/core/moleculesTypes.d.ts.map +1 -0
  150. package/lib/moleculesClient/core/moleculesTypes.js +2 -0
  151. package/lib/moleculesClient/core/moleculesTypes.js.map +1 -0
  152. package/lib/moleculesClient/core/requestRetry.d.ts +50 -0
  153. package/lib/moleculesClient/core/requestRetry.d.ts.map +1 -0
  154. package/lib/moleculesClient/core/requestRetry.js +108 -0
  155. package/lib/moleculesClient/core/requestRetry.js.map +1 -0
  156. package/lib/molstar/core/camera.d.ts +2 -1
  157. package/lib/molstar/core/camera.d.ts.map +1 -1
  158. package/lib/molstar/core/camera.js +3 -2
  159. package/lib/molstar/core/camera.js.map +1 -1
  160. package/lib/molstar/core/framing.d.ts +102 -0
  161. package/lib/molstar/core/framing.d.ts.map +1 -0
  162. package/lib/molstar/core/framing.js +120 -0
  163. package/lib/molstar/core/framing.js.map +1 -0
  164. package/lib/molstar/core/hover.d.ts +16 -0
  165. package/lib/molstar/core/hover.d.ts.map +1 -1
  166. package/lib/molstar/core/hover.js +14 -0
  167. package/lib/molstar/core/hover.js.map +1 -1
  168. package/lib/molstar/core/index.d.ts +4 -1
  169. package/lib/molstar/core/index.d.ts.map +1 -1
  170. package/lib/molstar/core/index.js +2 -1
  171. package/lib/molstar/core/index.js.map +1 -1
  172. package/lib/pedagogy/core/answers.d.ts +46 -0
  173. package/lib/pedagogy/core/answers.d.ts.map +1 -0
  174. package/lib/pedagogy/core/answers.js +77 -0
  175. package/lib/pedagogy/core/answers.js.map +1 -0
  176. package/lib/pedagogy/core/attempts.d.ts +86 -0
  177. package/lib/pedagogy/core/attempts.d.ts.map +1 -0
  178. package/lib/pedagogy/core/attempts.js +117 -0
  179. package/lib/pedagogy/core/attempts.js.map +1 -0
  180. package/lib/pedagogy/core/index.d.ts +8 -0
  181. package/lib/pedagogy/core/index.d.ts.map +1 -1
  182. package/lib/pedagogy/core/index.js +4 -0
  183. package/lib/pedagogy/core/index.js.map +1 -1
  184. package/lib/pedagogy/core/progressController.d.ts +64 -0
  185. package/lib/pedagogy/core/progressController.d.ts.map +1 -0
  186. package/lib/pedagogy/core/progressController.js +56 -0
  187. package/lib/pedagogy/core/progressController.js.map +1 -0
  188. package/lib/pedagogy/core/seed.d.ts +96 -0
  189. package/lib/pedagogy/core/seed.d.ts.map +1 -0
  190. package/lib/pedagogy/core/seed.js +128 -0
  191. package/lib/pedagogy/core/seed.js.map +1 -0
  192. package/lib/pedagogy/core/series.d.ts +77 -0
  193. package/lib/pedagogy/core/series.d.ts.map +1 -0
  194. package/lib/pedagogy/core/series.js +10 -0
  195. package/lib/pedagogy/core/series.js.map +1 -0
  196. package/lib/pedagogy/ui/AnswerFields.d.ts +21 -0
  197. package/lib/pedagogy/ui/AnswerFields.d.ts.map +1 -0
  198. package/lib/pedagogy/ui/AnswerFields.js +24 -0
  199. package/lib/pedagogy/ui/AnswerFields.js.map +1 -0
  200. package/lib/pedagogy/ui/ExerciseList.d.ts +82 -0
  201. package/lib/pedagogy/ui/ExerciseList.d.ts.map +1 -0
  202. package/lib/pedagogy/ui/ExerciseList.js +53 -0
  203. package/lib/pedagogy/ui/ExerciseList.js.map +1 -0
  204. package/lib/pedagogy/ui/ExerciseSeries.d.ts +95 -0
  205. package/lib/pedagogy/ui/ExerciseSeries.d.ts.map +1 -0
  206. package/lib/pedagogy/ui/ExerciseSeries.js +74 -0
  207. package/lib/pedagogy/ui/ExerciseSeries.js.map +1 -0
  208. package/lib/pedagogy/ui/QuestionCard.d.ts +64 -0
  209. package/lib/pedagogy/ui/QuestionCard.d.ts.map +1 -0
  210. package/lib/pedagogy/ui/QuestionCard.js +73 -0
  211. package/lib/pedagogy/ui/QuestionCard.js.map +1 -0
  212. package/lib/pedagogy/ui/index.d.ts +10 -0
  213. package/lib/pedagogy/ui/index.d.ts.map +1 -1
  214. package/lib/pedagogy/ui/index.js +6 -0
  215. package/lib/pedagogy/ui/index.js.map +1 -1
  216. package/lib/pedagogy/ui/seriesCounts.d.ts +17 -0
  217. package/lib/pedagogy/ui/seriesCounts.d.ts.map +1 -0
  218. package/lib/pedagogy/ui/seriesCounts.js +27 -0
  219. package/lib/pedagogy/ui/seriesCounts.js.map +1 -0
  220. package/lib/pedagogy/ui/seriesParts.d.ts +55 -0
  221. package/lib/pedagogy/ui/seriesParts.d.ts.map +1 -0
  222. package/lib/pedagogy/ui/seriesParts.js +38 -0
  223. package/lib/pedagogy/ui/seriesParts.js.map +1 -0
  224. package/lib/pedagogy/ui/useAttemptRecords.d.ts +10 -0
  225. package/lib/pedagogy/ui/useAttemptRecords.d.ts.map +1 -0
  226. package/lib/pedagogy/ui/useAttemptRecords.js +11 -0
  227. package/lib/pedagogy/ui/useAttemptRecords.js.map +1 -0
  228. package/lib/periodic/ui/PeriodicTable.d.ts.map +1 -1
  229. package/lib/periodic/ui/PeriodicTable.js +6 -3
  230. package/lib/periodic/ui/PeriodicTable.js.map +1 -1
  231. package/lib/property/core/copyableText.d.ts +14 -0
  232. package/lib/property/core/copyableText.d.ts.map +1 -0
  233. package/lib/property/core/copyableText.js +21 -0
  234. package/lib/property/core/copyableText.js.map +1 -0
  235. package/lib/property/core/index.d.ts +2 -0
  236. package/lib/property/core/index.d.ts.map +1 -0
  237. package/lib/property/core/index.js +2 -0
  238. package/lib/property/core/index.js.map +1 -0
  239. package/lib/property/ui/PropertyTable.d.ts +43 -0
  240. package/lib/property/ui/PropertyTable.d.ts.map +1 -0
  241. package/lib/property/ui/PropertyTable.js +19 -0
  242. package/lib/property/ui/PropertyTable.js.map +1 -0
  243. package/lib/property/ui/index.d.ts +3 -0
  244. package/lib/property/ui/index.d.ts.map +1 -0
  245. package/lib/property/ui/index.js +2 -0
  246. package/lib/property/ui/index.js.map +1 -0
  247. package/lib/router/core/history.d.ts +24 -3
  248. package/lib/router/core/history.d.ts.map +1 -1
  249. package/lib/router/core/history.js +55 -7
  250. package/lib/router/core/history.js.map +1 -1
  251. package/lib/router/core/index.d.ts +3 -3
  252. package/lib/router/core/index.d.ts.map +1 -1
  253. package/lib/router/core/index.js +2 -2
  254. package/lib/router/core/index.js.map +1 -1
  255. package/lib/router/core/languageRoute.d.ts +61 -0
  256. package/lib/router/core/languageRoute.d.ts.map +1 -0
  257. package/lib/router/core/languageRoute.js +96 -0
  258. package/lib/router/core/languageRoute.js.map +1 -0
  259. package/lib/router/core/siteAddresses.d.ts +23 -0
  260. package/lib/router/core/siteAddresses.d.ts.map +1 -1
  261. package/lib/router/core/siteAddresses.js +26 -0
  262. package/lib/router/core/siteAddresses.js.map +1 -1
  263. package/lib/router/core/tabRouter.d.ts +2 -108
  264. package/lib/router/core/tabRouter.d.ts.map +1 -1
  265. package/lib/router/core/tabRouter.js +38 -5
  266. package/lib/router/core/tabRouter.js.map +1 -1
  267. package/lib/router/core/tabRouterTypes.d.ts +154 -0
  268. package/lib/router/core/tabRouterTypes.d.ts.map +1 -0
  269. package/lib/router/core/tabRouterTypes.js +2 -0
  270. package/lib/router/core/tabRouterTypes.js.map +1 -0
  271. package/lib/seo/core/fitDescription.d.ts +40 -0
  272. package/lib/seo/core/fitDescription.d.ts.map +1 -0
  273. package/lib/seo/core/fitDescription.js +45 -0
  274. package/lib/seo/core/fitDescription.js.map +1 -0
  275. package/lib/seo/core/index.d.ts +7 -0
  276. package/lib/seo/core/index.d.ts.map +1 -1
  277. package/lib/seo/core/index.js +4 -0
  278. package/lib/seo/core/index.js.map +1 -1
  279. package/lib/seo/core/limits.d.ts +24 -0
  280. package/lib/seo/core/limits.d.ts.map +1 -0
  281. package/lib/seo/core/limits.js +24 -0
  282. package/lib/seo/core/limits.js.map +1 -0
  283. package/lib/seo/core/pageContent.d.ts +25 -0
  284. package/lib/seo/core/pageContent.d.ts.map +1 -0
  285. package/lib/seo/core/pageContent.js +25 -0
  286. package/lib/seo/core/pageContent.js.map +1 -0
  287. package/lib/seo/core/plainDescription.d.ts.map +1 -1
  288. package/lib/seo/core/plainDescription.js +3 -2
  289. package/lib/seo/core/plainDescription.js.map +1 -1
  290. package/lib/seo/core/routeProblems.d.ts.map +1 -1
  291. package/lib/seo/core/routeProblems.js +1 -6
  292. package/lib/seo/core/routeProblems.js.map +1 -1
  293. package/lib/seo/core/routeTable.d.ts +31 -0
  294. package/lib/seo/core/routeTable.d.ts.map +1 -0
  295. package/lib/seo/core/routeTable.js +96 -0
  296. package/lib/seo/core/routeTable.js.map +1 -0
  297. package/lib/seo/vite/index.d.ts +2 -0
  298. package/lib/seo/vite/index.d.ts.map +1 -1
  299. package/lib/seo/vite/index.js +1 -0
  300. package/lib/seo/vite/index.js.map +1 -1
  301. package/lib/seo/vite/prerender.d.ts +10 -0
  302. package/lib/seo/vite/prerender.d.ts.map +1 -1
  303. package/lib/seo/vite/prerender.js +12 -1
  304. package/lib/seo/vite/prerender.js.map +1 -1
  305. package/lib/seo/vite/routeTable.d.ts +40 -0
  306. package/lib/seo/vite/routeTable.d.ts.map +1 -0
  307. package/lib/seo/vite/routeTable.js +44 -0
  308. package/lib/seo/vite/routeTable.js.map +1 -0
  309. package/lib/server/answerAddresses.d.ts +51 -0
  310. package/lib/server/answerAddresses.d.ts.map +1 -0
  311. package/lib/server/answerAddresses.js +72 -0
  312. package/lib/server/answerAddresses.js.map +1 -0
  313. package/lib/server/cardMeta.d.ts +57 -0
  314. package/lib/server/cardMeta.d.ts.map +1 -0
  315. package/lib/server/cardMeta.js +52 -0
  316. package/lib/server/cardMeta.js.map +1 -0
  317. package/lib/server/config.d.ts +72 -0
  318. package/lib/server/config.d.ts.map +1 -0
  319. package/lib/server/config.js +67 -0
  320. package/lib/server/config.js.map +1 -0
  321. package/lib/server/envNumber.d.ts +35 -0
  322. package/lib/server/envNumber.d.ts.map +1 -0
  323. package/lib/server/envNumber.js +42 -0
  324. package/lib/server/envNumber.js.map +1 -0
  325. package/lib/server/healthRoute.d.ts +26 -0
  326. package/lib/server/healthRoute.d.ts.map +1 -0
  327. package/lib/server/healthRoute.js +22 -0
  328. package/lib/server/healthRoute.js.map +1 -0
  329. package/lib/server/listenSite.d.ts +38 -0
  330. package/lib/server/listenSite.d.ts.map +1 -0
  331. package/lib/server/listenSite.js +60 -0
  332. package/lib/server/listenSite.js.map +1 -0
  333. package/lib/server/mcpServer.d.ts +8 -0
  334. package/lib/server/mcpServer.d.ts.map +1 -0
  335. package/lib/server/mcpServer.js +11 -0
  336. package/lib/server/mcpServer.js.map +1 -0
  337. package/lib/server/repositoryVersion.d.ts +16 -0
  338. package/lib/server/repositoryVersion.d.ts.map +1 -0
  339. package/lib/server/repositoryVersion.js +33 -0
  340. package/lib/server/repositoryVersion.js.map +1 -0
  341. package/lib/server/routeOptions.d.ts +23 -0
  342. package/lib/server/routeOptions.d.ts.map +1 -0
  343. package/lib/server/routeOptions.js +20 -0
  344. package/lib/server/routeOptions.js.map +1 -0
  345. package/lib/server/routeTable.d.ts +14 -0
  346. package/lib/server/routeTable.d.ts.map +1 -0
  347. package/lib/server/routeTable.js +32 -0
  348. package/lib/server/routeTable.js.map +1 -0
  349. package/lib/server/siteView.d.ts +29 -0
  350. package/lib/server/siteView.d.ts.map +1 -0
  351. package/lib/server/siteView.js +21 -0
  352. package/lib/server/siteView.js.map +1 -0
  353. package/lib/server/spaPages.d.ts +32 -0
  354. package/lib/server/spaPages.d.ts.map +1 -0
  355. package/lib/server/spaPages.js +126 -0
  356. package/lib/server/spaPages.js.map +1 -0
  357. package/lib/server/spaSite.d.ts +30 -0
  358. package/lib/server/spaSite.d.ts.map +1 -0
  359. package/lib/server/spaSite.js +170 -0
  360. package/lib/server/spaSite.js.map +1 -0
  361. package/lib/server/spaSiteOptions.d.ts +126 -0
  362. package/lib/server/spaSiteOptions.d.ts.map +1 -0
  363. package/lib/server/spaSiteOptions.js +2 -0
  364. package/lib/server/spaSiteOptions.js.map +1 -0
  365. package/lib/server/staticSite.d.ts +9 -0
  366. package/lib/server/staticSite.d.ts.map +1 -1
  367. package/lib/server/staticSite.js +41 -19
  368. package/lib/server/staticSite.js.map +1 -1
  369. package/lib/server/toolSiteServer.d.ts +77 -0
  370. package/lib/server/toolSiteServer.d.ts.map +1 -0
  371. package/lib/server/toolSiteServer.js +58 -0
  372. package/lib/server/toolSiteServer.js.map +1 -0
  373. package/lib/server/trustProxy.d.ts +20 -0
  374. package/lib/server/trustProxy.d.ts.map +1 -0
  375. package/lib/server/trustProxy.js +32 -0
  376. package/lib/server/trustProxy.js.map +1 -0
  377. package/lib/server/types.d.ts +13 -0
  378. package/lib/server/types.d.ts.map +1 -0
  379. package/lib/server/types.js +2 -0
  380. package/lib/server/types.js.map +1 -0
  381. package/lib/server.d.ts +22 -0
  382. package/lib/server.d.ts.map +1 -1
  383. package/lib/server.js +12 -0
  384. package/lib/server.js.map +1 -1
  385. package/lib/share/core/config.d.ts +18 -0
  386. package/lib/share/core/config.d.ts.map +1 -1
  387. package/lib/share/core/config.js +33 -2
  388. package/lib/share/core/config.js.map +1 -1
  389. package/lib/share/core/index.d.ts +3 -1
  390. package/lib/share/core/index.d.ts.map +1 -1
  391. package/lib/share/core/index.js +2 -1
  392. package/lib/share/core/index.js.map +1 -1
  393. package/lib/share/core/keySetParam.d.ts +40 -0
  394. package/lib/share/core/keySetParam.d.ts.map +1 -0
  395. package/lib/share/core/keySetParam.js +60 -0
  396. package/lib/share/core/keySetParam.js.map +1 -0
  397. package/lib/share/core/vocabulary.d.ts +8 -0
  398. package/lib/share/core/vocabulary.d.ts.map +1 -1
  399. package/lib/shell/ui/ShareControl.d.ts +75 -0
  400. package/lib/shell/ui/ShareControl.d.ts.map +1 -0
  401. package/lib/shell/ui/ShareControl.js +40 -0
  402. package/lib/shell/ui/ShareControl.js.map +1 -0
  403. package/lib/shell/ui/ShellFrame.d.ts +14 -0
  404. package/lib/shell/ui/ShellFrame.d.ts.map +1 -0
  405. package/lib/shell/ui/ShellFrame.js +45 -0
  406. package/lib/shell/ui/ShellFrame.js.map +1 -0
  407. package/lib/shell/ui/SiteShell.d.ts +251 -0
  408. package/lib/shell/ui/SiteShell.d.ts.map +1 -0
  409. package/lib/shell/ui/SiteShell.js +39 -0
  410. package/lib/shell/ui/SiteShell.js.map +1 -0
  411. package/lib/shell/ui/index.d.ts +5 -0
  412. package/lib/shell/ui/index.d.ts.map +1 -0
  413. package/lib/shell/ui/index.js +3 -0
  414. package/lib/shell/ui/index.js.map +1 -0
  415. package/lib/state/core/index.d.ts +1 -0
  416. package/lib/state/core/index.d.ts.map +1 -1
  417. package/lib/state/core/index.js.map +1 -1
  418. package/lib/state/core/legacyEntries.d.ts +30 -0
  419. package/lib/state/core/legacyEntries.d.ts.map +1 -0
  420. package/lib/state/core/legacyEntries.js +51 -0
  421. package/lib/state/core/legacyEntries.js.map +1 -0
  422. package/lib/state/core/persistBucket.d.ts +26 -2
  423. package/lib/state/core/persistBucket.d.ts.map +1 -1
  424. package/lib/state/core/persistBucket.js +26 -9
  425. package/lib/state/core/persistBucket.js.map +1 -1
  426. package/lib/state/core/persistSignalBucket.d.ts +26 -0
  427. package/lib/state/core/persistSignalBucket.d.ts.map +1 -1
  428. package/lib/state/core/persistSignalBucket.js +31 -0
  429. package/lib/state/core/persistSignalBucket.js.map +1 -1
  430. package/lib/state/core/storageEntry.d.ts +15 -0
  431. package/lib/state/core/storageEntry.d.ts.map +1 -1
  432. package/lib/state/core/storageEntry.js +33 -0
  433. package/lib/state/core/storageEntry.js.map +1 -1
  434. package/lib/structure/ui/StructureExportButton.d.ts +27 -0
  435. package/lib/structure/ui/StructureExportButton.d.ts.map +1 -0
  436. package/lib/structure/ui/StructureExportButton.js +21 -0
  437. package/lib/structure/ui/StructureExportButton.js.map +1 -0
  438. package/lib/structure/ui/index.d.ts +4 -0
  439. package/lib/structure/ui/index.d.ts.map +1 -1
  440. package/lib/structure/ui/index.js +2 -0
  441. package/lib/structure/ui/index.js.map +1 -1
  442. package/lib/structure/ui/useStructureDraft.d.ts +32 -0
  443. package/lib/structure/ui/useStructureDraft.d.ts.map +1 -0
  444. package/lib/structure/ui/useStructureDraft.js +20 -0
  445. package/lib/structure/ui/useStructureDraft.js.map +1 -0
  446. package/lib/ui.d.ts +2 -0
  447. package/lib/ui.d.ts.map +1 -1
  448. package/lib/ui.js +2 -0
  449. package/lib/ui.js.map +1 -1
  450. package/lib/worker/core/index.d.ts +1 -1
  451. package/lib/worker/core/index.d.ts.map +1 -1
  452. package/lib/worker/core/messages.d.ts +4 -2
  453. package/lib/worker/core/messages.d.ts.map +1 -1
  454. package/lib/worker/core/messages.js.map +1 -1
  455. package/lib/worker/core/oclResourcesUrl.d.ts +16 -0
  456. package/lib/worker/core/oclResourcesUrl.d.ts.map +1 -0
  457. package/lib/worker/core/oclResourcesUrl.js +19 -0
  458. package/lib/worker/core/oclResourcesUrl.js.map +1 -0
  459. package/lib/worker/core/serveWorkerRequests.d.ts +8 -0
  460. package/lib/worker/core/serveWorkerRequests.d.ts.map +1 -1
  461. package/lib/worker/core/serveWorkerRequests.js +15 -2
  462. package/lib/worker/core/serveWorkerRequests.js.map +1 -1
  463. package/lib/worker/core/workerChannel.d.ts +3 -4
  464. package/lib/worker/core/workerChannel.d.ts.map +1 -1
  465. package/lib/worker/core/workerChannel.js +72 -67
  466. package/lib/worker/core/workerChannel.js.map +1 -1
  467. package/lib/worker/core/workerChannelParts.d.ts +17 -6
  468. package/lib/worker/core/workerChannelParts.d.ts.map +1 -1
  469. package/lib/worker/core/workerChannelParts.js +20 -4
  470. package/lib/worker/core/workerChannelParts.js.map +1 -1
  471. package/lib/worker/core/workerChannelTypes.d.ts +46 -2
  472. package/lib/worker/core/workerChannelTypes.d.ts.map +1 -1
  473. package/lib/worker/core/workerSlot.d.ts +66 -0
  474. package/lib/worker/core/workerSlot.d.ts.map +1 -0
  475. package/lib/worker/core/workerSlot.js +107 -0
  476. package/lib/worker/core/workerSlot.js.map +1 -0
  477. package/package.json +16 -1
  478. package/src/card/core/cardAddress.ts +100 -0
  479. package/src/card/core/cardPageUrl.ts +97 -0
  480. package/src/card/core/index.ts +6 -0
  481. package/src/card/core/panelRoom.ts +66 -0
  482. package/src/card/ui/CardDetailsButton.tsx +104 -0
  483. package/src/card/ui/CardFigure.tsx +86 -0
  484. package/src/card/ui/CardFrame.tsx +46 -0
  485. package/src/card/ui/CopyTableButton.tsx +81 -0
  486. package/src/card/ui/cardTooltip.ts +18 -0
  487. package/src/card/ui/embed.ts +27 -0
  488. package/src/card/ui/fitCardToFrame.ts +76 -0
  489. package/src/card/ui/holdRoomForPanels.ts +83 -0
  490. package/src/card/ui/index.ts +14 -0
  491. package/src/card/ui/openPanels.ts +106 -0
  492. package/src/card.ts +13 -0
  493. package/src/conformers.ts +4 -0
  494. package/src/core.ts +5 -0
  495. package/src/fetch/core/apiError.ts +65 -0
  496. package/src/fetch/core/fetchJson.ts +129 -0
  497. package/src/fetch/core/index.ts +4 -0
  498. package/src/formula/core/formulaText.ts +96 -0
  499. package/src/formula/core/index.ts +20 -0
  500. package/src/formula/core/normalizeFormula.ts +50 -0
  501. package/src/formula/core/readFormula.ts +211 -0
  502. package/src/formula/ui/CopyableFormula.tsx +51 -0
  503. package/src/formula/ui/FormulaInput.tsx +50 -0
  504. package/src/formula/ui/QuestionFormula.tsx +20 -0
  505. package/src/formula/ui/index.ts +6 -0
  506. package/src/formula.ts +11 -0
  507. package/src/hooks/ui/index.ts +1 -0
  508. package/src/hooks/ui/keyTargets.ts +5 -3
  509. package/src/hooks/ui/useAsync.ts +50 -14
  510. package/src/locales/de.json +37 -0
  511. package/src/locales/en.json +37 -0
  512. package/src/locales/es.json +37 -0
  513. package/src/locales/fr.json +37 -0
  514. package/src/locales/it.json +37 -0
  515. package/src/moleculesClient/core/index.ts +19 -0
  516. package/src/moleculesClient/core/moleculesClient.ts +175 -0
  517. package/src/moleculesClient/core/moleculesClientApi.ts +120 -0
  518. package/src/moleculesClient/core/moleculesTypes.ts +163 -0
  519. package/src/moleculesClient/core/requestRetry.ts +118 -0
  520. package/src/molstar/core/camera.ts +3 -2
  521. package/src/molstar/core/framing.ts +200 -0
  522. package/src/molstar/core/hover.ts +26 -0
  523. package/src/molstar/core/index.ts +21 -1
  524. package/src/pedagogy/core/answers.ts +94 -0
  525. package/src/pedagogy/core/attempts.ts +205 -0
  526. package/src/pedagogy/core/index.ts +36 -0
  527. package/src/pedagogy/core/progressController.ts +116 -0
  528. package/src/pedagogy/core/seed.ts +177 -0
  529. package/src/pedagogy/core/series.ts +82 -0
  530. package/src/pedagogy/ui/AnswerFields.tsx +63 -0
  531. package/src/pedagogy/ui/ExerciseList.tsx +202 -0
  532. package/src/pedagogy/ui/ExerciseSeries.tsx +250 -0
  533. package/src/pedagogy/ui/QuestionCard.tsx +231 -0
  534. package/src/pedagogy/ui/index.ts +18 -0
  535. package/src/pedagogy/ui/seriesCounts.ts +34 -0
  536. package/src/pedagogy/ui/seriesParts.tsx +127 -0
  537. package/src/pedagogy/ui/useAttemptRecords.ts +16 -0
  538. package/src/periodic/ui/PeriodicTable.tsx +6 -3
  539. package/src/property/core/copyableText.ts +20 -0
  540. package/src/property/core/index.ts +1 -0
  541. package/src/property/ui/PropertyTable.tsx +83 -0
  542. package/src/property/ui/index.ts +2 -0
  543. package/src/router/core/history.ts +61 -7
  544. package/src/router/core/index.ts +3 -2
  545. package/src/router/core/languageRoute.ts +136 -0
  546. package/src/router/core/siteAddresses.ts +38 -0
  547. package/src/router/core/tabRouter.ts +59 -117
  548. package/src/router/core/tabRouterTypes.ts +158 -0
  549. package/src/seo/core/fitDescription.ts +74 -0
  550. package/src/seo/core/index.ts +17 -0
  551. package/src/seo/core/limits.ts +27 -0
  552. package/src/seo/core/pageContent.ts +42 -0
  553. package/src/seo/core/plainDescription.ts +4 -2
  554. package/src/seo/core/routeProblems.ts +1 -7
  555. package/src/seo/core/routeTable.ts +103 -0
  556. package/src/seo/vite/index.ts +2 -0
  557. package/src/seo/vite/prerender.ts +26 -1
  558. package/src/seo/vite/routeTable.ts +79 -0
  559. package/src/server/answerAddresses.ts +92 -0
  560. package/src/server/cardMeta.ts +88 -0
  561. package/src/server/config.ts +125 -0
  562. package/src/server/envNumber.ts +65 -0
  563. package/src/server/healthRoute.ts +42 -0
  564. package/src/server/listenSite.ts +90 -0
  565. package/src/server/mcpServer.ts +14 -0
  566. package/src/server/repositoryVersion.ts +33 -0
  567. package/src/server/routeOptions.ts +26 -0
  568. package/src/server/routeTable.ts +35 -0
  569. package/src/server/siteView.ts +42 -0
  570. package/src/server/spaPages.ts +179 -0
  571. package/src/server/spaSite.ts +216 -0
  572. package/src/server/spaSiteOptions.ts +133 -0
  573. package/src/server/staticSite.ts +65 -35
  574. package/src/server/toolSiteServer.ts +127 -0
  575. package/src/server/trustProxy.ts +32 -0
  576. package/src/server/types.ts +25 -0
  577. package/src/server.ts +40 -0
  578. package/src/share/core/config.ts +45 -2
  579. package/src/share/core/index.ts +4 -0
  580. package/src/share/core/keySetParam.ts +92 -0
  581. package/src/share/core/vocabulary.ts +8 -0
  582. package/src/shell/ui/ShareControl.tsx +150 -0
  583. package/src/shell/ui/ShellFrame.tsx +180 -0
  584. package/src/shell/ui/SiteShell.tsx +297 -0
  585. package/src/shell/ui/index.ts +9 -0
  586. package/src/state/core/index.ts +1 -0
  587. package/src/state/core/legacyEntries.ts +76 -0
  588. package/src/state/core/persistBucket.ts +50 -10
  589. package/src/state/core/persistSignalBucket.ts +52 -0
  590. package/src/state/core/storageEntry.ts +32 -0
  591. package/src/structure/ui/StructureExportButton.tsx +57 -0
  592. package/src/structure/ui/index.ts +4 -0
  593. package/src/structure/ui/useStructureDraft.ts +47 -0
  594. package/src/ui.ts +2 -0
  595. package/src/worker/core/index.ts +1 -0
  596. package/src/worker/core/messages.ts +4 -3
  597. package/src/worker/core/oclResourcesUrl.ts +21 -0
  598. package/src/worker/core/serveWorkerRequests.ts +30 -2
  599. package/src/worker/core/workerChannel.ts +74 -74
  600. package/src/worker/core/workerChannelParts.ts +33 -13
  601. package/src/worker/core/workerChannelTypes.ts +47 -2
  602. package/src/worker/core/workerSlot.ts +181 -0
  603. package/styles/card.css +145 -0
  604. package/styles/chrome.css +248 -0
@@ -0,0 +1,179 @@
1
+ import { withoutQueryOrFragment } from '../router/core/address.ts';
2
+ import { stripBasePath } from '../router/core/basePath.ts';
3
+ import { noscriptIndex } from '../seo/core/noscript.ts';
4
+ import { pageHeadTags } from '../seo/core/pageMeta.ts';
5
+ import type { PageContent } from '../seo/core/pageProse.ts';
6
+ import type { RouteMeta } from '../seo/core/routes.ts';
7
+ import { pageMetaFor, routeFor } from '../seo/core/routes.ts';
8
+ import { mountPathOf, resolveSite } from '../seo/core/siteFiles.ts';
9
+ import { structuredDataScript } from '../seo/core/structuredData.ts';
10
+ import {
11
+ PAGE_BODY_MARKER,
12
+ PAGE_HEAD_MARKER,
13
+ fill,
14
+ } from '../seo/core/template.ts';
15
+ import { injectTrackingScript } from '../seo/core/trackingScript.ts';
16
+
17
+ import type { SpaSiteOptions } from './spaSiteOptions.ts';
18
+
19
+ /** The page an address is answered with. */
20
+ export interface SpaAnswer {
21
+ /** The page, its head and its crawl path written for the address. */
22
+ html: string;
23
+ /** Whether the app routes the address, rather than drawing its "not found". */
24
+ known: boolean;
25
+ }
26
+
27
+ /** Writes the page every address of a single-page app is answered with. */
28
+ export interface SpaPages {
29
+ /**
30
+ * The page for one address.
31
+ * @param url - The address asked for, query string included.
32
+ * @param origin - Where the site is served, mount path included.
33
+ * @returns The page, and whether the app routes the address.
34
+ */
35
+ answer: (url: string, origin: string) => Promise<SpaAnswer>;
36
+ }
37
+
38
+ /**
39
+ * Prepare the pages of a single-page app from its built template: the snippet
40
+ * is put in once, the crawl path is written once per page and kept, and the
41
+ * head — which names the origin the request arrived on — per request.
42
+ * @param template - The built `index.html`.
43
+ * @param routes - Every address the app routes itself.
44
+ * @param options - The site, and how its pages are written.
45
+ * @returns The page writer.
46
+ * @throws {Error} When an indexed site's template carries no head or body
47
+ * marker, rather than failing on every request afterwards.
48
+ */
49
+ export function createSpaPages(
50
+ template: string,
51
+ routes: readonly RouteMeta[],
52
+ options: SpaSiteOptions,
53
+ ): SpaPages {
54
+ const site = resolveSite(options.site);
55
+ const indexed = options.indexed ?? true;
56
+ const page = injectTrackingScript(template, options.trackingScript);
57
+ if (indexed) {
58
+ for (const marker of [PAGE_HEAD_MARKER, PAGE_BODY_MARKER]) {
59
+ if (!page.includes(marker)) {
60
+ throw new Error(`the page carries no ${marker}`);
61
+ }
62
+ }
63
+ }
64
+ const write = indexed ? fill : fillIfPresent;
65
+ const bodyFor = keptBodies(options.maxCachedPages ?? 2000);
66
+ const crawled = options.noscript?.routes ?? indexedRoutes(routes);
67
+ const structured = structuredData(routes, options);
68
+
69
+ return {
70
+ async answer(url, origin) {
71
+ const mount = mountPathOf({ site, origin });
72
+ const named = await options.page?.(url);
73
+ const meta = named?.meta ?? pageMetaFor(routes, url, mount);
74
+ const content: PageContent = named?.content ?? {
75
+ heading: meta.title,
76
+ paragraphs: [meta.description],
77
+ };
78
+ const body = bodyFor(
79
+ meta.path,
80
+ `${mount}\n${JSON.stringify(content)}`,
81
+ () =>
82
+ write(
83
+ page,
84
+ PAGE_BODY_MARKER,
85
+ noscriptIndex({
86
+ ...options.noscript,
87
+ site,
88
+ origin,
89
+ routes: crawled,
90
+ content,
91
+ }),
92
+ ),
93
+ );
94
+ const served = indexed ? meta : { ...meta, indexed: false };
95
+ const tags = pageHeadTags({
96
+ site,
97
+ routes: [served],
98
+ origin,
99
+ url: served.path,
100
+ image: options.image,
101
+ });
102
+ const script = indexed ? structured(origin) : undefined;
103
+ const head = script === undefined ? tags : `${tags}\n${script}`;
104
+ return {
105
+ html: write(body, PAGE_HEAD_MARKER, head),
106
+ known:
107
+ named !== undefined ||
108
+ isKnown(routes, url, mount, options.knownRoute),
109
+ };
110
+ },
111
+ };
112
+ }
113
+
114
+ function indexedRoutes(routes: readonly RouteMeta[]): RouteMeta[] {
115
+ return routes.filter((route) => route.indexed !== false);
116
+ }
117
+
118
+ function isKnown(
119
+ routes: readonly RouteMeta[],
120
+ url: string,
121
+ mount: string,
122
+ knownRoute: ((path: string) => boolean) | undefined,
123
+ ): boolean {
124
+ const path = withoutQueryOrFragment(url);
125
+ const own = stripBasePath(mount, path);
126
+ if (knownRoute !== undefined) return knownRoute(own);
127
+ return (
128
+ routeFor(routes, own) !== undefined || routeFor(routes, path) !== undefined
129
+ );
130
+ }
131
+
132
+ // The block is the same on every page of an origin, so the one origin a
133
+ // configured site is served at is written once rather than per request.
134
+ function structuredData(
135
+ routes: readonly RouteMeta[],
136
+ options: SpaSiteOptions,
137
+ ): (origin: string) => string | undefined {
138
+ const option = options.structuredData ?? {};
139
+ if (option === false) return () => undefined;
140
+ if (typeof option === 'function') return option;
141
+ let last: { origin: string; script: string } | undefined;
142
+ return (origin) => {
143
+ if (last?.origin !== origin) {
144
+ const script = structuredDataScript({
145
+ ...option,
146
+ site: options.site,
147
+ routes,
148
+ origin,
149
+ });
150
+ last = { origin, script };
151
+ }
152
+ return last.script;
153
+ };
154
+ }
155
+
156
+ // The crawl path of a page is kept under its canonical path, and rebuilt when
157
+ // what the page says changes — a course renamed, a compound read again.
158
+ function keptBodies(
159
+ limit: number,
160
+ ): (path: string, key: string, build: () => string) => string {
161
+ const kept = new Map<string, { key: string; html: string }>();
162
+ return (path, key, build) => {
163
+ const entry = kept.get(path);
164
+ if (entry?.key === key) return entry.html;
165
+ const html = build();
166
+ if (limit <= 0) return html;
167
+ kept.delete(path);
168
+ if (kept.size >= limit) {
169
+ const oldest = kept.keys().next();
170
+ if (oldest.done !== true) kept.delete(oldest.value);
171
+ }
172
+ kept.set(path, { key, html });
173
+ return html;
174
+ };
175
+ }
176
+
177
+ function fillIfPresent(html: string, marker: string, content: string): string {
178
+ return html.includes(marker) ? fill(html, marker, content) : html;
179
+ }
@@ -0,0 +1,216 @@
1
+ import { readFile } from 'node:fs/promises';
2
+ import { join, relative, resolve, sep } from 'node:path';
3
+
4
+ import type { FastifyInstance, FastifyReply, FastifyRequest } from 'fastify';
5
+
6
+ import type { SiteRecord } from '../ecosystem/core/sites.ts';
7
+ import { robotsTxt } from '../seo/core/robots.ts';
8
+ import type { RouteMeta } from '../seo/core/routes.ts';
9
+ import { originOf, resolveSite, sitemapXml } from '../seo/core/siteFiles.ts';
10
+
11
+ import { healthRoute } from './healthRoute.ts';
12
+ import {
13
+ BUNDLE_CACHE,
14
+ DEFAULT_RESERVED,
15
+ HIDDEN,
16
+ PAGE_CACHE,
17
+ } from './routeOptions.ts';
18
+ import { readRouteTable } from './routeTable.ts';
19
+ import { isHashedBundle, listSiteFiles } from './siteFiles.ts';
20
+ import type { SpaPages } from './spaPages.ts';
21
+ import { createSpaPages } from './spaPages.ts';
22
+ import type { SpaSiteOptions } from './spaSiteOptions.ts';
23
+
24
+ /** The page the build wrote, which is a template and never served as it is. */
25
+ const INDEX = 'index.html';
26
+
27
+ /** What keeps a page out of the index without stopping its crawl. */
28
+ const NO_INDEX = 'noindex, nofollow';
29
+
30
+ /** The policy of a site nobody is meant to find. */
31
+ const DISALLOW_ALL = 'User-agent: *\nDisallow: /\n';
32
+
33
+ /**
34
+ * Serve a single-page app from the backend that answers its API.
35
+ *
36
+ * Every address the app routes itself is the built page, with the head of that
37
+ * address — its title, description, canonical and card — and a crawl path of
38
+ * its own in its body, so a crawler that runs no script still tells the pages
39
+ * apart. The `TRACKING_SCRIPT` snippet is in every page. `sitemap.xml` and
40
+ * `robots.txt` are written from the route table, at the address the site is
41
+ * served at; the files of the build are served as they are, `assets/` kept for
42
+ * a year; an address under `reserved` is the API's own 404; and `/health`
43
+ * answers the deploy script.
44
+ *
45
+ * await app.register(spaSite, {
46
+ * root: 'frontend/dist',
47
+ * site: 'derepflow',
48
+ * siteUrl: process.env.SITE_URL,
49
+ * trackingScript: process.env.TRACKING_SCRIPT,
50
+ * });
51
+ *
52
+ * Without a build — a server started before the frontend was built — it logs
53
+ * it and serves the API alone.
54
+ * @param fastify - The server.
55
+ * @param options - The build, the site, and how its pages are written.
56
+ * @throws {Error} When `siteUrl` is not an absolute address, or the page of an
57
+ * indexed site carries no `<!--cheminfo:head-->` or `<!--cheminfo:body-->`.
58
+ */
59
+ export async function spaSite(
60
+ fastify: FastifyInstance,
61
+ options: SpaSiteOptions,
62
+ ): Promise<void> {
63
+ const {
64
+ health = true,
65
+ reserved = DEFAULT_RESERVED,
66
+ notFoundStatus = 200,
67
+ indexed = true,
68
+ siteUrl,
69
+ robots = DEFAULT_RESERVED,
70
+ sitemapPaths,
71
+ setHeaders,
72
+ } = options;
73
+ const site = resolveSite(options.site);
74
+ if (health !== false) {
75
+ await healthRoute(fastify, health === true ? {} : health);
76
+ }
77
+
78
+ const root = resolve(options.root);
79
+ const files = await listSiteFiles(root);
80
+ if (!files?.has(INDEX)) {
81
+ fastify.log.warn({ root }, 'no built frontend: serving the API alone');
82
+ return;
83
+ }
84
+ const routes = options.routes ?? readRouteTable(root, [homeOf(site)]);
85
+ const configured = siteUrl?.trim() || undefined;
86
+ if (configured !== undefined) originOf({ site, origin: configured });
87
+ const pages = createSpaPages(
88
+ await readFile(join(root, INDEX), 'utf8'),
89
+ routes,
90
+ options,
91
+ );
92
+ const originFor = (request: FastifyRequest) =>
93
+ configured ?? requestOrigin(request, site);
94
+
95
+ // An optional peer, installed only by a site that has a server: importing
96
+ // react-cheminfo/server must not need it.
97
+ const { default: fastifyStatic } = await import('@fastify/static');
98
+ await fastify.register(fastifyStatic, {
99
+ root,
100
+ serve: false,
101
+ cacheControl: false,
102
+ setHeaders: (reply, path) => {
103
+ const file = relative(root, path).split(sep).join('/');
104
+ reply.header(
105
+ 'cache-control',
106
+ isHashedBundle(file) ? BUNDLE_CACHE : PAGE_CACHE,
107
+ );
108
+ if (!indexed) reply.header('x-robots-tag', NO_INDEX);
109
+ setHeaders?.(reply, file);
110
+ },
111
+ });
112
+
113
+ const sendPage = sender(pages, originFor, { indexed, notFoundStatus });
114
+ const answer = (request: FastifyRequest, reply: FastifyReply) => {
115
+ const { pathname, search } = new URL(request.url, 'http://site');
116
+ if (reserved.some((prefix) => pathname.startsWith(prefix))) {
117
+ return reply.callNotFound();
118
+ }
119
+ if (pathname === `/${INDEX}`) return sendPage(request, reply, `/${search}`);
120
+ const file = buildFile(files, pathname);
121
+ if (file !== undefined) return reply.sendFile(file);
122
+ return sendPage(request, reply, request.url);
123
+ };
124
+ fastify.get('/', { schema: HIDDEN }, answer);
125
+ fastify.get('/*', { schema: HIDDEN }, answer);
126
+
127
+ fastify.get('/robots.txt', { schema: HIDDEN }, (request, reply) =>
128
+ reply
129
+ .type('text/plain; charset=utf-8')
130
+ .send(
131
+ indexed
132
+ ? robotsTxt({ site, routes, origin: originFor(request) }, robots)
133
+ : DISALLOW_ALL,
134
+ ),
135
+ );
136
+ fastify.get('/sitemap.xml', { schema: HIDDEN }, async (request, reply) => {
137
+ if (!indexed) return reply.callNotFound();
138
+ const paths = (await sitemapPaths?.()) ?? [];
139
+ const listed: RouteMeta[] = [...routes];
140
+ for (const path of paths) listed.push({ path, title: '', description: '' });
141
+ return reply
142
+ .type('application/xml; charset=utf-8')
143
+ .send(sitemapXml({ site, routes: listed, origin: originFor(request) }));
144
+ });
145
+ }
146
+
147
+ /**
148
+ * The handler answering an address with its page.
149
+ * @param pages - The page writer.
150
+ * @param originFor - Where the site is served, for a request.
151
+ * @param status - How the answer is labelled.
152
+ * @param status.indexed - Whether search engines may index the site.
153
+ * @param status.notFoundStatus - The status of an address the app does not route.
154
+ * @returns The handler.
155
+ */
156
+ function sender(
157
+ pages: SpaPages,
158
+ originFor: (request: FastifyRequest) => string,
159
+ status: { indexed: boolean; notFoundStatus: number },
160
+ ) {
161
+ return async (request: FastifyRequest, reply: FastifyReply, url: string) => {
162
+ const { html, known } = await pages.answer(url, originFor(request));
163
+ reply.header('cache-control', PAGE_CACHE);
164
+ if (!status.indexed) reply.header('x-robots-tag', NO_INDEX);
165
+ return reply
166
+ .code(known ? 200 : status.notFoundStatus)
167
+ .type('text/html; charset=utf-8')
168
+ .send(html);
169
+ };
170
+ }
171
+
172
+ /**
173
+ * The file of the build an address names, never the template.
174
+ * @param files - The files of the build.
175
+ * @param pathname - The address, without its query.
176
+ * @returns The file, or `undefined` when the address is a page.
177
+ */
178
+ function buildFile(
179
+ files: ReadonlySet<string>,
180
+ pathname: string,
181
+ ): string | undefined {
182
+ let path: string;
183
+ try {
184
+ path = decodeURIComponent(pathname);
185
+ } catch {
186
+ return undefined;
187
+ }
188
+ const local = path.replace(/^\/+/, '');
189
+ if (local === '' || local === INDEX) return undefined;
190
+ return files.has(local) ? local : undefined;
191
+ }
192
+
193
+ /**
194
+ * The origin a request arrived on. The `Host` header is the client's to write,
195
+ * so one that is not a host falls back to the site's own address rather than
196
+ * reaching a canonical link.
197
+ * @param request - The request.
198
+ * @param site - The site served.
199
+ * @returns The origin, e.g. `https://pdb.cheminfo.org`.
200
+ */
201
+ function requestOrigin(request: FastifyRequest, site: SiteRecord): string {
202
+ const candidate = `${request.protocol}://${request.host}`;
203
+ return URL.canParse(candidate)
204
+ ? new URL(candidate).origin
205
+ : `https://${site.host}`;
206
+ }
207
+
208
+ /**
209
+ * The page a site answers when its build wrote no route table.
210
+ * @param site - The site.
211
+ * @returns Its home page, titled and described by its tagline.
212
+ */
213
+ function homeOf(site: SiteRecord): RouteMeta {
214
+ const title = site.tagline.replace(/\.$/, '');
215
+ return { path: '/', title, description: site.tagline };
216
+ }
@@ -0,0 +1,133 @@
1
+ import type { FastifyReply } from 'fastify';
2
+
3
+ import type { SiteId, SiteRecord } from '../ecosystem/core/sites.ts';
4
+ import type { NoscriptText } from '../seo/core/noscript.ts';
5
+ import type { PageContent } from '../seo/core/pageProse.ts';
6
+ import type { RobotsDisallow } from '../seo/core/robots.ts';
7
+ import type { RouteMeta } from '../seo/core/routes.ts';
8
+ import type { StructuredDataOptions } from '../seo/core/structuredData.ts';
9
+
10
+ import type { HealthRouteOptions } from './healthRoute.ts';
11
+
12
+ /** A page an address names that the route table does not: a compound, a course. */
13
+ export interface SpaPage {
14
+ /** Its title, description and canonical path. */
15
+ meta: RouteMeta;
16
+ /**
17
+ * What it says for itself in the crawl path.
18
+ * @default its title as heading, its description as the paragraph
19
+ */
20
+ content?: PageContent;
21
+ }
22
+
23
+ /** What the structured-data block says beyond the site and its address. */
24
+ export type SpaStructuredData = Omit<
25
+ StructuredDataOptions,
26
+ 'site' | 'routes' | 'origin' | 'languages'
27
+ >;
28
+
29
+ /** Options of `spaSite`. */
30
+ export interface SpaSiteOptions {
31
+ /** The directory holding the built frontend. */
32
+ root: string;
33
+ /** The site, named or passed. */
34
+ site: SiteRecord | SiteId;
35
+ /**
36
+ * Every address the frontend routes itself, each with its title and
37
+ * description.
38
+ * @default the `routes.json` the build wrote beside the page, or the site's
39
+ * home page alone
40
+ */
41
+ routes?: readonly RouteMeta[];
42
+ /**
43
+ * Where the site is served, mount path included, e.g.
44
+ * `https://learn.cheminfo.org/surge`. Every canonical, card and sitemap address
45
+ * is built on it. A blank value is unset, as compose forwards `${SITE_URL:-}`.
46
+ * @default the origin the request arrived on
47
+ */
48
+ siteUrl?: string;
49
+ /**
50
+ * The analytics snippet, put at the end of the head of every page.
51
+ * @default undefined - nothing is loaded
52
+ */
53
+ trackingScript?: string;
54
+ /**
55
+ * Address prefixes another plugin answers, such as the API, which never
56
+ * answer a page: an unknown address there is the API's own 404.
57
+ * @default ['/v1/', '/docs']
58
+ */
59
+ reserved?: readonly string[];
60
+ /**
61
+ * The prose of the crawl path, and the pages it links.
62
+ * @default the site's name and tagline, linking every indexed route
63
+ */
64
+ noscript?: NoscriptText;
65
+ /**
66
+ * The structured-data block of every page: what kind of application the site
67
+ * is, a function writing the whole `<script>` for the origin served (an
68
+ * author, a citation, a search action), or `false` for none.
69
+ * @default {} - a free web application, described by the site's tagline
70
+ */
71
+ structuredData?: false | SpaStructuredData | ((origin: string) => string);
72
+ /**
73
+ * The card a link to a page unfurls into, as an absolute address or a path.
74
+ * @default '/og.png'
75
+ */
76
+ image?: string;
77
+ /**
78
+ * Addresses `robots.txt` keeps out of the index, each optionally with the
79
+ * sentence saying why.
80
+ * @default ['/v1/', '/docs']
81
+ */
82
+ robots?: ReadonlyArray<string | RobotsDisallow>;
83
+ /**
84
+ * More addresses the sitemap lists after the route table: one per compound,
85
+ * per published course.
86
+ * @default undefined - the route table alone
87
+ */
88
+ sitemapPaths?: () => readonly string[] | Promise<readonly string[]>;
89
+ /**
90
+ * The page an address names when the route table does not: read from the
91
+ * database, so `/compound/1234` is indexed under the compound's own name.
92
+ * `undefined` falls back to the table.
93
+ * @default undefined - every address is read from the table
94
+ */
95
+ page?: (url: string) => SpaPage | undefined | Promise<SpaPage | undefined>;
96
+ /**
97
+ * Whether an address is one the app routes, given its path without the query
98
+ * and without the mount.
99
+ * @default whether the route table claims it, or `page` named it
100
+ */
101
+ knownRoute?: (path: string) => boolean;
102
+ /**
103
+ * The status an address the app does not route is answered with. It is
104
+ * still the page, so the app draws its own "not found", but a crawler is not
105
+ * handed a soft 404.
106
+ * @default 200
107
+ */
108
+ notFoundStatus?: number;
109
+ /**
110
+ * Whether search engines may index the site. An admin site sets `false`:
111
+ * every answer then carries `X-Robots-Tag: noindex, nofollow`, `robots.txt`
112
+ * disallows everything, there is no sitemap, and a page without the
113
+ * `<!--cheminfo:head-->` marker is served as it is.
114
+ * @default true
115
+ */
116
+ indexed?: boolean;
117
+ /**
118
+ * How many pages, each with its own crawl path, are kept built.
119
+ * @default 2000
120
+ */
121
+ maxCachedPages?: number;
122
+ /**
123
+ * Whether `/health` is answered here, and with what more.
124
+ * @default true
125
+ */
126
+ health?: boolean | HealthRouteOptions;
127
+ /**
128
+ * Headers for a file of the build, such as a cross-origin opening for the
129
+ * decks another site fetches.
130
+ * @default undefined - the cache headers alone
131
+ */
132
+ setHeaders?: (reply: FastifyReply, file: string) => void;
133
+ }
@@ -1,15 +1,19 @@
1
1
  import { readFile } from 'node:fs/promises';
2
2
  import { join, relative, resolve, sep } from 'node:path';
3
3
 
4
- import type {
5
- FastifyInstance,
6
- FastifyReply,
7
- FastifyRequest,
8
- FastifySchema,
9
- } from 'fastify';
4
+ import type { FastifyInstance, FastifyReply, FastifyRequest } from 'fastify';
10
5
 
6
+ import { joinBasePath, normalizeBasePath } from '../router/core/basePath.ts';
11
7
  import { injectTrackingScript } from '../seo/core/trackingScript.ts';
12
-
8
+ import { escapeAttribute } from '../share/core/escape.ts';
9
+
10
+ import { healthRoute } from './healthRoute.ts';
11
+ import {
12
+ ALLOW_ORIGIN,
13
+ BUNDLE_CACHE,
14
+ HIDDEN,
15
+ PAGE_CACHE,
16
+ } from './routeOptions.ts';
13
17
  import { isHashedBundle, listSiteFiles, resolveAddress } from './siteFiles.ts';
14
18
 
15
19
  /** Options of {@link staticSite}. */
@@ -35,6 +39,15 @@ export interface StaticSiteOptions {
35
39
  * @default ['/v1/']
36
40
  */
37
41
  reserved?: readonly string[];
42
+ /**
43
+ * The path the deployment is mounted at, `/osiris` for
44
+ * `https://www.cheminfo.org/osiris/`, behind a proxy that takes it off before
45
+ * the request arrives. It is written into the `<base href="/">` of every page
46
+ * when they are read, and in front of every redirect, so one image serves a
47
+ * host of its own and a shared one without a rebuild or a copy of the build.
48
+ * @default '' - the site owns the root of its host
49
+ */
50
+ basePath?: string;
38
51
  }
39
52
 
40
53
  /** A page: the file with the snippet in its head, and the tag a browser checks. */
@@ -43,21 +56,8 @@ interface Page {
43
56
  etag: string;
44
57
  }
45
58
 
46
- /** A page is checked on every visit: it names the bundles of its own build. */
47
- const PAGE_CACHE = 'no-cache';
48
-
49
- /** A bundle is named by its content, so it never changes under its name. */
50
- const BUNDLE_CACHE = 'public, max-age=31536000, immutable';
51
-
52
- /**
53
- * Every file of a build is public, and a page framed by a sandboxed view runs
54
- * under an opaque origin, where everything it fetches from its own site is
55
- * cross-origin: the static hosts open every response, and so does this server.
56
- */
57
- const ALLOW_ORIGIN = 'access-control-allow-origin';
58
-
59
- /** Kept out of the API's documentation (`@fastify/swagger` reads `hide`). */
60
- const HIDDEN: FastifySchema & { hide: boolean } = { hide: true };
59
+ /** The `<base>` a build carries, which a mounted deployment rewrites. */
60
+ const ROOT_BASE = /<base\s+href=(?<quote>["'])\/\k<quote>\s*\/?>/i;
61
61
 
62
62
  /**
63
63
  * Serve a site's build from Node, with the rules every static host of the
@@ -81,19 +81,16 @@ export async function staticSite(
81
81
  ): Promise<void> {
82
82
  const { trackingScript, redirects = {}, reserved = ['/v1/'] } = options;
83
83
  const root = resolve(options.root);
84
+ const basePath = normalizeBasePath(options.basePath ?? '');
84
85
 
85
- fastify.get(
86
- '/health',
87
- { logLevel: 'silent', schema: HIDDEN },
88
- (_request, reply) => reply.header(ALLOW_ORIGIN, '*').send({ status: 'ok' }),
89
- );
86
+ await healthRoute(fastify);
90
87
 
91
88
  const files = await listSiteFiles(root);
92
89
  if (files === undefined) {
93
90
  fastify.log.warn({ root }, 'no built site: serving the API alone');
94
91
  return;
95
92
  }
96
- const pages = await readPages(root, files, trackingScript);
93
+ const pages = await readPages(root, files, { trackingScript, basePath });
97
94
 
98
95
  // An optional peer, installed only by a site that has a server: importing
99
96
  // react-cheminfo/server must not need it.
@@ -121,7 +118,10 @@ export async function staticSite(
121
118
  const destination =
122
119
  redirects[pathname] ?? redirects[pathname.replace(/\/$/, '')];
123
120
  if (destination !== undefined) {
124
- return reply.redirect(`${destination}${search}`, 301);
121
+ return reply.redirect(
122
+ `${mountedAddress(basePath, destination)}${search}`,
123
+ 301,
124
+ );
125
125
  }
126
126
 
127
127
  const file = resolveAddress(files, pathname);
@@ -138,23 +138,29 @@ export async function staticSite(
138
138
  }
139
139
 
140
140
  /**
141
- * Read every page of the build once, with the snippet in its head.
141
+ * Read every page of the build once, with the snippet in its head and the
142
+ * mount in its `<base>`.
142
143
  * @param root - The build.
143
144
  * @param files - Its files.
144
- * @param trackingScript - The snippet, if any.
145
+ * @param stamp - What is written into every page.
146
+ * @param stamp.trackingScript - The snippet, if any.
147
+ * @param stamp.basePath - The mount, `''` for none.
145
148
  * @returns The pages, by file.
146
149
  */
147
150
  async function readPages(
148
151
  root: string,
149
152
  files: ReadonlySet<string>,
150
- trackingScript: string | undefined,
153
+ stamp: { trackingScript: string | undefined; basePath: string },
151
154
  ): Promise<Map<string, Page>> {
152
155
  const htmlFiles = [...files].filter((file) => file.endsWith('.html'));
153
156
  const pages = await Promise.all(
154
157
  htmlFiles.map(async (file) => {
155
- const html = injectTrackingScript(
156
- await readFile(join(root, file), 'utf8'),
157
- trackingScript,
158
+ const html = stampBase(
159
+ injectTrackingScript(
160
+ await readFile(join(root, file), 'utf8'),
161
+ stamp.trackingScript,
162
+ ),
163
+ stamp.basePath,
158
164
  );
159
165
  return [file, { html, etag: await etagOf(html) }] as const;
160
166
  }),
@@ -162,6 +168,30 @@ async function readPages(
162
168
  return new Map(pages);
163
169
  }
164
170
 
171
+ /**
172
+ * Write the mount into the first `<base href="/">` a page carries, as the
173
+ * container entrypoints of a mounted image do.
174
+ * @param html - The page.
175
+ * @param basePath - The mount, `''` for none.
176
+ * @returns The page, its relative addresses resolving under the mount.
177
+ */
178
+ function stampBase(html: string, basePath: string): string {
179
+ if (basePath === '') return html;
180
+ const tag = `<base href="${escapeAttribute(`${basePath}/`)}" />`;
181
+ return html.replace(ROOT_BASE, () => tag);
182
+ }
183
+
184
+ /**
185
+ * Where a redirect sends the browser: under the mount the proxy took off.
186
+ * @param basePath - The mount, `''` for none.
187
+ * @param destination - The address, from the site's own root or absolute.
188
+ * @returns The address the browser is sent to.
189
+ */
190
+ function mountedAddress(basePath: string, destination: string): string {
191
+ if (basePath === '' || !destination.startsWith('/')) return destination;
192
+ return joinBasePath(basePath, destination);
193
+ }
194
+
165
195
  function sendPage(
166
196
  request: FastifyRequest,
167
197
  reply: FastifyReply,