@rimori/client 2.4.0 → 2.5.0-next.1

package/dist/cli/scripts/init/dev-registration.js

@@ -7,7 +7,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { createClient } from '@supabase/supabase-js';
+// import { createClient } from '@supabase/supabase-js';
 import path from 'path';
 import * as readline from 'readline';
 import { DEFAULT_ANON_KEY, DEFAULT_ENDPOINT } from '../../../utils/endpoint.js';
@@ -112,7 +112,9 @@ export function authenticateWithSupabase(_a) {
         // Initialize Supabase client (you may need to adjust the URL and key)
         const supabaseUrl = process.env.SUPABASE_URL || DEFAULT_ENDPOINT;
         const supabaseKey = process.env.SUPABASE_ANON_KEY || DEFAULT_ANON_KEY;
-        const supabase = createClient(supabaseUrl, supabaseKey);
+        throw new Error('Authentication is disabled until new developer platform is released.');
+        // const supabase = createClient(supabaseUrl, supabaseKey);
+        const supabase = {};
         try {
             const { data, error } = yield supabase.auth.signInWithPassword({
                 email,

package/dist/cli/scripts/init/main.js

@@ -82,6 +82,7 @@ function main() {
                 updateGitignore();
             }
             else {
+                throw new Error('Registration is disabled until new developer platform is released.');
                 // Step 1: Get user credentials
                 const credentials = yield askForCredentials();
                 console.log('');

package/dist/controller/SettingsController.d.ts

@@ -1,4 +1,4 @@
-import { SupabaseClient } from '@supabase/supabase-js';
+import { SupabaseClient } from '../plugin/CommunicationHandler';
 import { LanguageLevel } from '../utils/difficultyConverter';
 import { Guild } from '../plugin/CommunicationHandler';
 export interface Buddy {

package/dist/controller/SharedContentController.d.ts

@@ -1,4 +1,4 @@
-import { SupabaseClient } from '@supabase/supabase-js';
+import { SupabaseClient } from '../plugin/CommunicationHandler';
 import { RimoriClient } from '../plugin/RimoriClient';
 import { ObjectRequest } from './ObjectController';
 export interface SharedContentObjectRequest extends ObjectRequest {

package/dist/fromRimori/EventBus.js

@@ -106,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({

package/dist/index.d.ts

@@ -10,9 +10,9 @@ export { AudioController } from './controller/AudioController';
 export { Translator } from './controller/TranslationController';
 export type { TOptions } from 'i18next';
 export type { SharedContent, SharedContentObjectRequest } from './controller/SharedContentController';
-export type { Exercise } from './controller/ExerciseController';
+export type { Exercise } from './plugin/module/ExerciseModule';
 export type { UserInfo, Language, UserRole } from './controller/SettingsController';
 export type { Message, ToolInvocation } from './controller/AIController';
-export type { TriggerAction } from './controller/ExerciseController';
+export type { TriggerAction } from './plugin/module/ExerciseModule';
 export type { MacroAccomplishmentPayload, MicroAccomplishmentPayload } from './controller/AccomplishmentController';
 export type { EventBusMessage } from './fromRimori/EventBus';

package/dist/plugin/CommunicationHandler.d.ts

@@ -1,6 +1,7 @@
-import { SupabaseClient } from '@supabase/supabase-js';
 import { UserInfo } from '../controller/SettingsController';
 import { ActivePlugin, Plugin } from '../fromRimori/PluginTypes';
+import { PostgrestClient } from '@supabase/postgrest-js';
+export type SupabaseClient = PostgrestClient;
 export interface Guild {
     allowUserPluginSettings: boolean;
     city: string | null;
@@ -47,22 +48,26 @@ export declare class RimoriCommunicationHandler {
     private pluginId;
     private isMessageChannelReady;
     private pendingRequests;
+    private updateCallbacks;
     constructor(pluginId: string, standalone: boolean);
     private initMessageChannel;
     private sendHello;
     private sendFinishedInit;
     getQueryParam(key: string): string | null;
+    private getSupabase;
     getClient(): Promise<{
         supabase: SupabaseClient;
         info: RimoriInfo;
     }>;
-    getToken(): Promise<string>;
     /**
-     * Gets the Supabase URL.
-     * @returns The Supabase URL.
-     * @deprecated All endpoints should use the backend URL instead.
+     * Handles updates to RimoriInfo from rimori-main.
+     * Updates the cached info and Supabase client, then notifies all registered callbacks.
      */
-    getSupabaseUrl(): string;
-    getBackendUrl(): string;
-    getGlobalEventTopic(preliminaryTopic: string): string;
+    private handleRimoriInfoUpdate;
+    /**
+     * Registers a callback to be called when RimoriInfo is updated.
+     * @param callback - Function to call with the new RimoriInfo
+     * @returns Cleanup function to unregister the callback
+     */
+    onUpdate(callback: (info: RimoriInfo) => void): () => void;
 }

package/dist/plugin/CommunicationHandler.js

@@ -7,8 +7,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { createClient } from '@supabase/supabase-js';
 import { EventBus } from '../fromRimori/EventBus';
+import { PostgrestClient } from '@supabase/postgrest-js';
 export class RimoriCommunicationHandler {
     constructor(pluginId, standalone) {
         this.port = null;
@@ -17,6 +17,7 @@ export class RimoriCommunicationHandler {
         this.rimoriInfo = null;
         this.isMessageChannelReady = false;
         this.pendingRequests = [];
+        this.updateCallbacks = new Set();
         this.pluginId = pluginId;
         this.getClient = this.getClient.bind(this);
         //no need to forward messages to parent in standalone mode or worker context
@@ -44,9 +45,7 @@ export class RimoriCommunicationHandler {
             // Initialize Supabase client immediately with provided info
             if (rimoriInfo) {
                 this.rimoriInfo = rimoriInfo;
-                this.supabase = createClient(rimoriInfo.url, rimoriInfo.key, {
-                    accessToken: () => Promise.resolve(rimoriInfo.token),
-                });
+                this.supabase = this.getSupabase(rimoriInfo.url, rimoriInfo.key, rimoriInfo.token);
             }
             // Handle messages from parent
             this.port.onmessage = ({ data }) => {
@@ -78,6 +77,12 @@ export class RimoriCommunicationHandler {
                     (_a = this.port) === null || _a === void 0 ? void 0 : _a.postMessage({ event: ev });
                 }
             });
+            // Listen for updates from rimori-main (data changes, token refresh, etc.)
+            // Topic format: {pluginId}.supabase.triggerUpdate
+            EventBus.on(`${this.pluginId}.supabase.triggerUpdate`, (ev) => {
+                console.log('[RimoriCommunicationHandler] Received update from rimori-main');
+                this.handleRimoriInfoUpdate(ev.data);
+            });
             // Mark MessageChannel as ready and process pending requests
             this.isMessageChannelReady = true;
             // Process any pending requests
@@ -126,6 +131,16 @@ export class RimoriCommunicationHandler {
     getQueryParam(key) {
         return this.queryParams[key] || null;
     }
+    getSupabase(url, key, token) {
+        var _a;
+        return new PostgrestClient(`${url}/rest/v1`, {
+            schema: (_a = this.rimoriInfo) === null || _a === void 0 ? void 0 : _a.dbSchema,
+            headers: {
+                apikey: key,
+                Authorization: `Bearer ${token}`,
+            },
+        });
+    }
     getClient() {
         return __awaiter(this, void 0, void 0, function* () {
             // Return cached client if valid
@@ -167,9 +182,7 @@ export class RimoriCommunicationHandler {
                             var _a, _b;
                             if (((_a = event.data) === null || _a === void 0 ? void 0 : _a.topic) === 'global.supabase.requestAccess' && ((_b = event.data) === null || _b === void 0 ? void 0 : _b.eventId) === eventId) {
                                 this.rimoriInfo = event.data.data;
-                                this.supabase = createClient(this.rimoriInfo.url, this.rimoriInfo.key, {
-                                    accessToken: () => Promise.resolve(this.getToken()),
-                                });
+                                this.supabase = this.getSupabase(this.rimoriInfo.url, this.rimoriInfo.key, this.rimoriInfo.token);
                                 self.onmessage = originalOnMessage; // Restore original handler
                                 resolve({ supabase: this.supabase, info: this.rimoriInfo });
                             }
@@ -186,68 +199,40 @@ export class RimoriCommunicationHandler {
                     const { data } = yield EventBus.request(this.pluginId, 'global.supabase.requestAccess');
                     // console.log({ data });
                     this.rimoriInfo = data;
-                    this.supabase = createClient(this.rimoriInfo.url, this.rimoriInfo.key, {
-                        accessToken: () => Promise.resolve(this.getToken()),
-                    });
+                    this.supabase = this.getSupabase(this.rimoriInfo.url, this.rimoriInfo.key, this.rimoriInfo.token);
                 }
             }
             return { supabase: this.supabase, info: this.rimoriInfo };
         });
     }
-    getToken() {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (this.rimoriInfo && this.rimoriInfo.expiration && this.rimoriInfo.expiration > new Date()) {
-                return this.rimoriInfo.token;
+    /**
+     * Handles updates to RimoriInfo from rimori-main.
+     * Updates the cached info and Supabase client, then notifies all registered callbacks.
+     */
+    handleRimoriInfoUpdate(newInfo) {
+        // Update cached rimoriInfo
+        this.rimoriInfo = newInfo;
+        // Update Supabase client with new token
+        this.supabase = this.getSupabase(newInfo.url, newInfo.key, newInfo.token);
+        // Notify all registered callbacks
+        this.updateCallbacks.forEach((callback) => {
+            try {
+                callback(newInfo);
             }
-            // If we don't have rimoriInfo, request it
-            if (!this.rimoriInfo) {
-                const { data } = yield EventBus.request(this.pluginId, 'global.supabase.requestAccess');
-                this.rimoriInfo = data;
-                return this.rimoriInfo.token;
+            catch (error) {
+                console.error('[RimoriCommunicationHandler] Error in update callback:', error);
             }
-            // If token is expired, request fresh access
-            const { data } = yield EventBus.request(this.pluginId, 'global.supabase.requestAccess');
-            this.rimoriInfo.token = data.token;
-            this.rimoriInfo.expiration = data.expiration;
-            return this.rimoriInfo.token;
         });
     }
     /**
-     * Gets the Supabase URL.
-     * @returns The Supabase URL.
-     * @deprecated All endpoints should use the backend URL instead.
+     * Registers a callback to be called when RimoriInfo is updated.
+     * @param callback - Function to call with the new RimoriInfo
+     * @returns Cleanup function to unregister the callback
      */
-    getSupabaseUrl() {
-        if (!this.rimoriInfo) {
-            throw new Error('Supabase info not found');
-        }
-        return this.rimoriInfo.url;
-    }
-    getBackendUrl() {
-        if (!this.rimoriInfo) {
-            throw new Error('Rimori info not found');
-        }
-        return this.rimoriInfo.backendUrl;
-    }
-    getGlobalEventTopic(preliminaryTopic) {
-        var _a, _b;
-        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 = (_b = (_a = this.rimoriInfo) === null || _a === void 0 ? void 0 : _a.pluginId) !== null && _b !== void 0 ? _b : 'global';
-        return `${topicRoot}.${preliminaryTopic}`;
+    onUpdate(callback) {
+        this.updateCallbacks.add(callback);
+        return () => {
+            this.updateCallbacks.delete(callback);
+        };
     }
 }

package/dist/plugin/RimoriClient.d.ts

@@ -1,191 +1,31 @@
-import { PostgrestQueryBuilder } from '@supabase/postgrest-js';
-import { GenericSchema } from '@supabase/supabase-js/dist/module/lib/types';
-import { Message, OnLLMResponse } from '../controller/AIController';
-import { ObjectRequest } from '../controller/ObjectController';
-import { UserInfo } from '../controller/SettingsController';
 import { SharedContent, SharedContentFilter, SharedContentObjectRequest } from '../controller/SharedContentController';
-import { CreateExerciseParams } from '../controller/ExerciseController';
-import { EventBusMessage, EventHandler, EventPayload, EventListener } from '../fromRimori/EventBus';
-import { ActivePlugin, MainPanelAction, Plugin, Tool } from '../fromRimori/PluginTypes';
-import { AccomplishmentPayload } from '../controller/AccomplishmentController';
-import { Translator } from '../controller/TranslationController';
+import { PluginModule } from './module/PluginModule';
+import { DbModule } from './module/DbModule';
+import { EventModule } from './module/EventModule';
+import { AIModule } from './module/AIModule';
+import { ExerciseModule } from './module/ExerciseModule';
 export declare class RimoriClient {
     private static instance;
-    private superbase;
     private pluginController;
-    private settingsController;
     private sharedContentController;
-    private exerciseController;
-    private accomplishmentHandler;
+    db: DbModule;
+    event: EventModule;
+    plugin: PluginModule;
+    ai: AIModule;
+    exercise: ExerciseModule;
     private rimoriInfo;
-    private translator;
     private constructor();
-    get plugin(): {
-        pluginId: string;
-        /**
-         * The release channel of this plugin installation.
-         * Determines which database schema is used for plugin tables.
-         */
-        releaseChannel: "alpha" | "beta" | "stable";
-        /**
-         * Set the settings for the plugin.
-         * @param settings The settings to set.
-         */
-        setSettings: (settings: any) => Promise<void>;
-        /**
-         * 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.
-         */
-        getSettings: <T extends object>(defaultSettings: T) => Promise<T>;
-        getUserInfo: () => UserInfo;
-        /**
-         * 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;
-        };
-        /**
-         * Get the translator for the plugin.
-         * @returns The translator for the plugin.
-         */
-        getTranslator: () => Promise<Translator>;
-    };
-    get db(): {
-        from: <ViewName extends string & keyof GenericSchema["Views"], View extends GenericSchema["Views"][ViewName]>(relation: string) => PostgrestQueryBuilder<GenericSchema, View, ViewName>;
-        /**
-         * The table prefix for of database tables of the plugin.
-         */
-        tablePrefix: string;
-        /**
-         * The database schema used for plugin tables.
-         * Determined by rimori-main based on release channel:
-         * - 'plugins_alpha' for alpha release channel
-         * - 'plugins' for beta and stable release channels
-         */
-        schema: "plugins" | "plugins_alpha";
-        /**
-         * 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;
-    };
-    event: {
-        /**
-         * 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;
-        /**
-         * 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>>;
-        /**
-         * 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;
-        /**
-         * 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;
-        /**
-         * 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;
-        /**
-         * 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;
-        /**
-         * 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;
-        onSidePanelAction: (callback: (data: MainPanelAction) => void, actionsToListen?: string | string[]) => EventListener;
-    };
     navigation: {
         toDashboard: () => void;
     };
     /**
      * Get a query parameter value that was passed via MessageChannel
      * @param key The query parameter key
+     * @deprecated Use the plugin.applicationMode and plugin.theme properties instead
      * @returns The query parameter value or null if not found
      */
     getQueryParam(key: string): string | null;
     static getInstance(pluginId?: string): Promise<RimoriClient>;
-    ai: {
-        getText: (messages: Message[], tools?: Tool[]) => Promise<string>;
-        getSteamedText: (messages: Message[], onMessage: OnLLMResponse, tools?: Tool[]) => Promise<void>;
-        getVoice: (text: string, voice?: string, speed?: number, language?: string) => Promise<Blob>;
-        getTextFromVoice: (file: Blob) => Promise<string>;
-        getObject: <T = any>(request: ObjectRequest) => Promise<T>;
-    };
     runtime: {
         fetchBackend: (url: string, options: RequestInit) => Promise<Response>;
     };
@@ -268,28 +108,4 @@ export declare class RimoriClient {
             remove: (id: string) => Promise<SharedContent<any>>;
         };
     };
-    exercise: {
-        /**
-         * Fetches weekly exercises from the weekly_exercises view.
-         * Shows exercises for the current week that haven't expired.
-         * @returns Array of exercise objects.
-         */
-        view: () => Promise<import("../controller/ExerciseController").Exercise[]>;
-        /**
-         * 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.
-         */
-        add: (params: CreateExerciseParams | CreateExerciseParams[]) => Promise<import("../controller/ExerciseController").Exercise[]>;
-        /**
-         * Deletes an exercise via the backend API.
-         * @param id The exercise ID to delete.
-         * @returns Success status.
-         */
-        delete: (id: string) => Promise<{
-            success: boolean;
-            message: string;
-        }>;
-    };
 }