@rimori/client 2.4.0-next.4 → 2.4.0-next.5

package/src/plugin/module/EventModule.ts

@@ -0,0 +1,192 @@
+import { EventBus, EventBusMessage, EventHandler, EventPayload, EventListener } from '../../fromRimori/EventBus';
+import { MainPanelAction } from '../../fromRimori/PluginTypes';
+import { AccomplishmentController, AccomplishmentPayload } from '../../controller/AccomplishmentController';
+
+/**
+ * Event module for plugin event bus operations.
+ * Provides methods for emitting, listening to, and responding to events.
+ */
+export class EventModule {
+  private pluginId: string;
+  private accomplishmentController: AccomplishmentController;
+
+  constructor(pluginId: string) {
+    this.pluginId = pluginId;
+    this.accomplishmentController = new AccomplishmentController(pluginId);
+  }
+
+  public getGlobalEventTopic(preliminaryTopic: string): 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.pluginId ?? 'global';
+    return `${topicRoot}.${preliminaryTopic}`;
+  }
+
+  /**
+   * Emit an event to Rimori or a plugin.
+   * The topic schema is:
+   * {pluginId}.{eventId}
+   * Check out the event bus documentation for more information.
+   * For triggering events from Rimori like context menu actions use the "global" keyword.
+   * @param topic The topic to emit the event on.
+   * @param data The data to emit.
+   * @param eventId The event id.
+   */
+  emit(topic: string, data?: any, eventId?: number): void {
+    const globalTopic = this.getGlobalEventTopic(topic);
+    EventBus.emit(this.pluginId, globalTopic, data, eventId);
+  }
+
+  /**
+   * Request an event.
+   * @param topic The topic to request the event on.
+   * @param data The data to request.
+   * @returns The response from the event.
+   */
+  request<T>(topic: string, data?: any): Promise<EventBusMessage<T>> {
+    const globalTopic = this.getGlobalEventTopic(topic);
+    return EventBus.request<T>(this.pluginId, globalTopic, data);
+  }
+
+  /**
+   * Subscribe to an event.
+   * @param topic The topic to subscribe to.
+   * @param callback The callback to call when the event is emitted.
+   * @returns An EventListener object containing an off() method to unsubscribe the listeners.
+   */
+  on<T = EventPayload>(topic: string | string[], callback: EventHandler<T>): EventListener {
+    const topics = Array.isArray(topic) ? topic : [topic];
+    return EventBus.on<T>(
+      topics.map((t) => this.getGlobalEventTopic(t)),
+      callback,
+    );
+  }
+
+  /**
+   * Subscribe to an event once.
+   * @param topic The topic to subscribe to.
+   * @param callback The callback to call when the event is emitted.
+   */
+  once<T = EventPayload>(topic: string, callback: EventHandler<T>): void {
+    EventBus.once<T>(this.getGlobalEventTopic(topic), callback);
+  }
+
+  /**
+   * Respond to an event.
+   * @param topic The topic to respond to.
+   * @param data The data to respond with.
+   */
+  respond<T = EventPayload>(
+    topic: string | string[],
+    data: EventPayload | ((data: EventBusMessage<T>) => EventPayload | Promise<EventPayload>),
+  ): void {
+    const topics = Array.isArray(topic) ? topic : [topic];
+    EventBus.respond(
+      this.pluginId,
+      topics.map((t) => this.getGlobalEventTopic(t)),
+      data,
+    );
+  }
+
+  /**
+   * Emit an accomplishment.
+   * @param payload The payload to emit.
+   */
+  emitAccomplishment(payload: AccomplishmentPayload): void {
+    this.accomplishmentController.emitAccomplishment(payload);
+  }
+
+  /**
+   * 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 {
+    this.accomplishmentController.subscribe(accomplishmentTopic, callback);
+  }
+
+  /**
+   * 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 {
+    this.emit('global.sidebar.triggerAction', { plugin_id: pluginId, action_key: actionKey, text });
+  }
+
+  /**
+   * Subscribe to main panel actions triggered by the user from the dashboard.
+   * @param callback Handler function that receives the action data when a matching action is triggered.
+   * @param actionsToListen Optional filter to listen only to specific action keys. If empty or not provided, all actions will trigger the callback.
+   * @returns An EventListener object with an `off()` method for cleanup.
+   *
+   * @example
+   * ```ts
+   * const listener = client.event.onMainPanelAction((data) => {
+   *   console.log('Action received:', data.action_key);
+   * }, ['startSession', 'pauseSession']);
+   *
+   * // Clean up when component unmounts to prevent events from firing
+   * // when navigating away or returning to the page
+   * useEffect(() => {
+   *   return () => listener.off();
+   * }, []);
+   * ```
+   *
+   * **Important:** Always call `listener.off()` when your component unmounts or when you no longer need to listen.
+   * This prevents the event handler from firing when navigating away from or returning to the page, which could
+   * cause unexpected behavior or duplicate event handling.
+   */
+  onMainPanelAction(callback: (data: MainPanelAction) => void, actionsToListen: string | string[] = []): EventListener {
+    const listeningActions = Array.isArray(actionsToListen) ? actionsToListen : [actionsToListen];
+    // this needs to be a emit and on because the main panel action is triggered by the user and not by the plugin
+    this.emit('action.requestMain');
+    return this.on<MainPanelAction>('action.requestMain', ({ data }) => {
+      // console.log('Received action for main panel ' + data.action_key);
+      // console.log('Listening to actions', listeningActions);
+      if (listeningActions.length === 0 || listeningActions.includes(data.action_key)) {
+        callback(data);
+      }
+    });
+  }
+
+  /**
+   * Subscribe to side panel actions triggered by the user from the dashboard.
+   * @param callback Handler function that receives the action data when a matching action is triggered.
+   * @param actionsToListen Optional filter to listen only to specific action keys. If empty or not provided, all actions will trigger the callback.
+   * @returns An EventListener object with an `off()` method for cleanup.
+   */
+  onSidePanelAction(callback: (data: MainPanelAction) => void, actionsToListen: string | string[] = []): EventListener {
+    const listeningActions = Array.isArray(actionsToListen) ? actionsToListen : [actionsToListen];
+    // this needs to be a emit and on because the main panel action is triggered by the user and not by the plugin
+    this.emit('action.requestSidebar');
+    return this.on<MainPanelAction>('action.requestSidebar', ({ data }) => {
+      // console.log("eventHandler .onSidePanelAction", data);
+      // console.log('Received action for sidebar ' + data.action);
+      // console.log('Listening to actions', listeningActions);
+      if (listeningActions.length === 0 || listeningActions.includes(data.action)) {
+        callback(data);
+      }
+    });
+  }
+}

package/src/{controller/ExerciseController.ts → plugin/module/ExerciseModule.ts}

@@ -1,5 +1,6 @@
 import { SupabaseClient } from '@supabase/supabase-js';
-import { RimoriClient } from '../plugin/RimoriClient';
+import { RimoriCommunicationHandler, RimoriInfo } from '../CommunicationHandler';
+import { EventModule } from './EventModule';
 
 export type TriggerAction = { action_key: string } & Record<string, string | number | boolean>;
 
@@ -20,7 +21,6 @@ export interface Exercise {
   start_date: string;
   end_date: string;
   trigger_action: TriggerAction;
-  // topic that identifies the accomplishment that the exercise is related to
   achievement_topic: string;
   name: string;
   description: string;
@@ -29,13 +29,32 @@ export interface Exercise {
   updated_at?: string;
 }
 
-export class ExerciseController {
+/**
+ * Controller for exercise-related operations.
+ * Provides access to weekly exercises and exercise management.
+ */
+export class ExerciseModule {
   private supabase: SupabaseClient;
-  private rimoriClient: RimoriClient;
-
-  constructor(supabase: SupabaseClient, rimoriClient: RimoriClient) {
+  private communicationHandler: RimoriCommunicationHandler;
+  private eventModule: EventModule;
+  private backendUrl: string;
+  private token: string;
+
+  constructor(
+    supabase: SupabaseClient,
+    communicationHandler: RimoriCommunicationHandler,
+    info: RimoriInfo,
+    eventModule: EventModule,
+  ) {
     this.supabase = supabase;
-    this.rimoriClient = rimoriClient;
+    this.communicationHandler = communicationHandler;
+    this.eventModule = eventModule;
+    this.token = info.token;
+    this.backendUrl = info.backendUrl;
+
+    this.communicationHandler.onUpdate((updatedInfo) => {
+      this.token = updatedInfo.token;
+    });
   }
 
   /**
@@ -43,7 +62,7 @@ export class ExerciseController {
    * Shows exercises for the current week that haven't expired.
    * @returns Array of exercise objects.
    */
-  public async viewWeeklyExercises(): Promise<Exercise[]> {
+  async view(): Promise<Exercise[]> {
     const { data, error } = await this.supabase.from('weekly_exercises').select('*');
 
     if (error) {
@@ -54,21 +73,21 @@ export class ExerciseController {
   }
 
   /**
-   * Creates multiple exercises via the backend API.
-   * All requests are made in parallel but only one event is emitted.
-   * @param token The token to use for authentication.
-   * @param backendUrl The URL of the backend API.
-   * @param exercises Exercise creation parameters.
+   * Creates a new exercise or multiple exercises via the backend API.
+   * When creating multiple exercises, all requests are made in parallel but only one event is emitted.
+   * @param params Exercise creation parameters (single or array).
    * @returns Created exercise objects.
    */
-  public async addExercise(token: string, backendUrl: string, exercises: CreateExerciseParams[]): Promise<Exercise[]> {
+  async add(params: CreateExerciseParams | CreateExerciseParams[]): Promise<Exercise[]> {
+    const exercises = Array.isArray(params) ? params : [params];
+
     const responses = await Promise.all(
       exercises.map(async (exercise) => {
-        const response = await fetch(`${backendUrl}/exercises`, {
+        const response = await fetch(`${this.backendUrl}/exercises`, {
           method: 'POST',
           headers: {
             'Content-Type': 'application/json',
-            Authorization: `Bearer ${token}`,
+            Authorization: `Bearer ${this.token}`,
           },
           body: JSON.stringify(exercise),
         });
@@ -82,27 +101,21 @@ export class ExerciseController {
       }),
     );
 
-    this.rimoriClient.event.emit('global.exercises.triggerChange');
+    this.eventModule.emit('global.exercises.triggerChange');
 
     return responses;
   }
 
   /**
    * Deletes an exercise via the backend API.
-   * @param token The token to use for authentication.
-   * @param backendUrl The URL of the backend API.
-   * @param exerciseId The exercise ID to delete.
+   * @param id The exercise ID to delete.
    * @returns Success status.
    */
-  public async deleteExercise(
-    token: string,
-    backendUrl: string,
-    id: string,
-  ): Promise<{ success: boolean; message: string }> {
-    const response = await fetch(`${backendUrl}/exercises/${id}`, {
+  async delete(id: string): Promise<{ success: boolean; message: string }> {
+    const response = await fetch(`${this.backendUrl}/exercises/${id}`, {
       method: 'DELETE',
       headers: {
-        Authorization: `Bearer ${token}`,
+        Authorization: `Bearer ${this.token}`,
       },
     });
 
@@ -110,7 +123,8 @@ export class ExerciseController {
       const errorText = await response.text();
       throw new Error(`Failed to delete exercise: ${errorText}`);
     }
-    this.rimoriClient.event.emit('global.exercises.triggerChange');
+
+    this.eventModule.emit('global.exercises.triggerChange');
 
     return await response.json();
   }

package/src/plugin/module/PluginModule.ts

@@ -0,0 +1,114 @@
+import { SettingsController, UserInfo } from '../../controller/SettingsController';
+import { RimoriCommunicationHandler, RimoriInfo } from '../CommunicationHandler';
+import { Translator } from '../../controller/TranslationController';
+import { ActivePlugin, Plugin } from '../../fromRimori/PluginTypes';
+import { SupabaseClient } from '@supabase/supabase-js';
+
+type Theme = 'light' | 'dark';
+type ApplicationMode = 'main' | 'sidebar' | 'settings';
+/**
+ * Controller for plugin-related operations.
+ * Provides access to plugin settings, user info, and plugin information.
+ */
+export class PluginModule {
+  private settingsController: SettingsController;
+  private communicationHandler: RimoriCommunicationHandler;
+  private translator: Translator;
+  private rimoriInfo: RimoriInfo;
+  public pluginId: string;
+  /**
+   * The release channel of this plugin installation.
+   * Determines which database schema is used for plugin tables.
+   */
+  public releaseChannel: string;
+  public applicationMode: ApplicationMode;
+  public theme: Theme;
+
+  constructor(supabase: SupabaseClient, communicationHandler: RimoriCommunicationHandler, info: RimoriInfo) {
+    this.rimoriInfo = info;
+    this.communicationHandler = communicationHandler;
+    this.pluginId = info.pluginId;
+    this.releaseChannel = info.releaseChannel;
+
+    this.settingsController = new SettingsController(supabase, info.pluginId, info.guild);
+
+    const currentPlugin = info.installedPlugins.find((plugin) => plugin.id === info.pluginId);
+    this.translator = new Translator(info.interfaceLanguage, currentPlugin?.endpoint || '');
+
+    this.communicationHandler.onUpdate((updatedInfo) => (this.rimoriInfo = updatedInfo));
+    this.applicationMode = this.communicationHandler.getQueryParam('applicationMode') as ApplicationMode;
+    this.theme = (this.communicationHandler.getQueryParam('rm_theme') as Theme) || 'light';
+  }
+
+  /**
+   * Set the settings for the plugin.
+   * @param settings The settings to set.
+   */
+  async setSettings(settings: any): Promise<void> {
+    await this.settingsController.setSettings(settings);
+  }
+
+  /**
+   * 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.
+   * @returns The settings for the plugin.
+   */
+  async getSettings<T extends object>(defaultSettings: T): Promise<T> {
+    return await this.settingsController.getSettings<T>(defaultSettings);
+  }
+
+  /**
+   * Get the current user info.
+   * Note: For reactive updates in React components, use the userInfo from useRimori() hook instead.
+   * @returns The user info.
+   */
+  getUserInfo(): UserInfo {
+    return this.rimoriInfo.profile;
+  }
+
+  /**
+   * Register a callback to be notified when RimoriInfo is updated.
+   * This is useful for reacting to changes in user info, tokens, or other rimori data.
+   * @param callback - Function to call with the new RimoriInfo
+   * @returns Cleanup function to unregister the callback
+   */
+  onRimoriInfoUpdate(callback: (info: RimoriInfo) => void): () => void {
+    return this.communicationHandler.onUpdate(callback);
+  }
+
+  /**
+   * Retrieves information about plugins, including:
+   * - All installed plugins
+   * - The currently active plugin in the main panel
+   * - The currently active plugin in the side panel
+   */
+  getPluginInfo(): {
+    /**
+     * All installed plugins.
+     */
+    installedPlugins: Plugin[];
+    /**
+     * The plugin that is loaded in the main panel.
+     */
+    mainPanelPlugin?: ActivePlugin;
+    /**
+     * The plugin that is loaded in the side panel.
+     */
+    sidePanelPlugin?: ActivePlugin;
+  } {
+    return {
+      installedPlugins: this.rimoriInfo.installedPlugins,
+      mainPanelPlugin: this.rimoriInfo.mainPanelPlugin,
+      sidePanelPlugin: this.rimoriInfo.sidePanelPlugin,
+    };
+  }
+
+  /**
+   * Get the translator for the plugin.
+   * @returns The translator for the plugin.
+   */
+  async getTranslator(): Promise<Translator> {
+    await this.translator.initialize();
+    return this.translator;
+  }
+}