@getodk/xforms-engine 0.6.0 → 0.7.0

package/dist/instance/Group.d.ts

@@ -2,10 +2,11 @@ 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 { InstanceState } from '../client/serialization/InstanceState.ts';
 import { TextRange } from '../client/TextRange.ts';
 import { AncestorNodeValidationState } from '../client/validation.ts';
 import { XFormsXPathElement } from '../integration/xpath/adapter/XFormsXPathNode.ts';
+import { StaticElement } from '../integration/xpath/static-dom/StaticElement.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';
@@ -13,7 +14,7 @@ import { SharedNodeState } from '../lib/reactivity/node-state/createSharedNodeSt
 import { DescendantNodeSharedStateSpec, DescendantNode } from './abstract/DescendantNode.ts';
 import { GeneralChildNode, GeneralParentNode } from './hierarchy.ts';
 import { EvaluationContext } from './internal-api/EvaluationContext.ts';
-import { ClientReactiveSubmittableParentNode } from './internal-api/submission/ClientReactiveSubmittableParentNode.ts';
+import { ClientReactiveSerializableParentNode } from './internal-api/serialization/ClientReactiveSerializableParentNode.ts';
 interface GroupStateSpec extends DescendantNodeSharedStateSpec {
     readonly label: Accessor<TextRange<'label'> | null>;
     readonly hint: null;
@@ -21,7 +22,7 @@ interface GroupStateSpec extends DescendantNodeSharedStateSpec {
     readonly valueOptions: null;
     readonly value: null;
 }
-export declare class Group extends DescendantNode<GroupDefinition, GroupStateSpec, GeneralParentNode, GeneralChildNode> implements GroupNode, XFormsXPathElement, EvaluationContext, ClientReactiveSubmittableParentNode<GeneralChildNode> {
+export declare class Group extends DescendantNode<GroupDefinition, GroupStateSpec, GeneralParentNode, GeneralChildNode> implements GroupNode, XFormsXPathElement, EvaluationContext, ClientReactiveSerializableParentNode<GeneralChildNode> {
     private readonly childrenState;
     readonly [XPathNodeKindKey] = "element";
     protected readonly state: SharedNodeState<GroupStateSpec>;
@@ -31,8 +32,8 @@ export declare class Group extends DescendantNode<GroupDefinition, GroupStateSpe
     readonly nodeOptions: null;
     readonly currentState: MaterializedChildren<CurrentState<GroupStateSpec>, GeneralChildNode>;
     readonly validationState: AncestorNodeValidationState;
-    readonly submissionState: SubmissionState;
-    constructor(parent: GeneralParentNode, definition: GroupDefinition);
+    readonly instanceState: InstanceState;
+    constructor(parent: GeneralParentNode, instanceNode: StaticElement | null, definition: GroupDefinition);
     getChildren(): readonly GeneralChildNode[];
 }
 export {};

package/dist/instance/InputControl.d.ts

@@ -4,6 +4,7 @@ import { InputDefinition, InputNode, InputNodeAppearances, InputNodeInputValue,
 import { TextRange } from '../client/TextRange.ts';
 import { ValueType } from '../client/ValueType.ts';
 import { XFormsXPathElement } from '../integration/xpath/adapter/XFormsXPathNode.ts';
+import { StaticLeafElement } from '../integration/xpath/static-dom/StaticElement.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';
@@ -11,7 +12,7 @@ import { SharedNodeState } from '../lib/reactivity/node-state/createSharedNodeSt
 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 { ClientReactiveSerializableValueNode } from './internal-api/serialization/ClientReactiveSerializableValueNode.ts';
 import { ValidationContext } from './internal-api/ValidationContext.ts';
 import { Root } from './Root.ts';
 export type AnyInputDefinition = {
@@ -22,8 +23,8 @@ interface InputControlStateSpec<V extends ValueType> extends ValueNodeStateSpec<
     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;
+export declare class InputControl<V extends ValueType = ValueType> extends ValueNode<V, InputDefinition<V>, RuntimeValue<V>, RuntimeInputValue<V>> implements InputNode<V>, XFormsXPathElement, EvaluationContext, ValidationContext, ClientReactiveSerializableValueNode {
+    static from(parent: GeneralParentNode, instanceNode: StaticLeafElement | null, definition: InputDefinition): AnyInputControl;
     readonly [XPathNodeKindKey] = "element";
     protected readonly state: SharedNodeState<InputControlStateSpec<V>>;
     protected readonly engineState: EngineState<InputControlStateSpec<V>>;
@@ -31,7 +32,7 @@ export declare class InputControl<V extends ValueType = ValueType> extends Value
     readonly appearances: InputNodeAppearances;
     readonly nodeOptions: InputNodeOptions<V>;
     readonly currentState: CurrentState<InputControlStateSpec<V>>;
-    constructor(parent: GeneralParentNode, definition: InputDefinition<V>);
+    constructor(parent: GeneralParentNode, instanceNode: StaticLeafElement | null, 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'>;

package/dist/instance/ModelValue.d.ts

@@ -2,6 +2,7 @@ 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 { StaticLeafElement } from '../integration/xpath/static-dom/StaticElement.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';
@@ -10,14 +11,14 @@ 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';
+import { ClientReactiveSerializableValueNode } from './internal-api/serialization/ClientReactiveSerializableValueNode.ts';
 interface ModelValueStateSpec<V extends ValueType> extends ValueNodeStateSpec<RuntimeValue<V>> {
     readonly label: null;
     readonly hint: null;
     readonly valueOptions: null;
 }
-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;
+export declare class ModelValue<V extends ValueType = ValueType> extends ValueNode<V, ModelValueDefinition<V>, RuntimeValue<V>, RuntimeInputValue<V>> implements ModelValueNode<V>, XFormsXPathElement, EvaluationContext, ValidationContext, ClientReactiveSerializableValueNode {
+    static from(parent: GeneralParentNode, instanceNode: StaticLeafElement | null, definition: ModelValueDefinition): AnyModelValue;
     readonly [XPathNodeKindKey] = "element";
     protected readonly state: SharedNodeState<ModelValueStateSpec<V>>;
     protected readonly engineState: EngineState<ModelValueStateSpec<V>>;
@@ -25,7 +26,7 @@ export declare class ModelValue<V extends ValueType = ValueType> extends ValueNo
     readonly appearances: null;
     readonly nodeOptions: null;
     readonly currentState: CurrentState<ModelValueStateSpec<V>>;
-    constructor(parent: GeneralParentNode, definition: ModelValueDefinition<V>);
+    constructor(parent: GeneralParentNode, instanceNode: StaticLeafElement | null, 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

@@ -4,6 +4,7 @@ import { NoteNode, NoteNodeAppearances, NoteValue } from '../client/NoteNode.ts'
 import { TextRange } from '../client/TextRange.ts';
 import { ValueType } from '../client/ValueType.ts';
 import { XFormsXPathElement } from '../integration/xpath/adapter/XFormsXPathNode.ts';
+import { StaticLeafElement } from '../integration/xpath/static-dom/StaticElement.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';
@@ -13,7 +14,7 @@ import { NoteNodeDefinition } from '../parse/model/NoteNodeDefinition.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 { ClientReactiveSerializableValueNode } from './internal-api/serialization/ClientReactiveSerializableValueNode.ts';
 import { ValidationContext } from './internal-api/ValidationContext.ts';
 interface NoteStateSpec<V extends ValueType> extends ValueNodeStateSpec<NoteValue<V>> {
     readonly readonly: Accessor<true>;
@@ -22,7 +23,7 @@ interface NoteStateSpec<V extends ValueType> extends ValueNodeStateSpec<NoteValu
     readonly hint: Accessor<TextRange<'hint', 'form'> | null>;
     readonly valueOptions: null;
 }
-export declare class Note<V extends ValueType = ValueType> extends ValueNode<V, NoteNodeDefinition<V>, NoteRuntimeValue<V>, NoteInputValue<V>> implements NoteNode, XFormsXPathElement, EvaluationContext, ValidationContext, ClientReactiveSubmittableValueNode {
+export declare class Note<V extends ValueType = ValueType> extends ValueNode<V, NoteNodeDefinition<V>, NoteRuntimeValue<V>, NoteInputValue<V>> implements NoteNode, XFormsXPathElement, EvaluationContext, ValidationContext, ClientReactiveSerializableValueNode {
     readonly [XPathNodeKindKey] = "element";
     protected readonly state: SharedNodeState<NoteStateSpec<V>>;
     protected readonly engineState: EngineState<NoteStateSpec<V>>;
@@ -30,7 +31,7 @@ export declare class Note<V extends ValueType = ValueType> extends ValueNode<V,
     readonly appearances: NoteNodeAppearances;
     readonly nodeOptions: null;
     readonly currentState: CurrentState<NoteStateSpec<V>>;
-    constructor(parent: GeneralParentNode, definition: NoteNodeDefinition<V>);
+    constructor(parent: GeneralParentNode, instanceNode: StaticLeafElement | null, 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

@@ -1,13 +1,15 @@
 import { XPathNodeKindKey } from '@getodk/xpath';
 import { Accessor } from 'solid-js';
+import { FormInstanceInitializationMode } from '../client/form/FormInstance.ts';
 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 { InstancePayload } from '../client/serialization/InstancePayload.ts';
+import { InstancePayloadOptions, InstancePayloadType } from '../client/serialization/InstancePayloadOptions.ts';
+import { InstanceState } from '../client/serialization/InstanceState.ts';
 import { AncestorNodeValidationState } from '../client/validation.ts';
 import { XFormsXPathDocument } from '../integration/xpath/adapter/XFormsXPathNode.ts';
 import { EngineXPathEvaluator } from '../integration/xpath/EngineXPathEvaluator.ts';
+import { StaticDocument } from '../integration/xpath/static-dom/StaticDocument.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';
@@ -18,10 +20,11 @@ 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 { InitialInstanceState } from './input/InitialInstanceState.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 { ClientReactiveSerializableInstance } from './internal-api/serialization/ClientReactiveSerializableInstance.ts';
 import { TranslationContext } from './internal-api/TranslationContext.ts';
 import { Root } from './Root.ts';
 interface PrimaryInstanceStateSpec {
@@ -36,9 +39,33 @@ interface PrimaryInstanceStateSpec {
     readonly value: null;
     readonly activeLanguage: Accessor<ActiveLanguage>;
 }
-export declare class PrimaryInstance extends InstanceNode<RootDefinition, PrimaryInstanceStateSpec, null, Root> implements PrimaryInstanceDocument, XFormsXPathDocument, TranslationContext, EvaluationContext, ClientReactiveSubmittableInstance {
+interface PrimaryInstanceStateInputByMode {
+    readonly create: null;
+    readonly edit: InitialInstanceState;
+    readonly restore: InitialInstanceState;
+}
+export type PrimaryInstanceInitialState<Mode extends FormInstanceInitializationMode> = PrimaryInstanceStateInputByMode[Mode];
+export interface BasePrimaryInstanceOptions {
+    readonly scope: ReactiveScope;
+    readonly model: ModelDefinition;
+    readonly secondaryInstances: SecondaryInstancesDefinition;
+}
+export interface ModelessPrimaryInstanceOptions extends BasePrimaryInstanceOptions {
+    readonly config: InstanceConfig;
+}
+export interface PrimaryInstanceOptions<Mode extends FormInstanceInitializationMode> extends ModelessPrimaryInstanceOptions {
+    readonly mode: Mode;
+    readonly initialState: PrimaryInstanceInitialState<Mode>;
+}
+export declare class PrimaryInstance<Mode extends FormInstanceInitializationMode = FormInstanceInitializationMode> extends InstanceNode<RootDefinition, PrimaryInstanceStateSpec, null, Root> implements PrimaryInstanceDocument, XFormsXPathDocument, TranslationContext, EvaluationContext, ClientReactiveSerializableInstance {
+    /**
+     * @todo this will be populated as we introduce other initialization modes!
+     */
+    readonly initializationMode: FormInstanceInitializationMode;
+    readonly model: ModelDefinition;
     protected readonly state: SharedNodeState<PrimaryInstanceStateSpec>;
     protected readonly engineState: EngineState<PrimaryInstanceStateSpec>;
+    readonly instanceNode: StaticDocument;
     readonly getChildren: Accessor<readonly Root[]>;
     readonly hasReadonlyAncestor: () => boolean;
     readonly isReadonly: () => boolean;
@@ -53,13 +80,13 @@ export declare class PrimaryInstance extends InstanceNode<RootDefinition, Primar
     readonly root: Root;
     readonly currentState: MaterializedChildren<CurrentState<PrimaryInstanceStateSpec>, Root>;
     readonly validationState: AncestorNodeValidationState;
-    readonly submissionState: SubmissionState;
+    readonly instanceState: InstanceState;
     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);
+    constructor(options: PrimaryInstanceOptions<Mode>);
     /**
      * @todo Note that this method's signature is intentionally derived from
      * {@link RootNode.setLanguage}, but its return type differs! The design
@@ -80,6 +107,6 @@ export declare class PrimaryInstance extends InstanceNode<RootDefinition, Primar
      * philosophical reasoning behind the existing signature convention.
      */
     setLanguage(language: FormLanguage): FormLanguage;
-    prepareSubmission<ChunkedType extends SubmissionChunkedType = 'monolithic'>(options?: SubmissionOptions<ChunkedType>): Promise<SubmissionResult<ChunkedType>>;
+    prepareInstancePayload<PayloadType extends InstancePayloadType = 'monolithic'>(options?: InstancePayloadOptions<PayloadType>): Promise<InstancePayload<PayloadType>>;
 }
 export {};

package/dist/instance/RangeControl.d.ts

@@ -3,6 +3,7 @@ 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 { StaticLeafElement } from '../integration/xpath/static-dom/StaticElement.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';
@@ -12,14 +13,14 @@ 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';
+import { ClientReactiveSerializableValueNode } from './internal-api/serialization/ClientReactiveSerializableValueNode.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;
+export declare class RangeControl<V extends RangeValueType = RangeValueType> extends ValueNode<V, RangeNodeDefinition<V>, RangeValue<V>, RangeInputValue<V>> implements RangeNode<V>, XFormsXPathElement, EvaluationContext, ValidationContext, ClientReactiveSerializableValueNode {
+    static from(parent: GeneralParentNode, instanceNode: StaticLeafElement | null, definition: AnyRangeNodeDefinition): AnyRangeControl;
     readonly [XPathNodeKindKey] = "element";
     protected readonly state: SharedNodeState<RangeControlStateSpec<V>>;
     protected readonly engineState: EngineState<RangeControlStateSpec<V>>;
@@ -27,7 +28,7 @@ export declare class RangeControl<V extends RangeValueType = RangeValueType> ext
     readonly appearances: RangeNodeAppearances;
     readonly nodeOptions: null;
     readonly currentState: CurrentState<RangeControlStateSpec<V>>;
-    constructor(parent: GeneralParentNode, definition: RangeNodeDefinition<V>);
+    constructor(parent: GeneralParentNode, instanceNode: StaticLeafElement | null, definition: RangeNodeDefinition<V>);
     setValue(value: RangeInputValue<V>): Root;
 }
 export type AnyRangeControl = RangeControl<'decimal'> | RangeControl<'int'>;

package/dist/instance/RankControl.d.ts

@@ -2,18 +2,19 @@ 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 { ValueType } from '../client/ValueType.ts';
 import { XFormsXPathElement } from '../integration/xpath/adapter/XFormsXPathNode.ts';
+import { StaticLeafElement } from '../integration/xpath/static-dom/StaticElement.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 { UnknownAppearanceDefinition } from '../parse/body/appearance/unknownAppearanceParser.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';
+import { ClientReactiveSerializableValueNode } from './internal-api/serialization/ClientReactiveSerializableValueNode.ts';
 export type AnyRankDefinition = {
     [V in ValueType]: RankDefinition<V>;
 }[ValueType];
@@ -22,8 +23,8 @@ interface RankControlStateSpec extends ValueNodeStateSpec<readonly string[]> {
     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;
+export declare class RankControl extends ValueNode<'string', RankDefinition<'string'>, readonly string[], readonly string[]> implements RankNode, XFormsXPathElement, EvaluationContext, ValidationContext, ClientReactiveSerializableValueNode {
+    static from(parent: GeneralParentNode, instanceNode: StaticLeafElement | null, definition: RankDefinition): RankControl;
     private readonly mapOptionsByValue;
     protected readonly getInstanceValue: Accessor<string>;
     readonly [XPathNodeKindKey] = "element";

package/dist/instance/Root.d.ts

@@ -3,10 +3,9 @@ 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 { InstancePayload } from '../client/serialization/InstancePayload.ts';
+import { InstancePayloadOptions, InstancePayloadType } from '../client/serialization/InstancePayloadOptions.ts';
+import { InstanceState } from '../client/serialization/InstanceState.ts';
 import { AncestorNodeValidationState } from '../client/validation.ts';
 import { XFormsXPathElement } from '../integration/xpath/adapter/XFormsXPathNode.ts';
 import { MaterializedChildren } from '../lib/reactivity/materializeCurrentStateChildren.ts';
@@ -18,7 +17,7 @@ import { RootDefinition } from '../parse/model/RootDefinition.ts';
 import { DescendantNode } from './abstract/DescendantNode.ts';
 import { GeneralChildNode } from './hierarchy.ts';
 import { EvaluationContext } from './internal-api/EvaluationContext.ts';
-import { ClientReactiveSubmittableParentNode } from './internal-api/submission/ClientReactiveSubmittableParentNode.ts';
+import { ClientReactiveSerializableParentNode } from './internal-api/serialization/ClientReactiveSerializableParentNode.ts';
 import { TranslationContext } from './internal-api/TranslationContext.ts';
 import { PrimaryInstance } from './PrimaryInstance.ts';
 interface RootStateSpec {
@@ -33,7 +32,7 @@ interface RootStateSpec {
     readonly value: null;
     readonly activeLanguage: Accessor<ActiveLanguage>;
 }
-export declare class Root extends DescendantNode<RootDefinition, RootStateSpec, PrimaryInstance, GeneralChildNode> implements RootNode, XFormsXPathElement, EvaluationContext, TranslationContext, ClientReactiveSubmittableParentNode<GeneralChildNode> {
+export declare class Root extends DescendantNode<RootDefinition, RootStateSpec, PrimaryInstance, GeneralChildNode> implements RootNode, XFormsXPathElement, EvaluationContext, TranslationContext, ClientReactiveSerializableParentNode<GeneralChildNode> {
     private readonly childrenState;
     readonly [XPathNodeKindKey] = "element";
     protected readonly state: SharedNodeState<RootStateSpec>;
@@ -51,12 +50,11 @@ export declare class Root extends DescendantNode<RootDefinition, RootStateSpec,
     readonly classes: BodyClassList;
     readonly currentState: MaterializedChildren<CurrentState<RootStateSpec>, GeneralChildNode>;
     readonly validationState: AncestorNodeValidationState;
-    readonly submissionState: SubmissionState;
-    get submissionDefinition(): SubmissionDefinition;
+    readonly instanceState: InstanceState;
     readonly languages: FormLanguages;
     constructor(parent: PrimaryInstance);
     getChildren(): readonly GeneralChildNode[];
     setLanguage(language: FormLanguage): Root;
-    prepareSubmission<ChunkedType extends SubmissionChunkedType = 'monolithic'>(options?: SubmissionOptions<ChunkedType>): Promise<SubmissionResult<ChunkedType>>;
+    prepareInstancePayload<PayloadType extends InstancePayloadType = 'monolithic'>(options?: InstancePayloadOptions<PayloadType>): Promise<InstancePayload<PayloadType>>;
 }
 export {};

package/dist/instance/SelectControl.d.ts

@@ -4,6 +4,7 @@ import { SelectDefinition, SelectItem, SelectNode, SelectNodeAppearances, Select
 import { TextRange } from '../client/TextRange.ts';
 import { ValueType } from '../client/ValueType.ts';
 import { XFormsXPathElement } from '../integration/xpath/adapter/XFormsXPathNode.ts';
+import { StaticLeafElement } from '../integration/xpath/static-dom/StaticElement.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';
@@ -13,7 +14,7 @@ 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 { ClientReactiveSerializableValueNode } from './internal-api/serialization/ClientReactiveSerializableValueNode.ts';
 export type AnySelectDefinition = {
     [V in ValueType]: SelectDefinition<V>;
 }[ValueType];
@@ -22,8 +23,8 @@ interface SelectControlStateSpec extends ValueNodeStateSpec<readonly string[]> {
     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;
+export declare class SelectControl extends ValueNode<'string', SelectDefinition<'string'>, readonly string[], readonly string[]> implements SelectNode, XFormsXPathElement, EvaluationContext, ValidationContext, ClientReactiveSerializableValueNode {
+    static from(parent: GeneralParentNode, instanceNode: StaticLeafElement | null, definition: SelectDefinition): SelectControl;
     private readonly mapOptionsByValue;
     protected readonly getInstanceValue: Accessor<string>;
     readonly [XPathNodeKindKey] = "element";

package/dist/instance/Subtree.d.ts

@@ -1,10 +1,11 @@
 import { XPathNodeKindKey } from '@getodk/xpath';
 import { Accessor } from 'solid-js';
 import { FormNodeID } from '../client/identity.ts';
-import { SubmissionState } from '../client/submission/SubmissionState.ts';
+import { InstanceState } from '../client/serialization/InstanceState.ts';
 import { SubtreeDefinition, SubtreeNode } from '../client/SubtreeNode.ts';
 import { AncestorNodeValidationState } from '../client/validation.ts';
 import { XFormsXPathElement } from '../integration/xpath/adapter/XFormsXPathNode.ts';
+import { StaticElement } from '../integration/xpath/static-dom/StaticElement.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';
@@ -12,7 +13,7 @@ import { SharedNodeState } from '../lib/reactivity/node-state/createSharedNodeSt
 import { DescendantNodeSharedStateSpec, DescendantNode } from './abstract/DescendantNode.ts';
 import { GeneralChildNode, GeneralParentNode } from './hierarchy.ts';
 import { EvaluationContext } from './internal-api/EvaluationContext.ts';
-import { ClientReactiveSubmittableParentNode } from './internal-api/submission/ClientReactiveSubmittableParentNode.ts';
+import { ClientReactiveSerializableParentNode } from './internal-api/serialization/ClientReactiveSerializableParentNode.ts';
 interface SubtreeStateSpec extends DescendantNodeSharedStateSpec {
     readonly label: null;
     readonly hint: null;
@@ -20,7 +21,7 @@ interface SubtreeStateSpec extends DescendantNodeSharedStateSpec {
     readonly valueOptions: null;
     readonly value: null;
 }
-export declare class Subtree extends DescendantNode<SubtreeDefinition, SubtreeStateSpec, GeneralParentNode, GeneralChildNode> implements SubtreeNode, XFormsXPathElement, EvaluationContext, ClientReactiveSubmittableParentNode<GeneralChildNode> {
+export declare class Subtree extends DescendantNode<SubtreeDefinition, SubtreeStateSpec, GeneralParentNode, GeneralChildNode> implements SubtreeNode, XFormsXPathElement, EvaluationContext, ClientReactiveSerializableParentNode<GeneralChildNode> {
     private readonly childrenState;
     readonly [XPathNodeKindKey] = "element";
     protected readonly state: SharedNodeState<SubtreeStateSpec>;
@@ -30,8 +31,8 @@ export declare class Subtree extends DescendantNode<SubtreeDefinition, SubtreeSt
     readonly nodeOptions: null;
     readonly currentState: MaterializedChildren<CurrentState<SubtreeStateSpec>, GeneralChildNode>;
     readonly validationState: AncestorNodeValidationState;
-    readonly submissionState: SubmissionState;
-    constructor(parent: GeneralParentNode, definition: SubtreeDefinition);
+    readonly instanceState: InstanceState;
+    constructor(parent: GeneralParentNode, instanceNode: StaticElement | null, definition: SubtreeDefinition);
     getChildren(): readonly GeneralChildNode[];
 }
 export {};

package/dist/instance/TriggerControl.d.ts

@@ -3,6 +3,7 @@ import { Accessor } from 'solid-js';
 import { TextRange } from '../client/TextRange.ts';
 import { TriggerNode, TriggerNodeDefinition } from '../client/TriggerNode.ts';
 import { XFormsXPathElement } from '../integration/xpath/adapter/XFormsXPathNode.ts';
+import { StaticLeafElement } from '../integration/xpath/static-dom/StaticElement.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';
@@ -13,14 +14,14 @@ 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';
+import { ClientReactiveSerializableValueNode } from './internal-api/serialization/ClientReactiveSerializableValueNode.ts';
 interface TriggerControlStateSpec extends ValueNodeStateSpec<TriggerRuntimeValue> {
     readonly label: Accessor<TextRange<'label'> | null>;
     readonly hint: Accessor<TextRange<'hint'> | null>;
     readonly valueOptions: null;
 }
-export declare class TriggerControl extends ValueNode<'string', TriggerNodeDefinition<'string'>, TriggerRuntimeValue, TriggerInputValue> implements TriggerNode, XFormsXPathElement, EvaluationContext, ValidationContext, ClientReactiveSubmittableValueNode {
-    static from(parent: GeneralParentNode, definition: TriggerNodeDefinition): TriggerControl;
+export declare class TriggerControl extends ValueNode<'string', TriggerNodeDefinition<'string'>, TriggerRuntimeValue, TriggerInputValue> implements TriggerNode, XFormsXPathElement, EvaluationContext, ValidationContext, ClientReactiveSerializableValueNode {
+    static from(parent: GeneralParentNode, instanceNode: StaticLeafElement | null, definition: TriggerNodeDefinition): TriggerControl;
     readonly [XPathNodeKindKey] = "element";
     protected readonly state: SharedNodeState<TriggerControlStateSpec>;
     protected readonly engineState: EngineState<TriggerControlStateSpec>;

package/dist/instance/abstract/DescendantNode.d.ts

@@ -6,6 +6,7 @@ import { InstanceNodeType } from '../../client/node-types.ts';
 import { PrimaryInstanceXPathChildNode } from '../../integration/xpath/adapter/kind.ts';
 import { XFormsXPathPrimaryInstanceDescendantNode, XFormsXPathPrimaryInstanceDescendantNodeKind } from '../../integration/xpath/adapter/XFormsXPathNode.ts';
 import { EngineXPathEvaluator } from '../../integration/xpath/EngineXPathEvaluator.ts';
+import { StaticElement } from '../../integration/xpath/static-dom/StaticElement.ts';
 import { AnyNodeDefinition } from '../../parse/model/NodeDefinition.ts';
 import { AnyChildNode, AnyParentNode } from '../hierarchy.ts';
 import { EvaluationContext } from '../internal-api/EvaluationContext.ts';
@@ -23,8 +24,16 @@ export type AnyDescendantNode = DescendantNode<DescendantNodeDefinition, Descend
 interface DescendantNodeOptions {
     readonly computeReference?: Accessor<string>;
 }
+/**
+ * @todo Unify constructor signatures of {@link DescendantNode} and its
+ * subclasses, which will simplify the branchy logic of child node construction
+ * and minimize internal churn as common themes evolve. A good starting point is
+ * beginning to form in {@link DescendantNodeInitOptions} (not to be confused
+ * with the current module-local {@link DescendantNodeOptions}).
+ */
 export declare abstract class DescendantNode<Definition extends DescendantNodeDefinition, Spec extends DescendantNodeStateSpec<any>, Parent extends AnyParentNode, Child extends AnyChildNode | null = null> extends InstanceNode<Definition, Spec, Parent, Child> implements BaseNode, XFormsXPathPrimaryInstanceDescendantNode, EvaluationContext {
     readonly parent: Parent;
+    readonly instanceNode: StaticElement | null;
     readonly definition: Definition;
     /**
      * Partial implementation of {@link isAttached}, used to check whether `this`
@@ -56,7 +65,7 @@ export declare abstract class DescendantNode<Definition extends DescendantNodeDe
     readonly evaluator: EngineXPathEvaluator;
     readonly contextNode: PrimaryInstanceXPathChildNode;
     readonly getActiveLanguage: Accessor<ActiveLanguage>;
-    constructor(parent: Parent, definition: Definition, options?: DescendantNodeOptions);
+    constructor(parent: Parent, instanceNode: StaticElement | null, definition: Definition, options?: DescendantNodeOptions);
     /**
      * @package
      *

package/dist/instance/abstract/InstanceNode.d.ts

@@ -4,12 +4,14 @@ import { BaseNode } from '../../client/BaseNode.ts';
 import { NodeAppearances } from '../../client/NodeAppearances.ts';
 import { FormNodeID } from '../../client/identity.ts';
 import { InstanceNodeType as ClientInstanceNodeType } from '../../client/node-types.ts';
-import { SubmissionState } from '../../client/submission/SubmissionState.ts';
+import { InstanceState } from '../../client/serialization/InstanceState.ts';
 import { NodeValidationState } from '../../client/validation.ts';
 import { ActiveLanguage, TextRange } from '../../index.ts';
 import { EngineXPathEvaluator } from '../../integration/xpath/EngineXPathEvaluator.ts';
 import { XFormsXPathPrimaryInstanceNode, XFormsXPathPrimaryInstanceNodeKind } from '../../integration/xpath/adapter/XFormsXPathNode.ts';
 import { PrimaryInstanceXPathNode } from '../../integration/xpath/adapter/kind.ts';
+import { StaticDocument } from '../../integration/xpath/static-dom/StaticDocument.ts';
+import { StaticElement } from '../../integration/xpath/static-dom/StaticElement.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';
@@ -55,8 +57,9 @@ export interface InstanceNodeOptions {
     readonly scope?: ReactiveScope;
 }
 export declare abstract class InstanceNode<Definition extends AnyNodeDefinition, Spec extends InstanceNodeStateSpec<any>, Parent extends AnyParentNode | null, Child extends AnyChildNode | null = null> implements BaseEngineNode, XFormsXPathPrimaryInstanceNode, EvaluationContext {
-    readonly engineConfig: InstanceConfig;
+    readonly instanceConfig: InstanceConfig;
     readonly parent: Parent;
+    readonly instanceNode: StaticDocument | StaticElement | null;
     readonly definition: Definition;
     protected abstract readonly state: SharedNodeState<Spec>;
     protected abstract readonly engineState: EngineState<Spec>;
@@ -89,7 +92,7 @@ export declare abstract class InstanceNode<Definition extends AnyNodeDefinition,
     abstract readonly nodeOptions: object | null;
     abstract readonly currentState: InstanceNodeCurrentState<Spec, Child>;
     abstract readonly validationState: NodeValidationState;
-    abstract readonly submissionState: SubmissionState;
+    abstract readonly instanceState: InstanceState;
     abstract readonly evaluator: EngineXPathEvaluator;
     abstract readonly getActiveLanguage: Accessor<ActiveLanguage>;
     abstract readonly isAttached: Accessor<boolean>;
@@ -103,7 +106,7 @@ export declare abstract class InstanceNode<Definition extends AnyNodeDefinition,
      * constrain) their more specific `this` type.
      */
     readonly contextNode: PrimaryInstanceXPathNode;
-    constructor(engineConfig: InstanceConfig, parent: Parent, definition: Definition, options?: InstanceNodeOptions);
+    constructor(instanceConfig: InstanceConfig, parent: Parent, instanceNode: StaticDocument | StaticElement | null, definition: Definition, options?: InstanceNodeOptions);
     /** @package */
     isPrimaryInstance(): this is PrimaryInstance;
     /** @package */

package/dist/instance/abstract/ValueNode.d.ts

@@ -2,10 +2,11 @@ import { XPathNodeKindKey } from '@getodk/xpath';
 import { Accessor } from 'solid-js';
 import { BaseValueNode } from '../../client/BaseValueNode.ts';
 import { LeafNodeType as ValueNodeType } from '../../client/node-types.ts';
-import { SubmissionState } from '../../client/submission/SubmissionState.ts';
+import { InstanceState } from '../../client/serialization/InstanceState.ts';
 import { AnyViolation, LeafNodeValidationState } from '../../client/validation.ts';
 import { ValueType } from '../../client/ValueType.ts';
 import { XFormsXPathElement } from '../../integration/xpath/adapter/XFormsXPathNode.ts';
+import { StaticLeafElement } from '../../integration/xpath/static-dom/StaticElement.ts';
 import { RuntimeValueSetter, RuntimeValueState, ValueCodec } from '../../lib/codecs/ValueCodec.ts';
 import { CurrentState } from '../../lib/reactivity/node-state/createCurrentState.ts';
 import { EngineState } from '../../lib/reactivity/node-state/createEngineState.ts';
@@ -16,7 +17,7 @@ import { LeafNodeDefinition } from '../../parse/model/LeafNodeDefinition.ts';
 import { GeneralParentNode } from '../hierarchy.ts';
 import { EvaluationContext } from '../internal-api/EvaluationContext.ts';
 import { DecodeInstanceValue, InstanceValueContext } from '../internal-api/InstanceValueContext.ts';
-import { ClientReactiveSubmittableValueNode } from '../internal-api/submission/ClientReactiveSubmittableValueNode.ts';
+import { ClientReactiveSerializableValueNode } from '../internal-api/serialization/ClientReactiveSerializableValueNode.ts';
 import { ValidationContext } from '../internal-api/ValidationContext.ts';
 import { DescendantNodeStateSpec, DescendantNode } from './DescendantNode.ts';
 export type ValueNodeDefinition<V extends ValueType> = LeafNodeDefinition<V>;
@@ -25,7 +26,8 @@ export interface ValueNodeStateSpec<RuntimeValue> extends DescendantNodeStateSpe
     readonly value: SimpleAtomicState<RuntimeValue>;
     readonly instanceValue: Accessor<string>;
 }
-export declare abstract class ValueNode<V extends ValueType, Definition extends ValueNodeDefinition<V>, RuntimeValue extends RuntimeInputValue, RuntimeInputValue = RuntimeValue> extends DescendantNode<Definition, ValueNodeStateSpec<RuntimeValue>, GeneralParentNode, null> implements BaseValueNode<V, RuntimeValue>, XFormsXPathElement, EvaluationContext, InstanceValueContext, ValidationContext, ClientReactiveSubmittableValueNode {
+export declare abstract class ValueNode<V extends ValueType, Definition extends ValueNodeDefinition<V>, RuntimeValue extends RuntimeInputValue, RuntimeInputValue = RuntimeValue> extends DescendantNode<Definition, ValueNodeStateSpec<RuntimeValue>, GeneralParentNode, null> implements BaseValueNode<V, RuntimeValue>, XFormsXPathElement, EvaluationContext, InstanceValueContext, ValidationContext, ClientReactiveSerializableValueNode {
+    readonly instanceNode: StaticLeafElement | null;
     protected readonly validation: SharedValidationState;
     protected readonly getInstanceValue: Accessor<string>;
     protected readonly valueState: RuntimeValueState<RuntimeValue>;
@@ -39,8 +41,8 @@ export declare abstract class ValueNode<V extends ValueType, Definition extends
     readonly valueType: V;
     abstract readonly currentState: CurrentState<ValueNodeStateSpec<RuntimeValue>>;
     get validationState(): LeafNodeValidationState;
-    readonly submissionState: SubmissionState;
-    constructor(parent: GeneralParentNode, definition: Definition, codec: ValueCodec<V, RuntimeValue, RuntimeInputValue>);
+    readonly instanceState: InstanceState;
+    constructor(parent: GeneralParentNode, instanceNode: StaticLeafElement | null, definition: Definition, codec: ValueCodec<V, RuntimeValue, RuntimeInputValue>);
     getViolation(): AnyViolation | null;
     isBlank(): boolean;
     getChildren(): readonly [];