@rimori/client 2.4.0-next.6 → 2.4.0-next.7

package/src/controller/VoiceController.ts

@@ -1,33 +0,0 @@
-export async function getSTTResponse(backendUrl: string, audio: Blob, token: string): Promise<string> {
-  const formData = new FormData();
-  formData.append('file', audio);
-
-  return await fetch(`${backendUrl}/voice/stt`, {
-    method: 'POST',
-    headers: { Authorization: `Bearer ${token}` },
-    body: formData,
-  })
-    .then((r) => r.json())
-    .then((r) => {
-      // console.log("STT response: ", r);
-      return r.text;
-    });
-}
-
-export async function getTTSResponse(backendUrl: string, request: TTSRequest, token: string): Promise<Blob> {
-  return await fetch(`${backendUrl}/voice/tts`, {
-    method: 'POST',
-    headers: {
-      'Content-Type': 'application/json',
-      Authorization: `Bearer ${token}`,
-    },
-    body: JSON.stringify(request),
-  }).then((r) => r.blob());
-}
-
-interface TTSRequest {
-  input: string;
-  voice: string;
-  speed: number;
-  language?: string;
-}

package/src/fromRimori/EventBus.ts

@@ -1,382 +0,0 @@
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-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"
- *   Example: `EventBus.emit("yourPluginId", "global.system.requestDebug");`
- */
-export interface EventBusMessage<T = EventPayload> {
-  //timestamp of the event
-  timestamp: string;
-  //unique ID of the event
-  eventId: number;
-  //plugin id or "global" for global events
-  sender: string;
-  //the topic of the event consisting of the plugin id, key area and action e.g. "translator.word.triggerTranslation"
-  topic: string;
-  //any type of data to be transmitted
-  data: T;
-  //indicated if the debug mode is active
-  debug: boolean;
-}
-
-export type EventHandler<T = EventPayload> = (event: EventBusMessage<T>) => void | Promise<void>;
-
-interface Listeners<T = EventPayload> {
-  id: number;
-  handler: EventHandler<T>;
-  ignoreSender?: string[];
-}
-
-export interface EventListener {
-  off: () => void;
-}
-
-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 = false;
-  private evName = '';
-
-  private constructor() {
-    //private constructor
-  }
-
-  static getInstance(name?: string) {
-    if (!EventBusHandler.instance) {
-      EventBusHandler.instance = new EventBusHandler();
-
-      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 === '') {
-      EventBusHandler.instance.evName = name;
-    }
-    return EventBusHandler.instance;
-  }
-
-  private createEvent(sender: string, topic: string, data: EventPayload, eventId?: number): EventBusMessage {
-    const generatedEventId = eventId || Math.floor(Math.random() * 10000000000);
-
-    return {
-      eventId: generatedEventId,
-      timestamp: new Date().toISOString(),
-      sender,
-      topic,
-      data,
-      debug: this.debugEnabled,
-    };
-  }
-
-  /**
-   * Emits an event to the event bus. Can be a new event or a response to a request.
-   * @param sender - The sender of the event.
-   * @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
-   * - pl1234.card.requestAll
-   * - pl1234.card.create
-   * - pl1234.card.update
-   * - pl1234.card.delete
-   * - pl1234.card.triggerBackup
-   */
-  public emit<T = EventPayload>(sender: string, topic: string, data?: T, eventId?: number): void {
-    this.emitInternal(sender, topic, data || {}, eventId);
-  }
-
-  private emitInternal(
-    sender: string,
-    topic: string,
-    data: EventPayload,
-    eventId?: number,
-    skipResponseTrigger = false,
-  ): void {
-    if (!this.validateTopic(topic)) {
-      this.logAndThrowError(false, `Invalid topic: ` + topic);
-      return;
-    }
-
-    const event = this.createEvent(sender, topic, data, eventId);
-
-    const handlers = this.getMatchingHandlers(event.topic);
-    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;
-      }
-      handler.handler(event);
-    });
-    this.logIfDebug(`Emitting event to ` + topic, event);
-    if (handlers.size === 0) {
-      this.logAndThrowError(false, `No handlers found for topic: ` + topic);
-    }
-
-    // If it's a response to a request
-    if (eventId && this.responseResolvers.has(eventId) && !skipResponseTrigger) {
-      // console.log("[Rimori] Resolving response to request: " + eventId, event.data);
-      this.responseResolvers.get(eventId)!(event);
-      this.responseResolvers.delete(eventId);
-    }
-  }
-
-  /**
-   * Subscribes to an event on the event bus.
-   * @param topics - The topic of the event.
-   * @param handler - The handler to be called when the event is emitted.
-   * @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) => {
-      this.logIfDebug(`Subscribing to ` + topic, { ignoreSender });
-      if (!this.validateTopic(topic)) {
-        this.logAndThrowError(true, `Invalid topic: ` + topic);
-      }
-
-      if (!this.listeners.has(topic)) {
-        this.listeners.set(topic, new Set());
-      }
-      const id = Math.floor(Math.random() * 10000000000);
-
-      // 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,
-      });
-
-      return btoa(JSON.stringify({ topic, id }));
-    });
-
-    return {
-      off: () => this.off(ids),
-    };
-  }
-
-  /**
-   * Subscribes to an event, processes the data and emits a response on the event bus.
-   * @param sender - The sender of the event.
-   * @param topic - The topic of the event.
-   * @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 {
-    const topics = Array.isArray(topic) ? topic : [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 > 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(),
-      };
-    });
-    return {
-      off: () => listeners.forEach((listener) => listener.off()),
-    };
-  }
-
-  /**
-   * Subscribes to an event on the event bus. The handler will be called once and then removed.
-   * @param topic - The topic of the event.
-   * @param handler - The handler to be called when the event is emitted.
-   */
-  public once<T = EventPayload>(topic: string, handler: EventHandler<T>): void {
-    if (!this.validateTopic(topic)) {
-      this.logAndThrowError(false, `Invalid topic: ` + topic);
-      return;
-    }
-
-    let listener: EventListener | undefined = undefined;
-    const wrapper = (event: EventBusMessage<T>) => {
-      handler(event);
-      listener?.off();
-    };
-    listener = this.on(topic, wrapper);
-
-    this.logIfDebug(`Added once listener ` + topic, { listener, topic });
-  }
-
-  /**
-   * Unsubscribes from an event on the event bus.
-   * @param listenerIds - The ids of the listeners to unsubscribe from.
-   */
-  private off(listenerIds: string | string[]): void {
-    this.toArray(listenerIds).forEach((fullId) => {
-      const { topic, id } = JSON.parse(atob(fullId));
-
-      const listeners = this.listeners.get(topic) || new Set();
-
-      listeners.forEach((listener) => {
-        if (listener.id === Number(id)) {
-          listeners.delete(listener);
-          this.logIfDebug(`Removed listener ` + fullId, {
-            topic,
-            listenerId: id,
-          });
-        }
-      });
-    });
-  }
-
-  private toArray(item: string | string[]): string[] {
-    return Array.isArray(item) ? item : [item];
-  }
-
-  /**
-   * Requests data from the event bus.
-   * @param sender - The sender of the event.
-   * @param topic - The topic of the event.
-   * @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>> {
-    if (!this.validateTopic(topic)) {
-      this.logAndThrowError(true, `Invalid topic: ` + topic);
-    }
-
-    const event = this.createEvent(sender, topic, data || {});
-
-    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>),
-      );
-      this.emitInternal(sender, topic, data || {}, event.eventId, true);
-    });
-  }
-
-  /**
-   * Gets the matching handlers for an event.
-   * @param topic - The topic of the event.
-   * @returns A set of handlers that match the event type.
-   */
-  private getMatchingHandlers(topic: string): Set<Listeners<EventPayload>> {
-    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)))
-      .flatMap(([_, handlers]) => [...handlers]);
-    return new Set([...exact, ...wildcard]);
-  }
-
-  /**
-   * Validates the topic of an event.
-   * @param topic - The topic of the event.
-   * @returns True if the topic is valid, false otherwise.
-   */
-  private validateTopic(topic: string): boolean {
-    // Split event type into parts
-    const parts = topic.split('.');
-    const [plugin, area, action] = parts;
-
-    if (parts.length !== 3) {
-      if (parts.length === 1 && plugin === '*') {
-        return true;
-      }
-      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 === '*') {
-      return true;
-    }
-
-    // Validate action part
-    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(', '),
-    );
-    return false;
-  }
-
-  private logIfDebug(...args: (string | EventPayload)[]) {
-    if (this.debugEnabled) {
-      console.debug(`[${this.evName}] ` + args[0], ...args.slice(1));
-    }
-  }
-
-  private logAndThrowError(throwError: boolean, ...args: (string | EventPayload)[]) {
-    const message = `[${this.evName}] ` + args[0];
-    console.error(message, ...args.slice(1));
-    if (throwError) {
-      throw new Error(message);
-    }
-  }
-}
-
-export const EventBus = EventBusHandler.getInstance();

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 './plugin/module/ExerciseModule';
-export type { UserInfo, Language, UserRole } from './controller/SettingsController';
-export type { Message, ToolInvocation } from './controller/AIController';
-export type { TriggerAction } from './plugin/module/ExerciseModule';
-export type { MacroAccomplishmentPayload, MicroAccomplishmentPayload } from './controller/AccomplishmentController';
-export type { EventBusMessage } from './fromRimori/EventBus';