@getodk/xforms-engine 0.8.0 → 0.10.0

package/src/parse/text/abstract/TextElementDefinition.ts

@@ -2,10 +2,7 @@ import { isElementNode, isTextNode } from '@getodk/common/lib/dom/predicates.ts'
 import type { ElementTextRole } from '../../../client/TextRange.ts';
 import type { XFormDefinition } from '../../../parse/XFormDefinition.ts';
 import type { ItemDefinition } from '../../body/control/ItemDefinition.ts';
-import { TextLiteralExpression } from '../../expression/TextLiteralExpression.ts';
-import { TextOutputExpression } from '../../expression/TextOutputExpression.ts';
-import { TextReferenceExpression } from '../../expression/TextReferenceExpression.ts';
-import { TextTranslationExpression } from '../../expression/TextTranslationExpression.ts';
+import { TextChunkExpression } from '../../expression/TextChunkExpression.ts';
 import { parseNodesetReference } from '../../xpath/reference-parsing.ts';
 import type { HintDefinition } from '../HintDefinition.ts';
 import type { ItemLabelDefinition } from '../ItemLabelDefinition.ts';
@@ -14,27 +11,12 @@ import type { LabelDefinition, LabelOwner } from '../LabelDefinition.ts';
 import type { TextSourceNode } from './TextRangeDefinition.ts';
 import { TextRangeDefinition } from './TextRangeDefinition.ts';
 
-// prettier-ignore
-export type RefAttributeChunk =
-	| TextReferenceExpression
-	| TextTranslationExpression;
-
-// prettier-ignore
-type TextElementChildChunk =
-	| TextOutputExpression
-	| TextLiteralExpression;
-
-// prettier-ignore
-type TextElementChunks =
-	| readonly [RefAttributeChunk]
-	| readonly TextElementChildChunk[];
-
 type TextElementOwner = ItemDefinition | LabelOwner;
 
 export abstract class TextElementDefinition<
 	Role extends ElementTextRole,
 > extends TextRangeDefinition<Role> {
-	readonly chunks: TextElementChunks;
+	readonly chunks: ReadonlyArray<TextChunkExpression<'nodes' | 'string'>>;
 
 	constructor(form: XFormDefinition, owner: TextElementOwner, sourceNode: TextSourceNode<Role>) {
 		super(form, owner, sourceNode);
@@ -45,20 +27,22 @@ export abstract class TextElementDefinition<
 		if (refExpression == null) {
 			this.chunks = Array.from(sourceNode.childNodes).flatMap((childNode) => {
 				if (isElementNode(childNode)) {
-					return TextOutputExpression.from(context, childNode) ?? [];
+					return TextChunkExpression.fromOutput(context, childNode) ?? [];
 				}
 
 				if (isTextNode(childNode)) {
-					return TextLiteralExpression.from(context, childNode.data);
+					return TextChunkExpression.fromLiteral(context, childNode.data);
 				}
 
 				return [];
 			});
 		} else {
-			const refChunk =
-				TextTranslationExpression.from(context, refExpression) ??
-				TextReferenceExpression.from(context, refExpression);
-			this.chunks = [refChunk];
+			const expression = TextChunkExpression.fromTranslation(context, refExpression);
+			if (expression != null) {
+				this.chunks = [expression];
+			} else {
+				this.chunks = [TextChunkExpression.fromReference(context, refExpression)];
+			}
 		}
 	}
 }

package/src/parse/text/abstract/TextRangeDefinition.ts

@@ -2,7 +2,7 @@ import type { LocalNamedElement } from '@getodk/common/types/dom.ts';
 import type { TextRole } from '../../../client/TextRange.ts';
 import type { XFormDefinition } from '../../../parse/XFormDefinition.ts';
 import { DependencyContext } from '../../expression/abstract/DependencyContext.ts';
-import type { AnyTextChunkExpression } from '../../expression/abstract/TextChunkExpression.ts';
+import type { TextChunkExpression } from '../../expression/TextChunkExpression.ts';
 import type { AnyMessageDefinition } from '../MessageDefinition.ts';
 import type { AnyTextElementDefinition } from './TextElementDefinition.ts';
 
@@ -24,7 +24,7 @@ export abstract class TextRangeDefinition<Role extends TextRole> extends Depende
 	readonly parentReference: string | null;
 	readonly reference: string | null;
 
-	abstract readonly chunks: readonly AnyTextChunkExpression[];
+	abstract readonly chunks: ReadonlyArray<TextChunkExpression<'nodes' | 'string'>>;
 
 	override get isTranslated(): boolean {
 		return (

package/src/parse/xpath/semantic-analysis.ts

@@ -117,9 +117,14 @@ export type TranslationExpression = LocalNamedFunctionCallLiteral<'itext'>;
 export const isTranslationExpression = (
 	expression: string
 ): expression is TranslationExpression => {
-	const { rootNode } = expressionParser.parse(expression);
-	const functionCallNode = findTypedPrincipalExpressionNode(['function_call'], rootNode);
+	let result;
+	try {
+		result = expressionParser.parse(expression);
+	} catch {
+		return false;
+	}
 
+	const functionCallNode = findTypedPrincipalExpressionNode(['function_call'], result.rootNode);
 	if (functionCallNode == null) {
 		return false;
 	}

package/dist/parse/expression/TextLiteralExpression.d.ts

@@ -1,9 +0,0 @@
-import { AnyTextRangeDefinition } from '../text/abstract/TextRangeDefinition.ts';
-import { TextChunkExpression } from './abstract/TextChunkExpression.ts';
-export type TextLiteralSourceNode = Attr | Text;
-export declare class TextLiteralExpression extends TextChunkExpression<'literal'> {
-    readonly stringValue: string;
-    static from(context: AnyTextRangeDefinition, stringValue: string): TextLiteralExpression;
-    readonly source = "literal";
-    private constructor();
-}

package/dist/parse/expression/TextOutputExpression.d.ts

@@ -1,7 +0,0 @@
-import { AnyTextRangeDefinition } from '../text/abstract/TextRangeDefinition.ts';
-import { TextChunkExpression } from './abstract/TextChunkExpression.ts';
-export declare class TextOutputExpression extends TextChunkExpression<'output'> {
-    static from(context: AnyTextRangeDefinition, element: Element): TextOutputExpression | null;
-    readonly source = "output";
-    private constructor();
-}

package/dist/parse/expression/TextReferenceExpression.d.ts

@@ -1,7 +0,0 @@
-import { AnyTextRangeDefinition } from '../text/abstract/TextRangeDefinition.ts';
-import { TextChunkExpression } from './abstract/TextChunkExpression.ts';
-export declare class TextReferenceExpression extends TextChunkExpression<'reference'> {
-    static from(context: AnyTextRangeDefinition, refExpression: string): TextReferenceExpression;
-    readonly source = "reference";
-    private constructor();
-}

package/dist/parse/expression/TextTranslationExpression.d.ts

@@ -1,8 +0,0 @@
-import { AnyTextRangeDefinition } from '../text/abstract/TextRangeDefinition.ts';
-import { TextChunkExpression } from './abstract/TextChunkExpression.ts';
-export declare class TextTranslationExpression extends TextChunkExpression<'translation'> {
-    static fromMessage(context: AnyTextRangeDefinition, maybeExpression: string): TextTranslationExpression | null;
-    static from(context: AnyTextRangeDefinition, maybeExpression: string): TextTranslationExpression | null;
-    readonly source = "translation";
-    private constructor();
-}

package/dist/parse/expression/abstract/TextChunkExpression.d.ts

@@ -1,17 +0,0 @@
-import { TextChunkSource } from '../../../client/TextRange.ts';
-import { AnyTextRangeDefinition } from '../../text/abstract/TextRangeDefinition.ts';
-import { TextLiteralExpression } from '../TextLiteralExpression.ts';
-import { TextOutputExpression } from '../TextOutputExpression.ts';
-import { TextReferenceExpression } from '../TextReferenceExpression.ts';
-import { TextTranslationExpression } from '../TextTranslationExpression.ts';
-import { DependentExpression } from './DependentExpression.ts';
-interface TextChunkExpressionOptions {
-    readonly isTranslated?: true;
-}
-export declare abstract class TextChunkExpression<Source extends TextChunkSource> extends DependentExpression<'string'> {
-    abstract readonly source: Source;
-    readonly stringValue?: string;
-    constructor(context: AnyTextRangeDefinition, expression: string, options?: TextChunkExpressionOptions);
-}
-export type AnyTextChunkExpression = TextLiteralExpression | TextOutputExpression | TextReferenceExpression | TextTranslationExpression;
-export {};

package/src/parse/expression/TextLiteralExpression.ts

@@ -1,19 +0,0 @@
-import type { AnyTextRangeDefinition } from '../text/abstract/TextRangeDefinition.ts';
-import { TextChunkExpression } from './abstract/TextChunkExpression.ts';
-
-export type TextLiteralSourceNode = Attr | Text;
-
-export class TextLiteralExpression extends TextChunkExpression<'literal'> {
-	static from(context: AnyTextRangeDefinition, stringValue: string): TextLiteralExpression {
-		return new this(context, stringValue);
-	}
-
-	readonly source = 'literal';
-
-	private constructor(
-		context: AnyTextRangeDefinition,
-		override readonly stringValue: string
-	) {
-		super(context, 'null');
-	}
-}

package/src/parse/expression/TextOutputExpression.ts

@@ -1,25 +0,0 @@
-import type { KnownAttributeLocalNamedElement } from '@getodk/common/types/dom.ts';
-import type { AnyTextRangeDefinition } from '../text/abstract/TextRangeDefinition.ts';
-import { TextChunkExpression } from './abstract/TextChunkExpression.ts';
-
-interface OutputElement extends KnownAttributeLocalNamedElement<'output', 'value'> {}
-
-const isOutputElement = (element: Element): element is OutputElement => {
-	return element.localName === 'output' && element.hasAttribute('value');
-};
-
-export class TextOutputExpression extends TextChunkExpression<'output'> {
-	static from(context: AnyTextRangeDefinition, element: Element): TextOutputExpression | null {
-		if (isOutputElement(element)) {
-			return new this(context, element);
-		}
-
-		return null;
-	}
-
-	readonly source = 'output';
-
-	private constructor(context: AnyTextRangeDefinition, element: OutputElement) {
-		super(context, element.getAttribute('value'));
-	}
-}

package/src/parse/expression/TextReferenceExpression.ts

@@ -1,14 +0,0 @@
-import type { AnyTextRangeDefinition } from '../text/abstract/TextRangeDefinition.ts';
-import { TextChunkExpression } from './abstract/TextChunkExpression.ts';
-
-export class TextReferenceExpression extends TextChunkExpression<'reference'> {
-	static from(context: AnyTextRangeDefinition, refExpression: string): TextReferenceExpression {
-		return new this(context, refExpression);
-	}
-
-	readonly source = 'reference';
-
-	private constructor(context: AnyTextRangeDefinition, refExpression: string) {
-		super(context, refExpression);
-	}
-}

package/src/parse/expression/TextTranslationExpression.ts

@@ -1,38 +0,0 @@
-import { expressionParser } from '@getodk/xpath/expressionParser.js';
-import type { AnyTextRangeDefinition } from '../text/abstract/TextRangeDefinition.ts';
-import type { TranslationExpression } from '../xpath/semantic-analysis.ts';
-import { isTranslationExpression } from '../xpath/semantic-analysis.ts';
-import { TextChunkExpression } from './abstract/TextChunkExpression.ts';
-
-export class TextTranslationExpression extends TextChunkExpression<'translation'> {
-	static fromMessage(
-		context: AnyTextRangeDefinition,
-		maybeExpression: string
-	): TextTranslationExpression | null {
-		try {
-			expressionParser.parse(maybeExpression);
-		} catch {
-			return null;
-		}
-
-		if (isTranslationExpression(maybeExpression)) {
-			return new this(context, maybeExpression);
-		}
-
-		return null;
-	}
-
-	static from(context: AnyTextRangeDefinition, maybeExpression: string) {
-		if (isTranslationExpression(maybeExpression)) {
-			return new this(context, maybeExpression);
-		}
-
-		return null;
-	}
-
-	readonly source = 'translation';
-
-	private constructor(context: AnyTextRangeDefinition, expression: TranslationExpression) {
-		super(context, expression, { isTranslated: true });
-	}
-}

package/src/parse/expression/abstract/TextChunkExpression.ts

@@ -1,38 +0,0 @@
-import type { TextChunkSource } from '../../../client/TextRange.ts';
-import type { AnyTextRangeDefinition } from '../../text/abstract/TextRangeDefinition.ts';
-import type { TextLiteralExpression } from '../TextLiteralExpression.ts';
-import type { TextOutputExpression } from '../TextOutputExpression.ts';
-import type { TextReferenceExpression } from '../TextReferenceExpression.ts';
-import type { TextTranslationExpression } from '../TextTranslationExpression.ts';
-import { DependentExpression } from './DependentExpression.ts';
-
-interface TextChunkExpressionOptions {
-	readonly isTranslated?: true;
-}
-
-export abstract class TextChunkExpression<
-	Source extends TextChunkSource,
-> extends DependentExpression<'string'> {
-	abstract readonly source: Source;
-	readonly stringValue?: string;
-
-	constructor(
-		context: AnyTextRangeDefinition,
-		expression: string,
-		options: TextChunkExpressionOptions = {}
-	) {
-		super(context, 'string', expression, {
-			semanticDependencies: {
-				translations: options.isTranslated,
-			},
-			ignoreContextReference: true,
-		});
-	}
-}
-
-// prettier-ignore
-export type AnyTextChunkExpression =
-	| TextLiteralExpression
-	| TextOutputExpression
-	| TextReferenceExpression
-	| TextTranslationExpression;