@getodk/xforms-engine 0.4.0 → 0.6.0

package/README.md

@@ -3,7 +3,7 @@
 Implementation of the [ODK XForms specification](https://getodk.github.io/xforms-spec/)'s data model and computation logic. This package does not handle presentation or user interaction. Those aspects of forms are meant to be handled by a client. Presently, those clients are:
 
 - [`@getodk/web-forms`](../web-forms)
-- [`@getodk/ui-solid`](../ui-solid)
+- [`@getodk/scenario`](../scenario)
 
 ## Install
 

package/dist/client/BaseNode.d.ts

@@ -1,7 +1,9 @@
 import { AnyNodeDefinition } from '../parse/model/NodeDefinition.ts';
 import { NodeAppearances } from './NodeAppearances.ts';
 import { TextRange } from './TextRange.ts';
+import { FormNodeID } from './identity.ts';
 import { InstanceNodeType } from './node-types.ts';
+import { SubmissionState } from './submission/SubmissionState.ts';
 import { NodeValidationState } from './validation.ts';
 export interface BaseNodeState {
     /**
@@ -113,7 +115,6 @@ export interface BaseNodeState {
      */
     get value(): unknown;
 }
-type FormNodeID = string;
 /**
  * Base interface for common/shared aspects of any node type.
  */
@@ -132,6 +133,10 @@ export interface BaseNode {
      * @see {@link TokenListParser} for details.
      */
     readonly appearances: NodeAppearances<any> | null;
+    /**
+     * A node can have options that determine its behavior.
+     */
+    readonly nodeOptions: object | null;
     /**
      * Each node has a definition which specifies aspects of the node defined in
      * the form. These aspects include (but are not limited to) the node's data
@@ -153,7 +158,7 @@ export interface BaseNode {
      * Each node links back to its parent, if any. All nodes have a parent except
      * the form's {@link root}.
      */
-    readonly parent: BaseNode | null;
+    readonly parent: unknown;
     /**
      * Each node provides a discrete object representing the stateful aspects\* of
      * that node which will change over time. When a client provides a
@@ -205,5 +210,15 @@ export interface BaseNode {
      * clients to explicitly pause and resume recomputation.
      */
     readonly validationState: NodeValidationState;
+    /**
+     * Represents the current submission state of the node.
+     *
+     * @see {@link SubmissionState.submissionXML} for additional detail.
+     *
+     * @todo Consider whether this can (should) be merged with
+     * {@link currentState}, while providing the same client-reactivity
+     * guarantees. (The challenge there is in defining client-reactive state which
+     * self-referentially derives state from its own definition.)
+     */
+    readonly submissionState: SubmissionState;
 }
-export {};

package/dist/client/BaseValueNode.d.ts

@@ -0,0 +1,32 @@
+import { LeafNodeDefinition } from '../parse/model/LeafNodeDefinition.ts';
+import { BaseNode, BaseNodeState } from './BaseNode.ts';
+import { GeneralParentNode } from './hierarchy.ts';
+import { LeafNodeType } from './node-types.ts';
+import { LeafNodeValidationState } from './validation.ts';
+import { ValueType } from './ValueType.ts';
+export interface BaseValueNodeState<Value> extends BaseNodeState {
+    get children(): null;
+    get valueOptions(): unknown;
+    get value(): Value;
+    /**
+     * Reflects the serialized string representation of a {@link BaseValueNode}'s
+     * {@link value} state. This representation allows access to the node's value
+     * _as primary instance state_. In other words, this is the value which:
+     *
+     * - would be serialized as a text node in
+     *   {@link SubmissionState.submissionXML} (note: this value is **NOT**
+     *   escaped for XML serialization, as it is there)
+     *
+     * - is used when the node's value is referenced in any of a form's XPath
+     *   expressions
+     */
+    get instanceValue(): string;
+}
+export interface BaseValueNode<V extends ValueType = ValueType, Value = string> extends BaseNode {
+    readonly nodeType: LeafNodeType;
+    readonly valueType: V;
+    readonly definition: LeafNodeDefinition;
+    readonly parent: GeneralParentNode;
+    readonly currentState: BaseValueNodeState<Value>;
+    readonly validationState: LeafNodeValidationState;
+}

package/dist/client/EngineConfig.d.ts

@@ -1,32 +1,6 @@
+import { MissingResourceBehavior } from './constants.ts';
 import { OpaqueReactiveObjectFactory } from './OpaqueReactiveObjectFactory.ts';
-/**
- * @todo this is currently a strict subset of the web standard `Response`. Is it
- * sufficient? Ways it might not be:
- *
- * - No way to convey metadata about the resource
- * - Ambiguous if a client supplies an alternative implementation which doesn't
- *   exhaust the body on access
- */
-export interface FetchResourceResponse {
-    readonly ok?: boolean;
-    readonly body?: ReadableStream<Uint8Array> | null;
-    readonly bodyUsed?: boolean;
-    readonly blob: () => Promise<Blob>;
-    readonly text: () => Promise<string>;
-}
-/**
- * @todo this is a strict subset of the web standard `fetch` interface. It
- * implicitly assumes that the engine itself will only ever issue `GET`-like
- * requests. It also provides no further request-like semantics to the engine.
- * This is presumed sufficient for now, but notably doesn't expose any notion of
- * content negotiation (e.g. the ability to supply `Accept` headers).
- *
- * This also completely ignores any notion of mapping
- * {@link https://getodk.github.io/xforms-spec/#uris | `jr:` URLs} to their
- * actual resources (likely, but not necessarily, accessed at a corresponding
- * HTTP URL).
- */
-export type FetchResource = (resource: URL) => Promise<FetchResourceResponse>;
+import { FetchFormAttachment, FetchResource } from './resources.ts';
 /**
  * Options provided by a client to specify certain aspects of engine runtime
  * behavior. These options will generally be intended to facilitate cooperation
@@ -50,29 +24,56 @@ export interface EngineConfig {
      */
     readonly stateFactory?: OpaqueReactiveObjectFactory;
     /**
-     * A client may specify a generic function for retrieving resources referenced
-     * by a form, such as:
      *
-     * - Form definitions themselves (if not provided directly to the engine by
-     *   the client)
-     * - External secondary instances
-     * - Media (images, audio, video, etc.)
+     * A client may specify an arbitrary {@link fetch}-like function for retrieving an XML XForm form
+     * definition.
+     *
+     * Notes:
      *
-     * The function is expected to be a subset of the
-     * {@link https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API | Fetch API},
-     * performing `GET` requests for:
+     * - This configuration will only be consuled for calls to
+     *   {@link initializeForm} with a URL referencing an XML XForm definition. It
+     *   will be ignored for calls passing an XML XForm form definition directly.
      *
-     * - Text resources (e.g. XML, CSV, JSON/GeoJSON)
-     * - Binary resources (e.g. media)
-     * - Optionally streamed binary data of either (e.g. for optimized
-     *   presentation of audio/video)
+     * - For calls to {@link initializeForm} with a URL, if this configuration is
+     *   not specified it will default to the global {@link fetch} function (if
+     *   one is defined).
+     */
+    readonly fetchFormDefinition?: FetchResource;
+    /**
+     * A client may specify an arbitrary {@link fetch}-like function to retrieve a
+     * form's attachments, i.e. any `jr:` URL referenced by the form (as specified
+     * by {@link https://getodk.github.io/xforms-spec/ | ODK XForms}).
+     *
+     * Notes:
+     *
+     * - This configuration will be consulted for all supported form attachments,
+     *   as a part of {@link initializeForm | form initialization}.
+     *
+     * - If this configuration is not specified it will default to the global
+     *   {@link fetch} function (if one is defined).
+     *
+     * This default behavior will typically result in failure to load form
+     * attachments—and in most cases this will also cause
+     * {@link initializeForm | form initialization} to fail overall—with the
+     * following exceptions:
+     *
+     * - **CLIENT-SPECIFIC:** Usage in coordination with a client-implemented
+     *   {@link https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API | Serivce Worker},
+     *   which can intercept network requests **generally**. Clients already using
+     *   a Service Worker may opt for the convenience of handling network requests
+     *   for `jr:` URLs along with any other network interception logic. Client
+     *   implementors should be warned, however, that such `jr:` URLs are not
+     *   namespaced or otherwise scoped to a particular form; such a client would
+     *   therefore inherently need to coordinate state between the Service Worker
+     *   and the main thread (or whatever other realm calls
+     *   {@link initializeForm}).
+     */
+    readonly fetchFormAttachment?: FetchFormAttachment;
+    /**
+     * @see {@link MissingResourceBehavior}
+     * @see {@link MissingResourceBehaviorDefault}
      *
-     * If provided by a client, this function will be used by the engine to
-     * retrieve any such resource, as required for engine functionality. If
-     * absent, the engine will use the native `fetch` function (if available, a
-     * polyfill otherwise). Clients may use this function to provide resources
-     * from sources other than the network, (or even in a test client to provide
-     * e.g. resources from test fixtures).
+     * @default MissingResourceBehaviorDefault
      */
-    readonly fetchResource?: FetchResource;
+    readonly missingResourceBehavior?: MissingResourceBehavior;
 }

package/dist/client/GroupNode.d.ts

@@ -21,6 +21,7 @@ export type GroupNodeAppearances = NodeAppearances<GroupDefinition>;
 export interface GroupNode extends BaseNode {
     readonly nodeType: 'group';
     readonly appearances: GroupNodeAppearances;
+    readonly nodeOptions: null;
     readonly definition: GroupDefinition;
     readonly root: RootNode;
     readonly parent: GeneralParentNode;

package/dist/client/InputNode.d.ts

@@ -0,0 +1,82 @@
+import { RuntimeInputValue, RuntimeValue } from '../lib/codecs/getSharedValueCodec.ts';
+import { InputControlDefinition } from '../parse/body/control/InputControlDefinition.ts';
+import { LeafNodeDefinition } from '../parse/model/LeafNodeDefinition.ts';
+import { BaseValueNode, BaseValueNodeState } from './BaseValueNode.ts';
+import { NodeAppearances } from './NodeAppearances.ts';
+import { RootNode } from './RootNode.ts';
+import { ValueType } from './ValueType.ts';
+import { GeneralParentNode } from './hierarchy.ts';
+import { LeafNodeValidationState } from './validation.ts';
+export type InputValue<V extends ValueType> = RuntimeValue<V>;
+export type InputNodeInputValue<V extends ValueType> = RuntimeInputValue<V>;
+export interface InputNodeState<V extends ValueType> extends BaseValueNodeState<InputValue<V>> {
+    get children(): null;
+    get valueOptions(): null;
+    /**
+     * Reflects the current value of a {@link InputNode}. This value may be
+     * populated when a form is loaded, and it may be updated by certain
+     * computations defined by the form. It may also be updated by a client, using
+     * the {@link InputNode.setValue} method.
+     */
+    get value(): InputValue<V>;
+}
+export interface InputDefinition<V extends ValueType = ValueType> extends LeafNodeDefinition<V> {
+    readonly bodyElement: InputControlDefinition;
+}
+export type InputNodeAppearances = NodeAppearances<InputDefinition>;
+interface StringInputNodeOptions {
+    readonly rows: number | null;
+}
+interface GeoInputNodeOptions {
+    readonly accuracyThreshold: number | null;
+    readonly unacceptableAccuracyThreshold: number | null;
+}
+interface InputNodeOptionsByValueType {
+    readonly string: StringInputNodeOptions;
+    readonly int: null;
+    readonly boolean: null;
+    readonly decimal: null;
+    readonly date: null;
+    readonly time: null;
+    readonly dateTime: null;
+    readonly geopoint: GeoInputNodeOptions;
+    readonly geotrace: GeoInputNodeOptions;
+    readonly geoshape: GeoInputNodeOptions;
+    readonly binary: null;
+    readonly barcode: null;
+    readonly intent: null;
+}
+export type InputNodeOptions<V extends ValueType> = InputNodeOptionsByValueType[V];
+/**
+ * A node corresponding to form field defined as an
+ * {@link https://getodk.github.io/xforms-spec/#body-elements | XForms `<input>`},
+ * which a user-facing client would likely present for a user to fill.
+ */
+export interface InputNode<V extends ValueType = ValueType> extends BaseValueNode<V, InputValue<V>> {
+    readonly nodeType: 'input';
+    readonly valueType: V;
+    readonly appearances: InputNodeAppearances;
+    readonly nodeOptions: InputNodeOptions<V>;
+    readonly definition: InputDefinition<V>;
+    readonly root: RootNode;
+    readonly parent: GeneralParentNode;
+    readonly currentState: InputNodeState<V>;
+    readonly validationState: LeafNodeValidationState;
+    /**
+     * For use by a client to update the value of an {@link InputNode}.
+     */
+    setValue(value: InputNodeInputValue<V>): RootNode;
+}
+export type StringInputValue = InputValue<'string'>;
+export type IntInputValue = InputValue<'int'>;
+export type DecimalInputValue = InputValue<'decimal'>;
+export type GeopointInputValue = InputValue<'geopoint'>;
+export type StringInputNode = InputNode<'string'>;
+export type IntInputNode = InputNode<'int'>;
+export type DecimalInputNode = InputNode<'decimal'>;
+export type GeopointInputNode = InputNode<'geopoint'>;
+type SupportedInputValueType = 'string' | 'int' | 'decimal' | 'geopoint';
+type TemporaryStringValueType = Exclude<ValueType, SupportedInputValueType>;
+export type TemporaryStringValueInputNode = InputNode<TemporaryStringValueType>;
+export type AnyInputNode = StringInputNode | IntInputNode | DecimalInputNode | GeopointInputNode | TemporaryStringValueInputNode;
+export {};

package/dist/client/ModelValueNode.d.ts

@@ -1,9 +1,12 @@
+import { RuntimeValue } from '../lib/codecs/getSharedValueCodec.ts';
 import { LeafNodeDefinition } from '../parse/model/LeafNodeDefinition.ts';
-import { BaseNode, BaseNodeState } from './BaseNode.ts';
+import { BaseValueNode, BaseValueNodeState } from './BaseValueNode.ts';
 import { GeneralParentNode } from './hierarchy.ts';
 import { RootNode } from './RootNode.ts';
 import { LeafNodeValidationState } from './validation.ts';
-export interface ModelValueNodeState extends BaseNodeState {
+import { ValueType } from './ValueType.ts';
+export type ModelValue<V extends ValueType> = RuntimeValue<V>;
+export interface ModelValueNodeState<V extends ValueType> extends BaseValueNodeState<ModelValue<V>> {
     get label(): null;
     get hint(): null;
     get children(): null;
@@ -13,9 +16,9 @@ export interface ModelValueNodeState extends BaseNodeState {
      * populated when a form is loaded, and it may be updated by certain
      * computations defined by the form.
      */
-    get value(): string;
+    get value(): ModelValue<V>;
 }
-export interface ModelValueDefinition extends LeafNodeDefinition {
+export interface ModelValueDefinition<V extends ValueType = ValueType> extends LeafNodeDefinition<V> {
     readonly bodyElement: null;
 }
 /**
@@ -25,12 +28,15 @@ export interface ModelValueDefinition extends LeafNodeDefinition {
  * - a leaf/value node (i.e. it has no element children; it may be defined in
  *   the form's `<model>` as either an {@link Element} or {@link Attr})
  */
-export interface ModelValueNode extends BaseNode {
+export interface ModelValueNode<V extends ValueType = ValueType> extends BaseValueNode<V, ModelValue<V>> {
     readonly nodeType: 'model-value';
+    readonly valueType: V;
     readonly appearances: null;
-    readonly definition: ModelValueDefinition;
+    readonly nodeOptions: null;
+    readonly definition: ModelValueDefinition<V>;
     readonly root: RootNode;
     readonly parent: GeneralParentNode;
-    readonly currentState: ModelValueNodeState;
+    readonly currentState: ModelValueNodeState<V>;
     readonly validationState: LeafNodeValidationState;
 }
+export type AnyModelValueNode = ModelValueNode<'barcode'> | ModelValueNode<'binary'> | ModelValueNode<'boolean'> | ModelValueNode<'date'> | ModelValueNode<'dateTime'> | ModelValueNode<'decimal'> | ModelValueNode<'geopoint'> | ModelValueNode<'geoshape'> | ModelValueNode<'geotrace'> | ModelValueNode<'int'> | ModelValueNode<'intent'> | ModelValueNode<'string'> | ModelValueNode<'time'>;

package/dist/client/NoteNode.d.ts

@@ -1,12 +1,15 @@
-import { InputDefinition } from '../parse/body/control/InputDefinition.ts';
+import { NoteRuntimeValue } from '../lib/codecs/NoteCodec.ts';
+import { InputControlDefinition } from '../parse/body/control/InputControlDefinition.ts';
 import { LeafNodeDefinition } from '../parse/model/LeafNodeDefinition.ts';
-import { BaseNode, BaseNodeState } from './BaseNode.ts';
+import { BaseValueNode, BaseValueNodeState } from './BaseValueNode.ts';
 import { GeneralParentNode } from './hierarchy.ts';
 import { NodeAppearances } from './NodeAppearances.ts';
 import { RootNode } from './RootNode.ts';
 import { TextRange } from './TextRange.ts';
 import { LeafNodeValidationState } from './validation.ts';
-export interface NoteNodeState extends BaseNodeState {
+import { ValueType } from './ValueType.ts';
+export type NoteValue<V extends ValueType> = NoteRuntimeValue<V>;
+export interface NoteNodeState<V extends ValueType> extends BaseValueNodeState<NoteValue<V>> {
     /**
      * Note-specific specialization: a note will always have a non-null value in
      * at least one of:
@@ -29,10 +32,10 @@ export interface NoteNodeState extends BaseNodeState {
     /**
      * Reflects the readonly value of a {@link NoteNode}, or `null` if blank.
      */
-    get value(): string | null;
+    get value(): NoteValue<V>;
 }
-export interface NoteDefinition extends LeafNodeDefinition {
-    readonly bodyElement: InputDefinition;
+export interface NoteDefinition<V extends ValueType = ValueType> extends LeafNodeDefinition<V> {
+    readonly bodyElement: InputControlDefinition;
 }
 export type NoteNodeAppearances = NodeAppearances<NoteDefinition>;
 /**
@@ -41,12 +44,26 @@ export type NoteNodeAppearances = NodeAppearances<NoteDefinition>;
  * - associated with an input, with at least one text element (label or hint)
  * - guaranteed to be {@link NoteNodeState.readonly | readonly}
  */
-export interface NoteNode extends BaseNode {
+export interface NoteNode<V extends ValueType = ValueType> extends BaseValueNode<V, NoteValue<V>> {
     readonly nodeType: 'note';
     readonly appearances: NoteNodeAppearances;
-    readonly definition: NoteDefinition;
+    readonly nodeOptions: null;
+    readonly definition: NoteDefinition<V>;
     readonly root: RootNode;
     readonly parent: GeneralParentNode;
-    readonly currentState: NoteNodeState;
+    readonly currentState: NoteNodeState<V>;
     readonly validationState: LeafNodeValidationState;
 }
+export type StringNoteValue = NoteValue<'string'>;
+export type IntNoteValue = NoteValue<'int'>;
+export type DecimalNoteValue = NoteValue<'decimal'>;
+export type GeopointNoteValue = NoteValue<'geopoint'>;
+export type StringNoteNode = NoteNode<'string'>;
+export type IntNoteNode = NoteNode<'int'>;
+export type DecimalNoteNode = NoteNode<'decimal'>;
+export type GeopointNoteNode = NoteNode<'geopoint'>;
+type SupportedNoteValueType = 'string' | 'int' | 'decimal' | 'geopoint';
+type TemporaryStringValueType = Exclude<ValueType, SupportedNoteValueType>;
+export type TemporaryStringValueNoteNode = NoteNode<TemporaryStringValueType>;
+export type AnyNoteNode = StringNoteNode | IntNoteNode | DecimalNoteNode | GeopointNoteNode | TemporaryStringValueNoteNode;
+export {};

package/dist/client/RangeNode.d.ts

@@ -0,0 +1,36 @@
+import { RuntimeInputValue, RuntimeValue } from '../lib/codecs/getSharedValueCodec.ts';
+import { RangeNodeDefinition, RangeValueType } from '../parse/model/RangeNodeDefinition.ts';
+import { BaseValueNode, BaseValueNodeState } from './BaseValueNode.ts';
+import { NodeAppearances } from './NodeAppearances.ts';
+import { RootNode } from './RootNode.ts';
+import { GeneralParentNode } from './hierarchy.ts';
+import { LeafNodeValidationState } from './validation.ts';
+export type { RangeValueType };
+export type RangeValue<V extends RangeValueType> = RuntimeValue<V>;
+export type RangeInputValue<V extends RangeValueType> = RuntimeInputValue<V>;
+export interface RangeNodeState<V extends RangeValueType> extends BaseValueNodeState<RangeValue<V>> {
+    get valueOptions(): null;
+}
+export type RangeNodeAppearances = NodeAppearances<RangeNodeDefinition>;
+/**
+ * A node corresponding to form field defined as an
+ * {@link https://getodk.github.io/xforms-spec/#body-elements | XForms `<range>`}.
+ */
+export interface RangeNode<V extends RangeValueType = RangeValueType> extends BaseValueNode<V, RangeValue<V>> {
+    readonly nodeType: 'range';
+    readonly valueType: V;
+    readonly appearances: RangeNodeAppearances;
+    readonly nodeOptions: null;
+    readonly definition: RangeNodeDefinition<V>;
+    readonly root: RootNode;
+    readonly parent: GeneralParentNode;
+    readonly currentState: RangeNodeState<V>;
+    readonly validationState: LeafNodeValidationState;
+    /**
+     * For use by a client to update the value of an {@link RangeNode}.
+     */
+    setValue(value: RangeInputValue<V>): RootNode;
+}
+export type IntRangeNode = RangeNode<'int'>;
+export type DecimalRangeNode = RangeNode<'decimal'>;
+export type AnyRangeNode = IntRangeNode | DecimalRangeNode;

package/dist/client/RankNode.d.ts

@@ -0,0 +1,46 @@
+import { RankControlDefinition } from '../parse/body/control/RankControlDefinition.ts';
+import { LeafNodeDefinition } from '../parse/model/LeafNodeDefinition.ts';
+import { BaseValueNode, BaseValueNodeState } from './BaseValueNode.ts';
+import { RootNode } from './RootNode.ts';
+import { TextRange } from './TextRange.ts';
+import { GeneralParentNode } from './hierarchy.ts';
+import { LeafNodeValidationState } from './validation.ts';
+import { UnknownAppearanceDefinition } from '../parse/body/appearance/unknownAppearanceParser.ts';
+import { ValueType } from './ValueType.ts';
+export interface RankItem {
+    get label(): TextRange<'item-label'>;
+    get value(): string;
+}
+export type RankValueOptions = readonly RankItem[];
+export interface RankNodeState extends BaseValueNodeState<readonly string[]> {
+    get valueOptions(): RankValueOptions;
+    /**
+     * An ordered collection of values from {@link RankItem}.
+     * The order of the items is important and must be preserved during processing.
+     */
+    get value(): readonly string[];
+}
+export interface RankDefinition<V extends ValueType = ValueType> extends LeafNodeDefinition<V> {
+    readonly bodyElement: RankControlDefinition;
+}
+export interface RankNode extends BaseValueNode<'string', readonly string[]> {
+    readonly nodeType: 'rank';
+    readonly appearances: UnknownAppearanceDefinition;
+    readonly nodeOptions: null;
+    readonly valueType: 'string';
+    readonly definition: RankDefinition<'string'>;
+    readonly root: RootNode;
+    readonly parent: GeneralParentNode;
+    readonly currentState: RankNodeState;
+    readonly validationState: LeafNodeValidationState;
+    /**
+     * Convenience API to get the {@link RankItem}'s label.
+     */
+    getValueLabel(value: string): TextRange<'item-label'> | null;
+    /**
+     * Set the value which is an ordered collection of values from {@link RankItem}.
+     * Calling this setter replaces the currently value.
+     * If called with an empty array, the current is cleared.
+     */
+    setValues(values: readonly string[]): RootNode;
+}

package/dist/client/RootNode.d.ts

@@ -3,13 +3,13 @@ import { RootDefinition } from '../parse/model/RootDefinition.ts';
 import { BaseNode, BaseNodeState } from './BaseNode.ts';
 import { ActiveLanguage, FormLanguage, FormLanguages } from './FormLanguage.ts';
 import { GeneralChildNode } from './hierarchy.ts';
+import { SubmissionOptions } from './submission/SubmissionOptions.ts';
+import { ChunkedSubmissionResult, MonolithicSubmissionResult } from './submission/SubmissionResult.ts';
 import { AncestorNodeValidationState } from './validation.ts';
 export interface RootNodeState extends BaseNodeState {
     /**
-     * This, along with {@link RootNode.languages} is the most significant break
-       in consistency across node types' state and static properties. Exposing it
-       across all node types seems like a point of potential confusion, so this
-       particular divergence seems like the most reasonable compromise.
+     * @todo If we ever expose an interface to the primary instance document, it
+     * would make sense to move this state up.
      */
     get activeLanguage(): ActiveLanguage;
     get label(): null;
@@ -24,6 +24,7 @@ export interface RootNode extends BaseNode {
      * @todo this along with {@link classes} is... awkward.
      */
     readonly appearances: null;
+    readonly nodeOptions: null;
     /**
      * @todo This is another odd deviation in {@link RootNode}. Unlike
      * {@link languages}, it doesn't feel particularly **essential**. While it
@@ -40,13 +41,42 @@ export interface RootNode extends BaseNode {
     readonly classes: BodyClassList;
     readonly definition: RootDefinition;
     readonly root: RootNode;
-    readonly parent: null;
+    readonly parent: unknown;
     readonly currentState: RootNodeState;
     readonly validationState: AncestorNodeValidationState;
     /**
-     * @todo as with {@link RootNodeState.activeLanguage}, this is the most
-     * significant break in consistency across node types.
+     * @todo as discussed on {@link RootNodeState.activeLanguage}
      */
     readonly languages: FormLanguages;
     setLanguage(language: FormLanguage): RootNode;
+    /**
+     * Prepares the current form instance state for submission.
+     *
+     * A {@link SubmissionResult} will be prepared even if the current form state
+     * includes `constraint` or `required` violations. This is intended to serve
+     * two purposes:
+     *
+     * - A client may effectively use this method as a part of its own "submit"
+     *   routine, and use any violations included in the {@link SubmissionResult}
+     *   to prompt users to address those violations.
+     *
+     * - A client may inspect the submission state of a form at any time.
+     *   Depending on the client and use case, this may be a convenience (e.g. for
+     *   developers to inspect that form state at a current point in time); or it
+     *   may provide necessary functionality (e.g. for test or tooling clients).
+     *
+     * Note on asynchrony: preparing a {@link SubmissionResult} is expected to be
+     * a fast operation. It may even be nearly instantaneous, or roughly
+     * proportionate to the size of the form itself. However, this method is
+     * designed to be asynchronous out of an abundance of caution, anticipating
+     * that some as-yet undeveloped operations on binary data (e.g. form
+     * attachments) may themselves impose asynchrony (i.e. by interfaces provided
+     * by the platform and/or external dependencies).
+     *
+     * A client may specify {@link SubmissionOptions<'chunked'>}, in which case a
+     * {@link SubmissionResult<'chunked'>} will be produced, with form attachments
+     */
+    prepareSubmission(): Promise<MonolithicSubmissionResult>;
+    prepareSubmission(options: SubmissionOptions<'monolithic'>): Promise<MonolithicSubmissionResult>;
+    prepareSubmission(options: SubmissionOptions<'chunked'>): Promise<ChunkedSubmissionResult>;
 }