@kronor/dtv 7.3.0 → 7.4.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 (33) hide show
  1. package/README.md +1 -0
  2. package/dist/assets/{index-DBArvOFx.css → index-CZom8B0E.css} +1 -1
  3. package/dist/assets/index-DmKGY9pD.js +2300 -0
  4. package/dist/index.es.js +10409 -10305
  5. package/dist/index.html +2 -2
  6. package/dist/types/App.d.ts.map +1 -1
  7. package/dist/types/components/Table.d.ts +5 -2
  8. package/dist/types/components/Table.d.ts.map +1 -1
  9. package/dist/types/dsl/columns.d.ts +19 -10
  10. package/dist/types/dsl/columns.d.ts.map +1 -1
  11. package/dist/types/framework/column-definition.d.ts +20 -1
  12. package/dist/types/framework/column-definition.d.ts.map +1 -1
  13. package/dist/types/framework/data-ordering.d.ts +7 -0
  14. package/dist/types/framework/data-ordering.d.ts.map +1 -0
  15. package/dist/types/framework/data.d.ts +4 -2
  16. package/dist/types/framework/data.d.ts.map +1 -1
  17. package/dist/types/framework/graphql/query.d.ts +2 -1
  18. package/dist/types/framework/graphql/query.d.ts.map +1 -1
  19. package/dist/types/framework/order-direction.d.ts +3 -0
  20. package/dist/types/framework/order-direction.d.ts.map +1 -0
  21. package/dist/types/framework/runtime.d.ts +2 -1
  22. package/dist/types/framework/runtime.d.ts.map +1 -1
  23. package/dist/types/framework/state.d.ts +5 -1
  24. package/dist/types/framework/state.d.ts.map +1 -1
  25. package/dist/types/framework/view-parser.d.ts +6 -3
  26. package/dist/types/framework/view-parser.d.ts.map +1 -1
  27. package/dist/types/framework/view.d.ts +2 -1
  28. package/dist/types/framework/view.d.ts.map +1 -1
  29. package/dist/types/lib/index.d.ts +2 -0
  30. package/dist/types/lib/index.d.ts.map +1 -1
  31. package/docs/api/README.md +31 -0
  32. package/package.json +1 -1
  33. package/dist/assets/index-CPVKMD6m.js +0 -2300
@@ -9,6 +9,7 @@ This folder contains detailed API documentation for the runtime extension points
9
9
  - Query Transforms (`queryTransforms`)
10
10
  - Initial Values (`initialValues`)
11
11
  - Static Conditions (`staticConditions` on a View)
12
+ - Optional column `orderBy` fields for sortable headers
12
13
 
13
14
  Each extension point is referenced from JSON view definitions using a Runtime Reference object:
14
15
 
@@ -40,3 +41,33 @@ Resolution precedence: External (per-app) runtime overrides Built-in runtime. If
40
41
  - `no-rows-component.md` — Authoring components shown when a view returns zero rows.
41
42
 
42
43
  Add additional docs here for transforms, custom filters, etc. as needed.
44
+
45
+ ## Column Ordering
46
+ - Table column headers are sortable when DTV can map the column to a GraphQL order field.
47
+ - A table column with exactly one simple `valueQuery` automatically orders by that field.
48
+ - For rendered or composite columns, set `orderBy` on the table column JSON to one of the scalar GraphQL fields selected by `data` to enable sorting.
49
+ - `orderBy` may be a dot-separated path for nested order fields, such as `customer.profile.status`.
50
+ - Users can order by one sortable header at a time. Clicking a sorted header a third time removes the header ordering.
51
+
52
+ ```jsonc
53
+ {
54
+ "type": "tableColumn",
55
+ "id": "customerName",
56
+ "data": [
57
+ {
58
+ "type": "objectQuery",
59
+ "field": "customer",
60
+ "selectionSet": [
61
+ {
62
+ "type": "objectQuery",
63
+ "field": "profile",
64
+ "selectionSet": [{ "type": "valueQuery", "field": "lastName" }]
65
+ }
66
+ ]
67
+ }
68
+ ],
69
+ "name": "Customer",
70
+ "orderBy": "customer.profile.lastName",
71
+ "cellRenderer": { "section": "cellRenderers", "key": "text" }
72
+ }
73
+ ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kronor/dtv",
3
- "version": "7.3.0",
3
+ "version": "7.4.0",
4
4
  "type": "module",
5
5
  "bin": {
6
6
  "dtv": "./bin/dtv.js"