letopis 1.4.2 → 2.0.0

package/dist/messages/access.d.ts

@@ -0,0 +1,90 @@
+export declare const access: {
+    'access.switch_not_root': {
+        code: "invalid_query";
+        ru: string;
+        hint: string;
+    };
+    'access.role_not_string': {
+        code: "invalid_data";
+        ru: string;
+        hint: string;
+    };
+    'access.bad_role_name': {
+        code: "invalid_data";
+        ru: string;
+        hint: string;
+    };
+    'access.bad_condition_column': {
+        code: "invalid_data";
+        ru: string;
+        hint: string;
+    };
+    'access.bad_rule_target': {
+        code: "invalid_data";
+        ru: string;
+        hint: string;
+    };
+    'access.bad_endpoint_mask': {
+        code: "invalid_data";
+        ru: string;
+        hint: string;
+    };
+    'access.rule_spec_not_object': {
+        code: "invalid_data";
+        ru: string;
+        hint: string;
+    };
+    'access.unknown_rule_field': {
+        code: "invalid_data";
+        ru: string;
+        hint: string;
+    };
+    'access.bad_rule_weight': {
+        code: "invalid_data";
+        ru: string;
+        hint: string;
+    };
+    'access.rule_who': {
+        code: "invalid_data";
+        ru: string;
+        hint: string;
+    };
+    'access.no_rule_operations': {
+        code: "invalid_data";
+        ru: string;
+        hint: string;
+    };
+    'access.no_facade': {
+        code: "invalid_query";
+        ru: string;
+    };
+    'access.bad_account': {
+        code: "invalid_data";
+        ru: string;
+        hint: string;
+    };
+    'access.no_session_tenant': {
+        code: "no_session";
+        ru: string;
+    };
+    'access.roles_not_array': {
+        code: "invalid_data";
+        ru: string;
+        hint: string;
+    };
+    'access.duplicate_roles': {
+        code: "invalid_data";
+        ru: string;
+        hint: string;
+    };
+    'access.bad_scrypt_params': {
+        code: "invalid_data";
+        ru: string;
+        hint: string;
+    };
+    'access.bad_totp_secret': {
+        code: "invalid_data";
+        ru: string;
+        hint: string;
+    };
+};

package/dist/messages/access.js

@@ -0,0 +1,113 @@
+/**
+ * Подсказка неверного вызова db.acl: общая подсказка invalid_data — про issues, а у этих ошибок их нет. Параметр what в
+ * записях db.acl — метод (grant, deny, revoke, roles), с которого начинается текст.
+ */
+const ACL_CALL = 'исправить аргумент по тексту ошибки; вызовы db.acl — README, «Выдать право»';
+export const access = {
+    // auth.ts, switch(): фасад db.as() арендатора не меняет
+    'access.switch_not_root': {
+        code: 'invalid_query',
+        ru: 'auth.switch() — от корня подключения: при имперсонации арендатора задаёт db.as(…, { tenant })',
+        hint: 'сменить арендатора корня — db.auth.switch(); фасаду db.as() арендатора задают при создании: db.as(аккаунт, { tenant })',
+    },
+    // acl.ts, roleName: роль в grant, deny, revoke или в списке db.acl.roles — не строка; type — её тип
+    'access.role_not_string': {
+        code: 'invalid_data',
+        ru: 'db.acl.{what}: role — строка, а не {type}',
+        hint: ACL_CALL,
+    },
+    // acl.ts, roleName: имя роли пустое, с запятой или фигурной скобкой, с «!» в начале или с пробелом по краям
+    'access.bad_role_name': {
+        code: 'invalid_data',
+        ru: 'db.acl.{what}: роль {role} — непустая строка без запятых и фигурных скобок, без «!» в начале и пробелов по краям',
+        hint: ACL_CALL,
+    },
+    // acl.ts, classItem: условие цели правила — на колонку не из списка
+    'access.bad_condition_column': {
+        code: 'invalid_data',
+        ru: 'db.acl.{what}: условие на колонку {column} — условие ставят на {columns}',
+        hint: ACL_CALL,
+    },
+    // acl.ts, classItem: цель read, write или delete — не имя класса, не звёздочка и не объект с полем class
+    'access.bad_rule_target': {
+        code: 'invalid_data',
+        ru: "db.acl.{what}: цель {target} — имя класса, '*' (все классы) или { class, …условие на строки }",
+        hint: ACL_CALL,
+    },
+    // acl.ts, apiItem: цель api — не маска эндпоинта
+    'access.bad_endpoint_mask': {
+        code: 'invalid_data',
+        ru: 'db.acl.{what}: api {endpoint} — маска эндпоинта: сегменты через «.», {a,b} — любой из, * — хвост',
+        hint: ACL_CALL,
+    },
+    // acl.ts, parse: описание правила grant, deny или revoke — не объект
+    'access.rule_spec_not_object': {
+        code: 'invalid_data',
+        ru: 'db.acl.{what}: нужен объект { role, read | write | delete | api }',
+        hint: ACL_CALL,
+    },
+    // acl.ts, parse: лишнее поле в описании правила (у revoke нет и weight)
+    'access.unknown_rule_field': {
+        code: 'invalid_data',
+        ru: 'db.acl.{what}: поле {field} — допустимы {fields}',
+        hint: ACL_CALL,
+    },
+    // acl.ts, parse: weight — не целое от 1 до 999
+    'access.bad_rule_weight': {
+        code: 'invalid_data',
+        ru: 'db.acl.{what}: weight — целое от 1 до 999: вес правила арендатора (от 1000 — административный слой System)',
+        hint: ACL_CALL,
+    },
+    // acl.ts, parse: кому правило — нет ни role, ни everyone, есть оба или everyone не true
+    'access.rule_who': {
+        code: 'invalid_data',
+        ru: 'db.acl.{what}: кому правило — ровно одно из role (роль членства) и everyone: true (все аккаунты арендатора)',
+        hint: ACL_CALL,
+    },
+    // acl.ts, parse: в описании правила нет ни read, ни write, ни delete, ни api
+    'access.no_rule_operations': {
+        code: 'invalid_data',
+        ru: 'db.acl.{what}: нужна хотя бы одна операция: read, write, delete или api',
+        hint: ACL_CALL,
+    },
+    // acl.ts, makeAcl: db.acl без фасада подключения, а grant, deny, revoke, roles и list идут его цепочками
+    'access.no_facade': {
+        code: 'invalid_query',
+        ru: 'db.acl: запись правил — от фасада подключения',
+    },
+    // acl.ts, roles(): аккаунт — не id и не строка с полем id
+    'access.bad_account': {
+        code: 'invalid_data',
+        ru: 'db.acl.roles: аккаунт — id или строка с полем id',
+        hint: ACL_CALL,
+    },
+    // acl.ts, roles() и list(): у фасада нет рабочего арендатора — подключение без сессии; what — метод
+    'access.no_session_tenant': {
+        code: 'no_session',
+        ru: 'db.acl.{what}: нет арендатора сессии',
+    },
+    // acl.ts, roles(): роли — не массив и не null
+    'access.roles_not_array': {
+        code: 'invalid_data',
+        ru: 'db.acl.roles: роли — массив строк или null (снять членство)',
+        hint: ACL_CALL,
+    },
+    // acl.ts, roles(): роль в списке повторяется
+    'access.duplicate_roles': {
+        code: 'invalid_data',
+        ru: 'db.acl.roles: роли повторяются',
+        hint: ACL_CALL,
+    },
+    // auth.ts, verifyHash: scrypt отверг N, r, p из строки хэша — недопустимы или требуют больше 64 МБ памяти
+    'access.bad_scrypt_params': {
+        code: 'invalid_data',
+        ru: 'хэш пароля: параметры scrypt N={N}, r={r}, p={p} недопустимы или требуют больше 64 МБ памяти',
+        hint: 'хэш с такими параметрами не проверить: задать пароль заново — auth.setPassword()',
+    },
+    // auth.ts, base32Decode: в секрете TOTP (totpCode) знак не из алфавита base32
+    'access.bad_totp_secret': {
+        code: 'invalid_data',
+        ru: 'секрет TOTP — не base32',
+        hint: 'передать секрет из auth.enrollTotp() — строку base32 (A–Z, 2–7)',
+    },
+};

package/dist/messages/api.d.ts

@@ -0,0 +1,171 @@
+export declare const api: {
+    'api.validation_failed': {
+        code: "invalid_data";
+        ru: string;
+    };
+    'api.unknown_step': {
+        code: "invalid_class";
+        ru: string;
+    };
+    'api.connect_schema': {
+        code: "invalid_data";
+        ru: string;
+        hint: string;
+    };
+    'api.unknown_option': {
+        code: "invalid_data";
+        ru: string;
+        hint: string;
+    };
+    'api.row_check_denied': {
+        code: "acl_denied";
+        ru: string;
+    };
+    'api.no_history': {
+        code: "invalid_query";
+        ru: string;
+    };
+    'api.slow_query': {
+        code: "invalid_query";
+        ru: string;
+    };
+    'api.batch_queued': {
+        code: "invalid_query";
+        ru: string;
+    };
+    'api.mod_after_verb': {
+        code: "invalid_query";
+        ru: string;
+    };
+    'api.after_not_paged': {
+        code: "invalid_query";
+        ru: string;
+        hint: string;
+    };
+    'api.for_update_outside_tx': {
+        code: "tx_required";
+        ru: string;
+    };
+    'api.for_update_unsupported': {
+        code: "lock_unsupported";
+        ru: string;
+    };
+    'api.lock_denied': {
+        code: "acl_denied";
+        ru: string;
+    };
+    'api.slot_value': {
+        code: "invalid_query";
+        ru: string;
+    };
+    'api.slot_without_write': {
+        code: "invalid_query";
+        ru: string;
+    };
+    'api.slot_single': {
+        code: "invalid_query";
+        ru: string;
+    };
+    'api.slot_required': {
+        code: "invalid_query";
+        ru: string;
+    };
+    'api.slot_twice': {
+        code: "invalid_query";
+        ru: string;
+    };
+    'api.step_mod_after_verb': {
+        code: "invalid_query";
+        ru: string;
+    };
+    'api.verb_without_step': {
+        code: "invalid_query";
+        ru: string;
+    };
+    'api.entity_with_verbs': {
+        code: "invalid_query";
+        ru: string;
+    };
+    'api.entity_arg': {
+        code: "invalid_query";
+        ru: string;
+    };
+    'api.slot_method': {
+        code: "invalid_query";
+        ru: string;
+    };
+    'api.cache_ttl': {
+        code: "invalid_query";
+        ru: string;
+    };
+    'api.tx_only': {
+        code: "tx_required";
+        ru: string;
+    };
+    'api.id_of_no_tenant': {
+        code: "no_session";
+        ru: string;
+    };
+    'api.as_in_tx': {
+        code: "invalid_query";
+        ru: string;
+    };
+    'api.as_no_session': {
+        code: "no_session";
+        ru: string;
+    };
+    'api.as_context_changing': {
+        code: "no_session";
+        ru: string;
+        hint: string;
+    };
+    'api.nested_begin': {
+        code: "invalid_query";
+        ru: string;
+    };
+    'api.load_in_tx': {
+        code: "invalid_query";
+        ru: string;
+    };
+    'api.connect_no_dsn': {
+        code: "invalid_data";
+        ru: string;
+        hint: string;
+    };
+    'api.connect_admin_type': {
+        code: "invalid_data";
+        ru: string;
+        hint: string;
+    };
+    'api.connect_admin_role': {
+        code: "admin_required";
+        ru: string;
+        hint: string;
+    };
+    'api.connect_no_owner': {
+        code: "invalid_data";
+        ru: string;
+        hint: string;
+    };
+    'api.connect_bypass_rls': {
+        code: "bypass_rls";
+        ru: string;
+    };
+    'api.admin_connection': {
+        code: "bypass_rls";
+        ru: string;
+    };
+    'api.connect_no_schema': {
+        code: "invalid_data";
+        ru: string;
+        hint: string;
+    };
+    'api.schema_older': {
+        code: "invalid_data";
+        ru: string;
+    };
+    'api.schema_newer': {
+        code: "invalid_data";
+        ru: string;
+    };
+};

package/dist/messages/api.js

@@ -0,0 +1,215 @@
+export const api = {
+    // errors.ts, ValidationError: данные не проходят проверку на TypeScript (из базы — sql-write.invalid_data)
+    'api.validation_failed': {
+        code: 'invalid_data',
+        ru: 'данные не проходят описание класса {cls}',
+    },
+    // chain.ts: шаг цепочки — не класс, не алиас и не роль реестра сессии; похожие имена — params.similar
+    'api.unknown_step': {
+        code: 'invalid_class',
+        ru: 'класс или роль {name} не найдены',
+    },
+    // index.ts: connect({ schema })
+    'api.connect_schema': {
+        code: 'invalid_data',
+        ru: 'connect: схема {schema} — нужно v<N>.<имя>',
+        hint: 'имя схемы — v<N>.<имя>, как у up({ schema }): например, v2.salon',
+    },
+    // errors.ts, checkOptions: неизвестная опция connect(), up(), load(), watch(), createMcpServer() — в 1.5
+    // было предупреждение, с 2.0 — ошибка (план 2.0, этап 4, п. 2; 7.10 №4)
+    'api.unknown_option': {
+        code: 'invalid_data',
+        ru: 'неизвестная опция {where}({ {name} })',
+        hint: 'проверить имя опции: похожие названы в тексте, все опции — в README, «Справочник API»',
+    },
+    // errors.ts, fromDbError: новые значения строки не проходят условие ACL (политика RLS WITH CHECK)
+    'api.row_check_denied': {
+        code: 'acl_denied',
+        ru: 'новые значения строки запрещают правила доступа',
+    },
+    // chain.ts, warnNoHistory: versions(), asOf() у класса без журнала — предупреждение (lwarn), один раз
+    // на класс и метод; код записи не печатается
+    'api.no_history': {
+        code: 'invalid_query',
+        ru: '.{method}() у класса {cls} без журнала (history: false) — истории нет',
+    },
+    // chain.ts, report: медленный запрос без хука onQuery — предупреждение (lwarn); ms — целое, classes — классы шагов через →
+    'api.slow_query': {
+        code: 'invalid_query',
+        ru: 'медленный запрос {ms} мс — {mode} {classes}',
+    },
+    // chain.ts: терминал у цепочки батча с глаголами
+    'api.batch_queued': {
+        code: 'invalid_query',
+        ru: 'план стоит в очереди батча — его исполнит batch.run()',
+    },
+    // chain.ts, afterVerbError: модификатор выборки сразу после глагола перед rows, first, ids, count, paths (и в batch.run())
+    'api.mod_after_verb': {
+        code: 'invalid_query',
+        ru: '{name}() после {verb}() ни на что не действует: глагол проходит по всем целям шага, а ответ — его строки. Цели сужают limit(), offset() и sort() до глагола: db.Класс(…).limit(n).{verb}(…)',
+    },
+    // chain.ts, afterNotPaged: after() перед count() или агрегатом чтения (sum, avg, min, max, countBy) — с 2.0 отказ, в 1.x
+    // курсор там молча не учитывался (план 2.0, этап 4, п. 2; 7.10 №7); fn — имя терминала
+    'api.after_not_paged': {
+        code: 'invalid_query',
+        ru: '{fn}() не листается: after() сдвигает начало страницы rows(), ids(), versions() и paths(), а {fn}() считает по всем объектам шага',
+        hint: 'убрать after() перед счётом и агрегатом; сузить то, что считается, — фильтром шага',
+    },
+    // chain.ts, lockedRead: forUpdate() вне db.begin()
+    'api.for_update_outside_tx': {
+        code: 'tx_required',
+        ru: 'forUpdate() — только внутри db.begin(): вне явной транзакции блокировка снялась бы сразу',
+    },
+    // chain.ts, lockedRead: forUpdate() с другим терминалом, агрегатом, срезом, глаголом
+    'api.for_update_unsupported': {
+        code: 'lock_unsupported',
+        ru: 'forUpdate() — с терминалами rows, first, ids, без агрегатов, asOf, versions, withDeleted, deep и глаголов',
+    },
+    // chain.ts, lockedRead: строки видны, но политика правки не даёт их заблокировать; ids — через запятую (detail.ids — списком)
+    'api.lock_denied': {
+        code: 'acl_denied',
+        ru: 'строки видны, но заблокировать их нельзя: {ids}',
+    },
+    // chain.ts, slotValue: значение .Роль.set(…), .add(…), .remove(…)
+    'api.slot_value': {
+        code: 'invalid_query',
+        ru: 'значение слота — id, список id, строка ответа или цепочка',
+    },
+    // chain.ts: слот не сразу после create(), update() или upsert(); name — роль, как вызвана, op — set, unset, add, remove
+    'api.slot_without_write': {
+        code: 'invalid_query',
+        ru: 'слот .{name}.{op}() — после create(), update() или upsert(): db.Класс(…).update(…).{name}.{op}(…)',
+    },
+    // chain.ts: add() или remove() у одиночного конца
+    'api.slot_single': {
+        code: 'invalid_query',
+        ru: 'слот .{name}.{op}(): конец {role} одиночный — set() или unset()',
+    },
+    // chain.ts: unset() у обязательного конца
+    'api.slot_required': {
+        code: 'invalid_query',
+        ru: 'слот .{name}.unset(): конец {role} обязателен',
+    },
+    // chain.ts: set() или unset() одного конца дважды в одной записи
+    'api.slot_twice': {
+        code: 'invalid_query',
+        ru: 'слот {role} задан дважды в одной записи',
+    },
+    // chain.ts, withLast: deep(), exact(), alias(), tags(), owner() сразу после глагола; verb — глагол
+    'api.step_mod_after_verb': {
+        code: 'invalid_query',
+        ru: 'модификатор шага после {verb}() — сначала шаг класса',
+    },
+    // chain.ts, withOp: глагол без шага класса
+    'api.verb_without_step': {
+        code: 'invalid_query',
+        ru: '{verb}() — нужен шаг класса: db.Класс(…).{verb}(…)',
+    },
+    // chain.ts, entity(): цепочка с глаголами
+    'api.entity_with_verbs': {
+        code: 'invalid_query',
+        ru: 'entity() принимает читающий паттерн — цепочку с глаголами вклеить нельзя',
+    },
+    // chain.ts, entity(): не цепочка и не строка ответа
+    'api.entity_arg': {
+        code: 'invalid_query',
+        ru: 'entity() принимает ленивую цепочку или строку ответа',
+    },
+    // chain.ts: set, unset, add, remove у цепочки, а не у слота роли; method — имя метода
+    'api.slot_method': {
+        code: 'invalid_query',
+        ru: '{method}() — метод слота: db.Класс(…).update(…).Роль.{method}(…)',
+    },
+    // chain.ts: cache({ ttl })
+    'api.cache_ttl': {
+        code: 'invalid_query',
+        ru: 'cache({ ttl }): срок — положительное число секунд',
+    },
+    // index.ts, noTx: lock(), commit(), rollback() вне db.begin(); what — вызов
+    'api.tx_only': {
+        code: 'tx_required',
+        ru: '{what} — только внутри db.begin()',
+    },
+    // index.ts: db.idOf() без арендатора сессии
+    'api.id_of_no_tenant': {
+        code: 'no_session',
+        ru: 'idOf: нет арендатора сессии',
+    },
+    // index.ts: db.as() внутри db.begin()
+    'api.as_in_tx': {
+        code: 'invalid_query',
+        ru: 'db.as() — от корня подключения, а не внутри db.begin()',
+    },
+    // index.ts: db.as() — сессии нет (первое чтение контекста и повторное, если контекст ушёл из арендатора)
+    'api.as_no_session': {
+        code: 'no_session',
+        ru: 'db.as(): нет действующей сессии',
+    },
+    // index.ts: db.as() — контекст сессии трижды ушёл из арендатора, пока грузился реестр
+    'api.as_context_changing': {
+        code: 'no_session',
+        ru: 'db.as(): контекст сессии меняется — реестр арендатора не загружен',
+        hint: 'повторить вызов: между запросами db.as() сессия сменила арендатора или кончилась',
+    },
+    // index.ts: db.begin() внутри db.begin()
+    'api.nested_begin': {
+        code: 'invalid_query',
+        ru: 'вложенных транзакций нет: db.begin() внутри db.begin()',
+    },
+    // index.ts: db.load() внутри db.begin()
+    'api.load_in_tx': {
+        code: 'invalid_query',
+        ru: 'load() — своей транзакцией, не внутри db.begin()',
+    },
+    // index.ts: connect() без dsn и sql
+    'api.connect_no_dsn': {
+        code: 'invalid_data',
+        ru: 'connect: нужен dsn или sql',
+        hint: 'передать dsn — строку подключения — или sql — готовый пул postgres.js',
+    },
+    // index.ts: connect({ admin }) — не строка и не пул
+    'api.connect_admin_type': {
+        code: 'invalid_data',
+        ru: 'connect: admin — строка подключения администратора или пул postgres.js',
+        hint: 'передать в admin строку подключения администратора или пул postgres.js либо убрать опцию',
+    },
+    // index.ts, adminReady: роль строки admin не может стать владельцем схемы; owner — роль-владелец
+    'api.connect_admin_role': {
+        code: 'admin_required',
+        ru: 'connect({ admin }): роль администраторской строки подключения не может стать владельцем схемы — нужен суперпользователь или роль с SET на {owner}',
+        hint: 'для admin взять строку подключения суперпользователя или роли с правом SET на роль-владельца',
+    },
+    // index.ts: роли владельца (опция owner) в базе нет
+    'api.connect_no_owner': {
+        code: 'invalid_data',
+        ru: 'connect: роли владельца {owner} в базе нет — проверьте опцию owner (по умолчанию letopis_owner)',
+        hint: 'указать в owner роль-владельца, с которой up() ставил схему (по умолчанию letopis_owner)',
+    },
+    // index.ts: роль подключения обходит RLS, а allowBypassRls нет
+    'api.connect_bypass_rls': {
+        code: 'bypass_rls',
+        ru: 'роль подключения обходит RLS (суперпользователь, BYPASSRLS или член роли-владельца); администраторское подключение — только с опцией allowBypassRls',
+    },
+    // index.ts: подключение с allowBypassRls — предупреждение (lwarn)
+    'api.admin_connection': {
+        code: 'bypass_rls',
+        ru: 'администраторское подключение — RLS не действует, данные всех арендаторов видны',
+    },
+    // index.ts: схемы нет
+    'api.connect_no_schema': {
+        code: 'invalid_data',
+        ru: 'connect: схемы {schema} нет — установите её: up({ schema })',
+        hint: 'установить схему up({ schema }) или исправить имя в connect({ schema })',
+    },
+    // index.ts: ревизия движка схемы 2.x старше библиотеки — предупреждение (lwarn); want — DDL_REVISION. Схема 1.x — отказ
+    // boot.schema_1x (refuse1x в up.ts)
+    'api.schema_older': {
+        code: 'invalid_data',
+        ru: "движок схемы {schema} ревизии {rev}, библиотека ждёт {want} — обновите: up({ schema: '{schema}', upgrade: true })",
+    },
+    // index.ts: ревизия движка схемы новее библиотеки — предупреждение (lwarn); known — DDL_REVISION
+    'api.schema_newer': {
+        code: 'invalid_data',
+        ru: 'движок схемы {schema} ревизии {rev} новее библиотеки (она знает {known}) — обновите пакет letopis',
+    },
+};