@khanacademy/perseus 0.0.1 → 0.2.1

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 (507) hide show
  1. package/.babelrc.js +1 -1
  2. package/CHANGELOG.md +29 -0
  3. package/dist/es/index.css +4361 -0
  4. package/dist/es/index.js +7 -1
  5. package/dist/es/index.js.map +1 -1
  6. package/dist/index.css +4361 -0
  7. package/dist/index.js +7 -1
  8. package/dist/index.js.map +1 -1
  9. package/dist/strings.js +148 -46
  10. package/package.json +50 -4
  11. package/src/README.md +35 -0
  12. package/src/__stories__/item-renderer.stories.jsx +27 -0
  13. package/src/__stories__/server-item-renderer.stories.jsx +27 -0
  14. package/src/__testdata__/item-renderer_testdata.js +161 -0
  15. package/src/__testdata__/renderer_testdata.js +123 -0
  16. package/src/__tests__/__snapshots__/item-renderer_test.jsx.snap +233 -0
  17. package/src/__tests__/__snapshots__/perseus-markdown_test.jsx.snap +516 -0
  18. package/src/__tests__/__snapshots__/pure-markdown_test.js.snap +113 -0
  19. package/src/__tests__/__snapshots__/renderer_test.jsx.snap +576 -0
  20. package/src/__tests__/__snapshots__/server-item-renderer_test.jsx.snap +306 -0
  21. package/src/__tests__/a11y_test.jsx +304 -0
  22. package/src/__tests__/item-renderer_test.jsx +892 -0
  23. package/src/__tests__/mock-asset-loading-widget.jsx +57 -0
  24. package/src/__tests__/mock-widget.jsx +35 -0
  25. package/src/__tests__/perseus-markdown_test.jsx +747 -0
  26. package/src/__tests__/pure-markdown_test.js +552 -0
  27. package/src/__tests__/renderability_test.jsx +481 -0
  28. package/src/__tests__/renderer-api_test.jsx +333 -0
  29. package/src/__tests__/renderer_test.jsx +1792 -0
  30. package/src/__tests__/server-item-renderer_test.jsx +516 -0
  31. package/src/__tests__/test-items/image-item.js +25 -0
  32. package/src/__tests__/test-items/input-number-1-item.js +27 -0
  33. package/src/__tests__/test-items/input-number-2-item.js +39 -0
  34. package/src/__tests__/test-items/table-item.js +30 -0
  35. package/src/__tests__/tex-wrangler_test.js +83 -0
  36. package/src/__tests__/util_test.js +41 -0
  37. package/src/a11y.js +46 -0
  38. package/src/all-widgets.js +9 -0
  39. package/src/article-renderer.jsx +215 -0
  40. package/src/asset-context.js +30 -0
  41. package/src/basic-widgets.js +13 -0
  42. package/src/components/__stories__/button-group.stories.jsx +61 -0
  43. package/src/components/__stories__/fixed-to-responsive.stories.jsx +132 -0
  44. package/src/components/__stories__/graph.stories.jsx +27 -0
  45. package/src/components/__stories__/graphie.stories.jsx +28 -0
  46. package/src/components/__stories__/hud.stories.jsx +36 -0
  47. package/src/components/__stories__/icon.stories.jsx +56 -0
  48. package/src/components/__stories__/image-loader.stories.jsx +60 -0
  49. package/src/components/__stories__/info-tip.stories.jsx +33 -0
  50. package/src/components/__stories__/inline-icon.stories.jsx +39 -0
  51. package/src/components/__stories__/input-with-examples.stories.jsx +51 -0
  52. package/src/components/__stories__/lint.stories.jsx +40 -0
  53. package/src/components/__stories__/math-input.stories.jsx +29 -0
  54. package/src/components/__stories__/math-output.stories.jsx +24 -0
  55. package/src/components/__stories__/multi-button-group.stories.jsx +69 -0
  56. package/src/components/__stories__/number-input.stories.jsx +42 -0
  57. package/src/components/__stories__/possible-answers.stories.jsx +22 -0
  58. package/src/components/__stories__/prop-check-box.stories.jsx +62 -0
  59. package/src/components/__stories__/range-input.stories.jsx +28 -0
  60. package/src/components/__stories__/simple-keypad-input.stories.jsx +28 -0
  61. package/src/components/__stories__/sortable.stories.jsx +73 -0
  62. package/src/components/__stories__/stub-tag-editor.stories.jsx +44 -0
  63. package/src/components/__stories__/svg-image.stories.jsx +60 -0
  64. package/src/components/__stories__/tex.stories.jsx +18 -0
  65. package/src/components/__stories__/text-buttons.stories.jsx +51 -0
  66. package/src/components/__stories__/text-input.stories.jsx +34 -0
  67. package/src/components/__stories__/text-list-editor.stories.jsx +33 -0
  68. package/src/components/__stories__/zoomable-tex.stories.jsx +39 -0
  69. package/src/components/__stories__/zoomable.stories.jsx +40 -0
  70. package/src/components/__testdata__/sorter_testdata.js +20 -0
  71. package/src/components/__tests__/__snapshots__/sortable_test.jsx.snap +79 -0
  72. package/src/components/__tests__/__snapshots__/sorter_test.jsx.snap +297 -0
  73. package/src/components/__tests__/number-input_test.jsx +112 -0
  74. package/src/components/__tests__/sortable_test.jsx +234 -0
  75. package/src/components/__tests__/sorter_test.jsx +111 -0
  76. package/src/components/__tests__/zoomable_test.jsx +388 -0
  77. package/src/components/button-group.jsx +131 -0
  78. package/src/components/constants.js +15 -0
  79. package/src/components/fixed-to-responsive.jsx +164 -0
  80. package/src/components/graph.jsx +415 -0
  81. package/src/components/graphie-classes.jsx +148 -0
  82. package/src/components/graphie-movables.jsx +342 -0
  83. package/src/components/graphie.jsx +353 -0
  84. package/src/components/highlighting/highlightable-content.jsx +245 -0
  85. package/src/components/highlighting/highlights.js +208 -0
  86. package/src/components/highlighting/ranges.js +299 -0
  87. package/src/components/highlighting/types.js +73 -0
  88. package/src/components/highlighting/ui/highlight-renderer.jsx +179 -0
  89. package/src/components/highlighting/ui/highlight-set-renderer.jsx +190 -0
  90. package/src/components/highlighting/ui/highlight-tooltip.jsx +153 -0
  91. package/src/components/highlighting/ui/highlighting-ui.jsx +163 -0
  92. package/src/components/highlighting/ui/selection-tracker.jsx +195 -0
  93. package/src/components/highlighting/ui/types.js +21 -0
  94. package/src/components/highlighting/ui/util.js +166 -0
  95. package/src/components/highlighting/word-indexer.jsx +155 -0
  96. package/src/components/hud.jsx +179 -0
  97. package/src/components/icon.jsx +149 -0
  98. package/src/components/image-loader.jsx +175 -0
  99. package/src/components/info-tip/info-tip.jsx +146 -0
  100. package/src/components/info-tip.jsx +38 -0
  101. package/src/components/inline-icon.jsx +81 -0
  102. package/src/components/input-with-examples.jsx +231 -0
  103. package/src/components/lint.jsx +454 -0
  104. package/src/components/math-input.jsx +282 -0
  105. package/src/components/math-output.jsx +128 -0
  106. package/src/components/multi-button-group.jsx +137 -0
  107. package/src/components/new-tooltip/README.md +110 -0
  108. package/src/components/new-tooltip/__stories__/flexible-position.stories.jsx +437 -0
  109. package/src/components/new-tooltip/__stories__/new-tooltip.stories.jsx +665 -0
  110. package/src/components/new-tooltip/__stories__/tooltip-arrow.stories.jsx +70 -0
  111. package/src/components/new-tooltip/__stories__/tooltip-bubble.stories.jsx +98 -0
  112. package/src/components/new-tooltip/__tests__/style-constants_test.js +8 -0
  113. package/src/components/new-tooltip/__tests__/util_test.js +47 -0
  114. package/src/components/new-tooltip/flexible-position.jsx +182 -0
  115. package/src/components/new-tooltip/new-tooltip.jsx +399 -0
  116. package/src/components/new-tooltip/style-constants.js +13 -0
  117. package/src/components/new-tooltip/tooltip-arrow.jsx +184 -0
  118. package/src/components/new-tooltip/tooltip-bubble.jsx +223 -0
  119. package/src/components/new-tooltip/tooltip-portal.jsx +101 -0
  120. package/src/components/new-tooltip/tooltip-positioner.jsx +529 -0
  121. package/src/components/new-tooltip/types.js +183 -0
  122. package/src/components/new-tooltip/util.js +27 -0
  123. package/src/components/number-input.jsx +253 -0
  124. package/src/components/possible-answers.jsx +36 -0
  125. package/src/components/prop-check-box.jsx +80 -0
  126. package/src/components/range-input.jsx +61 -0
  127. package/src/components/simple-keypad-input.jsx +91 -0
  128. package/src/components/sortable.jsx +873 -0
  129. package/src/components/stub-tag-editor.jsx +54 -0
  130. package/src/components/svg-image.jsx +762 -0
  131. package/src/components/tex-buttons.jsx +322 -0
  132. package/src/components/tex.jsx +70 -0
  133. package/src/components/text-input.jsx +82 -0
  134. package/src/components/text-list-editor.jsx +157 -0
  135. package/src/components/tooltip.jsx +395 -0
  136. package/src/components/visibility-observer/__stories__/visibility-observer.stories.jsx +140 -0
  137. package/src/components/visibility-observer/get-scroll-parent.js +45 -0
  138. package/src/components/visibility-observer/visibility-observer.js +109 -0
  139. package/src/components/visibility-observer/visibility-observer.jsx +123 -0
  140. package/src/components/zoomable-tex.jsx +70 -0
  141. package/src/components/zoomable.jsx +304 -0
  142. package/src/components.js +17 -0
  143. package/src/dependencies.js +22 -0
  144. package/src/error-boundary.jsx +48 -0
  145. package/src/extra-widgets.js +75 -0
  146. package/src/gorgon/README +40 -0
  147. package/src/gorgon/__tests__/matcher_test.js +497 -0
  148. package/src/gorgon/__tests__/rule_test.js +101 -0
  149. package/src/gorgon/__tests__/rules_test.js +487 -0
  150. package/src/gorgon/__tests__/selector-parser_test.js +52 -0
  151. package/src/gorgon/__tests__/tree-transformer_test.js +446 -0
  152. package/src/gorgon/gorgon.js +290 -0
  153. package/src/gorgon/proptypes.js +29 -0
  154. package/src/gorgon/rule.js +413 -0
  155. package/src/gorgon/rules/absolute-url.js +24 -0
  156. package/src/gorgon/rules/all-rules.js +72 -0
  157. package/src/gorgon/rules/blockquoted-math.js +10 -0
  158. package/src/gorgon/rules/blockquoted-widget.js +10 -0
  159. package/src/gorgon/rules/double-spacing-after-terminal.js +12 -0
  160. package/src/gorgon/rules/extra-content-spacing.js +12 -0
  161. package/src/gorgon/rules/heading-level-1.js +14 -0
  162. package/src/gorgon/rules/heading-level-skip.js +20 -0
  163. package/src/gorgon/rules/heading-sentence-case.js +11 -0
  164. package/src/gorgon/rules/heading-title-case.js +63 -0
  165. package/src/gorgon/rules/image-alt-text.js +21 -0
  166. package/src/gorgon/rules/image-in-table.js +10 -0
  167. package/src/gorgon/rules/image-spaces-around-urls.js +35 -0
  168. package/src/gorgon/rules/image-widget.js +50 -0
  169. package/src/gorgon/rules/link-click-here.js +11 -0
  170. package/src/gorgon/rules/lint-utils.js +48 -0
  171. package/src/gorgon/rules/long-paragraph.js +14 -0
  172. package/src/gorgon/rules/math-adjacent.js +10 -0
  173. package/src/gorgon/rules/math-align-extra-break.js +11 -0
  174. package/src/gorgon/rules/math-align-linebreaks.js +43 -0
  175. package/src/gorgon/rules/math-empty.js +10 -0
  176. package/src/gorgon/rules/math-font-size.js +12 -0
  177. package/src/gorgon/rules/math-frac.js +10 -0
  178. package/src/gorgon/rules/math-nested.js +11 -0
  179. package/src/gorgon/rules/math-starts-with-space.js +12 -0
  180. package/src/gorgon/rules/math-text-empty.js +10 -0
  181. package/src/gorgon/rules/math-without-dollars.js +14 -0
  182. package/src/gorgon/rules/nested-lists.js +11 -0
  183. package/src/gorgon/rules/profanity.js +10 -0
  184. package/src/gorgon/rules/table-missing-cells.js +20 -0
  185. package/src/gorgon/rules/unbalanced-code-delimiters.js +14 -0
  186. package/src/gorgon/rules/unescaped-dollar.js +10 -0
  187. package/src/gorgon/rules/widget-in-table.js +10 -0
  188. package/src/gorgon/selector.js +506 -0
  189. package/src/gorgon/tree-transformer.js +588 -0
  190. package/src/hint-renderer.jsx +159 -0
  191. package/src/hints-renderer.jsx +359 -0
  192. package/src/icon-paths.js +120 -0
  193. package/src/index.js +149 -2
  194. package/src/init.js +49 -0
  195. package/src/interaction-tracker.js +60 -0
  196. package/src/interactive2/__tests__/movable-mock.js +48 -0
  197. package/src/interactive2/__tests__/movable-point_test.js +146 -0
  198. package/src/interactive2/interactive-util.js +152 -0
  199. package/src/interactive2/movable-helper-methods.js +160 -0
  200. package/src/interactive2/movable-line-options.js +392 -0
  201. package/src/interactive2/movable-line.js +322 -0
  202. package/src/interactive2/movable-point-options.js +190 -0
  203. package/src/interactive2/movable-point.jsx +603 -0
  204. package/src/interactive2/movable-polygon-options.js +351 -0
  205. package/src/interactive2/movable-polygon.js +368 -0
  206. package/src/interactive2/movable.js +273 -0
  207. package/src/interactive2/objective_.js +79 -0
  208. package/src/interactive2/types.js +3 -0
  209. package/src/interactive2/wrapped-defaults.js +86 -0
  210. package/src/interactive2/wrapped-ellipse.js +87 -0
  211. package/src/interactive2/wrapped-line.js +109 -0
  212. package/src/interactive2/wrapped-path.js +47 -0
  213. package/src/interactive2.js +91 -0
  214. package/src/item-renderer.jsx +518 -0
  215. package/src/item-version.js +12 -0
  216. package/src/jipt-paragraphs.js +44 -0
  217. package/src/jquery.mobile.vmouse.js +545 -0
  218. package/src/keypad-context.js +33 -0
  219. package/src/loading-context.js +20 -0
  220. package/src/logging/log.js +107 -0
  221. package/src/logging/log_test.js +41 -0
  222. package/src/mixins/changeable.jsx +115 -0
  223. package/src/mixins/editor-jsonify.jsx +13 -0
  224. package/src/mixins/provide-keypad.jsx +129 -0
  225. package/src/mixins/widget-jsonify-deprecated.jsx +23 -0
  226. package/src/mixins/widget-prop-blacklist.js +36 -0
  227. package/src/multi-items/__stories__/multi-renderer.stories.js +88 -0
  228. package/src/multi-items/__testdata__/multi-renderer_testdata.js +174 -0
  229. package/src/multi-items/__tests__/__snapshots__/multi-renderer_test.js.snap +994 -0
  230. package/src/multi-items/__tests__/items_test.js +245 -0
  231. package/src/multi-items/__tests__/multi-renderer_test.js +903 -0
  232. package/src/multi-items/__tests__/prop-type-builders_test.js +134 -0
  233. package/src/multi-items/__tests__/shapes_test.js +44 -0
  234. package/src/multi-items/__tests__/trees_test.js +316 -0
  235. package/src/multi-items/item-types.js +55 -0
  236. package/src/multi-items/items.js +176 -0
  237. package/src/multi-items/multi-renderer.jsx +543 -0
  238. package/src/multi-items/prop-type-builders.js +105 -0
  239. package/src/multi-items/shape-types.js +47 -0
  240. package/src/multi-items/shapes.js +53 -0
  241. package/src/multi-items/tree-types.js +42 -0
  242. package/src/multi-items/trees.js +345 -0
  243. package/src/multi-items.js +76 -0
  244. package/src/not-gorgon.js +129 -0
  245. package/src/perseus-api.jsx +270 -0
  246. package/src/perseus-env.js +26 -0
  247. package/src/perseus-error.js +19 -0
  248. package/src/perseus-markdown.jsx +433 -0
  249. package/src/perseus-types.js +1597 -0
  250. package/src/pure-markdown.js +347 -0
  251. package/src/question-paragraph.jsx +30 -0
  252. package/src/renderability.jsx +108 -0
  253. package/src/renderer.jsx +1932 -0
  254. package/src/server-item-renderer.jsx +467 -0
  255. package/src/sigfigs.jsx +492 -0
  256. package/src/styles/articles.less +748 -0
  257. package/src/styles/constants.js +119 -0
  258. package/src/styles/global-constants.js +350 -0
  259. package/src/styles/global-styles.js +307 -0
  260. package/src/styles/khan-exercise.css +1304 -0
  261. package/src/styles/media-queries.js +48 -0
  262. package/src/styles/perseus-renderer.less +1007 -0
  263. package/src/styles/shared.js +132 -0
  264. package/src/styles/util.less +47 -0
  265. package/src/styles/variables.boostrap.less +301 -0
  266. package/src/styles/variables.less +68 -0
  267. package/src/styles/variables.shared.less +356 -0
  268. package/src/styles/widgets/categorizer.less +39 -0
  269. package/src/styles/widgets/definition.less +86 -0
  270. package/src/styles/widgets/dropdown.less +3 -0
  271. package/src/styles/widgets/expression.less +147 -0
  272. package/src/styles/widgets/graded-group.less +36 -0
  273. package/src/styles/widgets/grapher.less +11 -0
  274. package/src/styles/widgets/group.less +19 -0
  275. package/src/styles/widgets/image.less +29 -0
  276. package/src/styles/widgets/interactive-graph.less +61 -0
  277. package/src/styles/widgets/label-image.less +41 -0
  278. package/src/styles/widgets/matcher.less +8 -0
  279. package/src/styles/widgets/matrix.less +120 -0
  280. package/src/styles/widgets/measurer.less +20 -0
  281. package/src/styles/widgets/orderer.less +97 -0
  282. package/src/styles/widgets/passage.less +151 -0
  283. package/src/styles/widgets/plotter.less +33 -0
  284. package/src/styles/widgets/radio.less +52 -0
  285. package/src/styles/widgets/reaction-diagram.less +35 -0
  286. package/src/styles/widgets/sequence.less +5 -0
  287. package/src/styles/widgets/sortable.less +127 -0
  288. package/src/styles/widgets/table.less +56 -0
  289. package/src/styles/widgets/transformer.less +28 -0
  290. package/src/styles/widgets/unit.less +14 -0
  291. package/src/tex-wrangler.js +176 -0
  292. package/src/traversal.jsx +141 -0
  293. package/src/types.js +538 -0
  294. package/src/util/a11y.js +24 -0
  295. package/src/util/answer-types.js +862 -0
  296. package/src/util/answer-types_test.js +115 -0
  297. package/src/util/colors.js +94 -0
  298. package/src/util/fix-passage-refs.jsx +122 -0
  299. package/src/util/graph-utils.js +16 -0
  300. package/src/util/graphie.js +1586 -0
  301. package/src/util/interactive.js +4078 -0
  302. package/src/util/katex-preprocess.js +16 -0
  303. package/src/util/math.js +296 -0
  304. package/src/util/mobile-native-utils.js +14 -0
  305. package/src/util/mobile-native-utils_test.js +24 -0
  306. package/src/util/register-all-widgets-for-testing.js +12 -0
  307. package/src/util/scroll-utils.js +162 -0
  308. package/src/util/sizing-utils.js +46 -0
  309. package/src/util/tex.js +203 -0
  310. package/src/util/url-utils.js +36 -0
  311. package/src/util.js +990 -0
  312. package/src/version.js +11 -0
  313. package/src/widget-container.jsx +174 -0
  314. package/src/widgets/__stories__/categorizer.stories.jsx +15 -0
  315. package/src/widgets/__stories__/cs-program.stories.jsx +15 -0
  316. package/src/widgets/__stories__/definition.stories.jsx +38 -0
  317. package/src/widgets/__stories__/dropdown.stories.jsx +15 -0
  318. package/src/widgets/__stories__/explanation.stories.jsx +19 -0
  319. package/src/widgets/__stories__/expression.stories.jsx +26 -0
  320. package/src/widgets/__stories__/graded-group-set.stories.jsx +32 -0
  321. package/src/widgets/__stories__/graded-group.stories.jsx +32 -0
  322. package/src/widgets/__stories__/grapher.stories.jsx +47 -0
  323. package/src/widgets/__stories__/group.stories.jsx +15 -0
  324. package/src/widgets/__stories__/iframe.stories.jsx +15 -0
  325. package/src/widgets/__stories__/image.stories.jsx +62 -0
  326. package/src/widgets/__stories__/input-number.stories.jsx +90 -0
  327. package/src/widgets/__stories__/interaction.stories.jsx +15 -0
  328. package/src/widgets/__stories__/interactive-graph.stories.jsx +61 -0
  329. package/src/widgets/__stories__/matcher.stories.jsx +15 -0
  330. package/src/widgets/__stories__/matrix.stories.jsx +15 -0
  331. package/src/widgets/__stories__/number-line.stories.jsx +15 -0
  332. package/src/widgets/__stories__/numeric-input.stories.jsx +19 -0
  333. package/src/widgets/__stories__/orderer.stories.jsx +15 -0
  334. package/src/widgets/__stories__/passage-ref.stories.jsx +19 -0
  335. package/src/widgets/__stories__/passage.stories.jsx +19 -0
  336. package/src/widgets/__stories__/radio.stories.jsx +82 -0
  337. package/src/widgets/__stories__/sorter.stories.jsx +15 -0
  338. package/src/widgets/__stories__/transformer.stories.jsx +15 -0
  339. package/src/widgets/__stories__/unit.stories.jsx +45 -0
  340. package/src/widgets/__stories__/video-transcript-link.stories.jsx +24 -0
  341. package/src/widgets/__stories__/video.stories.jsx +15 -0
  342. package/src/widgets/__testdata__/categorizer_testdata.js +50 -0
  343. package/src/widgets/__testdata__/cs-program_testdata.js +28 -0
  344. package/src/widgets/__testdata__/dropdown_testdata.js +34 -0
  345. package/src/widgets/__testdata__/explanation_testdata.js +56 -0
  346. package/src/widgets/__testdata__/expression_testdata.js +95 -0
  347. package/src/widgets/__testdata__/graded-group-set_testdata.js +358 -0
  348. package/src/widgets/__testdata__/graded-group_testdata.js +79 -0
  349. package/src/widgets/__testdata__/grapher_testdata.js +376 -0
  350. package/src/widgets/__testdata__/group_testdata.js +156 -0
  351. package/src/widgets/__testdata__/iframe_testdata.js +36 -0
  352. package/src/widgets/__testdata__/image_testdata.js +38 -0
  353. package/src/widgets/__testdata__/input-number_testdata.js +73 -0
  354. package/src/widgets/__testdata__/interaction_testdata.js +264 -0
  355. package/src/widgets/__testdata__/interactive-graph_testdata.js +646 -0
  356. package/src/widgets/__testdata__/matcher_testdata.js +34 -0
  357. package/src/widgets/__testdata__/matrix_testdata.js +29 -0
  358. package/src/widgets/__testdata__/number-line_testdata.js +31 -0
  359. package/src/widgets/__testdata__/numeric-input_testdata.js +266 -0
  360. package/src/widgets/__testdata__/orderer_testdata.js +58 -0
  361. package/src/widgets/__testdata__/passage-ref_testdata.js +41 -0
  362. package/src/widgets/__testdata__/passage_testdata.js +71 -0
  363. package/src/widgets/__testdata__/radio_testdata.js +210 -0
  364. package/src/widgets/__testdata__/sorter_testdata.js +20 -0
  365. package/src/widgets/__testdata__/transformer_testdata.js +109 -0
  366. package/src/widgets/__testdata__/video_testdata.js +22 -0
  367. package/src/widgets/__tests__/__snapshots__/categorizer_test.jsx.snap +928 -0
  368. package/src/widgets/__tests__/__snapshots__/cs-program_test.jsx.snap +75 -0
  369. package/src/widgets/__tests__/__snapshots__/definition_test.js.snap +99 -0
  370. package/src/widgets/__tests__/__snapshots__/dropdown_test.jsx.snap +143 -0
  371. package/src/widgets/__tests__/__snapshots__/explanation_test.js.snap +473 -0
  372. package/src/widgets/__tests__/__snapshots__/expression_test.jsx.snap +38 -0
  373. package/src/widgets/__tests__/__snapshots__/graded-group-set-jipt_test.jsx.snap +754 -0
  374. package/src/widgets/__tests__/__snapshots__/graded-group-set_test.jsx.snap +310 -0
  375. package/src/widgets/__tests__/__snapshots__/graded-group_test.jsx.snap +863 -0
  376. package/src/widgets/__tests__/__snapshots__/grapher_test.jsx.snap +2880 -0
  377. package/src/widgets/__tests__/__snapshots__/group_test.jsx.snap +1154 -0
  378. package/src/widgets/__tests__/__snapshots__/iframe_test.jsx.snap +69 -0
  379. package/src/widgets/__tests__/__snapshots__/image_test.jsx.snap +388 -0
  380. package/src/widgets/__tests__/__snapshots__/input-number_test.jsx.snap +978 -0
  381. package/src/widgets/__tests__/__snapshots__/interaction_test.jsx.snap +311 -0
  382. package/src/widgets/__tests__/__snapshots__/interactive-graph_test.jsx.snap +2915 -0
  383. package/src/widgets/__tests__/__snapshots__/matcher_test.jsx.snap +1039 -0
  384. package/src/widgets/__tests__/__snapshots__/matrix_test.jsx.snap +450 -0
  385. package/src/widgets/__tests__/__snapshots__/number-line_test.jsx.snap +888 -0
  386. package/src/widgets/__tests__/__snapshots__/numeric-input_test.jsx.snap +930 -0
  387. package/src/widgets/__tests__/__snapshots__/orderer_test.jsx.snap +275 -0
  388. package/src/widgets/__tests__/__snapshots__/passage-ref_test.jsx.snap +446 -0
  389. package/src/widgets/__tests__/__snapshots__/passage_test.jsx.snap +1988 -0
  390. package/src/widgets/__tests__/__snapshots__/radio_test.jsx.snap +7107 -0
  391. package/src/widgets/__tests__/__snapshots__/video_test.jsx.snap +163 -0
  392. package/src/widgets/__tests__/categorizer_test.jsx +205 -0
  393. package/src/widgets/__tests__/cs-program_test.jsx +45 -0
  394. package/src/widgets/__tests__/definition_test.js +152 -0
  395. package/src/widgets/__tests__/dropdown_test.jsx +106 -0
  396. package/src/widgets/__tests__/explanation_test.js +199 -0
  397. package/src/widgets/__tests__/expression_test.jsx +439 -0
  398. package/src/widgets/__tests__/graded-group-set-jipt_test.jsx +33 -0
  399. package/src/widgets/__tests__/graded-group-set_test.jsx +270 -0
  400. package/src/widgets/__tests__/graded-group_test.jsx +233 -0
  401. package/src/widgets/__tests__/grapher.cypress.jsx +486 -0
  402. package/src/widgets/__tests__/grapher_test.jsx +35 -0
  403. package/src/widgets/__tests__/group_test.jsx +512 -0
  404. package/src/widgets/__tests__/iframe_test.jsx +47 -0
  405. package/src/widgets/__tests__/image_test.jsx +65 -0
  406. package/src/widgets/__tests__/input-number_test.jsx +360 -0
  407. package/src/widgets/__tests__/interaction_test.jsx +33 -0
  408. package/src/widgets/__tests__/interactive-graph.cypress.jsx +697 -0
  409. package/src/widgets/__tests__/interactive-graph_test.jsx +105 -0
  410. package/src/widgets/__tests__/matcher_test.jsx +157 -0
  411. package/src/widgets/__tests__/matrix_test.jsx +84 -0
  412. package/src/widgets/__tests__/number-line_test.jsx +81 -0
  413. package/src/widgets/__tests__/numeric-input_test.jsx +574 -0
  414. package/src/widgets/__tests__/orderer_test.jsx +75 -0
  415. package/src/widgets/__tests__/passage-ref_test.jsx +166 -0
  416. package/src/widgets/__tests__/passage_test.jsx +133 -0
  417. package/src/widgets/__tests__/radio/base-radio_test.jsx +82 -0
  418. package/src/widgets/__tests__/radio_test.jsx +651 -0
  419. package/src/widgets/__tests__/renderQuestion.jsx +66 -0
  420. package/src/widgets/__tests__/unit_test.jsx +144 -0
  421. package/src/widgets/__tests__/video_test.jsx +55 -0
  422. package/src/widgets/categorizer.jsx +338 -0
  423. package/src/widgets/cs-program.jsx +227 -0
  424. package/src/widgets/definition.jsx +141 -0
  425. package/src/widgets/dropdown.jsx +143 -0
  426. package/src/widgets/explanation.jsx +315 -0
  427. package/src/widgets/expression.jsx +652 -0
  428. package/src/widgets/graded-group-answer-bar.jsx +152 -0
  429. package/src/widgets/graded-group-set.jsx +285 -0
  430. package/src/widgets/graded-group.jsx +448 -0
  431. package/src/widgets/grapher/util.jsx +806 -0
  432. package/src/widgets/grapher.jsx +663 -0
  433. package/src/widgets/group.jsx +213 -0
  434. package/src/widgets/iframe.jsx +198 -0
  435. package/src/widgets/image.jsx +310 -0
  436. package/src/widgets/input-number.jsx +411 -0
  437. package/src/widgets/interaction/arrow-picker.jsx +39 -0
  438. package/src/widgets/interaction/color-picker.jsx +69 -0
  439. package/src/widgets/interaction/dash-picker.jsx +46 -0
  440. package/src/widgets/interaction/element-container.jsx +97 -0
  441. package/src/widgets/interaction.jsx +742 -0
  442. package/src/widgets/interactive-graph.jsx +2820 -0
  443. package/src/widgets/label-image/__stories__/answer-choices.stories.jsx +93 -0
  444. package/src/widgets/label-image/__stories__/marker.stories.jsx +172 -0
  445. package/src/widgets/label-image/answer-choices.jsx +311 -0
  446. package/src/widgets/label-image/marker.jsx +365 -0
  447. package/src/widgets/label-image/types.js +33 -0
  448. package/src/widgets/label-image.jsx +841 -0
  449. package/src/widgets/label-image_test.js +840 -0
  450. package/src/widgets/lights-puzzle.jsx +356 -0
  451. package/src/widgets/matcher.jsx +271 -0
  452. package/src/widgets/matrix.jsx +616 -0
  453. package/src/widgets/measurer.jsx +215 -0
  454. package/src/widgets/molecule/__tests__/layout_test.jsx +159 -0
  455. package/src/widgets/molecule/__tests__/parser_test.jsx +142 -0
  456. package/src/widgets/molecule/molecule-drawing.jsx +175 -0
  457. package/src/widgets/molecule/molecule-layout.jsx +367 -0
  458. package/src/widgets/molecule/smiles-parser.jsx +300 -0
  459. package/src/widgets/molecule.jsx +172 -0
  460. package/src/widgets/number-line.jsx +858 -0
  461. package/src/widgets/numeric-input.jsx +622 -0
  462. package/src/widgets/orderer.jsx +753 -0
  463. package/src/widgets/passage/__tests__/passage-markdown_test.jsx +382 -0
  464. package/src/widgets/passage/get-line-height-for-node.js +10 -0
  465. package/src/widgets/passage/passage-markdown.jsx +416 -0
  466. package/src/widgets/passage-ref-target.jsx +70 -0
  467. package/src/widgets/passage-ref.jsx +198 -0
  468. package/src/widgets/passage.jsx +601 -0
  469. package/src/widgets/plotter.jsx +1198 -0
  470. package/src/widgets/radio/__stories__/base-radio.stories.jsx +40 -0
  471. package/src/widgets/radio/__stories__/choice-icon.stories.jsx +157 -0
  472. package/src/widgets/radio/__stories__/choice-none-above.stories.jsx +26 -0
  473. package/src/widgets/radio/__stories__/cross-out-button.stories.jsx +64 -0
  474. package/src/widgets/radio/__stories__/cross-out-menu.stories.jsx +59 -0
  475. package/src/widgets/radio/__stories__/cross-out-tooltip.stories.jsx +59 -0
  476. package/src/widgets/radio/__stories__/focus-ring.stories.jsx +38 -0
  477. package/src/widgets/radio/__stories__/option-status.stories.jsx +118 -0
  478. package/src/widgets/radio/__stories__/toggleable-radio-button.stories.jsx +28 -0
  479. package/src/widgets/radio/base-radio.jsx +642 -0
  480. package/src/widgets/radio/choice-icon.jsx +468 -0
  481. package/src/widgets/radio/choice-none-above.jsx +54 -0
  482. package/src/widgets/radio/choice.jsx +692 -0
  483. package/src/widgets/radio/choice.jsx.fixture.js +64 -0
  484. package/src/widgets/radio/cross-out-button.jsx +136 -0
  485. package/src/widgets/radio/cross-out-menu-wrapper.jsx +492 -0
  486. package/src/widgets/radio/cross-out-tooltip.jsx +129 -0
  487. package/src/widgets/radio/focus-ring.jsx +51 -0
  488. package/src/widgets/radio/option-status.jsx +89 -0
  489. package/src/widgets/radio/toggleable-radio-button.jsx +133 -0
  490. package/src/widgets/radio/util.js +32 -0
  491. package/src/widgets/radio/util_test.js +19 -0
  492. package/src/widgets/radio/widget.jsx +470 -0
  493. package/src/widgets/radio.jsx +156 -0
  494. package/src/widgets/reaction-diagram.jsx +137 -0
  495. package/src/widgets/sequence.jsx +140 -0
  496. package/src/widgets/simulator.jsx +808 -0
  497. package/src/widgets/sorter.jsx +146 -0
  498. package/src/widgets/table.jsx +394 -0
  499. package/src/widgets/transformer.jsx +2876 -0
  500. package/src/widgets/unit.jsx +372 -0
  501. package/src/widgets/video-transcript-link.jsx +84 -0
  502. package/src/widgets/video-transcript-link_test.js +211 -0
  503. package/src/widgets/video.jsx +126 -0
  504. package/src/widgets.js +431 -0
  505. package/src/zoom.js +539 -0
  506. package/README.md +0 -3
  507. package/src/__tests__/index.test.js +0 -14
@@ -0,0 +1,1932 @@
1
+ /* eslint-disable react/no-unsafe */
2
+ // @flow
3
+ import classNames from "classnames";
4
+ import $ from "jquery";
5
+ import * as React from "react";
6
+ import ReactDOM from "react-dom";
7
+ import _ from "underscore";
8
+
9
+ import AssetContext from "./asset-context.js";
10
+ import SvgImage from "./components/svg-image.jsx";
11
+ import TeX from "./components/tex.jsx";
12
+ import ZoomableTeX from "./components/zoomable-tex.jsx";
13
+ import Zoomable from "./components/zoomable.jsx";
14
+ import {getDependencies} from "./dependencies.js";
15
+ import ErrorBoundary from "./error-boundary.jsx";
16
+ import Gorgon from "./gorgon/gorgon.js"; // The linter engine
17
+ import {linterContextDefault} from "./gorgon/proptypes.js";
18
+ import InteractionTracker from "./interaction-tracker.js";
19
+ import Objective from "./interactive2/objective_.js";
20
+ import JiptParagraphs from "./jipt-paragraphs.js";
21
+ import {Errors, Log} from "./logging/log.js";
22
+ import NotGorgon from "./not-gorgon.js"; // The i18n linter
23
+ import {ClassNames as ApiClassNames, ApiOptions} from "./perseus-api.jsx";
24
+ import {PerseusError} from "./perseus-error.js";
25
+ import PerseusMarkdown from "./perseus-markdown.jsx";
26
+ import QuestionParagraph from "./question-paragraph.jsx";
27
+ import Util from "./util.js";
28
+ import preprocessTex from "./util/katex-preprocess.js";
29
+ import WidgetContainer from "./widget-container.jsx";
30
+ import * as Widgets from "./widgets.js";
31
+
32
+ import type {PerseusRenderer, PerseusWidgetOptions} from "./perseus-types.js";
33
+ import type {
34
+ APIOptions,
35
+ APIOptionsWithDefaults,
36
+ FilterCriterion,
37
+ FocusPath,
38
+ LinterContextProps,
39
+ PerseusDependencies,
40
+ PerseusScore,
41
+ WidgetInfo,
42
+ WidgetProps,
43
+ } from "./types.js";
44
+
45
+ import "./styles/perseus-renderer.less";
46
+
47
+ const {mapObject, mapObjectFromArray} = Objective;
48
+
49
+ const rContainsNonWhitespace = /\S/;
50
+ const rImageURL = /(web\+graphie|https):\/\/[^\s]*/;
51
+
52
+ const noopOnRender = () => {};
53
+
54
+ const SHOULD_CLEAR_WIDGETS_PROP_LIST = ["content", "problemNum", "widgets"];
55
+
56
+ // Check if one focus path / id path is a prefix of another
57
+ // The focus path null will never be a prefix of any non-null
58
+ // path, since it represents no focus.
59
+ // Otherwise, prefix is calculated by whether every array
60
+ // element in the prefix is present in the same position in the
61
+ // wholeArray path.
62
+ const isIdPathPrefix = function (
63
+ prefixArray: FocusPath,
64
+ wholeArray: FocusPath,
65
+ ) {
66
+ if (prefixArray === null || wholeArray === null) {
67
+ return prefixArray === wholeArray;
68
+ }
69
+
70
+ return _.every(prefixArray, (elem: string, i: number) => {
71
+ if (wholeArray != null) {
72
+ return _.isEqual(elem, wholeArray[i]);
73
+ }
74
+ });
75
+ };
76
+
77
+ type WidgetState = {|
78
+ isMobile?: boolean,
79
+ inTable?: boolean,
80
+ key?: number,
81
+ paragraphIndex?: number,
82
+ foundFullWidth?: boolean,
83
+ baseElements?: any,
84
+ |};
85
+
86
+ type SetWidgetPropsFn = (
87
+ id: string,
88
+ newProps: $FlowFixMe,
89
+ cb: () => boolean,
90
+ // Widgets can call `onChange` with `silent` set to `true` to prevent
91
+ // interaction events from being triggered in listeners.
92
+ silent?: boolean,
93
+ ) => void;
94
+
95
+ // The return type for getUserInput. Widgets have full control of what is
96
+ // returned so it's not easily typed (some widgets return a scalar (string),
97
+ // some return a custom-built object, some delegate to
98
+ // `WidgetJsonifyDeprecated` which returns an object containing widget props
99
+ // (filtered by deprecated keys)).
100
+ type WidgetUserInput = $FlowFixMe;
101
+
102
+ type SerializedState = {[id: string]: any, ...};
103
+
104
+ export type Widget = {|
105
+ focus: () =>
106
+ | {|
107
+ id: string,
108
+ path: FocusPath,
109
+ |}
110
+ | boolean,
111
+ getDOMNodeForPath: (path: FocusPath) => Element | Text | null,
112
+ deselectIncorrectSelectedChoices?: () => void,
113
+ restoreSerializedState: (props: any, callback: () => void) => any,
114
+ // TODO(jeremy): I think this return value is wrong. The widget
115
+ // getSerializedState should just return _its_ serialized state, not a
116
+ // key/value list of all widget states (i think!)
117
+ // Returns widget state that can be passed back to `restoreSerializedState`
118
+ // to put the widget back into exactly the same state. If the widget does
119
+ // not implement this function, the renderer simply returns all of the
120
+ // widget's props.
121
+ getSerializedState?: () => SerializedState, // SUSPECT
122
+ getGrammarTypeForPath: (path: FocusPath) => string,
123
+ blurInputPath?: (path: FocusPath) => null,
124
+ focusInputPath?: (path: FocusPath) => null,
125
+ getInputPaths?: () => $ReadOnlyArray<FocusPath>,
126
+ setInputValue?: (
127
+ path: FocusPath,
128
+ newValue: string,
129
+ focus: () => mixed, // TODO(jeremy): I think this is actually a callback
130
+ ) => void,
131
+ getUserInput?: () => ?WidgetUserInput,
132
+ simpleValidate?: (
133
+ options: any,
134
+ onOutputError: ?(
135
+ widgetId?: any,
136
+ value: string,
137
+ message: ?string,
138
+ ) => mixed,
139
+ ) => PerseusScore,
140
+ showRationalesForCurrentlySelectedChoices?: (options?: any) => void,
141
+ examples?: () => $ReadOnlyArray<string>,
142
+ |};
143
+
144
+ type Props = {|
145
+ apiOptions?: APIOptions,
146
+ alwaysUpdate?: boolean,
147
+ // eslint-disable-next-line flowtype/no-weak-types
148
+ findExternalWidgets: Function,
149
+ highlightedWidgets?: $ReadOnlyArray<any>,
150
+ images: PerseusRenderer["images"],
151
+ keypadElement?: $FlowFixMe, // TODO(kevinb): add proper flow types
152
+ onInteractWithWidget: (id: string) => void,
153
+ onRender: (node: any) => void,
154
+ problemNum?: number,
155
+ questionCompleted?: boolean,
156
+ reviewMode?: ?boolean,
157
+ content: PerseusRenderer["content"],
158
+
159
+ serializedState?: any,
160
+ // Callback which is called when serialized state changes with the new
161
+ // serialized state.
162
+ onSerializedStateUpdated: (serializedState: {[string]: any, ...}) => mixed,
163
+
164
+ // If linterContext.highlightLint is true, then content will be passed
165
+ // to the linter and any warnings will be highlighted in the rendered
166
+ // output.
167
+ linterContext: LinterContextProps,
168
+
169
+ legacyPerseusLint?: $ReadOnlyArray<string>,
170
+ widgets: PerseusRenderer["widgets"],
171
+ |};
172
+
173
+ type State = {|
174
+ notGorgonLintErrors: $ReadOnlyArray<string>,
175
+ widgetInfo: $ReadOnly<{|[id: string]: ?WidgetInfo|}>,
176
+ widgetProps: $ReadOnly<{|[id: string]: ?$FlowFixMe|}>,
177
+ jiptContent: any,
178
+ lastUsedWidgetId: ?string,
179
+ |};
180
+
181
+ type Context = {
182
+ ...LinterContextProps,
183
+ content: string,
184
+ widgets: {[id: string]: any, ...},
185
+ // This is inexact because LinterContextProps is inexact
186
+ ...
187
+ };
188
+
189
+ type DefaultProps = {|
190
+ alwaysUpdate: Props["alwaysUpdate"],
191
+ content: Props["content"],
192
+ findExternalWidgets: Props["findExternalWidgets"],
193
+ highlightedWidgets: Props["highlightedWidgets"],
194
+ images: Props["images"],
195
+ linterContext: Props["linterContext"],
196
+ onInteractWithWidget: Props["onInteractWithWidget"],
197
+ onRender: Props["onRender"],
198
+ onSerializedStateUpdated: Props["onSerializedStateUpdated"],
199
+ questionCompleted: Props["questionCompleted"],
200
+ reviewMode: Props["reviewMode"],
201
+ serializedState: Props["serializedState"],
202
+ widgets: Props["widgets"],
203
+ |};
204
+
205
+ class Renderer extends React.Component<Props, State> {
206
+ _currentFocus: ?FocusPath;
207
+ _foundTextNodes: boolean;
208
+ _interactionTrackers: {[id: string]: InteractionTracker, ...};
209
+ _isMounted: boolean;
210
+ _isTwoColumn: boolean;
211
+
212
+ // The i18n linter.
213
+ _notGorgon: NotGorgon;
214
+
215
+ lastRenderedMarkdown: React.Element<PerseusDependencies["KatexProvider"]>;
216
+ reuseMarkdown: boolean;
217
+ translationIndex: number;
218
+ // eslint-disable-next-line flowtype/no-mutable-array
219
+ widgetIds: Array<string>;
220
+
221
+ static defaultProps: DefaultProps = {
222
+ content: "",
223
+ widgets: {},
224
+ images: {},
225
+ highlightedWidgets: [],
226
+ questionCompleted: false,
227
+ // onRender may be called multiple times per render, for example
228
+ // if there are multiple images or TeX pieces within `content`.
229
+ // It is a good idea to debounce any functions passed here.
230
+ onRender: noopOnRender,
231
+ onInteractWithWidget: function () {},
232
+ findExternalWidgets: () => [],
233
+ alwaysUpdate: false,
234
+ reviewMode: false,
235
+ serializedState: null,
236
+ onSerializedStateUpdated: () => {},
237
+ linterContext: linterContextDefault,
238
+ };
239
+
240
+ constructor(props: Props, context: Context) {
241
+ super(props, context);
242
+ this._notGorgon = new NotGorgon();
243
+
244
+ this.state = {
245
+ jiptContent: null,
246
+
247
+ // NotGorgon is async and currently does not contain a location.
248
+ // This is a list of error strings NotGorgon detected on its last
249
+ // run.
250
+ notGorgonLintErrors: [],
251
+
252
+ // The ID of the last widget the user interacted with. We'll
253
+ // use this to set the `isLastUsedWidget` flag on the
254
+ // corresponding widget.
255
+ lastUsedWidgetId: null,
256
+
257
+ ...this._getInitialWidgetState(props),
258
+ };
259
+ }
260
+
261
+ componentDidMount() {
262
+ this._isMounted = true;
263
+
264
+ // figure out why we're passing an empty object
265
+ // $FlowFixMe[incompatible-exact]: Flow considers empty objects to be inexact and handleRender is expecting an exact object.
266
+ this.handleRender({});
267
+ this._currentFocus = null;
268
+
269
+ // TODO(emily): actually make the serializedState prop work like a
270
+ // controlled prop, instead of manually calling .restoreSerializedState
271
+ // at the right times.
272
+ if (this.props.serializedState) {
273
+ this.restoreSerializedState(this.props.serializedState);
274
+ }
275
+
276
+ if (this.props.linterContext.highlightLint) {
277
+ // Get i18n lint errors asynchronously. If there are lint errors,
278
+ // this component will be rerendered.
279
+ this._notGorgon.runLinter(
280
+ this.props.content,
281
+ this.handleNotGorgonLintErrors,
282
+ );
283
+ }
284
+ }
285
+
286
+ UNSAFE_componentWillReceiveProps(nextProps: Props) {
287
+ if (
288
+ !_.isEqual(
289
+ _.pick(this.props, SHOULD_CLEAR_WIDGETS_PROP_LIST),
290
+ _.pick(nextProps, SHOULD_CLEAR_WIDGETS_PROP_LIST),
291
+ )
292
+ ) {
293
+ this.setState(this._getInitialWidgetState(nextProps));
294
+ }
295
+ }
296
+
297
+ shouldComponentUpdate(nextProps: Props, nextState: State): any | boolean {
298
+ // QUESTION(jeremy): Shouldn't we look at `nextProps` here? Otherwise
299
+ // we're always looking "one render behind".
300
+ if (this.props.alwaysUpdate) {
301
+ // TOTAL hacks so that findWidgets doesn't break
302
+ // when one widget updates without the other.
303
+ // See passage-refs inside radios, which was why
304
+ // this was introduced.
305
+ // I'm sorry!
306
+ // TODO(aria): cry
307
+ //
308
+ // HACK(djf): I've also set this alwaysUpdate property from
309
+ // async-renderer.jsx in the manticore-package. I'm doing this
310
+ // to work around an infinite loop of some sort that started
311
+ // happening in manticore after the React 16 update. After
312
+ // clicking around in the manticore exercise editor (for example)
313
+ // the UI would freeze up, and the debugger would show that
314
+ // we were always deep in a recursion on the propsChanged line
315
+ // below. There is some kind of timing issue causing some kind
316
+ // of infinite loop, but by avoiding the time-consuming deep
317
+ // equal comparisons on our props (which are often huge) I can
318
+ // no longer reproduce the bug.
319
+ // TODO(djf): Remove this comment
320
+ // https://khanacademy.atlassian.net/browse/CP-834 is resolved.
321
+ return true;
322
+ }
323
+ const stateChanged = !_.isEqual(this.state, nextState);
324
+ const propsChanged = !_.isEqual(this.props, nextProps);
325
+ return propsChanged || stateChanged;
326
+ }
327
+
328
+ UNSAFE_componentWillUpdate(nextProps: Props, nextState: State) {
329
+ const oldJipt = this.shouldRenderJiptPlaceholder(
330
+ this.props,
331
+ this.state,
332
+ );
333
+ const newJipt = this.shouldRenderJiptPlaceholder(nextProps, nextState);
334
+ const oldContent = this.getContent(this.props, this.state);
335
+ const newContent = this.getContent(nextProps, nextState);
336
+ const oldHighlightedWidgets = this.props.highlightedWidgets;
337
+ const newHighlightedWidgets = nextProps.highlightedWidgets;
338
+
339
+ // TODO(jared): This seems to be a perfect overlap with
340
+ // "shouldComponentUpdate" -- can we just remove this
341
+ // componentWillUpdate and the reuseMarkdown attr?
342
+ this.reuseMarkdown =
343
+ !oldJipt &&
344
+ !newJipt &&
345
+ oldContent === newContent &&
346
+ _.isEqual(
347
+ this.state.notGorgonLintErrors,
348
+ nextState.notGorgonLintErrors,
349
+ ) &&
350
+ // If we are running the linter then we need to know when
351
+ // widgets have changed because we need for force the linter to
352
+ // run when that happens. Note: don't do identity comparison here:
353
+ // it can cause frequent re-renders that break MathJax somehow
354
+ (!this.props.linterContext.highlightLint ||
355
+ _.isEqual(this.props.widgets, nextProps.widgets)) &&
356
+ // If the linter is turned on or off, we have to rerender
357
+ this.props.linterContext.highlightLint ===
358
+ nextProps.linterContext.highlightLint &&
359
+ // yes, this is identity array comparison, but these are passed
360
+ // in from state in the item-renderer, so they should be
361
+ // identity equal unless something changed, and it's expensive
362
+ // to loop through them to look for differences.
363
+ // Technically, we could reuse the markdown when this changes,
364
+ // but to do that we'd have to do more expensive checking of
365
+ // whether a widget should be highlighted in the common case
366
+ // where this array hasn't changed, so we just redo the whole
367
+ // render if this changed
368
+ oldHighlightedWidgets === newHighlightedWidgets;
369
+ }
370
+
371
+ componentDidUpdate(prevProps: Props, prevState: State) {
372
+ this.handleRender(prevProps);
373
+ // We even do this if we did reuse the markdown because
374
+ // we might need to update the widget props on this render,
375
+ // even though we have the same widgets.
376
+ // WidgetContainers don't update their widgets' props when
377
+ // they are re-rendered, so even if they've been
378
+ // re-rendered we need to call these methods on them.
379
+ _.each(this.widgetIds, (id) => {
380
+ // eslint-disable-next-line react/no-string-refs
381
+ const container = this.refs["container:" + id];
382
+ container && container.replaceWidgetProps(this.getWidgetProps(id));
383
+ });
384
+
385
+ if (
386
+ this.props.serializedState &&
387
+ !_.isEqual(this.props.serializedState, this.getSerializedState())
388
+ ) {
389
+ this.restoreSerializedState(this.props.serializedState);
390
+ }
391
+
392
+ if (this.props.linterContext.highlightLint) {
393
+ // Get i18n lint errors asynchronously. If lint errors have changed
394
+ // since the last run, this component will be rerendered.
395
+ this._notGorgon.runLinter(
396
+ this.props.content,
397
+ this.handleNotGorgonLintErrors,
398
+ );
399
+ }
400
+ }
401
+
402
+ componentWillUnmount() {
403
+ // Clean out the list of widgetIds when unmounting, as this list is
404
+ // meant to be consistent with the refs controlled by the renderer, and
405
+ // refs are also cleared out during unmounting.
406
+ // (This may not be totally necessary, but mobile clients have been
407
+ // seeing JS errors due to an inconsistency between the list of
408
+ // widgetIds and the child refs of the renderer.
409
+ // See: https://phabricator.khanacademy.org/D32420.)
410
+ this.widgetIds = [];
411
+
412
+ if (this.translationIndex != null) {
413
+ // NOTE(jeremy): Since the translationIndex is simply the array
414
+ // index of each renderer, we can't remove Renderers from this
415
+ // list, rather, we simply null out the entry (which means that
416
+ // this array's growth is unbounded until a page reload).
417
+ getDependencies().rendererTranslationComponents.removeComponentAtIndex(
418
+ this.translationIndex,
419
+ );
420
+ }
421
+
422
+ this._isMounted = false;
423
+ }
424
+
425
+ getApiOptions: () => APIOptionsWithDefaults = () => {
426
+ return {
427
+ ...ApiOptions.defaults,
428
+ ...this.props.apiOptions,
429
+ };
430
+ };
431
+
432
+ _getInitialWidgetState: (props: Props) => {|
433
+ widgetInfo: State["widgetInfo"],
434
+ widgetProps: State["widgetProps"],
435
+ |} = (props: Props) => {
436
+ const allWidgetInfo = this._getAllWidgetsInfo(props);
437
+ return {
438
+ widgetInfo: allWidgetInfo,
439
+ widgetProps: this._getAllWidgetsStartProps(allWidgetInfo, props),
440
+ };
441
+ };
442
+
443
+ _getAllWidgetsInfo: (props: Props) => {|[string]: WidgetInfo|} = (
444
+ props: Props,
445
+ ) => {
446
+ return mapObject(props.widgets, (widgetInfo, widgetId) => {
447
+ if (!widgetInfo.type || !widgetInfo.alignment) {
448
+ const newValues = {};
449
+
450
+ if (!widgetInfo.type) {
451
+ newValues.type = widgetId.split(" ")[0];
452
+ }
453
+ if (!widgetInfo.alignment) {
454
+ newValues.alignment = "default";
455
+ }
456
+
457
+ widgetInfo = _.extend({}, widgetInfo, newValues);
458
+ }
459
+ return Widgets.upgradeWidgetInfoToLatestVersion(widgetInfo);
460
+ });
461
+ };
462
+
463
+ _getAllWidgetsStartProps: (
464
+ allWidgetInfo: {|[string]: WidgetInfo|},
465
+ props: Props,
466
+ ) => any = (allWidgetInfo, props) => {
467
+ return mapObject(allWidgetInfo, (widgetInfo) => {
468
+ return Widgets.getRendererPropsForWidgetInfo(
469
+ widgetInfo,
470
+ props.problemNum,
471
+ );
472
+ });
473
+ };
474
+
475
+ // This is only used in _getWidgetInfo as a fallback if widgetId
476
+ // doesn't exist in this.state.widgetInfo. It doesn't get run as
477
+ // part of the happy path.
478
+ // TODO(LP-10713): Refactor how we handle widgetIds that don't exist
479
+ // in this.state.widgetInfo.
480
+ _getDefaultWidgetInfo: (widgetId: string) => $FlowFixMe = (
481
+ widgetId: string,
482
+ ) => {
483
+ const widgetIdParts = Util.rTypeFromWidgetId.exec(widgetId);
484
+ if (widgetIdParts == null) {
485
+ // We should probably return null here since there's no
486
+ // widget with the given id.
487
+ // NOTE(jeremy): Further, the widgetId we were given does not even
488
+ // look like a widget ID (ie. `widget-type \d+`). I can't figure
489
+ // out how to trigger this line of code though.
490
+ /* istanbul ignore next line */
491
+ return {};
492
+ }
493
+ return {
494
+ type: widgetIdParts[1],
495
+ graded: true,
496
+ options: {},
497
+ };
498
+ };
499
+
500
+ _getWidgetInfo: (widgetId: string) => WidgetInfo = (
501
+ widgetId: string,
502
+ ): WidgetInfo => {
503
+ return (
504
+ this.state.widgetInfo[widgetId] ||
505
+ this._getDefaultWidgetInfo(widgetId)
506
+ );
507
+ };
508
+
509
+ renderWidget: (
510
+ impliedType: string,
511
+ id: string,
512
+ state: WidgetState,
513
+ ) => null | React.Node = (
514
+ impliedType: string,
515
+ id: string,
516
+ state: WidgetState,
517
+ ) => {
518
+ const widgetInfo = this.state.widgetInfo[id];
519
+
520
+ if (widgetInfo && widgetInfo.alignment === "full-width") {
521
+ state.foundFullWidth = true;
522
+ }
523
+
524
+ if (widgetInfo) {
525
+ const type = (widgetInfo && widgetInfo.type) || impliedType;
526
+ const shouldHighlight = _.contains(
527
+ this.props.highlightedWidgets,
528
+ id,
529
+ );
530
+
531
+ // By this point we should have no duplicates, which are
532
+ // filtered out in this.render(), so we shouldn't have to
533
+ // worry about using this widget key and ref:
534
+ return (
535
+ <ErrorBoundary key={"container:" + id}>
536
+ <WidgetContainer
537
+ ref={"container:" + id}
538
+ type={type}
539
+ initialProps={this.getWidgetProps(id)}
540
+ shouldHighlight={shouldHighlight}
541
+ linterContext={Gorgon.pushContextStack(
542
+ this.props.linterContext,
543
+ "widget",
544
+ )}
545
+ />
546
+ </ErrorBoundary>
547
+ );
548
+ }
549
+ return null;
550
+ };
551
+
552
+ getWidgetProps: (
553
+ id: string,
554
+ ) => WidgetProps<$FlowFixMe, PerseusWidgetOptions> = (id) => {
555
+ const apiOptions = this.getApiOptions();
556
+ const widgetProps = this.state.widgetProps[id] || {};
557
+
558
+ // The widget needs access to its "rubric" at all times when in review
559
+ // mode (which is really just part of its widget info).
560
+ let reviewModeRubric = null;
561
+ const widgetInfo = this.state.widgetInfo[id];
562
+ if (this.props.reviewMode && widgetInfo) {
563
+ reviewModeRubric = widgetInfo.options;
564
+ }
565
+
566
+ if (!this._interactionTrackers) {
567
+ this._interactionTrackers = {};
568
+ }
569
+
570
+ let interactionTracker = this._interactionTrackers[id];
571
+ if (!interactionTracker) {
572
+ interactionTracker = this._interactionTrackers[id] =
573
+ new InteractionTracker(
574
+ apiOptions.trackInteraction,
575
+ // $FlowFixMe[incompatible-call]
576
+ widgetInfo && widgetInfo.type,
577
+ id,
578
+ // $FlowFixMe[incompatible-call]
579
+ Widgets.getTracking(widgetInfo && widgetInfo.type),
580
+ );
581
+ }
582
+
583
+ return {
584
+ ...widgetProps,
585
+ ref: id,
586
+ widgetId: id,
587
+ alignment: widgetInfo && widgetInfo.alignment,
588
+ // When determining if a widget is static, we verify that the widget is not an
589
+ // exercise question by verifying that it has no problem number.
590
+ static: widgetInfo && widgetInfo.static && !this.props.problemNum,
591
+ problemNum: this.props.problemNum,
592
+ apiOptions: this.getApiOptions(),
593
+ keypadElement: this.props.keypadElement,
594
+ questionCompleted: this.props.questionCompleted,
595
+ onFocus: _.partial(this._onWidgetFocus, id),
596
+ onBlur: _.partial(this._onWidgetBlur, id),
597
+ findWidgets: this.findWidgets,
598
+ reviewModeRubric: reviewModeRubric,
599
+ onChange: (newProps, cb, silent = false) => {
600
+ this._setWidgetProps(id, newProps, cb, silent);
601
+ },
602
+ trackInteraction: interactionTracker.track,
603
+ isLastUsedWidget: id === this.state.lastUsedWidgetId,
604
+ };
605
+ };
606
+
607
+ /**
608
+ * Serializes the questions state so it can be recovered.
609
+ *
610
+ * The return value of this function can be sent to the
611
+ * `restoreSerializedState` method to restore this state.
612
+ *
613
+ * If an instance of widgetProps is passed in, it generates the serialized
614
+ * state from that instead of the current widget props.
615
+ */
616
+ getSerializedState: (widgetProps: any) => {[id: string]: any, ...} = (
617
+ widgetProps: any,
618
+ ): {[id: string]: any, ...} => {
619
+ return mapObject(
620
+ widgetProps || this.state.widgetProps,
621
+ (props, widgetId) => {
622
+ const widget = this.getWidgetInstance(widgetId);
623
+ if (widget && widget.getSerializedState) {
624
+ return widget.getSerializedState();
625
+ }
626
+ return props;
627
+ },
628
+ );
629
+ };
630
+
631
+ restoreSerializedState: (
632
+ serializedState: SerializedState,
633
+ callback?: () => void,
634
+ ) => void = (serializedState: SerializedState, callback?: () => void) => {
635
+ // Do some basic validation on the serialized state (just make sure the
636
+ // widget IDs are what we expect).
637
+ const serializedWidgetIds = _.keys(serializedState);
638
+ const widgetPropIds = _.keys(this.state.widgetProps);
639
+
640
+ // If the two lists of IDs match (ignoring order)
641
+ if (
642
+ serializedWidgetIds.length !== widgetPropIds.length ||
643
+ _.intersection(serializedWidgetIds, widgetPropIds).length !==
644
+ serializedWidgetIds.length
645
+ ) {
646
+ Log.error(
647
+ "Refusing to restore bad serialized state:",
648
+ Errors.Internal,
649
+ {
650
+ loggedMetadata: {
651
+ serializedState: JSON.stringify(serializedState),
652
+ currentProps: JSON.stringify(this.state.widgetProps),
653
+ },
654
+ },
655
+ );
656
+ return;
657
+ }
658
+
659
+ // We want to wait until any children widgets who have a
660
+ // restoreSerializedState function also call their own callbacks before
661
+ // we declare that the operation is finished.
662
+ let numCallbacks = 1;
663
+ const fireCallback = () => {
664
+ --numCallbacks;
665
+ if (callback && numCallbacks === 0) {
666
+ callback();
667
+ }
668
+ };
669
+
670
+ this.setState(
671
+ {
672
+ widgetProps: mapObject(serializedState, (props, widgetId) => {
673
+ const widget = this.getWidgetInstance(widgetId);
674
+ if (widget && widget.restoreSerializedState) {
675
+ // Note that we probably can't call
676
+ // `this.change()/this.props.onChange()` in this
677
+ // function, so we take the return value and use
678
+ // that as props if necessary so that
679
+ // `restoreSerializedState` in a widget can
680
+ // change the props as well as state.
681
+ // If a widget has no props to change, it can
682
+ // safely return null.
683
+ ++numCallbacks;
684
+ const restoreResult = widget.restoreSerializedState(
685
+ props,
686
+ fireCallback,
687
+ );
688
+ return _.extend(
689
+ {},
690
+ this.state.widgetProps[widgetId],
691
+ restoreResult,
692
+ );
693
+ }
694
+ return props;
695
+ }),
696
+ },
697
+ () => {
698
+ // Wait until all components have rendered. In React 16 setState
699
+ // callback fires immediately after this componentDidUpdate, and
700
+ // there is no guarantee that parent/siblings components have
701
+ // finished rendering.
702
+ // TODO(jeff, CP-3128): Use Wonder Blocks Timing API
703
+ // eslint-disable-next-line no-restricted-syntax
704
+ setTimeout(fireCallback, 0);
705
+ },
706
+ );
707
+ };
708
+
709
+ /**
710
+ * Tell each of the radio widgets to show rationales for each of the
711
+ * currently selected choices inside of them. If the widget is correct, it
712
+ * shows rationales for all of the choices. This also disables interaction
713
+ * with the choices that we show rationales for.
714
+ */
715
+ showRationalesForCurrentlySelectedChoices: () => void = () => {
716
+ Object.keys(this.props.widgets).forEach((widgetId) => {
717
+ const widget = this.getWidgetInstance(widgetId);
718
+ if (widget && widget.showRationalesForCurrentlySelectedChoices) {
719
+ // $FlowFixMe[not-a-function]: figure out why this check isn't working
720
+ widget.showRationalesForCurrentlySelectedChoices(
721
+ this._getWidgetInfo(widgetId).options,
722
+ );
723
+ }
724
+ });
725
+ };
726
+
727
+ /**
728
+ * Tells each of the radio widgets to deselect any of the incorrect choices
729
+ * that are currently selected (leaving correct choices still selected).
730
+ */
731
+ deselectIncorrectSelectedChoices: () => void = () => {
732
+ // TODO(emily): this has the exact same structure as
733
+ // showRationalesForCurrentlySelectedChoices above. Maybe DRY this up.
734
+ Object.keys(this.props.widgets).forEach((widgetId) => {
735
+ const widget = this.getWidgetInstance(widgetId);
736
+ if (widget && widget.deselectIncorrectSelectedChoices) {
737
+ widget.deselectIncorrectSelectedChoices();
738
+ }
739
+ });
740
+ };
741
+
742
+ /**
743
+ * Allows inter-widget communication.
744
+ *
745
+ * This function yields this Renderer's own internal widgets, and it's used
746
+ * in two places.
747
+ *
748
+ * First, we expose our own internal widgets to each other by giving them
749
+ * a `findWidgets` function that, in turn, calls this function.
750
+ *
751
+ * Second, we expose our own internal widgets to this Renderer's parent,
752
+ * by allowing it to call this function directly. That way, it can hook us
753
+ * up to other Renderers on the page, by writing a `findExternalWidgets`
754
+ * prop that calls each other Renderer's `findInternalWidgets` function.
755
+ *
756
+ * Takes a `filterCriterion` on which widgets to return.
757
+ * `filterCriterion` can be one of:
758
+ * * A string widget id
759
+ * * A string widget type
760
+ * * a function from (id, widgetInfo, widgetComponent) to true or false
761
+ *
762
+ * Returns an array of the matching widget components.
763
+ *
764
+ * If you need to do logic with more than the components, it is possible
765
+ * to do such logic inside the filter, rather than on the result array.
766
+ *
767
+ * See the passage-ref widget for an example.
768
+ *
769
+ * "Remember: abilities are not inherently good or evil, it's how you use
770
+ * them." ~ Kyle Katarn
771
+ * Please use this one with caution.
772
+ */
773
+ findInternalWidgets: (
774
+ filterCriterion: FilterCriterion,
775
+ ) => $ReadOnlyArray<?Widget> = (filterCriterion: FilterCriterion) => {
776
+ let filterFunc;
777
+ // Convenience filters:
778
+ // "interactive-graph 3" will give you [[interactive-graph 3]]
779
+ // "interactive-graph" will give you all interactive-graphs
780
+ if (typeof filterCriterion === "string") {
781
+ if (filterCriterion.indexOf(" ") !== -1) {
782
+ const widgetId = filterCriterion;
783
+ filterFunc = (
784
+ id: string,
785
+ widgetInfo: WidgetInfo,
786
+ widget: ?Widget,
787
+ ) => id === widgetId;
788
+ } else {
789
+ const widgetType = filterCriterion;
790
+ filterFunc = (
791
+ id: string,
792
+ widgetInfo: WidgetInfo,
793
+ widget: ?Widget,
794
+ ) => {
795
+ return widgetInfo.type === widgetType;
796
+ };
797
+ }
798
+ } else {
799
+ filterFunc = filterCriterion;
800
+ }
801
+
802
+ const results: $ReadOnlyArray<?Widget> = this.widgetIds
803
+ .filter((id: string) => {
804
+ const widgetInfo = this._getWidgetInfo(id);
805
+ const widget = this.getWidgetInstance(id);
806
+ return filterFunc(id, widgetInfo, widget);
807
+ })
808
+ .map(this.getWidgetInstance);
809
+
810
+ return results;
811
+ };
812
+
813
+ /**
814
+ * Allows inter-widget communication.
815
+ *
816
+ * Includes both widgets internal to this Renderer, and external widgets
817
+ * exposed by the `findExternalWidgets` prop.
818
+ *
819
+ * See `findInteralWidgets` for more information.
820
+ */
821
+ findWidgets: (filterCriterion: FilterCriterion) => any = (
822
+ filterCriterion: FilterCriterion,
823
+ ) => {
824
+ return [
825
+ ...this.findInternalWidgets(filterCriterion),
826
+ ...this.props.findExternalWidgets(filterCriterion),
827
+ ];
828
+ };
829
+
830
+ getWidgetInstance: (id: string) => ?Widget = (id: string): ?Widget => {
831
+ // eslint-disable-next-line react/no-string-refs
832
+ const ref = this.refs["container:" + id];
833
+ if (!ref) {
834
+ return null;
835
+ }
836
+ return ref.getWidget();
837
+ };
838
+
839
+ _onWidgetFocus: (id: string, focusPath?: $ReadOnlyArray<string>) => void = (
840
+ id: string,
841
+ focusPath: $ReadOnlyArray<string> = [],
842
+ ) => {
843
+ if (!_.isArray(focusPath)) {
844
+ throw new PerseusError(
845
+ "widget props.onFocus focusPath must be an Array, " +
846
+ "but was" +
847
+ JSON.stringify(focusPath),
848
+ Errors.Internal,
849
+ );
850
+ }
851
+ this._setCurrentFocus([id].concat(focusPath));
852
+ };
853
+
854
+ _onWidgetBlur: (id: string, blurPath: FocusPath) => void = (
855
+ id: string,
856
+ blurPath: FocusPath,
857
+ ) => {
858
+ const blurringFocusPath = this._currentFocus;
859
+
860
+ // Failsafe: abort if ID is different, because focus probably happened
861
+ // before blur
862
+ const fullPath = [id].concat(blurPath);
863
+ if (!_.isEqual(fullPath, blurringFocusPath)) {
864
+ return;
865
+ }
866
+
867
+ // Wait until after any new focus events fire this tick before
868
+ // declaring that nothing is focused.
869
+ // If a different widget was focused, we'll see an onBlur event
870
+ // now, but then an onFocus event on a different element before
871
+ // this callback is executed
872
+ _.defer(() => {
873
+ if (_.isEqual(this._currentFocus, blurringFocusPath)) {
874
+ this._setCurrentFocus(null);
875
+ }
876
+ });
877
+ };
878
+
879
+ getContent: (props: Props, state: State) => any = (
880
+ props: Props,
881
+ state: State,
882
+ ) => {
883
+ return state.jiptContent || props.content;
884
+ };
885
+
886
+ shouldRenderJiptPlaceholder: (props: Props, state: State) => boolean = (
887
+ props: Props,
888
+ state: State,
889
+ ): boolean => {
890
+ // TODO(aria): Pass this in via webapp as an apiOption
891
+ return (
892
+ getDependencies().JIPT.useJIPT &&
893
+ state.jiptContent == null &&
894
+ props.content.indexOf("crwdns") !== -1
895
+ );
896
+ };
897
+
898
+ replaceJiptContent: (content: string, paragraphIndex: number) => void = (
899
+ content: string,
900
+ paragraphIndex: number,
901
+ ) => {
902
+ if (paragraphIndex == null) {
903
+ // we're not translating paragraph-wise; replace the whole content
904
+ // (we could also theoretically check for apiOptions.isArticle
905
+ // here, which is what causes paragraphIndex to not be null)
906
+ this.setState({
907
+ jiptContent: content,
908
+ });
909
+ } else {
910
+ // This is the same regex we use in perseus/translate.py to find
911
+ // code blocks. We use it to count entire code blocks as
912
+ // paragraphs.
913
+ const codeFenceRegex =
914
+ /^\s*(`{3,}|~{3,})\s*(\S+)?\s*\n([\s\S]+?)\s*\1\s*$/;
915
+
916
+ if (codeFenceRegex.test(content)) {
917
+ // If a paragraph is a code block, we're going to treat it as a
918
+ // single paragraph even if it has double-newlines in it, so
919
+ // skip the next two checks.
920
+ } else if (/\S\n\s*\n\S/.test(content)) {
921
+ // Our "render the exact same QuestionParagraphs each time"
922
+ // strategy will fail if we allow translating a paragraph
923
+ // to more than one paragraph. This hack renders as a single
924
+ // paragraph and lets the translator know to not use \n\n,
925
+ // hopefully. We can't wait for linting because we can't
926
+ // safely render the node.
927
+ // TODO(aria): Check for the max number of backticks or tildes
928
+ // in the content, and just render a red code block of the
929
+ // content here instead?
930
+ content =
931
+ "$\\large{\\red{\\text{Please translate each " +
932
+ "paragraph to a single paragraph.}}}$";
933
+ } else if (/^\s*$/.test(content)) {
934
+ // We similarly can't have an all-whitespace paragraph, or
935
+ // we will parse it as the closing of the previous paragraph
936
+ content =
937
+ "$\\large{\\red{\\text{Translated paragraph is " +
938
+ "currently empty}}}$";
939
+ }
940
+ // Split the paragraphs; we have to use getContent() in case
941
+ // nothing has been translated yet (in which case we just have
942
+ // this.props.content)
943
+ const allContent = this.getContent(this.props, this.state);
944
+ const paragraphs = JiptParagraphs.parseToArray(allContent);
945
+ paragraphs[paragraphIndex] = content;
946
+ this.setState({
947
+ jiptContent: JiptParagraphs.joinFromArray(paragraphs),
948
+ });
949
+ }
950
+ };
951
+
952
+ // wrap top-level elements in a QuestionParagraph, mostly
953
+ // for appropriate spacing and other css
954
+ outputMarkdown: (ast: any, state: WidgetState) => React.Node = (
955
+ ast: any,
956
+ state: WidgetState,
957
+ ) => {
958
+ if (_.isArray(ast)) {
959
+ // This is duplicated from simple-markdown
960
+ // TODO(aria): Don't duplicate this logic
961
+ const oldKey = state.key;
962
+ const result = [];
963
+
964
+ // map nestedOutput over the ast, except group any text
965
+ // nodes together into a single string output.
966
+ // NOTE(aria): These are never strings--always QuestionParagraphs
967
+ // TODO(aria): We probably don't need this string logic here.
968
+ let lastWasString = false;
969
+ for (let i = 0; i < ast.length; i++) {
970
+ state.key = i;
971
+ state.paragraphIndex = i;
972
+ const nodeOut = this.outputMarkdown(ast[i], state);
973
+ const isString = typeof nodeOut === "string";
974
+ // NOTE(jeremy): As far as I can tell, this if is _never_
975
+ // reached. As noted above, these are always QuestionParagraphs
976
+ // now.
977
+ /* istanbul ignore if */
978
+ if (typeof nodeOut === "string" && lastWasString) {
979
+ /**
980
+ * $FlowIgnore[incompatible-type]
981
+ * We know that last was string, but Flow can't see this
982
+ * refinement.
983
+ */
984
+ result[result.length - 1] += nodeOut;
985
+ } else {
986
+ result.push(nodeOut);
987
+ }
988
+ lastWasString = isString;
989
+ }
990
+
991
+ state.key = oldKey;
992
+ return result;
993
+ }
994
+ // !!! WARNING: Mutative hacks! mutates `this._foundTextNodes`:
995
+ // because I wrote a bad interface to simple-markdown.js' `output`
996
+ this._foundTextNodes = false;
997
+ state.foundFullWidth = false;
998
+ const output = this.outputNested(ast, state);
999
+
1000
+ // In Jipt-land, we need to render the exact same outer
1001
+ // QuestionParagraph nodes always. This means the number of
1002
+ // paragraphs needs to stay the same, and we can't modify
1003
+ // the classnames on the QuestionParagraphs or we'll destroy
1004
+ // the crowdin classnames. So we just only use the
1005
+ // 'paragraph' classname from the QuestionParagraph.
1006
+ // If this becomes a problem it would be easy to fix by wrapping
1007
+ // the nodes in an extra layer (hopefully only for jipt) that
1008
+ // handles the jipt classnames, and let this layer handle the
1009
+ // dynamic classnames.
1010
+ // We can't render the classes the first time and leave them
1011
+ // the same because we don't know at the time of the first
1012
+ // render whether they are full-bleed or centered, since they
1013
+ // only contain crowdin IDs like `crwdns:972384209:0...`
1014
+ let className;
1015
+ if (this.translationIndex != null) {
1016
+ className = null;
1017
+ } else {
1018
+ className = classNames({
1019
+ "perseus-paragraph-centered": !this._foundTextNodes,
1020
+ // There is only one node being rendered,
1021
+ // and it's a full-width widget.
1022
+ "perseus-paragraph-full-width":
1023
+ state.foundFullWidth && ast.content.length === 1,
1024
+ });
1025
+ }
1026
+
1027
+ return (
1028
+ <QuestionParagraph
1029
+ key={state.key}
1030
+ className={className}
1031
+ translationIndex={this.translationIndex}
1032
+ paragraphIndex={state.paragraphIndex}
1033
+ >
1034
+ <ErrorBoundary>{output}</ErrorBoundary>
1035
+ </QuestionParagraph>
1036
+ );
1037
+ };
1038
+
1039
+ // output non-top-level nodes or arrays
1040
+ outputNested: (ast: any, state: WidgetState) => React.Node = (
1041
+ ast: any,
1042
+ state: WidgetState,
1043
+ ) => {
1044
+ if (_.isArray(ast)) {
1045
+ // This is duplicated from simple-markdown
1046
+ // TODO(aria): Don't duplicate this logic
1047
+ const oldKey = state.key;
1048
+ const result = [];
1049
+
1050
+ // map nestedOutput over the ast, except group any text
1051
+ // nodes together into a single string output.
1052
+ let lastWasString = false;
1053
+ for (let i = 0; i < ast.length; i++) {
1054
+ state.key = i;
1055
+ const nodeOut = this.outputNested(ast[i], state);
1056
+ const isString = typeof nodeOut === "string";
1057
+ if (typeof nodeOut === "string" && lastWasString) {
1058
+ /**
1059
+ * We know that last was string, but Flow can't see this
1060
+ * refinement.
1061
+ */
1062
+ // $FlowIgnore[incompatible-type]
1063
+ result[result.length - 1] += nodeOut;
1064
+ } else {
1065
+ result.push(nodeOut);
1066
+ }
1067
+ lastWasString = isString;
1068
+ }
1069
+
1070
+ state.key = oldKey;
1071
+ return result;
1072
+ }
1073
+ return this.outputNode(ast, this.outputNested, state);
1074
+ };
1075
+
1076
+ // output individual AST nodes [not arrays]
1077
+ outputNode: (
1078
+ node: any,
1079
+ nestedOutput: any,
1080
+ state: WidgetState,
1081
+ ) =>
1082
+ | any
1083
+ | null
1084
+ | React.Element<"div">
1085
+ | React.Element<"span">
1086
+ | React.Node = (node: any, nestedOutput: any, state: WidgetState) => {
1087
+ const apiOptions = this.getApiOptions();
1088
+ const imagePlaceholder = apiOptions.imagePlaceholder;
1089
+
1090
+ if (node.type === "widget") {
1091
+ const widgetPlaceholder = apiOptions.widgetPlaceholder;
1092
+
1093
+ if (widgetPlaceholder) {
1094
+ return widgetPlaceholder;
1095
+ }
1096
+ // Widgets can contain text nodes, so we don't center them with
1097
+ // markdown magic here.
1098
+ // Instead, we center them with css magic in articles.less
1099
+ // /cry(aria)
1100
+ this._foundTextNodes = true;
1101
+
1102
+ if (_.contains(this.widgetIds, node.id)) {
1103
+ // We don't want to render a duplicate widget key/ref,
1104
+ // as this causes problems with react (for obvious
1105
+ // reasons). Instead we just notify the
1106
+ // hopefully-content-creator that they need to change the
1107
+ // widget id.
1108
+ return (
1109
+ <span key={state.key} className="renderer-widget-error">
1110
+ {[
1111
+ "Widget [[",
1112
+ "☃",
1113
+ " ",
1114
+ node.id,
1115
+ "]] already exists.",
1116
+ ].join("")}
1117
+ </span>
1118
+ );
1119
+ }
1120
+ this.widgetIds.push(node.id);
1121
+ return this.renderWidget(node.widgetType, node.id, state);
1122
+ }
1123
+ if (node.type === "blockMath") {
1124
+ // We render math here instead of in perseus-markdown.jsx
1125
+ // because we need to pass it our onRender callback.
1126
+ const content = preprocessTex(node.content);
1127
+
1128
+ const innerStyle = {
1129
+ // HACK(benkomalo): we only want horizontal scrolling, but
1130
+ // overflowX: 'auto' causes a vertical scrolling scrollbar
1131
+ // as well, despite the parent and child elements having
1132
+ // the exact same height. Force it to not scroll by
1133
+ // applying overflowY: 'hidden'
1134
+ overflowX: "auto",
1135
+ overflowY: "hidden",
1136
+
1137
+ // HACK(kevinb): overflowY: 'hidden' inadvertently clips the
1138
+ // top and bottom of some fractions. We add padding to the
1139
+ // top and bottom to avoid the clipping and then correct for
1140
+ // the padding by adding equal but opposite margins.
1141
+ paddingTop: 10,
1142
+ paddingBottom: 10,
1143
+ marginTop: -10,
1144
+ marginBottom: -10,
1145
+ };
1146
+
1147
+ if (apiOptions.isMobile) {
1148
+ // The style for the body of articles and exercises on mobile is
1149
+ // to have a 16px margin. When a user taps to zoom math we'd
1150
+ // like the math to extend all the way to the edge of the page/
1151
+ // To achieve this affect we nest the Zoomable component in two
1152
+ // nested divs. The outer div has a negative margin to
1153
+ // counteract the margin on main perseus container. The inner
1154
+ // div adds the margin back as padding so that when the math is
1155
+ // scaled out it's inset from the edge of the page. When the
1156
+ // TeX component is full size it will extend to the edge of the
1157
+ // page if it's larger than the page.
1158
+ //
1159
+ // TODO(kevinb) automatically determine the margin size
1160
+ const margin = 16;
1161
+ const outerStyle = {
1162
+ marginLeft: -margin,
1163
+ marginRight: -margin,
1164
+ };
1165
+ const horizontalPadding = {
1166
+ paddingLeft: margin,
1167
+ paddingRight: margin,
1168
+ };
1169
+
1170
+ const mobileInnerStyle = {
1171
+ ...innerStyle,
1172
+ ...styles.mobileZoomableParentFix,
1173
+ };
1174
+
1175
+ return (
1176
+ <div
1177
+ key={state.key}
1178
+ className="perseus-block-math"
1179
+ style={outerStyle}
1180
+ >
1181
+ <ErrorBoundary>
1182
+ <div
1183
+ className="perseus-block-math-inner"
1184
+ style={{
1185
+ ...mobileInnerStyle,
1186
+ ...horizontalPadding,
1187
+ }}
1188
+ >
1189
+ <ZoomableTeX>{content}</ZoomableTeX>
1190
+ </div>
1191
+ </ErrorBoundary>
1192
+ </div>
1193
+ );
1194
+ }
1195
+ return (
1196
+ <div key={state.key} className="perseus-block-math">
1197
+ <ErrorBoundary>
1198
+ <div
1199
+ className="perseus-block-math-inner"
1200
+ style={innerStyle}
1201
+ >
1202
+ <AssetContext.Consumer>
1203
+ {({setAssetStatus}) => (
1204
+ <TeX setAssetStatus={setAssetStatus}>
1205
+ {content}
1206
+ </TeX>
1207
+ )}
1208
+ </AssetContext.Consumer>
1209
+ </div>
1210
+ </ErrorBoundary>
1211
+ </div>
1212
+ );
1213
+ }
1214
+ if (node.type === "math") {
1215
+ // Replace uses of \begin{align}...\end{align} which KaTeX doesn't
1216
+ // support (yet) with \begin{aligned}...\end{aligned} which renders
1217
+ // the same is supported by KaTeX. It does the same for align*.
1218
+ // TODO(kevinb) update content to use aligned instead of align.
1219
+ const tex = node.content.replace(/\{align[*]?\}/g, "{aligned}");
1220
+
1221
+ // We render math here instead of in perseus-markdown.jsx
1222
+ // because we need to pass it our onRender callback.
1223
+ return (
1224
+ <span
1225
+ key={state.key}
1226
+ style={{
1227
+ // If math is directly next to text, don't let it
1228
+ // wrap to the next line
1229
+ whiteSpace: "nowrap",
1230
+ }}
1231
+ >
1232
+ <ErrorBoundary>
1233
+ {/* We add extra empty spans around the math to make it not
1234
+ wrap (I don't know why this works, but it does) */}
1235
+ <span />
1236
+ <AssetContext.Consumer>
1237
+ {({setAssetStatus}) => (
1238
+ <TeX
1239
+ onRender={this.props.onRender}
1240
+ setAssetStatus={setAssetStatus}
1241
+ >
1242
+ {tex}
1243
+ </TeX>
1244
+ )}
1245
+ </AssetContext.Consumer>
1246
+ <span />
1247
+ </ErrorBoundary>
1248
+ </span>
1249
+ );
1250
+ }
1251
+ if (node.type === "image") {
1252
+ if (imagePlaceholder) {
1253
+ return imagePlaceholder;
1254
+ }
1255
+
1256
+ // We need to add width and height to images from our
1257
+ // props.images mapping.
1258
+
1259
+ // We do a _.has check here to avoid weird things like
1260
+ // 'toString' or '__proto__' as a url.
1261
+ const extraAttrs = _.has(this.props.images, node.target)
1262
+ ? this.props.images[node.target]
1263
+ : null;
1264
+
1265
+ // The width of a table column is determined by the widest table
1266
+ // cell within that column, but responsive images constrain
1267
+ // themselves to the width of their parent containers. Thus,
1268
+ // responsive images don't do very well within tables. To avoid
1269
+ // haphazard sizing, simply make images within tables unresponsive.
1270
+ // TODO(alex): Make tables themselves responsive.
1271
+ const responsive = !state.inTable;
1272
+ return (
1273
+ <ErrorBoundary key={state.key}>
1274
+ <AssetContext.Consumer>
1275
+ {({setAssetStatus}) => (
1276
+ <SvgImage
1277
+ setAssetStatus={setAssetStatus}
1278
+ /* $FlowFixMe[incompatible-type]: sanitizeUrl() can return null */
1279
+ src={PerseusMarkdown.sanitizeUrl(node.target)}
1280
+ alt={node.alt}
1281
+ title={node.title}
1282
+ responsive={responsive}
1283
+ onUpdate={this.props.onRender}
1284
+ zoomToFullSizeOnMobile={
1285
+ apiOptions.isMobile && apiOptions.isArticle
1286
+ }
1287
+ {...extraAttrs}
1288
+ />
1289
+ )}
1290
+ </AssetContext.Consumer>
1291
+ </ErrorBoundary>
1292
+ );
1293
+ }
1294
+ if (node.type === "columns") {
1295
+ // Note that we have two columns. This is so we can put
1296
+ // a className on the outer renderer content for SAT.
1297
+ // TODO(aria): See if there is a better way we can do
1298
+ // things like this
1299
+ this._isTwoColumn = true;
1300
+ // but then render normally:
1301
+ return (
1302
+ <ErrorBoundary key={state.key}>
1303
+ {PerseusMarkdown.ruleOutput(node, nestedOutput, state)}
1304
+ </ErrorBoundary>
1305
+ );
1306
+ }
1307
+ if (node.type === "text") {
1308
+ if (rContainsNonWhitespace.test(node.content)) {
1309
+ this._foundTextNodes = true;
1310
+ }
1311
+
1312
+ // Used by the translator portal to replace image URLs with
1313
+ // placeholders, see preprocessWidgets in manticore-utils.js
1314
+ // for more details.
1315
+ if (imagePlaceholder && rImageURL.test(node.content)) {
1316
+ return imagePlaceholder;
1317
+ }
1318
+ return node.content;
1319
+ }
1320
+ if (node.type === "table" || node.type === "titledTable") {
1321
+ const output = PerseusMarkdown.ruleOutput(node, nestedOutput, {
1322
+ ...state,
1323
+ isMobile: apiOptions.isMobile,
1324
+ inTable: true,
1325
+ });
1326
+
1327
+ if (!apiOptions.isMobile) {
1328
+ return output;
1329
+ }
1330
+
1331
+ const margin = 16;
1332
+ const outerStyle = {
1333
+ marginLeft: -margin,
1334
+ marginRight: -margin,
1335
+ };
1336
+ const innerStyle = {
1337
+ paddingLeft: 0,
1338
+ paddingRight: 0,
1339
+ };
1340
+ const mobileInnerStyle = {
1341
+ ...innerStyle,
1342
+ ...styles.mobileZoomableParentFix,
1343
+ };
1344
+
1345
+ const wrappedOutput = (
1346
+ <div style={{...mobileInnerStyle, overflowX: "auto"}}>
1347
+ <ErrorBoundary>
1348
+ <Zoomable animateHeight={true}>{output}</Zoomable>
1349
+ </ErrorBoundary>
1350
+ </div>
1351
+ );
1352
+
1353
+ // TODO(benkomalo): how should we deal with tappable items inside
1354
+ // of tables?
1355
+ return <div style={outerStyle}>{wrappedOutput}</div>;
1356
+ }
1357
+ // If it's a "normal" or "simple" markdown node, just
1358
+ // output it using its output rule.
1359
+ return (
1360
+ <ErrorBoundary key={state.key}>
1361
+ {PerseusMarkdown.ruleOutput(node, nestedOutput, state)}
1362
+ </ErrorBoundary>
1363
+ );
1364
+ };
1365
+
1366
+ handleRender: (prevProps: Props) => void = (prevProps: Props) => {
1367
+ const onRender = this.props.onRender;
1368
+ const oldOnRender = prevProps.onRender;
1369
+
1370
+ // In the common case of no callback specified, avoid this work.
1371
+ if (onRender !== noopOnRender || oldOnRender !== noopOnRender) {
1372
+ const $images = $(ReactDOM.findDOMNode(this)).find("img");
1373
+
1374
+ // Fire callback on image load...
1375
+ if (oldOnRender !== noopOnRender) {
1376
+ $images.off("load", oldOnRender);
1377
+ }
1378
+
1379
+ if (onRender !== noopOnRender) {
1380
+ $images.on("load", onRender);
1381
+ }
1382
+ }
1383
+
1384
+ // ...as well as right now (non-image, non-TeX or image from cache)
1385
+ onRender();
1386
+ };
1387
+
1388
+ // Sets the current focus path
1389
+ // If the new focus path is not a prefix of the old focus path,
1390
+ // we send an onChangeFocus event back to our parent.
1391
+ _setCurrentFocus: (path: FocusPath) => void = (path: FocusPath) => {
1392
+ const apiOptions = this.getApiOptions();
1393
+
1394
+ // We don't do this when the new path is a prefix because
1395
+ // that prefix is already focused (we're just in a more specific
1396
+ // area of it). This makes it safe to call _setCurrentFocus
1397
+ // whenever a widget is interacted with--we won't wipe out
1398
+ // our focus state if we are already focused on a subpart
1399
+ // of that widget (i.e. a transformation NumberInput inside
1400
+ // of a transformer widget).
1401
+ if (!isIdPathPrefix(path, this._currentFocus)) {
1402
+ const prevFocus = this._currentFocus;
1403
+
1404
+ if (prevFocus) {
1405
+ this.blurPath(prevFocus);
1406
+ }
1407
+
1408
+ this._currentFocus = path;
1409
+ apiOptions.onFocusChange(this._currentFocus, prevFocus);
1410
+ }
1411
+ };
1412
+
1413
+ focus: () => ?boolean = () => {
1414
+ let id;
1415
+ let focusResult;
1416
+ for (let i = 0; i < this.widgetIds.length; i++) {
1417
+ const widgetId = this.widgetIds[i];
1418
+ const widget = this.getWidgetInstance(widgetId);
1419
+ const widgetFocusResult = widget && widget.focus && widget.focus();
1420
+ if (widgetFocusResult) {
1421
+ id = widgetId;
1422
+ focusResult = widgetFocusResult;
1423
+ break;
1424
+ }
1425
+ }
1426
+
1427
+ if (id) {
1428
+ // reconstruct a {path, element} focus object
1429
+ let path;
1430
+ if (typeof focusResult === "object") {
1431
+ // TODO(jeremy): I am 99% sure this path is no longer possible.
1432
+ // In D10274, focus management sometimes returned an object
1433
+ // with a `path` and `element` key. But later in D11387 and
1434
+ // D13664 things have been changed and seemingly removed the
1435
+ // object return value.
1436
+ // The result of focus was a {path, id} object itself
1437
+ path = [id].concat(focusResult.path || []);
1438
+ Log.error(
1439
+ "Renderer received a focus result of type 'object' " +
1440
+ "instead of the expected type 'boolean'",
1441
+ Errors.Internal,
1442
+ {
1443
+ loggedMetadata: {
1444
+ focusResult: JSON.stringify(focusResult),
1445
+ currentProps: JSON.stringify(
1446
+ this.state.widgetProps,
1447
+ ),
1448
+ },
1449
+ },
1450
+ );
1451
+ } else {
1452
+ // The result of focus was true or the like; just
1453
+ // construct a root focus object
1454
+ path = [id];
1455
+ }
1456
+
1457
+ this._setCurrentFocus(path);
1458
+ return true;
1459
+ }
1460
+ };
1461
+
1462
+ getDOMNodeForPath: (path: FocusPath) => ?(Element | Text) = (
1463
+ path: FocusPath,
1464
+ ) => {
1465
+ const widgetId = _.first(path);
1466
+ const interWidgetPath = _.rest(path);
1467
+
1468
+ // Widget handles parsing of the interWidgetPath. If the path is empty
1469
+ // beyond the widgetID, as a special case we just return the widget's
1470
+ // DOM node.
1471
+ const widget = this.getWidgetInstance(widgetId);
1472
+ const getNode = widget && widget.getDOMNodeForPath;
1473
+ if (getNode) {
1474
+ return getNode(interWidgetPath);
1475
+ }
1476
+ if (interWidgetPath.length === 0) {
1477
+ // $FlowFixMe[incompatible-call]: make Widget a ReactInstance type
1478
+ return ReactDOM.findDOMNode(widget);
1479
+ }
1480
+ };
1481
+
1482
+ getGrammarTypeForPath: (path: FocusPath) => ?string = (path: FocusPath) => {
1483
+ const widgetId = _.first(path);
1484
+ const interWidgetPath = _.rest(path);
1485
+
1486
+ const widget = this.getWidgetInstance(widgetId);
1487
+ if (widget && widget.getGrammarTypeForPath) {
1488
+ return widget.getGrammarTypeForPath(interWidgetPath);
1489
+ }
1490
+ };
1491
+
1492
+ getInputPaths: () => $ReadOnlyArray<FocusPath> = () => {
1493
+ const inputPaths: Array<FocusPath> = [];
1494
+ _.each(this.widgetIds, (widgetId: string) => {
1495
+ const widget = this.getWidgetInstance(widgetId);
1496
+ if (widget && widget.getInputPaths) {
1497
+ // Grab all input paths and add widgetID to the front
1498
+ const widgetInputPaths = widget.getInputPaths();
1499
+ // Prefix paths with their widgetID and add to collective
1500
+ // list of paths.
1501
+ _.each(widgetInputPaths, (inputPath: string) => {
1502
+ const relativeInputPath = [widgetId].concat(inputPath);
1503
+ inputPaths.push(relativeInputPath);
1504
+ });
1505
+ }
1506
+ });
1507
+
1508
+ return inputPaths;
1509
+ };
1510
+
1511
+ focusPath: (path: FocusPath) => void = (path: FocusPath) => {
1512
+ // No need to focus if it's already focused
1513
+ if (_.isEqual(this._currentFocus, path)) {
1514
+ return;
1515
+ }
1516
+ if (this._currentFocus) {
1517
+ // Unfocus old path, if exists
1518
+ this.blurPath(this._currentFocus);
1519
+ }
1520
+
1521
+ const widgetId = _.first(path);
1522
+ const interWidgetPath = _.rest(path);
1523
+
1524
+ // Widget handles parsing of the interWidgetPath
1525
+ const focusWidget = this.getWidgetInstance(widgetId);
1526
+ if (focusWidget && focusWidget.focusInputPath) {
1527
+ focusWidget.focusInputPath(interWidgetPath);
1528
+ }
1529
+ };
1530
+
1531
+ blurPath: (path: FocusPath) => void = (path: FocusPath) => {
1532
+ // No need to blur if it's not focused
1533
+ if (!_.isEqual(this._currentFocus, path)) {
1534
+ return;
1535
+ }
1536
+
1537
+ const widgetId = _.first(path);
1538
+ const interWidgetPath = _.rest(path);
1539
+ const widget = this.getWidgetInstance(widgetId);
1540
+ // We might be in the editor and blurring a widget that no
1541
+ // longer exists, so only blur if we actually found the widget
1542
+ if (widget) {
1543
+ const blurWidget = this.getWidgetInstance(widgetId);
1544
+ if (blurWidget && blurWidget.blurInputPath) {
1545
+ // Widget handles parsing of the interWidgetPath
1546
+ blurWidget.blurInputPath(interWidgetPath);
1547
+ }
1548
+ }
1549
+ };
1550
+
1551
+ blur: () => void = () => {
1552
+ if (this._currentFocus) {
1553
+ this.blurPath(this._currentFocus);
1554
+ }
1555
+ };
1556
+
1557
+ // Serializes widget state. Seems to be used only by editors though.
1558
+ serialize: () => {...} = () => {
1559
+ const state = {};
1560
+ _.each(
1561
+ this.state.widgetInfo,
1562
+ function (info, id) {
1563
+ // eslint-disable-next-line @babel/no-invalid-this
1564
+ const widget = this.getWidgetInstance(id);
1565
+ const s = widget.serialize();
1566
+ if (!_.isEmpty(s)) {
1567
+ state[id] = s;
1568
+ }
1569
+ },
1570
+ this,
1571
+ );
1572
+ return state;
1573
+ };
1574
+
1575
+ emptyWidgets: () => any = () => {
1576
+ return _.filter(this.widgetIds, (id) => {
1577
+ const widgetInfo = this._getWidgetInfo(id);
1578
+ if (widgetInfo.static) {
1579
+ // Static widgets shouldn't count as empty
1580
+ return false;
1581
+ }
1582
+ const widget = this.getWidgetInstance(id);
1583
+ if (widget && widget.simpleValidate) {
1584
+ const score: PerseusScore = widget.simpleValidate(
1585
+ widgetInfo.options,
1586
+ null,
1587
+ );
1588
+ return Util.scoreIsEmpty(score);
1589
+ }
1590
+ });
1591
+ };
1592
+
1593
+ _setWidgetProps: SetWidgetPropsFn = (id, newProps, cb, silent) => {
1594
+ this.setState(
1595
+ (prevState) => {
1596
+ const widgetProps = {
1597
+ ...prevState.widgetProps,
1598
+ [id]: {
1599
+ ...prevState.widgetProps[id],
1600
+ ...newProps,
1601
+ },
1602
+ };
1603
+
1604
+ // Update the `lastUsedWidgetId` to this widget - unless we're
1605
+ // in silent mode. We only want to track the last widget that
1606
+ // was actually _used_, and silent updates generally don't come
1607
+ // from _usage_.
1608
+ const lastUsedWidgetId = silent
1609
+ ? prevState.lastUsedWidgetId
1610
+ : id;
1611
+
1612
+ if (!silent) {
1613
+ this.props.onSerializedStateUpdated(
1614
+ this.getSerializedState(widgetProps),
1615
+ );
1616
+ }
1617
+
1618
+ return {
1619
+ lastUsedWidgetId,
1620
+ widgetProps,
1621
+ };
1622
+ },
1623
+ () => {
1624
+ // Wait until all components have rendered. In React 16 setState
1625
+ // callback fires immediately after this componentDidUpdate, and
1626
+ // there is no guarantee that parent/siblings components have
1627
+ // finished rendering.
1628
+ // TODO(jeff, CP-3128): Use Wonder Blocks Timing API
1629
+ // eslint-disable-next-line no-restricted-syntax
1630
+ setTimeout(() => {
1631
+ const cbResult = cb && cb();
1632
+ if (!silent) {
1633
+ this.props.onInteractWithWidget(id);
1634
+ }
1635
+ if (cbResult !== false) {
1636
+ // TODO(jack): For some reason, some widgets don't always
1637
+ // end up in refs here, which is repro-able if you make an
1638
+ // [[ orderer 1 ]] and copy-paste this, then change it to
1639
+ // be an [[ orderer 2 ]]. The resulting Renderer ends up
1640
+ // with an "orderer 2" ref but not an "orderer 1" ref.
1641
+ // @_@??
1642
+ // TODO(jack): Figure out why this is happening and fix it
1643
+ // As far as I can tell, this is only an issue in the
1644
+ // editor-page, so doing this shouldn't break clients
1645
+ // hopefully
1646
+ this._setCurrentFocus([id]);
1647
+ }
1648
+ }, 0);
1649
+ },
1650
+ );
1651
+ };
1652
+
1653
+ setInputValue: (
1654
+ path: FocusPath,
1655
+ newValue: string,
1656
+ focus: () => mixed,
1657
+ ) => void = (path, newValue, focus) => {
1658
+ const widgetId = _.first(path);
1659
+ const interWidgetPath = _.rest(path);
1660
+ const widget = this.getWidgetInstance(widgetId);
1661
+
1662
+ // Widget handles parsing of the interWidgetPath.
1663
+ widget?.setInputValue?.(interWidgetPath, newValue, focus);
1664
+ };
1665
+
1666
+ /**
1667
+ * Returns an array of the widget `.getUserInput()` results
1668
+ */
1669
+ getUserInput: () => $ReadOnlyArray<?WidgetUserInput> = () => {
1670
+ return this.widgetIds.map((id: string) => {
1671
+ const widget = this.getWidgetInstance(id);
1672
+ if (widget && widget.getUserInput) {
1673
+ // TODO(Jeremy): Add the widget ID in here so we can more
1674
+ // easily correlate it to the widget state.
1675
+ return widget.getUserInput();
1676
+ }
1677
+ });
1678
+ };
1679
+
1680
+ /**
1681
+ * Returns an array of all widget IDs in the order they occur in
1682
+ * the content.
1683
+ */
1684
+ getWidgetIds: () => $ReadOnlyArray<string> = () => {
1685
+ return this.widgetIds;
1686
+ };
1687
+
1688
+ /**
1689
+ * Returns the result of `.getUserInput()` for each widget, in
1690
+ * a map from widgetId to userInput.
1691
+ * NOTE(jeremy): This function is hauntingly similar to `getUserInput` with
1692
+ * the major difference being that this function returns a map of
1693
+ * `widgetID` => UserInput and `getUserInput` simply returns an array. It
1694
+ * would be trivial to map between the results of each of these functions,
1695
+ * so we should aim to remove one of these functions.
1696
+ */
1697
+ getUserInputForWidgets: () => {[widgetId: string]: ?WidgetUserInput} =
1698
+ () => {
1699
+ return mapObjectFromArray(this.widgetIds, (id) => {
1700
+ const widget = this.getWidgetInstance(id);
1701
+ if (widget && widget.getUserInput) {
1702
+ return widget.getUserInput();
1703
+ }
1704
+ });
1705
+ };
1706
+
1707
+ /**
1708
+ * Returns an object mapping from widget ID to perseus-style score.
1709
+ * The keys of this object are the values of the array returned
1710
+ * from `getWidgetIds`.
1711
+ */
1712
+ scoreWidgets: () => {[widgetId: string]: PerseusScore} = () => {
1713
+ const widgetProps = this.state.widgetInfo;
1714
+ const onInputError = this.getApiOptions().onInputError;
1715
+
1716
+ const gradedWidgetIds = _.filter(this.widgetIds, (id) => {
1717
+ const props = widgetProps[id];
1718
+ const widgetIsGraded: boolean =
1719
+ props?.graded == null || props.graded;
1720
+ const widgetIsStatic: boolean = !!props?.static;
1721
+ // Ungraded widgets or widgets set to static shouldn't be graded.
1722
+ return widgetIsGraded && !widgetIsStatic;
1723
+ });
1724
+
1725
+ const widgetScores = {};
1726
+ _.each(gradedWidgetIds, (id) => {
1727
+ const props = widgetProps[id];
1728
+ const widget = this.getWidgetInstance(id);
1729
+ // widget can be undefined if it hasn't yet been rendered
1730
+ if (widget && widget.simpleValidate) {
1731
+ widgetScores[id] = widget.simpleValidate(
1732
+ props?.options,
1733
+ onInputError,
1734
+ );
1735
+ }
1736
+ });
1737
+
1738
+ return widgetScores;
1739
+ };
1740
+
1741
+ /**
1742
+ * Grades the content.
1743
+ */
1744
+ score: () => PerseusScore = () => {
1745
+ return _.reduce(this.scoreWidgets(), Util.combineScores, Util.noScore);
1746
+ };
1747
+
1748
+ guessAndScore: () => [$FlowFixMe, PerseusScore] = () => {
1749
+ const totalGuess = this.getUserInput();
1750
+ const totalScore = this.score();
1751
+
1752
+ return [totalGuess, totalScore];
1753
+ };
1754
+
1755
+ examples: () => ?$ReadOnlyArray<string> = () => {
1756
+ const widgetIds = this.widgetIds;
1757
+ const examples = _.compact(
1758
+ _.map(widgetIds, (widgetId) => {
1759
+ const widget = this.getWidgetInstance(widgetId);
1760
+ return widget != null && widget.examples
1761
+ ? widget.examples()
1762
+ : null;
1763
+ }),
1764
+ );
1765
+
1766
+ // no widgets with examples
1767
+ if (!examples.length) {
1768
+ return null;
1769
+ }
1770
+
1771
+ const allEqual = _.all(examples, function (example) {
1772
+ return _.isEqual(examples[0], example);
1773
+ });
1774
+
1775
+ // some widgets have different examples
1776
+ // TODO(alex): handle this better
1777
+ if (!allEqual) {
1778
+ return null;
1779
+ }
1780
+
1781
+ return examples[0];
1782
+ };
1783
+
1784
+ // NotGorgon callback
1785
+ handleNotGorgonLintErrors: (lintErrors: $ReadOnlyArray<string>) => void = (
1786
+ lintErrors: $ReadOnlyArray<string>,
1787
+ ) => {
1788
+ if (!this._isMounted) {
1789
+ return;
1790
+ }
1791
+
1792
+ this.setState({
1793
+ notGorgonLintErrors: lintErrors,
1794
+ });
1795
+ };
1796
+
1797
+ render(): React.Node {
1798
+ const apiOptions = this.getApiOptions();
1799
+ const {KatexProvider} = getDependencies();
1800
+
1801
+ if (this.reuseMarkdown) {
1802
+ return this.lastRenderedMarkdown;
1803
+ }
1804
+
1805
+ const content = this.getContent(this.props, this.state);
1806
+ // `this.widgetIds` is appended to in `this.outputMarkdown`:
1807
+ this.widgetIds = [];
1808
+
1809
+ if (this.shouldRenderJiptPlaceholder(this.props, this.state)) {
1810
+ // Crowdin's JIPT (Just in place translation) uses a fake language
1811
+ // with language tag "en-pt" where the value of the translations
1812
+ // look like: {crwdns2657085:0}{crwdne2657085:0} where it keeps the
1813
+ // {crowdinId:ngettext variant}. We detect whether the current
1814
+ // content matches this, so we can take over rendering of
1815
+ // the perseus content as the translators interact with jipt.
1816
+ // We search for only part of the tag that crowdin uses to guard
1817
+ // against them changing the format on us. The full tag it looks
1818
+ // for can be found in https://cdn.crowdin.net/jipt/jipt.js
1819
+ // globalPhrase var.
1820
+
1821
+ // If we haven't already added this component to the registry do so
1822
+ // now. showHints() may cause this component to be rerendered
1823
+ // before jipt has a chance to replace its contents, so this check
1824
+ // will keep us from adding the component to the registry a second
1825
+ // time.
1826
+ if (!this.translationIndex) {
1827
+ this.translationIndex =
1828
+ getDependencies().rendererTranslationComponents.addComponent(
1829
+ this,
1830
+ );
1831
+ }
1832
+
1833
+ // For articles, we add jipt data to individual paragraphs. For
1834
+ // exercises, we add it to the renderer and let translators
1835
+ // translate the entire thing. For the article equivalent of
1836
+ // this if block, search this file for where we render a
1837
+ // QuestionParagraph, and see the `isJipt:` parameter sent to
1838
+ // PerseusMarkdown.parse()
1839
+ if (!apiOptions.isArticle) {
1840
+ // We now need to output this tag, as jipt looks for it to be
1841
+ // able to replace it with a translation that it runs an ajax
1842
+ // call to get. We add a data attribute with the index to the
1843
+ // Persues.TranslationComponent registry so that when jipt
1844
+ // calls its before_dom_insert we can lookup this component by
1845
+ // this attribute and render the text with markdown.
1846
+ return (
1847
+ <KatexProvider>
1848
+ <div
1849
+ data-perseus-component-index={this.translationIndex}
1850
+ >
1851
+ {content}
1852
+ </div>
1853
+ </KatexProvider>
1854
+ );
1855
+ }
1856
+ }
1857
+
1858
+ // Hacks:
1859
+ // We use mutable state here to figure out whether the output
1860
+ // had two columns.
1861
+ // It is updated to true by `this.outputMarkdown` if a
1862
+ // column break is found
1863
+ // TODO(aria): We now have a state variable threaded through
1864
+ // simple-markdown output. We should mutate it instead of
1865
+ // state on this component to do this in a less hacky way.
1866
+ this._isTwoColumn = false;
1867
+
1868
+ // Parse the string of markdown to a parse tree
1869
+ const parsedMarkdown = PerseusMarkdown.parse(content, {
1870
+ // Recognize crowdin IDs while translating articles
1871
+ // (This should never be hit by exercises, though if you
1872
+ // decide you want to add a check that this is an article,
1873
+ // go for it.)
1874
+ isJipt: this.translationIndex != null,
1875
+ });
1876
+
1877
+ // Optionally apply the linter to the parse tree
1878
+ if (this.props.linterContext.highlightLint) {
1879
+ // If highlightLint is true and lint is detected, this call
1880
+ // will modify the parse tree by adding lint nodes that will
1881
+ // serve to highlight the lint when rendered
1882
+ // $FlowFixMe[cannot-spread-inexact]
1883
+ const context: Context = {
1884
+ content: this.props.content,
1885
+ widgets: this.props.widgets,
1886
+ ...this.props.linterContext,
1887
+ };
1888
+
1889
+ Gorgon.runLinter(parsedMarkdown, context, true);
1890
+
1891
+ // Apply the lint errors from the last NotGorgon run.
1892
+ // TODO(joshuan): Support overlapping dots.
1893
+ this._notGorgon.applyLintErrors(parsedMarkdown, [
1894
+ ...this.state.notGorgonLintErrors,
1895
+ ...(this.props.legacyPerseusLint || []),
1896
+ ]);
1897
+ }
1898
+
1899
+ // Render the linted markdown parse tree with React components
1900
+ const markdownContents = this.outputMarkdown(parsedMarkdown, {
1901
+ baseElements: apiOptions.baseElements,
1902
+ });
1903
+
1904
+ const className = classNames({
1905
+ [ApiClassNames.RENDERER]: true,
1906
+ [ApiClassNames.RESPONSIVE_RENDERER]: true,
1907
+ [ApiClassNames.TWO_COLUMN_RENDERER]: this._isTwoColumn,
1908
+ });
1909
+
1910
+ this.lastRenderedMarkdown = (
1911
+ <KatexProvider>
1912
+ <div className={className}>{markdownContents}</div>
1913
+ </KatexProvider>
1914
+ );
1915
+ return this.lastRenderedMarkdown;
1916
+ }
1917
+ }
1918
+
1919
+ const styles = {
1920
+ mobileZoomableParentFix: {
1921
+ // NOTE(abdul): There is an issue where transform animations will
1922
+ // cause the Zoomable component to disappear when running on the
1923
+ // native app on iPad (iOS 13). I found some answers online that recommend
1924
+ // transforming the parent in 3D space. Doing this forces hardware
1925
+ // acceleration, which causes the process to run on the GPU. It's not
1926
+ // clear to me why this fixes the issue, but it's suggested online
1927
+ // to people dealing with similar disappearance and flickering issues.
1928
+ transform: "translate3d(0,0,0)",
1929
+ },
1930
+ };
1931
+
1932
+ export default Renderer;