@getodk/xforms-engine 0.13.0 → 0.15.0

package/src/instance/Subtree.ts

@@ -1,102 +0,0 @@
-import { XPathNodeKindKey } from '@getodk/xpath';
-import type { Accessor } from 'solid-js';
-import type { FormNodeID } from '../client/identity.ts';
-import type { InstanceState } from '../client/serialization/InstanceState.ts';
-import type { SubtreeDefinition, SubtreeNode } from '../client/SubtreeNode.ts';
-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 { createParentNodeInstanceState } from '../lib/client-reactivity/instance-state/createParentNodeInstanceState.ts';
-import type { ChildrenState } from '../lib/reactivity/createChildrenState.ts';
-import { createChildrenState } from '../lib/reactivity/createChildrenState.ts';
-import type { MaterializedChildren } from '../lib/reactivity/materializeCurrentStateChildren.ts';
-import { materializeCurrentStateChildren } from '../lib/reactivity/materializeCurrentStateChildren.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 { createAggregatedViolations } from '../lib/reactivity/validation/createAggregatedViolations.ts';
-import type { DescendantNodeSharedStateSpec } from './abstract/DescendantNode.ts';
-import { DescendantNode } from './abstract/DescendantNode.ts';
-import { buildChildren } from './children/buildChildren.ts';
-import type { GeneralChildNode, GeneralParentNode } from './hierarchy.ts';
-import type { EvaluationContext } from './internal-api/EvaluationContext.ts';
-import type { ClientReactiveSerializableParentNode } from './internal-api/serialization/ClientReactiveSerializableParentNode.ts';
-
-interface SubtreeStateSpec extends DescendantNodeSharedStateSpec {
-	readonly label: null;
-	readonly hint: null;
-	readonly children: Accessor<readonly FormNodeID[]>;
-	readonly valueOptions: null;
-	readonly value: null;
-}
-
-export class Subtree
-	extends DescendantNode<SubtreeDefinition, SubtreeStateSpec, GeneralParentNode, GeneralChildNode>
-	implements
-		SubtreeNode,
-		XFormsXPathElement,
-		EvaluationContext,
-		ClientReactiveSerializableParentNode<GeneralChildNode>
-{
-	private readonly childrenState: ChildrenState<GeneralChildNode>;
-
-	override readonly [XPathNodeKindKey] = 'element';
-
-	// InstanceNode
-	protected readonly state: SharedNodeState<SubtreeStateSpec>;
-	protected readonly engineState: EngineState<SubtreeStateSpec>;
-
-	// SubtreeNode
-	readonly nodeType = 'subtree';
-	readonly appearances = null;
-	readonly nodeOptions = null;
-	readonly currentState: MaterializedChildren<CurrentState<SubtreeStateSpec>, GeneralChildNode>;
-	readonly validationState: AncestorNodeValidationState;
-	readonly instanceState: InstanceState;
-
-	constructor(
-		parent: GeneralParentNode,
-		instanceNode: StaticElement | null,
-		definition: SubtreeDefinition
-	) {
-		super(parent, instanceNode, definition);
-
-		const childrenState = createChildrenState<Subtree, GeneralChildNode>(this);
-
-		this.childrenState = childrenState;
-
-		const state = createSharedNodeState(
-			this.scope,
-			{
-				reference: this.contextReference,
-				readonly: this.isReadonly,
-				relevant: this.isRelevant,
-				required: this.isRequired,
-
-				label: null,
-				hint: null,
-				children: childrenState.childIds,
-				valueOptions: null,
-				value: null,
-			},
-			this.instanceConfig
-		);
-
-		this.state = state;
-		this.engineState = state.engineState;
-		this.currentState = materializeCurrentStateChildren(
-			this.scope,
-			state.currentState,
-			childrenState
-		);
-
-		childrenState.setChildren(buildChildren(this));
-		this.validationState = createAggregatedViolations(this, this.instanceConfig);
-		this.instanceState = createParentNodeInstanceState(this);
-	}
-
-	getChildren(): readonly GeneralChildNode[] {
-		return this.childrenState.getChildren();
-	}
-}

package/src/instance/text/FormattedTextStub.ts

@@ -1,8 +0,0 @@
-export const FormattedTextStub = new Proxy({} as Record<PropertyKey, unknown>, {
-	get() {
-		throw new TypeError('Not implemented');
-	},
-	set() {
-		return false;
-	},
-});

package/src/parse/body/group/BaseGroupDefinition.ts

@@ -1,89 +0,0 @@
-import { UpsertableMap } from '@getodk/common/lib/collections/UpsertableMap.ts';
-import { getLabelElement } from '../../../lib/dom/query.ts';
-import { LabelDefinition } from '../../text/LabelDefinition.ts';
-import type { XFormDefinition } from '../../XFormDefinition.ts';
-import { parseNodesetReference } from '../../xpath/reference-parsing.ts';
-import type { StructureElementAppearanceDefinition } from '../appearance/structureElementAppearanceParser.ts';
-import { structureElementAppearanceParser } from '../appearance/structureElementAppearanceParser.ts';
-import {
-	type BodyElementDefinitionArray,
-	type BodyElementParentContext,
-} from '../BodyDefinition.ts';
-import { BodyElementDefinition } from '../BodyElementDefinition.ts';
-
-/**
- * These type names are derived from **and expand upon** the language used in
- * the ODK XForms spec to describe various group usage. Whereas the spec
- * language allows for a group to be described as more than one case, the intent
- * here is to establish exclusive naming which may or may not compound. As such:
- *
- * - `logical-group`, per spec language, is a group with a `ref`; its usage here
- *   differs from the spec language in that it _may_ have a `<label>` child but
- *   is not also treated as a `presentation-group` (which is only used for
- *   groups which do not have a `ref`)
- * - `presentation-group` is a group with a `<label>` child; its usage here
- *   differs from the spec language in that `presentation-group` does **not**
- *   have a `ref`
- * - `structural-group` is any `<group>` element which does not satisfy any of
- *   the other usage scenarios; this isn't exactly the terminology used, but is
- *   the most closely fitting name for the concept where the other sceanarios
- *   do not apply
- *
- * A more succinct decision tree:
- *
- * - `<group ref="$ref">` -> `logical-group`, else
- * - `<group><label>` -> `presentation-group`, else
- * - `<group>` -> `structural-group`
- */
-export type GroupType = 'logical-group' | 'presentation-group' | 'structural-group';
-
-export abstract class BaseGroupDefinition<
-	Type extends GroupType,
-> extends BodyElementDefinition<Type> {
-	// TODO: does this really accomplish anything? It seems highly unlikely it
-	// has enough performance benefit to outweigh its memory and lookup costs.
-	private static groupTypes = new UpsertableMap<Element, GroupType | null>();
-
-	protected static getGroupType(localName: string, element: Element): GroupType | null {
-		return this.groupTypes.upsert(element, () => {
-			if (localName !== 'group') {
-				return null;
-			}
-
-			if (element.hasAttribute('ref')) {
-				return 'logical-group';
-			}
-
-			const label = getLabelElement(element);
-
-			if (label == null) {
-				return 'structural-group';
-			}
-
-			return 'presentation-group';
-		});
-	}
-
-	override readonly category = 'structure';
-
-	readonly children: BodyElementDefinitionArray;
-
-	override readonly reference: string | null;
-	readonly appearances: StructureElementAppearanceDefinition;
-	override readonly label: LabelDefinition | null;
-
-	constructor(form: XFormDefinition, parent: BodyElementParentContext, element: Element) {
-		super(form, parent, element);
-
-		const childElements = Array.from(element.children).filter((child) => {
-			const childName = child.localName;
-
-			return childName !== 'label';
-		});
-
-		this.children = this.body.getChildElementDefinitions(form, this, element, childElements);
-		this.reference = parseNodesetReference(parent, element, 'ref');
-		this.appearances = structureElementAppearanceParser.parseFrom(element, 'appearance');
-		this.label = LabelDefinition.forGroup(form, this);
-	}
-}

package/src/parse/body/group/LogicalGroupDefinition.ts

@@ -1,11 +0,0 @@
-import { BaseGroupDefinition } from './BaseGroupDefinition.ts';
-
-export class LogicalGroupDefinition extends BaseGroupDefinition<'logical-group'> {
-	static override isCompatible(localName: string, element: Element): boolean {
-		return this.getGroupType(localName, element) === 'logical-group';
-	}
-
-	readonly type = 'logical-group';
-}
-
-export type LogicalGroupDefinitionClass = typeof LogicalGroupDefinition;

package/src/parse/body/group/PresentationGroupDefinition.ts

@@ -1,28 +0,0 @@
-import { LabelDefinition } from '../../text/LabelDefinition.ts';
-import type { XFormDefinition } from '../../XFormDefinition.ts';
-import type { BodyElementParentContext } from '../BodyDefinition.ts';
-import { BaseGroupDefinition } from './BaseGroupDefinition.ts';
-
-export class PresentationGroupDefinition extends BaseGroupDefinition<'presentation-group'> {
-	static override isCompatible(localName: string, element: Element): boolean {
-		return this.getGroupType(localName, element) === 'presentation-group';
-	}
-
-	readonly type = 'presentation-group';
-
-	override readonly label: LabelDefinition;
-
-	constructor(form: XFormDefinition, parent: BodyElementParentContext, element: Element) {
-		super(form, parent, element);
-
-		const label = LabelDefinition.forGroup(form, this);
-
-		if (label == null) {
-			throw new Error('Invalid presentation-group: missing label');
-		}
-
-		this.label = label;
-	}
-}
-
-export type PresentationGroupDefinitionClass = typeof PresentationGroupDefinition;

package/src/parse/body/group/StructuralGroupDefinition.ts

@@ -1,11 +0,0 @@
-import { BaseGroupDefinition } from './BaseGroupDefinition.ts';
-
-export class StructuralGroupDefinition extends BaseGroupDefinition<'structural-group'> {
-	static override isCompatible(localName: string, element: Element): boolean {
-		return this.getGroupType(localName, element) === 'structural-group';
-	}
-
-	readonly type = 'structural-group';
-}
-
-export type StructuralGroupDefinitionClass = typeof StructuralGroupDefinition;

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;
-	}
-}