@tanstack/form-core 1.14.0 → 1.15.0

package/dist/cjs/FieldGroupApi.cjs

@@ -0,0 +1,156 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const store = require("@tanstack/store");
+const utils = require("./utils.cjs");
+class FieldGroupApi {
+  /**
+   * Constructs a new `FieldGroupApi` instance with the given form options.
+   */
+  constructor(opts) {
+    this.getFormFieldName = (subfield) => {
+      if (typeof this.fieldsMap === "string") {
+        return utils.concatenatePaths(this.fieldsMap, subfield);
+      }
+      const firstAccessor = utils.makePathArray(subfield)[0];
+      if (typeof firstAccessor !== "string") {
+        return "";
+      }
+      const restOfPath = subfield.slice(firstAccessor.length);
+      const formMappedPath = (
+        // TFields is either a string or this. See guard above.
+        this.fieldsMap[firstAccessor]
+      );
+      return utils.concatenatePaths(formMappedPath, restOfPath);
+    };
+    this.mount = () => {
+      const cleanup = this.store.mount();
+      return cleanup;
+    };
+    this.validateArrayFieldsStartingFrom = async (field, index, cause) => {
+      return this.form.validateArrayFieldsStartingFrom(
+        this.getFormFieldName(field),
+        index,
+        cause
+      );
+    };
+    this.validateField = (field, cause) => {
+      return this.form.validateField(this.getFormFieldName(field), cause);
+    };
+    this.getFieldValue = (field) => {
+      return this.form.getFieldValue(this.getFormFieldName(field));
+    };
+    this.getFieldMeta = (field) => {
+      return this.form.getFieldMeta(this.getFormFieldName(field));
+    };
+    this.setFieldMeta = (field, updater) => {
+      return this.form.setFieldMeta(this.getFormFieldName(field), updater);
+    };
+    this.setFieldValue = (field, updater, opts2) => {
+      return this.form.setFieldValue(
+        this.getFormFieldName(field),
+        updater,
+        opts2
+      );
+    };
+    this.deleteField = (field) => {
+      return this.form.deleteField(this.getFormFieldName(field));
+    };
+    this.pushFieldValue = (field, value, opts2) => {
+      return this.form.pushFieldValue(
+        this.getFormFieldName(field),
+        // since unknown doesn't extend an array, it types `value` as never.
+        value,
+        opts2
+      );
+    };
+    this.insertFieldValue = async (field, index, value, opts2) => {
+      return this.form.insertFieldValue(
+        this.getFormFieldName(field),
+        index,
+        // since unknown doesn't extend an array, it types `value` as never.
+        value,
+        opts2
+      );
+    };
+    this.replaceFieldValue = async (field, index, value, opts2) => {
+      return this.form.replaceFieldValue(
+        this.getFormFieldName(field),
+        index,
+        // since unknown doesn't extend an array, it types `value` as never.
+        value,
+        opts2
+      );
+    };
+    this.removeFieldValue = async (field, index, opts2) => {
+      return this.form.removeFieldValue(this.getFormFieldName(field), index, opts2);
+    };
+    this.swapFieldValues = (field, index1, index2, opts2) => {
+      return this.form.swapFieldValues(
+        this.getFormFieldName(field),
+        index1,
+        index2,
+        opts2
+      );
+    };
+    this.moveFieldValues = (field, index1, index2, opts2) => {
+      return this.form.moveFieldValues(
+        this.getFormFieldName(field),
+        index1,
+        index2,
+        opts2
+      );
+    };
+    this.clearFieldValues = (field, opts2) => {
+      return this.form.clearFieldValues(this.getFormFieldName(field), opts2);
+    };
+    this.resetField = (field) => {
+      return this.form.resetField(this.getFormFieldName(field));
+    };
+    this.validateAllFields = (cause) => this.form.validateAllFields(cause);
+    if (opts.form instanceof FieldGroupApi) {
+      const group = opts.form;
+      this.form = group.form;
+      if (typeof opts.fields === "string") {
+        this.fieldsMap = group.getFormFieldName(opts.fields);
+      } else {
+        const fields = {
+          ...opts.fields
+        };
+        for (const key in fields) {
+          fields[key] = group.getFormFieldName(fields[key]);
+        }
+        this.fieldsMap = fields;
+      }
+    } else {
+      this.form = opts.form;
+      this.fieldsMap = opts.fields;
+    }
+    this.store = new store.Derived({
+      deps: [this.form.store],
+      fn: ({ currDepVals }) => {
+        const currFormStore = currDepVals[0];
+        let values;
+        if (typeof this.fieldsMap === "string") {
+          values = utils.getBy(currFormStore.values, this.fieldsMap);
+        } else {
+          values = {};
+          const fields = this.fieldsMap;
+          for (const key in fields) {
+            values[key] = utils.getBy(currFormStore.values, fields[key]);
+          }
+        }
+        return {
+          values
+        };
+      }
+    });
+  }
+  get state() {
+    return this.store.state;
+  }
+  async handleSubmit(submitMeta) {
+    return this.form.handleSubmit(submitMeta);
+  }
+}
+exports.FieldGroupApi = FieldGroupApi;
+//# sourceMappingURL=FieldGroupApi.cjs.map

package/dist/cjs/FieldGroupApi.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"FieldGroupApi.cjs","sources":["../../src/FieldGroupApi.ts"],"sourcesContent":["import { Derived } from '@tanstack/store'\nimport { concatenatePaths, getBy, makePathArray } from './utils'\nimport type { Updater } from './utils'\nimport type {\n  FormApi,\n  FormAsyncValidateOrFn,\n  FormValidateOrFn,\n} from './FormApi'\nimport type { AnyFieldMeta, AnyFieldMetaBase } from './FieldApi'\nimport type {\n  DeepKeys,\n  DeepKeysOfType,\n  DeepValue,\n  FieldsMap,\n} from './util-types'\nimport type {\n  FieldManipulator,\n  UpdateMetaOptions,\n  ValidationCause,\n} from './types'\n\nexport type AnyFieldGroupApi = FieldGroupApi<\n  any,\n  any,\n  any,\n  any,\n  any,\n  any,\n  any,\n  any,\n  any,\n  any,\n  any,\n  any\n>\n\nexport interface FieldGroupState<in out TFieldGroupData> {\n  /**\n   * The current values of the field group\n   */\n  values: TFieldGroupData\n}\n\n/**\n * An object representing the options for a field group.\n */\nexport interface FieldGroupOptions<\n  in out TFormData,\n  in out TFieldGroupData,\n  in out TFields extends\n    | DeepKeysOfType<TFormData, TFieldGroupData | null | undefined>\n    | FieldsMap<TFormData, TFieldGroupData>,\n  in out TOnMount extends undefined | FormValidateOrFn<TFormData>,\n  in out TOnChange extends undefined | FormValidateOrFn<TFormData>,\n  in out TOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFormData>,\n  in out TOnBlur extends undefined | FormValidateOrFn<TFormData>,\n  in out TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>,\n  in out TOnSubmit extends undefined | FormValidateOrFn<TFormData>,\n  in out TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>,\n  in out TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>,\n  in out TSubmitMeta = never,\n> {\n  form:\n    | FormApi<\n        TFormData,\n        TOnMount,\n        TOnChange,\n        TOnChangeAsync,\n        TOnBlur,\n        TOnBlurAsync,\n        TOnSubmit,\n        TOnSubmitAsync,\n        TOnServer,\n        TSubmitMeta\n      >\n    | FieldGroupApi<\n        any,\n        TFormData,\n        any,\n        any,\n        any,\n        any,\n        any,\n        any,\n        any,\n        any,\n        any,\n        TSubmitMeta\n      >\n  /**\n   * The path to the field group data.\n   */\n  fields: TFields\n  /**\n   * The expected subsetValues that the form must provide.\n   */\n  defaultValues?: TFieldGroupData\n  /**\n   * onSubmitMeta, the data passed from the handleSubmit handler, to the onSubmit function props\n   */\n  onSubmitMeta?: TSubmitMeta\n}\n\nexport class FieldGroupApi<\n  in out TFormData,\n  in out TFieldGroupData,\n  in out TFields extends\n    | DeepKeysOfType<TFormData, TFieldGroupData | null | undefined>\n    | FieldsMap<TFormData, TFieldGroupData>,\n  in out TOnMount extends undefined | FormValidateOrFn<TFormData>,\n  in out TOnChange extends undefined | FormValidateOrFn<TFormData>,\n  in out TOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFormData>,\n  in out TOnBlur extends undefined | FormValidateOrFn<TFormData>,\n  in out TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>,\n  in out TOnSubmit extends undefined | FormValidateOrFn<TFormData>,\n  in out TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>,\n  in out TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>,\n  in out TSubmitMeta = never,\n> implements FieldManipulator<TFieldGroupData, TSubmitMeta>\n{\n  /**\n   * The form that called this field group.\n   */\n  readonly form: FormApi<\n    TFormData,\n    TOnMount,\n    TOnChange,\n    TOnChangeAsync,\n    TOnBlur,\n    TOnBlurAsync,\n    TOnSubmit,\n    TOnSubmitAsync,\n    TOnServer,\n    TSubmitMeta\n  >\n\n  readonly fieldsMap: TFields\n\n  /**\n   * Get the true name of the field. Not required within `Field` or `AppField`.\n   * @private\n   */\n  getFormFieldName = <TField extends DeepKeys<TFieldGroupData>>(\n    subfield: TField,\n  ): DeepKeys<TFormData> => {\n    if (typeof this.fieldsMap === 'string') {\n      return concatenatePaths(this.fieldsMap, subfield)\n    }\n\n    const firstAccessor = makePathArray(subfield)[0]\n    if (typeof firstAccessor !== 'string') {\n      // top-level arrays cannot be mapped\n      return ''\n    }\n\n    const restOfPath = subfield.slice(firstAccessor.length)\n    const formMappedPath =\n      // TFields is either a string or this. See guard above.\n      (this.fieldsMap as FieldsMap<TFormData, TFieldGroupData>)[\n        firstAccessor as keyof TFieldGroupData\n      ]\n\n    return concatenatePaths(formMappedPath, restOfPath)\n  }\n\n  store: Derived<FieldGroupState<TFieldGroupData>>\n\n  get state() {\n    return this.store.state\n  }\n\n  /**\n   * Constructs a new `FieldGroupApi` instance with the given form options.\n   */\n  constructor(\n    opts: FieldGroupOptions<\n      TFormData,\n      TFieldGroupData,\n      TFields,\n      TOnMount,\n      TOnChange,\n      TOnChangeAsync,\n      TOnBlur,\n      TOnBlurAsync,\n      TOnSubmit,\n      TOnSubmitAsync,\n      TOnServer,\n      TSubmitMeta\n    >,\n  ) {\n    if (opts.form instanceof FieldGroupApi) {\n      const group = opts.form\n      this.form = group.form as never\n\n      // the DeepKey is already namespaced, so we need to ensure that we reference\n      // the form and not the group\n      if (typeof opts.fields === 'string') {\n        this.fieldsMap = group.getFormFieldName(opts.fields) as TFields\n      } else {\n        // TypeScript has a tough time with generics being a union for some reason\n        const fields = {\n          ...(opts.fields as FieldsMap<TFormData, TFieldGroupData>),\n        }\n        for (const key in fields) {\n          fields[key] = group.getFormFieldName(fields[key]) as never\n        }\n        this.fieldsMap = fields as never\n      }\n    } else {\n      this.form = opts.form\n      this.fieldsMap = opts.fields\n    }\n\n    this.store = new Derived({\n      deps: [this.form.store],\n      fn: ({ currDepVals }) => {\n        const currFormStore = currDepVals[0]\n        let values: TFieldGroupData\n        if (typeof this.fieldsMap === 'string') {\n          // all values live at that name, so we can directly fetch it\n          values = getBy(currFormStore.values, this.fieldsMap)\n        } else {\n          // we need to fetch the values from all places where they were mapped from\n          values = {} as never\n          const fields: Record<keyof TFieldGroupData, string> = this\n            .fieldsMap as never\n          for (const key in fields) {\n            values[key] = getBy(currFormStore.values, fields[key])\n          }\n        }\n\n        return {\n          values,\n        }\n      },\n    })\n  }\n\n  /**\n   * Mounts the field group instance to listen to value changes.\n   */\n  mount = () => {\n    const cleanup = this.store.mount()\n\n    return cleanup\n  }\n\n  /**\n   * Validates the children of a specified array in the form starting from a given index until the end using the correct handlers for a given validation type.\n   */\n  validateArrayFieldsStartingFrom = async <\n    TField extends DeepKeysOfType<TFieldGroupData, any[]>,\n  >(\n    field: TField,\n    index: number,\n    cause: ValidationCause,\n  ) => {\n    return this.form.validateArrayFieldsStartingFrom(\n      this.getFormFieldName(field),\n      index,\n      cause,\n    )\n  }\n\n  /**\n   * Validates a specified field in the form using the correct handlers for a given validation type.\n   */\n  validateField = <TField extends DeepKeys<TFieldGroupData>>(\n    field: TField,\n    cause: ValidationCause,\n  ) => {\n    return this.form.validateField(this.getFormFieldName(field), cause)\n  }\n\n  /**\n   * Handles the form submission, performs validation, and calls the appropriate onSubmit or onSubmitInvalid callbacks.\n   */\n  handleSubmit(): Promise<void>\n  handleSubmit(submitMeta: TSubmitMeta): Promise<void>\n  async handleSubmit(submitMeta?: TSubmitMeta): Promise<void> {\n    // cast is required since the implementation isn't one of the two overloads\n    return this.form.handleSubmit(submitMeta as any)\n  }\n\n  /**\n   * Gets the value of the specified field.\n   */\n  getFieldValue = <TField extends DeepKeys<TFieldGroupData>>(\n    field: TField,\n  ): DeepValue<TFieldGroupData, TField> => {\n    return this.form.getFieldValue(this.getFormFieldName(field)) as DeepValue<\n      TFieldGroupData,\n      TField\n    >\n  }\n\n  /**\n   * Gets the metadata of the specified field.\n   */\n  getFieldMeta = <TField extends DeepKeys<TFieldGroupData>>(field: TField) => {\n    return this.form.getFieldMeta(this.getFormFieldName(field))\n  }\n\n  /**\n   * Updates the metadata of the specified field.\n   */\n  setFieldMeta = <TField extends DeepKeys<TFieldGroupData>>(\n    field: TField,\n    updater: Updater<AnyFieldMetaBase>,\n  ) => {\n    return this.form.setFieldMeta(this.getFormFieldName(field), updater)\n  }\n\n  /**\n   * Sets the value of the specified field and optionally updates the touched state.\n   */\n  setFieldValue = <TField extends DeepKeys<TFieldGroupData>>(\n    field: TField,\n    updater: Updater<DeepValue<TFieldGroupData, TField>>,\n    opts?: UpdateMetaOptions,\n  ) => {\n    return this.form.setFieldValue(\n      this.getFormFieldName(field) as never,\n      updater as never,\n      opts,\n    )\n  }\n\n  /**\n   * Delete a field and its subfields.\n   */\n  deleteField = <TField extends DeepKeys<TFieldGroupData>>(field: TField) => {\n    return this.form.deleteField(this.getFormFieldName(field))\n  }\n\n  /**\n   * Pushes a value into an array field.\n   */\n  pushFieldValue = <TField extends DeepKeysOfType<TFieldGroupData, any[]>>(\n    field: TField,\n    value: DeepValue<TFieldGroupData, TField> extends any[]\n      ? DeepValue<TFieldGroupData, TField>[number]\n      : never,\n    opts?: UpdateMetaOptions,\n  ) => {\n    return this.form.pushFieldValue(\n      this.getFormFieldName(field),\n      // since unknown doesn't extend an array, it types `value` as never.\n      value as never,\n      opts,\n    )\n  }\n\n  /**\n   * Insert a value into an array field at the specified index.\n   */\n  insertFieldValue = async <\n    TField extends DeepKeysOfType<TFieldGroupData, any[]>,\n  >(\n    field: TField,\n    index: number,\n    value: DeepValue<TFieldGroupData, TField> extends any[]\n      ? DeepValue<TFieldGroupData, TField>[number]\n      : never,\n    opts?: UpdateMetaOptions,\n  ) => {\n    return this.form.insertFieldValue(\n      this.getFormFieldName(field),\n      index,\n      // since unknown doesn't extend an array, it types `value` as never.\n      value as never,\n      opts,\n    )\n  }\n\n  /**\n   * Replaces a value into an array field at the specified index.\n   */\n  replaceFieldValue = async <\n    TField extends DeepKeysOfType<TFieldGroupData, any[]>,\n  >(\n    field: TField,\n    index: number,\n    value: DeepValue<TFieldGroupData, TField> extends any[]\n      ? DeepValue<TFieldGroupData, TField>[number]\n      : never,\n    opts?: UpdateMetaOptions,\n  ) => {\n    return this.form.replaceFieldValue(\n      this.getFormFieldName(field),\n      index,\n      // since unknown doesn't extend an array, it types `value` as never.\n      value as never,\n      opts,\n    )\n  }\n\n  /**\n   * Removes a value from an array field at the specified index.\n   */\n  removeFieldValue = async <\n    TField extends DeepKeysOfType<TFieldGroupData, any[]>,\n  >(\n    field: TField,\n    index: number,\n    opts?: UpdateMetaOptions,\n  ) => {\n    return this.form.removeFieldValue(this.getFormFieldName(field), index, opts)\n  }\n\n  /**\n   * Swaps the values at the specified indices within an array field.\n   */\n  swapFieldValues = <TField extends DeepKeysOfType<TFieldGroupData, any[]>>(\n    field: TField,\n    index1: number,\n    index2: number,\n    opts?: UpdateMetaOptions,\n  ) => {\n    return this.form.swapFieldValues(\n      this.getFormFieldName(field),\n      index1,\n      index2,\n      opts,\n    )\n  }\n\n  /**\n   * Moves the value at the first specified index to the second specified index within an array field.\n   */\n  moveFieldValues = <TField extends DeepKeysOfType<TFieldGroupData, any[]>>(\n    field: TField,\n    index1: number,\n    index2: number,\n    opts?: UpdateMetaOptions,\n  ) => {\n    return this.form.moveFieldValues(\n      this.getFormFieldName(field),\n      index1,\n      index2,\n      opts,\n    )\n  }\n\n  clearFieldValues = <TField extends DeepKeysOfType<TFieldGroupData, any[]>>(\n    field: TField,\n    opts?: UpdateMetaOptions,\n  ) => {\n    return this.form.clearFieldValues(this.getFormFieldName(field), opts)\n  }\n\n  /**\n   * Resets the field value and meta to default state\n   */\n  resetField = <TField extends DeepKeys<TFieldGroupData>>(field: TField) => {\n    return this.form.resetField(this.getFormFieldName(field))\n  }\n\n  validateAllFields = (cause: ValidationCause) =>\n    this.form.validateAllFields(cause)\n}\n"],"names":["concatenatePaths","makePathArray","opts","Derived","getBy"],"mappings":";;;;AAuGO,MAAM,cAgBb;AAAA;AAAA;AAAA;AAAA,EAuDE,YACE,MAcA;AA/CF,SAAA,mBAAmB,CACjB,aACwB;AACpB,UAAA,OAAO,KAAK,cAAc,UAAU;AAC/B,eAAAA,uBAAiB,KAAK,WAAW,QAAQ;AAAA,MAAA;AAGlD,YAAM,gBAAgBC,MAAAA,cAAc,QAAQ,EAAE,CAAC;AAC3C,UAAA,OAAO,kBAAkB,UAAU;AAE9B,eAAA;AAAA,MAAA;AAGT,YAAM,aAAa,SAAS,MAAM,cAAc,MAAM;AAChD,YAAA;AAAA;AAAA,QAEH,KAAK,UACJ,aACF;AAAA;AAEK,aAAAD,MAAA,iBAAiB,gBAAgB,UAAU;AAAA,IACpD;AA8EA,SAAA,QAAQ,MAAM;AACN,YAAA,UAAU,KAAK,MAAM,MAAM;AAE1B,aAAA;AAAA,IACT;AAKkC,SAAA,kCAAA,OAGhC,OACA,OACA,UACG;AACH,aAAO,KAAK,KAAK;AAAA,QACf,KAAK,iBAAiB,KAAK;AAAA,QAC3B;AAAA,QACA;AAAA,MACF;AAAA,IACF;AAKgB,SAAA,gBAAA,CACd,OACA,UACG;AACH,aAAO,KAAK,KAAK,cAAc,KAAK,iBAAiB,KAAK,GAAG,KAAK;AAAA,IACpE;AAeA,SAAA,gBAAgB,CACd,UACuC;AACvC,aAAO,KAAK,KAAK,cAAc,KAAK,iBAAiB,KAAK,CAAC;AAAA,IAI7D;AAKA,SAAA,eAAe,CAA2C,UAAkB;AAC1E,aAAO,KAAK,KAAK,aAAa,KAAK,iBAAiB,KAAK,CAAC;AAAA,IAC5D;AAKe,SAAA,eAAA,CACb,OACA,YACG;AACH,aAAO,KAAK,KAAK,aAAa,KAAK,iBAAiB,KAAK,GAAG,OAAO;AAAA,IACrE;AAKgB,SAAA,gBAAA,CACd,OACA,SACAE,UACG;AACH,aAAO,KAAK,KAAK;AAAA,QACf,KAAK,iBAAiB,KAAK;AAAA,QAC3B;AAAA,QACAA;AAAA,MACF;AAAA,IACF;AAKA,SAAA,cAAc,CAA2C,UAAkB;AACzE,aAAO,KAAK,KAAK,YAAY,KAAK,iBAAiB,KAAK,CAAC;AAAA,IAC3D;AAKiB,SAAA,iBAAA,CACf,OACA,OAGAA,UACG;AACH,aAAO,KAAK,KAAK;AAAA,QACf,KAAK,iBAAiB,KAAK;AAAA;AAAA,QAE3B;AAAA,QACAA;AAAA,MACF;AAAA,IACF;AAKA,SAAA,mBAAmB,OAGjB,OACA,OACA,OAGAA,UACG;AACH,aAAO,KAAK,KAAK;AAAA,QACf,KAAK,iBAAiB,KAAK;AAAA,QAC3B;AAAA;AAAA,QAEA;AAAA,QACAA;AAAA,MACF;AAAA,IACF;AAKA,SAAA,oBAAoB,OAGlB,OACA,OACA,OAGAA,UACG;AACH,aAAO,KAAK,KAAK;AAAA,QACf,KAAK,iBAAiB,KAAK;AAAA,QAC3B;AAAA;AAAA,QAEA;AAAA,QACAA;AAAA,MACF;AAAA,IACF;AAKmB,SAAA,mBAAA,OAGjB,OACA,OACAA,UACG;AACI,aAAA,KAAK,KAAK,iBAAiB,KAAK,iBAAiB,KAAK,GAAG,OAAOA,KAAI;AAAA,IAC7E;AAKA,SAAA,kBAAkB,CAChB,OACA,QACA,QACAA,UACG;AACH,aAAO,KAAK,KAAK;AAAA,QACf,KAAK,iBAAiB,KAAK;AAAA,QAC3B;AAAA,QACA;AAAA,QACAA;AAAA,MACF;AAAA,IACF;AAKA,SAAA,kBAAkB,CAChB,OACA,QACA,QACAA,UACG;AACH,aAAO,KAAK,KAAK;AAAA,QACf,KAAK,iBAAiB,KAAK;AAAA,QAC3B;AAAA,QACA;AAAA,QACAA;AAAA,MACF;AAAA,IACF;AAEmB,SAAA,mBAAA,CACjB,OACAA,UACG;AACH,aAAO,KAAK,KAAK,iBAAiB,KAAK,iBAAiB,KAAK,GAAGA,KAAI;AAAA,IACtE;AAKA,SAAA,aAAa,CAA2C,UAAkB;AACxE,aAAO,KAAK,KAAK,WAAW,KAAK,iBAAiB,KAAK,CAAC;AAAA,IAC1D;AAEA,SAAA,oBAAoB,CAAC,UACnB,KAAK,KAAK,kBAAkB,KAAK;AA7Q7B,QAAA,KAAK,gBAAgB,eAAe;AACtC,YAAM,QAAQ,KAAK;AACnB,WAAK,OAAO,MAAM;AAId,UAAA,OAAO,KAAK,WAAW,UAAU;AACnC,aAAK,YAAY,MAAM,iBAAiB,KAAK,MAAM;AAAA,MAAA,OAC9C;AAEL,cAAM,SAAS;AAAA,UACb,GAAI,KAAK;AAAA,QACX;AACA,mBAAW,OAAO,QAAQ;AACxB,iBAAO,GAAG,IAAI,MAAM,iBAAiB,OAAO,GAAG,CAAC;AAAA,QAAA;AAElD,aAAK,YAAY;AAAA,MAAA;AAAA,IACnB,OACK;AACL,WAAK,OAAO,KAAK;AACjB,WAAK,YAAY,KAAK;AAAA,IAAA;AAGnB,SAAA,QAAQ,IAAIC,cAAQ;AAAA,MACvB,MAAM,CAAC,KAAK,KAAK,KAAK;AAAA,MACtB,IAAI,CAAC,EAAE,kBAAkB;AACjB,cAAA,gBAAgB,YAAY,CAAC;AAC/B,YAAA;AACA,YAAA,OAAO,KAAK,cAAc,UAAU;AAEtC,mBAASC,MAAAA,MAAM,cAAc,QAAQ,KAAK,SAAS;AAAA,QAAA,OAC9C;AAEL,mBAAS,CAAC;AACV,gBAAM,SAAgD,KACnD;AACH,qBAAW,OAAO,QAAQ;AACxB,mBAAO,GAAG,IAAIA,MAAA,MAAM,cAAc,QAAQ,OAAO,GAAG,CAAC;AAAA,UAAA;AAAA,QACvD;AAGK,eAAA;AAAA,UACL;AAAA,QACF;AAAA,MAAA;AAAA,IACF,CACD;AAAA,EAAA;AAAA,EApEH,IAAI,QAAQ;AACV,WAAO,KAAK,MAAM;AAAA,EAAA;AAAA,EA+GpB,MAAM,aAAa,YAAyC;AAEnD,WAAA,KAAK,KAAK,aAAa,UAAiB;AAAA,EAAA;AAmLnD;;"}

package/dist/cjs/FieldGroupApi.d.cts

@@ -0,0 +1,116 @@
+import { Derived } from '@tanstack/store';
+import { Updater } from './utils.cjs';
+import { FormApi, FormAsyncValidateOrFn, FormValidateOrFn } from './FormApi.cjs';
+import { AnyFieldMeta, AnyFieldMetaBase } from './FieldApi.cjs';
+import { DeepKeys, DeepKeysOfType, DeepValue, FieldsMap } from './util-types.cjs';
+import { FieldManipulator, UpdateMetaOptions, ValidationCause } from './types.cjs';
+export type AnyFieldGroupApi = FieldGroupApi<any, any, any, any, any, any, any, any, any, any, any, any>;
+export interface FieldGroupState<in out TFieldGroupData> {
+    /**
+     * The current values of the field group
+     */
+    values: TFieldGroupData;
+}
+/**
+ * An object representing the options for a field group.
+ */
+export interface FieldGroupOptions<in out TFormData, in out TFieldGroupData, in out TFields extends DeepKeysOfType<TFormData, TFieldGroupData | null | undefined> | FieldsMap<TFormData, TFieldGroupData>, in out TOnMount extends undefined | FormValidateOrFn<TFormData>, in out TOnChange extends undefined | FormValidateOrFn<TFormData>, in out TOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFormData>, in out TOnBlur extends undefined | FormValidateOrFn<TFormData>, in out TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>, in out TOnSubmit extends undefined | FormValidateOrFn<TFormData>, in out TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>, in out TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>, in out TSubmitMeta = never> {
+    form: FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta> | FieldGroupApi<any, TFormData, any, any, any, any, any, any, any, any, any, TSubmitMeta>;
+    /**
+     * The path to the field group data.
+     */
+    fields: TFields;
+    /**
+     * The expected subsetValues that the form must provide.
+     */
+    defaultValues?: TFieldGroupData;
+    /**
+     * onSubmitMeta, the data passed from the handleSubmit handler, to the onSubmit function props
+     */
+    onSubmitMeta?: TSubmitMeta;
+}
+export declare class FieldGroupApi<in out TFormData, in out TFieldGroupData, in out TFields extends DeepKeysOfType<TFormData, TFieldGroupData | null | undefined> | FieldsMap<TFormData, TFieldGroupData>, in out TOnMount extends undefined | FormValidateOrFn<TFormData>, in out TOnChange extends undefined | FormValidateOrFn<TFormData>, in out TOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFormData>, in out TOnBlur extends undefined | FormValidateOrFn<TFormData>, in out TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>, in out TOnSubmit extends undefined | FormValidateOrFn<TFormData>, in out TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>, in out TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>, in out TSubmitMeta = never> implements FieldManipulator<TFieldGroupData, TSubmitMeta> {
+    /**
+     * The form that called this field group.
+     */
+    readonly form: FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta>;
+    readonly fieldsMap: TFields;
+    /**
+     * Get the true name of the field. Not required within `Field` or `AppField`.
+     * @private
+     */
+    getFormFieldName: <TField extends DeepKeys<TFieldGroupData>>(subfield: TField) => DeepKeys<TFormData>;
+    store: Derived<FieldGroupState<TFieldGroupData>>;
+    get state(): FieldGroupState<TFieldGroupData>;
+    /**
+     * Constructs a new `FieldGroupApi` instance with the given form options.
+     */
+    constructor(opts: FieldGroupOptions<TFormData, TFieldGroupData, TFields, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta>);
+    /**
+     * Mounts the field group instance to listen to value changes.
+     */
+    mount: () => () => void;
+    /**
+     * Validates the children of a specified array in the form starting from a given index until the end using the correct handlers for a given validation type.
+     */
+    validateArrayFieldsStartingFrom: <TField extends DeepKeysOfType<TFieldGroupData, any[]>>(field: TField, index: number, cause: ValidationCause) => Promise<unknown[]>;
+    /**
+     * Validates a specified field in the form using the correct handlers for a given validation type.
+     */
+    validateField: <TField extends DeepKeys<TFieldGroupData>>(field: TField, cause: ValidationCause) => unknown[] | Promise<unknown[]>;
+    /**
+     * Handles the form submission, performs validation, and calls the appropriate onSubmit or onSubmitInvalid callbacks.
+     */
+    handleSubmit(): Promise<void>;
+    handleSubmit(submitMeta: TSubmitMeta): Promise<void>;
+    /**
+     * Gets the value of the specified field.
+     */
+    getFieldValue: <TField extends DeepKeys<TFieldGroupData>>(field: TField) => DeepValue<TFieldGroupData, TField>;
+    /**
+     * Gets the metadata of the specified field.
+     */
+    getFieldMeta: <TField extends DeepKeys<TFieldGroupData>>(field: TField) => AnyFieldMeta | undefined;
+    /**
+     * Updates the metadata of the specified field.
+     */
+    setFieldMeta: <TField extends DeepKeys<TFieldGroupData>>(field: TField, updater: Updater<AnyFieldMetaBase>) => void;
+    /**
+     * Sets the value of the specified field and optionally updates the touched state.
+     */
+    setFieldValue: <TField extends DeepKeys<TFieldGroupData>>(field: TField, updater: Updater<DeepValue<TFieldGroupData, TField>>, opts?: UpdateMetaOptions) => void;
+    /**
+     * Delete a field and its subfields.
+     */
+    deleteField: <TField extends DeepKeys<TFieldGroupData>>(field: TField) => void;
+    /**
+     * Pushes a value into an array field.
+     */
+    pushFieldValue: <TField extends DeepKeysOfType<TFieldGroupData, any[]>>(field: TField, value: DeepValue<TFieldGroupData, TField> extends any[] ? DeepValue<TFieldGroupData, TField>[number] : never, opts?: UpdateMetaOptions) => void;
+    /**
+     * Insert a value into an array field at the specified index.
+     */
+    insertFieldValue: <TField extends DeepKeysOfType<TFieldGroupData, any[]>>(field: TField, index: number, value: DeepValue<TFieldGroupData, TField> extends any[] ? DeepValue<TFieldGroupData, TField>[number] : never, opts?: UpdateMetaOptions) => Promise<void>;
+    /**
+     * Replaces a value into an array field at the specified index.
+     */
+    replaceFieldValue: <TField extends DeepKeysOfType<TFieldGroupData, any[]>>(field: TField, index: number, value: DeepValue<TFieldGroupData, TField> extends any[] ? DeepValue<TFieldGroupData, TField>[number] : never, opts?: UpdateMetaOptions) => Promise<void>;
+    /**
+     * Removes a value from an array field at the specified index.
+     */
+    removeFieldValue: <TField extends DeepKeysOfType<TFieldGroupData, any[]>>(field: TField, index: number, opts?: UpdateMetaOptions) => Promise<void>;
+    /**
+     * Swaps the values at the specified indices within an array field.
+     */
+    swapFieldValues: <TField extends DeepKeysOfType<TFieldGroupData, any[]>>(field: TField, index1: number, index2: number, opts?: UpdateMetaOptions) => void;
+    /**
+     * Moves the value at the first specified index to the second specified index within an array field.
+     */
+    moveFieldValues: <TField extends DeepKeysOfType<TFieldGroupData, any[]>>(field: TField, index1: number, index2: number, opts?: UpdateMetaOptions) => void;
+    clearFieldValues: <TField extends DeepKeysOfType<TFieldGroupData, any[]>>(field: TField, opts?: UpdateMetaOptions) => void;
+    /**
+     * Resets the field value and meta to default state
+     */
+    resetField: <TField extends DeepKeys<TFieldGroupData>>(field: TField) => void;
+    validateAllFields: (cause: ValidationCause) => Promise<unknown[]>;
+}