@rimori/client 1.4.9 → 2.0.0

package/dist/{plugin → rimori-client/src/plugin}/RimoriClient.js

@@ -7,17 +7,19 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { generateText, streamChatGPT } from '../core/controller/AIController';
-import { generateObject } from '../core/controller/ObjectController';
-import { SettingsController } from '../core/controller/SettingsController';
-import { SharedContentController, } from '../core/controller/SharedContentController';
-import { getSTTResponse, getTTSResponse } from '../core/controller/VoiceController';
-import { ExerciseController } from '../core/controller/ExerciseController';
+import { generateText, streamChatGPT } from '../controller/AIController';
+import { generateObject } from '../controller/ObjectController';
+import { SettingsController } from '../controller/SettingsController';
+import { SharedContentController, } from '../controller/SharedContentController';
+import { getSTTResponse, getTTSResponse } from '../controller/VoiceController';
+import { ExerciseController } from '../controller/ExerciseController';
 import { EventBus } from '../fromRimori/EventBus';
-import { AccomplishmentHandler } from './AccomplishmentHandler';
-import { Translator } from './TranslationController';
+import { AccomplishmentController } from '../controller/AccomplishmentController';
+import { RimoriCommunicationHandler } from './CommunicationHandler';
+import { Translator } from '../controller/TranslationController';
+import { Logger } from './Logger';
 export class RimoriClient {
-    constructor(supabase, info, pluginController) {
+    constructor(controller, supabase, info) {
         this.event = {
             /**
              * Emit an event to Rimori or a plugin.
@@ -94,10 +96,14 @@ export class RimoriClient {
             emitSidebarAction: (pluginId, actionKey, text) => {
                 this.event.emit('global.sidebar.triggerAction', { plugin_id: pluginId, action_key: actionKey, text });
             },
-            onMainPanelAction: (callback) => {
+            onMainPanelAction: (callback, actionsToListen = []) => {
                 // this needs to be a emit and on because the main panel action is triggered by the user and not by the plugin
                 this.event.emit('action.requestMain');
-                this.event.on('action.requestMain', ({ data }) => callback(data));
+                this.event.on('action.requestMain', ({ data }) => {
+                    if (actionsToListen.includes(data.action)) {
+                        callback(data);
+                    }
+                });
             },
         };
         this.navigation = {
@@ -233,7 +239,9 @@ export class RimoriClient {
              * @returns Created exercise object.
              */
             add: (params) => __awaiter(this, void 0, void 0, function* () {
-                return this.exerciseController.addExercise(params);
+                const token = yield this.pluginController.getToken();
+                const backendUrl = this.pluginController.getBackendUrl();
+                return this.exerciseController.addExercise(token, backendUrl, params);
             }),
             /**
              * Deletes an exercise via the backend API.
@@ -241,37 +249,52 @@ export class RimoriClient {
              * @returns Success status.
              */
             delete: (id) => __awaiter(this, void 0, void 0, function* () {
-                return this.exerciseController.deleteExercise(id);
+                const token = yield this.pluginController.getToken();
+                const backendUrl = this.pluginController.getBackendUrl();
+                return this.exerciseController.deleteExercise(token, backendUrl, id);
             }),
         };
         this.rimoriInfo = info;
         this.superbase = supabase;
-        this.pluginController = pluginController;
+        this.pluginController = controller;
+        this.exerciseController = new ExerciseController(supabase);
+        this.accomplishmentHandler = new AccomplishmentController(info.pluginId);
         this.settingsController = new SettingsController(supabase, info.pluginId, info.guild);
-        this.sharedContentController = new SharedContentController(this.superbase, this);
-        this.exerciseController = new ExerciseController(supabase, pluginController);
-        this.accomplishmentHandler = new AccomplishmentHandler(info.pluginId);
+        this.sharedContentController = new SharedContentController(supabase, this);
         this.translator = new Translator(info.profile.mother_tongue.code);
-        this.from = this.from.bind(this);
-        this.getTableName = this.getTableName.bind(this);
-        this.db = {
-            from: this.from,
-            // storage: this.superbase.storage,
-            // functions: this.superbase.functions,
-            tablePrefix: info.tablePrefix,
-            getTableName: this.getTableName,
-        };
-        this.plugin = {
-            pluginId: info.pluginId,
+        //only init logger in workers and on main plugin pages
+        if (this.getQueryParam('applicationMode') !== 'sidebar') {
+            Logger.getInstance(this);
+        }
+    }
+    get plugin() {
+        return {
+            pluginId: this.rimoriInfo.pluginId,
+            /**
+             * Set the settings for the plugin.
+             * @param settings The settings to set.
+             */
             setSettings: (settings) => __awaiter(this, void 0, void 0, function* () {
                 yield this.settingsController.setSettings(settings);
             }),
+            /**
+             * Get the settings for the plugin. T can be any type of settings, UserSettings or SystemSettings.
+             * @param defaultSettings The default settings to use if no settings are found.
+             * @param genericSettings The type of settings to get.
+             * @returns The settings for the plugin.
+             */
             getSettings: (defaultSettings) => __awaiter(this, void 0, void 0, function* () {
                 return yield this.settingsController.getSettings(defaultSettings);
             }),
             getUserInfo: () => {
                 return this.rimoriInfo.profile;
             },
+            /**
+             * Retrieves information about plugins, including:
+             * - All installed plugins
+             * - The currently active plugin in the main panel
+             * - The currently active plugin in the side panel
+             */
             getPluginInfo: () => {
                 return {
                     installedPlugins: this.rimoriInfo.installedPlugins,
@@ -279,12 +302,51 @@ export class RimoriClient {
                     sidePanelPlugin: this.rimoriInfo.sidePanelPlugin,
                 };
             },
+            /**
+             * Get the translator for the plugin.
+             * @returns The translator for the plugin.
+             */
             getTranslator: () => __awaiter(this, void 0, void 0, function* () {
                 yield this.translator.initialize();
                 return this.translator;
             }),
         };
     }
+    get db() {
+        return {
+            //     private from<
+            //   TableName extends string & keyof GenericSchema['Tables'],
+            //   Table extends GenericSchema['Tables'][TableName],
+            // >(relation: TableName): PostgrestQueryBuilder<GenericSchema, Table, TableName>;
+            // private from<ViewName extends string & keyof GenericSchema['Views'], View extends GenericSchema['Views'][ViewName]>(
+            //   relation: ViewName,
+            // ): PostgrestQueryBuilder<GenericSchema, View, ViewName>;
+            from: (relation) => {
+                return this.superbase.from(this.db.getTableName(relation));
+            },
+            // storage: this.superbase.storage,
+            // functions: this.superbase.functions,
+            /**
+             * The table prefix for of database tables of the plugin.
+             */
+            tablePrefix: this.rimoriInfo.tablePrefix,
+            /**
+             * Get the table name for a given plugin table.
+             * Internally all tables are prefixed with the plugin id. This function is used to get the correct table name for a given public table.
+             * @param table The plugin table name to get the full table name for.
+             * @returns The full table name.
+             */
+            getTableName: (table) => {
+                if (/[A-Z]/.test(table)) {
+                    throw new Error('Table name cannot include uppercase letters. Please use snake_case for table names.');
+                }
+                if (table.startsWith('global_')) {
+                    return table.replace('global_', '');
+                }
+                return this.db.tablePrefix + '_' + table;
+            },
+        };
+    }
     /**
      * Get a query parameter value that was passed via MessageChannel
      * @param key The query parameter key
@@ -293,25 +355,21 @@ export class RimoriClient {
     getQueryParam(key) {
         return this.pluginController.getQueryParam(key);
     }
-    static getInstance(pluginController) {
+    static getInstance(pluginId) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!RimoriClient.instance) {
-                const client = yield pluginController.getClient();
-                RimoriClient.instance = new RimoriClient(client.supabase, client.info, pluginController);
+                if (!pluginId)
+                    throw new Error('Plugin ID is required');
+                const controller = new RimoriCommunicationHandler(pluginId, false);
+                if (typeof WorkerGlobalScope === 'undefined') {
+                    // In standalone mode, use URL fallback. In iframe mode, theme will be set after MessageChannel init
+                    // setTheme();
+                    // await StandaloneClient.initListeners(pluginId);
+                }
+                const client = yield controller.getClient();
+                RimoriClient.instance = new RimoriClient(controller, client.supabase, client.info);
             }
             return RimoriClient.instance;
         });
     }
-    from(relation) {
-        return this.superbase.from(this.getTableName(relation));
-    }
-    getTableName(table) {
-        if (/[A-Z]/.test(table)) {
-            throw new Error('Table name cannot include uppercase letters. Please use snake_case for table names.');
-        }
-        if (table.startsWith('global_')) {
-            return table.replace('global_', '');
-        }
-        return this.db.tablePrefix + '_' + table;
-    }
 }

package/dist/{worker → rimori-client/src/worker}/WorkerSetup.js

@@ -7,8 +7,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+import { RimoriClient } from '../plugin/RimoriClient';
 import { EventBusHandler } from '../fromRimori/EventBus';
-import { PluginController } from '../plugin/PluginController';
 /**
  * Sets up the web worker for the plugin to be able receive and send messages to Rimori.
  * @param pluginId - The id of the plugin to setup the worker for.
@@ -28,7 +28,7 @@ export function setupWorker(pluginId, init) {
         // Assign the mock to globalThis.
         Object.assign(globalThis, { window: mockWindow });
         EventBusHandler.getInstance('Worker EventBus');
-        const rimoriClient = yield PluginController.getInstance(pluginId);
+        const rimoriClient = yield RimoriClient.getInstance(pluginId);
         console.debug('[Worker] RimoriClient initialized.');
         yield init(rimoriClient);
         console.debug('[Worker] Worker initialized.');

package/example/docs/devdocs.md

@@ -42,7 +42,7 @@ plugin.event.emit('pl123456789.flashcard.createLangCard', {
 
 ```javascript
 // Request word translation
-const translation = await plugin.event.request('pl123456789.lookup.requestBasic', {
+const translation = await plugin.event.request('pl123456789.lookup.request', {
   word: 'laufen',
   language: 'de', // optional
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rimori/client",
-  "version": "1.4.9",
+  "version": "2.0.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "bin": {
@@ -12,38 +12,18 @@
     ".": {
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
-    },
-    "./core": {
-      "types": "./dist/core/core.d.ts",
-      "default": "./dist/core/core.js"
-    },
-    "./components": {
-      "types": "./dist/components.d.ts",
-      "default": "./dist/components.js"
     }
   },
   "scripts": {
-    "build": "tsc && sass src/style.scss:dist/style.css",
+    "build": "tsc",
     "dev": "tsc -w  --preserveWatchOutput",
-    "css-dev": "sass --watch src/style.scss:dist/style.css",
     "lint": "eslint . --fix",
     "format": "prettier --write ."
   },
-  "peerDependencies": {
-    "react": "^18.0.0",
-    "react-dom": "^18.0.0"
-  },
   "dependencies": {
     "@supabase/supabase-js": "2.49.4",
-    "@tiptap/react": "2.10.3",
-    "@tiptap/starter-kit": "2.10.3",
     "dotenv": "16.5.0",
-    "html2canvas": "1.4.1",
-    "i18next": "^25.6.0",
-    "prettier": "^3.6.2",
-    "react-icons": "5.4.0",
-    "react-markdown": "10.1.0",
-    "tiptap-markdown": "0.8.10"
+    "i18next": "^25.6.0"
   },
   "devDependencies": {
     "@eslint/js": "^9.37.0",
@@ -51,10 +31,8 @@
     "eslint-plugin-prettier": "^5.5.4",
     "eslint-plugin-react-hooks": "^7.0.0",
     "eslint-plugin-react-refresh": "^0.4.23",
-    "form-data": "^4.0.2",
     "globals": "^16.4.0",
-    "node-fetch": "^3.3.2",
-    "sass": "^1.82.0",
+    "prettier": "^3.6.2",
     "typescript": "^5.7.2",
     "typescript-eslint": "^8.46.0"
   }

package/src/{core/controller → controller}/AIController.ts

@@ -1,4 +1,4 @@
-import { Tool } from '../../fromRimori/PluginTypes';
+import { Tool } from '../fromRimori/PluginTypes';
 
 export interface ToolInvocation {
   toolCallId: string;
@@ -38,7 +38,7 @@ export async function streamChatGPT(
   token: string,
 ) {
   const messageId = Math.random().toString(36).substring(3);
-  let currentMessages: Message[] = [...messages];
+  const currentMessages: Message[] = [...messages];
 
   console.log('Starting streamChatGPT with:', {
     messageId,
@@ -71,7 +71,7 @@ export async function streamChatGPT(
 
       let content = '';
       let done = false;
-      let toolInvocations: { toolCallId: string; toolName: string; args: any }[] = [];
+      const toolInvocations: { toolCallId: string; toolName: string; args: any }[] = [];
       let currentTextId = '';
       let isToolCallMode = false;
       let buffer = ''; // Buffer for incomplete chunks

package/src/{plugin/AccomplishmentHandler.ts → controller/AccomplishmentController.ts}

@@ -36,7 +36,7 @@ export interface MacroAccomplishmentPayload extends BaseAccomplishmentPayload {
 
 export type AccomplishmentPayload = MicroAccomplishmentPayload | MacroAccomplishmentPayload;
 
-export class AccomplishmentHandler {
+export class AccomplishmentController {
   private pluginId: string;
 
   public constructor(pluginId: string) {

package/src/{core/controller → controller}/ExerciseController.ts

@@ -1,5 +1,4 @@
 import { SupabaseClient } from '@supabase/supabase-js';
-import { PluginController } from '../../plugin/PluginController';
 
 export type TriggerAction = { action_key: string } & Record<string, string | number | boolean>;
 
@@ -28,11 +27,9 @@ export interface Exercise {
 
 export class ExerciseController {
   private supabase: SupabaseClient;
-  private pluginController: PluginController;
 
-  constructor(supabase: SupabaseClient, pluginController: PluginController) {
+  constructor(supabase: SupabaseClient) {
     this.supabase = supabase;
-    this.pluginController = pluginController;
   }
 
   /**
@@ -52,12 +49,13 @@ export class ExerciseController {
 
   /**
    * Creates a new exercise via the backend API.
+   * @param token The token to use for authentication.
+   * @param backendUrl The URL of the backend API.
    * @param params Exercise creation parameters.
    * @returns Created exercise object.
    */
-  public async addExercise(params: CreateExerciseParams): Promise<Exercise> {
-    const token = await this.pluginController.getToken();
-    const response = await fetch(`${this.pluginController.getBackendUrl()}/exercises`, {
+  public async addExercise(token: string, backendUrl: string, params: CreateExerciseParams): Promise<Exercise> {
+    const response = await fetch(`${backendUrl}/exercises`, {
       method: 'POST',
       headers: {
         'Content-Type': 'application/json',
@@ -76,12 +74,17 @@ export class ExerciseController {
 
   /**
    * Deletes an exercise via the backend API.
-   * @param id The exercise ID to delete.
+   * @param token The token to use for authentication.
+   * @param backendUrl The URL of the backend API.
+   * @param exerciseId The exercise ID to delete.
    * @returns Success status.
    */
-  public async deleteExercise(id: string): Promise<{ success: boolean; message: string }> {
-    const token = await this.pluginController.getToken();
-    const response = await fetch(`${this.pluginController.getBackendUrl()}/exercises/${id}`, {
+  public async deleteExercise(
+    token: string,
+    backendUrl: string,
+    id: string,
+  ): Promise<{ success: boolean; message: string }> {
+    const response = await fetch(`${backendUrl}/exercises/${id}`, {
       method: 'DELETE',
       headers: {
         Authorization: `Bearer ${token}`,

package/src/{core/controller → controller}/ObjectController.ts

@@ -41,7 +41,7 @@ export interface ObjectRequest {
   instructions: string;
 }
 
-export async function generateObject(backendUrl: string, request: ObjectRequest, token: string) {
+export async function generateObject<T = any>(backendUrl: string, request: ObjectRequest, token: string): Promise<T> {
   return await fetch(`${backendUrl}/ai/llm-object`, {
     method: 'POST',
     body: JSON.stringify({
@@ -85,7 +85,7 @@ export async function streamObject(
 
   let content = '';
   let done = false;
-  let toolInvocations: any[] = [];
+  const toolInvocations: any[] = [];
   while (!done) {
     const { value } = await reader.read();
 

package/src/{core/controller → controller}/SettingsController.ts

@@ -1,6 +1,6 @@
 import { SupabaseClient } from '@supabase/supabase-js';
-import { LanguageLevel } from '../../utils/difficultyConverter';
-import { Guild } from '../core';
+import { LanguageLevel } from '../utils/difficultyConverter';
+import { Guild } from '../plugin/CommunicationHandler';
 
 export interface Buddy {
   id: string;

package/src/{core/controller → controller}/SharedContentController.ts

@@ -1,5 +1,5 @@
 import { SupabaseClient } from '@supabase/supabase-js';
-import { RimoriClient } from '../../plugin/RimoriClient';
+import { RimoriClient } from '../plugin/RimoriClient';
 import { ObjectRequest } from './ObjectController';
 
 export interface SharedContentObjectRequest extends ObjectRequest {

package/src/{plugin → controller}/TranslationController.ts

@@ -39,11 +39,13 @@ export class Translator {
 
   private getTranslationUrl(language: string): string {
     // For localhost development, use local- prefix for non-English languages
-    const isLocalhost = window.location.hostname === 'localhost';
-    const isEnglish = language === 'en';
-    const filename = isLocalhost && !isEnglish ? `local-${language}` : language;
+    if (window.location.hostname === 'localhost') {
+      const filename = language !== 'en' ? `local-${language}` : language;
 
-    return `${window.location.origin}/locales/${filename}.json`;
+      return `${window.location.origin}/locales/${filename}.json`;
+    }
+
+    return `./locales/${language}.json`;
   }
 
   public usePlugin(plugin: ThirdPartyModule): void {

package/src/{core/controller → controller}/VoiceController.ts

@@ -1,4 +1,4 @@
-export async function getSTTResponse(backendUrl: string, audio: Blob, token: string) {
+export async function getSTTResponse(backendUrl: string, audio: Blob, token: string): Promise<string> {
   const formData = new FormData();
   formData.append('file', audio);
 
@@ -14,7 +14,7 @@ export async function getSTTResponse(backendUrl: string, audio: Blob, token: str
     });
 }
 
-export async function getTTSResponse(backendUrl: string, request: TTSRequest, token: string) {
+export async function getTTSResponse(backendUrl: string, request: TTSRequest, token: string): Promise<Blob> {
   return await fetch(`${backendUrl}/voice/tts`, {
     method: 'POST',
     headers: {

package/src/fromRimori/readme.md

@@ -1,2 +1,2 @@
-Files inside this folder are copied from Rimori and should not be changed.
+Files inside this folder are copied from Rimori main repository and should not be changed.
 If change is needed adapt it in Rimori and copy the file then over.

package/src/index.ts

@@ -1,12 +1,12 @@
 // Re-export everything
-export * from './components';
-export * from './hooks/UseChatHook';
-export * from './plugin/PluginController';
-export * from './providers/PluginProvider';
+export * from './plugin/CommunicationHandler';
 export * from './cli/types/DatabaseTypes';
 export * from './utils/difficultyConverter';
-export * from './utils/PluginUtils';
 export * from './fromRimori/PluginTypes';
-export { FirstMessages } from './components/ai/utils';
-export { AudioController } from './plugin/AudioController';
-export { useTranslation } from './hooks/I18nHooks';
+export * from './fromRimori/EventBus';
+export * from './plugin/RimoriClient';
+export * from './plugin/StandaloneClient';
+export { AudioController } from './controller/AudioController';
+export { Translator } from './controller/TranslationController';
+export type { Message, ToolInvocation } from './controller/AIController';
+export type { TOptions } from 'i18next';

package/src/plugin/{PluginController.ts → CommunicationHandler.ts}

@@ -1,11 +1,7 @@
 import { createClient, SupabaseClient } from '@supabase/supabase-js';
-import { UserInfo } from '../core/controller/SettingsController';
+import { UserInfo } from '../controller/SettingsController';
 import { EventBus, EventBusMessage } from '../fromRimori/EventBus';
 import { ActivePlugin, Plugin } from '../fromRimori/PluginTypes';
-import { RimoriClient } from './RimoriClient';
-import { StandaloneClient } from './StandaloneClient';
-import { setTheme } from './ThemeSetter';
-import { Logger } from './Logger';
 
 // Add declaration for WorkerGlobalScope
 declare const WorkerGlobalScope: any;
@@ -31,35 +27,26 @@ export interface RimoriInfo {
   sidePanelPlugin?: ActivePlugin;
 }
 
-export class PluginController {
-  private static client: RimoriClient;
-  private static instance: PluginController;
+export class RimoriCommunicationHandler {
   private port: MessagePort | null = null;
   private queryParams: Record<string, string> = {};
   private supabase: SupabaseClient | null = null;
   private rimoriInfo: RimoriInfo | null = null;
   private pluginId: string;
-  private isMessageChannelReady: boolean = false;
+  private isMessageChannelReady = false;
   private pendingRequests: Array<() => void> = [];
 
-  private constructor(pluginId: string, standalone: boolean) {
+  public constructor(pluginId: string, standalone: boolean) {
     this.pluginId = pluginId;
     this.getClient = this.getClient.bind(this);
 
-    if (typeof WorkerGlobalScope === 'undefined') {
-      // In standalone mode, use URL fallback. In iframe mode, theme will be set after MessageChannel init
-      if (standalone) {
-        setTheme();
-      }
-    }
-
     //no need to forward messages to parent in standalone mode or worker context
     if (standalone) return;
 
     this.initMessageChannel(typeof WorkerGlobalScope !== 'undefined');
   }
 
-  private initMessageChannel(worker: boolean = false) {
+  private initMessageChannel(worker = false) {
     const listener = (event: MessageEvent) => {
       console.log('[PluginController] window message', { origin: event.origin, data: event.data });
       const { type, pluginId, queryParams, rimoriInfo } = event.data || {};
@@ -105,7 +92,8 @@ export class PluginController {
       // Set theme from MessageChannel query params
       if (!worker) {
         const theme = this.queryParams['rm_theme'];
-        setTheme(theme);
+        // setTheme(theme);
+        console.log('TODO: set theme from MessageChannel query params');
       }
 
       // Forward plugin events to parent (only after MessageChannel is ready)
@@ -130,7 +118,7 @@ export class PluginController {
     this.sendHello(worker);
   }
 
-  private sendHello(isWorker: boolean = false) {
+  private sendHello(isWorker = false): void {
     try {
       const payload = { type: 'rimori:hello', pluginId: this.pluginId };
       if (isWorker) {
@@ -143,22 +131,6 @@ export class PluginController {
     }
   }
 
-  public static async getInstance(pluginId: string, standalone = false): Promise<RimoriClient> {
-    if (!PluginController.instance) {
-      if (standalone) {
-        await StandaloneClient.initListeners(pluginId);
-      }
-      PluginController.instance = new PluginController(pluginId, standalone);
-      PluginController.client = await RimoriClient.getInstance(PluginController.instance);
-
-      //only init logger in workers and on main plugin pages
-      if (PluginController.instance.getQueryParam('applicationMode') !== 'sidebar') {
-        Logger.getInstance(PluginController.client);
-      }
-    }
-    return PluginController.client;
-  }
-
   public getQueryParam(key: string): string | null {
     return this.queryParams[key] || null;
   }