@rimori/client 2.2.0 → 2.3.0-next.1

package/dist/plugin/Logger.js

@@ -7,7 +7,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import html2canvas from 'html2canvas';
 /**
  * Singleton Logger class for Rimori client plugins.
  * Handles all logging levels, production filtering, and log transmission to Rimori.
@@ -242,17 +241,30 @@ export class Logger {
     }
     /**
      * Capture a screenshot of the current page.
+     * Dynamically imports html2canvas only in browser environments.
      * @returns Promise resolving to base64 screenshot or null if failed
      */
     captureScreenshot() {
         return __awaiter(this, void 0, void 0, function* () {
-            if (typeof window !== 'undefined' && typeof document !== 'undefined') {
+            // Only attempt to capture screenshot in browser environments
+            if (typeof window === 'undefined' || typeof document === 'undefined') {
+                return null;
+            }
+            try {
+                // Dynamically import html2canvas only when window is available
+                // html2canvas is an optional peer dependency - provided by @rimori/react-client
+                // In worker builds, this import should be marked as external to prevent bundling
+                const html2canvas = (yield import('html2canvas')).default;
                 const canvas = yield html2canvas(document.body);
                 const screenshot = canvas.toDataURL('image/png');
                 // this.originalConsole.log("screenshot captured", screenshot)
                 return screenshot;
             }
-            return null;
+            catch (error) {
+                // html2canvas may not be available (e.g., in workers or when not installed)
+                // Silently fail to avoid breaking logging functionality
+                return null;
+            }
         });
     }
     /**

package/dist/plugin/RimoriClient.d.ts

@@ -22,6 +22,11 @@ export declare class RimoriClient {
     private constructor();
     get plugin(): {
         pluginId: string;
+        /**
+         * The release channel of this plugin installation.
+         * Determines which database schema is used for plugin tables.
+         */
+        releaseChannel: "alpha" | "beta" | "stable";
         /**
          * Set the settings for the plugin.
          * @param settings The settings to set.
@@ -67,6 +72,13 @@ export declare class RimoriClient {
          * The table prefix for of database tables of the plugin.
          */
         tablePrefix: string;
+        /**
+         * The database schema used for plugin tables.
+         * Determined by rimori-main based on release channel:
+         * - 'plugins_alpha' for alpha release channel
+         * - 'plugins' for beta and stable release channels
+         */
+        schema: "plugins" | "plugins_alpha";
         /**
          * 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.

package/dist/plugin/RimoriClient.js

@@ -101,9 +101,9 @@ export class RimoriClient {
                 // 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 }) => {
-                    console.log('Received action ' + data.action);
-                    console.log('Listening to actions', listeningActions);
-                    if (actionsToListen.length === 0 || actionsToListen.includes(data.action)) {
+                    // console.log('Received action for main panel ' + data.action_key);
+                    // console.log('Listening to actions', listeningActions);
+                    if (listeningActions.length === 0 || listeningActions.includes(data.action_key)) {
                         callback(data);
                     }
                 });
@@ -113,9 +113,10 @@ export class RimoriClient {
                 // 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.requestSidebar');
                 this.event.on('action.requestSidebar', ({ data }) => {
-                    console.log('Received action ' + data.action);
-                    console.log('Listening to actions', listeningActions);
-                    if (actionsToListen.length === 0 || actionsToListen.includes(data.action)) {
+                    // console.log("eventHandler .onSidePanelAction", data);
+                    // console.log('Received action for sidebar ' + data.action);
+                    // console.log('Listening to actions', listeningActions);
+                    if (listeningActions.length === 0 || listeningActions.includes(data.action)) {
                         callback(data);
                     }
                 });
@@ -276,7 +277,8 @@ export class RimoriClient {
         this.accomplishmentHandler = new AccomplishmentController(info.pluginId);
         this.settingsController = new SettingsController(supabase, info.pluginId, info.guild);
         this.sharedContentController = new SharedContentController(supabase, this);
-        this.translator = new Translator(info.interfaceLanguage);
+        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) || '');
         //only init logger in workers and on main plugin pages
         if (this.getQueryParam('applicationMode') !== 'sidebar') {
             Logger.getInstance(this);
@@ -285,6 +287,11 @@ export class RimoriClient {
     get plugin() {
         return {
             pluginId: this.rimoriInfo.pluginId,
+            /**
+             * The release channel of this plugin installation.
+             * Determines which database schema is used for plugin tables.
+             */
+            releaseChannel: this.rimoriInfo.releaseChannel,
             /**
              * Set the settings for the plugin.
              * @param settings The settings to set.
@@ -337,7 +344,16 @@ export class RimoriClient {
             //   relation: ViewName,
             // ): PostgrestQueryBuilder<GenericSchema, View, ViewName>;
             from: (relation) => {
-                return this.superbase.from(this.db.getTableName(relation));
+                const tableName = this.db.getTableName(relation);
+                // Use the schema determined by rimori-main based on release channel
+                // Global tables (starting with 'global_') remain in public schema
+                // Plugin tables use the schema provided by rimori-main (plugins or plugins_alpha)
+                if (relation.startsWith('global_')) {
+                    // Global tables stay in public schema
+                    return this.superbase.from(tableName);
+                }
+                // Plugin tables go to the schema provided by rimori-main
+                return this.superbase.schema(this.rimoriInfo.dbSchema).from(tableName);
             },
             // storage: this.superbase.storage,
             // functions: this.superbase.functions,
@@ -345,6 +361,13 @@ export class RimoriClient {
              * The table prefix for of database tables of the plugin.
              */
             tablePrefix: this.rimoriInfo.tablePrefix,
+            /**
+             * The database schema used for plugin tables.
+             * Determined by rimori-main based on release channel:
+             * - 'plugins_alpha' for alpha release channel
+             * - 'plugins' for beta and stable release channels
+             */
+            schema: this.rimoriInfo.dbSchema,
             /**
              * 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.

package/example/worker/vite.config.ts

@@ -14,6 +14,9 @@ export default defineConfig({
     outDir: path.resolve(__dirname, '../public'),
     emptyOutDir: false,
     rollupOptions: {
+      // Exclude DOM-only libraries that can't run in workers
+      // html2canvas is provided by @rimori/react-client for browser contexts
+      external: ['html2canvas'],
       output: {
         inlineDynamicImports: true,
         entryFileNames: 'web-worker.js',

package/package.json

@@ -1,8 +1,13 @@
 {
   "name": "@rimori/client",
-  "version": "2.2.0",
+  "version": "2.3.0-next.1",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/rimori-org/rimori-client.git"
+  },
+  "license": "apache-2.0",
   "bin": {
     "rimori-release": "./dist/cli/scripts/release/release.js",
     "rimori-init": "./dist/cli/scripts/init/main.js"
@@ -32,6 +37,7 @@
     "eslint-plugin-prettier": "^5.5.4",
     "eslint-plugin-react-hooks": "^7.0.0",
     "eslint-plugin-react-refresh": "^0.4.23",
+    "html2canvas": "^1.4.1",
     "globals": "^16.4.0",
     "prettier": "^3.6.2",
     "typescript": "^5.7.2",

package/src/controller/SettingsController.ts

@@ -19,6 +19,8 @@ export interface Language {
   uppercase: string;
 }
 
+export type UserRole = 'user' | 'plugin_moderator' | 'lang_moderator' | 'admin';
+
 export interface UserInfo {
   skill_level_reading: LanguageLevel;
   skill_level_writing: LanguageLevel;
@@ -32,8 +34,7 @@ export interface UserInfo {
   story_genre: string;
   study_duration: number;
   /**
-   * The 2 letter language code of the language the user speaks natively.
-   * With the function getLanguageName, the language name can be retrieved.
+   * The language the user speaks natively.
    */
   mother_tongue: Language;
   /**
@@ -52,6 +53,10 @@ export interface UserInfo {
    * Optional: nearest big city (>100,000) near user's location
    */
   target_city?: string;
+  /**
+   * The user's role: 'user', 'plugin_moderator', 'lang_moderator', or 'admin'
+   */
+  user_role: UserRole;
 }
 
 export class SettingsController {

package/src/controller/TranslationController.ts

@@ -1,16 +1,22 @@
 import { createInstance, ThirdPartyModule, TOptions, i18n as i18nType } from 'i18next';
 
+type InitializationState = 'not-inited' | 'initing' | 'finished';
+
 /**
  * Translator class for handling internationalization
  */
 export class Translator {
   private currentLanguage: string;
-  private isInitialized: boolean;
+  private initializationState: InitializationState;
+  private initializationPromise: Promise<void> | null;
   private i18n: i18nType | undefined;
+  private translationUrl: string;
 
-  constructor(initialLanguage: string) {
-    this.isInitialized = false;
+  constructor(initialLanguage: string, translationUrl: string) {
     this.currentLanguage = initialLanguage;
+    this.initializationState = 'not-inited';
+    this.initializationPromise = null;
+    this.translationUrl = translationUrl;
   }
 
   /**
@@ -18,23 +24,46 @@ export class Translator {
    * @param userLanguage - Language code from user info
    */
   async initialize(): Promise<void> {
-    if (this.isInitialized) return;
-
-    const translations = await this.fetchTranslations(this.currentLanguage);
-
-    const instance = createInstance({
-      lng: this.currentLanguage,
-      resources: {
-        [this.currentLanguage]: {
-          translation: translations,
-        },
-      },
-      debug: window.location.hostname === 'localhost',
-    });
-
-    await instance.init();
-    this.i18n = instance;
-    this.isInitialized = true;
+    // If already finished, return immediately
+    if (this.initializationState === 'finished') {
+      return;
+    }
+
+    // If currently initializing, wait for the existing initialization to complete
+    if (this.initializationState === 'initing' && this.initializationPromise) {
+      return this.initializationPromise;
+    }
+
+    // Start initialization
+    this.initializationState = 'initing';
+
+    // Create a promise that will be resolved when initialization completes
+    this.initializationPromise = (async (): Promise<void> => {
+      try {
+        const translations = await this.fetchTranslations(this.currentLanguage);
+
+        const instance = createInstance({
+          lng: this.currentLanguage,
+          resources: {
+            [this.currentLanguage]: {
+              translation: translations,
+            },
+          },
+          debug: window.location.hostname === 'localhost',
+        });
+
+        await instance.init();
+        this.i18n = instance;
+        this.initializationState = 'finished';
+      } catch (error) {
+        // Reset state on error so it can be retried
+        this.initializationState = 'not-inited';
+        this.initializationPromise = null;
+        throw error;
+      }
+    })();
+
+    return this.initializationPromise;
   }
 
   private getTranslationUrl(language: string): string {
@@ -45,7 +74,7 @@ export class Translator {
       return `${window.location.origin}/locales/${filename}.json`;
     }
 
-    return `./locales/${language}.json`;
+    return `${this.translationUrl}/locales/${language}.json`;
   }
 
   public usePlugin(plugin: ThirdPartyModule): void {
@@ -102,6 +131,6 @@ export class Translator {
    * Check if translator is initialized
    */
   isReady(): boolean {
-    return this.isInitialized;
+    return this.initializationState === 'finished';
   }
 }

package/src/fromRimori/EventBus.ts

@@ -3,9 +3,9 @@ export type EventPayload = Record<string, any>;
 
 /**
  * Interface representing a message sent through the EventBus
- * 
+ *
  * Debug capabilities:
- * - System-wide debugging: Send an event to "global.system.requestDebug" 
+ * - System-wide debugging: Send an event to "global.system.requestDebug"
  *   Example: `EventBus.emit("yourPluginId", "global.system.requestDebug");`
  */
 export interface EventBusMessage<T = EventPayload> {
@@ -39,8 +39,8 @@ export class EventBusHandler {
   private listeners: Map<string, Set<Listeners<EventPayload>>> = new Map();
   private responseResolvers: Map<number, (value: EventBusMessage<unknown>) => void> = new Map();
   private static instance: EventBusHandler | null = null;
-  private debugEnabled: boolean = false;
-  private evName: string = "";
+  private debugEnabled = false;
+  private evName = '';
 
   private constructor() {
     //private constructor
@@ -50,12 +50,16 @@ export class EventBusHandler {
     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.`);
+        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;
@@ -80,9 +84,9 @@ export class EventBusHandler {
    * @param topic - The topic of the event.
    * @param data - The data of the event.
    * @param eventId - The event id of the event.
-   * 
+   *
    * The topic format is: **pluginId.area.action**
-   * 
+   *
    * Example topics:
    * - pl1234.card.requestHard
    * - pl1234.card.requestNew
@@ -96,7 +100,13 @@ export class EventBusHandler {
     this.emitInternal(sender, topic, data || {}, eventId);
   }
 
-  private emitInternal(sender: string, topic: string, data: EventPayload, eventId?: number, skipResponseTrigger = false): void {
+  private emitInternal(
+    sender: string,
+    topic: string,
+    data: EventPayload,
+    eventId?: number,
+    skipResponseTrigger = false,
+  ): void {
     if (!this.validateTopic(topic)) {
       this.logAndThrowError(false, `Invalid topic: ` + topic);
       return;
@@ -105,7 +115,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;
@@ -132,8 +142,12 @@ export class EventBusHandler {
    * @param ignoreSender - The senders to ignore.
    * @returns An EventListener object containing an off() method to unsubscribe the listeners.
    */
-  public on<T = EventPayload>(topics: string | string[], handler: EventHandler<T>, ignoreSender: string[] = []): EventListener {
-    const ids = this.toArray(topics).map(topic => {
+  public on<T = EventPayload>(
+    topics: string | string[],
+    handler: EventHandler<T>,
+    ignoreSender: string[] = [],
+  ): EventListener {
+    const ids = this.toArray(topics).map((topic) => {
       this.logIfDebug(`Subscribing to ` + topic, { ignoreSender });
       if (!this.validateTopic(topic)) {
         this.logAndThrowError(true, `Invalid topic: ` + topic);
@@ -144,17 +158,35 @@ export class EventBusHandler {
       }
       const id = Math.floor(Math.random() * 10000000000);
 
-      // Type assertion to handle the generic type mismatch
-      const eventHandler = handler as unknown as EventHandler<EventPayload>;
+      // To prevent infinite loops and processing the same eventId multiple times
+      const blackListedEventIds: { eventId: number; sender: string }[] = [];
+      const eventHandler = (data: EventBusMessage) => {
+        if (blackListedEventIds.some((item) => item.eventId === data.eventId && item.sender === data.sender)) {
+          console.log('BLACKLISTED EVENT ID', data.eventId, data);
+          return;
+        }
+        blackListedEventIds.push({
+          eventId: data.eventId,
+          sender: data.sender,
+        });
+        if (blackListedEventIds.length > 100) {
+          blackListedEventIds.shift();
+        }
+        return (handler as unknown as EventHandler<EventPayload>)(data);
+      };
+
       this.listeners.get(topic)!.add({ id, handler: eventHandler, ignoreSender });
 
-      this.logIfDebug(`Subscribed to ` + topic, { listenerId: id, ignoreSender });
+      this.logIfDebug(`Subscribed to ` + topic, {
+        listenerId: id,
+        ignoreSender,
+      });
 
       return btoa(JSON.stringify({ topic, id }));
     });
 
     return {
-      off: () => this.off(ids)
+      off: () => this.off(ids),
     };
   }
 
@@ -165,33 +197,41 @@ export class EventBusHandler {
    * @param handler - The handler to be called when the event is received. The handler returns the data to be emitted. Can be a static object or a function.
    * @returns An EventListener object containing an off() method to unsubscribe the listeners.
    */
-  public respond(sender: string, topic: string | string[], handler: EventPayload | ((data: EventBusMessage) => EventPayload | Promise<EventPayload>)): EventListener {
+  public respond(
+    sender: string,
+    topic: string | string[],
+    handler: EventPayload | ((data: EventBusMessage) => EventPayload | Promise<EventPayload>),
+  ): EventListener {
     const topics = Array.isArray(topic) ? topic : [topic];
-    const listeners = topics.map(topic => {
+    const listeners = topics.map((topic) => {
       const blackListedEventIds: number[] = [];
       //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 listener = this.on(topic, async (data: EventBusMessage) => {
-        if (blackListedEventIds.includes(data.eventId)) {
-          // console.log("BLACKLISTED EVENT ID", data.eventId);
-          return;
-        }
-        blackListedEventIds.push(data.eventId);
-        if (blackListedEventIds.length > 20) {
-          blackListedEventIds.shift();
-        }
-        const response = typeof handler === "function" ? await handler(data) : handler;
-        this.emit(sender, topic, response, data.eventId);
-      }, finalIgnoreSender);
-
-      this.logIfDebug(`Added respond listener ` + sender + " to topic " + topic, { listener, sender });
+      const finalIgnoreSender = !topic.startsWith('self.') ? [sender] : [];
+
+      const listener = this.on(
+        topic,
+        async (data: EventBusMessage) => {
+          if (blackListedEventIds.includes(data.eventId)) {
+            // console.log("BLACKLISTED EVENT ID", data.eventId);
+            return;
+          }
+          blackListedEventIds.push(data.eventId);
+          if (blackListedEventIds.length > 100) {
+            blackListedEventIds.shift();
+          }
+          const response = typeof handler === 'function' ? await handler(data) : handler;
+          this.emit(sender, topic, response, data.eventId);
+        },
+        finalIgnoreSender,
+      );
+
+      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()),
     };
   }
 
@@ -206,7 +246,7 @@ export class EventBusHandler {
       return;
     }
 
-    let listener: EventListener | undefined;
+    let listener: EventListener | undefined = undefined;
     const wrapper = (event: EventBusMessage<T>) => {
       handler(event);
       listener?.off();
@@ -221,15 +261,18 @@ export class EventBusHandler {
    * @param listenerIds - The ids of the listeners to unsubscribe from.
    */
   private off(listenerIds: string | string[]): void {
-    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 });
+          this.logIfDebug(`Removed listener ` + fullId, {
+            topic,
+            listenerId: id,
+          });
         }
       });
     });
@@ -246,7 +289,11 @@ export class EventBusHandler {
    * @param data - The data of the event.
    * @returns A promise that resolves to the event.
    */
-  public async request<T = EventPayload>(sender: string, topic: string, data?: EventPayload): Promise<EventBusMessage<T>> {
+  public async request<T = EventPayload>(
+    sender: string,
+    topic: string,
+    data?: EventPayload,
+  ): Promise<EventBusMessage<T>> {
     if (!this.validateTopic(topic)) {
       this.logAndThrowError(true, `Invalid topic: ` + topic);
     }
@@ -255,8 +302,10 @@ export class EventBusHandler {
 
     this.logIfDebug(`Requesting data from ` + topic, { event });
 
-    return new Promise<EventBusMessage<T>>(resolve => {
-      this.responseResolvers.set(event.eventId, (value: EventBusMessage<unknown>) => resolve(value as EventBusMessage<T>));
+    return new Promise<EventBusMessage<T>>((resolve) => {
+      this.responseResolvers.set(event.eventId, (value: EventBusMessage<unknown>) =>
+        resolve(value as EventBusMessage<T>),
+      );
       this.emitInternal(sender, topic, data || {}, event.eventId, true);
     });
   }
@@ -271,7 +320,7 @@ export class EventBusHandler {
 
     // 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]);
   }
@@ -283,32 +332,35 @@ export class EventBusHandler {
    */
   private validateTopic(topic: string): boolean {
     // 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"];
+    const validActions = ['request', 'create', 'update', 'delete', 'trigger'];
 
-    if (validActions.some(a => action.startsWith(a))) {
+    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;
   }
 
@@ -327,4 +379,4 @@ export class EventBusHandler {
   }
 }
 
-export const EventBus = EventBusHandler.getInstance();
+export const EventBus = EventBusHandler.getInstance();