@getodk/xforms-engine 0.2.0 → 0.3.0

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

package/src/lib/xpath/analysis.ts

@@ -1,241 +0,0 @@
-import { UnreachableError } from '@getodk/common/lib/error/UnreachableError';
-import { expressionParser } from '@getodk/xpath/expressionParser.js';
-import type {
-	AbsoluteLocationPathNode,
-	AnyBinaryExprNode,
-	AnySyntaxNode,
-	FilterPathExprNode,
-	LocalPartNode,
-	PrefixedNameNode,
-	RelativeLocationPathNode,
-	UnprefixedNameNode,
-} from '@getodk/xpath/static/grammar/SyntaxNode.js';
-import type { AnyBinaryExprType } from '@getodk/xpath/static/grammar/type-names.js';
-
-export type SingleChildNode = Extract<
-	AnySyntaxNode,
-	{ readonly children: readonly [AnySyntaxNode] }
->;
-
-const isSingleNodeChild = (node: AnySyntaxNode): node is SingleChildNode => {
-	return node.childCount === 1;
-};
-
-const binaryExprNodeTypes = new Set<AnyBinaryExprType>([
-	'addition_expr',
-	'and_expr',
-	'division_expr',
-	'eq_expr',
-	'gt_expr',
-	'gte_expr',
-	'lt_expr',
-	'lte_expr',
-	'modulo_expr',
-	'multiplication_expr',
-	'ne_expr',
-	'or_expr',
-	'subtraction_expr',
-	'union_expr',
-]);
-
-const isBinaryExprNode = (node: AnySyntaxNode): node is AnyBinaryExprNode => {
-	return binaryExprNodeTypes.has(node.type as AnyBinaryExprType);
-};
-
-const matchesLocalName = (
-	localName: string,
-	nameNode: PrefixedNameNode | UnprefixedNameNode
-): boolean => {
-	const localPartNode: LocalPartNode | UnprefixedNameNode =
-		nameNode.type === 'prefixed_name' ? nameNode.children[1] : nameNode;
-
-	return localPartNode.text === localName;
-};
-
-const isFunctionCalled = (localName: string, node: AnySyntaxNode): boolean => {
-	if (!node.text.includes(localName)) {
-		return false;
-	}
-
-	if (isSingleNodeChild(node)) {
-		const [child] = node.children;
-
-		return isFunctionCalled(localName, child);
-	}
-
-	if (isBinaryExprNode(node)) {
-		const [lhs, rhs] = node.children;
-
-		return isFunctionCalled(localName, lhs) || isFunctionCalled(localName, rhs);
-	}
-
-	switch (node.type) {
-		// Terminal nodes
-		case 'number':
-		case 'string_literal':
-		case 'variable_reference':
-
-		// Path sub-nodes which could not have a function call child
-		//
-		// This only errors because this set of cases is commented:
-		// eslint-disable-next-line no-fallthrough
-		case '//':
-		case 'absolute_root_location_path':
-		case 'axis_name':
-		case 'node_type_test':
-		case 'parent':
-		case 'self':
-
-		// Name nodes are also not function call parents
-		//
-		// This only errors because this set of cases is commented:
-		// eslint-disable-next-line no-fallthrough
-		case 'local_part':
-		case 'prefixed_name':
-		case 'prefix':
-		case 'unprefixed_name':
-		case 'unprefixed_wildcard_name_test':
-			return false;
-
-		// Path sub-nodes which could have a function call child
-		case 'abbreviated_absolute_location_path':
-		case 'abbreviated_step':
-		case 'absolute_location_path':
-		case 'axis_test':
-		case 'filter_path_expr':
-		case 'relative_location_path':
-		case 'step':
-			return node.children.some((childNode) => isFunctionCalled(localName, childNode));
-
-		case 'function_call': {
-			const [functionNameNode] = node.children;
-			const [nameNode] = functionNameNode.children;
-
-			return matchesLocalName(localName, nameNode);
-		}
-
-		default:
-			throw new UnreachableError(node);
-	}
-};
-
-export const isItextFunctionCalled = (expression: string): boolean => {
-	const { rootNode } = expressionParser.parse(expression);
-
-	return isFunctionCalled('itext', rootNode);
-};
-
-type LocationPathSubExpressionNode =
-	| AbsoluteLocationPathNode
-	| FilterPathExprNode
-	| RelativeLocationPathNode;
-
-const isAnyLocationPathExprNode = (node: AnySyntaxNode): node is LocationPathSubExpressionNode => {
-	const { type } = node;
-
-	if (type === 'absolute_location_path' || type === 'relative_location_path') {
-		return true;
-	}
-
-	return false;
-};
-
-// TODO: this does not currently even attempt to find sub-expressions nested
-// within sub-expressions.
-const findLocationPathExprNodes = (
-	node: AnySyntaxNode
-): readonly LocationPathSubExpressionNode[] => {
-	const results: LocationPathSubExpressionNode[] = [];
-
-	if (isAnyLocationPathExprNode(node)) {
-		results.push(node);
-	}
-
-	results.push(
-		...node.children.flatMap((childNode) => {
-			return findLocationPathExprNodes(childNode);
-		})
-	);
-
-	return results;
-};
-
-// TODO: this is a very small subset of resolution that needs to be supported,
-// and it's a hamfisted hack. **This is temporary** to unblock progress on
-// computations, but a longer term solution will need to address:
-//
-// - non-abbreviation axes (parent, child, self) according to XForms spec
-// - non-leading axes
-// - context expressions which are more complex than a series of explicit
-//   element name test steps (this may be fine for binds!)
-const resolveRelativeSubExpression = (contextReference: string | null, expression: string) => {
-	if (contextReference == null) {
-		return expression;
-	}
-
-	const [, axisAbbreviation, relativeExpression = ''] = expression.match(/^(\.{1,2})(\/.*$)?/) ?? [
-		null,
-		'',
-		expression,
-	];
-
-	switch (axisAbbreviation) {
-		case '':
-			return expression;
-
-		case '.':
-			return `${contextReference}${relativeExpression}`;
-
-		case '..':
-			return `${contextReference.replace(/\/[^/]+$/, '')}${relativeExpression}`;
-	}
-
-	throw new Error(`Unexpected relative expression: ${expression}`);
-};
-
-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 const getNodesetDependencies = (
-	expression: string,
-	options: GetNodesetDependenciesOptions = {}
-): Set<string> => {
-	const { rootNode } = expressionParser.parse(expression);
-	const subExpressionNodes = findLocationPathExprNodes(rootNode);
-	const {
-		contextReference = null,
-		ignoreContextReference = false,
-		ignoreNullExpressions = true,
-	} = options;
-
-	const subExpressions = subExpressionNodes
-		.map((syntaxNode) => resolveRelativeSubExpression(contextReference, syntaxNode.text))
-		.filter((subExpression) => {
-			if (ignoreContextReference && subExpression === contextReference) {
-				return false;
-			}
-
-			if (ignoreNullExpressions && subExpression === 'null') {
-				return false;
-			}
-
-			return true;
-		});
-
-	return new Set(subExpressions);
-};