@getodk/xforms-engine 0.7.0 → 0.8.0

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 { ChunkedInstancePayload, MonolithicInstancePayload } from './serialization/InstancePayload.ts';
-import { InstancePayloadOptions } from './serialization/InstancePayloadOptions.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 {
     /**
@@ -80,7 +80,7 @@ export interface RootNode extends BaseNode {
      * case a {@link ChunkedInstancePayload} will be produced, with form
      * attachments
      */
-    prepareInstancePayload(): Promise<MonolithicInstancePayload>;
-    prepareInstancePayload(options: InstancePayloadOptions<'monolithic'>): Promise<MonolithicInstancePayload>;
+    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/form/FormInstanceConfig.d.ts

@@ -1,3 +1,4 @@
+import { InstanceAttachmentsConfig } from '../attachments/InstanceAttachmentsConfig.ts';
 import { OpaqueReactiveObjectFactory } from '../OpaqueReactiveObjectFactory.ts';
 export interface FormInstanceConfig {
     /**
@@ -14,4 +15,5 @@ export interface FormInstanceConfig {
      * mechanism to handle state updates conveyed by the engine.
      */
     readonly stateFactory?: OpaqueReactiveObjectFactory;
+    readonly instanceAttachments?: InstanceAttachmentsConfig;
 }

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

package/dist/client/index.d.ts

@@ -1,3 +1,5 @@
+export type * from './attachments/InstanceAttachmentMeta.ts';
+export type * from './attachments/InstanceAttachmentsConfig.ts';
 export type * from './constants.ts';
 export * as constants from './constants.ts';
 export type * from './form/CreateFormInstance.ts';
@@ -10,7 +12,8 @@ export type * from './form/LoadFormResult.ts';
 export type * from './form/RestoreFormInstance.ts';
 export type * from './FormLanguage.ts';
 export type * from './GroupNode.ts';
-export type { AnyChildNode, AnyControlNode, AnyLeafNode, AnyNode, AnyParentNode, AnyUnsupportedControlNode, GeneralChildNode, GeneralParentNode, RepeatRangeNode, } from './hierarchy.ts';
+export type { AnyChildNode, AnyControlNode, AnyLeafNode, AnyNode, AnyParentNode, GeneralChildNode, GeneralParentNode, RepeatRangeNode, } from './hierarchy.ts';
+export type * from './identity.ts';
 export type * from './InputNode.ts';
 export type * from './ModelValueNode.ts';
 export type * from './NoteNode.ts';
@@ -32,6 +35,6 @@ export type * from './submission/SubmissionMeta.ts';
 export type * from './SubtreeNode.ts';
 export type * from './TextRange.ts';
 export type * from './TriggerNode.ts';
-export type * from './unsupported/UploadNode.ts';
+export type * from './UploadNode.ts';
 export type * from './validation.ts';
 export type * from './ValueType.ts';

package/dist/client/node-types.d.ts

@@ -1,4 +1,3 @@
-export type UnsupportedControlNodeType = 'upload';
 export type RepeatRangeNodeType = 'repeat-range:controlled' | 'repeat-range:uncontrolled';
-export type LeafNodeType = 'model-value' | 'note' | 'select' | 'input' | 'trigger' | 'range' | 'rank' | UnsupportedControlNodeType;
-export type InstanceNodeType = 'root' | RepeatRangeNodeType | 'repeat-instance' | 'group' | 'subtree' | LeafNodeType | UnsupportedControlNodeType;
+export type LeafNodeType = 'model-value' | 'note' | 'select' | 'input' | 'trigger' | 'range' | 'rank' | 'upload';
+export type InstanceNodeType = 'root' | RepeatRangeNodeType | 'repeat-instance' | 'group' | 'subtree' | LeafNodeType;

package/dist/client/serialization/InstanceData.d.ts

@@ -1,12 +1,14 @@
 import { INSTANCE_FILE_NAME, InstanceFile } from './InstanceFile.ts';
 export type InstanceAttachmentFileName = string;
+export type InstanceDataEntryValue = File;
 export interface InstanceData extends FormData {
+    [Symbol.iterator](): FormDataIterator<[string, InstanceDataEntryValue]>;
+    entries(): FormDataIterator<[string, InstanceDataEntryValue]>;
+    values(): FormDataIterator<InstanceDataEntryValue>;
+    forEach(callbackfn: (value: InstanceDataEntryValue, key: string, parent: InstanceData) => void, thisArg?: any): void;
     get(name: INSTANCE_FILE_NAME): InstanceFile;
-    /**
-     * @todo Can we guarantee (both in static types and at runtime) that
-     * {@link InstanceData} only contains files?
-     */
-    get(name: InstanceAttachmentFileName): FormDataEntryValue | null;
+    get(name: InstanceAttachmentFileName): InstanceDataEntryValue | null;
+    getAll(name: string): InstanceDataEntryValue[];
     has(name: INSTANCE_FILE_NAME): true;
     has(name: InstanceAttachmentFileName): boolean;
 }

package/dist/client/serialization/InstancePayloadOptions.d.ts

@@ -1,6 +1,6 @@
 export type InstancePayloadType = 'chunked' | 'monolithic';
 interface BaseInstancePayloadOptions<PayloadType extends InstancePayloadType> {
-    readonly payloadType?: PayloadType | undefined;
+    readonly payloadType: PayloadType;
     /**
      * As described in the
      * {@link https://docs.getodk.org/openrosa-form-submission/#extended-transmission-considerations | OpenRosa Form Submission API},
@@ -10,10 +10,11 @@ interface BaseInstancePayloadOptions<PayloadType extends InstancePayloadType> {
     readonly maxSize?: number;
 }
 interface ChunkedInstancePayloadOptions extends BaseInstancePayloadOptions<'chunked'> {
+    readonly payloadType: 'chunked';
     readonly maxSize: number;
 }
 interface MonolithicInstancePayloadOptions extends BaseInstancePayloadOptions<'monolithic'> {
-    readonly payloadType?: 'monolithic' | undefined;
+    readonly payloadType: 'monolithic';
     readonly maxSize?: never;
 }
 export type InstancePayloadOptions<PayloadType extends InstancePayloadType = 'monolithic'> = {

package/dist/error/UploadValueTypeError.d.ts

@@ -0,0 +1,8 @@
+import { UploadDefinition } from '../client/UploadNode.ts';
+import { ValueType } from '../client/ValueType.ts';
+import { XFormsSpecViolationError } from './XFormsSpecViolationError.ts';
+type UnsupportedUploadValueType = Exclude<ValueType, 'binary'>;
+export declare class UploadValueTypeError extends XFormsSpecViolationError {
+    constructor(definition: UploadDefinition<UnsupportedUploadValueType>);
+}
+export {};