@getodk/xforms-engine 0.1.0 → 0.2.0

package/dist/client/RepeatRangeNode.d.ts

@@ -1,9 +1,11 @@
-import type { RepeatSequenceDefinition } from '../model/RepeatSequenceDefinition.ts';
-import type { BaseNode, BaseNodeState } from './BaseNode.ts';
-import type { RepeatInstanceNode } from './RepeatInstanceNode.ts';
-import type { RootNode } from './RootNode.ts';
-import type { TextRange } from './TextRange.ts';
-import type { GeneralParentNode } from './hierarchy.ts';
+import { RepeatRangeDefinition } from '../model/RepeatRangeDefinition.ts';
+import { BaseNode, BaseNodeState } from './BaseNode.ts';
+import { NodeAppearances } from './NodeAppearances.ts';
+import { RepeatInstanceNode } from './RepeatInstanceNode.ts';
+import { RootNode } from './RootNode.ts';
+import { TextRange } from './TextRange.ts';
+import { GeneralParentNode } from './hierarchy.ts';
+
 export interface RepeatRangeNodeState extends BaseNodeState {
     get hint(): null;
     get label(): TextRange<'label'> | null;
@@ -19,6 +21,7 @@ export interface RepeatRangeNodeState extends BaseNodeState {
     get valueOptions(): null;
     get value(): null;
 }
+export type RepeatRangeNodeAppearances = NodeAppearances<RepeatRangeDefinition>;
 /**
  * Represents a contiguous set of zero or more {@link RepeatInstanceNode}s
  * (accessed by its
@@ -85,7 +88,8 @@ export interface RepeatRangeNodeState extends BaseNodeState {
  */
 export interface RepeatRangeNode extends BaseNode {
     readonly nodeType: 'repeat-range';
-    readonly definition: RepeatSequenceDefinition;
+    readonly appearances: RepeatRangeNodeAppearances;
+    readonly definition: RepeatRangeDefinition;
     readonly root: RootNode;
     readonly parent: GeneralParentNode;
     readonly currentState: RepeatRangeNodeState;

package/dist/client/RootNode.d.ts

@@ -1,7 +1,9 @@
-import type { RootDefinition } from '../model/RootDefinition.ts';
-import type { BaseNode, BaseNodeState } from './BaseNode.ts';
-import type { ActiveLanguage, FormLanguage, FormLanguages } from './FormLanguage.ts';
-import type { GeneralChildNode } from './hierarchy.ts';
+import { BodyClassList } from '../body/BodyDefinition.ts';
+import { RootDefinition } from '../model/RootDefinition.ts';
+import { BaseNode, BaseNodeState } from './BaseNode.ts';
+import { ActiveLanguage, FormLanguage, FormLanguages } from './FormLanguage.ts';
+import { GeneralChildNode } from './hierarchy.ts';
+
 export interface RootNodeState extends BaseNodeState {
     /**
      * This, along with {@link RootNode.languages} is the most significant break
@@ -18,6 +20,24 @@ export interface RootNodeState extends BaseNodeState {
 }
 export interface RootNode extends BaseNode {
     readonly nodeType: 'root';
+    /**
+     * @todo this along with {@link classes} is... awkward.
+     */
+    readonly appearances: null;
+    /**
+     * @todo This is another odd deviation in {@link RootNode}. Unlike
+     * {@link languages}, it doesn't feel particularly **essential**. While it
+     * would deviate from XForms spec terminology, it seems like it _might be
+     * reasonable_ to instead convey `<h:body class="...">` as
+     * {@link RootNode.appearances} in the client interface. They do have slightly
+     * different spec semantics (i.e. a body class can be anything, to trigger
+     * styling in a form UI). But the **most likely anticipated** use case in Web
+     * Forms would be the "pages" class, and perhaps "theme-grid". The former is
+     * definitely conceptually similar to a XForms `appearance` (albeit
+     * form-global, which is not a spec concept). The latter does as well, and we
+     * already anticipate applying that concept in non-form-global ways.
+     */
+    readonly classes: BodyClassList;
     readonly definition: RootDefinition;
     readonly root: RootNode;
     readonly parent: null;

package/dist/client/SelectNode.d.ts

@@ -1,9 +1,11 @@
-import type { AnySelectDefinition } from '../body/control/select/SelectDefinition.ts';
-import type { ValueNodeDefinition } from '../model/ValueNodeDefinition.ts';
-import type { BaseNode, BaseNodeState } from './BaseNode.ts';
-import type { RootNode } from './RootNode.ts';
-import type { TextRange } from './TextRange.ts';
-import type { GeneralParentNode } from './hierarchy.ts';
+import { AnySelectDefinition } from '../body/control/select/SelectDefinition.ts';
+import { ValueNodeDefinition } from '../model/ValueNodeDefinition.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';
+
 export interface SelectItem {
     get value(): string;
     get label(): TextRange<'label'> | null;
@@ -31,8 +33,10 @@ export interface SelectNodeState extends BaseNodeState {
 export interface SelectDefinition extends ValueNodeDefinition {
     readonly bodyElement: AnySelectDefinition;
 }
+export type SelectNodeAppearances = NodeAppearances<SelectDefinition>;
 export interface SelectNode extends BaseNode {
     readonly nodeType: 'select';
+    readonly appearances: SelectNodeAppearances;
     readonly definition: SelectDefinition;
     readonly root: RootNode;
     readonly parent: GeneralParentNode;

package/dist/client/StringNode.d.ts

@@ -1,8 +1,10 @@
-import type { InputDefinition } from '../body/control/InputDefinition.ts';
-import type { ValueNodeDefinition } from '../model/ValueNodeDefinition.ts';
-import type { BaseNode, BaseNodeState } from './BaseNode.ts';
-import type { RootNode } from './RootNode.ts';
-import type { GeneralParentNode } from './hierarchy.ts';
+import { InputDefinition } from '../body/control/InputDefinition.ts';
+import { ValueNodeDefinition } from '../model/ValueNodeDefinition.ts';
+import { BaseNode, BaseNodeState } from './BaseNode.ts';
+import { NodeAppearances } from './NodeAppearances.ts';
+import { RootNode } from './RootNode.ts';
+import { GeneralParentNode } from './hierarchy.ts';
+
 export interface StringNodeState extends BaseNodeState {
     get children(): null;
     get valueOptions(): null;
@@ -17,6 +19,7 @@ export interface StringNodeState extends BaseNodeState {
 export interface StringDefinition extends ValueNodeDefinition {
     readonly bodyElement: InputDefinition | null;
 }
+export type StringNodeAppearances = NodeAppearances<StringDefinition>;
 /**
  * A node which can be assigned a string/text value. A string node **MAY**
  * correspond to form field defined as an XForms `<input>`, which a user-facing
@@ -26,6 +29,7 @@ export interface StringDefinition extends ValueNodeDefinition {
  */
 export interface StringNode extends BaseNode {
     readonly nodeType: 'string';
+    readonly appearances: StringNodeAppearances;
     readonly definition: StringDefinition;
     readonly root: RootNode;
     readonly parent: GeneralParentNode;

package/dist/client/SubtreeNode.d.ts

@@ -1,7 +1,8 @@
-import type { SubtreeDefinition as BaseSubtreeDefinition } from '../model/SubtreeDefinition.ts';
-import type { BaseNode, BaseNodeState } from './BaseNode.ts';
-import type { RootNode } from './RootNode.ts';
-import type { GeneralChildNode, GeneralParentNode } from './hierarchy.ts';
+import { SubtreeDefinition as BaseSubtreeDefinition } from '../model/SubtreeDefinition.ts';
+import { BaseNode, BaseNodeState } from './BaseNode.ts';
+import { RootNode } from './RootNode.ts';
+import { GeneralChildNode, GeneralParentNode } from './hierarchy.ts';
+
 export interface SubtreeNodeState extends BaseNodeState {
     get label(): null;
     get hint(): null;
@@ -45,6 +46,7 @@ export interface SubtreeDefinition extends BaseSubtreeDefinition {
  */
 export interface SubtreeNode extends BaseNode {
     readonly nodeType: 'subtree';
+    readonly appearances: null;
     readonly definition: SubtreeDefinition;
     readonly root: RootNode;
     readonly parent: GeneralParentNode;

package/dist/client/TextRange.d.ts

@@ -1,4 +1,5 @@
-import type { ActiveLanguage } from './FormLanguage.ts';
+import { ActiveLanguage } from './FormLanguage.ts';
+
 export type TextChunkSource = 'itext' | 'output' | 'static';
 /**
  * @todo This (and everything else to do with {@link TextRange}s is for

package/dist/client/hierarchy.d.ts

@@ -1,11 +1,12 @@
-import type { ExpandUnion } from '../../../common/types/helpers.d.ts';
-import type { GroupNode } from './GroupNode.ts';
-import type { RepeatInstanceNode } from './RepeatInstanceNode.ts';
-import type { RepeatRangeNode } from './RepeatRangeNode.ts';
-import type { RootNode } from './RootNode.ts';
-import type { SelectNode } from './SelectNode.ts';
-import type { StringNode } from './StringNode.ts';
-import type { SubtreeNode } from './SubtreeNode.ts';
+import { ExpandUnion } from '../../../common/types/helpers.d.ts';
+import { GroupNode } from './GroupNode.ts';
+import { RepeatInstanceNode } from './RepeatInstanceNode.ts';
+import { RepeatRangeNode } from './RepeatRangeNode.ts';
+import { RootNode } from './RootNode.ts';
+import { SelectNode } from './SelectNode.ts';
+import { StringNode } from './StringNode.ts';
+import { SubtreeNode } from './SubtreeNode.ts';
+
 export type AnyLeafNode = SelectNode | StringNode;
 /**
  * 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 @@
-import type { EngineConfig } from './EngineConfig.ts';
-import type { RootNode } from './RootNode.ts';
+import { EngineConfig } from './EngineConfig.ts';
+import { RootNode } from './RootNode.ts';
+
 export type FormResource = Blob | URL | string;
 export interface InitializeFormOptions {
     readonly config: EngineConfig;

package/dist/expression/DependencyContext.d.ts

@@ -1,4 +1,5 @@
-import type { AnyDependentExpression } from './DependentExpression.ts';
+import { AnyDependentExpression } from './DependentExpression.ts';
+
 export declare abstract class DependencyContext {
     abstract get parentReference(): string | null;
     abstract get reference(): string | null;

package/dist/expression/DependentExpression.d.ts

@@ -1,5 +1,6 @@
-import type { XFormsXPathEvaluator } from '@getodk/xpath';
-import type { DependencyContext } from './DependencyContext.ts';
+import { XFormsXPathEvaluator } from '@getodk/xpath';
+import { DependencyContext } from './DependencyContext.ts';
+
 declare const evaluatorMethodsByResultType: {
     readonly boolean: "evaluateBoolean";
     readonly nodes: "evaluateNodes";

package/dist/index.d.ts

@@ -1,4 +1,5 @@
-import type { InitializeForm } from './index.ts';
+import { InitializeForm } from './index.ts';
+
 export declare const initializeForm: InitializeForm;
 export type * from './client/EngineConfig.ts';
 export type * from './client/FormLanguage.ts';