@getodk/xforms-engine 0.4.0 → 0.6.0

package/dist/instance/Group.d.ts

@@ -1,31 +1,37 @@
+import { XPathNodeKindKey } from '@getodk/xpath';
 import { Accessor } from 'solid-js';
 import { GroupDefinition, GroupNode, GroupNodeAppearances } from '../client/GroupNode.ts';
+import { FormNodeID } from '../client/identity.ts';
+import { SubmissionState } from '../client/submission/SubmissionState.ts';
 import { TextRange } from '../client/TextRange.ts';
 import { AncestorNodeValidationState } from '../client/validation.ts';
+import { XFormsXPathElement } from '../integration/xpath/adapter/XFormsXPathNode.ts';
 import { MaterializedChildren } from '../lib/reactivity/materializeCurrentStateChildren.ts';
 import { CurrentState } from '../lib/reactivity/node-state/createCurrentState.ts';
 import { EngineState } from '../lib/reactivity/node-state/createEngineState.ts';
 import { SharedNodeState } from '../lib/reactivity/node-state/createSharedNodeState.ts';
 import { DescendantNodeSharedStateSpec, DescendantNode } from './abstract/DescendantNode.ts';
 import { GeneralChildNode, GeneralParentNode } from './hierarchy.ts';
-import { NodeID } from './identity.ts';
 import { EvaluationContext } from './internal-api/EvaluationContext.ts';
-import { SubscribableDependency } from './internal-api/SubscribableDependency.ts';
+import { ClientReactiveSubmittableParentNode } from './internal-api/submission/ClientReactiveSubmittableParentNode.ts';
 interface GroupStateSpec extends DescendantNodeSharedStateSpec {
     readonly label: Accessor<TextRange<'label'> | null>;
     readonly hint: null;
-    readonly children: Accessor<readonly NodeID[]>;
+    readonly children: Accessor<readonly FormNodeID[]>;
     readonly valueOptions: null;
     readonly value: null;
 }
-export declare class Group extends DescendantNode<GroupDefinition, GroupStateSpec, GeneralChildNode> implements GroupNode, EvaluationContext, SubscribableDependency {
+export declare class Group extends DescendantNode<GroupDefinition, GroupStateSpec, GeneralParentNode, GeneralChildNode> implements GroupNode, XFormsXPathElement, EvaluationContext, ClientReactiveSubmittableParentNode<GeneralChildNode> {
     private readonly childrenState;
+    readonly [XPathNodeKindKey] = "element";
     protected readonly state: SharedNodeState<GroupStateSpec>;
     protected engineState: EngineState<GroupStateSpec>;
     readonly nodeType = "group";
     readonly appearances: GroupNodeAppearances;
+    readonly nodeOptions: null;
     readonly currentState: MaterializedChildren<CurrentState<GroupStateSpec>, GeneralChildNode>;
     readonly validationState: AncestorNodeValidationState;
+    readonly submissionState: SubmissionState;
     constructor(parent: GeneralParentNode, definition: GroupDefinition);
     getChildren(): readonly GeneralChildNode[];
 }

package/dist/instance/InputControl.d.ts

@@ -0,0 +1,38 @@
+import { XPathNodeKindKey } from '@getodk/xpath';
+import { Accessor } from 'solid-js';
+import { InputDefinition, InputNode, InputNodeAppearances, InputNodeInputValue, InputNodeOptions } from '../client/InputNode.ts';
+import { TextRange } from '../client/TextRange.ts';
+import { ValueType } from '../client/ValueType.ts';
+import { XFormsXPathElement } from '../integration/xpath/adapter/XFormsXPathNode.ts';
+import { RuntimeInputValue, RuntimeValue } from '../lib/codecs/getSharedValueCodec.ts';
+import { CurrentState } from '../lib/reactivity/node-state/createCurrentState.ts';
+import { EngineState } from '../lib/reactivity/node-state/createEngineState.ts';
+import { SharedNodeState } from '../lib/reactivity/node-state/createSharedNodeState.ts';
+import { ValueNode, ValueNodeStateSpec } from './abstract/ValueNode.ts';
+import { GeneralParentNode } from './hierarchy.ts';
+import { EvaluationContext } from './internal-api/EvaluationContext.ts';
+import { ClientReactiveSubmittableValueNode } from './internal-api/submission/ClientReactiveSubmittableValueNode.ts';
+import { ValidationContext } from './internal-api/ValidationContext.ts';
+import { Root } from './Root.ts';
+export type AnyInputDefinition = {
+    [V in ValueType]: InputDefinition<V>;
+}[ValueType];
+interface InputControlStateSpec<V extends ValueType> extends ValueNodeStateSpec<RuntimeValue<V>> {
+    readonly label: Accessor<TextRange<'label'> | null>;
+    readonly hint: Accessor<TextRange<'hint'> | null>;
+    readonly valueOptions: null;
+}
+export declare class InputControl<V extends ValueType = ValueType> extends ValueNode<V, InputDefinition<V>, RuntimeValue<V>, RuntimeInputValue<V>> implements InputNode<V>, XFormsXPathElement, EvaluationContext, ValidationContext, ClientReactiveSubmittableValueNode {
+    static from(parent: GeneralParentNode, definition: InputDefinition): AnyInputControl;
+    readonly [XPathNodeKindKey] = "element";
+    protected readonly state: SharedNodeState<InputControlStateSpec<V>>;
+    protected readonly engineState: EngineState<InputControlStateSpec<V>>;
+    readonly nodeType = "input";
+    readonly appearances: InputNodeAppearances;
+    readonly nodeOptions: InputNodeOptions<V>;
+    readonly currentState: CurrentState<InputControlStateSpec<V>>;
+    constructor(parent: GeneralParentNode, definition: InputDefinition<V>);
+    setValue(value: InputNodeInputValue<V>): Root;
+}
+export type AnyInputControl = InputControl<'barcode'> | InputControl<'binary'> | InputControl<'boolean'> | InputControl<'date'> | InputControl<'dateTime'> | InputControl<'decimal'> | InputControl<'geopoint'> | InputControl<'geoshape'> | InputControl<'geotrace'> | InputControl<'int'> | InputControl<'intent'> | InputControl<'string'> | InputControl<'time'>;
+export {};

package/dist/instance/ModelValue.d.ts

@@ -1,39 +1,31 @@
-import { ModelValueNode } from '../client/ModelValueNode.ts';
-import { AnyViolation, LeafNodeValidationState } from '../client/validation.ts';
+import { XPathNodeKindKey } from '@getodk/xpath';
+import { ModelValueDefinition, ModelValueNode } from '../client/ModelValueNode.ts';
+import { ValueType } from '../client/ValueType.ts';
+import { XFormsXPathElement } from '../integration/xpath/adapter/XFormsXPathNode.ts';
+import { RuntimeInputValue, RuntimeValue } from '../lib/codecs/getSharedValueCodec.ts';
 import { CurrentState } from '../lib/reactivity/node-state/createCurrentState.ts';
 import { EngineState } from '../lib/reactivity/node-state/createEngineState.ts';
 import { SharedNodeState } from '../lib/reactivity/node-state/createSharedNodeState.ts';
-import { SimpleAtomicState } from '../lib/reactivity/types.ts';
-import { LeafNodeDefinition } from '../parse/model/LeafNodeDefinition.ts';
-import { DescendantNodeStateSpec, DescendantNode } from './abstract/DescendantNode.ts';
+import { ValueNode, ValueNodeStateSpec } from './abstract/ValueNode.ts';
 import { GeneralParentNode } from './hierarchy.ts';
 import { EvaluationContext } from './internal-api/EvaluationContext.ts';
-import { SubscribableDependency } from './internal-api/SubscribableDependency.ts';
 import { ValidationContext } from './internal-api/ValidationContext.ts';
-import { ValueContext } from './internal-api/ValueContext.ts';
-export interface ModelValueDefinition extends LeafNodeDefinition {
-    readonly bodyElement: null;
-}
-interface ModelValueStateSpec extends DescendantNodeStateSpec<string> {
+import { ClientReactiveSubmittableValueNode } from './internal-api/submission/ClientReactiveSubmittableValueNode.ts';
+interface ModelValueStateSpec<V extends ValueType> extends ValueNodeStateSpec<RuntimeValue<V>> {
     readonly label: null;
     readonly hint: null;
-    readonly children: null;
-    readonly value: SimpleAtomicState<string>;
     readonly valueOptions: null;
 }
-export declare class ModelValue extends DescendantNode<ModelValueDefinition, ModelValueStateSpec, null> implements ModelValueNode, EvaluationContext, SubscribableDependency, ValidationContext, ValueContext<string> {
-    private readonly validation;
-    protected readonly state: SharedNodeState<ModelValueStateSpec>;
-    protected engineState: EngineState<ModelValueStateSpec>;
+export declare class ModelValue<V extends ValueType = ValueType> extends ValueNode<V, ModelValueDefinition<V>, RuntimeValue<V>, RuntimeInputValue<V>> implements ModelValueNode<V>, XFormsXPathElement, EvaluationContext, ValidationContext, ClientReactiveSubmittableValueNode {
+    static from(parent: GeneralParentNode, definition: ModelValueDefinition): AnyModelValue;
+    readonly [XPathNodeKindKey] = "element";
+    protected readonly state: SharedNodeState<ModelValueStateSpec<V>>;
+    protected readonly engineState: EngineState<ModelValueStateSpec<V>>;
     readonly nodeType = "model-value";
     readonly appearances: null;
-    readonly currentState: CurrentState<ModelValueStateSpec>;
-    get validationState(): LeafNodeValidationState;
-    readonly encodeValue: (value: string) => string;
-    readonly decodeValue: (value: string) => string;
-    constructor(parent: GeneralParentNode, definition: ModelValueDefinition);
-    getViolation(): AnyViolation | null;
-    isBlank(): boolean;
-    getChildren(): readonly [];
+    readonly nodeOptions: null;
+    readonly currentState: CurrentState<ModelValueStateSpec<V>>;
+    constructor(parent: GeneralParentNode, definition: ModelValueDefinition<V>);
 }
+export type AnyModelValue = ModelValue<'barcode'> | ModelValue<'binary'> | ModelValue<'boolean'> | ModelValue<'date'> | ModelValue<'dateTime'> | ModelValue<'decimal'> | ModelValue<'geopoint'> | ModelValue<'geoshape'> | ModelValue<'geotrace'> | ModelValue<'int'> | ModelValue<'intent'> | ModelValue<'string'> | ModelValue<'time'>;
 export {};

package/dist/instance/Note.d.ts

@@ -1,41 +1,36 @@
+import { XPathNodeKindKey } from '@getodk/xpath';
 import { Accessor } from 'solid-js';
-import { NoteNode, NoteNodeAppearances } from '../client/NoteNode.ts';
+import { NoteNode, NoteNodeAppearances, NoteValue } from '../client/NoteNode.ts';
 import { TextRange } from '../client/TextRange.ts';
-import { AnyViolation, LeafNodeValidationState } from '../client/validation.ts';
+import { ValueType } from '../client/ValueType.ts';
+import { XFormsXPathElement } from '../integration/xpath/adapter/XFormsXPathNode.ts';
+import { NoteInputValue, NoteRuntimeValue } from '../lib/codecs/NoteCodec.ts';
 import { CurrentState } from '../lib/reactivity/node-state/createCurrentState.ts';
 import { EngineState } from '../lib/reactivity/node-state/createEngineState.ts';
 import { SharedNodeState } from '../lib/reactivity/node-state/createSharedNodeState.ts';
 import { ComputedNoteText } from '../lib/reactivity/text/createNoteText.ts';
-import { SimpleAtomicState } from '../lib/reactivity/types.ts';
 import { NoteNodeDefinition } from '../parse/model/NoteNodeDefinition.ts';
-import { DescendantNodeStateSpec, DescendantNode } from './abstract/DescendantNode.ts';
+import { ValueNode, ValueNodeStateSpec } from './abstract/ValueNode.ts';
 import { GeneralParentNode } from './hierarchy.ts';
 import { EvaluationContext } from './internal-api/EvaluationContext.ts';
-import { SubscribableDependency } from './internal-api/SubscribableDependency.ts';
+import { ClientReactiveSubmittableValueNode } from './internal-api/submission/ClientReactiveSubmittableValueNode.ts';
 import { ValidationContext } from './internal-api/ValidationContext.ts';
-import { ValueContext } from './internal-api/ValueContext.ts';
-interface NoteStateSpec extends DescendantNodeStateSpec<string> {
+interface NoteStateSpec<V extends ValueType> extends ValueNodeStateSpec<NoteValue<V>> {
     readonly readonly: Accessor<true>;
     readonly noteText: ComputedNoteText;
     readonly label: Accessor<TextRange<'label', 'form'> | null>;
     readonly hint: Accessor<TextRange<'hint', 'form'> | null>;
-    readonly children: null;
-    readonly value: SimpleAtomicState<string>;
     readonly valueOptions: null;
 }
-export declare class Note extends DescendantNode<NoteNodeDefinition, NoteStateSpec, null> implements NoteNode, EvaluationContext, SubscribableDependency, ValidationContext, ValueContext<string> {
-    private readonly validation;
-    protected readonly state: SharedNodeState<NoteStateSpec>;
-    protected engineState: EngineState<NoteStateSpec>;
+export declare class Note<V extends ValueType = ValueType> extends ValueNode<V, NoteNodeDefinition<V>, NoteRuntimeValue<V>, NoteInputValue<V>> implements NoteNode, XFormsXPathElement, EvaluationContext, ValidationContext, ClientReactiveSubmittableValueNode {
+    readonly [XPathNodeKindKey] = "element";
+    protected readonly state: SharedNodeState<NoteStateSpec<V>>;
+    protected readonly engineState: EngineState<NoteStateSpec<V>>;
     readonly nodeType = "note";
     readonly appearances: NoteNodeAppearances;
-    readonly currentState: CurrentState<NoteStateSpec>;
-    get validationState(): LeafNodeValidationState;
-    readonly encodeValue: (value: string) => string;
-    readonly decodeValue: (value: string) => string;
-    constructor(parent: GeneralParentNode, definition: NoteNodeDefinition);
-    getViolation(): AnyViolation | null;
-    isBlank(): boolean;
-    getChildren(): readonly [];
+    readonly nodeOptions: null;
+    readonly currentState: CurrentState<NoteStateSpec<V>>;
+    constructor(parent: GeneralParentNode, definition: NoteNodeDefinition<V>);
 }
+export type AnyNote = Note<'barcode'> | Note<'binary'> | Note<'boolean'> | Note<'date'> | Note<'dateTime'> | Note<'decimal'> | Note<'geopoint'> | Note<'geoshape'> | Note<'geotrace'> | Note<'int'> | Note<'intent'> | Note<'string'> | Note<'time'>;
 export {};

package/dist/instance/PrimaryInstance.d.ts

@@ -0,0 +1,85 @@
+import { XPathNodeKindKey } from '@getodk/xpath';
+import { Accessor } from 'solid-js';
+import { ActiveLanguage, FormLanguage, FormLanguages } from '../client/FormLanguage.ts';
+import { FormNodeID } from '../client/identity.ts';
+import { SubmissionChunkedType, SubmissionOptions } from '../client/submission/SubmissionOptions.ts';
+import { SubmissionResult } from '../client/submission/SubmissionResult.ts';
+import { SubmissionState } from '../client/submission/SubmissionState.ts';
+import { AncestorNodeValidationState } from '../client/validation.ts';
+import { XFormsXPathDocument } from '../integration/xpath/adapter/XFormsXPathNode.ts';
+import { EngineXPathEvaluator } from '../integration/xpath/EngineXPathEvaluator.ts';
+import { MaterializedChildren } from '../lib/reactivity/materializeCurrentStateChildren.ts';
+import { CurrentState } from '../lib/reactivity/node-state/createCurrentState.ts';
+import { EngineState } from '../lib/reactivity/node-state/createEngineState.ts';
+import { SharedNodeState } from '../lib/reactivity/node-state/createSharedNodeState.ts';
+import { ReactiveScope } from '../lib/reactivity/scope.ts';
+import { BodyClassList } from '../parse/body/BodyDefinition.ts';
+import { ModelDefinition } from '../parse/model/ModelDefinition.ts';
+import { RootDefinition } from '../parse/model/RootDefinition.ts';
+import { SecondaryInstancesDefinition } from '../parse/model/SecondaryInstance/SecondaryInstancesDefinition.ts';
+import { InstanceNode } from './abstract/InstanceNode.ts';
+import { EvaluationContext } from './internal-api/EvaluationContext.ts';
+import { InstanceConfig } from './internal-api/InstanceConfig.ts';
+import { PrimaryInstanceDocument } from './internal-api/PrimaryInstanceDocument.ts';
+import { ClientReactiveSubmittableInstance } from './internal-api/submission/ClientReactiveSubmittableInstance.ts';
+import { TranslationContext } from './internal-api/TranslationContext.ts';
+import { Root } from './Root.ts';
+interface PrimaryInstanceStateSpec {
+    readonly reference: string;
+    readonly readonly: boolean;
+    readonly relevant: boolean;
+    readonly required: boolean;
+    readonly label: null;
+    readonly hint: null;
+    readonly children: Accessor<readonly FormNodeID[]>;
+    readonly valueOptions: null;
+    readonly value: null;
+    readonly activeLanguage: Accessor<ActiveLanguage>;
+}
+export declare class PrimaryInstance extends InstanceNode<RootDefinition, PrimaryInstanceStateSpec, null, Root> implements PrimaryInstanceDocument, XFormsXPathDocument, TranslationContext, EvaluationContext, ClientReactiveSubmittableInstance {
+    protected readonly state: SharedNodeState<PrimaryInstanceStateSpec>;
+    protected readonly engineState: EngineState<PrimaryInstanceStateSpec>;
+    readonly getChildren: Accessor<readonly Root[]>;
+    readonly hasReadonlyAncestor: () => boolean;
+    readonly isReadonly: () => boolean;
+    readonly hasNonRelevantAncestor: () => boolean;
+    readonly isRelevant: () => boolean;
+    private readonly setActiveLanguage;
+    readonly [XPathNodeKindKey] = "document";
+    readonly nodeType = "primary-instance";
+    readonly appearances: null;
+    readonly nodeOptions: null;
+    readonly classes: BodyClassList;
+    readonly root: Root;
+    readonly currentState: MaterializedChildren<CurrentState<PrimaryInstanceStateSpec>, Root>;
+    readonly validationState: AncestorNodeValidationState;
+    readonly submissionState: SubmissionState;
+    readonly languages: FormLanguages;
+    readonly getActiveLanguage: Accessor<ActiveLanguage>;
+    readonly isAttached: Accessor<boolean>;
+    readonly evaluator: EngineXPathEvaluator;
+    readonly contextNode: this;
+    constructor(scope: ReactiveScope, model: ModelDefinition, secondaryInstances: SecondaryInstancesDefinition, engineConfig: InstanceConfig);
+    /**
+     * @todo Note that this method's signature is intentionally derived from
+     * {@link RootNode.setLanguage}, but its return type differs! The design
+     * intent of returning {@link RootNode} from all of the client-facing state
+     * setter methods has proven… interesting philosophically. But nothing
+     * downstream has availed itself of that philosophy, and otherwise it's not
+     * particularly pragmatic or ergonomic (internally or for clients alike).
+     *
+     * Since this class is (currently) engine-internal, this seems like an
+     * excellent place to start a discussion around what we want longer term for
+     * state setter signatures in _client-facing_ APIs. As a first pass, it seems
+     * reasonable to borrow the idiomatic convention of returning the effective
+     * value assigned by the setter.
+     *
+     * @see
+     * {@link https://github.com/getodk/web-forms/issues/45#issuecomment-1967932261 | Initial read interface design between engine and UI - design summary comment}
+     * (and some of the comments leading up to it) for background on the
+     * philosophical reasoning behind the existing signature convention.
+     */
+    setLanguage(language: FormLanguage): FormLanguage;
+    prepareSubmission<ChunkedType extends SubmissionChunkedType = 'monolithic'>(options?: SubmissionOptions<ChunkedType>): Promise<SubmissionResult<ChunkedType>>;
+}
+export {};

package/dist/instance/RangeControl.d.ts

@@ -0,0 +1,34 @@
+import { XPathNodeKindKey } from '@getodk/xpath';
+import { Accessor } from 'solid-js';
+import { RangeInputValue, RangeNode, RangeNodeAppearances, RangeValue } from '../client/RangeNode.ts';
+import { TextRange } from '../client/TextRange.ts';
+import { XFormsXPathElement } from '../integration/xpath/adapter/XFormsXPathNode.ts';
+import { CurrentState } from '../lib/reactivity/node-state/createCurrentState.ts';
+import { EngineState } from '../lib/reactivity/node-state/createEngineState.ts';
+import { SharedNodeState } from '../lib/reactivity/node-state/createSharedNodeState.ts';
+import { AnyRangeNodeDefinition, RangeNodeDefinition, RangeValueType } from '../parse/model/RangeNodeDefinition.ts';
+import { Root } from './Root.ts';
+import { ValueNode, ValueNodeStateSpec } from './abstract/ValueNode.ts';
+import { GeneralParentNode } from './hierarchy.ts';
+import { EvaluationContext } from './internal-api/EvaluationContext.ts';
+import { ValidationContext } from './internal-api/ValidationContext.ts';
+import { ClientReactiveSubmittableValueNode } from './internal-api/submission/ClientReactiveSubmittableValueNode.ts';
+interface RangeControlStateSpec<V extends RangeValueType> extends ValueNodeStateSpec<RangeValue<V>> {
+    readonly label: Accessor<TextRange<'label'> | null>;
+    readonly hint: Accessor<TextRange<'hint'> | null>;
+    readonly valueOptions: null;
+}
+export declare class RangeControl<V extends RangeValueType = RangeValueType> extends ValueNode<V, RangeNodeDefinition<V>, RangeValue<V>, RangeInputValue<V>> implements RangeNode<V>, XFormsXPathElement, EvaluationContext, ValidationContext, ClientReactiveSubmittableValueNode {
+    static from(parent: GeneralParentNode, definition: AnyRangeNodeDefinition): AnyRangeControl;
+    readonly [XPathNodeKindKey] = "element";
+    protected readonly state: SharedNodeState<RangeControlStateSpec<V>>;
+    protected readonly engineState: EngineState<RangeControlStateSpec<V>>;
+    readonly nodeType = "range";
+    readonly appearances: RangeNodeAppearances;
+    readonly nodeOptions: null;
+    readonly currentState: CurrentState<RangeControlStateSpec<V>>;
+    constructor(parent: GeneralParentNode, definition: RangeNodeDefinition<V>);
+    setValue(value: RangeInputValue<V>): Root;
+}
+export type AnyRangeControl = RangeControl<'decimal'> | RangeControl<'int'>;
+export {};

package/dist/instance/RankControl.d.ts

@@ -0,0 +1,40 @@
+import { XPathNodeKindKey } from '@getodk/xpath';
+import { Accessor } from 'solid-js';
+import { RankDefinition, RankNode, RankValueOptions } from '../client/RankNode.ts';
+import { TextRange } from '../client/TextRange.ts';
+import { XFormsXPathElement } from '../integration/xpath/adapter/XFormsXPathNode.ts';
+import { CurrentState } from '../lib/reactivity/node-state/createCurrentState.ts';
+import { EngineState } from '../lib/reactivity/node-state/createEngineState.ts';
+import { SharedNodeState } from '../lib/reactivity/node-state/createSharedNodeState.ts';
+import { Root } from './Root.ts';
+import { ValueNodeStateSpec, ValueNode } from './abstract/ValueNode.ts';
+import { GeneralParentNode } from './hierarchy.ts';
+import { EvaluationContext } from './internal-api/EvaluationContext.ts';
+import { ValidationContext } from './internal-api/ValidationContext.ts';
+import { ClientReactiveSubmittableValueNode } from './internal-api/submission/ClientReactiveSubmittableValueNode.ts';
+import { UnknownAppearanceDefinition } from '../parse/body/appearance/unknownAppearanceParser.ts';
+import { ValueType } from '../client/ValueType.ts';
+export type AnyRankDefinition = {
+    [V in ValueType]: RankDefinition<V>;
+}[ValueType];
+interface RankControlStateSpec extends ValueNodeStateSpec<readonly string[]> {
+    readonly label: Accessor<TextRange<'label'> | null>;
+    readonly hint: Accessor<TextRange<'hint'> | null>;
+    readonly valueOptions: Accessor<RankValueOptions>;
+}
+export declare class RankControl extends ValueNode<'string', RankDefinition<'string'>, readonly string[], readonly string[]> implements RankNode, XFormsXPathElement, EvaluationContext, ValidationContext, ClientReactiveSubmittableValueNode {
+    static from(parent: GeneralParentNode, definition: RankDefinition): RankControl;
+    private readonly mapOptionsByValue;
+    protected readonly getInstanceValue: Accessor<string>;
+    readonly [XPathNodeKindKey] = "element";
+    protected readonly state: SharedNodeState<RankControlStateSpec>;
+    protected readonly engineState: EngineState<RankControlStateSpec>;
+    readonly nodeType = "rank";
+    readonly appearances: UnknownAppearanceDefinition;
+    readonly nodeOptions: null;
+    readonly currentState: CurrentState<RankControlStateSpec>;
+    private constructor();
+    getValueLabel(value: string): TextRange<'item-label'> | null;
+    setValues(valuesInOrder: readonly string[]): Root;
+}
+export {};

package/dist/instance/Root.d.ts

@@ -1,57 +1,62 @@
-import { XFormsXPathEvaluator } from '@getodk/xpath';
-import { Accessor, Signal } from 'solid-js';
+import { XPathNodeKindKey } from '@getodk/xpath';
+import { Accessor } from 'solid-js';
 import { ActiveLanguage, FormLanguage, FormLanguages } from '../client/FormLanguage.ts';
+import { FormNodeID } from '../client/identity.ts';
 import { RootNode } from '../client/RootNode.ts';
+import { SubmissionDefinition } from '../client/submission/SubmissionDefinition.ts';
+import { SubmissionChunkedType, SubmissionOptions } from '../client/submission/SubmissionOptions.ts';
+import { SubmissionResult } from '../client/submission/SubmissionResult.ts';
+import { SubmissionState } from '../client/submission/SubmissionState.ts';
 import { AncestorNodeValidationState } from '../client/validation.ts';
+import { XFormsXPathElement } from '../integration/xpath/adapter/XFormsXPathNode.ts';
 import { MaterializedChildren } from '../lib/reactivity/materializeCurrentStateChildren.ts';
 import { CurrentState } from '../lib/reactivity/node-state/createCurrentState.ts';
 import { EngineState } from '../lib/reactivity/node-state/createEngineState.ts';
 import { SharedNodeState } from '../lib/reactivity/node-state/createSharedNodeState.ts';
 import { BodyClassList } from '../parse/body/BodyDefinition.ts';
 import { RootDefinition } from '../parse/model/RootDefinition.ts';
-import { XFormDOM } from '../parse/XFormDOM.ts';
-import { InstanceNode } from './abstract/InstanceNode.ts';
+import { DescendantNode } from './abstract/DescendantNode.ts';
 import { GeneralChildNode } from './hierarchy.ts';
-import { NodeID } from './identity.ts';
-import { EvaluationContext, EvaluationContextRoot } from './internal-api/EvaluationContext.ts';
-import { InstanceConfig } from './internal-api/InstanceConfig.ts';
-import { SubscribableDependency } from './internal-api/SubscribableDependency.ts';
+import { EvaluationContext } from './internal-api/EvaluationContext.ts';
+import { ClientReactiveSubmittableParentNode } from './internal-api/submission/ClientReactiveSubmittableParentNode.ts';
 import { TranslationContext } from './internal-api/TranslationContext.ts';
+import { PrimaryInstance } from './PrimaryInstance.ts';
 interface RootStateSpec {
-    readonly reference: string;
-    readonly readonly: boolean;
-    readonly relevant: boolean;
-    readonly required: boolean;
+    readonly reference: Accessor<string>;
+    readonly readonly: Accessor<boolean>;
+    readonly relevant: Accessor<boolean>;
+    readonly required: Accessor<boolean>;
     readonly label: null;
     readonly hint: null;
-    readonly children: Accessor<readonly NodeID[]>;
+    readonly children: Accessor<readonly FormNodeID[]>;
     readonly valueOptions: null;
     readonly value: null;
-    readonly activeLanguage: Signal<ActiveLanguage>;
+    readonly activeLanguage: Accessor<ActiveLanguage>;
 }
-export declare class Root extends InstanceNode<RootDefinition, RootStateSpec, GeneralChildNode> implements RootNode, EvaluationContext, EvaluationContextRoot, SubscribableDependency, TranslationContext {
+export declare class Root extends DescendantNode<RootDefinition, RootStateSpec, PrimaryInstance, GeneralChildNode> implements RootNode, XFormsXPathElement, EvaluationContext, TranslationContext, ClientReactiveSubmittableParentNode<GeneralChildNode> {
     private readonly childrenState;
+    readonly [XPathNodeKindKey] = "element";
+    protected readonly state: SharedNodeState<RootStateSpec>;
+    protected readonly engineState: EngineState<RootStateSpec>;
     readonly hasReadonlyAncestor: () => boolean;
+    readonly isSelfReadonly: () => boolean;
     readonly isReadonly: () => boolean;
     readonly hasNonRelevantAncestor: () => boolean;
+    readonly isSelfRelevant: () => boolean;
     readonly isRelevant: () => boolean;
-    protected readonly state: SharedNodeState<RootStateSpec>;
-    protected readonly engineState: EngineState<RootStateSpec>;
+    readonly isRequired: () => boolean;
     readonly nodeType = "root";
     readonly appearances: null;
+    readonly nodeOptions: null;
     readonly classes: BodyClassList;
     readonly currentState: MaterializedChildren<CurrentState<RootStateSpec>, GeneralChildNode>;
     readonly validationState: AncestorNodeValidationState;
-    protected readonly instanceDOM: XFormDOM;
-    readonly root: this;
-    readonly evaluator: XFormsXPathEvaluator;
-    readonly contextNode: Element;
-    readonly parent: null;
+    readonly submissionState: SubmissionState;
+    get submissionDefinition(): SubmissionDefinition;
     readonly languages: FormLanguages;
-    get activeLanguage(): ActiveLanguage;
-    constructor(xformDOM: XFormDOM, definition: RootDefinition, engineConfig: InstanceConfig);
+    constructor(parent: PrimaryInstance);
     getChildren(): readonly GeneralChildNode[];
     setLanguage(language: FormLanguage): Root;
-    subscribe(): void;
+    prepareSubmission<ChunkedType extends SubmissionChunkedType = 'monolithic'>(options?: SubmissionOptions<ChunkedType>): Promise<SubmissionResult<ChunkedType>>;
 }
 export {};

package/dist/instance/SelectControl.d.ts

@@ -0,0 +1,66 @@
+import { XPathNodeKindKey } from '@getodk/xpath';
+import { Accessor } from 'solid-js';
+import { SelectDefinition, SelectItem, SelectNode, SelectNodeAppearances, SelectValueOptions } from '../client/SelectNode.ts';
+import { TextRange } from '../client/TextRange.ts';
+import { ValueType } from '../client/ValueType.ts';
+import { XFormsXPathElement } from '../integration/xpath/adapter/XFormsXPathNode.ts';
+import { CurrentState } from '../lib/reactivity/node-state/createCurrentState.ts';
+import { EngineState } from '../lib/reactivity/node-state/createEngineState.ts';
+import { SharedNodeState } from '../lib/reactivity/node-state/createSharedNodeState.ts';
+import { SelectType } from '../parse/body/control/SelectControlDefinition.ts';
+import { Root } from './Root.ts';
+import { ValueNodeStateSpec, ValueNode } from './abstract/ValueNode.ts';
+import { GeneralParentNode } from './hierarchy.ts';
+import { EvaluationContext } from './internal-api/EvaluationContext.ts';
+import { ValidationContext } from './internal-api/ValidationContext.ts';
+import { ClientReactiveSubmittableValueNode } from './internal-api/submission/ClientReactiveSubmittableValueNode.ts';
+export type AnySelectDefinition = {
+    [V in ValueType]: SelectDefinition<V>;
+}[ValueType];
+interface SelectControlStateSpec extends ValueNodeStateSpec<readonly string[]> {
+    readonly label: Accessor<TextRange<'label'> | null>;
+    readonly hint: Accessor<TextRange<'hint'> | null>;
+    readonly valueOptions: Accessor<SelectValueOptions>;
+}
+export declare class SelectControl extends ValueNode<'string', SelectDefinition<'string'>, readonly string[], readonly string[]> implements SelectNode, XFormsXPathElement, EvaluationContext, ValidationContext, ClientReactiveSubmittableValueNode {
+    static from(parent: GeneralParentNode, definition: SelectDefinition): SelectControl;
+    private readonly mapOptionsByValue;
+    protected readonly getInstanceValue: Accessor<string>;
+    readonly [XPathNodeKindKey] = "element";
+    protected readonly state: SharedNodeState<SelectControlStateSpec>;
+    protected readonly engineState: EngineState<SelectControlStateSpec>;
+    readonly nodeType = "select";
+    readonly selectType: SelectType;
+    readonly appearances: SelectNodeAppearances;
+    readonly nodeOptions: null;
+    readonly currentState: CurrentState<SelectControlStateSpec>;
+    private constructor();
+    /**
+     * Filters {@link values} to include only those values which are currently
+     * available in the mapping produced by {@link mapOptionsByValue}, i.e. within
+     * a potentially filtered itemset.
+     *
+     * Note: this method effectively produces an intersection of
+     * {@link sourceValues} and {@link values}. **Importantly**, ordering of the
+     * results is deterministic, preserving the order of values as yielded _by
+     * {@link sourceValues}_.
+     *
+     * At time of writing, there are several tests (in `@getodk/scenario`, ported
+     * from JavaRosa) which expect the values of a `<select>` to match the order
+     * they appear in the control's (potentially filtered) `<itemset>` (or list of
+     * `<item>`s, for forms defining those inline).
+     *
+     * @todo The `<odk:rank>` control, having semantics very similar to
+     * `<select>`, will likely perform similar filtering logic. However, one of
+     * the important distinctions between these controls is that `<odk:rank>`
+     * exists explicitly to control the order of values. It's quite likely that
+     * would be achieved by invoking the same logic with the parameter order
+     * reversed.
+     */
+    private filterValues;
+    getValueOption(value: string): SelectItem | null;
+    isSelected(value: string): boolean;
+    selectValue(value: string | null): Root;
+    selectValues(values: readonly string[]): Root;
+}
+export {};

package/dist/instance/Subtree.d.ts

@@ -1,30 +1,36 @@
+import { XPathNodeKindKey } from '@getodk/xpath';
 import { Accessor } from 'solid-js';
+import { FormNodeID } from '../client/identity.ts';
+import { SubmissionState } from '../client/submission/SubmissionState.ts';
 import { SubtreeDefinition, SubtreeNode } from '../client/SubtreeNode.ts';
 import { AncestorNodeValidationState } from '../client/validation.ts';
+import { XFormsXPathElement } from '../integration/xpath/adapter/XFormsXPathNode.ts';
 import { MaterializedChildren } from '../lib/reactivity/materializeCurrentStateChildren.ts';
 import { CurrentState } from '../lib/reactivity/node-state/createCurrentState.ts';
 import { EngineState } from '../lib/reactivity/node-state/createEngineState.ts';
 import { SharedNodeState } from '../lib/reactivity/node-state/createSharedNodeState.ts';
 import { DescendantNodeSharedStateSpec, DescendantNode } from './abstract/DescendantNode.ts';
 import { GeneralChildNode, GeneralParentNode } from './hierarchy.ts';
-import { NodeID } from './identity.ts';
 import { EvaluationContext } from './internal-api/EvaluationContext.ts';
-import { SubscribableDependency } from './internal-api/SubscribableDependency.ts';
+import { ClientReactiveSubmittableParentNode } from './internal-api/submission/ClientReactiveSubmittableParentNode.ts';
 interface SubtreeStateSpec extends DescendantNodeSharedStateSpec {
     readonly label: null;
     readonly hint: null;
-    readonly children: Accessor<readonly NodeID[]>;
+    readonly children: Accessor<readonly FormNodeID[]>;
     readonly valueOptions: null;
     readonly value: null;
 }
-export declare class Subtree extends DescendantNode<SubtreeDefinition, SubtreeStateSpec, GeneralChildNode> implements SubtreeNode, EvaluationContext, SubscribableDependency {
+export declare class Subtree extends DescendantNode<SubtreeDefinition, SubtreeStateSpec, GeneralParentNode, GeneralChildNode> implements SubtreeNode, XFormsXPathElement, EvaluationContext, ClientReactiveSubmittableParentNode<GeneralChildNode> {
     private readonly childrenState;
+    readonly [XPathNodeKindKey] = "element";
     protected readonly state: SharedNodeState<SubtreeStateSpec>;
-    protected engineState: EngineState<SubtreeStateSpec>;
+    protected readonly engineState: EngineState<SubtreeStateSpec>;
     readonly nodeType = "subtree";
     readonly appearances: null;
+    readonly nodeOptions: null;
     readonly currentState: MaterializedChildren<CurrentState<SubtreeStateSpec>, GeneralChildNode>;
     readonly validationState: AncestorNodeValidationState;
+    readonly submissionState: SubmissionState;
     constructor(parent: GeneralParentNode, definition: SubtreeDefinition);
     getChildren(): readonly GeneralChildNode[];
 }

package/dist/instance/TriggerControl.d.ts

@@ -1,40 +1,34 @@
+import { XPathNodeKindKey } from '@getodk/xpath';
 import { Accessor } from 'solid-js';
 import { TextRange } from '../client/TextRange.ts';
 import { TriggerNode, TriggerNodeDefinition } from '../client/TriggerNode.ts';
-import { AnyViolation, LeafNodeValidationState } from '../client/validation.ts';
+import { XFormsXPathElement } from '../integration/xpath/adapter/XFormsXPathNode.ts';
+import { TriggerInputValue, TriggerRuntimeValue } from '../lib/codecs/TriggerCodec.ts';
 import { CurrentState } from '../lib/reactivity/node-state/createCurrentState.ts';
 import { EngineState } from '../lib/reactivity/node-state/createEngineState.ts';
 import { SharedNodeState } from '../lib/reactivity/node-state/createSharedNodeState.ts';
-import { SimpleAtomicState } from '../lib/reactivity/types.ts';
 import { UnknownAppearanceDefinition } from '../parse/body/appearance/unknownAppearanceParser.ts';
 import { Root } from './Root.ts';
-import { DescendantNodeStateSpec, DescendantNode } from './abstract/DescendantNode.ts';
+import { ValueNode, ValueNodeStateSpec } from './abstract/ValueNode.ts';
 import { GeneralParentNode } from './hierarchy.ts';
 import { EvaluationContext } from './internal-api/EvaluationContext.ts';
-import { SubscribableDependency } from './internal-api/SubscribableDependency.ts';
 import { ValidationContext } from './internal-api/ValidationContext.ts';
-import { ValueContext } from './internal-api/ValueContext.ts';
-interface TriggerControlStateSpec extends DescendantNodeStateSpec<boolean> {
+import { ClientReactiveSubmittableValueNode } from './internal-api/submission/ClientReactiveSubmittableValueNode.ts';
+interface TriggerControlStateSpec extends ValueNodeStateSpec<TriggerRuntimeValue> {
     readonly label: Accessor<TextRange<'label'> | null>;
     readonly hint: Accessor<TextRange<'hint'> | null>;
-    readonly children: null;
-    readonly value: SimpleAtomicState<boolean>;
     readonly valueOptions: null;
 }
-export declare class TriggerControl extends DescendantNode<TriggerNodeDefinition, TriggerControlStateSpec, null> implements TriggerNode, EvaluationContext, SubscribableDependency, ValidationContext, ValueContext<boolean> {
-    private readonly validation;
+export declare class TriggerControl extends ValueNode<'string', TriggerNodeDefinition<'string'>, TriggerRuntimeValue, TriggerInputValue> implements TriggerNode, XFormsXPathElement, EvaluationContext, ValidationContext, ClientReactiveSubmittableValueNode {
+    static from(parent: GeneralParentNode, definition: TriggerNodeDefinition): TriggerControl;
+    readonly [XPathNodeKindKey] = "element";
     protected readonly state: SharedNodeState<TriggerControlStateSpec>;
-    protected engineState: EngineState<TriggerControlStateSpec>;
+    protected readonly engineState: EngineState<TriggerControlStateSpec>;
     readonly nodeType = "trigger";
     readonly appearances: UnknownAppearanceDefinition;
+    readonly nodeOptions: null;
     readonly currentState: CurrentState<TriggerControlStateSpec>;
-    get validationState(): LeafNodeValidationState;
-    readonly encodeValue: (runtimeValue: boolean) => string;
-    readonly decodeValue: (instanceValue: string) => boolean;
-    constructor(parent: GeneralParentNode, definition: TriggerNodeDefinition);
-    getViolation(): AnyViolation | null;
-    isBlank(): boolean;
-    getChildren(): readonly [];
-    setValue(value: boolean): Root;
+    private constructor();
+    setValue(value: TriggerInputValue): Root;
 }
 export {};