@getodk/xforms-engine 0.5.0 → 0.7.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 (425) hide show
  1. package/README.md +1 -1
  2. package/dist/client/BaseNode.d.ts +8 -4
  3. package/dist/client/BaseValueNode.d.ts +8 -4
  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 +21 -14
  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/constants.d.ts +11 -12
  15. package/dist/client/form/CreateFormInstance.d.ts +14 -0
  16. package/dist/client/form/EditFormInstance.d.ts +62 -0
  17. package/dist/client/form/FormInstance.d.ts +104 -0
  18. package/dist/client/form/FormInstanceConfig.d.ts +17 -0
  19. package/dist/client/form/FormResource.d.ts +1 -0
  20. package/dist/client/form/LoadForm.d.ts +79 -0
  21. package/dist/client/form/LoadFormResult.d.ts +67 -0
  22. package/dist/client/form/RestoreFormInstance.d.ts +8 -0
  23. package/dist/client/hierarchy.d.ts +5 -5
  24. package/dist/client/index.d.ts +37 -11
  25. package/dist/client/node-types.d.ts +2 -2
  26. package/dist/client/repeat/BaseRepeatRangeNode.d.ts +3 -4
  27. package/dist/client/repeat/RepeatInstanceNode.d.ts +4 -5
  28. package/dist/client/repeat/RepeatRangeControlledNode.d.ts +2 -2
  29. package/dist/client/repeat/RepeatRangeUncontrolledNode.d.ts +2 -2
  30. package/dist/client/resources.d.ts +1 -1
  31. package/dist/client/serialization/InstanceData.d.ts +12 -0
  32. package/dist/client/serialization/InstanceFile.d.ts +6 -0
  33. package/dist/client/serialization/InstancePayload.d.ts +93 -0
  34. package/dist/client/serialization/InstancePayloadOptions.d.ts +23 -0
  35. package/dist/client/serialization/InstanceState.d.ts +12 -0
  36. package/dist/client/submission/{SubmissionDefinition.d.ts → SubmissionMeta.d.ts} +1 -1
  37. package/dist/client/unsupported/UnsupportedControlNode.d.ts +1 -3
  38. package/dist/entrypoints/FormInstance.d.ts +20 -0
  39. package/dist/entrypoints/FormResult/BaseFormResult.d.ts +22 -0
  40. package/dist/entrypoints/FormResult/BaseInstantiableFormResult.d.ts +25 -0
  41. package/dist/entrypoints/FormResult/FormFailureResult.d.ts +17 -0
  42. package/dist/entrypoints/FormResult/FormSuccessResult.d.ts +15 -0
  43. package/dist/entrypoints/FormResult/FormWarningResult.d.ts +15 -0
  44. package/dist/entrypoints/createInstance.d.ts +9 -0
  45. package/dist/entrypoints/editInstance.d.ts +9 -0
  46. package/dist/entrypoints/index.d.ts +4 -0
  47. package/dist/entrypoints/loadForm.d.ts +4 -0
  48. package/dist/entrypoints/restoreInstance.d.ts +9 -0
  49. package/dist/error/LoadFormFailureError.d.ts +9 -0
  50. package/dist/error/MalformedInstanceDataError.d.ts +3 -0
  51. package/dist/error/RankMissingValueError.d.ts +3 -0
  52. package/dist/error/RankValueTypeError.d.ts +6 -0
  53. package/dist/error/SelectValueTypeError.d.ts +15 -0
  54. package/dist/error/TemplatedNodeAttributeSerializationError.d.ts +22 -0
  55. package/dist/error/XFormsSpecViolationError.d.ts +2 -0
  56. package/dist/index.d.ts +2 -34
  57. package/dist/index.js +7274 -5840
  58. package/dist/index.js.map +1 -1
  59. package/dist/instance/Group.d.ts +7 -5
  60. package/dist/instance/InputControl.d.ts +9 -6
  61. package/dist/instance/ModelValue.d.ts +7 -4
  62. package/dist/instance/Note.d.ts +14 -25
  63. package/dist/instance/PrimaryInstance.d.ts +36 -8
  64. package/dist/instance/RangeControl.d.ts +35 -0
  65. package/dist/instance/RankControl.d.ts +41 -0
  66. package/dist/instance/Root.d.ts +8 -9
  67. package/dist/instance/SelectControl.d.ts +67 -0
  68. package/dist/instance/Subtree.d.ts +7 -5
  69. package/dist/instance/TriggerControl.d.ts +10 -22
  70. package/dist/instance/abstract/DescendantNode.d.ts +11 -3
  71. package/dist/instance/abstract/InstanceNode.d.ts +10 -5
  72. package/dist/instance/abstract/ValueNode.d.ts +7 -6
  73. package/dist/instance/children/DescendantNodeInitOptions.d.ts +32 -0
  74. package/dist/instance/{children.d.ts → children/buildChildren.d.ts} +1 -1
  75. package/dist/instance/children/childrenInitOptions.d.ts +9 -0
  76. package/dist/instance/children/normalizeChildInitOptions.d.ts +2 -0
  77. package/dist/instance/hierarchy.d.ts +9 -9
  78. package/dist/instance/input/InitialInstanceState.d.ts +13 -0
  79. package/dist/instance/input/InstanceAttachmentMap.d.ts +19 -0
  80. package/dist/instance/internal-api/InstanceConfig.d.ts +2 -9
  81. package/dist/instance/internal-api/InstanceValueContext.d.ts +10 -1
  82. package/dist/instance/internal-api/serialization/ClientReactiveSerializableInstance.d.ts +14 -0
  83. package/dist/instance/internal-api/serialization/ClientReactiveSerializableLeafNode.d.ts +32 -0
  84. package/dist/instance/internal-api/serialization/ClientReactiveSerializableParentNode.d.ts +18 -0
  85. package/dist/instance/internal-api/serialization/ClientReactiveSerializableTemplatedNode.d.ts +13 -0
  86. package/dist/instance/internal-api/serialization/ClientReactiveSerializableValueNode.d.ts +21 -0
  87. package/dist/instance/repeat/BaseRepeatRange.d.ts +11 -8
  88. package/dist/instance/repeat/RepeatInstance.d.ts +11 -7
  89. package/dist/instance/repeat/RepeatRangeControlled.d.ts +27 -3
  90. package/dist/instance/repeat/RepeatRangeUncontrolled.d.ts +4 -3
  91. package/dist/instance/resource.d.ts +5 -1
  92. package/dist/instance/unsupported/UploadControl.d.ts +32 -4
  93. package/dist/integration/xpath/EngineXPathEvaluator.d.ts +2 -2
  94. package/dist/integration/xpath/adapter/kind.d.ts +4 -10
  95. package/dist/integration/xpath/adapter/names.d.ts +1 -11
  96. package/dist/integration/xpath/adapter/traversal.d.ts +10 -9
  97. package/dist/integration/xpath/static-dom/StaticAttribute.d.ts +10 -4
  98. package/dist/integration/xpath/static-dom/StaticDocument.d.ts +13 -11
  99. package/dist/integration/xpath/static-dom/StaticElement.d.ts +25 -18
  100. package/dist/integration/xpath/static-dom/StaticNode.d.ts +1 -1
  101. package/dist/integration/xpath/static-dom/StaticParentNode.d.ts +13 -0
  102. package/dist/integration/xpath/static-dom/staticNodeName.d.ts +3 -0
  103. package/dist/lib/client-reactivity/instance-state/createNodeRangeInstanceState.d.ts +4 -0
  104. package/dist/lib/client-reactivity/instance-state/createParentNodeInstanceState.d.ts +4 -0
  105. package/dist/lib/client-reactivity/instance-state/createPrimaryInstanceState.d.ts +3 -0
  106. package/dist/lib/client-reactivity/instance-state/createRootInstanceState.d.ts +3 -0
  107. package/dist/lib/client-reactivity/instance-state/createTemplatedNodeInstanceState.d.ts +6 -0
  108. package/dist/lib/client-reactivity/instance-state/createValueNodeInstanceState.d.ts +3 -0
  109. package/dist/lib/client-reactivity/instance-state/prepareInstancePayload.d.ts +8 -0
  110. package/dist/lib/codecs/Geopoint/Geopoint.d.ts +48 -0
  111. package/dist/lib/codecs/Geopoint/GeopointValueCodec.d.ts +5 -0
  112. package/dist/lib/codecs/NoteCodec.d.ts +8 -0
  113. package/dist/lib/codecs/RangeCodec.d.ts +8 -0
  114. package/dist/lib/codecs/TempUnsupportedControlCodec.d.ts +7 -0
  115. package/dist/lib/codecs/TriggerCodec.d.ts +7 -0
  116. package/dist/lib/codecs/ValueArrayCodec.d.ts +11 -0
  117. package/dist/lib/codecs/ValueCodec.d.ts +2 -2
  118. package/dist/lib/codecs/getNoteCodec.d.ts +3 -0
  119. package/dist/lib/codecs/getSelectCodec.d.ts +5 -0
  120. package/dist/lib/codecs/getSharedValueCodec.d.ts +3 -2
  121. package/dist/lib/codecs/items/BaseItemCodec.d.ts +9 -0
  122. package/dist/lib/codecs/items/MultipleValueItemCodec.d.ts +14 -0
  123. package/dist/lib/codecs/items/SingleValueItemCodec.d.ts +24 -0
  124. package/dist/lib/dom/query.d.ts +1 -2
  125. package/dist/lib/names/NamespaceDeclaration.d.ts +45 -0
  126. package/dist/lib/names/NamespaceDeclarationMap.d.ts +137 -0
  127. package/dist/lib/names/NamespaceURL.d.ts +30 -0
  128. package/dist/lib/names/QualifiedName.d.ts +113 -0
  129. package/dist/lib/names/UnprefixedXFormsName.d.ts +4 -0
  130. package/dist/lib/number-parsers.d.ts +2 -0
  131. package/dist/lib/reactivity/createInstanceValueState.d.ts +2 -27
  132. package/dist/lib/reactivity/createItemCollection.d.ts +21 -0
  133. package/dist/lib/xml-serialization.d.ts +11 -2
  134. package/dist/parse/XFormDOM.d.ts +1 -1
  135. package/dist/parse/body/BodyDefinition.d.ts +2 -2
  136. package/dist/parse/body/appearance/rangeAppearanceParser.d.ts +3 -0
  137. package/dist/parse/body/control/InputControlDefinition.d.ts +3 -0
  138. package/dist/parse/body/control/ItemDefinition.d.ts +14 -0
  139. package/dist/parse/body/control/ItemsetDefinition.d.ts +18 -0
  140. package/dist/parse/body/control/RangeControlDefinition.d.ts +31 -2
  141. package/dist/parse/body/control/RankControlDefinition.d.ts +7 -3
  142. package/dist/parse/body/control/{select/SelectDefinition.d.ts → SelectControlDefinition.d.ts} +9 -9
  143. package/dist/parse/expression/ItemsetNodesetExpression.d.ts +1 -1
  144. package/dist/parse/expression/ItemsetValueExpression.d.ts +1 -1
  145. package/dist/parse/model/BindDefinition.d.ts +3 -1
  146. package/dist/parse/model/BindPreloadDefinition.d.ts +42 -0
  147. package/dist/parse/model/DescendentNodeDefinition.d.ts +4 -13
  148. package/dist/parse/model/ItextTranslationsDefinition.d.ts +18 -0
  149. package/dist/parse/model/LeafNodeDefinition.d.ts +9 -7
  150. package/dist/parse/model/ModelDefinition.d.ts +9 -2
  151. package/dist/parse/model/NodeDefinition.d.ts +30 -45
  152. package/dist/parse/model/NoteNodeDefinition.d.ts +7 -5
  153. package/dist/parse/model/RangeNodeDefinition.d.ts +42 -0
  154. package/dist/parse/model/RepeatDefinition.d.ts +62 -0
  155. package/dist/parse/model/RootAttributeDefinition.d.ts +21 -0
  156. package/dist/parse/model/RootAttributeMap.d.ts +24 -0
  157. package/dist/parse/model/RootDefinition.d.ts +15 -14
  158. package/dist/parse/model/SecondaryInstance/SecondaryInstancesDefinition.d.ts +15 -2
  159. package/dist/parse/model/SecondaryInstance/assertSecondaryInstanceDefinition.d.ts +5 -0
  160. package/dist/parse/model/SecondaryInstance/defineSecondaryInstance.d.ts +5 -0
  161. package/dist/parse/model/SecondaryInstance/sources/BlankSecondaryInstanceSource.d.ts +1 -7
  162. package/dist/parse/model/SecondaryInstance/sources/CSVExternalSecondaryInstance.d.ts +1 -1
  163. package/dist/parse/model/SecondaryInstance/sources/GeoJSONExternalSecondaryInstance.d.ts +1 -1
  164. package/dist/parse/model/SecondaryInstance/sources/InternalSecondaryInstanceSource.d.ts +1 -1
  165. package/dist/parse/model/SecondaryInstance/sources/SecondaryInstanceSource.d.ts +1 -1
  166. package/dist/parse/model/SecondaryInstance/sources/XMLExternalSecondaryInstanceSource.d.ts +1 -1
  167. package/dist/parse/model/{FormSubmissionDefinition.d.ts → SubmissionDefinition.d.ts} +2 -2
  168. package/dist/parse/model/SubtreeDefinition.d.ts +9 -7
  169. package/dist/parse/model/nodeDefinitionMap.d.ts +5 -0
  170. package/dist/parse/shared/parseInstanceXML.d.ts +21 -0
  171. package/dist/parse/shared/parseStaticDocumentFromDOMSubtree.d.ts +4 -22
  172. package/dist/parse/text/ItemLabelDefinition.d.ts +1 -1
  173. package/dist/parse/text/ItemsetLabelDefinition.d.ts +2 -2
  174. package/dist/parse/text/abstract/TextElementDefinition.d.ts +1 -1
  175. package/dist/parse/xpath/semantic-analysis.d.ts +1 -3
  176. package/dist/solid.js +7247 -5813
  177. package/dist/solid.js.map +1 -1
  178. package/package.json +15 -12
  179. package/src/client/BaseNode.ts +9 -4
  180. package/src/client/BaseValueNode.ts +8 -4
  181. package/src/client/GroupNode.ts +1 -0
  182. package/src/client/InputNode.ts +38 -2
  183. package/src/client/ModelValueNode.ts +1 -0
  184. package/src/client/NoteNode.ts +43 -7
  185. package/src/client/RangeNode.ts +51 -0
  186. package/src/client/RankNode.ts +54 -0
  187. package/src/client/RootNode.ts +30 -16
  188. package/src/client/SelectNode.ts +53 -26
  189. package/src/client/SubtreeNode.ts +1 -0
  190. package/src/client/TriggerNode.ts +12 -6
  191. package/src/client/constants.ts +12 -14
  192. package/src/client/form/CreateFormInstance.ts +19 -0
  193. package/src/client/form/EditFormInstance.ts +93 -0
  194. package/src/client/form/FormInstance.ts +114 -0
  195. package/src/client/form/FormInstanceConfig.ts +18 -0
  196. package/src/client/form/FormResource.ts +1 -0
  197. package/src/client/form/LoadForm.ts +92 -0
  198. package/src/client/form/LoadFormResult.ts +103 -0
  199. package/src/client/form/RestoreFormInstance.ts +14 -0
  200. package/src/client/hierarchy.ts +7 -8
  201. package/src/client/index.ts +47 -29
  202. package/src/client/node-types.ts +3 -5
  203. package/src/client/repeat/BaseRepeatRangeNode.ts +3 -4
  204. package/src/client/repeat/RepeatInstanceNode.ts +4 -8
  205. package/src/client/repeat/RepeatRangeControlledNode.ts +2 -2
  206. package/src/client/repeat/RepeatRangeUncontrolledNode.ts +2 -2
  207. package/src/client/resources.ts +2 -2
  208. package/src/client/serialization/InstanceData.ts +16 -0
  209. package/src/client/serialization/InstanceFile.ts +9 -0
  210. package/src/client/serialization/InstancePayload.ts +126 -0
  211. package/src/client/serialization/InstancePayloadOptions.ts +28 -0
  212. package/src/client/serialization/InstanceState.ts +14 -0
  213. package/src/client/submission/{SubmissionDefinition.ts → SubmissionMeta.ts} +1 -1
  214. package/src/client/unsupported/UnsupportedControlNode.ts +2 -6
  215. package/src/entrypoints/FormInstance.ts +55 -0
  216. package/src/entrypoints/FormResult/BaseFormResult.ts +40 -0
  217. package/src/entrypoints/FormResult/BaseInstantiableFormResult.ts +109 -0
  218. package/src/entrypoints/FormResult/FormFailureResult.ts +44 -0
  219. package/src/entrypoints/FormResult/FormSuccessResult.ts +25 -0
  220. package/src/entrypoints/FormResult/FormWarningResult.ts +25 -0
  221. package/src/entrypoints/createInstance.ts +23 -0
  222. package/src/entrypoints/editInstance.ts +24 -0
  223. package/src/entrypoints/index.ts +4 -0
  224. package/src/entrypoints/loadForm.ts +154 -0
  225. package/src/entrypoints/restoreInstance.ts +27 -0
  226. package/src/error/LoadFormFailureError.ts +114 -0
  227. package/src/error/MalformedInstanceDataError.ts +3 -0
  228. package/src/error/RankMissingValueError.ts +5 -0
  229. package/src/error/RankValueTypeError.ts +13 -0
  230. package/src/error/SelectValueTypeError.ts +22 -0
  231. package/src/error/TemplatedNodeAttributeSerializationError.ts +24 -0
  232. package/src/error/XFormsSpecViolationError.ts +1 -0
  233. package/src/index.ts +2 -56
  234. package/src/instance/Group.ts +17 -15
  235. package/src/instance/InputControl.ts +58 -12
  236. package/src/instance/ModelValue.ts +19 -11
  237. package/src/instance/Note.ts +40 -64
  238. package/src/instance/PrimaryInstance.ts +70 -31
  239. package/src/instance/RangeControl.ts +119 -0
  240. package/src/instance/RankControl.ts +208 -0
  241. package/src/instance/Root.ts +21 -31
  242. package/src/instance/SelectControl.ts +228 -0
  243. package/src/instance/Subtree.ts +17 -15
  244. package/src/instance/TriggerControl.ts +50 -80
  245. package/src/instance/abstract/DescendantNode.ts +13 -8
  246. package/src/instance/abstract/InstanceNode.ts +19 -7
  247. package/src/instance/abstract/ValueNode.ts +14 -15
  248. package/src/instance/children/DescendantNodeInitOptions.ts +35 -0
  249. package/src/instance/children/buildChildren.ts +206 -0
  250. package/src/instance/children/childrenInitOptions.ts +117 -0
  251. package/src/instance/children/normalizeChildInitOptions.ts +332 -0
  252. package/src/instance/hierarchy.ts +21 -16
  253. package/src/instance/input/InitialInstanceState.ts +108 -0
  254. package/src/instance/input/InstanceAttachmentMap.ts +142 -0
  255. package/src/instance/internal-api/InstanceConfig.ts +3 -10
  256. package/src/instance/internal-api/InstanceValueContext.ts +11 -1
  257. package/src/instance/internal-api/serialization/ClientReactiveSerializableInstance.ts +20 -0
  258. package/src/instance/internal-api/serialization/ClientReactiveSerializableLeafNode.ts +43 -0
  259. package/src/instance/internal-api/serialization/ClientReactiveSerializableParentNode.ts +26 -0
  260. package/src/instance/internal-api/serialization/ClientReactiveSerializableTemplatedNode.ts +24 -0
  261. package/src/instance/internal-api/serialization/ClientReactiveSerializableValueNode.ts +28 -0
  262. package/src/instance/repeat/BaseRepeatRange.ts +21 -24
  263. package/src/instance/repeat/RepeatInstance.ts +27 -19
  264. package/src/instance/repeat/RepeatRangeControlled.ts +90 -17
  265. package/src/instance/repeat/RepeatRangeUncontrolled.ts +10 -9
  266. package/src/instance/resource.ts +18 -2
  267. package/src/instance/unsupported/UploadControl.ts +116 -5
  268. package/src/integration/xpath/EngineXPathEvaluator.ts +2 -2
  269. package/src/integration/xpath/adapter/kind.ts +1 -28
  270. package/src/integration/xpath/adapter/names.ts +66 -17
  271. package/src/integration/xpath/adapter/traversal.ts +12 -11
  272. package/src/integration/xpath/static-dom/StaticAttribute.ts +16 -7
  273. package/src/integration/xpath/static-dom/StaticDocument.ts +17 -18
  274. package/src/integration/xpath/static-dom/StaticElement.ts +211 -52
  275. package/src/integration/xpath/static-dom/StaticNode.ts +1 -1
  276. package/src/integration/xpath/static-dom/StaticParentNode.ts +22 -0
  277. package/src/integration/xpath/static-dom/staticNodeName.ts +20 -0
  278. package/src/lib/client-reactivity/instance-state/createNodeRangeInstanceState.ts +17 -0
  279. package/src/lib/client-reactivity/instance-state/createParentNodeInstanceState.ts +22 -0
  280. package/src/lib/client-reactivity/instance-state/createPrimaryInstanceState.ts +12 -0
  281. package/src/lib/client-reactivity/instance-state/createRootInstanceState.ts +19 -0
  282. package/src/lib/client-reactivity/instance-state/createTemplatedNodeInstanceState.ts +31 -0
  283. package/src/lib/client-reactivity/instance-state/createValueNodeInstanceState.ts +21 -0
  284. package/src/lib/client-reactivity/instance-state/prepareInstancePayload.ts +173 -0
  285. package/src/lib/codecs/Geopoint/Geopoint.ts +150 -0
  286. package/src/lib/codecs/Geopoint/GeopointValueCodec.ts +20 -0
  287. package/src/lib/codecs/NoteCodec.ts +32 -0
  288. package/src/lib/codecs/RangeCodec.ts +65 -0
  289. package/src/lib/codecs/TempUnsupportedControlCodec.ts +32 -0
  290. package/src/lib/codecs/TriggerCodec.ts +64 -0
  291. package/src/lib/codecs/ValueArrayCodec.ts +42 -0
  292. package/src/lib/codecs/ValueCodec.ts +2 -2
  293. package/src/lib/codecs/getNoteCodec.ts +27 -0
  294. package/src/lib/codecs/getSelectCodec.ts +27 -0
  295. package/src/lib/codecs/getSharedValueCodec.ts +5 -3
  296. package/src/lib/codecs/items/BaseItemCodec.ts +20 -0
  297. package/src/lib/codecs/items/MultipleValueItemCodec.ts +28 -0
  298. package/src/lib/codecs/items/SingleValueItemCodec.ts +67 -0
  299. package/src/lib/dom/query.ts +1 -2
  300. package/src/lib/names/NamespaceDeclaration.ts +106 -0
  301. package/src/lib/names/NamespaceDeclarationMap.ts +228 -0
  302. package/src/lib/names/NamespaceURL.ts +44 -0
  303. package/src/lib/names/QualifiedName.ts +170 -0
  304. package/src/lib/names/UnprefixedXFormsName.ts +12 -0
  305. package/src/lib/number-parsers.ts +25 -0
  306. package/src/lib/reactivity/createInstanceValueState.ts +69 -43
  307. package/src/lib/reactivity/{createSelectItems.ts → createItemCollection.ts} +41 -36
  308. package/src/lib/xml-serialization.ts +76 -9
  309. package/src/parse/XFormDOM.ts +141 -21
  310. package/src/parse/XFormDefinition.ts +1 -4
  311. package/src/parse/body/BodyDefinition.ts +4 -4
  312. package/src/parse/body/appearance/rangeAppearanceParser.ts +11 -0
  313. package/src/parse/body/control/InputControlDefinition.ts +9 -0
  314. package/src/parse/body/control/{select/ItemDefinition.ts → ItemDefinition.ts} +8 -6
  315. package/src/parse/body/control/{select/ItemsetDefinition.ts → ItemsetDefinition.ts} +11 -9
  316. package/src/parse/body/control/RangeControlDefinition.ts +91 -6
  317. package/src/parse/body/control/RankControlDefinition.ts +25 -7
  318. package/src/parse/body/control/{select/SelectDefinition.ts → SelectControlDefinition.ts} +9 -9
  319. package/src/parse/expression/ItemsetNodesetExpression.ts +1 -1
  320. package/src/parse/expression/ItemsetValueExpression.ts +1 -1
  321. package/src/parse/model/BindDefinition.ts +4 -0
  322. package/src/parse/model/BindPreloadDefinition.ts +100 -0
  323. package/src/parse/model/DescendentNodeDefinition.ts +7 -25
  324. package/src/parse/model/ItextTranslationsDefinition.ts +79 -0
  325. package/src/parse/model/LeafNodeDefinition.ts +13 -8
  326. package/src/parse/model/ModelDefinition.ts +36 -3
  327. package/src/parse/model/NodeDefinition.ts +38 -85
  328. package/src/parse/model/NoteNodeDefinition.ts +12 -10
  329. package/src/parse/model/RangeNodeDefinition.ts +119 -0
  330. package/src/parse/model/RepeatDefinition.ts +382 -0
  331. package/src/parse/model/RootAttributeDefinition.ts +44 -0
  332. package/src/parse/model/RootAttributeMap.ts +49 -0
  333. package/src/parse/model/RootDefinition.ts +42 -43
  334. package/src/parse/model/SecondaryInstance/SecondaryInstancesDefinition.ts +23 -2
  335. package/src/parse/model/SecondaryInstance/assertSecondaryInstanceDefinition.ts +14 -0
  336. package/src/parse/model/SecondaryInstance/defineSecondaryInstance.ts +32 -0
  337. package/src/parse/model/SecondaryInstance/sources/BlankSecondaryInstanceSource.ts +3 -24
  338. package/src/parse/model/SecondaryInstance/sources/CSVExternalSecondaryInstance.ts +33 -86
  339. package/src/parse/model/SecondaryInstance/sources/GeoJSONExternalSecondaryInstance.ts +64 -136
  340. package/src/parse/model/SecondaryInstance/sources/InternalSecondaryInstanceSource.ts +9 -7
  341. package/src/parse/model/SecondaryInstance/sources/SecondaryInstanceSource.ts +1 -1
  342. package/src/parse/model/SecondaryInstance/sources/XMLExternalSecondaryInstanceSource.ts +7 -7
  343. package/src/parse/model/{FormSubmissionDefinition.ts → SubmissionDefinition.ts} +2 -2
  344. package/src/parse/model/SubtreeDefinition.ts +15 -16
  345. package/src/parse/model/nodeDefinitionMap.ts +34 -0
  346. package/src/parse/shared/parseInstanceXML.ts +79 -0
  347. package/src/parse/shared/parseStaticDocumentFromDOMSubtree.ts +46 -131
  348. package/src/parse/text/ItemLabelDefinition.ts +1 -1
  349. package/src/parse/text/ItemsetLabelDefinition.ts +2 -2
  350. package/src/parse/text/abstract/TextElementDefinition.ts +1 -1
  351. package/src/parse/xpath/semantic-analysis.ts +4 -3
  352. package/dist/client/EngineConfig.d.ts +0 -79
  353. package/dist/client/submission/SubmissionData.d.ts +0 -7
  354. package/dist/client/submission/SubmissionInstanceFile.d.ts +0 -6
  355. package/dist/client/submission/SubmissionOptions.d.ts +0 -23
  356. package/dist/client/submission/SubmissionResult.d.ts +0 -91
  357. package/dist/client/submission/SubmissionState.d.ts +0 -12
  358. package/dist/client/unsupported/RangeNode.d.ts +0 -9
  359. package/dist/client/unsupported/RankNode.d.ts +0 -9
  360. package/dist/instance/SelectField.d.ts +0 -58
  361. package/dist/instance/abstract/UnsupportedControl.d.ts +0 -53
  362. package/dist/instance/index.d.ts +0 -8
  363. package/dist/instance/internal-api/ValueContext.d.ts +0 -23
  364. package/dist/instance/internal-api/submission/ClientReactiveSubmittableInstance.d.ts +0 -14
  365. package/dist/instance/internal-api/submission/ClientReactiveSubmittableLeafNode.d.ts +0 -31
  366. package/dist/instance/internal-api/submission/ClientReactiveSubmittableParentNode.d.ts +0 -18
  367. package/dist/instance/internal-api/submission/ClientReactiveSubmittableValueNode.d.ts +0 -17
  368. package/dist/instance/unsupported/RangeControl.d.ts +0 -6
  369. package/dist/instance/unsupported/RankControl.d.ts +0 -6
  370. package/dist/integration/xpath/static-dom/StaticNamedNode.d.ts +0 -17
  371. package/dist/lib/client-reactivity/submission/createInstanceSubmissionState.d.ts +0 -3
  372. package/dist/lib/client-reactivity/submission/createLeafNodeSubmissionState.d.ts +0 -3
  373. package/dist/lib/client-reactivity/submission/createNodeRangeSubmissionState.d.ts +0 -4
  374. package/dist/lib/client-reactivity/submission/createParentNodeSubmissionState.d.ts +0 -4
  375. package/dist/lib/client-reactivity/submission/createValueNodeSubmissionState.d.ts +0 -3
  376. package/dist/lib/client-reactivity/submission/prepareSubmission.d.ts +0 -8
  377. package/dist/lib/reactivity/createSelectItems.d.ts +0 -16
  378. package/dist/lib/reactivity/createValueState.d.ts +0 -40
  379. package/dist/parse/body/control/select/ItemDefinition.d.ts +0 -13
  380. package/dist/parse/body/control/select/ItemsetDefinition.d.ts +0 -17
  381. package/dist/parse/body/control/select/ItemsetNodesetContext.d.ts +0 -9
  382. package/dist/parse/model/ItextTranslation/ItextTranslationDefinition.d.ts +0 -4
  383. package/dist/parse/model/ItextTranslation/ItextTranslationRootDefinition.d.ts +0 -8
  384. package/dist/parse/model/ItextTranslation/ItextTranslationsDefinition.d.ts +0 -8
  385. package/dist/parse/model/RepeatInstanceDefinition.d.ts +0 -14
  386. package/dist/parse/model/RepeatRangeDefinition.d.ts +0 -29
  387. package/dist/parse/model/RepeatTemplateDefinition.d.ts +0 -28
  388. package/dist/parse/model/SecondaryInstance/SecondaryInstanceDefinition.d.ts +0 -4
  389. package/dist/parse/model/SecondaryInstance/SecondaryInstanceRootDefinition.d.ts +0 -7
  390. package/src/client/EngineConfig.ts +0 -84
  391. package/src/client/submission/SubmissionData.ts +0 -12
  392. package/src/client/submission/SubmissionInstanceFile.ts +0 -9
  393. package/src/client/submission/SubmissionOptions.ts +0 -28
  394. package/src/client/submission/SubmissionResult.ts +0 -124
  395. package/src/client/submission/SubmissionState.ts +0 -14
  396. package/src/client/unsupported/RangeNode.ts +0 -14
  397. package/src/client/unsupported/RankNode.ts +0 -14
  398. package/src/instance/SelectField.ts +0 -263
  399. package/src/instance/abstract/UnsupportedControl.ts +0 -174
  400. package/src/instance/children.ts +0 -158
  401. package/src/instance/index.ts +0 -55
  402. package/src/instance/internal-api/ValueContext.ts +0 -28
  403. package/src/instance/internal-api/submission/ClientReactiveSubmittableInstance.ts +0 -20
  404. package/src/instance/internal-api/submission/ClientReactiveSubmittableLeafNode.ts +0 -42
  405. package/src/instance/internal-api/submission/ClientReactiveSubmittableParentNode.ts +0 -25
  406. package/src/instance/internal-api/submission/ClientReactiveSubmittableValueNode.ts +0 -23
  407. package/src/instance/unsupported/RangeControl.ts +0 -9
  408. package/src/instance/unsupported/RankControl.ts +0 -9
  409. package/src/integration/xpath/static-dom/StaticNamedNode.ts +0 -45
  410. package/src/lib/client-reactivity/submission/createInstanceSubmissionState.ts +0 -12
  411. package/src/lib/client-reactivity/submission/createLeafNodeSubmissionState.ts +0 -20
  412. package/src/lib/client-reactivity/submission/createNodeRangeSubmissionState.ts +0 -17
  413. package/src/lib/client-reactivity/submission/createParentNodeSubmissionState.ts +0 -22
  414. package/src/lib/client-reactivity/submission/createValueNodeSubmissionState.ts +0 -21
  415. package/src/lib/client-reactivity/submission/prepareSubmission.ts +0 -172
  416. package/src/lib/reactivity/createValueState.ts +0 -200
  417. package/src/parse/body/control/select/ItemsetNodesetContext.ts +0 -21
  418. package/src/parse/model/ItextTranslation/ItextTranslationDefinition.ts +0 -4
  419. package/src/parse/model/ItextTranslation/ItextTranslationRootDefinition.ts +0 -41
  420. package/src/parse/model/ItextTranslation/ItextTranslationsDefinition.ts +0 -31
  421. package/src/parse/model/RepeatInstanceDefinition.ts +0 -34
  422. package/src/parse/model/RepeatRangeDefinition.ts +0 -94
  423. package/src/parse/model/RepeatTemplateDefinition.ts +0 -145
  424. package/src/parse/model/SecondaryInstance/SecondaryInstanceDefinition.ts +0 -4
  425. package/src/parse/model/SecondaryInstance/SecondaryInstanceRootDefinition.ts +0 -12
@@ -1,7 +1,7 @@
1
1
  import { parseStaticDocumentFromDOMSubtree } from '../../../shared/parseStaticDocumentFromDOMSubtree.ts';
2
2
  import type { DOMSecondaryInstanceElement } from '../../../XFormDOM.ts';
3
- import { SecondaryInstanceDefinition } from '../SecondaryInstanceDefinition.ts';
4
- import { SecondaryInstanceRootDefinition } from '../SecondaryInstanceRootDefinition.ts';
3
+ import { assertSecondaryInstanceDefinition } from '../assertSecondaryInstanceDefinition.ts';
4
+ import type { SecondaryInstanceDefinition } from '../SecondaryInstancesDefinition.ts';
5
5
  import { SecondaryInstanceSource } from './SecondaryInstanceSource.ts';
6
6
 
7
7
  export class InternalSecondaryInstanceSource extends SecondaryInstanceSource<'internal'> {
@@ -10,10 +10,12 @@ export class InternalSecondaryInstanceSource extends SecondaryInstanceSource<'in
10
10
  }
11
11
 
12
12
  parseDefinition(): SecondaryInstanceDefinition {
13
- return parseStaticDocumentFromDOMSubtree(
14
- SecondaryInstanceDefinition,
15
- SecondaryInstanceRootDefinition,
16
- this.domElement
17
- );
13
+ const doc = parseStaticDocumentFromDOMSubtree(this.domElement, {
14
+ nodesetPrefix: `instance('${this.instanceId}')`,
15
+ });
16
+
17
+ assertSecondaryInstanceDefinition(doc);
18
+
19
+ return doc;
18
20
  }
19
21
  }
@@ -1,6 +1,6 @@
1
1
  import type { JRResourceURL } from '@getodk/common/jr-resources/JRResourceURL.ts';
2
2
  import type { DOMSecondaryInstanceElement } from '../../../XFormDOM.ts';
3
- import type { SecondaryInstanceDefinition } from '../SecondaryInstanceDefinition.ts';
3
+ import type { SecondaryInstanceDefinition } from '../SecondaryInstancesDefinition.ts';
4
4
 
5
5
  // prettier-ignore
6
6
  export type ExternalSecondaryInstanceSourceFormat =
@@ -1,7 +1,7 @@
1
1
  import { XFORMS_NAMESPACE_URI } from '@getodk/common/constants/xmlns.ts';
2
2
  import { parseStaticDocumentFromDOMSubtree } from '../../../shared/parseStaticDocumentFromDOMSubtree.ts';
3
- import { SecondaryInstanceDefinition } from '../SecondaryInstanceDefinition.ts';
4
- import { SecondaryInstanceRootDefinition } from '../SecondaryInstanceRootDefinition.ts';
3
+ import { assertSecondaryInstanceDefinition } from '../assertSecondaryInstanceDefinition.ts';
4
+ import type { SecondaryInstanceDefinition } from '../SecondaryInstancesDefinition.ts';
5
5
  import { ExternalSecondaryInstanceSource } from './ExternalSecondaryInstanceSource.ts';
6
6
  import type { InternalSecondaryInstanceSource } from './InternalSecondaryInstanceSource.ts';
7
7
 
@@ -23,10 +23,10 @@ export class XMLExternalSecondaryInstanceSource extends ExternalSecondaryInstanc
23
23
  instanceElement.setAttribute('id', this.instanceId);
24
24
  instanceElement.innerHTML = this.resource.data;
25
25
 
26
- return parseStaticDocumentFromDOMSubtree(
27
- SecondaryInstanceDefinition,
28
- SecondaryInstanceRootDefinition,
29
- instanceElement
30
- );
26
+ const doc = parseStaticDocumentFromDOMSubtree(instanceElement);
27
+
28
+ assertSecondaryInstanceDefinition(doc);
29
+
30
+ return doc;
31
31
  }
32
32
  }
@@ -1,8 +1,8 @@
1
- import type { SubmissionDefinition } from '../../client/submission/SubmissionDefinition.ts';
1
+ import type { SubmissionMeta } from '../../client/submission/SubmissionMeta.ts';
2
2
  import { getSubmissionElement } from '../../lib/dom/query.ts';
3
3
  import type { XFormDOM } from '../XFormDOM.ts';
4
4
 
5
- export class FormSubmissionDefinition implements SubmissionDefinition {
5
+ export class SubmissionDefinition implements SubmissionMeta {
6
6
  readonly submissionAction!: URL | null;
7
7
  readonly submissionMethod = 'post';
8
8
  readonly encryptionKey!: string | null;
@@ -1,31 +1,29 @@
1
+ import type { StaticElement } from '../../integration/xpath/static-dom/StaticElement.ts';
2
+ import { NamespaceDeclarationMap } from '../../lib/names/NamespaceDeclarationMap.ts';
3
+ import { QualifiedName } from '../../lib/names/QualifiedName.ts';
1
4
  import type {
2
5
  AnyBodyElementDefinition,
3
6
  AnyGroupElementDefinition,
4
7
  } from '../body/BodyDefinition.ts';
5
8
  import type { BindDefinition } from './BindDefinition.ts';
6
9
  import { DescendentNodeDefinition } from './DescendentNodeDefinition.ts';
7
- import type {
8
- ChildNodeDefinition,
9
- NodeDefinition,
10
- ParentNodeDefinition,
11
- } from './NodeDefinition.ts';
12
-
13
- export class SubtreeDefinition
14
- extends DescendentNodeDefinition<'subtree', AnyGroupElementDefinition | null>
15
- implements NodeDefinition<'subtree'>
16
- {
10
+ import type { ChildNodeDefinition, ParentNodeDefinition } from './NodeDefinition.ts';
11
+
12
+ export class SubtreeDefinition extends DescendentNodeDefinition<
13
+ 'subtree',
14
+ AnyGroupElementDefinition | null
15
+ > {
17
16
  readonly type = 'subtree';
18
17
 
19
- readonly nodeName: string;
18
+ readonly namespaceDeclarations: NamespaceDeclarationMap;
19
+ readonly qualifiedName: QualifiedName;
20
20
  readonly children: readonly ChildNodeDefinition[];
21
- readonly instances = null;
22
- readonly defaultValue = null;
23
21
 
24
22
  constructor(
25
23
  parent: ParentNodeDefinition,
26
24
  bind: BindDefinition,
27
25
  bodyElement: AnyBodyElementDefinition | null,
28
- readonly node: Element
26
+ readonly template: StaticElement
29
27
  ) {
30
28
  if (
31
29
  bodyElement != null &&
@@ -38,8 +36,9 @@ export class SubtreeDefinition
38
36
 
39
37
  const { root } = parent;
40
38
 
41
- this.nodeName = node.localName;
42
- this.children = root.buildSubtree(this);
39
+ this.qualifiedName = template.qualifiedName;
40
+ this.namespaceDeclarations = new NamespaceDeclarationMap(this);
41
+ this.children = root.buildSubtree(this, template);
43
42
  }
44
43
 
45
44
  toJSON() {
@@ -0,0 +1,34 @@
1
+ import { ErrorProductionDesignPendingError } from '../../error/ErrorProductionDesignPendingError.ts';
2
+ import type { AnyNodeDefinition } from './NodeDefinition.ts';
3
+ import type { RootDefinition } from './RootDefinition.ts';
4
+
5
+ export type NodesetReference = string;
6
+
7
+ const collectDefinitions = (
8
+ result: Map<NodesetReference, AnyNodeDefinition>,
9
+ definition: AnyNodeDefinition
10
+ ): Map<NodesetReference, AnyNodeDefinition> => {
11
+ const { nodeset } = definition;
12
+
13
+ if (result.has(nodeset)) {
14
+ throw new ErrorProductionDesignPendingError();
15
+ }
16
+
17
+ result.set(nodeset, definition);
18
+
19
+ if (definition.type === 'leaf-node') {
20
+ return result;
21
+ }
22
+
23
+ for (const child of definition.children) {
24
+ collectDefinitions(result, child);
25
+ }
26
+
27
+ return result;
28
+ };
29
+
30
+ export type NodeDefinitionMap = ReadonlyMap<NodesetReference, AnyNodeDefinition>;
31
+
32
+ export const nodeDefinitionMap = (root: RootDefinition): NodeDefinitionMap => {
33
+ return collectDefinitions(new Map(), root);
34
+ };
@@ -0,0 +1,79 @@
1
+ import { ErrorProductionDesignPendingError } from '../../error/ErrorProductionDesignPendingError.ts';
2
+ import type { StaticDocument } from '../../integration/xpath/static-dom/StaticDocument.ts';
3
+ import type { StaticNode } from '../../integration/xpath/static-dom/StaticNode.ts';
4
+ import type { NamespaceDeclarationMap } from '../../lib/names/NamespaceDeclarationMap.ts';
5
+ import { escapeXMLText } from '../../lib/xml-serialization.ts';
6
+ import type { ModelDefinition } from '../model/ModelDefinition.ts';
7
+ import type { RootDefinition } from '../model/RootDefinition.ts';
8
+ import { parseStaticDocumentFromDOMSubtree } from './parseStaticDocumentFromDOMSubtree.ts';
9
+
10
+ type WrappedInstanceXML = `<wrapped${string}</wrapped>`;
11
+
12
+ const wrapInstanceXML = (model: ModelDefinition, instanceXML: string): WrappedInstanceXML => {
13
+ const defaultNamespace = model.root.namespaceDeclarations.get(null);
14
+ const defaultNamespaceURI = defaultNamespace?.declaredURI?.href;
15
+
16
+ if (defaultNamespaceURI == null) {
17
+ return `<wrapped>${instanceXML}</wrapped>`;
18
+ }
19
+
20
+ return /* xml */ `<wrapped xmlns="${escapeXMLText(defaultNamespaceURI, true)}">
21
+ ${instanceXML}
22
+ </wrapped>`;
23
+ };
24
+
25
+ type AssertSoleChildElement = (element?: Element | null) => asserts element is Element;
26
+
27
+ const assertSoleChildElement: AssertSoleChildElement = (element) => {
28
+ if (element == null) {
29
+ throw new ErrorProductionDesignPendingError('Expected a child element');
30
+ }
31
+
32
+ const { parentNode } = element;
33
+
34
+ if (parentNode == null) {
35
+ throw new ErrorProductionDesignPendingError('Expected element to be a child of a parent node');
36
+ }
37
+
38
+ if (element !== parentNode.firstElementChild || element !== parentNode.lastElementChild) {
39
+ throw new ErrorProductionDesignPendingError(
40
+ "Expected child element to be parent node's only element child."
41
+ );
42
+ }
43
+ };
44
+
45
+ const getWrappedInstanceRootElement = (xml: WrappedInstanceXML): Element => {
46
+ const domParser = new DOMParser();
47
+ const doc = domParser.parseFromString(xml, 'text/xml');
48
+ const { documentElement } = doc;
49
+ const [root] = documentElement.children;
50
+
51
+ assertSoleChildElement(root);
52
+
53
+ return root;
54
+ };
55
+
56
+ /**
57
+ * Parses incoming instance XML input into a {@link StaticDocument}, preserving
58
+ * the form definition's default namespace URI (when the instance XML does not
59
+ * explicitly declare a default namespace).
60
+ *
61
+ * @todo This is a hack! A proper solution will involve extending namespace
62
+ * resolution (i.e. probably {@link NamespaceDeclarationMap}) from
63
+ * {@link RootDefinition} on down throughout the instance's {@link StaticNode}
64
+ * tree. The same will probably be the case for parsing (XML) external secondary
65
+ * instances as well, so at that point we can also stop using this specialized
66
+ * name!
67
+ *
68
+ * @todo Aside from this being a hack, it's not very robust because it makes
69
+ * assumptions which are _likely but definitely not guaranteed_!
70
+ *
71
+ * - Instance XML (probably) doeesn't declare a default namespace
72
+ * - Instance XML **definitely** declares non-default namespaces
73
+ */
74
+ export const parseInstanceXML = (model: ModelDefinition, instanceXML: string): StaticDocument => {
75
+ const wrappedXML = wrapInstanceXML(model, instanceXML);
76
+ const root = getWrappedInstanceRootElement(wrappedXML);
77
+
78
+ return parseStaticDocumentFromDOMSubtree(root);
79
+ };
@@ -1,149 +1,64 @@
1
- import { UnreachableError } from '@getodk/common/lib/error/UnreachableError.ts';
2
- import type { AnyConstructor } from '@getodk/common/types/helpers.js';
3
- import { StaticAttribute } from '../../integration/xpath/static-dom/StaticAttribute.ts';
1
+ import type { StaticAttributeOptions } from '../../integration/xpath/static-dom/StaticAttribute.ts';
2
+ import { StaticDocument } from '../../integration/xpath/static-dom/StaticDocument.ts';
4
3
  import type {
5
- StaticDocument,
6
- StaticDocumentRootFactory,
7
- } from '../../integration/xpath/static-dom/StaticDocument.ts';
8
- import type {
9
- StaticElementAttributesFactory,
10
- StaticElementChildNodesFactory,
4
+ StaticElementChildOption,
5
+ StaticElementOptions,
11
6
  } from '../../integration/xpath/static-dom/StaticElement.ts';
12
- import { StaticElement } from '../../integration/xpath/static-dom/StaticElement.ts';
13
- import type { StaticNamedNodeOptions } from '../../integration/xpath/static-dom/StaticNamedNode.ts';
14
- import type { StaticParentNode } from '../../integration/xpath/static-dom/StaticNode.ts';
15
- import { StaticText } from '../../integration/xpath/static-dom/StaticText.ts';
16
-
17
- type ConcreteConstructor<T extends AnyConstructor> = Pick<T, keyof T>;
18
-
19
- // prettier-ignore
20
- export type ConcreteStaticDocumentConstructor<
21
- T extends StaticDocument<Root>,
22
- Root extends StaticElement,
23
- > =
24
- & ConcreteConstructor<typeof StaticDocument<Root>>
25
- & (new (rootFactory: StaticDocumentRootFactory<T, Root>) => T);
26
-
27
- const domElementAttributesFactory = (domElement: Element): StaticElementAttributesFactory => {
28
- const attributes = Array.from(domElement.attributes);
7
+ import type { QualifiedNameSource } from '../../lib/names/QualifiedName.ts';
29
8
 
30
- return (element) => {
31
- return attributes.map((attr) => {
32
- return new StaticAttribute(element, attr);
33
- });
9
+ const parseNodeName = (domNode: Attr | Element): QualifiedNameSource => {
10
+ return {
11
+ namespaceURI: domNode.namespaceURI,
12
+ prefix: domNode.prefix,
13
+ localName: domNode.localName,
34
14
  };
35
15
  };
36
16
 
37
- const { ELEMENT_NODE, CDATA_SECTION_NODE, TEXT_NODE } = Node;
38
-
39
- interface StaticChildElementSource {
40
- readonly domType: typeof ELEMENT_NODE;
41
- readonly domNode: Element;
42
- }
43
-
44
- interface StaticChildTextSource {
45
- readonly domType: typeof CDATA_SECTION_NODE | typeof TEXT_NODE;
46
- readonly domNode: CharacterData;
47
- }
48
-
49
- // prettier-ignore
50
- type StaticChildNodeSource =
51
- | StaticChildElementSource
52
- | StaticChildTextSource;
53
-
54
- export const toStaticChildNodeSource = (childNode: ChildNode): StaticChildNodeSource | null => {
55
- const domType = childNode.nodeType;
56
-
57
- switch (domType) {
58
- case ELEMENT_NODE:
59
- return {
60
- domType,
61
- domNode: childNode as Element,
62
- };
63
-
64
- case TEXT_NODE:
65
- return {
66
- domType,
67
- domNode: childNode as Text,
68
- };
69
-
70
- case CDATA_SECTION_NODE:
71
- return {
72
- domType,
73
- domNode: childNode as CDATASection,
74
- };
75
-
76
- default:
77
- return null;
78
- }
79
- };
80
-
81
- const toStaticChildNodeSources = (childNode: ChildNode): StaticChildNodeSource | readonly [] => {
82
- return toStaticChildNodeSource(childNode) ?? [];
17
+ const parseStaticElementAttributes = (domElement: Element): readonly StaticAttributeOptions[] => {
18
+ return Array.from(domElement.attributes).map((attr) => ({
19
+ name: attr,
20
+ value: attr.value,
21
+ }));
83
22
  };
84
23
 
85
- const domElementChildNodesFactory = (domElement: Element): StaticElementChildNodesFactory => {
86
- const childNodeSources = Array.from(domElement.childNodes).flatMap(toStaticChildNodeSources);
24
+ const { ELEMENT_NODE, CDATA_SECTION_NODE, TEXT_NODE } = Node;
87
25
 
88
- return (parent) => {
89
- return childNodeSources.map((domSource) => {
90
- switch (domSource.domType) {
91
- case ELEMENT_NODE:
92
- return parseStaticElementFromDOMElement(parent, StaticElement, domSource.domNode);
26
+ const parseStaticElementChildren = (domElement: Element): readonly StaticElementChildOption[] => {
27
+ return Array.from(domElement.childNodes).flatMap((child) => {
28
+ switch (child.nodeType) {
29
+ case ELEMENT_NODE:
30
+ return parseStaticElementOptions(child as Element);
93
31
 
94
- case TEXT_NODE:
95
- case CDATA_SECTION_NODE:
96
- return new StaticText(parent, domSource.domNode.data);
32
+ case TEXT_NODE:
33
+ case CDATA_SECTION_NODE:
34
+ return (child as CharacterData).data;
97
35
 
98
- default:
99
- throw new UnreachableError(domSource);
100
- }
101
- });
102
- };
36
+ default:
37
+ return [];
38
+ }
39
+ });
103
40
  };
104
41
 
105
- // prettier-ignore
106
- export type StaticElementConstructor<
107
- T extends StaticElement<Parent>,
108
- Parent extends StaticParentNode = StaticParentNode
109
- > =
110
- & ConcreteConstructor<typeof StaticElement>
111
- & {
112
- readonly prototype: T;
113
-
114
- new (
115
- parent: Parent,
116
- attributesFactory: StaticElementAttributesFactory,
117
- childNodesFactory: StaticElementChildNodesFactory,
118
- options: StaticNamedNodeOptions
119
- ): T;
42
+ const parseStaticElementOptions = (domElement: Element): StaticElementOptions => {
43
+ return {
44
+ name: parseNodeName(domElement),
45
+ attributes: parseStaticElementAttributes(domElement),
46
+ children: parseStaticElementChildren(domElement),
120
47
  };
121
-
122
- const parseStaticElementFromDOMElement = <
123
- T extends StaticElement,
124
- Parent extends StaticParentNode = StaticParentNode,
125
- >(
126
- parent: Parent,
127
- ElementConstructor: StaticElementConstructor<T, Parent>,
128
- domElement: Element
129
- ): T => {
130
- const attributesFactory = domElementAttributesFactory(domElement);
131
- const childNodesFactory = domElementChildNodesFactory(domElement);
132
-
133
- return new ElementConstructor(parent, attributesFactory, childNodesFactory, domElement);
134
48
  };
135
49
 
136
- export const parseStaticDocumentFromDOMSubtree = <
137
- T extends StaticDocument<Root>,
138
- Root extends StaticElement<T>,
139
- >(
140
- DocumentConstructor: ConcreteStaticDocumentConstructor<T, Root>,
141
- DocumentRootConstructor: StaticElementConstructor<Root, T>,
142
- subtreeRootElement: Element
143
- ): T => {
144
- const rootFactory: StaticDocumentRootFactory<T, Root> = (parent) => {
145
- return parseStaticElementFromDOMElement(parent, DocumentRootConstructor, subtreeRootElement);
146
- };
50
+ interface ParseStaticDocumentFromDOMSubtreeOptions {
51
+ readonly nodesetPrefix?: string;
52
+ }
53
+
54
+ export const parseStaticDocumentFromDOMSubtree = (
55
+ subtreeRootElement: Element,
56
+ options: ParseStaticDocumentFromDOMSubtreeOptions = {}
57
+ ): StaticDocument => {
58
+ const documentRoot = parseStaticElementOptions(subtreeRootElement);
147
59
 
148
- return new DocumentConstructor(rootFactory);
60
+ return new StaticDocument({
61
+ ...options,
62
+ documentRoot,
63
+ });
149
64
  };
@@ -1,7 +1,7 @@
1
1
  import type { LocalNamedElement } from '@getodk/common/types/dom.ts';
2
2
  import { getLabelElement } from '../../lib/dom/query.ts';
3
3
  import type { XFormDefinition } from '../../parse/XFormDefinition.ts';
4
- import type { ItemDefinition } from '../body/control/select/ItemDefinition.ts';
4
+ import type { ItemDefinition } from '../body/control/ItemDefinition.ts';
5
5
  import { TextElementDefinition } from './abstract/TextElementDefinition.ts';
6
6
 
7
7
  interface LabelElement extends LocalNamedElement<'label'> {}
@@ -1,8 +1,8 @@
1
1
  import type { LocalNamedElement } from '@getodk/common/types/dom.ts';
2
2
  import { getLabelElement } from '../../lib/dom/query.ts';
3
3
  import type { XFormDefinition } from '../../parse/XFormDefinition.ts';
4
- import type { ItemDefinition } from '../body/control/select/ItemDefinition.ts';
5
- import type { ItemsetDefinition } from '../body/control/select/ItemsetDefinition.ts';
4
+ import type { ItemDefinition } from '../body/control/ItemDefinition.ts';
5
+ import type { ItemsetDefinition } from '../body/control/ItemsetDefinition.ts';
6
6
  import { TextReferenceExpression } from '../expression/TextReferenceExpression.ts';
7
7
  import { TextTranslationExpression } from '../expression/TextTranslationExpression.ts';
8
8
  import type { RefAttributeChunk } from './abstract/TextElementDefinition.ts';
@@ -1,7 +1,7 @@
1
1
  import { isElementNode, isTextNode } from '@getodk/common/lib/dom/predicates.ts';
2
2
  import type { ElementTextRole } from '../../../client/TextRange.ts';
3
3
  import type { XFormDefinition } from '../../../parse/XFormDefinition.ts';
4
- import type { ItemDefinition } from '../../body/control/select/ItemDefinition.ts';
4
+ import type { ItemDefinition } from '../../body/control/ItemDefinition.ts';
5
5
  import { TextLiteralExpression } from '../../expression/TextLiteralExpression.ts';
6
6
  import { TextOutputExpression } from '../../expression/TextOutputExpression.ts';
7
7
  import { TextReferenceExpression } from '../../expression/TextReferenceExpression.ts';
@@ -396,9 +396,10 @@ const findConstantExpressionNode = (expression: string): ConstantExpressionSynta
396
396
  }
397
397
  };
398
398
 
399
- type BrandedExpression<Expression extends string, Brand extends symbol> = Expression & {
400
- readonly [K in Brand]: true;
401
- };
399
+ // prettier-ignore
400
+ type BrandedExpression<Expression extends string, Brand extends symbol> =
401
+ & Expression
402
+ & Readonly<Record<Brand, true>>;
402
403
 
403
404
  const CONSTANT_EXPRESSION = Symbol('CONSTANT_EXPRESSION');
404
405
  type CONSTANT_EXPRESSION = typeof CONSTANT_EXPRESSION;
@@ -1,79 +0,0 @@
1
- import { MissingResourceBehavior } from './constants.ts';
2
- import { OpaqueReactiveObjectFactory } from './OpaqueReactiveObjectFactory.ts';
3
- import { FetchFormAttachment, FetchResource } from './resources.ts';
4
- /**
5
- * Options provided by a client to specify certain aspects of engine runtime
6
- * behavior. These options will generally be intended to facilitate cooperation
7
- * where there is mixed responsibility between a client and the engine, or where
8
- * the engine may provide sensible defaults which a client could be expected to
9
- * override or augment.
10
- */
11
- export interface EngineConfig {
12
- /**
13
- * A client may specify a generic function for constructing stateful objects.
14
- * The only hard requirement of this function is that it accepts an **object**
15
- * and returns an object of the same shape. The engine will use this function
16
- * to initialize client-facing state, and will mutate properties of the object
17
- * when their corresponding state is changed.
18
- *
19
- * A client may use this function to provide its own implementation of
20
- * reactivity with semantics like those described above. The mechanism of
21
- * reactivity, if any, is at the discretion of the client. It is expected
22
- * that clients providing this function will use a reactive subscribe-on-read
23
- * mechanism to handle state updates conveyed by the engine.
24
- */
25
- readonly stateFactory?: OpaqueReactiveObjectFactory;
26
- /**
27
- *
28
- * A client may specify an arbitrary {@link fetch}-like function for retrieving an XML XForm form
29
- * definition.
30
- *
31
- * Notes:
32
- *
33
- * - This configuration will only be consuled for calls to
34
- * {@link initializeForm} with a URL referencing an XML XForm definition. It
35
- * will be ignored for calls passing an XML XForm form definition directly.
36
- *
37
- * - For calls to {@link initializeForm} with a URL, if this configuration is
38
- * not specified it will default to the global {@link fetch} function (if
39
- * one is defined).
40
- */
41
- readonly fetchFormDefinition?: FetchResource;
42
- /**
43
- * A client may specify an arbitrary {@link fetch}-like function to retrieve a
44
- * form's attachments, i.e. any `jr:` URL referenced by the form (as specified
45
- * by {@link https://getodk.github.io/xforms-spec/ | ODK XForms}).
46
- *
47
- * Notes:
48
- *
49
- * - This configuration will be consulted for all supported form attachments,
50
- * as a part of {@link initializeForm | form initialization}.
51
- *
52
- * - If this configuration is not specified it will default to the global
53
- * {@link fetch} function (if one is defined).
54
- *
55
- * This default behavior will typically result in failure to load form
56
- * attachments—and in most cases this will also cause
57
- * {@link initializeForm | form initialization} to fail overall—with the
58
- * following exceptions:
59
- *
60
- * - **CLIENT-SPECIFIC:** Usage in coordination with a client-implemented
61
- * {@link https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API | Serivce Worker},
62
- * which can intercept network requests **generally**. Clients already using
63
- * a Service Worker may opt for the convenience of handling network requests
64
- * for `jr:` URLs along with any other network interception logic. Client
65
- * implementors should be warned, however, that such `jr:` URLs are not
66
- * namespaced or otherwise scoped to a particular form; such a client would
67
- * therefore inherently need to coordinate state between the Service Worker
68
- * and the main thread (or whatever other realm calls
69
- * {@link initializeForm}).
70
- */
71
- readonly fetchFormAttachment?: FetchFormAttachment;
72
- /**
73
- * @see {@link MissingResourceBehavior}
74
- * @see {@link MissingResourceBehaviorDefault}
75
- *
76
- * @default MissingResourceBehaviorDefault
77
- */
78
- readonly missingResourceBehavior?: MissingResourceBehavior;
79
- }
@@ -1,7 +0,0 @@
1
- import { SubmissionInstanceFile, SubmissionInstanceFileName } from './SubmissionInstanceFile.ts';
2
- export interface SubmissionData extends FormData {
3
- get(name: SubmissionInstanceFileName): SubmissionInstanceFile;
4
- get(name: string): FormDataEntryValue | null;
5
- has(name: SubmissionInstanceFileName): true;
6
- has(name: string): boolean;
7
- }
@@ -1,6 +0,0 @@
1
- import { SubmissionInstanceFileName, SubmissionInstanceFileType } from '../constants.ts';
2
- export type { SubmissionInstanceFileName, SubmissionInstanceFileType };
3
- export interface SubmissionInstanceFile extends File {
4
- readonly name: SubmissionInstanceFileName;
5
- readonly type: SubmissionInstanceFileType;
6
- }
@@ -1,23 +0,0 @@
1
- export type SubmissionChunkedType = 'chunked' | 'monolithic';
2
- interface BaseSubmissionOptions<ChunkedType extends SubmissionChunkedType> {
3
- readonly chunked?: ChunkedType | undefined;
4
- /**
5
- * As described in the
6
- * {@link https://docs.getodk.org/openrosa-form-submission/#extended-transmission-considerations | OpenRosa Form Submission API},
7
- * clients may obtain this value from an OpenRosa server's
8
- * `X-OpenRosa-Accept-Content-Length` header.
9
- */
10
- readonly maxSize?: number;
11
- }
12
- interface ChunkedSubmissionOptions extends BaseSubmissionOptions<'chunked'> {
13
- readonly maxSize: number;
14
- }
15
- interface MonolithicSubmissionOptions extends BaseSubmissionOptions<'monolithic'> {
16
- readonly chunked?: 'monolithic' | undefined;
17
- readonly maxSize?: never;
18
- }
19
- export type SubmissionOptions<ChunkedType extends SubmissionChunkedType = 'monolithic'> = {
20
- chunked: ChunkedSubmissionOptions;
21
- monolithic: MonolithicSubmissionOptions;
22
- }[ChunkedType];
23
- export {};