@viewkitjs/views 0.0.0-stage → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (451) hide show
  1. package/CHANGELOG.md +615 -0
  2. package/LICENSE.md +7 -0
  3. package/README.md +99 -2
  4. package/dist/atoms/CommandMenu.d.ts +2 -0
  5. package/dist/atoms/CommandMenu.js +20 -0
  6. package/dist/atoms/List.d.ts +2 -0
  7. package/dist/atoms/List.js +6 -0
  8. package/dist/atoms/LoadMore.d.ts +2 -0
  9. package/dist/atoms/LoadMore.js +25 -0
  10. package/dist/atoms/Loading.d.ts +2 -0
  11. package/dist/atoms/Loading.js +7 -0
  12. package/dist/atoms/PlatformMark.d.ts +2 -0
  13. package/dist/atoms/PlatformMark.js +4 -0
  14. package/dist/atoms/RelationLink.d.ts +2 -0
  15. package/dist/atoms/RelationLink.js +6 -0
  16. package/dist/atoms/Row.d.ts +3 -0
  17. package/dist/atoms/Row.js +30 -0
  18. package/dist/atoms/RowMenu.d.ts +2 -0
  19. package/dist/atoms/RowMenu.js +112 -0
  20. package/dist/atoms/StatusBadge.d.ts +2 -0
  21. package/dist/atoms/StatusBadge.js +7 -0
  22. package/dist/atoms/StatusMarker.d.ts +2 -0
  23. package/dist/atoms/StatusMarker.js +19 -0
  24. package/dist/atoms/Tag.d.ts +2 -0
  25. package/dist/atoms/Tag.js +13 -0
  26. package/dist/atoms/TickBox.d.ts +2 -0
  27. package/dist/atoms/TickBox.js +8 -0
  28. package/dist/atoms/defaults.d.ts +2 -0
  29. package/dist/atoms/defaults.js +27 -0
  30. package/dist/atoms/tones.d.ts +5 -0
  31. package/dist/atoms/tones.js +28 -0
  32. package/dist/atoms/types.d.ts +178 -0
  33. package/dist/atoms/types.js +3 -0
  34. package/dist/cells/cell-format.d.ts +138 -0
  35. package/dist/cells/cell-format.js +16 -0
  36. package/dist/cells/cell-title.d.ts +17 -0
  37. package/dist/cells/cell-title.js +8 -0
  38. package/dist/cells/cell-values.d.ts +28 -0
  39. package/dist/cells/cell-values.js +87 -0
  40. package/dist/cells/index.d.ts +4 -0
  41. package/dist/cells/index.js +4 -0
  42. package/dist/cells/legacy-field.d.ts +52 -0
  43. package/dist/cells/legacy-field.js +164 -0
  44. package/dist/cells/relation-wrap.d.ts +3 -0
  45. package/dist/cells/relation-wrap.js +24 -0
  46. package/dist/cells/use-cell-format.d.ts +5 -0
  47. package/dist/cells/use-cell-format.js +10 -0
  48. package/dist/contract.d.ts +461 -0
  49. package/dist/contract.js +682 -0
  50. package/dist/display/actor.d.ts +4 -0
  51. package/dist/display/actor.js +26 -0
  52. package/dist/display/boolean.d.ts +18 -0
  53. package/dist/display/boolean.js +43 -0
  54. package/dist/display/breakdown.d.ts +15 -0
  55. package/dist/display/breakdown.js +32 -0
  56. package/dist/display/currency.d.ts +9 -0
  57. package/dist/display/currency.js +29 -0
  58. package/dist/display/date.d.ts +12 -0
  59. package/dist/display/date.js +26 -0
  60. package/dist/display/display-cores.d.ts +31 -0
  61. package/dist/display/display-cores.js +57 -0
  62. package/dist/display/entity-chip.d.ts +26 -0
  63. package/dist/display/entity-chip.js +9 -0
  64. package/dist/display/format.d.ts +66 -0
  65. package/dist/display/format.js +190 -0
  66. package/dist/display/index.d.ts +8 -0
  67. package/dist/display/index.js +7 -0
  68. package/dist/display/link.d.ts +29 -0
  69. package/dist/display/link.js +50 -0
  70. package/dist/display/location.d.ts +8 -0
  71. package/dist/display/location.js +22 -0
  72. package/dist/display/multi-value.d.ts +18 -0
  73. package/dist/display/multi-value.js +28 -0
  74. package/dist/display/name.d.ts +6 -0
  75. package/dist/display/name.js +14 -0
  76. package/dist/display/number.d.ts +11 -0
  77. package/dist/display/number.js +27 -0
  78. package/dist/display/options.d.ts +153 -0
  79. package/dist/display/options.js +1 -0
  80. package/dist/display/percent.d.ts +4 -0
  81. package/dist/display/percent.js +40 -0
  82. package/dist/display/phone.d.ts +11 -0
  83. package/dist/display/phone.js +45 -0
  84. package/dist/display/range.d.ts +6 -0
  85. package/dist/display/range.js +29 -0
  86. package/dist/display/relation.d.ts +4 -0
  87. package/dist/display/relation.js +29 -0
  88. package/dist/display/rich-text.d.ts +10 -0
  89. package/dist/display/rich-text.js +34 -0
  90. package/dist/display/select.d.ts +6 -0
  91. package/dist/display/select.js +38 -0
  92. package/dist/display/text-class.d.ts +23 -0
  93. package/dist/display/text-class.js +5 -0
  94. package/dist/display/text.d.ts +19 -0
  95. package/dist/display/text.js +8 -0
  96. package/dist/display/use-display-options.d.ts +2 -0
  97. package/dist/display/use-display-options.js +14 -0
  98. package/dist/display/user.d.ts +11 -0
  99. package/dist/display/user.js +10 -0
  100. package/dist/display/value-list.d.ts +10 -0
  101. package/dist/display/value-list.js +12 -0
  102. package/dist/display/viewer.d.ts +4 -0
  103. package/dist/display/viewer.js +11 -0
  104. package/dist/display/web-href.d.ts +8 -0
  105. package/dist/display/web-href.js +12 -0
  106. package/dist/editors/ChipsEditor.d.ts +59 -0
  107. package/dist/editors/ChipsEditor.js +73 -0
  108. package/dist/editors/DateEditor.d.ts +25 -0
  109. package/dist/editors/DateEditor.js +122 -0
  110. package/dist/editors/LocationEditor.d.ts +22 -0
  111. package/dist/editors/LocationEditor.js +228 -0
  112. package/dist/editors/NameEditor.d.ts +22 -0
  113. package/dist/editors/NameEditor.js +92 -0
  114. package/dist/editors/NumberEditor.d.ts +67 -0
  115. package/dist/editors/NumberEditor.js +86 -0
  116. package/dist/editors/RangeEditor.d.ts +22 -0
  117. package/dist/editors/RangeEditor.js +70 -0
  118. package/dist/editors/RelationEditor.d.ts +65 -0
  119. package/dist/editors/RelationEditor.js +64 -0
  120. package/dist/editors/SelectEditor.d.ts +72 -0
  121. package/dist/editors/SelectEditor.js +59 -0
  122. package/dist/editors/ValueListEditor.d.ts +38 -0
  123. package/dist/editors/ValueListEditor.js +217 -0
  124. package/dist/editors/edit-cores.d.ts +83 -0
  125. package/dist/editors/edit-cores.js +38 -0
  126. package/dist/editors/edit-session.d.ts +74 -0
  127. package/dist/editors/edit-session.js +35 -0
  128. package/dist/editors/open-values.d.ts +28 -0
  129. package/dist/editors/open-values.js +26 -0
  130. package/dist/editors/relation-source.d.ts +66 -0
  131. package/dist/editors/relation-source.js +102 -0
  132. package/dist/fields/binding.d.ts +87 -0
  133. package/dist/fields/binding.js +117 -0
  134. package/dist/fields/currency.d.ts +82 -0
  135. package/dist/fields/currency.js +41 -0
  136. package/dist/fields/denomination.d.ts +42 -0
  137. package/dist/fields/denomination.js +11 -0
  138. package/dist/fields/edit-core-types.d.ts +40 -0
  139. package/dist/fields/edit-core-types.js +29 -0
  140. package/dist/fields/format-knobs.d.ts +34 -0
  141. package/dist/fields/format-knobs.js +36 -0
  142. package/dist/fields/menus.d.ts +28 -0
  143. package/dist/fields/menus.js +1 -0
  144. package/dist/fields/money.d.ts +60 -0
  145. package/dist/fields/money.js +78 -0
  146. package/dist/fields/number-edit.d.ts +11 -0
  147. package/dist/fields/number-edit.js +17 -0
  148. package/dist/fields/prepare-write.d.ts +55 -0
  149. package/dist/fields/prepare-write.js +67 -0
  150. package/dist/fields/relation-source-types.d.ts +54 -0
  151. package/dist/fields/relation-source-types.js +1 -0
  152. package/dist/figures.d.ts +52 -0
  153. package/dist/figures.js +63 -0
  154. package/dist/filters/date-filter.d.ts +2 -0
  155. package/dist/filters/date-filter.js +1 -0
  156. package/dist/filters/filter-model.d.ts +176 -0
  157. package/dist/filters/filter-model.js +41 -0
  158. package/dist/filters/number-filter.d.ts +2 -0
  159. package/dist/filters/number-filter.js +1 -0
  160. package/dist/filters/range-filter.d.ts +2 -0
  161. package/dist/filters/range-filter.js +1 -0
  162. package/dist/filters/registry.d.ts +103 -0
  163. package/dist/filters/registry.js +8 -0
  164. package/dist/filters/relation-filter.d.ts +16 -0
  165. package/dist/filters/relation-filter.js +53 -0
  166. package/dist/filters/text-filter.d.ts +2 -0
  167. package/dist/filters/text-filter.js +1 -0
  168. package/dist/grid/chrome/GridAddColumn.d.ts +11 -0
  169. package/dist/grid/chrome/GridAddColumn.js +29 -0
  170. package/dist/grid/chrome/GridAggregateMenu.d.ts +31 -0
  171. package/dist/grid/chrome/GridAggregateMenu.js +27 -0
  172. package/dist/grid/chrome/GridCellEditors.d.ts +64 -0
  173. package/dist/grid/chrome/GridCellEditors.js +55 -0
  174. package/dist/grid/chrome/GridCellOutline.d.ts +70 -0
  175. package/dist/grid/chrome/GridCellOutline.js +21 -0
  176. package/dist/grid/chrome/GridChipsEditor.d.ts +28 -0
  177. package/dist/grid/chrome/GridChipsEditor.js +40 -0
  178. package/dist/grid/chrome/GridColumnColorSection.d.ts +11 -0
  179. package/dist/grid/chrome/GridColumnColorSection.js +40 -0
  180. package/dist/grid/chrome/GridColumnDateSection.d.ts +23 -0
  181. package/dist/grid/chrome/GridColumnDateSection.js +23 -0
  182. package/dist/grid/chrome/GridColumnDurationSection.d.ts +19 -0
  183. package/dist/grid/chrome/GridColumnDurationSection.js +24 -0
  184. package/dist/grid/chrome/GridColumnMenu.d.ts +101 -0
  185. package/dist/grid/chrome/GridColumnMenu.js +99 -0
  186. package/dist/grid/chrome/GridColumnNumberSection.d.ts +25 -0
  187. package/dist/grid/chrome/GridColumnNumberSection.js +27 -0
  188. package/dist/grid/chrome/GridColumnPercentSection.d.ts +15 -0
  189. package/dist/grid/chrome/GridColumnPercentSection.js +16 -0
  190. package/dist/grid/chrome/GridColumnSortSection.d.ts +18 -0
  191. package/dist/grid/chrome/GridColumnSortSection.js +16 -0
  192. package/dist/grid/chrome/GridDateEditor.d.ts +22 -0
  193. package/dist/grid/chrome/GridDateEditor.js +31 -0
  194. package/dist/grid/chrome/GridFlyout.d.ts +44 -0
  195. package/dist/grid/chrome/GridFlyout.js +80 -0
  196. package/dist/grid/chrome/GridFooter.d.ts +23 -0
  197. package/dist/grid/chrome/GridFooter.js +81 -0
  198. package/dist/grid/chrome/GridGroupMenu.d.ts +37 -0
  199. package/dist/grid/chrome/GridGroupMenu.js +57 -0
  200. package/dist/grid/chrome/GridHeader.d.ts +61 -0
  201. package/dist/grid/chrome/GridHeader.js +37 -0
  202. package/dist/grid/chrome/GridLongTextEditor.d.ts +36 -0
  203. package/dist/grid/chrome/GridLongTextEditor.js +127 -0
  204. package/dist/grid/chrome/GridMenuRow.d.ts +15 -0
  205. package/dist/grid/chrome/GridMenuRow.js +15 -0
  206. package/dist/grid/chrome/GridNameEditor.d.ts +19 -0
  207. package/dist/grid/chrome/GridNameEditor.js +36 -0
  208. package/dist/grid/chrome/GridNumberEditor.d.ts +35 -0
  209. package/dist/grid/chrome/GridNumberEditor.js +25 -0
  210. package/dist/grid/chrome/GridRangeEditor.d.ts +20 -0
  211. package/dist/grid/chrome/GridRangeEditor.js +25 -0
  212. package/dist/grid/chrome/GridRelationEditor.d.ts +21 -0
  213. package/dist/grid/chrome/GridRelationEditor.js +30 -0
  214. package/dist/grid/chrome/GridResizeHandle.d.ts +19 -0
  215. package/dist/grid/chrome/GridResizeHandle.js +19 -0
  216. package/dist/grid/chrome/GridRow.d.ts +25 -0
  217. package/dist/grid/chrome/GridRow.js +136 -0
  218. package/dist/grid/chrome/GridRowActions.d.ts +32 -0
  219. package/dist/grid/chrome/GridRowActions.js +25 -0
  220. package/dist/grid/chrome/GridRowCells.d.ts +4 -0
  221. package/dist/grid/chrome/GridRowCells.js +133 -0
  222. package/dist/grid/chrome/GridRowGlyph.d.ts +12 -0
  223. package/dist/grid/chrome/GridRowGlyph.js +13 -0
  224. package/dist/grid/chrome/GridSelectEditor.d.ts +18 -0
  225. package/dist/grid/chrome/GridSelectEditor.js +49 -0
  226. package/dist/grid/chrome/GridStructure.d.ts +48 -0
  227. package/dist/grid/chrome/GridStructure.js +45 -0
  228. package/dist/grid/chrome/GridTable.d.ts +4 -0
  229. package/dist/grid/chrome/GridTable.js +125 -0
  230. package/dist/grid/chrome/GridTableSurface.d.ts +15 -0
  231. package/dist/grid/chrome/GridTableSurface.js +6 -0
  232. package/dist/grid/chrome/GridTextEditor.d.ts +11 -0
  233. package/dist/grid/chrome/GridTextEditor.js +40 -0
  234. package/dist/grid/chrome/GridValueListEditor.d.ts +18 -0
  235. package/dist/grid/chrome/GridValueListEditor.js +36 -0
  236. package/dist/grid/chrome/StuckMarker.d.ts +16 -0
  237. package/dist/grid/chrome/StuckMarker.js +34 -0
  238. package/dist/grid/chrome/cell-clipboard.d.ts +9 -0
  239. package/dist/grid/chrome/cell-clipboard.js +28 -0
  240. package/dist/grid/chrome/cells.d.ts +21 -0
  241. package/dist/grid/chrome/cells.js +20 -0
  242. package/dist/grid/chrome/checks.d.ts +35 -0
  243. package/dist/grid/chrome/checks.js +22 -0
  244. package/dist/grid/chrome/column-glyph.d.ts +14 -0
  245. package/dist/grid/chrome/column-glyph.js +44 -0
  246. package/dist/grid/chrome/editors.d.ts +9 -0
  247. package/dist/grid/chrome/editors.js +10 -0
  248. package/dist/grid/chrome/grid-cell-classes.d.ts +59 -0
  249. package/dist/grid/chrome/grid-cell-classes.js +30 -0
  250. package/dist/grid/chrome/grid-menu-search.d.ts +7 -0
  251. package/dist/grid/chrome/grid-menu-search.js +7 -0
  252. package/dist/grid/chrome/grid-row-props.d.ts +131 -0
  253. package/dist/grid/chrome/grid-row-props.js +1 -0
  254. package/dist/grid/chrome/grid-styles.d.ts +37 -0
  255. package/dist/grid/chrome/grid-styles.js +8 -0
  256. package/dist/grid/chrome/grid-table-props.d.ts +173 -0
  257. package/dist/grid/chrome/grid-table-props.js +1 -0
  258. package/dist/grid/chrome/useGridBatchApi.d.ts +34 -0
  259. package/dist/grid/chrome/useGridBatchApi.js +35 -0
  260. package/dist/grid/chrome/useGridColumnLayout.d.ts +30 -0
  261. package/dist/grid/chrome/useGridColumnLayout.js +206 -0
  262. package/dist/grid/chrome/useGridHeaderDrag.d.ts +20 -0
  263. package/dist/grid/chrome/useGridHeaderDrag.js +37 -0
  264. package/dist/grid/chrome/useGridKeyboard.d.ts +47 -0
  265. package/dist/grid/chrome/useGridKeyboard.js +274 -0
  266. package/dist/grid/chrome/useGridPendingReconciliation.d.ts +12 -0
  267. package/dist/grid/chrome/useGridPendingReconciliation.js +32 -0
  268. package/dist/grid/chrome/useGridRailReveal.d.ts +57 -0
  269. package/dist/grid/chrome/useGridRailReveal.js +67 -0
  270. package/dist/grid/chrome/useGridRangeActions.d.ts +49 -0
  271. package/dist/grid/chrome/useGridRangeActions.js +188 -0
  272. package/dist/grid/chrome/useGridRangeGestures.d.ts +32 -0
  273. package/dist/grid/chrome/useGridRangeGestures.js +190 -0
  274. package/dist/grid/chrome/useGridRowContextMenu.d.ts +35 -0
  275. package/dist/grid/chrome/useGridRowContextMenu.js +127 -0
  276. package/dist/grid/chrome/useGridScaleStyles.d.ts +1 -0
  277. package/dist/grid/chrome/useGridScaleStyles.js +29 -0
  278. package/dist/grid/chrome/useGridScrollSync.d.ts +38 -0
  279. package/dist/grid/chrome/useGridScrollSync.js +176 -0
  280. package/dist/grid/chrome/useGridTableInteractionModel.d.ts +55 -0
  281. package/dist/grid/chrome/useGridTableInteractionModel.js +197 -0
  282. package/dist/grid/chrome/useGridTableSelection.d.ts +29 -0
  283. package/dist/grid/chrome/useGridTableSelection.js +55 -0
  284. package/dist/grid/chrome/useHeaderDragReorder.d.ts +21 -0
  285. package/dist/grid/chrome/useHeaderDragReorder.js +216 -0
  286. package/dist/grid/core/clipboard-model.d.ts +81 -0
  287. package/dist/grid/core/clipboard-model.js +291 -0
  288. package/dist/grid/core/column-values.d.ts +27 -0
  289. package/dist/grid/core/column-values.js +76 -0
  290. package/dist/grid/core/commit-model.d.ts +34 -0
  291. package/dist/grid/core/commit-model.js +3 -0
  292. package/dist/grid/core/coordinates.d.ts +48 -0
  293. package/dist/grid/core/coordinates.js +27 -0
  294. package/dist/grid/core/edit-values.d.ts +9 -0
  295. package/dist/grid/core/edit-values.js +1 -0
  296. package/dist/grid/core/editing-controller.d.ts +59 -0
  297. package/dist/grid/core/editing-controller.js +240 -0
  298. package/dist/grid/core/editing-model.d.ts +78 -0
  299. package/dist/grid/core/editing-model.js +136 -0
  300. package/dist/grid/core/grid-scale.d.ts +14 -0
  301. package/dist/grid/core/grid-scale.js +8 -0
  302. package/dist/grid/core/nav.d.ts +94 -0
  303. package/dist/grid/core/nav.js +92 -0
  304. package/dist/grid/core/pending-reconciliation.d.ts +50 -0
  305. package/dist/grid/core/pending-reconciliation.js +49 -0
  306. package/dist/grid/core/range-model.d.ts +25 -0
  307. package/dist/grid/core/range-model.js +59 -0
  308. package/dist/grid/core/spreadsheet-operations.d.ts +85 -0
  309. package/dist/grid/core/spreadsheet-operations.js +253 -0
  310. package/dist/grid/core/useGridEditing.d.ts +43 -0
  311. package/dist/grid/core/useGridEditing.js +90 -0
  312. package/dist/grid/core/useGridRange.d.ts +20 -0
  313. package/dist/grid/core/useGridRange.js +24 -0
  314. package/dist/grid/core/value-equality.d.ts +32 -0
  315. package/dist/grid/core/value-equality.js +34 -0
  316. package/dist/grid/index.d.ts +18 -0
  317. package/dist/grid/index.js +5 -0
  318. package/dist/grid/useGridTablePrefs.d.ts +50 -0
  319. package/dist/grid/useGridTablePrefs.js +101 -0
  320. package/dist/grouping/sort-groups.d.ts +18 -0
  321. package/dist/grouping/sort-groups.js +33 -0
  322. package/dist/grouping/types.d.ts +10 -0
  323. package/dist/grouping/types.js +1 -0
  324. package/dist/index.d.ts +28 -0
  325. package/dist/index.js +28 -0
  326. package/dist/internal/chip.d.ts +4 -0
  327. package/dist/internal/chip.js +3 -0
  328. package/dist/internal/cx.d.ts +3 -0
  329. package/dist/internal/cx.js +3 -0
  330. package/dist/internal/viewport.d.ts +5 -0
  331. package/dist/internal/viewport.js +29 -0
  332. package/dist/model/aggregates.d.ts +59 -0
  333. package/dist/model/aggregates.js +186 -0
  334. package/dist/model/card-density.d.ts +8 -0
  335. package/dist/model/card-density.js +10 -0
  336. package/dist/model/card-layout.d.ts +85 -0
  337. package/dist/model/card-layout.js +90 -0
  338. package/dist/model/column-capabilities.d.ts +162 -0
  339. package/dist/model/column-capabilities.js +233 -0
  340. package/dist/model/column-filters.d.ts +106 -0
  341. package/dist/model/column-filters.js +321 -0
  342. package/dist/model/column-format.d.ts +103 -0
  343. package/dist/model/column-format.js +1 -0
  344. package/dist/model/column-from.d.ts +28 -0
  345. package/dist/model/column-from.js +160 -0
  346. package/dist/model/column-inspect.d.ts +18 -0
  347. package/dist/model/column-inspect.js +6 -0
  348. package/dist/model/column-knobs.d.ts +20 -0
  349. package/dist/model/column-knobs.js +16 -0
  350. package/dist/model/column-money.d.ts +13 -0
  351. package/dist/model/column-money.js +27 -0
  352. package/dist/model/column-order.d.ts +36 -0
  353. package/dist/model/column-order.js +68 -0
  354. package/dist/model/column-schema.d.ts +335 -0
  355. package/dist/model/column-schema.js +1 -0
  356. package/dist/model/column-sort.d.ts +17 -0
  357. package/dist/model/column-sort.js +11 -0
  358. package/dist/model/column-state.d.ts +77 -0
  359. package/dist/model/column-state.js +95 -0
  360. package/dist/model/column-types.d.ts +109 -0
  361. package/dist/model/column-types.js +50 -0
  362. package/dist/model/column-warnings.d.ts +44 -0
  363. package/dist/model/column-warnings.js +24 -0
  364. package/dist/model/density.d.ts +3 -0
  365. package/dist/model/density.js +13 -0
  366. package/dist/model/field-type-of.d.ts +21 -0
  367. package/dist/model/field-type-of.js +11 -0
  368. package/dist/model/filter-capabilities.d.ts +1 -0
  369. package/dist/model/filter-capabilities.js +1 -0
  370. package/dist/model/index.d.ts +38 -0
  371. package/dist/model/index.js +20 -0
  372. package/dist/model/part-rows.d.ts +28 -0
  373. package/dist/model/part-rows.js +40 -0
  374. package/dist/model/preferences.d.ts +155 -0
  375. package/dist/model/preferences.js +84 -0
  376. package/dist/model/prefs-buckets.d.ts +173 -0
  377. package/dist/model/prefs-buckets.js +71 -0
  378. package/dist/model/relation-filters.d.ts +45 -0
  379. package/dist/model/relation-filters.js +78 -0
  380. package/dist/model/render-count.d.ts +2 -0
  381. package/dist/model/render-count.js +24 -0
  382. package/dist/model/row-icon.d.ts +23 -0
  383. package/dist/model/row-icon.js +5 -0
  384. package/dist/model/view-rules.d.ts +73 -0
  385. package/dist/model/view-rules.js +216 -0
  386. package/dist/provider/ViewsProvider.d.ts +26 -0
  387. package/dist/provider/ViewsProvider.js +16 -0
  388. package/dist/provider/components.d.ts +230 -0
  389. package/dist/provider/components.js +3 -0
  390. package/dist/provider/context.d.ts +20 -0
  391. package/dist/provider/context.js +10 -0
  392. package/dist/provider/icons.d.ts +6 -0
  393. package/dist/provider/icons.js +1 -0
  394. package/dist/provider/menu-groups.d.ts +8 -0
  395. package/dist/provider/menu-groups.js +38 -0
  396. package/dist/provider/ports.d.ts +57 -0
  397. package/dist/provider/ports.js +9 -0
  398. package/dist/react.d.ts +9 -0
  399. package/dist/react.js +4 -0
  400. package/dist/selection/SelectCheckbox.d.ts +17 -0
  401. package/dist/selection/SelectCheckbox.js +11 -0
  402. package/dist/selection/index.d.ts +7 -0
  403. package/dist/selection/index.js +6 -0
  404. package/dist/selection/model.d.ts +55 -0
  405. package/dist/selection/model.js +86 -0
  406. package/dist/selection/row-click.d.ts +35 -0
  407. package/dist/selection/row-click.js +20 -0
  408. package/dist/selection/types.d.ts +17 -0
  409. package/dist/selection/types.js +1 -0
  410. package/dist/selection/useCheckDragSelect.d.ts +61 -0
  411. package/dist/selection/useCheckDragSelect.js +165 -0
  412. package/dist/selection/useListSelection.d.ts +39 -0
  413. package/dist/selection/useListSelection.js +48 -0
  414. package/dist/selection/useListSelectionShortcuts.d.ts +6 -0
  415. package/dist/selection/useListSelectionShortcuts.js +14 -0
  416. package/dist/selection/useRestIntent.d.ts +18 -0
  417. package/dist/selection/useRestIntent.js +35 -0
  418. package/docs/contract.md +525 -0
  419. package/docs/getting-started.md +250 -0
  420. package/docs/guides/atoms.md +245 -0
  421. package/docs/guides/cells.md +302 -0
  422. package/docs/guides/columns.md +412 -0
  423. package/docs/guides/display.md +203 -0
  424. package/docs/guides/editors.md +404 -0
  425. package/docs/guides/ports.md +246 -0
  426. package/docs/guides/selection.md +270 -0
  427. package/docs/guides/the-grid.md +677 -0
  428. package/docs/guides/the-provider.md +446 -0
  429. package/docs/index.md +50 -0
  430. package/docs/install.md +67 -0
  431. package/docs/reference/cells.md +28 -0
  432. package/docs/reference/display.md +42 -0
  433. package/docs/reference/editors-chips.md +6 -0
  434. package/docs/reference/editors-date.md +6 -0
  435. package/docs/reference/editors-location.md +10 -0
  436. package/docs/reference/editors-name.md +6 -0
  437. package/docs/reference/editors-number.md +11 -0
  438. package/docs/reference/editors-open-values.md +9 -0
  439. package/docs/reference/editors-range.md +6 -0
  440. package/docs/reference/editors-relation.md +9 -0
  441. package/docs/reference/editors-select.md +8 -0
  442. package/docs/reference/editors-session.md +9 -0
  443. package/docs/reference/editors-value-list.md +6 -0
  444. package/docs/reference/editors.md +5 -0
  445. package/docs/reference/grid.md +39 -0
  446. package/docs/reference/react.md +86 -0
  447. package/docs/reference/selection.md +33 -0
  448. package/docs/reference/views.md +601 -0
  449. package/docs/reshaping.md +19 -0
  450. package/package.json +118 -3
  451. package/skills/views/SKILL.md +102 -0
@@ -0,0 +1,321 @@
1
+ import { actorKey, COUNTRY_CODES, countryName, isIntegerField, isMultipleType, isOpenVocabulary, presentedDef, relationKey, scalarOf, valueItems, valueTypeOf, } from "@viewkitjs/fields";
2
+ import { matchesRule, operatorsFor } from "@viewkitjs/fields/query";
3
+ import { FILTER_PART_ROWS, parsePartKey, partKey, partLabel } from "./part-rows.js";
4
+ import { phoneFilterOperand, phoneMatchText, readPhone } from "@viewkitjs/fields/phone";
5
+ import { isTextRuleActive, matchesTextRule } from "../filters/text-filter.js";
6
+ import { matchesNameRule } from "@viewkitjs/fields/query";
7
+ import { matchesNumberRule } from "../filters/number-filter.js";
8
+ import { matchesRangeRule } from "../filters/range-filter.js";
9
+ import { matchesDateRule } from "../filters/date-filter.js";
10
+ import { typeRule } from "./column-types.js";
11
+ import { columnLabel } from "./column-capabilities.js";
12
+ import { isColumnHidden, prettifyOptionValue, resolveColumnOrder } from "./column-state.js";
13
+ import { fieldTypeOf } from "./field-type-of.js";
14
+ import { fieldKeyOf, fromListFilterRule } from "./view-rules.js";
15
+ export function filterEditor(col) {
16
+ return typeRule(col.type)?.filter ?? null;
17
+ }
18
+ const WIRED_EDITORS = new Set(["text", "options", "boolean", "number", "date", "range"]);
19
+ const NAMED_VALUE_TYPES = new Set(["relation", "user", "actor"]);
20
+ function relationOptions(known, names, onScreen) {
21
+ const byId = new Map();
22
+ for (const id of known ?? []) {
23
+ const name = names?.[id];
24
+ if (name !== undefined)
25
+ byId.set(id, name);
26
+ }
27
+ for (const value of onScreen ?? [])
28
+ if (!byId.has(value.id))
29
+ byId.set(value.id, value.label);
30
+ return [...byId]
31
+ .map(([value, label]) => ({ value, label }))
32
+ .sort((a, b) => a.label.localeCompare(b.label));
33
+ }
34
+ export const HIDDEN_COLUMN_SECTION = "Hidden columns";
35
+ export function numberDecimals(col, overrides) {
36
+ if (col.field && isIntegerField(col.field))
37
+ return 0;
38
+ return overrides?.[fieldKeyOf(col)] ?? col.format?.decimals ?? 2;
39
+ }
40
+ function numberUnit(col) {
41
+ if (fieldTypeOf(col) === "percent")
42
+ return "%";
43
+ if (col.format?.style === "duration")
44
+ return "s";
45
+ if (col.currencyAccessor)
46
+ return undefined;
47
+ if (fieldTypeOf(col) === "currency")
48
+ return col.format?.currency;
49
+ return undefined;
50
+ }
51
+ export function booleanFilterOptions(col) {
52
+ const display = col.format?.booleanDisplay ?? "checkbox";
53
+ if (display === "marker") {
54
+ const label = col.marker?.label ?? columnLabel(col).toLowerCase();
55
+ return [
56
+ { value: "true", label: label.charAt(0).toUpperCase() + label.slice(1) },
57
+ { value: "false", label: `Not ${label}` },
58
+ ];
59
+ }
60
+ if (display === "text") {
61
+ const labelFor = (value, fallback) => col.options?.find((o) => o.value === value)?.label ?? fallback;
62
+ return [
63
+ { value: "true", label: labelFor("true", "True") },
64
+ { value: "false", label: labelFor("false", "False") },
65
+ ];
66
+ }
67
+ return [
68
+ { value: "true", label: "Checked" },
69
+ { value: "false", label: "Unchecked" },
70
+ ];
71
+ }
72
+ export function buildColumnFilters({ columns, order, declared = [], icon, rules = {}, onRuleChange, selectValues = {}, relationValues = {}, decimals, columnState, viewId, capabilities, knownValues = {}, knownLabels = {}, onValuesWanted, parts = false, messages, conventions, }) {
73
+ const declaredByKey = new Map(declared.map((f) => [f.key, f]));
74
+ const claimed = new Set();
75
+ const buildOne = (col) => {
76
+ const capability = capabilities?.[col.id];
77
+ if (capability?.mode === "unavailable") {
78
+ return {
79
+ key: col.id,
80
+ label: columnLabel(col),
81
+ icon: icon?.(col),
82
+ editor: "unavailable",
83
+ reason: capability.reason,
84
+ stale: rules[col.id] !== undefined,
85
+ onClear: () => onRuleChange?.(col.id, null),
86
+ };
87
+ }
88
+ const own = declaredByKey.get(col.id);
89
+ if (own) {
90
+ claimed.add(col.id);
91
+ return { ...own, icon: own.icon ?? icon?.(col) };
92
+ }
93
+ const editor = filterEditor(col);
94
+ const wired = editor != null && WIRED_EDITORS.has(editor) && !!col.accessor;
95
+ const stored = rules[col.id];
96
+ if (wired && editor === "text") {
97
+ const rule = stored?.editor === "text" ? stored : null;
98
+ return {
99
+ key: col.id,
100
+ label: columnLabel(col),
101
+ icon: icon?.(col),
102
+ editor: "text",
103
+ value: rule ? { operator: rule.operator, query: rule.query } : null,
104
+ onChange: (next) => onRuleChange?.(col.id, next ? { editor: "text", ...next } : null),
105
+ };
106
+ }
107
+ if (wired && editor === "number") {
108
+ const rule = stored?.editor === "number" ? stored : null;
109
+ return {
110
+ key: col.id,
111
+ label: columnLabel(col),
112
+ icon: icon?.(col),
113
+ editor: "number",
114
+ value: rule ? { operator: rule.operator, value: rule.value, value2: rule.value2 } : null,
115
+ decimals: numberDecimals(col, decimals),
116
+ unit: numberUnit(col),
117
+ ...(col.format?.style === "duration"
118
+ ? { numberStyle: "duration", durationUnit: col.format.unit ?? "ms" }
119
+ : {}),
120
+ onChange: (next) => onRuleChange?.(col.id, next ? { editor: "number", ...next } : null),
121
+ };
122
+ }
123
+ if (wired && editor === "range") {
124
+ const rule = stored?.editor === "range" ? stored : null;
125
+ const def = col.field ? presentedDef(col.field) : undefined;
126
+ const range = def?.type === "range" ? def : undefined;
127
+ return {
128
+ key: col.id,
129
+ label: columnLabel(col),
130
+ icon: icon?.(col),
131
+ editor: "range",
132
+ value: rule ? { operator: rule.operator, value: rule.value, value2: rule.value2 } : null,
133
+ unit: range?.of === "percent" ? "%" : range?.of === "currency" ? range.code?.fixed : undefined,
134
+ presets: range?.presets,
135
+ onChange: (next) => onRuleChange?.(col.id, next ? { editor: "range", ...next } : null),
136
+ };
137
+ }
138
+ if (wired && editor === "date") {
139
+ const rule = stored?.editor === "date" ? stored : null;
140
+ return {
141
+ key: col.id,
142
+ label: columnLabel(col),
143
+ icon: icon?.(col),
144
+ editor: "date",
145
+ value: rule
146
+ ? {
147
+ operator: rule.operator,
148
+ from: rule.from,
149
+ to: rule.to,
150
+ direction: rule.direction,
151
+ unit: rule.unit,
152
+ }
153
+ : null,
154
+ onChange: (next) => onRuleChange?.(col.id, next ? { editor: "date", ...next } : null),
155
+ };
156
+ }
157
+ if (wired && (editor === "options" || editor === "boolean")) {
158
+ const shown = col.field ? presentedDef(col.field) : undefined;
159
+ const open = !!shown && isOpenVocabulary(shown);
160
+ const openSelect = open && shown?.type === "select";
161
+ const onScreen = selectValues[col.id] ?? (col.options ?? []).map((o) => o.value);
162
+ const values = open ? [...new Set([...(knownValues[col.id] ?? []), ...onScreen])] : onScreen;
163
+ const named = !!col.field && NAMED_VALUE_TYPES.has(col.field.type);
164
+ const options = editor === "boolean"
165
+ ? booleanFilterOptions(col)
166
+ :
167
+ col.type === "relation" || col.type === "user" || col.type === "actor"
168
+ ? relationOptions(knownValues[col.id], knownLabels[col.id], relationValues[col.id])
169
+ : values.map((value) => ({
170
+ value,
171
+ label: col.options?.find((o) => o.value === value)?.label ??
172
+ (openSelect ? value : prettifyOptionValue(value)),
173
+ }));
174
+ return {
175
+ key: col.id,
176
+ label: columnLabel(col),
177
+ icon: icon?.(col),
178
+ ...((open || named) && onValuesWanted ? { onOpen: () => onValuesWanted(col.id) } : {}),
179
+ multi: true,
180
+ value: stored?.editor === "options" ? stored.values : [],
181
+ options,
182
+ onChange: (next) => onRuleChange?.(col.id, next.length ? { editor: "options", values: next } : null),
183
+ emptyLabel: `All ${columnLabel(col).toLowerCase()}`,
184
+ };
185
+ }
186
+ return {
187
+ key: col.id,
188
+ label: columnLabel(col),
189
+ icon: icon?.(col),
190
+ multi: true,
191
+ value: [],
192
+ options: [],
193
+ onChange: () => { },
194
+ disabled: !wired,
195
+ ...(wired ? {} : { valueLabel: "—" }),
196
+ };
197
+ };
198
+ const buildPartRows = (col) => {
199
+ if (!parts || !col.field || !col.accessor)
200
+ return [];
201
+ if (declaredByKey.has(col.id) || capabilities?.[col.id]?.mode === "unavailable")
202
+ return [];
203
+ const type = valueTypeOf(col.field);
204
+ return (FILTER_PART_ROWS[type] ?? []).map((part) => {
205
+ const key = partKey(col.id, part);
206
+ const label = partLabel(columnLabel(col), type, part, messages);
207
+ const stored = rules[key];
208
+ if (operatorsFor(type, part)[0] === "is_any_of") {
209
+ const offered = [...new Set([...(knownValues[key] ?? []), ...(selectValues[key] ?? [])])];
210
+ const locale = conventions?.locale;
211
+ return {
212
+ key,
213
+ label,
214
+ icon: icon?.(col),
215
+ ...(onValuesWanted ? { onOpen: () => onValuesWanted(key) } : {}),
216
+ multi: true,
217
+ value: stored?.editor === "options" ? stored.values : [],
218
+ options: (offered.length ? offered : COUNTRY_CODES)
219
+ .map((value) => ({ value, label: countryName(value, locale) }))
220
+ .sort((a, b) => a.label.localeCompare(b.label, locale)),
221
+ onChange: (next) => onRuleChange?.(key, next.length ? { editor: "options", values: next } : null),
222
+ };
223
+ }
224
+ const rule = stored?.editor === "text" ? stored : null;
225
+ return {
226
+ key,
227
+ label,
228
+ icon: icon?.(col),
229
+ editor: "text",
230
+ value: rule ? { operator: rule.operator, query: rule.query } : null,
231
+ onChange: (next) => onRuleChange?.(key, next ? { editor: "text", ...next } : null),
232
+ };
233
+ });
234
+ };
235
+ const derived = resolveColumnOrder(columns, order).flatMap((col) => {
236
+ const partRows = buildPartRows(col);
237
+ const own = partRows.length && col.field && valueTypeOf(col.field) === "location" ? [] : [buildOne(col)];
238
+ const hidden = isColumnHidden(col, columnState, viewId);
239
+ return [...own, ...partRows].map((built) => built.section || !hidden ? built : { ...built, section: HIDDEN_COLUMN_SECTION });
240
+ });
241
+ return [...derived, ...declared.filter((f) => !claimed.has(f.key))];
242
+ }
243
+ function phoneTextRule(col, value, rule, conventions) {
244
+ if (fieldTypeOf(col) !== "phone" || readPhone(value)?.kind !== "international")
245
+ return [value, rule];
246
+ return [
247
+ phoneMatchText(value),
248
+ { ...rule, query: phoneFilterOperand(rule.operator, rule.query, conventions.region) },
249
+ ];
250
+ }
251
+ function textRuleHolds(col, value, rule, holds) {
252
+ if (!isMultipleType(fieldTypeOf(col)) || !Array.isArray(value))
253
+ return holds(value);
254
+ if (!isTextRuleActive(rule))
255
+ return true;
256
+ const values = valueItems(value).map((item) => item.value);
257
+ if (rule.operator === "is_empty")
258
+ return values.length === 0;
259
+ if (rule.operator === "is_not_empty")
260
+ return values.length > 0;
261
+ return rule.operator === "is_not" || rule.operator === "not_contains" ? values.every(holds) : values.some(holds);
262
+ }
263
+ function partRuleMatches(row, key, rule, columns, conventions) {
264
+ const { id, part } = parsePartKey(key);
265
+ if (part === undefined)
266
+ return true;
267
+ const col = columns.find((c) => c.id === id);
268
+ if (!col?.field || !col.accessor)
269
+ return true;
270
+ const type = valueTypeOf(col.field);
271
+ if (!FILTER_PART_ROWS[type]?.includes(part))
272
+ return true;
273
+ const filterRule = fromListFilterRule(fieldKeyOf(col), type, rule, part);
274
+ return !filterRule || matchesRule(type, col.accessor(row), filterRule, { conventions });
275
+ }
276
+ export function rowMatchesRules(row, rules, columns, decimals, conventions) {
277
+ const ids = Object.keys(rules);
278
+ if (ids.length === 0)
279
+ return true;
280
+ for (const id of ids) {
281
+ const rule = rules[id];
282
+ const col = columns.find((c) => c.id === id);
283
+ if (!col) {
284
+ if (!partRuleMatches(row, id, rule, columns, conventions))
285
+ return false;
286
+ continue;
287
+ }
288
+ if (!col.accessor)
289
+ continue;
290
+ const raw = col.field ? scalarOf(col.field, col.accessor(row)) : col.accessor(row);
291
+ const value = col.type === "boolean" ? String(raw === true) : raw;
292
+ const textMatch = fieldTypeOf(col) === "name" ? matchesNameRule : matchesTextRule;
293
+ if (rule.editor === "text") {
294
+ const holds = (one) => textMatch(...phoneTextRule(col, one, rule, conventions));
295
+ if (!textRuleHolds(col, value, rule, holds))
296
+ return false;
297
+ }
298
+ if (rule.editor === "options" && !matchesOptionsRule(value, rule.values))
299
+ return false;
300
+ if (rule.editor === "number" && !matchesNumberRule(value, rule, numberDecimals(col, decimals)))
301
+ return false;
302
+ if (rule.editor === "range" && !matchesRangeRule(value, rule))
303
+ return false;
304
+ if (rule.editor === "date" &&
305
+ !matchesDateRule(value, rule, undefined, undefined, conventions))
306
+ return false;
307
+ }
308
+ return true;
309
+ }
310
+ function matchesOptionsRule(value, picked) {
311
+ if (picked.length === 0)
312
+ return true;
313
+ if (Array.isArray(value))
314
+ return value.some((v) => picked.includes(optionKey(v)));
315
+ if (value == null)
316
+ return false;
317
+ return picked.includes(optionKey(value));
318
+ }
319
+ function optionKey(value) {
320
+ return actorKey(value) ?? relationKey(value) ?? String(value);
321
+ }
@@ -0,0 +1,103 @@
1
+ import type { ReactNode } from "react";
2
+ import type { PercentDisplay } from "@viewkitjs/fields";
3
+ import type { DurationStyle } from "@viewkitjs/fields/format/time";
4
+ export type ListDateStyle = "short" | "long" | "numeric" | "relative";
5
+ /** How a duration reads. Defined in `lib/format/time` beside the formatter
6
+ * that implements it, re-exported here so a column declares it in list
7
+ * vocabulary without two unions drifting apart. */
8
+ export type ListDurationStyle = DurationStyle;
9
+ export type ListNumberFormatState = {
10
+ decimals?: number;
11
+ /** A convertible money column's reading in force, and the readings the
12
+ * header menu offers (Original first). Absent on a column that reads one way. */
13
+ currency?: string;
14
+ currencyOptions?: {
15
+ value: string;
16
+ label: string;
17
+ }[];
18
+ };
19
+ export type ListNumberFormatOverrides = Record<string, ListNumberFormatState>;
20
+ export type ListDateStyleOverrides = Record<string, ListDateStyle>;
21
+ export type ListDurationStyleOverrides = Record<string, ListDurationStyle>;
22
+ export type ListShowTimeOverrides = Record<string, boolean>;
23
+ export type ListPercentDisplayOverrides = Record<string, PercentDisplay>;
24
+ export type ListColumnFormat = {
25
+ /**
26
+ * A `number` column's one denomination that is not a type: `duration` is
27
+ * always milliseconds, everywhere — the cell, the filter rule and the
28
+ * aggregate all carry ms and only the presentation is human (`1.2s`,
29
+ * `3m 04s`). That is what keeps it a number rather than a type of its own —
30
+ * comparison, sorting, sum/avg/min/max, paste and the cursor all work on it
31
+ * unchanged, and a column declaring it inherits every one of them.
32
+ *
33
+ * Percent and currency are TYPES; a legacy `number` column wearing one of
34
+ * those styles is retyped, not restyled.
35
+ */
36
+ style?: "plain" | "duration";
37
+ /** `duration` only: the unit the value is STORED in (default `ms`) — `NumberFormat.unit`. */
38
+ unit?: "ms" | "s";
39
+ /** ONE code for every number in the column. On a convertible column (one
40
+ * whose binding states rates) the SURFACE writes what the column opens on —
41
+ * a currency, or `"default"` for the reader's own — and `readMoneyColumn`
42
+ * rewrites it to the reading in force (absent under Original). */
43
+ currency?: string;
44
+ signed?: boolean;
45
+ /**
46
+ * Whether a POSITIVE signed number should read as good (tinted) or as merely
47
+ * larger. Defaults to "positive-good", which is right for money in; set
48
+ * "neutral" for a column where up is not an improvement (churn, error rate,
49
+ * days overdue) so the cell stops colouring bad news green.
50
+ */
51
+ signedTone?: "positive-good" | "neutral";
52
+ /**
53
+ * This column has a custom `render` that does NOT read the workspace's
54
+ * format settings (decimals, display, date style…). Declared so the header
55
+ * menu and the Columns drill-in withhold knobs the cell would ignore. The
56
+ * default is the other way: a bound column's custom cell is expected to
57
+ * thread the options it is handed, as the subscriptions cost cell does.
58
+ */
59
+ ignoresOverrides?: boolean;
60
+ decimals?: number;
61
+ suffix?: string;
62
+ dateStyle?: ListDateStyle;
63
+ /**
64
+ * Which of the three duration renderings this column defaults to. Only read
65
+ * when `style: "duration"`. The user's per-column override wins over it,
66
+ * exactly as it does for `dateStyle` — the column picks the sensible default
67
+ * for what it measures, the reader picks what they want to see.
68
+ */
69
+ durationStyle?: ListDurationStyle;
70
+ /** percent: the column's default drawing, from the field's `format.display`.
71
+ * The workspace's field setting wins over it, as `dateStyle`'s does. */
72
+ percentDisplay?: PercentDisplay;
73
+ withTime?: boolean;
74
+ long?: boolean;
75
+ /**
76
+ * boolean — this knob is a WRITE POLICY as much as a look. Four looks:
77
+ * - `checkbox` (default) — both states are real information; drawn either
78
+ * way; the write is a two-way flip.
79
+ * - `icon` — a two-way flip like `checkbox`, drawn with the column's own
80
+ * glyph instead of a box (a star for a favourite, a pin, a bell). Supply
81
+ * `format.icon`; without it this falls back to the checkbox glyph.
82
+ * - `text` — the column's own two words as plain, read-only text, from its
83
+ * `options` keyed `"true"`/`"false"` ("True"/"False" with none declared).
84
+ * An observed fact — "Configured" / "Missing" — never a switch.
85
+ * - `marker` — `true` is an EXCEPTION raised elsewhere (a pipeline flag, a
86
+ * review hold). Nothing is drawn when false, and the only write is
87
+ * `true → false` ("resolve").
88
+ * Display and verb are one knob because a marker draws nothing when false:
89
+ * there is no affordance to click to turn it ON, so the shape dictates the
90
+ * verb. Which one a column is comes down to: is `false` worth drawing?
91
+ * None of the four is a pill: a value that reads as a STATE on screen is a
92
+ * `status` column, and says so in its type.
93
+ */
94
+ booleanDisplay?: "checkbox" | "icon" | "text" | "marker";
95
+ /**
96
+ * The glyph for a `booleanDisplay: "icon"` column, given the current state —
97
+ * so one column can draw a filled star for `true` and a hollow one for
98
+ * `false`. A render fn rather than a pair of icon slots, matching
99
+ * `ListCellAction.icon(row)`; the cell owns nothing about which library the
100
+ * glyph comes from.
101
+ */
102
+ icon?: (on: boolean) => ReactNode;
103
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,28 @@
1
+ import type { ReactNode } from "react";
2
+ import { type FieldBinding } from "../fields/binding.js";
3
+ import { type FieldDef } from "@viewkitjs/fields";
4
+ import type { ListColumn } from "./column-schema.js";
5
+ /** Everything a column declares that neither the field nor the binding can
6
+ * know. `type`, `options`, `field`, `binding`, `custom`, `command` and `ratio`
7
+ * are derived; `header` defaults to the field's label; the reading keys come
8
+ * from the binding. */
9
+ export type ColumnPresentation<Row> = Omit<ListColumn<Row>, "type" | "options" | "field" | "binding" | "header" | "accessor" | "editAccessor" | "editUnit" | "currencyAccessor" | "surfaceOwnsCurrency" | "money" | "reading" | "relation" | "multiple" | "chips" | "icon" | "custom" | "command" | "ratio"> & {
10
+ header?: ReactNode;
11
+ /** A surface that READS differently than the binding (an FX-converted amount
12
+ * for display-currency sorting) may override; the binding's `write` still
13
+ * maps the commit.
14
+ *
15
+ * `null` means "this surface draws the value itself and offers no comparable
16
+ * value": the column then carries NO accessor at all — the key stays absent,
17
+ * which is what the readers that key on its absence look for (the filter
18
+ * panel lists the column but leaves it inert, paste-option and relation-value
19
+ * harvesting skip it). The editor still opens on the stored value, because
20
+ * `editAccessor` is carried from the binding either way.
21
+ *
22
+ * Either shape — an override or `null` — means the number this column shows
23
+ * is not the one the binding reads, so the binding's `unit` stops being that
24
+ * number's denomination and no `currencyAccessor` is derived. */
25
+ accessor?: ((row: Row) => unknown) | null;
26
+ editAccessor?: (row: Row) => unknown;
27
+ };
28
+ export declare function columnFrom<Row, D extends FieldDef>(binding: FieldBinding<Row, D>, presentation: ColumnPresentation<Row>): ListColumn<Row>;
@@ -0,0 +1,160 @@
1
+ import { bindingWritable } from "../fields/binding.js";
2
+ import { readMoneyColumn, resolveOpensOn } from "../fields/money.js";
3
+ import { moneyDeclarationFor } from "./column-money.js";
4
+ import { derivedReason, FieldDefinitionError, isDerived, isIntegerField, isMultipleType, normalizerFor, presentedDef, relationKinds, valueTypeOf, } from "@viewkitjs/fields";
5
+ import { typeRule } from "./column-types.js";
6
+ const NUMERIC_TYPES = new Set(["number", "percent", "currency"]);
7
+ function typeOf(field) {
8
+ if (field.identity)
9
+ return "title";
10
+ return valueTypeOf(field);
11
+ }
12
+ function formatOf(field) {
13
+ const def = presentedDef(field);
14
+ const integer = isIntegerField(def);
15
+ switch (def.type) {
16
+ case "number": {
17
+ const f = def.format ?? {};
18
+ const out = { style: f.style ?? "plain" };
19
+ if ("decimals" in f && f.decimals !== undefined)
20
+ out.decimals = f.decimals;
21
+ if ("suffix" in f && f.suffix !== undefined)
22
+ out.suffix = f.suffix;
23
+ if ("signed" in f && f.signed !== undefined)
24
+ out.signed = f.signed;
25
+ if ("signedTone" in f && f.signedTone !== undefined)
26
+ out.signedTone = f.signedTone;
27
+ if ("durationStyle" in f && f.durationStyle !== undefined)
28
+ out.durationStyle = f.durationStyle;
29
+ if ("unit" in f && f.unit)
30
+ out.unit = f.unit;
31
+ if (integer && out.style !== "duration" && out.decimals === undefined)
32
+ out.decimals = 0;
33
+ if (!def.format && !integer)
34
+ return undefined;
35
+ return out;
36
+ }
37
+ case "percent": {
38
+ const out = { decimals: integer ? 0 : (def.format?.decimals ?? 0) };
39
+ if (def.format?.display)
40
+ out.percentDisplay = def.format.display;
41
+ return out;
42
+ }
43
+ case "currency": {
44
+ const out = { decimals: integer ? 0 : (def.format?.decimals ?? 2) };
45
+ if ("fixed" in def.code)
46
+ out.currency = def.code.fixed;
47
+ if (def.format?.suffix !== undefined)
48
+ out.suffix = def.format.suffix;
49
+ if (def.format?.signed !== undefined)
50
+ out.signed = def.format.signed;
51
+ if (def.format?.signedTone !== undefined)
52
+ out.signedTone = def.format.signedTone;
53
+ return out;
54
+ }
55
+ case "date":
56
+ return def.format?.dateStyle ? { dateStyle: def.format.dateStyle } : undefined;
57
+ case "datetime": {
58
+ const out = {};
59
+ if (def.format?.dateStyle)
60
+ out.dateStyle = def.format.dateStyle;
61
+ if (def.format?.withTime)
62
+ out.withTime = true;
63
+ return Object.keys(out).length ? out : undefined;
64
+ }
65
+ case "boolean":
66
+ return def.format?.style ? { booleanDisplay: def.format.style } : undefined;
67
+ case "text":
68
+ return def.format?.long ? { long: true } : undefined;
69
+ default:
70
+ return undefined;
71
+ }
72
+ }
73
+ export function columnFrom(binding, presentation) {
74
+ const field = binding.field;
75
+ const { header, reasons, format, editable, clearable, accessor, editAccessor, ...rest } = presentation;
76
+ if (presentation.custom) {
77
+ throw new FieldDefinitionError(field.key, `column "${rest.id}" hand-writes custom on a bound column — a derived value is a rollup or formula field`);
78
+ }
79
+ if (rest.aggAccessor && accessor === undefined) {
80
+ throw new FieldDefinitionError(field.key, `column "${rest.id}" passes aggAccessor without its own accessor — the footer totals the binding's read; declare both or neither`);
81
+ }
82
+ const writable = bindingWritable(binding);
83
+ if (editable === true && !writable) {
84
+ throw new FieldDefinitionError(field.key, `column "${rest.id}" claims editable but its binding has no write (or the field is ${field.edit?.mutability})`);
85
+ }
86
+ if (editable === true && reasons?.editable) {
87
+ throw new FieldDefinitionError(field.key, `column "${rest.id}" cannot both refuse and offer an edit — it states reasons.editable ("${reasons.editable}") and asks for editable: true`);
88
+ }
89
+ const derivedFormat = formatOf(field);
90
+ const mergedFormat = derivedFormat || format ? { ...derivedFormat, ...format } : undefined;
91
+ const presented = presentedDef(field);
92
+ const mergedReasons = presented.edit?.reasons || reasons ? { ...presented.edit?.reasons, ...reasons } : undefined;
93
+ const options = "options" in presented && presented.options ? [...presented.options] : undefined;
94
+ const column = {
95
+ ...rest,
96
+ header: header ?? field.label,
97
+ type: typeOf(field),
98
+ ...(rest.align === undefined && NUMERIC_TYPES.has(valueTypeOf(field))
99
+ ? { align: "right" }
100
+ : {}),
101
+ field,
102
+ binding,
103
+ };
104
+ const displayRead = accessor === null ? undefined : (accessor ?? binding.read);
105
+ if (displayRead)
106
+ column.accessor = displayRead;
107
+ const editRead = editAccessor ?? binding.editRead;
108
+ if (editRead)
109
+ column.editAccessor = editRead;
110
+ if (options)
111
+ column.options = options;
112
+ if (mergedFormat)
113
+ column.format = mergedFormat;
114
+ if (mergedReasons)
115
+ column.reasons = mergedReasons;
116
+ if (isDerived(field))
117
+ column.custom = { from: derivedReason(field) };
118
+ if (field.edit?.mutability === "command")
119
+ column.command = true;
120
+ if (binding.ratio)
121
+ column.ratio = binding.ratio;
122
+ const hasEditor = typeRule(column.type)?.editor != null || column.type === "boolean";
123
+ if (writable && hasEditor && editable !== false && !reasons?.editable)
124
+ column.editable = true;
125
+ const money = moneyDeclarationFor(binding, { id: rest.id, accessor, aggAccessor: rest.aggAccessor, format });
126
+ if (money && binding.unit) {
127
+ column.editUnit = { value: binding.unit.read, options: [...binding.unit.options] };
128
+ column.money = money;
129
+ }
130
+ const surfaceOwnsShownCode = accessor !== undefined || format?.currency !== undefined;
131
+ const surfaceOwnsCurrency = accessor !== null && (accessor !== undefined || format?.currency !== undefined);
132
+ if (surfaceOwnsCurrency && valueTypeOf(field) === "currency" && !column.money)
133
+ column.surfaceOwnsCurrency = true;
134
+ if (binding.unit && !column.money) {
135
+ column.editUnit = { value: binding.unit.read, options: [...binding.unit.options] };
136
+ if (!surfaceOwnsShownCode)
137
+ column.currencyAccessor = binding.unit.read;
138
+ }
139
+ const clear = clearable ?? (field.nullable || field.emptiable ? true : undefined);
140
+ if (clear !== undefined)
141
+ column.clearable = clear;
142
+ const shown = presentedDef(field);
143
+ if (shown.type === "relation" || shown.type === "user") {
144
+ const source = binding.relation;
145
+ column.relation = {
146
+ entity: shown.type === "user" ? "user" : relationKinds(shown)[0],
147
+ ...(source ? { source } : {}),
148
+ ...(source?.kind === "static" ? { options: source.items } : {}),
149
+ };
150
+ }
151
+ if (isMultipleType(shown.type) && "multiple" in shown && shown.multiple)
152
+ column.multiple = true;
153
+ if (binding.labels === false)
154
+ column.labels = false;
155
+ if (shown.type === "multiselect")
156
+ column.chips = { normalize: normalizerFor(shown) };
157
+ if (column.money)
158
+ return readMoneyColumn(column, resolveOpensOn(column.money.opensOn, "EUR"));
159
+ return column;
160
+ }
@@ -0,0 +1,18 @@
1
+ import type { ListColumn } from "./column-schema.js";
2
+ /**
3
+ * The grid's READ capability — whether a cell opens a panel to be read in full,
4
+ * independent of whether it can be written.
5
+ *
6
+ * `column-capabilities` answers the write questions (does this column mount an
7
+ * editor, can it be written, in what shape). This file answers the one read
8
+ * question the mount gestures (click-on-focused, double-click, Enter) ask
9
+ * beside them: a long text you cannot edit is still worth reading in full, and
10
+ * the anchored panel is the one reading surface the grid has. Today only long
11
+ * text qualifies.
12
+ */
13
+ /** A text column whose value is a paragraph, not a phrase — the field said so
14
+ * with `format.long`. It edits (and reads) in the anchored long-text panel
15
+ * rather than the one-line inline input. */
16
+ export declare function isLongTextColumn<Row>(col: ListColumn<Row>): boolean;
17
+ /** Whether a cell opens a PANEL to be READ, whatever its write state. */
18
+ export declare function gridColumnInspectable<Row>(col: ListColumn<Row>): boolean;
@@ -0,0 +1,6 @@
1
+ export function isLongTextColumn(col) {
2
+ return (col.type === "text" && !!col.format?.long) || col.type === "rich_text";
3
+ }
4
+ export function gridColumnInspectable(col) {
5
+ return isLongTextColumn(col);
6
+ }
@@ -0,0 +1,20 @@
1
+ import { type FormatKnobKind } from "../fields/format-knobs.js";
2
+ import type { ListColumn } from "./column-schema.js";
3
+ /**
4
+ * WHICH KNOBS THIS COLUMN OFFERS — one answer for the header menu and the
5
+ * Columns drill-in, so the two doors cannot disagree (they used to, by a
6
+ * comment asking them to move together).
7
+ *
8
+ * The TYPE answers (`formatKnobsForField`: a percent's display and decimals,
9
+ * a datetime's style and time toggle, an integer's nothing-to-argue). The
10
+ * column may only SUBTRACT: a plain number has no duration style; a duration
11
+ * has no decimals; a currency's Display-in exists only on a column whose
12
+ * binding states rates (`money`) — a fixed-code or rate-less money column
13
+ * reads one way and offers nothing to pick; a custom render that cannot honour
14
+ * a knob says so (`format.ignoresOverrides`) — the default is that it does,
15
+ * because a bound column's cell reads the same options the typed cell does.
16
+ *
17
+ * A field-less column offers nothing: a knob writes a field's shared setting,
18
+ * and there is no field to write it against.
19
+ */
20
+ export declare function columnKnobs<Row>(col: ListColumn<Row>): ReadonlySet<FormatKnobKind>;