@getodk/xforms-engine 0.6.0 → 0.8.0

package/dist/client/BaseNode.d.ts

@@ -3,7 +3,7 @@ import { NodeAppearances } from './NodeAppearances.ts';
 import { TextRange } from './TextRange.ts';
 import { FormNodeID } from './identity.ts';
 import { InstanceNodeType } from './node-types.ts';
-import { SubmissionState } from './submission/SubmissionState.ts';
+import { InstanceState } from './serialization/InstanceState.ts';
 import { NodeValidationState } from './validation.ts';
 export interface BaseNodeState {
     /**
@@ -211,14 +211,14 @@ export interface BaseNode {
      */
     readonly validationState: NodeValidationState;
     /**
-     * Represents the current submission state of the node.
+     * Represents the current instance state of the node.
      *
-     * @see {@link SubmissionState.submissionXML} for additional detail.
+     * @see {@link InstanceState.instanceXML} for additional detail.
      *
      * @todo Consider whether this can (should) be merged with
      * {@link currentState}, while providing the same client-reactivity
      * guarantees. (The challenge there is in defining client-reactive state which
      * self-referentially derives state from its own definition.)
      */
-    readonly submissionState: SubmissionState;
+    readonly instanceState: InstanceState;
 }

package/dist/client/BaseValueNode.d.ts

@@ -2,6 +2,7 @@ import { LeafNodeDefinition } from '../parse/model/LeafNodeDefinition.ts';
 import { BaseNode, BaseNodeState } from './BaseNode.ts';
 import { GeneralParentNode } from './hierarchy.ts';
 import { LeafNodeType } from './node-types.ts';
+import { InstanceState } from './serialization/InstanceState.ts';
 import { LeafNodeValidationState } from './validation.ts';
 import { ValueType } from './ValueType.ts';
 export interface BaseValueNodeState<Value> extends BaseNodeState {
@@ -13,12 +14,14 @@ export interface BaseValueNodeState<Value> extends BaseNodeState {
      * {@link value} state. This representation allows access to the node's value
      * _as primary instance state_. In other words, this is the value which:
      *
-     * - would be serialized as a text node in
-     *   {@link SubmissionState.submissionXML} (note: this value is **NOT**
-     *   escaped for XML serialization, as it is there)
+     * - would be serialized as a text node in {@link InstanceState.instanceXML}
+     *   (note: this value is **NOT** escaped for XML serialization, as it is
+     *   there)
      *
      * - is used when the node's value is referenced in any of a form's XPath
      *   expressions
+     *
+     * @todo Consider moving into {@link InstanceState}
      */
     get instanceValue(): string;
 }
@@ -29,4 +32,5 @@ export interface BaseValueNode<V extends ValueType = ValueType, Value = string>
     readonly parent: GeneralParentNode;
     readonly currentState: BaseValueNodeState<Value>;
     readonly validationState: LeafNodeValidationState;
+    readonly instanceState: InstanceState;
 }

package/dist/client/RootNode.d.ts

@@ -3,8 +3,8 @@ import { RootDefinition } from '../parse/model/RootDefinition.ts';
 import { BaseNode, BaseNodeState } from './BaseNode.ts';
 import { ActiveLanguage, FormLanguage, FormLanguages } from './FormLanguage.ts';
 import { GeneralChildNode } from './hierarchy.ts';
-import { SubmissionOptions } from './submission/SubmissionOptions.ts';
-import { ChunkedSubmissionResult, MonolithicSubmissionResult } from './submission/SubmissionResult.ts';
+import { ChunkedInstancePayload, InstancePayload, MonolithicInstancePayload } from './serialization/InstancePayload.ts';
+import { InstancePayloadOptions, InstancePayloadType } from './serialization/InstancePayloadOptions.ts';
 import { AncestorNodeValidationState } from './validation.ts';
 export interface RootNodeState extends BaseNodeState {
     /**
@@ -50,33 +50,37 @@ export interface RootNode extends BaseNode {
     readonly languages: FormLanguages;
     setLanguage(language: FormLanguage): RootNode;
     /**
-     * Prepares the current form instance state for submission.
+     * Prepares the current form instance state as an {@link InstancePayload}.
      *
-     * A {@link SubmissionResult} will be prepared even if the current form state
-     * includes `constraint` or `required` violations. This is intended to serve
-     * two purposes:
+     * A payload will be prepared even if the current form state includes
+     * `constraint` or `required` violations. This supports serveral purposes:
      *
-     * - A client may effectively use this method as a part of its own "submit"
-     *   routine, and use any violations included in the {@link SubmissionResult}
+     * - A client may effectively use this method as a part of its "submit"
+     *   workflow, and use any violations included in the {@link InstancePayload}
      *   to prompt users to address those violations.
      *
-     * - A client may inspect the submission state of a form at any time.
+     * - A client may inspect the serialized instance state of a form at any time.
      *   Depending on the client and use case, this may be a convenience (e.g. for
      *   developers to inspect that form state at a current point in time); or it
      *   may provide necessary functionality (e.g. for test or tooling clients).
      *
-     * Note on asynchrony: preparing a {@link SubmissionResult} is expected to be
-     * a fast operation. It may even be nearly instantaneous, or roughly
+     * - A client may capture _incomplete_ instance state (e.g. for storage in
+     *   client-side storage or similar persistance layer), to resume filling the
+     *   instance at a later time.
+     *
+     * Note on asynchrony: preparing a {@link InstancePayload} is expected to be a
+     * fast operation. It may even be nearly instantaneous, or roughly
      * proportionate to the size of the form itself. However, this method is
      * designed to be asynchronous out of an abundance of caution, anticipating
      * that some as-yet undeveloped operations on binary data (e.g. form
      * attachments) may themselves impose asynchrony (i.e. by interfaces provided
      * by the platform and/or external dependencies).
      *
-     * A client may specify {@link SubmissionOptions<'chunked'>}, in which case a
-     * {@link SubmissionResult<'chunked'>} will be produced, with form attachments
+     * A client may specify {@link InstancePayloadOptions<'chunked'>}, in which
+     * case a {@link ChunkedInstancePayload} will be produced, with form
+     * attachments
      */
-    prepareSubmission(): Promise<MonolithicSubmissionResult>;
-    prepareSubmission(options: SubmissionOptions<'monolithic'>): Promise<MonolithicSubmissionResult>;
-    prepareSubmission(options: SubmissionOptions<'chunked'>): Promise<ChunkedSubmissionResult>;
+    prepareInstancePayload(options?: InstancePayloadOptions<'monolithic'>): Promise<MonolithicInstancePayload>;
+    prepareInstancePayload(options: InstancePayloadOptions<'chunked'>): Promise<ChunkedInstancePayload>;
+    prepareInstancePayload<PayloadType extends InstancePayloadType>(options: InstancePayloadOptions<PayloadType>): Promise<InstancePayload<PayloadType>>;
 }

package/dist/client/UploadNode.d.ts

@@ -0,0 +1,53 @@
+import { PartiallyKnownString } from '../../../common/types/string/PartiallyKnownString.ts';
+import { UnknownAppearanceDefinition } from '../parse/body/appearance/unknownAppearanceParser.ts';
+import { UploadControlDefinition } from '../parse/body/control/UploadControlDefinition.ts';
+import { LeafNodeDefinition } from '../parse/model/LeafNodeDefinition.ts';
+import { BaseValueNode, BaseValueNodeState } from './BaseValueNode.ts';
+import { GeneralParentNode } from './hierarchy.ts';
+import { RootNode } from './RootNode.ts';
+import { InstanceAttachmentFileName } from './serialization/InstanceData.ts';
+import { LeafNodeValidationState } from './validation.ts';
+import { ValueType } from './ValueType.ts';
+export type UploadValue = File | null;
+export interface UploadNodeState extends BaseValueNodeState<UploadValue> {
+    get valueOptions(): null;
+    get value(): UploadValue;
+    get instanceValue(): InstanceAttachmentFileName;
+}
+export interface UploadDefinition<V extends ValueType = ValueType> extends LeafNodeDefinition<V> {
+    readonly bodyElement: UploadControlDefinition;
+}
+export type UploadMediaType = PartiallyKnownString<'*' | 'audio' | 'image' | 'video'>;
+export type UploadMediaSubtype = PartiallyKnownString<'*'>;
+export type UploadMediaAccept = PartiallyKnownString<'*' | `${UploadMediaType}/${UploadMediaSubtype}`>;
+interface BaseUploadMediaOptions {
+    readonly accept: UploadMediaAccept;
+    readonly type: UploadMediaType | null;
+    readonly subtype: UploadMediaSubtype | null;
+}
+export interface ExplicitUploadMediaOptions extends BaseUploadMediaOptions {
+    readonly type: UploadMediaType;
+    readonly subtype: UploadMediaSubtype;
+}
+export interface UnspecifiedUploadMediaOptions extends BaseUploadMediaOptions {
+    readonly type: null;
+    readonly subtype: null;
+}
+export type UploadMediaOptions = ExplicitUploadMediaOptions | UnspecifiedUploadMediaOptions;
+export interface UploadNodeOptions {
+    readonly media: UploadMediaOptions;
+}
+export interface UploadNode extends BaseValueNode<'binary', UploadValue> {
+    readonly nodeType: 'upload';
+    /** @todo */
+    readonly appearances: UnknownAppearanceDefinition;
+    readonly nodeOptions: UploadNodeOptions;
+    readonly valueType: 'binary';
+    readonly definition: UploadDefinition<'binary'>;
+    readonly root: RootNode;
+    readonly parent: GeneralParentNode;
+    readonly currentState: UploadNodeState;
+    readonly validationState: LeafNodeValidationState;
+    setValue(value: UploadValue): RootNode;
+}
+export {};

package/dist/client/attachments/InstanceAttachmentMeta.d.ts

@@ -0,0 +1,8 @@
+import { FormNodeID } from '../identity.ts';
+export type InstanceAttachmentExtension = `.${string}`;
+export interface InstanceAttachmentMeta {
+    readonly nodeId: FormNodeID;
+    readonly writtenAt: Date | null;
+    readonly basename: string;
+    readonly extension: InstanceAttachmentExtension | null;
+}

package/dist/client/attachments/InstanceAttachmentsConfig.d.ts

@@ -0,0 +1,8 @@
+import { InstanceAttachmentMeta } from './InstanceAttachmentMeta.ts';
+export interface UpdatedInstanceAttachmentMeta extends InstanceAttachmentMeta {
+    readonly writtenAt: Date;
+}
+export type InstanceAttachmentFileNameFactory = (meta: UpdatedInstanceAttachmentMeta) => string | null;
+export interface InstanceAttachmentsConfig {
+    readonly fileNameFactory?: InstanceAttachmentFileNameFactory;
+}

package/dist/client/constants.d.ts

@@ -1,17 +1,16 @@
 import { ValidationTextRole } from './TextRange.ts';
 export declare const MISSING_RESOURCE_BEHAVIOR: {
     /**
-     * When this behavior is configured, {@link InitializeForm | initializing} a
-     * {@link PrimaryInstance} for a form which references any **missing**
-     * resources will fail, producing an error to the calling client.
+     * When this behavior is configured, {@link LoadForm | loading a form} which
+     * references any **missing** resources will fail, producing an error to the
+     * calling client.
      *
      * @see {@link MissingResourceBehavior}
      */
     readonly ERROR: "ERROR";
     /**
-     * When this behavior is configured, {@link InitializeForm | initializing} a
-     * {@link PrimaryInstance} for a form which references any **missing**
-     * resources will succeed (producing a warning).
+     * When this behavior is configured, {@link LoadForm | loading a form} which
+     * references any **missing** resources will succeed (producing a warning).
      *
      * Such missing resources will be parsed as if they are blank, as appropriate
      * for the resource's XForm semantic usage and/or format.
@@ -28,8 +27,8 @@ export type MissingResourceBehaviorError = typeof MISSING_RESOURCE_BEHAVIOR.ERRO
 export type MissingResourceBehaviorBlank = typeof MISSING_RESOURCE_BEHAVIOR.BLANK;
 export type MissingResourceBehaviorDefault = typeof MISSING_RESOURCE_BEHAVIOR.DEFAULT;
 /**
- * Specifies behavior for {@link InitializeForm | initializing} a form's
- * {@link PrimaryInstance} which references any **missing** resources.
+ * Specifies behavior for {@link LoadForm | loading a form} which references any
+ * **missing** resources.
  *
  * Here the term "missing" is consistent with
  * {@link https://www.rfc-editor.org/rfc/rfc9110#status.404 | HTTP 404 status}
@@ -51,8 +50,8 @@ export declare const VALIDATION_TEXT: {
 };
 type ValidationTextDefaults = typeof VALIDATION_TEXT;
 export type ValidationTextDefault<Role extends ValidationTextRole> = ValidationTextDefaults[Role];
-export declare const SUBMISSION_INSTANCE_FILE_NAME = "xml_submission_file";
-export type SubmissionInstanceFileName = typeof SUBMISSION_INSTANCE_FILE_NAME;
-export declare const SUBMISSION_INSTANCE_FILE_TYPE = "text/xml";
-export type SubmissionInstanceFileType = typeof SUBMISSION_INSTANCE_FILE_TYPE;
+export declare const INSTANCE_FILE_NAME = "xml_submission_file";
+export type INSTANCE_FILE_NAME = typeof INSTANCE_FILE_NAME;
+export declare const INSTANCE_FILE_TYPE = "text/xml";
+export type INSTANCE_FILE_TYPE = typeof INSTANCE_FILE_TYPE;
 export {};

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

@@ -0,0 +1,14 @@
+import { FormInstance, FormInstanceCreateMode } from './FormInstance.ts';
+import { FormInstanceConfig } from './FormInstanceConfig.ts';
+export type CreatedFormInstance = FormInstance<FormInstanceCreateMode>;
+/**
+ * @todo This is fallible! Client-facing interfaces will need to account for
+ * this. We've begun addressing fallibility _at the interface level_ in
+ * {@link LoadForm} (with {@link LoadFormResult}). We'll eventually have a more
+ * general interface pattern for this, and we'll apply it here as well. The baby
+ * step approach in {@link LoadFormResult} is impractical here due to
+ * engine-internal designs, and revising that is currently out of scope. As
+ * such, explicit interface-level documentation of fallibility is deferred here,
+ * on {@link RootNode} itself, and into any of its sub-interfaces.
+ */
+export type CreateFormInstance = (config?: FormInstanceConfig) => CreatedFormInstance;

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

@@ -0,0 +1,62 @@
+import { Awaitable, Thunk } from '../../../../common/types/helpers.d.ts';
+import { FetchResourceResponse } from '../resources.ts';
+import { InstanceAttachmentFileName, InstanceData } from '../serialization/InstanceData.ts';
+import { FormInstance, FormInstanceEditMode } from './FormInstance.ts';
+import { FormInstanceConfig } from './FormInstanceConfig.ts';
+import { RestoreFormInstanceInput } from './RestoreFormInstance.ts';
+export type ResolvableFormInstanceInputType = 'FORM_INSTANCE_INPUT_RESOLVABLE';
+export type ResolvedFormInstanceInputType = 'FORM_INSTANCE_INPUT_RESOLVED';
+export type EditFormInstanceInputType = ResolvableFormInstanceInputType | ResolvedFormInstanceInputType;
+export type ResolvedFormInstance = Blob | FetchResourceResponse | File | string;
+export type ResolvableFormInstance = Thunk<Awaitable<ResolvedFormInstance>>;
+export type ResolveFormInstanceResource = Thunk<Promise<FetchResourceResponse>>;
+export type ResolvableInstanceAttachmentsMap = ReadonlyMap<InstanceAttachmentFileName, ResolveFormInstanceResource>;
+interface BaseEditFormInstanceInput {
+    readonly inputType: EditFormInstanceInputType;
+    readonly data?: readonly [InstanceData, ...InstanceData[]];
+    readonly resolveInstance?: ResolvableFormInstance;
+    readonly attachments?: ResolvableInstanceAttachmentsMap;
+}
+export interface ResolvableFormInstanceInput extends BaseEditFormInstanceInput {
+    readonly inputType: ResolvableFormInstanceInputType;
+    readonly resolveInstance: ResolvableFormInstance;
+    readonly attachments: ResolvableInstanceAttachmentsMap;
+    readonly data?: never;
+}
+/**
+ * @todo This is included as a strawman for discussiong: "should we accept input
+ * to {@link EditFormInstance} in the same shape as input to
+ * {@link RestoreFormInstance}?".
+ *
+ * Pros:
+ *
+ * - More consistency between the two entrypoint APIs, which are pretty similar
+ *   _conceptually_.
+ * - ?
+ *
+ * Cons:
+ *
+ * - Less consistency between this entrypoint API and {@link LoadForm}, which is
+ *   also responsible for loading arbitrary attachments (presumably over a
+ *   network), which...
+ * - ... all but rules out flexibility to optimize loading large resources (i.e.
+ *   streaming video/audio)
+ *
+ * Alternative:
+ *
+ * - Increase consistency across the board by inverting the relationship between
+ *   edit/restore: {@link RestoreFormInstanceInput} could be the place where we
+ *   accept a union of resolved | resolvable input, and clients which might
+ *   benefit from this consistency could consolidate on the resolvable case
+ *   without sacrificing resource loading optimizations)
+ */
+export interface ResolvedFormInstanceInput extends BaseEditFormInstanceInput, RestoreFormInstanceInput {
+    readonly inputType: ResolvedFormInstanceInputType;
+    readonly data: readonly [InstanceData, ...InstanceData[]];
+    readonly resolveInstance?: never;
+    readonly attachments?: never;
+}
+export type EditFormInstanceInput = ResolvableFormInstanceInput | ResolvedFormInstanceInput;
+export type EditedFormInstance = FormInstance<FormInstanceEditMode>;
+export type EditFormInstance = (input: EditFormInstanceInput, config?: FormInstanceConfig) => Promise<EditedFormInstance>;
+export {};

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

@@ -0,0 +1,104 @@
+import { RootNode } from '../RootNode.ts';
+import { InstantiableLoadFormResult } from './LoadFormResult.ts';
+/**
+ * Represents an instance which is newly created from a form definition.
+ *
+ * A newly created instance is populated with default values and state defined
+ * by the form.
+ *
+ * Computations are performed on initialization as specified by
+ * {@link https://getodk.github.io/xforms-spec/ | ODK XForms}, as the instance's
+ * {@link https://getodk.github.io/xforms-spec/#event:odk-instance-first-load | first load}.
+ */
+export type FormInstanceCreateMode = 'create';
+/**
+ * Represents an instance restored from previously filled state, as represented
+ * in an {@link InstancePayload}. Clients may serialize and persist an instance
+ * payload as appropriate for their use cases, and can restore the instance with
+ * a partial instance payload structure, defined by the
+ * {@link RestoreFormInstanceInput} interface.
+ *
+ * A restored instance is populated by the engine with the answers as they had
+ * been filled at the time the {@link InstancePayload}
+ * ({@link RestoreFormInstanceInput}) was created.
+ *
+ * Computations are performed on initialization as specified by
+ * {@link https://getodk.github.io/xforms-spec/#event:odk-instance-load | ODK XForms},
+ * as a
+ * {@link https://getodk.github.io/xforms-spec/#event:odk-instance-load | subsequent load}
+ * (i.e. **NOT** "first load", as is the case with newly
+ * {@link FormInstanceCreateMode | created} instances}) of the instance.
+ */
+export type FormInstanceRestoreMode = 'restore';
+/**
+ * Represents an instance which:
+ *
+ * - was previously serialized
+ * - was **submitted**, often referred to as a "submission" (noun)
+ * - is being initialized to produce an edited instance of that "submission"
+ *
+ * An edited instance may be populated from one or more network-accessible
+ * resources—its serialized instance XML, and any _instance attachments_—which
+ * are resolved in a manner similar to that of a form definition and its _form
+ * attachments_.
+ *
+ * Once resolved, an edited instance is restored from its previously filled
+ * state _as it was submitted_, consistent with
+ * {@link FormInstanceRestoreMode | restoring an instance}, with the following
+ * exceptions:
+ *
+ * - If the form or instance does not define an explicit
+ *   {@link https://getodk.github.io/xforms-spec/#metadata | `deprecatedID` metadata element},
+ *   one will be created.
+ *
+ * - If the instance has an `instanceID` metadata element, that element's value
+ *   will be assigned to the instance's `deprecatedID`.
+ *
+ * - If applicable, a new instance id will be assigned:
+ *
+ *     - If the instance has an `instanceID` metadata element, and the form
+ *       explicitly defines a
+ *       {@link https://getodk.github.io/xforms-spec/#preload-attributes | `uid` preload attribute}
+ *       for its model binding, a new instance id value will be assigned to that
+ *       element _as if it were the
+ *       {@link https://getodk.github.io/xforms-spec/#event:odk-instance-first-load | instance's first load}_.
+ *
+ *     - **Consistent with {@link FormInstanceCreateMode | instance creation}:**
+ *       if the form **DOES NOT** define an `instanceID` element or model
+ *       binding, the `uid` preload behavior described above is **implied** as
+ *       the form's default behavior for that metadata; in which case whether
+ *       the instance defines an `instanceID` element explicitly or not, it will
+ *       be treated as if it had, behaving as described in the point above.
+ *
+ * **NOTE:** the behavior for an instance's `instanceID` metadata element and a
+ * form's `uid` preload attribute describe a special case, applying only to that
+ * specific preload attribute. In other words, when initializing instance state
+ * for editing:
+ *
+ * - The `odk-instance-first-load` event itself will **NOT** be triggered
+ * - Preload attributes _other than `uid`_ will **NOT** be recomputed
+ *
+ * **NOTE:** while the `uid` preload attribute is discussed above in terms of
+ * the `instanceID` meta element, its behavior is not applied specially to any
+ * particular node, regardless of
+ * {@link FormInstanceInitializationMode | initialization mode}.
+ */
+export type FormInstanceEditMode = 'edit';
+export type FormInstanceInitializationMode = FormInstanceCreateMode | FormInstanceEditMode | FormInstanceRestoreMode;
+/**
+ * @todo this could hypothetically convey warnings and/or errors, just as
+ * {@link LoadFormResult} does. This has been deferred because:
+ *
+ * - We really want a more thoughtful design for Result types
+ * - The `try`/`catch` approach to capturing all errors takes a huge performance
+ *   hit, which we should not incur if we have a more thoughtful design coming
+ *   eventually. It would be too easy to forget about, indefinitely!
+ */
+export interface FormInstance<Mode extends FormInstanceInitializationMode> {
+    readonly formResult: InstantiableLoadFormResult;
+    readonly mode: Mode;
+    readonly root: RootNode;
+}
+export type AnyFormInstance = {
+    [Mode in FormInstanceInitializationMode]: FormInstance<Mode>;
+}[FormInstanceInitializationMode];

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

@@ -0,0 +1,19 @@
+import { InstanceAttachmentsConfig } from '../attachments/InstanceAttachmentsConfig.ts';
+import { OpaqueReactiveObjectFactory } from '../OpaqueReactiveObjectFactory.ts';
+export interface FormInstanceConfig {
+    /**
+     * A client may specify a generic function for constructing stateful objects.
+     * The only hard requirement of this function is that it accepts an **object**
+     * and returns an object of the same shape. The engine will use this function
+     * to initialize client-facing state, and will mutate properties of the object
+     * when their corresponding state is changed.
+     *
+     * A client may use this function to provide its own implementation of
+     * reactivity with semantics like those described above. The mechanism of
+     * reactivity, if any, is at the discretion of the client. It is expected that
+     * clients providing this function will use a reactive subscribe-on-read
+     * mechanism to handle state updates conveyed by the engine.
+     */
+    readonly stateFactory?: OpaqueReactiveObjectFactory;
+    readonly instanceAttachments?: InstanceAttachmentsConfig;
+}

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

@@ -0,0 +1 @@
+export type FormResource = Blob | File | URL | string;

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

@@ -0,0 +1,79 @@
+import { MissingResourceBehavior } from '../constants.ts';
+import { FetchFormAttachment, FetchResource } from '../resources.ts';
+import { FormResource } from './FormResource.ts';
+import { LoadFormResult } from './LoadFormResult.ts';
+/**
+ * @see {@link LoadForm}
+ */
+export interface FormLoadPromise<T> extends PromiseLike<T> {
+}
+/**
+ * Any fetch-like {@link LoadFormOptions | form loading options} which are not
+ * provided will default to the global {@link fetch} function, if one is
+ * available in the calling environment. If a global {@link fetch} function is
+ * _is not available_, and if the associated form loading option is required for
+ * the provided {@link FormResource} to be loaded, a
+ * {@link LoadFormFailureResult} will be produced.
+ */
+export type GlobalFetchDefault = typeof fetch;
+export interface LoadFormOptions {
+    /**
+     * A client may specify an arbitrary {@link fetch}-like function for
+     * retrieving an XML XForm form definition.
+     *
+     * Calls to {@link loadForm | load a form} from a form definition provided as
+     * either a raw XML string or {@link Blob} data containing an XML string, this
+     * option will be ignored.
+     *
+     * Calls to load a form by {@link URL} will consult this option, if defined.
+     *
+     * If this option is omitted, loading a form by URL will use the
+     * {@link GlobalFetchDefault | global fetch function} by default.
+     */
+    readonly fetchFormDefinition?: FetchResource;
+    /**
+     * A client may specify an arbitrary {@link fetch}-like function to retrieve a
+     * form's attachments, i.e. any `jr:` URL referenced by the form (as specified
+     * by {@link https://getodk.github.io/xforms-spec/ | ODK XForms}).
+     *
+     * As part of {@link loadForm | loading a form}, once the form definition
+     * itself is resolved, this option (if provided) will be consulted to load any
+     * form attachments referenced by the form definition.
+     *
+     * If this option is omitted, the engine will attempt to load form attachments
+     * by calling the {@link GlobalFetchDefault | global fetch function} with each
+     * attachment's `jr:` URL. This default behavior will typically result in
+     * failure to load form attachments—and in most cases this will in most cases
+     * cause {@link loadForm | loading a form} to produce a
+     * {@link LoadFormFailureResult}, with the following exception:
+     *
+     * Clients implementing a
+     * {@link https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API | Service Worker}
+     * (e.g. supporting offline functionality, or any other use case for
+     * intercepting network requests) may opt for the convenience of handling
+     * network requests _for form attachments' `jr:` URLs_ along with any other
+     * network interception logic. Client implementors should be warned, however,
+     * that such `jr:` URLs are not namespaced or otherwise scoped to a particular
+     * form definition! Such a client would therefore inherently need to
+     * coordinate state between the Service Worker and the main thread (or
+     * whatever other realm calls {@link loadForm}).
+     *
+     * @todo We can almost certainly address the scoping caveat! We'll probably
+     * want to design for that as part of offline support.
+     */
+    readonly fetchFormAttachment?: FetchFormAttachment;
+    /**
+     * @see {@link MissingResourceBehavior}
+     * @see {@link MissingResourceBehaviorDefault}
+     *
+     * @default MissingResourceBehaviorDefault
+     */
+    readonly missingResourceBehavior?: MissingResourceBehavior;
+}
+/**
+ * Note: loading a form produce a {@link Promise} which **will never reject**.
+ * Rather than rejecting, any errors encountered in the process of loading a
+ * form will be **resolved**, in a
+ * {@link LoadFormFailureResult.error | FormLoadFailureResult error}.
+ */
+export type LoadForm = (formResource: FormResource, options?: LoadFormOptions) => FormLoadPromise<LoadFormResult>;

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

@@ -0,0 +1,67 @@
+import { UnknownObject } from '../../../../common/src/lib/type-assertions/assertUnknownObject.ts';
+import { AnyFunction } from '../../../../common/types/helpers.js';
+import { LoadFormFailureError } from '../../error/LoadFormFailureError.ts';
+import { CreateFormInstance } from './CreateFormInstance.ts';
+import { EditFormInstance } from './EditFormInstance.ts';
+import { RestoreFormInstance } from './RestoreFormInstance.ts';
+export type { LoadFormFailureError };
+export type FormResultStatus = 'success' | 'warning' | 'failure';
+/**
+ * @todo Pending design and modeling of warning cases.
+ */
+export type LoadFormWarnings = UnknownObject;
+type FailedLoadFormResultMethodParameters<T extends AnyFunction> = readonly never[] & (Parameters<T> extends {
+    readonly length: infer Length extends number;
+} ? {
+    readonly length: Length;
+} : never);
+export type FailedLoadFormResultMethod<T extends AnyFunction> = (...args: FailedLoadFormResultMethodParameters<T>) => never;
+export type FallibleLoadFormResultMethod<T extends AnyFunction> = T | FailedLoadFormResultMethod<T>;
+interface BaseLoadFormResult {
+    readonly status: FormResultStatus;
+    readonly warnings: LoadFormWarnings | null;
+    readonly error: LoadFormFailureError | null;
+    readonly createInstance: FallibleLoadFormResultMethod<CreateFormInstance>;
+    readonly editInstance: FallibleLoadFormResultMethod<EditFormInstance>;
+    readonly restoreInstance: FallibleLoadFormResultMethod<RestoreFormInstance>;
+}
+export interface LoadFormSuccessResult extends BaseLoadFormResult {
+    readonly status: 'success';
+    readonly warnings: null;
+    readonly error: null;
+    readonly createInstance: CreateFormInstance;
+    readonly editInstance: EditFormInstance;
+    readonly restoreInstance: RestoreFormInstance;
+}
+export interface LoadFormWarningResult extends BaseLoadFormResult {
+    readonly status: 'warning';
+    readonly warnings: LoadFormWarnings;
+    readonly error: null;
+    readonly createInstance: CreateFormInstance;
+    readonly editInstance: EditFormInstance;
+    readonly restoreInstance: RestoreFormInstance;
+}
+export interface LoadFormFailureResult extends BaseLoadFormResult {
+    readonly status: 'failure';
+    readonly warnings: LoadFormWarnings | null;
+    readonly error: LoadFormFailureError;
+    /**
+     * @example A temporary demo integration was built during development of this
+     * interface.
+     *
+     * @see
+     * {@link https://github.com/getodk/web-forms/pull/345/commits/9ef36355d89dd1450d3a87c3a55506bb9b0fc414}
+     */
+    readonly createInstance: FailedLoadFormResultMethod<CreateFormInstance>;
+    readonly editInstance: FailedLoadFormResultMethod<EditFormInstance>;
+    /**
+     * @example A temporary demo integration was built during development of this
+     * interface.
+     *
+     * @see
+     * {@link https://github.com/getodk/web-forms/pull/345/commits/9ef36355d89dd1450d3a87c3a55506bb9b0fc414}
+     */
+    readonly restoreInstance: FailedLoadFormResultMethod<RestoreFormInstance>;
+}
+export type InstantiableLoadFormResult = LoadFormSuccessResult | LoadFormWarningResult;
+export type LoadFormResult = InstantiableLoadFormResult | LoadFormFailureResult;

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

@@ -0,0 +1,8 @@
+import { InstanceData } from '../serialization/InstanceData.ts';
+import { FormInstance, FormInstanceRestoreMode } from './FormInstance.ts';
+import { FormInstanceConfig } from './FormInstanceConfig.ts';
+export interface RestoreFormInstanceInput {
+    readonly data: readonly [InstanceData, ...InstanceData[]];
+}
+export type RestoredFormInstance = FormInstance<FormInstanceRestoreMode>;
+export type RestoreFormInstance = (input: RestoreFormInstanceInput, config?: FormInstanceConfig) => Promise<RestoredFormInstance>;

package/dist/client/hierarchy.d.ts

@@ -4,6 +4,7 @@ import { AnyInputNode } from './InputNode.ts';
 import { AnyModelValueNode } from './ModelValueNode.ts';
 import { AnyNoteNode } from './NoteNode.ts';
 import { AnyRangeNode } from './RangeNode.ts';
+import { RankNode } from './RankNode.ts';
 import { RepeatInstanceNode } from './repeat/RepeatInstanceNode.ts';
 import { RepeatRangeControlledNode } from './repeat/RepeatRangeControlledNode.ts';
 import { RepeatRangeUncontrolledNode } from './repeat/RepeatRangeUncontrolledNode.ts';
@@ -11,11 +12,9 @@ import { RootNode } from './RootNode.ts';
 import { SelectNode } from './SelectNode.ts';
 import { SubtreeNode } from './SubtreeNode.ts';
 import { TriggerNode } from './TriggerNode.ts';
-import { RankNode } from './RankNode.ts';
-import { UploadNode } from './unsupported/UploadNode.ts';
-export type AnyUnsupportedControlNode = UploadNode;
-export type AnyControlNode = AnyInputNode | AnyNoteNode | AnyRangeNode | RankNode | SelectNode | TriggerNode;
-export type AnyLeafNode = AnyControlNode | AnyModelValueNode | AnyUnsupportedControlNode;
+import { UploadNode } from './UploadNode.ts';
+export type AnyControlNode = AnyInputNode | AnyNoteNode | AnyRangeNode | RankNode | SelectNode | TriggerNode | UploadNode;
+export type AnyLeafNode = AnyControlNode | AnyModelValueNode;
 export type RepeatRangeNode = RepeatRangeControlledNode | RepeatRangeUncontrolledNode;
 /**
  * Any of the concrete node types which may be a parent of non-repeat instance