@getodk/xforms-engine 0.7.0 → 0.8.0

package/dist/instance/PrimaryInstance.d.ts

@@ -20,6 +20,7 @@ import { ModelDefinition } from '../parse/model/ModelDefinition.ts';
 import { RootDefinition } from '../parse/model/RootDefinition.ts';
 import { SecondaryInstancesDefinition } from '../parse/model/SecondaryInstance/SecondaryInstancesDefinition.ts';
 import { InstanceNode } from './abstract/InstanceNode.ts';
+import { InstanceAttachmentsState } from './attachments/InstanceAttachmentsState.ts';
 import { InitialInstanceState } from './input/InitialInstanceState.ts';
 import { EvaluationContext } from './internal-api/EvaluationContext.ts';
 import { InstanceConfig } from './internal-api/InstanceConfig.ts';
@@ -58,11 +59,9 @@ export interface PrimaryInstanceOptions<Mode extends FormInstanceInitializationM
     readonly initialState: PrimaryInstanceInitialState<Mode>;
 }
 export declare class PrimaryInstance<Mode extends FormInstanceInitializationMode = FormInstanceInitializationMode> extends InstanceNode<RootDefinition, PrimaryInstanceStateSpec, null, Root> implements PrimaryInstanceDocument, XFormsXPathDocument, TranslationContext, EvaluationContext, ClientReactiveSerializableInstance {
-    /**
-     * @todo this will be populated as we introduce other initialization modes!
-     */
     readonly initializationMode: FormInstanceInitializationMode;
     readonly model: ModelDefinition;
+    readonly attachments: InstanceAttachmentsState;
     protected readonly state: SharedNodeState<PrimaryInstanceStateSpec>;
     protected readonly engineState: EngineState<PrimaryInstanceStateSpec>;
     readonly instanceNode: StaticDocument;

package/dist/instance/UploadControl.d.ts

@@ -0,0 +1,58 @@
+import { XPathNodeKindKey } from '@getodk/xpath';
+import { Accessor } from 'solid-js';
+import { TextRange } from '../client/TextRange.ts';
+import { UploadDefinition, UploadNode, UploadNodeOptions } from '../client/UploadNode.ts';
+import { ValueType } from '../client/ValueType.ts';
+import { InstanceAttachmentFileName, InstanceState } from '../client/index.ts';
+import { AnyViolation, LeafNodeValidationState } from '../client/validation.ts';
+import { XFormsXPathElement } from '../integration/xpath/adapter/XFormsXPathNode.ts';
+import { StaticLeafElement } from '../integration/xpath/static-dom/StaticElement.ts';
+import { CurrentState } from '../lib/reactivity/node-state/createCurrentState.ts';
+import { EngineState } from '../lib/reactivity/node-state/createEngineState.ts';
+import { SharedNodeState } from '../lib/reactivity/node-state/createSharedNodeState.ts';
+import { SimpleAtomicState } from '../lib/reactivity/types.ts';
+import { UnknownAppearanceDefinition } from '../parse/body/appearance/unknownAppearanceParser.ts';
+import { Root } from './Root.ts';
+import { DescendantNodeStateSpec, DescendantNode } from './abstract/DescendantNode.ts';
+import { InstanceAttachmentRuntimeValue } from './attachments/InstanceAttachment.ts';
+import { GeneralParentNode } from './hierarchy.ts';
+import { EvaluationContext } from './internal-api/EvaluationContext.ts';
+import { InstanceAttachmentContext } from './internal-api/InstanceAttachmentContext.ts';
+import { DecodeInstanceValue, InstanceValueContext } from './internal-api/InstanceValueContext.ts';
+import { ValidationContext } from './internal-api/ValidationContext.ts';
+import { ClientReactiveSerializableValueNode } from './internal-api/serialization/ClientReactiveSerializableValueNode.ts';
+export type AnyUploadDefinition = {
+    [V in ValueType]: UploadDefinition<V>;
+}[ValueType];
+interface UploadControlStateSpec extends DescendantNodeStateSpec<InstanceAttachmentRuntimeValue> {
+    readonly label: Accessor<TextRange<'label'> | null>;
+    readonly hint: Accessor<TextRange<'hint'> | null>;
+    readonly children: null;
+    readonly valueOptions: null;
+    readonly value: SimpleAtomicState<InstanceAttachmentRuntimeValue>;
+    readonly instanceValue: Accessor<InstanceAttachmentFileName>;
+}
+export declare class UploadControl extends DescendantNode<UploadDefinition<'binary'>, UploadControlStateSpec, GeneralParentNode, null> implements UploadNode, XFormsXPathElement, EvaluationContext, InstanceAttachmentContext, InstanceValueContext, ValidationContext, ClientReactiveSerializableValueNode {
+    readonly instanceNode: StaticLeafElement | null;
+    static from(parent: GeneralParentNode, instanceNode: StaticLeafElement | null, definition: UploadDefinition): UploadControl;
+    private readonly validation;
+    private readonly instanceAttachment;
+    readonly [XPathNodeKindKey] = "element";
+    readonly getXPathValue: () => InstanceAttachmentFileName;
+    protected readonly state: SharedNodeState<UploadControlStateSpec>;
+    protected readonly engineState: EngineState<UploadControlStateSpec>;
+    readonly decodeInstanceValue: DecodeInstanceValue;
+    readonly nodeType = "upload";
+    readonly valueType = "binary";
+    readonly appearances: UnknownAppearanceDefinition;
+    readonly nodeOptions: UploadNodeOptions;
+    readonly currentState: CurrentState<UploadControlStateSpec>;
+    get validationState(): LeafNodeValidationState;
+    readonly instanceState: InstanceState;
+    private constructor();
+    getViolation(): AnyViolation | null;
+    isBlank(): boolean;
+    getChildren(): readonly [];
+    setValue(value: InstanceAttachmentRuntimeValue): Root;
+}
+export {};

package/dist/instance/attachments/InstanceAttachment.d.ts

@@ -0,0 +1,42 @@
+import { Accessor } from 'solid-js';
+import { SimpleAtomicState, SimpleAtomicStateSetter } from '../../lib/reactivity/types.ts';
+import { InstanceAttachmentContext } from '../internal-api/InstanceAttachmentContext.ts';
+import { DecodeInstanceValue } from '../internal-api/InstanceValueContext.ts';
+export type InstanceAttachmentFileName = string;
+export type InstanceAttachmentRuntimeValue = File | null;
+export interface InstanceAttachmentOptions {
+    readonly getFileName: Accessor<InstanceAttachmentFileName | null>;
+    readonly getInstanceValue: Accessor<InstanceAttachmentFileName>;
+    readonly decodeInstanceValue: DecodeInstanceValue;
+    readonly getValue: Accessor<InstanceAttachmentRuntimeValue>;
+    readonly setValue: SimpleAtomicStateSetter<InstanceAttachmentRuntimeValue>;
+    readonly valueState: SimpleAtomicState<InstanceAttachmentRuntimeValue>;
+}
+export declare class InstanceAttachment {
+    /**
+     * 1. Creates {@link InstanceAttachment | attachment state} from
+     *    {@link InstanceAttachmentOptions}
+     * 2. Registers that attachment state in an instance-global
+     *    {@link InstanceAttachmentsState} entry
+     *
+     * This allows an instance to:
+     *
+     * - Produce distinct file names for each attachment
+     * - Track all attachments so they can be serialized in an
+     *   {@link InstancePayload}
+     */
+    static init(context: InstanceAttachmentContext, options: InstanceAttachmentOptions): InstanceAttachment;
+    /**
+     * This property isn't used at runtime. It causes TypeScript to treat
+     * {@link InstanceAttachment} as a nominal type, ensuring
+     * {@link InstanceAttachment.init} is called to instantiate it.
+     */
+    protected readonly _: null;
+    readonly getFileName: Accessor<InstanceAttachmentFileName | null>;
+    readonly getInstanceValue: Accessor<InstanceAttachmentFileName>;
+    readonly decodeInstanceValue: DecodeInstanceValue;
+    readonly getValue: Accessor<InstanceAttachmentRuntimeValue>;
+    readonly setValue: SimpleAtomicStateSetter<InstanceAttachmentRuntimeValue>;
+    readonly valueState: SimpleAtomicState<InstanceAttachmentRuntimeValue>;
+    private constructor();
+}

package/dist/instance/attachments/InstanceAttachmentsState.d.ts

@@ -0,0 +1,9 @@
+import { StaticLeafElement } from '../../integration/xpath/static-dom/StaticElement.ts';
+import { InstanceAttachmentMap } from '../input/InstanceAttachmentMap.ts';
+import { InstanceAttachmentContext } from '../internal-api/InstanceAttachmentContext.ts';
+import { InstanceAttachment, InstanceAttachmentRuntimeValue } from './InstanceAttachment.ts';
+export declare class InstanceAttachmentsState extends Map<InstanceAttachmentContext, InstanceAttachment> {
+    private readonly sourceAttachments;
+    constructor(sourceAttachments?: InstanceAttachmentMap | null);
+    getInitialFileValue(instanceNode: StaticLeafElement | null): InstanceAttachmentRuntimeValue;
+}

package/dist/instance/hierarchy.d.ts

@@ -4,6 +4,7 @@ import { AnyModelValue } from './ModelValue.ts';
 import { AnyNote } from './Note.ts';
 import { PrimaryInstance } from './PrimaryInstance.ts';
 import { AnyRangeControl } from './RangeControl.ts';
+import { RankControl } from './RankControl.ts';
 import { RepeatInstance } from './repeat/RepeatInstance.ts';
 import { RepeatRangeControlled } from './repeat/RepeatRangeControlled.ts';
 import { RepeatRangeUncontrolled } from './repeat/RepeatRangeUncontrolled.ts';
@@ -11,13 +12,11 @@ import { Root } from './Root.ts';
 import { SelectControl } from './SelectControl.ts';
 import { Subtree } from './Subtree.ts';
 import { TriggerControl } from './TriggerControl.ts';
-import { RankControl } from './RankControl.ts';
-import { UploadControl } from './unsupported/UploadControl.ts';
+import { UploadControl } from './UploadControl.ts';
 export type RepeatRange = RepeatRangeControlled | RepeatRangeUncontrolled;
-export type AnyUnsupportedControl = UploadControl;
-export type AnyNode = PrimaryInstance | Root | Group | Subtree | RepeatRange | RepeatInstance | AnyNote | AnyModelValue | AnyInputControl | AnyRangeControl | RankControl | SelectControl | TriggerControl | AnyUnsupportedControl;
+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 | AnyUnsupportedControl;
-export type GeneralChildNode = Group | Subtree | RepeatRange | AnyModelValue | AnyNote | AnyInputControl | AnyRangeControl | RankControl | SelectControl | TriggerControl | AnyUnsupportedControl;
-export type AnyValueNode = AnyModelValue | AnyNote | AnyInputControl | AnyRangeControl | RankControl | SelectControl | TriggerControl | AnyUnsupportedControl;
+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 AnyValueNode = AnyModelValue | AnyNote | AnyInputControl | AnyRangeControl | RankControl | SelectControl | TriggerControl | UploadControl;

package/dist/instance/internal-api/InstanceAttachmentContext.d.ts

@@ -0,0 +1,19 @@
+import { Accessor } from 'solid-js';
+import { FormNodeID } from '../../client/identity.ts';
+import { StaticLeafElement } from '../../integration/xpath/static-dom/StaticElement.ts';
+import { ReactiveScope } from '../../lib/reactivity/scope.ts';
+import { InstanceAttachmentsState } from '../attachments/InstanceAttachmentsState.ts';
+import { InstanceConfig } from './InstanceConfig.ts';
+interface InstanceAttachmentRootDocument {
+    readonly attachments: InstanceAttachmentsState;
+}
+export interface InstanceAttachmentContext {
+    readonly instanceConfig: InstanceConfig;
+    readonly scope: ReactiveScope;
+    readonly rootDocument: InstanceAttachmentRootDocument;
+    readonly nodeId: FormNodeID;
+    readonly instanceNode: StaticLeafElement | null;
+    readonly isRelevant: Accessor<boolean>;
+    readonly isAttached: Accessor<boolean>;
+}
+export {};

package/dist/instance/internal-api/InstanceConfig.d.ts

@@ -1,7 +1,9 @@
+import { InstanceAttachmentFileNameFactory } from '../../client/attachments/InstanceAttachmentsConfig.ts';
 import { OpaqueReactiveObjectFactory } from '../../client/OpaqueReactiveObjectFactory.ts';
 export interface InstanceConfig {
     /**
      * @see {@link FormInstanceConfig.stateFactory}
      */
     readonly clientStateFactory: OpaqueReactiveObjectFactory;
+    readonly computeAttachmentName: InstanceAttachmentFileNameFactory;
 }

package/dist/instance/internal-api/serialization/ClientReactiveSerializableInstance.d.ts

@@ -1,5 +1,6 @@
 import { SubmissionMeta } from '../../../client/submission/SubmissionMeta.ts';
 import { AncestorNodeValidationState } from '../../../client/validation.ts';
+import { InstanceAttachmentsState } from '../../attachments/InstanceAttachmentsState.ts';
 import { Root } from '../../Root.ts';
 import { ClientReactiveSerializableParentNode, ClientReactiveSerializableParentNodeDefinition } from './ClientReactiveSerializableParentNode.ts';
 interface ClientReactiveSerializableInstanceDefinition extends ClientReactiveSerializableParentNodeDefinition {
@@ -9,6 +10,7 @@ export interface ClientReactiveSerializableInstance extends ClientReactiveSerial
     readonly definition: ClientReactiveSerializableInstanceDefinition;
     readonly root: Root;
     readonly parent: null;
+    readonly attachments: InstanceAttachmentsState;
     readonly validationState: AncestorNodeValidationState;
 }
 export {};

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

@@ -0,0 +1,8 @@
+import { InstanceAttachmentFileName, InstanceAttachment } from '../../instance/attachments/InstanceAttachment.ts';
+import { InstanceAttachmentContext } from '../../instance/internal-api/InstanceAttachmentContext.ts';
+export type InstanceAttachmentRuntimeValue = File | null;
+export type InstanceAttachmentFormDataEntry = readonly [
+    key: InstanceAttachmentFileName,
+    value: NonNullable<InstanceAttachmentRuntimeValue>
+];
+export declare const createInstanceAttachment: (context: InstanceAttachmentContext) => InstanceAttachment;

package/dist/lib/resource-helpers.d.ts

@@ -0,0 +1,2 @@
+import { FetchResourceResponse } from '../client/resources.ts';
+export declare const getResponseContentType: (response: FetchResourceResponse) => string | null;

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

@@ -69,7 +69,8 @@ export declare class BodyDefinition extends DependencyContext implements BodyEle
     readonly reference: string;
     constructor(form: XFormDefinition);
     getBodyElement(reference: string): AnyBodyElementDefinition | null;
+    getBodyElementType(reference: BodyElementReference): AnyBodyElementType | null;
     getChildElementDefinitions(form: XFormDefinition, parent: BodyElementParentContext, parentElement: Element, children?: readonly Element[]): readonly AnyBodyElementDefinition[];
-    toJSON(): Omit<this, "form" | "toJSON" | "isTranslated" | "getBodyElement" | "getChildElementDefinitions">;
+    toJSON(): Omit<this, "form" | "toJSON" | "isTranslated" | "getBodyElement" | "getBodyElementType" | "getChildElementDefinitions">;
 }
 export {};

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

@@ -1,3 +1,4 @@
+import { UploadNodeOptions } from '../../../client/UploadNode.ts';
 import { XFormDefinition } from '../../XFormDefinition.ts';
 import { UnknownAppearanceDefinition } from '../appearance/unknownAppearanceParser.ts';
 import { BodyElementParentContext } from '../BodyDefinition.ts';
@@ -6,6 +7,7 @@ export declare class UploadControlDefinition extends ControlDefinition<'upload'>
     static isCompatible(localName: string): boolean;
     readonly type = "upload";
     readonly appearances: UnknownAppearanceDefinition;
+    readonly options: UploadNodeOptions;
     constructor(form: XFormDefinition, parent: BodyElementParentContext, element: Element);
     toJSON(): object;
 }

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

@@ -1,9 +1,5 @@
+import { XFormDefinition } from '../XFormDefinition.ts';
 import { BindElement } from './BindElement.ts';
-/**
- * As specified by {@link https://getodk.github.io/xforms-spec/#bind-attributes}
- */
-export declare const DEFAULT_BIND_TYPE = "string";
-export type DefaultBindType = typeof DEFAULT_BIND_TYPE;
 /**
  * As specified by {@link https://getodk.github.io/xforms-spec/#data-types}
  */
@@ -13,8 +9,7 @@ export type BindType = BindTypes[number];
 export declare class BindTypeDefinition<T extends BindType = BindType> {
     readonly source: string | null;
     readonly resolved: T;
-    static from<T extends BindType>(bindElement: BindElement): BindTypeDefinition<T>;
-    private constructor();
+    static from<T extends BindType>(form: XFormDefinition, nodeset: string, bindElement: BindElement): BindTypeDefinition<T>;
     private constructor();
 }
 export {};