DZakh/sury

Что это?

Ключевые возможности

• 01Разбирает и кодирует данные по единственному описанию схемы, автоматически выводя типы TypeScript.
• 02Встроенные wire-форматы для строк JSON, данных форм, переменных окружения, Protobuf, base64, File и Blob.
• 03Поддерживает Standard Schema, поэтому библиотека интегрируется с tRPC, Hono и другими совместимыми библиотеками.
• 04Преобразует данные в JSON Schema и обратно, а также генерирует определения .proto из схем Protobuf.
• 05Сообщает обо всех ошибках валидации с указанием пути и выбрасывает исключение для значений, которые JSON.stringify незаметно исказил бы.

Сценарии использования

• Валидация тел запросов и ответов API на стороне TypeScript-бэкенда или клиента.
• Разбор и формирование multipart-форм с типизированными полями и файлами.
• Чтение переменных окружения в типизированную конфигурацию со значениями по умолчанию и валидацией.
• Кодирование и декодирование сообщений Protobuf без поддержки сгенерированного кода.

Быстрый старт

1. 1

   Установите пакет из npm

   npm install sury
2. 2

   Импортируйте библиотеку в код TypeScript и объявите схему

Что важно знать

• !Несколько wire-форматов, включая S.request, S.response, S.capnp, S.rkyv и S.toon, указаны как планируемые и пока недоступны.
• !Импорт JSON Schema проходит около 93% официального набора тестов draft-07, поэтому некоторые схемы могут быть преобразованы не полностью.

Темы

Частые вопросы

Что такое sury?

Библиотека схем для TypeScript и ReScript: проверяет, разбирает и кодирует данные по одному описанию в JSON, формах и Protobuf. Sury — библиотека схем для TypeScript и ReScript. Достаточно один раз описать модель данных: та же схема будет разбирать недоверенный ввод в типизированные значения, кодировать типизированные значения обратно в wire-формат и выводить типы TypeScript из описания. Схемы можно объединять в цепочки: wire-формат, например строка base64url или текст JSON, становится промежуточным этапом между исходными данными и моделью.

sury можно использовать бесплатно? Какая у него лицензия?

sury распространяется с открытым исходным кодом под лицензией MIT. Перед использованием в коммерческих продуктах проверьте условия лицензии.

sury всё ещё поддерживается?

Активно поддерживается. Последний коммит в sury — 5 нояб. 2026 г..

Для чего можно использовать sury?

Валидация тел запросов и ответов API на стороне TypeScript-бэкенда или клиента. Разбор и формирование multipart-форм с типизированными полями и файлами. Чтение переменных окружения в типизированную конфигурацию со значениями по умолчанию и валидацией. Кодирование и декодирование сообщений Protobuf без поддержки сгенерированного кода.

Как установить sury?

Установите пакет из npm: npm install sury Импортируйте библиотеку в код TypeScript и объявите схему

Где скачать sury?

Исходный код и инструкции по установке — на GitHub: https://github.com/DZakh/sury