@xh/hoist 73.0.0-SNAPSHOT.1745973083869 → 73.0.0-SNAPSHOT.1746025071597

package/build/types/admin/tabs/activity/tracking/charts/ChartsModel.d.ts

@@ -0,0 +1,34 @@
+/// <reference types="react" />
+import { ChartModel } from '@xh/hoist/cmp/chart';
+import { HoistModel } from '@xh/hoist/core';
+import { PanelModel } from '@xh/hoist/desktop/cmp/panel';
+import { ActivityTrackingModel } from '../ActivityTrackingModel';
+export declare class ChartsModel extends HoistModel {
+    panelModel: PanelModel;
+    activityTrackingModel: ActivityTrackingModel;
+    /** metric to chart on Y axis - one of:
+     *      + entryCount - count of total track log entries within the primary dim group.
+     *      + count - count of unique secondary dim values within the primary dim group.
+     *      + elapsed - avg elapsed time in ms for the primary dim group.
+     */
+    metric: 'entryCount' | 'count' | 'elapsed';
+    /** show weekends on the activity chart */
+    incWeekends: boolean;
+    categoryChartModel: ChartModel;
+    timeseriesChartModel: ChartModel;
+    get showAsTimeseries(): boolean;
+    get chartModel(): ChartModel;
+    get primaryDim(): string;
+    get secondaryDim(): string;
+    get data(): import("../../../../../data").StoreRecord[];
+    get dimensions(): string[];
+    constructor();
+    getLabelForMetric(metric: any, multiline: any): string | import("react").ReactElement<{
+        children?: import("react").ReactNode;
+    }, any>;
+    private selectRow;
+    onLinked(): void;
+    private loadChart;
+    private getSeriesData;
+    private getUnitsForDim;
+}

package/build/types/admin/tabs/activity/tracking/charts/ChartsPanel.d.ts

@@ -0,0 +1,2 @@
+import { ChartsModel } from './ChartsModel';
+export declare const chartsPanel: import("@xh/hoist/core").ElementFactory<import("@xh/hoist/core").DefaultHoistProps<ChartsModel>>;

package/build/types/admin/tabs/activity/tracking/detail/ActivityDetailModel.d.ts

@@ -6,23 +6,11 @@ export declare class ActivityDetailModel extends HoistModel {
     activityTrackingModel: ActivityTrackingModel;
     gridModel: GridModel;
     formModel: FormModel;
-    /**
-     * Optional dot-delimited path(s) to filter the displayed `data` payload down to a particular
-     * node or nodes, for easier browsing of records with a large data payload. Multiple paths
-     * can be separated with `|`.
-     */
-    formattedDataFilterPath: string;
-    /** Stringified, pretty-printed, optionally path-filtered `data` payload. */
-    formattedData: string;
+    formattedData: any;
     get hasSelection(): boolean;
     constructor();
     onLinked(): void;
     private showActivityEntriesAsync;
     private getAllLeafRows;
-    /** Extract data from a (detail) grid record and flush it into our form for display. */
     private showEntryDetail;
-    private updateFormattedData;
-    private createAndSetCoreModels;
-    private createGridModel;
-    private createSingleEntryFormModel;
 }

package/build/types/cmp/form/FormModel.d.ts

@@ -1,39 +1,49 @@
-import { HoistModel, PlainObject } from '@xh/hoist/core';
+import { HoistModel, PersistOptions, PlainObject } from '@xh/hoist/core';
 import { ValidationState } from '@xh/hoist/data';
 import { BaseFieldConfig, BaseFieldModel } from './field/BaseFieldModel';
 import { SubformsFieldConfig, SubformsFieldModel } from './field/SubformsFieldModel';
 export interface FormConfig {
-    /** FieldModels, or configs to create them, for all data fields managed by the model. */
+    /**
+     * FieldModels, or configurations to create them, for all data fields managed by this FormModel.
+     */
     fields?: Array<BaseFieldModel | BaseFieldConfig | SubformsFieldConfig | SubformsFieldModel>;
     /** Map of initial values for fields in this model. */
     initialValues?: PlainObject;
+    /** Options governing persistence of the form state. */
+    persistWith?: FormPersistOptions;
     disabled?: boolean;
     readonly?: boolean;
     /** @internal */
     xhImpl?: boolean;
 }
+export interface FormPersistOptions extends PersistOptions {
+    /** If persisting only a subset of all fields, provide an array of field names. */
+    includeFields?: string[];
+    /** If excluding a subset of all fields, provide an array of field names. */
+    excludeFields?: string[];
+}
 /**
- * FormModel is the main entry point for Form specification. This Model's `fields` object references
- * multiple {@link FieldModel} instances, keyed by name, which in turn hold the state of user-
- * edited data and the validation rules around editing that data.
+ * FormModel is the main entry point for Form specification. This Model's `fields` collection holds
+ * multiple FieldModel instances, which in turn hold the state of user edited data and the
+ * validation rules around editing that data.
  *
  * A complete representation of all fields and data within a Form can be produced via this model's
- * {@link getData} method, making it easy to harvest all values for e.g. submission to a server.
+ * `getData()` method, making it easy to harvest all values for e.g. submission to a server.
  *
- * Individual field values are also available as observables via this model's {@link values} proxy.
- * An application model can setup a reaction to track changes to any value and execute app-specific
+ * Individual field values are also available as observables via this model's `values` proxy. An
+ * application model can setup a reaction to track changes to any value and execute app-specific
  * logic such as disabling one field based on the state of another, or setting up cascading options.
  *
  * This Model provides an overall validation state, determined by the current validation state of
  * its fields as per their configured rules and constraints.
  *
- * FormModels can be nested via {@link SubformsFieldModel}s, a specialized type of FieldModel that
- * itself manages a collection of child FormModels. This enables forms to support editing of
+ * FormModels can be nested via SubformsFieldModels, a specialized type of FieldModel that itself
+ * manages a collection of child FormModels. This allows use cases where Forms support editing of
  * dynamic collections of complex objects with their own internal validation rules (e.g. a FormModel
  * representing a market order might have multiple nested FormModels to represent execution splits,
  * where each split has its own internal fields for broker, quantity, and time).
  *
- * See {@link FieldModel} for details on state/validation maintained at the individual field level.
+ * @see FieldModel for details on state and validation maintained at the individual field level.
  */
 export declare class FormModel extends HoistModel {
     /** Container object for FieldModel instances, keyed by field name.*/
@@ -55,7 +65,7 @@ export declare class FormModel extends HoistModel {
      * See {@link getData} instead if you need to get or react to the values of *any/all* fields.
      */
     get values(): PlainObject;
-    constructor({ fields, initialValues, disabled, readonly, xhImpl }?: FormConfig);
+    constructor({ fields, initialValues, disabled, persistWith, readonly, xhImpl }?: FormConfig);
     getField(fieldName: string): BaseFieldModel;
     /**
      * Snapshot of current field values, keyed by field name.
@@ -85,6 +95,7 @@ export declare class FormModel extends HoistModel {
     init(initialValues?: PlainObject): void;
     /**
      * Set the value of one or more fields on this form.
+     *
      * @param values - map of field name to value.
      */
     setValues(values: PlainObject): void;
@@ -92,12 +103,16 @@ export declare class FormModel extends HoistModel {
     get isDirty(): boolean;
     /**
      * The Field that is currently focused on this form.
-     * See {@link FieldModel.focus} for important information on this method and its limitations.
+     *
+     * @see FieldModel.focus() for important information on this method
+     * and its limitations.
      */
     get focusedField(): BaseFieldModel;
     /**
      * Focus a field on this form.
-     * See {@link FieldModel.focus} for important information on this method and its limitations.
+     *
+     * @see FieldModel.focus() for important information on this method
+     * and its limitations.
      */
     focusField(name: string): void;
     get validationState(): ValidationState;
@@ -107,12 +122,20 @@ export declare class FormModel extends HoistModel {
     get isValid(): boolean;
     /** List of all validation errors for this form. */
     get allErrors(): string[];
-    /** Recompute all validations and return true if the form is valid. */
+    /**
+     * Recompute all validations and return true if the form is valid.
+     *
+     * @param opts - set 'display' to true to trigger the display of
+     *  validation errors (if any) by bound FormField components after validation
+     *  is complete.
+     */
     validateAsync(opts?: {
-        /** True to trigger display of validation errors (if any) by bound `FormField`s after validation is complete. */
         display?: boolean;
     }): Promise<boolean>;
-    /** Trigger the display of validation errors (if any) by bound `FormField`s. */
+    /** Trigger the display of validation errors (if any) by bound FormField components. */
     displayValidation(): void;
     private createValuesProxy;
+    private initPersist;
+    private serialize;
+    private deserialize;
 }

package/build/types/cmp/form/field/SubformsFieldModel.d.ts

@@ -4,37 +4,32 @@ import { FormModel } from '../FormModel';
 import { BaseFieldModel, BaseFieldConfig } from './BaseFieldModel';
 import { FormConfig } from '../FormModel';
 export interface SubformsFieldConfig extends BaseFieldConfig {
-    /**
-     * Config for a {@link FormModel} to be auto-created to manage and validate the data for each
-     *
-     */
+    /** Config for FormModel representing a subform. */
     subforms: FormConfig;
     /**
-     * Initial value of this field. If a function, will be executed dynamically when form is
-     * initialized to provide value.
+     * Initial value of this field.  If a function, will be
+     * executed dynamically when form is initialized to provide value.
      */
     initialValue?: any[];
 }
 /**
- * A data field in a form whose value is a collection of nested objects - all of the same shape, but
- * with arbitrary internal complexity. A dedicated {@link FormModel} is auto-created to manage and
- * validate each object independently.
+ * A data field in a form whose value is a collection of FormModels (subforms).
  *
- * Applications should initialize this field with an array of objects. These values will be loaded
- * into an array of managed FormModels which will form the value of this field.
+ * Applications should initialize this field with an array of objects.  These values will be
+ * loaded into an array of managed FormModels which will form the value of this field.
  *
  * Applications should *not* modify the value property directly, unless they wish to reinitialize
- * all existing form contents to new values. Call {@link add} or {@link remove} on one of these
- * fields to adjust the contents of its collection while preserving existing state.
+ * all existing form contents to new values.  Use the methods add() or remove() to
+ * adjust the contents of the collection while preserving existing form state.
  *
- * Validation rules for the entire collection may be specified as for any field, but validations on
- * the subforms will also bubble up to this field, affecting its overall validation state.
+ * Validation rules for the entire collection may be specified as for any field, but
+ * validations on the subforms will also bubble up to this field, affecting its overall
+ * validation state.
  */
 export declare class SubformsFieldModel extends BaseFieldModel {
-    /** (Sub)FormModels created by this model, tracked to support cleanup. */
     private createdModels;
     private formConfig;
-    private readonly origInitialValues;
+    private origInitialValues;
     constructor({ subforms, initialValue, ...rest }: SubformsFieldConfig);
     get hasFocus(): boolean;
     focus(): void;
@@ -54,11 +49,14 @@ export declare class SubformsFieldModel extends BaseFieldModel {
         display?: boolean;
     }): Promise<boolean>;
     protected deriveValidationState(): ValidationState;
-    /** Add a new object (subform) to this field's collection. */
+    /**
+     * Add a new record (subform) to this field.
+     *
+     * @param initialValues - object containing initial values for new record.
+     * @param index - index in collection where subform should be inserted.
+     */
     add(opts?: {
-        /** Initial values for the new object/subform. */
         initialValues?: PlainObject;
-        /** Index within the collection where the new subform should be inserted. */
         index?: number;
     }): void;
     remove(formModel: FormModel): void;

package/build/types/core/HoistBase.d.ts

@@ -1,7 +1,7 @@
+import { PersistOptions, DebounceSpec, Some } from './';
 import { comparer } from '@xh/hoist/mobx';
 import { IAutorunOptions, IReactionOptions } from 'mobx/dist/api/autorun';
-import { IEqualsComparer, IReactionDisposer } from 'mobx/dist/internal';
-import { DebounceSpec, PersistOptions, Some } from './';
+import { IReactionDisposer, IEqualsComparer } from 'mobx/dist/internal';
 export interface HoistBaseClass {
     new (...args: any[]): HoistBase;
     isHoistBase: boolean;

package/build/types/data/cube/CubeField.d.ts

@@ -3,8 +3,11 @@ import { Aggregator, AverageAggregator, AverageStrictAggregator, ChildCountAggre
 export interface CubeFieldSpec extends FieldSpec {
     /** True to allow this field to be used for grouping.*/
     isDimension?: boolean;
-    /** Instance of a Hoist Cube {@link Aggregator} or string token alias for one. */
-    aggregator?: Aggregator | AggregatorToken;
+    /**
+     * Instance of a Hoist Cube Aggregator (from the aggregate package), or string alias for the
+     * same (e.g. 'MAX').
+     */
+    aggregator?: Aggregator | 'AVG' | 'AVG_STRICT' | 'CHILD_COUNT' | 'LEAF_COUNT' | 'MAX' | 'MIN' | 'NULL' | 'SINGLE' | 'SUM' | 'SUM_STRICT' | 'UNIQUE';
     /** Function to determine if aggregation should be performed at a given level of a query result. */
     canAggregateFn?: CanAggregateFn;
     /** True if any further groupings below this dimension would be derivative (have only one member). */
@@ -16,8 +19,6 @@ export interface CubeFieldSpec extends FieldSpec {
      */
     parentDimension?: string;
 }
-/** Convenient (and serializable) alias for one of Hoist's Cube {@link Aggregator} classes. */
-export type AggregatorToken = 'AVG' | 'AVG_STRICT' | 'CHILD_COUNT' | 'LEAF_COUNT' | 'MAX' | 'MIN' | 'NULL' | 'SINGLE' | 'SUM' | 'SUM_STRICT' | 'UNIQUE';
 /**
  * @param dimension - dimension of aggregation
  * @param value - value of record on dimension

package/build/types/desktop/cmp/appOption/AutoRefreshAppOption.d.ts

@@ -86,7 +86,7 @@ export declare const autoRefreshAppOption: ({ formFieldProps, inputProps }?: Aut
         suppressContentEditableWarning?: boolean;
         suppressHydrationWarning?: boolean;
         accessKey?: string;
-        autoCapitalize?: "none" | "off" | "on" | "sentences" | "words" | "characters" | (string & {});
+        autoCapitalize?: "off" | "none" | "on" | "sentences" | "words" | "characters" | (string & {});
         autoFocus?: boolean;
         contentEditable?: "inherit" | (boolean | "true" | "false") | "plaintext-only";
         dir?: string;
@@ -121,7 +121,7 @@ export declare const autoRefreshAppOption: ({ formFieldProps, inputProps }?: Aut
         results?: number;
         security?: string;
         unselectable?: "off" | "on";
-        inputMode?: "none" | "search" | "text" | "tel" | "url" | "email" | "numeric" | "decimal";
+        inputMode?: "search" | "text" | "none" | "tel" | "url" | "email" | "numeric" | "decimal";
         is?: string;
         "aria-activedescendant"?: string;
         "aria-atomic"?: boolean | "true" | "false";
@@ -140,7 +140,7 @@ export declare const autoRefreshAppOption: ({ formFieldProps, inputProps }?: Aut
         "aria-description"?: string;
         "aria-details"?: string;
         "aria-disabled"?: boolean | "true" | "false";
-        "aria-dropeffect"?: "none" | "link" | "copy" | "execute" | "move" | "popup";
+        "aria-dropeffect"?: "link" | "none" | "copy" | "execute" | "move" | "popup";
         "aria-errormessage"?: string;
         "aria-expanded"?: boolean | "true" | "false";
         "aria-flowto"?: string;

package/build/types/desktop/cmp/appOption/ThemeAppOption.d.ts

@@ -84,7 +84,7 @@ export declare const themeAppOption: ({ formFieldProps, inputProps }?: ThemeAppO
         suppressContentEditableWarning?: boolean;
         suppressHydrationWarning?: boolean;
         accessKey?: string;
-        autoCapitalize?: "none" | "off" | "on" | "sentences" | "words" | "characters" | (string & {});
+        autoCapitalize?: "off" | "none" | "on" | "sentences" | "words" | "characters" | (string & {});
         autoFocus?: boolean;
         contentEditable?: "inherit" | (boolean | "true" | "false") | "plaintext-only";
         dir?: string;
@@ -119,7 +119,7 @@ export declare const themeAppOption: ({ formFieldProps, inputProps }?: ThemeAppO
         results?: number;
         security?: string;
         unselectable?: "off" | "on";
-        inputMode?: "none" | "search" | "text" | "tel" | "url" | "email" | "numeric" | "decimal";
+        inputMode?: "search" | "text" | "none" | "tel" | "url" | "email" | "numeric" | "decimal";
         is?: string;
         "aria-activedescendant"?: string;
         "aria-atomic"?: boolean | "true" | "false";
@@ -138,7 +138,7 @@ export declare const themeAppOption: ({ formFieldProps, inputProps }?: ThemeAppO
         "aria-description"?: string;
         "aria-details"?: string;
         "aria-disabled"?: boolean | "true" | "false";
-        "aria-dropeffect"?: "none" | "link" | "copy" | "execute" | "move" | "popup";
+        "aria-dropeffect"?: "link" | "none" | "copy" | "execute" | "move" | "popup";
         "aria-errormessage"?: string;
         "aria-expanded"?: boolean | "true" | "false";
         "aria-flowto"?: string;

package/cmp/error/ErrorBoundaryModel.ts

@@ -5,8 +5,8 @@
  * Copyright © 2025 Extremely Heavy Industries Inc.
  */
 import {ExceptionHandlerOptions, HoistModel, XH} from '@xh/hoist/core';
-import {action, makeObservable, observable} from '@xh/hoist/mobx';
 import {isFunction} from 'lodash';
+import {action, makeObservable, observable} from 'mobx';
 import {ReactNode} from 'react';
 
 export interface ErrorBoundaryConfig {

package/cmp/form/FormModel.ts

@@ -4,22 +4,50 @@
  *
  * Copyright © 2025 Extremely Heavy Industries Inc.
  */
-import {HoistModel, managed, PlainObject} from '@xh/hoist/core';
+import {
+    HoistModel,
+    managed,
+    PersistableState,
+    PersistenceProvider,
+    PersistOptions,
+    PlainObject
+} from '@xh/hoist/core';
 import {ValidationState} from '@xh/hoist/data';
 import {action, bindable, computed, makeObservable, observable} from '@xh/hoist/mobx';
 import {throwIf} from '@xh/hoist/utils/js';
-import {flatMap, forEach, forOwn, map, mapValues, pickBy, some, values} from 'lodash';
+import {
+    flatMap,
+    forEach,
+    forOwn,
+    isArray,
+    isDate,
+    isObject,
+    isString,
+    map,
+    mapValues,
+    pick,
+    pickBy,
+    some,
+    values,
+    without
+} from 'lodash';
 import {BaseFieldConfig, BaseFieldModel} from './field/BaseFieldModel';
 import {FieldModel} from './field/FieldModel';
 import {SubformsFieldConfig, SubformsFieldModel} from './field/SubformsFieldModel';
+import {isLocalDate, LocalDate} from '@xh/hoist/utils/datetime';
 
 export interface FormConfig {
-    /** FieldModels, or configs to create them, for all data fields managed by the model. */
+    /**
+     * FieldModels, or configurations to create them, for all data fields managed by this FormModel.
+     */
     fields?: Array<BaseFieldModel | BaseFieldConfig | SubformsFieldConfig | SubformsFieldModel>;
 
     /** Map of initial values for fields in this model. */
     initialValues?: PlainObject;
 
+    /** Options governing persistence of the form state. */
+    persistWith?: FormPersistOptions;
+
     disabled?: boolean;
     readonly?: boolean;
 
@@ -27,28 +55,35 @@ export interface FormConfig {
     xhImpl?: boolean;
 }
 
+export interface FormPersistOptions extends PersistOptions {
+    /** If persisting only a subset of all fields, provide an array of field names. */
+    includeFields?: string[];
+    /** If excluding a subset of all fields, provide an array of field names. */
+    excludeFields?: string[];
+}
+
 /**
- * FormModel is the main entry point for Form specification. This Model's `fields` object references
- * multiple {@link FieldModel} instances, keyed by name, which in turn hold the state of user-
- * edited data and the validation rules around editing that data.
+ * FormModel is the main entry point for Form specification. This Model's `fields` collection holds
+ * multiple FieldModel instances, which in turn hold the state of user edited data and the
+ * validation rules around editing that data.
  *
  * A complete representation of all fields and data within a Form can be produced via this model's
- * {@link getData} method, making it easy to harvest all values for e.g. submission to a server.
+ * `getData()` method, making it easy to harvest all values for e.g. submission to a server.
  *
- * Individual field values are also available as observables via this model's {@link values} proxy.
- * An application model can setup a reaction to track changes to any value and execute app-specific
+ * Individual field values are also available as observables via this model's `values` proxy. An
+ * application model can setup a reaction to track changes to any value and execute app-specific
  * logic such as disabling one field based on the state of another, or setting up cascading options.
  *
  * This Model provides an overall validation state, determined by the current validation state of
  * its fields as per their configured rules and constraints.
  *
- * FormModels can be nested via {@link SubformsFieldModel}s, a specialized type of FieldModel that
- * itself manages a collection of child FormModels. This enables forms to support editing of
+ * FormModels can be nested via SubformsFieldModels, a specialized type of FieldModel that itself
+ * manages a collection of child FormModels. This allows use cases where Forms support editing of
  * dynamic collections of complex objects with their own internal validation rules (e.g. a FormModel
  * representing a market order might have multiple nested FormModels to represent execution splits,
  * where each split has its own internal fields for broker, quantity, and time).
  *
- * See {@link FieldModel} for details on state/validation maintained at the individual field level.
+ * @see FieldModel for details on state and validation maintained at the individual field level.
  */
 export class FormModel extends HoistModel {
     /** Container object for FieldModel instances, keyed by field name.*/
@@ -85,6 +120,7 @@ export class FormModel extends HoistModel {
         fields = [],
         initialValues = {},
         disabled = false,
+        persistWith = null,
         readonly = false,
         xhImpl = false
     }: FormConfig = {}) {
@@ -95,6 +131,7 @@ export class FormModel extends HoistModel {
         this.disabled = disabled;
         this.readonly = readonly;
         const models = {};
+
         fields.forEach((f: any) => {
             const model =
                     f instanceof BaseFieldModel
@@ -109,6 +146,7 @@ export class FormModel extends HoistModel {
         this.fields = models;
 
         this.init(initialValues);
+        if (persistWith) this.initPersist(persistWith);
 
         // Set the owning formModel *last* after all fields in place with data.
         // This (currently) kicks off the validation and other reactivity.
@@ -162,6 +200,7 @@ export class FormModel extends HoistModel {
 
     /**
      * Set the value of one or more fields on this form.
+     *
      * @param values - map of field name to value.
      */
     @action
@@ -181,7 +220,9 @@ export class FormModel extends HoistModel {
     //-----------------------------------
     /**
      * The Field that is currently focused on this form.
-     * See {@link FieldModel.focus} for important information on this method and its limitations.
+     *
+     * @see FieldModel.focus() for important information on this method
+     * and its limitations.
      */
     @computed
     get focusedField(): BaseFieldModel {
@@ -190,7 +231,9 @@ export class FormModel extends HoistModel {
 
     /**
      * Focus a field on this form.
-     * See {@link FieldModel.focus} for important information on this method and its limitations.
+     *
+     * @see FieldModel.focus() for important information on this method
+     * and its limitations.
      */
     focusField(name: string) {
         this.getField(name)?.focus();
@@ -223,18 +266,21 @@ export class FormModel extends HoistModel {
         return flatMap(this.fields, s => s.allErrors);
     }
 
-    /** Recompute all validations and return true if the form is valid. */
-    async validateAsync(opts?: {
-        /** True to trigger display of validation errors (if any) by bound `FormField`s after validation is complete. */
-        display?: boolean;
-    }): Promise<boolean> {
+    /**
+     * Recompute all validations and return true if the form is valid.
+     *
+     * @param opts - set 'display' to true to trigger the display of
+     *  validation errors (if any) by bound FormField components after validation
+     *  is complete.
+     */
+    async validateAsync(opts?: {display?: boolean}): Promise<boolean> {
         const {display = true} = opts ?? {},
             promises = map(this.fields, m => m.validateAsync({display}));
         await Promise.all(promises);
         return this.isValid;
     }
 
-    /** Trigger the display of validation errors (if any) by bound `FormField`s. */
+    /** Trigger the display of validation errors (if any) by bound FormField components. */
     displayValidation() {
         forOwn(this.fields, m => m.displayValidation());
     }
@@ -264,4 +310,50 @@ export class FormModel extends HoistModel {
             }
         );
     }
+
+    private initPersist({
+        includeFields = null,
+        excludeFields = null,
+        path = 'formValues',
+        ...rootPersistWith
+    }: FormPersistOptions) {
+        const allFields = Object.keys(this.fields);
+        const fieldNamesToPersist = excludeFields
+            ? without(allFields, ...excludeFields)
+            : (includeFields ?? allFields);
+
+        PersistenceProvider.create({
+            persistOptions: {
+                path,
+                ...rootPersistWith
+            },
+            target: {
+                getPersistableState: () =>
+                    new PersistableState(this.serialize(pick(this.getData(), fieldNamesToPersist))),
+                setPersistableState: ({value: formValues}) =>
+                    this.setValues(this.deserialize(pick(formValues, fieldNamesToPersist)))
+            },
+            owner: this
+        });
+    }
+
+    private serialize = (formValue: unknown) => {
+        if (isArray(formValue)) return formValue.map(this.serialize);
+        if (isDate(formValue)) return {_xhType: 'date', value: formValue.toJSON()};
+        if (isLocalDate(formValue)) return {_xhType: 'localDate', value: formValue.toJSON()};
+        if (isObject(formValue)) return mapValues(formValue, this.serialize);
+        return formValue;
+    };
+
+    private deserialize = (formValue: unknown) => {
+        if (isArray(formValue)) return formValue.map(this.deserialize);
+        if (isObject(formValue)) {
+            if ('_xhType' in formValue && 'value' in formValue && isString(formValue.value)) {
+                if (formValue._xhType === 'date') return new Date(formValue.value);
+                if (formValue._xhType === 'localDate') return LocalDate.get(formValue.value);
+            }
+            return mapValues(formValue, this.deserialize);
+        }
+        return formValue;
+    };
 }