@rimori/client 2.4.0 → 2.5.0-next.2

package/src/fromRimori/PluginTypes.ts

@@ -1,214 +0,0 @@
-// whole configuration of a plugin (from the database)
-export type Plugin<T extends object = object> = Omit<RimoriPluginConfig<T>, 'context_menu_actions'> & {
-  version: string;
-  endpoint: string;
-  assetEndpoint: string;
-  context_menu_actions: MenuEntry[];
-  release_channel: 'alpha' | 'beta' | 'stable';
-};
-
-export type ActivePlugin = Plugin<{ active?: boolean }>;
-
-// browsable page of a plugin
-export interface PluginPage {
-  id: string;
-  name: string;
-  url: string;
-  // Whether the page should be shown in the navbar
-  show: boolean;
-  description: string;
-  root:
-    | 'vocabulary'
-    | 'grammar'
-    | 'reading'
-    | 'listening'
-    | 'watching'
-    | 'writing'
-    | 'speaking'
-    | 'other'
-    | 'community';
-  // The actions that can be triggered in the plugin
-  // The key is the action key. The other entries are additional properties needed when triggering the action
-  action?: {
-    key: string;
-    parameters: ObjectTool;
-  };
-}
-
-// a sidebar page of a plugin
-export interface SidebarPage {
-  // identifier of the page. Used to know which page to trigger when clicking on the sidebar
-  id: string;
-  // name of the page. Shown in the settings
-  name: string;
-  // description of the page. Shown in the settings
-  description: string;
-  // relative or absolute URL or path to the plugin's page
-  url: string;
-  // relative or absolute URL or path to the plugin's icon image
-  icon: string;
-}
-
-// context menu entry being configured in the plugin configuration
-export interface MenuEntry {
-  // id of the plugin that the menu entry belongs to
-  plugin_id: string;
-  // identifier of the menu entry action. Used to know which entry to trigger when clicking on the context menu
-  action_key: string;
-  // text of the menu entry. Shown in the context menu
-  text: string;
-  // icon of the menu entry. Shown in the context menu
-  iconUrl?: string;
-}
-
-// an action from the main panel that can be triggered and performs an action in the main panel
-export type MainPanelAction = {
-  plugin_id: string;
-  action_key: string;
-} & Record<string, string>;
-
-// an action from the context menu that can be triggered and performs an action in the sidebar plugin
-export interface ContextMenuAction {
-  // selected text when clicking on the context menu
-  text: string;
-  // id of the plugin that the action belongs to
-  plugin_id: string;
-  // key of the action. Used to know which action to trigger when clicking on the context menu
-  action_key: string;
-}
-
-/**
- * Rimori plugin structure representing the complete configuration
- * of a Rimori plugin with all metadata and configuration options.
- */
-export interface RimoriPluginConfig<T extends object = object> {
-  id: string;
-  /**
-   * Basic information about the plugin including branding and core details.
-   */
-  info: {
-    /** The display name of the plugin shown to users */
-    title: string;
-    /** Detailed description introducing the plugin */
-    description: string;
-    /** relative or absolute URL or path to the plugin's logo/icon image */
-    logo: string;
-    /** Optional website URL for the plugin's homepage or link to plugins owner for contributions */
-    website?: string;
-  };
-  /**
-   * Configuration for different types of pages.
-   */
-  pages: {
-    /** Optional external URL where the plugin is hosted instead of the default CDN */
-    external_hosted_url?: string;
-    /** Array of main plugin pages that appear in the application's main navigation (can be disabled using the 'show' flag) */
-    main: (PluginPage & T)[];
-    /** Array of sidebar pages that appear in the sidebar for quick access (can be disabled using the 'show' flag) */
-    sidebar: (SidebarPage & T)[];
-    /** Optional path to the plugin's settings/configuration page */
-    settings?: string;
-    /** Optional array of event topics the plugin pages can listen to for cross-plugin communication */
-    topics?: string[];
-  };
-  /**
-   * Context menu actions that the plugin registers to appear in right-click menus throughout the application.
-   */
-  context_menu_actions: Omit<MenuEntry, 'plugin_id'>[];
-  /**
-   * Documentation paths for different types of plugin documentation.
-   */
-  documentation: {
-    /** Path to the general overview documentation. It's shown upon installation of the plugin. */
-    overview_path: string;
-    /** Path to user-facing documentation and guides */
-    user_path: string;
-    /** Path to developer documentation for plugin development */
-    developer_path: string;
-  };
-  /**
-   * Configuration for the plugin's web worker if it uses background processing or exposes actions to other plugins.
-   */
-  worker?: {
-    /** Relative path to the web worker JavaScript file. Mostly it's 'web-worker.js' which is located in the public folder. */
-    url: string;
-    /** Optional array of event topics the worker should listen to in addition to events having the pluginId in the topic. Can be a wildcard. Example: 'global.topic.*' or 'pluginId.*' */
-    topics?: string[];
-  };
-}
-
-// copied from llm edge function
-
-export interface Tool {
-  name: string;
-  description: string;
-  parameters: {
-    name: string;
-    description: string;
-    type: 'string' | 'number' | 'boolean';
-  }[];
-  execute?: (args: Record<string, any>) => Promise<unknown> | unknown | void;
-}
-
-/**
- * The tool definition structure is used for LLM function calling and plugin action parameters.
- * It defines the schema for tools that can be used by Language Learning Models (LLMs)
- * and plugin actions.
- *
- * @example
- * ```typescript
- * const flashcardTool: Tool = {
- *   total_amount: {
- *     type: 'string',
- *     enum: ['default', '10', '20', '50'],
- *     description: 'Number of flashcards to practice'
- *   },
- *   deck: {
- *     type: 'string',
- *     enum: ['latest', 'random', 'oldest', 'mix', 'best_known'],
- *     description: 'Type of deck to practice'
- *   }
- * };
- * ```
- *
- */
-export type ObjectTool = {
-  [key: string]: ToolParameter;
-};
-
-/**
- * Parameter definition for LLM tools and plugin actions.
- * Defines the structure, validation rules, and metadata for individual tool parameters.
- * Used to create type-safe interfaces between LLMs, plugins, and the Rimori platform.
- */
-interface ToolParameter {
-  /** The data type of the parameter - can be primitive, nested object, or array */
-  type: ToolParameterType;
-  /** Human-readable description of the parameter's purpose and usage */
-  description: string;
-  /** Optional array of allowed values for enumerated parameters */
-  enum?: string[];
-  /** Whether the parameter is optional */
-  optional?: boolean;
-}
-
-/**
- * Union type defining all possible parameter types for LLM tools.
- * Supports primitive types, nested objects for complex data structures,
- * and arrays of objects for collections. The tuple notation [{}] indicates
- * arrays of objects with a specific structure.
- *
- * @example Primitive: 'string' | 'number' | 'boolean'
- * @example Nested object: { name: { type: 'string' }, age: { type: 'number' } }
- * @example Array of objects: [{ id: { type: 'string' }, value: { type: 'number' } }]
- */
-type ToolParameterType =
-  | PrimitiveType
-  | { [key: string]: ToolParameter } // for nested objects
-  | [{ [key: string]: ToolParameter }]; // for arrays of objects (notice the tuple type)
-
-/**
- * Primitive data types supported by the LLM tool system.
- * These align with JSON schema primitive types and TypeScript basic types.
- */
-type PrimitiveType = 'string' | 'number' | 'boolean';

package/src/fromRimori/readme.md

@@ -1,2 +0,0 @@
-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,19 +0,0 @@
-// Re-export everything
-export * from './plugin/CommunicationHandler';
-export * from './cli/types/DatabaseTypes';
-export * from './utils/difficultyConverter';
-export * from './fromRimori/PluginTypes';
-export * from './fromRimori/EventBus';
-export * from './plugin/RimoriClient';
-export * from './plugin/StandaloneClient';
-export { setupWorker } from './worker/WorkerSetup';
-export { AudioController } from './controller/AudioController';
-export { Translator } from './controller/TranslationController';
-export type { TOptions } from 'i18next';
-export type { SharedContent, SharedContentObjectRequest } from './controller/SharedContentController';
-export type { Exercise } from './controller/ExerciseController';
-export type { UserInfo, Language, UserRole } from './controller/SettingsController';
-export type { Message, ToolInvocation } from './controller/AIController';
-export type { TriggerAction } from './controller/ExerciseController';
-export type { MacroAccomplishmentPayload, MicroAccomplishmentPayload } from './controller/AccomplishmentController';
-export type { EventBusMessage } from './fromRimori/EventBus';

package/src/plugin/CommunicationHandler.ts

@@ -1,310 +0,0 @@
-import { createClient, SupabaseClient } from '@supabase/supabase-js';
-import { UserInfo } from '../controller/SettingsController';
-import { EventBus, EventBusMessage } from '../fromRimori/EventBus';
-import { ActivePlugin, Plugin } from '../fromRimori/PluginTypes';
-
-// Add declaration for WorkerGlobalScope
-declare const WorkerGlobalScope: any;
-
-export interface Guild {
-  allowUserPluginSettings: boolean;
-  city: string | null;
-  country: string | null;
-  description: string | null;
-  id: string;
-  isPublic: boolean;
-  name: string;
-  ownerId: string;
-  primaryLanguage: string;
-  scope: string;
-}
-
-export interface RimoriInfo {
-  url: string;
-  key: string;
-  backendUrl: string;
-  token: string;
-  expiration: Date;
-  tablePrefix: string;
-  pluginId: string;
-  guild: Guild;
-  installedPlugins: Plugin[];
-  profile: UserInfo;
-  mainPanelPlugin?: ActivePlugin;
-  sidePanelPlugin?: ActivePlugin;
-  interfaceLanguage: string;
-  /**
-   * The release channel of the plugin installation.
-   */
-  releaseChannel: 'alpha' | 'beta' | 'stable';
-  /**
-   * The database schema to use for plugin tables.
-   * Determined by rimori-main based on release channel:
-   * - 'plugins_alpha' for alpha release channel
-   * - 'plugins' for beta and stable release channels
-   */
-  dbSchema: 'plugins' | 'plugins_alpha';
-}
-
-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 = false;
-  private pendingRequests: Array<() => void> = [];
-
-  public constructor(pluginId: string, standalone: boolean) {
-    this.pluginId = pluginId;
-    this.getClient = this.getClient.bind(this);
-
-    //no need to forward messages to parent in standalone mode or worker context
-    if (standalone) return;
-
-    this.initMessageChannel(typeof WorkerGlobalScope !== 'undefined');
-  }
-
-  private initMessageChannel(worker = false): void {
-    const listener = (event: MessageEvent) => {
-      // console.log('[PluginController] window message', { origin: event.origin, data: event.data });
-      const { type, pluginId, queryParams, rimoriInfo } = event.data || {};
-      const [transferredPort] = event.ports || [];
-
-      if (type !== 'rimori:init' || !transferredPort || pluginId !== this.pluginId) {
-        // console.log('[PluginController] message ignored (not init or wrong plugin)', {
-        //   type,
-        //   pluginId,
-        //   currentPluginId: this.pluginId,
-        //   hasPortProperty: !!transferredPort,
-        //   event
-        // });
-        return;
-      }
-
-      this.queryParams = queryParams || {};
-      this.port = transferredPort;
-
-      // Initialize Supabase client immediately with provided info
-      if (rimoriInfo) {
-        this.rimoriInfo = rimoriInfo;
-        this.supabase = createClient(rimoriInfo.url, rimoriInfo.key, {
-          accessToken: () => Promise.resolve(rimoriInfo.token),
-        });
-      }
-
-      // Handle messages from parent
-      this.port.onmessage = ({ data }) => {
-        const { event, type, eventId, response, error } = data || {};
-
-        // no idea why this is needed but it works for now
-        if (type === 'response' && eventId) {
-          EventBus.emit(this.pluginId, response.topic, response.data, eventId);
-        } else if (type === 'error' && eventId) {
-          EventBus.emit(this.pluginId, 'error', { error }, eventId);
-        } else if (event) {
-          const { topic, sender, data: eventData, eventId } = event as EventBusMessage;
-          if (sender !== this.pluginId) {
-            EventBus.emit(sender, topic, eventData, eventId);
-          }
-        }
-      };
-
-      // Set theme from MessageChannel query params
-      if (!worker) {
-        // const theme = this.queryParams['rm_theme'];
-        // setTheme(theme);
-        // console.log('TODO: set theme from MessageChannel query params');
-      }
-
-      // Forward plugin events to parent (only after MessageChannel is ready)
-      EventBus.on('*', (ev) => {
-        if (ev.sender === this.pluginId && !ev.topic.startsWith('self.')) {
-          this.port?.postMessage({ event: ev });
-        }
-      });
-
-      // Mark MessageChannel as ready and process pending requests
-      this.isMessageChannelReady = true;
-
-      // Process any pending requests
-      this.pendingRequests.forEach((request) => request());
-      this.pendingRequests = [];
-    };
-    if (worker) {
-      self.onmessage = listener;
-    } else {
-      window.addEventListener('message', listener);
-    }
-    this.sendHello(worker);
-    EventBus.on('self.rimori.triggerInitFinished', () => {
-      this.sendFinishedInit(worker);
-    });
-  }
-
-  private sendHello(isWorker = false): void {
-    try {
-      const payload = { type: 'rimori:hello', pluginId: this.pluginId };
-      if (isWorker) {
-        self.postMessage(payload);
-      } else {
-        window.parent.postMessage(payload, '*');
-      }
-    } catch (e) {
-      console.error('[PluginController] Error sending hello:', e);
-    }
-  }
-
-  private sendFinishedInit(isWorker = false): void {
-    try {
-      const payload = { type: 'rimori:acknowledged', pluginId: this.pluginId };
-      if (isWorker) {
-        self.postMessage(payload);
-      } else {
-        window.parent.postMessage(payload, '*');
-      }
-    } catch (e) {
-      console.error('[PluginController] Error sending finished init:', e);
-    }
-  }
-
-  public getQueryParam(key: string): string | null {
-    return this.queryParams[key] || null;
-  }
-
-  public async getClient(): Promise<{ supabase: SupabaseClient; info: RimoriInfo }> {
-    // Return cached client if valid
-    if (this.supabase && this.rimoriInfo && this.rimoriInfo.expiration > new Date()) {
-      return { supabase: this.supabase, info: this.rimoriInfo };
-    }
-
-    // If MessageChannel is not ready yet, queue the request
-    if (!this.isMessageChannelReady) {
-      return new Promise<{ supabase: SupabaseClient; info: RimoriInfo }>((resolve) => {
-        this.pendingRequests.push(async () => {
-          const result = await this.getClient();
-          resolve(result);
-        });
-      });
-    }
-
-    // If we have rimoriInfo from MessageChannel init, use it directly
-    if (this.rimoriInfo && this.supabase) {
-      return { supabase: this.supabase, info: this.rimoriInfo };
-    }
-
-    // Fallback: request from parent
-    if (!this.rimoriInfo) {
-      if (typeof WorkerGlobalScope !== 'undefined') {
-        // In worker context, send request via self.postMessage to WorkerHandler
-        const eventId = Math.floor(Math.random() * 1000000000);
-        const requestEvent = {
-          event: {
-            timestamp: new Date().toISOString(),
-            eventId,
-            sender: this.pluginId,
-            topic: 'global.supabase.requestAccess',
-            data: {},
-            debug: false,
-          },
-        };
-
-        return new Promise<{ supabase: SupabaseClient; info: RimoriInfo }>((resolve) => {
-          // Listen for the response
-          const originalOnMessage = self.onmessage;
-          self.onmessage = (event) => {
-            if (event.data?.topic === 'global.supabase.requestAccess' && event.data?.eventId === eventId) {
-              this.rimoriInfo = event.data.data;
-              this.supabase = createClient(this.rimoriInfo!.url, this.rimoriInfo!.key, {
-                accessToken: () => Promise.resolve(this.getToken()),
-              });
-              self.onmessage = originalOnMessage; // Restore original handler
-              resolve({ supabase: this.supabase, info: this.rimoriInfo! });
-            } else if (originalOnMessage) {
-              originalOnMessage.call(self, event);
-            }
-          };
-
-          // Send the request
-          self.postMessage(requestEvent);
-        });
-      } else {
-        // In main thread context, use EventBus
-        const { data } = await EventBus.request<RimoriInfo>(this.pluginId, 'global.supabase.requestAccess');
-        // console.log({ data });
-        this.rimoriInfo = data;
-        this.supabase = createClient(this.rimoriInfo.url, this.rimoriInfo.key, {
-          accessToken: () => Promise.resolve(this.getToken()),
-        });
-      }
-    }
-
-    return { supabase: this.supabase!, info: this.rimoriInfo };
-  }
-
-  public async getToken(): Promise<string> {
-    if (this.rimoriInfo && this.rimoriInfo.expiration && this.rimoriInfo.expiration > new Date()) {
-      return this.rimoriInfo.token;
-    }
-
-    // If we don't have rimoriInfo, request it
-    if (!this.rimoriInfo) {
-      const { data } = await EventBus.request<RimoriInfo>(this.pluginId, 'global.supabase.requestAccess');
-      this.rimoriInfo = data;
-      return this.rimoriInfo.token;
-    }
-
-    // If token is expired, request fresh access
-    const { data } = await EventBus.request<{ token: string; expiration: Date }>(
-      this.pluginId,
-      'global.supabase.requestAccess',
-    );
-    this.rimoriInfo.token = data.token;
-    this.rimoriInfo.expiration = data.expiration;
-
-    return this.rimoriInfo.token;
-  }
-
-  /**
-   * Gets the Supabase URL.
-   * @returns The Supabase URL.
-   * @deprecated All endpoints should use the backend URL instead.
-   */
-  public getSupabaseUrl(): string {
-    if (!this.rimoriInfo) {
-      throw new Error('Supabase info not found');
-    }
-
-    return this.rimoriInfo.url;
-  }
-
-  public getBackendUrl(): string {
-    if (!this.rimoriInfo) {
-      throw new Error('Rimori info not found');
-    }
-    return this.rimoriInfo.backendUrl;
-  }
-
-  public getGlobalEventTopic(preliminaryTopic: string): string {
-    if (preliminaryTopic.startsWith('global.')) {
-      return preliminaryTopic;
-    }
-    if (preliminaryTopic.startsWith('self.')) {
-      return preliminaryTopic;
-    }
-    const topicParts = preliminaryTopic.split('.');
-    if (topicParts.length === 3) {
-      if (!topicParts[0].startsWith('pl') && topicParts[0] !== 'global') {
-        throw new Error("The event topic must start with the plugin id or 'global'.");
-      }
-      return preliminaryTopic;
-    } else if (topicParts.length > 3) {
-      throw new Error(
-        `The event topic must consist of 3 parts. <pluginId>.<topic area>.<action>. Received: ${preliminaryTopic}`,
-      );
-    }
-
-    const topicRoot = this.rimoriInfo?.pluginId ?? 'global';
-    return `${topicRoot}.${preliminaryTopic}`;
-  }
-}