@getodk/xforms-engine 0.2.0 → 0.4.0

package/src/instance/ModelValue.ts

@@ -0,0 +1,104 @@
+import { identity } from '@getodk/common/lib/identity.ts';
+import type { ModelValueNode } from '../client/ModelValueNode.ts';
+import type { AnyViolation, LeafNodeValidationState } from '../client/validation.ts';
+import { createValueState } from '../lib/reactivity/createValueState.ts';
+import type { CurrentState } from '../lib/reactivity/node-state/createCurrentState.ts';
+import type { EngineState } from '../lib/reactivity/node-state/createEngineState.ts';
+import type { SharedNodeState } from '../lib/reactivity/node-state/createSharedNodeState.ts';
+import { createSharedNodeState } from '../lib/reactivity/node-state/createSharedNodeState.ts';
+import type { SimpleAtomicState } from '../lib/reactivity/types.ts';
+import type { SharedValidationState } from '../lib/reactivity/validation/createValidation.ts';
+import { createValidationState } from '../lib/reactivity/validation/createValidation.ts';
+import type { LeafNodeDefinition } from '../parse/model/LeafNodeDefinition.ts';
+import type { DescendantNodeStateSpec } from './abstract/DescendantNode.ts';
+import { DescendantNode } from './abstract/DescendantNode.ts';
+import type { GeneralParentNode } from './hierarchy.ts';
+import type { EvaluationContext } from './internal-api/EvaluationContext.ts';
+import type { SubscribableDependency } from './internal-api/SubscribableDependency.ts';
+import type { ValidationContext } from './internal-api/ValidationContext.ts';
+import type { ValueContext } from './internal-api/ValueContext.ts';
+
+export interface ModelValueDefinition extends LeafNodeDefinition {
+	readonly bodyElement: null;
+}
+
+interface ModelValueStateSpec extends DescendantNodeStateSpec<string> {
+	readonly label: null;
+	readonly hint: null;
+	readonly children: null;
+	readonly value: SimpleAtomicState<string>;
+	readonly valueOptions: null;
+}
+
+export class ModelValue
+	extends DescendantNode<ModelValueDefinition, ModelValueStateSpec, null>
+	implements
+		ModelValueNode,
+		EvaluationContext,
+		SubscribableDependency,
+		ValidationContext,
+		ValueContext<string>
+{
+	private readonly validation: SharedValidationState;
+	protected readonly state: SharedNodeState<ModelValueStateSpec>;
+
+	// InstanceNode
+	protected engineState: EngineState<ModelValueStateSpec>;
+
+	// ModelValueNode
+	readonly nodeType = 'model-value';
+	readonly appearances = null;
+	readonly currentState: CurrentState<ModelValueStateSpec>;
+
+	get validationState(): LeafNodeValidationState {
+		return this.validation.currentState;
+	}
+
+	// ValueContext
+	readonly encodeValue = identity<string>;
+	readonly decodeValue = identity<string>;
+
+	constructor(parent: GeneralParentNode, definition: ModelValueDefinition) {
+		super(parent, definition);
+
+		const sharedStateOptions = {
+			clientStateFactory: this.engineConfig.stateFactory,
+		};
+
+		const state = createSharedNodeState(
+			this.scope,
+			{
+				reference: this.contextReference,
+				readonly: this.isReadonly,
+				relevant: this.isRelevant,
+				required: this.isRequired,
+
+				label: null,
+				hint: null,
+				children: null,
+				valueOptions: null,
+				value: createValueState(this),
+			},
+			sharedStateOptions
+		);
+
+		this.state = state;
+		this.engineState = state.engineState;
+		this.currentState = state.currentState;
+		this.validation = createValidationState(this, sharedStateOptions);
+	}
+
+	// ValidationContext
+	getViolation(): AnyViolation | null {
+		return this.validation.engineState.violation;
+	}
+
+	isBlank(): boolean {
+		return this.engineState.value === '';
+	}
+
+	// InstanceNode
+	getChildren(): readonly [] {
+		return [];
+	}
+}

package/src/instance/Note.ts

@@ -0,0 +1,142 @@
+import { UnreachableError } from '@getodk/common/lib/error/UnreachableError.ts';
+import { identity } from '@getodk/common/lib/identity.ts';
+import type { Accessor } from 'solid-js';
+import type { NoteNode, NoteNodeAppearances } from '../client/NoteNode.ts';
+import type { TextRange } from '../client/TextRange.ts';
+import type { AnyViolation, LeafNodeValidationState } from '../client/validation.ts';
+import { createNoteReadonlyThunk } from '../lib/reactivity/createNoteReadonlyThunk.ts';
+import { createValueState } from '../lib/reactivity/createValueState.ts';
+import type { CurrentState } from '../lib/reactivity/node-state/createCurrentState.ts';
+import type { EngineState } from '../lib/reactivity/node-state/createEngineState.ts';
+import type { SharedNodeState } from '../lib/reactivity/node-state/createSharedNodeState.ts';
+import { createSharedNodeState } from '../lib/reactivity/node-state/createSharedNodeState.ts';
+import { createFieldHint } from '../lib/reactivity/text/createFieldHint.ts';
+import { createNodeLabel } from '../lib/reactivity/text/createNodeLabel.ts';
+import { createNoteText, type ComputedNoteText } from '../lib/reactivity/text/createNoteText.ts';
+import type { SimpleAtomicState } from '../lib/reactivity/types.ts';
+import type { SharedValidationState } from '../lib/reactivity/validation/createValidation.ts';
+import { createValidationState } from '../lib/reactivity/validation/createValidation.ts';
+import type { NoteNodeDefinition } from '../parse/model/NoteNodeDefinition.ts';
+import type { DescendantNodeStateSpec } from './abstract/DescendantNode.ts';
+import { DescendantNode } from './abstract/DescendantNode.ts';
+import type { GeneralParentNode } from './hierarchy.ts';
+import type { EvaluationContext } from './internal-api/EvaluationContext.ts';
+import type { SubscribableDependency } from './internal-api/SubscribableDependency.ts';
+import type { ValidationContext } from './internal-api/ValidationContext.ts';
+import type { ValueContext } from './internal-api/ValueContext.ts';
+
+interface NoteStateSpec extends DescendantNodeStateSpec<string> {
+	readonly readonly: Accessor<true>;
+	readonly noteText: ComputedNoteText;
+	readonly label: Accessor<TextRange<'label', 'form'> | null>;
+	readonly hint: Accessor<TextRange<'hint', 'form'> | null>;
+	readonly children: null;
+	readonly value: SimpleAtomicState<string>;
+	readonly valueOptions: null;
+}
+
+export class Note
+	extends DescendantNode<NoteNodeDefinition, NoteStateSpec, null>
+	implements
+		NoteNode,
+		EvaluationContext,
+		SubscribableDependency,
+		ValidationContext,
+		ValueContext<string>
+{
+	private readonly validation: SharedValidationState;
+	protected readonly state: SharedNodeState<NoteStateSpec>;
+
+	// InstanceNode
+	protected engineState: EngineState<NoteStateSpec>;
+
+	// NoteNode
+	readonly nodeType = 'note';
+	readonly appearances: NoteNodeAppearances;
+	readonly currentState: CurrentState<NoteStateSpec>;
+
+	get validationState(): LeafNodeValidationState {
+		return this.validation.currentState;
+	}
+
+	// ValueContext
+	readonly encodeValue = identity<string>;
+
+	readonly decodeValue = identity<string>;
+
+	constructor(parent: GeneralParentNode, definition: NoteNodeDefinition) {
+		super(parent, definition);
+
+		this.appearances = definition.bodyElement.appearances;
+
+		const sharedStateOptions = {
+			clientStateFactory: this.engineConfig.stateFactory,
+		};
+
+		const isReadonly = createNoteReadonlyThunk(this, definition.bind.readonly);
+		const noteTextComputation = createNoteText(this, definition.noteTextDefinition);
+
+		let noteText: ComputedNoteText;
+		let label: Accessor<TextRange<'label', 'form'> | null>;
+		let hint: Accessor<TextRange<'hint', 'form'> | null>;
+
+		switch (noteTextComputation.role) {
+			case 'label': {
+				noteText = noteTextComputation.label;
+				label = noteTextComputation.label;
+				hint = createFieldHint(this, definition);
+
+				break;
+			}
+
+			case 'hint': {
+				noteText = noteTextComputation.hint;
+				label = createNodeLabel(this, definition);
+				hint = noteTextComputation.hint;
+
+				break;
+			}
+
+			default:
+				throw new UnreachableError(noteTextComputation);
+		}
+
+		const state = createSharedNodeState(
+			this.scope,
+			{
+				reference: this.contextReference,
+				readonly: isReadonly,
+				relevant: this.isRelevant,
+				required: this.isRequired,
+
+				label,
+				hint,
+				noteText,
+
+				children: null,
+				valueOptions: null,
+				value: createValueState(this),
+			},
+			sharedStateOptions
+		);
+
+		this.state = state;
+		this.engineState = state.engineState;
+		this.currentState = state.currentState;
+		this.validation = createValidationState(this, sharedStateOptions);
+	}
+
+	// ValidationContext
+	getViolation(): AnyViolation | null {
+		return this.validation.engineState.violation;
+	}
+
+	isBlank(): boolean {
+		return this.engineState.value === '';
+	}
+
+	// InstanceNode
+	getChildren(): readonly [] {
+		return [];
+	}
+}

package/src/instance/Root.ts

@@ -1,10 +1,9 @@
 import type { XFormsXPathEvaluator } from '@getodk/xpath';
 import type { Accessor, Signal } from 'solid-js';
 import { createSignal } from 'solid-js';
-import type { XFormDOM } from '../XFormDOM.ts';
-import type { BodyClassList } from '../body/BodyDefinition.ts';
 import type { ActiveLanguage, FormLanguage, FormLanguages } from '../client/FormLanguage.ts';
 import type { RootNode } from '../client/RootNode.ts';
+import type { AncestorNodeValidationState } from '../client/validation.ts';
 import type { ChildrenState } from '../lib/reactivity/createChildrenState.ts';
 import { createChildrenState } from '../lib/reactivity/createChildrenState.ts';
 import type { MaterializedChildren } from '../lib/reactivity/materializeCurrentStateChildren.ts';
@@ -13,7 +12,10 @@ import type { CurrentState } from '../lib/reactivity/node-state/createCurrentSta
 import type { EngineState } from '../lib/reactivity/node-state/createEngineState.ts';
 import type { SharedNodeState } from '../lib/reactivity/node-state/createSharedNodeState.ts';
 import { createSharedNodeState } from '../lib/reactivity/node-state/createSharedNodeState.ts';
-import type { RootDefinition } from '../model/RootDefinition.ts';
+import { createAggregatedViolations } from '../lib/reactivity/validation/createAggregatedViolations.ts';
+import type { BodyClassList } from '../parse/body/BodyDefinition.ts';
+import type { RootDefinition } from '../parse/model/RootDefinition.ts';
+import type { XFormDOM } from '../parse/XFormDOM.ts';
 import { InstanceNode } from './abstract/InstanceNode.ts';
 import { buildChildren } from './children.ts';
 import type { GeneralChildNode } from './hierarchy.ts';
@@ -114,6 +116,7 @@ export class Root
 	readonly appearances = null;
 	readonly classes: BodyClassList;
 	readonly currentState: MaterializedChildren<CurrentState<RootStateSpec>, GeneralChildNode>;
+	readonly validationState: AncestorNodeValidationState;
 
 	protected readonly instanceDOM: XFormDOM;
 
@@ -152,6 +155,10 @@ export class Root
 		const evaluator = instanceDOM.primaryInstanceEvaluator;
 		const { translations } = evaluator;
 		const { defaultLanguage, languages } = getInitialLanguageState(translations);
+		const sharedStateOptions = {
+			clientStateFactory: this.engineConfig.stateFactory,
+		};
+
 		const state = createSharedNodeState(
 			this.scope,
 			{
@@ -166,9 +173,7 @@ export class Root
 				value: null,
 				children: childrenState.childIds,
 			},
-			{
-				clientStateFactory: engineConfig.stateFactory,
-			}
+			sharedStateOptions
 		);
 
 		this.state = state;
@@ -189,6 +194,7 @@ export class Root
 		this.languages = languages;
 
 		childrenState.setChildren(buildChildren(this));
+		this.validationState = createAggregatedViolations(this, sharedStateOptions);
 	}
 
 	getChildren(): readonly GeneralChildNode[] {
@@ -215,6 +221,10 @@ export class Root
 	override subscribe(): void {
 		super.subscribe();
 
+		// TODO: typescript-eslint is right to object to this! We should _at least_
+		// make internal reactive reads obvious, i.e. function calls.
+		//
+		// eslint-disable-next-line @typescript-eslint/no-unused-expressions -- read == subscribe
 		this.engineState.activeLanguage;
 	}
 }

package/src/instance/SelectField.ts

@@ -1,9 +1,9 @@
 import { xmlXPathWhitespaceSeparatedList } from '@getodk/common/lib/string/whitespace.ts';
 import type { Accessor } from 'solid-js';
 import { untrack } from 'solid-js';
-import type { AnySelectDefinition } from '../body/control/select/SelectDefinition.ts';
 import type { SelectItem, SelectNode, SelectNodeAppearances } from '../client/SelectNode.ts';
-import type { TextRange } from '../index.ts';
+import type { TextRange } from '../client/TextRange.ts';
+import type { AnyViolation, LeafNodeValidationState } from '../client/validation.ts';
 import { createSelectItems } from '../lib/reactivity/createSelectItems.ts';
 import { createValueState } from '../lib/reactivity/createValueState.ts';
 import type { CurrentState } from '../lib/reactivity/node-state/createCurrentState.ts';
@@ -13,16 +13,20 @@ import { createSharedNodeState } from '../lib/reactivity/node-state/createShared
 import { createFieldHint } from '../lib/reactivity/text/createFieldHint.ts';
 import { createNodeLabel } from '../lib/reactivity/text/createNodeLabel.ts';
 import type { SimpleAtomicState } from '../lib/reactivity/types.ts';
-import type { ValueNodeDefinition } from '../model/ValueNodeDefinition.ts';
+import type { SharedValidationState } from '../lib/reactivity/validation/createValidation.ts';
+import { createValidationState } from '../lib/reactivity/validation/createValidation.ts';
+import type { AnySelectDefinition } from '../parse/body/control/select/SelectDefinition.ts';
+import type { LeafNodeDefinition } from '../parse/model/LeafNodeDefinition.ts';
 import type { Root } from './Root.ts';
 import type { DescendantNodeStateSpec } from './abstract/DescendantNode.ts';
 import { DescendantNode } from './abstract/DescendantNode.ts';
 import type { GeneralParentNode } from './hierarchy.ts';
 import type { EvaluationContext } from './internal-api/EvaluationContext.ts';
 import type { SubscribableDependency } from './internal-api/SubscribableDependency.ts';
+import type { ValidationContext } from './internal-api/ValidationContext.ts';
 import type { ValueContext } from './internal-api/ValueContext.ts';
 
-export interface SelectFieldDefinition extends ValueNodeDefinition {
+export interface SelectFieldDefinition extends LeafNodeDefinition {
 	readonly bodyElement: AnySelectDefinition;
 }
 
@@ -40,9 +44,11 @@ export class SelectField
 		SelectNode,
 		EvaluationContext,
 		SubscribableDependency,
+		ValidationContext,
 		ValueContext<readonly SelectItem[]>
 {
 	private readonly selectExclusive: boolean;
+	private readonly validation: SharedValidationState;
 
 	// InstanceNode
 	protected readonly state: SharedNodeState<SelectFieldStateSpec>;
@@ -53,6 +59,10 @@ export class SelectField
 	readonly appearances: SelectNodeAppearances;
 	readonly currentState: CurrentState<SelectFieldStateSpec>;
 
+	get validationState(): LeafNodeValidationState {
+		return this.validation.currentState;
+	}
+
 	// ValueContext
 	readonly encodeValue = (runtimeValue: readonly SelectItem[]): string => {
 		const itemValues = new Set(runtimeValue.map(({ value }) => value));
@@ -90,6 +100,10 @@ export class SelectField
 
 		this.getValueOptions = valueOptions;
 
+		const sharedStateOptions = {
+			clientStateFactory: this.engineConfig.stateFactory,
+		};
+
 		const state = createSharedNodeState(
 			this.scope,
 			{
@@ -104,14 +118,13 @@ export class SelectField
 				value: createValueState(this),
 				valueOptions,
 			},
-			{
-				clientStateFactory: this.engineConfig.stateFactory,
-			}
+			sharedStateOptions
 		);
 
 		this.state = state;
 		this.engineState = state.engineState;
 		this.currentState = state.currentState;
+		this.validation = createValidationState(this, sharedStateOptions);
 	}
 
 	protected getSelectItemsByValue(
@@ -201,4 +214,13 @@ export class SelectField
 	getChildren(): readonly [] {
 		return [];
 	}
+
+	// ValidationContext
+	getViolation(): AnyViolation | null {
+		return this.validation.engineState.violation;
+	}
+
+	isBlank(): boolean {
+		return this.engineState.value.length === 0;
+	}
 }

package/src/instance/StringField.ts

@@ -1,8 +1,8 @@
 import { identity } from '@getodk/common/lib/identity.ts';
 import type { Accessor } from 'solid-js';
-import type { InputDefinition } from '../body/control/InputDefinition.ts';
 import type { StringNode, StringNodeAppearances } from '../client/StringNode.ts';
-import type { TextRange } from '../index.ts';
+import type { TextRange } from '../client/TextRange.ts';
+import type { AnyViolation, LeafNodeValidationState } from '../client/validation.ts';
 import { createValueState } from '../lib/reactivity/createValueState.ts';
 import type { CurrentState } from '../lib/reactivity/node-state/createCurrentState.ts';
 import type { EngineState } from '../lib/reactivity/node-state/createEngineState.ts';
@@ -11,17 +11,21 @@ import { createSharedNodeState } from '../lib/reactivity/node-state/createShared
 import { createFieldHint } from '../lib/reactivity/text/createFieldHint.ts';
 import { createNodeLabel } from '../lib/reactivity/text/createNodeLabel.ts';
 import type { SimpleAtomicState } from '../lib/reactivity/types.ts';
-import type { ValueNodeDefinition } from '../model/ValueNodeDefinition.ts';
+import type { SharedValidationState } from '../lib/reactivity/validation/createValidation.ts';
+import { createValidationState } from '../lib/reactivity/validation/createValidation.ts';
+import type { InputDefinition } from '../parse/body/control/InputDefinition.ts';
+import type { LeafNodeDefinition } from '../parse/model/LeafNodeDefinition.ts';
 import type { Root } from './Root.ts';
 import type { DescendantNodeStateSpec } from './abstract/DescendantNode.ts';
 import { DescendantNode } from './abstract/DescendantNode.ts';
 import type { GeneralParentNode } from './hierarchy.ts';
 import type { EvaluationContext } from './internal-api/EvaluationContext.ts';
 import type { SubscribableDependency } from './internal-api/SubscribableDependency.ts';
+import type { ValidationContext } from './internal-api/ValidationContext.ts';
 import type { ValueContext } from './internal-api/ValueContext.ts';
 
-export interface StringFieldDefinition extends ValueNodeDefinition {
-	readonly bodyElement: InputDefinition | null;
+export interface StringFieldDefinition extends LeafNodeDefinition {
+	readonly bodyElement: InputDefinition;
 }
 
 interface StringFieldStateSpec extends DescendantNodeStateSpec<string> {
@@ -34,8 +38,14 @@ interface StringFieldStateSpec extends DescendantNodeStateSpec<string> {
 
 export class StringField
 	extends DescendantNode<StringFieldDefinition, StringFieldStateSpec, null>
-	implements StringNode, EvaluationContext, SubscribableDependency, ValueContext<string>
+	implements
+		StringNode,
+		EvaluationContext,
+		SubscribableDependency,
+		ValidationContext,
+		ValueContext<string>
 {
+	private readonly validation: SharedValidationState;
 	protected readonly state: SharedNodeState<StringFieldStateSpec>;
 
 	// InstanceNode
@@ -46,6 +56,10 @@ export class StringField
 	readonly appearances: StringNodeAppearances;
 	readonly currentState: CurrentState<StringFieldStateSpec>;
 
+	get validationState(): LeafNodeValidationState {
+		return this.validation.currentState;
+	}
+
 	// ValueContext
 	readonly encodeValue = identity<string>;
 
@@ -54,7 +68,11 @@ export class StringField
 	constructor(parent: GeneralParentNode, definition: StringFieldDefinition) {
 		super(parent, definition);
 
-		this.appearances = (definition.bodyElement?.appearances ?? null) as StringNodeAppearances;
+		this.appearances = definition.bodyElement.appearances;
+
+		const sharedStateOptions = {
+			clientStateFactory: this.engineConfig.stateFactory,
+		};
 
 		const state = createSharedNodeState(
 			this.scope,
@@ -70,14 +88,22 @@ export class StringField
 				valueOptions: null,
 				value: createValueState(this),
 			},
-			{
-				clientStateFactory: this.engineConfig.stateFactory,
-			}
+			sharedStateOptions
 		);
 
 		this.state = state;
 		this.engineState = state.engineState;
 		this.currentState = state.currentState;
+		this.validation = createValidationState(this, sharedStateOptions);
+	}
+
+	// ValidationContext
+	getViolation(): AnyViolation | null {
+		return this.validation.engineState.violation;
+	}
+
+	isBlank(): boolean {
+		return this.engineState.value === '';
 	}
 
 	// InstanceNode

package/src/instance/Subtree.ts

@@ -1,5 +1,6 @@
 import { type Accessor } from 'solid-js';
 import type { SubtreeDefinition, SubtreeNode } from '../client/SubtreeNode.ts';
+import type { AncestorNodeValidationState } from '../client/validation.ts';
 import type { ChildrenState } from '../lib/reactivity/createChildrenState.ts';
 import { createChildrenState } from '../lib/reactivity/createChildrenState.ts';
 import type { MaterializedChildren } from '../lib/reactivity/materializeCurrentStateChildren.ts';
@@ -8,6 +9,7 @@ import type { CurrentState } from '../lib/reactivity/node-state/createCurrentSta
 import type { EngineState } from '../lib/reactivity/node-state/createEngineState.ts';
 import type { SharedNodeState } from '../lib/reactivity/node-state/createSharedNodeState.ts';
 import { createSharedNodeState } from '../lib/reactivity/node-state/createSharedNodeState.ts';
+import { createAggregatedViolations } from '../lib/reactivity/validation/createAggregatedViolations.ts';
 import type { DescendantNodeSharedStateSpec } from './abstract/DescendantNode.ts';
 import { DescendantNode } from './abstract/DescendantNode.ts';
 import { buildChildren } from './children.ts';
@@ -38,6 +40,7 @@ export class Subtree
 	readonly nodeType = 'subtree';
 	readonly appearances = null;
 	readonly currentState: MaterializedChildren<CurrentState<SubtreeStateSpec>, GeneralChildNode>;
+	readonly validationState: AncestorNodeValidationState;
 
 	constructor(parent: GeneralParentNode, definition: SubtreeDefinition) {
 		super(parent, definition);
@@ -46,6 +49,10 @@ export class Subtree
 
 		this.childrenState = childrenState;
 
+		const sharedStateOptions = {
+			clientStateFactory: this.engineConfig.stateFactory,
+		};
+
 		const state = createSharedNodeState(
 			this.scope,
 			{
@@ -60,9 +67,7 @@ export class Subtree
 				valueOptions: null,
 				value: null,
 			},
-			{
-				clientStateFactory: this.engineConfig.stateFactory,
-			}
+			sharedStateOptions
 		);
 
 		this.state = state;
@@ -74,6 +79,7 @@ export class Subtree
 		);
 
 		childrenState.setChildren(buildChildren(this));
+		this.validationState = createAggregatedViolations(this, sharedStateOptions);
 	}
 
 	getChildren(): readonly GeneralChildNode[] {