typizer 0.3.0 → 0.4.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.
@@ -1121,9 +1121,9 @@ export const getCatalogPublisher = (options) => (options.client ?? client).get({
1121
1121
  ...options
1122
1122
  });
1123
1123
  /**
1124
- * Каталог готовых схем
1124
+ * Каталог готовых схем и проверок
1125
1125
  *
1126
- * Официальные схемы Typizer и опубликованные организациями (когда они доступны вашей организации). Схемы «по ссылке» в список не попадают. Порядок может немного сдвинуться между страницами при пересчёте популярности (раз в час).
1126
+ * Официальные схемы Typizer и опубликованные организациями (когда они доступны вашей организации). С type=validator — каталог проверок полей (ИНН, СНИЛС, IBAN, VIN…): у каждой есть validator.ref для x-typizer-check. Записи «по ссылке» в список не попадают. Порядок может немного сдвинуться между страницами при пересчёте популярности (раз в час).
1127
1127
  *
1128
1128
  * Доступ: ключ API со скоупом typizers:read или сессия.
1129
1129
  */
@@ -1157,9 +1157,9 @@ export const installCatalogEntry = (options) => (options.client ?? client).post(
1157
1157
  }
1158
1158
  });
1159
1159
  /**
1160
- * Создать типизатор на основе схемы
1160
+ * Создать типизатор или проверку на основе записи каталога
1161
1161
  *
1162
- * Всегда создаёт новый типизатор — вашу копию схемы, которую можно менять. Новые версии источника предлагаются в catalog_source.update. Поддерживает Idempotency-Key.
1162
+ * Схема: всегда создаёт новый типизатор — вашу копию схемы, которую можно менять. Новые версии источника предлагаются в catalog_source.update. С type=validator создаёт вашу проверку my/<slug> с правилом и опубликованными примерами (тело — CatalogForkValidatorRequest; занятый slug — 409 с param: slug), ответ — Validator. Поддерживает Idempotency-Key.
1163
1163
  *
1164
1164
  * Доступ: ключ API со скоупом typizers:write или сессия.
1165
1165
  */
@@ -1209,7 +1209,7 @@ export const favoriteCatalogEntry = (options) => (options.client ?? client).put(
1209
1209
  ...options
1210
1210
  });
1211
1211
  /**
1212
- * Версии схемы, новые первыми
1212
+ * Версии схемы или проверки, новые первыми
1213
1213
  *
1214
1214
  * Доступ: ключ API со скоупом typizers:read или сессия.
1215
1215
  */
@@ -1261,7 +1261,7 @@ export const unpublishCatalogEntry = (options) => (options.client ?? client).pos
1261
1261
  ...options
1262
1262
  });
1263
1263
  /**
1264
- * Схема каталога
1264
+ * Схема или проверка каталога
1265
1265
  *
1266
1266
  * Доступ: ключ API со скоупом typizers:read или сессия.
1267
1267
  */
@@ -1348,6 +1348,184 @@ export const applyTypizerCatalogUpdate = (options) => (options.client ?? client)
1348
1348
  ...options.headers
1349
1349
  }
1350
1350
  });
1351
+ /**
1352
+ * Свои проверки организации, новые первыми
1353
+ *
1354
+ * Доступ: ключ API со скоупом typizers:read или сессия.
1355
+ */
1356
+ export const listValidators = (options) => (options?.client ?? client).get({
1357
+ security: [{ scheme: 'bearer', type: 'http' }, {
1358
+ in: 'cookie',
1359
+ name: '__Secure-better-auth.session_token',
1360
+ type: 'apiKey'
1361
+ }],
1362
+ url: '/v1/validators',
1363
+ ...options
1364
+ });
1365
+ /**
1366
+ * Создать проверку (версия 1.0.0)
1367
+ *
1368
+ * Подключается к полю схемы ссылкой в x-typizer-check: my/<slug>@1. До 500 проверок в организации. Занятый slug (в том числе у архивной проверки) — 409 conflict с param: slug. Поддерживает Idempotency-Key.
1369
+ *
1370
+ * Доступ: ключ API со скоупом typizers:write или сессия.
1371
+ */
1372
+ export const createValidator = (options) => (options.client ?? client).post({
1373
+ security: [{ scheme: 'bearer', type: 'http' }, {
1374
+ in: 'cookie',
1375
+ name: '__Secure-better-auth.session_token',
1376
+ type: 'apiKey'
1377
+ }],
1378
+ url: '/v1/validators',
1379
+ ...options,
1380
+ headers: {
1381
+ 'Content-Type': 'application/json',
1382
+ ...options.headers
1383
+ }
1384
+ });
1385
+ /**
1386
+ * Проверить значения проверкой (без сохранения)
1387
+ *
1388
+ * Передайте ref (сохранённая или официальная проверка) или spec (черновик) и до 100 значений. Ничего не сохраняется, страницы не списываются.
1389
+ *
1390
+ * Доступ: ключ API со скоупом typizers:read или сессия.
1391
+ */
1392
+ export const testValidator = (options) => (options.client ?? client).post({
1393
+ security: [{ scheme: 'bearer', type: 'http' }, {
1394
+ in: 'cookie',
1395
+ name: '__Secure-better-auth.session_token',
1396
+ type: 'apiKey'
1397
+ }],
1398
+ url: '/v1/validators/test',
1399
+ ...options,
1400
+ headers: {
1401
+ 'Content-Type': 'application/json',
1402
+ ...options.headers
1403
+ }
1404
+ });
1405
+ /**
1406
+ * Предложить проверку по описанию и примерам (без сохранения)
1407
+ *
1408
+ * Сначала ищутся готовые проверки (candidates_from_catalog); без описания подходящая под все примеры официальная проверка сразу становится ответом (source: catalog). Без описания правило по возможности выводится из примеров сразу (source: shape) — без модели и без расхода лимита. Иначе проверку составляет модель и прогоняет на ваших примерах до 3 раз; если все примеры так и не сошлись, возвращается лучший вариант с converged: false. Вызов модели расходует одну единицу дневной квоты ассистента, как генерация схемы (сверх неё — 429 с Retry-After). Ничего не сохраняется: сохраните проверку через POST /v1/validators.
1409
+ *
1410
+ * Доступ: ключ API со скоупом typizers:write или сессия.
1411
+ */
1412
+ export const suggestValidator = (options) => (options.client ?? client).post({
1413
+ security: [{ scheme: 'bearer', type: 'http' }, {
1414
+ in: 'cookie',
1415
+ name: '__Secure-better-auth.session_token',
1416
+ type: 'apiKey'
1417
+ }],
1418
+ url: '/v1/validators/suggest',
1419
+ ...options,
1420
+ headers: {
1421
+ 'Content-Type': 'application/json',
1422
+ ...options.headers
1423
+ }
1424
+ });
1425
+ /**
1426
+ * Значения поля из последних прогонов
1427
+ *
1428
+ * Только сессия Кабинета. Уникальные значения поля (path вида seller.inn или items[].amount) из успешных прогонов типизатора за days дней (до 30), самые частые первыми, не больше limit (до 500). Читаются только результаты, которые ещё хранятся (по настройке хранения результатов организации). Ответ не кешируется.
1429
+ *
1430
+ * Доступ: только сессия.
1431
+ *
1432
+ * @deprecated
1433
+ */
1434
+ export const listValidatorFieldValues = (options) => (options.client ?? client).get({
1435
+ security: [{
1436
+ in: 'cookie',
1437
+ name: '__Secure-better-auth.session_token',
1438
+ type: 'apiKey'
1439
+ }],
1440
+ url: '/v1/validators/field-values',
1441
+ ...options
1442
+ });
1443
+ /**
1444
+ * Получить свою проверку по ссылке my/<slug>
1445
+ *
1446
+ * Доступ: ключ API со скоупом typizers:read или сессия.
1447
+ */
1448
+ export const getValidatorBySlug = (options) => (options.client ?? client).get({
1449
+ security: [{ scheme: 'bearer', type: 'http' }, {
1450
+ in: 'cookie',
1451
+ name: '__Secure-better-auth.session_token',
1452
+ type: 'apiKey'
1453
+ }],
1454
+ url: '/v1/validators/my/{slug}',
1455
+ ...options
1456
+ });
1457
+ /**
1458
+ * Архивировать проверку
1459
+ *
1460
+ * Пока проверку использует хотя бы один типизатор — 409 conflict с param: used_by. Версии сохраняются для прогонов, которые их использовали.
1461
+ *
1462
+ * Доступ: ключ API со скоупом typizers:write или сессия.
1463
+ */
1464
+ export const deleteValidator = (options) => (options.client ?? client).delete({
1465
+ security: [{ scheme: 'bearer', type: 'http' }, {
1466
+ in: 'cookie',
1467
+ name: '__Secure-better-auth.session_token',
1468
+ type: 'apiKey'
1469
+ }],
1470
+ url: '/v1/validators/{id}',
1471
+ ...options
1472
+ });
1473
+ /**
1474
+ * Получить проверку с версиями и типизаторами, которые её используют
1475
+ *
1476
+ * Доступ: ключ API со скоупом typizers:read или сессия.
1477
+ */
1478
+ export const getValidator = (options) => (options.client ?? client).get({
1479
+ security: [{ scheme: 'bearer', type: 'http' }, {
1480
+ in: 'cookie',
1481
+ name: '__Secure-better-auth.session_token',
1482
+ type: 'apiKey'
1483
+ }],
1484
+ url: '/v1/validators/{id}',
1485
+ ...options
1486
+ });
1487
+ /**
1488
+ * Изменить проверку (новая версия)
1489
+ *
1490
+ * Версии неизменяемы: изменение создаёт новую версию, semver решает машина (bump). Новая minor/patch сразу получают типизаторы, которые ссылаются на проверку без точной версии (my/x или my/x@1): у них появляется новая версия (propagated_to). Точная ссылка my/x@1.2.0 остаётся на своей версии. Новую major типизаторы не получают сами (suggested_to).
1491
+ *
1492
+ * Доступ: ключ API со скоупом typizers:write или сессия.
1493
+ */
1494
+ export const updateValidator = (options) => (options.client ?? client).patch({
1495
+ security: [{ scheme: 'bearer', type: 'http' }, {
1496
+ in: 'cookie',
1497
+ name: '__Secure-better-auth.session_token',
1498
+ type: 'apiKey'
1499
+ }],
1500
+ url: '/v1/validators/{id}',
1501
+ ...options,
1502
+ headers: {
1503
+ 'Content-Type': 'application/json',
1504
+ ...options.headers
1505
+ }
1506
+ });
1507
+ /**
1508
+ * Опубликовать проверку в каталоге
1509
+ *
1510
+ * Только сессия владельца или администратора; каталог сообщества должен быть включён для организации (иначе 404). Ворота без модели: правило корректно, среди всех примеров текущей версии не меньше 3 проходящих и 2 непроходящих, все сходятся (иначе 400 с param: tests); в публикуемых примерах, значениях списков, сообщениях и описании нет персональных данных (иначе 400 invalid_request с findings: путь и вид, без значений — публикация блокируется). Версия в каталоге — версия проверки. Первая публикация — 201, следующие — 200. Публичная публикация автора без доверия ждёт модератора. Без профиля автора — 409 с param: publisher. Поддерживает Idempotency-Key.
1511
+ *
1512
+ * Доступ: только сессия с ролью owner или admin.
1513
+ *
1514
+ * @deprecated
1515
+ */
1516
+ export const publishValidator = (options) => (options.client ?? client).post({
1517
+ security: [{
1518
+ in: 'cookie',
1519
+ name: '__Secure-better-auth.session_token',
1520
+ type: 'apiKey'
1521
+ }],
1522
+ url: '/v1/validators/{id}/publish',
1523
+ ...options,
1524
+ headers: {
1525
+ 'Content-Type': 'application/json',
1526
+ ...options.headers
1527
+ }
1528
+ });
1351
1529
  /**
1352
1530
  * Запустить типизатор на документе
1353
1531
  *
@@ -1801,7 +1979,7 @@ export const saveAgentThread = (options) => (options.client ?? client).post({
1801
1979
  /**
1802
1980
  * Отправить сообщение; ассистент отвечает потоком server-sent events
1803
1981
  *
1804
- * Только сессия (любая роль); диалог виден пользователю, который его начал. Расходует одну единицу дневной квоты ассистента (100 на организацию и 100 на пользователя, сутки по Москве; сверх квоты 429 с Retry-After до открытия потока). Стоимость модели ассистента также ограничена на пользователя и на организацию за сутки по Москве: когда лимит исчерпан, 429 до открытия потока или событие error с 429, завершающее текущий ход. Одно сообщение за раз в диалоге: 409 conflict, пока ассистент отвечает на предыдущее. Ответ — text/event-stream с событиями message_start, text_delta, tool_call, tool_result, schema_updated, sample_run, ask_user, error (ошибка в формате problem) и последним message_end (stop_reason: end_turn, ask_user, max_steps или aborted); комментарий : ping каждые 15 с. Ход длится не больше 300 с. Idempotency-Key принимается и игнорируется.
1982
+ * Только сессия (любая роль); диалог виден пользователю, который его начал. Расходует одну единицу дневной квоты ассистента (100 на организацию и 100 на пользователя, сутки по Москве; сверх квоты 429 с Retry-After до открытия потока). Стоимость модели ассистента также ограничена на пользователя и на организацию за сутки по Москве: когда лимит исчерпан, 429 до открытия потока или событие error с 429, завершающее текущий ход. Одно сообщение за раз в диалоге: 409 conflict, пока ассистент отвечает на предыдущее. Ответ — text/event-stream с событиями message_start, text_delta, tool_call, tool_result, schema_updated, sample_run, ask_user, validator_draft (карточка проверки), rules_draft (карточка сверок), error (ошибка в формате problem) и последним message_end (stop_reason: end_turn, ask_user, max_steps или aborted); комментарий : ping каждые 15 с. Ход длится не больше 300 с. Idempotency-Key принимается и игнорируется.
1805
1983
  *
1806
1984
  * Доступ: только сессия.
1807
1985
  *