Skip to content

v0.1.0 — Литералы и дискриминированные объединения

Latest

Choose a tag to compare

@zerobig zerobig released this 09 Nov 19:57

zod-1c v0.1.0

Добавлены литералы и дискриминированные объединения - механизмы
для описания объектов с взаимоисключающими полями. Типичный кейс:

{
  "method": "pickup",
  "pickup": { "address": "...", "storeId": 42 }
}

или

{
  "method": "delivery",
  "delivery": { "address": "...", "courierPhone": "..." }
}

Раньше такое описывалось громоздким Zod.Объединение() с перебором всех
вариантов и «кашей» из ошибок. Теперь - одна декларативная конструкция,
аналог z.discriminatedUnion() из Zod 4.

Что нового

Zod.Литерал(Значение)

Схема точного значения. Пропускает только значение, полностью совпадающее
по типу и содержимому:

Zod.Литерал("pickup").Проверить("pickup");   // успешно
Zod.Литерал("pickup").Проверить("delivery"); // провал
Zod.Литерал("1").Проверить(1);               // провал (тип разный)

Zod.ДискриминированноеОбъединение(Дискриминатор, Варианты)

Выбирает ровно один вариант по значению дискриминатора. Валидация
идёт только по нему - отсюда строгая взаимосвязь полей, точные ошибки и
производительность O(1) вместо O(n).

СхемаЗаказа = Zod.ДискриминированноеОбъединение("method", Новый Массив(
    Zod.СтрогийОбъект()
        .Поле("method", Zod.Литерал("pickup"))
        .Поле("pickup", Zod.Объект()
            .Поле("address", Zod.Строки().Непустая())
            .Поле("storeId", Zod.Числа().Целое())),
    Zod.СтрогийОбъект()
        .Поле("method", Zod.Литерал("delivery"))
        .Поле("delivery", Zod.Объект()
            .Поле("address", Zod.Строки().Непустая())
            .Поле("courierPhone", Zod.Строки().Телефон()))
));

// pickup
СхемаЗаказа.Проверить(Новый Структура(
    "method, pickup", "pickup",
    Новый Структура("address, storeId", "ул. Ленина, 1", 42)));

// недопустимый method
СхемаЗаказа.Проверить(Новый Структура("method", "unknown"));

Валидация конфигурации

Ошибки в конфигурации ловятся при построении схемы, а не в рантайме:

  • дубликат значения дискриминатора;
  • поле-дискриминатор не Литерал();
  • у варианта отсутствует поле-дискриминатор;
  • вариант не является объектной схемой.

Новые публичные методы схемы

Для использования плагинами и составными схемами:

  • Схема.ПолучитьТип() - тип схемы.
  • Схема.ПолучитьЛитерал() - значение литерала.
  • Схема.НайтиСхемуПоля(Имя) - схема поля по имени.

Совместимость

  • Обратная совместимость полная. Все изменения аддитивны: новые
    фабрики, новые ветки в диспетчере типов. Существующий код не затронут.
  • Совместимость с swagger-1c 2.0.0+ сохраняется.
  • Совместимость с .Необязательное(), .ДопускаетNull(),
    .Трансформировать(), .Проверка()
    - работает как для обычных схем.
  • Покрытие тестами: 23 новых теста в YaxUnit
    (Zod_Литерал_ДискриминированноеОбъединение_Тесты).

Полный список изменений

См. CHANGELOG.md.