@getodk/xforms-engine 0.5.0 → 0.7.0

package/src/client/index.ts

@@ -1,29 +1,47 @@
-import type { EngineConfig } from './EngineConfig.ts';
-import type { RootNode } from './RootNode.ts';
-
-export type FormResource = Blob | URL | string;
-
-export interface InitializeFormOptions {
-	readonly config: EngineConfig;
-
-	// E.g. opening a submitted form instance for edit. TDOO: the `FormResource`
-	// name is shared here for both init input and initial state, but the shape of
-	// those resources would differ. Probably a more generic name is appropriate.
-	readonly initialState?: FormResource;
-}
-
-/**
- * Creates an instance of a form to be filled (or edited) by a client.
- */
-// TODO: initialization is represented as asynchronous here, so that any
-// requisite resources can be retrieved before passing control to a client. This
-// is an obvious first step, but we can consider a more complex (if optional)
-// flow, e.g.:
-//
-// - Where it can be determined upfront that the form has no need to perform IO
-// - Where the IO may have already been performed (e.g. offline, other potential
-//   caching cases where appropriate)
-export type InitializeForm = (
-	input: FormResource,
-	options?: InitializeFormOptions
-) => Promise<RootNode>;
+export type * from './constants.ts';
+export * as constants from './constants.ts';
+export type * from './form/CreateFormInstance.ts';
+export type * from './form/EditFormInstance.ts';
+export type * from './form/FormInstance.ts';
+export type * from './form/FormInstanceConfig.ts';
+export type * from './form/FormResource.ts';
+export type * from './form/LoadForm.ts';
+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 * from './InputNode.ts';
+export type * from './ModelValueNode.ts';
+export type * from './NoteNode.ts';
+export type * from './OpaqueReactiveObjectFactory.ts';
+export type * from './RangeNode.ts';
+export type * from './RankNode.ts';
+export type * from './repeat/RepeatInstanceNode.ts';
+export type * from './repeat/RepeatRangeControlledNode.ts';
+export type * from './repeat/RepeatRangeUncontrolledNode.ts';
+export type * from './resources.ts';
+export type * from './RootNode.ts';
+export type * from './SelectNode.ts';
+export type * from './serialization/InstanceData.ts';
+export type * from './serialization/InstanceFile.ts';
+export type * from './serialization/InstancePayload.ts';
+export type * from './serialization/InstancePayloadOptions.ts';
+export type * from './serialization/InstanceState.ts';
+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 './validation.ts';
+export type * from './ValueType.ts';

package/src/client/node-types.ts

@@ -1,8 +1,4 @@
-// prettier-ignore
-export type UnsupportedControlNodeType =
-	| 'range'
-	| 'rank'
-	| 'upload';
+export type UnsupportedControlNodeType = 'upload';
 
 // prettier-ignore
 export type RepeatRangeNodeType =
@@ -17,6 +13,8 @@ export type LeafNodeType =
 	| 'select'
 	| 'input'
 	| 'trigger'
+	| 'range'
+	| 'rank'
 	| UnsupportedControlNodeType;
 
 // prettier-ignore

package/src/client/repeat/BaseRepeatRangeNode.ts

@@ -1,4 +1,3 @@
-import type { AnyRepeatRangeDefinition } from '../../parse/model/RepeatRangeDefinition.ts';
 import type { BaseNode, BaseNodeState } from '../BaseNode.ts';
 import type { NodeAppearances } from '../NodeAppearances.ts';
 import type { RootNode } from '../RootNode.ts';
@@ -6,7 +5,7 @@ import type { TextRange } from '../TextRange.ts';
 import type { GeneralParentNode } from '../hierarchy.ts';
 import type { RepeatRangeNodeType } from '../node-types.ts';
 import type { AncestorNodeValidationState } from '../validation.ts';
-import type { RepeatInstanceNode } from './RepeatInstanceNode.ts';
+import type { AnyRepeatDefinition, RepeatInstanceNode } from './RepeatInstanceNode.ts';
 
 export interface BaseRepeatRangeNodeState extends BaseNodeState {
 	get hint(): null;
@@ -26,7 +25,7 @@ export interface BaseRepeatRangeNodeState extends BaseNodeState {
 	get value(): null;
 }
 
-export type RepeatRangeNodeAppearances = NodeAppearances<AnyRepeatRangeDefinition>;
+export type RepeatRangeNodeAppearances = NodeAppearances<AnyRepeatDefinition>;
 
 /**
  * Represents a contiguous set of zero or more {@link RepeatInstanceNode}s
@@ -95,7 +94,7 @@ export type RepeatRangeNodeAppearances = NodeAppearances<AnyRepeatRangeDefinitio
 export interface BaseRepeatRangeNode extends BaseNode {
 	readonly nodeType: RepeatRangeNodeType;
 	readonly appearances: RepeatRangeNodeAppearances;
-	readonly definition: AnyRepeatRangeDefinition;
+	readonly definition: AnyRepeatDefinition;
 	readonly root: RootNode;
 	readonly parent: GeneralParentNode;
 	readonly currentState: BaseRepeatRangeNodeState;

package/src/client/repeat/RepeatInstanceNode.ts

@@ -1,5 +1,4 @@
-import type { RepeatInstanceDefinition } from '../../parse/model/RepeatInstanceDefinition.ts';
-import type { RepeatTemplateDefinition } from '../../parse/model/RepeatTemplateDefinition.ts';
+import type { AnyRepeatDefinition } from '../../parse/model/RepeatDefinition.ts';
 import type { BaseNode, BaseNodeState } from '../BaseNode.ts';
 import type { GeneralChildNode, RepeatRangeNode } from '../hierarchy.ts';
 import type { NodeAppearances } from '../NodeAppearances.ts';
@@ -19,17 +18,14 @@ export interface RepeatInstanceNodeState extends BaseNodeState {
 	get value(): null;
 }
 
-// prettier-ignore
-export type RepeatDefinition =
-	| RepeatInstanceDefinition
-	| RepeatTemplateDefinition;
+export type { AnyRepeatDefinition };
 
-export type RepeatInstanceNodeAppearances = NodeAppearances<RepeatDefinition>;
+export type RepeatInstanceNodeAppearances = NodeAppearances<AnyRepeatDefinition>;
 
 export interface RepeatInstanceNode extends BaseNode {
 	readonly nodeType: 'repeat-instance';
 	readonly appearances: RepeatInstanceNodeAppearances;
-	readonly definition: RepeatDefinition;
+	readonly definition: AnyRepeatDefinition;
 	readonly root: RootNode;
 
 	/**

package/src/client/repeat/RepeatRangeControlledNode.ts

@@ -1,4 +1,4 @@
-import type { ControlledRepeatRangeDefinition } from '../../parse/model/RepeatRangeDefinition.ts';
+import type { ControlledRepeatDefinition } from '../../parse/model/RepeatDefinition.ts';
 import type { BaseRepeatRangeNode, BaseRepeatRangeNodeState } from './BaseRepeatRangeNode.ts';
 import type { RepeatRangeUncontrolledNode } from './RepeatRangeUncontrolledNode.ts';
 
@@ -16,5 +16,5 @@ export interface RepeatRangeControlledState extends BaseRepeatRangeNodeState {}
  */
 export interface RepeatRangeControlledNode extends BaseRepeatRangeNode {
 	readonly nodeType: 'repeat-range:controlled';
-	readonly definition: ControlledRepeatRangeDefinition;
+	readonly definition: ControlledRepeatDefinition;
 }

package/src/client/repeat/RepeatRangeUncontrolledNode.ts

@@ -1,4 +1,4 @@
-import type { UncontrolledRepeatRangeDefinition } from '../../parse/model/RepeatRangeDefinition.ts';
+import type { UncontrolledRepeatDefinition } from '../../parse/model/RepeatDefinition.ts';
 import type { RootNode } from '../RootNode.ts';
 import type { BaseRepeatRangeNode, BaseRepeatRangeNodeState } from './BaseRepeatRangeNode.ts';
 
@@ -14,7 +14,7 @@ export interface RepeatRangeUncontrolledState extends BaseRepeatRangeNodeState {
  */
 export interface RepeatRangeUncontrolledNode extends BaseRepeatRangeNode {
 	readonly nodeType: 'repeat-range:uncontrolled';
-	readonly definition: UncontrolledRepeatRangeDefinition;
+	readonly definition: UncontrolledRepeatDefinition;
 
 	addInstances(afterIndex?: number, count?: number): RootNode;
 	removeInstances(startIndex: number, count?: number): RootNode;

package/src/client/resources.ts

@@ -1,5 +1,5 @@
 import type { JRResourceURL } from '@getodk/common/jr-resources/JRResourceURL.ts';
-import type { initializeForm } from '../instance/index.ts';
+import type { loadForm } from '../entrypoints/loadForm.ts';
 
 interface FetchResourceHeadersIterator<T>
 	extends IteratorObject<
@@ -85,7 +85,7 @@ export interface FetchResourceResponseHeaders {
  *
  * Furthermore, if the engine intends to read {@link body} (or its indirect
  * {@link blob} or {@link text} consumers), it will do so in the course of a
- * client's call to {@link initializeForm}, and before the
+ * client's call to {@link loadForm}, and before the
  * {@link Promise<PrimaryInstance>} returned by that call is resolved.
  */
 export interface FetchResourceResponse {

package/src/client/serialization/InstanceData.ts

@@ -0,0 +1,16 @@
+import type { INSTANCE_FILE_NAME, InstanceFile } from './InstanceFile.ts';
+
+export type InstanceAttachmentFileName = string;
+
+export interface InstanceData extends FormData {
+	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;
+
+	has(name: INSTANCE_FILE_NAME): true;
+	has(name: InstanceAttachmentFileName): boolean;
+}

package/src/client/serialization/InstanceFile.ts

@@ -0,0 +1,9 @@
+import type { INSTANCE_FILE_NAME, INSTANCE_FILE_TYPE } from '../constants.ts';
+
+// Re-export for convenient `InstanceFile` construction/access flows
+export type { INSTANCE_FILE_NAME, INSTANCE_FILE_TYPE };
+
+export interface InstanceFile extends File {
+	readonly name: INSTANCE_FILE_NAME;
+	readonly type: INSTANCE_FILE_TYPE;
+}

package/src/client/serialization/InstancePayload.ts

@@ -0,0 +1,126 @@
+import type { SubmissionMeta } from '../submission/SubmissionMeta.ts';
+import type { AnyViolation, DescendantNodeViolationReference } from '../validation.ts';
+import type { InstanceData } from './InstanceData.ts';
+import type { InstancePayloadOptions, InstancePayloadType } from './InstancePayloadOptions.ts';
+
+// prettier-ignore
+export type InstancePayloadStatus =
+	// eslint-disable-next-line @typescript-eslint/sort-type-constituents
+	| 'pending'
+	| 'max-size-exceeded'
+	| 'ready';
+
+// prettier-ignore
+type InstancePayloadData<PayloadType extends InstancePayloadType> = {
+	chunked: readonly [InstanceData, ...InstanceData[]];
+	monolithic: readonly [InstanceData];
+}[PayloadType];
+
+/**
+ * Provides detail about an individual instance attachment {@link File}s which
+ * exceeds the client-specified {@link maxSize} for a
+ * {@link ChunkedInstancePayload | chunked instance payload}. Clients may use
+ * this value to provide guidance to users.
+ *
+ * @todo We may want to consider (a) making {@link maxSize} a configuration the
+ * client can provide when initializing a form instance, rather than only when
+ * serializing an instance payload; and then (b) treating a maximum size
+ * violation as another kind of node-level violation. This would go beyond the
+ * kinds of validation specified by ODK XForms, but it would make a lot of
+ * _conceptual sense_.
+ *
+ * It would almost certainly be helpful to alert users to violations as the
+ * occur, rather than only at instance payload serialization time (where they
+ * have likely already moved on). This is something clients can do without
+ * engine support, but it would likely promote good usability patterns if the
+ * engine makes it an obvious and uniform option at the main engine/client
+ * entrypoint.
+ *
+ * @todo If we consider the above, we'd want to reframe _this interface_ to
+ * match the shape of other {@link AnyViolation | violations} (adding it as a
+ * member of that union). We'd also likely eliminate
+ * {@link MaxSizeExceededResult} in the process, since
+ * {@link PendingInstancePayload} would then cover the case.
+ */
+interface MaxSizeViolation {
+	/**
+	 * Specifies the index of
+	 * {@link InstancePayloadData<'chunked'> | chunked instance payload data}
+	 * where an instance attachment {@link File} exceeds the client-specified
+	 * {@link maxSize}.
+	 */
+	readonly dataIndex: number;
+
+	/**
+	 * Specifies the name of the file which exceeds the client-specified
+	 * {@link maxSize}. This name can also be used as a key to access the
+	 * violating {@link File}/instance attachment, in the {@link InstanceData} at
+	 * the specified {@link dataIndex}.
+	 */
+	readonly fileName: string;
+
+	/**
+	 * Reflects the client-specified maximum size for each chunk of a
+	 * {@link ChunkedInstancePayload | chunked instance payload}.
+	 */
+	readonly maxSize: number;
+
+	/**
+	 * Details the actual size of the violating {@link File}/instance attachment.
+	 * Along with {@link maxSize}. Clients may use the delta between this value
+	 * and {@link maxSize} to provide detailed guidance to users.
+	 */
+	readonly actualSize: number;
+}
+
+// prettier-ignore
+type InstancePayloadViolation =
+	| DescendantNodeViolationReference
+	| MaxSizeViolation;
+
+interface BaseInstancePayload<PayloadType extends InstancePayloadType> {
+	readonly payloadType: PayloadType;
+	readonly status: InstancePayloadStatus;
+	readonly submissionMeta: SubmissionMeta;
+
+	get violations(): readonly InstancePayloadViolation[] | null;
+
+	/**
+	 * Instance attachment data may be chunked according to the
+	 * {@link InstancePayloadOptions.maxSize | maxSize instance payload option}
+	 */
+	readonly data: InstancePayloadData<PayloadType>;
+}
+
+interface PendingInstancePayload<PayloadType extends InstancePayloadType>
+	extends BaseInstancePayload<PayloadType> {
+	readonly status: 'pending';
+	get violations(): readonly DescendantNodeViolationReference[];
+}
+
+interface MaxSizeExceededResult extends BaseInstancePayload<'chunked'> {
+	readonly status: 'max-size-exceeded';
+	get violations(): readonly MaxSizeViolation[];
+}
+
+interface ReadyInstancePayload<PayloadType extends InstancePayloadType>
+	extends BaseInstancePayload<PayloadType> {
+	readonly status: 'ready';
+	get violations(): null;
+}
+
+// prettier-ignore
+export type ChunkedInstancePayload =
+	| MaxSizeExceededResult
+	| PendingInstancePayload<'chunked'>
+	| ReadyInstancePayload<'chunked'>;
+
+export type MonolithicInstancePayload =
+	| PendingInstancePayload<'monolithic'>
+	| ReadyInstancePayload<'monolithic'>;
+
+// prettier-ignore
+export type InstancePayload<PayloadType extends InstancePayloadType> = {
+	chunked: ChunkedInstancePayload;
+	monolithic: MonolithicInstancePayload;
+}[PayloadType];

package/src/client/serialization/InstancePayloadOptions.ts

@@ -0,0 +1,28 @@
+export type InstancePayloadType = 'chunked' | 'monolithic';
+
+interface BaseInstancePayloadOptions<PayloadType extends InstancePayloadType> {
+	readonly payloadType?: PayloadType | undefined;
+
+	/**
+	 * As described in the
+	 * {@link https://docs.getodk.org/openrosa-form-submission/#extended-transmission-considerations | OpenRosa Form Submission API},
+	 * clients may obtain this value from an OpenRosa server's
+	 * `X-OpenRosa-Accept-Content-Length` header.
+	 */
+	readonly maxSize?: number;
+}
+
+interface ChunkedInstancePayloadOptions extends BaseInstancePayloadOptions<'chunked'> {
+	readonly maxSize: number;
+}
+
+interface MonolithicInstancePayloadOptions extends BaseInstancePayloadOptions<'monolithic'> {
+	readonly payloadType?: 'monolithic' | undefined;
+	readonly maxSize?: never;
+}
+
+// prettier-ignore
+export type InstancePayloadOptions<PayloadType extends InstancePayloadType = 'monolithic'> = {
+	chunked: ChunkedInstancePayloadOptions;
+	monolithic: MonolithicInstancePayloadOptions;
+}[PayloadType];

package/src/client/serialization/InstanceState.ts

@@ -0,0 +1,14 @@
+import type { RootNode } from '../RootNode.ts';
+
+export interface InstanceState {
+	/**
+	 * Represents the serialized XML state of a given node. The value produced in
+	 * {@link RootNode.instanceState} is the same serialization which will be
+	 * produced for a complete instance.
+	 *
+	 * @todo Note that this particular aspect of the design doesn't yet address
+	 * production of unique file names. As such, this may change as we introduce
+	 * affected data types (and their supporting nodes).
+	 */
+	get instanceXML(): string;
+}

package/src/client/submission/{SubmissionDefinition.ts → SubmissionMeta.ts}

@@ -1,4 +1,4 @@
-export interface SubmissionDefinition {
+export interface SubmissionMeta {
 	/**
 	 * @see {@link https://getodk.github.io/xforms-spec/#submission-attributes | `action` submission attribute}
 	 */

package/src/client/unsupported/UnsupportedControlNode.ts

@@ -1,6 +1,4 @@
 import type { UnknownAppearanceDefinition } from '../../parse/body/appearance/unknownAppearanceParser.ts';
-import type { RangeControlDefinition } from '../../parse/body/control/RangeControlDefinition.ts';
-import type { RankControlDefinition } from '../../parse/body/control/RankControlDefinition.ts';
 import type { UploadControlDefinition } from '../../parse/body/control/UploadControlDefinition.ts';
 import type { LeafNodeDefinition } from '../../parse/model/LeafNodeDefinition.ts';
 import type { BaseNode, BaseNodeState } from '../BaseNode.ts';
@@ -15,10 +13,8 @@ export interface UnsupportedControlNodeState extends BaseNodeState {
 	get value(): unknown;
 }
 
-export type UnsupportedControlElementDefinition =
-	| RangeControlDefinition
-	| RankControlDefinition
-	| UploadControlDefinition;
+// prettier-ignore
+export type UnsupportedControlElementDefinition = UploadControlDefinition;
 
 export interface UnsupportedControlDefinition extends LeafNodeDefinition {
 	readonly bodyElement: UnsupportedControlElementDefinition;

package/src/entrypoints/FormInstance.ts

@@ -0,0 +1,55 @@
+import { identity } from '@getodk/common/lib/identity.ts';
+import type {
+	FormInstance as ClientFormInstance,
+	FormInstanceInitializationMode,
+} from '../client/form/FormInstance.ts';
+import type { FormInstanceConfig } from '../client/index.ts';
+import type { InstanceConfig } from '../instance/internal-api/InstanceConfig.ts';
+import type {
+	BasePrimaryInstanceOptions,
+	PrimaryInstanceInitialState,
+	PrimaryInstanceOptions,
+} from '../instance/PrimaryInstance.ts';
+import { PrimaryInstance } from '../instance/PrimaryInstance.ts';
+import type { Root } from '../instance/Root.ts';
+import type { FormSuccessResult } from './FormResult/FormSuccessResult.ts';
+import type { FormWarningResult } from './FormResult/FormWarningResult.ts';
+
+// prettier-ignore
+export type InstantiableFormResult =
+	| FormSuccessResult
+	| FormWarningResult;
+
+interface FormInstanceOptions<Mode extends FormInstanceInitializationMode> {
+	readonly mode: Mode;
+	readonly initialState: PrimaryInstanceInitialState<Mode>;
+	readonly instanceOptions: BasePrimaryInstanceOptions;
+	readonly instanceConfig: FormInstanceConfig;
+}
+
+export class FormInstance<Mode extends FormInstanceInitializationMode>
+	implements ClientFormInstance<Mode>
+{
+	readonly mode: Mode;
+	readonly root: Root;
+
+	constructor(
+		readonly formResult: InstantiableFormResult,
+		options: FormInstanceOptions<Mode>
+	) {
+		const { mode, initialState } = options;
+		const config: InstanceConfig = {
+			clientStateFactory: options.instanceConfig.stateFactory ?? identity,
+		};
+		const primaryInstanceOptions: PrimaryInstanceOptions<Mode> = {
+			...options.instanceOptions,
+			mode,
+			initialState,
+			config,
+		};
+		const { root } = new PrimaryInstance(primaryInstanceOptions);
+
+		this.mode = mode;
+		this.root = root;
+	}
+}

package/src/entrypoints/FormResult/BaseFormResult.ts

@@ -0,0 +1,40 @@
+import type {
+	FormResultStatus,
+	LoadFormFailureResult,
+	LoadFormResult,
+	LoadFormSuccessResult,
+	LoadFormWarningResult,
+} from '../../client/form/LoadFormResult.ts';
+
+interface LoadFormResultByStatus {
+	readonly success: LoadFormSuccessResult;
+	readonly warning: LoadFormWarningResult;
+	readonly failure: LoadFormFailureResult;
+}
+
+export type BaseFormResultProperty<
+	Status extends FormResultStatus,
+	Key extends keyof LoadFormResult,
+> = LoadFormResultByStatus[Status][Key];
+
+export interface BaseFormResultOptions<Status extends FormResultStatus> {
+	readonly status: Status;
+	readonly warnings: BaseFormResultProperty<Status, 'warnings'>;
+	readonly error: BaseFormResultProperty<Status, 'error'>;
+}
+
+export abstract class BaseFormResult<Status extends FormResultStatus> {
+	readonly status: Status;
+	readonly warnings: BaseFormResultProperty<Status, 'warnings'>;
+	readonly error: BaseFormResultProperty<Status, 'error'>;
+
+	abstract readonly createInstance: BaseFormResultProperty<Status, 'createInstance'>;
+	abstract readonly editInstance: BaseFormResultProperty<Status, 'editInstance'>;
+	abstract readonly restoreInstance: BaseFormResultProperty<Status, 'restoreInstance'>;
+
+	constructor(options: BaseFormResultOptions<Status>) {
+		this.status = options.status;
+		this.warnings = options.warnings;
+		this.error = options.error;
+	}
+}

package/src/entrypoints/FormResult/BaseInstantiableFormResult.ts

@@ -0,0 +1,109 @@
+import type { CreateFormInstance } from '../../client/form/CreateFormInstance.ts';
+import type {
+	EditFormInstance,
+	EditFormInstanceInput,
+} from '../../client/form/EditFormInstance.ts';
+import type { FormInstanceConfig } from '../../client/form/FormInstanceConfig.ts';
+import type { FormResultStatus } from '../../client/form/LoadFormResult.ts';
+import type {
+	RestoreFormInstance,
+	RestoreFormInstanceInput,
+} from '../../client/form/RestoreFormInstance.ts';
+import { ErrorProductionDesignPendingError } from '../../error/ErrorProductionDesignPendingError.ts';
+import { InitialInstanceState } from '../../instance/input/InitialInstanceState.ts';
+import type { BasePrimaryInstanceOptions } from '../../instance/PrimaryInstance.ts';
+import type { FormResource } from '../../instance/resource.ts';
+import type { ReactiveScope } from '../../lib/reactivity/scope.ts';
+import type { InstantiableFormResult } from '../FormInstance.ts';
+import { FormInstance } from '../FormInstance.ts';
+import type { BaseFormResultProperty } from './BaseFormResult.ts';
+import { BaseFormResult } from './BaseFormResult.ts';
+
+// prettier-ignore
+export type InstantiableFormResultStatus =
+	| 'success'
+	| 'warning';
+
+export interface BaseInstantiableFormResultOptions<Status extends InstantiableFormResultStatus> {
+	readonly status: Status;
+	readonly warnings: BaseFormResultProperty<Status, 'warnings'>;
+	readonly error: null;
+	readonly scope: ReactiveScope;
+	readonly formResource: FormResource;
+	readonly instanceOptions: BasePrimaryInstanceOptions;
+}
+
+export abstract class BaseInstantiableFormResult<
+	Status extends InstantiableFormResultStatus,
+> extends BaseFormResult<Status> {
+	readonly createInstance: CreateFormInstance;
+	readonly editInstance: EditFormInstance;
+	readonly restoreInstance: RestoreFormInstance;
+
+	constructor(options: BaseInstantiableFormResultOptions<Status>) {
+		const { status, warnings, error, instanceOptions } = options;
+
+		super({
+			status,
+			warnings,
+			error,
+		});
+
+		this.createInstance = (instanceConfig: FormInstanceConfig = {}) => {
+			this.assertInstantiable();
+
+			return new FormInstance(this, {
+				mode: 'create',
+				instanceOptions,
+				initialState: null,
+				instanceConfig,
+			});
+		};
+
+		this.editInstance = async (
+			input: EditFormInstanceInput,
+			instanceConfig: FormInstanceConfig = {}
+		) => {
+			this.assertInstantiable();
+
+			const initialState = await InitialInstanceState.resolve(instanceOptions.model, input);
+
+			return new FormInstance(this, {
+				mode: 'edit',
+				instanceOptions,
+				initialState,
+				instanceConfig,
+			});
+		};
+
+		this.restoreInstance = async (
+			input: RestoreFormInstanceInput,
+			instanceConfig: FormInstanceConfig = {}
+		) => {
+			this.assertInstantiable();
+
+			const initialState = await InitialInstanceState.from(instanceOptions.model, input.data);
+
+			return new FormInstance(this, {
+				mode: 'restore',
+				instanceOptions,
+				initialState,
+				instanceConfig,
+			});
+		};
+	}
+
+	isInstantiable(): this is InstantiableFormResult {
+		const self: BaseFormResult<FormResultStatus> = this satisfies BaseFormResult<FormResultStatus>;
+
+		return self.status !== 'failure';
+	}
+
+	assertInstantiable(): asserts this is InstantiableFormResult {
+		if (!this.isInstantiable()) {
+			throw new ErrorProductionDesignPendingError(
+				'Failed to instantiate from result with status: "failure"'
+			);
+		}
+	}
+}