@getodk/xforms-engine 0.13.0 → 0.15.0

package/dist/client/AttributeNode.d.ts

@@ -0,0 +1,53 @@
+import { Root } from '../instance/Root.ts';
+import { AttributeDefinition } from '../parse/model/AttributeDefinition.ts';
+import { InstanceState } from './serialization/InstanceState.ts';
+export interface AttributeNodeState {
+    get value(): string;
+}
+/**
+ * Base interface for common/shared aspects of attributes.
+ */
+export interface AttributeNode {
+    /**
+     * Specifies the node's general type. This can be useful for narrowing types,
+     * e.g. those of children.
+     */
+    readonly nodeType: 'attribute';
+    /**
+     * Each node has a definition which specifies aspects of the node defined in
+     * the form. These aspects include (but are not limited to) the node's data
+     * type, its body presentation constraints (if any), its bound nodeset, and
+     * so on...
+     */
+    readonly definition: AttributeDefinition;
+    /**
+     * Each node links back to the node representing the root of the form.
+     */
+    readonly root: Root;
+    /**
+     * Each node links back to its parent, if any. All nodes have a parent except
+     * the form's {@link root}.
+     */
+    readonly parent: unknown;
+    /**
+     * Each node provides a discrete object representing the stateful aspects of
+     * that node which will change over time. This includes state which is either
+     * client-/user-mutable, or state which is computed based on the core XForms
+     * computation model. Each node also exposes {@link validationState}, which
+     * reflects the validity of the node, or its descendants.
+     *
+     * When a client provides a {@link OpaqueReactiveObjectFactory}, the engine
+     * will update the properties of this object as their respective states
+     * change, so a client can implement reactive updates that respond to changes
+     * as they occur.
+     */
+    readonly currentState: AttributeNodeState;
+    /**
+     * Represents the current instance state of the node.
+     *
+     * @see {@link InstanceState.instanceXML} for additional detail.
+     */
+    readonly instanceState: InstanceState;
+    readonly appearances: null;
+    readonly nodeOptions: null;
+}

package/dist/client/BaseItem.d.ts

@@ -0,0 +1,6 @@
+import { TextRange } from './TextRange.ts';
+export interface BaseItem {
+    get label(): TextRange<'item-label'>;
+    get value(): string;
+    properties: Array<[string, string]>;
+}

package/dist/client/GroupNode.d.ts

@@ -1,5 +1,5 @@
-import { AnyGroupElementDefinition } from '../parse/body/BodyDefinition.ts';
-import { SubtreeDefinition } from '../parse/model/SubtreeDefinition.ts';
+import { GroupElementDefinition } from '../parse/body/GroupElementDefinition.ts';
+import { GroupDefinition as GroupNodeDefinition } from '../parse/model/GroupDefinition.ts';
 import { BaseNode, BaseNodeState } from './BaseNode.ts';
 import { NodeAppearances } from './NodeAppearances.ts';
 import { RootNode } from './RootNode.ts';
@@ -11,8 +11,8 @@ export interface GroupNodeState extends BaseNodeState {
     get valueOptions(): null;
     get value(): null;
 }
-export interface GroupDefinition extends SubtreeDefinition {
-    readonly bodyElement: AnyGroupElementDefinition;
+export interface GroupDefinition extends GroupNodeDefinition {
+    readonly bodyElement: GroupElementDefinition;
 }
 export type GroupNodeAppearances = NodeAppearances<GroupDefinition>;
 /**

package/dist/client/MarkdownNode.d.ts

@@ -0,0 +1,33 @@
+export type Heading = 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6';
+export type ElementName = Heading | 'a' | 'div' | 'em' | 'li' | 'ol' | 'p' | 'span' | 'strong' | 'u' | 'ul';
+export type MarkdownNode = ChildMarkdownNode | HtmlMarkdownNode | ParentMarkdownNode;
+export interface ParentMarkdownNode {
+    readonly role: 'parent';
+    readonly elementName: string;
+    readonly children: MarkdownNode[];
+}
+export interface ChildMarkdownNode {
+    readonly role: 'child';
+    readonly value: string;
+}
+export interface HtmlMarkdownNode {
+    readonly role: 'html';
+    readonly unsafeHtml: string;
+}
+export interface AnchorMarkdownNode extends ParentMarkdownNode {
+    readonly elementName: 'a';
+    readonly url: string;
+}
+export interface StyledMarkdownNode extends ParentMarkdownNode {
+    readonly elementName: 'div' | 'p' | 'span';
+    readonly properties: MarkdownProperty | undefined;
+}
+export interface MarkdownProperty {
+    readonly style: StyleProperty;
+}
+export interface StyleProperty {
+    readonly color: string | undefined;
+    readonly 'font-family': string | undefined;
+    readonly 'text-align': 'center' | 'left' | 'right' | undefined;
+    readonly 'font-size': string | undefined;
+}

package/dist/client/RankNode.d.ts

@@ -1,16 +1,14 @@
 import { RankControlDefinition } from '../parse/body/control/RankControlDefinition.ts';
 import { LeafNodeDefinition } from '../parse/model/LeafNodeDefinition.ts';
 import { BaseValueNode, BaseValueNodeState } from './BaseValueNode.ts';
+import { BaseItem } from './BaseItem.ts';
 import { RootNode } from './RootNode.ts';
 import { TextRange } from './TextRange.ts';
 import { GeneralParentNode } from './hierarchy.ts';
 import { LeafNodeValidationState } from './validation.ts';
 import { UnknownAppearanceDefinition } from '../parse/body/appearance/unknownAppearanceParser.ts';
 import { ValueType } from './ValueType.ts';
-export interface RankItem {
-    get label(): TextRange<'item-label'>;
-    get value(): string;
-}
+export type RankItem = BaseItem;
 export type RankValueOptions = readonly RankItem[];
 export interface RankNodeState extends BaseValueNodeState<readonly string[]> {
     get valueOptions(): RankValueOptions;

package/dist/client/SelectNode.d.ts

@@ -1,16 +1,13 @@
 import { AnySelectControlDefinition, SelectType } from '../parse/body/control/SelectControlDefinition.ts';
 import { LeafNodeDefinition } from '../parse/model/LeafNodeDefinition.ts';
 import { BaseValueNode, BaseValueNodeState } from './BaseValueNode.ts';
+import { BaseItem } from './BaseItem.ts';
 import { NodeAppearances } from './NodeAppearances.ts';
 import { RootNode } from './RootNode.ts';
-import { TextRange } from './TextRange.ts';
 import { ValueType } from './ValueType.ts';
 import { GeneralParentNode } from './hierarchy.ts';
 import { LeafNodeValidationState } from './validation.ts';
-export interface SelectItem {
-    get label(): TextRange<'item-label'>;
-    get value(): string;
-}
+export type SelectItem = BaseItem;
 export type SelectValueOptions = readonly SelectItem[];
 export interface SelectNodeState extends BaseValueNodeState<readonly string[]> {
     get isSelectWithImages(): boolean;

package/dist/client/TextRange.d.ts

@@ -1,5 +1,6 @@
 import { JRResourceURL } from '../../../common/src/jr-resources/JRResourceURL.ts';
 import { ActiveLanguage } from './FormLanguage.ts';
+import { MarkdownNode } from './MarkdownNode.ts';
 /**
  * **COMMENTARY**
  *
@@ -64,7 +65,6 @@ export interface TextChunk {
      */
     get language(): ActiveLanguage;
     get asString(): string;
-    get formatted(): unknown;
 }
 export type ElementTextRole = 'hint' | 'label' | 'item-label';
 export type ValidationTextRole = 'constraintMsg' | 'requiredMsg';
@@ -126,7 +126,7 @@ export interface TextRange<Role extends TextRole, Origin extends TextOrigin = Te
     readonly role: Role;
     [Symbol.iterator](): Iterable<TextChunk>;
     get asString(): string;
-    get formatted(): unknown;
+    get formatted(): MarkdownNode[];
     get imageSource(): JRResourceURL | undefined;
     get audioSource(): JRResourceURL | undefined;
     get videoSource(): JRResourceURL | undefined;

package/dist/client/hierarchy.d.ts

@@ -10,7 +10,6 @@ import { RepeatRangeControlledNode } from './repeat/RepeatRangeControlledNode.ts
 import { RepeatRangeUncontrolledNode } from './repeat/RepeatRangeUncontrolledNode.ts';
 import { RootNode } from './RootNode.ts';
 import { SelectNode } from './SelectNode.ts';
-import { SubtreeNode } from './SubtreeNode.ts';
 import { TriggerNode } from './TriggerNode.ts';
 import { UploadNode } from './UploadNode.ts';
 export type AnyControlNode = AnyInputNode | AnyNoteNode | AnyRangeNode | RankNode | SelectNode | TriggerNode | UploadNode;
@@ -20,7 +19,7 @@ export type RepeatRangeNode = RepeatRangeControlledNode | RepeatRangeUncontrolle
  * Any of the concrete node types which may be a parent of non-repeat instance
  * child nodes.
  */
-export type GeneralParentNode = RootNode | SubtreeNode | GroupNode | RepeatInstanceNode;
+export type GeneralParentNode = RootNode | GroupNode | RepeatInstanceNode;
 /**
  * Any of the concrete node types which may be a parent of any other node.
  *

package/dist/client/index.d.ts

@@ -1,5 +1,6 @@
 export type * from './attachments/InstanceAttachmentMeta.ts';
 export type * from './attachments/InstanceAttachmentsConfig.ts';
+export type * from './AttributeNode.ts';
 export type * from './constants.ts';
 export * as constants from './constants.ts';
 export type * from './form/CreateFormInstance.ts';
@@ -15,6 +16,7 @@ export type * from './GroupNode.ts';
 export type { AnyChildNode, AnyControlNode, AnyLeafNode, AnyNode, AnyParentNode, GeneralChildNode, GeneralParentNode, RepeatRangeNode, } from './hierarchy.ts';
 export type * from './identity.ts';
 export type * from './InputNode.ts';
+export type * from './MarkdownNode.ts';
 export type * from './ModelValueNode.ts';
 export type * from './NoteNode.ts';
 export type * from './OpaqueReactiveObjectFactory.ts';
@@ -32,7 +34,6 @@ export type * from './serialization/InstancePayload.ts';
 export type * from './serialization/InstancePayloadOptions.ts';
 export type * from './serialization/InstanceState.ts';
 export type * from './submission/SubmissionMeta.ts';
-export type * from './SubtreeNode.ts';
 export type * from './TextRange.ts';
 export type * from './TriggerNode.ts';
 export type * from './UploadNode.ts';

package/dist/client/node-types.d.ts

@@ -1,3 +1,3 @@
 export type RepeatRangeNodeType = 'repeat-range:controlled' | 'repeat-range:uncontrolled';
-export type LeafNodeType = 'model-value' | 'note' | 'select' | 'input' | 'trigger' | 'range' | 'rank' | 'upload';
-export type InstanceNodeType = 'root' | RepeatRangeNodeType | 'repeat-instance' | 'group' | 'subtree' | LeafNodeType;
+export type LeafNodeType = 'model-value' | 'note' | 'select' | 'input' | 'trigger' | 'range' | 'rank' | 'attribute' | 'upload';
+export type InstanceNodeType = 'root' | RepeatRangeNodeType | 'repeat-instance' | 'group' | LeafNodeType;

package/dist/client/validation.d.ts

@@ -158,5 +158,11 @@ export interface DescendantNodeViolationReference {
 export interface AncestorNodeValidationState {
     get violations(): readonly DescendantNodeViolationReference[];
 }
-export type NodeValidationState = AncestorNodeValidationState | LeafNodeValidationState;
+/**
+ * Convenience interface for nodes that cannot be invalid.
+ */
+export interface NullValidationState {
+    get violations(): readonly [];
+}
+export type NodeValidationState = AncestorNodeValidationState | LeafNodeValidationState | NullValidationState;
 export {};