@rimori/client 1.1.10 → 1.3.0

package/src/{controller → core/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 {
@@ -22,7 +22,11 @@ export class SharedContentController {
    * @param contentType - The type of content to fetch.
    * @param generatorInstructions - The instructions for the generator. The object needs to have a tool property with a topic and keywords property to let a new unique topic be generated.
    * @param filter - An optional filter to apply to the query.
-   * @param privateTopic - An optional flag to indicate if the topic should be private and only be visible to the user.
+   * @param options - Optional options.
+   * @param options.privateTopic - If the topic should be private and only be visible to the user.
+   * @param options.skipDbSave - If true, do not persist a newly generated content to the DB (default false).
+   * @param options.alwaysGenerateNew - If true, always generate a new content even if there is already a content with the same filter.
+   * @param options.excludeIds - Optional list of shared_content ids to exclude from selection.
    * @returns The new shared content.
    */
   public async getNewSharedContent<T>(
@@ -30,56 +34,66 @@ export class SharedContentController {
     generatorInstructions: SharedContentObjectRequest,
     //this filter is there if the content should be filtered additionally by a column and value
     filter?: SharedContentFilter,
-    privateTopic?: boolean,
+    options?: { privateTopic?: boolean, skipDbSave?: boolean, alwaysGenerateNew?: boolean, excludeIds?: string[] },
   ): Promise<SharedContent<T>> {
-    const query = this.supabase.from("shared_content")
-      .select("*, scc:shared_content_completed(id)")
+    let query = this.supabase.from("shared_content")
+      .select("*, scc:shared_content_completed(id, state)")
       .eq('content_type', contentType)
-      .is('scc.id', null)
-      .is('deleted_at', null)
-      .limit(10);
+      .not('scc.state', 'in', '("completed","ongoing","hidden")')
+      .is('deleted_at', null);
+
+    if (options?.excludeIds && options.excludeIds.length > 0) {
+      const excludeIds = options.excludeIds.filter((id) => !id.startsWith('internal-temp-id-'));
+      // Supabase expects raw PostgREST syntax like '("id1","id2")'.
+      const excludeList = `(${excludeIds.map((id) => `"${id}"`).join(',')})`;
+      query = query.not('id', 'in', excludeList);
+    }
 
     if (filter) {
       query.contains('data', filter);
     }
 
-    const { data: newAssignments, error } = await query;
+    const { data: newAssignments, error } = await query.limit(30);
 
     if (error) {
       console.error('error fetching new assignments:', error);
       throw new Error('error fetching new assignments');
     }
 
-    console.log('newAssignments:', newAssignments);
+    // console.log('newAssignments:', newAssignments);
 
-    if (newAssignments.length > 0) {
+    if (!(options?.alwaysGenerateNew) && newAssignments.length > 0) {
       const index = Math.floor(Math.random() * newAssignments.length);
       return newAssignments[index];
     }
 
-    // generate new assignments
-    const fullInstructions = await this.getGeneratorInstructions(contentType, generatorInstructions, filter);
-
-    console.log('fullInstructions:', fullInstructions);
-
-    const instructions = await this.rimoriClient.llm.getObject(fullInstructions);
+    const instructions = await this.generateNewAssignment(contentType, generatorInstructions, filter);
 
     console.log('instructions:', instructions);
 
-    const { data: newAssignment, error: insertError } = await this.supabase.from("shared_content").insert({
-      private: privateTopic,
-      content_type: contentType,
-      topic: instructions.topic,
+    //create the shared content object
+    const data: SharedContent<T> = {
+      id: "internal-temp-id-" + Math.random().toString(36).substring(2, 15),
+      contentType,
+      title: instructions.title,
       keywords: instructions.keywords.map(({ text }: { text: string }) => text),
-      data: { ...instructions, topic: undefined, keywords: undefined, ...generatorInstructions.fixedProperties },
-    }).select();
+      data: { ...instructions, title: undefined, keywords: undefined, ...generatorInstructions.fixedProperties },
+      privateTopic: options?.privateTopic,
+    }
 
-    if (insertError) {
-      console.error('error inserting new assignment:', insertError);
-      throw new Error('error inserting new assignment');
+    if (options?.skipDbSave) {
+      return data;
     }
 
-    return newAssignment[0];
+    return await this.createSharedContent(data);
+  }
+
+  private async generateNewAssignment(contentType: string, generatorInstructions: SharedContentObjectRequest, filter?: SharedContentFilter): Promise<any> {
+    const fullInstructions = await this.getGeneratorInstructions(contentType, generatorInstructions, filter);
+
+    console.log('fullInstructions:', fullInstructions);
+
+    return await this.rimoriClient.ai.getObject(fullInstructions);
   }
 
   private async getGeneratorInstructions(contentType: string, generatorInstructions: ObjectRequest, filter?: SharedContentFilter): Promise<ObjectRequest> {
@@ -88,7 +102,7 @@ export class SharedContentController {
     generatorInstructions.instructions += `
     The following topics are already taken: ${completedTopics.join(', ')}`;
 
-    generatorInstructions.tool.topic = {
+    generatorInstructions.tool.title = {
       type: "string",
       description: "What the topic is about. Short. ",
     }
@@ -129,7 +143,55 @@ export class SharedContentController {
   }
 
   public async completeSharedContent(contentType: string, assignmentId: string) {
-    await this.supabase.from("shared_content_completed").insert({ content_type: contentType, id: assignmentId });
+    // Idempotent completion: upsert on (id, user_id) so repeated calls don't fail
+    const { error } = await this.supabase
+      .from("shared_content_completed")
+      .upsert({ content_type: contentType, id: assignmentId } as any, { onConflict: 'id' });
+
+    if (error) {
+      console.error('error completing shared content:', error);
+      throw new Error('error completing shared content');
+    }
+  }
+
+  /**
+   * Update state details for a shared content entry in shared_content_completed.
+   * Assumes table has columns: state ('completed'|'ongoing'|'hidden'), reaction ('liked'|'disliked'|null), bookmarked boolean.
+   * Upserts per (id, content_type, user).
+   * @param param
+   * @param param.contentType - The content type.
+   * @param param.id - The shared content id.
+   * @param param.state - The state to set.
+   * @param param.reaction - Optional reaction.
+   * @param param.bookmarked - Optional bookmark flag.
+   */
+  public async updateSharedContentState({
+    contentType,
+    id,
+    state,
+    reaction,
+    bookmarked,
+  }: {
+    contentType: string
+    id: string
+    state?: 'completed' | 'ongoing' | 'hidden'
+    reaction?: 'liked' | 'disliked' | null
+    bookmarked?: boolean
+  }): Promise<void> {
+    const payload: Record<string, unknown> = { content_type: contentType, id };
+    if (state !== undefined) payload.state = state;
+    if (reaction !== undefined) payload.reaction = reaction;
+    if (bookmarked !== undefined) payload.bookmarked = bookmarked;
+
+    // Prefer upsert, fall back to insert/update if upsert not allowed
+    const { error } = await this.supabase
+      .from('shared_content_completed')
+      .upsert(payload as any, { onConflict: 'id' });
+
+    if (error) {
+      console.error('error updating shared content state:', error);
+      throw new Error('error updating shared content state');
+    }
   }
 
   /**

package/src/core/controller/VoiceController.ts

@@ -0,0 +1,31 @@
+export async function getSTTResponse(backendUrl: string, audio: Blob, token: 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) {
+  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/core/core.ts

@@ -0,0 +1,16 @@
+// Core functionality exports
+export * from "../fromRimori/PluginTypes";
+export * from "../plugin/PluginController";
+export * from "../plugin/RimoriClient";
+export * from "../utils/difficultyConverter";
+export * from "../utils/Language";
+export * from "../utils/PluginUtils";
+export * from "../worker/WorkerSetup";
+export { EventBusMessage } from "../fromRimori/EventBus";
+export { Buddy, UserInfo } from "./controller/SettingsController";
+export { SharedContent } from "./controller/SharedContentController";
+export { Message, OnLLMResponse, ToolInvocation } from "./controller/AIController";
+export { MacroAccomplishmentPayload, MicroAccomplishmentPayload } from "../plugin/AccomplishmentHandler";
+export { Tool } from "../fromRimori/PluginTypes";
+export { SharedContentObjectRequest } from "./controller/SharedContentController";
+

package/src/{plugin/fromRimori → fromRimori}/EventBus.ts

@@ -39,7 +39,7 @@ 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 = true;
+  private debugEnabled: boolean = false;
   private evName: string = "";
 
   private constructor() {
@@ -130,7 +130,7 @@ export class EventBusHandler {
    * @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 The ids of the listeners.
+   * @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 => {
@@ -163,17 +163,35 @@ export class EventBusHandler {
    * @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 The ids of the listeners.
+   * @returns An EventListener object containing an off() method to unsubscribe the listeners.
    */
-  public respond(sender: string, topic: string, handler: EventPayload | ((data: EventBusMessage) => EventPayload | Promise<EventPayload>)): EventListener {
-    const listener = this.on(topic, async (data: EventBusMessage) => {
-      const response = typeof handler === "function" ? await handler(data) : handler;
-      this.emit(sender, topic, response, data.eventId);
-    }, [sender]);
-
-    this.logIfDebug(`Added respond listener ` + sender + " to topic " + topic, { listener, sender });
+  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 > 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 });
+      return {
+        off: () => listener.off()
+      };
+    });
     return {
-      off: () => listener.off()
+      off: () => listeners.forEach(listener => listener.off())
     };
   }
 

package/src/fromRimori/PluginTypes.ts

@@ -0,0 +1,205 @@
+// whole configuration of a plugin (from the database)
+export type Plugin<T extends {} = {}> = 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
+  icon?: React.ReactNode;
+}
+
+// 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 {} = {}> {
+  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/hooks/UseChatHook.ts

@@ -1,14 +1,17 @@
 import React from "react";
-import { Message, Tool, ToolInvocation } from "../controller/AIController";
-import { usePlugin } from "../providers/PluginProvider";
+import { Tool } from "../fromRimori/PluginTypes";
+import { useRimori } from "../providers/PluginProvider";
+import { Message, ToolInvocation } from "../core/controller/AIController";
 
 export function useChat(tools?: Tool[]) {
   const [messages, setMessages] = React.useState<Message[]>([]);
   const [isLoading, setIsLoading] = React.useState(false);
-  const { llm } = usePlugin();
+  const { ai } = useRimori();
 
   const append = (appendMessages: Message[]) => {
-    llm.getSteamedText([...messages, ...appendMessages], (id, message, finished: boolean, toolInvocations?: ToolInvocation[]) => {
+    const allMessages = [...messages, ...appendMessages];
+    setMessages(allMessages);
+    ai.getSteamedText(allMessages, (id, message, finished: boolean, toolInvocations?: ToolInvocation[]) => {
       const lastMessage = messages[messages.length - 1];
       setIsLoading(!finished);
 
@@ -16,7 +19,7 @@ export function useChat(tools?: Tool[]) {
         lastMessage.content = message;
         setMessages([...messages, lastMessage]);
       } else {
-        setMessages([...messages, ...appendMessages, { id, role: 'assistant', content: message, toolInvocations }]);
+        setMessages([...allMessages, { id, role: 'assistant', content: message, toolCalls: toolInvocations }]);
       }
     }, tools);
   };

package/src/index.ts

@@ -1,9 +1,12 @@
 // Re-export everything
-export * from './core';
 export * from './components';
 export * from "./hooks/UseChatHook";
-export * from "./plugin/RimoriClient";
+export * from "./plugin/PluginController";
 export * from "./providers/PluginProvider";
+export * from "./cli/types/DatabaseTypes";
 export * from "./utils/difficultyConverter";
 export * from "./utils/PluginUtils";
-export * from "./plugin/PluginController";
+export * from "./utils/Language";
+export * from "./fromRimori/PluginTypes";
+export { FirstMessages } from "./components/ai/utils";
+export { AudioController } from "./plugin/AudioController";

package/src/plugin/AccomplishmentHandler.ts

@@ -1,4 +1,4 @@
-import { EventBus, EventBusMessage } from "./fromRimori/EventBus";
+import { EventBus, EventBusMessage } from "../fromRimori/EventBus";
 
 export type AccomplishmentMessage = EventBusMessage<MicroAccomplishmentPayload>;
 

package/src/plugin/AudioController.ts

@@ -0,0 +1,58 @@
+import { EventBus } from "../fromRimori/EventBus";
+
+/**
+ * AudioController is a class that provides methods to record audio. It is a wrapper around the Capacitor Voice Recorder plugin. For more information, see https://github.com/tchvu3/capacitor-voice-recorder.
+ * 
+ * @example
+ * const audioController = new AudioController();
+ * await audioController.startRecording();
+ */
+export class AudioController {
+  private pluginId: string;
+
+  constructor(pluginId: string) {
+    this.pluginId = pluginId;
+  }
+
+  /**
+   * Start the recording.
+   * 
+   * @example
+   * const audioController = new AudioController();
+   * await audioController.startRecording();
+   * @returns void
+   */
+  public async startRecording(): Promise<void> {
+    EventBus.emit(this.pluginId, "global.microphone.triggerStartRecording");
+  }
+
+  /**
+   * Stop the recording and return the audio data.
+   * @returns The audio data.
+   * 
+   * @example 
+   * const audioRef = new Audio(`data:${mimeType};base64,${base64Sound}`)
+   * audioRef.oncanplaythrough = () => audioRef.play()
+   * audioRef.load()
+   */
+  public async stopRecording(): Promise<{ recording: Blob, msDuration: number, mimeType: string }> {
+    const result = await EventBus.request<{ recording: Blob, msDuration: number, mimeType: string }>(this.pluginId, "global.microphone.triggerStopRecording");
+
+    return result.data;
+  }
+
+  public async pauseRecording(): Promise<boolean> {
+    const result = await EventBus.request<boolean>(this.pluginId, "global.microphone.triggerPauseRecording");
+    return result.data;
+  }
+
+  public async resumeRecording(): Promise<boolean> {
+    const result = await EventBus.request<boolean>(this.pluginId, "global.microphone.triggerResumeRecording");
+    return result.data;
+  }
+
+  public async getCurrentStatus(): Promise<"RECORDING" | "PAUSED" | "NONE"> {
+    const result = await EventBus.request<"RECORDING" | "PAUSED" | "NONE">(this.pluginId, "global.microphone.triggerGetCurrentStatus");
+    return result.data;
+  }
+}