@getodk/xforms-engine 0.13.0 → 0.14.0

package/dist/instance/hierarchy.d.ts

@@ -10,13 +10,12 @@ import { RepeatRangeControlled } from './repeat/RepeatRangeControlled.ts';
 import { RepeatRangeUncontrolled } from './repeat/RepeatRangeUncontrolled.ts';
 import { Root } from './Root.ts';
 import { SelectControl } from './SelectControl.ts';
-import { Subtree } from './Subtree.ts';
 import { TriggerControl } from './TriggerControl.ts';
 import { UploadControl } from './UploadControl.ts';
 export type RepeatRange = RepeatRangeControlled | RepeatRangeUncontrolled;
-export type AnyNode = PrimaryInstance | Root | Group | Subtree | RepeatRange | RepeatInstance | AnyNote | AnyModelValue | AnyInputControl | AnyRangeControl | RankControl | SelectControl | TriggerControl | UploadControl;
-export type AnyParentNode = PrimaryInstance | Root | Group | Subtree | RepeatRange | RepeatInstance;
-export type GeneralParentNode = Root | Group | Subtree | RepeatInstance;
-export type AnyChildNode = Root | Group | Subtree | RepeatRange | RepeatInstance | AnyModelValue | AnyNote | AnyInputControl | AnyRangeControl | RankControl | SelectControl | TriggerControl | UploadControl;
-export type GeneralChildNode = Group | Subtree | RepeatRange | AnyModelValue | AnyNote | AnyInputControl | AnyRangeControl | RankControl | SelectControl | TriggerControl | UploadControl;
+export type AnyNode = PrimaryInstance | Root | Group | RepeatRange | RepeatInstance | AnyNote | AnyModelValue | AnyInputControl | AnyRangeControl | RankControl | SelectControl | TriggerControl | UploadControl;
+export type AnyParentNode = PrimaryInstance | Root | Group | RepeatRange | RepeatInstance;
+export type GeneralParentNode = Root | Group | RepeatInstance;
+export type AnyChildNode = Root | Group | RepeatRange | RepeatInstance | AnyModelValue | AnyNote | AnyInputControl | AnyRangeControl | RankControl | SelectControl | TriggerControl | UploadControl;
+export type GeneralChildNode = Group | RepeatRange | AnyModelValue | AnyNote | AnyInputControl | AnyRangeControl | RankControl | SelectControl | TriggerControl | UploadControl;
 export type AnyValueNode = AnyModelValue | AnyNote | AnyInputControl | AnyRangeControl | RankControl | SelectControl | TriggerControl | UploadControl;

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

@@ -0,0 +1,75 @@
+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[];
+    readonly role = "parent";
+    abstract elementName: ElementName;
+    constructor(children: MarkdownNode[]);
+}
+export declare class Heading1 extends ParentMarkdownNode {
+    readonly elementName = "h1";
+}
+export declare class Heading2 extends ParentMarkdownNode {
+    readonly elementName = "h2";
+}
+export declare class Heading3 extends ParentMarkdownNode {
+    readonly elementName = "h3";
+}
+export declare class Heading4 extends ParentMarkdownNode {
+    readonly elementName = "h4";
+}
+export declare class Heading5 extends ParentMarkdownNode {
+    readonly elementName = "h5";
+}
+export declare class Heading6 extends ParentMarkdownNode {
+    readonly elementName = "h6";
+}
+export declare class Strong extends ParentMarkdownNode {
+    readonly elementName = "strong";
+}
+export declare class Underline extends ParentMarkdownNode {
+    readonly elementName = "u";
+}
+export declare class Emphasis extends ParentMarkdownNode {
+    readonly elementName = "em";
+}
+export declare class OrderedList extends ParentMarkdownNode {
+    readonly elementName = "ol";
+}
+export declare class UnorderedList extends ParentMarkdownNode {
+    readonly elementName = "ul";
+}
+export declare class ListItem extends ParentMarkdownNode {
+    readonly elementName = "li";
+}
+export declare class Anchor extends ParentMarkdownNode implements AnchorMarkdownNode {
+    readonly elementName = "a";
+    readonly url: string;
+    constructor(children: MarkdownNode[], url: string);
+}
+declare abstract class StyledMarkdownNode implements ClientParentMarkdownNode {
+    readonly children: MarkdownNode[];
+    readonly role = "parent";
+    abstract elementName: ElementName;
+    readonly properties: MarkdownProperty | undefined;
+    constructor(children: MarkdownNode[], properties: MarkdownProperty | undefined);
+}
+export declare class Paragraph extends StyledMarkdownNode implements ClientStyledMarkdownNode {
+    readonly elementName = "p";
+}
+export declare class Span extends StyledMarkdownNode implements ClientStyledMarkdownNode {
+    readonly elementName = "span";
+}
+export declare class Div extends StyledMarkdownNode implements ClientStyledMarkdownNode {
+    readonly elementName = "div";
+}
+export declare class ChildMarkdownNode implements ClientChildMarkdownNode {
+    readonly role = "child";
+    readonly value: string;
+    constructor(value: string);
+}
+export declare class Html implements ClientHtmlMarkdownNode {
+    readonly role = "html";
+    readonly unsafeHtml: string;
+    constructor(unsafeHtml: string);
+}
+export {};

package/dist/instance/text/TextChunk.d.ts

@@ -5,7 +5,6 @@ export declare class TextChunk implements ClientTextChunk {
     readonly context: TranslationContext;
     readonly source: TextChunkSource;
     readonly asString: string;
-    get formatted(): Record<PropertyKey, unknown>;
     get language(): ActiveLanguage;
     constructor(context: TranslationContext, source: TextChunkSource, asString: string);
 }

package/dist/instance/text/TextRange.d.ts

@@ -1,4 +1,5 @@
 import { JRResourceURL } from '../../../../common/src/jr-resources/JRResourceURL.ts';
+import { MarkdownNode } from '../../client/MarkdownNode.ts';
 import { TextRange as ClientTextRange, TextChunk, TextOrigin, TextRole } from '../../client/TextRange.ts';
 export interface MediaSources {
     image?: JRResourceURL;
@@ -11,7 +12,7 @@ export declare class TextRange<Role extends TextRole, Origin extends TextOrigin>
     protected readonly chunks: readonly TextChunk[];
     protected readonly mediaSources?: MediaSources | undefined;
     [Symbol.iterator](): Generator<TextChunk, void, unknown>;
-    get formatted(): Record<PropertyKey, unknown>;
+    get formatted(): MarkdownNode[];
     get asString(): string;
     get imageSource(): JRResourceURL | undefined;
     get audioSource(): JRResourceURL | undefined;

package/dist/instance/text/markdownFormat.d.ts

@@ -0,0 +1,3 @@
+import { MarkdownNode } from '../../client';
+import { TextChunk } from '../../client/TextRange.ts';
+export declare function format(chunks: readonly TextChunk[]): MarkdownNode[];

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

@@ -1,13 +1,11 @@
 import { Accessor } from 'solid-js';
-import { SelectItem } from '../../client/SelectNode.ts';
-import { RankItem } from '../../client/RankNode.ts';
-import { SelectControl } from '../../instance/SelectControl.ts';
+import { BaseItem } from '../../client/BaseItem.ts';
 import { RankControl } from '../../instance/RankControl.ts';
-export type ItemCollectionControl = RankControl | SelectControl;
-type Item = RankItem | SelectItem;
+import { SelectControl } from '../../instance/SelectControl.ts';
+type ItemCollectionControl = RankControl | SelectControl;
 /**
  * Creates a reactive computation of a {@link ItemCollectionControl}'s
- * {@link Item}s, in support of the field's `valueOptions`.
+ * {@link BaseItem}s, in support of the field's `valueOptions`.
  *
  * - The control defined with static `<item>`s will compute to an corresponding
  *   static list of items.
@@ -17,5 +15,5 @@ type Item = RankItem | SelectItem;
  *   their appropriate dependencies (whether relative to the itemset item node,
  *   referencing a form's `itext` translations, etc).
  */
-export declare const createItemCollection: (control: ItemCollectionControl) => Accessor<readonly Item[]>;
+export declare const createItemCollection: (control: ItemCollectionControl) => Accessor<readonly BaseItem[]>;
 export {};

package/dist/parse/body/BodyDefinition.d.ts

@@ -7,9 +7,7 @@ import { RankControlDefinition } from './control/RankControlDefinition.ts';
 import { AnySelectControlDefinition } from './control/SelectControlDefinition.ts';
 import { TriggerControlDefinition } from './control/TriggerControlDefinition.ts';
 import { UploadControlDefinition } from './control/UploadControlDefinition.ts';
-import { LogicalGroupDefinition } from './group/LogicalGroupDefinition.ts';
-import { PresentationGroupDefinition } from './group/PresentationGroupDefinition.ts';
-import { StructuralGroupDefinition } from './group/StructuralGroupDefinition.ts';
+import { GroupElementDefinition } from './GroupElementDefinition.ts';
 import { RepeatElementDefinition } from './RepeatElementDefinition.ts';
 import { UnsupportedBodyElementDefinition } from './UnsupportedBodyElementDefinition.ts';
 export interface BodyElementParentContext {
@@ -18,14 +16,10 @@ export interface BodyElementParentContext {
     readonly element: Element;
 }
 export type ControlElementDefinition = AnySelectControlDefinition | InputControlDefinition | RangeControlDefinition | RankControlDefinition | TriggerControlDefinition | UploadControlDefinition;
-type SupportedBodyElementDefinition = RepeatElementDefinition | LogicalGroupDefinition | PresentationGroupDefinition | StructuralGroupDefinition | ControlElementDefinition;
+type SupportedBodyElementDefinition = ControlElementDefinition | GroupElementDefinition | RepeatElementDefinition;
 export type AnyBodyElementDefinition = SupportedBodyElementDefinition | UnsupportedBodyElementDefinition;
 export type BodyElementDefinitionArray = readonly AnyBodyElementDefinition[];
 export type AnyBodyElementType = AnyBodyElementDefinition['type'];
-export type AnyGroupElementDefinition = Extract<AnyBodyElementDefinition, {
-    readonly type: `${string}-group`;
-}>;
-export declare const groupElementDefinition: (element: AnyBodyElementDefinition) => AnyGroupElementDefinition | null;
 export type AnyControlElementDefinition = Extract<AnyBodyElementDefinition, {
     readonly category: 'control';
 }>;

package/dist/parse/body/GroupElementDefinition.d.ts

@@ -0,0 +1,22 @@
+import { LabelDefinition } from '../text/LabelDefinition.ts';
+import { XFormDefinition } from '../XFormDefinition.ts';
+import { StructureElementAppearanceDefinition } from './appearance/structureElementAppearanceParser.ts';
+import { BodyElementDefinitionArray, BodyElementParentContext } from './BodyDefinition.ts';
+import { BodyElementDefinition } from './BodyElementDefinition.ts';
+/**
+ * As per the spec: https://getodk.github.io/xforms-spec/#groups
+ *
+ * A group combines elements together.
+ * The group can have a label, and if so is referred to as a "presentation group".
+ * The group can have a ref, and if so is referred to as a "logical group".
+ */
+export declare class GroupElementDefinition extends BodyElementDefinition<'group'> {
+    readonly category = "structure";
+    readonly type = "group";
+    readonly children: BodyElementDefinitionArray;
+    readonly reference: string | null;
+    readonly appearances: StructureElementAppearanceDefinition;
+    readonly label: LabelDefinition | null;
+    static isCompatible(localName: string): boolean;
+    constructor(form: XFormDefinition, parent: BodyElementParentContext, element: Element);
+}

package/dist/parse/body/control/ItemsetDefinition.d.ts

@@ -1,4 +1,6 @@
+import { StaticElement } from '../../../integration/xpath/static-dom/StaticElement.ts';
 import { ItemsetElement } from '../../../lib/dom/query.ts';
+import { DependentExpression } from '../../expression/abstract/DependentExpression.ts';
 import { ItemsetNodesetExpression } from '../../expression/ItemsetNodesetExpression.ts';
 import { ItemsetValueExpression } from '../../expression/ItemsetValueExpression.ts';
 import { ItemsetLabelDefinition } from '../../text/ItemsetLabelDefinition.ts';
@@ -15,4 +17,5 @@ export declare class ItemsetDefinition extends BodyElementDefinition<'itemset'>
     readonly nodes: ItemsetNodesetExpression;
     readonly value: ItemsetValueExpression;
     constructor(form: XFormDefinition, parent: AnySelectControlDefinition | RankControlDefinition, element: ItemsetElement);
+    getPropertiesExpressions(propertiesNodes: StaticElement[]): Array<DependentExpression<'string'>>;
 }

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

@@ -0,0 +1,6 @@
+import { StaticElement } from '../../integration/xpath/static-dom/StaticElement.ts';
+import { DependentExpression } from './abstract/DependentExpression.ts';
+export declare class ItemPropertyExpression extends DependentExpression<'string'> {
+    static from(propertiesNodes: StaticElement[]): ItemPropertyExpression[];
+    constructor(propertyName: string);
+}

package/dist/parse/model/{SubtreeDefinition.d.ts → GroupDefinition.d.ts}

@@ -1,13 +1,14 @@
 import { StaticElement } from '../../integration/xpath/static-dom/StaticElement.ts';
 import { NamespaceDeclarationMap } from '../../lib/names/NamespaceDeclarationMap.ts';
 import { QualifiedName } from '../../lib/names/QualifiedName.ts';
-import { AnyBodyElementDefinition, AnyGroupElementDefinition } from '../body/BodyDefinition.ts';
+import { AnyBodyElementDefinition } from '../body/BodyDefinition.ts';
+import { GroupElementDefinition } from '../body/GroupElementDefinition.ts';
 import { BindDefinition } from './BindDefinition.ts';
 import { DescendentNodeDefinition } from './DescendentNodeDefinition.ts';
 import { ChildNodeDefinition, ParentNodeDefinition } from './NodeDefinition.ts';
-export declare class SubtreeDefinition extends DescendentNodeDefinition<'subtree', AnyGroupElementDefinition | null> {
+export declare class GroupDefinition extends DescendentNodeDefinition<'group', GroupElementDefinition | null> {
     readonly template: StaticElement;
-    readonly type = "subtree";
+    readonly type = "group";
     readonly namespaceDeclarations: NamespaceDeclarationMap;
     readonly qualifiedName: QualifiedName;
     readonly children: readonly ChildNodeDefinition[];

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

@@ -4,10 +4,10 @@ import { QualifiedName } from '../../lib/names/QualifiedName.ts';
 import { AnyBodyElementDefinition } from '../body/BodyDefinition.ts';
 import { RepeatElementDefinition } from '../body/RepeatElementDefinition.ts';
 import { BindDefinition } from './BindDefinition.ts';
+import { GroupDefinition } from './GroupDefinition.ts';
 import { LeafNodeDefinition } from './LeafNodeDefinition.ts';
 import { AnyRepeatDefinition } from './RepeatDefinition.ts';
 import { RootDefinition } from './RootDefinition.ts';
-import { SubtreeDefinition } from './SubtreeDefinition.ts';
 /**
  * Corresponds to a model instance root node, i.e.:
  *
@@ -27,10 +27,9 @@ export type RootNodeType = 'root';
 export type RepeatType = 'repeat';
 /**
  * Corresponds to a model instance subtree which **does not** correspond to a
- * <repeat> in the form definition. This will typically correspond to a <group>,
- * but this is not strictly necessary per spec (hence the distinct name).
+ * <repeat> in the form definition.
  */
-export type SubtreeNodeType = 'subtree';
+export type GroupNodeType = 'group';
 /**
  * Corresponds to a model instance leaf node, i.e. one of:
  *
@@ -38,9 +37,9 @@ export type SubtreeNodeType = 'subtree';
  * - Any attribute corresponding to a bind's `nodeset` expression
  */
 export type LeafNodeType = 'leaf-node';
-export type NodeDefinitionType = RootNodeType | RepeatType | SubtreeNodeType | LeafNodeType;
-export type ParentNodeDefinition = RootDefinition | AnyRepeatDefinition | SubtreeDefinition;
-export type ChildNodeDefinition = AnyRepeatDefinition | LeafNodeDefinition | SubtreeDefinition;
+export type NodeDefinitionType = RootNodeType | RepeatType | GroupNodeType | LeafNodeType;
+export type ParentNodeDefinition = RootDefinition | AnyRepeatDefinition | GroupDefinition;
+export type ChildNodeDefinition = AnyRepeatDefinition | GroupDefinition | LeafNodeDefinition;
 export declare abstract class NodeDefinition<Type extends NodeDefinitionType> implements NamedSubtreeDefinition {
     readonly bind: BindDefinition;
     abstract readonly type: Type;
@@ -55,4 +54,4 @@ export declare abstract class NodeDefinition<Type extends NodeDefinitionType> im
     readonly nodeset: string;
     constructor(bind: BindDefinition);
 }
-export type AnyNodeDefinition = RootDefinition | AnyRepeatDefinition | SubtreeDefinition | LeafNodeDefinition;
+export type AnyNodeDefinition = RootDefinition | AnyRepeatDefinition | GroupDefinition | LeafNodeDefinition;

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

@@ -18,7 +18,7 @@ export interface UncontrolledRepeatDefinition extends RepeatDefinition {
  * "repeat", as defined by a form, where those concepts include:
  *
  * - A {@link RepeatElementDefinition}—corresponding to a `<repeat>` {@link https://getodk.github.io/xforms-spec/#body-elements | body element}—which is associated with the nodeset referencing the "repeat template" and
- *   all "repeat instances" (see below points describing both concepts in more detail). The presence of such a body element determines whether to produce a repeat definition (rather than e.g. a {@link SubtreeDefinition}).
+ *   all "repeat instances" (see below points describing both concepts in more detail). The presence of such a body element determines whether to produce a repeat definition (rather than e.g. a {@link GroupDefinition}).
  *
  * - A "repeat template", defined by a form either
  *   explicitly,

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

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

package/dist/parse/text/LabelDefinition.d.ts

@@ -1,14 +1,13 @@
 import { XFormDefinition } from '../../parse/XFormDefinition.ts';
-import { AnyGroupElementDefinition } from '../../parse/body/BodyDefinition.ts';
-import { RepeatElementDefinition } from '../body/RepeatElementDefinition.ts';
 import { AnyControlDefinition } from '../body/control/ControlDefinition.ts';
-import { BaseGroupDefinition } from '../body/group/BaseGroupDefinition.ts';
+import { GroupElementDefinition } from '../body/GroupElementDefinition.ts';
+import { RepeatElementDefinition } from '../body/RepeatElementDefinition.ts';
 import { TextElementDefinition } from './abstract/TextElementDefinition.ts';
-export type LabelOwner = AnyControlDefinition | AnyGroupElementDefinition | RepeatElementDefinition;
+export type LabelOwner = AnyControlDefinition | GroupElementDefinition | RepeatElementDefinition;
 export declare class LabelDefinition extends TextElementDefinition<'label'> {
     static forControl(form: XFormDefinition, control: AnyControlDefinition): LabelDefinition | null;
     static forRepeatGroup(form: XFormDefinition, repeat: RepeatElementDefinition): LabelDefinition | null;
-    static forGroup(form: XFormDefinition, group: BaseGroupDefinition<any>): LabelDefinition | null;
+    static forGroup(form: XFormDefinition, group: GroupElementDefinition): LabelDefinition | null;
     readonly role = "label";
     private constructor();
 }