@getodk/xforms-engine 0.1.1 → 0.3.0

package/src/instance/SelectField.ts

@@ -2,8 +2,9 @@ import { xmlXPathWhitespaceSeparatedList } from '@getodk/common/lib/string/white
 import type { Accessor } from 'solid-js';
 import { untrack } from 'solid-js';
 import type { AnySelectDefinition } from '../body/control/select/SelectDefinition.ts';
-import type { SelectItem, SelectNode } from '../client/SelectNode.ts';
-import type { TextRange } from '../index.ts';
+import type { SelectItem, SelectNode, SelectNodeAppearances } from '../client/SelectNode.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 +14,19 @@ 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 { LeafNodeDefinition } from '../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>;
@@ -50,9 +56,13 @@ export class SelectField
 
 	// SelectNode
 	readonly nodeType = 'select';
-
+	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));
@@ -83,16 +93,24 @@ export class SelectField
 	constructor(parent: GeneralParentNode, definition: SelectFieldDefinition) {
 		super(parent, definition);
 
+		this.appearances = definition.bodyElement.appearances;
 		this.selectExclusive = definition.bodyElement.type === 'select1';
 
 		const valueOptions = createSelectItems(this);
 
 		this.getValueOptions = valueOptions;
 
+		const sharedStateOptions = {
+			clientStateFactory: this.engineConfig.stateFactory,
+		};
+
 		const state = createSharedNodeState(
 			this.scope,
 			{
-				...this.buildSharedStateSpec(parent, definition),
+				reference: this.contextReference,
+				readonly: this.isReadonly,
+				relevant: this.isRelevant,
+				required: this.isRequired,
 
 				label: createNodeLabel(this, definition),
 				hint: createFieldHint(this, definition),
@@ -100,14 +118,17 @@ 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);
+	}
+
+	getViolation(): AnyViolation | null {
+		return this.validation.engineState.violation;
 	}
 
 	protected getSelectItemsByValue(
@@ -120,10 +141,6 @@ export class SelectField
 		);
 	}
 
-	protected computeReference(parent: GeneralParentNode): string {
-		return this.computeChildStepReference(parent);
-	}
-
 	protected updateSelectedItemValues(values: readonly string[]) {
 		const itemsByValue = untrack(() => this.getSelectItemsByValue());
 
@@ -201,4 +218,9 @@ export class SelectField
 	getChildren(): readonly [] {
 		return [];
 	}
+
+	// ValidationContext
+	isBlank(): boolean {
+		return this.engineState.value.length === 0;
+	}
 }

package/src/instance/StringField.ts

@@ -1,8 +1,9 @@
 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 } from '../client/StringNode.ts';
-import type { TextRange } from '../index.ts';
+import type { StringNode, StringNodeAppearances } from '../client/StringNode.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 +12,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 { LeafNodeDefinition } from '../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
@@ -43,9 +53,13 @@ export class StringField
 
 	// StringNode
 	readonly nodeType = 'string';
-
+	readonly appearances: StringNodeAppearances;
 	readonly currentState: CurrentState<StringFieldStateSpec>;
 
+	get validationState(): LeafNodeValidationState {
+		return this.validation.currentState;
+	}
+
 	// ValueContext
 	readonly encodeValue = identity<string>;
 
@@ -54,10 +68,19 @@ export class StringField
 	constructor(parent: GeneralParentNode, definition: StringFieldDefinition) {
 		super(parent, definition);
 
+		this.appearances = definition.bodyElement.appearances;
+
+		const sharedStateOptions = {
+			clientStateFactory: this.engineConfig.stateFactory,
+		};
+
 		const state = createSharedNodeState(
 			this.scope,
 			{
-				...this.buildSharedStateSpec(parent, definition),
+				reference: this.contextReference,
+				readonly: this.isReadonly,
+				relevant: this.isRelevant,
+				required: this.isRequired,
 
 				label: createNodeLabel(this, definition),
 				hint: createFieldHint(this, definition),
@@ -65,18 +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);
+	}
+
+	getViolation(): AnyViolation | null {
+		return this.validation.engineState.violation;
 	}
 
-	protected computeReference(parent: GeneralParentNode): string {
-		return this.computeChildStepReference(parent);
+	// ValidationContext
+	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';
@@ -36,8 +38,9 @@ export class Subtree
 
 	// SubtreeNode
 	readonly nodeType = 'subtree';
-
+	readonly appearances = null;
 	readonly currentState: MaterializedChildren<CurrentState<SubtreeStateSpec>, GeneralChildNode>;
+	readonly validationState: AncestorNodeValidationState;
 
 	constructor(parent: GeneralParentNode, definition: SubtreeDefinition) {
 		super(parent, definition);
@@ -46,10 +49,17 @@ export class Subtree
 
 		this.childrenState = childrenState;
 
+		const sharedStateOptions = {
+			clientStateFactory: this.engineConfig.stateFactory,
+		};
+
 		const state = createSharedNodeState(
 			this.scope,
 			{
-				...this.buildSharedStateSpec(parent, definition),
+				reference: this.contextReference,
+				readonly: this.isReadonly,
+				relevant: this.isRelevant,
+				required: this.isRequired,
 
 				label: null,
 				hint: null,
@@ -57,20 +67,19 @@ export class Subtree
 				valueOptions: null,
 				value: null,
 			},
-			{
-				clientStateFactory: this.engineConfig.stateFactory,
-			}
+			sharedStateOptions
 		);
 
 		this.state = state;
 		this.engineState = state.engineState;
-		this.currentState = materializeCurrentStateChildren(state.currentState, childrenState);
+		this.currentState = materializeCurrentStateChildren(
+			this.scope,
+			state.currentState,
+			childrenState
+		);
 
 		childrenState.setChildren(buildChildren(this));
-	}
-
-	protected computeReference(parent: GeneralParentNode): string {
-		return this.computeChildStepReference(parent);
+		this.validationState = createAggregatedViolations(this, sharedStateOptions);
 	}
 
 	getChildren(): readonly GeneralChildNode[] {

package/src/instance/abstract/DescendantNode.ts

@@ -1,19 +1,17 @@
 import type { XFormsXPathEvaluator } from '@getodk/xpath';
 import type { Accessor } from 'solid-js';
-import { createMemo } from 'solid-js';
 import type { BaseNode } from '../../client/BaseNode.ts';
 import { createComputedExpression } from '../../lib/reactivity/createComputedExpression.ts';
 import type { ReactiveScope } from '../../lib/reactivity/scope.ts';
 import type { AnyDescendantNodeDefinition } from '../../model/DescendentNodeDefinition.ts';
+import type { LeafNodeDefinition } from '../../model/LeafNodeDefinition.ts';
 import type { AnyNodeDefinition } from '../../model/NodeDefinition.ts';
 import type { RepeatInstanceDefinition } from '../../model/RepeatInstanceDefinition.ts';
-import type { ValueNodeDefinition } from '../../model/ValueNodeDefinition.ts';
-import type { RepeatInstance } from '../RepeatInstance.ts';
-import type { RepeatRange } from '../RepeatRange.ts';
-import type { Root } from '../Root.ts';
-import type { AnyChildNode, GeneralParentNode } from '../hierarchy.ts';
+import type { AnyChildNode, GeneralParentNode, RepeatRange } from '../hierarchy.ts';
 import type { EvaluationContext } from '../internal-api/EvaluationContext.ts';
 import type { SubscribableDependency } from '../internal-api/SubscribableDependency.ts';
+import type { RepeatInstance } from '../repeat/RepeatInstance.ts';
+import type { Root } from '../Root.ts';
 import type { InstanceNodeStateSpec } from './InstanceNode.ts';
 import { InstanceNode } from './InstanceNode.ts';
 
@@ -38,7 +36,7 @@ export type DescendantNodeDefinition = Extract<
 
 // prettier-ignore
 export type DescendantNodeParent<Definition extends DescendantNodeDefinition> =
-	Definition extends ValueNodeDefinition
+	Definition extends LeafNodeDefinition
 		? GeneralParentNode
 	: Definition extends RepeatInstanceDefinition
 		? RepeatRange
@@ -52,6 +50,10 @@ export type AnyDescendantNode = DescendantNode<
 	any
 >;
 
+interface DescendantNodeOptions {
+	readonly computeReference?: Accessor<string>;
+}
+
 export abstract class DescendantNode<
 		Definition extends DescendantNodeDefinition,
 		// eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -61,63 +63,62 @@ export abstract class DescendantNode<
 	extends InstanceNode<Definition, Spec, Child>
 	implements BaseNode, EvaluationContext, SubscribableDependency
 {
+	readonly hasReadonlyAncestor: Accessor<boolean> = () => {
+		const { parent } = this;
+
+		return parent.hasReadonlyAncestor() || parent.isReadonly();
+	};
+
+	readonly isSelfReadonly: Accessor<boolean>;
+
+	readonly isReadonly: Accessor<boolean> = () => {
+		if (this.hasReadonlyAncestor()) {
+			return true;
+		}
+
+		return this.isSelfReadonly();
+	};
+
+	readonly hasNonRelevantAncestor: Accessor<boolean> = () => {
+		const { parent } = this;
+
+		return parent.hasNonRelevantAncestor() || !parent.isRelevant();
+	};
+
+	readonly isSelfRelevant: Accessor<boolean>;
+
+	readonly isRelevant: Accessor<boolean> = () => {
+		if (this.hasNonRelevantAncestor()) {
+			return false;
+		}
+
+		return this.isSelfRelevant();
+	};
+
+	readonly isRequired: Accessor<boolean>;
+
 	readonly root: Root;
 	readonly evaluator: XFormsXPathEvaluator;
 	readonly contextNode: Element;
 
 	constructor(
 		override readonly parent: DescendantNodeParent<Definition>,
-		override readonly definition: Definition
+		override readonly definition: Definition,
+		options?: DescendantNodeOptions
 	) {
-		super(parent.engineConfig, parent, definition);
+		super(parent.engineConfig, parent, definition, options);
 
 		const { evaluator, root } = parent;
 
 		this.root = root;
 		this.evaluator = evaluator;
 		this.contextNode = this.initializeContextNode(parent.contextNode, definition.nodeName);
-	}
 
-	protected computeChildStepReference(parent: DescendantNodeParent<Definition>): string {
-		return `${parent.contextReference}/${this.definition.nodeName}`;
-	}
+		const { readonly, relevant, required } = definition.bind;
 
-	protected abstract override computeReference(
-		parent: DescendantNodeParent<Definition>,
-		definition: Definition
-	): string;
-
-	protected buildSharedStateSpec(
-		parent: DescendantNodeParent<Definition>,
-		definition: Definition
-	): DescendantNodeSharedStateSpec {
-		return this.scope.runTask(() => {
-			const reference = createMemo(() => this.contextReference);
-			const { bind } = definition;
-
-			// TODO: we can likely short-circuit `readonly` computation when a node
-			// is non-relevant.
-			const selfReadonly = createComputedExpression(this, bind.readonly);
-			const readonly = createMemo(() => {
-				return parent.isReadonly || selfReadonly();
-			});
-
-			const selfRelevant = createComputedExpression(this, bind.relevant);
-			const relevant = createMemo(() => {
-				return parent.isRelevant && selfRelevant();
-			});
-
-			// TODO: we can likely short-circuit `required` computation when a node
-			// is non-relevant.
-			const required = createComputedExpression(this, bind.required);
-
-			return {
-				reference,
-				readonly,
-				relevant,
-				required,
-			};
-		});
+		this.isSelfReadonly = createComputedExpression(this, readonly);
+		this.isSelfRelevant = createComputedExpression(this, relevant);
+		this.isRequired = createComputedExpression(this, required);
 	}
 
 	protected createContextNode(parentContextNode: Element, nodeName: string): Element {