proje-react-panel 1.10.0 → 1.11.0-beta.0

package/CHANGELOG.md

@@ -0,0 +1,38 @@
+# Changelog
+
+This file starts at 1.11.0; earlier releases are only in the git history.
+
+## 1.11.0-beta.0
+
+### Changed — please read before upgrading
+
+- **`inputType: 'number'` fields now reach `onSubmit` as numbers.** `FormField` registers them
+  with a `setValueAs` conversion, the same way `type: 'checkbox'` has always been registered as a
+  boolean. `@Type(() => Number)` on the model is no longer needed — and keeps working where it is
+  already written, since a value that is already a number passes through untouched.
+- **An empty number field is now `undefined`, where it used to be `''`.** This is a deliberate
+  behaviour change, and the reason to try this release on a branch first:
+  - Before: `''` reached the body, and `@Type(() => Number)` turned it into `0`. A user who left
+    an optional number field empty silently saved a `0`.
+  - Now: the key is `undefined`, so `JSON.stringify` drops it from the request. `@IsOptional()`
+    fields stay unset, and a required `@IsInt()` fails client-side with the message shown under
+    the field.
+  - Why not react-hook-form's `valueAsNumber`: it produces `NaN` for an empty input. `NaN` is
+    neither `null` nor `undefined`, so `@IsOptional()` does not skip it and every untouched
+    optional number field would start failing validation — and `NaN` becomes `null` in JSON.
+  - If your backend distinguishes "field absent" from "field null", check those endpoints.
+- **`type: 'hidden'` fields go through the same conversion.** A hidden id declared with
+  `inputType: 'number'` reaches the body as a number instead of a string.
+- **`inputType: 'date'` is deliberately left as a string** — the native input's `'YYYY-MM-DD'`,
+  and `''` when empty. Existing consumers validate it with `@IsString()` / `@IsISO8601()` and post
+  it as-is, so it is never converted to a `Date`. Documented in the README rather than left to be
+  discovered.
+- Multipart forms (`@Form({ type: 'formData' })`) no longer append `undefined`/`null` values on
+  top of what the DOM already put into the `FormData`; an empty number field used to be able to
+  post the literal string `undefined`.
+
+### Added
+
+- `src/__tests__/components/form/NumberField.test.tsx` pins all of the above: filled, empty,
+  hidden, `defaultValue`, programmatic `setValue`, text and date fields, plus a model that still
+  declares `@Type(() => Number)`.

package/README.md

@@ -99,6 +99,29 @@ The render function receives:
 Because the value is whatever you pass to `onChange`, a custom field can hold an id, an
 object or a file reference — validation and submit treat it like any other form value.
 
+## What a field puts into the submitted body
+
+The DOM hands every input value over as a string. The library converts it before it reaches
+`onSubmit`, so a model does not need `@Type(() => Number)` to get a number:
+
+| Field                             | Value in the submitted body                                           |
+| --------------------------------- | --------------------------------------------------------------------- |
+| `@Input({ inputType: 'number' })` | `number` — and `undefined` when the field is empty                    |
+| `@Input({ inputType: 'date' })`   | `string` — the input's own `'YYYY-MM-DD'`, `''` when empty, no `Date` |
+| `@Input({ type: 'checkbox' })`    | `boolean`                                                             |
+| everything else                   | `string`                                                              |
+
+Notes:
+
+- **Empty number fields are `undefined`, not `0`.** `JSON.stringify` drops the key, so
+  `@IsOptional()` fields simply stay unset, and a required `@IsInt()` fails with the message
+  under the field instead of quietly posting `0`.
+- **Date fields stay strings.** They are meant to be validated with `@IsString()` /
+  `@IsISO8601()` and posted as-is; the library never turns them into `Date` objects.
+- **`type: 'hidden'` follows the same rules** — declare `inputType: 'number'` on a hidden id
+  and it reaches the body as a number rather than a string.
+- `@Type(() => Number)` on a model keeps working; it just is not needed anymore.
+
 ## Guides
 
 - **[Dashboard Guide](./guides/DASHBOARD_GUIDE.md)** - Complete guide for using Dashboard components

package/dist/__tests__/components/form/NumberField.test.d.ts

@@ -0,0 +1 @@
+import 'reflect-metadata';

package/dist/components/form/registerOptions.d.ts

@@ -0,0 +1,12 @@
+import { UseFormRegister } from 'react-hook-form';
+import { InputConfiguration } from '../../decorators/form/Input';
+type FieldRegisterOptions = Parameters<UseFormRegister<any>>[1];
+/**
+ * The DOM hands every <input> value over as a string, number inputs included. Deciding what
+ * lands in the form body is this module's job — not the model author's: a forgotten
+ * `@Type(() => Number)` used to turn into a client-side `@IsInt()` error under the field, or a
+ * backend 400, with no visible cause. Checkbox already closed the same trap through
+ * `setValueAs`, see Checkbox.tsx.
+ */
+export declare function getFieldRegisterOptions(inputType: InputConfiguration['inputType']): FieldRegisterOptions;
+export {};