cx 26.0.12 → 26.0.13

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 (363) hide show
  1. package/build/charts/ScatterGraph.d.ts +4 -4
  2. package/build/charts/ScatterGraph.js +2 -2
  3. package/build/data/ArrayElementView.spec.d.ts +1 -0
  4. package/build/data/ArrayElementView.spec.js +81 -0
  5. package/build/data/Binding.spec.d.ts +1 -0
  6. package/build/data/Binding.spec.js +61 -0
  7. package/build/data/Expression.spec.d.ts +1 -0
  8. package/build/data/Expression.spec.js +196 -0
  9. package/build/data/Grouper.spec.d.ts +1 -0
  10. package/build/data/Grouper.spec.js +48 -0
  11. package/build/data/Ref.spec.d.ts +1 -0
  12. package/build/data/Ref.spec.js +72 -0
  13. package/build/data/Selector.d.ts +1 -1
  14. package/build/data/Store.spec.d.ts +1 -0
  15. package/build/data/Store.spec.js +19 -0
  16. package/build/data/StoreRef.spec.d.ts +1 -0
  17. package/build/data/StoreRef.spec.js +22 -0
  18. package/build/data/StringTemplate.spec.d.ts +1 -0
  19. package/build/data/StringTemplate.spec.js +112 -0
  20. package/build/data/StructuredSelector.spec.d.ts +1 -0
  21. package/build/data/StructuredSelector.spec.js +102 -0
  22. package/build/data/View.spec.d.ts +1 -0
  23. package/build/data/View.spec.js +44 -0
  24. package/build/data/ZoomIntoPropertyView.spec.d.ts +1 -0
  25. package/build/data/ZoomIntoPropertyView.spec.js +54 -0
  26. package/build/data/comparer.spec.d.ts +1 -0
  27. package/build/data/comparer.spec.js +50 -0
  28. package/build/data/computable.d.ts +3 -6
  29. package/build/data/computable.spec.d.ts +1 -0
  30. package/build/data/computable.spec.js +56 -0
  31. package/build/data/createAccessorModelProxy.d.ts +5 -3
  32. package/build/data/createAccessorModelProxy.spec.d.ts +1 -0
  33. package/build/data/createAccessorModelProxy.spec.js +30 -0
  34. package/build/data/createStructuredSelector.spec.d.ts +1 -0
  35. package/build/data/createStructuredSelector.spec.js +42 -0
  36. package/build/data/diff/diffs.spec.d.ts +1 -0
  37. package/build/data/diff/diffs.spec.js +45 -0
  38. package/build/data/getAccessor.spec.d.ts +1 -0
  39. package/build/data/getAccessor.spec.js +10 -0
  40. package/build/data/getSelector.spec.d.ts +1 -0
  41. package/build/data/getSelector.spec.js +36 -0
  42. package/build/data/ops/append.spec.d.ts +1 -0
  43. package/build/data/ops/append.spec.js +24 -0
  44. package/build/data/ops/filter.spec.d.ts +1 -0
  45. package/build/data/ops/filter.spec.js +25 -0
  46. package/build/data/ops/findTreeNode.d.ts +1 -1
  47. package/build/data/ops/findTreeNode.js +1 -1
  48. package/build/data/ops/findTreeNode.spec.d.ts +1 -0
  49. package/build/data/ops/findTreeNode.spec.js +20 -0
  50. package/build/data/ops/findTreePath.d.ts +1 -1
  51. package/build/data/ops/merge.spec.d.ts +1 -0
  52. package/build/data/ops/merge.spec.js +23 -0
  53. package/build/data/ops/removeTreeNodes.d.ts +1 -1
  54. package/build/data/ops/removeTreeNodes.js +1 -1
  55. package/build/data/ops/removeTreeNodes.spec.d.ts +1 -0
  56. package/build/data/ops/removeTreeNodes.spec.js +35 -0
  57. package/build/data/ops/updateArray.spec.d.ts +1 -0
  58. package/build/data/ops/updateArray.spec.js +33 -0
  59. package/build/data/ops/updateTree.d.ts +1 -1
  60. package/build/data/ops/updateTree.spec.d.ts +1 -0
  61. package/build/data/ops/updateTree.spec.js +44 -0
  62. package/build/hooks/invokeCallback.spec.d.ts +1 -0
  63. package/build/hooks/invokeCallback.spec.js +44 -0
  64. package/build/hooks/resolveCallback.spec.d.ts +1 -0
  65. package/build/hooks/resolveCallback.spec.js +35 -0
  66. package/build/hooks/store.spec.d.ts +1 -0
  67. package/build/hooks/store.spec.js +48 -0
  68. package/build/hooks/useTrigger.spec.d.ts +1 -0
  69. package/build/hooks/useTrigger.spec.js +59 -0
  70. package/build/jsx-runtime.d.ts +10 -10
  71. package/build/jsx-runtime.js +6 -0
  72. package/build/svg/util/Rect.d.ts +1 -1
  73. package/build/ui/ContentResolver.d.ts +16 -6
  74. package/build/ui/Controller.d.ts +7 -0
  75. package/build/ui/Controller.js +2 -1
  76. package/build/ui/Controller.spec.d.ts +1 -0
  77. package/build/ui/Controller.spec.js +247 -0
  78. package/build/ui/Cx.spec.d.ts +1 -0
  79. package/build/ui/Cx.spec.js +153 -0
  80. package/build/ui/DataProxy.spec.d.ts +1 -0
  81. package/build/ui/DataProxy.spec.js +208 -0
  82. package/build/ui/Instance.d.ts +1 -1
  83. package/build/ui/Instance.js +10 -10
  84. package/build/ui/IsolatedScope.spec.d.ts +1 -0
  85. package/build/ui/IsolatedScope.spec.js +42 -0
  86. package/build/ui/Prop.d.ts +12 -1
  87. package/build/ui/PureContainer.spec.d.ts +1 -0
  88. package/build/ui/PureContainer.spec.js +149 -0
  89. package/build/ui/Repeater.d.ts +3 -3
  90. package/build/ui/Repeater.spec.d.ts +1 -0
  91. package/build/ui/Repeater.spec.js +109 -0
  92. package/build/ui/Rescope.spec.d.ts +1 -0
  93. package/build/ui/Rescope.spec.js +134 -0
  94. package/build/ui/Restate.spec.d.ts +1 -0
  95. package/build/ui/Restate.spec.js +257 -0
  96. package/build/ui/Text.d.ts +14 -2
  97. package/build/ui/Text.js +3 -0
  98. package/build/ui/adapter/ArrayAdapter.js +4 -1
  99. package/build/ui/adapter/ArrayAdapter.spec.d.ts +1 -0
  100. package/build/ui/adapter/ArrayAdapter.spec.js +44 -0
  101. package/build/ui/adapter/TreeAdapter.spec.d.ts +1 -0
  102. package/build/ui/adapter/TreeAdapter.spec.js +71 -0
  103. package/build/ui/app/Url.spec.d.ts +1 -0
  104. package/build/ui/app/Url.spec.js +43 -0
  105. package/build/ui/app/startHotAppLoop.js +1 -1
  106. package/build/ui/createFunctionalComponent.d.ts +14 -1
  107. package/build/ui/createFunctionalComponent.js +7 -4
  108. package/build/ui/createFunctionalComponent.spec.d.ts +1 -0
  109. package/build/ui/createFunctionalComponent.spec.js +272 -0
  110. package/build/ui/expr.d.ts +3 -1
  111. package/build/ui/exprHelpers.d.ts +32 -0
  112. package/build/ui/exprHelpers.js +61 -0
  113. package/build/ui/index.d.ts +1 -0
  114. package/build/ui/index.js +1 -0
  115. package/build/ui/layout/ContentPlaceholder.spec.d.ts +1 -0
  116. package/build/ui/layout/ContentPlaceholder.spec.js +333 -0
  117. package/build/ui/layout/FirstVisibleChildLayout.spec.d.ts +1 -0
  118. package/build/ui/layout/FirstVisibleChildLayout.spec.js +101 -0
  119. package/build/util/Console.d.ts +1 -0
  120. package/build/util/Console.js +7 -3
  121. package/build/util/Format.spec.d.ts +1 -0
  122. package/build/util/Format.spec.js +58 -0
  123. package/build/util/TraversalStack.spec.d.ts +1 -0
  124. package/build/util/TraversalStack.spec.js +43 -0
  125. package/build/util/date/upperBoundCheck.spec.d.ts +1 -0
  126. package/build/util/date/upperBoundCheck.spec.js +22 -0
  127. package/build/util/getSearchQueryPredicate.spec.d.ts +1 -0
  128. package/build/util/getSearchQueryPredicate.spec.js +33 -0
  129. package/build/util/isValidIdentifierName.spec.d.ts +1 -0
  130. package/build/util/isValidIdentifierName.spec.js +28 -0
  131. package/build/util/routeAppend.spec.d.ts +1 -0
  132. package/build/util/routeAppend.spec.js +14 -0
  133. package/build/widgets/AccessorBindings.spec.d.ts +1 -0
  134. package/build/widgets/AccessorBindings.spec.js +40 -0
  135. package/build/widgets/Button.d.ts +3 -6
  136. package/build/widgets/Button.js +1 -1
  137. package/build/widgets/DocumentTitle.d.ts +2 -0
  138. package/build/widgets/Heading.d.ts +2 -2
  139. package/build/widgets/HtmlElement.d.ts +31 -8
  140. package/build/widgets/HtmlElement.js +7 -9
  141. package/build/widgets/HtmlElement.spec.d.ts +1 -0
  142. package/build/widgets/HtmlElement.spec.js +38 -0
  143. package/build/widgets/Icon.d.ts +3 -13
  144. package/build/widgets/List.d.ts +4 -0
  145. package/build/widgets/ReactElementWrapper.d.ts +29 -0
  146. package/build/widgets/ReactElementWrapper.js +59 -0
  147. package/build/widgets/drag-drop/DragSource.d.ts +3 -3
  148. package/build/widgets/drag-drop/DragSource.js +2 -3
  149. package/build/widgets/drag-drop/DropZone.d.ts +3 -3
  150. package/build/widgets/drag-drop/DropZone.js +2 -3
  151. package/build/widgets/form/Checkbox.d.ts +2 -0
  152. package/build/widgets/form/ColorField.d.ts +2 -0
  153. package/build/widgets/form/DateTimeField.d.ts +2 -0
  154. package/build/widgets/form/Field.d.ts +0 -2
  155. package/build/widgets/form/LabeledContainer.d.ts +9 -8
  156. package/build/widgets/form/LabeledContainer.js +9 -9
  157. package/build/widgets/form/LookupField.d.ts +57 -9
  158. package/build/widgets/form/MonthField.d.ts +2 -0
  159. package/build/widgets/form/NumberField.d.ts +2 -0
  160. package/build/widgets/form/Radio.d.ts +2 -0
  161. package/build/widgets/form/Select.d.ts +2 -0
  162. package/build/widgets/form/Slider.d.ts +3 -0
  163. package/build/widgets/form/Switch.d.ts +2 -0
  164. package/build/widgets/form/TextField.d.ts +34 -0
  165. package/build/widgets/form/TimeList.d.ts +16 -1
  166. package/build/widgets/form/TimeList.js +34 -62
  167. package/build/widgets/form/UploadButton.d.ts +34 -2
  168. package/build/widgets/form/UploadButton.js +3 -1
  169. package/build/widgets/form/ValidationGroup.spec.d.ts +1 -0
  170. package/build/widgets/form/ValidationGroup.spec.js +62 -0
  171. package/build/widgets/form/Validator.d.ts +33 -2
  172. package/build/widgets/form/Validator.js +3 -0
  173. package/build/widgets/grid/Grid.d.ts +9 -9
  174. package/build/widgets/grid/TreeNode.d.ts +6 -0
  175. package/build/widgets/index.d.ts +1 -0
  176. package/build/widgets/index.js +1 -0
  177. package/build/widgets/nav/MenuItem.d.ts +3 -2
  178. package/build/widgets/nav/Route.spec.d.ts +1 -0
  179. package/build/widgets/nav/Route.spec.js +15 -0
  180. package/build/widgets/nav/Scroller.d.ts +4 -6
  181. package/build/widgets/nav/Scroller.js +6 -3
  182. package/build/widgets/nav/Tab.d.ts +2 -2
  183. package/build/widgets/overlay/ContextMenu.d.ts +3 -3
  184. package/build/widgets/overlay/Overlay.d.ts +2 -1
  185. package/build/widgets/overlay/Overlay.js +1 -1
  186. package/build.js +133 -133
  187. package/dist/data.js +2 -2
  188. package/dist/jsx-runtime.js +6 -1
  189. package/dist/manifest.d.ts +1443 -0
  190. package/dist/manifest.js +855 -807
  191. package/dist/ui.js +91 -5
  192. package/dist/util.js +3 -0
  193. package/dist/widgets.js +520 -161
  194. package/package.json +46 -20
  195. package/src/charts/Chart.ts +108 -108
  196. package/src/charts/ScatterGraph.tsx +6 -6
  197. package/src/data/ArrayElementView.ts +90 -90
  198. package/src/data/AugmentedViewBase.ts +88 -88
  199. package/src/data/Binding.ts +104 -104
  200. package/src/data/ExposedRecordView.ts +95 -95
  201. package/src/data/ExposedValueView.ts +89 -89
  202. package/src/data/Expression.spec.ts +229 -229
  203. package/src/data/Expression.ts +233 -233
  204. package/src/data/Grouper.spec.ts +57 -57
  205. package/src/data/Grouper.ts +158 -158
  206. package/src/data/NestedDataView.ts +43 -43
  207. package/src/data/ReadOnlyDataView.ts +39 -39
  208. package/src/data/Ref.ts +104 -104
  209. package/src/data/Selector.ts +10 -10
  210. package/src/data/Store.ts +52 -52
  211. package/src/data/StoreProxy.ts +19 -19
  212. package/src/data/StoreRef.ts +66 -66
  213. package/src/data/StringTemplate.spec.ts +132 -132
  214. package/src/data/StringTemplate.ts +93 -93
  215. package/src/data/StructuredSelector.spec.ts +113 -113
  216. package/src/data/StructuredSelector.ts +146 -146
  217. package/src/data/SubscribableView.ts +63 -63
  218. package/src/data/ZoomIntoPropertyView.spec.ts +64 -64
  219. package/src/data/ZoomIntoPropertyView.ts +45 -45
  220. package/src/data/computable.spec.ts +87 -62
  221. package/src/data/computable.ts +3 -6
  222. package/src/data/createAccessorModelProxy.spec.tsx +102 -1
  223. package/src/data/createAccessorModelProxy.ts +9 -3
  224. package/src/data/createStructuredSelector.ts +62 -62
  225. package/src/data/getAccessor.spec.ts +11 -11
  226. package/src/data/getAccessor.ts +74 -74
  227. package/src/data/getSelector.spec.ts +43 -43
  228. package/src/data/getSelector.ts +66 -66
  229. package/src/data/ops/filter.spec.ts +35 -35
  230. package/src/data/ops/filter.ts +9 -9
  231. package/src/data/ops/findTreeNode.ts +1 -5
  232. package/src/data/ops/findTreePath.ts +1 -1
  233. package/src/data/ops/merge.ts +13 -13
  234. package/src/data/ops/removeTreeNodes.spec.ts +37 -37
  235. package/src/data/ops/removeTreeNodes.ts +2 -2
  236. package/src/data/ops/updateArray.spec.ts +69 -69
  237. package/src/data/ops/updateArray.ts +31 -31
  238. package/src/data/ops/updateTree.ts +1 -1
  239. package/src/data/test-types.ts +7 -7
  240. package/src/hooks/resolveCallback.spec.tsx +30 -7
  241. package/src/hooks/useTrigger.ts +26 -26
  242. package/src/index.scss +6 -6
  243. package/src/jsx-dev-runtime.ts +4 -4
  244. package/src/jsx-runtime.spec.tsx +402 -0
  245. package/src/jsx-runtime.ts +26 -22
  246. package/src/svg/BoundedObject.ts +101 -101
  247. package/src/svg/util/Rect.ts +105 -105
  248. package/src/ui/CSSHelper.ts +17 -17
  249. package/src/ui/ContentResolver.spec.tsx +172 -19
  250. package/src/ui/ContentResolver.ts +16 -8
  251. package/src/ui/Controller.ts +15 -2
  252. package/src/ui/Culture.ts +159 -159
  253. package/src/ui/DataProxy.ts +55 -55
  254. package/src/ui/FocusManager.ts +171 -171
  255. package/src/ui/Instance.ts +866 -868
  256. package/src/ui/Prop.ts +140 -112
  257. package/src/ui/RenderingContext.ts +99 -99
  258. package/src/ui/Repeater.ts +3 -12
  259. package/src/ui/Rescope.ts +49 -49
  260. package/src/ui/StructuredInstanceDataAccessor.ts +32 -32
  261. package/src/ui/Text.ts +21 -2
  262. package/src/ui/VDOM.ts +34 -34
  263. package/src/ui/adapter/ArrayAdapter.spec.ts +55 -55
  264. package/src/ui/adapter/ArrayAdapter.ts +4 -1
  265. package/src/ui/adapter/TreeAdapter.spec.ts +76 -76
  266. package/src/ui/adapter/TreeAdapter.ts +185 -185
  267. package/src/ui/app/History.ts +133 -133
  268. package/src/ui/app/Url.spec.ts +50 -50
  269. package/src/ui/app/startHotAppLoop.ts +41 -41
  270. package/src/ui/createFunctionalComponent.spec.tsx +53 -0
  271. package/src/ui/createFunctionalComponent.ts +86 -65
  272. package/src/ui/expr.ts +4 -1
  273. package/src/ui/exprHelpers.spec.ts +379 -0
  274. package/src/ui/exprHelpers.ts +78 -0
  275. package/src/ui/index.ts +47 -46
  276. package/src/ui/layout/Content.ts +30 -30
  277. package/src/ui/layout/FirstVisibleChildLayout.spec.tsx +1 -1
  278. package/src/ui/layout/FirstVisibleChildLayout.ts +60 -60
  279. package/src/ui/selection/KeySelection.ts +153 -153
  280. package/src/ui/selection/Selection.ts +128 -128
  281. package/src/util/Console.ts +13 -11
  282. package/src/util/Format.ts +267 -267
  283. package/src/util/addEventListenerWithOptions.ts +41 -41
  284. package/src/util/browserSupportsPassiveEventHandlers.ts +20 -20
  285. package/src/util/color/rgbToHsl.ts +35 -35
  286. package/src/util/getActiveElement.ts +4 -4
  287. package/src/util/hasKey.ts +18 -18
  288. package/src/util/index.ts +55 -55
  289. package/src/util/innerTextTrim.ts +10 -10
  290. package/src/util/isArray.ts +3 -3
  291. package/src/util/isDataRecord.ts +5 -5
  292. package/src/util/isDefined.ts +3 -3
  293. package/src/util/isString.ts +3 -3
  294. package/src/widgets/AccessorBindings.spec.tsx +26 -0
  295. package/src/widgets/Button.tsx +5 -17
  296. package/src/widgets/DocumentTitle.ts +95 -92
  297. package/src/widgets/Heading.ts +2 -2
  298. package/src/widgets/HtmlElement.spec.helpers.tsx +108 -0
  299. package/src/widgets/HtmlElement.spec.tsx +20 -12
  300. package/src/widgets/HtmlElement.tsx +77 -23
  301. package/src/widgets/Icon.ts +3 -17
  302. package/src/widgets/List.tsx +6 -0
  303. package/src/widgets/ReactElementWrapper.spec.tsx +452 -0
  304. package/src/widgets/ReactElementWrapper.tsx +108 -0
  305. package/src/widgets/Sandbox.ts +103 -103
  306. package/src/widgets/autoFocus.ts +9 -9
  307. package/src/widgets/cx.ts +63 -63
  308. package/src/widgets/drag-drop/DragSource.tsx +3 -4
  309. package/src/widgets/drag-drop/DropZone.tsx +3 -4
  310. package/src/widgets/form/Checkbox.tsx +3 -0
  311. package/src/widgets/form/ColorField.tsx +3 -0
  312. package/src/widgets/form/DateTimeField.tsx +5 -0
  313. package/src/widgets/form/Field.tsx +0 -3
  314. package/src/widgets/form/Label.tsx +1 -0
  315. package/src/widgets/form/LabeledContainer.ts +22 -26
  316. package/src/widgets/form/LookupField.spec.tsx +93 -0
  317. package/src/widgets/form/LookupField.tsx +104 -9
  318. package/src/widgets/form/MonthField.tsx +5 -0
  319. package/src/widgets/form/NumberField.tsx +3 -0
  320. package/src/widgets/form/Radio.tsx +5 -0
  321. package/src/widgets/form/Select.tsx +5 -0
  322. package/src/widgets/form/Slider.tsx +4 -0
  323. package/src/widgets/form/Switch.tsx +3 -0
  324. package/src/widgets/form/TextField.tsx +62 -0
  325. package/src/widgets/form/TimeList.tsx +84 -73
  326. package/src/widgets/form/UploadButton.tsx +53 -2
  327. package/src/widgets/form/Validator.ts +40 -3
  328. package/src/widgets/grid/Grid.tsx +9 -12
  329. package/src/widgets/grid/GridCell.ts +143 -143
  330. package/src/widgets/grid/TreeNode.tsx +9 -0
  331. package/src/widgets/icons/calendar.tsx +17 -17
  332. package/src/widgets/icons/check.tsx +13 -13
  333. package/src/widgets/icons/clear.tsx +15 -15
  334. package/src/widgets/icons/close.tsx +20 -20
  335. package/src/widgets/icons/cx.tsx +38 -38
  336. package/src/widgets/icons/drop-down.tsx +15 -15
  337. package/src/widgets/icons/file.tsx +13 -13
  338. package/src/widgets/icons/folder-open.tsx +15 -15
  339. package/src/widgets/icons/folder.tsx +13 -13
  340. package/src/widgets/icons/forward.tsx +22 -22
  341. package/src/widgets/icons/loading.tsx +24 -24
  342. package/src/widgets/icons/menu.tsx +17 -17
  343. package/src/widgets/icons/pixel-picker.tsx +18 -18
  344. package/src/widgets/icons/search.tsx +13 -13
  345. package/src/widgets/icons/sort-asc.tsx +14 -14
  346. package/src/widgets/icons/square.tsx +18 -18
  347. package/src/widgets/index.ts +1 -0
  348. package/src/widgets/nav/MenuItem.tsx +3 -2
  349. package/src/widgets/nav/Route.ts +142 -142
  350. package/src/widgets/nav/Scroller.tsx +8 -9
  351. package/src/widgets/nav/Tab.ts +2 -2
  352. package/src/widgets/overlay/ContextMenu.ts +42 -42
  353. package/src/widgets/overlay/Dropdown.tsx +762 -762
  354. package/src/widgets/overlay/MsgBox.tsx +141 -141
  355. package/src/widgets/overlay/Overlay.tsx +5 -4
  356. package/src/widgets/overlay/Toast.ts +111 -111
  357. package/src/widgets/overlay/Window.tsx +299 -299
  358. package/src/widgets/overlay/alerts.ts +46 -46
  359. package/src/widgets/overlay/captureMouse.ts +195 -195
  360. package/src/widgets/overlay/createHotPromiseWindowFactory.ts +72 -72
  361. package/src/widgets/overlay/index.d.ts +11 -11
  362. package/src/widgets/overlay/index.ts +11 -11
  363. package/src/widgets/overlay/tooltip-ops.ts +173 -173
@@ -1,868 +1,866 @@
1
- import { Controller } from "./Controller";
2
- import { debug, renderFlag, processDataFlag, destroyFlag } from "../util/Debug";
3
- import { GlobalCacheIdentifier } from "../util/GlobalCacheIdentifier";
4
- import { throttle } from "../util/throttle";
5
- import { validatedDebounce } from "../util/validatedDebounce";
6
- import { batchUpdates } from "./batchUpdates";
7
- import { isString } from "../util/isString";
8
- import { isFunction } from "../util/isFunction";
9
- import { isDefined } from "../util/isDefined";
10
- import { isArray } from "../util/isArray";
11
- import { isObject } from "../util/isObject";
12
- import { isNonEmptyArray } from "../util/isNonEmptyArray";
13
- import { isUndefined } from "../util/isUndefined";
14
- import { isAccessorChain } from "../data/createAccessorModelProxy";
15
- import { CxChild, RenderingContext } from "./RenderingContext";
16
- import type { Widget } from "./Widget";
17
- import { View } from "../data/View";
18
-
19
- /**
20
- * Serializable value types that can be safely passed through the framework
21
- */
22
- export type SerializableValue = string | number | boolean | object | null | undefined;
23
-
24
- /**
25
- * Core instance data structure used by widgets
26
- *
27
- * For custom widget data, extend this interface:
28
- * @example
29
- * interface MyWidgetData extends WidgetData {
30
- * customProp: string;
31
- * }
32
- */
33
- export interface WidgetData {
34
- visible?: boolean;
35
- disabled?: boolean;
36
- enabled?: boolean;
37
- text?: string;
38
- innerHtml?: string;
39
- attrs?: Record<string, unknown>;
40
- data?: Record<string, unknown>;
41
- classNames?: string;
42
- className?: string;
43
- class?: string;
44
- style?: Record<string, string | number> | string;
45
- stateMods?: Record<string, boolean | undefined>;
46
- mod?: Record<string, boolean | undefined>;
47
- pressed?: boolean;
48
- icon?: string | boolean;
49
- confirm?: string | ConfirmConfig;
50
- parentDisabled?: boolean;
51
- parentStrict?: boolean;
52
- error?: string;
53
- }
54
-
55
- /**
56
- * Confirmation dialog configuration
57
- */
58
- export interface ConfirmConfig {
59
- message: string;
60
- title?: string;
61
- yesText?: string;
62
- noText?: string;
63
- }
64
-
65
- /**
66
- * Parent options passed down from overlay/modal components
67
- *
68
- * For custom parent options, extend this interface:
69
- * @example
70
- * interface MyParentOptions extends ParentOptions {
71
- * customOption: string;
72
- * }
73
- */
74
- export interface ParentOptions {
75
- dismiss?: () => void;
76
- }
77
-
78
- /**
79
- * Props object used for rendering (passed to React.createElement)
80
- */
81
- export type RenderProps = Record<string, any>;
82
-
83
- /**
84
- * Result type for yes/no dialogs
85
- */
86
- export const enum YesNoResult {
87
- Yes = "yes",
88
- No = "no",
89
- }
90
-
91
- /**
92
- * Partial instance-like object used in some render methods
93
- * This is a hack to allow passing only the data property instead of full Instance
94
- */
95
- export interface PartialInstance {
96
- data: Record<string, any>;
97
- widget?: Widget;
98
- state?: Record<string, any>;
99
- }
100
-
101
- /**
102
- * Example widget-specific properties for dropdown widgets
103
- */
104
- export interface DropdownWidgetProps {
105
- lastDropdown?: Instance;
106
- dropdownOpen?: boolean;
107
- selectedIndex?: number;
108
- }
109
-
110
- /**
111
- * Example widget-specific properties for form field widgets
112
- */
113
- export interface FieldWidgetProps {
114
- inputElement?: HTMLInputElement;
115
- validationState?: "valid" | "invalid" | "pending";
116
- }
117
-
118
- /**
119
- * Type aliases for common widget instance types using intersection types
120
- */
121
- export type DropdownInstance = Instance & DropdownWidgetProps;
122
- export type FieldInstance = Instance & FieldWidgetProps;
123
-
124
- let instanceId = 1000;
125
-
126
- /**
127
- * Base Instance class
128
- */
129
- export class Instance<WidgetType extends Widget<any, any> = Widget<any, any>> {
130
- // Core properties
131
- declare public widget: WidgetType;
132
- declare public key: string;
133
- declare public id: string;
134
- declare public parent?: Instance;
135
- declare public parentStore: View;
136
- declare public store: View;
137
- declare public controller?: Controller;
138
-
139
- // Data and state
140
- declare public data: Record<string, any>;
141
- declare public rawData: Record<string, any>;
142
- declare public state?: Record<string, any>;
143
- declare public cached: Record<string, any>;
144
- declare public cacheList?: Record<string, any> | null;
145
-
146
- // Selectors
147
- public dataSelector?: (store: any) => Record<string, any>;
148
-
149
- // Lifecycle flags
150
- public initialized?: boolean;
151
- declare public visible?: boolean;
152
- declare public explored?: boolean;
153
- declare public prepared?: boolean;
154
- declare public shouldUpdate?: boolean;
155
- declare public childStateDirty?: boolean;
156
- declare public detached?: boolean;
157
-
158
- // Cleanup tracking
159
- declare public needsExploreCleanup?: boolean;
160
- declare public needsPrepare?: boolean;
161
- declare public needsCleanup?: boolean;
162
- declare public destroyTracked?: boolean;
163
- public destroySubscriptions?: Array<() => void> | null;
164
-
165
- // Child management
166
- declare public instanceCache?: InstanceCache | null;
167
- declare public children?: Instance[];
168
- public helpers?: Record<string, Instance>;
169
- public components?: Record<string, Instance>;
170
-
171
- // Rendering
172
- declare public vdom?: any;
173
- declare public contentVDOM?: any;
174
- declare public renderList?: any;
175
- declare public assignedRenderList?: any;
176
-
177
- // Layout
178
- declare public outerLayout?: Instance;
179
- declare public contentPlaceholder?: any;
180
- declare public parentOptions?: any;
181
-
182
- // Setters
183
- declare public setters?: Record<string, any>;
184
-
185
- // Other
186
- declare public record?: any;
187
- declare public mappedRecords?: any[];
188
-
189
- // List-specific
190
- declare public instances?: Instance[];
191
- declare public selected?: boolean;
192
-
193
- constructor(widget: WidgetType, key: string, parent?: Instance, parentStore?: any) {
194
- this.widget = widget;
195
- this.key = key;
196
- this.id = String(++instanceId);
197
- this.cached = {};
198
- this.parent = parent;
199
- this.parentStore = parentStore ?? parent?.store;
200
-
201
- if (this.parentStore == null) throw new Error("Cannot create instance without a parent store.");
202
- }
203
-
204
- public setParentStore(parentStore: any): void {
205
- this.parentStore = parentStore;
206
- this.widget.applyParentStore(this);
207
- }
208
-
209
- public init(context: RenderingContext): void {
210
- // widget is initialized when the first instance is initialized
211
- if (!this.widget.initialized) {
212
- this.widget.init();
213
- this.widget.initialized = true;
214
- }
215
-
216
- if (!this.dataSelector) {
217
- this.widget.selector!.init(this.parentStore);
218
- this.dataSelector = this.widget.selector!.createStoreSelector();
219
- }
220
-
221
- // init instance might change the store, so this must go before the controller initialization
222
- this.widget.initInstance(context, this);
223
-
224
- // initInstance can set the store, otherwise use parent store
225
- if (!this.store) this.store = this.parentStore;
226
- if (this.widget.onInit) this.widget.onInit(context, this);
227
-
228
- this.widget.initState(context, this);
229
-
230
- if (this.widget.controller)
231
- this.controller = Controller.create(this.widget.controller, {
232
- widget: this.widget,
233
- instance: this,
234
- store: this.store,
235
- });
236
-
237
- if (
238
- this.widget.exploreCleanup ||
239
- this.widget.outerLayout ||
240
- this.widget.isContent ||
241
- this.widget.controller ||
242
- this.widget.prepareCleanup
243
- )
244
- this.needsExploreCleanup = true;
245
- if (this.widget.prepare || this.widget.controller) this.needsPrepare = true;
246
- if (this.widget.cleanup || this.widget.controller) this.needsCleanup = true;
247
- this.initialized = true;
248
- }
249
-
250
- public checkVisible(context: RenderingContext): boolean {
251
- if (!this.initialized) this.init(context);
252
-
253
- const wasVisible = this.visible;
254
- this.rawData = this.dataSelector!(this.store);
255
- this.visible = this.widget.checkVisible(context, this, this.rawData);
256
- if (this.visible && !this.detached) this.parent!.instanceCache!.addChild(this);
257
- this.explored = false;
258
- this.prepared = false;
259
-
260
- if (!this.visible && wasVisible) this.destroy();
261
-
262
- return this.visible;
263
- }
264
-
265
- public scheduleExploreIfVisible(context: RenderingContext): boolean {
266
- if (this.checkVisible(context)) {
267
- context.exploreStack.push(this);
268
-
269
- if (this.needsExploreCleanup) context.exploreStack.push(this);
270
-
271
- return true;
272
- }
273
- return false;
274
- }
275
-
276
- public cache(key: string, value: any): boolean {
277
- const oldValue = this.cached[key];
278
- if (oldValue === value) return false;
279
-
280
- if (!this.cacheList) this.cacheList = {};
281
- this.cacheList[key] = value;
282
- return true;
283
- }
284
-
285
- public markShouldUpdate(context: RenderingContext): void {
286
- let ins: Instance | undefined = this;
287
- let renderList = this.renderList;
288
- renderList.markReverseIndex();
289
-
290
- //notify all parents that child state changed to bust up caching
291
- while (ins && !ins.shouldUpdate && ins.explored) {
292
- if (ins.renderList !== renderList) {
293
- renderList.reverse();
294
- renderList = ins.renderList;
295
- renderList.markReverseIndex();
296
- }
297
- ins.shouldUpdate = true;
298
- renderList.data.push(ins);
299
- ins = ins.widget.isContent
300
- ? ins.contentPlaceholder
301
- : ins.parent?.outerLayout === ins
302
- ? ins.parent?.parent
303
- : ins.parent;
304
- }
305
- renderList.reverse();
306
- }
307
-
308
- public explore(context: RenderingContext): void {
309
- if (!this.visible) throw new Error("Explore invisible!");
310
-
311
- if (this.explored) {
312
- if (this.widget.prepareCleanup) context.prepareList.push(this);
313
-
314
- if (this.widget.exploreCleanup) this.widget.exploreCleanup(context, this);
315
-
316
- if (this.parent?.outerLayout === this) context.popNamedValue("content", "body");
317
-
318
- if (this.widget.controller) context.pop("controller");
319
-
320
- return;
321
- }
322
-
323
- this.explored = true;
324
-
325
- if (this.needsPrepare) context.prepareList.push(this);
326
- else this.prepared = true;
327
-
328
- if (this.needsCleanup) context.cleanupList.push(this);
329
-
330
- if (this.instanceCache) this.instanceCache.mark();
331
-
332
- //controller may reconfigure the widget and need to go before shouldUpdate calculation
333
- this.parentOptions = context.parentOptions;
334
-
335
- if (!this.controller) {
336
- if (context.controller) this.controller = context.controller;
337
- else if (this.parent?.controller) this.controller = this.parent?.controller;
338
- }
339
-
340
- this.destroyTracked = false;
341
-
342
- if (this.controller) {
343
- if (this.widget.controller) {
344
- if (!this.controller.initialized) {
345
- this.controller.init(context);
346
- this.controller.initialized = true;
347
- }
348
- context.push("controller", this.controller);
349
- this.controller.explore(context);
350
- if (this.controller.onDestroy && this.controller.widget == this.widget) this.trackDestroy();
351
- }
352
- }
353
-
354
- if (this.widget.onDestroy || isNonEmptyArray(this.destroySubscriptions)) this.trackDestroy();
355
-
356
- this.renderList = this.assignedRenderList || this.parent?.renderList || context.getRootRenderList();
357
-
358
- let shouldUpdate =
359
- this.rawData !== this.cached.rawData ||
360
- this.state !== this.cached.state ||
361
- this.widget.version !== this.cached.widgetVersion ||
362
- this.cached.globalCacheIdentifier !== GlobalCacheIdentifier.get();
363
-
364
- if (shouldUpdate) {
365
- this.data = { ...this.rawData };
366
- this.widget.prepareData(context, this);
367
- debug(processDataFlag, this.widget);
368
- }
369
-
370
- //onExplore might set the outer layout
371
- if (this.widget.onExplore) this.widget.onExplore(context, this);
372
-
373
- if (this.parent?.outerLayout === this) {
374
- this.renderList = this.renderList.insertRight();
375
- context.pushNamedValue("content", "body", this.parent);
376
- }
377
-
378
- if (this.widget.outerLayout) {
379
- this.outerLayout = this.getChild(context, this.widget.outerLayout, null, this.store);
380
- this.outerLayout.scheduleExploreIfVisible(context);
381
- this.renderList = this.renderList.insertLeft();
382
- }
383
-
384
- if (this.widget.isContent) {
385
- this.contentPlaceholder = context.contentPlaceholder && context.contentPlaceholder[this.widget.putInto!];
386
- if (this.contentPlaceholder) context.contentPlaceholder[this.widget.putInto!](this);
387
- else {
388
- this.renderList = this.renderList.insertLeft();
389
- context.pushNamedValue("content", this.widget.putInto!, this);
390
- if (!context.contentList) context.contentList = {};
391
- let list = context.contentList[this.widget.putInto!];
392
- if (!list) list = context.contentList[this.widget.putInto!] = [];
393
- list.push(this);
394
- }
395
- }
396
-
397
- this.shouldUpdate = false;
398
- if (shouldUpdate || this.childStateDirty || !this.widget.memoize) this.markShouldUpdate(context);
399
-
400
- context.exploreStack.hop();
401
-
402
- if (this.widget.helpers) {
403
- this.helpers = {};
404
- for (let cmp in this.widget.helpers) {
405
- let helper = this.widget.helpers[cmp];
406
- if (helper) {
407
- let ins = this.getChild(context, helper);
408
- if (ins.scheduleExploreIfVisible(context)) this.helpers[cmp] = ins;
409
- }
410
- }
411
- }
412
-
413
- //TODO: check do we need to pass data here?
414
- this.widget.explore(context, this, this.data);
415
- }
416
-
417
- public prepare(context: RenderingContext): void {
418
- if (!this.visible) throw new Error("Prepare invisible!");
419
-
420
- if (this.prepared) {
421
- if (this.widget.prepareCleanup) this.widget.prepareCleanup(context, this);
422
- return;
423
- }
424
-
425
- this.prepared = true;
426
- if (this.widget.prepare) this.widget.prepare(context, this);
427
-
428
- if (this.widget.controller && this.controller?.prepare) this.controller.prepare(context);
429
- }
430
-
431
- public render(context: RenderingContext): null | Record<string, React.ReactNode> | React.ReactNode[] {
432
- if (!this.visible) throw new Error("Render invisible!");
433
-
434
- if (this.shouldUpdate) {
435
- debug(renderFlag, this.widget, this.key);
436
- const vdom = renderResultFix(this.widget.render(context, this, this.key));
437
- if (this.widget.isContent || this.outerLayout) this.contentVDOM = vdom;
438
- else this.vdom = vdom;
439
- }
440
-
441
- if (this.cacheList) {
442
- for (const key in this.cacheList) {
443
- this.cached[key] = this.cacheList[key];
444
- }
445
- }
446
-
447
- this.cacheList = null;
448
-
449
- this.cached.rawData = this.rawData;
450
- this.cached.data = this.data;
451
- this.cached.state = this.state;
452
- this.cached.widgetVersion = this.widget.version;
453
- this.cached.globalCacheIdentifier = GlobalCacheIdentifier.get();
454
- this.childStateDirty = false;
455
-
456
- if (this.instanceCache) this.instanceCache.sweep();
457
-
458
- if (this.parent?.outerLayout === this) {
459
- //if outer layouts are chained we need to find the originating element (last element with OL set)
460
- let parent = this.parent;
461
- while (parent.parent?.outerLayout == parent) parent = parent.parent;
462
- parent.vdom = this.vdom;
463
- }
464
-
465
- return this.vdom;
466
- }
467
-
468
- public cleanup(context: RenderingContext): void {
469
- if (this.widget.controller && this.controller?.cleanup) this.controller.cleanup(context);
470
-
471
- if (this.widget.cleanup) this.widget.cleanup(context, this);
472
- }
473
-
474
- private trackDestroy(): void {
475
- if (!this.destroyTracked) {
476
- this.destroyTracked = true;
477
- if (this.parent && !this.detached) this.parent.trackDestroyableChild(this);
478
- }
479
- }
480
-
481
- private trackDestroyableChild(child: Instance): void {
482
- this.instanceCache!.trackDestroy(child);
483
- this.trackDestroy();
484
- }
485
-
486
- public subscribeOnDestroy(callback: () => void): () => void {
487
- if (!this.destroySubscriptions) this.destroySubscriptions = [];
488
- this.destroySubscriptions.push(callback);
489
- this.trackDestroy();
490
- return () => {
491
- if (this.destroySubscriptions) {
492
- this.destroySubscriptions = this.destroySubscriptions.filter((cb) => cb !== callback);
493
- }
494
- };
495
- }
496
-
497
- public destroy(): void {
498
- if (this.instanceCache) {
499
- this.instanceCache.destroy();
500
- this.instanceCache = null;
501
- }
502
-
503
- if (this.destroySubscriptions) {
504
- this.destroySubscriptions.forEach((cb) => cb());
505
- this.destroySubscriptions = null;
506
- }
507
-
508
- if (this.destroyTracked) {
509
- debug(destroyFlag, this);
510
-
511
- if (this.widget.onDestroy) this.widget.onDestroy(this);
512
-
513
- if (
514
- this.widget.controller &&
515
- this.controller &&
516
- this.controller.onDestroy &&
517
- this.controller.widget == this.widget
518
- )
519
- this.controller.onDestroy();
520
-
521
- this.destroyTracked = false;
522
- }
523
- }
524
-
525
- public setState(state: Record<string, any>): void {
526
- let skip = !!this.state;
527
- if (this.state) {
528
- for (const k in state) {
529
- if (this.state[k] !== state[k]) {
530
- skip = false;
531
- break;
532
- }
533
- }
534
- }
535
-
536
- if (skip) return;
537
-
538
- this.state = Object.assign({}, this.state, state);
539
- let parent = this.parent;
540
- //notify all parents that child state change to bust up caching
541
- while (parent) {
542
- parent.childStateDirty = true;
543
- parent = parent.parent;
544
- }
545
- batchUpdates(() => {
546
- this.store.notify();
547
- });
548
- }
549
-
550
- public set(prop: string, value: any, options: { internal?: boolean; immediate?: boolean } = {}): boolean {
551
- //skip re-rendering (used for reading state from uncontrolled components)
552
- if (options.internal && this.rawData) {
553
- this.rawData[prop] = value;
554
- this.data[prop] = value;
555
- }
556
-
557
- const setter = this.setters && this.setters[prop];
558
- if (setter) {
559
- if (options.immediate && isFunction(setter.reset)) setter.reset(value);
560
- else setter(value);
561
- return true;
562
- }
563
-
564
- const p = (this.widget as any)[prop];
565
- if (p && typeof p == "object") {
566
- if (p.debounce) {
567
- this.definePropertySetter(
568
- prop,
569
- validatedDebounce(
570
- (value: any) => this.doSet(prop, value),
571
- () => this.dataSelector!(this.store)[prop],
572
- p.debounce,
573
- ),
574
- );
575
- this.set(prop, value, options);
576
- return true;
577
- }
578
-
579
- if (p.throttle) {
580
- this.definePropertySetter(
581
- prop,
582
- throttle((value: any) => this.doSet(prop, value), p.throttle),
583
- );
584
- this.set(prop, value, options);
585
- return true;
586
- }
587
- }
588
-
589
- return this.doSet(prop, value);
590
- }
591
-
592
- public definePropertySetter(prop: string, setter: any): void {
593
- if (!this.setters) this.setters = {};
594
- this.setters[prop] = setter;
595
- }
596
-
597
- protected doSet(prop: string, value: any): boolean {
598
- let changed = false;
599
- batchUpdates(() => {
600
- const p = (this.widget as any)[prop];
601
- if (isObject(p)) {
602
- const pObj = p as any;
603
- if (pObj.set) {
604
- if (isFunction(pObj.set)) {
605
- pObj.set(value, this);
606
- changed = true;
607
- } else if (isString(pObj.set)) {
608
- (this.controller as any)?.[pObj.set](value, this);
609
- changed = true;
610
- }
611
- } else if (pObj.action) {
612
- const action = pObj.action(value, this);
613
- this.store.dispatch(action);
614
- changed = true;
615
- } else if (isString(pObj.bind) || isAccessorChain(pObj.bind)) {
616
- changed = this.store.set(pObj.bind, value);
617
- }
618
- } else if (isAccessorChain(p)) {
619
- changed = this.store.set(p.toString(), value);
620
- }
621
- });
622
- return changed;
623
- }
624
-
625
- public nestedDataSet(key: string, value: any, dataConfig: Record<string, any>, useParentStore?: boolean): boolean {
626
- let config = dataConfig[key];
627
- if (!config)
628
- throw new Error(`Unknown nested data key ${key}. Known keys are ${Object.keys(dataConfig).join(", ")}.`);
629
-
630
- if (isAccessorChain(config)) config = { bind: config.toString() };
631
-
632
- if (config.bind) {
633
- let store = this.store;
634
- //in case of Rescope or DataProxy, bindings point to the data in the parent store
635
- if (useParentStore && store.store) store = store.store;
636
- return isUndefined(value) ? store.deleteItem(config.bind) : store.setItem(config.bind, value);
637
- }
638
-
639
- if (!config.set)
640
- throw new Error(
641
- `Cannot change nested data value for ${key} as it's read-only. Either define it as a binding or define a set function.`,
642
- );
643
- if (isString(config.set)) this.getControllerMethod(config.set)(value, this);
644
- else if (isFunction(config.set)) config.set(value, this);
645
- else
646
- throw new Error(
647
- `Cannot change nested data value for ${key} the defined setter is neither a function nor a controller method.`,
648
- );
649
-
650
- return true;
651
- }
652
-
653
- public replaceState(state: Record<string, any>): void {
654
- this.cached.state = this.state;
655
- this.state = state;
656
- this.store.notify();
657
- }
658
-
659
- public getInstanceCache(): InstanceCache {
660
- if (!this.instanceCache)
661
- this.instanceCache = new InstanceCache(this, this.widget.isPureContainer ? this.key : null);
662
- return this.instanceCache;
663
- }
664
-
665
- public clearChildrenCache(): void {
666
- if (this.instanceCache) this.instanceCache.destroy();
667
- }
668
-
669
- public getChild(
670
- context: RenderingContext | null,
671
- widget: Widget,
672
- key?: string | number | null,
673
- store?: any,
674
- ): Instance {
675
- return this.getInstanceCache().getChild(widget, store ?? this.store, key);
676
- }
677
-
678
- public getDetachedChild(widget: Widget, key: string, store?: any): Instance {
679
- const child = new Instance(widget, key, this, store ?? this.store);
680
- child.detached = true;
681
- return child;
682
- }
683
-
684
- public prepareRenderCleanupChild(widget: any, store?: any, keyPrefix?: string, options?: any): any {
685
- return widget.prepareRenderCleanup(store ?? this.store, options, keyPrefix, this);
686
- }
687
-
688
- public getJsxEventProps(): Record<string, any> | null {
689
- const { widget } = this;
690
-
691
- if (!isArray(widget.jsxAttributes)) return null;
692
-
693
- const props: Record<string, any> = {};
694
- widget.jsxAttributes.forEach((attr) => {
695
- if (attr.indexOf("on") == 0 && attr.length > 2) {
696
- props[attr] = (e: any) => this.invoke(attr, e, this);
697
- }
698
- });
699
- return props;
700
- }
701
-
702
- public getCallback(methodName: string): (...args: any[]) => any {
703
- const scope = this.widget as any;
704
- const callback = scope[methodName];
705
-
706
- if (typeof callback === "string") return this.getControllerMethod(callback);
707
-
708
- if (typeof callback !== "function")
709
- throw new Error(`Cannot invoke callback method ${methodName} as assigned value is not a function.`);
710
-
711
- return callback.bind(scope);
712
- }
713
-
714
- /**
715
- * Finds the first controller in the instance tree matching the predicate
716
- * @param predicate Function to test each controller
717
- * @returns The matching controller or undefined
718
- */
719
- public findController(predicate: (controller: Controller) => boolean): Controller | undefined {
720
- let at: Instance | undefined = this;
721
- while (at?.controller != null) {
722
- if (predicate(at.controller)) {
723
- return at.controller;
724
- }
725
- at = at.parent;
726
- }
727
- return undefined;
728
- }
729
-
730
- /**
731
- * Finds a controller of the specified type in the instance tree
732
- * @param type Controller class/constructor to find
733
- * @returns The matching controller cast to the specified type, or undefined
734
- */
735
- public findControllerByType<T extends Controller>(type: new (...args: any[]) => T): T | undefined {
736
- return this.findController((c) => c instanceof type) as T | undefined;
737
- }
738
-
739
- /**
740
- * Gets the first controller in the instance tree matching the predicate
741
- * @param predicate Function to test each controller
742
- * @returns The matching controller
743
- * @throws Error if no matching controller is found
744
- */
745
- public getController(predicate: (controller: Controller) => boolean): Controller {
746
- const controller = this.findController(predicate);
747
- if (!controller)
748
- throw new Error("Cannot find a controller matching the given predicate in the instance tree.");
749
- return controller;
750
- }
751
-
752
- /**
753
- * Gets a controller of the specified type in the instance tree
754
- * @param type Controller class/constructor to find
755
- * @returns The matching controller cast to the specified type
756
- * @throws Error if no controller of the specified type is found
757
- */
758
- public getControllerByType<T extends Controller>(type: new (...args: any[]) => T): T {
759
- const controller = this.findControllerByType(type);
760
- if (!controller)
761
- throw new Error(`Cannot find a controller of type "${type.name}" in the instance tree.`);
762
- return controller;
763
- }
764
-
765
- public getControllerMethod(methodName: string): (...args: any[]) => any {
766
- if (!this.controller)
767
- throw new Error(
768
- `Cannot invoke controller method "${methodName}" as controller is not assigned to the widget.`,
769
- );
770
-
771
- const controller = this.findController((c) => !!(c as any)[methodName]);
772
-
773
- if (!controller)
774
- throw new Error(
775
- `Cannot invoke controller method "${methodName}". The method cannot be found in any of the assigned controllers.`,
776
- );
777
-
778
- return (controller as any)[methodName].bind(controller);
779
- }
780
-
781
- public invoke(methodName: string, ...args: any[]): any {
782
- return this.getCallback(methodName).apply(null, args);
783
- }
784
-
785
- public invokeControllerMethod(methodName: string, ...args: any[]): any {
786
- return this.getControllerMethod(methodName).apply(null, args);
787
- }
788
- }
789
-
790
- function renderResultFix(res: any): any {
791
- return res != null && isDefined(res.content) ? res : { content: res };
792
- }
793
-
794
- export class InstanceCache {
795
- declare public children: Record<string, Instance>;
796
- declare public parent: Instance;
797
- declare public marked: Record<string, Instance>;
798
- declare public monitored: Record<string, Instance> | null;
799
- declare public keyPrefix: string;
800
-
801
- constructor(parent: Instance, keyPrefix?: string | number | null) {
802
- this.children = {};
803
- this.parent = parent;
804
- this.marked = {};
805
- this.monitored = null;
806
- this.keyPrefix = keyPrefix != null ? keyPrefix + "-" : "";
807
- }
808
-
809
- public getChild(widget: Widget, parentStore: any, key?: string | number | null): Instance {
810
- const k = this.keyPrefix + (key != null ? key : widget.vdomKey || widget.widgetId);
811
- let instance = this.children[k];
812
-
813
- if (
814
- !instance ||
815
- instance.widget !== widget ||
816
- (!instance.visible && (instance.widget.controller || instance.widget.onInit))
817
- ) {
818
- instance = new Instance(widget, k, this.parent, parentStore);
819
- this.children[k] = instance;
820
- } else if (instance.parentStore !== parentStore) {
821
- instance.setParentStore(parentStore);
822
- }
823
-
824
- return instance;
825
- }
826
-
827
- public addChild(instance: Instance): void {
828
- this.marked[instance.key] = instance;
829
- }
830
-
831
- public mark(): void {
832
- this.marked = {};
833
- }
834
-
835
- public trackDestroy(instance: Instance): void {
836
- if (!this.monitored) this.monitored = {};
837
- this.monitored[instance.key as string] = instance;
838
- }
839
-
840
- public destroy(): void {
841
- this.children = {};
842
- this.marked = {};
843
-
844
- if (!this.monitored) return;
845
-
846
- for (const key in this.monitored) {
847
- this.monitored[key].destroy();
848
- }
849
-
850
- this.monitored = null;
851
- }
852
-
853
- public sweep(): void {
854
- this.children = this.marked;
855
- if (!this.monitored) return;
856
- let activeCount = 0;
857
- for (const key in this.monitored) {
858
- const monitoredChild = this.monitored[key];
859
- const child = this.children[key];
860
- if (child !== monitoredChild || !monitoredChild.visible) {
861
- monitoredChild.destroy();
862
- delete this.monitored[key];
863
- if (child === monitoredChild) delete this.children[key];
864
- } else activeCount++;
865
- }
866
- if (activeCount === 0) this.monitored = null;
867
- }
868
- }
1
+ import { isAccessorChain } from "../data/createAccessorModelProxy";
2
+ import { View } from "../data/View";
3
+ import { debug, destroyFlag, processDataFlag, renderFlag } from "../util/Debug";
4
+ import { GlobalCacheIdentifier } from "../util/GlobalCacheIdentifier";
5
+ import { isArray } from "../util/isArray";
6
+ import { isDefined } from "../util/isDefined";
7
+ import { isFunction } from "../util/isFunction";
8
+ import { isNonEmptyArray } from "../util/isNonEmptyArray";
9
+ import { isObject } from "../util/isObject";
10
+ import { isString } from "../util/isString";
11
+ import { isUndefined } from "../util/isUndefined";
12
+ import { throttle } from "../util/throttle";
13
+ import { validatedDebounce } from "../util/validatedDebounce";
14
+ import { batchUpdates } from "./batchUpdates";
15
+ import { Controller } from "./Controller";
16
+ import { RenderingContext } from "./RenderingContext";
17
+ import type { Widget } from "./Widget";
18
+
19
+ /**
20
+ * Serializable value types that can be safely passed through the framework
21
+ */
22
+ export type SerializableValue = string | number | boolean | object | null | undefined;
23
+
24
+ /**
25
+ * Core instance data structure used by widgets
26
+ *
27
+ * For custom widget data, extend this interface:
28
+ * @example
29
+ * interface MyWidgetData extends WidgetData {
30
+ * customProp: string;
31
+ * }
32
+ */
33
+ export interface WidgetData {
34
+ visible?: boolean;
35
+ disabled?: boolean;
36
+ enabled?: boolean;
37
+ text?: string;
38
+ innerHtml?: string;
39
+ attrs?: Record<string, unknown>;
40
+ data?: Record<string, unknown>;
41
+ classNames?: string;
42
+ className?: string;
43
+ class?: string;
44
+ style?: Record<string, string | number> | string;
45
+ stateMods?: Record<string, boolean | undefined>;
46
+ mod?: Record<string, boolean | undefined>;
47
+ pressed?: boolean;
48
+ icon?: string | boolean;
49
+ confirm?: string | ConfirmConfig;
50
+ parentDisabled?: boolean;
51
+ parentStrict?: boolean;
52
+ error?: string;
53
+ }
54
+
55
+ /**
56
+ * Confirmation dialog configuration
57
+ */
58
+ export interface ConfirmConfig {
59
+ message: string;
60
+ title?: string;
61
+ yesText?: string;
62
+ noText?: string;
63
+ }
64
+
65
+ /**
66
+ * Parent options passed down from overlay/modal components
67
+ *
68
+ * For custom parent options, extend this interface:
69
+ * @example
70
+ * interface MyParentOptions extends ParentOptions {
71
+ * customOption: string;
72
+ * }
73
+ */
74
+ export interface ParentOptions {
75
+ dismiss?: () => void;
76
+ }
77
+
78
+ /**
79
+ * Props object used for rendering (passed to React.createElement)
80
+ */
81
+ export type RenderProps = Record<string, any>;
82
+
83
+ /**
84
+ * Result type for yes/no dialogs
85
+ */
86
+ export const enum YesNoResult {
87
+ Yes = "yes",
88
+ No = "no",
89
+ }
90
+
91
+ /**
92
+ * Partial instance-like object used in some render methods
93
+ * This is a hack to allow passing only the data property instead of full Instance
94
+ */
95
+ export interface PartialInstance {
96
+ data: Record<string, any>;
97
+ widget?: Widget;
98
+ state?: Record<string, any>;
99
+ }
100
+
101
+ /**
102
+ * Example widget-specific properties for dropdown widgets
103
+ */
104
+ export interface DropdownWidgetProps {
105
+ lastDropdown?: Instance;
106
+ dropdownOpen?: boolean;
107
+ selectedIndex?: number;
108
+ }
109
+
110
+ /**
111
+ * Example widget-specific properties for form field widgets
112
+ */
113
+ export interface FieldWidgetProps {
114
+ inputElement?: HTMLInputElement;
115
+ validationState?: "valid" | "invalid" | "pending";
116
+ }
117
+
118
+ /**
119
+ * Type aliases for common widget instance types using intersection types
120
+ */
121
+ export type DropdownInstance = Instance & DropdownWidgetProps;
122
+ export type FieldInstance = Instance & FieldWidgetProps;
123
+
124
+ let instanceId = 1000;
125
+
126
+ /**
127
+ * Base Instance class
128
+ */
129
+ export class Instance<WidgetType extends Widget<any, any> = Widget<any, any>> {
130
+ // Core properties
131
+ declare public widget: WidgetType;
132
+ declare public key: string;
133
+ declare public id: string;
134
+ declare public parent?: Instance;
135
+ declare public parentStore: View;
136
+ declare public store: View;
137
+ declare public controller?: Controller;
138
+
139
+ // Data and state
140
+ declare public data: Record<string, any>;
141
+ declare public rawData: Record<string, any>;
142
+ declare public state?: Record<string, any>;
143
+ declare public cached: Record<string, any>;
144
+ declare public cacheList?: Record<string, any> | null;
145
+
146
+ // Selectors
147
+ public dataSelector?: (store: any) => Record<string, any>;
148
+
149
+ // Lifecycle flags
150
+ public initialized?: boolean;
151
+ declare public visible?: boolean;
152
+ declare public explored?: boolean;
153
+ declare public prepared?: boolean;
154
+ declare public shouldUpdate?: boolean;
155
+ declare public childStateDirty?: boolean;
156
+ declare public detached?: boolean;
157
+
158
+ // Cleanup tracking
159
+ declare public needsExploreCleanup?: boolean;
160
+ declare public needsPrepare?: boolean;
161
+ declare public needsCleanup?: boolean;
162
+ declare public destroyTracked?: boolean;
163
+ public destroySubscriptions?: Array<() => void> | null;
164
+
165
+ // Child management
166
+ declare public instanceCache?: InstanceCache | null;
167
+ declare public children?: Instance[];
168
+ public helpers?: Record<string, Instance>;
169
+ public components?: Record<string, Instance>;
170
+
171
+ // Rendering
172
+ declare public vdom?: any;
173
+ declare public contentVDOM?: any;
174
+ declare public renderList?: any;
175
+ declare public assignedRenderList?: any;
176
+
177
+ // Layout
178
+ declare public outerLayout?: Instance;
179
+ declare public contentPlaceholder?: any;
180
+ declare public parentOptions?: any;
181
+
182
+ // Setters
183
+ declare public setters?: Record<string, any>;
184
+
185
+ // Other
186
+ declare public record?: any;
187
+ declare public mappedRecords?: any[];
188
+
189
+ // List-specific
190
+ declare public instances?: Instance[];
191
+ declare public selected?: boolean;
192
+
193
+ constructor(widget: WidgetType, key: string, parent?: Instance, parentStore?: any) {
194
+ this.widget = widget;
195
+ this.key = key;
196
+ this.id = String(++instanceId);
197
+ this.cached = {};
198
+ this.parent = parent;
199
+ this.parentStore = parentStore ?? parent?.store;
200
+
201
+ if (this.parentStore == null) throw new Error("Cannot create instance without a parent store.");
202
+ }
203
+
204
+ public setParentStore(parentStore: any): void {
205
+ this.parentStore = parentStore;
206
+ this.widget.applyParentStore(this);
207
+ }
208
+
209
+ public init(context: RenderingContext): void {
210
+ // widget is initialized when the first instance is initialized
211
+ if (!this.widget.initialized) {
212
+ this.widget.init();
213
+ this.widget.initialized = true;
214
+ }
215
+
216
+ if (!this.dataSelector) {
217
+ this.widget.selector!.init(this.parentStore);
218
+ this.dataSelector = this.widget.selector!.createStoreSelector();
219
+ }
220
+
221
+ // init instance might change the store, so this must go before the controller initialization
222
+ this.widget.initInstance(context, this);
223
+
224
+ // initInstance can set the store, otherwise use parent store
225
+ if (!this.store) this.store = this.parentStore;
226
+ if (this.widget.onInit) this.widget.onInit(context, this);
227
+
228
+ this.widget.initState(context, this);
229
+
230
+ if (this.widget.controller)
231
+ this.controller = Controller.create(this.widget.controller, {
232
+ widget: this.widget,
233
+ instance: this,
234
+ store: this.store,
235
+ });
236
+
237
+ if (
238
+ this.widget.exploreCleanup ||
239
+ this.widget.outerLayout ||
240
+ this.widget.isContent ||
241
+ this.widget.controller ||
242
+ this.widget.prepareCleanup
243
+ )
244
+ this.needsExploreCleanup = true;
245
+ if (this.widget.prepare || this.widget.controller) this.needsPrepare = true;
246
+ if (this.widget.cleanup || this.widget.controller) this.needsCleanup = true;
247
+ this.initialized = true;
248
+ }
249
+
250
+ public checkVisible(context: RenderingContext): boolean {
251
+ if (!this.initialized) this.init(context);
252
+
253
+ const wasVisible = this.visible;
254
+ this.rawData = this.dataSelector!(this.store);
255
+ this.visible = this.widget.checkVisible(context, this, this.rawData);
256
+ if (this.visible && !this.detached) this.parent!.instanceCache!.addChild(this);
257
+ this.explored = false;
258
+ this.prepared = false;
259
+
260
+ if (!this.visible && wasVisible) this.destroy();
261
+
262
+ return this.visible;
263
+ }
264
+
265
+ public scheduleExploreIfVisible(context: RenderingContext): boolean {
266
+ if (this.checkVisible(context)) {
267
+ context.exploreStack.push(this);
268
+
269
+ if (this.needsExploreCleanup) context.exploreStack.push(this);
270
+
271
+ return true;
272
+ }
273
+ return false;
274
+ }
275
+
276
+ public cache(key: string, value: any): boolean {
277
+ const oldValue = this.cached[key];
278
+ if (oldValue === value) return false;
279
+
280
+ if (!this.cacheList) this.cacheList = {};
281
+ this.cacheList[key] = value;
282
+ return true;
283
+ }
284
+
285
+ public markShouldUpdate(context: RenderingContext): void {
286
+ let ins: Instance | undefined = this;
287
+ let renderList = this.renderList;
288
+ renderList.markReverseIndex();
289
+
290
+ //notify all parents that child state changed to bust up caching
291
+ while (ins && !ins.shouldUpdate && ins.explored) {
292
+ if (ins.renderList !== renderList) {
293
+ renderList.reverse();
294
+ renderList = ins.renderList;
295
+ renderList.markReverseIndex();
296
+ }
297
+ ins.shouldUpdate = true;
298
+ renderList.data.push(ins);
299
+ ins = ins.widget.isContent
300
+ ? ins.contentPlaceholder
301
+ : ins.parent?.outerLayout === ins
302
+ ? ins.parent?.parent
303
+ : ins.parent;
304
+ }
305
+ renderList.reverse();
306
+ }
307
+
308
+ public explore(context: RenderingContext): void {
309
+ if (!this.visible) throw new Error("Explore invisible!");
310
+
311
+ if (this.explored) {
312
+ if (this.widget.prepareCleanup) context.prepareList.push(this);
313
+
314
+ if (this.widget.exploreCleanup) this.widget.exploreCleanup(context, this);
315
+
316
+ if (this.parent?.outerLayout === this) context.popNamedValue("content", "body");
317
+
318
+ if (this.widget.controller) context.pop("controller");
319
+
320
+ return;
321
+ }
322
+
323
+ this.explored = true;
324
+
325
+ if (this.needsPrepare) context.prepareList.push(this);
326
+ else this.prepared = true;
327
+
328
+ if (this.needsCleanup) context.cleanupList.push(this);
329
+
330
+ if (this.instanceCache) this.instanceCache.mark();
331
+
332
+ //controller may reconfigure the widget and need to go before shouldUpdate calculation
333
+ this.parentOptions = context.parentOptions;
334
+
335
+ if (!this.controller) {
336
+ if (context.controller) this.controller = context.controller;
337
+ else if (this.parent?.controller) this.controller = this.parent?.controller;
338
+ }
339
+
340
+ this.destroyTracked = false;
341
+
342
+ if (this.controller) {
343
+ if (this.widget.controller) {
344
+ if (!this.controller.initialized) {
345
+ this.controller.init(context);
346
+ this.controller.initialized = true;
347
+ }
348
+ context.push("controller", this.controller);
349
+ this.controller.explore(context);
350
+ if (this.controller.onDestroy && this.controller.widget == this.widget) this.trackDestroy();
351
+ }
352
+ }
353
+
354
+ if (this.widget.onDestroy || isNonEmptyArray(this.destroySubscriptions)) this.trackDestroy();
355
+
356
+ this.renderList = this.assignedRenderList || this.parent?.renderList || context.getRootRenderList();
357
+
358
+ let shouldUpdate =
359
+ this.rawData !== this.cached.rawData ||
360
+ this.state !== this.cached.state ||
361
+ this.widget.version !== this.cached.widgetVersion ||
362
+ this.cached.globalCacheIdentifier !== GlobalCacheIdentifier.get();
363
+
364
+ if (shouldUpdate) {
365
+ this.data = { ...this.rawData };
366
+ this.widget.prepareData(context, this);
367
+ debug(processDataFlag, this.widget);
368
+ }
369
+
370
+ //onExplore might set the outer layout
371
+ if (this.widget.onExplore) this.widget.onExplore(context, this);
372
+
373
+ if (this.parent?.outerLayout === this) {
374
+ this.renderList = this.renderList.insertRight();
375
+ context.pushNamedValue("content", "body", this.parent);
376
+ }
377
+
378
+ if (this.widget.outerLayout) {
379
+ this.outerLayout = this.getChild(context, this.widget.outerLayout, null, this.store);
380
+ this.outerLayout.scheduleExploreIfVisible(context);
381
+ this.renderList = this.renderList.insertLeft();
382
+ }
383
+
384
+ if (this.widget.isContent) {
385
+ this.contentPlaceholder = context.contentPlaceholder && context.contentPlaceholder[this.widget.putInto!];
386
+ if (this.contentPlaceholder) context.contentPlaceholder[this.widget.putInto!](this);
387
+ else {
388
+ this.renderList = this.renderList.insertLeft();
389
+ context.pushNamedValue("content", this.widget.putInto!, this);
390
+ if (!context.contentList) context.contentList = {};
391
+ let list = context.contentList[this.widget.putInto!];
392
+ if (!list) list = context.contentList[this.widget.putInto!] = [];
393
+ list.push(this);
394
+ }
395
+ }
396
+
397
+ this.shouldUpdate = false;
398
+ if (shouldUpdate || this.childStateDirty || !this.widget.memoize) this.markShouldUpdate(context);
399
+
400
+ context.exploreStack.hop();
401
+
402
+ if (this.widget.helpers) {
403
+ this.helpers = {};
404
+ for (let cmp in this.widget.helpers) {
405
+ let helper = this.widget.helpers[cmp];
406
+ if (helper) {
407
+ let ins = this.getChild(context, helper);
408
+ if (ins.scheduleExploreIfVisible(context)) this.helpers[cmp] = ins;
409
+ }
410
+ }
411
+ }
412
+
413
+ //TODO: check do we need to pass data here?
414
+ this.widget.explore(context, this, this.data);
415
+ }
416
+
417
+ public prepare(context: RenderingContext): void {
418
+ if (!this.visible) throw new Error("Prepare invisible!");
419
+
420
+ if (this.prepared) {
421
+ if (this.widget.prepareCleanup) this.widget.prepareCleanup(context, this);
422
+ return;
423
+ }
424
+
425
+ this.prepared = true;
426
+ if (this.widget.prepare) this.widget.prepare(context, this);
427
+
428
+ if (this.widget.controller && this.controller?.prepare) this.controller.prepare(context);
429
+ }
430
+
431
+ public render(context: RenderingContext): null | Record<string, React.ReactNode> | React.ReactNode[] {
432
+ if (!this.visible) throw new Error("Render invisible!");
433
+
434
+ if (this.shouldUpdate) {
435
+ debug(renderFlag, this.widget, this.key);
436
+ const vdom = renderResultFix(this.widget.render(context, this, this.key));
437
+ if (this.widget.isContent || this.outerLayout) this.contentVDOM = vdom;
438
+ else this.vdom = vdom;
439
+ }
440
+
441
+ if (this.cacheList) {
442
+ for (const key in this.cacheList) {
443
+ this.cached[key] = this.cacheList[key];
444
+ }
445
+ }
446
+
447
+ this.cacheList = null;
448
+
449
+ this.cached.rawData = this.rawData;
450
+ this.cached.data = this.data;
451
+ this.cached.state = this.state;
452
+ this.cached.widgetVersion = this.widget.version;
453
+ this.cached.globalCacheIdentifier = GlobalCacheIdentifier.get();
454
+ this.childStateDirty = false;
455
+
456
+ if (this.instanceCache) this.instanceCache.sweep();
457
+
458
+ if (this.parent?.outerLayout === this) {
459
+ //if outer layouts are chained we need to find the originating element (last element with OL set)
460
+ let parent = this.parent;
461
+ while (parent.parent?.outerLayout == parent) parent = parent.parent;
462
+ parent.vdom = this.vdom;
463
+ }
464
+
465
+ return this.vdom;
466
+ }
467
+
468
+ public cleanup(context: RenderingContext): void {
469
+ if (this.widget.controller && this.controller?.cleanup) this.controller.cleanup(context);
470
+
471
+ if (this.widget.cleanup) this.widget.cleanup(context, this);
472
+ }
473
+
474
+ private trackDestroy(): void {
475
+ if (!this.destroyTracked) {
476
+ this.destroyTracked = true;
477
+ if (this.parent && !this.detached) this.parent.trackDestroyableChild(this);
478
+ }
479
+ }
480
+
481
+ private trackDestroyableChild(child: Instance): void {
482
+ this.instanceCache!.trackDestroy(child);
483
+ this.trackDestroy();
484
+ }
485
+
486
+ public subscribeOnDestroy(callback: () => void): () => void {
487
+ if (!this.destroySubscriptions) this.destroySubscriptions = [];
488
+ this.destroySubscriptions.push(callback);
489
+ this.trackDestroy();
490
+ return () => {
491
+ if (this.destroySubscriptions) {
492
+ this.destroySubscriptions = this.destroySubscriptions.filter((cb) => cb !== callback);
493
+ }
494
+ };
495
+ }
496
+
497
+ public destroy(): void {
498
+ if (this.instanceCache) {
499
+ this.instanceCache.destroy();
500
+ this.instanceCache = null;
501
+ }
502
+
503
+ if (this.destroySubscriptions) {
504
+ this.destroySubscriptions.forEach((cb) => cb());
505
+ this.destroySubscriptions = null;
506
+ }
507
+
508
+ if (this.destroyTracked) {
509
+ debug(destroyFlag, this);
510
+
511
+ if (this.widget.onDestroy) this.widget.onDestroy(this);
512
+
513
+ if (
514
+ this.widget.controller &&
515
+ this.controller &&
516
+ this.controller.onDestroy &&
517
+ this.controller.widget == this.widget
518
+ )
519
+ this.controller.onDestroy();
520
+
521
+ this.destroyTracked = false;
522
+ }
523
+ }
524
+
525
+ public setState(state: Record<string, any>): void {
526
+ let skip = !!this.state;
527
+ if (this.state) {
528
+ for (const k in state) {
529
+ if (this.state[k] !== state[k]) {
530
+ skip = false;
531
+ break;
532
+ }
533
+ }
534
+ }
535
+
536
+ if (skip) return;
537
+
538
+ this.state = Object.assign({}, this.state, state);
539
+ let parent = this.parent;
540
+ //notify all parents that child state change to bust up caching
541
+ while (parent) {
542
+ parent.childStateDirty = true;
543
+ parent = parent.parent;
544
+ }
545
+ batchUpdates(() => {
546
+ this.store.notify();
547
+ });
548
+ }
549
+
550
+ public set(prop: string, value: any, options: { internal?: boolean; immediate?: boolean } = {}): boolean {
551
+ //skip re-rendering (used for reading state from uncontrolled components)
552
+ if (options.internal && this.rawData) {
553
+ this.rawData[prop] = value;
554
+ this.data[prop] = value;
555
+ }
556
+
557
+ const setter = this.setters && this.setters[prop];
558
+ if (setter) {
559
+ if (options.immediate && isFunction(setter.reset)) setter.reset(value);
560
+ else setter(value);
561
+ return true;
562
+ }
563
+
564
+ const p = (this.widget as any)[prop];
565
+ if (p && typeof p == "object") {
566
+ if (p.debounce) {
567
+ this.definePropertySetter(
568
+ prop,
569
+ validatedDebounce(
570
+ (value: any) => this.doSet(prop, value),
571
+ () => this.dataSelector!(this.store)[prop],
572
+ p.debounce,
573
+ ),
574
+ );
575
+ this.set(prop, value, options);
576
+ return true;
577
+ }
578
+
579
+ if (p.throttle) {
580
+ this.definePropertySetter(
581
+ prop,
582
+ throttle((value: any) => this.doSet(prop, value), p.throttle),
583
+ );
584
+ this.set(prop, value, options);
585
+ return true;
586
+ }
587
+ }
588
+
589
+ return this.doSet(prop, value);
590
+ }
591
+
592
+ public definePropertySetter(prop: string, setter: any): void {
593
+ if (!this.setters) this.setters = {};
594
+ this.setters[prop] = setter;
595
+ }
596
+
597
+ protected doSet(prop: string, value: any): boolean {
598
+ let changed = false;
599
+ batchUpdates(() => {
600
+ const p = (this.widget as any)[prop];
601
+ if (isObject(p)) {
602
+ const pObj = p as any;
603
+ if (pObj.set) {
604
+ if (isFunction(pObj.set)) {
605
+ pObj.set(value, this);
606
+ changed = true;
607
+ } else if (isString(pObj.set)) {
608
+ (this.controller as any)?.[pObj.set](value, this);
609
+ changed = true;
610
+ }
611
+ } else if (pObj.action) {
612
+ const action = pObj.action(value, this);
613
+ this.store.dispatch(action);
614
+ changed = true;
615
+ } else if (isString(pObj.bind) || isAccessorChain(pObj.bind)) {
616
+ changed = this.store.set(pObj.bind, value);
617
+ }
618
+ } else if (isAccessorChain(p)) {
619
+ changed = this.store.set(p.toString(), value);
620
+ }
621
+ });
622
+ return changed;
623
+ }
624
+
625
+ public nestedDataSet(key: string, value: any, dataConfig: Record<string, any>, useParentStore?: boolean): boolean {
626
+ let config = dataConfig[key];
627
+ if (!config)
628
+ throw new Error(`Unknown nested data key ${key}. Known keys are ${Object.keys(dataConfig).join(", ")}.`);
629
+
630
+ if (isAccessorChain(config)) config = { bind: config.toString() };
631
+
632
+ if (config.bind) {
633
+ let store = this.store;
634
+ //in case of Rescope or DataProxy, bindings point to the data in the parent store
635
+ if (useParentStore && store.store) store = store.store;
636
+ return isUndefined(value) ? store.deleteItem(config.bind) : store.setItem(config.bind, value);
637
+ }
638
+
639
+ if (!config.set)
640
+ throw new Error(
641
+ `Cannot change nested data value for ${key} as it's read-only. Either define it as a binding or define a set function.`,
642
+ );
643
+ if (isString(config.set)) this.getControllerMethod(config.set)(value, this);
644
+ else if (isFunction(config.set)) config.set(value, this);
645
+ else
646
+ throw new Error(
647
+ `Cannot change nested data value for ${key} the defined setter is neither a function nor a controller method.`,
648
+ );
649
+
650
+ return true;
651
+ }
652
+
653
+ public replaceState(state: Record<string, any>): void {
654
+ this.cached.state = this.state;
655
+ this.state = state;
656
+ this.store.notify();
657
+ }
658
+
659
+ public getInstanceCache(): InstanceCache {
660
+ if (!this.instanceCache)
661
+ this.instanceCache = new InstanceCache(this, this.widget.isPureContainer ? this.key : null);
662
+ return this.instanceCache;
663
+ }
664
+
665
+ public clearChildrenCache(): void {
666
+ if (this.instanceCache) this.instanceCache.destroy();
667
+ }
668
+
669
+ public getChild(
670
+ context: RenderingContext | null,
671
+ widget: Widget,
672
+ key?: string | number | null,
673
+ store?: any,
674
+ ): Instance {
675
+ return this.getInstanceCache().getChild(widget, store ?? this.store, key);
676
+ }
677
+
678
+ public getDetachedChild(widget: Widget, key: string, store?: any): Instance {
679
+ const child = new Instance(widget, key, this, store ?? this.store);
680
+ child.detached = true;
681
+ return child;
682
+ }
683
+
684
+ public prepareRenderCleanupChild(widget: any, store?: any, keyPrefix?: string, options?: any): any {
685
+ return widget.prepareRenderCleanup(store ?? this.store, options, keyPrefix, this);
686
+ }
687
+
688
+ public getJsxEventProps(): Record<string, any> | null {
689
+ const { widget } = this;
690
+
691
+ if (!isArray(widget.jsxAttributes)) return null;
692
+
693
+ const props: Record<string, any> = {};
694
+ widget.jsxAttributes.forEach((attr) => {
695
+ if (attr.indexOf("on") == 0 && attr.length > 2) {
696
+ props[attr] = (e: any) => this.invoke(attr, e, this);
697
+ }
698
+ });
699
+ return props;
700
+ }
701
+
702
+ public getCallback(methodName: string): (...args: any[]) => any {
703
+ const scope = this.widget as any;
704
+ const callback = scope[methodName];
705
+
706
+ if (typeof callback === "string") return this.getControllerMethod(callback);
707
+
708
+ if (typeof callback !== "function")
709
+ throw new Error(`Cannot invoke callback method ${methodName} as assigned value is not a function.`);
710
+
711
+ return callback.bind(scope);
712
+ }
713
+
714
+ /**
715
+ * Finds the first controller in the instance tree matching the predicate
716
+ * @param predicate Function to test each controller
717
+ * @returns The matching controller or undefined
718
+ */
719
+ public findController(predicate: (controller: Controller) => boolean): Controller | undefined {
720
+ let at: Instance | undefined = this;
721
+ while (at?.controller != null) {
722
+ if (predicate(at.controller)) {
723
+ return at.controller;
724
+ }
725
+ at = at.parent;
726
+ }
727
+ return undefined;
728
+ }
729
+
730
+ /**
731
+ * Finds a controller of the specified type in the instance tree
732
+ * @param type Controller class/constructor to find
733
+ * @returns The matching controller cast to the specified type, or undefined
734
+ */
735
+ public findControllerByType<T extends Controller>(type: new (...args: any[]) => T): T | undefined {
736
+ return this.findController((c) => c instanceof type) as T | undefined;
737
+ }
738
+
739
+ /**
740
+ * Gets the first controller in the instance tree matching the predicate
741
+ * @param predicate Function to test each controller
742
+ * @returns The matching controller
743
+ * @throws Error if no matching controller is found
744
+ */
745
+ public getController(predicate: (controller: Controller) => boolean): Controller {
746
+ const controller = this.findController(predicate);
747
+ if (!controller) throw new Error("Cannot find a controller matching the given predicate in the instance tree.");
748
+ return controller;
749
+ }
750
+
751
+ /**
752
+ * Gets a controller of the specified type in the instance tree
753
+ * @param type Controller class/constructor to find
754
+ * @returns The matching controller cast to the specified type
755
+ * @throws Error if no controller of the specified type is found
756
+ */
757
+ public getControllerByType<T extends Controller>(type: new (...args: any[]) => T): T {
758
+ const controller = this.findControllerByType(type);
759
+ if (!controller) throw new Error(`Cannot find a controller of type "${type.name}" in the instance tree.`);
760
+ return controller;
761
+ }
762
+
763
+ public getControllerMethod(methodName: string): (...args: any[]) => any {
764
+ if (!this.controller)
765
+ throw new Error(
766
+ `Cannot invoke controller method "${methodName}" as controller is not assigned to the widget.`,
767
+ );
768
+
769
+ const controller = this.findController((c) => !!(c as any)[methodName]);
770
+
771
+ if (!controller)
772
+ throw new Error(
773
+ `Cannot invoke controller method "${methodName}". The method cannot be found in any of the assigned controllers.`,
774
+ );
775
+
776
+ return (controller as any)[methodName].bind(controller);
777
+ }
778
+
779
+ public invoke(methodName: string, ...args: any[]): any {
780
+ return this.getCallback(methodName).apply(null, args);
781
+ }
782
+
783
+ public invokeControllerMethod(methodName: string, ...args: any[]): any {
784
+ return this.getControllerMethod(methodName).apply(null, args);
785
+ }
786
+ }
787
+
788
+ function renderResultFix(res: any): any {
789
+ return res != null && isDefined(res.content) ? res : { content: res };
790
+ }
791
+
792
+ export class InstanceCache {
793
+ declare public children: Record<string, Instance>;
794
+ declare public parent: Instance;
795
+ declare public marked: Record<string, Instance>;
796
+ declare public monitored: Record<string, Instance> | null;
797
+ declare public keyPrefix: string;
798
+
799
+ constructor(parent: Instance, keyPrefix?: string | number | null) {
800
+ this.children = {};
801
+ this.parent = parent;
802
+ this.marked = {};
803
+ this.monitored = null;
804
+ this.keyPrefix = keyPrefix != null ? keyPrefix + "-" : "";
805
+ }
806
+
807
+ public getChild(widget: Widget, parentStore: any, key?: string | number | null): Instance {
808
+ const k = this.keyPrefix + (key != null ? key : widget.vdomKey || widget.widgetId);
809
+ let instance = this.children[k];
810
+
811
+ if (
812
+ !instance ||
813
+ instance.widget !== widget ||
814
+ (!instance.visible && (instance.widget.controller || instance.widget.onInit))
815
+ ) {
816
+ instance = new Instance(widget, k, this.parent, parentStore);
817
+ this.children[k] = instance;
818
+ } else if (instance.parentStore !== parentStore) {
819
+ instance.setParentStore(parentStore);
820
+ }
821
+
822
+ return instance;
823
+ }
824
+
825
+ public addChild(instance: Instance): void {
826
+ this.marked[instance.key] = instance;
827
+ }
828
+
829
+ public mark(): void {
830
+ this.marked = {};
831
+ }
832
+
833
+ public trackDestroy(instance: Instance): void {
834
+ if (!this.monitored) this.monitored = {};
835
+ this.monitored[instance.key as string] = instance;
836
+ }
837
+
838
+ public destroy(): void {
839
+ this.children = {};
840
+ this.marked = {};
841
+
842
+ if (!this.monitored) return;
843
+
844
+ for (const key in this.monitored) {
845
+ this.monitored[key].destroy();
846
+ }
847
+
848
+ this.monitored = null;
849
+ }
850
+
851
+ public sweep(): void {
852
+ this.children = this.marked;
853
+ if (!this.monitored) return;
854
+ let activeCount = 0;
855
+ for (const key in this.monitored) {
856
+ const monitoredChild = this.monitored[key];
857
+ const child = this.children[key];
858
+ if (child !== monitoredChild || !monitoredChild.visible) {
859
+ monitoredChild.destroy();
860
+ delete this.monitored[key];
861
+ if (child === monitoredChild) delete this.children[key];
862
+ } else activeCount++;
863
+ }
864
+ if (activeCount === 0) this.monitored = null;
865
+ }
866
+ }