feat(deps): Update dependencies 2024.07.07 (#41)

* feat(deps): Update dependencies 2024.07.07

* Update API docs

.github/workflows/ci.yml

@@ -27,25 +27,12 @@ jobs:
       - run: yarn compile
       - run: yarn lint
       - run: yarn test
-
-  docs:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version-file: .nvmrc
-          cache: yarn
-      - run: yarn install --immutable
       - run: yarn docs
       - uses: tj-actions/verify-changed-files@v20
-        id: verify-changed-files
         with:
-          files: |
-            **/docs/**
-      - name: Fail on missing docs
-        if: steps.verify-changed-files.outputs.files_changed == 'true'
-        run: |
-          echo "::error::The API reference docs have uncommitted changes:"
-          echo "::error::${{ steps.verify-changed-files.outputs.changed_files }}"
-          exit 1
+          files: docs/**
+          fail-if-changed: true
+          fail-message: >-
+            Uncommited API Reference docs found! Run `yarn docs` locally and 
+            commit the changes.
+      

.nvmrc

@@ -1 +1 @@
-22.1.0
+22.4.0

.yarnrc.yml

@@ -9,4 +9,4 @@ plugins:
     path: .yarn/plugins/@yarnpkg/plugin-engines.cjs
     spec: "https://raw.githubusercontent.com/devoto13/yarn-plugin-engines/main/bundles/%40yarnpkg/plugin-engines.js"
 
-yarnPath: .yarn/releases/yarn-4.2.1.cjs
+yarnPath: .yarn/releases/yarn-4.3.1.cjs

package.json

@@ -11,10 +11,10 @@
   "workspaces": [
     "packages/*"
   ],
-  "packageManager": "yarn@4.2.1",
+  "packageManager": "yarn@4.3.1",
   "scripts": {
     "build": "turbo build",
-    "check": "turbo check && yarn lint",
+    "check": "yarn lint && turbo check",
     "compile": "turbo compile",
     "docs": "turbo docs",
     "lint": "eslint .",
@@ -25,29 +25,29 @@
   "devDependencies": {
     "@eslint/compat": "^1.1.0",
     "@eslint/eslintrc": "^3.1.0",
-    "@eslint/js": "^9.5.0",
-    "@stylistic/eslint-plugin": "^2.2.2",
+    "@eslint/js": "^9.6.0",
+    "@stylistic/eslint-plugin": "^2.3.0",
     "@types/eslint__eslintrc": "^2.1.1",
     "@types/eslint__js": "^8.42.3",
-    "@types/node": "^20.12.10",
-    "eslint": "^9.5.0",
+    "@types/node": "^20.14.10",
+    "eslint": "^9.6.0",
     "eslint-import-resolver-typescript": "^3.6.1",
     "eslint-plugin-deprecation": "^3.0.0",
     "eslint-plugin-etc": "^2.0.3",
     "eslint-plugin-extra-rules": "^0.0.0-development",
     "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-jsdoc": "^48.3.0",
+    "eslint-plugin-jsdoc": "^48.5.2",
     "eslint-plugin-react": "^7.34.3",
     "eslint-plugin-sonarjs": "^1.0.3",
-    "globals": "^15.6.0",
-    "semantic-release": "^23.0.8",
+    "globals": "^15.8.0",
+    "semantic-release": "^24.0.0",
     "ts-node": "^10.9.2",
-    "tslib": "^2.6.2",
-    "turbo": "^1.13.3",
-    "typedoc": "^0.25.13",
-    "typedoc-plugin-markdown": "^4.0.1",
-    "typedoc-plugin-merge-modules": "^5.1.0",
-    "typescript": "^5.4.5",
-    "typescript-eslint": "^7.13.1"
+    "tslib": "^2.6.3",
+    "turbo": "^2.0.6",
+    "typedoc": "^0.26.3",
+    "typedoc-plugin-markdown": "^4.1.2",
+    "typedoc-plugin-merge-modules": "^6.0.0",
+    "typescript": "^5.5.3",
+    "typescript-eslint": "^7.15.0"
   }
 }

packages/core/docs/functions/ArrayField.md

@@ -10,12 +10,16 @@
 
 Helper component for array fields with finner control over the re-renders.
 
-## Type parameters
+## Type Parameters
 
 • **T** *extends* [`Struct`](../type-aliases/Struct.md)
 
+struct type of the form values
+
 • **K** *extends* `string`
 
+the type of the path of the array field
+
 ## Parameters
 
 • **props**: [`ArrayFieldProps`](../interfaces/ArrayFieldProps.md)\<`T`, `K`\>
@@ -26,6 +30,6 @@ the array field props
 
 `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\>
 
-## Source
+## Defined in
 
-[lib/components/ArrayField.component.tsx:63](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/components/ArrayField.component.tsx#L63)
+[components/ArrayField.component.tsx:63](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/components/ArrayField.component.tsx#L63)

packages/core/docs/functions/Field.md

@@ -10,12 +10,16 @@
 
 Helper component for rendering fields with finner control over the re-renders
 
-## Type parameters
+## Type Parameters
 
 • **T** *extends* [`Struct`](../type-aliases/Struct.md)
 
+struct type of the form values
+
 • **K** *extends* `string`
 
+the type of the path of the field
+
 • **D** = [`Optional`](../type-aliases/Optional.md)\<[`ValueByPath`](../type-aliases/ValueByPath.md)\<`T`, `K`\>\>
 
 ## Parameters
@@ -28,6 +32,6 @@ the field props
 
 `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\>
 
-## Source
+## Defined in
 
-[lib/components/Field.component.tsx:79](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/components/Field.component.tsx#L79)
+[components/Field.component.tsx:79](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/components/Field.component.tsx#L79)

packages/core/docs/functions/FormProvider.md

@@ -10,10 +10,12 @@
 
 The form context provider component.
 
-## Type parameters
+## Type Parameters
 
 • **T** *extends* [`Struct`](../type-aliases/Struct.md)
 
+struct type of the form values
+
 ## Parameters
 
 • **props**: [`FormProviderProps`](../interfaces/FormProviderProps.md)\<`T`\>
@@ -24,6 +26,6 @@ the provider component props
 
 `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\>
 
-## Source
+## Defined in
 
-[lib/Form.provider.tsx:148](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.provider.tsx#L148)
+[Form.provider.tsx:148](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.provider.tsx#L148)

packages/core/docs/functions/arrayFieldOf.md

@@ -12,7 +12,7 @@ Utility function which helps you create an [ArrayField](ArrayField.md) component
 an specific struct type. Once you have this, the only type parameter left is
 the [Path\<T\>](../type-aliases/Path.md) of the property which is an array.
 
-## Type parameters
+## Type Parameters
 
 • **T** *extends* [`Struct`](../type-aliases/Struct.md)
 
@@ -37,6 +37,6 @@ const ArrayField = arrayFieldOf<User>();
 </ArrayField>
 ```
 
-## Source
+## Defined in
 
-[lib/components/ArrayField.component.tsx:101](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/components/ArrayField.component.tsx#L101)
+[components/ArrayField.component.tsx:101](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/components/ArrayField.component.tsx#L101)

packages/core/docs/functions/fieldOf.md

@@ -12,7 +12,7 @@ Utility function which helps you create a [Field](Field.md) component of an
 specific struct type. Once you have this, the only type parameters left is
 the [Path\<T\>](../type-aliases/Path.md) of the property and the optional fallback type.
 
-## Type parameters
+## Type Parameters
 
 • **T** *extends* [`Struct`](../type-aliases/Struct.md)
 
@@ -49,6 +49,6 @@ const Field = fieldOf<User>();
 </Field>
 ```
 
-## Source
+## Defined in
 
-[lib/components/Field.component.tsx:138](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/components/Field.component.tsx#L138)
+[components/Field.component.tsx:138](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/components/Field.component.tsx#L138)

packages/core/docs/functions/noValidate.md

@@ -11,7 +11,7 @@
 Helper function that creates an [Adapter\<T\>](../interfaces/Adapter.md) to bypass the
 form validation.
 
-## Type parameters
+## Type Parameters
 
 • **T** *extends* [`Struct`](../type-aliases/Struct.md)
 
@@ -23,6 +23,6 @@ struct type of the form values
 
 an adapter to bypass validation
 
-## Source
+## Defined in
 
-[lib/helpers/adapters.ts:65](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/helpers/adapters.ts#L65)
+[helpers/adapters.ts:65](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/helpers/adapters.ts#L65)

packages/core/docs/functions/useArrayField.md

@@ -12,7 +12,7 @@ A hook to handle array field in the form. It provides the array field items
 to iterate over and a few helper functions to handle changes and renders on
 the array.
 
-## Type parameters
+## Type Parameters
 
 • **T** *extends* [`Struct`](../type-aliases/Struct.md)
 
@@ -30,6 +30,6 @@ the path of the array field in `T`
 
 an object containing the array items and helper array functions
 
-## Source
+## Defined in
 
-[lib/hooks/useArrayField.ts:104](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/hooks/useArrayField.ts#L104)
+[hooks/useArrayField.ts:104](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/hooks/useArrayField.ts#L104)

packages/core/docs/functions/useField.md

@@ -13,7 +13,7 @@ field and helper function to change its state.
 
 If the `fallback` parameter is not set, the default value is `undefined`.
 
-## Type parameters
+## Type Parameters
 
 • **T** *extends* [`Struct`](../type-aliases/Struct.md)
 
@@ -37,6 +37,6 @@ optional default value the field should take
 
 an object with the field value and some helper functions
 
-## Source
+## Defined in
 
-[lib/hooks/useField.ts:39](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/hooks/useField.ts#L39)
+[hooks/useField.ts:39](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/hooks/useField.ts#L39)

packages/core/docs/functions/useFieldValidation.md

@@ -10,7 +10,7 @@
 
 A hook to retrieve validation related states of a field.
 
-## Type parameters
+## Type Parameters
 
 • **T** *extends* [`Struct`](../type-aliases/Struct.md)
 
@@ -26,6 +26,6 @@ the path of the field in `T`
 
 an object with validation related states
 
-## Source
+## Defined in
 
-[lib/hooks/useFieldValidation.ts:27](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/hooks/useFieldValidation.ts#L27)
+[hooks/useFieldValidation.ts:27](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/hooks/useFieldValidation.ts#L27)

packages/core/docs/functions/useForm.md

@@ -12,7 +12,7 @@ A hook to access the entire value of `FormCtxt<T>`. If you want just some
 properties of the context, use [useFormSelector](useFormSelector.md) instead for an
 increased performance and avoid unnecessary renders.
 
-## Type parameters
+## Type Parameters
 
 • **T** *extends* [`Struct`](../type-aliases/Struct.md)
 
@@ -22,6 +22,6 @@ increased performance and avoid unnecessary renders.
 
 the entire value of the form context
 
-## Source
+## Defined in
 
-[lib/Form.context.ts:210](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.context.ts#L210)
+[Form.context.ts:210](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.context.ts#L210)

packages/core/docs/functions/useFormSelector.md

@@ -10,7 +10,7 @@
 
 A hook to select a value from the form `FormCtxt<T>`.
 
-## Type parameters
+## Type Parameters
 
 • **T** *extends* [`Struct`](../type-aliases/Struct.md)
 
@@ -28,6 +28,6 @@ a function to select a value from the context
 
 the selected value
 
-## Source
+## Defined in
 
-[lib/Form.context.ts:222](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.context.ts#L222)
+[Form.context.ts:222](https://github.com/JoseLion/lynxts/blob/main/packages/core/src/lib/Form.context.ts#L222)