@rimori/client 1.4.5 → 1.4.8

package/README.md

@@ -952,6 +952,122 @@ const ChatExample = () => {
 };
 ```
 
+### useTranslation
+
+Internationalization (i18n) support built on i18next:
+
+```typescript
+import { useTranslation } from "@rimori/client";
+
+const TranslatedComponent = () => {
+  const { t, ready } = useTranslation();
+ 
+  if (!ready) {
+    return <div>Loading translations...</div>;
+  }
+ 
+  return (
+    <div>
+      <h1>{t('discussion.title')}</h1>
+      <p>{t('discussion.whatToTalkAbout')}</p>
+    </div>
+  );
+};
+```
+
+## Translation Feature
+
+Rimori includes a comprehensive internationalization (i18n) system built on i18next that allows plugins to support multiple languages with minimal developer effort.
+
+### How it works
+
+- **Developer Focus**: Developers only need to ensure their interface works in English
+- **Automatic Translations**: With every release, translations for all other languages are generated automatically
+- **Local Testing**: For local development, you can test translations by:
+  1. Setting your user language to a non-English locale (e.g., German)
+  2. Creating a local translation file with "local-" prefix (e.g., `local-de.json`) in the `public/locales/` directory
+  3. The translator will automatically use the local translation file in development mode
+- **Manual Translations**: If developers want to manually translate files, they should place the language file manually in the `public/locales/` folder with the language code as filename (e.g., `de.json`, `fr.json`)
+
+### Usage
+
+#### Using the Hook (Recommended)
+
+```typescript
+import { useTranslation } from "@rimori/client";
+
+function MyComponent() {
+  const { t, ready } = useTranslation();
+ 
+  if (!ready) {
+    return <div>Loading translations...</div>;
+  }
+ 
+  return (
+    <div>
+      <h1>{t('discussion.title')}</h1>
+      <p>{t('discussion.whatToTalkAbout')}</p>
+    </div>
+  );
+}
+```
+
+#### Using the Translator Instance
+
+```typescript
+import { useRimori } from "@rimori/client";
+
+const { plugin } = useRimori();
+const translator = await plugin.getTranslator()
+
+const translatedText = translator.t("discussion.title");
+```
+
+### Translation File Structure
+
+- **Location**: `public/locales/`
+- **Production Files**: Must be named `{language}.json` (e.g., `en.json`, `de.json`, `fr.json`)
+- **Local Development Files**: Must be named `local-{language}.json` (e.g., `local-de.json`, `local-fr.json`)
+- **Format**: Standard JSON with nested objects for organization
+- **English Requirement**: `en.json` is required as the base language
+- **Release Process**: Files starting with "local-" are ignored during the release process
+
+Example translation file structure:
+
+```json
+{
+  "discussion": {
+    "title": "Discussion",
+    "whatToTalkAbout": "What do you want to talk about?",
+    "topics": {
+      "everyday": {
+        "title": "Everyday Conversations",
+        "description": "Ordering coffee, asking for directions, etc."
+      }
+    }
+  }
+}
+```
+
+### Features
+
+- **I18next Support**: All i18next features work with these translations including:
+  - Variable interpolation: `{{name}}`
+  - Pluralization
+  - Fallback mechanisms
+- **Automatic Fallback**: If a translation is missing, it falls back to English
+- **Development Mode**: Local translation files are prioritized in development
+- **Production Ready**: Automatic translation generation for production releases
+
+### Limitations
+
+- Only one translation file per language is allowed
+- Namespaces are not supported
+- Production translation files must be named `{language}.json` and placed in `public/locales/`
+- Local development files must be named `local-{language}.json` and placed in `public/locales/`
+- English (`en.json`) is required as the base language
+- Local files (prefixed with "local-") are ignored during the release process
+
 ## Utilities
 
 ### difficultyConverter

package/dist/cli/scripts/release/detect-translation-languages.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Detect available translation languages from public/locales directory
+ * @returns Promise<string[]> Array of language codes found in the locales directory
+ */
+export declare function detectTranslationLanguages(): Promise<string[]>;

package/dist/cli/scripts/release/detect-translation-languages.js

@@ -0,0 +1,43 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import fs from 'fs';
+/**
+ * Detect available translation languages from public/locales directory
+ * @returns Promise<string[]> Array of language codes found in the locales directory
+ */
+export function detectTranslationLanguages() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const localesPath = './public/locales';
+        try {
+            yield fs.promises.access(localesPath);
+        }
+        catch (e) {
+            console.log('⚠️ No locales directory found, no translations available');
+            return [];
+        }
+        try {
+            const files = yield fs.promises.readdir(localesPath);
+            // Filter out local- files and only include .json files
+            const translationFiles = files.filter((file) => file.endsWith('.json') && !file.startsWith('local-'));
+            if (translationFiles.length === 0) {
+                console.log('⚠️ No translation files found (excluding local- files)');
+                return [];
+            }
+            // Extract language codes from filenames (e.g., en.json -> en)
+            const languages = translationFiles.map((file) => file.replace('.json', ''));
+            console.log(`🌐 Found ${languages.length} translation languages: ${languages.join(', ')}`);
+            return languages;
+        }
+        catch (error) {
+            console.error(`❌ Error reading locales directory:`, error.message);
+            return [];
+        }
+    });
+}

package/dist/cli/scripts/release/release-config-upload.js

@@ -10,6 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import fs from 'fs';
 import path from 'path';
 import ts from 'typescript';
+import { detectTranslationLanguages } from './detect-translation-languages.js';
 /**
  * Read and send the rimori configuration to the release endpoint
  * @param config - Configuration object
@@ -54,6 +55,8 @@ export function sendConfiguration(config) {
             if (!configObject) {
                 throw new Error('Configuration object is empty or undefined');
             }
+            // Detect available translation languages
+            const availableLanguages = yield detectTranslationLanguages();
             console.log(`🚀 Sending configuration...`);
             const requestBody = {
                 config: configObject,
@@ -61,6 +64,7 @@ export function sendConfiguration(config) {
                 plugin_id: config.plugin_id,
                 release_channel: config.release_channel,
                 rimori_client_version: config.rimori_client_version,
+                provided_languages: availableLanguages.join(','),
             };
             try {
                 const response = yield fetch(`${config.domain}/release`, {

package/dist/cli/scripts/release/release-translation-upload.d.ts

@@ -0,0 +1,6 @@
+import { Config } from './release.js';
+/**
+ * Upload translation files to the release function
+ * @param config - Configuration object
+ */
+export declare function uploadTranslations(config: Config, release_id: string): Promise<void>;

package/dist/cli/scripts/release/release-translation-upload.js

@@ -0,0 +1,87 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import fs from 'fs';
+import path from 'path';
+/**
+ * Upload translation files to the release function
+ * @param config - Configuration object
+ */
+export function uploadTranslations(config, release_id) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const localesPath = './public/locales';
+        console.log(`📁 Checking for translation files...`);
+        // Check if locales directory exists
+        try {
+            yield fs.promises.access(localesPath);
+        }
+        catch (e) {
+            console.log('⚠️ No locales directory found at public/locales, skipping translation upload');
+            return;
+        }
+        // Read all files in the locales directory
+        const files = yield fs.promises.readdir(localesPath);
+        // Filter out local- files and only include .json files
+        const translationFiles = files.filter(file => file.endsWith('.json') &&
+            !file.startsWith('local-'));
+        if (translationFiles.length === 0) {
+            console.log('⚠️ No translation files found (excluding local- files), skipping translation upload');
+            return;
+        }
+        console.log(`🌐 Found ${translationFiles.length} translation files: ${translationFiles.join(', ')}`);
+        // Create FormData
+        const formData = new FormData();
+        // Add version and release channel data
+        formData.append('version', config.version);
+        formData.append('release_channel', config.release_channel);
+        formData.append('plugin_id', config.plugin_id);
+        // Create path mapping with ID as key
+        const pathMapping = {};
+        try {
+            // Process each translation file
+            for (let i = 0; i < translationFiles.length; i++) {
+                const fileName = translationFiles[i];
+                const filePath = path.join(localesPath, fileName);
+                console.log(`📄 Processing ${fileName}...`);
+                const fileContent = yield fs.promises.readFile(filePath);
+                const contentType = 'application/json';
+                // Generate unique ID for this file
+                const fileId = `file_${i}`;
+                // Add to path mapping using ID as key
+                pathMapping[fileId] = fileName;
+                // Create a Blob with the file content and content type
+                const blob = new Blob([new Uint8Array(fileContent)], { type: contentType });
+                // Add file to FormData with ID_filename format
+                const formFileName = `${fileId}_${fileName}`;
+                formData.append('files', blob, formFileName);
+            }
+        }
+        catch (error) {
+            console.error(`❌ Error reading translation files:`, error.message);
+            throw error;
+        }
+        // Add path mapping to FormData
+        formData.append('path_mapping', JSON.stringify(pathMapping));
+        // Upload to the release endpoint
+        const response = yield fetch(`${config.domain}/release/${release_id}/translations`, {
+            method: 'POST',
+            headers: { Authorization: `Bearer ${config.token}` },
+            body: formData,
+        });
+        if (response.ok) {
+            console.log('✅ Translation files uploaded successfully!');
+        }
+        else {
+            const errorText = yield response.text();
+            console.log('❌ Translation upload failed!');
+            console.log('Response:', errorText);
+            throw new Error(`Translation upload failed with status ${response.status}`);
+        }
+    });
+}

package/dist/cli/scripts/release/release.d.ts

@@ -4,7 +4,7 @@
  *   rimori-release <release_channel>
  *
  * Environment variables required:
- *   RIMORI_TOKEN      - Your Rimori token
+ *   RIMORI_TOKEN   - Your Rimori token
  *   RIMORI_PLUGIN  - Your plugin ID
  *
  * Make sure to install dependencies:

package/dist/cli/scripts/release/release.js

@@ -4,7 +4,7 @@
  *   rimori-release <release_channel>
  *
  * Environment variables required:
- *   RIMORI_TOKEN      - Your Rimori token
+ *   RIMORI_TOKEN   - Your Rimori token
  *   RIMORI_PLUGIN  - Your plugin ID
  *
  * Make sure to install dependencies:
@@ -29,15 +29,22 @@ import { releasePlugin, sendConfiguration } from './release-config-upload.js';
 const packageJson = JSON.parse(fs.readFileSync(path.resolve('./package.json'), 'utf8'));
 const { version, r_id: pluginId } = packageJson;
 const RIMORI_TOKEN = process.env.RIMORI_TOKEN;
-if (!RIMORI_TOKEN)
-    throw new Error('RIMORI_TOKEN is not set');
-if (!pluginId)
-    throw new Error('The plugin id (r_id) is not set in package.json');
+if (!RIMORI_TOKEN) {
+    console.error('Error: RIMORI_TOKEN is not set');
+    process.exit(1);
+}
+if (!pluginId) {
+    console.error('Error: The plugin id (r_id) is not set in package.json');
+    process.exit(1);
+}
 const [releaseChannel] = process.argv.slice(2);
 if (!releaseChannel) {
     console.error('Usage: rimori-release <release_channel>');
     process.exit(1);
 }
+if (process.env.RIMORI_BACKEND_URL) {
+    console.info('Using backend url:', process.env.RIMORI_BACKEND_URL);
+}
 const config = {
     version,
     release_channel: releaseChannel,
@@ -60,6 +67,8 @@ function releaseProcess() {
             yield uploadDirectory(config, release_id);
             // Then release the plugin
             yield releasePlugin(config, release_id);
+            // Inform user about translation processing
+            console.log('🌐 Hint: The plugin is released but it might take some time until all translations are being processed.');
         }
         catch (error) {
             console.log('❌ Error:', error.message);

package/dist/components/ai/EmbeddedAssistent/TTS/MessageSender.js

@@ -20,9 +20,9 @@ export class MessageSender {
         this.voice = voice;
     }
     getCompletedSentences(currentText, isLoading) {
-        // Split the text based on the following characters: .,?!
+        // Split the text based on the following characters: .?!
         // Only split on : when followed by a space
-        const pattern = /(.+?[,.?!]|.+?:\s+|.+?\n+)/g;
+        const pattern = /(.+?[.?!]|.+?:\s+|.+?\n+)/g;
         const result = [];
         let match;
         while ((match = pattern.exec(currentText)) !== null) {

package/dist/core/controller/EnhancedUserInfo.js

@@ -0,0 +1 @@
+"use strict";

package/dist/core/controller/SettingsController.d.ts

@@ -1,6 +1,5 @@
 import { SupabaseClient } from '@supabase/supabase-js';
 import { LanguageLevel } from '../../utils/difficultyConverter';
-import { Language } from '../../utils/Language';
 import { Guild } from '../core';
 export interface Buddy {
     id: string;
@@ -10,6 +9,13 @@ export interface Buddy {
     voiceId: string;
     aiPersonality: string;
 }
+export interface Language {
+    code: string;
+    name: string;
+    native: string;
+    capitalized: string;
+    uppercase: string;
+}
 export interface UserInfo {
     skill_level_reading: LanguageLevel;
     skill_level_writing: LanguageLevel;

package/dist/core/core.d.ts

@@ -2,11 +2,10 @@ export * from '../fromRimori/PluginTypes';
 export * from '../plugin/PluginController';
 export * from '../plugin/RimoriClient';
 export * from '../utils/difficultyConverter';
-export * from '../utils/Language';
 export * from '../utils/PluginUtils';
 export * from '../worker/WorkerSetup';
 export { EventBusMessage } from '../fromRimori/EventBus';
-export { Buddy, UserInfo } from './controller/SettingsController';
+export { Buddy, UserInfo, Language } from './controller/SettingsController';
 export { SharedContent } from './controller/SharedContentController';
 export { Exercise, TriggerAction } from './controller/ExerciseController';
 export { Message, OnLLMResponse, ToolInvocation } from './controller/AIController';

package/dist/core/core.js

@@ -3,6 +3,5 @@ export * from '../fromRimori/PluginTypes';
 export * from '../plugin/PluginController';
 export * from '../plugin/RimoriClient';
 export * from '../utils/difficultyConverter';
-export * from '../utils/Language';
 export * from '../utils/PluginUtils';
 export * from '../worker/WorkerSetup';

package/dist/fromRimori/EventBus.js

@@ -12,18 +12,18 @@ export class EventBusHandler {
         this.listeners = new Map();
         this.responseResolvers = new Map();
         this.debugEnabled = false;
-        this.evName = '';
+        this.evName = "";
         //private constructor
     }
     static getInstance(name) {
         if (!EventBusHandler.instance) {
             EventBusHandler.instance = new EventBusHandler();
-            EventBusHandler.instance.on('global.system.requestDebug', () => {
+            EventBusHandler.instance.on("global.system.requestDebug", () => {
                 EventBusHandler.instance.debugEnabled = true;
                 console.log(`[${EventBusHandler.instance.evName}] Debug mode enabled. Make sure debugging messages are enabled in the browser console.`);
             });
         }
-        if (name && EventBusHandler.instance.evName === '') {
+        if (name && EventBusHandler.instance.evName === "") {
             EventBusHandler.instance.evName = name;
         }
         return EventBusHandler.instance;
@@ -67,7 +67,7 @@ export class EventBusHandler {
         }
         const event = this.createEvent(sender, topic, data, eventId);
         const handlers = this.getMatchingHandlers(event.topic);
-        handlers.forEach((handler) => {
+        handlers.forEach(handler => {
             if (handler.ignoreSender && handler.ignoreSender.includes(sender)) {
                 // console.log("ignore event as its in the ignoreSender list", { event, ignoreList: handler.ignoreSender });
                 return;
@@ -93,7 +93,7 @@ export class EventBusHandler {
      * @returns An EventListener object containing an off() method to unsubscribe the listeners.
      */
     on(topics, handler, ignoreSender = []) {
-        const ids = this.toArray(topics).map((topic) => {
+        const ids = this.toArray(topics).map(topic => {
             this.logIfDebug(`Subscribing to ` + topic, { ignoreSender });
             if (!this.validateTopic(topic)) {
                 this.logAndThrowError(true, `Invalid topic: ` + topic);
@@ -109,7 +109,7 @@ export class EventBusHandler {
             return btoa(JSON.stringify({ topic, id }));
         });
         return {
-            off: () => this.off(ids),
+            off: () => this.off(ids)
         };
     }
     /**
@@ -121,10 +121,10 @@ export class EventBusHandler {
      */
     respond(sender, topic, handler) {
         const topics = Array.isArray(topic) ? topic : [topic];
-        const listeners = topics.map((topic) => {
+        const listeners = topics.map(topic => {
             const blackListedEventIds = [];
             //To allow event communication inside the same plugin the sender needs to be ignored but the events still need to be checked for the same event just reaching the subscriber to prevent infinite loops
-            const finalIgnoreSender = !topic.startsWith('self.') ? [sender] : [];
+            const finalIgnoreSender = !topic.startsWith("self.") ? [sender] : [];
             const listener = this.on(topic, (data) => __awaiter(this, void 0, void 0, function* () {
                 if (blackListedEventIds.includes(data.eventId)) {
                     // console.log("BLACKLISTED EVENT ID", data.eventId);
@@ -134,16 +134,16 @@ export class EventBusHandler {
                 if (blackListedEventIds.length > 20) {
                     blackListedEventIds.shift();
                 }
-                const response = typeof handler === 'function' ? yield handler(data) : handler;
+                const response = typeof handler === "function" ? yield handler(data) : handler;
                 this.emit(sender, topic, response, data.eventId);
             }), finalIgnoreSender);
-            this.logIfDebug(`Added respond listener ` + sender + ' to topic ' + topic, { listener, sender });
+            this.logIfDebug(`Added respond listener ` + sender + " to topic " + topic, { listener, sender });
             return {
-                off: () => listener.off(),
+                off: () => listener.off()
             };
         });
         return {
-            off: () => listeners.forEach((listener) => listener.off()),
+            off: () => listeners.forEach(listener => listener.off())
         };
     }
     /**
@@ -169,10 +169,10 @@ export class EventBusHandler {
      * @param listenerIds - The ids of the listeners to unsubscribe from.
      */
     off(listenerIds) {
-        this.toArray(listenerIds).forEach((fullId) => {
+        this.toArray(listenerIds).forEach(fullId => {
             const { topic, id } = JSON.parse(atob(fullId));
             const listeners = this.listeners.get(topic) || new Set();
-            listeners.forEach((listener) => {
+            listeners.forEach(listener => {
                 if (listener.id === Number(id)) {
                     listeners.delete(listener);
                     this.logIfDebug(`Removed listener ` + fullId, { topic, listenerId: id });
@@ -197,7 +197,7 @@ export class EventBusHandler {
             }
             const event = this.createEvent(sender, topic, data || {});
             this.logIfDebug(`Requesting data from ` + topic, { event });
-            return new Promise((resolve) => {
+            return new Promise(resolve => {
                 this.responseResolvers.set(event.eventId, (value) => resolve(value));
                 this.emitInternal(sender, topic, data || {}, event.eventId, true);
             });
@@ -212,7 +212,7 @@ export class EventBusHandler {
         const exact = this.listeners.get(topic) || new Set();
         // Find wildcard matches
         const wildcard = [...this.listeners.entries()]
-            .filter(([key]) => key.endsWith('*') && topic.startsWith(key.slice(0, -1)))
+            .filter(([key]) => key.endsWith("*") && topic.startsWith(key.slice(0, -1)))
             .flatMap(([_, handlers]) => [...handlers]);
         return new Set([...exact, ...wildcard]);
     }
@@ -223,27 +223,27 @@ export class EventBusHandler {
      */
     validateTopic(topic) {
         // Split event type into parts
-        const parts = topic.split('.');
+        const parts = topic.split(".");
         const [plugin, area, action] = parts;
         if (parts.length !== 3) {
-            if (parts.length === 1 && plugin === '*') {
+            if (parts.length === 1 && plugin === "*") {
                 return true;
             }
-            if (parts.length === 2 && plugin !== '*' && area === '*') {
+            if (parts.length === 2 && plugin !== "*" && area === "*") {
                 return true;
             }
             this.logAndThrowError(false, `Event type must have 3 parts separated by dots. Received: ` + topic);
             return false;
         }
-        if (action === '*') {
+        if (action === "*") {
             return true;
         }
         // Validate action part
-        const validActions = ['request', 'create', 'update', 'delete', 'trigger'];
-        if (validActions.some((a) => action.startsWith(a))) {
+        const validActions = ["request", "create", "update", "delete", "trigger"];
+        if (validActions.some(a => action.startsWith(a))) {
             return true;
         }
-        this.logAndThrowError(false, `Invalid event topic name. The action: ` + action + '. Must be or start with one of: ' + validActions.join(', '));
+        this.logAndThrowError(false, `Invalid event topic name. The action: ` + action + ". Must be or start with one of: " + validActions.join(", "));
         return false;
     }
     logIfDebug(...args) {

package/dist/fromRimori/PluginTypes.d.ts

@@ -3,7 +3,7 @@ export type Plugin<T extends {} = {}> = Omit<RimoriPluginConfig<T>, 'context_men
     endpoint: string;
     assetEndpoint: string;
     context_menu_actions: MenuEntry[];
-    release_channel: 'alpha' | 'beta' | 'stable';
+    release_channel: "alpha" | "beta" | "stable";
 };
 export type ActivePlugin = Plugin<{
     active?: boolean;
@@ -14,7 +14,7 @@ export interface PluginPage {
     url: string;
     show: boolean;
     description: string;
-    root: 'vocabulary' | 'grammar' | 'reading' | 'listening' | 'watching' | 'writing' | 'speaking' | 'other' | 'community';
+    root: "vocabulary" | "grammar" | "reading" | "listening" | "watching" | "writing" | "speaking" | "other" | "community";
     action?: {
         key: string;
         parameters: ObjectTool;
@@ -79,7 +79,7 @@ export interface RimoriPluginConfig<T extends {} = {}> {
     /**
      * Context menu actions that the plugin registers to appear in right-click menus throughout the application.
      */
-    context_menu_actions: Omit<MenuEntry, 'plugin_id'>[];
+    context_menu_actions: Omit<MenuEntry, "plugin_id">[];
     /**
      * Documentation paths for different types of plugin documentation.
      */
@@ -107,7 +107,7 @@ export interface Tool {
     parameters: {
         name: string;
         description: string;
-        type: 'string' | 'number' | 'boolean';
+        type: "string" | "number" | "boolean";
     }[];
     execute?: (args: Record<string, any>) => Promise<unknown> | unknown | void;
 }

package/dist/hooks/I18nHooks.d.ts

@@ -0,0 +1,11 @@
+import { TOptions } from 'i18next';
+type TranslatorFn = (key: string, options?: TOptions) => string;
+/**
+ * Custom useTranslation hook that provides a translation function and indicates readiness
+ * @returns An object containing the translation function (`t`) and a boolean (`ready`) indicating if the translator is initialized.
+ */
+export declare function useTranslation(): {
+    t: TranslatorFn;
+    ready: boolean;
+};
+export {};

package/dist/hooks/I18nHooks.js

@@ -0,0 +1,25 @@
+import { useEffect, useState } from 'react';
+import { useRimori } from '../providers/PluginProvider';
+/**
+ * Custom useTranslation hook that provides a translation function and indicates readiness
+ * @returns An object containing the translation function (`t`) and a boolean (`ready`) indicating if the translator is initialized.
+ */
+export function useTranslation() {
+    const { plugin } = useRimori();
+    const [translatorInstance, setTranslatorInstance] = useState(null);
+    useEffect(() => {
+        void plugin.getTranslator().then(setTranslatorInstance);
+    }, [plugin]);
+    const safeT = (key, options) => {
+        // return zero-width space if translator is not initialized to keep text space occupied
+        if (!translatorInstance)
+            return '\u200B'; // zero-width space
+        const result = translatorInstance.t(key, options);
+        if (!result) {
+            console.error(`Translation key not found: ${key}`);
+            return '\u200B'; // zero-width space
+        }
+        return result;
+    };
+    return { t: safeT, ready: translatorInstance !== null };
+}

package/dist/i18n/I18nHooks.d.ts

@@ -0,0 +1,11 @@
+import { TOptions } from 'i18next';
+type TranslatorFn = (key: string, options?: TOptions) => string;
+/**
+ * Custom useTranslation hook that provides a translation function and indicates readiness
+ * @returns An object containing the translation function (`t`) and a boolean (`ready`) indicating if the translator is initialized.
+ */
+export declare function useTranslation(): {
+    t: TranslatorFn;
+    ready: boolean;
+};
+export {};