@stapel/chat-react 0.1.0

package/src/i18n/generated/errors.json

@@ -0,0 +1,408 @@
+[
+  {
+    "code": "error.400.bad_request",
+    "status": 400,
+    "params": [],
+    "remediation": "fix_input",
+    "en": "Bad request"
+  },
+  {
+    "code": "error.400.captcha_invalid",
+    "status": 400,
+    "params": [],
+    "remediation": "retry",
+    "en": "Captcha verification failed. Please try again."
+  },
+  {
+    "code": "error.400.captcha_required",
+    "status": 400,
+    "params": [],
+    "remediation": "retry",
+    "en": "Captcha token is required."
+  },
+  {
+    "code": "error.400.chat_attachments_disabled",
+    "status": 400,
+    "params": [],
+    "remediation": "fix_input",
+    "en": "Attachments are not enabled in this deployment"
+  },
+  {
+    "code": "error.400.chat_body_too_long",
+    "status": 400,
+    "params": [],
+    "remediation": "fix_input",
+    "en": "Message body exceeds the maximum allowed length"
+  },
+  {
+    "code": "error.400.chat_empty_message",
+    "status": 400,
+    "params": [],
+    "remediation": "fix_input",
+    "en": "A message must carry a body or at least one attachment"
+  },
+  {
+    "code": "error.400.chat_invalid_direct",
+    "status": 400,
+    "params": [],
+    "remediation": "fix_input",
+    "en": "A direct conversation needs exactly one other participant"
+  },
+  {
+    "code": "error.400.chat_invalid_kind",
+    "status": 400,
+    "params": [],
+    "remediation": "fix_input",
+    "en": "Unknown conversation kind"
+  },
+  {
+    "code": "error.400.chat_invalid_reply",
+    "status": 400,
+    "params": [],
+    "remediation": "fix_input",
+    "en": "The replied-to message does not belong to this conversation"
+  },
+  {
+    "code": "error.400.chat_kind_disabled",
+    "status": 400,
+    "params": [],
+    "remediation": "fix_input",
+    "en": "This conversation kind is not enabled in this deployment"
+  },
+  {
+    "code": "error.400.chat_not_support",
+    "status": 400,
+    "params": [],
+    "remediation": "fix_input",
+    "en": "This operation applies only to support conversations"
+  },
+  {
+    "code": "error.400.expected_list",
+    "status": 400,
+    "params": [],
+    "remediation": "fix_input",
+    "en": "Expected a list of items"
+  },
+  {
+    "code": "error.400.field.blank",
+    "status": 400,
+    "params": [
+      "field"
+    ],
+    "remediation": "fix_input",
+    "en": "{field} may not be blank"
+  },
+  {
+    "code": "error.400.field.does_not_exist",
+    "status": 400,
+    "params": [
+      "field"
+    ],
+    "remediation": "fix_input",
+    "en": "{field} does not exist"
+  },
+  {
+    "code": "error.400.field.invalid",
+    "status": 400,
+    "params": [
+      "field"
+    ],
+    "remediation": "fix_input",
+    "en": "{field} is invalid"
+  },
+  {
+    "code": "error.400.field.invalid_choice",
+    "status": 400,
+    "params": [
+      "field"
+    ],
+    "remediation": "fix_input",
+    "en": "{field} is not a valid choice"
+  },
+  {
+    "code": "error.400.field.max_length",
+    "status": 400,
+    "params": [
+      "field",
+      "max_length"
+    ],
+    "remediation": "fix_input",
+    "en": "{field} must be at most {max_length} characters"
+  },
+  {
+    "code": "error.400.field.max_value",
+    "status": 400,
+    "params": [
+      "field",
+      "max_value"
+    ],
+    "remediation": "fix_input",
+    "en": "{field} must be at most {max_value}"
+  },
+  {
+    "code": "error.400.field.min_length",
+    "status": 400,
+    "params": [
+      "field",
+      "min_length"
+    ],
+    "remediation": "fix_input",
+    "en": "{field} must be at least {min_length} characters"
+  },
+  {
+    "code": "error.400.field.min_value",
+    "status": 400,
+    "params": [
+      "field",
+      "min_value"
+    ],
+    "remediation": "fix_input",
+    "en": "{field} must be at least {min_value}"
+  },
+  {
+    "code": "error.400.field.null",
+    "status": 400,
+    "params": [
+      "field"
+    ],
+    "remediation": "fix_input",
+    "en": "{field} may not be null"
+  },
+  {
+    "code": "error.400.field.required",
+    "status": 400,
+    "params": [
+      "field"
+    ],
+    "remediation": "fix_input",
+    "en": "{field} is required"
+  },
+  {
+    "code": "error.400.field.unique",
+    "status": 400,
+    "params": [
+      "field"
+    ],
+    "remediation": "fix_input",
+    "en": "{field} must be unique"
+  },
+  {
+    "code": "error.400.invalid_ad_id",
+    "status": 400,
+    "params": [],
+    "remediation": "fix_input",
+    "en": "Invalid advertisement ID"
+  },
+  {
+    "code": "error.400.validation_error",
+    "status": 400,
+    "params": [],
+    "remediation": "fix_input",
+    "en": "Validation error"
+  },
+  {
+    "code": "error.400.verification_failed",
+    "status": 400,
+    "params": [],
+    "remediation": "verify",
+    "en": "Verification failed"
+  },
+  {
+    "code": "error.400.verification_invalid_factor",
+    "status": 400,
+    "params": [],
+    "remediation": "verify",
+    "en": "This verification factor is not available"
+  },
+  {
+    "code": "error.401.unauthorized",
+    "status": 401,
+    "params": [],
+    "remediation": "reauthenticate",
+    "en": "Authentication required"
+  },
+  {
+    "code": "error.402.payment_required",
+    "status": 402,
+    "params": [],
+    "remediation": "retry",
+    "en": "Payment required"
+  },
+  {
+    "code": "error.403.chat_not_operator",
+    "status": 403,
+    "params": [],
+    "remediation": "retry",
+    "en": "Only a support operator may perform this action"
+  },
+  {
+    "code": "error.403.chat_not_participant",
+    "status": 403,
+    "params": [],
+    "remediation": "retry",
+    "en": "You are not a participant of this conversation"
+  },
+  {
+    "code": "error.403.forbidden",
+    "status": 403,
+    "params": [],
+    "remediation": "retry",
+    "en": "You do not have permission to perform this action"
+  },
+  {
+    "code": "error.403.network_blocked",
+    "status": 403,
+    "params": [],
+    "remediation": "contact_support",
+    "en": "Requests from this network are not allowed"
+  },
+  {
+    "code": "error.403.verification_enrollment_required",
+    "status": 403,
+    "params": [],
+    "remediation": "verify",
+    "en": "Verification factor enrollment required"
+  },
+  {
+    "code": "error.403.verification_required",
+    "status": 403,
+    "params": [],
+    "remediation": "verify",
+    "en": "Additional verification required"
+  },
+  {
+    "code": "error.404.ad_not_found",
+    "status": 404,
+    "params": [],
+    "remediation": "retry",
+    "en": "Listing not found"
+  },
+  {
+    "code": "error.404.chat_conversation_not_found",
+    "status": 404,
+    "params": [],
+    "remediation": "retry",
+    "en": "Conversation not found"
+  },
+  {
+    "code": "error.404.not_found",
+    "status": 404,
+    "params": [],
+    "remediation": "retry",
+    "en": "Requested resource not found"
+  },
+  {
+    "code": "error.404.verification_challenge_not_found",
+    "status": 404,
+    "params": [],
+    "remediation": "verify",
+    "en": "Verification challenge not found or expired"
+  },
+  {
+    "code": "error.405.method_not_allowed",
+    "status": 405,
+    "params": [],
+    "remediation": "retry",
+    "en": "Method not allowed"
+  },
+  {
+    "code": "error.406.not_acceptable",
+    "status": 406,
+    "params": [],
+    "remediation": "retry",
+    "en": "Not acceptable"
+  },
+  {
+    "code": "error.408.request_timeout",
+    "status": 408,
+    "params": [],
+    "remediation": "retry",
+    "en": "Request timeout"
+  },
+  {
+    "code": "error.409.chat_already_assigned",
+    "status": 409,
+    "params": [],
+    "remediation": "fix_input",
+    "en": "This support conversation is already assigned"
+  },
+  {
+    "code": "error.409.conflict",
+    "status": 409,
+    "params": [],
+    "remediation": "fix_input",
+    "en": "Resource already exists"
+  },
+  {
+    "code": "error.410.gone",
+    "status": 410,
+    "params": [],
+    "remediation": "retry",
+    "en": "Resource has been permanently removed"
+  },
+  {
+    "code": "error.413.payload_too_large",
+    "status": 413,
+    "params": [],
+    "remediation": "retry",
+    "en": "Request body is too large"
+  },
+  {
+    "code": "error.415.unsupported_media_type",
+    "status": 415,
+    "params": [],
+    "remediation": "retry",
+    "en": "Unsupported media type"
+  },
+  {
+    "code": "error.422.unprocessable_entity",
+    "status": 422,
+    "params": [],
+    "remediation": "wait_and_retry",
+    "en": "Unprocessable entity"
+  },
+  {
+    "code": "error.423.locked",
+    "status": 423,
+    "params": [],
+    "remediation": "wait_and_retry",
+    "en": "Resource is locked"
+  },
+  {
+    "code": "error.423.verification_locked",
+    "status": 423,
+    "params": [],
+    "remediation": "wait_and_retry",
+    "en": "Too many failed attempts — verification locked"
+  },
+  {
+    "code": "error.429.rate_limit",
+    "status": 429,
+    "params": [
+      "retry_after_minutes"
+    ],
+    "remediation": "wait_and_retry",
+    "en": "Too many attempts. Try again in {retry_after_minutes} minutes."
+  },
+  {
+    "code": "error.429.too_many_requests",
+    "status": 429,
+    "params": [],
+    "remediation": "wait_and_retry",
+    "en": "Too many requests. Please try again later."
+  },
+  {
+    "code": "error.500.internal",
+    "status": 500,
+    "params": [],
+    "remediation": "contact_support",
+    "en": "Something went wrong"
+  },
+  {
+    "code": "error.503.mandate_unavailable",
+    "status": 503,
+    "params": [],
+    "remediation": "retry",
+    "en": "Cannot verify workspace mandate right now"
+  }
+]

package/src/i18n/generated/errors.ru.gen.ts

@@ -0,0 +1,64 @@
+// AUTO-GENERATED by scripts/gen-errors.mjs — do not edit by hand.
+// Source: stapel-auth canonical errors.json (backend codegen artifact).
+// Regenerate: pnpm gen:errors   ·   Drift gate: pnpm gen:errors:check
+// Locale source: backend translations/errors.ru.json (locale catalog
+// beside the canonical errors.json — i18n-shipping.md §1).
+import type { ChatErrorCode } from "./errors.gen.js";
+
+/**
+ * `ru` texts for the backend error codes this catalog carries.
+ *
+ * PARTIAL, and deliberately typed to say so: 12 key(s) owned by
+ * stapel_chat are absent, because that owner ships no locale catalog
+ * (ERRORS_LOCALE_EXEMPT_OWNERS). English for them still comes from the registry
+ * artifact via the en bundle; the pair layers its own authored `ru`
+ * strings over this one until upstream ships translations. `Partial` is what
+ * makes the gap visible to TypeScript instead of a silent English fallback.
+ *
+ * Import from the pair's `./i18n/ru` subpath, NOT the main entry, so
+ * the locale stays out of hosts that don't ship it.
+ */
+export const chatErrorBundleRu: Partial<Record<ChatErrorCode, string>> = {
+  "error.400.bad_request": "Некорректный запрос",
+  "error.400.captcha_invalid": "Проверка капчи не пройдена. Пожалуйста, попробуйте ещё раз.",
+  "error.400.captcha_required": "Требуется токен капчи.",
+  "error.400.expected_list": "Ожидался список элементов",
+  "error.400.field.blank": "Поле «{field}» не может быть пустым",
+  "error.400.field.does_not_exist": "«{field}» не существует",
+  "error.400.field.invalid": "Поле «{field}» содержит недопустимое значение",
+  "error.400.field.invalid_choice": "Недопустимый вариант для поля «{field}»",
+  "error.400.field.max_length": "Поле «{field}» должно содержать не более {max_length} символов",
+  "error.400.field.max_value": "Значение поля «{field}» должно быть не больше {max_value}",
+  "error.400.field.min_length": "Поле «{field}» должно содержать не менее {min_length} символов",
+  "error.400.field.min_value": "Значение поля «{field}» должно быть не меньше {min_value}",
+  "error.400.field.null": "Поле «{field}» не может быть null",
+  "error.400.field.required": "Поле «{field}» обязательно",
+  "error.400.field.unique": "Значение поля «{field}» должно быть уникальным",
+  "error.400.invalid_ad_id": "Недопустимый идентификатор объявления",
+  "error.400.validation_error": "Ошибка валидации",
+  "error.400.verification_failed": "Проверка не пройдена",
+  "error.400.verification_invalid_factor": "Этот способ подтверждения недоступен",
+  "error.401.unauthorized": "Требуется аутентификация",
+  "error.402.payment_required": "Требуется оплата",
+  "error.403.forbidden": "У вас нет прав для выполнения этого действия",
+  "error.403.network_blocked": "Запросы из этой сети не разрешены.",
+  "error.403.verification_enrollment_required": "Требуется регистрация фактора подтверждения.",
+  "error.403.verification_required": "Требуется дополнительная проверка",
+  "error.404.ad_not_found": "Объявление не найдено",
+  "error.404.not_found": "Запрошенный ресурс не найден",
+  "error.404.verification_challenge_not_found": "Запрос на подтверждение не найден или истёк",
+  "error.405.method_not_allowed": "Метод не разрешён",
+  "error.406.not_acceptable": "Недопустимый формат ответа",
+  "error.408.request_timeout": "Время ожидания запроса истекло",
+  "error.409.conflict": "Ресурс уже существует",
+  "error.410.gone": "Ресурс был безвозвратно удалён",
+  "error.413.payload_too_large": "Тело запроса слишком большое",
+  "error.415.unsupported_media_type": "Неподдерживаемый тип данных",
+  "error.422.unprocessable_entity": "Невозможно обработать данные запроса",
+  "error.423.locked": "Ресурс заблокирован",
+  "error.423.verification_locked": "Слишком много неудачных попыток — подтверждение заблокировано",
+  "error.429.rate_limit": "Слишком много попыток. Повторите попытку через {retry_after_minutes} мин.",
+  "error.429.too_many_requests": "Слишком много запросов. Пожалуйста, повторите попытку позже.",
+  "error.500.internal": "Что-то пошло не так",
+  "error.503.mandate_unavailable": "Не удалось проверить доступ к рабочему пространству",
+};

package/src/i18n/keys.ts

@@ -0,0 +1,152 @@
+import type { I18nDictionary, I18nEngine } from "@stapel/core";
+import { chatErrorBundleEn } from "./generated/errors.gen.js";
+
+/**
+ * chat-react's own translation KEYS (frontend-standard §4.2): headless
+ * components never render literal strings — hosts resolve these via core's
+ * i18n engine (`useT`). Backend error codes flow through the SAME contour: a
+ * `StapelApiError.code` is already a key, so the default bundle below ships
+ * English fallbacks for both the backend error codes (generated) and the
+ * pair's own UI keys.
+ */
+export const CHAT_I18N_KEYS = {
+  unknownError: "chat.error.unknown",
+
+  // Conversation list
+  listTitle: "chat.list.title",
+  listEmpty: "chat.list.empty",
+  listLoading: "chat.list.loading",
+  listLoadMore: "chat.list.load_more",
+  listEnd: "chat.list.end",
+  listRetry: "chat.list.retry",
+  listUnread: "chat.list.unread",
+  listOpen: "chat.list.open",
+
+  // Conversation kinds (the response carries no title — the kind and the
+  // participants are all a row can honestly say)
+  kindDirect: "chat.kind.direct",
+  kindGroup: "chat.kind.group",
+  kindSupport: "chat.kind.support",
+
+  // Thread
+  threadLoading: "chat.thread.loading",
+  threadEmpty: "chat.thread.empty",
+  threadRetry: "chat.thread.retry",
+  threadLoadOlder: "chat.thread.load_older",
+  threadBeginning: "chat.thread.beginning",
+  threadSystem: "chat.thread.system",
+
+  // Composer
+  composerPlaceholder: "chat.composer.placeholder",
+  composerSend: "chat.composer.send",
+  composerSending: "chat.composer.sending",
+  composerBlockedEmpty: "chat.composer.blocked.empty",
+  composerBlockedTooLong: "chat.composer.blocked.too_long",
+
+  // "Message the seller"
+  startButton: "chat.start.button",
+  startStarting: "chat.start.starting",
+  startBlockedSelf: "chat.start.blocked.self",
+  startBlockedUnknownSeller: "chat.start.blocked.unknown_seller",
+
+  // Transport (the seam is invisible to the UI's BEHAVIOUR, but a person may
+  // still be told whether the thread is live or on a timer)
+  transportLive: "chat.transport.live",
+  transportPolling: "chat.transport.polling",
+  transportIdle: "chat.transport.idle",
+
+  // Backend error keys the pair OWNS the localization of. stapel-chat ships
+  // English only (it has no `translations/` directory), so its 12 keys are
+  // absent from the generated ru/es bundles and are authored here instead —
+  // the stapel-forms/stapel_attributes precedent. Listed as keys so the
+  // i18n-key-exists lint knows them and `test/i18n.test.ts` can prove all
+  // three locales carry them.
+  errorEmptyMessage: "error.400.chat_empty_message",
+  errorBodyTooLong: "error.400.chat_body_too_long",
+  errorAttachmentsDisabled: "error.400.chat_attachments_disabled",
+  errorInvalidDirect: "error.400.chat_invalid_direct",
+  errorInvalidKind: "error.400.chat_invalid_kind",
+  errorKindDisabled: "error.400.chat_kind_disabled",
+  errorInvalidReply: "error.400.chat_invalid_reply",
+  errorNotSupport: "error.400.chat_not_support",
+  errorNotOperator: "error.403.chat_not_operator",
+  errorNotParticipant: "error.403.chat_not_participant",
+  errorConversationNotFound: "error.404.chat_conversation_not_found",
+  errorAlreadyAssigned: "error.409.chat_already_assigned",
+
+  // Nav-manifest label (`../nav/manifest.ts`) — read by a shell via
+  // `t(entry.labelKey)`.
+  navConversations: "chat.nav.conversations",
+} as const;
+
+export type ChatI18nKey = (typeof CHAT_I18N_KEYS)[keyof typeof CHAT_I18N_KEYS];
+
+/**
+ * English fallback bundle for chat-react UI keys + backend error codes. The
+ * generated `chatErrorBundleEn` (from stapel-chat's error registry, `pnpm
+ * gen:errors`) is spread FIRST so every backend `error.*` key has a fallback —
+ * a `StapelApiError.code` never renders as a raw key. Hand-polished copy below
+ * then OVERRIDES the generated English for the keys users see most.
+ */
+export const chatI18nBundleEn: I18nDictionary = {
+  // Backend error codes — generated en fallbacks (coverage by construction).
+  ...chatErrorBundleEn,
+
+  // chat-react UI
+  "chat.error.unknown": "Something went wrong. Please try again.",
+
+  "chat.list.title": "Messages",
+  "chat.list.empty": "No conversations yet.",
+  "chat.list.loading": "Loading conversations…",
+  "chat.list.load_more": "Load more",
+  "chat.list.end": "That's everything.",
+  "chat.list.retry": "Try again",
+  "chat.list.unread": "{count} unread",
+  "chat.list.open": "Open",
+
+  "chat.kind.direct": "Direct message",
+  "chat.kind.group": "Group",
+  "chat.kind.support": "Support",
+
+  "chat.thread.loading": "Loading messages…",
+  "chat.thread.empty": "No messages yet. Say hello.",
+  "chat.thread.retry": "Try again",
+  "chat.thread.load_older": "Show earlier messages",
+  "chat.thread.beginning": "This is the beginning of the conversation.",
+  "chat.thread.system": "System",
+
+  "chat.composer.placeholder": "Write a message…",
+  "chat.composer.send": "Send",
+  "chat.composer.sending": "Sending…",
+  "chat.composer.blocked.empty": "Write something first.",
+  "chat.composer.blocked.too_long":
+    "That is longer than {max} characters — shorten it a little.",
+
+  "chat.start.button": "Message the seller",
+  "chat.start.starting": "Opening…",
+  "chat.start.blocked.self": "This is your own listing.",
+  "chat.start.blocked.unknown_seller": "This listing has no seller to write to.",
+
+  "chat.transport.live": "Live",
+  "chat.transport.polling": "Refreshing every few seconds",
+  "chat.transport.idle": "Paused",
+
+  "chat.nav.conversations": "Messages",
+};
+
+/**
+ * Register chat-react's key bundle into a core i18n engine (call once at
+ * startup). Registers under the given locale (default `"en"`).
+ *
+ * MERGE-PRIORITY CONVENTION (i18n-shipping.md §3 — every `@stapel/*-react`
+ * pair follows it): registration order IS override priority, later wins per
+ * key. Within a locale, layers register bottom-up:
+ *
+ *   1. generated en floor (`chatErrorBundleEn` — coverage by construction),
+ *   2. the pair's polish / UI copy (this bundle spreads 1 then overrides),
+ *   3. the pair's locale bundle from the `./i18n/<locale>` subpath,
+ *   4. the HOST's own bundle — always registered LAST.
+ */
+export function registerChatI18n(engine: I18nEngine, locale = "en"): void {
+  engine.registerBundle(locale, chatI18nBundleEn);
+}