@rimori/client 1.0.5 → 1.1.1

package/src/hooks/UseChatHook.ts

@@ -1,25 +1,25 @@
 import React from "react";
+import { Message, Tool, ToolInvocation } from "../controller/AIController";
 import { usePlugin } from "../providers/PluginProvider";
-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 { llm } = usePlugin();
+  const [messages, setMessages] = React.useState<Message[]>([]);
+  const [isLoading, setIsLoading] = React.useState(false);
+  const { llm } = usePlugin();
 
-    const append = (appendMessages: Message[]) => {
-        llm.getSteamedText([...messages, ...appendMessages], (id, message, finished: boolean, toolInvocations?: ToolInvocation[]) => {
-            const lastMessage = messages[messages.length - 1];
-            setIsLoading(!finished);
+  const append = (appendMessages: Message[]) => {
+    llm.getSteamedText([...messages, ...appendMessages], (id, message, finished: boolean, toolInvocations?: ToolInvocation[]) => {
+      const lastMessage = messages[messages.length - 1];
+      setIsLoading(!finished);
 
-            if (lastMessage?.id === id) {
-                lastMessage.content = message;
-                setMessages([...messages, lastMessage]);
-            } else {
-                setMessages([...messages, ...appendMessages, { id, role: 'assistant', content: message, toolInvocations }]);
-            }
-        }, tools);
-    };
+      if (lastMessage?.id === id) {
+        lastMessage.content = message;
+        setMessages([...messages, lastMessage]);
+      } else {
+        setMessages([...messages, ...appendMessages, { id, role: 'assistant', content: message, toolInvocations }]);
+      }
+    }, tools);
+  };
 
-    return { messages, append, isLoading, setMessages, lastMessage: messages[messages.length - 1] as Message | undefined };
+  return { messages, append, isLoading, setMessages, lastMessage: messages[messages.length - 1] as Message | undefined };
 }

package/src/index.ts

@@ -1,16 +1,8 @@
 // Re-export everything
 export * from './core';
 export * from './components';
-export * from "./components/MarkdownEditor";
-export * from "./components/CRUDModal";
-export * from "./components/Spinner";
-export * from "./components/audio/Playbutton";
-export * from "./controller/AIController";
-export * from "./controller/SharedContentController";
-export * from "./controller/SettingsController";
 export * from "./hooks/UseChatHook";
 export * from "./plugin/RimoriClient";
-export * from "./plugin/ThemeSetter";
 export * from "./providers/PluginProvider";
 export * from "./utils/difficultyConverter";
 export * from "./utils/PluginUtils";

package/src/plugin/AccomplishmentHandler.ts

@@ -0,0 +1,165 @@
+import { EventBus, EventBusMessage } from "./fromRimori/EventBus";
+
+export type AccomplishmentMessage = EventBusMessage<MicroAccomplishmentPayload>;
+
+export const skillCategories = ["reading", "listening", "speaking", "writing", "learning", "community"] as const;
+
+interface BaseAccomplishmentPayload {
+  type: "micro" | "macro";
+  skillCategory: (typeof skillCategories)[number];
+  /*
+  what is the accomplishment? e.g. chapter, flashcard, story, etc.
+  only one keyword per skill category, written in lowercase without spaces, numbers, or special characters
+  */
+  accomplishmentKeyword: string;
+  // the human readable description of the accomplishment. Important for other plugin developers to understand the accomplishment.
+  description: string;
+  meta?: {
+    //the key of the meta data in snake_case
+    key: string;
+    //the value of the meta data
+    value: string | number | boolean;
+    //the human readable description of the meta data. Important for other plugin developers to understand the meta data.
+    description: string;
+  }[];
+}
+
+export interface MicroAccomplishmentPayload extends BaseAccomplishmentPayload {
+  type: "micro";
+}
+
+export interface MacroAccomplishmentPayload extends BaseAccomplishmentPayload {
+  type: "macro";
+  errorRatio: number;
+  durationMinutes: number;
+}
+
+export type AccomplishmentPayload = MicroAccomplishmentPayload | MacroAccomplishmentPayload;
+
+export class AccomplishmentHandler {
+  private pluginId: string;
+
+  public constructor(pluginId: string) {
+    this.pluginId = pluginId;
+  }
+
+  emitAccomplishment(payload: Omit<AccomplishmentPayload, "type">) {
+    const accomplishmentPayload = { ...payload, type: "durationMinutes" in payload ? "macro" : "micro" } as AccomplishmentPayload;
+
+    this.validateAccomplishment(accomplishmentPayload);
+
+    const sanitizedPayload = this.sanitizeAccomplishment(accomplishmentPayload);
+
+    const topic = "global.accomplishment.trigger" + (accomplishmentPayload.type === "macro" ? "Macro" : "Micro");
+
+    EventBus.emit(this.pluginId, topic, sanitizedPayload);
+  }
+
+  private validateAccomplishment(payload: AccomplishmentPayload) {
+    if (!skillCategories.includes(payload.skillCategory)) {
+      throw new Error(`Invalid skill category: ${payload.skillCategory}`);
+    }
+
+    //regex validate accomplishmentKeyword
+    if (!/^[a-z_-]+$/.test(payload.accomplishmentKeyword)) {
+      throw new Error(`The accomplishment keyword: ${payload.accomplishmentKeyword} is invalid. Only lowercase letters, minuses and underscores are allowed`);
+    }
+
+    //description is required
+    if (payload.description.length < 10) {
+      throw new Error("Description is too short");
+    }
+
+    //check that the type is valid
+    if (!["micro", "macro"].includes(payload.type)) {
+      throw new Error("Invalid accomplishment type " + payload.type);
+    }
+
+    //durationMinutes is required
+    if (payload.type === "macro" && payload.durationMinutes < 4) {
+      throw new Error("The duration must be at least 4 minutes");
+    }
+
+    //errorRatio is required
+    if (payload.type === "macro" && (payload.errorRatio < 0 || payload.errorRatio > 1)) {
+      throw new Error("The error ratio must be between 0 and 1");
+    }
+
+    //regex check meta data key
+    if (payload.meta) {
+      payload.meta.forEach(meta => {
+        if (!/^[a-z_]+$/.test(meta.key)) {
+          throw new Error("Invalid meta data key " + meta.key + ", only lowercase letters and underscores are allowed");
+        }
+      });
+    }
+  }
+
+  private sanitizeAccomplishment(payload: AccomplishmentPayload) {
+    payload.description = payload.description.replace(/[^\x20-\x7E]/g, "");
+
+    payload.meta?.forEach((meta) => {
+      meta.description = meta.description.replace(/[^\x20-\x7E]/g, "");
+    });
+
+    return payload;
+  }
+
+  private getDecoupledTopic(topic: string) {
+    const [plugin, skillCategory, accomplishmentKeyword] = topic.split(".");
+
+    return { plugin: plugin || "*", skillCategory: skillCategory || "*", accomplishmentKeyword: accomplishmentKeyword || "*" };
+  }
+
+  /**
+   * Subscribe to accomplishment events
+   * @param accomplishmentTopic - The topic of the accomplishment event. The pattern can be any pattern of plugin.skillCategory.accomplishmentKeyword or an * as wildcard for any plugin, skill category or accomplishment keyword
+   * @param callback - The callback function to be called when the accomplishment event is triggered
+   */
+  subscribe(accomplishmentTopics = "*" as string | string[], callback: (payload: EventBusMessage<AccomplishmentPayload>) => void) {
+    if (typeof accomplishmentTopics === "string") {
+      accomplishmentTopics = [accomplishmentTopics];
+    }
+
+    accomplishmentTopics.forEach((accomplishmentTopic) => {
+      const topicLength = accomplishmentTopic.split(".").length
+      if (topicLength === 1) {
+        accomplishmentTopic += ".*.*"
+      } else if (topicLength === 2) {
+        accomplishmentTopic += ".*"
+      } else if (topicLength !== 3) {
+        throw new Error("Invalid accomplishment topic pattern. The pattern must be plugin.skillCategory.accomplishmentKeyword or an * as wildcard for any plugin, skill category or accomplishment keyword");
+      }
+
+      EventBus.on<AccomplishmentPayload>(["global.accomplishment.triggerMicro", "global.accomplishment.triggerMacro"], (event) => {
+        const { plugin, skillCategory, accomplishmentKeyword } = this.getDecoupledTopic(accomplishmentTopic);
+
+        if (plugin !== "*" && event.sender !== plugin) return;
+        if (skillCategory !== "*" && event.data.skillCategory !== skillCategory) return;
+        if (accomplishmentKeyword !== "*" && event.data.accomplishmentKeyword !== accomplishmentKeyword) return;
+
+        callback(event);
+      }, [this.pluginId]);
+    });
+  }
+}
+
+// const accomplishmentHandler = AccomplishmentHandler.getInstance("my-plugin");
+
+// accomplishmentHandler.subscribe("*", (payload) => {
+//   console.log(payload);
+// });
+
+// accomplishmentHandler.emitAccomplishment({
+//   skillCategory: "reading",
+//   accomplishmentKeyword: "chapter",
+//   description: "Read chapter 1 of the book",
+//   durationMinutes: 10,
+//   meta: [
+//     {
+//       key: "book",
+//       value: "The Great Gatsby",
+//       description: "The book I read",
+//     },
+//   ],
+// });

package/src/plugin/PluginController.ts

@@ -7,127 +7,129 @@ import { setTheme } from './ThemeSetter';
 declare const WorkerGlobalScope: any;
 
 interface SupabaseInfo {
-    url: string,
-    key: string,
-    token: string,
-    expiration: Date,
-    tablePrefix: string,
-    pluginId: string
+  url: string,
+  key: string,
+  token: string,
+  expiration: Date,
+  tablePrefix: string,
+  pluginId: string
 }
 
 export class PluginController {
-    private static client: RimoriClient;
-    private static instance: PluginController;
-    private communicationSecret: string | null = null;
-    private supabase: SupabaseClient | null = null;
-    private supabaseInfo: SupabaseInfo | null = null;
-    private pluginId: string;
-
-    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);
-        });
-
-        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() }, "*")
-        });
+  private static client: RimoriClient;
+  private static instance: PluginController;
+  private communicationSecret: string | null = null;
+  private supabase: SupabaseClient | null = null;
+  private supabaseInfo: SupabaseInfo | null = null;
+  private pluginId: string;
+
+  private constructor(pluginId: string) {
+    this.pluginId = pluginId;
+    this.getClient = this.getClient.bind(this);
+
+    if (typeof WorkerGlobalScope === 'undefined') {
+      setTheme();
     }
 
-    public static async getInstance(sender: string): Promise<RimoriClient> {
-        if (!PluginController.instance) {
-            PluginController.instance = new PluginController(sender);
-            PluginController.client = await RimoriClient.getInstance(PluginController.instance);
-        }
-        return PluginController.client;
-    }
+    window.addEventListener("message", (event) => {
+      // console.log("client: message received", event);
+      const { topic, sender, data, eventId } = event.data.event as EventBusMessage;
 
-    private getSecret() {
-        if (!this.communicationSecret) {
-            const secret = new URLSearchParams(window.location.search).get("secret");
-            if (!secret) {
-                throw new Error("Communication secret not found in URL as query parameter");
-            }
-            this.communicationSecret = secret;
-        }
-        return this.communicationSecret;
-    }
+      // skip forwarding messages from own plugin
+      if (sender === pluginId) return;
+
+      EventBus.emit(sender, topic, data, eventId);
+    });
 
-    public async getClient(): Promise<{ supabase: SupabaseClient, tablePrefix: string, pluginId: string }> {
-        if (
-            this.supabase &&
-            this.supabaseInfo &&
-            this.supabaseInfo.expiration > new Date()
-        ) {
-            return { supabase: this.supabase, tablePrefix: this.supabaseInfo.tablePrefix, pluginId: this.supabaseInfo.pluginId };
-        }
-
-        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())
-        });
-
-        return { supabase: this.supabase, tablePrefix: this.supabaseInfo.tablePrefix, pluginId: this.supabaseInfo.pluginId };
+    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(sender: string): Promise<RimoriClient> {
+    if (!PluginController.instance) {
+      PluginController.instance = new PluginController(sender);
+      PluginController.client = await RimoriClient.getInstance(PluginController.instance);
+    }
+    return PluginController.client;
+  }
+
+  private getSecret() {
+    if (!this.communicationSecret) {
+      const secret = new URLSearchParams(window.location.search).get("secret");
+      if (!secret) {
+        throw new Error("Communication secret not found in URL as query parameter");
+      }
+      this.communicationSecret = secret;
+    }
+    return this.communicationSecret;
+  }
+
+  public async getClient(): Promise<{ supabase: SupabaseClient, tablePrefix: string, pluginId: string }> {
+    if (
+      this.supabase &&
+      this.supabaseInfo &&
+      this.supabaseInfo.expiration > new Date()
+    ) {
+      return { supabase: this.supabase, tablePrefix: this.supabaseInfo.tablePrefix, pluginId: this.supabaseInfo.pluginId };
     }
 
-    public async getToken() {
-        if (this.supabaseInfo && this.supabaseInfo.expiration && this.supabaseInfo.expiration > new Date()) {
-            return this.supabaseInfo.token;
-        }
+    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())
+    });
 
-        const { data } = await EventBus.request<{ token: string, expiration: Date }>(this.pluginId, "global.supabase.requestAccess");
+    return { supabase: this.supabase, tablePrefix: this.supabaseInfo.tablePrefix, pluginId: this.supabaseInfo.pluginId };
+  }
 
-        if (!this.supabaseInfo) {
-            throw new Error("Supabase info not found");
-        }
+  public async getToken() {
+    if (this.supabaseInfo && this.supabaseInfo.expiration && this.supabaseInfo.expiration > new Date()) {
+      return this.supabaseInfo.token;
+    }
 
-        this.supabaseInfo.token = data.token;
-        this.supabaseInfo.expiration = data.expiration;
+    const { data } = await EventBus.request<{ token: string, expiration: Date }>(this.pluginId, "global.supabase.requestAccess");
 
-        return this.supabaseInfo.token;
+    if (!this.supabaseInfo) {
+      throw new Error("Supabase info not found");
     }
 
-    public getSupabaseUrl() {
-        if (!this.supabaseInfo) {
-            throw new Error("Supabase info not found");
-        }
+    this.supabaseInfo.token = data.token;
+    this.supabaseInfo.expiration = data.expiration;
+
+    return this.supabaseInfo.token;
+  }
 
-        return this.supabaseInfo.url;
+  public getSupabaseUrl() {
+    if (!this.supabaseInfo) {
+      throw new Error("Supabase info not found");
     }
 
-    public getGlobalEventTopic(preliminaryTopic: string) {
-        if (preliminaryTopic.startsWith("global.")) {
-            return preliminaryTopic;
-        }
-        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;
-        }
-
-        const topicRoot = this.supabaseInfo?.pluginId ?? "global";
-        return `${topicRoot}.${preliminaryTopic}`;
+    return this.supabaseInfo.url;
+  }
+
+  public getGlobalEventTopic(preliminaryTopic: 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.supabaseInfo?.pluginId ?? "global";
+    return `${topicRoot}.${preliminaryTopic}`;
+  }
 
 }