Resolves feedback: Refactors truncate function, rename number parser file, fixes changeset, improves notes template

Author: latin-panda

.changeset/violet-chefs-dress.md

@@ -5,5 +5,5 @@
 '@getodk/common': patch
 ---
 
-Support for default geopoint question type (`<input type="geopoint">`)
-Support for geopoint note
+- Support for geopoint questions with no appearance
+- Support for geopoint notes

packages/scenario/test/smoketests/child-vaccination.test.ts

@@ -760,7 +760,7 @@ describe('ChildVaccinationTest.java', () => {
 
 			scenario.next('/data/not_single');
 			scenario.next('/data/not_single/gps');
-			scenario.answer('1.234 5.678 0 2.3');
+			scenario.answer('1.234 5.678 0 2.3'); // an accuracy of 0m or greater than 5m makes a second geopoint question relevant
 			scenario.next('/data/building_name');
 			scenario.answer('Some building');
 			scenario.next('/data/full_address1');

packages/web-forms/src/components/controls/GeopointFormattedValue.vue

@@ -26,7 +26,7 @@ const value = computed<GeopointValue>(() => {
 <template>
 	<!-- TODO: translations -->
 	<p class="geopoint-formatted-value">
-		<span v-if="value?.accuracy != null">Accuracy: {{ truncateDecimals(value.accuracy) }} m</span>
+		<span v-if="value?.accuracy != null">Accuracy: {{ truncateDecimals(value.accuracy, { decimals: 3 }) }} m</span>
 		<span v-if="value?.latitude != null">Latitude: {{ value.latitude }}</span>
 		<span v-if="value?.longitude != null">Longitude: {{ value.longitude }}</span>
 	</p>

packages/web-forms/src/components/controls/Input/Geopoint/GeolocationRequestDialog.vue

@@ -23,6 +23,8 @@ interface GeolocationRequestDialogProps {
 
 const props = defineProps<GeolocationRequestDialogProps>();
 
+const accuracyTruncateOptions = { decimals: 3 };
+
 const previousAccuracy = computed(() => {
 	return new GeopointAccuracy(props.geopoint, props.options);
 });
@@ -164,14 +166,14 @@ onBeforeUnmount(cleanup);
 				<div class="geopoint-information">
 					<!-- TODO: translations -->
 					<strong v-if="accuracy.value != null" class="geo-quality">
-						{{ truncateDecimals(accuracy.value) }} m - {{ accuracy.label }}
+						{{ truncateDecimals(accuracy.value, accuracyTruncateOptions) }} m - {{ accuracy.label }}
 					</strong>
 					<p v-if="options.accuracyThreshold > 0 && state.geopoint == null">
 						Location will be saved at {{ options.accuracyThreshold }} m
 					</p>
 					<p>Time taken to capture location: <ElapsedTime /></p>
 					<p v-if="previousAccuracy.value">
-						Previous saved location at {{ truncateDecimals(previousAccuracy.value) }} m
+						Previous saved location at {{ truncateDecimals(previousAccuracy.value, accuracyTruncateOptions) }} m
 					</p>
 				</div>
 			</div>

packages/web-forms/src/components/controls/NoteControl.vue

@@ -69,15 +69,15 @@ const value = computed<NoteRenderableValue>(() => {
 	<div class="note-control">
 		<ControlText :question="question" />
 
-		<template v-if="question.valueType === 'geopoint'">
-			<GeopointFormattedValue :question="question" />
-		</template>
+		<div v-if="value != null" class="note-value">
+			<template v-if="question.valueType === 'geopoint'">
+				<GeopointFormattedValue :question="question" />
+			</template>
 
-		<template v-else-if="value != null">
-			<div class="note-value">
+			<template v-else>
 				{{ value }}
-			</div>
-		</template>
+			</template>
+		</div>
 	</div>
 </template>
 

packages/web-forms/src/lib/format/truncateDecimals.ts

@@ -1,18 +1,27 @@
-export const truncateDecimals = (num: number, decimals = 3): string => {
-	if (
-		typeof num !== 'number' ||
-		Number.isNaN(num) ||
-		typeof decimals !== 'number' ||
-		Number.isNaN(decimals)
-	) {
+interface TruncateDecimalsOptions {
+	readonly decimals: number;
+}
+
+export const truncateDecimals = (num: number, options: TruncateDecimalsOptions): string => {
+	const { decimals } = options;
+
+	if (!Number.isFinite(decimals) || decimals < 0) {
+		throw new Error(
+			`Truncation failed: expected a finite, non-negative decimal option, got: ${decimals}`
+		);
+	}
+
+	if (!Number.isFinite(num)) {
 		return '';
 	}
 
-	if (Number.isInteger(num) || decimals <= 0) {
+	if (Number.isInteger(num)) {
 		return num.toString();
 	}
 
 	const factor = Math.pow(10, decimals);
 	const withDecimals = Math.floor(Math.abs(num) * factor) / factor;
-	return (num < 0 ? -withDecimals : withDecimals).toString();
+	const sign = Math.sign(num);
+
+	return String(withDecimals * sign);
 };

packages/xforms-engine/src/lib/NumberParsers.ts packages/xforms-engine/src/lib/number-parsers.ts

@@ -17,7 +17,7 @@ export const parseToFloat = (value: string | null): number | null => {
 	}
 
 	const parsed = Number(value);
-	if (typeof value !== 'string' || value.trim() === '' || isNaN(parsed)) {
+	if (typeof value !== 'string' || value.trim() === '' || Number.isNaN(parsed)) {
 		throw new Error(`Expected a float, but got: ${value}`);
 	}
 

packages/xforms-engine/src/parse/body/control/InputControlDefinition.ts

@@ -2,7 +2,7 @@ import type { XFormDefinition } from '../../XFormDefinition.ts';
 import type { InputAppearanceDefinition } from '../appearance/inputAppearanceParser.ts';
 import { inputAppearanceParser } from '../appearance/inputAppearanceParser.ts';
 import type { BodyElementParentContext } from '../BodyDefinition.ts';
-import { parseToFloat, parseToInteger } from '../../../lib/NumberParsers.ts';
+import { parseToFloat, parseToInteger } from '../../../lib/number-parsers.ts';
 import { ControlDefinition } from './ControlDefinition.ts';
 
 export class InputControlDefinition extends ControlDefinition<'input'> {

packages/xforms-engine/test/lib/NumberParsers.test.ts packages/xforms-engine/test/lib/number-parsers.test.ts

@@ -1,5 +1,5 @@
 import { assert, describe, expect, it } from 'vitest';
-import { parseToFloat, parseToInteger } from '../../src/lib/NumberParsers.ts';
+import { parseToFloat, parseToInteger } from '../../src/lib/number-parsers.ts';
 
 describe('NumberParsers', () => {
 	interface SuccessTestCase {