@rimori/client 1.3.1 → 1.4.3

package/src/core/controller/SharedContentController.ts

@@ -1,12 +1,12 @@
 import { SupabaseClient } from '@supabase/supabase-js';
-import { RimoriClient } from "../../plugin/RimoriClient";
-import { ObjectRequest } from "./ObjectController";
+import { RimoriClient } from '../../plugin/RimoriClient';
+import { ObjectRequest } from './ObjectController';
 
 export interface SharedContentObjectRequest extends ObjectRequest {
-  fixedProperties?: Record<string, string | number | boolean>
+  fixedProperties?: Record<string, string | number | boolean>;
 }
 
-export type SharedContentFilter = Record<string, string | number | boolean>
+export type SharedContentFilter = Record<string, string | number | boolean>;
 
 export class SharedContentController {
   private supabase: SupabaseClient;
@@ -34,10 +34,11 @@ export class SharedContentController {
     generatorInstructions: SharedContentObjectRequest,
     //this filter is there if the content should be filtered additionally by a column and value
     filter?: SharedContentFilter,
-    options?: { privateTopic?: boolean, skipDbSave?: boolean, alwaysGenerateNew?: boolean, excludeIds?: string[] },
+    options?: { privateTopic?: boolean; skipDbSave?: boolean; alwaysGenerateNew?: boolean; excludeIds?: string[] },
   ): Promise<SharedContent<T>> {
-    let query = this.supabase.from("shared_content")
-      .select("*, scc:shared_content_completed(id, state)")
+    let query = this.supabase
+      .from('shared_content')
+      .select('*, scc:shared_content_completed(id, state)')
       .eq('content_type', contentType)
       .not('scc.state', 'in', '("completed","ongoing","hidden")')
       .is('deleted_at', null);
@@ -62,7 +63,7 @@ export class SharedContentController {
 
     // console.log('newAssignments:', newAssignments);
 
-    if (!(options?.alwaysGenerateNew) && newAssignments.length > 0) {
+    if (!options?.alwaysGenerateNew && newAssignments.length > 0) {
       const index = Math.floor(Math.random() * newAssignments.length);
       return newAssignments[index];
     }
@@ -73,13 +74,13 @@ export class SharedContentController {
 
     //create the shared content object
     const data: SharedContent<T> = {
-      id: "internal-temp-id-" + Math.random().toString(36).substring(2, 15),
+      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, title: undefined, keywords: undefined, ...generatorInstructions.fixedProperties },
       privateTopic: options?.privateTopic,
-    }
+    };
 
     if (options?.skipDbSave) {
       return data;
@@ -88,7 +89,11 @@ export class SharedContentController {
     return await this.createSharedContent(data);
   }
 
-  private async generateNewAssignment(contentType: string, generatorInstructions: SharedContentObjectRequest, filter?: SharedContentFilter): Promise<any> {
+  private async generateNewAssignment(
+    contentType: string,
+    generatorInstructions: SharedContentObjectRequest,
+    filter?: SharedContentFilter,
+  ): Promise<any> {
     const fullInstructions = await this.getGeneratorInstructions(contentType, generatorInstructions, filter);
 
     console.log('fullInstructions:', fullInstructions);
@@ -96,29 +101,34 @@ export class SharedContentController {
     return await this.rimoriClient.ai.getObject(fullInstructions);
   }
 
-  private async getGeneratorInstructions(contentType: string, generatorInstructions: ObjectRequest, filter?: SharedContentFilter): Promise<ObjectRequest> {
+  private async getGeneratorInstructions(
+    contentType: string,
+    generatorInstructions: ObjectRequest,
+    filter?: SharedContentFilter,
+  ): Promise<ObjectRequest> {
     const completedTopics = await this.getCompletedTopics(contentType, filter);
 
     generatorInstructions.instructions += `
     The following topics are already taken: ${completedTopics.join(', ')}`;
 
     generatorInstructions.tool.title = {
-      type: "string",
-      description: "What the topic is about. Short. ",
-    }
+      type: 'string',
+      description: 'What the topic is about. Short. ',
+    };
     generatorInstructions.tool.keywords = {
-      type: [{ text: { type: "string" } }],
-      description: "Keywords around the topic of the assignment.",
-    }
+      type: [{ text: { type: 'string' } }],
+      description: 'Keywords around the topic of the assignment.',
+    };
     return generatorInstructions;
   }
 
   private async getCompletedTopics(contentType: string, filter?: SharedContentFilter): Promise<string[]> {
-    const query = this.supabase.from("shared_content")
-      .select("title, keywords, scc:shared_content_completed(id)")
+    const query = this.supabase
+      .from('shared_content')
+      .select('title, keywords, scc:shared_content_completed(id)')
       .eq('content_type', contentType)
       .not('scc.id', 'is', null)
-      .is('deleted_at', null)
+      .is('deleted_at', null);
 
     if (filter) {
       query.contains('data', filter);
@@ -134,7 +144,13 @@ export class SharedContentController {
   }
 
   public async getSharedContent<T>(contentType: string, id: string): Promise<SharedContent<T>> {
-    const { data, error } = await this.supabase.from("shared_content").select().eq('content_type', contentType).eq('id', id).is('deleted_at', null).single();
+    const { data, error } = await this.supabase
+      .from('shared_content')
+      .select()
+      .eq('content_type', contentType)
+      .eq('id', id)
+      .is('deleted_at', null)
+      .single();
     if (error) {
       console.error('error fetching shared content:', error);
       throw new Error('error fetching shared content');
@@ -145,7 +161,7 @@ export class SharedContentController {
   public async completeSharedContent(contentType: string, assignmentId: string) {
     // Idempotent completion: upsert on (id, user_id) so repeated calls don't fail
     const { error } = await this.supabase
-      .from("shared_content_completed")
+      .from('shared_content_completed')
       .upsert({ content_type: contentType, id: assignmentId } as any, { onConflict: 'id' });
 
     if (error) {
@@ -172,11 +188,11 @@ export class SharedContentController {
     reaction,
     bookmarked,
   }: {
-    contentType: string
-    id: string
-    state?: 'completed' | 'ongoing' | 'hidden'
-    reaction?: 'liked' | 'disliked' | null
-    bookmarked?: boolean
+    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;
@@ -184,9 +200,7 @@ export class SharedContentController {
     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' });
+    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);
@@ -201,8 +215,17 @@ export class SharedContentController {
    * @param limit - Optional limit for the number of results.
    * @returns Array of shared content matching the criteria.
    */
-  public async getSharedContentList<T>(contentType: string, filter?: SharedContentFilter, limit?: number): Promise<SharedContent<T>[]> {
-    const query = this.supabase.from("shared_content").select("*").eq('content_type', contentType).is('deleted_at', null).limit(limit ?? 30);
+  public async getSharedContentList<T>(
+    contentType: string,
+    filter?: SharedContentFilter,
+    limit?: number,
+  ): Promise<SharedContent<T>[]> {
+    const query = this.supabase
+      .from('shared_content')
+      .select('*')
+      .eq('content_type', contentType)
+      .is('deleted_at', null)
+      .limit(limit ?? 30);
 
     if (filter) {
       query.contains('data', filter);
@@ -229,14 +252,23 @@ export class SharedContentController {
    * @returns The inserted shared content.
    * @throws {Error} if insertion fails.
    */
-  public async createSharedContent<T>({ contentType, title, keywords, data, privateTopic }: Omit<SharedContent<T>, 'id'>): Promise<SharedContent<T>> {
-    const { data: newContent, error } = await this.supabase.from("shared_content").insert({
-      private: privateTopic,
-      content_type: contentType,
-      title,
-      keywords,
-      data,
-    }).select();
+  public async createSharedContent<T>({
+    contentType,
+    title,
+    keywords,
+    data,
+    privateTopic,
+  }: Omit<SharedContent<T>, 'id'>): Promise<SharedContent<T>> {
+    const { data: newContent, error } = await this.supabase
+      .from('shared_content')
+      .insert({
+        private: privateTopic,
+        content_type: contentType,
+        title,
+        keywords,
+        data,
+      })
+      .select();
 
     if (error) {
       console.error('error inserting shared content:', error);
@@ -262,7 +294,11 @@ export class SharedContentController {
     if (updates.data) updateData.data = updates.data;
     if (updates.privateTopic !== undefined) updateData.private = updates.privateTopic;
 
-    const { data: updatedContent, error } = await this.supabase.from("shared_content").update(updateData).eq('id', id).select();
+    const { data: updatedContent, error } = await this.supabase
+      .from('shared_content')
+      .update(updateData)
+      .eq('id', id)
+      .select();
 
     if (error) {
       console.error('error updating shared content:', error);
@@ -284,7 +320,7 @@ export class SharedContentController {
    */
   public async removeSharedContent(id: string): Promise<SharedContent<any>> {
     const { data: deletedContent, error } = await this.supabase
-      .from("shared_content")
+      .from('shared_content')
       .update({ deleted_at: new Date().toISOString() })
       .eq('id', id)
       .select();
@@ -324,4 +360,4 @@ export interface SharedContent<T> {
 
   /** Whether this content should only be visible to the creator. Defaults to false if not specified */
   privateTopic?: boolean;
-}
+}

package/src/core/controller/VoiceController.ts

@@ -4,12 +4,14 @@ export async function getSTTResponse(backendUrl: string, audio: Blob, token: str
 
   return await fetch(`${backendUrl}/voice/stt`, {
     method: 'POST',
-    headers: { 'Authorization': `Bearer ${token}` },
+    headers: { Authorization: `Bearer ${token}` },
     body: formData,
-  }).then(r => r.json()).then(r => {
-    // console.log("STT response: ", r);
-    return r.text;
-  });
+  })
+    .then((r) => r.json())
+    .then((r) => {
+      // console.log("STT response: ", r);
+      return r.text;
+    });
 }
 
 export async function getTTSResponse(backendUrl: string, request: TTSRequest, token: string) {
@@ -17,10 +19,10 @@ export async function getTTSResponse(backendUrl: string, request: TTSRequest, to
     method: 'POST',
     headers: {
       'Content-Type': 'application/json',
-      'Authorization': `Bearer ${token}`
+      Authorization: `Bearer ${token}`,
     },
     body: JSON.stringify(request),
-  }).then(r => r.blob());
+  }).then((r) => r.blob());
 }
 
 interface TTSRequest {
@@ -28,4 +30,4 @@ interface TTSRequest {
   voice: string;
   speed: number;
   language?: string;
-}
+}

package/src/core/core.ts

@@ -1,16 +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";
-
+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 { Exercise, TriggerAction } from './controller/ExerciseController';
+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/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> {
@@ -40,7 +40,7 @@ export class EventBusHandler {
   private responseResolvers: Map<number, (value: EventBusMessage<unknown>) => void> = new Map();
   private static instance: EventBusHandler | null = null;
   private debugEnabled: boolean = false;
-  private evName: string = "";
+  private evName: string = '';
 
   private constructor() {
     //private constructor
@@ -50,12 +50,14 @@ 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 +82,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 +98,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 +113,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 +140,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);
@@ -154,7 +166,7 @@ export class EventBusHandler {
     });
 
     return {
-      off: () => this.off(ids)
+      off: () => this.off(ids),
     };
   }
 
@@ -165,33 +177,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 > 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()
+        off: () => listener.off(),
       };
     });
     return {
-      off: () => listeners.forEach(listener => listener.off())
+      off: () => listeners.forEach((listener) => listener.off()),
     };
   }
 
@@ -221,12 +241,12 @@ 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 });
@@ -246,7 +266,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 +279,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 +297,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 +309,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 +356,4 @@ export class EventBusHandler {
   }
 }
 
-export const EventBus = EventBusHandler.getInstance();
+export const EventBus = EventBusHandler.getInstance();