@getodk/xforms-engine 0.2.0 → 0.4.0

package/dist/body/text/LabelDefinition.d.ts

@@ -1,22 +0,0 @@
-import { XFormDefinition } from '../../XFormDefinition.ts';
-import { AnyControlDefinition } from '../control/ControlDefinition.ts';
-import { ItemDefinition } from '../control/select/ItemDefinition.ts';
-import { ItemsetDefinition } from '../control/select/ItemsetDefinition.ts';
-import { BaseGroupDefinition } from '../group/BaseGroupDefinition.ts';
-import { RepeatElementDefinition } from '../RepeatElementDefinition.ts';
-import { TextElement, TextElementOwner, TextElementDefinition } from './TextElementDefinition.ts';
-
-export interface LabelElement extends TextElement {
-    readonly localName: 'label';
-}
-type StaticLabelContext = Exclude<TextElementOwner, ItemsetDefinition>;
-export declare class LabelDefinition extends TextElementDefinition<'label'> {
-    protected static staticDefinition(form: XFormDefinition, definition: StaticLabelContext): LabelDefinition | null;
-    static forControl(form: XFormDefinition, control: AnyControlDefinition): LabelDefinition | null;
-    static forRepeatGroup(form: XFormDefinition, repeat: RepeatElementDefinition): LabelDefinition | null;
-    static forGroup(form: XFormDefinition, group: BaseGroupDefinition<any>): LabelDefinition | null;
-    static forItem(form: XFormDefinition, item: ItemDefinition): LabelDefinition | null;
-    static forItemset(form: XFormDefinition, itemset: ItemsetDefinition): LabelDefinition | null;
-    readonly type = "label";
-}
-export {};

package/dist/body/text/TextElementDefinition.d.ts

@@ -1,33 +0,0 @@
-import { XFormDefinition } from '../../XFormDefinition.ts';
-import { AnyDependentExpression } from '../../expression/DependentExpression.ts';
-import { AnyGroupElementDefinition } from '../BodyDefinition.ts';
-import { BodyElementDefinition } from '../BodyElementDefinition.ts';
-import { RepeatElementDefinition } from '../RepeatElementDefinition.ts';
-import { AnyControlDefinition } from '../control/ControlDefinition.ts';
-import { ItemDefinition } from '../control/select/ItemDefinition.ts';
-import { ItemsetDefinition } from '../control/select/ItemsetDefinition.ts';
-import { TextElementOutputPart } from './TextElementOutputPart.ts';
-import { TextElementReferencePart } from './TextElementReferencePart.ts';
-import { TextElementStaticPart } from './TextElementStaticPart.ts';
-
-export type TextElementType = 'hint' | 'label';
-export interface TextElement extends Element {
-    readonly localName: TextElementType;
-}
-export type TextElementOwner = AnyControlDefinition | AnyGroupElementDefinition | ItemDefinition | ItemsetDefinition | RepeatElementDefinition;
-export type TextElementChild = TextElementOutputPart | TextElementStaticPart;
-export declare abstract class TextElementDefinition<Type extends TextElementType> extends BodyElementDefinition<Type> {
-    readonly owner: TextElementOwner;
-    readonly category = "support";
-    abstract readonly type: Type;
-    readonly reference: string | null;
-    readonly parentReference: string | null;
-    readonly referenceExpression: TextElementReferencePart | null;
-    readonly children: readonly TextElementChild[];
-    get isTranslated(): boolean;
-    set isTranslated(value: true);
-    protected constructor(form: XFormDefinition, owner: TextElementOwner, element: TextElement);
-    registerDependentExpression(expression: AnyDependentExpression): void;
-    toJSON(): object;
-}
-export type AnyTextElementDefinition = TextElementDefinition<TextElementType>;

package/dist/body/text/TextElementOutputPart.d.ts

@@ -1,13 +0,0 @@
-import { AnyTextElementDefinition } from './TextElementDefinition.ts';
-import { TextElementPart } from './TextElementPart.ts';
-
-interface OutputElement extends Element {
-    readonly localName: 'output';
-    getAttribute(name: 'value'): string;
-    getAttribute(name: string): string | null;
-}
-export declare class TextElementOutputPart extends TextElementPart<'output'> {
-    static from(context: AnyTextElementDefinition, element: Element): TextElementOutputPart | null;
-    protected constructor(context: AnyTextElementDefinition, element: OutputElement);
-}
-export {};

package/dist/body/text/TextElementPart.d.ts

@@ -1,13 +0,0 @@
-import { DependentExpression } from '../../expression/DependentExpression.ts';
-import { AnyTextElementDefinition } from './TextElementDefinition.ts';
-import { TextElementOutputPart } from './TextElementOutputPart.ts';
-import { TextElementReferencePart } from './TextElementReferencePart.ts';
-import { TextElementStaticPart } from './TextElementStaticPart.ts';
-
-export type TextElementPartType = 'output' | 'reference' | 'static';
-export declare abstract class TextElementPart<Type extends TextElementPartType> extends DependentExpression<'string'> {
-    readonly type: Type;
-    readonly stringValue?: string;
-    constructor(type: Type, context: AnyTextElementDefinition, expression: string);
-}
-export type AnyTextElementPart = TextElementOutputPart | TextElementReferencePart | TextElementStaticPart;

package/dist/body/text/TextElementReferencePart.d.ts

@@ -1,7 +0,0 @@
-import { AnyTextElementDefinition, TextElement } from './TextElementDefinition.ts';
-import { TextElementPart } from './TextElementPart.ts';
-
-export declare class TextElementReferencePart extends TextElementPart<'reference'> {
-    static from(context: AnyTextElementDefinition, element: TextElement): TextElementReferencePart | null;
-    protected constructor(context: AnyTextElementDefinition, expression: string);
-}

package/dist/body/text/TextElementStaticPart.d.ts

@@ -1,7 +0,0 @@
-import { AnyTextElementDefinition } from './TextElementDefinition.ts';
-import { TextElementPart } from './TextElementPart.ts';
-
-export declare class TextElementStaticPart extends TextElementPart<'static'> {
-    readonly stringValue: string;
-    constructor(context: AnyTextElementDefinition, node: Text);
-}

package/dist/lib/xpath/analysis.d.ts

@@ -1,23 +0,0 @@
-import { AnySyntaxNode } from '@getodk/xpath/static/grammar/SyntaxNode.js';
-
-export type SingleChildNode = Extract<AnySyntaxNode, {
-    readonly children: readonly [AnySyntaxNode];
-}>;
-export declare const isItextFunctionCalled: (expression: string) => boolean;
-interface GetNodesetDependenciesOptions {
-    readonly contextReference?: string | null;
-    /**
-     * @default false
-     */
-    readonly ignoreContextReference?: boolean;
-    /**
-     * Ignores location path sub-expressions whose full text is `null`. While this
-     * is technically a valid relative name test step, it seems that real forms in
-     * the wild use it as if XPath had an actual `null` token/value.
-     *
-     * @default true
-     */
-    readonly ignoreNullExpressions?: boolean;
-}
-export declare const getNodesetDependencies: (expression: string, options?: GetNodesetDependenciesOptions) => Set<string>;
-export {};

package/dist/model/BindDefinition.d.ts

@@ -1,32 +0,0 @@
-import { XFormDataType } from '../XFormDataType.ts';
-import { XFormDefinition } from '../XFormDefinition.ts';
-import { DependencyContext } from '../expression/DependencyContext.ts';
-import { DependentExpression } from '../expression/DependentExpression.ts';
-import { BindComputation } from './BindComputation.ts';
-import { BindElement } from './BindElement.ts';
-import { ModelDefinition } from './ModelDefinition.ts';
-
-export declare class BindDefinition extends DependencyContext {
-    readonly form: XFormDefinition;
-    protected readonly model: ModelDefinition;
-    readonly nodeset: string;
-    readonly bindElement: BindElement;
-    readonly bindType: string | null;
-    readonly dataType: XFormDataType;
-    readonly parentNodeset: string | null;
-    readonly calculate: BindComputation<'calculate'> | null;
-    readonly readonly: BindComputation<'readonly'>;
-    readonly relevant: BindComputation<'relevant'>;
-    readonly required: BindComputation<'required'>;
-    /**
-     * Diverges from {@link https://github.com/getodk/javarosa/blob/059321160e6f8dbb3e81d9add61d68dd35b13cc8/dag.md | JavaRosa's}, which excludes `constraint` expressions. We compute `constraint` dependencies like the other <bind> computation expressions, but explicitly ignore self-references (this is currently handled by {@link BindComputation}, via its {@link DependentExpression} parent class).
-     */
-    readonly constraint: BindComputation<'constraint'> & DependentExpression<'boolean'>;
-    readonly saveIncomplete: BindComputation<'saveIncomplete'>;
-    protected _parentBind: BindDefinition | null | undefined;
-    get parentBind(): BindDefinition | null;
-    get reference(): string;
-    get parentReference(): string | null;
-    constructor(form: XFormDefinition, model: ModelDefinition, nodeset: string, bindElement: BindElement);
-    toJSON(): Omit<this, "model" | "toJSON" | "form" | "reference" | "parentReference" | "isTranslated" | "registerDependentExpression" | "dependencyExpressions" | "bindElement" | "parentBind">;
-}

package/src/body/control/select/ItemsetDefinition.ts

@@ -1,36 +0,0 @@
-import { getValueElement, type ItemsetElement } from '../../../lib/dom/query.ts';
-import type { XFormDefinition } from '../../../XFormDefinition.ts';
-import { BodyElementDefinition } from '../../BodyElementDefinition.ts';
-import { LabelDefinition } from '../../text/LabelDefinition.ts';
-import { ItemsetNodesetExpression } from './ItemsetNodesetExpression.ts';
-import { ItemsetValueExpression } from './ItemsetValueExpression.ts';
-import type { AnySelectDefinition } from './SelectDefinition.ts';
-
-export class ItemsetDefinition extends BodyElementDefinition<'itemset'> {
-	override readonly category = 'support';
-	readonly type = 'itemset';
-
-	override readonly reference: string;
-	override readonly label: LabelDefinition | null;
-
-	readonly nodes: ItemsetNodesetExpression;
-	readonly value: ItemsetValueExpression;
-
-	constructor(form: XFormDefinition, select: AnySelectDefinition, element: ItemsetElement) {
-		const valueElement = getValueElement(element);
-		const valueExpression = valueElement?.getAttribute('ref');
-
-		if (valueExpression == null) {
-			throw new Error(`<itemset> has no <value>`);
-		}
-
-		super(form, select, element);
-
-		const nodesetExpression = element.getAttribute('nodeset');
-
-		this.reference = nodesetExpression;
-		this.nodes = new ItemsetNodesetExpression(this, nodesetExpression);
-		this.value = new ItemsetValueExpression(this, valueExpression);
-		this.label = LabelDefinition.forItemset(form, this);
-	}
-}

package/src/body/control/select/ItemsetNodesetExpression.ts

@@ -1,8 +0,0 @@
-import { DependentExpression } from '../../../expression/DependentExpression.ts';
-import type { ItemsetDefinition } from './ItemsetDefinition.ts';
-
-export class ItemsetNodesetExpression extends DependentExpression<'nodes'> {
-	constructor(itemset: ItemsetDefinition, nodesetExpression: string) {
-		super(itemset, 'nodes', nodesetExpression);
-	}
-}

package/src/body/text/HintDefinition.ts

@@ -1,26 +0,0 @@
-import { getHintElement } from '../../lib/dom/query.ts';
-import type { XFormDefinition } from '../../XFormDefinition.ts';
-import type { AnyControlDefinition } from '../control/ControlDefinition.ts';
-import type { TextElement } from './TextElementDefinition.ts';
-import { TextElementDefinition } from './TextElementDefinition.ts';
-
-export interface HintElement extends TextElement {
-	readonly localName: 'hint';
-}
-
-export class HintDefinition extends TextElementDefinition<'hint'> {
-	static forElement(
-		form: XFormDefinition,
-		definition: AnyControlDefinition
-	): HintDefinition | null {
-		const hintElement = getHintElement(definition.element);
-
-		if (hintElement == null) {
-			return null;
-		}
-
-		return new this(form, definition, hintElement);
-	}
-
-	readonly type = 'hint';
-}

package/src/body/text/LabelDefinition.ts

@@ -1,68 +0,0 @@
-import { getLabelElement, getRepeatGroupLabelElement } from '../../lib/dom/query.ts';
-import type { XFormDefinition } from '../../XFormDefinition.ts';
-import type { AnyControlDefinition } from '../control/ControlDefinition.ts';
-import type { ItemDefinition } from '../control/select/ItemDefinition.ts';
-import type { ItemsetDefinition } from '../control/select/ItemsetDefinition.ts';
-import type { BaseGroupDefinition } from '../group/BaseGroupDefinition.ts';
-import type { RepeatElementDefinition } from '../RepeatElementDefinition.ts';
-import type { TextElement, TextElementOwner } from './TextElementDefinition.ts';
-import { TextElementDefinition } from './TextElementDefinition.ts';
-
-export interface LabelElement extends TextElement {
-	readonly localName: 'label';
-}
-
-type StaticLabelContext = Exclude<TextElementOwner, ItemsetDefinition>;
-
-export class LabelDefinition extends TextElementDefinition<'label'> {
-	protected static staticDefinition(
-		form: XFormDefinition,
-		definition: StaticLabelContext
-	): LabelDefinition | null {
-		const labelElement = getLabelElement(definition.element);
-
-		if (labelElement == null) {
-			return null;
-		}
-
-		return new this(form, definition, labelElement);
-	}
-
-	static forControl(form: XFormDefinition, control: AnyControlDefinition): LabelDefinition | null {
-		return this.staticDefinition(form, control);
-	}
-
-	static forRepeatGroup(
-		form: XFormDefinition,
-		repeat: RepeatElementDefinition
-	): LabelDefinition | null {
-		const repeatGroupLabel = getRepeatGroupLabelElement(repeat.element);
-
-		if (repeatGroupLabel == null) {
-			return null;
-		}
-
-		return new this(form, repeat, repeatGroupLabel);
-	}
-
-	// eslint-disable-next-line @typescript-eslint/no-explicit-any
-	static forGroup(form: XFormDefinition, group: BaseGroupDefinition<any>): LabelDefinition | null {
-		return this.staticDefinition(form, group);
-	}
-
-	static forItem(form: XFormDefinition, item: ItemDefinition): LabelDefinition | null {
-		return this.staticDefinition(form, item);
-	}
-
-	static forItemset(form: XFormDefinition, itemset: ItemsetDefinition): LabelDefinition | null {
-		const labelElement = getLabelElement(itemset.element);
-
-		if (labelElement == null) {
-			return null;
-		}
-
-		return new this(form, itemset, labelElement);
-	}
-
-	readonly type = 'label';
-}

package/src/body/text/TextElementDefinition.ts

@@ -1,97 +0,0 @@
-import { isCommentNode, isElementNode, isTextNode } from '@getodk/common/lib/dom/predicates.ts';
-import type { XFormDefinition } from '../../XFormDefinition.ts';
-import { type AnyDependentExpression } from '../../expression/DependentExpression.ts';
-import type { AnyGroupElementDefinition } from '../BodyDefinition.ts';
-import { BodyElementDefinition } from '../BodyElementDefinition.ts';
-import type { RepeatElementDefinition } from '../RepeatElementDefinition.ts';
-import type { AnyControlDefinition } from '../control/ControlDefinition.ts';
-import type { ItemDefinition } from '../control/select/ItemDefinition.ts';
-import type { ItemsetDefinition } from '../control/select/ItemsetDefinition.ts';
-import { TextElementOutputPart } from './TextElementOutputPart.ts';
-import { TextElementReferencePart } from './TextElementReferencePart.ts';
-import { TextElementStaticPart } from './TextElementStaticPart.ts';
-
-export type TextElementType = 'hint' | 'label';
-
-export interface TextElement extends Element {
-	readonly localName: TextElementType;
-}
-
-export type TextElementOwner =
-	| AnyControlDefinition
-	| AnyGroupElementDefinition
-	| ItemDefinition
-	| ItemsetDefinition
-	| RepeatElementDefinition;
-
-export type TextElementChild = TextElementOutputPart | TextElementStaticPart;
-
-export abstract class TextElementDefinition<
-	Type extends TextElementType,
-> extends BodyElementDefinition<Type> {
-	readonly category = 'support';
-	abstract override readonly type: Type;
-
-	override readonly reference: string | null;
-	override readonly parentReference: string | null;
-
-	readonly referenceExpression: TextElementReferencePart | null;
-	readonly children: readonly TextElementChild[];
-
-	override get isTranslated(): boolean {
-		return this.owner.isTranslated;
-	}
-
-	override set isTranslated(value: true) {
-		this.owner.isTranslated = value;
-	}
-
-	protected constructor(
-		form: XFormDefinition,
-		readonly owner: TextElementOwner,
-		element: TextElement
-	) {
-		super(form, owner, element);
-
-		this.reference = owner.reference;
-		this.parentReference = owner.parentReference;
-		this.referenceExpression = TextElementReferencePart.from(this, element);
-
-		const children = Array.from(element.childNodes).flatMap((node) => {
-			if (isTextNode(node)) {
-				return new TextElementStaticPart(this, node);
-			}
-
-			if (isElementNode(node)) {
-				const output = TextElementOutputPart.from(this, node);
-
-				if (output != null) {
-					return output;
-				}
-			}
-
-			if (isCommentNode(node)) {
-				return [];
-			}
-
-			// eslint-disable-next-line no-console
-			console.error('Unexpected text element child', node);
-
-			throw new Error(`Unexpected <${element.nodeName}> child element`);
-		});
-
-		this.children = children;
-	}
-
-	override registerDependentExpression(expression: AnyDependentExpression): void {
-		this.owner.registerDependentExpression(expression);
-	}
-
-	override toJSON(): object {
-		const { form, owner, parent, ...rest } = this;
-
-		return rest;
-	}
-}
-
-export type AnyTextElementDefinition = TextElementDefinition<TextElementType>;

package/src/body/text/TextElementOutputPart.ts

@@ -1,27 +0,0 @@
-import type { AnyTextElementDefinition } from './TextElementDefinition.ts';
-import { TextElementPart } from './TextElementPart.ts';
-
-interface OutputElement extends Element {
-	readonly localName: 'output';
-
-	getAttribute(name: 'value'): string;
-	getAttribute(name: string): string | null;
-}
-
-const isOutputElement = (element: Element): element is OutputElement => {
-	return element.localName === 'output' && element.hasAttribute('value');
-};
-
-export class TextElementOutputPart extends TextElementPart<'output'> {
-	static from(context: AnyTextElementDefinition, element: Element): TextElementOutputPart | null {
-		if (isOutputElement(element)) {
-			return new this(context, element);
-		}
-
-		return null;
-	}
-
-	protected constructor(context: AnyTextElementDefinition, element: OutputElement) {
-		super('output', context, element.getAttribute('value'));
-	}
-}

package/src/body/text/TextElementPart.ts

@@ -1,31 +0,0 @@
-import { DependentExpression } from '../../expression/DependentExpression.ts';
-import type { AnyTextElementDefinition } from './TextElementDefinition.ts';
-import type { TextElementOutputPart } from './TextElementOutputPart.ts';
-import type { TextElementReferencePart } from './TextElementReferencePart.ts';
-import type { TextElementStaticPart } from './TextElementStaticPart.ts';
-
-export type TextElementPartType = 'output' | 'reference' | 'static';
-
-export abstract class TextElementPart<
-	Type extends TextElementPartType,
-> extends DependentExpression<'string'> {
-	readonly stringValue?: string;
-
-	constructor(
-		readonly type: Type,
-		context: AnyTextElementDefinition,
-		expression: string
-	) {
-		super(context, 'string', expression, {
-			semanticDependencies: {
-				translations: type !== 'static',
-			},
-			ignoreContextReference: true,
-		});
-	}
-}
-
-export type AnyTextElementPart =
-	| TextElementOutputPart
-	| TextElementReferencePart
-	| TextElementStaticPart;

package/src/body/text/TextElementReferencePart.ts

@@ -1,21 +0,0 @@
-import type { AnyTextElementDefinition, TextElement } from './TextElementDefinition.ts';
-import { TextElementPart } from './TextElementPart.ts';
-
-export class TextElementReferencePart extends TextElementPart<'reference'> {
-	static from(
-		context: AnyTextElementDefinition,
-		element: TextElement
-	): TextElementReferencePart | null {
-		const expression = element.getAttribute('ref');
-
-		if (expression == null) {
-			return null;
-		}
-
-		return new this(context, expression);
-	}
-
-	protected constructor(context: AnyTextElementDefinition, expression: string) {
-		super('reference', context, expression);
-	}
-}

package/src/body/text/TextElementStaticPart.ts

@@ -1,26 +0,0 @@
-import type { AnyTextElementDefinition } from './TextElementDefinition.ts';
-import { TextElementPart } from './TextElementPart.ts';
-
-const toStaticXPathExpression = (staticTextValue: string): string => {
-	const quote = staticTextValue.includes('"') ? "'" : '"';
-
-	if (staticTextValue.includes(quote)) {
-		// throw new Error('todo concat()');
-		return 'todo(concat())';
-	}
-
-	return `${quote}${staticTextValue}${quote}`;
-};
-
-export class TextElementStaticPart extends TextElementPart<'static'> {
-	override readonly stringValue: string;
-
-	constructor(context: AnyTextElementDefinition, node: Text) {
-		const stringValue = node.data;
-		const expression = toStaticXPathExpression(stringValue);
-
-		super('static', context, expression);
-
-		this.stringValue = stringValue;
-	}
-}