@rimori/client 1.0.4 → 1.1.0

package/dist/plugin/AccomplishmentHandler.js

@@ -0,0 +1,108 @@
+import { EventBus } from "./fromRimori/EventBus";
+export const skillCategories = ["reading", "listening", "speaking", "writing", "learning", "community"];
+export class AccomplishmentHandler {
+    constructor(pluginId) {
+        this.pluginId = pluginId;
+    }
+    emitAccomplishment(payload) {
+        const accomplishmentPayload = Object.assign(Object.assign({}, payload), { type: "durationMinutes" in payload ? "macro" : "micro" });
+        this.validateAccomplishment(accomplishmentPayload);
+        const sanitizedPayload = this.sanitizeAccomplishment(accomplishmentPayload);
+        const topic = "global.accomplishment.trigger" + (accomplishmentPayload.type === "macro" ? "Macro" : "Micro");
+        EventBus.emit(this.pluginId, topic, sanitizedPayload);
+    }
+    validateAccomplishment(payload) {
+        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");
+                }
+            });
+        }
+    }
+    sanitizeAccomplishment(payload) {
+        var _a;
+        payload.description = payload.description.replace(/[^\x20-\x7E]/g, "");
+        (_a = payload.meta) === null || _a === void 0 ? void 0 : _a.forEach((meta) => {
+            meta.description = meta.description.replace(/[^\x20-\x7E]/g, "");
+        });
+        return payload;
+    }
+    getDecoupledTopic(topic) {
+        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 = "*", callback) {
+        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(["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/dist/plugin/ContextMenu.d.ts

@@ -0,0 +1,17 @@
+import React from "react";
+interface Props {
+    iframeRef: React.RefObject<HTMLIFrameElement | null>;
+}
+export interface ContextMenuInfo {
+    x: number;
+    y: number;
+    text: string;
+    open: boolean;
+}
+export interface ContextMenuAction {
+    text: string;
+    pluginId: string;
+    actionKey: string;
+}
+declare const ContextMenu: ({ iframeRef }: Props) => import("react/jsx-runtime").JSX.Element | null;
+export default ContextMenu;

package/dist/plugin/ContextMenu.js

@@ -0,0 +1,45 @@
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { EventBus } from "@/lib/handler/EventBus";
+import { useState, useEffect } from "react";
+import { SupabaseClient } from "@/integrations/supabase/client";
+const ContextMenu = ({ iframeRef }) => {
+    const [showMenu, setMenuVisibility] = useState(false);
+    const [constextActions, setContextMenuActions] = useState([]);
+    const [contextMenu, setContextMenu] = useState({ x: 0, y: 0, open: false, text: "" });
+    useEffect(() => {
+        SupabaseClient.getPlugins().then(plugins => {
+            setContextMenuActions(plugins.flatMap(p => p.context_menu_actions));
+        });
+    }, []);
+    useEffect(() => {
+        // Hide the menu on click outside
+        const handleClick = () => setMenuVisibility(false);
+        document.addEventListener("click", handleClick);
+        return () => document.removeEventListener("click", handleClick);
+    }, []);
+    useEffect(() => {
+        EventBus.on("global.contextMenu.createActions", ({ data }) => {
+            console.log("addContextMenuActions", data.actions);
+            setContextMenuActions([...data.actions, ...constextActions]);
+        });
+        EventBus.on("global.contextMenu.trigger", ({ data }) => {
+            if (!iframeRef.current)
+                return;
+            const { x, y, open, text } = data;
+            const rect = iframeRef.current.getBoundingClientRect();
+            setContextMenu({ x: x + rect.left, y: y + rect.top, open, text });
+            setMenuVisibility(open);
+        });
+    }, []);
+    if (!showMenu) {
+        return null;
+    }
+    return (_jsx("div", { className: "fixed bg-gray-400 dark:bg-gray-700 shadow-lg border border-gray-400 rounded-md overflow-hidden dark:text-white", style: { top: contextMenu.y, left: contextMenu.x }, children: constextActions.map((action, index) => (_jsx(MenuEntryItem, { icon: action.icon, text: action.text, onClick: () => {
+                setMenuVisibility(false);
+                EventBus.emit("global.contextMenu", "global.sidebar.triggerAction", Object.assign(Object.assign({}, action), { text: contextMenu.text }));
+            } }, index))) }));
+};
+function MenuEntryItem(props) {
+    return _jsxs("button", { onClick: props.onClick, className: "px-4 py-2 text-left hover:bg-gray-500 dark:hover:bg-gray-600 w-full flex flex-row", children: [_jsx("span", { className: "flex-grow", children: props.icon }), _jsx("span", { className: "flex-grow", children: props.text })] });
+}
+export default ContextMenu;

package/dist/plugin/PluginController.js

@@ -11,7 +11,6 @@ import { createClient } from '@supabase/supabase-js';
 import { RimoriClient } from "./RimoriClient";
 import { EventBus } from './fromRimori/EventBus';
 import { setTheme } from './ThemeSetter';
-setTheme();
 export class PluginController {
     constructor(pluginId) {
         this.communicationSecret = null;
@@ -19,6 +18,9 @@ export class PluginController {
         this.supabaseInfo = null;
         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;
@@ -91,7 +93,7 @@ export class PluginController {
         return this.supabaseInfo.url;
     }
     getGlobalEventTopic(preliminaryTopic) {
-        var _a, _b, _c;
+        var _a, _b;
         if (preliminaryTopic.startsWith("global.")) {
             return preliminaryTopic;
         }
@@ -100,12 +102,15 @@ export class PluginController {
         }
         const topicParts = preliminaryTopic.split(".");
         if (topicParts.length === 3) {
-            if (![(_a = this.supabaseInfo) === null || _a === void 0 ? void 0 : _a.pluginId, "global"].includes(topicParts[0])) {
+            if (!topicParts[0].startsWith("pl") && topicParts[0] !== "global") {
                 throw new Error("The event topic must start with the plugin id or 'global'.");
             }
             return preliminaryTopic;
         }
-        const topicRoot = (_c = (_b = this.supabaseInfo) === null || _b === void 0 ? void 0 : _b.pluginId) !== null && _c !== void 0 ? _c : "global";
+        else if (topicParts.length > 3) {
+            throw new Error(`The event topic must consist of 3 parts. <pluginId>.<topic area>.<action>. Received: ${preliminaryTopic}`);
+        }
+        const topicRoot = (_b = (_a = this.supabaseInfo) === null || _a === void 0 ? void 0 : _a.pluginId) !== null && _b !== void 0 ? _b : "global";
         return `${topicRoot}.${preliminaryTopic}`;
     }
 }

package/dist/plugin/RimoriClient.d.ts

@@ -1,30 +1,34 @@
-import { PluginController } from "./PluginController";
+import { PostgrestQueryBuilder } from "@supabase/postgrest-js";
 import { SupabaseClient } from "@supabase/supabase-js";
-import { EventBusMessage, EventPayload } from "./fromRimori/EventBus";
 import { GenericSchema } from "@supabase/supabase-js/dist/module/lib/types";
-import { PostgrestQueryBuilder, PostgrestFilterBuilder } from "@supabase/postgrest-js";
-import { BasicAssignment } from "../controller/SharedContentController";
-import { Message, Tool, OnLLMResponse } from "../controller/AIController";
+import { Message, OnLLMResponse, Tool } from "../controller/AIController";
 import { ObjectRequest } from "../controller/ObjectController";
-import { Plugin } from "../controller/SidePluginController";
 import { UserInfo } from "../controller/SettingsController";
-import { EventHandler } from "./fromRimori/EventBus";
+import { BasicAssignment, SharedContent, SharedContentFilter, SharedContentObjectRequest } from "../controller/SharedContentController";
+import { AccomplishmentPayload } from "./AccomplishmentHandler";
+import { EventBusMessage, EventHandler, EventPayload } from "./fromRimori/EventBus";
+import { Plugin } from "./fromRimori/PluginTypes";
+import { PluginController } from "./PluginController";
 interface Db {
     from: {
         <TableName extends string & keyof GenericSchema['Tables'], Table extends GenericSchema['Tables'][TableName]>(relation: TableName): PostgrestQueryBuilder<GenericSchema, Table, TableName>;
         <ViewName extends string & keyof GenericSchema['Views'], View extends GenericSchema['Views'][ViewName]>(relation: ViewName): PostgrestQueryBuilder<GenericSchema, View, ViewName>;
     };
-    rpc: <Fn extends GenericSchema['Functions'][string], FnName extends string & keyof GenericSchema['Functions']>(functionName: FnName, args?: Fn["Args"], options?: {
-        head?: boolean;
-        get?: boolean;
-        count?: "exact" | "planned" | "estimated";
-    }) => PostgrestFilterBuilder<GenericSchema, Fn["Returns"] extends any[] ? Fn["Returns"][number] extends Record<string, unknown> ? Fn["Returns"][number] : never : never, Fn["Returns"], string, null>;
-    functions: SupabaseClient["functions"];
     storage: SupabaseClient["storage"];
+    /**
+     * The table prefix for of database tables of the plugin.
+     */
+    tablePrefix: string;
+    /**
+     * Get the table name for a given plugin table.
+     * Internally all tables are prefixed with the plugin id. This function is used to get the correct table name for a given public table.
+     * @param table The plugin table name to get the full table name for.
+     * @returns The full table name.
+     */
+    getTableName: (table: string) => string;
 }
 interface PluginInterface {
     pluginId: string;
-    tablePrefix: string;
     setSettings: (settings: any) => Promise<void>;
     /**
      * Get the settings for the plugin. T can be any type of settings, UserSettings or SystemSettings.
@@ -46,6 +50,7 @@ export declare class RimoriClient {
     private pluginController;
     private settingsController;
     private sharedContentController;
+    private accomplishmentHandler;
     private supabaseUrl;
     db: Db;
     plugin: PluginInterface;
@@ -61,7 +66,7 @@ export declare class RimoriClient {
          * @param data The data to emit.
          * @param eventId The event id.
          */
-        emit: (topic: string, data: any, eventId?: number) => void;
+        emit: (topic: string, data?: any, eventId?: number) => void;
         /**
          * Request an event.
          * @param topic The topic to request the event on.
@@ -73,8 +78,9 @@ export declare class RimoriClient {
          * Subscribe to an event.
          * @param topic The topic to subscribe to.
          * @param callback The callback to call when the event is emitted.
+         * @returns The unsubscribe ids.
          */
-        on: <T = EventPayload>(topic: string, callback: EventHandler<T>) => void;
+        on: <T = EventPayload>(topic: string | string[], callback: EventHandler<T>) => import("./fromRimori/EventBus").EventListener[];
         /**
          * Subscribe to an event once.
          * @param topic The topic to subscribe to.
@@ -87,33 +93,27 @@ export declare class RimoriClient {
          * @param data The data to respond with.
          */
         respond: <T = EventPayload>(topic: string, data: EventPayload | ((data: EventBusMessage<T>) => EventPayload | Promise<EventPayload>)) => void;
+        /**
+         * Emit an accomplishment.
+         * @param payload The payload to emit.
+         */
+        emitAccomplishment: (payload: AccomplishmentPayload) => void;
+        /**
+         * Subscribe to an accomplishment.
+         * @param accomplishmentTopic The topic to subscribe to.
+         * @param callback The callback to call when the accomplishment is emitted.
+         */
+        onAccomplishment: (accomplishmentTopic: string, callback: (payload: EventBusMessage<AccomplishmentPayload>) => void) => void;
+        /**
+         * Trigger an action that opens the sidebar and triggers an action in the designated plugin.
+         * @param pluginId The id of the plugin to trigger the action for.
+         * @param actionKey The key of the action to trigger.
+         * @param text Optional text to be used for the action like for example text that the translator would look up.
+         */
+        emitSidebarAction: (pluginId: string, actionKey: string, text?: string) => void;
     };
     static getInstance(pluginController: PluginController): Promise<RimoriClient>;
     private from;
-    /**
-    * Perform a function call.
-    *
-    * @param functionName - The function name to call
-    * @param args - The arguments to pass to the function call
-    * @param options - Named parameters
-    * @param options.head - When set to `true`, `data` will not be returned.
-    * Useful if you only need the count.
-    * @param options.get - When set to `true`, the function will be called with
-    * read-only access mode.
-    * @param options.count - Count algorithm to use to count rows returned by the
-    * function. Only applicable for [set-returning
-    * functions](https://www.postgresql.org/docs/current/functions-srf.html).
-    *
-    * `"exact"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the
-    * hood.
-    *
-    * `"planned"`: Approximated but fast count algorithm. Uses the Postgres
-    * statistics under the hood.
-    *
-    * `"estimated"`: Uses exact count for low numbers and planned count for high
-    * numbers.
-    */
-    private rpc;
     private getTableName;
     llm: {
         getText: (messages: Message[], tools?: Tool[]) => Promise<string>;
@@ -122,30 +122,57 @@ export declare class RimoriClient {
         getTextFromVoice: (file: Blob) => Promise<string>;
         getObject: (request: ObjectRequest) => Promise<any>;
     };
-    /**
-     * Fetch new shared content.
-     * @param type The type of shared content to fetch. E.g. assignments, exercises, etc.
-     * @param generatorInstructions The instructions for the generator.
-     * @param filter The filter for the shared content.
-     * @returns The new shared content.
-     */
-    fetchNewSharedContent<T, R = T & BasicAssignment>(type: string, generatorInstructions: (reservedTopics: string[]) => Promise<ObjectRequest> | ObjectRequest, filter?: {
-        column: string;
-        value: string | number | boolean;
-    }): Promise<R[]>;
-    /**
-     * Get a shared content item by id.
-     * @param type The type of shared content to get. E.g. assignments, exercises, etc.
-     * @param id The id of the shared content item.
-     * @returns The shared content item.
-     */
-    getSharedContent<T extends BasicAssignment>(type: string, id: string): Promise<T>;
-    /**
-     * Complete a shared content item.
-     * @param type The type of shared content to complete. E.g. assignments, exercises, etc.
-     * @param assignmentId The id of the shared content item to complete.
-     */
-    completeSharedContent(type: string, assignmentId: string): Promise<void>;
-    triggerSidebarAction(pluginId: string, actionKey: string, text?: string): void;
+    community: {
+        /**
+         * Shared content is a way to share completable content with other users using this plugin.
+         * Typical examples are assignments, exercises, stories, etc.
+         * Users generate new shared content items and others can complete the content too.
+         */
+        sharedContent: {
+            /**
+             * Get one dedicated shared content item by id. It does not matter if it is completed or not.
+             * @param contentType The type of shared content to get. E.g. assignments, exercises, etc.
+             * @param id The id of the shared content item.
+             * @returns The shared content item.
+             */
+            get: <T = any>(contentType: string, id: string) => Promise<BasicAssignment<T>>;
+            /**
+             * Get a list of shared content items.
+             * @param contentType The type of shared content to get. E.g. assignments, exercises, etc.
+             * @param filter The optional additional filter for checking new shared content based on a column and value. This is useful if the aditional information stored on the shared content is used to further narrow down the kind of shared content wanted to be received. E.g. only adjective grammar exercises.
+             * @param limit The optional limit for the number of results.
+             * @returns The list of shared content items.
+             */
+            getList: <T = any>(contentType: string, filter?: SharedContentFilter, limit?: number) => Promise<BasicAssignment<T>[]>;
+            /**
+             * Get new shared content.
+             * @param contentType The type of shared content to fetch. E.g. assignments, exercises, etc.
+             * @param generatorInstructions The instructions for the creation of new shared content. The object will automatically be extended with a tool property with a topic and keywords property to let a new unique topic be generated.
+             * @param filter The optional additional filter for checking new shared content based on a column and value. This is useful if the aditional information stored on the shared content is used to further narrow down the kind of shared content wanted to be received. E.g. only adjective grammar exercises.
+             * @param privateTopic An optional flag to indicate if the topic should be private and only be visible to the user. This is useful if the topic is not meant to be shared with other users. Like for personal topics or if the content is based on the personal study goal.
+             * @returns The new shared content.
+             */
+            getNew: <T = any>(contentType: string, generatorInstructions: SharedContentObjectRequest, filter?: SharedContentFilter, privateTopic?: boolean) => Promise<BasicAssignment<T>>;
+            /**
+             * Create a new shared content item.
+             * @param content The content to create.
+             * @returns The new shared content item.
+             */
+            create: <T = any>(content: SharedContent<T>) => Promise<BasicAssignment<T>>;
+            /**
+             * Update a shared content item.
+             * @param id The id of the shared content item to update.
+             * @param content The content to update.
+             * @returns The updated shared content item.
+             */
+            update: <T = any>(id: string, content: Partial<SharedContent<T>>) => Promise<BasicAssignment<T>>;
+            /**
+              * Complete a shared content item.
+              * @param contentType The type of shared content to complete. E.g. assignments, exercises, etc.
+              * @param assignmentId The id of the shared content item to complete.
+              */
+            complete: (contentType: string, assignmentId: string) => Promise<void>;
+        };
+    };
 }
 export {};