@rimori/client 2.2.0-next.3 → 2.2.0-next.5

package/.github/workflows/pre-release.yml

@@ -92,18 +92,18 @@ jobs:
         # Uses OIDC token automatically (no NODE_AUTH_TOKEN needed)
         # Requires npm 11.5.1+ and id-token: write permission (already set)
 
-      - name: Commit version bump
-        run: |
-          git config --local user.email "action@github.com"
-          git config --local user.name "GitHub Action"
-          git add package.json
-          git commit -m "chore: bump @rimori/client to ${{ steps.version.outputs.new_version }} [skip ci]"
-          git push
-
       - name: Output published version
         run: |
           echo "✅ Published @rimori/client@${{ steps.version.outputs.new_version }} to npm with @next tag"
 
+      - name: Create git tag
+        run: |
+          git config --local user.email "action@github.com"
+          git config --local user.name "GitHub Action"
+          git tag "v${{ steps.version.outputs.new_version }}" -m "Pre-release v${{ steps.version.outputs.new_version }}"
+          git push origin "v${{ steps.version.outputs.new_version }}"
+          echo "🏷️ Created and pushed tag v${{ steps.version.outputs.new_version }}"
+
       - name: Notify Slack
         if: always()
         uses: slackapi/slack-github-action@v1.24.0

package/dist/fromRimori/EventBus.js

@@ -12,18 +12,18 @@ export class EventBusHandler {
         this.listeners = new Map();
         this.responseResolvers = new Map();
         this.debugEnabled = false;
-        this.evName = "";
+        this.evName = '';
         //private constructor
     }
     static getInstance(name) {
         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.`);
             });
         }
-        if (name && EventBusHandler.instance.evName === "") {
+        if (name && EventBusHandler.instance.evName === '') {
             EventBusHandler.instance.evName = name;
         }
         return EventBusHandler.instance;
@@ -79,9 +79,7 @@ export class EventBusHandler {
             this.logAndThrowError(false, `No handlers found for topic: ` + topic);
         }
         // If it's a response to a request
-        if (eventId &&
-            this.responseResolvers.has(eventId) &&
-            !skipResponseTrigger) {
+        if (eventId && this.responseResolvers.has(eventId) && !skipResponseTrigger) {
             // console.log("[Rimori] Resolving response to request: " + eventId, event.data);
             this.responseResolvers.get(eventId)(event);
             this.responseResolvers.delete(eventId);
@@ -108,7 +106,7 @@ export class EventBusHandler {
             const blackListedEventIds = [];
             const eventHandler = (data) => {
                 if (blackListedEventIds.some((item) => item.eventId === data.eventId && item.sender === data.sender)) {
-                    console.log("BLACKLISTED EVENT ID", data.eventId, data);
+                    console.log('BLACKLISTED EVENT ID', data.eventId, data);
                     return;
                 }
                 blackListedEventIds.push({
@@ -120,9 +118,7 @@ export class EventBusHandler {
                 }
                 return handler(data);
             };
-            this.listeners
-                .get(topic)
-                .add({ id, handler: eventHandler, ignoreSender });
+            this.listeners.get(topic).add({ id, handler: eventHandler, ignoreSender });
             this.logIfDebug(`Subscribed to ` + topic, {
                 listenerId: id,
                 ignoreSender,
@@ -145,7 +141,7 @@ export class EventBusHandler {
         const listeners = topics.map((topic) => {
             const blackListedEventIds = [];
             //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 finalIgnoreSender = !topic.startsWith('self.') ? [sender] : [];
             const listener = this.on(topic, (data) => __awaiter(this, void 0, void 0, function* () {
                 if (blackListedEventIds.includes(data.eventId)) {
                     // console.log("BLACKLISTED EVENT ID", data.eventId);
@@ -155,10 +151,10 @@ export class EventBusHandler {
                 if (blackListedEventIds.length > 100) {
                     blackListedEventIds.shift();
                 }
-                const response = typeof handler === "function" ? yield handler(data) : handler;
+                const response = typeof handler === 'function' ? yield handler(data) : handler;
                 this.emit(sender, topic, response, data.eventId);
             }), finalIgnoreSender);
-            this.logIfDebug(`Added respond listener ` + sender + " to topic " + topic, { listener, sender });
+            this.logIfDebug(`Added respond listener ` + sender + ' to topic ' + topic, { listener, sender });
             return {
                 off: () => listener.off(),
             };
@@ -177,7 +173,7 @@ export class EventBusHandler {
             this.logAndThrowError(false, `Invalid topic: ` + topic);
             return;
         }
-        let listener;
+        let listener = undefined;
         const wrapper = (event) => {
             handler(event);
             listener === null || listener === void 0 ? void 0 : listener.off();
@@ -236,7 +232,7 @@ export class EventBusHandler {
         const exact = this.listeners.get(topic) || new Set();
         // 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]);
     }
@@ -247,30 +243,27 @@ export class EventBusHandler {
      */
     validateTopic(topic) {
         // 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))) {
             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;
     }
     logIfDebug(...args) {

package/dist/fromRimori/PluginTypes.d.ts

@@ -1,9 +1,9 @@
-export type Plugin<T extends {} = {}> = Omit<RimoriPluginConfig<T>, 'context_menu_actions'> & {
+export type Plugin<T extends object = object> = Omit<RimoriPluginConfig<T>, 'context_menu_actions'> & {
     version: string;
     endpoint: string;
     assetEndpoint: string;
     context_menu_actions: MenuEntry[];
-    release_channel: "alpha" | "beta" | "stable";
+    release_channel: 'alpha' | 'beta' | 'stable';
 };
 export type ActivePlugin = Plugin<{
     active?: boolean;
@@ -14,7 +14,7 @@ export interface PluginPage {
     url: string;
     show: boolean;
     description: string;
-    root: "vocabulary" | "grammar" | "reading" | "listening" | "watching" | "writing" | "speaking" | "other" | "community";
+    root: 'vocabulary' | 'grammar' | 'reading' | 'listening' | 'watching' | 'writing' | 'speaking' | 'other' | 'community';
     action?: {
         key: string;
         parameters: ObjectTool;
@@ -46,7 +46,7 @@ export interface ContextMenuAction {
  * Rimori plugin structure representing the complete configuration
  * of a Rimori plugin with all metadata and configuration options.
  */
-export interface RimoriPluginConfig<T extends {} = {}> {
+export interface RimoriPluginConfig<T extends object = object> {
     id: string;
     /**
      * Basic information about the plugin including branding and core details.
@@ -79,7 +79,7 @@ export interface RimoriPluginConfig<T extends {} = {}> {
     /**
      * Context menu actions that the plugin registers to appear in right-click menus throughout the application.
      */
-    context_menu_actions: Omit<MenuEntry, "plugin_id">[];
+    context_menu_actions: Omit<MenuEntry, 'plugin_id'>[];
     /**
      * Documentation paths for different types of plugin documentation.
      */
@@ -107,7 +107,7 @@ export interface Tool {
     parameters: {
         name: string;
         description: string;
-        type: "string" | "number" | "boolean";
+        type: 'string' | 'number' | 'boolean';
     }[];
     execute?: (args: Record<string, any>) => Promise<unknown> | unknown | void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rimori/client",
-  "version": "2.2.0-next.3",
+  "version": "2.2.0-next.5",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "repository": {

package/src/fromRimori/EventBus.ts

@@ -23,9 +23,7 @@ export interface EventBusMessage<T = EventPayload> {
   debug: boolean;
 }
 
-export type EventHandler<T = EventPayload> = (
-  event: EventBusMessage<T>
-) => void | Promise<void>;
+export type EventHandler<T = EventPayload> = (event: EventBusMessage<T>) => void | Promise<void>;
 
 interface Listeners<T = EventPayload> {
   id: number;
@@ -39,13 +37,10 @@ export interface EventListener {
 
 export class EventBusHandler {
   private listeners: Map<string, Set<Listeners<EventPayload>>> = new Map();
-  private responseResolvers: Map<
-    number,
-    (value: EventBusMessage<unknown>) => void
-  > = new Map();
+  private responseResolvers: Map<number, (value: EventBusMessage<unknown>) => void> = new Map();
   private static instance: EventBusHandler | null = null;
-  private debugEnabled: boolean = false;
-  private evName: string = "";
+  private debugEnabled = false;
+  private evName = '';
 
   private constructor() {
     //private constructor
@@ -55,27 +50,22 @@ 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.`
+          }] 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;
   }
 
-  private createEvent(
-    sender: string,
-    topic: string,
-    data: EventPayload,
-    eventId?: number
-  ): EventBusMessage {
+  private createEvent(sender: string, topic: string, data: EventPayload, eventId?: number): EventBusMessage {
     const generatedEventId = eventId || Math.floor(Math.random() * 10000000000);
 
     return {
@@ -106,12 +96,7 @@ export class EventBusHandler {
    * - pl1234.card.delete
    * - pl1234.card.triggerBackup
    */
-  public emit<T = EventPayload>(
-    sender: string,
-    topic: string,
-    data?: T,
-    eventId?: number
-  ): void {
+  public emit<T = EventPayload>(sender: string, topic: string, data?: T, eventId?: number): void {
     this.emitInternal(sender, topic, data || {}, eventId);
   }
 
@@ -120,7 +105,7 @@ export class EventBusHandler {
     topic: string,
     data: EventPayload,
     eventId?: number,
-    skipResponseTrigger = false
+    skipResponseTrigger = false,
   ): void {
     if (!this.validateTopic(topic)) {
       this.logAndThrowError(false, `Invalid topic: ` + topic);
@@ -143,11 +128,7 @@ export class EventBusHandler {
     }
 
     // If it's a response to a request
-    if (
-      eventId &&
-      this.responseResolvers.has(eventId) &&
-      !skipResponseTrigger
-    ) {
+    if (eventId && this.responseResolvers.has(eventId) && !skipResponseTrigger) {
       // console.log("[Rimori] Resolving response to request: " + eventId, event.data);
       this.responseResolvers.get(eventId)!(event);
       this.responseResolvers.delete(eventId);
@@ -164,7 +145,7 @@ export class EventBusHandler {
   public on<T = EventPayload>(
     topics: string | string[],
     handler: EventHandler<T>,
-    ignoreSender: string[] = []
+    ignoreSender: string[] = [],
   ): EventListener {
     const ids = this.toArray(topics).map((topic) => {
       this.logIfDebug(`Subscribing to ` + topic, { ignoreSender });
@@ -180,13 +161,8 @@ export class EventBusHandler {
       // To prevent infinite loops and processing the same eventId multiple times
       const blackListedEventIds: { eventId: number; sender: string }[] = [];
       const eventHandler = (data: EventBusMessage) => {
-        if (
-          blackListedEventIds.some(
-            (item) =>
-              item.eventId === data.eventId && item.sender === data.sender
-          )
-        ) {
-          console.log("BLACKLISTED EVENT ID", data.eventId, data);
+        if (blackListedEventIds.some((item) => item.eventId === data.eventId && item.sender === data.sender)) {
+          console.log('BLACKLISTED EVENT ID', data.eventId, data);
           return;
         }
         blackListedEventIds.push({
@@ -199,9 +175,7 @@ export class EventBusHandler {
         return (handler as unknown as EventHandler<EventPayload>)(data);
       };
 
-      this.listeners
-        .get(topic)!
-        .add({ id, handler: eventHandler, ignoreSender });
+      this.listeners.get(topic)!.add({ id, handler: eventHandler, ignoreSender });
 
       this.logIfDebug(`Subscribed to ` + topic, {
         listenerId: id,
@@ -226,15 +200,13 @@ export class EventBusHandler {
   public respond(
     sender: string,
     topic: string | string[],
-    handler:
-      | EventPayload
-      | ((data: EventBusMessage) => EventPayload | Promise<EventPayload>)
+    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 finalIgnoreSender = !topic.startsWith('self.') ? [sender] : [];
 
       const listener = this.on(
         topic,
@@ -247,17 +219,13 @@ export class EventBusHandler {
           if (blackListedEventIds.length > 100) {
             blackListedEventIds.shift();
           }
-          const response =
-            typeof handler === "function" ? await handler(data) : handler;
+          const response = typeof handler === 'function' ? await handler(data) : handler;
           this.emit(sender, topic, response, data.eventId);
         },
-        finalIgnoreSender
+        finalIgnoreSender,
       );
 
-      this.logIfDebug(
-        `Added respond listener ` + sender + " to topic " + topic,
-        { listener, sender }
-      );
+      this.logIfDebug(`Added respond listener ` + sender + ' to topic ' + topic, { listener, sender });
       return {
         off: () => listener.off(),
       };
@@ -278,7 +246,7 @@ export class EventBusHandler {
       return;
     }
 
-    let listener: EventListener | undefined;
+    let listener: EventListener | undefined = undefined;
     const wrapper = (event: EventBusMessage<T>) => {
       handler(event);
       listener?.off();
@@ -324,7 +292,7 @@ export class EventBusHandler {
   public async request<T = EventPayload>(
     sender: string,
     topic: string,
-    data?: EventPayload
+    data?: EventPayload,
   ): Promise<EventBusMessage<T>> {
     if (!this.validateTopic(topic)) {
       this.logAndThrowError(true, `Invalid topic: ` + topic);
@@ -335,10 +303,8 @@ 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>)
+      this.responseResolvers.set(event.eventId, (value: EventBusMessage<unknown>) =>
+        resolve(value as EventBusMessage<T>),
       );
       this.emitInternal(sender, topic, data || {}, event.eventId, true);
     });
@@ -354,9 +320,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]);
   }
@@ -368,29 +332,26 @@ 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
-      );
+      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))) {
       return true;
@@ -398,10 +359,7 @@ export class EventBusHandler {
 
     this.logAndThrowError(
       false,
-      `Invalid event topic name. The action: ` +
-        action +
-        ". Must be or start with one of: " +
-        validActions.join(", ")
+      `Invalid event topic name. The action: ` + action + '. Must be or start with one of: ' + validActions.join(', '),
     );
     return false;
   }
@@ -412,10 +370,7 @@ export class EventBusHandler {
     }
   }
 
-  private logAndThrowError(
-    throwError: boolean,
-    ...args: (string | EventPayload)[]
-  ) {
+  private logAndThrowError(throwError: boolean, ...args: (string | EventPayload)[]) {
     const message = `[${this.evName}] ` + args[0];
     console.error(message, ...args.slice(1));
     if (throwError) {

package/src/fromRimori/PluginTypes.ts

@@ -1,13 +1,13 @@
 // whole configuration of a plugin (from the database)
-export type Plugin<T extends {} = {}> = Omit<RimoriPluginConfig<T>, 'context_menu_actions'> & {
+export type Plugin<T extends object = object> = Omit<RimoriPluginConfig<T>, 'context_menu_actions'> & {
   version: string;
   endpoint: string;
   assetEndpoint: string;
   context_menu_actions: MenuEntry[];
-  release_channel: "alpha" | "beta" | "stable";
-}
+  release_channel: 'alpha' | 'beta' | 'stable';
+};
 
-export type ActivePlugin = Plugin<{ active?: boolean }>
+export type ActivePlugin = Plugin<{ active?: boolean }>;
 
 // browsable page of a plugin
 export interface PluginPage {
@@ -17,13 +17,22 @@ export interface PluginPage {
   // Whether the page should be shown in the navbar
   show: boolean;
   description: string;
-  root: "vocabulary" | "grammar" | "reading" | "listening" | "watching" | "writing" | "speaking" | "other" | "community";
+  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
@@ -65,14 +74,14 @@ export interface ContextMenuAction {
   // 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
+  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 {} = {}> {
+export interface RimoriPluginConfig<T extends object = object> {
   id: string;
   /**
    * Basic information about the plugin including branding and core details.
@@ -86,7 +95,7 @@ export interface RimoriPluginConfig<T extends {} = {}> {
     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.
    */
@@ -101,11 +110,11 @@ export interface RimoriPluginConfig<T extends {} = {}> {
     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">[];
+  context_menu_actions: Omit<MenuEntry, 'plugin_id'>[];
   /**
    * Documentation paths for different types of plugin documentation.
    */
@@ -116,7 +125,7 @@ export interface RimoriPluginConfig<T extends {} = {}> {
     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.
    */
@@ -136,7 +145,7 @@ export interface Tool {
   parameters: {
     name: string;
     description: string;
-    type: "string" | "number" | "boolean";
+    type: 'string' | 'number' | 'boolean';
   }[];
   execute?: (args: Record<string, any>) => Promise<unknown> | unknown | void;
 }
@@ -145,7 +154,7 @@ export interface Tool {
  * 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 = {
@@ -155,13 +164,13 @@ export interface Tool {
  *     description: 'Number of flashcards to practice'
  *   },
  *   deck: {
- *     type: 'string', 
+ *     type: 'string',
  *     enum: ['latest', 'random', 'oldest', 'mix', 'best_known'],
  *     description: 'Type of deck to practice'
  *   }
  * };
  * ```
- * 
+ *
  */
 export type ObjectTool = {
   [key: string]: ToolParameter;
@@ -188,15 +197,15 @@ interface ToolParameter {
  * 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)
+  | { [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.