@terrafirmagreg-team/chat 0.1.0 → 1.2.0

package/package.json

@@ -1,27 +1,32 @@
 {
   "name": "@terrafirmagreg-team/chat",
-  "version": "0.1.0",
+  "version": "1.2.0",
   "type": "module",
+  "description": "Chat",
+  "license": "LGPL-3.0-only",
   "exports": {
-    ".": "./src/ui/index.ts",
+    ".": "./src/components/index.ts",
     "./lib": "./src/lib/index.ts",
+    "./lib/*": [
+      "./src/lib/*.ts",
+      "./src/lib/*/index.ts"
+    ],
+    "./types": "./src/types.ts",
     "./styles.css": "./src/styles.css",
-    "./*": [
-      "./src/*.ts",
-      "./src/*.tsx",
-      "./src/*/index.ts",
-      "./src/*/index.tsx"
+    "./locales": "./src/locales.ts",
+    "./components/*": [
+      "./src/components/*.tsx",
+      "./src/components/*/index.tsx",
+      "./src/components/*/index.ts"
     ]
   },
   "files": [
-    "src",
-    "styles",
-    "styles.css"
+    "src"
   ],
   "dependencies": {
-    "@terrafirmagreg-team/ui": "0.1.0",
-    "lucide-react": "^1.63.0",
-    "@terrafirmagreg-team/translate": "0.1.0"
+    "@terrafirmagreg-team/ui": "1.2.0",
+    "lucide-react": "^0.577.0",
+    "@terrafirmagreg-team/translate": "1.2.0"
   },
   "peerDependencies": {
     "react": ">=19"

package/src/{ui → components}/box.tsx

@@ -45,7 +45,7 @@ export function ChatBox({
   onClose,
   onLogin,
   renderAvatar,
-  unknownError = 'chat.errorUnknown',
+  unknownError = 'Unknown error',
 }: {
   messages: readonly ChatMessage[];
   t: ChatTranslate;
@@ -101,7 +101,11 @@ export function ChatBox({
       await send(message, loggedIn ? undefined : chatName.trim() || undefined);
       setEnteredMessage('');
     } catch (err) {
-      setSendingError(err instanceof Error ? err.message : t(unknownError));
+      setSendingError(
+        err instanceof Error
+          ? err.message
+          : t(unknownError, { note: 'chat.errorUnknown' }),
+      );
     } finally {
       setSendingMessage(false);
       requestAnimationFrame(() => inputRef.current?.focus());
@@ -111,13 +115,13 @@ export function ChatBox({
   return (
     <section className="chat">
       <header className="chat__header">
-        <p className="chat__title">{t('chat.title')}</p>
+        <p className="chat__title">{t('Chat', { note: 'chat.title' })}</p>
         {onClose && (
-          <Hint label={t('common.close')}>
+          <Hint label={t('Close', { note: 'common.close' })}>
             <button
               type="button"
               className="chat__close"
-              aria-label={t('common.close')}
+              aria-label={t('Close', { note: 'common.close' })}
               onClick={onClose}>
               <X className="size-4" aria-hidden="true" />
             </button>
@@ -128,7 +132,7 @@ export function ChatBox({
         <div className="chat__offline" role="status">
           <span className="chat__offline-chip">
             <WifiOff className="size-3.5" aria-hidden="true" />
-            {t('servers.offline')}
+            {t('Servers offline', { note: 'servers.offline' })}
           </span>
         </div>
       ) : (
@@ -153,8 +157,12 @@ export function ChatBox({
                 {!shown.length && (
                   <Empty>
                     <EmptyHeader>
-                      <EmptyTitle>{t('chat.title')}</EmptyTitle>
-                      <EmptyDescription>{t('chat.noMessages')}</EmptyDescription>
+                      <EmptyTitle>
+                        {t('Chat', { note: 'chat.title' })}
+                      </EmptyTitle>
+                      <EmptyDescription>
+                        {t('No messages yet', { note: 'chat.noMessages' })}
+                      </EmptyDescription>
                     </EmptyHeader>
                   </Empty>
                 )}
@@ -181,8 +189,8 @@ export function ChatBox({
                   type="text"
                   value={chatName}
                   maxLength={24}
-                  placeholder={t('chat.namePlaceholder')}
-                  aria-label={t('chat.nameLabel')}
+                  placeholder={t('Name', { note: 'chat.namePlaceholder' })}
+                  aria-label={t('Name', { note: 'chat.nameLabel' })}
                   onChange={e => rememberChatName(e.target.value)}
                 />
               </InputGroupAddon>
@@ -192,9 +200,9 @@ export function ChatBox({
               rows={2}
               value={enteredMessage}
               maxLength={maxLength}
-              placeholder={nameMissing ? t('chat.namePlaceholder') : t('chat.placeholder')}
+              placeholder={nameMissing ? t('Name', { note: 'chat.namePlaceholder' }) : t('Message', { note: 'chat.placeholder' })}
               disabled={sendingMessage || nameMissing}
-              aria-label={t('chat.placeholder')}
+              aria-label={t('Message', { note: 'chat.placeholder' })}
               onChange={e => setEnteredMessage(e.target.value)}
               onKeyDown={e => {
                 if (e.nativeEvent.isComposing || e.keyCode === 229) return;
@@ -210,7 +218,7 @@ export function ChatBox({
                 variant="default"
                 size="icon-sm"
                 disabled={!enteredMessage.trim() || sendingMessage || nameMissing}
-                aria-label={t('chat.send')}>
+                aria-label={t('Send', { note: 'chat.send' })}>
                 <ArrowUp strokeWidth={2.25} aria-hidden="true" />
               </InputGroupButton>
             </InputGroupAddon>
@@ -220,9 +228,10 @@ export function ChatBox({
       {send && loginRequired && !loggedIn && onLogin && (
         <button type="button" className="chat__login" onClick={onLogin}>
           <LogIn className="size-4" aria-hidden="true" />
-          {t('chat.login')}
+          {t('Log in', { note: 'chat.login' })}
         </button>
       )}
     </section>
   );
 }
+

package/src/{ui → components}/index.ts

@@ -8,3 +8,4 @@ export type {
   ChatTranslate,
 } from '@terrafirmagreg-team/chat/types';
 export {getStoredName, isOwnChatMessage, setStoredName} from '@terrafirmagreg-team/chat/lib';
+

package/src/{ui → components}/message.tsx

@@ -23,12 +23,12 @@ export function ChatMessageRow({
         return message.message;
       case 'playerjoin':
         return message.playerName
-          ? t('chat.playerJoin', {playername: message.playerName})
-          : t('chat.anonymousJoin');
+          ? t('{playername} joined the game', {note: 'chat.playerJoin', variables: {playername: message.playerName}})
+          : t('A player joined the game', {note: 'chat.anonymousJoin'});
       case 'playerleave':
         return message.playerName
-          ? t('chat.playerQuit', {playername: message.playerName})
-          : t('chat.anonymousQuit');
+          ? t('{playername} left the game', {note: 'chat.playerQuit', variables: {playername: message.playerName}})
+          : t('A player left the game', {note: 'chat.anonymousQuit'});
     }
   })();
 
@@ -56,3 +56,4 @@ export function ChatMessageRow({
     </Message>
   );
 }
+

package/src/lib/identity.ts

@@ -16,7 +16,6 @@ export function setStoredName(key: string, name: string): void {
   }
 }
 
-
 export function isOwnChatMessage(
   message: ChatMessage,
   names: {chatName?: string; loginName?: string},
@@ -26,3 +25,4 @@ export function isOwnChatMessage(
   const login = names.loginName?.trim();
   return (!!chat && message.playerName === chat) || (!!login && message.playerName === login);
 }
+

package/src/lib/index.ts

@@ -10,3 +10,4 @@ export {
   setStoredName,
 } from './identity';
 export { type ChatTranslate } from '@terrafirmagreg-team/chat/types';
+

package/src/locales/en_us.json

@@ -1,16 +1,16 @@
 {
-  "chat": {
-    "title": "Chat",
-    "noMessages": "No messages yet",
-    "placeholder": "Message",
-    "namePlaceholder": "Name",
-    "nameLabel": "Name",
-    "send": "Send",
-    "login": "Log in",
-    "playerJoin": "{playername} joined the game",
-    "playerQuit": "{playername} left the game",
-    "anonymousJoin": "A player joined the game",
-    "anonymousQuit": "A player left the game",
-    "errorUnknown": "Unknown error"
-  }
+  "A player joined the game(chat.anonymousJoin)": "A player joined the game",
+  "A player left the game(chat.anonymousQuit)": "A player left the game",
+  "Chat(chat.title)": "Chat",
+  "Close(common.close)": "Close",
+  "Log in(chat.login)": "Log in",
+  "Message(chat.placeholder)": "Message",
+  "Name(chat.nameLabel)": "Name",
+  "Name(chat.namePlaceholder)": "Name",
+  "No messages yet(chat.noMessages)": "No messages yet",
+  "Send(chat.send)": "Send",
+  "Servers offline(servers.offline)": "Servers offline",
+  "Unknown error(chat.errorUnknown)": "Unknown error",
+  "{playername} joined the game(chat.playerJoin)": "{playername} joined the game",
+  "{playername} left the game(chat.playerQuit)": "{playername} left the game"
 }

package/src/locales/pl_pl.json

@@ -1,16 +1,14 @@
-{
-  "chat": {
-    "title": "Czat",
-    "noMessages": "Brak wiadomości",
-    "placeholder": "Wiadomość",
-    "namePlaceholder": "Nazwa",
-    "nameLabel": "Nazwa",
-    "send": "Wyślij",
-    "login": "Zaloguj się",
-    "playerJoin": "{playername} dołączył do gry",
-    "playerQuit": "{playername} opuścił grę",
-    "anonymousJoin": "Gracz dołączył do gry",
-    "anonymousQuit": "Gracz opuścił grę",
-    "errorUnknown": "Nieznany błąd"
-  }
-}
+{
+  "A player joined the game(chat.anonymousJoin)": "Gracz dołączył do gry",
+  "A player left the game(chat.anonymousQuit)": "Gracz opuścił grę",
+  "Chat(chat.title)": "Czat",
+  "Log in(chat.login)": "Zaloguj się",
+  "Message(chat.placeholder)": "Wiadomość",
+  "Name(chat.nameLabel)": "Nazwa",
+  "Name(chat.namePlaceholder)": "Nazwa",
+  "No messages yet(chat.noMessages)": "Brak wiadomości",
+  "Send(chat.send)": "Wyślij",
+  "Unknown error(chat.errorUnknown)": "Nieznany błąd",
+  "{playername} joined the game(chat.playerJoin)": "{playername} dołączył do gry",
+  "{playername} left the game(chat.playerQuit)": "{playername} opuścił grę"
+}

package/src/locales/ru_ru.json

@@ -1,16 +1,16 @@
 {
-  "chat": {
-    "title": "Чат",
-    "noMessages": "Пока нет сообщений",
-    "placeholder": "Сообщение",
-    "namePlaceholder": "Имя",
-    "nameLabel": "Имя",
-    "send": "Отправить",
-    "login": "Войти",
-    "playerJoin": "{playername} зашёл в игру",
-    "playerQuit": "{playername} вышел из игры",
-    "anonymousJoin": "Игрок зашёл в игру",
-    "anonymousQuit": "Игрок вышел из игры",
-    "errorUnknown": "Неизвестная ошибка"
-  }
+  "A player joined the game(chat.anonymousJoin)": "Игрок зашёл в игру",
+  "A player left the game(chat.anonymousQuit)": "Игрок вышел из игры",
+  "Chat(chat.title)": "Чат",
+  "Close(common.close)": "Закрыть",
+  "Log in(chat.login)": "Войти",
+  "Message(chat.placeholder)": "Сообщение",
+  "Name(chat.nameLabel)": "Имя",
+  "Name(chat.namePlaceholder)": "Имя",
+  "No messages yet(chat.noMessages)": "Пока нет сообщений",
+  "Send(chat.send)": "Отправить",
+  "Servers offline(servers.offline)": "Серверы недоступны",
+  "Unknown error(chat.errorUnknown)": "Неизвестная ошибка",
+  "{playername} joined the game(chat.playerJoin)": "{playername} зашёл в игру",
+  "{playername} left the game(chat.playerQuit)": "{playername} вышел из игры"
 }

package/src/locales/uk_ua.json

@@ -1,16 +1,14 @@
-{
-  "chat": {
-    "title": "Чат",
-    "noMessages": "Поки немає повідомлень",
-    "placeholder": "Повідомлення",
-    "namePlaceholder": "Ім'я",
-    "nameLabel": "Ім'я",
-    "send": "Надіслати",
-    "login": "Увійти",
-    "playerJoin": "{playername} зайшов у гру",
-    "playerQuit": "{playername} вийшов з гри",
-    "anonymousJoin": "Гравець зайшов у гру",
-    "anonymousQuit": "Гравець вийшов з гри",
-    "errorUnknown": "Невідома помилка"
-  }
-}
+{
+  "A player joined the game(chat.anonymousJoin)": "Гравець зайшов у гру",
+  "A player left the game(chat.anonymousQuit)": "Гравець вийшов з гри",
+  "Chat(chat.title)": "Чат",
+  "Log in(chat.login)": "Увійти",
+  "Message(chat.placeholder)": "Повідомлення",
+  "Name(chat.nameLabel)": "Ім'я",
+  "Name(chat.namePlaceholder)": "Ім'я",
+  "No messages yet(chat.noMessages)": "Поки немає повідомлень",
+  "Send(chat.send)": "Надіслати",
+  "Unknown error(chat.errorUnknown)": "Невідома помилка",
+  "{playername} joined the game(chat.playerJoin)": "{playername} зайшов у гру",
+  "{playername} left the game(chat.playerQuit)": "{playername} вийшов з гри"
+}

package/src/locales/zh_cn.json

@@ -1,16 +1,14 @@
-{
-  "chat": {
-    "title": "",
-    "noMessages": "",
-    "placeholder": "",
-    "namePlaceholder": "",
-    "nameLabel": "",
-    "send": "",
-    "login": "",
-    "playerJoin": "{playername} ",
-    "playerQuit": "{playername} ",
-    "anonymousJoin": "",
-    "anonymousQuit": "",
-    "errorUnknown": ""
-  }
-}
+{
+  "A player joined the game(chat.anonymousJoin)": "",
+  "A player left the game(chat.anonymousQuit)": "",
+  "Chat(chat.title)": "",
+  "Log in(chat.login)": "",
+  "Message(chat.placeholder)": "",
+  "Name(chat.nameLabel)": "",
+  "Name(chat.namePlaceholder)": "",
+  "No messages yet(chat.noMessages)": "",
+  "Send(chat.send)": "",
+  "Unknown error(chat.errorUnknown)": "",
+  "{playername} joined the game(chat.playerJoin)": "{playername} ",
+  "{playername} left the game(chat.playerQuit)": "{playername} "
+}

package/src/locales/zh_tw.json

@@ -1,16 +1,14 @@
-{
-  "chat": {
-    "title": "",
-    "noMessages": "",
-    "placeholder": "",
-    "namePlaceholder": "",
-    "nameLabel": "",
-    "send": "",
-    "login": "",
-    "playerJoin": "{playername} ",
-    "playerQuit": "{playername} ",
-    "anonymousJoin": "",
-    "anonymousQuit": "",
-    "errorUnknown": ""
-  }
-}
+{
+  "A player joined the game(chat.anonymousJoin)": "",
+  "A player left the game(chat.anonymousQuit)": "",
+  "Chat(chat.title)": "",
+  "Log in(chat.login)": "",
+  "Message(chat.placeholder)": "",
+  "Name(chat.nameLabel)": "",
+  "Name(chat.namePlaceholder)": "",
+  "No messages yet(chat.noMessages)": "",
+  "Send(chat.send)": "",
+  "Unknown error(chat.errorUnknown)": "",
+  "{playername} joined the game(chat.playerJoin)": "{playername} ",
+  "{playername} left the game(chat.playerQuit)": "{playername} "
+}

package/src/locales.ts

@@ -3,3 +3,4 @@ import { createLocaleCatalog } from '@terrafirmagreg-team/translate/lib/locales'
 export const locales = createLocaleCatalog(
   import.meta.glob('./locales/*.json', { eager: true, import: 'default' }),
 );
+

package/src/styles.css

@@ -177,3 +177,4 @@
 		max-width: calc(100% - 7rem);
 	}
 }
+

package/src/types.ts

@@ -28,4 +28,8 @@ export interface ChatSendingSettings {
   loginRequired?: boolean;
 }
 
-export type ChatTranslate = (key: string, params?: Record<string, unknown>) => string;
+export type ChatTranslate = (
+  text: string,
+  opts?: { note?: string; variables?: Record<string, string> },
+) => string;
+