@getodk/xforms-engine 0.5.0 → 0.6.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 (232) hide show
  1. package/README.md +1 -1
  2. package/dist/client/BaseNode.d.ts +4 -0
  3. package/dist/client/BaseValueNode.d.ts +1 -1
  4. package/dist/client/GroupNode.d.ts +1 -0
  5. package/dist/client/InputNode.d.ts +32 -3
  6. package/dist/client/ModelValueNode.d.ts +1 -0
  7. package/dist/client/NoteNode.d.ts +24 -7
  8. package/dist/client/RangeNode.d.ts +36 -0
  9. package/dist/client/RankNode.d.ts +46 -0
  10. package/dist/client/RootNode.d.ts +6 -3
  11. package/dist/client/SelectNode.d.ts +47 -25
  12. package/dist/client/SubtreeNode.d.ts +1 -0
  13. package/dist/client/TriggerNode.d.ts +10 -6
  14. package/dist/client/hierarchy.d.ts +5 -5
  15. package/dist/client/node-types.d.ts +2 -2
  16. package/dist/client/unsupported/UnsupportedControlNode.d.ts +1 -3
  17. package/dist/error/RankMissingValueError.d.ts +3 -0
  18. package/dist/error/RankValueTypeError.d.ts +6 -0
  19. package/dist/error/SelectValueTypeError.d.ts +15 -0
  20. package/dist/error/XFormsSpecViolationError.d.ts +2 -0
  21. package/dist/index.d.ts +2 -3
  22. package/dist/index.js +5604 -4666
  23. package/dist/index.js.map +1 -1
  24. package/dist/instance/Group.d.ts +1 -0
  25. package/dist/instance/InputControl.d.ts +5 -3
  26. package/dist/instance/ModelValue.d.ts +2 -0
  27. package/dist/instance/Note.d.ts +13 -25
  28. package/dist/instance/PrimaryInstance.d.ts +1 -0
  29. package/dist/instance/RangeControl.d.ts +34 -0
  30. package/dist/instance/RankControl.d.ts +40 -0
  31. package/dist/instance/Root.d.ts +1 -0
  32. package/dist/instance/SelectControl.d.ts +66 -0
  33. package/dist/instance/Subtree.d.ts +1 -0
  34. package/dist/instance/TriggerControl.d.ts +9 -22
  35. package/dist/instance/abstract/DescendantNode.d.ts +1 -2
  36. package/dist/instance/abstract/InstanceNode.d.ts +3 -1
  37. package/dist/instance/abstract/UnsupportedControl.d.ts +1 -0
  38. package/dist/instance/abstract/ValueNode.d.ts +0 -1
  39. package/dist/instance/hierarchy.d.ts +9 -9
  40. package/dist/instance/internal-api/InstanceValueContext.d.ts +2 -0
  41. package/dist/instance/internal-api/submission/ClientReactiveSubmittableLeafNode.d.ts +2 -1
  42. package/dist/instance/internal-api/submission/ClientReactiveSubmittableParentNode.d.ts +2 -1
  43. package/dist/instance/internal-api/submission/ClientReactiveSubmittableValueNode.d.ts +2 -1
  44. package/dist/instance/repeat/BaseRepeatRange.d.ts +1 -0
  45. package/dist/instance/repeat/RepeatInstance.d.ts +1 -0
  46. package/dist/integration/xpath/adapter/names.d.ts +1 -11
  47. package/dist/integration/xpath/adapter/traversal.d.ts +10 -9
  48. package/dist/integration/xpath/static-dom/StaticAttribute.d.ts +10 -3
  49. package/dist/integration/xpath/static-dom/StaticDocument.d.ts +0 -1
  50. package/dist/integration/xpath/static-dom/StaticElement.d.ts +12 -4
  51. package/dist/lib/client-reactivity/submission/createRootSubmissionState.d.ts +3 -0
  52. package/dist/lib/codecs/Geopoint/Geopoint.d.ts +48 -0
  53. package/dist/lib/codecs/Geopoint/GeopointValueCodec.d.ts +5 -0
  54. package/dist/lib/codecs/NoteCodec.d.ts +8 -0
  55. package/dist/lib/codecs/RangeCodec.d.ts +8 -0
  56. package/dist/lib/codecs/TriggerCodec.d.ts +7 -0
  57. package/dist/lib/codecs/ValueArrayCodec.d.ts +11 -0
  58. package/dist/lib/codecs/ValueCodec.d.ts +2 -2
  59. package/dist/lib/codecs/getNoteCodec.d.ts +3 -0
  60. package/dist/lib/codecs/getSelectCodec.d.ts +5 -0
  61. package/dist/lib/codecs/getSharedValueCodec.d.ts +3 -2
  62. package/dist/lib/codecs/items/BaseItemCodec.d.ts +9 -0
  63. package/dist/lib/codecs/items/MultipleValueItemCodec.d.ts +14 -0
  64. package/dist/lib/codecs/items/SingleValueItemCodec.d.ts +24 -0
  65. package/dist/lib/dom/query.d.ts +1 -2
  66. package/dist/lib/names/NamespaceDeclaration.d.ts +45 -0
  67. package/dist/lib/names/NamespaceDeclarationMap.d.ts +137 -0
  68. package/dist/lib/names/NamespaceURL.d.ts +30 -0
  69. package/dist/lib/names/QualifiedName.d.ts +113 -0
  70. package/dist/lib/number-parsers.d.ts +2 -0
  71. package/dist/lib/reactivity/createItemCollection.d.ts +21 -0
  72. package/dist/lib/xml-serialization.d.ts +11 -2
  73. package/dist/parse/XFormDOM.d.ts +1 -1
  74. package/dist/parse/body/BodyDefinition.d.ts +2 -2
  75. package/dist/parse/body/appearance/rangeAppearanceParser.d.ts +3 -0
  76. package/dist/parse/body/control/InputControlDefinition.d.ts +3 -0
  77. package/dist/parse/body/control/ItemDefinition.d.ts +14 -0
  78. package/dist/parse/body/control/ItemsetDefinition.d.ts +18 -0
  79. package/dist/parse/body/control/RangeControlDefinition.d.ts +31 -2
  80. package/dist/parse/body/control/RankControlDefinition.d.ts +7 -3
  81. package/dist/parse/body/control/{select/SelectDefinition.d.ts → SelectControlDefinition.d.ts} +9 -9
  82. package/dist/parse/expression/ItemsetNodesetExpression.d.ts +1 -1
  83. package/dist/parse/expression/ItemsetValueExpression.d.ts +1 -1
  84. package/dist/parse/model/BindDefinition.d.ts +3 -1
  85. package/dist/parse/model/BindPreloadDefinition.d.ts +42 -0
  86. package/dist/parse/model/DescendentNodeDefinition.d.ts +4 -13
  87. package/dist/parse/model/ItextTranslation/ItextTranslationRootDefinition.d.ts +2 -1
  88. package/dist/parse/model/LeafNodeDefinition.d.ts +7 -4
  89. package/dist/parse/model/ModelBindMap.d.ts +1 -1
  90. package/dist/parse/model/NodeDefinition.d.ts +16 -19
  91. package/dist/parse/model/NoteNodeDefinition.d.ts +6 -5
  92. package/dist/parse/model/RangeNodeDefinition.d.ts +41 -0
  93. package/dist/parse/model/RepeatInstanceDefinition.d.ts +7 -4
  94. package/dist/parse/model/RepeatRangeDefinition.d.ts +7 -4
  95. package/dist/parse/model/RepeatTemplateDefinition.d.ts +7 -4
  96. package/dist/parse/model/RootAttributeDefinition.d.ts +24 -0
  97. package/dist/parse/model/RootAttributeMap.d.ts +23 -0
  98. package/dist/parse/model/RootDefinition.d.ts +9 -7
  99. package/dist/parse/model/SubtreeDefinition.d.ts +7 -4
  100. package/dist/parse/shared/parseStaticDocumentFromDOMSubtree.d.ts +2 -3
  101. package/dist/parse/text/ItemLabelDefinition.d.ts +1 -1
  102. package/dist/parse/text/ItemsetLabelDefinition.d.ts +2 -2
  103. package/dist/parse/text/abstract/TextElementDefinition.d.ts +1 -1
  104. package/dist/parse/xpath/semantic-analysis.d.ts +1 -3
  105. package/dist/solid.js +5603 -4665
  106. package/dist/solid.js.map +1 -1
  107. package/package.json +15 -12
  108. package/src/client/BaseNode.ts +5 -0
  109. package/src/client/BaseValueNode.ts +1 -1
  110. package/src/client/GroupNode.ts +1 -0
  111. package/src/client/InputNode.ts +38 -2
  112. package/src/client/ModelValueNode.ts +1 -0
  113. package/src/client/NoteNode.ts +43 -7
  114. package/src/client/RangeNode.ts +51 -0
  115. package/src/client/RankNode.ts +54 -0
  116. package/src/client/RootNode.ts +11 -5
  117. package/src/client/SelectNode.ts +53 -26
  118. package/src/client/SubtreeNode.ts +1 -0
  119. package/src/client/TriggerNode.ts +12 -6
  120. package/src/client/hierarchy.ts +7 -8
  121. package/src/client/node-types.ts +1 -1
  122. package/src/client/unsupported/UnsupportedControlNode.ts +2 -6
  123. package/src/error/RankMissingValueError.ts +5 -0
  124. package/src/error/RankValueTypeError.ts +13 -0
  125. package/src/error/SelectValueTypeError.ts +22 -0
  126. package/src/error/XFormsSpecViolationError.ts +1 -0
  127. package/src/index.ts +2 -12
  128. package/src/instance/Group.ts +1 -0
  129. package/src/instance/InputControl.ts +42 -2
  130. package/src/instance/ModelValue.ts +2 -0
  131. package/src/instance/Note.ts +34 -59
  132. package/src/instance/PrimaryInstance.ts +1 -0
  133. package/src/instance/RangeControl.ts +113 -0
  134. package/src/instance/RankControl.ts +199 -0
  135. package/src/instance/Root.ts +3 -2
  136. package/src/instance/SelectControl.ts +219 -0
  137. package/src/instance/Subtree.ts +1 -0
  138. package/src/instance/TriggerControl.ts +36 -75
  139. package/src/instance/abstract/DescendantNode.ts +1 -6
  140. package/src/instance/abstract/InstanceNode.ts +10 -2
  141. package/src/instance/abstract/UnsupportedControl.ts +1 -0
  142. package/src/instance/abstract/ValueNode.ts +3 -2
  143. package/src/instance/children.ts +71 -30
  144. package/src/instance/hierarchy.ts +21 -16
  145. package/src/instance/internal-api/InstanceValueContext.ts +2 -0
  146. package/src/instance/internal-api/submission/ClientReactiveSubmittableLeafNode.ts +2 -1
  147. package/src/instance/internal-api/submission/ClientReactiveSubmittableParentNode.ts +2 -1
  148. package/src/instance/internal-api/submission/ClientReactiveSubmittableValueNode.ts +2 -1
  149. package/src/instance/repeat/BaseRepeatRange.ts +2 -0
  150. package/src/instance/repeat/RepeatInstance.ts +1 -0
  151. package/src/instance/resource.ts +4 -1
  152. package/src/integration/xpath/adapter/names.ts +66 -17
  153. package/src/integration/xpath/adapter/traversal.ts +10 -9
  154. package/src/integration/xpath/static-dom/StaticAttribute.ts +15 -7
  155. package/src/integration/xpath/static-dom/StaticDocument.ts +0 -2
  156. package/src/integration/xpath/static-dom/StaticElement.ts +21 -8
  157. package/src/lib/client-reactivity/submission/createLeafNodeSubmissionState.ts +1 -1
  158. package/src/lib/client-reactivity/submission/createParentNodeSubmissionState.ts +1 -1
  159. package/src/lib/client-reactivity/submission/createRootSubmissionState.ts +19 -0
  160. package/src/lib/client-reactivity/submission/createValueNodeSubmissionState.ts +2 -2
  161. package/src/lib/codecs/Geopoint/Geopoint.ts +150 -0
  162. package/src/lib/codecs/Geopoint/GeopointValueCodec.ts +20 -0
  163. package/src/lib/codecs/NoteCodec.ts +32 -0
  164. package/src/lib/codecs/RangeCodec.ts +65 -0
  165. package/src/lib/codecs/TriggerCodec.ts +64 -0
  166. package/src/lib/codecs/ValueArrayCodec.ts +42 -0
  167. package/src/lib/codecs/ValueCodec.ts +2 -2
  168. package/src/lib/codecs/getNoteCodec.ts +27 -0
  169. package/src/lib/codecs/getSelectCodec.ts +27 -0
  170. package/src/lib/codecs/getSharedValueCodec.ts +5 -3
  171. package/src/lib/codecs/items/BaseItemCodec.ts +20 -0
  172. package/src/lib/codecs/items/MultipleValueItemCodec.ts +28 -0
  173. package/src/lib/codecs/items/SingleValueItemCodec.ts +67 -0
  174. package/src/lib/dom/query.ts +1 -2
  175. package/src/lib/names/NamespaceDeclaration.ts +106 -0
  176. package/src/lib/names/NamespaceDeclarationMap.ts +228 -0
  177. package/src/lib/names/NamespaceURL.ts +44 -0
  178. package/src/lib/names/QualifiedName.ts +170 -0
  179. package/src/lib/number-parsers.ts +25 -0
  180. package/src/lib/reactivity/createInstanceValueState.ts +50 -0
  181. package/src/lib/reactivity/{createSelectItems.ts → createItemCollection.ts} +41 -36
  182. package/src/lib/xml-serialization.ts +76 -9
  183. package/src/parse/XFormDOM.ts +141 -21
  184. package/src/parse/XFormDefinition.ts +1 -4
  185. package/src/parse/body/BodyDefinition.ts +4 -4
  186. package/src/parse/body/appearance/rangeAppearanceParser.ts +11 -0
  187. package/src/parse/body/control/InputControlDefinition.ts +9 -0
  188. package/src/parse/body/control/{select/ItemDefinition.ts → ItemDefinition.ts} +8 -6
  189. package/src/parse/body/control/{select/ItemsetDefinition.ts → ItemsetDefinition.ts} +11 -9
  190. package/src/parse/body/control/RangeControlDefinition.ts +91 -6
  191. package/src/parse/body/control/RankControlDefinition.ts +25 -7
  192. package/src/parse/body/control/{select/SelectDefinition.ts → SelectControlDefinition.ts} +9 -9
  193. package/src/parse/expression/ItemsetNodesetExpression.ts +1 -1
  194. package/src/parse/expression/ItemsetValueExpression.ts +1 -1
  195. package/src/parse/model/BindDefinition.ts +4 -0
  196. package/src/parse/model/BindPreloadDefinition.ts +100 -0
  197. package/src/parse/model/DescendentNodeDefinition.ts +7 -25
  198. package/src/parse/model/ItextTranslation/ItextTranslationRootDefinition.ts +2 -1
  199. package/src/parse/model/LeafNodeDefinition.ts +11 -4
  200. package/src/parse/model/NodeDefinition.ts +24 -45
  201. package/src/parse/model/NoteNodeDefinition.ts +8 -7
  202. package/src/parse/model/RangeNodeDefinition.ts +118 -0
  203. package/src/parse/model/RepeatInstanceDefinition.ts +11 -7
  204. package/src/parse/model/RepeatRangeDefinition.ts +11 -7
  205. package/src/parse/model/RepeatTemplateDefinition.ts +11 -7
  206. package/src/parse/model/RootAttributeDefinition.ts +45 -0
  207. package/src/parse/model/RootAttributeMap.ts +44 -0
  208. package/src/parse/model/RootDefinition.ts +29 -28
  209. package/src/parse/model/SecondaryInstance/sources/GeoJSONExternalSecondaryInstance.ts +1 -0
  210. package/src/parse/model/SubtreeDefinition.ts +12 -12
  211. package/src/parse/shared/parseStaticDocumentFromDOMSubtree.ts +3 -3
  212. package/src/parse/text/ItemLabelDefinition.ts +1 -1
  213. package/src/parse/text/ItemsetLabelDefinition.ts +2 -2
  214. package/src/parse/text/abstract/TextElementDefinition.ts +1 -1
  215. package/src/parse/xpath/semantic-analysis.ts +4 -3
  216. package/dist/client/unsupported/RangeNode.d.ts +0 -9
  217. package/dist/client/unsupported/RankNode.d.ts +0 -9
  218. package/dist/instance/SelectField.d.ts +0 -58
  219. package/dist/instance/unsupported/RangeControl.d.ts +0 -6
  220. package/dist/instance/unsupported/RankControl.d.ts +0 -6
  221. package/dist/integration/xpath/static-dom/StaticNamedNode.d.ts +0 -17
  222. package/dist/lib/reactivity/createSelectItems.d.ts +0 -16
  223. package/dist/parse/body/control/select/ItemDefinition.d.ts +0 -13
  224. package/dist/parse/body/control/select/ItemsetDefinition.d.ts +0 -17
  225. package/dist/parse/body/control/select/ItemsetNodesetContext.d.ts +0 -9
  226. package/src/client/unsupported/RangeNode.ts +0 -14
  227. package/src/client/unsupported/RankNode.ts +0 -14
  228. package/src/instance/SelectField.ts +0 -263
  229. package/src/instance/unsupported/RangeControl.ts +0 -9
  230. package/src/instance/unsupported/RankControl.ts +0 -9
  231. package/src/integration/xpath/static-dom/StaticNamedNode.ts +0 -45
  232. package/src/parse/body/control/select/ItemsetNodesetContext.ts +0 -21
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@getodk/xforms-engine",
3
- "version": "0.5.0",
3
+ "version": "0.6.0",
4
4
  "license": "Apache-2.0",
5
5
  "description": "XForms engine for ODK Web Forms",
6
6
  "type": "module",
@@ -29,7 +29,7 @@
29
29
  "README.md"
30
30
  ],
31
31
  "engines": {
32
- "node": "^18.20.4 || ^20.17.0 || ^22.9.0",
32
+ "node": "^18.20.5 || ^20.18.1 || ^22.12.0",
33
33
  "yarn": "1.22.22"
34
34
  },
35
35
  "scripts": {
@@ -55,30 +55,33 @@
55
55
  },
56
56
  "dependencies": {
57
57
  "papaparse": "^5.4.1",
58
- "solid-js": "^1.9.1"
58
+ "solid-js": "^1.9.3"
59
59
  },
60
60
  "devDependencies": {
61
- "@babel/core": "^7.25.2",
61
+ "@babel/core": "^7.26.0",
62
62
  "@getodk/tree-sitter-xpath": "0.1.2",
63
- "@getodk/xpath": "0.3.0",
64
- "@playwright/test": "^1.47.2",
63
+ "@getodk/xpath": "0.4.0",
64
+ "@playwright/test": "^1.49.1",
65
65
  "@types/papaparse": "^5.3.15",
66
- "@vitest/browser": "^2.1.1",
66
+ "@vitest/browser": "^2.1.8",
67
67
  "babel-plugin-transform-jsbi-to-bigint": "^1.4.0",
68
68
  "http-server": "^14.1.1",
69
69
  "jsdom": "^25.0.1",
70
- "typedoc": "^0.26.7",
71
- "vite": "^5.4.8",
72
- "vite-plugin-dts": "^4.2.2",
70
+ "typedoc": "^0.27.5",
71
+ "vite": "^5.4.11",
72
+ "vite-plugin-dts": "^4.3.0",
73
73
  "vite-plugin-no-bundle": "^4.0.0",
74
- "vitest": "^2.1.1"
74
+ "vitest": "^2.1.8"
75
75
  },
76
76
  "peerDependencies": {
77
- "solid-js": "^1.8.18"
77
+ "solid-js": "^1.9.3"
78
78
  },
79
79
  "peerDependenciesMeta": {
80
80
  "solid-js": {
81
81
  "optional": true
82
82
  }
83
+ },
84
+ "publishConfig": {
85
+ "access": "public"
83
86
  }
84
87
  }
@@ -153,6 +153,11 @@ export interface BaseNode {
153
153
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
154
154
  readonly appearances: NodeAppearances<any> | null;
155
155
 
156
+ /**
157
+ * A node can have options that determine its behavior.
158
+ */
159
+ readonly nodeOptions: object | null;
160
+
156
161
  /**
157
162
  * Each node has a definition which specifies aspects of the node defined in
158
163
  * the form. These aspects include (but are not limited to) the node's data
@@ -7,7 +7,7 @@ import type { ValueType } from './ValueType.ts';
7
7
 
8
8
  export interface BaseValueNodeState<Value> extends BaseNodeState {
9
9
  get children(): null;
10
- get valueOptions(): null;
10
+ get valueOptions(): unknown;
11
11
  get value(): Value;
12
12
 
13
13
  /**
@@ -31,6 +31,7 @@ export type GroupNodeAppearances = NodeAppearances<GroupDefinition>;
31
31
  export interface GroupNode extends BaseNode {
32
32
  readonly nodeType: 'group';
33
33
  readonly appearances: GroupNodeAppearances;
34
+ readonly nodeOptions: null;
34
35
  readonly definition: GroupDefinition;
35
36
  readonly root: RootNode;
36
37
  readonly parent: GeneralParentNode;
@@ -31,16 +31,44 @@ export interface InputDefinition<V extends ValueType = ValueType> extends LeafNo
31
31
 
32
32
  export type InputNodeAppearances = NodeAppearances<InputDefinition>;
33
33
 
34
+ interface StringInputNodeOptions {
35
+ readonly rows: number | null;
36
+ }
37
+
38
+ interface GeoInputNodeOptions {
39
+ readonly accuracyThreshold: number | null;
40
+ readonly unacceptableAccuracyThreshold: number | null;
41
+ }
42
+
43
+ interface InputNodeOptionsByValueType {
44
+ readonly string: StringInputNodeOptions;
45
+ readonly int: null;
46
+ readonly boolean: null;
47
+ readonly decimal: null;
48
+ readonly date: null;
49
+ readonly time: null;
50
+ readonly dateTime: null;
51
+ readonly geopoint: GeoInputNodeOptions;
52
+ readonly geotrace: GeoInputNodeOptions;
53
+ readonly geoshape: GeoInputNodeOptions;
54
+ readonly binary: null;
55
+ readonly barcode: null;
56
+ readonly intent: null;
57
+ }
58
+
59
+ export type InputNodeOptions<V extends ValueType> = InputNodeOptionsByValueType[V];
60
+
34
61
  /**
35
62
  * A node corresponding to form field defined as an
36
63
  * {@link https://getodk.github.io/xforms-spec/#body-elements | XForms `<input>`},
37
- * which a user-facing client would likely present for a user to fill..
64
+ * which a user-facing client would likely present for a user to fill.
38
65
  */
39
66
  export interface InputNode<V extends ValueType = ValueType>
40
67
  extends BaseValueNode<V, InputValue<V>> {
41
68
  readonly nodeType: 'input';
42
69
  readonly valueType: V;
43
70
  readonly appearances: InputNodeAppearances;
71
+ readonly nodeOptions: InputNodeOptions<V>;
44
72
  readonly definition: InputDefinition<V>;
45
73
  readonly root: RootNode;
46
74
  readonly parent: GeneralParentNode;
@@ -53,16 +81,23 @@ export interface InputNode<V extends ValueType = ValueType>
53
81
  setValue(value: InputNodeInputValue<V>): RootNode;
54
82
  }
55
83
 
84
+ export type StringInputValue = InputValue<'string'>;
85
+ export type IntInputValue = InputValue<'int'>;
86
+ export type DecimalInputValue = InputValue<'decimal'>;
87
+ export type GeopointInputValue = InputValue<'geopoint'>;
88
+
56
89
  export type StringInputNode = InputNode<'string'>;
57
90
  export type IntInputNode = InputNode<'int'>;
58
91
  export type DecimalInputNode = InputNode<'decimal'>;
92
+ export type GeopointInputNode = InputNode<'geopoint'>;
59
93
 
60
94
  // prettier-ignore
61
95
  type SupportedInputValueType =
62
96
  // eslint-disable-next-line @typescript-eslint/sort-type-constituents
63
97
  | 'string'
64
98
  | 'int'
65
- | 'decimal';
99
+ | 'decimal'
100
+ | 'geopoint';
66
101
 
67
102
  type TemporaryStringValueType = Exclude<ValueType, SupportedInputValueType>;
68
103
 
@@ -74,4 +109,5 @@ export type AnyInputNode =
74
109
  | StringInputNode
75
110
  | IntInputNode
76
111
  | DecimalInputNode
112
+ | GeopointInputNode
77
113
  | TemporaryStringValueInputNode;
@@ -40,6 +40,7 @@ export interface ModelValueNode<V extends ValueType = ValueType>
40
40
  readonly nodeType: 'model-value';
41
41
  readonly valueType: V;
42
42
  readonly appearances: null;
43
+ readonly nodeOptions: null;
43
44
  readonly definition: ModelValueDefinition<V>;
44
45
  readonly root: RootNode;
45
46
  readonly parent: GeneralParentNode;
@@ -1,13 +1,17 @@
1
+ import type { NoteRuntimeValue } from '../lib/codecs/NoteCodec.ts';
1
2
  import type { InputControlDefinition } from '../parse/body/control/InputControlDefinition.ts';
2
3
  import type { LeafNodeDefinition } from '../parse/model/LeafNodeDefinition.ts';
3
- import type { BaseNode, BaseNodeState } from './BaseNode.ts';
4
+ import type { BaseValueNode, BaseValueNodeState } from './BaseValueNode.ts';
4
5
  import type { GeneralParentNode } from './hierarchy.ts';
5
6
  import type { NodeAppearances } from './NodeAppearances.ts';
6
7
  import type { RootNode } from './RootNode.ts';
7
8
  import type { TextRange } from './TextRange.ts';
8
9
  import type { LeafNodeValidationState } from './validation.ts';
10
+ import type { ValueType } from './ValueType.ts';
9
11
 
10
- export interface NoteNodeState extends BaseNodeState {
12
+ export type NoteValue<V extends ValueType> = NoteRuntimeValue<V>;
13
+
14
+ export interface NoteNodeState<V extends ValueType> extends BaseValueNodeState<NoteValue<V>> {
11
15
  /**
12
16
  * Note-specific specialization: a note will always have a non-null value in
13
17
  * at least one of:
@@ -48,10 +52,10 @@ export interface NoteNodeState extends BaseNodeState {
48
52
  // node types, specifically to make a clear distinction between blank and
49
53
  // non-blank values (as that has been a primary driver for prioritizing note
50
54
  // functionality).
51
- get value(): string | null;
55
+ get value(): NoteValue<V>;
52
56
  }
53
57
 
54
- export interface NoteDefinition extends LeafNodeDefinition {
58
+ export interface NoteDefinition<V extends ValueType = ValueType> extends LeafNodeDefinition<V> {
55
59
  readonly bodyElement: InputControlDefinition;
56
60
  }
57
61
 
@@ -63,12 +67,44 @@ export type NoteNodeAppearances = NodeAppearances<NoteDefinition>;
63
67
  * - associated with an input, with at least one text element (label or hint)
64
68
  * - guaranteed to be {@link NoteNodeState.readonly | readonly}
65
69
  */
66
- export interface NoteNode extends BaseNode {
70
+ export interface NoteNode<V extends ValueType = ValueType> extends BaseValueNode<V, NoteValue<V>> {
67
71
  readonly nodeType: 'note';
68
72
  readonly appearances: NoteNodeAppearances;
69
- readonly definition: NoteDefinition;
73
+ readonly nodeOptions: null;
74
+ readonly definition: NoteDefinition<V>;
70
75
  readonly root: RootNode;
71
76
  readonly parent: GeneralParentNode;
72
- readonly currentState: NoteNodeState;
77
+ readonly currentState: NoteNodeState<V>;
73
78
  readonly validationState: LeafNodeValidationState;
74
79
  }
80
+
81
+ export type StringNoteValue = NoteValue<'string'>;
82
+ export type IntNoteValue = NoteValue<'int'>;
83
+ export type DecimalNoteValue = NoteValue<'decimal'>;
84
+ export type GeopointNoteValue = NoteValue<'geopoint'>;
85
+
86
+ export type StringNoteNode = NoteNode<'string'>;
87
+ export type IntNoteNode = NoteNode<'int'>;
88
+ export type DecimalNoteNode = NoteNode<'decimal'>;
89
+ export type GeopointNoteNode = NoteNode<'geopoint'>;
90
+
91
+ // prettier-ignore
92
+ type SupportedNoteValueType =
93
+ // eslint-disable-next-line @typescript-eslint/sort-type-constituents
94
+ | 'string'
95
+ | 'int'
96
+ | 'decimal'
97
+ | 'geopoint';
98
+
99
+ type TemporaryStringValueType = Exclude<ValueType, SupportedNoteValueType>;
100
+
101
+ export type TemporaryStringValueNoteNode = NoteNode<TemporaryStringValueType>;
102
+
103
+ // prettier-ignore
104
+ export type AnyNoteNode =
105
+ // eslint-disable-next-line @typescript-eslint/sort-type-constituents
106
+ | StringNoteNode
107
+ | IntNoteNode
108
+ | DecimalNoteNode
109
+ | GeopointNoteNode
110
+ | TemporaryStringValueNoteNode;
@@ -0,0 +1,51 @@
1
+ import type { RuntimeInputValue, RuntimeValue } from '../lib/codecs/getSharedValueCodec.ts';
2
+ import type { RangeNodeDefinition, RangeValueType } from '../parse/model/RangeNodeDefinition.ts';
3
+ import type { BaseValueNode, BaseValueNodeState } from './BaseValueNode.ts';
4
+ import type { NodeAppearances } from './NodeAppearances.ts';
5
+ import type { RootNode } from './RootNode.ts';
6
+ import type { GeneralParentNode } from './hierarchy.ts';
7
+ import type { LeafNodeValidationState } from './validation.ts';
8
+
9
+ export type { RangeValueType };
10
+
11
+ export type RangeValue<V extends RangeValueType> = RuntimeValue<V>;
12
+
13
+ export type RangeInputValue<V extends RangeValueType> = RuntimeInputValue<V>;
14
+
15
+ export interface RangeNodeState<V extends RangeValueType>
16
+ extends BaseValueNodeState<RangeValue<V>> {
17
+ get valueOptions(): null;
18
+ }
19
+
20
+ export type RangeNodeAppearances = NodeAppearances<RangeNodeDefinition>;
21
+
22
+ /**
23
+ * A node corresponding to form field defined as an
24
+ * {@link https://getodk.github.io/xforms-spec/#body-elements | XForms `<range>`}.
25
+ */
26
+ export interface RangeNode<V extends RangeValueType = RangeValueType>
27
+ extends BaseValueNode<V, RangeValue<V>> {
28
+ readonly nodeType: 'range';
29
+ readonly valueType: V;
30
+ readonly appearances: RangeNodeAppearances;
31
+ readonly nodeOptions: null;
32
+ readonly definition: RangeNodeDefinition<V>;
33
+ readonly root: RootNode;
34
+ readonly parent: GeneralParentNode;
35
+ readonly currentState: RangeNodeState<V>;
36
+ readonly validationState: LeafNodeValidationState;
37
+
38
+ /**
39
+ * For use by a client to update the value of an {@link RangeNode}.
40
+ */
41
+ setValue(value: RangeInputValue<V>): RootNode;
42
+ }
43
+
44
+ export type IntRangeNode = RangeNode<'int'>;
45
+ export type DecimalRangeNode = RangeNode<'decimal'>;
46
+
47
+ // prettier-ignore
48
+ export type AnyRangeNode =
49
+ // eslint-disable-next-line @typescript-eslint/sort-type-constituents
50
+ | IntRangeNode
51
+ | DecimalRangeNode;
@@ -0,0 +1,54 @@
1
+ import type { RankControlDefinition } from '../parse/body/control/RankControlDefinition.ts';
2
+ import type { LeafNodeDefinition } from '../parse/model/LeafNodeDefinition.ts';
3
+ import type { BaseValueNode, BaseValueNodeState } from './BaseValueNode.ts';
4
+ import type { RootNode } from './RootNode.ts';
5
+ import type { TextRange } from './TextRange.ts';
6
+ import type { GeneralParentNode } from './hierarchy.ts';
7
+ import type { LeafNodeValidationState } from './validation.ts';
8
+ import type { UnknownAppearanceDefinition } from '../parse/body/appearance/unknownAppearanceParser.ts';
9
+ import type { ValueType } from './ValueType.ts';
10
+
11
+ export interface RankItem {
12
+ get label(): TextRange<'item-label'>;
13
+ get value(): string;
14
+ }
15
+
16
+ export type RankValueOptions = readonly RankItem[];
17
+
18
+ export interface RankNodeState extends BaseValueNodeState<readonly string[]> {
19
+ get valueOptions(): RankValueOptions;
20
+
21
+ /**
22
+ * An ordered collection of values from {@link RankItem}.
23
+ * The order of the items is important and must be preserved during processing.
24
+ */
25
+ get value(): readonly string[];
26
+ }
27
+
28
+ export interface RankDefinition<V extends ValueType = ValueType> extends LeafNodeDefinition<V> {
29
+ readonly bodyElement: RankControlDefinition;
30
+ }
31
+
32
+ export interface RankNode extends BaseValueNode<'string', readonly string[]> {
33
+ readonly nodeType: 'rank';
34
+ readonly appearances: UnknownAppearanceDefinition;
35
+ readonly nodeOptions: null;
36
+ readonly valueType: 'string';
37
+ readonly definition: RankDefinition<'string'>;
38
+ readonly root: RootNode;
39
+ readonly parent: GeneralParentNode;
40
+ readonly currentState: RankNodeState;
41
+ readonly validationState: LeafNodeValidationState;
42
+
43
+ /**
44
+ * Convenience API to get the {@link RankItem}'s label.
45
+ */
46
+ getValueLabel(value: string): TextRange<'item-label'> | null;
47
+
48
+ /**
49
+ * Set the value which is an ordered collection of values from {@link RankItem}.
50
+ * Calling this setter replaces the currently value.
51
+ * If called with an empty array, the current is cleared.
52
+ */
53
+ setValues(values: readonly string[]): RootNode;
54
+ }
@@ -3,8 +3,12 @@ import type { RootDefinition } from '../parse/model/RootDefinition.ts';
3
3
  import type { BaseNode, BaseNodeState } from './BaseNode.ts';
4
4
  import type { ActiveLanguage, FormLanguage, FormLanguages } from './FormLanguage.ts';
5
5
  import type { GeneralChildNode } from './hierarchy.ts';
6
- import type { SubmissionChunkedType, SubmissionOptions } from './submission/SubmissionOptions.ts';
7
- import type { SubmissionResult } from './submission/SubmissionResult.ts';
6
+ import type { SubmissionOptions } from './submission/SubmissionOptions.ts';
7
+ import type {
8
+ ChunkedSubmissionResult,
9
+ MonolithicSubmissionResult,
10
+ SubmissionResult,
11
+ } from './submission/SubmissionResult.ts';
8
12
  import type { AncestorNodeValidationState } from './validation.ts';
9
13
 
10
14
  export interface RootNodeState extends BaseNodeState {
@@ -29,6 +33,8 @@ export interface RootNode extends BaseNode {
29
33
  */
30
34
  readonly appearances: null;
31
35
 
36
+ readonly nodeOptions: null;
37
+
32
38
  /**
33
39
  * @todo This is another odd deviation in {@link RootNode}. Unlike
34
40
  * {@link languages}, it doesn't feel particularly **essential**. While it
@@ -84,7 +90,7 @@ export interface RootNode extends BaseNode {
84
90
  * A client may specify {@link SubmissionOptions<'chunked'>}, in which case a
85
91
  * {@link SubmissionResult<'chunked'>} will be produced, with form attachments
86
92
  */
87
- prepareSubmission<ChunkedType extends SubmissionChunkedType>(
88
- options?: SubmissionOptions<ChunkedType>
89
- ): Promise<SubmissionResult<ChunkedType>>;
93
+ prepareSubmission(): Promise<MonolithicSubmissionResult>;
94
+ prepareSubmission(options: SubmissionOptions<'monolithic'>): Promise<MonolithicSubmissionResult>;
95
+ prepareSubmission(options: SubmissionOptions<'chunked'>): Promise<ChunkedSubmissionResult>;
90
96
  }
@@ -1,24 +1,26 @@
1
- import type { AnySelectDefinition } from '../parse/body/control/select/SelectDefinition.ts';
1
+ import type {
2
+ AnySelectControlDefinition,
3
+ SelectType,
4
+ } from '../parse/body/control/SelectControlDefinition.ts';
2
5
  import type { LeafNodeDefinition } from '../parse/model/LeafNodeDefinition.ts';
3
- import type { BaseNode, BaseNodeState } from './BaseNode.ts';
4
- import type { InputNode } from './InputNode.ts';
6
+ import type { BaseValueNode, BaseValueNodeState } from './BaseValueNode.ts';
5
7
  import type { NodeAppearances } from './NodeAppearances.ts';
6
8
  import type { RootNode } from './RootNode.ts';
7
9
  import type { TextRange } from './TextRange.ts';
10
+ import type { ValueType } from './ValueType.ts';
8
11
  import type { GeneralParentNode } from './hierarchy.ts';
9
12
  import type { LeafNodeValidationState } from './validation.ts';
10
13
 
11
14
  export interface SelectItem {
15
+ get label(): TextRange<'item-label'>;
12
16
  get value(): string;
13
- get label(): TextRange<'item-label'> | null;
14
17
  }
15
18
 
16
- export interface SelectNodeState extends BaseNodeState {
19
+ export type SelectValueOptions = readonly SelectItem[];
20
+
21
+ export interface SelectNodeState extends BaseValueNodeState<readonly string[]> {
17
22
  get children(): null;
18
23
 
19
- /**
20
- * @todo should {@link BaseNodeState} include this??
21
- */
22
24
  get valueOptions(): readonly SelectItem[];
23
25
 
24
26
  /**
@@ -33,43 +35,68 @@ export interface SelectNodeState extends BaseNodeState {
33
35
  * Should a `SelectNodeState` have this `value` type, whereas a hypothetical
34
36
  * `Select1NodeState` would have `get value(): SelectItem | null`?
35
37
  */
36
- get value(): readonly SelectItem[];
38
+ get value(): readonly string[];
37
39
  }
38
40
 
39
- export interface SelectDefinition extends LeafNodeDefinition {
40
- readonly bodyElement: AnySelectDefinition;
41
+ export interface SelectDefinition<V extends ValueType = ValueType> extends LeafNodeDefinition<V> {
42
+ readonly bodyElement: AnySelectControlDefinition;
41
43
  }
42
44
 
43
45
  export type SelectNodeAppearances = NodeAppearances<SelectDefinition>;
44
46
 
45
- export interface SelectNode extends BaseNode {
47
+ export interface SelectNode extends BaseValueNode<'string', readonly string[]> {
46
48
  readonly nodeType: 'select';
49
+ readonly valueType: 'string';
50
+ readonly selectType: SelectType;
47
51
  readonly appearances: SelectNodeAppearances;
48
- readonly definition: SelectDefinition;
52
+ readonly nodeOptions: null;
53
+ readonly definition: SelectDefinition<'string'>;
49
54
  readonly root: RootNode;
50
55
  readonly parent: GeneralParentNode;
51
56
  readonly currentState: SelectNodeState;
52
57
  readonly validationState: LeafNodeValidationState;
53
58
 
54
59
  /**
55
- * For use by a client to update the selection of a select node where:
60
+ * Convenience API to get the {@link SelectItem} which is associated with
61
+ * {@link value}, if one is currently available—i.e. if it is present in
62
+ * {@link SelectNodeState.valueOptions}.
63
+ */
64
+ getValueOption(value: string): SelectItem | null;
65
+
66
+ /**
67
+ * Convenience API to determine if {@link value} is currently selected—i.e. if
68
+ * it is one of the selected values in {@link SelectNodeState.value}.
69
+ */
70
+ isSelected(value: string): boolean;
71
+
72
+ /**
73
+ * Selects a single {@link value}, as provided by a {@link SelectItem.value}.
74
+ * Calling this setter replaces the currently selected value(s, if any),
75
+ * where:
56
76
  *
57
- * - For fields defined with an XForms `<select>`, calling this method is
58
- * additive, i.e. it will include the item in its
59
- * {@link SelectNodeState.value}.
60
- * - For fields defined with an XForms `<select1>`, calling this method will
61
- * replace the selection (if any).
77
+ * - if the provided value is `null`, the current selection is cleared; ELSE
78
+ * - the provided value is selected in place of any currently selected values.
62
79
  *
63
- * @todo @see {@link InputNode.setValue} re: write restrictions
64
- * @todo @see {@link SelectNodeState.value} re: breaking up the types
80
+ * This setter is most useful for {@link SelectNode}s associated with an
81
+ * XForms
82
+ * {@link https://getodk.github.io/xforms-spec/#body-elements | `<select1>`}
83
+ * control.
65
84
  */
66
- select(item: SelectItem): RootNode;
85
+ selectValue(value: string | null): RootNode;
67
86
 
68
87
  /**
69
- * For use by a client to remove an item from the node's
70
- * {@link SelectNodeState.value}.
88
+ * Selects any number of {@link values}, as provided by any number of
89
+ * {@link SelectItem.value}s. Calling this setter replaces the currently
90
+ * selected value(s, if any). If called with an empty array, the current
91
+ * selection is cleared.
92
+ *
93
+ * This setter is most useful for {@link SelectNode}s associated with an
94
+ * XForms
95
+ * {@link https://getodk.github.io/xforms-spec/#body-elements | `<select>`}
96
+ * control.
71
97
  *
72
- * @todo @see {@link InputNode.setValue} re: write restrictions
98
+ * This setter _may_ be used with a `<select1>` control, in which case the
99
+ * provided {@link values} should produce at most one value.
73
100
  */
74
- deselect(item: SelectItem): RootNode;
101
+ selectValues(values: readonly string[]): RootNode;
75
102
  }
@@ -52,6 +52,7 @@ export interface SubtreeDefinition extends BaseSubtreeDefinition {
52
52
  export interface SubtreeNode extends BaseNode {
53
53
  readonly nodeType: 'subtree';
54
54
  readonly appearances: null;
55
+ readonly nodeOptions: null;
55
56
  readonly definition: SubtreeDefinition;
56
57
  readonly root: RootNode;
57
58
  readonly parent: GeneralParentNode;
@@ -1,25 +1,31 @@
1
+ import type { TriggerRuntimeValue, TriggerValueType } from '../lib/codecs/TriggerCodec.ts';
1
2
  import type { UnknownAppearanceDefinition } from '../parse/body/appearance/unknownAppearanceParser.ts';
2
3
  import type { TriggerControlDefinition } from '../parse/body/control/TriggerControlDefinition.ts';
3
4
  import type { LeafNodeDefinition } from '../parse/model/LeafNodeDefinition.ts';
4
- import type { BaseNode, BaseNodeState } from './BaseNode.ts';
5
+ import type { BaseValueNode, BaseValueNodeState } from './BaseValueNode.ts';
5
6
  import type { GeneralParentNode } from './hierarchy.ts';
6
7
  import type { RootNode } from './RootNode.ts';
7
8
  import type { LeafNodeValidationState } from './validation.ts';
9
+ import type { ValueType } from './ValueType.ts';
8
10
 
9
- export interface TriggerNodeState extends BaseNodeState {
11
+ export type TriggerValue = TriggerRuntimeValue;
12
+
13
+ export interface TriggerNodeState extends BaseValueNodeState<TriggerValue> {
10
14
  get children(): null;
11
15
  get valueOptions(): null;
12
- get value(): boolean;
16
+ get value(): TriggerValue;
13
17
  }
14
18
 
15
- export interface TriggerNodeDefinition extends LeafNodeDefinition {
19
+ export interface TriggerNodeDefinition<V extends ValueType = ValueType>
20
+ extends LeafNodeDefinition<V> {
16
21
  readonly bodyElement: TriggerControlDefinition;
17
22
  }
18
23
 
19
- export interface TriggerNode extends BaseNode {
24
+ export interface TriggerNode extends BaseValueNode<TriggerValueType, TriggerValue> {
20
25
  readonly nodeType: 'trigger';
21
- readonly definition: TriggerNodeDefinition;
26
+ readonly definition: TriggerNodeDefinition<TriggerValueType>;
22
27
  readonly appearances: UnknownAppearanceDefinition;
28
+ readonly nodeOptions: null;
23
29
  readonly root: RootNode;
24
30
  readonly parent: GeneralParentNode;
25
31
  readonly currentState: TriggerNodeState;
@@ -2,7 +2,8 @@ import type { ExpandUnion } from '@getodk/common/types/helpers.d.ts';
2
2
  import type { GroupNode } from './GroupNode.ts';
3
3
  import type { AnyInputNode } from './InputNode.ts';
4
4
  import type { AnyModelValueNode } from './ModelValueNode.ts';
5
- import type { NoteNode } from './NoteNode.ts';
5
+ import type { AnyNoteNode } from './NoteNode.ts';
6
+ import type { AnyRangeNode } from './RangeNode.ts';
6
7
  import type { RepeatInstanceNode } from './repeat/RepeatInstanceNode.ts';
7
8
  import type { RepeatRangeControlledNode } from './repeat/RepeatRangeControlledNode.ts';
8
9
  import type { RepeatRangeUncontrolledNode } from './repeat/RepeatRangeUncontrolledNode.ts';
@@ -10,20 +11,18 @@ import type { RootNode } from './RootNode.ts';
10
11
  import type { SelectNode } from './SelectNode.ts';
11
12
  import type { SubtreeNode } from './SubtreeNode.ts';
12
13
  import type { TriggerNode } from './TriggerNode.ts';
13
- import type { RangeNode } from './unsupported/RangeNode.ts';
14
- import type { RankNode } from './unsupported/RankNode.ts';
14
+ import type { RankNode } from './RankNode.ts';
15
15
  import type { UploadNode } from './unsupported/UploadNode.ts';
16
16
 
17
17
  // prettier-ignore
18
- export type AnyUnsupportedControlNode =
19
- | RangeNode
20
- | RankNode
21
- | UploadNode;
18
+ export type AnyUnsupportedControlNode = UploadNode;
22
19
 
23
20
  // prettier-ignore
24
21
  export type AnyControlNode =
25
22
  | AnyInputNode
26
- | NoteNode
23
+ | AnyNoteNode
24
+ | AnyRangeNode
25
+ | RankNode
27
26
  | SelectNode
28
27
  | TriggerNode;
29
28
 
@@ -1,6 +1,5 @@
1
1
  // prettier-ignore
2
2
  export type UnsupportedControlNodeType =
3
- | 'range'
4
3
  | 'rank'
5
4
  | 'upload';
6
5
 
@@ -17,6 +16,7 @@ export type LeafNodeType =
17
16
  | 'select'
18
17
  | 'input'
19
18
  | 'trigger'
19
+ | 'range'
20
20
  | UnsupportedControlNodeType;
21
21
 
22
22
  // prettier-ignore
@@ -1,6 +1,4 @@
1
1
  import type { UnknownAppearanceDefinition } from '../../parse/body/appearance/unknownAppearanceParser.ts';
2
- import type { RangeControlDefinition } from '../../parse/body/control/RangeControlDefinition.ts';
3
- import type { RankControlDefinition } from '../../parse/body/control/RankControlDefinition.ts';
4
2
  import type { UploadControlDefinition } from '../../parse/body/control/UploadControlDefinition.ts';
5
3
  import type { LeafNodeDefinition } from '../../parse/model/LeafNodeDefinition.ts';
6
4
  import type { BaseNode, BaseNodeState } from '../BaseNode.ts';
@@ -15,10 +13,8 @@ export interface UnsupportedControlNodeState extends BaseNodeState {
15
13
  get value(): unknown;
16
14
  }
17
15
 
18
- export type UnsupportedControlElementDefinition =
19
- | RangeControlDefinition
20
- | RankControlDefinition
21
- | UploadControlDefinition;
16
+ // prettier-ignore
17
+ export type UnsupportedControlElementDefinition = UploadControlDefinition;
22
18
 
23
19
  export interface UnsupportedControlDefinition extends LeafNodeDefinition {
24
20
  readonly bodyElement: UnsupportedControlElementDefinition;
@@ -0,0 +1,5 @@
1
+ export class RankMissingValueError extends Error {
2
+ constructor(message: string) {
3
+ super(message);
4
+ }
5
+ }