@getodk/xforms-engine 0.15.0 → 0.16.1

package/dist/integration/xpath/adapter/XFormsXPathNode.d.ts

@@ -64,7 +64,7 @@ export type XFormsXPathPrimaryInstanceNodeKind = XPathDocumentKind | XFormsXPath
 export interface XFormsXPathPrimaryInstanceNode extends XFormsXPathNode {
     readonly [XPathNodeKindKey]: XFormsXPathPrimaryInstanceNodeKind;
 }
-export type XFormsXPathPrimaryInstanceDescendantNodeKind = XFormsXPathNodeRangeKind | XPathElementKind | XPathTextKind;
+export type XFormsXPathPrimaryInstanceDescendantNodeKind = XFormsXPathNodeRangeKind | XPathAttributeKind | XPathElementKind | XPathTextKind;
 export interface XFormsXPathPrimaryInstanceDescendantNode extends XFormsXPathNode {
     readonly [XPathNodeKindKey]: XFormsXPathPrimaryInstanceDescendantNodeKind;
 }

package/dist/integration/xpath/adapter/kind.d.ts

@@ -1,19 +1,21 @@
 import { XPathNodeKind } from '@getodk/xpath';
+import { Attribute } from '../../../instance/Attribute.ts';
 import { AnyChildNode, AnyNode, AnyParentNode } from '../../../instance/hierarchy.ts';
 import { PrimaryInstance } from '../../../instance/PrimaryInstance.ts';
 import { StaticAttribute } from '../static-dom/StaticAttribute.ts';
 import { StaticDocument } from '../static-dom/StaticDocument.ts';
 import { StaticElement } from '../static-dom/StaticElement.ts';
 import { StaticText } from '../static-dom/StaticText.ts';
-import { XFormsXPathComment, XFormsXPathDocument, XFormsXPathElement, XFormsXPathPrimaryInstanceNode } from './XFormsXPathNode.ts';
+import { XFormsXPathAttribute, XFormsXPathComment, XFormsXPathDocument, XFormsXPathElement, XFormsXPathPrimaryInstanceNode } from './XFormsXPathNode.ts';
 export type PrimaryInstanceXPathNode = Extract<AnyNode, XFormsXPathPrimaryInstanceNode>;
 export type PrimaryInstanceXPathElement = Extract<AnyChildNode, XFormsXPathElement>;
+export type PrimaryInstanceXPathAttribute = Extract<Attribute, XFormsXPathAttribute>;
 export type PrimaryInstanceXPathComment = Extract<AnyChildNode, XFormsXPathComment>;
-export type PrimaryInstanceXPathChildNode = PrimaryInstanceXPathElement | PrimaryInstanceXPathComment;
+export type PrimaryInstanceXPathChildNode = PrimaryInstanceXPathElement | PrimaryInstanceXPathAttribute | PrimaryInstanceXPathComment;
 export type EngineXPathDocument = PrimaryInstance | StaticDocument;
 export type EngineXPathElement = PrimaryInstanceXPathElement | StaticElement;
 export type EngineXPathComment = PrimaryInstanceXPathComment;
-export type EngineXPathAttribute = StaticAttribute;
+export type EngineXPathAttribute = PrimaryInstanceXPathAttribute | StaticAttribute;
 export type EngineXPathText = StaticText;
 export type XFormsXPathChildNode = EngineXPathElement | EngineXPathText | EngineXPathComment;
 type XPathAdapterParentNode = XFormsXPathDocument | XFormsXPathElement;

package/dist/integration/xpath/adapter/traversal.d.ts

@@ -1,6 +1,6 @@
-import { EngineXPathAttribute, EngineXPathDocument, EngineXPathElement, EngineXPathNode, EngineXPathParentNode, XFormsXPathChildNode } from './kind.ts';
+import { EngineXPathAttribute, EngineXPathDocument, EngineXPathElement, EngineXPathNode, XFormsXPathChildNode } from './kind.ts';
 export declare const getContainingEngineXPathDocument: (node: EngineXPathNode) => EngineXPathDocument;
-export declare const getEngineXPathAttributes: (node: EngineXPathNode) => readonly EngineXPathAttribute[];
+export declare const getAttributes: (node: EngineXPathNode) => readonly EngineXPathAttribute[];
 /**
  * @todo We've now laid most of the groundwork necessary to implement this
  * properly. At time of writing it has still been deferred because:
@@ -15,7 +15,7 @@ export declare const getEngineXPathAttributes: (node: EngineXPathNode) => readon
  * are somehow wrong (or become wrong).
  */
 export declare const getNamespaceDeclarations: () => readonly [];
-export declare const getParentNode: (node: EngineXPathNode) => EngineXPathParentNode | null;
+export declare const getParentNode: (node: EngineXPathNode) => EngineXPathNode | null;
 export declare const getChildNodes: (node: EngineXPathNode) => readonly XFormsXPathChildNode[];
 export declare const getChildElements: (node: EngineXPathNode) => readonly EngineXPathElement[];
 export declare const getPreviousSiblingNode: (node: EngineXPathNode) => XFormsXPathChildNode | null;

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

@@ -19,6 +19,7 @@ export declare class StaticAttribute extends StaticNode<'attribute'> implements
     readonly nodeset: string;
     readonly attributes: readonly [];
     readonly children: null;
+    readonly childElements: never[];
     readonly value: string;
     constructor(parent: StaticElement, options: StaticAttributeOptions);
     getXPathValue(): string;

package/dist/lib/codecs/items/SingleValueItemCodec.d.ts

@@ -4,7 +4,7 @@ export type SingleValueSelectRuntimeValues = readonly [] | readonly [string];
 /**
  * @see {@link encodeValueFactory}
  */
-type SingleValueSelectCodecValues = SingleValueSelectRuntimeValues | readonly string[];
+type SingleValueSelectCodecValues = readonly string[];
 /**
  * Value codec implementation for `<select1>` controls.
  *

package/dist/lib/reactivity/createInstanceValueState.d.ts

@@ -1,5 +1,7 @@
+import { AttributeContext } from '../../instance/internal-api/AttributeContext.ts';
 import { InstanceValueContext } from '../../instance/internal-api/InstanceValueContext.ts';
 import { SimpleAtomicState } from './types.ts';
+type ValueContext = AttributeContext | InstanceValueContext;
 export type InstanceValueState = SimpleAtomicState<string>;
 /**
  * Provides a consistent interface for value nodes of any type which:
@@ -12,4 +14,5 @@ export type InstanceValueState = SimpleAtomicState<string>;
  *   nodes defined with one
  * - prevents downstream writes to nodes in a readonly state
  */
-export declare const createInstanceValueState: (context: InstanceValueContext) => InstanceValueState;
+export declare const createInstanceValueState: (context: ValueContext) => InstanceValueState;
+export {};

package/dist/lib/reactivity/node-state/createSharedNodeState.d.ts

@@ -5,8 +5,8 @@ import { CurrentState } from './createCurrentState.ts';
 import { EngineState } from './createEngineState.ts';
 import { MutablePropertySpec, SpecifiedState, StateSpec } from './createSpecifiedState.ts';
 type MutableKeyOf<Spec extends StateSpec> = {
-    [K in string & keyof Spec]: Spec[K] extends MutablePropertySpec<any> ? K : never;
-}[string & keyof Spec];
+    [K in Extract<keyof Spec, string>]: Spec[K] extends MutablePropertySpec<any> ? K : never;
+}[Extract<keyof Spec, string>];
 type SetEnginePropertyState<Spec extends StateSpec> = <K extends MutableKeyOf<Spec>>(key: K, newValue: SpecifiedState<Spec>[K]) => SpecifiedState<Spec>[K];
 export interface SharedNodeState<Spec extends StateSpec> {
     readonly spec: Spec;

package/dist/lib/xml-serialization.d.ts

@@ -42,5 +42,5 @@ export type EscapedXMLText = string & {
 export declare const escapeXMLText: <Text extends string>(text: Exclude<Text, EscapedXMLText>, attr?: boolean) => EscapedXMLText;
 export declare const serializeAttributeXML: (qualifiedName: QualifiedName, xmlValue: EscapedXMLText) => string;
 export declare const serializeParentElementXML: (qualifiedName: QualifiedName, children: readonly GeneralChildNode[], attributes: readonly Attribute[], namespaceDeclarations?: NamespaceDeclarationMap) => string;
-export declare const serializeLeafElementXML: (qualifiedName: QualifiedName, xmlValue: EscapedXMLText, namespaceDeclarations?: NamespaceDeclarationMap) => string;
+export declare const serializeLeafElementXML: (qualifiedName: QualifiedName, xmlValue: EscapedXMLText, attributes: readonly Attribute[], namespaceDeclarations?: NamespaceDeclarationMap) => string;
 export {};

package/dist/parse/XFormDOM.d.ts

@@ -1,6 +1,8 @@
 import { KnownAttributeLocalNamedElement } from '../../../common/types/dom.ts';
 interface DOMBindElement extends KnownAttributeLocalNamedElement<'bind', 'nodeset'> {
 }
+interface DOMSetValueElement extends KnownAttributeLocalNamedElement<'setvalue', 'event'> {
+}
 export interface DOMItextTranslationElement extends KnownAttributeLocalNamedElement<'translation', 'lang'> {
 }
 export interface DOMSecondaryInstanceElement extends KnownAttributeLocalNamedElement<'instance', 'id'> {
@@ -23,6 +25,7 @@ export declare class XFormDOM {
     readonly title: Element;
     readonly model: Element;
     readonly binds: readonly DOMBindElement[];
+    readonly setValues: readonly DOMSetValueElement[];
     readonly primaryInstance: Element;
     readonly primaryInstanceRoot: Element;
     readonly itextTranslationElements: readonly DOMItextTranslationElement[];

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

@@ -0,0 +1,4 @@
+import { DependentExpression, DependentExpressionResultType } from './abstract/DependentExpression.ts';
+export declare class ActionComputationExpression<Type extends DependentExpressionResultType> extends DependentExpression<Type> {
+    constructor(resultType: Type, expression: string);
+}

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

@@ -0,0 +1,15 @@
+import { ActionComputationExpression } from '../expression/ActionComputationExpression.ts';
+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 getValue(element: Element): string;
+    static isKnownEvent: (event: XFormEvent) => event is XFormEvent;
+    static getEvents(element: Element): XFormEvent[];
+    readonly ref: string;
+    readonly events: XFormEvent[];
+    readonly computation: ActionComputationExpression<'string'>;
+    readonly source: string | undefined;
+    constructor(model: ModelDefinition, element: Element, source?: string);
+}

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

@@ -2,13 +2,16 @@ import { StaticAttribute } from '../../integration/xpath/static-dom/StaticAttrib
 import { NamespaceDeclarationMap, NamedNodeDefinition } from '../../lib/names/NamespaceDeclarationMap.ts';
 import { QualifiedName } from '../../lib/names/QualifiedName.ts';
 import { BindDefinition } from './BindDefinition.ts';
+import { ModelDefinition } from './ModelDefinition.ts';
 import { NodeDefinition } from './NodeDefinition.ts';
 import { RootDefinition } from './RootDefinition.ts';
 export declare class AttributeDefinition extends NodeDefinition<'attribute'> implements NamedNodeDefinition {
+    readonly model: ModelDefinition;
     readonly template: StaticAttribute;
     private readonly serializedXML;
     readonly value: string;
     readonly type = "attribute";
+    readonly valueType = "string";
     readonly namespaceDeclarations: NamespaceDeclarationMap;
     readonly bodyElement: null;
     readonly root: RootDefinition;
@@ -17,6 +20,7 @@ export declare class AttributeDefinition extends NodeDefinition<'attribute'> imp
     readonly children: null;
     readonly attributes: null;
     readonly qualifiedName: QualifiedName;
-    constructor(root: RootDefinition, bind: BindDefinition, template: StaticAttribute);
+    constructor(model: ModelDefinition, bind: BindDefinition, template: StaticAttribute);
     serializeAttributeXML(): string;
+    toJSON(): Omit<this, "parent" | "toJSON" | "bind" | "root" | "bodyElement" | "serializeAttributeXML">;
 }

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

@@ -1,6 +1,9 @@
 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 { BindElement } from './BindElement.ts';
-type PartiallyKnownPreloadParameter<Known extends string> = PartiallyKnownString<NonNullable<Known>> | Extract<Known, null>;
+import { XFormEvent } from './Event.ts';
+type PartiallyKnownPreloadParameter<Known extends string> = PartiallyKnownString<NonNullable<Known>>;
 interface PreloadParametersByType {
     readonly uid: string | null;
     readonly date: PartiallyKnownPreloadParameter<'today'>;
@@ -22,20 +25,13 @@ interface PreloadInput<Type extends PreloadType> {
  *
  * - {@link type}, a `jr:preload`
  * - {@link parameter}, an associated `jr:preloadParams` value
- *
- * @todo It would probably make sense for the _definition_ to also convey:
- *
- * 1. Which {@link https://getodk.github.io/xforms-spec/#events | event} the
- *    preload is semantically associated with (noting that the spec may be a tad
- *    overzealous about this association).
- *
- * 2. The constant XPath expression (or other computation?) expressed by the
- *    combined {@link type} and {@link parameter}.
  */
 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;
+    getValue(context: AttributeContext | InstanceValueContext): string | undefined;
     private constructor();
 }
 export type AnyBindPreloadDefinition = BindPreloadDefinition<'uid'> | BindPreloadDefinition<'timestamp'> | BindPreloadDefinition<'property'> | BindPreloadDefinition<string>;

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

@@ -0,0 +1,8 @@
+export declare const XFORM_EVENT: {
+    readonly odkInstanceLoad: "odk-instance-load";
+    readonly odkInstanceFirstLoad: "odk-instance-first-load";
+    readonly odkNewRepeat: "odk-new-repeat";
+    readonly xformsRevalidate: "xforms-revalidate";
+    readonly xformsValueChanged: "xforms-value-changed";
+};
+export type XFormEvent = (typeof XFORM_EVENT)[keyof typeof XFORM_EVENT];

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

@@ -3,17 +3,20 @@ import { StaticLeafElement } from '../../integration/xpath/static-dom/StaticElem
 import { NamespaceDeclarationMap, NamedSubtreeDefinition } from '../../lib/names/NamespaceDeclarationMap.ts';
 import { QualifiedName } from '../../lib/names/QualifiedName.ts';
 import { AnyBodyElementDefinition, ControlElementDefinition } from '../body/BodyDefinition.ts';
+import { AttributeDefinitionMap } from './AttributeDefinitionMap.ts';
 import { BindDefinition } from './BindDefinition.ts';
 import { DescendentNodeDefinition } from './DescendentNodeDefinition.ts';
+import { ModelDefinition } from './ModelDefinition.ts';
 import { ParentNodeDefinition } from './NodeDefinition.ts';
 export declare class LeafNodeDefinition<V extends ValueType = ValueType> extends DescendentNodeDefinition<'leaf-node', ControlElementDefinition | null> implements NamedSubtreeDefinition {
+    readonly model: ModelDefinition;
     readonly template: StaticLeafElement;
     readonly type = "leaf-node";
     readonly valueType: V;
     readonly namespaceDeclarations: NamespaceDeclarationMap;
     readonly qualifiedName: QualifiedName;
     readonly children: null;
-    readonly attributes: null;
-    constructor(parent: ParentNodeDefinition, bind: BindDefinition, bodyElement: AnyBodyElementDefinition | null, template: StaticLeafElement);
+    readonly attributes: AttributeDefinitionMap;
+    constructor(model: ModelDefinition, parent: ParentNodeDefinition, bind: BindDefinition, bodyElement: AnyBodyElementDefinition | null, template: StaticLeafElement);
     toJSON(): Omit<this, "parent" | "toJSON" | "bind" | "root" | "bodyElement">;
 }

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

@@ -0,0 +1,9 @@
+import { ActionDefinition } from './ActionDefinition.ts';
+import { ModelDefinition } from './ModelDefinition.ts';
+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;
+    add(action: ActionDefinition): void;
+}

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

@@ -4,21 +4,28 @@ 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';
 import { AnyNodeDefinition } from './NodeDefinition.ts';
 import { NodeDefinitionMap } from './nodeDefinitionMap.ts';
 import { RootDefinition } from './RootDefinition.ts';
+type XformsRevalidateListener = () => void;
 export declare class ModelDefinition {
     readonly form: XFormDefinition;
     readonly binds: ModelBindMap;
+    readonly actions: ModelActionMap;
     readonly root: RootDefinition;
     readonly nodes: NodeDefinitionMap;
     readonly instance: StaticDocument;
     readonly itextTranslations: ItextTranslationsDefinition;
     readonly itextChunks: Map<string, ChunkExpressionsByItextId>;
+    readonly xformsRevalidateListeners: Map<string, XformsRevalidateListener>;
     constructor(form: XFormDefinition);
     getNodeDefinition(nodeset: string): AnyNodeDefinition;
     getRootDefinition(instance: StaticDocument): RootDefinition;
-    toJSON(): Omit<this, "form" | "toJSON" | "getNodeDefinition" | "getRootDefinition" | "getTranslationChunks">;
+    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">;
 }
+export {};

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

@@ -8,6 +8,7 @@ import { HintDefinition } from '../text/HintDefinition.ts';
 import { LabelDefinition } from '../text/LabelDefinition.ts';
 import { BindDefinition } from './BindDefinition.ts';
 import { LeafNodeDefinition } from './LeafNodeDefinition.ts';
+import { ModelDefinition } from './ModelDefinition.ts';
 import { ParentNodeDefinition } from './NodeDefinition.ts';
 export type NoteReadonlyDefinition = BindComputationExpression<'readonly'> & ConstantTruthyDependentExpression;
 export interface NoteBindDefinition<V extends ValueType> extends BindDefinition<V> {
@@ -27,6 +28,6 @@ export declare class NoteNodeDefinition<V extends ValueType = ValueType> extends
     readonly bind: NoteBindDefinition<V>;
     readonly bodyElement: InputControlDefinition;
     readonly noteTextDefinition: NoteTextDefinition;
-    static from<V extends ValueType>(parent: ParentNodeDefinition, bind: BindDefinition<V>, bodyElement: AnyBodyElementDefinition | null, node: StaticLeafElement): NoteNodeDefinition<V> | null;
-    constructor(parent: ParentNodeDefinition, bind: NoteBindDefinition<V>, bodyElement: InputControlDefinition, noteTextDefinition: NoteTextDefinition, template: StaticLeafElement);
+    static from<V extends ValueType>(model: ModelDefinition, parent: ParentNodeDefinition, bind: BindDefinition<V>, bodyElement: AnyBodyElementDefinition | null, node: StaticLeafElement): NoteNodeDefinition<V> | null;
+    constructor(model: ModelDefinition, parent: ParentNodeDefinition, bind: NoteBindDefinition<V>, bodyElement: InputControlDefinition, noteTextDefinition: NoteTextDefinition, template: StaticLeafElement);
 }

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

@@ -4,6 +4,7 @@ import { RuntimeValue } from '../../lib/codecs/getSharedValueCodec.ts';
 import { RangeControlBoundsDefinition, RangeControlDefinition } from '../body/control/RangeControlDefinition.ts';
 import { BindDefinition } from './BindDefinition.ts';
 import { LeafNodeDefinition } from './LeafNodeDefinition.ts';
+import { ModelDefinition } from './ModelDefinition.ts';
 import { ParentNodeDefinition } from './NodeDefinition.ts';
 declare const RANGE_VALUE_TYPES: readonly ["decimal", "int"];
 export type RangeValueType = (typeof RANGE_VALUE_TYPES)[number];
@@ -34,7 +35,7 @@ declare class RangeNodeBoundsDefinition<V extends RangeValueType = RangeValueTyp
 export declare class RangeNodeDefinition<V extends RangeValueType = RangeValueType> extends LeafNodeDefinition<V> implements RangeLeafNodeDefinition<V> {
     readonly bind: BindDefinition<V>;
     readonly bodyElement: RangeControlDefinition;
-    static from<V extends ValueType>(parent: ParentNodeDefinition, bind: BindDefinition<V>, bodyElement: RangeControlDefinition, node: StaticLeafElement): RangeNodeDefinition<Extract<V, RangeValueType>>;
+    static from<V extends ValueType>(model: ModelDefinition, parent: ParentNodeDefinition, bind: BindDefinition<V>, bodyElement: RangeControlDefinition, node: StaticLeafElement): RangeNodeDefinition<Extract<V, RangeValueType>>;
     readonly bounds: RangeNodeBoundsDefinition<V>;
     private constructor();
 }

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

@@ -23,6 +23,7 @@ export declare class RootDefinition extends NodeDefinition<'root'> {
     readonly children: readonly ChildNodeDefinition[];
     readonly isTranslated = false;
     constructor(form: XFormDefinition, model: ModelDefinition, submission: SubmissionDefinition, classes: BodyClassList);
+    private mapActions;
     buildSubtree(parent: ParentNodeDefinition, node: StaticElement): readonly ChildNodeDefinition[];
     toJSON(): Omit<this, "form" | "toJSON" | "bind" | "model" | "root" | "bodyElement" | "buildSubtree">;
 }