@getodk/xforms-engine 0.16.1 → 0.17.0

package/dist/instance/PrimaryInstance.d.ts

@@ -45,12 +45,13 @@ interface PrimaryInstanceStateSpec {
 }
 interface PrimaryInstanceStateInputByMode {
     readonly create: null;
+    readonly reset: null;
     readonly edit: InitialInstanceState;
     readonly restore: InitialInstanceState;
 }
 export type PrimaryInstanceInitialState<Mode extends FormInstanceInitializationMode> = PrimaryInstanceStateInputByMode[Mode];
 export interface BasePrimaryInstanceOptions {
-    readonly scope: ReactiveScope;
+    scope: ReactiveScope;
     readonly model: ModelDefinition;
     readonly secondaryInstances: SecondaryInstancesDefinition;
 }
@@ -74,6 +75,7 @@ export declare class PrimaryInstance<Mode extends FormInstanceInitializationMode
     readonly isReadonly: () => boolean;
     readonly hasNonRelevantAncestor: () => boolean;
     readonly isRelevant: () => boolean;
+    private geolocationProvider;
     private readonly setActiveLanguage;
     readonly [XPathNodeKindKey] = "document";
     readonly nodeType = "primary-instance";
@@ -112,5 +114,6 @@ export declare class PrimaryInstance<Mode extends FormInstanceInitializationMode
      */
     setLanguage(language: FormLanguage): FormLanguage;
     prepareInstancePayload<PayloadType extends InstancePayloadType = 'monolithic'>(options?: InstancePayloadOptions<PayloadType>): Promise<InstancePayload<PayloadType>>;
+    getBackgroundGeopoint(): Promise<string>;
 }
 export {};

package/dist/instance/internal-api/AttributeContext.d.ts

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

package/dist/instance/internal-api/InstanceConfig.d.ts

@@ -1,5 +1,5 @@
 import { InstanceAttachmentFileNameFactory } from '../../client/attachments/InstanceAttachmentsConfig.ts';
-import { PreloadProperties } from '../../client/form/FormInstanceConfig.ts';
+import { GeolocationProvider, PreloadProperties } from '../../client/form/FormInstanceConfig.ts';
 import { OpaqueReactiveObjectFactory } from '../../client/OpaqueReactiveObjectFactory.ts';
 export interface InstanceConfig {
     /**
@@ -8,4 +8,5 @@ export interface InstanceConfig {
     readonly clientStateFactory: OpaqueReactiveObjectFactory;
     readonly computeAttachmentName: InstanceAttachmentFileNameFactory;
     readonly preloadProperties: PreloadProperties;
+    readonly geolocationProvider: GeolocationProvider | undefined;
 }

package/dist/instance/internal-api/InstanceValueContext.d.ts

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

package/dist/instance/markdown/MarkdownNode.d.ts

@@ -1,9 +1,13 @@
-import { AnchorMarkdownNode, ChildMarkdownNode as ClientChildMarkdownNode, HtmlMarkdownNode as ClientHtmlMarkdownNode, ParentMarkdownNode as ClientParentMarkdownNode, StyledMarkdownNode as ClientStyledMarkdownNode, ElementName, MarkdownNode, MarkdownProperty } from '../../client';
-declare abstract class ParentMarkdownNode implements ClientParentMarkdownNode {
-    readonly children: MarkdownNode[];
+import { AnchorMarkdownNode, ChildMarkdownNode as ClientChildMarkdownNode, HtmlMarkdownNode as ClientHtmlMarkdownNode, MarkdownNode as ClientMarkdownNode, ParentMarkdownNode as ClientParentMarkdownNode, StyledMarkdownNode as ClientStyledMarkdownNode, ElementName, MarkdownProperty } from '../../client';
+declare abstract class MarkdownNode {
+    readonly id: string;
+    constructor();
+}
+declare abstract class ParentMarkdownNode extends MarkdownNode implements ClientParentMarkdownNode {
+    readonly children: ClientMarkdownNode[];
     readonly role = "parent";
     abstract elementName: ElementName;
-    constructor(children: MarkdownNode[]);
+    constructor(children: ClientMarkdownNode[]);
 }
 export declare class Heading1 extends ParentMarkdownNode {
     readonly elementName = "h1";
@@ -44,14 +48,15 @@ export declare class ListItem extends ParentMarkdownNode {
 export declare class Anchor extends ParentMarkdownNode implements AnchorMarkdownNode {
     readonly elementName = "a";
     readonly url: string;
-    constructor(children: MarkdownNode[], url: string);
+    constructor(children: ClientMarkdownNode[], url: string);
 }
 declare abstract class StyledMarkdownNode implements ClientParentMarkdownNode {
-    readonly children: MarkdownNode[];
+    readonly id: string;
+    readonly children: ClientMarkdownNode[];
     readonly role = "parent";
     abstract elementName: ElementName;
     readonly properties: MarkdownProperty | undefined;
-    constructor(children: MarkdownNode[], properties: MarkdownProperty | undefined);
+    constructor(children: ClientMarkdownNode[], properties: MarkdownProperty | undefined);
 }
 export declare class Paragraph extends StyledMarkdownNode implements ClientStyledMarkdownNode {
     readonly elementName = "p";
@@ -62,12 +67,12 @@ export declare class Span extends StyledMarkdownNode implements ClientStyledMark
 export declare class Div extends StyledMarkdownNode implements ClientStyledMarkdownNode {
     readonly elementName = "div";
 }
-export declare class ChildMarkdownNode implements ClientChildMarkdownNode {
+export declare class ChildMarkdownNode extends MarkdownNode implements ClientChildMarkdownNode {
     readonly role = "child";
     readonly value: string;
     constructor(value: string);
 }
-export declare class Html implements ClientHtmlMarkdownNode {
+export declare class Html extends MarkdownNode implements ClientHtmlMarkdownNode {
     readonly role = "html";
     readonly unsafeHtml: string;
     constructor(unsafeHtml: string);

package/dist/integration/xpath/static-dom/StaticDocument.d.ts

@@ -1,4 +1,5 @@
 import { XFormsXPathDocument } from '../adapter/XFormsXPathNode.ts';
+import { StaticAttribute } from './StaticAttribute.ts';
 import { StaticElementOptions, StaticElement } from './StaticElement.ts';
 import { StaticParentNode } from './StaticParentNode.ts';
 interface StaticDocumentOptions {
@@ -12,6 +13,7 @@ export declare class StaticDocument extends StaticParentNode<'document'> impleme
     readonly nodeset: string;
     readonly children: readonly [root: StaticElement];
     readonly childElements: readonly [root: StaticElement];
+    readonly attributes: readonly StaticAttribute[];
     constructor(options: StaticDocumentOptions);
     getXPathValue(): string;
 }

package/dist/lib/codecs/{Geopoint/Geopoint.d.ts → geolocation/Geolocation.d.ts}

@@ -1,8 +1,3 @@
-/**
- * This abstract class defines the minimal behavior for a default geopoint.
- * It can be expanded later to support units (e.g., degrees or meters),
- * which would also serve as documentation to clarify what each value represents.
- */
 declare abstract class SemanticValue<Semantic extends string, Value extends number | null> {
     readonly value: Value;
     abstract readonly semantic: Semantic;
@@ -20,29 +15,30 @@ declare class Altitude<Value extends number | null = number> extends SemanticVal
 declare class Accuracy<Value extends number | null = number> extends SemanticValue<'accuracy', Value> {
     readonly semantic = "accuracy";
 }
-export interface GeopointValue {
+export interface LocationPoint {
     readonly latitude: number;
     readonly longitude: number;
     readonly altitude: number | null;
     readonly accuracy: number | null;
 }
-export type GeopointRuntimeValue = GeopointValue | null;
-export type GeopointInputValue = GeopointRuntimeValue | string;
-type GeopointTuple = readonly [
+type LocationPointTuple = readonly [
     latitude: Latitude,
     longitude: Longitude,
     altitude: Altitude<null> | Altitude<number>,
     accuracy: Accuracy
 ] | readonly [latitude: Latitude, longitude: Longitude, altitude: Altitude] | readonly [latitude: Latitude, longitude: Longitude];
-export declare class Geopoint {
+export declare const SEGMENT_SEPARATOR = ";";
+export declare class Geolocation {
     private readonly internalValue;
-    constructor(coordinates: GeopointValue);
-    getTuple(): GeopointTuple;
-    getRuntimeValue(): GeopointRuntimeValue;
+    constructor(coordinates: LocationPoint);
+    getTuple(): LocationPointTuple;
+    getRuntimeValue(): LocationPoint | null;
     private isValidDegrees;
     private isValidNumber;
     private static isNullLocation;
-    static parseString(value: string): GeopointRuntimeValue;
-    static toCoordinatesString(value: GeopointInputValue): string;
+    static parseString(value: string): LocationPoint | null;
+    static toCoordinatesString(value: LocationPoint | string | null): string;
+    static isClosedShape(points: LocationPoint[]): boolean;
+    static getSegments(value: string): string[] | null;
 }
 export {};

package/dist/lib/codecs/geolocation/Geopoint.d.ts

@@ -0,0 +1,7 @@
+import { Geolocation, LocationPoint } from './Geolocation.ts';
+export type GeopointRuntimeValue = LocationPoint | null;
+export type GeopointInputValue = GeopointRuntimeValue | string;
+export declare class Geopoint extends Geolocation {
+    static parseStringToGeopoint(value: string): GeopointRuntimeValue;
+    static parseGeopointToString(value: GeopointInputValue): string;
+}

package/dist/lib/codecs/geolocation/Geoshape.d.ts

@@ -0,0 +1,7 @@
+import { Geolocation, LocationPoint } from './Geolocation.ts';
+export type GeoshapeRuntimeValue = LocationPoint[] | null;
+export type GeoshapeInputValue = GeoshapeRuntimeValue | string;
+export declare class Geoshape extends Geolocation {
+    static parseStringToGeoshape(value: string): GeoshapeRuntimeValue;
+    static parseGeoshapeString(points: GeoshapeInputValue): string;
+}

package/dist/lib/codecs/geolocation/Geotrace.d.ts

@@ -0,0 +1,7 @@
+import { Geolocation, LocationPoint } from './Geolocation.ts';
+export type GeotraceRuntimeValue = LocationPoint[] | null;
+export type GeotraceInputValue = GeotraceRuntimeValue | string;
+export declare class Geotrace extends Geolocation {
+    static parseStringToGeotrace(value: string): GeotraceRuntimeValue;
+    static parseGeotraceString(points: GeotraceInputValue): string;
+}

package/dist/lib/codecs/geolocation/createGeolocationValueCodec.d.ts

@@ -0,0 +1,3 @@
+import { ValueType } from '../../../client';
+import { CodecDecoder, CodecEncoder, ValueCodec } from '../ValueCodec.ts';
+export declare function createGeolocationValueCodec<V extends ValueType, RuntimeValue extends RuntimeInputValue, RuntimeInputValue = RuntimeValue>(valueType: V, encodeValue: CodecEncoder<RuntimeInputValue>, decodeValue: CodecDecoder<RuntimeValue>): ValueCodec<V, RuntimeValue, RuntimeInputValue>;

package/dist/lib/codecs/getSharedValueCodec.d.ts

@@ -1,7 +1,9 @@
 import { ValueType } from '../../client/ValueType.ts';
 import { DatetimeInputValue, DatetimeRuntimeValue } from './DateValueCodec.ts';
 import { DecimalInputValue, DecimalRuntimeValue } from './DecimalValueCodec.ts';
-import { GeopointInputValue, GeopointRuntimeValue } from './Geopoint/Geopoint.ts';
+import { GeopointInputValue, GeopointRuntimeValue } from './geolocation/Geopoint.ts';
+import { GeoshapeInputValue, GeoshapeRuntimeValue } from './geolocation/Geoshape.ts';
+import { GeotraceInputValue, GeotraceRuntimeValue } from './geolocation/Geotrace.ts';
 import { IntInputValue, IntRuntimeValue } from './IntValueCodec.ts';
 import { ValueCodec } from './ValueCodec.ts';
 interface RuntimeValuesByType {
@@ -13,8 +15,8 @@ interface RuntimeValuesByType {
     readonly time: string;
     readonly dateTime: string;
     readonly geopoint: GeopointRuntimeValue;
-    readonly geotrace: string;
-    readonly geoshape: string;
+    readonly geotrace: GeotraceRuntimeValue;
+    readonly geoshape: GeoshapeRuntimeValue;
     readonly binary: string;
     readonly barcode: string;
     readonly intent: string;
@@ -29,8 +31,8 @@ interface RuntimeInputValuesByType {
     readonly time: string;
     readonly dateTime: string;
     readonly geopoint: GeopointInputValue;
-    readonly geotrace: string;
-    readonly geoshape: string;
+    readonly geotrace: GeotraceInputValue;
+    readonly geoshape: GeoshapeInputValue;
     readonly binary: string;
     readonly barcode: string;
     readonly intent: string;

package/dist/lib/reactivity/text/createTextRange.d.ts

@@ -9,8 +9,6 @@ type ComputedFormTextRange<Role extends TextRole> = Accessor<TextRange<Role, 'fo
  *
  * - The form's current language (e.g. `<label ref="jr:itext('text-id')" />`)
  * - Direct `<output>` references within the label's children
- *
- * @todo This does not yet handle itext translations **with** outputs!
  */
 export declare const createTextRange: <Role extends TextRole>(context: EvaluationContext, role: Role, definition: TextRangeDefinition<Role>) => ComputedFormTextRange<Role>;
 export {};

package/dist/parse/XFormDOM.d.ts

@@ -1,7 +1,11 @@
 import { KnownAttributeLocalNamedElement } from '../../../common/types/dom.ts';
+export declare const SET_VALUE_LOCAL_NAME = "setvalue";
+export declare const SET_GEOPOINT_LOCAL_NAME = "odk:setgeopoint";
 interface DOMBindElement extends KnownAttributeLocalNamedElement<'bind', 'nodeset'> {
 }
-interface DOMSetValueElement extends KnownAttributeLocalNamedElement<'setvalue', 'event'> {
+export interface DOMSetValueElement extends KnownAttributeLocalNamedElement<'setvalue', 'event'> {
+}
+export interface DOMSetGeopointElement extends KnownAttributeLocalNamedElement<'odk:setgeopoint', 'event'> {
 }
 export interface DOMItextTranslationElement extends KnownAttributeLocalNamedElement<'translation', 'lang'> {
 }
@@ -18,6 +22,7 @@ interface XFormDOMOptions {
 export declare class XFormDOM {
     protected readonly sourceXML: string;
     static from(sourceXML: string): XFormDOM;
+    isInstanceID: (nodeset: string) => boolean | null;
     protected readonly normalizedXML: string;
     readonly xformDocument: XMLDocument;
     readonly html: Element;
@@ -26,6 +31,7 @@ export declare class XFormDOM {
     readonly model: Element;
     readonly binds: readonly DOMBindElement[];
     readonly setValues: readonly DOMSetValueElement[];
+    readonly setGeopoints: readonly DOMSetGeopointElement[];
     readonly primaryInstance: Element;
     readonly primaryInstanceRoot: Element;
     readonly itextTranslationElements: readonly DOMItextTranslationElement[];

package/dist/parse/body/appearance/inputAppearanceParser.d.ts

@@ -1,3 +1,3 @@
 import { TokenListParser, ParsedTokenList } from '../../../lib/TokenListParser.ts';
-export declare const inputAppearanceParser: TokenListParser<"multiline" | "numbers" | "url" | "thousands-sep" | "no-calendar" | "month-year" | "year" | "ethiopian" | "coptic" | "islamic" | "bikram-sambat" | "myanmar" | "persian" | "placement-map" | "maps" | "hidden-answer" | "annotate" | "draw" | "signature" | "new-front" | "new" | "front" | "printer" | "masked", "multiline" | "numbers" | "url" | "thousands-sep" | "no-calendar" | "month-year" | "year" | "ethiopian" | "coptic" | "islamic" | "bikram-sambat" | "myanmar" | "persian" | "placement-map" | "maps" | "hidden-answer" | "annotate" | "draw" | "signature" | "new-front" | "new" | "front" | "printer" | "masked">;
+export declare const inputAppearanceParser: TokenListParser<"year" | "multiline" | "numbers" | "url" | "thousands-sep" | "no-calendar" | "month-year" | "ethiopian" | "coptic" | "islamic" | "bikram-sambat" | "myanmar" | "persian" | "placement-map" | "maps" | "hidden-answer" | "annotate" | "draw" | "signature" | "new-front" | "new" | "front" | "printer" | "masked", "year" | "multiline" | "numbers" | "url" | "thousands-sep" | "no-calendar" | "month-year" | "ethiopian" | "coptic" | "islamic" | "bikram-sambat" | "myanmar" | "persian" | "placement-map" | "maps" | "hidden-answer" | "annotate" | "draw" | "signature" | "new-front" | "new" | "front" | "printer" | "masked">;
 export type InputAppearanceDefinition = ParsedTokenList<typeof inputAppearanceParser>;

package/dist/parse/model/ActionDefinition.d.ts

@@ -3,7 +3,7 @@ import { XFormEvent } from './Event.ts';
 import { ModelDefinition } from './ModelDefinition.ts';
 export declare class ActionDefinition {
     readonly element: Element;
-    static getRef(model: ModelDefinition, setValueElement: Element): string | null;
+    static getRef(model: ModelDefinition, element: Element): string | null;
     static getValue(element: Element): string;
     static isKnownEvent: (event: XFormEvent) => event is XFormEvent;
     static getEvents(element: Element): XFormEvent[];

package/dist/parse/model/BindPreloadDefinition.d.ts

@@ -1,6 +1,7 @@
 import { PartiallyKnownString } from '../../../../common/types/string/PartiallyKnownString.ts';
 import { AttributeContext } from '../../instance/internal-api/AttributeContext.ts';
 import { InstanceValueContext } from '../../instance/internal-api/InstanceValueContext.ts';
+import { BindDefinition } from './BindDefinition.ts';
 import { BindElement } from './BindElement.ts';
 import { XFormEvent } from './Event.ts';
 type PartiallyKnownPreloadParameter<Known extends string> = PartiallyKnownString<NonNullable<Known>>;
@@ -27,10 +28,10 @@ interface PreloadInput<Type extends PreloadType> {
  * - {@link parameter}, an associated `jr:preloadParams` value
  */
 export declare class BindPreloadDefinition<Type extends PreloadType> implements PreloadInput<Type> {
-    static from(bindElement: BindElement): AnyBindPreloadDefinition | null;
     readonly type: Type;
     readonly parameter: PreloadParameter<Type>;
     readonly event: XFormEvent;
+    static from(definition: BindDefinition, bindElement: BindElement): AnyBindPreloadDefinition | null;
     getValue(context: AttributeContext | InstanceValueContext): string | undefined;
     private constructor();
 }

package/dist/parse/model/ModelActionMap.d.ts

@@ -1,9 +1,10 @@
 import { ActionDefinition } from './ActionDefinition.ts';
 import { ModelDefinition } from './ModelDefinition.ts';
-export declare class ModelActionMap extends Map<string, ActionDefinition> {
+export declare class ModelActionMap extends Map<string, ActionDefinition[]> {
     static fromModel(model: ModelDefinition): ModelActionMap;
     static getKey(ref: string): string;
     protected constructor(model: ModelDefinition);
-    get(ref: string): ActionDefinition | undefined;
+    get(ref: string): ActionDefinition[] | undefined;
+    private addAll;
     add(action: ActionDefinition): void;
 }

package/dist/parse/model/ModelDefinition.d.ts

@@ -1,8 +1,6 @@
 import { ActiveLanguage } from '../../client/FormLanguage.ts';
 import { StaticDocument } from '../../integration/xpath/static-dom/StaticDocument.ts';
-import { TextChunkExpression } from '../expression/TextChunkExpression.ts';
 import { XFormDefinition } from '../XFormDefinition.ts';
-import { ChunkExpressionsByItextId } from './generateItextChunks.ts';
 import { ItextTranslationsDefinition } from './ItextTranslationsDefinition.ts';
 import { ModelActionMap } from './ModelActionMap.ts';
 import { ModelBindMap } from './ModelBindMap.ts';
@@ -18,14 +16,14 @@ export declare class ModelDefinition {
     readonly nodes: NodeDefinitionMap;
     readonly instance: StaticDocument;
     readonly itextTranslations: ItextTranslationsDefinition;
-    readonly itextChunks: Map<string, ChunkExpressionsByItextId>;
+    readonly itextElements: Map<string, Map<string, Element>>;
     readonly xformsRevalidateListeners: Map<string, XformsRevalidateListener>;
     constructor(form: XFormDefinition);
     getNodeDefinition(nodeset: string): AnyNodeDefinition;
     getRootDefinition(instance: StaticDocument): RootDefinition;
     registerXformsRevalidateListener(ref: string, listener: XformsRevalidateListener): void;
     triggerXformsRevalidateListeners(): void;
-    getTranslationChunks(itextId: string, activeLanguage: ActiveLanguage): ReadonlyArray<TextChunkExpression<'string'>>;
-    toJSON(): Omit<this, "form" | "toJSON" | "getNodeDefinition" | "getRootDefinition" | "registerXformsRevalidateListener" | "triggerXformsRevalidateListeners" | "getTranslationChunks">;
+    getItextElement(activeLanguage: ActiveLanguage, itextId: string): Element | undefined;
+    toJSON(): Omit<this, "form" | "toJSON" | "getNodeDefinition" | "getRootDefinition" | "registerXformsRevalidateListener" | "triggerXformsRevalidateListeners" | "getItextElement">;
 }
 export {};

package/dist/parse/model/SecondaryInstance/sources/CSVExternalSecondaryInstance.d.ts

@@ -1,22 +1,5 @@
 import { SecondaryInstanceDefinition } from '../SecondaryInstancesDefinition.ts';
 import { ExternalSecondaryInstanceSource } from './ExternalSecondaryInstanceSource.ts';
 export declare class CSVExternalSecondaryInstanceSource extends ExternalSecondaryInstanceSource<'csv'> {
-    /**
-     * Based on
-     * {@link https://github.com/getodk/central-frontend/blob/42c9277709e593480d1462e28b4be5f1364532b7/src/util/csv.js#L79} (and {@link https://github.com/getodk/central-frontend/blob/42c9277709e593480d1462e28b4be5f1364532b7/src/util/csv.js#L13}).
-     *
-     * The most significant deviations at time of writing:
-     *
-     * - we have already retrieved the CSV resource, so we are parsing the raw CSV data directly.
-     * - we have no need for asynchronous/streaming parsing at this point in the
-     *   form initialization process, so we can dispense with those details of the
-     *   {@link papa | papaparse} API/config.
-     */
-    private parseCSVHeader;
-    /**
-     * Largely based on {@link https://github.com/getodk/central-frontend/blob/42c9277709e593480d1462e28b4be5f1364532b7/src/util/csv.js#L170}
-     */
-    private parseCSVRows;
-    private toItems;
     parseDefinition(): SecondaryInstanceDefinition;
 }

package/dist/parse/model/SecondaryInstance/sources/external-instance-csv-parser.d.ts

@@ -0,0 +1,8 @@
+import { JRResourceURL } from '../../../../../../common/src/jr-resources/JRResourceURL';
+interface CSVExternalSecondaryInstanceItemColumn {
+    readonly columnName: string;
+    readonly cellValue: string;
+}
+type CSVExternalSecondaryInstanceItem = readonly CSVExternalSecondaryInstanceItemColumn[];
+export declare const parseItems: (resourceURL: JRResourceURL, data: string) => readonly CSVExternalSecondaryInstanceItem[];
+export {};

package/dist/parse/model/TranslationDefinitionMap.d.ts

@@ -0,0 +1,4 @@
+import { DOMItextTranslationElement } from '../XFormDOM.ts';
+export declare class TranslationDefinitionMap extends Map<string, Map<string, Element>> {
+    constructor(translationElements: readonly DOMItextTranslationElement[]);
+}