@rimori/client 2.5.18 → 2.5.19-next.1

package/dist/fromRimori/EventBus.d.ts

@@ -13,6 +13,8 @@ export interface EventBusMessage<T = EventPayload> {
     topic: string;
     data: T;
     debug: boolean;
+    /** Session token inherited from the calling plugin, used to attribute AI calls to the originating exercise session. */
+    ai_session_token?: string;
 }
 export type EventHandler<T = EventPayload> = (event: EventBusMessage<T>) => void | Promise<void>;
 export interface EventListener {
@@ -56,7 +58,7 @@ export declare class EventBusHandler {
      * - pl1234.card.delete
      * - pl1234.card.triggerBackup
      */
-    emit<T = EventPayload>(sender: string, topic: string, data?: T, eventId?: number): void;
+    emit<T = EventPayload>(sender: string, topic: string, data?: T, eventId?: number, aiSessionToken?: string): void;
     private emitInternal;
     /**
      * Subscribes to an event on the event bus.
@@ -93,7 +95,7 @@ export declare class EventBusHandler {
      * @param data - The data of the event.
      * @returns A promise that resolves to the event.
      */
-    request<T = EventPayload>(sender: string, topic: string, data?: EventPayload): Promise<EventBusMessage<T>>;
+    request<T = EventPayload>(sender: string, topic: string, data?: EventPayload, aiSessionToken?: string): Promise<EventBusMessage<T>>;
     /**
      * Gets the matching handlers for an event.
      * @param topic - The topic of the event.

package/dist/fromRimori/EventBus.js

@@ -63,7 +63,7 @@ export class EventBusHandler {
         this.generatedIds.set(id, now);
         return id;
     }
-    createEvent(sender, topic, data, eventId) {
+    createEvent(sender, topic, data, eventId, aiSessionToken) {
         const generatedEventId = eventId || this.generateUniqueId();
         return {
             eventId: generatedEventId,
@@ -72,6 +72,7 @@ export class EventBusHandler {
             topic,
             data,
             debug: this.debugEnabled,
+            ai_session_token: aiSessionToken,
         };
     }
     /**
@@ -92,15 +93,15 @@ export class EventBusHandler {
      * - pl1234.card.delete
      * - pl1234.card.triggerBackup
      */
-    emit(sender, topic, data, eventId) {
-        this.emitInternal(sender, topic, data || {}, eventId);
+    emit(sender, topic, data, eventId, aiSessionToken) {
+        this.emitInternal(sender, topic, data || {}, eventId, false, aiSessionToken);
     }
-    emitInternal(sender, topic, data, eventId, skipResponseTrigger = false) {
+    emitInternal(sender, topic, data, eventId, skipResponseTrigger = false, aiSessionToken) {
         if (!this.validateTopic(topic)) {
             this.logAndThrowError(false, `Invalid topic: ` + topic);
             return;
         }
-        const event = this.createEvent(sender, topic, data, eventId);
+        const event = this.createEvent(sender, topic, data, eventId, aiSessionToken);
         const handlers = this.getMatchingHandlers(event.topic);
         handlers.forEach((handler) => {
             if (handler.ignoreSender && handler.ignoreSender.includes(sender)) {
@@ -245,16 +246,16 @@ export class EventBusHandler {
      * @param data - The data of the event.
      * @returns A promise that resolves to the event.
      */
-    request(sender, topic, data) {
+    request(sender, topic, data, aiSessionToken) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!this.validateTopic(topic)) {
                 this.logAndThrowError(true, `Invalid topic: ` + topic);
             }
-            const event = this.createEvent(sender, topic, data || {});
+            const event = this.createEvent(sender, topic, data || {}, undefined, aiSessionToken);
             this.logIfDebug(`Requesting data from ` + topic, { event });
             return new Promise((resolve) => {
                 this.responseResolvers.set(event.eventId, (value) => resolve(value));
-                this.emitInternal(sender, topic, data || {}, event.eventId, true);
+                this.emitInternal(sender, topic, data || {}, event.eventId, true, aiSessionToken);
             });
         });
     }

package/dist/index.d.ts

@@ -15,7 +15,8 @@ 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, SubscriptionTier, ExplicitUndefined, BasePluginSettings } from './plugin/module/PluginModule';
+export { TIER_ORDER, ROLE_ORDER } 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/index.js

@@ -10,4 +10,5 @@ export * from './plugin/CommunicationHandler';
 export { setupWorker } from './worker/WorkerSetup';
 export { AudioController } from './controller/AudioController';
 export { Translator } from './controller/TranslationController';
+export { TIER_ORDER, ROLE_ORDER } from './plugin/module/PluginModule';
 export { StorageModule } from './plugin/module/StorageModule';

package/dist/plugin/CommunicationHandler.js

@@ -58,9 +58,9 @@ export class RimoriCommunicationHandler {
                     EventBus.emit(this.pluginId, 'error', { error }, eventId);
                 }
                 else if (event) {
-                    const { topic, sender, data: eventData, eventId } = event;
+                    const { topic, sender, data: eventData, eventId, ai_session_token } = event;
                     if (sender !== this.pluginId) {
-                        EventBus.emit(sender, topic, eventData, eventId);
+                        EventBus.emit(sender, topic, eventData, eventId, ai_session_token);
                     }
                     else {
                         console.log('[PluginController] event from self', event);

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

@@ -61,17 +61,20 @@ export declare class AIModule {
     private sessionTokenId;
     private onRateLimitedCb?;
     constructor(backendUrl: string, getToken: () => string);
-    /** Returns the current exercise session token ID (null if no active session). */
-    getSessionTokenId(): string | null;
-    /** Sets the session token ID (used by workers inheriting a session from the plugin). */
-    setSessionToken(id: string): void;
-    /** Clears the stored session token (called after macro accomplishment). */
-    clearSessionToken(): void;
-    /**
-     * Ensures a session token exists, requesting one from the backend if needed.
-     * Mirrors the lazy-issuance pattern used by the AI/LLM endpoint.
-     */
-    private ensureSessionToken;
+    /** Exercise session management. */
+    readonly session: {
+        /** Returns the current exercise session token ID (null if no active session). */
+        get: () => string | null;
+        /** Sets the session token ID. */
+        set: (id: string) => void;
+        /** Clears the stored session token. */
+        clear: () => void;
+        /**
+         * Ensures a session token exists, creating one from the backend if needed.
+         * Mirrors the lazy-issuance pattern used by the AI/LLM endpoint.
+         */
+        ensure: () => Promise<void>;
+    };
     /** Registers a callback invoked whenever a 429 rate-limit response is received. */
     setOnRateLimited(cb: (exercisesRemaining: number) => void): void;
     /**
@@ -91,7 +94,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 +154,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

@@ -14,47 +14,46 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 export class AIModule {
     constructor(backendUrl, getToken) {
         this.sessionTokenId = null;
+        /** Exercise session management. */
+        this.session = {
+            /** Returns the current exercise session token ID (null if no active session). */
+            get: () => this.sessionTokenId,
+            /** Sets the session token ID. */
+            set: (id) => {
+                this.sessionTokenId = id;
+            },
+            /** Clears the stored session token. */
+            clear: () => {
+                this.sessionTokenId = null;
+            },
+            /**
+             * Ensures a session token exists, creating one from the backend if needed.
+             * Mirrors the lazy-issuance pattern used by the AI/LLM endpoint.
+             */
+            ensure: () => __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                if (this.sessionTokenId)
+                    return;
+                const response = yield fetch(`${this.backendUrl}/ai/session`, {
+                    method: 'POST',
+                    headers: { Authorization: `Bearer ${this.getToken()}` },
+                });
+                if (!response.ok) {
+                    if (response.status === 429) {
+                        const body = yield response.json().catch(() => ({}));
+                        const remaining = (_a = body.exercises_remaining) !== null && _a !== void 0 ? _a : 0;
+                        (_b = this.onRateLimitedCb) === null || _b === void 0 ? void 0 : _b.call(this, remaining);
+                        throw new Error(`Rate limit exceeded: ${(_c = body.error) !== null && _c !== void 0 ? _c : 'Daily exercise limit reached'}. exercises_remaining: ${remaining}`);
+                    }
+                    throw new Error(`Failed to create session: ${response.status} ${response.statusText}`);
+                }
+                const { session_token_id } = yield response.json();
+                this.sessionTokenId = session_token_id;
+            }),
+        };
         this.backendUrl = backendUrl;
         this.getToken = getToken;
     }
-    /** Returns the current exercise session token ID (null if no active session). */
-    getSessionTokenId() {
-        return this.sessionTokenId;
-    }
-    /** Sets the session token ID (used by workers inheriting a session from the plugin). */
-    setSessionToken(id) {
-        this.sessionTokenId = id;
-    }
-    /** Clears the stored session token (called after macro accomplishment). */
-    clearSessionToken() {
-        this.sessionTokenId = null;
-    }
-    /**
-     * Ensures a session token exists, requesting one from the backend if needed.
-     * Mirrors the lazy-issuance pattern used by the AI/LLM endpoint.
-     */
-    ensureSessionToken() {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c;
-            if (this.sessionTokenId)
-                return;
-            const response = yield fetch(`${this.backendUrl}/ai/session`, {
-                method: 'POST',
-                headers: { Authorization: `Bearer ${this.getToken()}` },
-            });
-            if (!response.ok) {
-                if (response.status === 429) {
-                    const body = yield response.json().catch(() => ({}));
-                    const remaining = (_a = body.exercises_remaining) !== null && _a !== void 0 ? _a : 0;
-                    (_b = this.onRateLimitedCb) === null || _b === void 0 ? void 0 : _b.call(this, remaining);
-                    throw new Error(`Rate limit exceeded: ${(_c = body.error) !== null && _c !== void 0 ? _c : 'Daily exercise limit reached'}. exercises_remaining: ${remaining}`);
-                }
-                throw new Error(`Failed to create session: ${response.status} ${response.statusText}`);
-            }
-            const { session_token_id } = yield response.json();
-            this.sessionTokenId = session_token_id;
-        });
-    }
     /** Registers a callback invoked whenever a 429 rate-limit response is received. */
     setOnRateLimited(cb) {
         this.onRateLimitedCb = cb;
@@ -108,6 +107,7 @@ export class AIModule {
                 onResult: ({ result }) => onMessage(messageId, result, false),
             });
             onMessage(messageId, result, true);
+            return result;
         });
     }
     /**
@@ -122,7 +122,7 @@ export class AIModule {
     getVoice(text_1) {
         return __awaiter(this, arguments, void 0, function* (text, voice = 'alloy', speed = 1, language, cache = false) {
             var _a;
-            yield this.ensureSessionToken();
+            yield this.session.ensure();
             return yield fetch(`${this.backendUrl}/voice/tts`, {
                 method: 'POST',
                 headers: {
@@ -141,7 +141,7 @@ export class AIModule {
      */
     getTextFromVoice(file, language) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.ensureSessionToken();
+            yield this.session.ensure();
             const formData = new FormData();
             formData.append('file', file);
             if (language) {
@@ -208,7 +208,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/DbModule.d.ts

@@ -1,7 +1,5 @@
-import { PostgrestClientOptions, PostgrestQueryBuilder } from '@supabase/postgrest-js';
 import { SupabaseClient } from '../CommunicationHandler';
 import { RimoriCommunicationHandler, RimoriInfo } from '../CommunicationHandler';
-import { GenericSchema, GenericTable } from '@supabase/postgrest-js/dist/cjs/types/common/common';
 /**
  * Database module for plugin database operations.
  * Provides access to plugin tables with automatic prefixing and schema management.
@@ -19,7 +17,7 @@ export declare class DbModule {
      * @param relation The table name (without prefix for plugin tables, with 'global_' for global tables).
      * @returns A Postgrest query builder for the table.
      */
-    from<ViewName extends string & keyof GenericSchema['Views'], View extends GenericSchema['Views'][ViewName]>(relation: string): PostgrestQueryBuilder<PostgrestClientOptions, GenericSchema, GenericTable, ViewName, View>;
+    from(relation: string): import("@supabase/postgrest-js").PostgrestQueryBuilder<{} | import("@supabase/postgrest-js").PostgrestClientOptions, any, any, string, unknown>;
     /**
      * 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.

package/dist/plugin/module/DbModule.js

@@ -23,14 +23,9 @@ export class DbModule {
      */
     from(relation) {
         const tableName = this.getTableName(relation);
-        // Use the schema determined by rimori-main based on release channel
-        // Global tables (starting with 'global_') remain in public schema
-        // Plugin tables use the schema provided by rimori-main (plugins or plugins_alpha)
         if (relation.startsWith('global_')) {
-            // Global tables stay in public schema
             return this.supabase.schema('public').from(tableName);
         }
-        // Plugin tables go to the schema provided by rimori-main
         return this.supabase.schema(this.rimoriInfo.dbSchema).from(tableName);
     }
     /**

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;
         }
@@ -63,8 +63,13 @@ export class EventModule {
      * @returns The response from the event.
      */
     request(topic, data) {
-        const globalTopic = this.getGlobalEventTopic(topic);
-        return EventBus.request(this.pluginId, globalTopic, data);
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            const globalTopic = this.getGlobalEventTopic(topic);
+            yield this.aiModule.session.ensure();
+            const sessionToken = (_a = this.aiModule.session.get()) !== null && _a !== void 0 ? _a : undefined;
+            return EventBus.request(this.pluginId, globalTopic, data, sessionToken);
+        });
     }
     /**
      * Subscribe to an event.
@@ -74,7 +79,12 @@ export class EventModule {
      */
     on(topic, callback) {
         const topics = Array.isArray(topic) ? topic : [topic];
-        return EventBus.on(topics.map((t) => this.getGlobalEventTopic(t)), callback);
+        return EventBus.on(topics.map((t) => this.getGlobalEventTopic(t)), (event) => {
+            if (event.ai_session_token && !this.aiModule.session.get()) {
+                this.aiModule.session.set(event.ai_session_token);
+            }
+            callback(event);
+        });
     }
     /**
      * Subscribe to an event once.
@@ -91,7 +101,30 @@ export class EventModule {
      */
     respond(topic, data) {
         const topics = Array.isArray(topic) ? topic : [topic];
-        EventBus.respond(this.pluginId, topics.map((t) => this.getGlobalEventTopic(t)), data);
+        let wrappedData = data;
+        if (typeof data === 'function') {
+            wrappedData = (event) => __awaiter(this, void 0, void 0, function* () {
+                const previousToken = this.aiModule.session.get();
+                if (event.ai_session_token) {
+                    this.aiModule.session.set(event.ai_session_token);
+                }
+                try {
+                    console.log('responding to event', event);
+                    return yield data(event);
+                }
+                finally {
+                    if (event.ai_session_token) {
+                        if (previousToken) {
+                            this.aiModule.session.set(previousToken);
+                        }
+                        else {
+                            this.aiModule.session.clear();
+                        }
+                    }
+                }
+            });
+        }
+        EventBus.respond(this.pluginId, topics.map((t) => this.getGlobalEventTopic(t)), wrappedData);
     }
     /**
      * Emit an accomplishment.
@@ -100,7 +133,7 @@ export class EventModule {
     emitAccomplishment(payload) {
         return __awaiter(this, void 0, void 0, function* () {
             if (payload.type === 'macro') {
-                const sessionId = this.aiModule.getSessionTokenId();
+                const sessionId = this.aiModule.session.get();
                 if (sessionId) {
                     try {
                         yield fetch(`${this.backendUrl}/ai/session/${sessionId}/complete`, {
@@ -111,7 +144,7 @@ export class EventModule {
                     catch (_a) {
                         // non-fatal — session will expire naturally
                     }
-                    this.aiModule.clearSessionToken();
+                    this.aiModule.session.clear();
                 }
             }
             this.accomplishmentController.emitAccomplishment(payload);

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.
@@ -105,11 +105,23 @@ export interface Language {
     uppercase: string;
 }
 export type UserRole = 'user' | 'plugin_moderator' | 'lang_moderator' | 'admin';
+export type SubscriptionTier = 'anonymous' | 'free' | 'standard' | 'premium' | 'early_access';
+/** Ordered tiers from lowest to highest access level */
+export declare const TIER_ORDER: SubscriptionTier[];
+/** Ordered roles from lowest to highest access level */
+export declare const ROLE_ORDER: UserRole[];
 export declare const LEARNING_REASONS: readonly ["work", "partner", "friends", "study", "living", "culture", "growth", "citizenship", "other"];
 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
@@ -154,4 +166,9 @@ export interface UserInfo {
      * The user's role: 'user', 'plugin_moderator', 'lang_moderator', or 'admin'
      */
     user_role: UserRole;
+    /**
+     * The user's subscription tier. Higher tiers include all privileges of lower tiers.
+     * Order (ascending): anonymous < free < standard < premium < early_access
+     */
+    subscription_tier: SubscriptionTier;
 }

package/dist/plugin/module/PluginModule.js

@@ -178,6 +178,10 @@ export class PluginModule {
         });
     }
 }
+/** Ordered tiers from lowest to highest access level */
+export const TIER_ORDER = ['anonymous', 'free', 'standard', 'premium', 'early_access'];
+/** Ordered roles from lowest to highest access level */
+export const ROLE_ORDER = ['user', 'plugin_moderator', 'lang_moderator', 'admin'];
 export const LEARNING_REASONS = [
     'work',
     'partner',

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.1",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "repository": {