@getodk/xforms-engine 0.15.0 → 0.16.1

package/dist/client/AttributeNode.d.ts

@@ -1,13 +1,15 @@
 import { Root } from '../instance/Root.ts';
 import { AttributeDefinition } from '../parse/model/AttributeDefinition.ts';
+import { BaseNode, BaseNodeState } from './BaseNode.ts';
 import { InstanceState } from './serialization/InstanceState.ts';
-export interface AttributeNodeState {
+export interface AttributeNodeState extends BaseNodeState {
     get value(): string;
+    get relevant(): boolean;
 }
 /**
  * Base interface for common/shared aspects of attributes.
  */
-export interface AttributeNode {
+export interface AttributeNode extends BaseNode {
     /**
      * Specifies the node's general type. This can be useful for narrowing types,
      * e.g. those of children.
@@ -24,10 +26,6 @@ export interface AttributeNode {
      * 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

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