@getodk/xforms-engine 0.14.0 → 0.16.0

package/dist/client/AttributeNode.d.ts

@@ -0,0 +1,50 @@
+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;
+    get relevant(): boolean;
+}
+/**
+ * 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;
+    readonly owner: 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/BaseNode.d.ts

@@ -1,3 +1,4 @@
+import { Attribute } from '../instance/Attribute.ts';
 import { AnyNodeDefinition } from '../parse/model/NodeDefinition.ts';
 import { NodeAppearances } from './NodeAppearances.ts';
 import { TextRange } from './TextRange.ts';
@@ -114,6 +115,10 @@ export interface BaseNodeState {
      * is an internal engine consideration.
      */
     get value(): unknown;
+    /**
+     * Nodes can own attributes, which have a literal or reference value.
+     */
+    get attributes(): readonly Attribute[];
 }
 /**
  * Base interface for common/shared aspects of any node type.

package/dist/client/form/FormInstanceConfig.d.ts

@@ -1,5 +1,19 @@
 import { InstanceAttachmentsConfig } from '../attachments/InstanceAttachmentsConfig.ts';
 import { OpaqueReactiveObjectFactory } from '../OpaqueReactiveObjectFactory.ts';
+/**
+ * @see https://getodk.github.io/xforms-spec/#preload-attributes
+ */
+export interface PreloadProperties {
+    /**
+     * The unique identifier for this device. If not provided, then an identifier will be
+     * generated during the first page load and stored in localstorage and reused for
+     * subsequent form loads.
+     */
+    readonly deviceID?: string;
+    readonly email?: string;
+    readonly username?: string;
+    readonly phoneNumber?: string;
+}
 export interface FormInstanceConfig {
     /**
      * A client may specify a generic function for constructing stateful objects.
@@ -16,4 +30,5 @@ export interface FormInstanceConfig {
      */
     readonly stateFactory?: OpaqueReactiveObjectFactory;
     readonly instanceAttachments?: InstanceAttachmentsConfig;
+    readonly preloadProperties?: PreloadProperties;
 }

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';

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 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 {};