@ivlev-dev/silent-validation 0.12.0 → 0.13.0
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.
- package/README.md +59 -26
- package/dist/engine.d.ts +2 -0
- package/dist/engine.d.ts.map +1 -1
- package/dist/engine.js +239 -56
- package/dist/engine.js.map +1 -1
- package/dist/messages.d.ts +2 -0
- package/dist/messages.d.ts.map +1 -1
- package/dist/messages.js +129 -14
- package/dist/messages.js.map +1 -1
- package/dist/modifiers.d.ts.map +1 -1
- package/dist/modifiers.js +5 -11
- package/dist/modifiers.js.map +1 -1
- package/dist/property.d.ts.map +1 -1
- package/dist/property.js +6 -3
- package/dist/property.js.map +1 -1
- package/dist/registry.d.ts +1 -1
- package/dist/registry.d.ts.map +1 -1
- package/dist/registry.js +106 -3
- package/dist/registry.js.map +1 -1
- package/dist/rules/strings.d.ts.map +1 -1
- package/dist/rules/strings.js +45 -5
- package/dist/rules/strings.js.map +1 -1
- package/dist/type-validation.d.ts +11 -0
- package/dist/type-validation.d.ts.map +1 -1
- package/dist/type-validation.js +121 -17
- package/dist/type-validation.js.map +1 -1
- package/dist/types.d.ts +2 -2
- package/dist/types.d.ts.map +1 -1
- package/dist/types.js.map +1 -1
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
- Имена декораторов в PascalCase: `@Required`, `@IsEmail`, `@Min`, `@Nested`.
|
|
14
14
|
- Синхронный `validate` и асинхронный `validateAsync` с одинаковым набором правил.
|
|
15
15
|
- Вложенная валидация объектов (`@Nested`) и элементов коллекций (`@Each`).
|
|
16
|
-
- Модификаторы: `@ValidateIf`, `@Optional`, `@Label`, `@Groups`.
|
|
16
|
+
- Модификаторы: `@ValidateIf`, `@Optional`, `@Label`, `@Groups`, `@ValidateOnSet`.
|
|
17
17
|
- Сообщения: переопределение через `message`/`messageKey`, ярлыки полей, встроенные каталоги `ru`/`en`, глобальная настройка `configureValidation` и собственный резолвер (например, i18next).
|
|
18
18
|
- Пути ошибок вида `address.city` и `items[2].name`.
|
|
19
19
|
- Ошибки с машинно-читаемыми полями: `field`, `rule`, `params`, `value`, `path`, `label`, `index`.
|
|
@@ -68,7 +68,7 @@ if (!result.valid) {
|
|
|
68
68
|
}
|
|
69
69
|
```
|
|
70
70
|
|
|
71
|
-
Валидация явная: декораторы только регистрируют правила, проверка запускается вызовом `validate
|
|
71
|
+
Валидация явная: декораторы только регистрируют правила, проверка запускается вызовом `validate`, `validateAsync`, `validateOrThrow`, `validateOrThrowAsync`, `validateProperty`/`validatePropertyAsync`, `validatePartial`/`validatePartialAsync` или `safeParse`/`safeParseAsync`. Исключение — opt-in `@ValidateOnSet`: он проверяет поле при каждом присваивании.
|
|
72
72
|
|
|
73
73
|
## Валидация из типов
|
|
74
74
|
|
|
@@ -110,6 +110,7 @@ export default defineConfig({
|
|
|
110
110
|
| `exclude` | `RegExp` | `/node_modules/` | Файлы, которые плагин пропускает |
|
|
111
111
|
| `tsconfig` | `string` | ближайший `tsconfig.json` | Путь к конфигу относительно корня проекта |
|
|
112
112
|
| `base` | `string` | `"ValidationModel"` | Имя базового класса, потомки которого получают схему |
|
|
113
|
+
| `strict` | `boolean` | `false` | Бросать ошибку вместо предупреждения при неподдерживаемом типе |
|
|
113
114
|
|
|
114
115
|
TypeScript используется только на сборке: `typescript` — зависимость пакета `@ivlev-dev/silent-validation-vite`, рантайм от него не зависит. Плагин самостоятельный: `silent()` нужен только для JSX/VM-компиляции, в обычном Vite-конфиге достаточно `validation()`.
|
|
115
116
|
|
|
@@ -148,10 +149,12 @@ const result = validate(order);
|
|
|
148
149
|
|
|
149
150
|
```js
|
|
150
151
|
static {
|
|
151
|
-
this[Symbol.for("silent.validation.schema")] = { fields: { email: "string", age: ["optional", "number"] } };
|
|
152
|
+
this[Symbol.for("silent.validation.schema")] = { version: 1, fields: { email: "string", age: ["optional", "number"] } };
|
|
152
153
|
}
|
|
153
154
|
```
|
|
154
155
|
|
|
156
|
+
Схема без `version` (`{ fields: ... }`) поддерживается как legacy-формат; текущий плагин всегда генерирует `version: 1`.
|
|
157
|
+
|
|
155
158
|
Ошибка типа получает `rule: "type"`, `params.type` с именем ожидаемого типа, сообщение по ключу `validation.type` и обычный `path`:
|
|
156
159
|
|
|
157
160
|
```ts
|
|
@@ -176,7 +179,7 @@ class Order extends ValidationModel {
|
|
|
176
179
|
}
|
|
177
180
|
```
|
|
178
181
|
|
|
179
|
-
Ошибки приходят как `address.city`, `items[0].quantity`; для
|
|
182
|
+
Ошибки приходят как `address.city`, `items[0].quantity`; для прямых ошибок элемента массива заполняется `index`, а у ошибок внутри вложенного класса индекс есть только в `path`. Ключи объектов и `Record` идут через точку (`counts.apples`), ключи `Map` — в скобках (`map[userId]`).
|
|
180
183
|
|
|
181
184
|
### Смешивание с декораторами
|
|
182
185
|
|
|
@@ -193,6 +196,10 @@ class User extends ValidationModel {
|
|
|
193
196
|
public accessor age: number = 0;
|
|
194
197
|
}
|
|
195
198
|
|
|
199
|
+
const user = new User();
|
|
200
|
+
user.email = "user@example.com";
|
|
201
|
+
user.age = 30;
|
|
202
|
+
|
|
196
203
|
validate(user);
|
|
197
204
|
```
|
|
198
205
|
|
|
@@ -204,7 +211,7 @@ validate(user);
|
|
|
204
211
|
validate(instance, { types: false });
|
|
205
212
|
```
|
|
206
213
|
|
|
207
|
-
Флаг `types` в `ValidationOptions` по умолчанию `true
|
|
214
|
+
Флаг `types` в `ValidationOptions` по умолчанию `true`; глобально он не настраивается. С `types: false` остаются только правила декораторов — удобно, когда схема приходит извне или типы описывают данные шире, чем допустимо в конкретном вызове. Флаг `cascade` (по умолчанию `true`) управляет каскадом: `false` останавливает декораторы поля после ошибки типа. `cascade` можно задать глобально через `configureValidation` и переопределить на вызов; `types` задаётся только в `ValidationOptions`.
|
|
208
215
|
|
|
209
216
|
### Поддерживаемые типы
|
|
210
217
|
|
|
@@ -213,10 +220,10 @@ validate(instance, { types: false });
|
|
|
213
220
|
| Примитивы | `string`, `number`, `boolean`, `bigint`, `symbol`, `object`, `function`, `undefined`, `null`, `void`, `never` |
|
|
214
221
|
| Литералы | `"admin"`, `42`, `true` — значение сверяется с литералом |
|
|
215
222
|
| Объединения и пересечения | `string \| number`, `A & B`, `T \| null`, `T \| undefined` |
|
|
216
|
-
| Массивы и кортежи | `T[]`, `ReadonlyArray<T>`, `[string, number]`, `[string, number?]`, `[string, ...number[]]` |
|
|
217
|
-
| Объекты | `Record<K, V>`, `{ [key: string]: T }`, классы и интерфейсы, type alias’ы (структурно, включая рекурсивные) |
|
|
218
|
-
| Коллекции | `Map`, `Set`; `WeakMap`/`WeakSet` — только `instanceof`, без проверки ключей и значений |
|
|
219
|
-
| Встроенные | `Promise`, `Date`, `RegExp`, `Error` и подклассы, `ArrayBuffer`, `SharedArrayBuffer`, `DataView`, typed arrays, `URL`, `URLSearchParams` |
|
|
223
|
+
| Массивы и кортежи | `T[]`, `ReadonlyArray<T>`, `ArrayLike<T>` (массивы и array-like объекты), `[string, number]`, `[string, number?]`, `[string, ...number[]]` |
|
|
224
|
+
| Объекты | `Record<K, V>`, `{ [key: string]: T }`, классы и интерфейсы, type alias’ы (структурно, включая рекурсивные), mapped-утилиты `Partial`/`Pick`/`Omit`/`Readonly`/`Required` |
|
|
225
|
+
| Коллекции | `Map`, `Set`, `ReadonlyMap`, `ReadonlySet`; `WeakMap`/`WeakSet` — только `instanceof`, без проверки ключей и значений |
|
|
226
|
+
| Встроенные | `Promise`, `Date`, `RegExp`, `Error` и подклассы, `ArrayBuffer`, `SharedArrayBuffer`, `DataView`, typed arrays, `Buffer` (как `Uint8Array`), `URL`, `URLSearchParams` |
|
|
220
227
|
| Итераторы | `Iterable`, `Iterator`, `AsyncIterable`, `AsyncIterator` |
|
|
221
228
|
| Enum | значения `enum` — как у `@IsEnum` |
|
|
222
229
|
|
|
@@ -229,11 +236,12 @@ validate(instance, { types: false });
|
|
|
229
236
|
|
|
230
237
|
### Ограничения
|
|
231
238
|
|
|
232
|
-
- Метаданные получают только классы с `accessor`-полями и аннотациями; файл должен попадать под `include` и не попадать под `exclude`.
|
|
239
|
+
- Метаданные получают только классы с `accessor`-полями и аннотациями; файл должен попадать под `include` и не попадать под `exclude`. Проверяются только `accessor`-поля с явной аннотацией и identifier-именем; вычисляемые и символьные имена пропускаются.
|
|
233
240
|
- Схема генерируется только для классов-потомков `ValidationModel`; класс без базового класса не валидируется по типу.
|
|
234
241
|
- Optional-поле описывается как `public accessor age: number | undefined = undefined;`. Синтаксис `accessor age?: number` в TypeScript запрещён.
|
|
235
|
-
- Mapped-утилиты (`Partial`, `Pick`, `Omit`, `Readonly`, `Required`) поддерживаются структурно. Глубина данных ограничена 256 уровнями (глубже — ошибка `validation.depth`). Условные, template и indexed-типы, а также generic-параметры без конкретизации пропускаются с
|
|
236
|
-
-
|
|
242
|
+
- Mapped-утилиты (`Partial`, `Pick`, `Omit`, `Readonly`, `Required`) поддерживаются структурно. Глубина данных ограничена 256 уровнями (глубже — ошибка `validation.depth`). Числовая index-signature учитывается только у типов без именованных свойств. Условные, template и indexed-типы, а также generic-параметры без конкретизации пропускаются с диагностикой (в `strict` — ошибка).
|
|
243
|
+
- Символьные свойства структурных типов пропускаются с диагностикой (в `strict` — ошибка); ambient-классы (`declare class`) без рантайм-модуля пропускаются.
|
|
244
|
+
- Если класс импортирован только как тип (`import type { Item }`), плагин добавляет namespace-импорт при наличии рантайм-файла. Если рантайма нет, поле пропускается с диагностикой (в `strict` — ошибка).
|
|
237
245
|
- Плагин вставляет статический блок в бандл: без него `validate` увидит только правила декораторов.
|
|
238
246
|
|
|
239
247
|
## API
|
|
@@ -246,14 +254,14 @@ validate(instance, { types: false });
|
|
|
246
254
|
| `validatePropertyAsync(instance, field, options?)` | Асинхронная проверка одного поля |
|
|
247
255
|
| `validatePartial(instance, fields, options?)` | Проверка выбранных полей |
|
|
248
256
|
| `validatePartialAsync(instance, fields, options?)` | Асинхронная проверка выбранных полей |
|
|
249
|
-
| `safeParse(instance, options?)` |
|
|
257
|
+
| `safeParse(instance, options?)` | Не бросает `ValidationException`; ошибки валидации в `{ success, data, errors }` |
|
|
250
258
|
| `safeParseAsync(instance, options?)` | Асинхронный вариант `safeParse` |
|
|
251
259
|
| `validateOrThrow(instance, options?)` | Синхронная проверка, при ошибках бросает `ValidationException` |
|
|
252
260
|
| `validateOrThrowAsync(instance, options?)` | Асинхронная проверка, при ошибках бросает `ValidationException` |
|
|
253
261
|
| `ValidationResult` | `{ valid: boolean; errors: readonly ValidationError[] }` |
|
|
254
262
|
| `ValidationError` | Ошибка правила: `field`, `rule`, `message`, `params`, `value`, `path`, `label`, `index?` |
|
|
255
263
|
| `ValidationException` | Исключение с полями `errors` и `result` |
|
|
256
|
-
| `AsyncRuleError` | Бросается
|
|
264
|
+
| `AsyncRuleError` | Бросается `validate`, `validateProperty`, `validatePartial`, `safeParse`, `validateOrThrow`, если правило вернуло промис |
|
|
257
265
|
| `ValidationModel` | Базовый класс-маркер: схема из TS-типов генерируется только для его потомков |
|
|
258
266
|
| `ValidationOptions` | `groups`, `stopAtFirst`, `labels`, `types`, `cascade`, `locale`, `resolve`, `messages` |
|
|
259
267
|
|
|
@@ -270,11 +278,11 @@ import {
|
|
|
270
278
|
|
|
271
279
|
- `groups` — проверять только поля с указанными группами; поле без групп участвует всегда.
|
|
272
280
|
- `stopAtFirst` — остановиться на первой ошибке.
|
|
273
|
-
- `labels` — карта `имя поля → человекочитаемый
|
|
281
|
+
- `labels` — карта `имя поля или путь → человекочитаемый ярлык`; приоритет: `RuleOptions.label` → `@Label` → `labels[path]` → `labels[field]` → имя поля.
|
|
274
282
|
- `types` — проверка типов из TS-аннотаций (по умолчанию `true`, см. «Валидация из типов»).
|
|
275
283
|
- `locale`, `resolve`, `messages` — переопределяют глобальный конфиг сообщений для конкретного вызова.
|
|
276
284
|
|
|
277
|
-
`validate`
|
|
285
|
+
Синхронные `validate`, `validateProperty`, `validatePartial`, `safeParse` и `validateOrThrow` бросают `AsyncRuleError`, если встретилось асинхронное правило (`Custom` с `async`-функцией). Они же бросают `TypeError`, если аргумент — не объект или обычный массив (подклассы `Array` валидируются), и `Error` при асинхронном резолвере сообщений. Для моделей с асинхронными правилами используйте `validateAsync`, `validatePropertyAsync`, `validatePartialAsync`, `safeParseAsync` или `validateOrThrowAsync`.
|
|
278
286
|
|
|
279
287
|
## Правила
|
|
280
288
|
|
|
@@ -385,7 +393,7 @@ class Order {
|
|
|
385
393
|
}
|
|
386
394
|
```
|
|
387
395
|
|
|
388
|
-
`Custom` принимает функцию `(value, context) => boolean | Promise<boolean>`. Асинхронная функция требует `validateAsync`,
|
|
396
|
+
`Custom` принимает функцию `(value, context) => boolean | Promise<boolean>`. Асинхронная функция требует одной из async-функций: `validateAsync`, `validatePropertyAsync`, `validatePartialAsync`, `safeParseAsync`, `validateOrThrowAsync`. Синхронные `validate`, `validateProperty`, `validatePartial`, `safeParse` и `validateOrThrow` бросят `AsyncRuleError`.
|
|
389
397
|
|
|
390
398
|
## Модификаторы
|
|
391
399
|
|
|
@@ -414,6 +422,11 @@ class Profile {
|
|
|
414
422
|
public accessor role: string | undefined = undefined;
|
|
415
423
|
}
|
|
416
424
|
|
|
425
|
+
const profile = new Profile();
|
|
426
|
+
profile.age = 30;
|
|
427
|
+
profile.consent = true;
|
|
428
|
+
profile.role = "admin";
|
|
429
|
+
|
|
417
430
|
validate(profile, { groups: ["admin"] });
|
|
418
431
|
```
|
|
419
432
|
|
|
@@ -423,6 +436,8 @@ validate(profile, { groups: ["admin"] });
|
|
|
423
436
|
|
|
424
437
|
Каждое правило формирует ключ `validation.<rule>`, например `validation.min` или `validation.isEmail`. Встроенные каталоги — `ru` (по умолчанию, `DEFAULT_LOCALE`) и `en`.
|
|
425
438
|
|
|
439
|
+
Служебные ключи: `validation.type` — значение не совпало с типом из схемы, `validation.depth` — вложенность глубже 256 уровней, `validation.each` — элемент `@Each` не является объектом, `validation.eachValue` — значение `@Each` не является коллекцией (`each`/`eachValue` различают ошибку элемента и ошибку самой коллекции).
|
|
440
|
+
|
|
426
441
|
```ts
|
|
427
442
|
import { validate, Required, Min, IsEmail } from "@ivlev-dev/silent-validation";
|
|
428
443
|
|
|
@@ -438,7 +453,7 @@ class User {
|
|
|
438
453
|
|
|
439
454
|
- `message` — строка с плейсхолдерами `{label}`, `{value}`, `{field}`, `{index}` и параметрами правила, либо функция `(context) => string`. Имеет приоритет над резолвером и каталогом.
|
|
440
455
|
- `messageKey` — другой ключ каталога, например `validation.required`.
|
|
441
|
-
- `label` — ярлык поля в сообщении; приоритет: `options.label` → `@Label` → `options.labels[field]` → имя поля.
|
|
456
|
+
- `label` — ярлык поля в сообщении; приоритет: `options.label` → `@Label` → `options.labels[path]` → `options.labels[field]` → имя поля.
|
|
442
457
|
|
|
443
458
|
### Глобальный конфиг
|
|
444
459
|
|
|
@@ -462,7 +477,7 @@ const config = getValidationConfig();
|
|
|
462
477
|
resetValidationConfig();
|
|
463
478
|
```
|
|
464
479
|
|
|
465
|
-
`configureValidation` мержит переданные поля с текущими настройками: `locale`, `resolve`, `messages`. Значения `messages` переопределяют встроенные каталоги. Если ключа нет в выбранной локали, используется `ru`, затем встроенный `en`.
|
|
480
|
+
`configureValidation` мержит переданные поля с текущими настройками: `cascade`, `locale`, `resolve`, `messages`. Значения `messages` переопределяют встроенные каталоги. Если ключа нет в выбранной локали, используется `ru`, затем встроенный `en`.
|
|
466
481
|
|
|
467
482
|
### Резолвер (i18next)
|
|
468
483
|
|
|
@@ -478,9 +493,20 @@ configureValidation({
|
|
|
478
493
|
|
|
479
494
|
Резолвер `MessageResolver` получает `key`, `params`, `locale`, `label`, `field`, `value`, `path` и возвращает строку или `undefined`. При `undefined` используется каталог. Возвращённая строка интерполируется так же, как шаблон каталога.
|
|
480
495
|
|
|
481
|
-
Резолвер может быть асинхронным: `resolve` вправе вернуть `Promise<string | undefined>`, но такой режим работает только в `validateAsync`
|
|
496
|
+
Резолвер может быть асинхронным: `resolve` вправе вернуть `Promise<string | undefined>`, но такой режим работает только в async-функциях (`validateAsync`, `validatePropertyAsync`, `validatePartialAsync`, `safeParseAsync`, `validateOrThrowAsync`); синхронные `validate`, `validateProperty`, `validatePartial`, `safeParse` и `validateOrThrow` бросят `Error`.
|
|
497
|
+
|
|
498
|
+
Для i18next есть готовый адаптер `createI18nextResolver`:
|
|
499
|
+
|
|
500
|
+
```ts
|
|
501
|
+
import { configureValidation, createI18nextResolver } from "@ivlev-dev/silent-validation";
|
|
502
|
+
import i18next from "i18next";
|
|
503
|
+
|
|
504
|
+
configureValidation({ resolve: createI18nextResolver(i18next) });
|
|
505
|
+
```
|
|
506
|
+
|
|
507
|
+
`createI18nextResolver(i18n, { keyPrefix })` вызывает `i18n.t(prefix + key, { ...params, label, lng: locale, defaultValue, count })`. `lng` — текущая локаль, `label` — ярлык поля, `defaultValue` — встроенный шаблон (или сам ключ, если шаблона нет). `count` передаётся только для `arrayMinSize`, `arrayMaxSize`, `arrayNotEmpty`, `arrayUnique`, `length`, `minLength`, `maxLength`, `each`, `eachValue` и берётся из `params.count`/`min`/`max`/`length`, иначе из длины массива/строки или `Set.size`. Если `i18n.t` вернул не строку, пустую строку или сам ключ, используется встроенный каталог.
|
|
482
508
|
|
|
483
|
-
Для правил размера и длины (`arrayMinSize`, `arrayMaxSize`, `minLength`, `maxLength`) встроенные каталоги содержат плюральные
|
|
509
|
+
Для правил размера и длины (`arrayMinSize`, `arrayMaxSize`, `minLength`, `maxLength`) встроенные каталоги содержат плюральные формы: `_one`/`_few`/`_many`/`_other` в `ru`, `_one`/`_other` в `en`. Форма выбирается по числу из `params.count`/`min`/`max`/`length`, затем по числу значения, длине массива/строки или `Set.size`. Например, для `ru`: `1 символ`, `2 символа`, `5 символов`.
|
|
484
510
|
|
|
485
511
|
## Вложенность
|
|
486
512
|
|
|
@@ -508,12 +534,19 @@ class Order {
|
|
|
508
534
|
public accessor items!: Item[];
|
|
509
535
|
}
|
|
510
536
|
|
|
537
|
+
const order = new Order();
|
|
538
|
+
order.address = new Address();
|
|
539
|
+
order.address.city = "Москва";
|
|
540
|
+
order.items = [new Item()];
|
|
541
|
+
order.items[0]!.name = "Чай";
|
|
542
|
+
order.items[0]!.quantity = 2;
|
|
543
|
+
|
|
511
544
|
const result = validate(order);
|
|
512
545
|
```
|
|
513
546
|
|
|
514
|
-
Пути ошибок: `address.city`, `items[0].name`, `items[2].quantity`.
|
|
547
|
+
Пути ошибок: `address.city`, `items[0].name`, `items[2].quantity`. `ValidationError.index` и плейсхолдер `{index}` заполняются у прямых ошибок элемента коллекции (неверный тип элемента или правило с `each: true`); у ошибок внутри вложенного класса индекс есть только в пути.
|
|
515
548
|
|
|
516
|
-
`@Nested()` проверяет вложенный объект правилами его класса. `@Each()` делает то же для каждого элемента массива или `Set
|
|
549
|
+
`@Nested()` проверяет вложенный объект правилами его класса. `@Each()` делает то же для каждого элемента массива или `Set`: неверная коллекция даёт `validation.eachValue`, неверный элемент — `validation.each`. Для примитивных элементов используйте `@Min(0, { each: true })`.
|
|
517
550
|
|
|
518
551
|
Элементы `@Each()` должны быть созданы конструктором класса с декораторами — правила регистрируются при инициализации экземпляра. Plain-объекты без декораторов считаются валидными (у них нет правил).
|
|
519
552
|
|
|
@@ -521,11 +554,11 @@ const result = validate(order);
|
|
|
521
554
|
|
|
522
555
|
- Поддерживаются только stage-3 `accessor`-поля (`public accessor email!: string`). Обычные поля, приватные (`#field`) и статические поля не поддерживаются — декоратор бросает `TypeError` (и типы не дадут применить его к обычному полю).
|
|
523
556
|
- Optional-поле описывается через `| undefined`: `public accessor age: number | undefined = undefined;`. Синтаксис `accessor age?: number` в TypeScript запрещён.
|
|
524
|
-
- Типы проверяются только из аннотаций `accessor`-полей и только при подключённом плагине `validation()` из `@ivlev-dev/silent-validation-vite`. Обычные поля и поля без аннотации остаются без проверки типов; условные/
|
|
525
|
-
- Валидация явная: ни декораторы, ни типы из аннотаций не запускают проверку без вызова `validate`/`
|
|
557
|
+
- Типы проверяются только из аннотаций `accessor`-полей и только при подключённом плагине `validation()` из `@ivlev-dev/silent-validation-vite`. Обычные поля и поля без аннотации остаются без проверки типов; условные/template/indexed-типы и generic-параметры без конкретизации пропускаются. Mapped-утилиты (`Partial`, `Pick`, `Omit`, `Readonly`, `Required`) поддерживаются структурно.
|
|
558
|
+
- Валидация явная: ни декораторы, ни типы из аннотаций не запускают проверку без вызова `validate`, `validateAsync`, `validateOrThrow`, `validateOrThrowAsync`, `validateProperty`/`validatePropertyAsync`, `validatePartial`/`validatePartialAsync` или `safeParse`/`safeParseAsync`. Исключение — opt-in `@ValidateOnSet`: он проверяет поле при каждом присваивании.
|
|
526
559
|
- Нужны stage 3 декораторы: `experimentalDecorators: false`. Legacy-декораторы (`experimentalDecorators: true`) не поддерживаются.
|
|
527
560
|
- ESM-only, Node.js >= 22.
|
|
528
|
-
- `validate` не
|
|
561
|
+
- Синхронные функции (`validate`, `validateProperty`, `validatePartial`, `safeParse`, `validateOrThrow`) не поддерживают асинхронные правила — используйте `validateAsync`, `validatePropertyAsync`, `validatePartialAsync`, `safeParseAsync` или `validateOrThrowAsync`.
|
|
529
562
|
- Вложенный объект должен быть создан конструктором класса с декораторами: правила регистрируются при инициализации экземпляра. Plain-объекты без декораторов считаются валидными (у них нет правил). Кольцевые ссылки не приводят к бесконечной рекурсии.
|
|
530
563
|
- Пути и сообщения не зависят от фреймворка: пакет не требует `@ivlev-dev/silent-core`.
|
|
531
564
|
|
package/dist/engine.d.ts
CHANGED
|
@@ -1,4 +1,6 @@
|
|
|
1
1
|
import type { FieldKey, SafeParseResult, ValidationOptions, ValidationResult } from "./types.js";
|
|
2
|
+
/** @internal Диагностический счётчик построений плана полей (для тестов). */
|
|
3
|
+
export declare function validationPlanBuilds(): number;
|
|
2
4
|
export declare function validate(instance: object, options?: ValidationOptions): ValidationResult;
|
|
3
5
|
export declare function validateAsync(instance: object, options?: ValidationOptions): Promise<ValidationResult>;
|
|
4
6
|
export declare function validateProperty(instance: object, field: string, options?: ValidationOptions): ValidationResult;
|
package/dist/engine.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"engine.d.ts","sourceRoot":"","sources":["../src/engine.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EACV,QAAQ,EAMR,eAAe,EAGf,iBAAiB,EACjB,gBAAgB,EACjB,MAAM,YAAY,CAAC;
|
|
1
|
+
{"version":3,"file":"engine.d.ts","sourceRoot":"","sources":["../src/engine.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EACV,QAAQ,EAMR,eAAe,EAGf,iBAAiB,EACjB,gBAAgB,EACjB,MAAM,YAAY,CAAC;AAmCpB,6EAA6E;AAC7E,wBAAgB,oBAAoB,IAAI,MAAM,CAE7C;AA2gCD,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,gBAAgB,CAKxF;AAED,wBAAsB,aAAa,CACjC,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,gBAAgB,CAAC,CAK3B;AA8CD,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,iBAAiB,GAC1B,gBAAgB,CAElB;AAED,wBAAsB,qBAAqB,CACzC,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,gBAAgB,CAAC,CAE3B;AAED,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,MAAM,EAChB,GAAG,EAAE,QAAQ,EACb,OAAO,EAAE,iBAAiB,GAAG,SAAS,GACrC,gBAAgB,CAalB;AAED,wBAAgB,eAAe,CAC7B,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,SAAS,MAAM,EAAE,EACzB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,gBAAgB,CAElB;AAED,wBAAsB,oBAAoB,CACxC,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,SAAS,MAAM,EAAE,EACzB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,gBAAgB,CAAC,CAE3B;AAED,wBAAgB,SAAS,CAAC,CAAC,SAAS,MAAM,EACxC,QAAQ,EAAE,CAAC,EACX,OAAO,CAAC,EAAE,iBAAiB,GAC1B,eAAe,CAAC,CAAC,CAAC,CAMpB;AAED,wBAAsB,cAAc,CAAC,CAAC,SAAS,MAAM,EACnD,QAAQ,EAAE,CAAC,EACX,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAM7B;AAED,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,IAAI,CAKnF;AAED,wBAAsB,oBAAoB,CACxC,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,iBAAiB,GAC1B,OAAO,CAAC,IAAI,CAAC,CAKf"}
|