@getodk/xforms-engine 0.16.1 → 0.17.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@getodk/xforms-engine",
-  "version": "0.16.1",
+  "version": "0.17.0",
   "license": "Apache-2.0",
   "description": "XForms engine for ODK Web Forms",
   "type": "module",
@@ -63,7 +63,7 @@
   "devDependencies": {
     "@babel/core": "^7.28.5",
     "@getodk/tree-sitter-xpath": "0.2.2",
-    "@getodk/xpath": "0.9.2",
+    "@getodk/xpath": "0.10.0",
     "@playwright/test": "^1.57.0",
     "@types/papaparse": "^5.5.0",
     "@vitest/browser": "^3.2.4",

package/src/client/InputNode.ts

@@ -49,8 +49,8 @@ interface InputNodeOptionsByValueType {
 	readonly time: null;
 	readonly dateTime: null;
 	readonly geopoint: GeoInputNodeOptions;
-	readonly geotrace: GeoInputNodeOptions;
-	readonly geoshape: GeoInputNodeOptions;
+	readonly geotrace: null;
+	readonly geoshape: null;
 	readonly binary: null;
 	readonly barcode: null;
 	readonly intent: null;
@@ -86,12 +86,16 @@ export type IntInputValue = InputValue<'int'>;
 export type DecimalInputValue = InputValue<'decimal'>;
 export type DateInputValue = InputValue<'date'>;
 export type GeopointInputValue = InputValue<'geopoint'>;
+export type GeoshapeInputValue = InputValue<'geoshape'>;
+export type GeotraceInputValue = InputValue<'geotrace'>;
 
 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'>;
+export type GeoshapeInputNode = InputNode<'geoshape'>;
+export type GeotraceInputNode = InputNode<'geotrace'>;
 
 // prettier-ignore
 type SupportedInputValueType =
@@ -100,7 +104,9 @@ type SupportedInputValueType =
 	| 'int'
 	| 'decimal'
 	| 'date'
-	| 'geopoint';
+	| 'geopoint'
+	| 'geoshape'
+	| 'geotrace';
 
 type TemporaryStringValueType = Exclude<ValueType, SupportedInputValueType>;
 
@@ -114,4 +120,6 @@ export type AnyInputNode =
 	| DecimalInputNode
 	| DateInputNode
 	| GeopointInputNode
+	| GeoshapeInputNode
+	| GeotraceInputNode
 	| TemporaryStringValueInputNode;

package/src/client/MarkdownNode.ts

@@ -16,17 +16,20 @@ export type ElementName =
 export type MarkdownNode = ChildMarkdownNode | HtmlMarkdownNode | ParentMarkdownNode;
 
 export interface ParentMarkdownNode {
+	readonly id: string;
 	readonly role: 'parent';
 	readonly elementName: string;
 	readonly children: MarkdownNode[];
 }
 
 export interface ChildMarkdownNode {
+	readonly id: string;
 	readonly role: 'child';
 	readonly value: string;
 }
 
 export interface HtmlMarkdownNode {
+	readonly id: string;
 	readonly role: 'html';
 	readonly unsafeHtml: string;
 }

package/src/client/NoteNode.ts

@@ -83,12 +83,16 @@ export type IntNoteValue = NoteValue<'int'>;
 export type DecimalNoteValue = NoteValue<'decimal'>;
 export type DateNoteValue = NoteValue<'date'>;
 export type GeopointNoteValue = NoteValue<'geopoint'>;
+export type GeoshapeNoteValue = NoteValue<'geoshape'>;
+export type GeotraceNoteValue = NoteValue<'geotrace'>;
 
 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'>;
+export type GeoshapeNoteNode = NoteNode<'geoshape'>;
+export type GeotraceNoteNode = NoteNode<'geotrace'>;
 
 // prettier-ignore
 type SupportedNoteValueType =
@@ -97,7 +101,9 @@ type SupportedNoteValueType =
 	| 'int'
 	| 'decimal'
 	| 'date'
-	| 'geopoint';
+	| 'geopoint'
+	| 'geoshape'
+	| 'geotrace';
 
 type TemporaryStringValueType = Exclude<ValueType, SupportedNoteValueType>;
 
@@ -111,4 +117,6 @@ export type AnyNoteNode =
 	| DecimalNoteNode
 	| DateNoteNode
 	| GeopointNoteNode
+	| GeoshapeNoteNode
+	| GeotraceNoteNode
 	| TemporaryStringValueNoteNode;

package/src/client/form/FormInstanceConfig.ts

@@ -16,6 +16,10 @@ export interface PreloadProperties {
 	readonly phoneNumber?: string;
 }
 
+export interface GeolocationProvider {
+	getLocation(): Promise<string>;
+}
+
 export interface FormInstanceConfig {
 	/**
 	 * A client may specify a generic function for constructing stateful objects.
@@ -35,4 +39,6 @@ export interface FormInstanceConfig {
 	readonly instanceAttachments?: InstanceAttachmentsConfig;
 
 	readonly preloadProperties?: PreloadProperties;
+
+	readonly geolocationProvider?: GeolocationProvider;
 }

package/src/client/form/LoadFormResult.ts

@@ -3,6 +3,7 @@ import type { AnyFunction } from '@getodk/common/types/helpers.js';
 import type { LoadFormFailureError } from '../../error/LoadFormFailureError.ts';
 import type { CreateFormInstance } from './CreateFormInstance.ts';
 import type { EditFormInstance } from './EditFormInstance.ts';
+import type { ResetFormInstance } from './ResetFormInstance.ts';
 import type { RestoreFormInstance } from './RestoreFormInstance.ts';
 
 // Re-export for client access
@@ -44,6 +45,7 @@ interface BaseLoadFormResult {
 	readonly warnings: LoadFormWarnings | null;
 	readonly error: LoadFormFailureError | null;
 	readonly createInstance: FallibleLoadFormResultMethod<CreateFormInstance>;
+	readonly resetInstance: FallibleLoadFormResultMethod<ResetFormInstance>;
 	readonly editInstance: FallibleLoadFormResultMethod<EditFormInstance>;
 	readonly restoreInstance: FallibleLoadFormResultMethod<RestoreFormInstance>;
 }
@@ -53,6 +55,7 @@ export interface LoadFormSuccessResult extends BaseLoadFormResult {
 	readonly warnings: null;
 	readonly error: null;
 	readonly createInstance: CreateFormInstance;
+	readonly resetInstance: ResetFormInstance;
 	readonly editInstance: EditFormInstance;
 	readonly restoreInstance: RestoreFormInstance;
 }
@@ -62,6 +65,7 @@ export interface LoadFormWarningResult extends BaseLoadFormResult {
 	readonly warnings: LoadFormWarnings;
 	readonly error: null;
 	readonly createInstance: CreateFormInstance;
+	readonly resetInstance: ResetFormInstance;
 	readonly editInstance: EditFormInstance;
 	readonly restoreInstance: RestoreFormInstance;
 }
@@ -70,25 +74,9 @@ export interface LoadFormFailureResult extends BaseLoadFormResult {
 	readonly status: 'failure';
 	readonly warnings: LoadFormWarnings | null;
 	readonly error: LoadFormFailureError;
-
-	/**
-	 * @example A temporary demo integration was built during development of this
-	 * interface.
-	 *
-	 * @see
-	 * {@link https://github.com/getodk/web-forms/pull/345/commits/9ef36355d89dd1450d3a87c3a55506bb9b0fc414}
-	 */
 	readonly createInstance: FailedLoadFormResultMethod<CreateFormInstance>;
-
+	readonly resetInstance: FailedLoadFormResultMethod<ResetFormInstance>;
 	readonly editInstance: FailedLoadFormResultMethod<EditFormInstance>;
-
-	/**
-	 * @example A temporary demo integration was built during development of this
-	 * interface.
-	 *
-	 * @see
-	 * {@link https://github.com/getodk/web-forms/pull/345/commits/9ef36355d89dd1450d3a87c3a55506bb9b0fc414}
-	 */
 	readonly restoreInstance: FailedLoadFormResultMethod<RestoreFormInstance>;
 }
 

package/src/client/form/ResetFormInstance.ts

@@ -0,0 +1,17 @@
+import type { RootNode } from '../RootNode.ts';
+import type { CreatedFormInstance } from './CreateFormInstance.ts';
+import type { FormInstanceConfig } from './FormInstanceConfig.ts';
+import type { LoadForm } from './LoadForm.ts';
+import type { LoadFormResult } from './LoadFormResult.ts';
+
+/**
+ * @todo This is fallible! Client-facing interfaces will need to account for
+ * this. We've begun addressing fallibility _at the interface level_ in
+ * {@link LoadForm} (with {@link LoadFormResult}). We'll eventually have a more
+ * general interface pattern for this, and we'll apply it here as well. The baby
+ * step approach in {@link LoadFormResult} is impractical here due to
+ * engine-internal designs, and revising that is currently out of scope. As
+ * such, explicit interface-level documentation of fallibility is deferred here,
+ * on {@link RootNode} itself, and into any of its sub-interfaces.
+ */
+export type ResetFormInstance = (config?: FormInstanceConfig) => CreatedFormInstance;

package/src/entrypoints/FormInstance.ts

@@ -42,6 +42,7 @@ export class FormInstance<Mode extends FormInstanceInitializationMode>
 			clientStateFactory: instanceConfig.stateFactory ?? identity,
 			computeAttachmentName: instanceConfig.instanceAttachments?.fileNameFactory ?? (() => null),
 			preloadProperties: instanceConfig.preloadProperties ?? {},
+			geolocationProvider: instanceConfig.geolocationProvider,
 		};
 		const primaryInstanceOptions: PrimaryInstanceOptions<Mode> = {
 			...options.instanceOptions,
@@ -49,6 +50,7 @@ export class FormInstance<Mode extends FormInstanceInitializationMode>
 			initialState,
 			config,
 		};
+
 		const { root } = new PrimaryInstance(primaryInstanceOptions);
 
 		this.mode = mode;

package/src/entrypoints/FormResult/BaseFormResult.ts

@@ -29,6 +29,7 @@ export abstract class BaseFormResult<Status extends FormResultStatus> {
 	readonly error: BaseFormResultProperty<Status, 'error'>;
 
 	abstract readonly createInstance: BaseFormResultProperty<Status, 'createInstance'>;
+	abstract readonly resetInstance: BaseFormResultProperty<Status, 'resetInstance'>;
 	abstract readonly editInstance: BaseFormResultProperty<Status, 'editInstance'>;
 	abstract readonly restoreInstance: BaseFormResultProperty<Status, 'restoreInstance'>;
 

package/src/entrypoints/FormResult/BaseInstantiableFormResult.ts

@@ -5,6 +5,7 @@ import type {
 } from '../../client/form/EditFormInstance.ts';
 import type { FormInstanceConfig } from '../../client/form/FormInstanceConfig.ts';
 import type { FormResultStatus } from '../../client/form/LoadFormResult.ts';
+import type { ResetFormInstance } from '../../client/form/ResetFormInstance.ts';
 import type {
 	RestoreFormInstance,
 	RestoreFormInstanceInput,
@@ -13,7 +14,8 @@ import { ErrorProductionDesignPendingError } from '../../error/ErrorProductionDe
 import { InitialInstanceState } from '../../instance/input/InitialInstanceState.ts';
 import type { BasePrimaryInstanceOptions } from '../../instance/PrimaryInstance.ts';
 import type { FormResource } from '../../instance/resource.ts';
-import type { ReactiveScope } from '../../lib/reactivity/scope.ts';
+import { type ReactiveScope } from '../../lib/reactivity/scope.ts';
+import { createPotentiallyClientOwnedReactiveScope } from '../createPotentiallyClientOwnedReactiveScope.ts';
 import type { InstantiableFormResult } from '../FormInstance.ts';
 import { FormInstance } from '../FormInstance.ts';
 import type { BaseFormResultProperty } from './BaseFormResult.ts';
@@ -37,6 +39,7 @@ export abstract class BaseInstantiableFormResult<
 	Status extends InstantiableFormResultStatus,
 > extends BaseFormResult<Status> {
 	readonly createInstance: CreateFormInstance;
+	readonly resetInstance: ResetFormInstance;
 	readonly editInstance: EditFormInstance;
 	readonly restoreInstance: RestoreFormInstance;
 
@@ -60,6 +63,12 @@ export abstract class BaseInstantiableFormResult<
 			});
 		};
 
+		this.resetInstance = (instanceConfig: FormInstanceConfig = {}) => {
+			instanceOptions.scope.dispose();
+			instanceOptions.scope = createPotentiallyClientOwnedReactiveScope();
+			return this.createInstance(instanceConfig);
+		};
+
 		this.editInstance = async (
 			input: EditFormInstanceInput,
 			instanceConfig: FormInstanceConfig = {}

package/src/entrypoints/FormResult/FormFailureResult.ts

@@ -6,6 +6,7 @@ import type {
 	LoadFormFailureResult,
 	LoadFormWarnings,
 } from '../../client/form/LoadFormResult.ts';
+import type { ResetFormInstance } from '../../client/form/ResetFormInstance.ts';
 import type { RestoreFormInstance } from '../../client/form/RestoreFormInstance.ts';
 import { LoadFormFailureError } from '../../error/LoadFormFailureError.ts';
 import { BaseFormResult } from './BaseFormResult.ts';
@@ -25,6 +26,7 @@ const failedFormResultMethodFactory = <T extends AnyFunction>(
 
 export class FormFailureResult extends BaseFormResult<'failure'> implements LoadFormFailureResult {
 	readonly createInstance: FailedLoadFormResultMethod<CreateFormInstance>;
+	readonly resetInstance: FailedLoadFormResultMethod<ResetFormInstance>;
 	readonly editInstance: FailedLoadFormResultMethod<EditFormInstance>;
 	readonly restoreInstance: FailedLoadFormResultMethod<RestoreFormInstance>;
 
@@ -38,6 +40,7 @@ export class FormFailureResult extends BaseFormResult<'failure'> implements Load
 		});
 
 		this.createInstance = failedFormResultMethodFactory(error);
+		this.resetInstance = failedFormResultMethodFactory(error);
 		this.editInstance = failedFormResultMethodFactory(error);
 		this.restoreInstance = failedFormResultMethodFactory(error);
 	}

package/src/entrypoints/createPotentiallyClientOwnedReactiveScope.ts

@@ -0,0 +1,30 @@
+import { getOwner, type Owner } from 'solid-js';
+import { createReactiveScope, type ReactiveScope } from '../lib/reactivity/scope';
+
+/**
+ * Creates a {@link ReactiveScope | reactive scope} from which all form
+ * instances derive, and:
+ *
+ * - if a client loads a form within a Solid reactive context, the scope will be
+ *   disposed along with the client's reactive context; OR
+ * - if a client loads a form outside a Solid reactive context (typically: if a
+ *   client does not use Solid reactivity), the scope will disposed if and when
+ *   the engine drops access to the loaded form
+ *
+ * **IMPORTANT:** this **MUST** be called synchronously. If it is called in an
+ * `async` function, it **MUST** be called before any `await` expression; if it
+ * is called in any other flow with mixed synchrony, it must be called before
+ * yielding to the event loop. Failing to do this will cause the engine to lose
+ * access to a client's Solid reactive context, potentially leaking form
+ * reactivity indefinitely.
+ */
+export const createPotentiallyClientOwnedReactiveScope = (): ReactiveScope => {
+	/**
+	 * A {@link clientOwner | client owner} is the owner of a client's Solid
+	 * reactive context, if one exists. If none exists, the {@link ReactiveScope}
+	 * is fully owned by the engine.
+	 */
+	const clientOwner: Owner | null = getOwner();
+
+	return createReactiveScope({ owner: clientOwner });
+};

package/src/entrypoints/loadForm.ts

@@ -1,5 +1,3 @@
-import type { Owner } from 'solid-js';
-import { getOwner } from 'solid-js';
 import { MISSING_RESOURCE_BEHAVIOR } from '../client/constants.ts';
 import type { FormResource } from '../client/form/FormResource.ts';
 import type { LoadForm, LoadFormOptions } from '../client/form/LoadForm.ts';
@@ -7,40 +5,12 @@ import type { LoadFormResult } from '../client/form/LoadFormResult.ts';
 import { LoadFormFailureError } from '../error/LoadFormFailureError.ts';
 import { retrieveFormDefinition } from '../instance/resource.ts';
 import type { ReactiveScope } from '../lib/reactivity/scope.ts';
-import { createReactiveScope } from '../lib/reactivity/scope.ts';
 import { XFormDOM } from '../parse/XFormDOM.ts';
 import { XFormDefinition } from '../parse/XFormDefinition.ts';
 import { SecondaryInstancesDefinition } from '../parse/model/SecondaryInstance/SecondaryInstancesDefinition.ts';
 import { FormFailureResult } from './FormResult/FormFailureResult.ts';
 import { FormSuccessResult } from './FormResult/FormSuccessResult.ts';
-
-/**
- * Creates a {@link ReactiveScope | reactive scope} from which all form
- * instances derive, and:
- *
- * - if a client loads a form within a Solid reactive context, the scope will be
- *   disposed along with the client's reactive context; OR
- * - if a client loads a form outside a Solid reactive context (typically: if a
- *   client does not use Solid reactivity), the scope will disposed if and when
- *   the engine drops access to the loaded form
- *
- * **IMPORTANT:** this **MUST** be called synchronously. If it is called in an
- * `async` function, it **MUST** be called before any `await` expression; if it
- * is called in any other flow with mixed synchrony, it must be called before
- * yielding to the event loop. Failing to do this will cause the engine to lose
- * access to a client's Solid reactive context, potentially leaking form
- * reactivity indefinitely.
- */
-const createPotentiallyClientOwnedReactiveScope = (): ReactiveScope => {
-	/**
-	 * A {@link clientOwner | client owner} is the owner of a client's Solid
-	 * reactive context, if one exists. If none exists, the {@link ReactiveScope}
-	 * is fully owned by the engine.
-	 */
-	const clientOwner: Owner | null = getOwner();
-
-	return createReactiveScope({ owner: clientOwner });
-};
+import { createPotentiallyClientOwnedReactiveScope } from './createPotentiallyClientOwnedReactiveScope.ts';
 
 type GlobalFetch = typeof globalThis.fetch;
 

package/src/instance/InputControl.ts

@@ -41,9 +41,7 @@ const stringInputNodeOptions = (control: InputControlDefinition): InputNodeOptio
 	rows: control.rows,
 });
 
-const geoInputNodeOptions = (
-	control: InputControlDefinition
-): InputNodeOptions<'geopoint' | 'geoshape' | 'geotrace'> => ({
+const geoInputNodeOptions = (control: InputControlDefinition): InputNodeOptions<'geopoint'> => ({
 	accuracyThreshold: control.accuracyThreshold,
 	unacceptableAccuracyThreshold: control.unacceptableAccuracyThreshold,
 });
@@ -65,8 +63,8 @@ const nodeOptionsFactoryByType: NodeOptionsFactoryByType = {
 	time: () => null,
 	dateTime: () => null,
 	geopoint: geoInputNodeOptions,
-	geotrace: geoInputNodeOptions,
-	geoshape: geoInputNodeOptions,
+	geotrace: () => null,
+	geoshape: () => null,
 	binary: () => null,
 	barcode: () => null,
 	intent: () => null,

package/src/instance/PrimaryInstance.ts

@@ -1,6 +1,7 @@
-import { XPathNodeKindKey } from '@getodk/xpath';
+import { clearCache, XPathNodeKindKey } from '@getodk/xpath';
 import type { Accessor } from 'solid-js';
 import { createSignal } from 'solid-js';
+import type { GeolocationProvider } from '../client';
 import type { FormInstanceInitializationMode } from '../client/form/FormInstance.ts';
 import type { ActiveLanguage, FormLanguage, FormLanguages } from '../client/FormLanguage.ts';
 import type { FormNodeID } from '../client/identity.ts';
@@ -87,6 +88,7 @@ interface PrimaryInstanceStateSpec {
 
 interface PrimaryInstanceStateInputByMode {
 	readonly create: null;
+	readonly reset: null;
 	readonly edit: InitialInstanceState;
 	readonly restore: InitialInstanceState;
 }
@@ -95,7 +97,7 @@ export type PrimaryInstanceInitialState<Mode extends FormInstanceInitializationM
 	PrimaryInstanceStateInputByMode[Mode];
 
 export interface BasePrimaryInstanceOptions {
-	readonly scope: ReactiveScope;
+	scope: ReactiveScope;
 	readonly model: ModelDefinition;
 	readonly secondaryInstances: SecondaryInstancesDefinition;
 }
@@ -137,6 +139,7 @@ export class PrimaryInstance<
 	readonly hasNonRelevantAncestor = () => false;
 	readonly isRelevant = () => true;
 
+	private geolocationProvider: GeolocationProvider | undefined;
 	// TranslationContext (support)
 	private readonly setActiveLanguage: SimpleAtomicStateSetter<FormLanguage>;
 
@@ -168,6 +171,8 @@ export class PrimaryInstance<
 		const activeInstance = initialState?.document ?? modelInstance;
 		const definition = model.getRootDefinition(activeInstance);
 
+		clearCache();
+
 		super(config, null, activeInstance, definition, {
 			scope,
 			computeReference: () => PRIMARY_INSTANCE_REFERENCE,
@@ -177,6 +182,7 @@ export class PrimaryInstance<
 		this.model = model;
 		this.attachments = new InstanceAttachmentsState(initialState?.attachments);
 		this.instanceNode = activeInstance;
+		this.geolocationProvider = config.geolocationProvider;
 
 		const [isAttached, setIsAttached] = createSignal(false);
 
@@ -294,4 +300,13 @@ export class PrimaryInstance<
 
 		return Promise.resolve(result);
 	}
+
+	async getBackgroundGeopoint(): Promise<string> {
+		if (!this.geolocationProvider) {
+			return '';
+		}
+
+		const location = await this.geolocationProvider.getLocation();
+		return location ?? '';
+	}
 }

package/src/instance/attachments/buildAttributes.ts

@@ -1,3 +1,6 @@
+import type { StaticAttribute } from '../../integration/xpath/static-dom/StaticAttribute.ts';
+import type { StaticDocument } from '../../integration/xpath/static-dom/StaticDocument.ts';
+import type { StaticElement } from '../../integration/xpath/static-dom/StaticElement.ts';
 import { Attribute } from '../Attribute';
 import type { AnyNode } from '../hierarchy.ts';
 import type { InputControl } from '../InputControl.ts';
@@ -5,6 +8,19 @@ import type { ModelValue } from '../ModelValue.ts';
 import type { Note } from '../Note.ts';
 import type { RangeControl } from '../RangeControl.ts';
 
+function buildInstanceAttributeMap(
+	instanceNode: StaticAttribute | StaticDocument | StaticElement | null
+): Map<string, StaticAttribute> {
+	const map = new Map<string, StaticAttribute>();
+	if (!instanceNode) {
+		return map;
+	}
+	for (const attribute of instanceNode.attributes) {
+		map.set(attribute.qualifiedName.getPrefixedName(), attribute);
+	}
+	return map;
+}
+
 export function buildAttributes(
 	// eslint-disable-next-line @typescript-eslint/no-explicit-any
 	owner: AnyNode | InputControl<any> | ModelValue<any> | Note<any> | RangeControl<any>
@@ -13,7 +29,11 @@ export function buildAttributes(
 	if (!attributes) {
 		return [];
 	}
+	const instanceAttributes = buildInstanceAttributeMap(owner.instanceNode);
 	return Array.from(attributes.values()).map((attributeDefinition) => {
-		return new Attribute(owner, attributeDefinition, attributeDefinition.template);
+		const instanceNode =
+			instanceAttributes.get(attributeDefinition.qualifiedName.getPrefixedName()) ??
+			attributeDefinition.template;
+		return new Attribute(owner, attributeDefinition, instanceNode);
 	});
 }

package/src/instance/internal-api/AttributeContext.ts

@@ -11,6 +11,7 @@ import type { InstanceConfig } from './InstanceConfig.ts';
 export interface InstanceAttributeContextDocument {
 	readonly initializationMode: FormInstanceInitializationMode;
 	readonly isAttached: Accessor<boolean>;
+	getBackgroundGeopoint: Accessor<Promise<string>>;
 }
 
 export type DecodeInstanceValue = (value: string) => string;

package/src/instance/internal-api/InstanceConfig.ts

@@ -1,6 +1,7 @@
 import type { InstanceAttachmentFileNameFactory } from '../../client/attachments/InstanceAttachmentsConfig.ts';
 import type {
 	FormInstanceConfig,
+	GeolocationProvider,
 	PreloadProperties,
 } from '../../client/form/FormInstanceConfig.ts';
 import type { OpaqueReactiveObjectFactory } from '../../client/OpaqueReactiveObjectFactory.ts';
@@ -14,4 +15,6 @@ export interface InstanceConfig {
 	readonly computeAttachmentName: InstanceAttachmentFileNameFactory;
 
 	readonly preloadProperties: PreloadProperties;
+
+	readonly geolocationProvider: GeolocationProvider | undefined;
 }

package/src/instance/internal-api/InstanceValueContext.ts

@@ -11,6 +11,7 @@ import type { InstanceConfig } from './InstanceConfig.ts';
 export interface InstanceValueContextDocument {
 	readonly initializationMode: FormInstanceInitializationMode;
 	readonly isAttached: Accessor<boolean>;
+	getBackgroundGeopoint: Accessor<Promise<string>>;
 }
 
 export type DecodeInstanceValue = (value: string) => string;

package/src/instance/markdown/MarkdownNode.ts

@@ -2,18 +2,26 @@ import {
 	type AnchorMarkdownNode,
 	type ChildMarkdownNode as ClientChildMarkdownNode,
 	type HtmlMarkdownNode as ClientHtmlMarkdownNode,
+	type MarkdownNode as ClientMarkdownNode,
 	type ParentMarkdownNode as ClientParentMarkdownNode,
 	type StyledMarkdownNode as ClientStyledMarkdownNode,
 	type ElementName,
-	type MarkdownNode,
 	type MarkdownProperty,
 } from '../../client';
 
-abstract class ParentMarkdownNode implements ClientParentMarkdownNode {
+abstract class MarkdownNode {
+	readonly id: string;
+	constructor() {
+		this.id = crypto.randomUUID();
+	}
+}
+
+abstract class ParentMarkdownNode extends MarkdownNode implements ClientParentMarkdownNode {
 	readonly children;
 	readonly role = 'parent';
 	abstract elementName: ElementName;
-	constructor(children: MarkdownNode[]) {
+	constructor(children: ClientMarkdownNode[]) {
+		super();
 		this.children = children;
 	}
 }
@@ -69,18 +77,20 @@ export class ListItem extends ParentMarkdownNode {
 export class Anchor extends ParentMarkdownNode implements AnchorMarkdownNode {
 	readonly elementName = 'a';
 	readonly url: string;
-	constructor(children: MarkdownNode[], url: string) {
+	constructor(children: ClientMarkdownNode[], url: string) {
 		super(children);
 		this.url = url;
 	}
 }
 
 abstract class StyledMarkdownNode implements ClientParentMarkdownNode {
+	readonly id: string;
 	readonly children;
 	readonly role = 'parent';
 	abstract elementName: ElementName;
 	readonly properties: MarkdownProperty | undefined;
-	constructor(children: MarkdownNode[], properties: MarkdownProperty | undefined) {
+	constructor(children: ClientMarkdownNode[], properties: MarkdownProperty | undefined) {
+		this.id = crypto.randomUUID();
 		this.children = children;
 		this.properties = properties;
 	}
@@ -98,18 +108,20 @@ export class Div extends StyledMarkdownNode implements ClientStyledMarkdownNode
 	readonly elementName = 'div';
 }
 
-export class ChildMarkdownNode implements ClientChildMarkdownNode {
+export class ChildMarkdownNode extends MarkdownNode implements ClientChildMarkdownNode {
 	readonly role = 'child';
 	readonly value: string;
 	constructor(value: string) {
+		super();
 		this.value = value;
 	}
 }
 
-export class Html implements ClientHtmlMarkdownNode {
+export class Html extends MarkdownNode implements ClientHtmlMarkdownNode {
 	readonly role = 'html';
 	readonly unsafeHtml: string;
 	constructor(unsafeHtml: string) {
+		super();
 		this.unsafeHtml = unsafeHtml;
 	}
 }

package/src/instance/text/markdownFormat.ts

@@ -42,7 +42,7 @@ const SUPPORTED_HTML_TAGS = Object.entries(HTML_TAG_MAP).map(([tag, type]) => {
 	};
 });
 
-let outputStrings: Map<string, string>;
+const outputStrings = new Map<string, string>();
 
 function validateStyleProperty(name: string | undefined, value: string | undefined): boolean {
 	if (!name || !value) {
@@ -208,7 +208,8 @@ function toOdkMarkdown(str: string): MarkdownNode[] {
 }
 
 export function format(chunks: readonly TextChunk[]): MarkdownNode[] {
-	outputStrings = new Map<string, string>();
 	const str = escapeEditableChunks(chunks);
-	return toOdkMarkdown(str);
+	const result = toOdkMarkdown(str);
+	outputStrings.clear();
+	return result;
 }

package/src/integration/xpath/static-dom/StaticDocument.ts

@@ -1,4 +1,5 @@
 import type { XFormsXPathDocument } from '../adapter/XFormsXPathNode.ts';
+import type { StaticAttribute } from './StaticAttribute.ts';
 import type { StaticElementOptions } from './StaticElement.ts';
 import { StaticElement } from './StaticElement.ts';
 import { StaticParentNode } from './StaticParentNode.ts';
@@ -15,6 +16,7 @@ export class StaticDocument extends StaticParentNode<'document'> implements XFor
 	readonly nodeset: string;
 	readonly children: readonly [root: StaticElement];
 	readonly childElements: readonly [root: StaticElement];
+	readonly attributes: readonly StaticAttribute[] = [];
 
 	constructor(options: StaticDocumentOptions) {
 		super('document');