@pretty-chitty/core 2.0.0 → 2.3.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 (377) hide show
  1. package/README.md +8 -0
  2. package/dist/components/ActionLogDisplay.d.ts.map +1 -1
  3. package/dist/components/ActionLogDisplay.js +1 -1
  4. package/dist/components/ActionLogDisplay.js.map +1 -1
  5. package/dist/components/BottomBarButton.d.ts +3 -1
  6. package/dist/components/BottomBarButton.d.ts.map +1 -1
  7. package/dist/components/BottomBarButton.js +3 -2
  8. package/dist/components/BottomBarButton.js.map +1 -1
  9. package/dist/components/ContextGalleryDisplay.d.ts.map +1 -1
  10. package/dist/components/ContextGalleryDisplay.js +1 -1
  11. package/dist/components/ContextGalleryDisplay.js.map +1 -1
  12. package/dist/components/DemoWrapper.d.ts +33 -2
  13. package/dist/components/DemoWrapper.d.ts.map +1 -1
  14. package/dist/components/DemoWrapper.js +77 -36
  15. package/dist/components/DemoWrapper.js.map +1 -1
  16. package/dist/components/FullScreenGalleryDisplay.d.ts.map +1 -1
  17. package/dist/components/FullScreenGalleryDisplay.js +2 -2
  18. package/dist/components/FullScreenGalleryDisplay.js.map +1 -1
  19. package/dist/components/Gallery/BuiltItem.d.ts +16 -2
  20. package/dist/components/Gallery/BuiltItem.d.ts.map +1 -1
  21. package/dist/components/Gallery/BuiltItem.js +92 -16
  22. package/dist/components/Gallery/BuiltItem.js.map +1 -1
  23. package/dist/components/Gallery/GalleryController.d.ts +26 -0
  24. package/dist/components/Gallery/GalleryController.d.ts.map +1 -1
  25. package/dist/components/Gallery/GalleryController.js +106 -6
  26. package/dist/components/Gallery/GalleryController.js.map +1 -1
  27. package/dist/components/Gallery/GalleryViewer.d.ts +6 -1
  28. package/dist/components/Gallery/GalleryViewer.d.ts.map +1 -1
  29. package/dist/components/Gallery/GalleryViewer.js +139 -12
  30. package/dist/components/Gallery/GalleryViewer.js.map +1 -1
  31. package/dist/components/Gallery/LayoutManager.d.ts +10 -0
  32. package/dist/components/Gallery/LayoutManager.d.ts.map +1 -1
  33. package/dist/components/Gallery/LayoutManager.js +49 -3
  34. package/dist/components/Gallery/LayoutManager.js.map +1 -1
  35. package/dist/components/Gallery/constants.d.ts +6 -0
  36. package/dist/components/Gallery/constants.d.ts.map +1 -1
  37. package/dist/components/Gallery/constants.js +6 -0
  38. package/dist/components/Gallery/constants.js.map +1 -1
  39. package/dist/components/Gallery/registry.d.ts +34 -0
  40. package/dist/components/Gallery/registry.d.ts.map +1 -0
  41. package/dist/components/Gallery/registry.js +17 -0
  42. package/dist/components/Gallery/registry.js.map +1 -0
  43. package/dist/components/Gallery/types.d.ts +5 -0
  44. package/dist/components/Gallery/types.d.ts.map +1 -1
  45. package/dist/components/GameDesigner.d.ts.map +1 -1
  46. package/dist/components/GameDesigner.js +84 -10
  47. package/dist/components/GameDesigner.js.map +1 -1
  48. package/dist/components/InlineGalleryDisplay.d.ts.map +1 -1
  49. package/dist/components/InlineGalleryDisplay.js +35 -8
  50. package/dist/components/InlineGalleryDisplay.js.map +1 -1
  51. package/dist/components/LiveButton.d.ts.map +1 -1
  52. package/dist/components/LiveButton.js +5 -2
  53. package/dist/components/LiveButton.js.map +1 -1
  54. package/dist/components/MatchViewer.d.ts +6 -1
  55. package/dist/components/MatchViewer.d.ts.map +1 -1
  56. package/dist/components/MatchViewer.js +9 -3
  57. package/dist/components/MatchViewer.js.map +1 -1
  58. package/dist/components/Panel/ExternalDrag.d.ts +30 -0
  59. package/dist/components/Panel/ExternalDrag.d.ts.map +1 -0
  60. package/dist/components/Panel/ExternalDrag.js +87 -0
  61. package/dist/components/Panel/ExternalDrag.js.map +1 -0
  62. package/dist/components/Panel/MultiPanel.d.ts.map +1 -1
  63. package/dist/components/Panel/MultiPanel.js +18 -0
  64. package/dist/components/Panel/MultiPanel.js.map +1 -1
  65. package/dist/components/Panel/PanelContents.d.ts +3 -0
  66. package/dist/components/Panel/PanelContents.d.ts.map +1 -1
  67. package/dist/components/Panel/PanelContents.js +116 -23
  68. package/dist/components/Panel/PanelContents.js.map +1 -1
  69. package/dist/components/Panel/PanelTabStack.d.ts.map +1 -1
  70. package/dist/components/Panel/PanelTabStack.js +1 -1
  71. package/dist/components/Panel/PanelTabStack.js.map +1 -1
  72. package/dist/components/PanelSpark.d.ts.map +1 -1
  73. package/dist/components/PanelSpark.js +6 -3
  74. package/dist/components/PanelSpark.js.map +1 -1
  75. package/dist/components/Playground.d.ts.map +1 -1
  76. package/dist/components/Playground.js +10 -4
  77. package/dist/components/Playground.js.map +1 -1
  78. package/dist/components/PromptControls.d.ts.map +1 -1
  79. package/dist/components/PromptControls.js +4 -2
  80. package/dist/components/PromptControls.js.map +1 -1
  81. package/dist/components/SparkLineChart.d.ts.map +1 -1
  82. package/dist/components/SparkLineChart.js +22 -26
  83. package/dist/components/SparkLineChart.js.map +1 -1
  84. package/dist/components/TimeControlBar.d.ts.map +1 -1
  85. package/dist/components/TimeControlBar.js +5 -3
  86. package/dist/components/TimeControlBar.js.map +1 -1
  87. package/dist/components/TokenizedMarkdown.d.ts +23 -0
  88. package/dist/components/TokenizedMarkdown.d.ts.map +1 -0
  89. package/dist/components/TokenizedMarkdown.js +144 -0
  90. package/dist/components/TokenizedMarkdown.js.map +1 -0
  91. package/dist/components/TokenizedMessage.d.ts +6 -0
  92. package/dist/components/TokenizedMessage.d.ts.map +1 -1
  93. package/dist/components/TokenizedMessage.js +20 -19
  94. package/dist/components/TokenizedMessage.js.map +1 -1
  95. package/dist/components/TopBar.d.ts.map +1 -1
  96. package/dist/components/TopBar.js +3 -1
  97. package/dist/components/TopBar.js.map +1 -1
  98. package/dist/components/TopBarPlayers.d.ts.map +1 -1
  99. package/dist/components/TopBarPlayers.js +2 -2
  100. package/dist/components/TopBarPlayers.js.map +1 -1
  101. package/dist/components/Tutorial/BrowserNarration.d.ts +55 -0
  102. package/dist/components/Tutorial/BrowserNarration.d.ts.map +1 -0
  103. package/dist/components/Tutorial/BrowserNarration.js +240 -0
  104. package/dist/components/Tutorial/BrowserNarration.js.map +1 -0
  105. package/dist/components/Tutorial/TutorialBox.d.ts +26 -0
  106. package/dist/components/Tutorial/TutorialBox.d.ts.map +1 -0
  107. package/dist/components/Tutorial/TutorialBox.js +239 -0
  108. package/dist/components/Tutorial/TutorialBox.js.map +1 -0
  109. package/dist/components/Tutorial/TutorialDevPanel.d.ts +9 -0
  110. package/dist/components/Tutorial/TutorialDevPanel.d.ts.map +1 -0
  111. package/dist/components/Tutorial/TutorialDevPanel.js +92 -0
  112. package/dist/components/Tutorial/TutorialDevPanel.js.map +1 -0
  113. package/dist/components/Tutorial/TutorialOverlay.d.ts +7 -0
  114. package/dist/components/Tutorial/TutorialOverlay.d.ts.map +1 -0
  115. package/dist/components/Tutorial/TutorialOverlay.js +1147 -0
  116. package/dist/components/Tutorial/TutorialOverlay.js.map +1 -0
  117. package/dist/components/Tutorial/targetRects.d.ts +67 -0
  118. package/dist/components/Tutorial/targetRects.d.ts.map +1 -0
  119. package/dist/components/Tutorial/targetRects.js +241 -0
  120. package/dist/components/Tutorial/targetRects.js.map +1 -0
  121. package/dist/components/Viewer.d.ts.map +1 -1
  122. package/dist/components/Viewer.js +1 -0
  123. package/dist/components/Viewer.js.map +1 -1
  124. package/dist/game/Chit.d.ts +10 -1
  125. package/dist/game/Chit.d.ts.map +1 -1
  126. package/dist/game/Chit.js +24 -6
  127. package/dist/game/Chit.js.map +1 -1
  128. package/dist/game/ClientTimeState.d.ts +14 -0
  129. package/dist/game/ClientTimeState.d.ts.map +1 -1
  130. package/dist/game/ClientTimeState.js +17 -0
  131. package/dist/game/ClientTimeState.js.map +1 -1
  132. package/dist/game/GalleryItemChitChildrenSource.d.ts +1 -0
  133. package/dist/game/GalleryItemChitChildrenSource.d.ts.map +1 -1
  134. package/dist/game/GalleryItemChitChildrenSource.js +1 -0
  135. package/dist/game/GalleryItemChitChildrenSource.js.map +1 -1
  136. package/dist/game/GalleryItemRawSource.d.ts +1 -0
  137. package/dist/game/GalleryItemRawSource.d.ts.map +1 -1
  138. package/dist/game/GalleryItemRawSource.js +1 -0
  139. package/dist/game/GalleryItemRawSource.js.map +1 -1
  140. package/dist/game/Game.d.ts +6 -0
  141. package/dist/game/Game.d.ts.map +1 -1
  142. package/dist/game/GameButton.d.ts +8 -0
  143. package/dist/game/GameButton.d.ts.map +1 -1
  144. package/dist/game/GameButton.js +13 -1
  145. package/dist/game/GameButton.js.map +1 -1
  146. package/dist/game/GameTheme.d.ts +3 -0
  147. package/dist/game/GameTheme.d.ts.map +1 -1
  148. package/dist/game/GameTheme.js +2 -0
  149. package/dist/game/GameTheme.js.map +1 -1
  150. package/dist/game/Match.d.ts +8 -2
  151. package/dist/game/Match.d.ts.map +1 -1
  152. package/dist/game/Match.js +4 -1
  153. package/dist/game/Match.js.map +1 -1
  154. package/dist/game/ModalState.d.ts +3 -0
  155. package/dist/game/ModalState.d.ts.map +1 -1
  156. package/dist/game/ModalState.js +2 -0
  157. package/dist/game/ModalState.js.map +1 -1
  158. package/dist/game/Pick.d.ts +2 -0
  159. package/dist/game/Pick.d.ts.map +1 -1
  160. package/dist/game/Pick.js +18 -4
  161. package/dist/game/Pick.js.map +1 -1
  162. package/dist/game/PlayerPromptStatusChit.d.ts +8 -0
  163. package/dist/game/PlayerPromptStatusChit.d.ts.map +1 -1
  164. package/dist/game/PlayerPromptStatusChit.js +6 -4
  165. package/dist/game/PlayerPromptStatusChit.js.map +1 -1
  166. package/dist/game/Prompt.d.ts +18 -1
  167. package/dist/game/Prompt.d.ts.map +1 -1
  168. package/dist/game/Prompt.js +29 -1
  169. package/dist/game/Prompt.js.map +1 -1
  170. package/dist/game/SparkChit.d.ts +6 -0
  171. package/dist/game/SparkChit.d.ts.map +1 -1
  172. package/dist/game/SparkChit.js +8 -0
  173. package/dist/game/SparkChit.js.map +1 -1
  174. package/dist/game/Turn.d.ts +17 -6
  175. package/dist/game/Turn.d.ts.map +1 -1
  176. package/dist/game/Turn.js +179 -69
  177. package/dist/game/Turn.js.map +1 -1
  178. package/dist/game/TurnState.d.ts +12 -1
  179. package/dist/game/TurnState.d.ts.map +1 -1
  180. package/dist/game/TurnState.js +15 -3
  181. package/dist/game/TurnState.js.map +1 -1
  182. package/dist/game/ai/AiClientPrompts.d.ts +20 -3
  183. package/dist/game/ai/AiClientPrompts.d.ts.map +1 -1
  184. package/dist/game/ai/AiClientPrompts.js +42 -6
  185. package/dist/game/ai/AiClientPrompts.js.map +1 -1
  186. package/dist/game/ai/AiPlayerView.js +2 -0
  187. package/dist/game/ai/AiPlayerView.js.map +1 -1
  188. package/dist/game/clientTransport/ClientPrompts.d.ts +22 -1
  189. package/dist/game/clientTransport/ClientPrompts.d.ts.map +1 -1
  190. package/dist/game/clientTransport/ClientPrompts.js +72 -5
  191. package/dist/game/clientTransport/ClientPrompts.js.map +1 -1
  192. package/dist/game/clientTransport/ClientTime.d.ts +13 -0
  193. package/dist/game/clientTransport/ClientTime.d.ts.map +1 -1
  194. package/dist/game/clientTransport/ClientTime.js +71 -12
  195. package/dist/game/clientTransport/ClientTime.js.map +1 -1
  196. package/dist/game/tutorial/TutorialController.d.ts +308 -0
  197. package/dist/game/tutorial/TutorialController.d.ts.map +1 -0
  198. package/dist/game/tutorial/TutorialController.js +1195 -0
  199. package/dist/game/tutorial/TutorialController.js.map +1 -0
  200. package/dist/game/tutorial/TutorialRuntime.d.ts +89 -0
  201. package/dist/game/tutorial/TutorialRuntime.d.ts.map +1 -0
  202. package/dist/game/tutorial/TutorialRuntime.js +261 -0
  203. package/dist/game/tutorial/TutorialRuntime.js.map +1 -0
  204. package/dist/game/tutorial/TutorialTheme.d.ts +28 -0
  205. package/dist/game/tutorial/TutorialTheme.d.ts.map +1 -0
  206. package/dist/game/tutorial/TutorialTheme.js +39 -0
  207. package/dist/game/tutorial/TutorialTheme.js.map +1 -0
  208. package/dist/game/tutorial/allowed.d.ts +2 -0
  209. package/dist/game/tutorial/allowed.d.ts.map +1 -0
  210. package/dist/game/tutorial/allowed.js +119 -0
  211. package/dist/game/tutorial/allowed.js.map +1 -0
  212. package/dist/game/tutorial/checks.d.ts +58 -0
  213. package/dist/game/tutorial/checks.d.ts.map +1 -0
  214. package/dist/game/tutorial/checks.js +144 -0
  215. package/dist/game/tutorial/checks.js.map +1 -0
  216. package/dist/game/tutorial/createDemoMatch.d.ts +47 -0
  217. package/dist/game/tutorial/createDemoMatch.d.ts.map +1 -0
  218. package/dist/game/tutorial/createDemoMatch.js +67 -0
  219. package/dist/game/tutorial/createDemoMatch.js.map +1 -0
  220. package/dist/game/tutorial/defineTutorial.d.ts +353 -0
  221. package/dist/game/tutorial/defineTutorial.d.ts.map +1 -0
  222. package/dist/game/tutorial/defineTutorial.js +86 -0
  223. package/dist/game/tutorial/defineTutorial.js.map +1 -0
  224. package/dist/game/tutorial/runTutorial.d.ts +64 -0
  225. package/dist/game/tutorial/runTutorial.d.ts.map +1 -0
  226. package/dist/game/tutorial/runTutorial.js +293 -0
  227. package/dist/game/tutorial/runTutorial.js.map +1 -0
  228. package/dist/hooks/usePanelNavigation.d.ts +28 -0
  229. package/dist/hooks/usePanelNavigation.d.ts.map +1 -0
  230. package/dist/hooks/usePanelNavigation.js +36 -0
  231. package/dist/hooks/usePanelNavigation.js.map +1 -0
  232. package/dist/hooks/useTimeController.d.ts +4 -1
  233. package/dist/hooks/useTimeController.d.ts.map +1 -1
  234. package/dist/hooks/useTimeController.js +10 -2
  235. package/dist/hooks/useTimeController.js.map +1 -1
  236. package/dist/hooks/useTutorial.d.ts +51 -0
  237. package/dist/hooks/useTutorial.d.ts.map +1 -0
  238. package/dist/hooks/useTutorial.js +16 -0
  239. package/dist/hooks/useTutorial.js.map +1 -0
  240. package/dist/index.d.ts +37 -0
  241. package/dist/index.d.ts.map +1 -1
  242. package/dist/index.js +19 -2
  243. package/dist/index.js.map +1 -1
  244. package/dist/rendering/CameraWrapperPerspective.d.ts +5 -0
  245. package/dist/rendering/CameraWrapperPerspective.d.ts.map +1 -1
  246. package/dist/rendering/CameraWrapperPerspective.js +16 -0
  247. package/dist/rendering/CameraWrapperPerspective.js.map +1 -1
  248. package/dist/rendering/ChitGalleryItemInstance.d.ts +14 -3
  249. package/dist/rendering/ChitGalleryItemInstance.d.ts.map +1 -1
  250. package/dist/rendering/ChitGalleryItemInstance.js +29 -1
  251. package/dist/rendering/ChitGalleryItemInstance.js.map +1 -1
  252. package/dist/rendering/ChitRenderInstance.d.ts +15 -1
  253. package/dist/rendering/ChitRenderInstance.d.ts.map +1 -1
  254. package/dist/rendering/ChitRenderInstance.js +49 -4
  255. package/dist/rendering/ChitRenderInstance.js.map +1 -1
  256. package/dist/rendering/LightWrapper.d.ts.map +1 -1
  257. package/dist/rendering/LightWrapper.js +10 -1
  258. package/dist/rendering/LightWrapper.js.map +1 -1
  259. package/dist/rendering/RootChitRenderInstance.d.ts +2 -0
  260. package/dist/rendering/RootChitRenderInstance.d.ts.map +1 -1
  261. package/dist/rendering/RootChitRenderInstance.js +29 -0
  262. package/dist/rendering/RootChitRenderInstance.js.map +1 -1
  263. package/dist/rendering/Splay.d.ts +11 -0
  264. package/dist/rendering/Splay.d.ts.map +1 -1
  265. package/dist/rendering/Splay.js +20 -10
  266. package/dist/rendering/Splay.js.map +1 -1
  267. package/dist/utilities/Annotations.d.ts +15 -0
  268. package/dist/utilities/Annotations.d.ts.map +1 -1
  269. package/dist/utilities/Annotations.js +31 -7
  270. package/dist/utilities/Annotations.js.map +1 -1
  271. package/dist/utilities/CanvasStack/CanvasStack.d.ts +2 -0
  272. package/dist/utilities/CanvasStack/CanvasStack.d.ts.map +1 -1
  273. package/dist/utilities/CanvasStack/CanvasStack.js +4 -0
  274. package/dist/utilities/CanvasStack/CanvasStack.js.map +1 -1
  275. package/dist/utilities/CanvasStack/RichTextRenderer.d.ts.map +1 -1
  276. package/dist/utilities/CanvasStack/RichTextRenderer.js +12 -0
  277. package/dist/utilities/CanvasStack/RichTextRenderer.js.map +1 -1
  278. package/dist/utilities/Dice.d.ts +2 -0
  279. package/dist/utilities/Dice.d.ts.map +1 -1
  280. package/dist/utilities/Dice.js +5 -1
  281. package/dist/utilities/Dice.js.map +1 -1
  282. package/dist/utilities/GalleryItemConversion.d.ts.map +1 -1
  283. package/dist/utilities/GalleryItemConversion.js +5 -7
  284. package/dist/utilities/GalleryItemConversion.js.map +1 -1
  285. package/dist/utilities/TokenizedText.d.ts +6 -0
  286. package/dist/utilities/TokenizedText.d.ts.map +1 -1
  287. package/dist/utilities/TokenizedText.js.map +1 -1
  288. package/dist/utilities/zIndex.d.ts +1 -0
  289. package/dist/utilities/zIndex.d.ts.map +1 -1
  290. package/dist/utilities/zIndex.js +1 -0
  291. package/dist/utilities/zIndex.js.map +1 -1
  292. package/package.json +3 -2
  293. package/src/library/components/ActionLogDisplay.tsx +1 -0
  294. package/src/library/components/BottomBarButton.tsx +5 -0
  295. package/src/library/components/ContextGalleryDisplay.tsx +2 -0
  296. package/src/library/components/DemoWrapper.tsx +150 -44
  297. package/src/library/components/FullScreenGalleryDisplay.tsx +3 -0
  298. package/src/library/components/Gallery/BuiltItem.ts +92 -16
  299. package/src/library/components/Gallery/GalleryController.ts +111 -10
  300. package/src/library/components/Gallery/GalleryViewer.tsx +144 -12
  301. package/src/library/components/Gallery/LayoutManager.ts +55 -6
  302. package/src/library/components/Gallery/constants.ts +6 -0
  303. package/src/library/components/Gallery/registry.ts +44 -0
  304. package/src/library/components/Gallery/types.ts +6 -0
  305. package/src/library/components/GameDesigner.tsx +165 -12
  306. package/src/library/components/InlineGalleryDisplay.tsx +41 -6
  307. package/src/library/components/LiveButton.tsx +8 -5
  308. package/src/library/components/MatchViewer.tsx +14 -3
  309. package/src/library/components/Panel/ExternalDrag.ts +122 -0
  310. package/src/library/components/Panel/MultiPanel.tsx +21 -0
  311. package/src/library/components/Panel/PanelContents.tsx +96 -1
  312. package/src/library/components/Panel/PanelTabStack.tsx +1 -0
  313. package/src/library/components/PanelSpark.tsx +12 -5
  314. package/src/library/components/Playground.tsx +48 -21
  315. package/src/library/components/PromptControls.tsx +7 -3
  316. package/src/library/components/SparkLineChart.tsx +23 -27
  317. package/src/library/components/TimeControlBar.tsx +5 -3
  318. package/src/library/components/TokenizedMarkdown.tsx +224 -0
  319. package/src/library/components/TokenizedMessage.tsx +28 -32
  320. package/src/library/components/TopBar.tsx +2 -1
  321. package/src/library/components/TopBarPlayers.tsx +13 -15
  322. package/src/library/components/Tutorial/BrowserNarration.ts +233 -0
  323. package/src/library/components/Tutorial/TutorialBox.tsx +506 -0
  324. package/src/library/components/Tutorial/TutorialDevPanel.tsx +297 -0
  325. package/src/library/components/Tutorial/TutorialOverlay.tsx +1316 -0
  326. package/src/library/components/Tutorial/targetRects.ts +273 -0
  327. package/src/library/components/Viewer.tsx +1 -0
  328. package/src/library/game/Chit.ts +28 -7
  329. package/src/library/game/ClientTimeState.ts +18 -0
  330. package/src/library/game/GalleryItemChitChildrenSource.ts +1 -0
  331. package/src/library/game/GalleryItemRawSource.ts +1 -0
  332. package/src/library/game/Game.ts +7 -0
  333. package/src/library/game/GameButton.ts +13 -1
  334. package/src/library/game/GameTheme.ts +4 -0
  335. package/src/library/game/Match.ts +12 -2
  336. package/src/library/game/ModalState.ts +3 -0
  337. package/src/library/game/Pick.ts +17 -4
  338. package/src/library/game/PlayerPromptStatusChit.ts +6 -4
  339. package/src/library/game/Prompt.ts +33 -2
  340. package/src/library/game/SparkChit.ts +9 -0
  341. package/src/library/game/Turn.ts +185 -70
  342. package/src/library/game/TurnState.ts +26 -3
  343. package/src/library/game/ai/AI_GUIDE.md +10 -0
  344. package/src/library/game/ai/AiClientPrompts.ts +60 -11
  345. package/src/library/game/ai/AiPlayerView.ts +2 -0
  346. package/src/library/game/clientTransport/ClientPrompts.ts +76 -5
  347. package/src/library/game/clientTransport/ClientTime.ts +75 -14
  348. package/src/library/game/serialize.test.ts +275 -0
  349. package/src/library/game/tutorial/TUTORIAL_GUIDE.md +416 -0
  350. package/src/library/game/tutorial/TutorialController.test.ts +731 -0
  351. package/src/library/game/tutorial/TutorialController.ts +1299 -0
  352. package/src/library/game/tutorial/TutorialRuntime.ts +311 -0
  353. package/src/library/game/tutorial/TutorialTheme.ts +67 -0
  354. package/src/library/game/tutorial/allowed.ts +145 -0
  355. package/src/library/game/tutorial/checks.ts +186 -0
  356. package/src/library/game/tutorial/createDemoMatch.ts +115 -0
  357. package/src/library/game/tutorial/defineTutorial.ts +414 -0
  358. package/src/library/game/tutorial/runTutorial.ts +350 -0
  359. package/src/library/game/undo.test.ts +282 -0
  360. package/src/library/hooks/usePanelNavigation.tsx +65 -0
  361. package/src/library/hooks/useTimeController.tsx +10 -2
  362. package/src/library/hooks/useTutorial.tsx +80 -0
  363. package/src/library/index.ts +58 -2
  364. package/src/library/rendering/CameraWrapperPerspective.ts +17 -0
  365. package/src/library/rendering/ChitGalleryItemInstance.ts +30 -1
  366. package/src/library/rendering/ChitRenderInstance.ts +57 -4
  367. package/src/library/rendering/LightWrapper.ts +10 -1
  368. package/src/library/rendering/RootChitRenderInstance.ts +30 -1
  369. package/src/library/rendering/Splay.test.ts +60 -0
  370. package/src/library/rendering/Splay.ts +30 -9
  371. package/src/library/utilities/Annotations.ts +35 -7
  372. package/src/library/utilities/CanvasStack/CanvasStack.ts +6 -1
  373. package/src/library/utilities/CanvasStack/RichTextRenderer.ts +13 -0
  374. package/src/library/utilities/Dice.tsx +5 -1
  375. package/src/library/utilities/GalleryItemConversion.ts +5 -6
  376. package/src/library/utilities/TokenizedText.ts +6 -0
  377. package/src/library/utilities/zIndex.ts +1 -0
@@ -0,0 +1,275 @@
1
+ import { describe, expect, test } from "vitest";
2
+
3
+ import { Chit } from "./Chit";
4
+ import { Game } from "./Game";
5
+ import { GameButton } from "./GameButton";
6
+ import { Match } from "./Match";
7
+ import { EphemeralMatchStorage } from "./MatchStorage";
8
+ import { OrderedOutlet } from "./OrderedOutlet";
9
+ import { PlayerChit } from "./PlayerChit";
10
+ import { PlayerInfo } from "./PlayerInfo";
11
+ import { RootChit } from "./RootChit";
12
+ import { Turn } from "./Turn";
13
+ import { connectAiPlayer } from "./ai/connectAiPlayer";
14
+
15
+ //
16
+ // A small game that exercises every kind of clock step: sequential sub-turns, parallel sub-turns,
17
+ // flushes with and without logs, amended logs and zips. Bots play it at random.
18
+ //
19
+
20
+ class Card extends Chit {
21
+ value = 0;
22
+ }
23
+
24
+ class Seat extends PlayerChit {
25
+ score = 0;
26
+ ready = 0;
27
+ hand = new OrderedOutlet<Card>("hand", this);
28
+ }
29
+
30
+ class Table extends RootChit<Seat> {
31
+ minPlayers = 2;
32
+ lastMover = "";
33
+ market = new OrderedOutlet<Card>("market", this);
34
+ }
35
+
36
+ class ChoiceButton extends GameButton {
37
+ label = "Choice";
38
+ }
39
+
40
+ function tableGame(rounds: number): Game<Seat, Table> {
41
+ return {
42
+ chitLibrary: { Root: Table, Player: Seat, Table, Seat, Card },
43
+ buttonLibrary: { ChoiceButton },
44
+ canvasLibrary: {},
45
+ async run(setup: Turn<any, Seat, Table>, root: Table) {
46
+ const players = root.players.copy();
47
+ for (let i = 0; i < 30; i++) {
48
+ root.market.add(new Card().set((c) => (c.value = i)));
49
+ }
50
+ setup.flush();
51
+ setup.log("setup");
52
+
53
+ for (let round = 0; round < rounds; round++) {
54
+ for (const player of players) {
55
+ await setup.createTurn([root], player, async (turn) => {
56
+ const take = Chit.pick(root.market, async (c: Card) => {
57
+ player.hand.add(c);
58
+ player.score += c.value;
59
+ root.lastMover = player.id ?? "";
60
+ }).message("take a card");
61
+ const pass = new ChoiceButton(() => {
62
+ root.lastMover = player.id ?? "";
63
+ })
64
+ .pick()
65
+ .message("pass");
66
+ await turn.pick([take, pass]);
67
+ turn.log(`${player.id} moved`);
68
+ turn.zip();
69
+ });
70
+ }
71
+ setup.amendLog((previous) => `${previous} (round ${round})`);
72
+
73
+ await setup.runParallelTurns(
74
+ players,
75
+ (p) => [p],
76
+ async (player, turn) => {
77
+ const ready = new ChoiceButton(() => {
78
+ player.ready += 1;
79
+ })
80
+ .pick()
81
+ .message("ready");
82
+ const wait = new ChoiceButton(() => {
83
+ player.ready += 2;
84
+ })
85
+ .pick()
86
+ .message("wait");
87
+ await turn.pick([ready, wait]);
88
+ turn.log(`${player.id} ready`);
89
+ },
90
+ );
91
+ setup.log(`round ${round} done`);
92
+ }
93
+ return { winners: [players[0]] };
94
+ },
95
+ } as unknown as Game<Seat, Table>;
96
+ }
97
+
98
+ // Private engine structure the test reaches into
99
+ type AnyTurn = {
100
+ clockSteps: { turns?: AnyTurn[]; absorbed?: AnyTurn[] }[];
101
+ _checkpoints: { nextIndex: number }[];
102
+ lockedChitStates: Record<string, string>;
103
+ absorbed: boolean;
104
+ serialize: (playerId: string, clock: number) => { chits: Record<string, string> };
105
+ chitsHistory: (playerId: string, ids: string[]) => unknown;
106
+ playerVisibleClockTime: (playerId: string) => number;
107
+ };
108
+
109
+ function allTurns(turn: AnyTurn): AnyTurn[] {
110
+ const result = [turn];
111
+ for (const step of turn.clockSteps) {
112
+ for (const sub of step.turns ?? []) {
113
+ result.push(...allTurns(sub));
114
+ }
115
+ }
116
+ return result;
117
+ }
118
+
119
+ /** Every turn in the tree its parent has absorbed */
120
+ function finishedTurns(root: AnyTurn): AnyTurn[] {
121
+ return allTurns(root).flatMap((t) => t.clockSteps.flatMap((s) => s.absorbed ?? []));
122
+ }
123
+
124
+ /** Runs `fn` as if every finished turn had released its snapshot and checkpoints at absorption. */
125
+ function withReleasedTurns<T>(root: AnyTurn, fn: () => T): T {
126
+ const turns = finishedTurns(root);
127
+ const saved = turns.map((t) => ({ locked: t.lockedChitStates, checkpoints: t._checkpoints, absorbed: t.absorbed }));
128
+ turns.forEach((t) => {
129
+ t.lockedChitStates = {};
130
+ t._checkpoints = [];
131
+ t.absorbed = true;
132
+ });
133
+ try {
134
+ return fn();
135
+ } finally {
136
+ turns.forEach((t, i) => {
137
+ t.lockedChitStates = saved[i].locked;
138
+ t._checkpoints = saved[i].checkpoints;
139
+ t.absorbed = saved[i].absorbed;
140
+ });
141
+ }
142
+ }
143
+
144
+ /** Runs `fn` with every checkpoint in the tree hidden and none created: a replay from the snapshots. */
145
+ function withoutCheckpoints<T>(root: AnyTurn, fn: () => T): T {
146
+ const turns = allTurns(root);
147
+ const saved = turns.map((t) => t._checkpoints);
148
+ turns.forEach((t) => (t._checkpoints = []));
149
+ Turn.serializeCheckpoints = false;
150
+ try {
151
+ return fn();
152
+ } finally {
153
+ Turn.serializeCheckpoints = true;
154
+ turns.forEach((t, i) => (t._checkpoints = saved[i]));
155
+ }
156
+ }
157
+
158
+ // `pass` is wall-clock based; everything else must match exactly
159
+ function comparable(response: unknown): string {
160
+ return JSON.stringify(response, (key, value) => (key === "pass" ? undefined : value));
161
+ }
162
+
163
+ const PLAYERS = [0, 1, 2].map((i) => new PlayerInfo(`p${i}`, `Bot ${i}`));
164
+
165
+ /** Plays the game with seeded bots, calling `onChange(root)` at every match change, and returns the root turn. */
166
+ async function play(onChange: (root: AnyTurn) => void): Promise<AnyTurn> {
167
+ const match = new Match(tableGame(6), PLAYERS, new EphemeralMatchStorage("serialize"), {});
168
+ await match.load();
169
+ const bots = PLAYERS.map((p) => connectAiPlayer(match, p.id, { log: false, seed: 1 }));
170
+ match.onChange(() => {
171
+ const root = match.turn.value as unknown as AnyTurn | undefined;
172
+ if (root) onChange(root);
173
+ }, false);
174
+ await match.start();
175
+ bots.forEach((b) => b.dispose());
176
+ const root = match.turn.value as unknown as AnyTurn;
177
+ match.dispose();
178
+ return root;
179
+ }
180
+
181
+ /**
182
+ * Compares two ways of reading the match for every player at every clock, forwards like a client
183
+ * playing the timeline, then backwards like one scrubbing it, and the history of every chit.
184
+ * Returns the readings that differed.
185
+ */
186
+ function compareEveryReading(
187
+ root: AnyTurn,
188
+ read: (fn: () => string) => [expected: string, actual: string],
189
+ counter: { checks: number },
190
+ ): string[] {
191
+ const mismatches: string[] = [];
192
+ const check = (label: string, fn: () => string) => {
193
+ const [expected, actual] = read(fn);
194
+ counter.checks++;
195
+ if (expected !== actual) mismatches.push(label);
196
+ };
197
+ for (const p of PLAYERS) {
198
+ const max = root.playerVisibleClockTime(p.id);
199
+ const clocks = [...Array(max).keys()].map((c) => c + 1);
200
+ for (const clock of [...clocks, ...clocks.reverse()]) {
201
+ check(`${p.id}@${clock}`, () => comparable(root.serialize(p.id, clock)));
202
+ }
203
+ const ids = Object.keys(root.serialize(p.id, max).chits);
204
+ check(`${p.id} history`, () => JSON.stringify(root.chitsHistory(p.id, ids)));
205
+ }
206
+ return mismatches;
207
+ }
208
+
209
+ describe("Turn.serialize", () => {
210
+ test("checkpoints match a full replay for every player at every clock, as the game runs", async () => {
211
+ // A short interval so a small game spans several checkpoints
212
+ const defaultInterval = Turn.serializeCheckpointInterval;
213
+ Turn.serializeCheckpointInterval = 8;
214
+ try {
215
+ const counter = { checks: 0 };
216
+ const mismatches: string[] = [];
217
+ const resets: string[] = [];
218
+ const root = await play((root) => {
219
+ mismatches.push(...compareEveryReading(root, (fn) => [withoutCheckpoints(root, fn), fn()], counter));
220
+ // A move must not throw the walk away: after reading the latest clock, the last
221
+ // checkpoint reaches every step but the one still in motion.
222
+ const last = root._checkpoints[root._checkpoints.length - 1];
223
+ if (root.clockSteps.length > 1 && (!last || last.nextIndex < root.clockSteps.length - 1)) {
224
+ resets.push(`${last?.nextIndex ?? "none"} of ${root.clockSteps.length}`);
225
+ }
226
+ });
227
+
228
+ expect(mismatches).toEqual([]);
229
+ expect(resets).toEqual([]);
230
+ expect(counter.checks).toBeGreaterThan(1000);
231
+
232
+ root.serialize("p0", root.playerVisibleClockTime("p0"));
233
+ expect(root.clockSteps.length).toBeGreaterThan(Turn.serializeCheckpointInterval);
234
+ expect(root._checkpoints.length).toBeGreaterThanOrEqual(3);
235
+ expect(root._checkpoints[root._checkpoints.length - 1].nextIndex).toBe(root.clockSteps.length);
236
+ } finally {
237
+ Turn.serializeCheckpointInterval = defaultInterval;
238
+ }
239
+ });
240
+
241
+ test("finished turns read the same without their snapshots and checkpoints", async () => {
242
+ // Reference game: every finished turn keeps its locked snapshot and checkpoints. At every
243
+ // change, each reading is taken that way and again as a plain replay with them released.
244
+ Turn.releaseAbsorbedTurns = false;
245
+ try {
246
+ const counter = { checks: 0 };
247
+ const mismatches: string[] = [];
248
+ const root = await play((root) => {
249
+ mismatches.push(
250
+ ...compareEveryReading(
251
+ root,
252
+ (fn) => [fn(), withReleasedTurns(root, () => withoutCheckpoints(root, fn))],
253
+ counter,
254
+ ),
255
+ );
256
+ });
257
+ expect(mismatches).toEqual([]);
258
+ expect(counter.checks).toBeGreaterThan(1000);
259
+ expect(finishedTurns(root).length).toBeGreaterThan(10);
260
+ expect(finishedTurns(root).filter((t) => Object.keys(t.lockedChitStates).length === 0)).toEqual([]);
261
+ } finally {
262
+ Turn.releaseAbsorbedTurns = true;
263
+ }
264
+
265
+ // As shipped, a finished turn holds nothing; the live root keeps its own snapshot
266
+ const root = await play(() => {});
267
+ root.serialize("p0", root.playerVisibleClockTime("p0"));
268
+ const finished = finishedTurns(root);
269
+ expect(finished.length).toBeGreaterThan(10);
270
+ expect(finished.filter((t) => !t.absorbed)).toEqual([]);
271
+ expect(finished.filter((t) => Object.keys(t.lockedChitStates).length > 0)).toEqual([]);
272
+ expect(finished.filter((t) => t._checkpoints.length > 0)).toEqual([]);
273
+ expect(Object.keys(root.lockedChitStates).length).toBeGreaterThan(0);
274
+ });
275
+ });