@rimori/client 2.5.8 → 2.5.9

package/README.md

@@ -119,7 +119,7 @@ Access metadata and settings through `client.plugin`:
 - `plugin.getSettings(defaults)` / `plugin.setSettings(settings)` – persist configuration.
 - `plugin.getPluginInfo()` – read active/installed plugin information.
 - `plugin.getUserInfo()` – obtain user profile details (language, name, guild, etc.).
-- `plugin.getTranslator()` – lazily initialize the translator for manual i18n.
+- `plugin.getTranslator()` – lazily initialize the translator for manual i18n. Translation keys must follow the dot notation (`section.subsection.key`); non-key strings are translated via AI and cached.
 
 ### Database Access
 
@@ -183,7 +183,7 @@ The controller handles topic generation, metadata, and completion tracking autom
 Import additional helpers as needed:
 
 - `AudioController` – high-level audio playback/recording utilities for non-React environments.
-- `Translator` – encapsulated i18next integration for manual translation flows.
+- `Translator` – encapsulated i18next integration for manual translation flows, with AI fallback for non-key strings.
 - `difficultyConverter` – convert between textual and numeric difficulty levels.
 - Type definitions for AI messages, shared content, triggers, accomplishments, and more.
 

package/dist/controller/ObjectController.d.ts

@@ -37,6 +37,6 @@ export interface ObjectRequest {
     instructions: string;
 }
 export declare function generateObject<T = any>(backendUrl: string, request: ObjectRequest, token: string): Promise<T>;
-export type OnLLMResponse = (id: string, response: string, finished: boolean, toolInvocations?: any[]) => void;
-export declare function streamObject(backendUrl: string, request: ObjectRequest, onResponse: OnLLMResponse, token: string): Promise<void>;
+export type OnStreamedObjectResult<T = any> = (result: T, isLoading: boolean) => void;
+export declare function streamObject<T = any>(backendUrl: string, request: ObjectRequest, onResult: OnStreamedObjectResult<T>, token: string): Promise<void>;
 export {};

package/dist/controller/ObjectController.js

@@ -21,56 +21,85 @@ export function generateObject(backendUrl, request, token) {
         }).then((response) => response.json());
     });
 }
-export function streamObject(backendUrl, request, onResponse, token) {
+const tryParseJson = (value) => {
+    try {
+        return JSON.parse(value);
+    }
+    catch (_a) {
+        return null;
+    }
+};
+const mergeStreamObject = (base, patch) => {
+    if (Array.isArray(patch)) {
+        return patch.map((item, index) => mergeStreamObject(base === null || base === void 0 ? void 0 : base[index], item));
+    }
+    if (patch && typeof patch === 'object') {
+        const result = base && typeof base === 'object' && !Array.isArray(base) ? Object.assign({}, base) : {};
+        for (const [key, value] of Object.entries(patch)) {
+            result[key] = mergeStreamObject(result[key], value);
+        }
+        return result;
+    }
+    return patch;
+};
+const applyStreamChunk = (current, chunk) => {
+    if (!chunk || typeof chunk !== 'object') {
+        return { next: current, updated: false };
+    }
+    if (chunk.object && typeof chunk.object === 'object') {
+        return { next: chunk.object, updated: true };
+    }
+    if (chunk.delta && typeof chunk.delta === 'object') {
+        return { next: mergeStreamObject(current, chunk.delta), updated: true };
+    }
+    if (chunk.value && typeof chunk.value === 'object') {
+        return { next: mergeStreamObject(current, chunk.value), updated: true };
+    }
+    return { next: current, updated: false };
+};
+export function streamObject(backendUrl, request, onResult, token) {
     return __awaiter(this, void 0, void 0, function* () {
-        const messageId = Math.random().toString(36).substring(3);
         const response = yield fetch(`${backendUrl}/ai/llm-object`, {
             method: 'POST',
             body: JSON.stringify({
                 stream: true,
-                tools: request.tool,
-                systemInstructions: request.behaviour,
-                secondaryInstructions: request.instructions,
+                tool: request.tool,
+                behaviour: request.behaviour,
+                instructions: request.instructions,
             }),
             headers: { Authorization: `Bearer ${token}`, 'Content-Type': 'application/json' },
         });
+        if (!response.ok) {
+            console.error('Failed to stream object:', response.status, response.statusText);
+            return;
+        }
         if (!response.body) {
             console.error('No response body.');
             return;
         }
         const reader = response.body.getReader();
         const decoder = new TextDecoder('utf-8');
-        let content = '';
         let done = false;
-        const toolInvocations = [];
+        let currentObject = {};
         while (!done) {
-            const { value } = yield reader.read();
+            const { value, done: readerDone } = yield reader.read();
             if (value) {
                 const chunk = decoder.decode(value, { stream: true });
-                const lines = chunk.split('\n').filter((line) => line.trim() !== '');
+                const lines = chunk.split('\n').filter((line) => line.trim());
                 for (const line of lines) {
-                    const data = line.substring(3, line.length - 1);
-                    const command = line.substring(0, 1);
-                    // console.log("data: ", { line, data, command });
-                    if (command === '0') {
-                        content += data;
-                        // console.log("AI response:", content);
-                        //content \n\n should be real line break when message is displayed
-                        onResponse(messageId, content.replace(/\\n/g, '\n').replace(/\\+"/g, '"'), false);
-                    }
-                    else if (command === 'd') {
-                        // console.log("AI usage:", JSON.parse(line.substring(2)));
+                    const dataStr = line.substring(5).trim();
+                    if (dataStr === '[DONE]') {
                         done = true;
                         break;
                     }
-                    else if (command === '9') {
-                        // console.log("tool call:", JSON.parse(line.substring(2)));
-                        // console.log("tools", tools);
-                        toolInvocations.push(JSON.parse(line.substring(2)));
-                    }
+                    currentObject = JSON.parse(dataStr);
+                    onResult(currentObject, true);
                 }
             }
+            if (readerDone) {
+                done = true;
+            }
         }
-        onResponse(messageId, content.replace(/\\n/g, '\n').replace(/\\+"/g, '"'), true, toolInvocations);
+        onResult(currentObject, false);
     });
 }

package/dist/controller/TranslationController.d.ts

@@ -1,4 +1,7 @@
 import { ThirdPartyModule, TOptions } from 'i18next';
+import { ObjectRequest } from './ObjectController';
+import { AIModule } from '../plugin/module/AIModule';
+export type AIObjectGenerator = <T>(request: ObjectRequest) => Promise<T>;
 /**
  * Translator class for handling internationalization
  */
@@ -8,7 +11,10 @@ export declare class Translator {
     private initializationPromise;
     private i18n;
     private translationUrl;
-    constructor(initialLanguage: string, translationUrl: string);
+    private ai;
+    private aiTranslationCache;
+    private aiTranslationInFlight;
+    constructor(initialLanguage: string, translationUrl: string, ai: AIModule);
     /**
      * Initialize translator with user's language
      * @param userLanguage - Language code from user info
@@ -23,8 +29,8 @@ export declare class Translator {
      */
     private fetchTranslations;
     /**
-     * Get translation for a key
-     * @param key - Translation key
+     * Get translation for a key or freeform text. If the key is not a valid translation key, the freeform text is translated using AI and cached.
+     * @param key - Translation key or freeform text
      * @param options - Translation options
      * @returns Translated string
      */
@@ -37,4 +43,7 @@ export declare class Translator {
      * Check if translator is initialized
      */
     isReady(): boolean;
+    private isTranslationKey;
+    private translateFreeformText;
+    private fetchAiTranslation;
 }

package/dist/controller/TranslationController.js

@@ -12,11 +12,14 @@ import { createInstance } from 'i18next';
  * Translator class for handling internationalization
  */
 export class Translator {
-    constructor(initialLanguage, translationUrl) {
+    constructor(initialLanguage, translationUrl, ai) {
+        this.aiTranslationCache = new Map();
+        this.aiTranslationInFlight = new Set();
         this.currentLanguage = initialLanguage;
         this.initializationState = 'not-inited';
         this.initializationPromise = null;
         this.translationUrl = translationUrl;
+        this.ai = ai;
     }
     /**
      * Initialize translator with user's language
@@ -102,12 +105,15 @@ export class Translator {
         });
     }
     /**
-     * Get translation for a key
-     * @param key - Translation key
+     * Get translation for a key or freeform text. If the key is not a valid translation key, the freeform text is translated using AI and cached.
+     * @param key - Translation key or freeform text
      * @param options - Translation options
      * @returns Translated string
      */
     t(key, options) {
+        if (!this.isTranslationKey(key)) {
+            return this.translateFreeformText(key);
+        }
         if (!this.i18n) {
             throw new Error('Translator is not initialized');
         }
@@ -125,4 +131,45 @@ export class Translator {
     isReady() {
         return this.initializationState === 'finished';
     }
+    isTranslationKey(key) {
+        return /^[^\s.]+(\.[^\s.]+)+$/.test(key);
+    }
+    translateFreeformText(text) {
+        const cached = this.aiTranslationCache.get(text);
+        if (cached)
+            return cached;
+        if (!this.ai || this.aiTranslationInFlight.has(text)) {
+            return text;
+        }
+        this.aiTranslationInFlight.add(text);
+        void this.fetchAiTranslation(text).finally(() => {
+            this.aiTranslationInFlight.delete(text);
+        });
+        return text;
+    }
+    fetchAiTranslation(text) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                if (!this.ai)
+                    return;
+                const response = yield this.ai.getObject({
+                    behaviour: 'You are a translation engine. Return only the translated text.',
+                    instructions: `Translate the following text into ${this.currentLanguage}: ${text}`,
+                    tool: {
+                        translation: {
+                            type: 'string',
+                            description: `The translation of the input text into ${this.currentLanguage}.`,
+                        },
+                    },
+                });
+                const translation = response === null || response === void 0 ? void 0 : response.translation;
+                if (translation) {
+                    this.aiTranslationCache.set(text, translation);
+                }
+            }
+            catch (error) {
+                console.warn('Failed to translate freeform text:', { text, error });
+            }
+        });
+    }
 }

package/dist/plugin/CommunicationHandler.js

@@ -80,7 +80,7 @@ export class RimoriCommunicationHandler {
             // Listen for updates from rimori-main (data changes, token refresh, etc.)
             // Topic format: {pluginId}.supabase.triggerUpdate
             EventBus.on(`${this.pluginId}.supabase.triggerUpdate`, (ev) => {
-                console.log('[RimoriCommunicationHandler] Received update from rimori-main', ev.data);
+                // console.log('[RimoriCommunicationHandler] Received update from rimori-main', ev.data);
                 this.handleRimoriInfoUpdate(ev.data);
             });
             // Mark MessageChannel as ready and process pending requests
@@ -211,7 +211,7 @@ export class RimoriCommunicationHandler {
      */
     handleRimoriInfoUpdate(newInfo) {
         if (JSON.stringify(this.rimoriInfo) === JSON.stringify(newInfo)) {
-            console.log('[RimoriCommunicationHandler] RimoriInfo update is the same as the cached info, skipping update');
+            // console.log('[RimoriCommunicationHandler] RimoriInfo update is the same as the cached info, skipping update');
             return;
         }
         // Update cached rimoriInfo

package/dist/plugin/RimoriClient.js

@@ -32,7 +32,7 @@ export class RimoriClient {
         this.ai = new AIModule(controller, info);
         this.event = new EventModule(info.pluginId);
         this.db = new DbModule(supabase, controller, info);
-        this.plugin = new PluginModule(supabase, controller, info);
+        this.plugin = new PluginModule(supabase, controller, info, this.ai);
         this.exercise = new ExerciseModule(supabase, controller, info, this.event);
         controller.onUpdate((updatedInfo) => {
             this.rimoriInfo = updatedInfo;

package/dist/plugin/module/AIModule.d.ts

@@ -46,4 +46,10 @@ export declare class AIModule {
      * @returns The generated object.
      */
     getObject<T = any>(request: ObjectRequest): Promise<T>;
+    /**
+     * Generate a streamed structured object from a request using AI.
+     * @param request The object generation request.
+     * @param onResult Callback for each result chunk.
+     */
+    getStreamedObject<T = any>(request: ObjectRequest, onResult: (result: T, isLoading: boolean) => void): Promise<void>;
 }

package/dist/plugin/module/AIModule.js

@@ -8,7 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { generateText, streamChatGPT } from '../../controller/AIController';
-import { generateObject } from '../../controller/ObjectController';
+import { generateObject, streamObject } from '../../controller/ObjectController';
 import { getSTTResponse, getTTSResponse } from '../../controller/VoiceController';
 /**
  * Controller for AI-related operations.
@@ -78,4 +78,14 @@ export class AIModule {
             return generateObject(this.backendUrl, request, this.token);
         });
     }
+    /**
+     * Generate a streamed structured object from a request using AI.
+     * @param request The object generation request.
+     * @param onResult Callback for each result chunk.
+     */
+    getStreamedObject(request, onResult) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return streamObject(this.backendUrl, request, onResult, this.token);
+        });
+    }
 }

package/dist/plugin/module/PluginModule.d.ts

@@ -3,6 +3,7 @@ import { RimoriCommunicationHandler, RimoriInfo } from '../CommunicationHandler'
 import { Translator } from '../../controller/TranslationController';
 import { ActivePlugin, Plugin } from '../../fromRimori/PluginTypes';
 import { SupabaseClient } from '../CommunicationHandler';
+import { AIModule } from './AIModule';
 export type Theme = 'light' | 'dark' | 'system';
 export type ApplicationMode = 'main' | 'sidebar' | 'settings';
 /**
@@ -22,7 +23,7 @@ export declare class PluginModule {
     releaseChannel: string;
     applicationMode: ApplicationMode;
     theme: Theme;
-    constructor(supabase: SupabaseClient, communicationHandler: RimoriCommunicationHandler, info: RimoriInfo);
+    constructor(supabase: SupabaseClient, communicationHandler: RimoriCommunicationHandler, info: RimoriInfo, ai: AIModule);
     /**
      * Set the settings for the plugin.
      * @param settings The settings to set.

package/dist/plugin/module/PluginModule.js

@@ -14,14 +14,14 @@ import { Translator } from '../../controller/TranslationController';
  * Provides access to plugin settings, user info, and plugin information.
  */
 export class PluginModule {
-    constructor(supabase, communicationHandler, info) {
+    constructor(supabase, communicationHandler, info, ai) {
         this.rimoriInfo = info;
         this.communicationHandler = communicationHandler;
         this.pluginId = info.pluginId;
         this.releaseChannel = info.releaseChannel;
         this.settingsController = new SettingsController(supabase, info.pluginId, info.guild);
         const currentPlugin = info.installedPlugins.find((plugin) => plugin.id === info.pluginId);
-        this.translator = new Translator(info.interfaceLanguage, (currentPlugin === null || currentPlugin === void 0 ? void 0 : currentPlugin.endpoint) || '');
+        this.translator = new Translator(info.interfaceLanguage, (currentPlugin === null || currentPlugin === void 0 ? void 0 : currentPlugin.endpoint) || '', ai);
         this.communicationHandler.onUpdate((updatedInfo) => (this.rimoriInfo = updatedInfo));
         this.applicationMode = this.communicationHandler.getQueryParam('applicationMode');
         this.theme = this.communicationHandler.getQueryParam('rm_theme') || 'light';

package/dist/utils/difficultyConverter.d.ts

@@ -2,3 +2,11 @@ export type LanguageLevel = 'Pre-A1' | 'A1' | 'A2' | 'B1' | 'B2' | 'C1' | 'C2' |
 export declare function getDifficultyLevel(difficulty: LanguageLevel): number;
 export declare function getDifficultyLabel(difficulty: number): LanguageLevel;
 export declare function getNeighborDifficultyLevel(difficulty: LanguageLevel, difficultyAdjustment: number): LanguageLevel;
+/**
+ * Compares two LanguageLevel values to determine their relative order.
+ * Returns:
+ * - negative number if level1 < level2
+ * - 0 if level1 === level2
+ * - positive number if level1 > level2
+ */
+export declare function compareLanguageLevels(level1: LanguageLevel, level2: LanguageLevel): number;

package/dist/utils/difficultyConverter.js

@@ -8,3 +8,13 @@ export function getDifficultyLabel(difficulty) {
 export function getNeighborDifficultyLevel(difficulty, difficultyAdjustment) {
     return getDifficultyLabel(getDifficultyLevel(difficulty) + difficultyAdjustment - 1);
 }
+/**
+ * Compares two LanguageLevel values to determine their relative order.
+ * Returns:
+ * - negative number if level1 < level2
+ * - 0 if level1 === level2
+ * - positive number if level1 > level2
+ */
+export function compareLanguageLevels(level1, level2) {
+    return getDifficultyLevel(level1) - getDifficultyLevel(level2);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rimori/client",
-  "version": "2.5.8",
+  "version": "2.5.9",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "repository": {