@getodk/xforms-engine 0.14.0 → 0.16.0

package/src/parse/model/RootDefinition.ts

@@ -1,8 +1,10 @@
 import type { StaticElement } from '../../integration/xpath/static-dom/StaticElement.ts';
 import { NamespaceDeclarationMap } from '../../lib/names/NamespaceDeclarationMap.ts';
 import { QualifiedName } from '../../lib/names/QualifiedName.ts';
-import type { BodyClassList } from '../body/BodyDefinition.ts';
+import type { AnyBodyElementDefinition, BodyClassList } from '../body/BodyDefinition.ts';
 import type { XFormDefinition } from '../XFormDefinition.ts';
+import { ActionDefinition } from './ActionDefinition.ts';
+import { AttributeDefinitionMap } from './AttributeDefinitionMap.ts';
 import { GroupDefinition } from './GroupDefinition.ts';
 import { LeafNodeDefinition } from './LeafNodeDefinition.ts';
 import type { ModelDefinition } from './ModelDefinition.ts';
@@ -11,7 +13,6 @@ import { NodeDefinition } from './NodeDefinition.ts';
 import { NoteNodeDefinition } from './NoteNodeDefinition.ts';
 import { RangeNodeDefinition } from './RangeNodeDefinition.ts';
 import { RepeatDefinition } from './RepeatDefinition.ts';
-import { RootAttributeMap } from './RootAttributeMap.ts';
 import type { SubmissionDefinition } from './SubmissionDefinition.ts';
 
 export class RootDefinition extends NodeDefinition<'root'> {
@@ -22,7 +23,7 @@ export class RootDefinition extends NodeDefinition<'root'> {
 	readonly parent = null;
 	readonly template: StaticElement;
 	readonly namespaceDeclarations: NamespaceDeclarationMap;
-	readonly attributes: RootAttributeMap;
+	readonly attributes: AttributeDefinitionMap;
 	readonly children: readonly ChildNodeDefinition[];
 
 	readonly isTranslated = false;
@@ -51,11 +52,24 @@ export class RootDefinition extends NodeDefinition<'root'> {
 
 		this.qualifiedName = qualifiedName;
 		this.template = template;
-		this.attributes = RootAttributeMap.from(this, template);
+		this.attributes = AttributeDefinitionMap.from(model, template);
 		this.namespaceDeclarations = new NamespaceDeclarationMap(this);
 		this.children = this.buildSubtree(this, template);
 	}
 
+	private mapActions(bodyElement: AnyBodyElementDefinition) {
+		const source = bodyElement.reference;
+		if (!source) {
+			return;
+		}
+		for (const child of bodyElement.element.children) {
+			if (child.nodeName === 'setvalue') {
+				const action = new ActionDefinition(this.model, child, source);
+				this.model.actions.add(action);
+			}
+		}
+	}
+
 	buildSubtree(parent: ParentNodeDefinition, node: StaticElement): readonly ChildNodeDefinition[] {
 		const { form, model } = this;
 		const { body } = form;
@@ -86,8 +100,12 @@ export class RootDefinition extends NodeDefinition<'root'> {
 			const bodyElement = body.getBodyElement(nodeset);
 			const [firstChild, ...restChildren] = children;
 
+			if (bodyElement) {
+				this.mapActions(bodyElement);
+			}
+
 			if (bodyElement?.type === 'repeat') {
-				return RepeatDefinition.from(parent, bind, bodyElement, children);
+				return RepeatDefinition.from(model, parent, bind, bodyElement, children);
 			}
 
 			if (restChildren.length) {
@@ -98,16 +116,16 @@ export class RootDefinition extends NodeDefinition<'root'> {
 
 			if (element.isLeafElement()) {
 				if (bodyElement?.type === 'range') {
-					return RangeNodeDefinition.from(parent, bind, bodyElement, element);
+					return RangeNodeDefinition.from(model, parent, bind, bodyElement, element);
 				}
 
 				return (
-					NoteNodeDefinition.from(parent, bind, bodyElement, element) ??
-					new LeafNodeDefinition(parent, bind, bodyElement, element)
+					NoteNodeDefinition.from(model, parent, bind, bodyElement, element) ??
+					new LeafNodeDefinition(model, parent, bind, bodyElement, element)
 				);
 			}
 
-			return new GroupDefinition(parent, bind, bodyElement, element);
+			return new GroupDefinition(model, parent, bind, bodyElement, element);
 		});
 	}
 

package/src/parse/model/nodeDefinitionMap.ts

@@ -16,7 +16,7 @@ const collectDefinitions = (
 
 	result.set(nodeset, definition);
 
-	if (definition.type === 'leaf-node') {
+	if (definition.type === 'leaf-node' || definition.type === 'attribute') {
 		return result;
 	}
 

package/dist/error/TemplatedNodeAttributeSerializationError.d.ts

@@ -1,22 +0,0 @@
-/**
- * This error class is intended as a common point of reference for all of the
- * related interfaces and implementation where we've deferred two concerns:
- *
- * 1. Support for attributes on instance nodes (which may be bound in a form's
- *    model and/or may be expected to preserve model-defined defaults)
- * 2. Present lack of logic to treat a `jr:template` attribute as a special
- *    case: whereas in the general case we would expect to pass through a
- *    form/model-defined attribute, we expect to specifically **omit**
- *    `jr:template` from repeat instances derived from any of form's
- *    explicitly-defined repeat templates
- *
- * Addressing #1 is (now) a prerequisite to addressing #2, and it is also a
- * prerequisite for #2's unaddressed status to _become meaningfully observable
- * and problematic_.
- *
- * By introducing this error at a point where a change in #1's status is likely
- * to be implicated, we're also likely to be reminded to address #2 in tandem.
- */
-export declare class TemplatedNodeAttributeSerializationError extends Error {
-    constructor();
-}

package/dist/parse/model/RootAttributeDefinition.d.ts

@@ -1,21 +0,0 @@
-import { NamedNodeDefinition } from '../../lib/names/NamespaceDeclarationMap.ts';
-import { QualifiedName } from '../../lib/names/QualifiedName.ts';
-import { RootDefinition } from './RootDefinition.ts';
-interface RootAttributeSource {
-    readonly qualifiedName: QualifiedName;
-    readonly value: string;
-}
-/**
- * @todo This class is named and typed to emphasize its intentionally narrow
- * usage and purpose. It **intentionally** avoids addressing the much broader
- * set of concerns around modeling attributes in primary instance/submissions.
- */
-export declare class RootAttributeDefinition implements NamedNodeDefinition {
-    private readonly serializedXML;
-    readonly parent: RootDefinition;
-    readonly qualifiedName: QualifiedName;
-    readonly value: string;
-    constructor(root: RootDefinition, source: RootAttributeSource);
-    serializeAttributeXML(): string;
-}
-export {};

package/src/error/TemplatedNodeAttributeSerializationError.ts

@@ -1,24 +0,0 @@
-/**
- * This error class is intended as a common point of reference for all of the
- * related interfaces and implementation where we've deferred two concerns:
- *
- * 1. Support for attributes on instance nodes (which may be bound in a form's
- *    model and/or may be expected to preserve model-defined defaults)
- * 2. Present lack of logic to treat a `jr:template` attribute as a special
- *    case: whereas in the general case we would expect to pass through a
- *    form/model-defined attribute, we expect to specifically **omit**
- *    `jr:template` from repeat instances derived from any of form's
- *    explicitly-defined repeat templates
- *
- * Addressing #1 is (now) a prerequisite to addressing #2, and it is also a
- * prerequisite for #2's unaddressed status to _become meaningfully observable
- * and problematic_.
- *
- * By introducing this error at a point where a change in #1's status is likely
- * to be implicated, we're also likely to be reminded to address #2 in tandem.
- */
-export class TemplatedNodeAttributeSerializationError extends Error {
-	constructor() {
-		super('Template attribute omission not implemented');
-	}
-}

package/src/parse/model/RootAttributeDefinition.ts

@@ -1,44 +0,0 @@
-import { XMLNS_NAMESPACE_URI } from '@getodk/common/constants/xmlns.ts';
-import type { NamedNodeDefinition } from '../../lib/names/NamespaceDeclarationMap.ts';
-import { QualifiedName } from '../../lib/names/QualifiedName.ts';
-import { escapeXMLText } from '../../lib/xml-serialization.ts';
-import type { RootDefinition } from './RootDefinition.ts';
-
-interface RootAttributeSource {
-	readonly qualifiedName: QualifiedName;
-	readonly value: string;
-}
-
-/**
- * @todo This class is named and typed to emphasize its intentionally narrow
- * usage and purpose. It **intentionally** avoids addressing the much broader
- * set of concerns around modeling attributes in primary instance/submissions.
- */
-export class RootAttributeDefinition implements NamedNodeDefinition {
-	private readonly serializedXML: string;
-
-	readonly parent: RootDefinition;
-	readonly qualifiedName: QualifiedName;
-	readonly value: string;
-
-	constructor(root: RootDefinition, source: RootAttributeSource) {
-		const { qualifiedName, value } = source;
-
-		this.parent = root;
-		this.qualifiedName = qualifiedName;
-		this.value = value;
-
-		// We serialize namespace declarations separately
-		if (qualifiedName.namespaceURI?.href === XMLNS_NAMESPACE_URI) {
-			this.serializedXML = '';
-		} else {
-			const nodeName = qualifiedName.getPrefixedName();
-
-			this.serializedXML = ` ${nodeName}="${escapeXMLText(value, true)}"`;
-		}
-	}
-
-	serializeAttributeXML(): string {
-		return this.serializedXML;
-	}
-}