@rimori/client 1.0.3 → 1.0.5

package/src/controller/ObjectController.ts

@@ -1,5 +1,3 @@
-import { env } from "../utils/constants";
-
 type PrimitiveType = 'string' | 'number' | 'boolean';
 
 // This is the type that can appear in the `type` property
@@ -35,8 +33,8 @@ export interface ObjectRequest {
     instructions: string;
 }
 
-export async function generateObject(request: ObjectRequest, token: string) {
-    return await fetch(`${env.SUPABASE_URL}/functions/v1/llm-object`, {
+export async function generateObject(supabaseUrl: string, request: ObjectRequest, token: string) {
+    return await fetch(`${supabaseUrl}/functions/v1/llm-object`, {
         method: 'POST',
         body: JSON.stringify({
             stream: false,
@@ -51,9 +49,9 @@ export async function generateObject(request: ObjectRequest, token: string) {
 // TODO adjust stream to work with object
 export type OnLLMResponse = (id: string, response: string, finished: boolean, toolInvocations?: any[]) => void;
 
-export async function streamObject(request: ObjectRequest, onResponse: OnLLMResponse, token: string) {
+export async function streamObject(supabaseUrl: string, request: ObjectRequest, onResponse: OnLLMResponse, token: string) {
     const messageId = Math.random().toString(36).substring(3);
-    const response = await fetch(`${env.SUPABASE_URL}/functions/v1/llm-object`, {
+    const response = await fetch(`${supabaseUrl}/functions/v1/llm-object`, {
         method: 'POST',
         body: JSON.stringify({
             stream: true,

package/src/controller/SettingsController.ts

@@ -1,16 +1,23 @@
 import { SupabaseClient } from "@supabase/supabase-js";
 import { LanguageLevel } from "../utils/difficultyConverter";
 
-type SettingsType = "user" | "system" | "plugin";
-
-export interface UserSettings {
+export interface UserInfo {
     motherTongue: string;
-    languageLevel: LanguageLevel;
-    contextMenuOnSelect: boolean;
-}
-
-export interface SystemSettings {
-    // TODO: add system settings
+    xp: number;
+    listening_level: LanguageLevel;
+    reading_level: LanguageLevel;
+    speaking_level: LanguageLevel;
+    writing_level: LanguageLevel;
+    understanding_level: LanguageLevel;
+    grammar_level: LanguageLevel;
+    longterm_goal: string;
+    motivation_type: string;
+    study_buddy: string;
+    preferred_genre: string;
+    milestone: string;
+    settings: {
+        contextMenuOnSelect: boolean;
+    }
 }
 
 export class SettingsController {
@@ -22,13 +29,8 @@ export class SettingsController {
         this.pluginId = pluginId;
     }
 
-    private getSettingsType(genericSettings?: "user" | "system"): SettingsType {
-        return genericSettings || "plugin";
-    }
-
-    private async fetchSettings(type: SettingsType): Promise<any | null> {
-        const pluginId = type === "plugin" ? this.pluginId : type;
-        const { data } = await this.supabase.from("plugin_settings").select("*").eq("plugin_id", pluginId)
+    private async fetchSettings(): Promise<any | null> {
+        const { data } = await this.supabase.from("plugin_settings").select("*").eq("plugin_id", this.pluginId)
 
         if (!data || data.length === 0) {
             return null;
@@ -37,28 +39,47 @@ export class SettingsController {
         return data[0].settings;
     }
 
-    private async saveSettings(settings: any, type: SettingsType): Promise<void> {
-        if (type !== "plugin") {
-            throw new Error(`Cannot modify ${type} settings`);
+    public async setSettings(settings: any): Promise<void> {
+        await this.supabase.from("plugin_settings").upsert({ plugin_id: this.pluginId, settings });
+    }
+
+    public async getUserInfo(): Promise<UserInfo> {
+        const { data } = await this.supabase.from("profiles").select("*");
+
+        if (!data || data.length === 0) {
+            return {
+                motherTongue: "en",
+                xp: 0,
+                listening_level: "Pre-A1",
+                reading_level: "Pre-A1",
+                speaking_level: "Pre-A1",
+                writing_level: "Pre-A1",
+                understanding_level: "Pre-A1",
+                grammar_level: "Pre-A1",
+                longterm_goal: "",
+                motivation_type: "self-motivated",
+                study_buddy: "clarence",
+                preferred_genre: "adventure",
+                milestone: "",
+                settings: {
+                    contextMenuOnSelect: false,
+                }
+            }
         }
 
-        await this.supabase.from("plugin_settings").upsert({ plugin_id: this.pluginId, settings });
+        return data[0];
     }
 
     /**
      * Get the settings for the plugin. T can be any type of settings, UserSettings or SystemSettings.
      * @param defaultSettings The default settings to use if no settings are found.
-     * @param genericSettings The type of settings to get.
      * @returns The settings for the plugin. 
      */
-    public async getSettings<T extends object>(defaultSettings: T, genericSettings?: "user" | "system"): Promise<T> {
-        const type = this.getSettingsType(genericSettings);
-        const storedSettings = await this.fetchSettings(type) as T | null;
+    public async getSettings<T extends object>(defaultSettings: T): Promise<T> {
+        const storedSettings = await this.fetchSettings() as T | null;
 
         if (!storedSettings) {
-            if (type === "plugin") {
-                await this.saveSettings(defaultSettings, type);
-            }
+            await this.setSettings(defaultSettings);
             return defaultSettings;
         }
 
@@ -72,17 +93,10 @@ export class SettingsController {
             );
             const mergedSettings = { ...defaultSettings, ...validStoredSettings } as T;
 
-            if (type === "plugin") {
-                await this.saveSettings(mergedSettings, type);
-            }
+            await this.setSettings(mergedSettings);
             return mergedSettings;
         }
 
         return storedSettings;
     }
-
-    public async setSettings(settings: any, genericSettings?: "user" | "system"): Promise<void> {
-        const type = this.getSettingsType(genericSettings);
-        await this.saveSettings(settings, type);
-    }
 }

package/src/controller/SharedContentController.ts

@@ -24,14 +24,14 @@ export class SharedContentController {
         filter?: { column: string, value: string | number | boolean },
     ): Promise<R[]> {
         const queryParameter = { filter_column: filter?.column || null, filter_value: filter?.value || null, unread: true }
-        const { data: newAssignments } = await this.rimoriClient.rpc(type + "_entries", queryParameter)
+        const { data: newAssignments } = await this.rimoriClient.db.rpc(type + "_entries", queryParameter)
         console.log('newAssignments:', newAssignments);
 
         if ((newAssignments as any[]).length > 0) {
             return newAssignments as R[];
         }
         // generate new assignments
-        const { data: oldAssignments } = await this.rimoriClient.rpc(type + "_entries", { ...queryParameter, unread: false })
+        const { data: oldAssignments } = await this.rimoriClient.db.rpc(type + "_entries", { ...queryParameter, unread: false })
         console.log('oldAssignments:', oldAssignments);
         const reservedTopics = this.getReservedTopics(oldAssignments as BasicAssignment[]);
 
@@ -39,7 +39,7 @@ export class SharedContentController {
         if (!request.tool.keywords || !request.tool.topic) {
             throw new Error("topic or keywords not found in the request schema");
         }
-        const instructions = await this.rimoriClient.generateObject(request);
+        const instructions = await this.rimoriClient.llm.getObject(request);
         console.log('instructions:', instructions);
 
         const preparedData = {
@@ -47,7 +47,7 @@ export class SharedContentController {
             ...instructions,
             keywords: this.purifyStringArray(instructions.keywords),
         };
-        return await this.rimoriClient.from(type).insert(preparedData).then(() => [preparedData] as R[]);
+        return await this.rimoriClient.db.from(type).insert(preparedData).then(() => [preparedData] as R[]);
     }
 
     private getReservedTopics(oldAssignments: BasicAssignment[]) {
@@ -62,10 +62,10 @@ export class SharedContentController {
     }
 
     public async getSharedContent<T extends BasicAssignment>(type: string, id: string): Promise<T> {
-        return await this.rimoriClient.from(type).select().eq('id', id).single() as unknown as T;
+        return await this.rimoriClient.db.from(type).select().eq('id', id).single() as unknown as T;
     }
 
     public async completeSharedContent(type: string, assignmentId: string) {
-        await this.rimoriClient.from(type + "_result").insert({ assignment_id: assignmentId });
+        await this.rimoriClient.db.from(type + "_result").insert({ assignment_id: assignmentId });
     }
 }

package/src/core.ts

@@ -0,0 +1,10 @@
+// Core functionality exports
+export * from "./controller/AIController";
+export * from "./controller/SharedContentController";
+export * from "./controller/SettingsController";
+export * from "./plugin/RimoriClient";
+export * from "./plugin/PluginController";
+export * from "./utils/difficultyConverter";
+export * from "./utils/PluginUtils";
+export * from "./worker/WorkerSetup";
+export * from "./plugin/fromRimori/EventBus";

package/src/hooks/UseChatHook.ts

@@ -5,10 +5,10 @@ import { ToolInvocation, Tool, Message } from "../controller/AIController";
 export function useChat(tools?: Tool[]) {
     const [messages, setMessages] = React.useState<Message[]>([]);
     const [isLoading, setIsLoading] = React.useState(false);
-    const { getAIResponseStream } = usePlugin();
+    const { llm } = usePlugin();
 
     const append = (appendMessages: Message[]) => {
-        getAIResponseStream([...messages, ...appendMessages], (id, message, finished: boolean, toolInvocations?: ToolInvocation[]) => {
+        llm.getSteamedText([...messages, ...appendMessages], (id, message, finished: boolean, toolInvocations?: ToolInvocation[]) => {
             const lastMessage = messages[messages.length - 1];
             setIsLoading(!finished);
 

package/src/index.ts

@@ -1,3 +1,6 @@
+// Re-export everything
+export * from './core';
+export * from './components';
 export * from "./components/MarkdownEditor";
 export * from "./components/CRUDModal";
 export * from "./components/Spinner";
@@ -8,8 +11,7 @@ export * from "./controller/SettingsController";
 export * from "./hooks/UseChatHook";
 export * from "./plugin/RimoriClient";
 export * from "./plugin/ThemeSetter";
-export * from "./providers/EventEmitter";
-export * from "./providers/EventEmitterContext";
 export * from "./providers/PluginProvider";
 export * from "./utils/difficultyConverter";
 export * from "./utils/PluginUtils";
+export * from "./plugin/PluginController";

package/src/plugin/PluginController.ts

@@ -1,6 +1,10 @@
-import { Child } from "ibridge-flex";
 import { createClient, SupabaseClient } from '@supabase/supabase-js'
 import { RimoriClient } from "./RimoriClient";
+import { EventBus, EventBusMessage } from './fromRimori/EventBus';
+import { setTheme } from './ThemeSetter';
+
+// Add declaration for WorkerGlobalScope
+declare const WorkerGlobalScope: any;
 
 interface SupabaseInfo {
     url: string,
@@ -12,55 +16,47 @@ interface SupabaseInfo {
 }
 
 export class PluginController {
-    private static instance: PluginController;
     private static client: RimoriClient;
-    private plugin: Child<null, null>;
-    private onceListeners: Map<string, any[]> = new Map();
-    private listeners: Map<string, any[]> = new Map();
+    private static instance: PluginController;
     private communicationSecret: string | null = null;
-    private initialized = false;
     private supabase: SupabaseClient | null = null;
     private supabaseInfo: SupabaseInfo | null = null;
+    private pluginId: string;
 
-    private constructor() {
-        // localStorage.debug = "*";
-        this.plugin = new Child({
-            triggerChild: ({ topic, data, _id }: any) => {
-                // console.log("trigger child with topic:" + topic + " and data: ", data);
-                this.onceListeners.get(topic)?.forEach((callback: any) => callback(_id, data));
-                this.onceListeners.set(topic, []);
-                this.listeners.get(topic)?.forEach((callback: any) => callback(_id, data));
-            }
+    private constructor(pluginId: string) {
+        this.pluginId = pluginId;
+        this.getClient = this.getClient.bind(this);
+
+        if (typeof WorkerGlobalScope === 'undefined') {
+            setTheme();
+        }
+
+        window.addEventListener("message", (event) => {
+            // console.log("client: message received", event);
+            const { topic, sender, data, eventId } = event.data.event as EventBusMessage;
+
+            // skip forwarding messages from own plugin
+            if (sender === pluginId) return;
+
+            EventBus.emit(sender, topic, data, eventId);
         });
 
-        this.emit = this.emit.bind(this);
-        this.onOnce = this.onOnce.bind(this);
-        this.getClient = this.getClient.bind(this);
-        this.subscribe = this.subscribe.bind(this);
-        this.internalEmit = this.internalEmit.bind(this);
-        this.request = this.request.bind(this);
+        EventBus.on("*", (event) => {
+            // skip messages which are not from the own plugin
+            if (event.sender !== this.pluginId) return;
+            if (event.topic.startsWith("self.")) return;
+            window.parent.postMessage({ event, secret: this.getSecret() }, "*")
+        });
     }
 
-    public static async getInstance(): Promise<RimoriClient> {
+    public static async getInstance(sender: string): Promise<RimoriClient> {
         if (!PluginController.instance) {
-            PluginController.instance = new PluginController();
-            await PluginController.instance.init();
-            PluginController.client = await RimoriClient.getInstance(
-                PluginController.instance
-            );
+            PluginController.instance = new PluginController(sender);
+            PluginController.client = await RimoriClient.getInstance(PluginController.instance);
         }
         return PluginController.client;
     }
 
-    async init() {
-        if (this.initialized) return;
-
-        // Wait for the plugin to be ready
-        await this.plugin.handshake().then(() => this.initialized = true).catch((error: any) => {
-            console.error("Failed to initialize the plugin communication:", error);
-        });
-    }
-
     private getSecret() {
         if (!this.communicationSecret) {
             const secret = new URLSearchParams(window.location.search).get("secret");
@@ -81,8 +77,8 @@ export class PluginController {
             return { supabase: this.supabase, tablePrefix: this.supabaseInfo.tablePrefix, pluginId: this.supabaseInfo.pluginId };
         }
 
-        this.supabaseInfo = await this.request<SupabaseInfo>("getSupabaseAccess");
-
+        const { data } = await EventBus.request<SupabaseInfo>(this.pluginId, "global.supabase.requestAccess");
+        this.supabaseInfo = data;
         this.supabase = createClient(this.supabaseInfo.url, this.supabaseInfo.key, {
             accessToken: () => Promise.resolve(this.getToken())
         });
@@ -95,14 +91,14 @@ export class PluginController {
             return this.supabaseInfo.token;
         }
 
-        const response = await this.request<{ token: string, expiration: Date }>("getSupabaseAccess");
+        const { data } = await EventBus.request<{ token: string, expiration: Date }>(this.pluginId, "global.supabase.requestAccess");
 
         if (!this.supabaseInfo) {
             throw new Error("Supabase info not found");
         }
 
-        this.supabaseInfo.token = response.token;
-        this.supabaseInfo.expiration = response.expiration;
+        this.supabaseInfo.token = data.token;
+        this.supabaseInfo.expiration = data.expiration;
 
         return this.supabaseInfo.token;
     }
@@ -115,44 +111,23 @@ export class PluginController {
         return this.supabaseInfo.url;
     }
 
-    public emit(eventName: string, data?: any) {
-        this.internalEmit(eventName, 0, data);
-    }
-
-    // the communication needs to have an id to be able to distinguish between different responses
-    private internalEmit(eventName: string, id: number, data?: any) {
-        this.init().then(() => this.plugin.emitToParent(eventName, { data, _id: id, secret: this.getSecret() }));
-    }
-
-    public subscribe(eventName: string, callback: (_id: number, data: any) => void) {
-        if (!this.listeners.has(eventName)) {
-            this.listeners.set(eventName, []);
+    public getGlobalEventTopic(preliminaryTopic: string) {
+        if (preliminaryTopic.startsWith("global.")) {
+            return preliminaryTopic;
         }
-
-        this.listeners.get(eventName)?.push(callback);
-    }
-
-    public onOnce(eventName: string, callback: (data: any) => void) {
-        if (!this.onceListeners.has(eventName)) {
-            this.onceListeners.set(eventName, []);
+        if (preliminaryTopic.startsWith("self.")) {
+            return preliminaryTopic;
+        }
+        const topicParts = preliminaryTopic.split(".");
+        if (topicParts.length === 3) {
+            if (![this.supabaseInfo?.pluginId, "global"].includes(topicParts[0])) {
+                throw new Error("The event topic must start with the plugin id or 'global'.");
+            }
+            return preliminaryTopic;
         }
 
-        this.onceListeners.get(eventName)?.push(callback);
+        const topicRoot = this.supabaseInfo?.pluginId ?? "global";
+        return `${topicRoot}.${preliminaryTopic}`;
     }
 
-    async request<T>(topic: string, data: any = {}): Promise<T> {
-        return await new Promise((resolve) => {
-            let triggered = false;
-            const id = Math.random();
-
-            this.internalEmit(topic, id, data);
-
-            this.subscribe(topic, (_id: number, data: any) => {
-                if (triggered || (_id !== id && _id !== 0)) return;
-                triggered = true;
-
-                resolve(data)
-            })
-        });
-    }
 }