Merge branch 'main' into patch-1

TanStack · Jul 30, 2024 · f1ae348 · f1ae348
2 parents c3d89ab + e1c5bee
commit f1ae348
Show file tree

Hide file tree

Showing 91 changed files with 1,649 additions and 2,013 deletions.
diff --git a/.github/renovate.json b/.github/renovate.json
@@ -1,25 +1,21 @@
 {
   "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "configMigration": true,
   "extends": [
     "config:recommended",
+    "group:allNonMajor",
     "schedule:weekly",
     ":approveMajorUpdates",
+    ":automergeMinor",
     ":disablePeerDependencies",
+    ":maintainLockFilesMonthly",
+    ":semanticCommits",
     ":semanticCommitTypeAll(chore)"
   ],
   "ignorePresets": [":ignoreModulesAndTests"],
   "labels": ["dependencies"],
   "rangeStrategy": "bump",
   "postUpdateOptions": ["pnpmDedupe"],
-  "semanticCommits": "enabled",
-  "packageRules": [
-    {
-      "groupName": "all non-major dependencies",
-      "groupSlug": "all-minor-patch",
-      "matchCurrentVersion": ">=1.0.0",
-      "matchUpdateTypes": ["minor", "patch"]
-    }
-  ],
   "ignoreDeps": [
     "@types/node",
     "@types/react",

diff --git a/.github/workflows/autofix.yml b/.github/workflows/autofix.yml
@@ -20,10 +20,10 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
       - name: Setup Tools
-        uses: tanstack/config/.github/setup@629cd3152485cbe985f5a7e66d370c858132c517
+        uses: tanstack/config/.github/setup@1ce18c19ec31f6191db71f4b768b6b9ec3575a0e
       - name: Fix formatting
         run: pnpm prettier:write
       - name: Apply fixes
-        uses: autofix-ci/action@dd55f44df8f7cdb7a6bf74c78677eb8acd40cd0a
+        uses: autofix-ci/action@ff86a557419858bb967097bfc916833f5647fa8c
         with:
           commit-message: 'ci: apply automated fixes'
diff --git a/docs/config.json b/docs/config.json
@@ -192,40 +192,40 @@
       "label": "API Reference",
       "children": [
         { "label": "JavaScript Reference", "to": "reference/index" },
-        { "label": "Classes / FieldApi", "to": "reference/FieldApi" },
-        { "label": "Classes / FormApi", "to": "reference/FormApi" },
-        { "label": "Functions / formOptions", "to": "reference/formOptions" },
-        { "label": "Functions / mergeForm", "to": "reference/mergeForm" },
+        { "label": "Classes / FieldApi", "to": "reference/classes/fieldapi" },
+        { "label": "Classes / FormApi", "to": "reference/classes/formapi" },
+        { "label": "Functions / formOptions", "to": "reference/functions/formoptions" },
+        { "label": "Functions / mergeForm", "to": "reference/functions/mergeform" },
         {
           "label": "Interfaces / FieldApiOptions",
-          "to": "reference/FieldApiOptions"
+          "to": "reference/interfaces/fieldapioptions"
         },
         {
           "label": "Interfaces / FieldOptions",
-          "to": "reference/FieldOptions"
+          "to": "reference/interfaces/fieldoptions"
         },
         {
           "label": "Interfaces / FieldValidators",
-          "to": "reference/FieldValidators"
+          "to": "reference/interfaces/fieldvalidators"
         },
-        { "label": "Interfaces / FormOptions", "to": "reference/FormOptions" },
+        { "label": "Interfaces / FormOptions", "to": "reference/interfaces/formoptions" },
         {
           "label": "Interfaces / FormValidators",
-          "to": "reference/FormValidators"
+          "to": "reference/interfaces/formvalidators"
         },
-        { "label": "Types / DeepKeys", "to": "reference/DeepKeys" },
-        { "label": "Types / DeepValue", "to": "reference/DeepValue" },
-        { "label": "Types / FieldInfo", "to": "reference/FieldInfo" },
-        { "label": "Types / FieldMeta", "to": "reference/FieldMeta" },
-        { "label": "Types / FieldState", "to": "reference/FieldState" },
-        { "label": "Types / FormState", "to": "reference/FormState" },
-        { "label": "Types / Updater", "to": "reference/Updater" },
-        { "label": "Types / UpdaterFn", "to": "reference/UpdaterFn" },
+        { "label": "Types / DeepKeys", "to": "reference/type-aliases/deepkeys" },
+        { "label": "Types / DeepValue", "to": "reference/type-aliases/deepvalue" },
+        { "label": "Types / FieldInfo", "to": "reference/type-aliases/fieldinfo" },
+        { "label": "Types / FieldMeta", "to": "reference/type-aliases/fieldmeta" },
+        { "label": "Types / FieldState", "to": "reference/type-aliases/fieldstate" },
+        { "label": "Types / FormState", "to": "reference/type-aliases/formstate" },
+        { "label": "Types / Updater", "to": "reference/type-aliases/updater" },
+        { "label": "Types / UpdaterFn", "to": "reference/type-aliases/updaterfn" },
         {
           "label": "Types / ValidationError",
-          "to": "reference/ValidationError"
+          "to": "reference/type-aliases/validationerror"
         },
-        { "label": "Types / ValidationMeta", "to": "reference/ValidationMeta" }
+        { "label": "Types / ValidationMeta", "to": "reference/type-aliases/validationmeta" }
       ],
       "frameworks": [
         {
@@ -237,35 +237,31 @@
             },
             {
               "label": "Functions / createServerValidate",
-              "to": "framework/react/reference/createServerValidate"
+              "to": "framework/react/reference/functions/createservervalidate"
             },
             {
               "label": "Functions / Field",
-              "to": "framework/react/reference/Field"
+              "to": "framework/react/reference/functions/field"
             },
             {
               "label": "Functions / useField",
-              "to": "framework/react/reference/useField"
+              "to": "framework/react/reference/functions/usefield"
             },
             {
               "label": "Functions / useForm",
-              "to": "framework/react/reference/useForm"
+              "to": "framework/react/reference/functions/useform"
             },
             {
               "label": "Functions / useTransform",
-              "to": "framework/react/reference/useTransform"
+              "to": "framework/react/reference/functions/usetransform"
             },
             {
               "label": "Types / FieldComponent",
-              "to": "framework/react/reference/FieldComponent"
+              "to": "framework/react/reference/type-aliases/fieldcomponent"
             },
             {
               "label": "Types / UseField",
-              "to": "framework/react/reference/UseField"
-            },
-            {
-              "label": "Variables / initialFormState",
-              "to": "framework/react/reference/initialFormState"
+              "to": "framework/react/reference/type-aliases/usefield"
             }
           ]
         },
@@ -275,23 +271,23 @@
             { "label": "Vue Reference", "to": "framework/vue/reference/index" },
             {
               "label": "Functions / Field",
-              "to": "framework/vue/reference/Field"
+              "to": "framework/vue/reference/functions/field"
             },
             {
               "label": "Functions / useField",
-              "to": "framework/vue/reference/useField"
+              "to": "framework/vue/reference/functions/usefield"
             },
             {
               "label": "Functions / useForm",
-              "to": "framework/vue/reference/useForm"
+              "to": "framework/vue/reference/functions/useform"
             },
             {
               "label": "Types / FieldComponent",
-              "to": "framework/vue/reference/FieldComponent"
+              "to": "framework/vue/reference/type-aliases/fieldcomponent"
             },
             {
               "label": "Types / UseField",
-              "to": "framework/vue/reference/UseField"
+              "to": "framework/vue/reference/type-aliases/usefield"
             }
           ]
         },
@@ -304,23 +300,23 @@
             },
             {
               "label": "Functions / createField",
-              "to": "framework/solid/reference/createField"
+              "to": "framework/solid/reference/functions/createfield"
             },
             {
               "label": "Functions / createForm",
-              "to": "framework/solid/reference/createForm"
+              "to": "framework/solid/reference/functions/createform"
             },
             {
               "label": "Functions / Field",
-              "to": "framework/solid/reference/Field"
+              "to": "framework/solid/reference/functions/field"
             },
             {
               "label": "Types / CreateField",
-              "to": "framework/solid/reference/CreateField"
+              "to": "framework/solid/reference/type-aliases/createfield"
             },
             {
               "label": "Types / FieldComponent",
-              "to": "framework/solid/reference/FieldComponent"
+              "to": "framework/solid/reference/type-aliases/fieldcomponent"
             }
           ]
         },
@@ -330,7 +326,7 @@
             { "label": "Lit Reference", "to": "framework/lit/reference/index" },
             {
               "label": "Classes / TanStackFormController",
-              "to": "framework/lit/reference/TanStackFormController"
+              "to": "framework/lit/reference/classes/tanstackformcontroller"
             }
           ]
         },
@@ -343,15 +339,15 @@
             },
             {
               "label": "Classes / TanStackField",
-              "to": "framework/angular/reference/TanStackField"
+              "to": "framework/angular/reference/classes/tanstackfield"
             },
             {
               "label": "Functions / injectForm",
-              "to": "framework/angular/reference/injectForm"
+              "to": "framework/angular/reference/functions/injectform"
             },
             {
               "label": "Functions / injectStore",
-              "to": "framework/angular/reference/injectStore"
+              "to": "framework/angular/reference/functions/injectstore"
             }
           ]
         }

diff --git a/...mework/angular/reference/TanStackField.md → ...ngular/reference/classes/tanstackfield.md b/...mework/angular/reference/TanStackField.md → ...ngular/reference/classes/tanstackfield.md
@@ -34,7 +34,7 @@ new TanStackField<TParentData, TName, TFieldValidator, TFormValidator, TData>():
 
 #### Returns
 
-[`TanStackField`](TanStackField.md)\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>
+[`TanStackField`](tanstackfield.md)\<`TParentData`, `TName`, `TFieldValidator`, `TFormValidator`, `TData`\>
 
 ## Properties
 
@@ -46,7 +46,7 @@ api: FieldApi<TParentData, TName, TFieldValidator, TFormValidator, TData>;
 
 #### Defined in
 
-[tanstack-field.directive.ts:61](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L61)
+[tanstack-field.directive.ts:61](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/tanstack-field.directive.ts#L61)
 
 ***
 
@@ -64,7 +64,7 @@ If `true`, always run async validation, even if there are errors emitted during
 
 #### Defined in
 
-[tanstack-field.directive.ts:50](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L50)
+[tanstack-field.directive.ts:50](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/tanstack-field.directive.ts#L50)
 
 ***
 
@@ -82,7 +82,7 @@ The default time to debounce async validation if there is not a more specific de
 
 #### Defined in
 
-[tanstack-field.directive.ts:49](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L49)
+[tanstack-field.directive.ts:49](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/tanstack-field.directive.ts#L49)
 
 ***
 
@@ -100,7 +100,7 @@ An optional object with default metadata for the field.
 
 #### Defined in
 
-[tanstack-field.directive.ts:59](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L59)
+[tanstack-field.directive.ts:59](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/tanstack-field.directive.ts#L59)
 
 ***
 
@@ -118,7 +118,7 @@ An optional default value for the field.
 
 #### Defined in
 
-[tanstack-field.directive.ts:48](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L48)
+[tanstack-field.directive.ts:48](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/tanstack-field.directive.ts#L48)
 
 ***
 
@@ -136,7 +136,7 @@ The field name. The type will be `DeepKeys<TParentData>` to ensure your name is
 
 #### Defined in
 
-[tanstack-field.directive.ts:44](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L44)
+[tanstack-field.directive.ts:44](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/tanstack-field.directive.ts#L44)
 
 ***
 
@@ -148,7 +148,7 @@ tanstackField: FormApi<TParentData, TFormValidator>;
 
 #### Defined in
 
-[tanstack-field.directive.ts:52](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L52)
+[tanstack-field.directive.ts:52](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/tanstack-field.directive.ts#L52)
 
 ***
 
@@ -164,7 +164,7 @@ optional unmount: () => void;
 
 #### Defined in
 
-[tanstack-field.directive.ts:76](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L76)
+[tanstack-field.directive.ts:76](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/tanstack-field.directive.ts#L76)
 
 ***
 
@@ -182,7 +182,7 @@ A validator provided by an extension, like `yupValidator` from `@tanstack/yup-fo
 
 #### Defined in
 
-[tanstack-field.directive.ts:51](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L51)
+[tanstack-field.directive.ts:51](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/tanstack-field.directive.ts#L51)
 
 ***
 
@@ -200,7 +200,7 @@ A list of validators to pass to the field
 
 #### Defined in
 
-[tanstack-field.directive.ts:56](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L56)
+[tanstack-field.directive.ts:56](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/tanstack-field.directive.ts#L56)
 
 ## Methods
 
@@ -225,7 +225,7 @@ children are checked.
 
 #### Defined in
 
-[tanstack-field.directive.ts:88](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L88)
+[tanstack-field.directive.ts:88](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/tanstack-field.directive.ts#L88)
 
 ***
 
@@ -248,7 +248,7 @@ before a directive, pipe, or service instance is destroyed.
 
 #### Defined in
 
-[tanstack-field.directive.ts:84](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L84)
+[tanstack-field.directive.ts:84](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/tanstack-field.directive.ts#L84)
 
 ***
 
@@ -274,4 +274,4 @@ It is invoked only once when the directive is instantiated.
 
 #### Defined in
 
-[tanstack-field.directive.ts:78](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/tanstack-field.directive.ts#L78)
+[tanstack-field.directive.ts:78](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/tanstack-field.directive.ts#L78)
diff --git a/...framework/angular/reference/injectForm.md → ...angular/reference/functions/injectform.md b/...framework/angular/reference/injectForm.md → ...angular/reference/functions/injectform.md
@@ -25,4 +25,4 @@ function injectForm<TFormData, TFormValidator>(opts?): FormApi<TFormData, TFormV
 
 ## Defined in
 
-[inject-form.ts:4](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/inject-form.ts#L4)
+[inject-form.ts:4](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/inject-form.ts#L4)
diff --git a/...ramework/angular/reference/injectStore.md → ...ngular/reference/functions/injectstore.md b/...ramework/angular/reference/injectStore.md → ...ngular/reference/functions/injectstore.md
@@ -29,4 +29,4 @@ function injectStore<TFormData, TFormValidator, TSelected>(form, selector?): Sig
 
 ## Defined in
 
-[inject-store.ts:4](https://github.com/TanStack/form/blob/a6313b7699753752ae30ff16c169e0b08c2369e8/packages/angular-form/src/inject-store.ts#L4)
+[inject-store.ts:4](https://github.com/TanStack/form/blob/bde3b1cb3de955b47034f0bfaa43dec13c67999a/packages/angular-form/src/inject-store.ts#L4)
diff --git a/docs/framework/angular/reference/index.md b/docs/framework/angular/reference/index.md
@@ -7,9 +7,9 @@ title: "@tanstack/angular-form"
 
 ## Classes
 
-- [TanStackField](TanStackField.md)
+- [TanStackField](classes/tanstackfield.md)
 
 ## Functions
 
-- [injectForm](injectForm.md)
-- [injectStore](injectStore.md)
+- [injectForm](functions/injectform.md)
+- [injectStore](functions/injectstore.md)