@getodk/xforms-engine 0.3.0 → 0.4.0

package/dist/client/BaseNode.d.ts

@@ -1,9 +1,8 @@
-import { AnyNodeDefinition } from '../model/NodeDefinition.ts';
+import { AnyNodeDefinition } from '../parse/model/NodeDefinition.ts';
 import { NodeAppearances } from './NodeAppearances.ts';
 import { TextRange } from './TextRange.ts';
 import { InstanceNodeType } from './node-types.ts';
 import { NodeValidationState } from './validation.ts';
-
 export interface BaseNodeState {
     /**
      * Location path reference to the node's primary instance state. This property

package/dist/client/EngineConfig.d.ts

@@ -1,5 +1,4 @@
 import { OpaqueReactiveObjectFactory } from './OpaqueReactiveObjectFactory.ts';
-
 /**
  * @todo this is currently a strict subset of the web standard `Response`. Is it
  * sufficient? Ways it might not be:

package/dist/client/GroupNode.d.ts

@@ -1,11 +1,10 @@
-import { AnyGroupElementDefinition } from '../body/BodyDefinition.ts';
-import { SubtreeDefinition } from '../model/SubtreeDefinition.ts';
+import { AnyGroupElementDefinition } from '../parse/body/BodyDefinition.ts';
+import { SubtreeDefinition } from '../parse/model/SubtreeDefinition.ts';
 import { BaseNode, BaseNodeState } from './BaseNode.ts';
 import { NodeAppearances } from './NodeAppearances.ts';
 import { RootNode } from './RootNode.ts';
 import { GeneralChildNode, GeneralParentNode } from './hierarchy.ts';
 import { AncestorNodeValidationState } from './validation.ts';
-
 export interface GroupNodeState extends BaseNodeState {
     get hint(): null;
     get children(): readonly GeneralChildNode[];

package/dist/client/ModelValueNode.d.ts

@@ -1,9 +1,8 @@
-import { LeafNodeDefinition } from '../model/LeafNodeDefinition.ts';
+import { LeafNodeDefinition } from '../parse/model/LeafNodeDefinition.ts';
 import { BaseNode, BaseNodeState } from './BaseNode.ts';
 import { GeneralParentNode } from './hierarchy.ts';
 import { RootNode } from './RootNode.ts';
 import { LeafNodeValidationState } from './validation.ts';
-
 export interface ModelValueNodeState extends BaseNodeState {
     get label(): null;
     get hint(): null;

package/dist/client/NodeAppearances.d.ts

@@ -1,6 +1,5 @@
 import { ParsedTokenList } from '../lib/TokenListParser.ts';
-import { NodeDefinition } from '../model/NodeDefinition.ts';
-
+import { NodeDefinition } from '../parse/model/NodeDefinition.ts';
 /**
  * - Provides a means to distinguish between internal and client-facing names
  *   for the same {@link ParsedTokenList} types.

package/dist/client/NoteNode.d.ts

@@ -1,12 +1,11 @@
-import { InputDefinition } from '../body/control/InputDefinition.ts';
-import { LeafNodeDefinition } from '../model/LeafNodeDefinition.ts';
+import { InputDefinition } from '../parse/body/control/InputDefinition.ts';
+import { LeafNodeDefinition } from '../parse/model/LeafNodeDefinition.ts';
 import { BaseNode, BaseNodeState } from './BaseNode.ts';
 import { GeneralParentNode } from './hierarchy.ts';
 import { NodeAppearances } from './NodeAppearances.ts';
 import { RootNode } from './RootNode.ts';
 import { TextRange } from './TextRange.ts';
 import { LeafNodeValidationState } from './validation.ts';
-
 export interface NoteNodeState extends BaseNodeState {
     /**
      * Note-specific specialization: a note will always have a non-null value in

package/dist/client/RootNode.d.ts

@@ -1,10 +1,9 @@
-import { BodyClassList } from '../body/BodyDefinition.ts';
-import { RootDefinition } from '../model/RootDefinition.ts';
+import { BodyClassList } from '../parse/body/BodyDefinition.ts';
+import { RootDefinition } from '../parse/model/RootDefinition.ts';
 import { BaseNode, BaseNodeState } from './BaseNode.ts';
 import { ActiveLanguage, FormLanguage, FormLanguages } from './FormLanguage.ts';
 import { GeneralChildNode } from './hierarchy.ts';
 import { AncestorNodeValidationState } from './validation.ts';
-
 export interface RootNodeState extends BaseNodeState {
     /**
      * This, along with {@link RootNode.languages} is the most significant break

package/dist/client/SelectNode.d.ts

@@ -1,12 +1,11 @@
-import { AnySelectDefinition } from '../body/control/select/SelectDefinition.ts';
-import { LeafNodeDefinition } from '../model/LeafNodeDefinition.ts';
+import { AnySelectDefinition } from '../parse/body/control/select/SelectDefinition.ts';
+import { LeafNodeDefinition } from '../parse/model/LeafNodeDefinition.ts';
 import { BaseNode, BaseNodeState } from './BaseNode.ts';
 import { NodeAppearances } from './NodeAppearances.ts';
 import { RootNode } from './RootNode.ts';
 import { TextRange } from './TextRange.ts';
 import { GeneralParentNode } from './hierarchy.ts';
 import { LeafNodeValidationState } from './validation.ts';
-
 export interface SelectItem {
     get value(): string;
     get label(): TextRange<'item-label'> | null;

package/dist/client/StringNode.d.ts

@@ -1,11 +1,10 @@
-import { InputDefinition } from '../body/control/InputDefinition.ts';
-import { LeafNodeDefinition } from '../model/LeafNodeDefinition.ts';
+import { InputDefinition } from '../parse/body/control/InputDefinition.ts';
+import { LeafNodeDefinition } from '../parse/model/LeafNodeDefinition.ts';
 import { BaseNode, BaseNodeState } from './BaseNode.ts';
 import { NodeAppearances } from './NodeAppearances.ts';
 import { RootNode } from './RootNode.ts';
 import { GeneralParentNode } from './hierarchy.ts';
 import { LeafNodeValidationState } from './validation.ts';
-
 export interface StringNodeState extends BaseNodeState {
     get children(): null;
     get valueOptions(): null;

package/dist/client/SubtreeNode.d.ts

@@ -1,9 +1,8 @@
-import { SubtreeDefinition as BaseSubtreeDefinition } from '../model/SubtreeDefinition.ts';
+import { SubtreeDefinition as BaseSubtreeDefinition } from '../parse/model/SubtreeDefinition.ts';
 import { BaseNode, BaseNodeState } from './BaseNode.ts';
 import { RootNode } from './RootNode.ts';
 import { GeneralChildNode, GeneralParentNode } from './hierarchy.ts';
 import { AncestorNodeValidationState } from './validation.ts';
-
 export interface SubtreeNodeState extends BaseNodeState {
     get label(): null;
     get hint(): null;

package/dist/client/TextRange.d.ts

@@ -1,5 +1,4 @@
 import { ActiveLanguage } from './FormLanguage.ts';
-
 /**
  * **COMMENTARY**
  *
@@ -23,7 +22,7 @@ import { ActiveLanguage } from './FormLanguage.ts';
  *       Here, `is-translation-expr()` is a fictional shorthand for checking
  *       that the attribute's value is a valid `jr:itext(...)` FunctionCall
  *       expression. Note that, per spec, these attributes **do not accept
- *       arbitrary XPath expressions**! The non-translation case is  treated as
+ *       arbitrary XPath expressions**! The non-translation case is treated as
  *       static text, not parsed for e.g. an XPath [string] Literal expression.
  *       This is why we have introduced this 'translation' case, distinct from
  *       'reference', which previously handled translated labels and hints.
@@ -33,7 +32,7 @@ import { ActiveLanguage } from './FormLanguage.ts';
  *
  *     - `h:body//label/@ref[is-translation-expr()]`
  *
- * - 'static':
+ * - 'literal':
  *   - `h:head//bind/@jr:constraintMsg[not(is-translation-expr())]`
  *   - `h:head//bind/@jr:requiredMsg[not(is-translation-expr())]`
  *   - `h:body//label/text()`
@@ -57,7 +56,7 @@ import { ActiveLanguage } from './FormLanguage.ts';
  * package, and the engine doesn't really deal with itext translations at the
  * node level at all).
  */
-export type TextChunkSource = 'output' | 'reference' | 'translation' | 'static';
+export type TextChunkSource = 'literal' | 'output' | 'reference' | 'translation';
 /**
  * @todo This (and everything else to do with {@link TextRange}s is for
  * illustration purposes, as a starting point where any particular detail is of

package/dist/client/TriggerNode.d.ts

@@ -0,0 +1,25 @@
+import { UnknownAppearanceDefinition } from '../parse/body/appearance/unknownAppearanceParser.ts';
+import { TriggerControlDefinition } from '../parse/body/control/TriggerControlDefinition.ts';
+import { LeafNodeDefinition } from '../parse/model/LeafNodeDefinition.ts';
+import { BaseNode, BaseNodeState } from './BaseNode.ts';
+import { GeneralParentNode } from './hierarchy.ts';
+import { RootNode } from './RootNode.ts';
+import { LeafNodeValidationState } from './validation.ts';
+export interface TriggerNodeState extends BaseNodeState {
+    get children(): null;
+    get valueOptions(): null;
+    get value(): boolean;
+}
+export interface TriggerNodeDefinition extends LeafNodeDefinition {
+    readonly bodyElement: TriggerControlDefinition;
+}
+export interface TriggerNode extends BaseNode {
+    readonly nodeType: 'trigger';
+    readonly definition: TriggerNodeDefinition;
+    readonly appearances: UnknownAppearanceDefinition;
+    readonly root: RootNode;
+    readonly parent: GeneralParentNode;
+    readonly currentState: TriggerNodeState;
+    readonly validationState: LeafNodeValidationState;
+    setValue(value: boolean): RootNode;
+}

package/dist/client/constants.d.ts

@@ -1,5 +1,4 @@
 import { ValidationTextRole } from './TextRange.ts';
-
 export declare const VALIDATION_TEXT: {
     readonly constraintMsg: "Condition not satisfied: constraint";
     readonly requiredMsg: "Condition not satisfied: required";

package/dist/client/hierarchy.d.ts

@@ -9,9 +9,13 @@ import { RootNode } from './RootNode.ts';
 import { SelectNode } from './SelectNode.ts';
 import { StringNode } from './StringNode.ts';
 import { SubtreeNode } from './SubtreeNode.ts';
-
-export type AnyControlNode = NoteNode | SelectNode | StringNode;
-export type AnyLeafNode = AnyControlNode | ModelValueNode;
+import { TriggerNode } from './TriggerNode.ts';
+import { RangeNode } from './unsupported/RangeNode.ts';
+import { RankNode } from './unsupported/RankNode.ts';
+import { UploadNode } from './unsupported/UploadNode.ts';
+export type AnyUnsupportedControlNode = RangeNode | RankNode | UploadNode;
+export type AnyControlNode = NoteNode | SelectNode | StringNode | TriggerNode;
+export type AnyLeafNode = AnyControlNode | AnyUnsupportedControlNode | ModelValueNode;
 export type RepeatRangeNode = RepeatRangeControlledNode | RepeatRangeUncontrolledNode;
 /**
  * Any of the concrete node types which may be a parent of non-repeat instance

package/dist/client/index.d.ts

@@ -1,6 +1,5 @@
 import { EngineConfig } from './EngineConfig.ts';
 import { RootNode } from './RootNode.ts';
-
 export type FormResource = Blob | URL | string;
 export interface InitializeFormOptions {
     readonly config: EngineConfig;

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

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

package/dist/client/repeat/BaseRepeatRangeNode.d.ts

@@ -1,4 +1,4 @@
-import { AnyRepeatRangeDefinition } from '../../model/RepeatRangeDefinition.ts';
+import { AnyRepeatRangeDefinition } from '../../parse/model/RepeatRangeDefinition.ts';
 import { BaseNode, BaseNodeState } from '../BaseNode.ts';
 import { NodeAppearances } from '../NodeAppearances.ts';
 import { RootNode } from '../RootNode.ts';
@@ -7,7 +7,6 @@ import { GeneralParentNode } from '../hierarchy.ts';
 import { RepeatRangeNodeType } from '../node-types.ts';
 import { AncestorNodeValidationState } from '../validation.ts';
 import { RepeatInstanceNode } from './RepeatInstanceNode.ts';
-
 export interface BaseRepeatRangeNodeState extends BaseNodeState {
     get hint(): null;
     get label(): TextRange<'label'> | null;

package/dist/client/repeat/RepeatInstanceNode.d.ts

@@ -1,11 +1,10 @@
-import { RepeatInstanceDefinition } from '../../model/RepeatInstanceDefinition.ts';
-import { RepeatTemplateDefinition } from '../../model/RepeatTemplateDefinition.ts';
+import { RepeatInstanceDefinition } from '../../parse/model/RepeatInstanceDefinition.ts';
+import { RepeatTemplateDefinition } from '../../parse/model/RepeatTemplateDefinition.ts';
 import { BaseNode, BaseNodeState } from '../BaseNode.ts';
 import { GeneralChildNode, RepeatRangeNode } from '../hierarchy.ts';
 import { NodeAppearances } from '../NodeAppearances.ts';
 import { RootNode } from '../RootNode.ts';
 import { AncestorNodeValidationState } from '../validation.ts';
-
 export interface RepeatInstanceNodeState extends BaseNodeState {
     get hint(): null;
     get children(): readonly GeneralChildNode[];

package/dist/client/repeat/RepeatRangeControlledNode.d.ts

@@ -1,6 +1,5 @@
-import { ControlledRepeatRangeDefinition } from '../../model/RepeatRangeDefinition.ts';
+import { ControlledRepeatRangeDefinition } from '../../parse/model/RepeatRangeDefinition.ts';
 import { BaseRepeatRangeNode, BaseRepeatRangeNodeState } from './BaseRepeatRangeNode.ts';
-
 /**
  * {@inheritDoc BaseRepeatRangeNodeState}
  * @see {@link BaseRepeatRangeNodeState}

package/dist/client/repeat/RepeatRangeUncontrolledNode.d.ts

@@ -1,7 +1,6 @@
-import { UncontrolledRepeatRangeDefinition } from '../../model/RepeatRangeDefinition.ts';
+import { UncontrolledRepeatRangeDefinition } from '../../parse/model/RepeatRangeDefinition.ts';
 import { RootNode } from '../RootNode.ts';
 import { BaseRepeatRangeNode, BaseRepeatRangeNodeState } from './BaseRepeatRangeNode.ts';
-
 /**
  * {@inheritDoc BaseRepeatRangeNodeState}
  * @see {@link BaseRepeatRangeNodeState}

package/dist/client/unsupported/RangeNode.d.ts

@@ -0,0 +1,9 @@
+import { RangeControlDefinition } from '../../parse/body/control/RangeControlDefinition.ts';
+import { UnsupportedControlDefinition, UnsupportedControlNode } from './UnsupportedControlNode.ts';
+export interface RangeNodeDefinition extends UnsupportedControlDefinition {
+    readonly bodyElement: RangeControlDefinition;
+}
+export interface RangeNode extends UnsupportedControlNode {
+    readonly nodeType: 'range';
+    readonly definition: RangeNodeDefinition;
+}

package/dist/client/unsupported/RankNode.d.ts

@@ -0,0 +1,9 @@
+import { RankControlDefinition } from '../../parse/body/control/RankControlDefinition.ts';
+import { UnsupportedControlDefinition, UnsupportedControlNode } from './UnsupportedControlNode.ts';
+export interface RankNodeDefinition extends UnsupportedControlDefinition {
+    readonly bodyElement: RankControlDefinition;
+}
+export interface RankNode extends UnsupportedControlNode {
+    readonly nodeType: 'rank';
+    readonly definition: RankNodeDefinition;
+}

package/dist/client/unsupported/UnsupportedControlNode.d.ts

@@ -0,0 +1,32 @@
+import { UnknownAppearanceDefinition } from '../../parse/body/appearance/unknownAppearanceParser.ts';
+import { RangeControlDefinition } from '../../parse/body/control/RangeControlDefinition.ts';
+import { RankControlDefinition } from '../../parse/body/control/RankControlDefinition.ts';
+import { UploadControlDefinition } from '../../parse/body/control/UploadControlDefinition.ts';
+import { LeafNodeDefinition } from '../../parse/model/LeafNodeDefinition.ts';
+import { BaseNode, BaseNodeState } from '../BaseNode.ts';
+import { RootNode } from '../RootNode.ts';
+import { GeneralParentNode } from '../hierarchy.ts';
+import { UnsupportedControlNodeType } from '../node-types.ts';
+import { LeafNodeValidationState } from '../validation.ts';
+export interface UnsupportedControlNodeState extends BaseNodeState {
+    get children(): null;
+    get valueOptions(): unknown;
+    get value(): unknown;
+}
+export type UnsupportedControlElementDefinition = RangeControlDefinition | RankControlDefinition | UploadControlDefinition;
+export interface UnsupportedControlDefinition extends LeafNodeDefinition {
+    readonly bodyElement: UnsupportedControlElementDefinition;
+}
+/**
+ * Stub node, for form controls pending further engine support.
+ */
+export interface UnsupportedControlNode extends BaseNode {
+    readonly nodeType: UnsupportedControlNodeType;
+    readonly appearances: UnknownAppearanceDefinition;
+    readonly definition: UnsupportedControlDefinition;
+    readonly root: RootNode;
+    readonly parent: GeneralParentNode;
+    readonly currentState: UnsupportedControlNodeState;
+    readonly validationState: LeafNodeValidationState;
+    setValue?(value: never): never;
+}

package/dist/client/unsupported/UploadNode.d.ts

@@ -0,0 +1,9 @@
+import { UploadControlDefinition } from '../../parse/body/control/UploadControlDefinition.ts';
+import { UnsupportedControlDefinition, UnsupportedControlNode } from './UnsupportedControlNode.ts';
+export interface UploadNodeDefinition extends UnsupportedControlDefinition {
+    readonly bodyElement: UploadControlDefinition;
+}
+export interface UploadNode extends UnsupportedControlNode {
+    readonly nodeType: 'upload';
+    readonly definition: UploadNodeDefinition;
+}

package/dist/client/validation.d.ts

@@ -1,6 +1,5 @@
 import { NodeID } from '../instance/identity.ts';
 import { TextRange } from './TextRange.ts';
-
 interface BaseValidity {
     /**
      * Specifies the unambiguous validity state for each validity condition of a

package/dist/index.d.ts

@@ -1,11 +1,10 @@
 import { InitializeForm } from './index.ts';
-
 export declare const initializeForm: InitializeForm;
 export * as constants from './client/constants.ts';
 export type * from './client/EngineConfig.ts';
 export type * from './client/FormLanguage.ts';
 export type * from './client/GroupNode.ts';
-export type { AnyChildNode, AnyControlNode, AnyLeafNode, AnyNode, AnyParentNode, GeneralChildNode, GeneralParentNode, RepeatRangeNode, } from './client/hierarchy.ts';
+export type { AnyChildNode, AnyControlNode, AnyLeafNode, AnyNode, AnyParentNode, AnyUnsupportedControlNode, GeneralChildNode, GeneralParentNode, RepeatRangeNode, } from './client/hierarchy.ts';
 export type * from './client/index.ts';
 export type * from './client/ModelValueNode.ts';
 export type * from './client/NoteNode.ts';
@@ -18,5 +17,9 @@ export type * from './client/SelectNode.ts';
 export type * from './client/StringNode.ts';
 export type * from './client/SubtreeNode.ts';
 export type * from './client/TextRange.ts';
+export type * from './client/TriggerNode.ts';
+export type * from './client/unsupported/RangeNode.ts';
+export type * from './client/unsupported/RankNode.ts';
+export type * from './client/unsupported/UploadNode.ts';
 export type * from './client/validation.ts';
-export type { AnySelectDefinition, SelectDefinition, } from './body/control/select/SelectDefinition.ts';
+export type { AnySelectDefinition, SelectDefinition, } from './parse/body/control/select/SelectDefinition.ts';