@rimori/client 2.5.18 → 2.5.19-next.0

package/dist/index.d.ts

@@ -15,7 +15,7 @@ export { Translator } from './controller/TranslationController';
 export type { TriggerAction } from './plugin/module/ExerciseModule';
 export type { Message, ToolInvocation } from './plugin/module/AIModule';
 export type { Theme, ApplicationMode } from './plugin/module/PluginModule';
-export type { UserInfo, Language, UserRole, ExplicitUndefined } from './plugin/module/PluginModule';
+export type { UserInfo, Language, UserRole, ExplicitUndefined, BasePluginSettings } from './plugin/module/PluginModule';
 export type { SharedContent, BasicSharedContent, ContentStatus } from './plugin/module/SharedContentController';
 export type { MacroAccomplishmentPayload, MicroAccomplishmentPayload } from './controller/AccomplishmentController';
 export { StorageModule } from './plugin/module/StorageModule';

package/dist/plugin/module/AIModule.d.ts

@@ -91,7 +91,7 @@ export declare class AIModule {
      * @param cache Whether to cache the result (default: false).
      * @param model The model to use for generation.
      */
-    getSteamedText(messages: Message[], onMessage: OnLLMResponse, tools?: Tool[], cache?: boolean, model?: string, knowledgeId?: string): Promise<void>;
+    getSteamedText(messages: Message[], onMessage: OnLLMResponse, tools?: Tool[], cache?: boolean, model?: string, knowledgeId?: string): Promise<string>;
     /**
      * Generate voice audio from text using AI.
      * @param text The text to convert to voice.
@@ -151,7 +151,7 @@ export declare class AIModule {
         tools?: Tool[];
         model?: string;
         knowledgeId?: string;
-    }): Promise<void>;
+    }): Promise<T>;
     private streamObject;
     private sendToolResult;
 }

package/dist/plugin/module/AIModule.js

@@ -108,6 +108,7 @@ export class AIModule {
                 onResult: ({ result }) => onMessage(messageId, result, false),
             });
             onMessage(messageId, result, true);
+            return result;
         });
     }
     /**
@@ -208,7 +209,7 @@ export class AIModule {
     getStreamedObject(params) {
         return __awaiter(this, void 0, void 0, function* () {
             const { systemPrompt, responseSchema, userPrompt, onResult, cache = false, tools = [], model = undefined, knowledgeId, } = params;
-            yield this.streamObject({
+            return yield this.streamObject({
                 responseSchema,
                 messages: this.getChatMessage(systemPrompt, userPrompt),
                 onResult,

package/dist/plugin/module/EventModule.js

@@ -32,7 +32,7 @@ export class EventModule {
         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'.");
+                throw new Error(`Invalid event topic '${preliminaryTopic}'. The topic must start with the plugin id, 'self' or 'global'.`);
             }
             return preliminaryTopic;
         }

package/dist/plugin/module/PluginModule.d.ts

@@ -44,7 +44,7 @@ export declare class PluginModule {
      * @param defaultSettings The default settings to use if no settings are found.
      * @returns The settings for the plugin.
      */
-    getSettings<T>(defaultSettings: ExplicitUndefined<T>): Promise<ExplicitUndefined<T>>;
+    getSettings<T extends BasePluginSettings>(defaultSettings: ExplicitUndefined<T>): Promise<ExplicitUndefined<T>>;
     /**
      * Get the current user info.
      * Note: For reactive updates in React components, use the userInfo from useRimori() hook instead.
@@ -110,6 +110,13 @@ export type LearningReason = (typeof LEARNING_REASONS)[number];
 export type ExplicitUndefined<T> = {
     [K in Exclude<keyof T, never>]-?: {} extends Pick<T, K> ? T[K] | undefined : T[K];
 };
+/**
+ * All plugin settings must include is_inited so rimori-main can detect
+ * plugins whose one-time worker init did not complete and re-trigger them.
+ */
+export type BasePluginSettings = {
+    is_inited: boolean;
+};
 export interface UserInfo {
     /**
      * The user's unique ID

package/dist/worker/WorkerSetup.d.ts

@@ -2,6 +2,7 @@ import { RimoriClient } from '../plugin/RimoriClient';
 /**
  * Sets up the web worker for the plugin to be able receive and send messages to Rimori.
  * @param pluginId - The id of the plugin to setup the worker for.
- * @param init - The function containing the initialization logic.
+ * @param init - The function containing the initialization logic. The init must be completed within 5s. For long running tasks use the init event (e.g. onboarding.triggerInitPlugin) or run the work async.
+ * @returns A promise that resolves when the worker is setup.
  */
 export declare function setupWorker(pluginId: string, init: (client: RimoriClient) => void | Promise<void>): Promise<void>;

package/dist/worker/WorkerSetup.js

@@ -12,7 +12,8 @@ import { EventBusHandler } from '../fromRimori/EventBus';
 /**
  * Sets up the web worker for the plugin to be able receive and send messages to Rimori.
  * @param pluginId - The id of the plugin to setup the worker for.
- * @param init - The function containing the initialization logic.
+ * @param init - The function containing the initialization logic. The init must be completed within 5s. For long running tasks use the init event (e.g. onboarding.triggerInitPlugin) or run the work async.
+ * @returns A promise that resolves when the worker is setup.
  */
 export function setupWorker(pluginId, init) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -27,10 +28,15 @@ export function setupWorker(pluginId, init) {
         };
         // Assign the mock to globalThis.
         Object.assign(globalThis, { window: mockWindow });
-        EventBusHandler.getInstance('Worker EventBus');
+        EventBusHandler.getInstance('Worker ' + pluginId + ' EventBus');
         const rimoriClient = yield RimoriClient.getInstance(pluginId);
         console.debug('[Worker] RimoriClient initialized.');
-        yield init(rimoriClient);
+        const timoutError = new Error('[Worker ' +
+            pluginId +
+            '] Worker setup must complete within 5s. Use init event (e.g. onboarding.triggerInitPlugin) or run work async.');
+        const initPromise = Promise.resolve(init(rimoriClient));
+        const timeout = new Promise((_, reject) => setTimeout(() => reject(timoutError), 5000));
+        yield Promise.race([initPromise, timeout]);
         console.debug('[Worker] Worker initialized.');
         rimoriClient.event.emit('self.rimori.triggerInitFinished');
     });

package/package.json

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