@getodk/xforms-engine 0.4.0 → 0.5.0

package/dist/integration/xpath/static-dom/StaticNode.d.ts

@@ -0,0 +1,33 @@
+import { XPathNodeKindKey } from '@getodk/xpath';
+import { XFormsXPathNode } from '../adapter/XFormsXPathNode.ts';
+import { StaticAttribute } from './StaticAttribute.ts';
+import { StaticDocument } from './StaticDocument.ts';
+import { StaticElement } from './StaticElement.ts';
+import { StaticText } from './StaticText.ts';
+export type StaticNodeKind = 'document' | 'element' | 'attribute' | 'text';
+export type StaticNodeType<Kind extends StaticNodeKind> = `static-${Kind}`;
+export declare abstract class StaticNode<Kind extends StaticNodeKind> implements XFormsXPathNode {
+    abstract readonly [XPathNodeKindKey]: Kind;
+    abstract readonly nodeType: StaticNodeType<Kind>;
+    /**
+     * A concrete {@link StaticDocument} instance, representing the topmost node
+     * of a static document tree, containing all of:
+     *
+     * - {@link root}
+     * - {@link children}
+     * - any {@link StaticChildNode} descendants of either of the above
+     */
+    abstract readonly rootDocument: StaticDocument;
+    /**
+     * A concrete {@link StaticElement} instance, representing the single,
+     * immediate child of {@link rootDocument}, containing all other descendants
+     * of its document tree.
+     */
+    abstract readonly root: StaticElement;
+    abstract readonly children: readonly StaticChildNode[] | null;
+    getXPathChildNodes(): readonly StaticChildNode[];
+    abstract getXPathValue(): string;
+}
+export type AnyStaticNode = StaticDocument | StaticElement | StaticAttribute | StaticText;
+export type StaticParentNode = StaticDocument | StaticElement;
+export type StaticChildNode = StaticElement | StaticText;

package/dist/integration/xpath/static-dom/StaticText.d.ts

@@ -0,0 +1,16 @@
+import { XPathNodeKindKey } from '@getodk/xpath';
+import { XFormsXPathText } from '../adapter/XFormsXPathNode.ts';
+import { StaticDocument } from './StaticDocument.ts';
+import { StaticElement } from './StaticElement.ts';
+import { StaticNode } from './StaticNode.ts';
+export declare class StaticText extends StaticNode<'text'> implements XFormsXPathText {
+    readonly parent: StaticElement;
+    readonly value: string;
+    readonly [XPathNodeKindKey] = "text";
+    readonly nodeType = "static-text";
+    readonly rootDocument: StaticDocument;
+    readonly root: StaticElement;
+    readonly children: null;
+    constructor(parent: StaticElement, value: string);
+    getXPathValue(): string;
+}

package/dist/lib/client-reactivity/submission/createInstanceSubmissionState.d.ts

@@ -0,0 +1,3 @@
+import { SubmissionState } from '../../../client/submission/SubmissionState.ts';
+import { ClientReactiveSubmittableInstance } from '../../../instance/internal-api/submission/ClientReactiveSubmittableInstance.ts';
+export declare const createInstanceSubmissionState: (node: ClientReactiveSubmittableInstance) => SubmissionState;

package/dist/lib/client-reactivity/submission/createLeafNodeSubmissionState.d.ts

@@ -0,0 +1,3 @@
+import { SubmissionState } from '../../../client/submission/SubmissionState.ts';
+import { ClientReactiveSubmittableLeafNode } from '../../../instance/internal-api/submission/ClientReactiveSubmittableLeafNode.ts';
+export declare const createLeafNodeSubmissionState: <Value>(node: ClientReactiveSubmittableLeafNode<Value>) => SubmissionState;

package/dist/lib/client-reactivity/submission/createNodeRangeSubmissionState.d.ts

@@ -0,0 +1,4 @@
+import { SubmissionState } from '../../../client/submission/SubmissionState.ts';
+import { ClientReactiveSubmittableParentNode } from '../../../instance/internal-api/submission/ClientReactiveSubmittableParentNode.ts';
+import { RepeatInstance } from '../../../instance/repeat/RepeatInstance.ts';
+export declare const createNodeRangeSubmissionState: (node: ClientReactiveSubmittableParentNode<RepeatInstance>) => SubmissionState;

package/dist/lib/client-reactivity/submission/createParentNodeSubmissionState.d.ts

@@ -0,0 +1,4 @@
+import { SubmissionState } from '../../../client/submission/SubmissionState.ts';
+import { GeneralChildNode } from '../../../instance/hierarchy.ts';
+import { ClientReactiveSubmittableParentNode } from '../../../instance/internal-api/submission/ClientReactiveSubmittableParentNode.ts';
+export declare const createParentNodeSubmissionState: (node: ClientReactiveSubmittableParentNode<GeneralChildNode>) => SubmissionState;

package/dist/lib/client-reactivity/submission/createValueNodeSubmissionState.d.ts

@@ -0,0 +1,3 @@
+import { SubmissionState } from '../../../client/submission/SubmissionState.ts';
+import { ClientReactiveSubmittableValueNode } from '../../../instance/internal-api/submission/ClientReactiveSubmittableValueNode.ts';
+export declare const createValueNodeSubmissionState: (node: ClientReactiveSubmittableValueNode) => SubmissionState;

package/dist/lib/client-reactivity/submission/prepareSubmission.d.ts

@@ -0,0 +1,8 @@
+import { SubmissionChunkedType } from '../../../client/submission/SubmissionOptions.ts';
+import { SubmissionResult } from '../../../client/submission/SubmissionResult.ts';
+import { ClientReactiveSubmittableInstance } from '../../../instance/internal-api/submission/ClientReactiveSubmittableInstance.ts';
+export interface PrepeareSubmissionOptions<ChunkedType extends SubmissionChunkedType> {
+    readonly chunked: ChunkedType;
+    readonly maxSize: number;
+}
+export declare const prepareSubmission: <ChunkedType extends SubmissionChunkedType>(instanceRoot: ClientReactiveSubmittableInstance, options: PrepeareSubmissionOptions<ChunkedType>) => SubmissionResult<ChunkedType>;

package/dist/lib/codecs/DecimalValueCodec.d.ts

@@ -0,0 +1,6 @@
+import { ValueCodec } from './ValueCodec.ts';
+export type DecimalInputValue = bigint | number | string | null;
+export type DecimalRuntimeValue = number | null;
+export declare class DecimalValueCodec extends ValueCodec<'decimal', DecimalRuntimeValue, DecimalInputValue> {
+    constructor();
+}

package/dist/lib/codecs/IntValueCodec.d.ts

@@ -0,0 +1,6 @@
+import { ValueCodec } from './ValueCodec.ts';
+export type IntInputValue = bigint | number | string | null;
+export type IntRuntimeValue = bigint | null;
+export declare class IntValueCodec extends ValueCodec<'int', IntRuntimeValue, IntInputValue> {
+    constructor();
+}

package/dist/lib/codecs/StringValueCodec.d.ts

@@ -0,0 +1,4 @@
+import { ValueCodec } from './ValueCodec.ts';
+export declare class StringValueCodec extends ValueCodec<'string', string, string> {
+    constructor();
+}

package/dist/lib/codecs/ValueCodec.d.ts

@@ -0,0 +1,30 @@
+import { Accessor } from 'solid-js';
+import { ValueType } from '../../client/ValueType.ts';
+import { DecodeInstanceValue } from '../../instance/internal-api/InstanceValueContext.ts';
+import { SimpleAtomicState } from '../reactivity/types.ts';
+type CodecEncoder<RuntimeInputValue> = (input: RuntimeInputValue) => string;
+type CodecDecoder<RuntimeValue> = (value: string) => RuntimeValue;
+type RuntimeValueAccessor<RuntimeValue> = Accessor<RuntimeValue>;
+export type RuntimeValueSetter<RuntimeValue extends RuntimeInputValue, RuntimeInputValue = RuntimeValue> = (input: RuntimeInputValue) => RuntimeValue;
+export type RuntimeValueState<RuntimeValue extends RuntimeInputValue, RuntimeInputValue = RuntimeValue> = readonly [
+    get: RuntimeValueAccessor<RuntimeValue>,
+    set: RuntimeValueSetter<RuntimeValue, RuntimeInputValue>
+];
+export type CreateRuntimeValueState<RuntimeValue extends RuntimeInputValue, RuntimeInputValue = RuntimeValue> = (instanceState: SimpleAtomicState<string>) => RuntimeValueState<RuntimeValue, RuntimeInputValue>;
+type RuntimeValueStateFactory<RuntimeValue extends RuntimeInputValue, RuntimeInputValue = RuntimeValue> = (encodeValue: CodecEncoder<RuntimeInputValue>, decodeValue: CodecDecoder<RuntimeValue>) => CreateRuntimeValueState<RuntimeValue, RuntimeInputValue>;
+type DecodeInstanceValueFactory<RuntimeValue extends RuntimeInputValue, RuntimeInputValue = RuntimeValue> = (encodeValue: CodecEncoder<RuntimeInputValue>, decodeValue: CodecDecoder<RuntimeValue>) => DecodeInstanceValue;
+interface ValueCodecOptions<RuntimeValue extends RuntimeInputValue, RuntimeInputValue> {
+    readonly decodeInstanceValueFactory?: DecodeInstanceValueFactory<RuntimeValue, RuntimeInputValue>;
+    readonly runtimeValueStateFactory?: RuntimeValueStateFactory<RuntimeValue, RuntimeInputValue>;
+}
+export declare abstract class ValueCodec<V extends ValueType, RuntimeValue extends RuntimeInputValue, RuntimeInputValue = RuntimeValue> {
+    readonly valueType: V;
+    readonly encodeValue: CodecEncoder<RuntimeInputValue>;
+    readonly decodeValue: CodecDecoder<RuntimeValue>;
+    protected readonly defaultRuntimeValueStateFactory: RuntimeValueStateFactory<RuntimeValue, RuntimeInputValue>;
+    protected readonly defaultDecodeInstanceValueFactory: DecodeInstanceValueFactory<RuntimeValue, RuntimeInputValue>;
+    readonly decodeInstanceValue: DecodeInstanceValue;
+    readonly createRuntimeValueState: CreateRuntimeValueState<RuntimeValue, RuntimeInputValue>;
+    constructor(valueType: V, encodeValue: CodecEncoder<RuntimeInputValue>, decodeValue: CodecDecoder<RuntimeValue>, options?: ValueCodecOptions<RuntimeValue, RuntimeInputValue>);
+}
+export {};

package/dist/lib/codecs/ValueTypePlaceholderCodec.d.ts

@@ -0,0 +1,12 @@
+import { ValueType } from '../../client/ValueType.ts';
+import { ValueCodec } from './ValueCodec.ts';
+/**
+ * Provides fallback functionality where a {@link ValueCodec} is expected, for
+ * those {@link ValueType | value types} which are still pending implementation.
+ * This allows consistent use of the {@link ValueCodec} interface while
+ * maintaining the current behavior of treating those unimplemented value types
+ * as string values.
+ */
+export declare class ValueTypePlaceholderCodec<V extends ValueType> extends ValueCodec<V, string, string> {
+    constructor(valueType: V);
+}

package/dist/lib/codecs/getSharedValueCodec.d.ts

@@ -0,0 +1,47 @@
+import { ValueType } from '../../client/ValueType.ts';
+import { DecimalInputValue, DecimalRuntimeValue } from './DecimalValueCodec.ts';
+import { IntInputValue, IntRuntimeValue } from './IntValueCodec.ts';
+import { ValueCodec } from './ValueCodec.ts';
+interface RuntimeValuesByType {
+    readonly string: string;
+    readonly int: IntRuntimeValue;
+    readonly decimal: DecimalRuntimeValue;
+    readonly boolean: string;
+    readonly date: string;
+    readonly time: string;
+    readonly dateTime: string;
+    readonly geopoint: string;
+    readonly geotrace: string;
+    readonly geoshape: string;
+    readonly binary: string;
+    readonly barcode: string;
+    readonly intent: string;
+}
+export type RuntimeValue<V extends ValueType> = RuntimeValuesByType[V];
+interface RuntimeInputValuesByType {
+    readonly string: string;
+    readonly int: IntInputValue;
+    readonly decimal: DecimalInputValue;
+    readonly boolean: string;
+    readonly date: string;
+    readonly time: string;
+    readonly dateTime: string;
+    readonly geopoint: string;
+    readonly geotrace: string;
+    readonly geoshape: string;
+    readonly binary: string;
+    readonly barcode: string;
+    readonly intent: string;
+}
+export type RuntimeInputValue<V extends ValueType> = RuntimeInputValuesByType[V];
+type SharedValueCodecs = {
+    readonly [V in ValueType]: ValueCodec<V, RuntimeValue<V>, RuntimeInputValue<V>>;
+};
+export type SharedValueCodec<V extends ValueType> = SharedValueCodecs[V];
+/**
+ * Provides codecs for each {@link ValueType | value type}, for nodes with a
+ * common representation of those value types.
+ */
+export declare const sharedValueCodecs: SharedValueCodecs;
+export declare const getSharedValueCodec: <V extends ValueType>(valueType: V) => SharedValueCodec<V>;
+export {};

package/dist/lib/dom/query.d.ts

@@ -23,3 +23,6 @@ export declare const getLabelElement: (parent: Element) => LabelElement | null;
 export declare const getRepeatGroupLabelElement: (parent: Element) => RepeatGroupLabelElement | null;
 export declare const getRepeatElement: (parent: Element) => RepeatElement | null;
 export declare const getValueElement: (parent: ItemElement | ItemsetElement) => ValueElement | null;
+export interface SubmissionElement extends LocalNamedElement<'submission'> {
+}
+export declare const getSubmissionElement: (parent: Element) => SubmissionElement | null;

package/dist/lib/reactivity/createChildrenState.d.ts

@@ -1,17 +1,18 @@
 import { Accessor, Setter, Signal } from 'solid-js';
+import { FormNodeID } from '../../client/identity.ts';
 import { AnyChildNode, AnyParentNode } from '../../instance/hierarchy.ts';
-import { NodeID } from '../../instance/identity.ts';
 export interface ChildrenState<Child extends AnyChildNode> {
     readonly children: Signal<readonly Child[]>;
     readonly getChildren: Accessor<readonly Child[]>;
     readonly setChildren: Setter<readonly Child[]>;
-    readonly childIds: Accessor<readonly NodeID[]>;
+    readonly childIds: Accessor<readonly FormNodeID[]>;
 }
 /**
  * Creates a synchronized pair of:
  *
  * - Internal children state suitable for all parent node types
- * - The same children state computed as an array of each child's {@link NodeID}
+ * - The same children state computed as an array of each child's
+ *   {@link FormNodeID}
  *
  * This state is used, in tandem with {@link materializeCurrentStateChildren},
  * to ensure children in **client-facing** state are not written into nested
@@ -26,11 +27,12 @@ export interface ChildrenState<Child extends AnyChildNode> {
  * The produced {@link ChildrenState.childIds} memo is intended to be used to
  * specify each parent node's `children` in an instance of {@link EngineState}.
  * In so doing, the node's corresponding (internal, synchronized)
- * {@link ClientState} will likewise store only the children's {@link NodeID}s.
+ * {@link ClientState} will likewise store only the children's
+ * {@link FormNodeID}s.
  *
  * As a client reacts to changes in a given parent node's `children` state, that
  * node's {@link CurrentState} should produce the child nodes corresponding to
- * those {@link NodeID}s with the aforementioned
+ * those {@link FormNodeID}s with the aforementioned
  * {@link materializeCurrentStateChildren}.
  */
 export declare const createChildrenState: <Parent extends AnyParentNode, Child extends AnyChildNode>(parent: Parent) => ChildrenState<Child>;

package/dist/lib/reactivity/createComputedExpression.d.ts

@@ -1,17 +1,30 @@
 import { Accessor } from 'solid-js';
 import { EvaluationContext } from '../../instance/internal-api/EvaluationContext.ts';
-import { SubscribableDependency } from '../../instance/internal-api/SubscribableDependency.ts';
+import { EngineXPathNode } from '../../integration/xpath/adapter/kind.ts';
 import { DependentExpression, DependentExpressionResultType } from '../../parse/expression/abstract/DependentExpression.ts';
 interface ComputedExpressionResults {
     readonly boolean: boolean;
-    readonly nodes: Node[];
+    readonly nodes: EngineXPathNode[];
     readonly number: number;
     readonly string: string;
 }
 type EvaluatedExpression<Type extends DependentExpressionResultType> = ComputedExpressionResults[Type];
 type ComputedExpression<Type extends DependentExpressionResultType> = Accessor<EvaluatedExpression<Type>>;
-interface CreateComputedExpressionOptions {
-    readonly arbitraryDependencies?: readonly SubscribableDependency[];
+interface CreateComputedExpressionOptions<Type extends DependentExpressionResultType> {
+    /**
+     * If a default value is provided, {@link createComputedExpression} will
+     * produce this value for computations in a non-attached evaluation context,
+     * i.e. when evaluating an expression against a node which has not yet been
+     * appended to its parents children state (or which has since been removed
+     * from that state). A non-attached state is detected when
+     * {@link EvaluationContext.isAttached} returns false.
+     *
+     * If no default value is provided, an implicit default value is produced as
+     * appropriate for the expression's intrinsic result type.
+     *
+     * @see {@link defaultEvaluationsByType} for these implicit defaults.
+     */
+    readonly defaultValue?: EvaluatedExpression<Type>;
 }
-export declare const createComputedExpression: <Type extends DependentExpressionResultType>(context: EvaluationContext, dependentExpression: DependentExpression<Type>, options?: CreateComputedExpressionOptions) => ComputedExpression<Type>;
+export declare const createComputedExpression: <Type extends DependentExpressionResultType>(context: EvaluationContext, dependentExpression: DependentExpression<Type>, options?: CreateComputedExpressionOptions<Type>) => ComputedExpression<Type>;
 export {};

package/dist/lib/reactivity/createInstanceValueState.d.ts

@@ -0,0 +1,40 @@
+import { InstanceValueContext } from '../../instance/internal-api/InstanceValueContext.ts';
+import { SimpleAtomicState } from './types.ts';
+type InitialValueSource = 'FORM_DEFAULT' | 'PRIMARY_INSTANCE';
+export interface InstanceValueStateOptions {
+    /**
+     * Specifies the source of a {@link createInstanceValueState} signal's initial
+     * value state, where:
+     *
+     * - 'FORM_DEFAULT': Derives the initial state from the form's definition of
+     *   the node itself. This is the default option, appropriate when
+     *   initializing a form without additional primary instance data. In other
+     *   words, this value should not be used for edits.
+     *
+     * - 'PRIMARY_INSTANCE': Derives the initial state from the current text
+     *   content of the {@link ValueNode.contextNode}. This option should be
+     *   specified when initializing a form with existing primary instance data,
+     *   such as when editing a previous submission.
+     *
+     * @default 'FORM_DEFAULT'
+     *
+     * Specifies whether a {@link createInstanceValueState} signal's initial state
+     * should be derived from the current text content of the
+     * {@link ValueNode.contextNode | primary instance DOM state}.
+     */
+    readonly initialValueSource?: InitialValueSource;
+}
+export type InstanceValueState = SimpleAtomicState<string>;
+/**
+ * Provides a consistent interface for value nodes of any type which:
+ *
+ * - derives initial state from either an existing instance (e.g. for edits) or
+ *   the node's definition (e.g. initializing a new submission)
+ * - decodes current primary instance state into the value node's runtime type
+ * - encodes updated runtime values to store updated instance state
+ * - initializes reactive computation of `calculate` bind expressions for those
+ *   nodes defined with one
+ * - prevents downstream writes to nodes in a readonly state
+ */
+export declare const createInstanceValueState: (context: InstanceValueContext, options?: InstanceValueStateOptions) => InstanceValueState;
+export {};

package/dist/lib/reactivity/createNoteReadonlyThunk.d.ts

@@ -1,4 +1,4 @@
 import { Accessor } from 'solid-js';
 import { EvaluationContext } from '../../instance/internal-api/EvaluationContext.ts';
-import { BindComputationExpression } from '../../parse/expression/BindComputationExpression.ts';
-export declare const createNoteReadonlyThunk: (context: EvaluationContext, readonlyDefinition: BindComputationExpression<"readonly">) => Accessor<true>;
+import { NoteNodeDefinition } from '../../parse/model/NoteNodeDefinition.ts';
+export declare const createNoteReadonlyThunk: (context: EvaluationContext, definition: NoteNodeDefinition) => Accessor<true>;

package/dist/lib/reactivity/createTranslationState.d.ts

@@ -0,0 +1,19 @@
+import { Accessor } from 'solid-js';
+import { ActiveLanguage, FormLanguage, FormLanguages } from '../../client/FormLanguage.ts';
+import { EngineXPathEvaluator } from '../../integration/xpath/EngineXPathEvaluator.ts';
+import { ReactiveScope } from './scope.ts';
+import { SimpleAtomicStateSetter } from './types.ts';
+interface TranslationState {
+    readonly languages: FormLanguages;
+    readonly getActiveLanguage: Accessor<ActiveLanguage>;
+    readonly setActiveLanguage: SimpleAtomicStateSetter<FormLanguage>;
+}
+/**
+ * @todo It's been very silly all along that {@link XFormsXPathEvaluator} is
+ * responsible for parsing translation languages, and maintaining the active
+ * language state. It is especially silly now that we've moved _part of the
+ * parsing_ up to the constructor call site. Let's finish off that awkwardness
+ * in a subsequent refactor.
+ */
+export declare const createTranslationState: (scope: ReactiveScope, evaluator: EngineXPathEvaluator) => TranslationState;
+export {};

package/dist/lib/reactivity/createValueState.d.ts

@@ -12,8 +12,7 @@ export interface ValueStateOptions {
      *   other words, this value should not be used for edits.
      *
      * - 'PRIMARY_INSTANCE': Derives the initial state from the current text
-     *   content of the {@link ValueNode.contextNode} (currently an XML DOM
-     *   backing store/source of thruth for primary instance state). This option
+     *   content of the {@link ValueNode.contextNode}. This option
      *   should be specified when initializing a form with existing primary
      *   instance data, such as when editing a previous submission.
      *
@@ -29,16 +28,13 @@ type ValueState<RuntimeValue> = SimpleAtomicState<RuntimeValue>;
 /**
  * Provides a consistent interface for value nodes of any type which:
  *
- * - derives initial state from either the existing primary instance state (e.g.
- *   for edits) or the node's definition (e.g. initializing a new submission)
- * - decodes primary instance state into the value node's runtime type
- * - encodes and persists updated values to the primary instance
+ * - derives initial state from either an existing instance (e.g. for edits) or
+ *   the node's definition (e.g. initializing a new submission)
+ * - decodes current primary instance state into the value node's runtime type
+ * - encodes updated runtime values to store updated instance state
  * - initializes reactive computation of `calculate` bind expressions for those
  *   nodes defined with one
- * - ensures any downstream reactive dependencies are updated only after writes
- *   (whether performed by a client, or by a reactive `calculate` computation)
- *   are persisted, ensuring a consistent view of state when downstream
- *   computations perform XPath evaluations against that primary instance state
+ * - prevents downstream writes to nodes in a readonly state
  */
 export declare const createValueState: <RuntimeValue>(context: ValueContext<RuntimeValue>, options?: ValueStateOptions) => ValueState<RuntimeValue>;
 export {};

package/dist/lib/reactivity/materializeCurrentStateChildren.d.ts

@@ -1,9 +1,9 @@
+import { FormNodeID } from '../../client/identity.ts';
 import { AnyChildNode } from '../../instance/hierarchy.ts';
-import { NodeID } from '../../instance/identity.ts';
 import { ChildrenState } from './createChildrenState.ts';
 import { ReactiveScope } from './scope.ts';
 export interface EncodedParentState {
-    readonly children: readonly NodeID[];
+    readonly children: readonly FormNodeID[];
 }
 export type MaterializedChildren<BaseState extends EncodedParentState, Child extends AnyChildNode | null> = Omit<BaseState, 'children'> & {
     readonly children: readonly Child[];
@@ -11,8 +11,8 @@ export type MaterializedChildren<BaseState extends EncodedParentState, Child ext
 /**
  * Creates a wrapper proxy around a parent node's {@link CurrentState} to map
  * `children` state, which is written to the node's (internal, synchronized)
- * {@link ClientState} as an array of {@link NodeID}s, back to the node objects
- * corresponding to those IDs.
+ * {@link ClientState} as an array of {@link FormNodeID}s, back to the node
+ * objects corresponding to those IDs.
  *
  * @see {@link createChildrenState} for further detail.
  */

package/dist/lib/xml-serialization.d.ts

@@ -0,0 +1,41 @@
+declare const ESCAPED_XML_TEXT_BRAND: unique symbol;
+export type EscapedXMLText = string & {
+    readonly [ESCAPED_XML_TEXT_BRAND]: true;
+};
+/**
+ * This is based on the `escapeHTML` implementation in
+ * {@link https://github.com/ryansolid/dom-expressions} (Solid's JSX transform).
+ *
+ * @see {@link https://github.com/ryansolid/dom-expressions/pull/27} for
+ * motivation to derive this implementation approach.
+ *
+ * The intent is that this can be updated easily if the base implementation
+ * changes. As such, some aspects of this implementation differ from some of our
+ * typical code style preferences.
+ *
+ * Notable changes from the base implementation:
+ *
+ * - Formatting: automated only.
+ * - Naming: the {@link text} parameter is named `html` in the base
+ *   implementation. That would be confusing if preserved.
+ * - Types:
+ *     - Parameter types are added (of course)
+ *     - Return type is branded as {@link EscapedXMLText}, to allow downstream
+ *       checks that escaping has been performed. Return statements are cast
+ *       accordingly.
+ *     - {@link text} attempts to minimize risk of double-escaping by excluding
+ *       that same branded type.
+ * - The '>' character is also escaped, necessary for producing valid XML.
+ *
+ * As with the base implementation, we leave some characters unescaped:
+ *
+ * - " (double quote): except when {@link attr} is `true`.
+ *
+ * - ' (single quote): on the assumption that attributes are always serialized
+ *   in double quotes. If we ever move this to `@getodk/common`, we'd want to
+ *   reconsider this assumption.
+ */
+export declare const escapeXMLText: <Text extends string>(text: Exclude<Text, EscapedXMLText>, attr?: boolean) => EscapedXMLText;
+export declare const serializeParentElementXML: (nodeName: string, serializedChildren: readonly string[]) => string;
+export declare const serializeLeafElementXML: (nodeName: string, xmlValue: EscapedXMLText) => string;
+export {};

package/dist/parse/XFormDOM.d.ts

@@ -1,24 +1,35 @@
-import { XFormsXPathEvaluator } from '@getodk/xpath';
-interface XFormDOMNormalizationOptions {
+import { KnownAttributeLocalNamedElement } from '../../../common/types/dom.ts';
+interface DOMBindElement extends KnownAttributeLocalNamedElement<'bind', 'nodeset'> {
+}
+export interface DOMItextTranslationElement extends KnownAttributeLocalNamedElement<'translation', 'lang'> {
+}
+export interface DOMSecondaryInstanceElement extends KnownAttributeLocalNamedElement<'instance', 'id'> {
+}
+interface XFormDOMOptions {
     readonly isNormalized: boolean;
 }
+/**
+ * @todo **Everything** in this class should be cacheable. Maybe not worth it
+ * for small forms, but may make a pretty substantial difference for very large
+ * forms (in bytes) in sessions creating multiple instances of the same form.
+ */
 export declare class XFormDOM {
     protected readonly sourceXML: string;
     static from(sourceXML: string): XFormDOM;
     protected readonly normalizedXML: string;
-    readonly rootEvaluator: XFormsXPathEvaluator;
-    readonly primaryInstanceEvaluator: XFormsXPathEvaluator;
     readonly xformDocument: XMLDocument;
     readonly html: Element;
     readonly head: Element;
     readonly title: Element;
     readonly model: Element;
+    readonly binds: readonly DOMBindElement[];
     readonly primaryInstance: Element;
     readonly primaryInstanceRoot: Element;
+    readonly itextTranslationElements: readonly DOMItextTranslationElement[];
+    readonly secondaryInstanceElements: readonly DOMSecondaryInstanceElement[];
     readonly body: Element;
-    protected constructor(sourceXML: string, options: XFormDOMNormalizationOptions);
-    createInstance(): XFormDOM;
-    toJSON(): Omit<this, "head" | "html" | "title" | "toJSON" | "model" | "primaryInstanceRoot" | "xformDocument" | "rootEvaluator" | "primaryInstanceEvaluator" | "primaryInstance" | "createInstance"> & {
+    protected constructor(sourceXML: string, options: XFormDOMOptions);
+    toJSON(): Omit<this, "head" | "html" | "title" | "toJSON" | "model" | "primaryInstanceRoot" | "primaryInstance" | "xformDocument"> & {
         xformDocument: string;
         html: string;
         head: string;

package/dist/parse/XFormDefinition.d.ts

@@ -2,7 +2,6 @@ import { BodyDefinition } from '../parse/body/BodyDefinition.ts';
 import { ModelDefinition } from './model/ModelDefinition.ts';
 import { XFormDOM } from './XFormDOM.ts';
 export declare class XFormDefinition {
-    readonly sourceXML: string;
     readonly xformDOM: XFormDOM;
     readonly xformDocument: XMLDocument;
     readonly id: string;
@@ -10,5 +9,5 @@ export declare class XFormDefinition {
     readonly rootReference: string;
     readonly body: BodyDefinition;
     readonly model: ModelDefinition;
-    constructor(sourceXML: string);
+    constructor(xformDOM: XFormDOM);
 }

package/dist/parse/attachments/FormAttachmentResource.d.ts

@@ -0,0 +1,27 @@
+import { JRResourceURL } from '../../../../common/src/jr-resources/JRResourceURL.ts';
+export type FormAttachmentDataType = 'media' | 'secondary-instance';
+/**
+ * @todo This type anticipates work to support media form attachments, which
+ * will tend to be associated with binary data. The
+ * expectation is that:
+ *
+ * - {@link Blob} would be appropriate for representing data from attachment
+ *   resources which are conventionally loaded to completion (where network
+ *   conditions are favorable), such as images
+ *
+ * - {@link MediaSource} or {@link ReadableStream} may be more appropriate for
+ *   representing data from resources which are conventionally streamed in a
+ *   browser context (often regardless of network conditions), such as video and
+ *   audio
+ */
+export type FormAttachmentMediaData = Blob | MediaSource | ReadableStream<unknown>;
+export type FormAttachmentSecondaryInstanceData = string;
+type FormAttachmentData<DataType extends FormAttachmentDataType> = DataType extends 'media' ? FormAttachmentMediaData : FormAttachmentSecondaryInstanceData;
+export declare abstract class FormAttachmentResource<DataType extends FormAttachmentDataType> {
+    readonly dataType: DataType;
+    readonly resourceURL: JRResourceURL;
+    readonly contentType: string;
+    readonly data: FormAttachmentData<DataType>;
+    protected constructor(dataType: DataType, resourceURL: JRResourceURL, contentType: string, data: FormAttachmentData<DataType>);
+}
+export {};

package/dist/parse/body/BodyDefinition.d.ts

@@ -1,7 +1,7 @@
 import { ParsedTokenList, TokenListParser } from '../../lib/TokenListParser.ts';
 import { XFormDefinition } from '../../parse/XFormDefinition.ts';
 import { DependencyContext } from '../expression/abstract/DependencyContext.ts';
-import { InputDefinition } from './control/InputDefinition.ts';
+import { InputControlDefinition } from './control/InputControlDefinition.ts';
 import { RangeControlDefinition } from './control/RangeControlDefinition.ts';
 import { RankControlDefinition } from './control/RankControlDefinition.ts';
 import { AnySelectDefinition } from './control/select/SelectDefinition.ts';
@@ -17,7 +17,7 @@ export interface BodyElementParentContext {
     readonly reference: string | null;
     readonly element: Element;
 }
-export type ControlElementDefinition = AnySelectDefinition | InputDefinition | RangeControlDefinition | RankControlDefinition | TriggerControlDefinition | UploadControlDefinition;
+export type ControlElementDefinition = AnySelectDefinition | InputControlDefinition | RangeControlDefinition | RankControlDefinition | TriggerControlDefinition | UploadControlDefinition;
 type SupportedBodyElementDefinition = RepeatElementDefinition | LogicalGroupDefinition | PresentationGroupDefinition | StructuralGroupDefinition | ControlElementDefinition;
 export type AnyBodyElementDefinition = SupportedBodyElementDefinition | UnsupportedBodyElementDefinition;
 export type BodyElementDefinitionArray = readonly AnyBodyElementDefinition[];
@@ -70,6 +70,6 @@ export declare class BodyDefinition extends DependencyContext implements BodyEle
     constructor(form: XFormDefinition);
     getBodyElement(reference: string): AnyBodyElementDefinition | null;
     getChildElementDefinitions(form: XFormDefinition, parent: BodyElementParentContext, parentElement: Element, children?: readonly Element[]): readonly AnyBodyElementDefinition[];
-    toJSON(): Omit<this, "form" | "isTranslated" | "toJSON" | "dependencyExpressions" | "registerDependentExpression" | "getBodyElement" | "getChildElementDefinitions">;
+    toJSON(): Omit<this, "form" | "toJSON" | "isTranslated" | "getBodyElement" | "getChildElementDefinitions">;
 }
 export {};

package/dist/parse/body/RepeatElementDefinition.d.ts

@@ -14,5 +14,5 @@ export declare class RepeatElementDefinition extends BodyElementDefinition<'repe
     readonly noAddRemoveExpression: string | null;
     readonly children: BodyElementDefinitionArray;
     constructor(form: XFormDefinition, parent: BodyElementParentContext, element: Element);
-    toJSON(): Omit<this, "parent" | "form" | "isTranslated" | "toJSON" | "dependencyExpressions" | "registerDependentExpression">;
+    toJSON(): Omit<this, "parent" | "form" | "toJSON" | "isTranslated">;
 }

package/dist/parse/body/appearance/inputAppearanceParser.d.ts

@@ -1,3 +1,3 @@
 import { TokenListParser, ParsedTokenList } from '../../../lib/TokenListParser.ts';
-export declare const inputAppearanceParser: TokenListParser<"multiline" | "numbers" | "url" | "thousand-sep" | "no-calendar" | "month-year" | "year" | "ethiopian" | "coptic" | "islamic" | "bikram-sambat" | "myanmar" | "persian" | "placement-map" | "maps" | "hidden-answer" | "annotate" | "draw" | "signature" | "new-front" | "new" | "front" | "printer" | "masked", "multiline" | "numbers" | "url" | "thousand-sep" | "no-calendar" | "month-year" | "year" | "ethiopian" | "coptic" | "islamic" | "bikram-sambat" | "myanmar" | "persian" | "placement-map" | "maps" | "hidden-answer" | "annotate" | "draw" | "signature" | "new-front" | "new" | "front" | "printer" | "masked">;
+export declare const inputAppearanceParser: TokenListParser<"multiline" | "numbers" | "url" | "thousands-sep" | "no-calendar" | "month-year" | "year" | "ethiopian" | "coptic" | "islamic" | "bikram-sambat" | "myanmar" | "persian" | "placement-map" | "maps" | "hidden-answer" | "annotate" | "draw" | "signature" | "new-front" | "new" | "front" | "printer" | "masked", "multiline" | "numbers" | "url" | "thousands-sep" | "no-calendar" | "month-year" | "year" | "ethiopian" | "coptic" | "islamic" | "bikram-sambat" | "myanmar" | "persian" | "placement-map" | "maps" | "hidden-answer" | "annotate" | "draw" | "signature" | "new-front" | "new" | "front" | "printer" | "masked">;
 export type InputAppearanceDefinition = ParsedTokenList<typeof inputAppearanceParser>;

package/dist/parse/body/control/{InputDefinition.d.ts → InputControlDefinition.d.ts}

@@ -2,7 +2,7 @@ import { XFormDefinition } from '../../XFormDefinition.ts';
 import { InputAppearanceDefinition } from '../appearance/inputAppearanceParser.ts';
 import { BodyElementParentContext } from '../BodyDefinition.ts';
 import { ControlDefinition } from './ControlDefinition.ts';
-export declare class InputDefinition extends ControlDefinition<'input'> {
+export declare class InputControlDefinition extends ControlDefinition<'input'> {
     static isCompatible(localName: string): boolean;
     readonly type = "input";
     readonly appearances: InputAppearanceDefinition;

package/dist/parse/body/control/select/ItemsetNodesetContext.d.ts

@@ -1,5 +1,4 @@
 import { DependencyContext } from '../../../expression/abstract/DependencyContext.ts';
-import { AnyDependentExpression } from '../../../expression/abstract/DependentExpression.ts';
 import { ItemsetDefinition } from './ItemsetDefinition.ts';
 export declare class ItemsetNodesetContext extends DependencyContext {
     protected readonly itemset: ItemsetDefinition;
@@ -7,5 +6,4 @@ export declare class ItemsetNodesetContext extends DependencyContext {
     readonly reference: string;
     constructor(itemset: ItemsetDefinition, nodesetExpression: string);
     set isTranslated(value: true);
-    registerDependentExpression(expression: AnyDependentExpression): void;
 }