@getodk/xforms-engine 0.14.0 → 0.16.0

package/dist/parse/model/{RootAttributeMap.d.ts → AttributeDefinitionMap.d.ts}

@@ -1,14 +1,8 @@
 import { StaticElement } from '../../integration/xpath/static-dom/StaticElement.ts';
 import { QualifiedName } from '../../lib/names/QualifiedName.ts';
-import { RootAttributeDefinition } from './RootAttributeDefinition.ts';
-import { RootDefinition } from './RootDefinition.ts';
+import { AttributeDefinition } from './AttributeDefinition.ts';
+import { ModelDefinition } from './ModelDefinition.ts';
 /**
- * @todo This can be trivially expanded to a narrowly general case when we
- * prioritize work to
- * {@link https://github.com/getodk/web-forms/issues/285 | support attributes}
- * (as modeled form nodes on par with elements). It's been deferred here to
- * avoid expanding scope of an already fairly large yak shave.
- *
  * @todo There's a **much more expansive** general case just waiting for a good
  * opportuntity to prioritize it. E.g. a `NamedNodeMap<T>`, where T is any
  * generalized concept of a named node. This expansive generalization would have
@@ -18,7 +12,7 @@ import { RootDefinition } from './RootDefinition.ts';
  *
  * @see {@link QualifiedName} for more detail.
  */
-export declare class RootAttributeMap extends Map<QualifiedName, RootAttributeDefinition> {
-    static from(root: RootDefinition, instanceNode: StaticElement): RootAttributeMap;
+export declare class AttributeDefinitionMap extends Map<QualifiedName, AttributeDefinition> {
+    static from(model: ModelDefinition, instanceNode: StaticElement): AttributeDefinitionMap;
     private constructor();
 }

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/GroupDefinition.d.ts

@@ -3,8 +3,10 @@ import { NamespaceDeclarationMap } from '../../lib/names/NamespaceDeclarationMap
 import { QualifiedName } from '../../lib/names/QualifiedName.ts';
 import { AnyBodyElementDefinition } from '../body/BodyDefinition.ts';
 import { GroupElementDefinition } from '../body/GroupElementDefinition.ts';
+import { AttributeDefinitionMap } from './AttributeDefinitionMap.ts';
 import { BindDefinition } from './BindDefinition.ts';
 import { DescendentNodeDefinition } from './DescendentNodeDefinition.ts';
+import { ModelDefinition } from './ModelDefinition.ts';
 import { ChildNodeDefinition, ParentNodeDefinition } from './NodeDefinition.ts';
 export declare class GroupDefinition extends DescendentNodeDefinition<'group', GroupElementDefinition | null> {
     readonly template: StaticElement;
@@ -12,6 +14,7 @@ export declare class GroupDefinition extends DescendentNodeDefinition<'group', G
     readonly namespaceDeclarations: NamespaceDeclarationMap;
     readonly qualifiedName: QualifiedName;
     readonly children: readonly ChildNodeDefinition[];
-    constructor(parent: ParentNodeDefinition, bind: BindDefinition, bodyElement: AnyBodyElementDefinition | null, template: StaticElement);
+    readonly attributes: AttributeDefinitionMap;
+    constructor(model: ModelDefinition, parent: ParentNodeDefinition, bind: BindDefinition, bodyElement: AnyBodyElementDefinition | null, template: StaticElement);
     toJSON(): Omit<this, "parent" | "toJSON" | "bind" | "root" | "bodyElement">;
 }

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

@@ -3,16 +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;
-    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/NodeDefinition.d.ts

@@ -1,8 +1,11 @@
+import { StaticAttribute } from '../../integration/xpath/static-dom/StaticAttribute.ts';
 import { StaticElement } from '../../integration/xpath/static-dom/StaticElement.ts';
 import { NamedSubtreeDefinition, NamespaceDeclarationMap } from '../../lib/names/NamespaceDeclarationMap.ts';
 import { QualifiedName } from '../../lib/names/QualifiedName.ts';
 import { AnyBodyElementDefinition } from '../body/BodyDefinition.ts';
 import { RepeatElementDefinition } from '../body/RepeatElementDefinition.ts';
+import { AttributeDefinition } from './AttributeDefinition.ts';
+import { AttributeDefinitionMap } from './AttributeDefinitionMap.ts';
 import { BindDefinition } from './BindDefinition.ts';
 import { GroupDefinition } from './GroupDefinition.ts';
 import { LeafNodeDefinition } from './LeafNodeDefinition.ts';
@@ -37,7 +40,8 @@ export type GroupNodeType = 'group';
  * - Any attribute corresponding to a bind's `nodeset` expression
  */
 export type LeafNodeType = 'leaf-node';
-export type NodeDefinitionType = RootNodeType | RepeatType | GroupNodeType | LeafNodeType;
+export type AttributeNodeType = 'attribute';
+export type NodeDefinitionType = RootNodeType | RepeatType | GroupNodeType | LeafNodeType | AttributeNodeType;
 export type ParentNodeDefinition = RootDefinition | AnyRepeatDefinition | GroupDefinition;
 export type ChildNodeDefinition = AnyRepeatDefinition | GroupDefinition | LeafNodeDefinition;
 export declare abstract class NodeDefinition<Type extends NodeDefinitionType> implements NamedSubtreeDefinition {
@@ -49,9 +53,10 @@ export declare abstract class NodeDefinition<Type extends NodeDefinitionType> im
     abstract readonly isTranslated: boolean;
     abstract readonly root: RootDefinition;
     abstract readonly parent: ParentNodeDefinition | null;
-    abstract readonly template: StaticElement;
+    abstract readonly template: StaticAttribute | StaticElement;
     abstract readonly children: readonly ChildNodeDefinition[] | null;
+    abstract readonly attributes: AttributeDefinitionMap | null;
     readonly nodeset: string;
     constructor(bind: BindDefinition);
 }
-export type AnyNodeDefinition = RootDefinition | AnyRepeatDefinition | GroupDefinition | LeafNodeDefinition;
+export type AnyNodeDefinition = RootDefinition | AnyRepeatDefinition | GroupDefinition | LeafNodeDefinition | AttributeDefinition;

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/RepeatDefinition.d.ts

@@ -3,8 +3,10 @@ import { NamespaceDeclarationMap } from '../../lib/names/NamespaceDeclarationMap
 import { QualifiedName } from '../../lib/names/QualifiedName.ts';
 import { RepeatElementDefinition } from '../body/RepeatElementDefinition.ts';
 import { RepeatCountControlExpression } from '../expression/RepeatCountControlExpression.ts';
+import { AttributeDefinitionMap } from './AttributeDefinitionMap.ts';
 import { BindDefinition } from './BindDefinition.ts';
 import { DescendentNodeDefinition } from './DescendentNodeDefinition.ts';
+import { ModelDefinition } from './ModelDefinition.ts';
 import { ChildNodeDefinition, ParentNodeDefinition } from './NodeDefinition.ts';
 export type RepeatInstanceNodes = readonly [StaticElement, ...StaticElement[]];
 export interface ControlledRepeatDefinition extends RepeatDefinition {
@@ -46,13 +48,14 @@ export interface UncontrolledRepeatDefinition extends RepeatDefinition {
  * associated with a defined repeat.
  */
 export declare class RepeatDefinition extends DescendentNodeDefinition<'repeat', RepeatElementDefinition> {
-    static from(parent: ParentNodeDefinition, bind: BindDefinition, bodyElement: RepeatElementDefinition, instanceNodes: RepeatInstanceNodes): AnyRepeatDefinition;
+    static from(model: ModelDefinition, parent: ParentNodeDefinition, bind: BindDefinition, bodyElement: RepeatElementDefinition, instanceNodes: RepeatInstanceNodes): AnyRepeatDefinition;
     readonly type = "repeat";
     readonly children: readonly ChildNodeDefinition[];
     readonly count: RepeatCountControlExpression | null;
     readonly template: StaticElement;
     readonly namespaceDeclarations: NamespaceDeclarationMap;
     readonly qualifiedName: QualifiedName;
+    readonly attributes: AttributeDefinitionMap;
     private constructor();
     isControlled(): this is ControlledRepeatDefinition;
     isUncontrolled(): this is UncontrolledRepeatDefinition;

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

@@ -3,9 +3,9 @@ import { NamespaceDeclarationMap } from '../../lib/names/NamespaceDeclarationMap
 import { QualifiedName } from '../../lib/names/QualifiedName.ts';
 import { BodyClassList } from '../body/BodyDefinition.ts';
 import { XFormDefinition } from '../XFormDefinition.ts';
+import { AttributeDefinitionMap } from './AttributeDefinitionMap.ts';
 import { ModelDefinition } from './ModelDefinition.ts';
 import { ChildNodeDefinition, ParentNodeDefinition, NodeDefinition } from './NodeDefinition.ts';
-import { RootAttributeMap } from './RootAttributeMap.ts';
 import { SubmissionDefinition } from './SubmissionDefinition.ts';
 export declare class RootDefinition extends NodeDefinition<'root'> {
     protected readonly form: XFormDefinition;
@@ -19,10 +19,11 @@ export declare class RootDefinition extends NodeDefinition<'root'> {
     readonly parent: null;
     readonly template: StaticElement;
     readonly namespaceDeclarations: NamespaceDeclarationMap;
-    readonly attributes: RootAttributeMap;
+    readonly attributes: AttributeDefinitionMap;
     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">;
 }