@tanstack/react-form 0.3.1 → 0.3.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (77) hide show
  1. package/build/legacy/createFormFactory.cjs +42 -0
  2. package/build/legacy/createFormFactory.cjs.map +1 -0
  3. package/build/legacy/createFormFactory.d.cts +12 -0
  4. package/build/legacy/createFormFactory.d.ts +12 -0
  5. package/build/legacy/createFormFactory.js +17 -0
  6. package/build/legacy/createFormFactory.js.map +1 -0
  7. package/build/legacy/formContext.cjs +51 -0
  8. package/build/legacy/formContext.cjs.map +1 -0
  9. package/build/legacy/formContext.d.cts +13 -0
  10. package/build/legacy/formContext.d.ts +13 -0
  11. package/build/legacy/formContext.js +15 -0
  12. package/build/legacy/formContext.js.map +1 -0
  13. package/build/legacy/index.cjs +46 -0
  14. package/build/legacy/index.cjs.map +1 -0
  15. package/build/legacy/index.d.cts +7 -0
  16. package/build/legacy/index.d.ts +7 -0
  17. package/build/legacy/index.js +15 -0
  18. package/build/legacy/index.js.map +1 -0
  19. package/build/legacy/types.cjs +19 -0
  20. package/build/legacy/types.cjs.map +1 -0
  21. package/build/legacy/types.d.cts +7 -0
  22. package/build/legacy/types.d.ts +7 -0
  23. package/build/legacy/types.js +1 -0
  24. package/build/legacy/types.js.map +1 -0
  25. package/build/legacy/useField.cjs +84 -0
  26. package/build/legacy/useField.cjs.map +1 -0
  27. package/build/legacy/useField.d.cts +29 -0
  28. package/build/legacy/useField.d.ts +29 -0
  29. package/build/legacy/useField.js +48 -0
  30. package/build/legacy/useField.js.map +1 -0
  31. package/build/legacy/useForm.cjs +72 -0
  32. package/build/legacy/useForm.cjs.map +1 -0
  33. package/build/legacy/useForm.d.cts +23 -0
  34. package/build/legacy/useForm.d.ts +23 -0
  35. package/build/legacy/useForm.js +37 -0
  36. package/build/legacy/useForm.js.map +1 -0
  37. package/build/modern/createFormFactory.cjs +42 -0
  38. package/build/modern/createFormFactory.cjs.map +1 -0
  39. package/build/modern/createFormFactory.d.cts +12 -0
  40. package/build/modern/createFormFactory.d.ts +12 -0
  41. package/build/modern/createFormFactory.js +17 -0
  42. package/build/modern/createFormFactory.js.map +1 -0
  43. package/build/modern/formContext.cjs +51 -0
  44. package/build/modern/formContext.cjs.map +1 -0
  45. package/build/modern/formContext.d.cts +13 -0
  46. package/build/modern/formContext.d.ts +13 -0
  47. package/build/modern/formContext.js +15 -0
  48. package/build/modern/formContext.js.map +1 -0
  49. package/build/modern/index.cjs +46 -0
  50. package/build/modern/index.cjs.map +1 -0
  51. package/build/modern/index.d.cts +7 -0
  52. package/build/modern/index.d.ts +7 -0
  53. package/build/modern/index.js +15 -0
  54. package/build/modern/index.js.map +1 -0
  55. package/build/modern/types.cjs +19 -0
  56. package/build/modern/types.cjs.map +1 -0
  57. package/build/modern/types.d.cts +7 -0
  58. package/build/modern/types.d.ts +7 -0
  59. package/build/modern/types.js +1 -0
  60. package/build/modern/types.js.map +1 -0
  61. package/build/modern/useField.cjs +84 -0
  62. package/build/modern/useField.cjs.map +1 -0
  63. package/build/modern/useField.d.cts +29 -0
  64. package/build/modern/useField.d.ts +29 -0
  65. package/build/modern/useField.js +48 -0
  66. package/build/modern/useField.js.map +1 -0
  67. package/build/modern/useForm.cjs +72 -0
  68. package/build/modern/useForm.cjs.map +1 -0
  69. package/build/modern/useForm.d.cts +23 -0
  70. package/build/modern/useForm.d.ts +23 -0
  71. package/build/modern/useForm.js +37 -0
  72. package/build/modern/useForm.js.map +1 -0
  73. package/package.json +2 -2
  74. package/src/tests/useField.test-d.tsx +63 -0
  75. package/src/types.ts +5 -4
  76. package/src/useField.tsx +60 -60
  77. package/src/useForm.tsx +3 -4
@@ -0,0 +1,48 @@
1
+ // src/useField.tsx
2
+ import React, { useState } from "react";
3
+ import { useStore } from "@tanstack/react-store";
4
+ import { FieldApi, functionalUpdate } from "@tanstack/form-core";
5
+ import { useFormContext, formContext } from "./formContext.js";
6
+ import useIsomorphicLayoutEffect from "use-isomorphic-layout-effect";
7
+ function useField(opts) {
8
+ const { formApi, parentFieldName } = useFormContext();
9
+ const [fieldApi] = useState(() => {
10
+ const name = (typeof opts.index === "number" ? [parentFieldName, opts.index, opts.name] : [parentFieldName, opts.name]).filter((d) => d !== void 0).join(".");
11
+ const api = new FieldApi({
12
+ ...opts,
13
+ form: formApi,
14
+ name
15
+ });
16
+ api.Field = Field;
17
+ return api;
18
+ });
19
+ useIsomorphicLayoutEffect(() => {
20
+ fieldApi.update({ ...opts, form: formApi });
21
+ });
22
+ useStore(
23
+ fieldApi.store,
24
+ opts.mode === "array" ? (state) => {
25
+ return [state.meta, Object.keys(state.value || []).length];
26
+ } : void 0
27
+ );
28
+ useIsomorphicLayoutEffect(() => fieldApi.mount(), [fieldApi]);
29
+ return fieldApi;
30
+ }
31
+ function Field({
32
+ children,
33
+ ...fieldOptions
34
+ }) {
35
+ const fieldApi = useField(fieldOptions);
36
+ return /* @__PURE__ */ React.createElement(
37
+ formContext.Provider,
38
+ {
39
+ value: { formApi: fieldApi.form, parentFieldName: fieldApi.name },
40
+ children: functionalUpdate(children, fieldApi)
41
+ }
42
+ );
43
+ }
44
+ export {
45
+ Field,
46
+ useField
47
+ };
48
+ //# sourceMappingURL=useField.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../src/useField.tsx"],"sourcesContent":["import React, { useState } from 'react'\nimport { useStore } from '@tanstack/react-store'\nimport type {\n DeepKeys,\n DeepValue,\n FieldApiOptions,\n Narrow,\n} from '@tanstack/form-core'\nimport { FieldApi, type FormApi, functionalUpdate } from '@tanstack/form-core'\nimport { useFormContext, formContext } from './formContext'\nimport useIsomorphicLayoutEffect from 'use-isomorphic-layout-effect'\nimport type { UseFieldOptions } from './types'\n\ndeclare module '@tanstack/form-core' {\n // eslint-disable-next-line no-shadow\n interface FieldApi<_TData, TFormData, Opts, TData> {\n Field: FieldComponent<TData, TFormData>\n }\n}\n\nexport type UseField<TFormData> = <TField extends DeepKeys<TFormData>>(\n opts?: { name: Narrow<TField> } & UseFieldOptions<\n DeepValue<TFormData, TField>,\n TFormData\n >,\n) => FieldApi<DeepValue<TFormData, TField>, TFormData>\n\nexport function useField<\n TData,\n TFormData,\n TName extends unknown extends TFormData\n ? string\n : DeepKeys<TFormData> = unknown extends TFormData\n ? string\n : DeepKeys<TFormData>,\n>(\n opts: UseFieldOptions<TData, TFormData, TName>,\n): FieldApi<\n TData,\n TFormData,\n Omit<typeof opts, 'onMount'> & {\n form: FormApi<TFormData>\n }\n> {\n // Get the form API either manually or from context\n const { formApi, parentFieldName } = useFormContext()\n\n const [fieldApi] = useState(() => {\n const name = (\n typeof opts.index === 'number'\n ? [parentFieldName, opts.index, opts.name]\n : [parentFieldName, opts.name]\n )\n .filter((d) => d !== undefined)\n .join('.')\n\n const api = new FieldApi({\n ...opts,\n form: formApi,\n name: name,\n } as never)\n\n api.Field = Field as never\n\n return api\n })\n\n /**\n * fieldApi.update should not have any side effects. Think of it like a `useRef`\n * that we need to keep updated every render with the most up-to-date information.\n */\n useIsomorphicLayoutEffect(() => {\n fieldApi.update({ ...opts, form: formApi } as never)\n })\n\n useStore(\n fieldApi.store,\n opts.mode === 'array'\n ? (state: any) => {\n return [state.meta, Object.keys(state.value || []).length]\n }\n : undefined,\n )\n // Instantiates field meta and removes it when unrendered\n useIsomorphicLayoutEffect(() => fieldApi.mount(), [fieldApi])\n\n return fieldApi as never\n}\n\ntype FieldComponentProps<\n TParentData,\n TFormData,\n TField,\n TName extends unknown extends TFormData ? string : DeepKeys<TFormData>,\n> = {\n children: (\n fieldApi: FieldApi<\n TField,\n TFormData,\n FieldApiOptions<TField, TFormData, TName>\n >,\n ) => any\n} & (TParentData extends any[]\n ? {\n name?: TName\n index: number\n }\n : {\n name: TName\n index?: never\n }) &\n Omit<UseFieldOptions<TField, TFormData, TName>, 'name' | 'index'>\n\nexport type FieldComponent<TParentData, TFormData> = <\n // Type of the field\n TField,\n // Name of the field\n TName extends unknown extends TFormData ? string : DeepKeys<TFormData>,\n>({\n children,\n ...fieldOptions\n}: FieldComponentProps<TParentData, TFormData, TField, TName>) => any\n\nexport function Field<TData, TFormData>({\n children,\n ...fieldOptions\n}: {\n children: (fieldApi: FieldApi<TData, TFormData>) => any\n} & UseFieldOptions<TData, TFormData>) {\n const fieldApi = useField(fieldOptions as any)\n\n return (\n <formContext.Provider\n value={{ formApi: fieldApi.form, parentFieldName: fieldApi.name }}\n children={functionalUpdate(children, fieldApi as any)}\n />\n )\n}\n"],"mappings":";AAAA,OAAO,SAAS,gBAAgB;AAChC,SAAS,gBAAgB;AAOzB,SAAS,UAAwB,wBAAwB;AACzD,SAAS,gBAAgB,mBAAmB;AAC5C,OAAO,+BAA+B;AAiB/B,SAAS,SASd,MAOA;AAEA,QAAM,EAAE,SAAS,gBAAgB,IAAI,eAAe;AAEpD,QAAM,CAAC,QAAQ,IAAI,SAAS,MAAM;AAChC,UAAM,QACJ,OAAO,KAAK,UAAU,WAClB,CAAC,iBAAiB,KAAK,OAAO,KAAK,IAAI,IACvC,CAAC,iBAAiB,KAAK,IAAI,GAE9B,OAAO,CAAC,MAAM,MAAM,MAAS,EAC7B,KAAK,GAAG;AAEX,UAAM,MAAM,IAAI,SAAS;AAAA,MACvB,GAAG;AAAA,MACH,MAAM;AAAA,MACN;AAAA,IACF,CAAU;AAEV,QAAI,QAAQ;AAEZ,WAAO;AAAA,EACT,CAAC;AAMD,4BAA0B,MAAM;AAC9B,aAAS,OAAO,EAAE,GAAG,MAAM,MAAM,QAAQ,CAAU;AAAA,EACrD,CAAC;AAED;AAAA,IACE,SAAS;AAAA,IACT,KAAK,SAAS,UACV,CAAC,UAAe;AACd,aAAO,CAAC,MAAM,MAAM,OAAO,KAAK,MAAM,SAAS,CAAC,CAAC,EAAE,MAAM;AAAA,IAC3D,IACA;AAAA,EACN;AAEA,4BAA0B,MAAM,SAAS,MAAM,GAAG,CAAC,QAAQ,CAAC;AAE5D,SAAO;AACT;AAoCO,SAAS,MAAwB;AAAA,EACtC;AAAA,EACA,GAAG;AACL,GAEuC;AACrC,QAAM,WAAW,SAAS,YAAmB;AAE7C,SACE;AAAA,IAAC,YAAY;AAAA,IAAZ;AAAA,MACC,OAAO,EAAE,SAAS,SAAS,MAAM,iBAAiB,SAAS,KAAK;AAAA,MAChE,UAAU,iBAAiB,UAAU,QAAe;AAAA;AAAA,EACtD;AAEJ;","names":[]}
@@ -0,0 +1,72 @@
1
+ "use strict";
2
+ var __create = Object.create;
3
+ var __defProp = Object.defineProperty;
4
+ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
5
+ var __getOwnPropNames = Object.getOwnPropertyNames;
6
+ var __getProtoOf = Object.getPrototypeOf;
7
+ var __hasOwnProp = Object.prototype.hasOwnProperty;
8
+ var __export = (target, all) => {
9
+ for (var name in all)
10
+ __defProp(target, name, { get: all[name], enumerable: true });
11
+ };
12
+ var __copyProps = (to, from, except, desc) => {
13
+ if (from && typeof from === "object" || typeof from === "function") {
14
+ for (let key of __getOwnPropNames(from))
15
+ if (!__hasOwnProp.call(to, key) && key !== except)
16
+ __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
17
+ }
18
+ return to;
19
+ };
20
+ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
21
+ // If the importer is in node compatibility mode or this is not an ESM
22
+ // file that has been converted to a CommonJS file using a Babel-
23
+ // compatible transform (i.e. "__esModule" has not been set), then set
24
+ // "default" to the CommonJS "module.exports" for node compatibility.
25
+ isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
26
+ mod
27
+ ));
28
+ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
29
+
30
+ // src/useForm.tsx
31
+ var useForm_exports = {};
32
+ __export(useForm_exports, {
33
+ useForm: () => useForm
34
+ });
35
+ module.exports = __toCommonJS(useForm_exports);
36
+ var import_form_core = require("@tanstack/form-core");
37
+ var import_react_store = require("@tanstack/react-store");
38
+ var import_react = __toESM(require("react"), 1);
39
+ var import_useField = require("./useField.cjs");
40
+ var import_formContext = require("./formContext.cjs");
41
+ var import_use_isomorphic_layout_effect = __toESM(require("use-isomorphic-layout-effect"), 1);
42
+ function useForm(opts) {
43
+ const [formApi] = (0, import_react.useState)(() => {
44
+ const api = new import_form_core.FormApi(opts);
45
+ api.Provider = function Provider(props) {
46
+ return /* @__PURE__ */ import_react.default.createElement(import_formContext.formContext.Provider, { ...props, value: { formApi: api } });
47
+ };
48
+ api.Field = import_useField.Field;
49
+ api.useField = import_useField.useField;
50
+ api.useStore = (selector) => {
51
+ return (0, import_react_store.useStore)(api.store, selector);
52
+ };
53
+ api.Subscribe = (props) => {
54
+ return (0, import_form_core.functionalUpdate)(
55
+ props.children,
56
+ // eslint-disable-next-line react-hooks/rules-of-hooks
57
+ (0, import_react_store.useStore)(api.store, props.selector)
58
+ );
59
+ };
60
+ return api;
61
+ });
62
+ formApi.useStore((state) => state.isSubmitting);
63
+ (0, import_use_isomorphic_layout_effect.default)(() => {
64
+ formApi.update(opts);
65
+ });
66
+ return formApi;
67
+ }
68
+ // Annotate the CommonJS export names for ESM import in node:
69
+ 0 && (module.exports = {
70
+ useForm
71
+ });
72
+ //# sourceMappingURL=useForm.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../src/useForm.tsx"],"sourcesContent":["import type { FormState, FormOptions } from '@tanstack/form-core'\nimport { FormApi, functionalUpdate } from '@tanstack/form-core'\nimport type { NoInfer } from '@tanstack/react-store'\nimport { useStore } from '@tanstack/react-store'\nimport React, { type ReactNode, useState } from 'react'\nimport { type UseField, type FieldComponent, Field, useField } from './useField'\nimport { formContext } from './formContext'\nimport useIsomorphicLayoutEffect from 'use-isomorphic-layout-effect'\n\ndeclare module '@tanstack/form-core' {\n // eslint-disable-next-line no-shadow\n interface FormApi<TFormData> {\n Provider: (props: { children: any }) => any\n Field: FieldComponent<TFormData, TFormData>\n useField: UseField<TFormData>\n useStore: <TSelected = NoInfer<FormState<TFormData>>>(\n selector?: (state: NoInfer<FormState<TFormData>>) => TSelected,\n ) => TSelected\n Subscribe: <TSelected = NoInfer<FormState<TFormData>>>(props: {\n selector?: (state: NoInfer<FormState<TFormData>>) => TSelected\n children: ((state: NoInfer<TSelected>) => ReactNode) | ReactNode\n }) => any\n }\n}\n\nexport function useForm<TData>(opts?: FormOptions<TData>): FormApi<TData> {\n const [formApi] = useState(() => {\n // @ts-ignore\n const api = new FormApi<TData>(opts)\n\n api.Provider = function Provider(props) {\n return <formContext.Provider {...props} value={{ formApi: api }} />\n }\n api.Field = Field as any\n api.useField = useField as any\n api.useStore = (\n // @ts-ignore\n selector,\n ) => {\n // eslint-disable-next-line react-hooks/rules-of-hooks\n return useStore(api.store as any, selector as any) as any\n }\n api.Subscribe = (\n // @ts-ignore\n props,\n ) => {\n return functionalUpdate(\n props.children,\n // eslint-disable-next-line react-hooks/rules-of-hooks\n useStore(api.store as any, props.selector as any),\n ) as any\n }\n\n return api\n })\n\n formApi.useStore((state) => state.isSubmitting)\n\n /**\n * formApi.update should not have any side effects. Think of it like a `useRef`\n * that we need to keep updated every render with the most up-to-date information.\n */\n useIsomorphicLayoutEffect(() => {\n formApi.update(opts)\n })\n\n return formApi as any\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AACA,uBAA0C;AAE1C,yBAAyB;AACzB,mBAAgD;AAChD,sBAAoE;AACpE,yBAA4B;AAC5B,0CAAsC;AAkB/B,SAAS,QAAe,MAA2C;AACxE,QAAM,CAAC,OAAO,QAAI,uBAAS,MAAM;AAE/B,UAAM,MAAM,IAAI,yBAAe,IAAI;AAEnC,QAAI,WAAW,SAAS,SAAS,OAAO;AACtC,aAAO,6BAAAA,QAAA,cAAC,+BAAY,UAAZ,EAAsB,GAAG,OAAO,OAAO,EAAE,SAAS,IAAI,GAAG;AAAA,IACnE;AACA,QAAI,QAAQ;AACZ,QAAI,WAAW;AACf,QAAI,WAAW,CAEb,aACG;AAEH,iBAAO,6BAAS,IAAI,OAAc,QAAe;AAAA,IACnD;AACA,QAAI,YAAY,CAEd,UACG;AACH,iBAAO;AAAA,QACL,MAAM;AAAA;AAAA,YAEN,6BAAS,IAAI,OAAc,MAAM,QAAe;AAAA,MAClD;AAAA,IACF;AAEA,WAAO;AAAA,EACT,CAAC;AAED,UAAQ,SAAS,CAAC,UAAU,MAAM,YAAY;AAM9C,0CAAAC,SAA0B,MAAM;AAC9B,YAAQ,OAAO,IAAI;AAAA,EACrB,CAAC;AAED,SAAO;AACT;","names":["React","useIsomorphicLayoutEffect"]}
@@ -0,0 +1,23 @@
1
+ import { FormState, FormOptions, FormApi } from '@tanstack/form-core';
2
+ import { NoInfer } from '@tanstack/react-store';
3
+ import { ReactNode } from 'react';
4
+ import { FieldComponent, UseField } from './useField.cjs';
5
+ import './types.cjs';
6
+
7
+ declare module '@tanstack/form-core' {
8
+ interface FormApi<TFormData> {
9
+ Provider: (props: {
10
+ children: any;
11
+ }) => any;
12
+ Field: FieldComponent<TFormData, TFormData>;
13
+ useField: UseField<TFormData>;
14
+ useStore: <TSelected = NoInfer<FormState<TFormData>>>(selector?: (state: NoInfer<FormState<TFormData>>) => TSelected) => TSelected;
15
+ Subscribe: <TSelected = NoInfer<FormState<TFormData>>>(props: {
16
+ selector?: (state: NoInfer<FormState<TFormData>>) => TSelected;
17
+ children: ((state: NoInfer<TSelected>) => ReactNode) | ReactNode;
18
+ }) => any;
19
+ }
20
+ }
21
+ declare function useForm<TData>(opts?: FormOptions<TData>): FormApi<TData>;
22
+
23
+ export { useForm };
@@ -0,0 +1,23 @@
1
+ import { FormState, FormOptions, FormApi } from '@tanstack/form-core';
2
+ import { NoInfer } from '@tanstack/react-store';
3
+ import { ReactNode } from 'react';
4
+ import { FieldComponent, UseField } from './useField.js';
5
+ import './types.js';
6
+
7
+ declare module '@tanstack/form-core' {
8
+ interface FormApi<TFormData> {
9
+ Provider: (props: {
10
+ children: any;
11
+ }) => any;
12
+ Field: FieldComponent<TFormData, TFormData>;
13
+ useField: UseField<TFormData>;
14
+ useStore: <TSelected = NoInfer<FormState<TFormData>>>(selector?: (state: NoInfer<FormState<TFormData>>) => TSelected) => TSelected;
15
+ Subscribe: <TSelected = NoInfer<FormState<TFormData>>>(props: {
16
+ selector?: (state: NoInfer<FormState<TFormData>>) => TSelected;
17
+ children: ((state: NoInfer<TSelected>) => ReactNode) | ReactNode;
18
+ }) => any;
19
+ }
20
+ }
21
+ declare function useForm<TData>(opts?: FormOptions<TData>): FormApi<TData>;
22
+
23
+ export { useForm };
@@ -0,0 +1,37 @@
1
+ // src/useForm.tsx
2
+ import { FormApi, functionalUpdate } from "@tanstack/form-core";
3
+ import { useStore } from "@tanstack/react-store";
4
+ import React, { useState } from "react";
5
+ import { Field, useField } from "./useField.js";
6
+ import { formContext } from "./formContext.js";
7
+ import useIsomorphicLayoutEffect from "use-isomorphic-layout-effect";
8
+ function useForm(opts) {
9
+ const [formApi] = useState(() => {
10
+ const api = new FormApi(opts);
11
+ api.Provider = function Provider(props) {
12
+ return /* @__PURE__ */ React.createElement(formContext.Provider, { ...props, value: { formApi: api } });
13
+ };
14
+ api.Field = Field;
15
+ api.useField = useField;
16
+ api.useStore = (selector) => {
17
+ return useStore(api.store, selector);
18
+ };
19
+ api.Subscribe = (props) => {
20
+ return functionalUpdate(
21
+ props.children,
22
+ // eslint-disable-next-line react-hooks/rules-of-hooks
23
+ useStore(api.store, props.selector)
24
+ );
25
+ };
26
+ return api;
27
+ });
28
+ formApi.useStore((state) => state.isSubmitting);
29
+ useIsomorphicLayoutEffect(() => {
30
+ formApi.update(opts);
31
+ });
32
+ return formApi;
33
+ }
34
+ export {
35
+ useForm
36
+ };
37
+ //# sourceMappingURL=useForm.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../src/useForm.tsx"],"sourcesContent":["import type { FormState, FormOptions } from '@tanstack/form-core'\nimport { FormApi, functionalUpdate } from '@tanstack/form-core'\nimport type { NoInfer } from '@tanstack/react-store'\nimport { useStore } from '@tanstack/react-store'\nimport React, { type ReactNode, useState } from 'react'\nimport { type UseField, type FieldComponent, Field, useField } from './useField'\nimport { formContext } from './formContext'\nimport useIsomorphicLayoutEffect from 'use-isomorphic-layout-effect'\n\ndeclare module '@tanstack/form-core' {\n // eslint-disable-next-line no-shadow\n interface FormApi<TFormData> {\n Provider: (props: { children: any }) => any\n Field: FieldComponent<TFormData, TFormData>\n useField: UseField<TFormData>\n useStore: <TSelected = NoInfer<FormState<TFormData>>>(\n selector?: (state: NoInfer<FormState<TFormData>>) => TSelected,\n ) => TSelected\n Subscribe: <TSelected = NoInfer<FormState<TFormData>>>(props: {\n selector?: (state: NoInfer<FormState<TFormData>>) => TSelected\n children: ((state: NoInfer<TSelected>) => ReactNode) | ReactNode\n }) => any\n }\n}\n\nexport function useForm<TData>(opts?: FormOptions<TData>): FormApi<TData> {\n const [formApi] = useState(() => {\n // @ts-ignore\n const api = new FormApi<TData>(opts)\n\n api.Provider = function Provider(props) {\n return <formContext.Provider {...props} value={{ formApi: api }} />\n }\n api.Field = Field as any\n api.useField = useField as any\n api.useStore = (\n // @ts-ignore\n selector,\n ) => {\n // eslint-disable-next-line react-hooks/rules-of-hooks\n return useStore(api.store as any, selector as any) as any\n }\n api.Subscribe = (\n // @ts-ignore\n props,\n ) => {\n return functionalUpdate(\n props.children,\n // eslint-disable-next-line react-hooks/rules-of-hooks\n useStore(api.store as any, props.selector as any),\n ) as any\n }\n\n return api\n })\n\n formApi.useStore((state) => state.isSubmitting)\n\n /**\n * formApi.update should not have any side effects. Think of it like a `useRef`\n * that we need to keep updated every render with the most up-to-date information.\n */\n useIsomorphicLayoutEffect(() => {\n formApi.update(opts)\n })\n\n return formApi as any\n}\n"],"mappings":";AACA,SAAS,SAAS,wBAAwB;AAE1C,SAAS,gBAAgB;AACzB,OAAO,SAAyB,gBAAgB;AAChD,SAA6C,OAAO,gBAAgB;AACpE,SAAS,mBAAmB;AAC5B,OAAO,+BAA+B;AAkB/B,SAAS,QAAe,MAA2C;AACxE,QAAM,CAAC,OAAO,IAAI,SAAS,MAAM;AAE/B,UAAM,MAAM,IAAI,QAAe,IAAI;AAEnC,QAAI,WAAW,SAAS,SAAS,OAAO;AACtC,aAAO,oCAAC,YAAY,UAAZ,EAAsB,GAAG,OAAO,OAAO,EAAE,SAAS,IAAI,GAAG;AAAA,IACnE;AACA,QAAI,QAAQ;AACZ,QAAI,WAAW;AACf,QAAI,WAAW,CAEb,aACG;AAEH,aAAO,SAAS,IAAI,OAAc,QAAe;AAAA,IACnD;AACA,QAAI,YAAY,CAEd,UACG;AACH,aAAO;AAAA,QACL,MAAM;AAAA;AAAA,QAEN,SAAS,IAAI,OAAc,MAAM,QAAe;AAAA,MAClD;AAAA,IACF;AAEA,WAAO;AAAA,EACT,CAAC;AAED,UAAQ,SAAS,CAAC,UAAU,MAAM,YAAY;AAM9C,4BAA0B,MAAM;AAC9B,YAAQ,OAAO,IAAI;AAAA,EACrB,CAAC;AAED,SAAO;AACT;","names":[]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tanstack/react-form",
3
- "version": "0.3.1",
3
+ "version": "0.3.3",
4
4
  "description": "Powerful, type-safe forms for React.",
5
5
  "author": "tannerlinsley",
6
6
  "license": "MIT",
@@ -54,7 +54,7 @@
54
54
  "@tanstack/react-store": "0.1.3",
55
55
  "@tanstack/store": "0.1.3",
56
56
  "use-isomorphic-layout-effect": "^1.1.2",
57
- "@tanstack/form-core": "0.3.1"
57
+ "@tanstack/form-core": "0.3.3"
58
58
  },
59
59
  "peerDependencies": {
60
60
  "react": "^17.0.0 || ^18.0.0",
@@ -0,0 +1,63 @@
1
+ import { assertType } from 'vitest'
2
+ import * as React from 'react'
3
+ import { useForm } from '../useForm'
4
+
5
+ it('should type state.value properly', () => {
6
+ function Comp() {
7
+ const form = useForm({
8
+ defaultValues: {
9
+ firstName: 'test',
10
+ age: 84,
11
+ },
12
+ } as const)
13
+
14
+ return (
15
+ <form.Provider>
16
+ <form.Field
17
+ name="firstName"
18
+ children={(field) => {
19
+ assertType<'test'>(field.state.value)
20
+ }}
21
+ />
22
+ <form.Field
23
+ name="age"
24
+ children={(field) => {
25
+ assertType<84>(field.state.value)
26
+ }}
27
+ />
28
+ </form.Provider>
29
+ )
30
+ }
31
+ })
32
+
33
+ it('should type onChange properly', () => {
34
+ function Comp() {
35
+ const form = useForm({
36
+ defaultValues: {
37
+ firstName: 'test',
38
+ age: 84,
39
+ },
40
+ } as const)
41
+
42
+ return (
43
+ <form.Provider>
44
+ <form.Field
45
+ name="firstName"
46
+ onChange={(val) => {
47
+ assertType<'test'>(val)
48
+ return null
49
+ }}
50
+ children={(field) => null}
51
+ />
52
+ <form.Field
53
+ name="age"
54
+ onChange={(val) => {
55
+ assertType<84>(val)
56
+ return null
57
+ }}
58
+ children={(field) => null}
59
+ />
60
+ </form.Provider>
61
+ )
62
+ }
63
+ })
package/src/types.ts CHANGED
@@ -1,8 +1,9 @@
1
- import type { FieldOptions } from '@tanstack/form-core'
1
+ import type { FieldOptions, DeepKeys } from '@tanstack/form-core'
2
2
 
3
- export type UseFieldOptions<TData, TFormData> = FieldOptions<
3
+ export type UseFieldOptions<
4
4
  TData,
5
- TFormData
6
- > & {
5
+ TFormData,
6
+ TName = unknown extends TFormData ? string : DeepKeys<TFormData>,
7
+ > = FieldOptions<TData, TFormData, TName> & {
7
8
  mode?: 'value' | 'array'
8
9
  }
package/src/useField.tsx CHANGED
@@ -3,17 +3,17 @@ import { useStore } from '@tanstack/react-store'
3
3
  import type {
4
4
  DeepKeys,
5
5
  DeepValue,
6
- FieldOptions,
6
+ FieldApiOptions,
7
7
  Narrow,
8
8
  } from '@tanstack/form-core'
9
- import { FieldApi, functionalUpdate } from '@tanstack/form-core'
9
+ import { FieldApi, type FormApi, functionalUpdate } from '@tanstack/form-core'
10
10
  import { useFormContext, formContext } from './formContext'
11
11
  import useIsomorphicLayoutEffect from 'use-isomorphic-layout-effect'
12
12
  import type { UseFieldOptions } from './types'
13
13
 
14
14
  declare module '@tanstack/form-core' {
15
15
  // eslint-disable-next-line no-shadow
16
- interface FieldApi<TData, TFormData> {
16
+ interface FieldApi<_TData, TFormData, Opts, TData> {
17
17
  Field: FieldComponent<TData, TFormData>
18
18
  }
19
19
  }
@@ -25,13 +25,27 @@ export type UseField<TFormData> = <TField extends DeepKeys<TFormData>>(
25
25
  >,
26
26
  ) => FieldApi<DeepValue<TFormData, TField>, TFormData>
27
27
 
28
- export function useField<TData, TFormData>(
29
- opts: UseFieldOptions<TData, TFormData>,
30
- ): FieldApi<TData, TFormData> {
28
+ export function useField<
29
+ TData,
30
+ TFormData,
31
+ TName extends unknown extends TFormData
32
+ ? string
33
+ : DeepKeys<TFormData> = unknown extends TFormData
34
+ ? string
35
+ : DeepKeys<TFormData>,
36
+ >(
37
+ opts: UseFieldOptions<TData, TFormData, TName>,
38
+ ): FieldApi<
39
+ TData,
40
+ TFormData,
41
+ Omit<typeof opts, 'onMount'> & {
42
+ form: FormApi<TFormData>
43
+ }
44
+ > {
31
45
  // Get the form API either manually or from context
32
46
  const { formApi, parentFieldName } = useFormContext()
33
47
 
34
- const [fieldApi] = useState<FieldApi<TData, TFormData>>(() => {
48
+ const [fieldApi] = useState(() => {
35
49
  const name = (
36
50
  typeof opts.index === 'number'
37
51
  ? [parentFieldName, opts.index, opts.name]
@@ -40,9 +54,13 @@ export function useField<TData, TFormData>(
40
54
  .filter((d) => d !== undefined)
41
55
  .join('.')
42
56
 
43
- const api = new FieldApi({ ...opts, form: formApi, name: name as any })
57
+ const api = new FieldApi({
58
+ ...opts,
59
+ form: formApi,
60
+ name: name,
61
+ } as never)
44
62
 
45
- api.Field = Field as any
63
+ api.Field = Field as never
46
64
 
47
65
  return api
48
66
  })
@@ -56,70 +74,52 @@ export function useField<TData, TFormData>(
56
74
  })
57
75
 
58
76
  useStore(
59
- fieldApi.store as any,
77
+ fieldApi.store,
60
78
  opts.mode === 'array'
61
79
  ? (state: any) => {
62
80
  return [state.meta, Object.keys(state.value || []).length]
63
81
  }
64
82
  : undefined,
65
83
  )
66
-
67
84
  // Instantiates field meta and removes it when unrendered
68
85
  useIsomorphicLayoutEffect(() => fieldApi.mount(), [fieldApi])
69
86
 
70
- return fieldApi
87
+ return fieldApi as never
71
88
  }
72
89
 
73
- // export type FieldValue<TFormData, TField> = TFormData extends any[]
74
- // ? TField extends `[${infer TIndex extends number | 'i'}].${infer TRest}`
75
- // ? DeepValue<TFormData[TIndex extends 'i' ? number : TIndex], TRest>
76
- // : TField extends `[${infer TIndex extends number | 'i'}]`
77
- // ? TFormData[TIndex extends 'i' ? number : TIndex]
78
- // : never
79
- // : TField extends `${infer TPrefix}[${infer TIndex extends
80
- // | number
81
- // | 'i'}].${infer TRest}`
82
- // ? DeepValue<
83
- // DeepValue<TFormData, TPrefix>[TIndex extends 'i' ? number : TIndex],
84
- // TRest
85
- // >
86
- // : TField extends `${infer TPrefix}[${infer TIndex extends number | 'i'}]`
87
- // ? DeepValue<TFormData, TPrefix>[TIndex extends 'i' ? number : TIndex]
88
- // : DeepValue<TFormData, TField>
89
-
90
- export type FieldValue<TFormData, TField> = TFormData extends any[]
91
- ? unknown extends TField
92
- ? TFormData[number]
93
- : DeepValue<TFormData[number], TField>
94
- : DeepValue<TFormData, TField>
95
-
96
- // type Test1 = FieldValue<{ foo: { bar: string }[] }, 'foo'>
97
- // // ^?
98
- // type Test2 = FieldValue<{ foo: { bar: string }[] }, 'foo[i]'>
99
- // // ^?
100
- // type Test3 = FieldValue<{ foo: { bar: string }[] }, 'foo[2].bar'>
101
- // // ^?
102
-
103
- export type FieldComponent<TParentData, TFormData> = <TField>({
104
- children,
105
- ...fieldOptions
106
- }: {
90
+ type FieldComponentProps<
91
+ TParentData,
92
+ TFormData,
93
+ TField,
94
+ TName extends unknown extends TFormData ? string : DeepKeys<TFormData>,
95
+ > = {
107
96
  children: (
108
- fieldApi: FieldApi<FieldValue<TParentData, TField>, TFormData>,
97
+ fieldApi: FieldApi<
98
+ TField,
99
+ TFormData,
100
+ FieldApiOptions<TField, TFormData, TName>
101
+ >,
109
102
  ) => any
110
- } & Omit<
111
- UseFieldOptions<FieldValue<TParentData, TField>, TFormData>,
112
- 'name' | 'index'
113
- > &
114
- (TParentData extends any[]
115
- ? {
116
- name?: TField extends undefined ? TField : DeepKeys<TParentData>
117
- index: number
118
- }
119
- : {
120
- name: TField extends undefined ? TField : DeepKeys<TParentData>
121
- index?: never
122
- })) => any
103
+ } & (TParentData extends any[]
104
+ ? {
105
+ name?: TName
106
+ index: number
107
+ }
108
+ : {
109
+ name: TName
110
+ index?: never
111
+ }) &
112
+ Omit<UseFieldOptions<TField, TFormData, TName>, 'name' | 'index'>
113
+
114
+ export type FieldComponent<TParentData, TFormData> = <
115
+ // Type of the field
116
+ TField,
117
+ // Name of the field
118
+ TName extends unknown extends TFormData ? string : DeepKeys<TFormData>,
119
+ >({
120
+ children,
121
+ ...fieldOptions
122
+ }: FieldComponentProps<TParentData, TFormData, TField, TName>) => any
123
123
 
124
124
  export function Field<TData, TFormData>({
125
125
  children,
package/src/useForm.tsx CHANGED
@@ -28,10 +28,9 @@ export function useForm<TData>(opts?: FormOptions<TData>): FormApi<TData> {
28
28
  // @ts-ignore
29
29
  const api = new FormApi<TData>(opts)
30
30
 
31
- // eslint-disable-next-line react/display-name
32
- api.Provider = (props) => (
33
- <formContext.Provider {...props} value={{ formApi: api }} />
34
- )
31
+ api.Provider = function Provider(props) {
32
+ return <formContext.Provider {...props} value={{ formApi: api }} />
33
+ }
35
34
  api.Field = Field as any
36
35
  api.useField = useField as any
37
36
  api.useStore = (