@getodk/xforms-engine 0.15.0 → 0.16.0

package/src/instance/Root.ts

@@ -12,10 +12,7 @@ import type { InstanceState } from '../client/serialization/InstanceState.ts';
 import type { AncestorNodeValidationState } from '../client/validation.ts';
 import type { XFormsXPathElement } from '../integration/xpath/adapter/XFormsXPathNode.ts';
 import { createRootInstanceState } from '../lib/client-reactivity/instance-state/createRootInstanceState.ts';
-import {
-	createAttributeState,
-	type AttributeState,
-} from '../lib/reactivity/createAttributeState.ts';
+import { createAttributeState } from '../lib/reactivity/createAttributeState.ts';
 import type { ChildrenState } from '../lib/reactivity/createChildrenState.ts';
 import { createChildrenState } from '../lib/reactivity/createChildrenState.ts';
 import type { MaterializedChildren } from '../lib/reactivity/materializeCurrentStateChildren.ts';
@@ -63,7 +60,6 @@ export class Root
 		ClientReactiveSerializableParentNode<GeneralChildNode>
 {
 	private readonly childrenState: ChildrenState<GeneralChildNode>;
-	private readonly attributeState: AttributeState;
 
 	// XFormsXPathElement
 	override readonly [XPathNodeKindKey] = 'element';
@@ -106,7 +102,6 @@ export class Root
 		const attributeState = createAttributeState(this.scope);
 
 		this.childrenState = childrenState;
-		this.attributeState = attributeState;
 		this.languages = parent.languages;
 
 		const state = createSharedNodeState(
@@ -145,10 +140,6 @@ export class Root
 		return this.childrenState.getChildren();
 	}
 
-	getAttributes(): readonly Attribute[] {
-		return this.attributeState.getAttributes();
-	}
-
 	// RootNode
 	setLanguage(language: FormLanguage): Root {
 		this.rootDocument.setLanguage(language);

package/src/instance/SelectControl.ts

@@ -14,6 +14,7 @@ import { SelectValueTypeError } from '../error/SelectValueTypeError.ts';
 import type { XFormsXPathElement } from '../integration/xpath/adapter/XFormsXPathNode.ts';
 import type { StaticLeafElement } from '../integration/xpath/static-dom/StaticElement.ts';
 import { getSelectCodec } from '../lib/codecs/getSelectCodec.ts';
+import { createAttributeState } from '../lib/reactivity/createAttributeState.ts';
 import { createItemCollection } from '../lib/reactivity/createItemCollection.ts';
 import type { CurrentState } from '../lib/reactivity/node-state/createCurrentState.ts';
 import type { EngineState } from '../lib/reactivity/node-state/createEngineState.ts';
@@ -26,6 +27,7 @@ import type { SelectType } from '../parse/body/control/SelectControlDefinition.t
 import type { Root } from './Root.ts';
 import type { ValueNodeStateSpec } from './abstract/ValueNode.ts';
 import { ValueNode } from './abstract/ValueNode.ts';
+import { buildAttributes } from './attachments/buildAttributes.ts';
 import type { GeneralParentNode } from './hierarchy.ts';
 import type { EvaluationContext } from './internal-api/EvaluationContext.ts';
 import type { ValidationContext } from './internal-api/ValidationContext.ts';
@@ -108,6 +110,7 @@ export class SelectControl
 
 		this.appearances = definition.bodyElement.appearances;
 		this.selectType = definition.bodyElement.type;
+		const attributeState = createAttributeState(this.scope);
 
 		const valueOptions = createItemCollection(this);
 
@@ -153,7 +156,7 @@ export class SelectControl
 				label: createNodeLabel(this, definition),
 				hint: createFieldHint(this, definition),
 				children: null,
-				attributes: null,
+				attributes: attributeState.getAttributes,
 				valueOptions,
 				value: valueState,
 				instanceValue: this.getInstanceValue,
@@ -162,6 +165,8 @@ export class SelectControl
 			this.instanceConfig
 		);
 
+		attributeState.setAttributes(buildAttributes(this));
+
 		this.state = state;
 		this.engineState = state.engineState;
 		this.currentState = state.currentState;

package/src/instance/TriggerControl.ts

@@ -8,6 +8,7 @@ import type { XFormsXPathElement } from '../integration/xpath/adapter/XFormsXPat
 import type { StaticLeafElement } from '../integration/xpath/static-dom/StaticElement.ts';
 import type { TriggerInputValue, TriggerRuntimeValue } from '../lib/codecs/TriggerCodec.ts';
 import { TriggerCodec } from '../lib/codecs/TriggerCodec.ts';
+import { createAttributeState } from '../lib/reactivity/createAttributeState.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';
@@ -17,6 +18,7 @@ import { createNodeLabel } from '../lib/reactivity/text/createNodeLabel.ts';
 import type { UnknownAppearanceDefinition } from '../parse/body/appearance/unknownAppearanceParser.ts';
 import type { Root } from './Root.ts';
 import { ValueNode, type ValueNodeStateSpec } from './abstract/ValueNode.ts';
+import { buildAttributes } from './attachments/buildAttributes.ts';
 import type { GeneralParentNode } from './hierarchy.ts';
 import type { EvaluationContext } from './internal-api/EvaluationContext.ts';
 import type { ValidationContext } from './internal-api/ValidationContext.ts';
@@ -88,6 +90,7 @@ export class TriggerControl
 		super(parent, instanceNode, definition, codec);
 
 		this.appearances = definition.bodyElement.appearances;
+		const attributeState = createAttributeState(this.scope);
 
 		const state = createSharedNodeState(
 			this.scope,
@@ -100,7 +103,7 @@ export class TriggerControl
 				label: createNodeLabel(this, definition),
 				hint: createFieldHint(this, definition),
 				children: null,
-				attributes: null,
+				attributes: attributeState.getAttributes,
 				valueOptions: null,
 				value: this.valueState,
 				instanceValue: this.getInstanceValue,
@@ -108,6 +111,8 @@ export class TriggerControl
 			this.instanceConfig
 		);
 
+		attributeState.setAttributes(buildAttributes(this));
+
 		this.state = state;
 		this.engineState = state.engineState;
 		this.currentState = state.currentState;

package/src/instance/UploadControl.ts

@@ -9,10 +9,7 @@ import { UploadValueTypeError } from '../error/UploadValueTypeError.ts';
 import type { XFormsXPathElement } from '../integration/xpath/adapter/XFormsXPathNode.ts';
 import type { StaticLeafElement } from '../integration/xpath/static-dom/StaticElement.ts';
 import { createValueNodeInstanceState } from '../lib/client-reactivity/instance-state/createValueNodeInstanceState.ts';
-import {
-	createAttributeState,
-	type AttributeState,
-} from '../lib/reactivity/createAttributeState.ts';
+import { createAttributeState } from '../lib/reactivity/createAttributeState.ts';
 import { createInstanceAttachment } from '../lib/reactivity/createInstanceAttachment.ts';
 import type { CurrentState } from '../lib/reactivity/node-state/createCurrentState.ts';
 import type { EngineState } from '../lib/reactivity/node-state/createEngineState.ts';
@@ -101,7 +98,6 @@ export class UploadControl
 
 	private readonly validation: SharedValidationState;
 	private readonly instanceAttachment: InstanceAttachment;
-	private readonly attributeState: AttributeState;
 
 	// XFormsXPathElement
 	override readonly [XPathNodeKindKey] = 'element';
@@ -141,7 +137,6 @@ export class UploadControl
 
 		this.instanceAttachment = instanceAttachment;
 		const attributeState = createAttributeState(this.scope);
-		this.attributeState = attributeState;
 		this.decodeInstanceValue = instanceAttachment.decodeInstanceValue;
 		this.getXPathValue = instanceAttachment.getInstanceValue;
 
@@ -191,8 +186,4 @@ export class UploadControl
 
 		return this.root;
 	}
-
-	getAttributes(): readonly Attribute[] {
-		return this.attributeState.getAttributes();
-	}
 }

package/src/instance/abstract/DescendantNode.ts

@@ -167,11 +167,6 @@ export abstract class DescendantNode<
 						return true;
 					}
 				}
-				for (const attr of parent.getAttributes()) {
-					if (attr === self) {
-						return true;
-					}
-				}
 				return false;
 			});
 		});

package/src/instance/abstract/InstanceNode.ts

@@ -240,13 +240,13 @@ export abstract class InstanceNode<
 	 * (though for those nodes it will always be empty). This affords consistency
 	 * and efficiency of interface for those internal uses.
 	 */
-	abstract getChildren(this: AnyInstanceNode): ReadonlyArray<Exclude<AnyChildNode, Attribute>>;
+	abstract getChildren(this: AnyInstanceNode): readonly AnyChildNode[];
 
 	// XFormsXPathNode
 	/**
 	 * @todo Values as text nodes(?)
 	 */
-	getXPathChildNodes(): ReadonlyArray<Exclude<AnyChildNode, Attribute>> {
+	getXPathChildNodes(): readonly AnyChildNode[] {
 		return (this as AnyInstanceNode).getChildren().flatMap((child) => {
 			switch (child.nodeType) {
 				case 'repeat-range:controlled':

package/src/instance/abstract/ValueNode.ts

@@ -21,6 +21,7 @@ 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 { LeafNodeDefinition } from '../../parse/model/LeafNodeDefinition.ts';
+import type { Attribute } from '../Attribute.ts';
 import type { GeneralParentNode } from '../hierarchy.ts';
 import type { EvaluationContext } from '../internal-api/EvaluationContext.ts';
 import type {
@@ -36,7 +37,7 @@ export type ValueNodeDefinition<V extends ValueType> = LeafNodeDefinition<V>;
 
 export interface ValueNodeStateSpec<RuntimeValue> extends DescendantNodeStateSpec<RuntimeValue> {
 	readonly children: null;
-	readonly attributes: null;
+	readonly attributes: Accessor<readonly Attribute[]>;
 	readonly value: SimpleAtomicState<RuntimeValue>;
 	readonly instanceValue: Accessor<string>;
 }

package/src/instance/attachments/buildAttributes.ts

@@ -1,8 +1,15 @@
 import { Attribute } from '../Attribute';
-import type { AnyParentNode } from '../hierarchy';
+import type { AnyNode } from '../hierarchy.ts';
+import type { InputControl } from '../InputControl.ts';
+import type { ModelValue } from '../ModelValue.ts';
+import type { Note } from '../Note.ts';
+import type { RangeControl } from '../RangeControl.ts';
 
-export function buildAttributes(parent: AnyParentNode): Attribute[] {
-	return Array.from(parent.definition.attributes.values()).map((attributeDefinition) => {
-		return new Attribute(parent, attributeDefinition, attributeDefinition.template);
+export function buildAttributes(
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any
+	owner: AnyNode | InputControl<any> | ModelValue<any> | Note<any> | RangeControl<any>
+): Attribute[] {
+	return Array.from(owner.definition.attributes.values()).map((attributeDefinition) => {
+		return new Attribute(owner, attributeDefinition, attributeDefinition.template);
 	});
 }

package/src/instance/children/normalizeChildInitOptions.ts

@@ -217,7 +217,7 @@ const buildDeprecatedIDDefinition = (
 	const nodeset = instanceNode.nodeset;
 	const bind = group.model.binds.getOrCreateBindDefinition(nodeset);
 
-	return new LeafNodeDefinition(group.parent.definition, bind, null, instanceNode);
+	return new LeafNodeDefinition(group.model, group.parent.definition, bind, null, instanceNode);
 };
 
 const buildDeprecatedID = (

package/src/instance/hierarchy.ts

@@ -1,4 +1,3 @@
-import type { Attribute } from './Attribute.ts';
 import type { Group } from './Group.ts';
 import type { AnyInputControl } from './InputControl.ts';
 import type { AnyModelValue } from './ModelValue.ts';
@@ -63,8 +62,7 @@ export type AnyChildNode =
 	| RankControl
 	| SelectControl
 	| TriggerControl
-	| UploadControl
-	| Attribute;
+	| UploadControl;
 
 // prettier-ignore
 export type GeneralChildNode =

package/src/instance/internal-api/AttributeContext.ts

@@ -1,12 +1,16 @@
+import type { Accessor } from 'solid-js';
 import type { FormInstanceInitializationMode } from '../../client/index.ts';
 import type { StaticAttribute } from '../../integration/xpath/static-dom/StaticAttribute.ts';
 import type { ReactiveScope } from '../../lib/reactivity/scope.ts';
 import type { BindComputationExpression } from '../../parse/expression/BindComputationExpression.ts';
 import type { AnyBindPreloadDefinition } from '../../parse/model/BindPreloadDefinition.ts';
+import type { ModelDefinition } from '../../parse/model/ModelDefinition.ts';
 import type { EvaluationContext } from './EvaluationContext.ts';
+import type { InstanceConfig } from './InstanceConfig.ts';
 
 export interface InstanceAttributeContextDocument {
 	readonly initializationMode: FormInstanceInitializationMode;
+	readonly isAttached: Accessor<boolean>;
 }
 
 export type DecodeInstanceValue = (value: string) => string;
@@ -20,6 +24,7 @@ interface InstanceAttributeContextDefinitionBind {
 export interface InstanceAttributeContextDefinition {
 	readonly bind: InstanceAttributeContextDefinitionBind;
 	readonly template: StaticAttribute;
+	readonly model: ModelDefinition;
 }
 
 export interface AttributeContext extends EvaluationContext {
@@ -27,6 +32,7 @@ export interface AttributeContext extends EvaluationContext {
 	readonly rootDocument: InstanceAttributeContextDocument;
 	readonly definition: InstanceAttributeContextDefinition;
 	readonly instanceNode: StaticAttribute;
+	readonly instanceConfig: InstanceConfig;
 	readonly decodeInstanceValue: DecodeInstanceValue;
 
 	isReadonly(): boolean;

package/src/instance/internal-api/InstanceConfig.ts

@@ -1,5 +1,8 @@
 import type { InstanceAttachmentFileNameFactory } from '../../client/attachments/InstanceAttachmentsConfig.ts';
-import type { FormInstanceConfig } from '../../client/form/FormInstanceConfig.ts';
+import type {
+	FormInstanceConfig,
+	PreloadProperties,
+} from '../../client/form/FormInstanceConfig.ts';
 import type { OpaqueReactiveObjectFactory } from '../../client/OpaqueReactiveObjectFactory.ts';
 
 export interface InstanceConfig {
@@ -9,4 +12,6 @@ export interface InstanceConfig {
 	readonly clientStateFactory: OpaqueReactiveObjectFactory;
 
 	readonly computeAttachmentName: InstanceAttachmentFileNameFactory;
+
+	readonly preloadProperties: PreloadProperties;
 }

package/src/instance/internal-api/InstanceValueContext.ts

@@ -1,12 +1,16 @@
+import type { Accessor } from 'solid-js';
 import type { FormInstanceInitializationMode } from '../../client/index.ts';
 import type { StaticLeafElement } from '../../integration/xpath/static-dom/StaticElement.ts';
 import type { ReactiveScope } from '../../lib/reactivity/scope.ts';
 import type { BindComputationExpression } from '../../parse/expression/BindComputationExpression.ts';
 import type { AnyBindPreloadDefinition } from '../../parse/model/BindPreloadDefinition.ts';
+import type { ModelDefinition } from '../../parse/model/ModelDefinition.ts';
 import type { EvaluationContext } from './EvaluationContext.ts';
+import type { InstanceConfig } from './InstanceConfig.ts';
 
 export interface InstanceValueContextDocument {
 	readonly initializationMode: FormInstanceInitializationMode;
+	readonly isAttached: Accessor<boolean>;
 }
 
 export type DecodeInstanceValue = (value: string) => string;
@@ -20,6 +24,7 @@ interface InstanceValueContextDefinitionBind {
 export interface InstanceValueContextDefinition {
 	readonly bind: InstanceValueContextDefinitionBind;
 	readonly template: StaticLeafElement;
+	readonly model: ModelDefinition;
 }
 
 export interface InstanceValueContext extends EvaluationContext {
@@ -27,6 +32,7 @@ export interface InstanceValueContext extends EvaluationContext {
 	readonly rootDocument: InstanceValueContextDocument;
 	readonly definition: InstanceValueContextDefinition;
 	readonly instanceNode: StaticLeafElement | null;
+	readonly instanceConfig: InstanceConfig;
 	readonly decodeInstanceValue: DecodeInstanceValue;
 
 	isReadonly(): boolean;

package/src/instance/internal-api/serialization/ClientReactiveSerializableAttributeNode.ts

@@ -4,7 +4,6 @@ import type { QualifiedName } from '../../../lib/names/QualifiedName.ts';
 export type SerializedInstanceValue = string;
 
 interface ClientReactiveSerializableAttributeNodeCurrentState {
-	get relevant(): boolean;
 	get instanceValue(): SerializedInstanceValue;
 }
 

package/src/instance/internal-api/serialization/ClientReactiveSerializableValueNode.ts

@@ -1,5 +1,7 @@
 import type { InstanceState } from '../../../client/serialization/InstanceState.ts';
 import type { QualifiedName } from '../../../lib/names/QualifiedName.ts';
+import type { BindDefinition } from '../../../parse/model/BindDefinition.ts';
+import type { Attribute } from '../../Attribute.ts';
 import type {
 	ClientReactiveSerializableChildNode,
 	ClientReactiveSerializableParentNode,
@@ -14,10 +16,12 @@ interface ClientReactiveSerializableValueNodeCurrentState {
 	 * @todo Consider moving into {@link InstanceState}
 	 */
 	get instanceValue(): SerializedInstanceValue;
+	get attributes(): readonly Attribute[];
 }
 
 interface ClientReactiveSerializableValueNodeDefinition {
 	readonly qualifiedName: QualifiedName;
+	readonly bind: BindDefinition;
 }
 
 export interface ClientReactiveSerializableValueNode {

package/src/instance/repeat/RepeatInstance.ts

@@ -13,10 +13,7 @@ import type { AncestorNodeValidationState } from '../../client/validation.ts';
 import type { XFormsXPathElement } from '../../integration/xpath/adapter/XFormsXPathNode.ts';
 import type { StaticElement } from '../../integration/xpath/static-dom/StaticElement.ts';
 import { createTemplatedNodeInstanceState } from '../../lib/client-reactivity/instance-state/createTemplatedNodeInstanceState.ts';
-import {
-	createAttributeState,
-	type AttributeState,
-} from '../../lib/reactivity/createAttributeState.ts';
+import { createAttributeState } from '../../lib/reactivity/createAttributeState.ts';
 import type { ChildrenState } from '../../lib/reactivity/createChildrenState.ts';
 import { createChildrenState } from '../../lib/reactivity/createChildrenState.ts';
 import type { MaterializedChildren } from '../../lib/reactivity/materializeCurrentStateChildren.ts';
@@ -63,7 +60,6 @@ export class RepeatInstance
 		ClientReactiveSerializableTemplatedNode
 {
 	private readonly childrenState: ChildrenState<GeneralChildNode>;
-	private readonly attributeState: AttributeState;
 	private readonly currentIndex: Accessor<number>;
 
 	override readonly [XPathNodeKindKey] = 'element';
@@ -138,7 +134,6 @@ export class RepeatInstance
 		const attributeState = createAttributeState(this.scope);
 
 		this.childrenState = childrenState;
-		this.attributeState = attributeState;
 		this.currentIndex = currentIndex;
 
 		const state = createSharedNodeState(
@@ -197,8 +192,4 @@ export class RepeatInstance
 	getChildren(): readonly GeneralChildNode[] {
 		return this.childrenState.getChildren();
 	}
-
-	getAttributes(): readonly Attribute[] {
-		return this.attributeState.getAttributes();
-	}
 }

package/src/lib/client-reactivity/instance-state/createValueNodeInstanceState.ts

@@ -14,8 +14,9 @@ export const createValueNodeInstanceState = (
 			}
 
 			const xmlValue = escapeXMLText(node.currentState.instanceValue);
+			const attributes = node.currentState.attributes;
 
-			return serializeLeafElementXML(qualifiedName, xmlValue);
+			return serializeLeafElementXML(qualifiedName, xmlValue, attributes);
 		},
 	};
 };

package/src/lib/client-reactivity/instance-state/prepareInstancePayload.ts

@@ -208,6 +208,7 @@ export const prepareInstancePayload = <PayloadType extends InstancePayloadType>(
 	instanceRoot: ClientReactiveSerializableInstance,
 	options: PrepareInstancePayloadOptions<PayloadType>
 ): InstancePayload<PayloadType> => {
+	instanceRoot.root.parent.model.triggerXformsRevalidateListeners();
 	const validation = validateInstance(instanceRoot);
 	const submissionMeta = instanceRoot.definition.submission;
 	const instanceFile = new InstanceFile(instanceRoot);

package/src/lib/codecs/NoteCodec.ts

@@ -10,7 +10,7 @@ export type NoteRuntimeValue<V extends ValueType> =
 // prettier-ignore
 export type NoteInputValue<V extends ValueType> =
 	| RuntimeInputValue<V>
-	| RuntimeValue<V>
+	| RuntimeValue<V> // eslint-disable-line @typescript-eslint/no-redundant-type-constituents
 	| null;
 
 export class NoteCodec<V extends ValueType> extends ValueCodec<

package/src/lib/codecs/items/SingleValueItemCodec.ts

@@ -12,9 +12,7 @@ export type SingleValueSelectRuntimeValues =
  * @see {@link encodeValueFactory}
  */
 // prettier-ignore
-type SingleValueSelectCodecValues =
-	| SingleValueSelectRuntimeValues
-	| readonly string[];
+type SingleValueSelectCodecValues = readonly string[];
 
 /**
  * @todo This is more permissive than it should be, allowing an array of any