@getodk/xforms-engine 0.5.0 → 0.6.0

package/dist/instance/unsupported/RangeControl.d.ts

@@ -1,6 +0,0 @@
-import { UnsupportedControl } from '../abstract/UnsupportedControl.ts';
-import { ValueContext } from '../internal-api/ValueContext.ts';
-export declare class RangeControl extends UnsupportedControl<'range'> implements ValueContext<unknown> {
-    readonly nodeType = "range";
-    readonly contextNode: this;
-}

package/dist/instance/unsupported/RankControl.d.ts

@@ -1,6 +0,0 @@
-import { UnsupportedControl } from '../abstract/UnsupportedControl.ts';
-import { ValueContext } from '../internal-api/ValueContext.ts';
-export declare class RankControl extends UnsupportedControl<'rank'> implements ValueContext<unknown> {
-    readonly nodeType = "rank";
-    readonly contextNode: this;
-}

package/dist/integration/xpath/static-dom/StaticNamedNode.d.ts

@@ -1,17 +0,0 @@
-import { XFormsXPathNamedNode, XPathNamedNodeKind } from '../adapter/XFormsXPathNode.ts';
-import { StaticDocument } from './StaticDocument.ts';
-import { StaticParentNode, StaticNode } from './StaticNode.ts';
-export interface StaticNamedNodeOptions {
-    readonly namespaceURI: string | null;
-    readonly localName: string;
-    readonly value?: string;
-}
-export declare abstract class StaticNamedNode<Kind extends XPathNamedNodeKind> extends StaticNode<Kind> implements XFormsXPathNamedNode {
-    readonly parent: StaticParentNode;
-    readonly rootDocument: StaticDocument;
-    readonly isXFormsNamespace: boolean;
-    readonly namespaceURI: string | null;
-    readonly localName: string;
-    readonly value: string | null;
-    protected constructor(parent: StaticParentNode, options: StaticNamedNodeOptions);
-}

package/dist/lib/reactivity/createSelectItems.d.ts

@@ -1,16 +0,0 @@
-import { Accessor } from 'solid-js';
-import { SelectItem } from '../../index.ts';
-import { SelectField } from '../../instance/SelectField.ts';
-/**
- * Creates a reactive computation of a {@link SelectField}'s
- * {@link SelectItem}s, in support of the field's `valueOptions`.
- *
- * - Selects defined with static `<item>`s will compute to an corresponding
- *   static list of items.
- * - Selects defined with a computed `<itemset>` will compute to a reactive list
- *   of items.
- * - Items of both will produce {@link SelectItem.label | labels} reactive to
- *   their appropriate dependencies (whether relative to the itemset item node,
- *   referencing a form's `itext` translations, etc).
- */
-export declare const createSelectItems: (selectField: SelectField) => Accessor<readonly SelectItem[]>;

package/dist/parse/body/control/select/ItemDefinition.d.ts

@@ -1,13 +0,0 @@
-import { ItemElement } from '../../../../lib/dom/query.ts';
-import { ItemLabelDefinition } from '../../../text/ItemLabelDefinition.ts';
-import { XFormDefinition } from '../../../XFormDefinition.ts';
-import { BodyElementDefinition } from '../../BodyElementDefinition.ts';
-import { AnySelectDefinition } from './SelectDefinition.ts';
-export declare class ItemDefinition extends BodyElementDefinition<'item'> {
-    readonly parent: AnySelectDefinition;
-    readonly category = "support";
-    readonly type = "item";
-    readonly label: ItemLabelDefinition | null;
-    readonly value: string;
-    constructor(form: XFormDefinition, parent: AnySelectDefinition, element: ItemElement);
-}

package/dist/parse/body/control/select/ItemsetDefinition.d.ts

@@ -1,17 +0,0 @@
-import { ItemsetElement } from '../../../../lib/dom/query.ts';
-import { ItemsetNodesetExpression } from '../../../expression/ItemsetNodesetExpression.ts';
-import { ItemsetValueExpression } from '../../../expression/ItemsetValueExpression.ts';
-import { ItemsetLabelDefinition } from '../../../text/ItemsetLabelDefinition.ts';
-import { XFormDefinition } from '../../../XFormDefinition.ts';
-import { BodyElementDefinition } from '../../BodyElementDefinition.ts';
-import { AnySelectDefinition } from './SelectDefinition.ts';
-export declare class ItemsetDefinition extends BodyElementDefinition<'itemset'> {
-    readonly parent: AnySelectDefinition;
-    readonly category = "support";
-    readonly type = "itemset";
-    readonly reference: string;
-    readonly label: ItemsetLabelDefinition | null;
-    readonly nodes: ItemsetNodesetExpression;
-    readonly value: ItemsetValueExpression;
-    constructor(form: XFormDefinition, parent: AnySelectDefinition, element: ItemsetElement);
-}

package/dist/parse/body/control/select/ItemsetNodesetContext.d.ts

@@ -1,9 +0,0 @@
-import { DependencyContext } from '../../../expression/abstract/DependencyContext.ts';
-import { ItemsetDefinition } from './ItemsetDefinition.ts';
-export declare class ItemsetNodesetContext extends DependencyContext {
-    protected readonly itemset: ItemsetDefinition;
-    readonly parentReference: null;
-    readonly reference: string;
-    constructor(itemset: ItemsetDefinition, nodesetExpression: string);
-    set isTranslated(value: true);
-}

package/src/client/unsupported/RangeNode.ts

@@ -1,14 +0,0 @@
-import type { RangeControlDefinition } from '../../parse/body/control/RangeControlDefinition.ts';
-import type {
-	UnsupportedControlDefinition,
-	UnsupportedControlNode,
-} from './UnsupportedControlNode.ts';
-
-export interface RangeNodeDefinition extends UnsupportedControlDefinition {
-	readonly bodyElement: RangeControlDefinition;
-}
-
-export interface RangeNode extends UnsupportedControlNode {
-	readonly nodeType: 'range';
-	readonly definition: RangeNodeDefinition;
-}

package/src/client/unsupported/RankNode.ts

@@ -1,14 +0,0 @@
-import type { RankControlDefinition } from '../../parse/body/control/RankControlDefinition.ts';
-import type {
-	UnsupportedControlDefinition,
-	UnsupportedControlNode,
-} from './UnsupportedControlNode.ts';
-
-export interface RankNodeDefinition extends UnsupportedControlDefinition {
-	readonly bodyElement: RankControlDefinition;
-}
-
-export interface RankNode extends UnsupportedControlNode {
-	readonly nodeType: 'rank';
-	readonly definition: RankNodeDefinition;
-}

package/src/instance/SelectField.ts

@@ -1,263 +0,0 @@
-import { xmlXPathWhitespaceSeparatedList } from '@getodk/common/lib/string/whitespace.ts';
-import { XPathNodeKindKey } from '@getodk/xpath';
-import type { Accessor } from 'solid-js';
-import { createMemo, untrack } from 'solid-js';
-import type { SelectItem, SelectNode, SelectNodeAppearances } from '../client/SelectNode.ts';
-import type { TextRange } from '../client/TextRange.ts';
-import type { SubmissionState } from '../client/submission/SubmissionState.ts';
-import type { AnyViolation, LeafNodeValidationState } from '../client/validation.ts';
-import type { XFormsXPathElement } from '../integration/xpath/adapter/XFormsXPathNode.ts';
-import { createLeafNodeSubmissionState } from '../lib/client-reactivity/submission/createLeafNodeSubmissionState.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';
-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 { 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 { SharedValidationState } from '../lib/reactivity/validation/createValidation.ts';
-import { createValidationState } from '../lib/reactivity/validation/createValidation.ts';
-import type { AnySelectDefinition } from '../parse/body/control/select/SelectDefinition.ts';
-import type { LeafNodeDefinition } from '../parse/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 { ValidationContext } from './internal-api/ValidationContext.ts';
-import type { ValueContext } from './internal-api/ValueContext.ts';
-import type { ClientReactiveSubmittableLeafNode } from './internal-api/submission/ClientReactiveSubmittableLeafNode.ts';
-
-export interface SelectFieldDefinition extends LeafNodeDefinition {
-	readonly bodyElement: AnySelectDefinition;
-}
-
-interface SelectFieldStateSpec extends DescendantNodeStateSpec<readonly SelectItem[]> {
-	readonly label: Accessor<TextRange<'label'> | null>;
-	readonly hint: Accessor<TextRange<'hint'> | null>;
-	readonly children: null;
-	readonly value: SimpleAtomicState<readonly SelectItem[]>;
-	readonly valueOptions: Accessor<readonly SelectItem[]>;
-}
-
-export class SelectField
-	extends DescendantNode<SelectFieldDefinition, SelectFieldStateSpec, GeneralParentNode, null>
-	implements
-		SelectNode,
-		XFormsXPathElement,
-		EvaluationContext,
-		ValidationContext,
-		ValueContext<readonly SelectItem[]>,
-		ClientReactiveSubmittableLeafNode<readonly SelectItem[]>
-{
-	private readonly selectExclusive: boolean;
-	private readonly validation: SharedValidationState;
-
-	// XFormsXPathElement
-	override readonly [XPathNodeKindKey] = 'element';
-
-	// InstanceNode
-	protected readonly state: SharedNodeState<SelectFieldStateSpec>;
-	protected override engineState: EngineState<SelectFieldStateSpec>;
-
-	// SelectNode
-	readonly nodeType = 'select';
-	readonly appearances: SelectNodeAppearances;
-	readonly currentState: CurrentState<SelectFieldStateSpec>;
-
-	get validationState(): LeafNodeValidationState {
-		return this.validation.currentState;
-	}
-
-	readonly submissionState: SubmissionState;
-
-	// ValueContext
-	override readonly contextNode = this;
-
-	readonly encodeValue = (runtimeValue: readonly SelectItem[]): string => {
-		const itemValues = new Set(runtimeValue.map(({ value }) => value));
-		const selectedItems = this.getValueOptions().filter(({ value }) => {
-			return itemValues.has(value);
-		});
-
-		return selectedItems.map(({ value }) => value).join(' ');
-	};
-
-	readonly decodeValue = (instanceValue: string): readonly SelectItem[] => {
-		const itemValues = new Set(
-			xmlXPathWhitespaceSeparatedList(instanceValue, {
-				ignoreEmpty: true,
-			})
-		);
-
-		// TODO: also want set-like behavior, probably?
-		return this.getValueOptions().filter((option) => {
-			return itemValues.has(option.value);
-		});
-	};
-
-	protected readonly getValueOptions: Accessor<readonly SelectItem[]>;
-	protected readonly getValue: Accessor<readonly SelectItem[]>;
-
-	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 [baseGetValue, setValue] = createValueState(this);
-
-		const getValue = this.scope.runTask(() => {
-			const selectItemsByValue = createMemo((): ReadonlyMap<string, SelectItem> => {
-				return new Map(valueOptions().map((item) => [item.value, item]));
-			});
-
-			return createMemo(() => {
-				const items = selectItemsByValue();
-
-				return baseGetValue().filter((item) => {
-					return items.has(item.value);
-				});
-			});
-		});
-
-		this.getValue = getValue;
-
-		const valueState: SimpleAtomicState<readonly SelectItem[]> = [getValue, setValue];
-
-		const sharedStateOptions = {
-			clientStateFactory: this.engineConfig.stateFactory,
-		};
-
-		const state = createSharedNodeState(
-			this.scope,
-			{
-				reference: this.contextReference,
-				readonly: this.isReadonly,
-				relevant: this.isRelevant,
-				required: this.isRequired,
-
-				label: createNodeLabel(this, definition),
-				hint: createFieldHint(this, definition),
-				children: null,
-				value: valueState,
-				valueOptions,
-			},
-			sharedStateOptions
-		);
-
-		this.state = state;
-		this.engineState = state.engineState;
-		this.currentState = state.currentState;
-		this.validation = createValidationState(this, sharedStateOptions);
-		this.submissionState = createLeafNodeSubmissionState(this);
-	}
-
-	protected getSelectItemsByValue(
-		valueOptions: readonly SelectItem[] = this.getValueOptions()
-	): ReadonlyMap<string, SelectItem> {
-		return new Map(
-			valueOptions.map((item) => {
-				return [item.value, item];
-			})
-		);
-	}
-
-	protected updateSelectedItemValues(values: readonly string[]) {
-		const itemsByValue = untrack(() => this.getSelectItemsByValue());
-
-		const items = values.flatMap((value) => {
-			const item = itemsByValue.get(value);
-
-			if (item == null) {
-				return [];
-			}
-
-			return item ?? [];
-		});
-
-		this.state.setProperty('value', items);
-	}
-
-	protected setSelectedItemValue(value: string | null) {
-		if (value == null) {
-			this.state.setProperty('value', []);
-
-			return;
-		}
-
-		this.updateSelectedItemValues([value]);
-	}
-
-	// XFormsXPathElement
-	override getXPathValue(): string {
-		return this.encodeValue(this.engineState.value);
-	}
-
-	// SelectNode
-	select(selectedItem: SelectItem): Root {
-		const { engineState, root } = this;
-
-		if (this.selectExclusive) {
-			this.setSelectedItemValue(selectedItem.value);
-
-			return root;
-		}
-
-		const currentValues = engineState.value.map(({ value }) => {
-			return value;
-		});
-
-		const selectedValue = selectedItem.value;
-
-		if (currentValues.includes(selectedValue)) {
-			return root;
-		}
-
-		this.updateSelectedItemValues(currentValues.concat(selectedValue));
-
-		return root;
-	}
-
-	deselect(deselectedItem: SelectItem): Root {
-		const { engineState, root } = this;
-
-		const currentValues = engineState.value.map(({ value }) => {
-			return value;
-		});
-
-		const selectedValue = deselectedItem.value;
-
-		if (!currentValues.includes(selectedValue)) {
-			return root;
-		}
-
-		const updatedValues = currentValues.filter((value) => {
-			return value !== selectedValue;
-		});
-
-		this.updateSelectedItemValues(updatedValues);
-
-		return root;
-	}
-
-	// InstanceNode
-	getChildren(): readonly [] {
-		return [];
-	}
-
-	// ValidationContext
-	getViolation(): AnyViolation | null {
-		return this.validation.engineState.violation;
-	}
-
-	isBlank(): boolean {
-		return this.engineState.value.length === 0;
-	}
-}

package/src/instance/unsupported/RangeControl.ts

@@ -1,9 +0,0 @@
-import { UnsupportedControl } from '../abstract/UnsupportedControl.ts';
-import type { ValueContext } from '../internal-api/ValueContext.ts';
-
-export class RangeControl extends UnsupportedControl<'range'> implements ValueContext<unknown> {
-	readonly nodeType = 'range';
-
-	// ValueContext
-	readonly contextNode = this;
-}

package/src/instance/unsupported/RankControl.ts

@@ -1,9 +0,0 @@
-import { UnsupportedControl } from '../abstract/UnsupportedControl.ts';
-import type { ValueContext } from '../internal-api/ValueContext.ts';
-
-export class RankControl extends UnsupportedControl<'rank'> implements ValueContext<unknown> {
-	readonly nodeType = 'rank';
-
-	// ValueContext
-	readonly contextNode = this;
-}

package/src/integration/xpath/static-dom/StaticNamedNode.ts

@@ -1,45 +0,0 @@
-import { XFORMS_NAMESPACE_URI } from '@getodk/common/constants/xmlns.ts';
-import type { XFormsXPathNamedNode, XPathNamedNodeKind } from '../adapter/XFormsXPathNode.ts';
-import type { StaticDocument } from './StaticDocument.ts';
-import type { StaticParentNode } from './StaticNode.ts';
-import { StaticNode } from './StaticNode.ts';
-
-export interface StaticNamedNodeOptions {
-	readonly namespaceURI: string | null;
-	readonly localName: string;
-	readonly value?: string;
-}
-
-export abstract class StaticNamedNode<Kind extends XPathNamedNodeKind>
-	extends StaticNode<Kind>
-	implements XFormsXPathNamedNode
-{
-	readonly rootDocument: StaticDocument;
-	readonly isXFormsNamespace: boolean;
-	readonly namespaceURI: string | null;
-	readonly localName: string;
-	readonly value: string | null;
-
-	protected constructor(
-		readonly parent: StaticParentNode,
-		options: StaticNamedNodeOptions
-	) {
-		super();
-
-		this.rootDocument = parent.rootDocument;
-
-		const { namespaceURI, localName, value = null } = options;
-
-		this.namespaceURI = namespaceURI;
-		this.localName = localName;
-		this.value = value;
-
-		if (namespaceURI === XFORMS_NAMESPACE_URI) {
-			this.isXFormsNamespace = true;
-		} else if (parent == null || parent.isXFormsNamespace) {
-			this.isXFormsNamespace = namespaceURI == null;
-		} else {
-			this.isXFormsNamespace = false;
-		}
-	}
-}

package/src/parse/body/control/select/ItemsetNodesetContext.ts

@@ -1,21 +0,0 @@
-import { DependencyContext } from '../../../expression/abstract/DependencyContext.ts';
-import type { ItemsetDefinition } from './ItemsetDefinition.ts';
-
-export class ItemsetNodesetContext extends DependencyContext {
-	override readonly parentReference = null;
-	override readonly reference: string;
-
-	constructor(
-		protected readonly itemset: ItemsetDefinition,
-		nodesetExpression: string
-	) {
-		super();
-
-		this.reference = nodesetExpression;
-	}
-
-	override set isTranslated(value: true) {
-		super.isTranslated = value;
-		this.itemset.isTranslated = value;
-	}
-}