@getodk/xforms-engine 0.1.1 → 0.2.0

package/src/model/RepeatTemplateDefinition.ts

@@ -1,9 +1,9 @@
 import { JAVAROSA_NAMESPACE_URI } from '@getodk/common/constants/xmlns.ts';
-import type { RepeatDefinition } from '../body/RepeatDefinition.ts';
+import type { RepeatElementDefinition } from '../body/RepeatElementDefinition.ts';
 import { BindDefinition } from './BindDefinition.ts';
 import { DescendentNodeDefinition } from './DescendentNodeDefinition.ts';
 import type { ChildNodeDefinition, NodeDefinition } from './NodeDefinition.ts';
-import type { RepeatSequenceDefinition } from './RepeatSequenceDefinition.ts';
+import type { RepeatRangeDefinition } from './RepeatRangeDefinition.ts';
 
 const repeatTemplates = new WeakMap<BindDefinition, RepeatTemplateDefinition>();
 
@@ -73,14 +73,14 @@ interface ParsedRepeatNodes {
 }
 
 export class RepeatTemplateDefinition
-	extends DescendentNodeDefinition<'repeat-template', RepeatDefinition>
+	extends DescendentNodeDefinition<'repeat-template', RepeatElementDefinition>
 	implements NodeDefinition<'repeat-template'>
 {
 	static parseModelNodes(
-		sequence: RepeatSequenceDefinition,
+		range: RepeatRangeDefinition,
 		modelNodes: readonly [Element, ...Element[]]
 	): ParsedRepeatNodes {
-		const { bind } = sequence;
+		const { bind } = range;
 
 		let template = repeatTemplates.get(bind);
 		let instanceNodes: readonly Element[];
@@ -89,7 +89,7 @@ export class RepeatTemplateDefinition
 			const [templateNode, ...rest] = splitInstanceNodes(modelNodes);
 
 			instanceNodes = rest;
-			template = new this(sequence, templateNode);
+			template = new this(range, templateNode);
 		} else {
 			// TODO: this is under the assumption that for any depth > 1, if a
 			// template has already been defined for the given form definition, any
@@ -121,17 +121,12 @@ export class RepeatTemplateDefinition
 	readonly defaultValue = null;
 
 	protected constructor(
-		protected readonly sequence: RepeatSequenceDefinition,
+		range: RepeatRangeDefinition,
 		protected readonly templateNode: ExplicitRepeatTemplateElement
 	) {
-		const {
-			bind,
-			bodyElement: repeatGroupBodyElement,
-			parent: repeatSequenceParent,
-			root,
-		} = sequence;
+		const { bind, bodyElement, parent, root } = range;
 
-		super(repeatSequenceParent, bind, repeatGroupBodyElement.repeat);
+		super(parent, bind, bodyElement);
 
 		const node = templateNode.cloneNode(true) as Element;
 
@@ -143,7 +138,7 @@ export class RepeatTemplateDefinition
 	}
 
 	toJSON() {
-		const { bind, bodyElement, parent, root, sequence, ...rest } = this;
+		const { bind, bodyElement, parent, root, ...rest } = this;
 
 		return rest;
 	}

package/src/model/RootDefinition.ts

@@ -1,5 +1,5 @@
 import type { XFormDefinition } from '../XFormDefinition.ts';
-import type { RepeatGroupDefinition } from '../body/group/RepeatGroupDefinition.ts';
+import type { BodyClassList } from '../body/BodyDefinition.ts';
 import type { BindDefinition } from './BindDefinition.ts';
 import type { ModelDefinition } from './ModelDefinition.ts';
 import type {
@@ -7,7 +7,7 @@ import type {
 	NodeDefinition,
 	ParentNodeDefinition,
 } from './NodeDefinition.ts';
-import { RepeatSequenceDefinition } from './RepeatSequenceDefinition.ts';
+import { RepeatRangeDefinition } from './RepeatRangeDefinition.ts';
 import { SubtreeDefinition } from './SubtreeDefinition.ts';
 import { ValueNodeDefinition } from './ValueNodeDefinition.ts';
 
@@ -29,7 +29,8 @@ export class RootDefinition implements NodeDefinition<'root'> {
 
 	constructor(
 		protected readonly form: XFormDefinition,
-		protected readonly model: ModelDefinition
+		protected readonly model: ModelDefinition,
+		readonly classes: BodyClassList
 	) {
 		// TODO: theoretically the pertinent step in the bind's `nodeset` *could* be
 		// namespaced. It also may make more sense to determine the root nodeset
@@ -86,16 +87,9 @@ export class RootDefinition implements NodeDefinition<'root'> {
 			const bind = binds.getOrCreateBindDefinition(nodeset);
 			const bodyElement = body.getBodyElement(nodeset);
 			const [firstChild, ...restChildren] = children;
-			const repeatGroup = body.getRepeatGroup(nodeset);
 
-			if (repeatGroup != null) {
-				const repeatDefinition = (bodyElement as RepeatGroupDefinition).repeat;
-
-				if (repeatDefinition == null) {
-					throw 'TODO: this is why I have hesitated to pick an "is repeat" predicate direction';
-				}
-
-				return new RepeatSequenceDefinition(parent, bind, repeatGroup, children);
+			if (bodyElement?.type === 'repeat') {
+				return new RepeatRangeDefinition(parent, bind, bodyElement, children);
 			}
 
 			if (restChildren.length) {

package/src/model/SubtreeDefinition.ts

@@ -1,6 +1,6 @@
 import type {
 	AnyBodyElementDefinition,
-	NonRepeatGroupElementDefinition,
+	AnyGroupElementDefinition,
 } from '../body/BodyDefinition.ts';
 import type { BindDefinition } from './BindDefinition.ts';
 import { DescendentNodeDefinition } from './DescendentNodeDefinition.ts';
@@ -11,7 +11,7 @@ import type {
 } from './NodeDefinition.ts';
 
 export class SubtreeDefinition
-	extends DescendentNodeDefinition<'subtree', NonRepeatGroupElementDefinition | null>
+	extends DescendentNodeDefinition<'subtree', AnyGroupElementDefinition | null>
 	implements NodeDefinition<'subtree'>
 {
 	readonly type = 'subtree';
@@ -29,7 +29,7 @@ export class SubtreeDefinition
 	) {
 		if (
 			bodyElement != null &&
-			(bodyElement.category !== 'structure' || bodyElement.type === 'repeat-group')
+			(bodyElement.category !== 'structure' || bodyElement.type === 'repeat')
 		) {
 			throw new Error(`Unexpected body element for nodeset ${bind.nodeset}`);
 		}

package/src/model/ValueNodeDefinition.ts

@@ -1,11 +1,10 @@
-import type { AnyBodyElementDefinition } from '../body/BodyDefinition.ts';
-import type { AnyControlDefinition } from '../body/control/ControlDefinition.ts';
+import type { AnyBodyElementDefinition, ControlElementDefinition } from '../body/BodyDefinition.ts';
 import type { BindDefinition } from './BindDefinition.ts';
 import { DescendentNodeDefinition } from './DescendentNodeDefinition.ts';
 import type { NodeDefinition, ParentNodeDefinition } from './NodeDefinition.ts';
 
 export class ValueNodeDefinition
-	extends DescendentNodeDefinition<'value-node', AnyControlDefinition | null>
+	extends DescendentNodeDefinition<'value-node', ControlElementDefinition | null>
 	implements NodeDefinition<'value-node'>
 {
 	readonly type = 'value-node';

package/dist/body/RepeatDefinition.d.ts

@@ -1,16 +0,0 @@
-import { XFormDefinition } from '../XFormDefinition.ts';
-import { BodyElementDefinitionArray } from './BodyDefinition.ts';
-import { BodyElementDefinition } from './BodyElementDefinition.ts';
-import { RepeatGroupDefinition } from './group/RepeatGroupDefinition.ts';
-
-export declare class RepeatDefinition extends BodyElementDefinition<'repeat'> {
-    readonly groupDefinition: RepeatGroupDefinition;
-    readonly category = "structure";
-    readonly type = "repeat";
-    readonly reference: string;
-    readonly countExpression: string | null;
-    readonly isFixedCount: boolean;
-    readonly children: BodyElementDefinitionArray;
-    constructor(form: XFormDefinition, groupDefinition: RepeatGroupDefinition, element: Element);
-    toJSON(): Omit<this, "toJSON" | "form" | "parent" | "isTranslated" | "registerDependentExpression" | "dependencyExpressions" | "groupDefinition">;
-}

package/dist/body/group/RepeatGroupDefinition.d.ts

@@ -1,13 +0,0 @@
-import { XFormDefinition } from '../../XFormDefinition.ts';
-import { BodyElementDefinitionArray, BodyElementParentContext } from '../BodyDefinition.ts';
-import { RepeatDefinition } from '../RepeatDefinition.ts';
-import { BaseGroupDefinition } from './BaseGroupDefinition.ts';
-
-export declare class RepeatGroupDefinition extends BaseGroupDefinition<'repeat-group'> {
-    static isCompatible(localName: string, element: Element): boolean;
-    readonly type = "repeat-group";
-    readonly repeat: RepeatDefinition;
-    get repeatChildren(): BodyElementDefinitionArray;
-    constructor(form: XFormDefinition, parent: BodyElementParentContext, element: Element);
-}
-export type RepeatGroupDefinitionClass = typeof RepeatGroupDefinition;

package/src/body/RepeatDefinition.ts

@@ -1,54 +0,0 @@
-import { JAVAROSA_NAMESPACE_URI } from '@getodk/common/constants/xmlns.ts';
-import type { XFormDefinition } from '../XFormDefinition.ts';
-import type { BodyElementDefinitionArray } from './BodyDefinition.ts';
-import { BodyElementDefinition } from './BodyElementDefinition.ts';
-import type { RepeatGroupDefinition } from './group/RepeatGroupDefinition.ts';
-
-export class RepeatDefinition extends BodyElementDefinition<'repeat'> {
-	override readonly category = 'structure';
-	readonly type = 'repeat';
-	override readonly reference: string;
-
-	// TODO: this will fall into the growing category of non-`BindExpression`
-	// cases which have roughly the same design story.
-	readonly countExpression: string | null;
-
-	readonly isFixedCount: boolean;
-
-	readonly children: BodyElementDefinitionArray;
-
-	constructor(
-		form: XFormDefinition,
-		readonly groupDefinition: RepeatGroupDefinition,
-		element: Element
-	) {
-		super(form, groupDefinition, element);
-
-		const reference = element.getAttribute('nodeset');
-
-		if (reference == null) {
-			throw new Error('Invalid repeat: missing `nodeset` reference');
-		}
-
-		this.reference = reference;
-		this.countExpression = element.getAttributeNS(JAVAROSA_NAMESPACE_URI, 'count');
-		this.children = groupDefinition.getChildren(element);
-
-		// Spec says this can be either `true()` or `false()`. That said, it
-		// could also presumably be `true ( )` or whatever.
-		const noAddRemove =
-			element
-				.getAttributeNS(JAVAROSA_NAMESPACE_URI, 'noAddRemove')
-				?.trim()
-				.replaceAll(/\s+/g, '') ?? 'false()';
-
-		// TODO: **probably** safe to disregard anything else?
-		this.isFixedCount = noAddRemove === 'true()';
-	}
-
-	override toJSON() {
-		const { form, groupDefinition, parent, ...rest } = this;
-
-		return rest;
-	}
-}

package/src/body/group/RepeatGroupDefinition.ts

@@ -1,91 +0,0 @@
-import { getRepeatElement } from '../../lib/dom/query.ts';
-import type { XFormDefinition } from '../../XFormDefinition.ts';
-import type { BodyElementDefinitionArray, BodyElementParentContext } from '../BodyDefinition.ts';
-import { RepeatDefinition } from '../RepeatDefinition.ts';
-import { BaseGroupDefinition } from './BaseGroupDefinition.ts';
-
-/**
- * TODO: The `RepeatGroupDefinition`/`RepeatDefinition` types are currently
- * expected to always pair, mirroring the corresponding XForm structure, e.g.
- *
- * ```xml
- * <group ref="/root/rep"> <!-- RepeatGroupDefinition -->
- *   <repeat nodeset="/root/rep" /> <!-- RepeatDefinition -->
- * </group>
- * ```
- *
- * This structure has already been a source of one bug (where a recursive walk
- * through a `BodyDefinition`'s descendants failed to reach the children of
- * `RepeatDefinition`s). It seems likely this will continue to be a footgun.
- * After some discussion with @lognaturel, I concluded that the pairing isn't
- * strictly necessary, as this should be considered invalid:
- *
- * ```xml
- * <group ref="/root/rep">
- *   <repeat nodeset="/root/rep" />
- *   <input ref="/root/rep/not-a-repeat-child" />
- * </group>
- * ```
- *
- * It **may** make sense to collapse these types in the future, but I've held
- * off, following another discussion with @lognaturel. There's some potential
- * for group/repeat labeling ambiguity.
- *
- * - The current design accommodates sharing a repeat-containing group's label
- *   across multiple repeat instances, but
- * - The
- *   {@link https://github.com/getodk/xforms-spec/blob/791753a09fabd3d64d8cb95776dc0cef71fa4446/_sections/60-repeats.md?plain=1#L46 | ODK XForms spec suggests}
- *   a repeat's first group might be a better candidate
- *
- * Example of such a structure:
- *
- * ```xml
- * <group ref="/root/foo">
- *   <label>Foo (outer label)</label>
- *   <repeat nodeset="/root/foo">
- *     <group>
- *       <label>Foo (inner label)</label>
- *       <!-- ... -->
- *     </group>
- *   </repeat>
- * </group>
- * ```
- */
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore - All this so I could attach a JSDoc comment to something other
-// than the actual class...
-// eslint-disable-next-line @typescript-eslint/no-empty-interface, @typescript-eslint/no-unused-vars
-interface IgnoreMeIAmJustHereForTheJSDoc {}
-
-export class RepeatGroupDefinition extends BaseGroupDefinition<'repeat-group'> {
-	static override isCompatible(localName: string, element: Element): boolean {
-		return this.getGroupType(localName, element) === 'repeat-group';
-	}
-
-	readonly type = 'repeat-group';
-
-	readonly repeat: RepeatDefinition;
-
-	get repeatChildren(): BodyElementDefinitionArray {
-		return this.repeat.children;
-	}
-
-	constructor(form: XFormDefinition, parent: BodyElementParentContext, element: Element) {
-		// TODO: this has already been queried at least twice before reaching this
-		// point!
-		const repeat = getRepeatElement(element);
-
-		// TODO: and as such, this should not happen
-		if (repeat == null) {
-			throw new Error('Invalid repeat-group');
-		}
-
-		super(form, parent, element);
-
-		const repeatDefinition = new RepeatDefinition(form, this, repeat);
-
-		this.repeat = repeatDefinition;
-	}
-}
-
-export type RepeatGroupDefinitionClass = typeof RepeatGroupDefinition;