@getodk/xforms-engine 0.8.0 → 0.9.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@getodk/xforms-engine",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "license": "Apache-2.0",
   "description": "XForms engine for ODK Web Forms",
   "type": "module",
@@ -56,12 +56,13 @@
   "dependencies": {
     "bin-packer": "1.7.0",
     "papaparse": "^5.5.2",
-    "solid-js": "^1.9.5"
+    "solid-js": "^1.9.5",
+    "temporal-polyfill": "^0.3.0"
   },
   "devDependencies": {
     "@babel/core": "^7.26.10",
     "@getodk/tree-sitter-xpath": "0.1.3",
-    "@getodk/xpath": "0.4.1",
+    "@getodk/xpath": "0.5.0",
     "@playwright/test": "^1.49.1",
     "@types/papaparse": "^5.3.15",
     "@vitest/browser": "^3.0.9",

package/src/client/InputNode.ts

@@ -84,11 +84,13 @@ export interface InputNode<V extends ValueType = ValueType>
 export type StringInputValue = InputValue<'string'>;
 export type IntInputValue = InputValue<'int'>;
 export type DecimalInputValue = InputValue<'decimal'>;
+export type DateInputValue = InputValue<'date'>;
 export type GeopointInputValue = InputValue<'geopoint'>;
 
 export type StringInputNode = InputNode<'string'>;
 export type IntInputNode = InputNode<'int'>;
 export type DecimalInputNode = InputNode<'decimal'>;
+export type DateInputNode = InputNode<'date'>;
 export type GeopointInputNode = InputNode<'geopoint'>;
 
 // prettier-ignore
@@ -97,6 +99,7 @@ type SupportedInputValueType =
 	| 'string'
 	| 'int'
 	| 'decimal'
+	| 'date'
 	| 'geopoint';
 
 type TemporaryStringValueType = Exclude<ValueType, SupportedInputValueType>;
@@ -109,5 +112,6 @@ export type AnyInputNode =
 	| StringInputNode
 	| IntInputNode
 	| DecimalInputNode
+	| DateInputNode
 	| GeopointInputNode
 	| TemporaryStringValueInputNode;

package/src/client/NoteNode.ts

@@ -81,11 +81,13 @@ export interface NoteNode<V extends ValueType = ValueType> extends BaseValueNode
 export type StringNoteValue = NoteValue<'string'>;
 export type IntNoteValue = NoteValue<'int'>;
 export type DecimalNoteValue = NoteValue<'decimal'>;
+export type DateNoteValue = NoteValue<'date'>;
 export type GeopointNoteValue = NoteValue<'geopoint'>;
 
 export type StringNoteNode = NoteNode<'string'>;
 export type IntNoteNode = NoteNode<'int'>;
 export type DecimalNoteNode = NoteNode<'decimal'>;
+export type DateNoteNode = NoteNode<'date'>;
 export type GeopointNoteNode = NoteNode<'geopoint'>;
 
 // prettier-ignore
@@ -94,6 +96,7 @@ type SupportedNoteValueType =
 	| 'string'
 	| 'int'
 	| 'decimal'
+	| 'date'
 	| 'geopoint';
 
 type TemporaryStringValueType = Exclude<ValueType, SupportedNoteValueType>;
@@ -106,5 +109,6 @@ export type AnyNoteNode =
 	| StringNoteNode
 	| IntNoteNode
 	| DecimalNoteNode
+	| DateNoteNode
 	| GeopointNoteNode
 	| TemporaryStringValueNoteNode;

package/src/integration/xpath/adapter/traversal.ts

@@ -18,7 +18,9 @@ export const getContainingEngineXPathDocument = (node: EngineXPathNode): EngineX
 	return node.rootDocument;
 };
 
-export const getEngineXPathAttributes = (node: EngineXPathNode): Iterable<EngineXPathAttribute> => {
+export const getEngineXPathAttributes = (
+	node: EngineXPathNode
+): readonly EngineXPathAttribute[] => {
 	if (node.nodeType === 'static-element') {
 		return node.attributes;
 	}
@@ -39,7 +41,7 @@ export const getEngineXPathAttributes = (node: EngineXPathNode): Iterable<Engine
  * it throw? It might be nice to be alerted if the assumptions in point 2 above
  * are somehow wrong (or become wrong).
  */
-export const getNamespaceDeclarations = (): Iterable<never> => [];
+export const getNamespaceDeclarations = (): readonly [] => [];
 
 export const getParentNode = (node: EngineXPathNode): EngineXPathParentNode | null => {
 	if (node.nodeType === 'repeat-instance') {

package/src/lib/codecs/DateValueCodec.ts

@@ -0,0 +1,94 @@
+import { ISO_DATE_OR_DATE_TIME_NO_OFFSET_PATTERN } from '@getodk/common/constants/datetime.ts';
+import { Temporal } from 'temporal-polyfill';
+import { type CodecDecoder, type CodecEncoder, ValueCodec } from './ValueCodec.ts';
+
+export type DatetimeRuntimeValue = Temporal.PlainDate | null;
+
+export type DatetimeInputValue =
+	| Date
+	| Temporal.PlainDate
+	| Temporal.PlainDateTime
+	| Temporal.ZonedDateTime
+	| string
+	| null;
+
+/**
+ * Parses a string in the format 'YYYY-MM-DD' or 'YYYY-MM-DDTHH:MM:SS' (no offset)
+ * into a Temporal.PlainDate.
+ * TODO: Datetimes with a valid timezone offset are treated as errors.
+ *       User research is needed to determine whether the date should honor
+ *       the timezone or be truncated to the yyyy-mm-dd format only.
+ *
+ * @param value - The string to parse.
+ * @returns A {@link DatetimeRuntimeValue}
+ */
+const parseString = (value: string): DatetimeRuntimeValue => {
+	if (
+		value == null ||
+		typeof value !== 'string' ||
+		!ISO_DATE_OR_DATE_TIME_NO_OFFSET_PATTERN.test(value)
+	) {
+		return null;
+	}
+
+	try {
+		const dateOnly = value.split('T')[0]!;
+		return Temporal.PlainDate.from(dateOnly);
+	} catch {
+		// TODO: should we throw when codec cannot interpret the value?
+		return null;
+	}
+};
+
+/**
+ * Converts a date-like value ({@link DatetimeInputValue}) to a 'YYYY-MM-DD' string.
+ * TODO: Datetimes with a valid timezone offset are treated as errors.
+ *       User research is needed to determine whether the date should honor
+ *       the timezone or be truncated to the yyyy-mm-dd format only.
+ *
+ * @param value - The value to convert.
+ * @returns A date string or empty string if invalid.
+ */
+const toDateString = (value: DatetimeInputValue): string => {
+	if (value == null || value instanceof Temporal.ZonedDateTime) {
+		return '';
+	}
+
+	try {
+		if (value instanceof Temporal.PlainDate) {
+			return value.toString();
+		}
+
+		if (value instanceof Temporal.PlainDateTime) {
+			return value.toPlainDate().toString();
+		}
+
+		if (value instanceof Date) {
+			return Temporal.PlainDate.from({
+				year: value.getFullYear(),
+				month: value.getMonth() + 1,
+				day: value.getDate(),
+			}).toString();
+		}
+
+		const parsed = parseString(String(value));
+		return parsed?.toString() ?? '';
+	} catch {
+		// TODO: should we throw when codec cannot interpret the value?
+		return '';
+	}
+};
+
+export class DateValueCodec extends ValueCodec<'date', DatetimeRuntimeValue, DatetimeInputValue> {
+	constructor() {
+		const encodeValue: CodecEncoder<DatetimeInputValue> = (value) => {
+			return toDateString(value);
+		};
+
+		const decodeValue: CodecDecoder<DatetimeRuntimeValue> = (value: string) => {
+			return parseString(value);
+		};
+
+		super('date', encodeValue, decodeValue);
+	}
+}

package/src/lib/codecs/getSharedValueCodec.ts

@@ -1,4 +1,6 @@
 import type { ValueType } from '../../client/ValueType.ts';
+import type { DatetimeInputValue, DatetimeRuntimeValue } from './DateValueCodec.ts';
+import { DateValueCodec } from './DateValueCodec.ts';
 import {
 	DecimalValueCodec,
 	type DecimalInputValue,
@@ -16,7 +18,7 @@ interface RuntimeValuesByType {
 	readonly int: IntRuntimeValue;
 	readonly decimal: DecimalRuntimeValue;
 	readonly boolean: string;
-	readonly date: string;
+	readonly date: DatetimeRuntimeValue;
 	readonly time: string;
 	readonly dateTime: string;
 	readonly geopoint: GeopointRuntimeValue;
@@ -34,7 +36,7 @@ interface RuntimeInputValuesByType {
 	readonly int: IntInputValue;
 	readonly decimal: DecimalInputValue;
 	readonly boolean: string;
-	readonly date: string;
+	readonly date: DatetimeInputValue;
 	readonly time: string;
 	readonly dateTime: string;
 	readonly geopoint: GeopointInputValue;
@@ -63,7 +65,7 @@ export const sharedValueCodecs: SharedValueCodecs = {
 	int: new IntValueCodec(),
 	decimal: new DecimalValueCodec(),
 	boolean: new ValueTypePlaceholderCodec('boolean'),
-	date: new ValueTypePlaceholderCodec('date'),
+	date: new DateValueCodec(),
 	time: new ValueTypePlaceholderCodec('time'),
 	dateTime: new ValueTypePlaceholderCodec('dateTime'),
 	geopoint: new GeopointValueCodec(),

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

@@ -21,8 +21,8 @@ export type RefAttributeChunk =
 
 // prettier-ignore
 type TextElementChildChunk =
-	| TextOutputExpression
-	| TextLiteralExpression;
+	| TextLiteralExpression
+	| TextOutputExpression;
 
 // prettier-ignore
 type TextElementChunks =