@rimori/react-client 0.1.0 → 0.2.0

package/dist/rimori-client/src/controller/AccomplishmentController.d.ts

@@ -1,38 +0,0 @@
-import { EventBusMessage } from '../fromRimori/EventBus';
-export type AccomplishmentMessage = EventBusMessage<MicroAccomplishmentPayload>;
-export declare const skillCategories: readonly ["reading", "listening", "speaking", "writing", "learning", "community"];
-interface BaseAccomplishmentPayload {
-    type: 'micro' | 'macro';
-    skillCategory: (typeof skillCategories)[number];
-    accomplishmentKeyword: string;
-    description: string;
-    meta?: {
-        key: string;
-        value: string | number | boolean;
-        description: string;
-    }[];
-}
-export interface MicroAccomplishmentPayload extends BaseAccomplishmentPayload {
-    type: 'micro';
-}
-export interface MacroAccomplishmentPayload extends BaseAccomplishmentPayload {
-    type: 'macro';
-    errorRatio: number;
-    durationMinutes: number;
-}
-export type AccomplishmentPayload = MicroAccomplishmentPayload | MacroAccomplishmentPayload;
-export declare class AccomplishmentController {
-    private pluginId;
-    constructor(pluginId: string);
-    emitAccomplishment(payload: Omit<AccomplishmentPayload, 'type'>): void;
-    private validateAccomplishment;
-    private sanitizeAccomplishment;
-    private getDecoupledTopic;
-    /**
-     * Subscribe to accomplishment events
-     * @param accomplishmentTopic - The topic of the accomplishment event. The pattern can be any pattern of plugin.skillCategory.accomplishmentKeyword or an * as wildcard for any plugin, skill category or accomplishment keyword
-     * @param callback - The callback function to be called when the accomplishment event is triggered
-     */
-    subscribe(accomplishmentTopics: string | string[] | undefined, callback: (payload: EventBusMessage<AccomplishmentPayload>) => void): void;
-}
-export {};

package/dist/rimori-client/src/controller/AccomplishmentController.js

@@ -1,112 +0,0 @@
-import { EventBus } from '../fromRimori/EventBus';
-export const skillCategories = ['reading', 'listening', 'speaking', 'writing', 'learning', 'community'];
-export class AccomplishmentController {
-    constructor(pluginId) {
-        this.pluginId = pluginId;
-    }
-    emitAccomplishment(payload) {
-        const accomplishmentPayload = Object.assign(Object.assign({}, payload), { type: 'durationMinutes' in payload ? 'macro' : 'micro' });
-        this.validateAccomplishment(accomplishmentPayload);
-        const sanitizedPayload = this.sanitizeAccomplishment(accomplishmentPayload);
-        const topic = 'global.accomplishment.trigger' + (accomplishmentPayload.type === 'macro' ? 'Macro' : 'Micro');
-        EventBus.emit(this.pluginId, topic, sanitizedPayload);
-    }
-    validateAccomplishment(payload) {
-        if (!skillCategories.includes(payload.skillCategory)) {
-            throw new Error(`Invalid skill category: ${payload.skillCategory}`);
-        }
-        //regex validate accomplishmentKeyword
-        if (!/^[a-z_-]+$/.test(payload.accomplishmentKeyword)) {
-            throw new Error(`The accomplishment keyword: ${payload.accomplishmentKeyword} is invalid. Only lowercase letters, minuses and underscores are allowed`);
-        }
-        //description is required
-        if (payload.description.length < 10) {
-            throw new Error('Description is too short');
-        }
-        //check that the type is valid
-        if (!['micro', 'macro'].includes(payload.type)) {
-            throw new Error('Invalid accomplishment type ' + payload.type);
-        }
-        //durationMinutes is required
-        if (payload.type === 'macro' && payload.durationMinutes < 4) {
-            throw new Error('The duration must be at least 4 minutes');
-        }
-        //errorRatio is required
-        if (payload.type === 'macro' && (payload.errorRatio < 0 || payload.errorRatio > 1)) {
-            throw new Error('The error ratio must be between 0 and 1');
-        }
-        //regex check meta data key
-        if (payload.meta) {
-            payload.meta.forEach((meta) => {
-                if (!/^[a-z_]+$/.test(meta.key)) {
-                    throw new Error('Invalid meta data key ' + meta.key + ', only lowercase letters and underscores are allowed');
-                }
-            });
-        }
-    }
-    sanitizeAccomplishment(payload) {
-        var _a;
-        payload.description = payload.description.replace(/[^\x20-\x7E]/g, '');
-        (_a = payload.meta) === null || _a === void 0 ? void 0 : _a.forEach((meta) => {
-            meta.description = meta.description.replace(/[^\x20-\x7E]/g, '');
-        });
-        return payload;
-    }
-    getDecoupledTopic(topic) {
-        const [plugin, skillCategory, accomplishmentKeyword] = topic.split('.');
-        return {
-            plugin: plugin || '*',
-            skillCategory: skillCategory || '*',
-            accomplishmentKeyword: accomplishmentKeyword || '*',
-        };
-    }
-    /**
-     * Subscribe to accomplishment events
-     * @param accomplishmentTopic - The topic of the accomplishment event. The pattern can be any pattern of plugin.skillCategory.accomplishmentKeyword or an * as wildcard for any plugin, skill category or accomplishment keyword
-     * @param callback - The callback function to be called when the accomplishment event is triggered
-     */
-    subscribe(accomplishmentTopics = '*', callback) {
-        if (typeof accomplishmentTopics === 'string') {
-            accomplishmentTopics = [accomplishmentTopics];
-        }
-        accomplishmentTopics.forEach((accomplishmentTopic) => {
-            const topicLength = accomplishmentTopic.split('.').length;
-            if (topicLength === 1) {
-                accomplishmentTopic += '.*.*';
-            }
-            else if (topicLength === 2) {
-                accomplishmentTopic += '.*';
-            }
-            else if (topicLength !== 3) {
-                throw new Error('Invalid accomplishment topic pattern. The pattern must be plugin.skillCategory.accomplishmentKeyword or an * as wildcard for any plugin, skill category or accomplishment keyword');
-            }
-            EventBus.on(['global.accomplishment.triggerMicro', 'global.accomplishment.triggerMacro'], (event) => {
-                const { plugin, skillCategory, accomplishmentKeyword } = this.getDecoupledTopic(accomplishmentTopic);
-                if (plugin !== '*' && event.sender !== plugin)
-                    return;
-                if (skillCategory !== '*' && event.data.skillCategory !== skillCategory)
-                    return;
-                if (accomplishmentKeyword !== '*' && event.data.accomplishmentKeyword !== accomplishmentKeyword)
-                    return;
-                callback(event);
-            }, [this.pluginId]);
-        });
-    }
-}
-// const accomplishmentHandler = AccomplishmentHandler.getInstance("my-plugin");
-// accomplishmentHandler.subscribe("*", (payload) => {
-//   console.log(payload);
-// });
-// accomplishmentHandler.emitAccomplishment({
-//   skillCategory: "reading",
-//   accomplishmentKeyword: "chapter",
-//   description: "Read chapter 1 of the book",
-//   durationMinutes: 10,
-//   meta: [
-//     {
-//       key: "book",
-//       value: "The Great Gatsby",
-//       description: "The book I read",
-//     },
-//   ],
-// });

package/dist/rimori-client/src/controller/AudioController.d.ts

@@ -1,37 +0,0 @@
-/**
- * AudioController is a class that provides methods to record audio. It is a wrapper around the Capacitor Voice Recorder plugin. For more information, see https://github.com/tchvu3/capacitor-voice-recorder.
- *
- * @example
- * const audioController = new AudioController();
- * await audioController.startRecording();
- */
-export declare class AudioController {
-    private pluginId;
-    constructor(pluginId: string);
-    /**
-     * Start the recording.
-     *
-     * @example
-     * const audioController = new AudioController();
-     * await audioController.startRecording();
-     * @returns void
-     */
-    startRecording(): Promise<void>;
-    /**
-     * Stop the recording and return the audio data.
-     * @returns The audio data.
-     *
-     * @example
-     * const audioRef = new Audio(`data:${mimeType};base64,${base64Sound}`)
-     * audioRef.oncanplaythrough = () => audioRef.play()
-     * audioRef.load()
-     */
-    stopRecording(): Promise<{
-        recording: Blob;
-        msDuration: number;
-        mimeType: string;
-    }>;
-    pauseRecording(): Promise<boolean>;
-    resumeRecording(): Promise<boolean>;
-    getCurrentStatus(): Promise<'RECORDING' | 'PAUSED' | 'NONE'>;
-}

package/dist/rimori-client/src/controller/AudioController.js

@@ -1,68 +0,0 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import { EventBus } from '../fromRimori/EventBus';
-/**
- * AudioController is a class that provides methods to record audio. It is a wrapper around the Capacitor Voice Recorder plugin. For more information, see https://github.com/tchvu3/capacitor-voice-recorder.
- *
- * @example
- * const audioController = new AudioController();
- * await audioController.startRecording();
- */
-export class AudioController {
-    constructor(pluginId) {
-        this.pluginId = pluginId;
-    }
-    /**
-     * Start the recording.
-     *
-     * @example
-     * const audioController = new AudioController();
-     * await audioController.startRecording();
-     * @returns void
-     */
-    startRecording() {
-        return __awaiter(this, void 0, void 0, function* () {
-            EventBus.emit(this.pluginId, 'global.microphone.triggerStartRecording');
-        });
-    }
-    /**
-     * Stop the recording and return the audio data.
-     * @returns The audio data.
-     *
-     * @example
-     * const audioRef = new Audio(`data:${mimeType};base64,${base64Sound}`)
-     * audioRef.oncanplaythrough = () => audioRef.play()
-     * audioRef.load()
-     */
-    stopRecording() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const result = yield EventBus.request(this.pluginId, 'global.microphone.triggerStopRecording');
-            return result.data;
-        });
-    }
-    pauseRecording() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const result = yield EventBus.request(this.pluginId, 'global.microphone.triggerPauseRecording');
-            return result.data;
-        });
-    }
-    resumeRecording() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const result = yield EventBus.request(this.pluginId, 'global.microphone.triggerResumeRecording');
-            return result.data;
-        });
-    }
-    getCurrentStatus() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const result = yield EventBus.request(this.pluginId, 'global.microphone.triggerGetCurrentStatus');
-            return result.data;
-        });
-    }
-}

package/dist/rimori-client/src/controller/ExerciseController.d.ts

@@ -1,54 +0,0 @@
-import { SupabaseClient } from '@supabase/supabase-js';
-export type TriggerAction = {
-    action_key: string;
-} & Record<string, string | number | boolean>;
-export interface CreateExerciseParams {
-    plugin_id: string;
-    start_date: string;
-    end_date: string;
-    trigger_action: TriggerAction;
-    name: string;
-    description: string;
-    estimated_duration: number;
-}
-export interface Exercise {
-    id: string;
-    plugin_id: string;
-    start_date: string;
-    end_date: string;
-    trigger_action: TriggerAction;
-    name: string;
-    description: string;
-    estimated_duration: number;
-    created_at?: string;
-    updated_at?: string;
-}
-export declare class ExerciseController {
-    private supabase;
-    constructor(supabase: SupabaseClient);
-    /**
-     * Fetches weekly exercises from the weekly_exercises view.
-     * Shows exercises for the current week that haven't expired.
-     * @returns Array of exercise objects.
-     */
-    viewWeeklyExercises(): Promise<Exercise[]>;
-    /**
-     * Creates a new exercise via the backend API.
-     * @param token The token to use for authentication.
-     * @param backendUrl The URL of the backend API.
-     * @param params Exercise creation parameters.
-     * @returns Created exercise object.
-     */
-    addExercise(token: string, backendUrl: string, params: CreateExerciseParams): Promise<Exercise>;
-    /**
-     * 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.
-     * @returns Success status.
-     */
-    deleteExercise(token: string, backendUrl: string, id: string): Promise<{
-        success: boolean;
-        message: string;
-    }>;
-}

package/dist/rimori-client/src/controller/ExerciseController.js

@@ -1,74 +0,0 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-export class ExerciseController {
-    constructor(supabase) {
-        this.supabase = supabase;
-    }
-    /**
-     * Fetches weekly exercises from the weekly_exercises view.
-     * Shows exercises for the current week that haven't expired.
-     * @returns Array of exercise objects.
-     */
-    viewWeeklyExercises() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { data, error } = yield this.supabase.from('weekly_exercises').select('*');
-            if (error) {
-                throw new Error(`Failed to fetch weekly exercises: ${error.message}`);
-            }
-            return data || [];
-        });
-    }
-    /**
-     * Creates a new exercise via the backend API.
-     * @param token The token to use for authentication.
-     * @param backendUrl The URL of the backend API.
-     * @param params Exercise creation parameters.
-     * @returns Created exercise object.
-     */
-    addExercise(token, backendUrl, params) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const response = yield fetch(`${backendUrl}/exercises`, {
-                method: 'POST',
-                headers: {
-                    'Content-Type': 'application/json',
-                    Authorization: `Bearer ${token}`,
-                },
-                body: JSON.stringify(params),
-            });
-            if (!response.ok) {
-                const errorText = yield response.text();
-                throw new Error(`Failed to create exercise: ${errorText}`);
-            }
-            return yield response.json();
-        });
-    }
-    /**
-     * 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.
-     * @returns Success status.
-     */
-    deleteExercise(token, backendUrl, id) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const response = yield fetch(`${backendUrl}/exercises/${id}`, {
-                method: 'DELETE',
-                headers: {
-                    Authorization: `Bearer ${token}`,
-                },
-            });
-            if (!response.ok) {
-                const errorText = yield response.text();
-                throw new Error(`Failed to delete exercise: ${errorText}`);
-            }
-            return yield response.json();
-        });
-    }
-}

package/dist/rimori-client/src/controller/ObjectController.d.ts

@@ -1,42 +0,0 @@
-type PrimitiveType = 'string' | 'number' | 'boolean';
-type ObjectToolParameterType = PrimitiveType | {
-    [key: string]: ObjectToolParameter;
-} | [{
-    [key: string]: ObjectToolParameter;
-}];
-interface ObjectToolParameter {
-    type: ObjectToolParameterType;
-    description?: string;
-    enum?: string[];
-    optional?: boolean;
-}
-/**
- * The tools that the AI can use.
- *
- * The key is the name of the tool.
- * The value is the parameter of the tool.
- *
- */
-export type ObjectTool = {
-    [key: string]: ObjectToolParameter;
-};
-export interface ObjectRequest {
-    /**
-     * The tools that the AI can use.
-     */
-    tool: ObjectTool;
-    /**
-     * High level instructions for the AI to follow. Behaviour, tone, restrictions, etc.
-     * Example: "Act like a recipe writer."
-     */
-    behaviour?: string;
-    /**
-     * The specific instruction for the AI to follow.
-     * Example: "Generate a recipe using chicken, rice and vegetables."
-     */
-    instructions: string;
-}
-export declare function generateObject<T = any>(backendUrl: string, request: ObjectRequest, token: string): Promise<T>;
-export type OnLLMResponse = (id: string, response: string, finished: boolean, toolInvocations?: any[]) => void;
-export declare function streamObject(backendUrl: string, request: ObjectRequest, onResponse: OnLLMResponse, token: string): Promise<void>;
-export {};

package/dist/rimori-client/src/controller/ObjectController.js

@@ -1,76 +0,0 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-export function generateObject(backendUrl, request, token) {
-    return __awaiter(this, void 0, void 0, function* () {
-        return yield fetch(`${backendUrl}/ai/llm-object`, {
-            method: 'POST',
-            body: JSON.stringify({
-                stream: false,
-                tool: request.tool,
-                behaviour: request.behaviour,
-                instructions: request.instructions,
-            }),
-            headers: { Authorization: `Bearer ${token}`, 'Content-Type': 'application/json' },
-        }).then((response) => response.json());
-    });
-}
-export function streamObject(backendUrl, request, onResponse, token) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const messageId = Math.random().toString(36).substring(3);
-        const response = yield fetch(`${backendUrl}/ai/llm-object`, {
-            method: 'POST',
-            body: JSON.stringify({
-                stream: true,
-                tools: request.tool,
-                systemInstructions: request.behaviour,
-                secondaryInstructions: request.instructions,
-            }),
-            headers: { Authorization: `Bearer ${token}`, 'Content-Type': 'application/json' },
-        });
-        if (!response.body) {
-            console.error('No response body.');
-            return;
-        }
-        const reader = response.body.getReader();
-        const decoder = new TextDecoder('utf-8');
-        let content = '';
-        let done = false;
-        const toolInvocations = [];
-        while (!done) {
-            const { value } = yield reader.read();
-            if (value) {
-                const chunk = decoder.decode(value, { stream: true });
-                const lines = chunk.split('\n').filter((line) => line.trim() !== '');
-                for (const line of lines) {
-                    const data = line.substring(3, line.length - 1);
-                    const command = line.substring(0, 1);
-                    // console.log("data: ", { line, data, command });
-                    if (command === '0') {
-                        content += data;
-                        // console.log("AI response:", content);
-                        //content \n\n should be real line break when message is displayed
-                        onResponse(messageId, content.replace(/\\n/g, '\n').replace(/\\+"/g, '"'), false);
-                    }
-                    else if (command === 'd') {
-                        // console.log("AI usage:", JSON.parse(line.substring(2)));
-                        done = true;
-                        break;
-                    }
-                    else if (command === '9') {
-                        // console.log("tool call:", JSON.parse(line.substring(2)));
-                        // console.log("tools", tools);
-                        toolInvocations.push(JSON.parse(line.substring(2)));
-                    }
-                }
-            }
-        }
-        onResponse(messageId, content.replace(/\\n/g, '\n').replace(/\\+"/g, '"'), true, toolInvocations);
-    });
-}

package/dist/rimori-client/src/controller/SettingsController.d.ts

@@ -1,79 +0,0 @@
-import { SupabaseClient } from '@supabase/supabase-js';
-import { LanguageLevel } from '../utils/difficultyConverter';
-import { Guild } from '../plugin/CommunicationHandler';
-export interface Buddy {
-    id: string;
-    name: string;
-    description: string;
-    avatarUrl: string;
-    voiceId: string;
-    aiPersonality: string;
-}
-export interface Language {
-    code: string;
-    name: string;
-    native: string;
-    capitalized: string;
-    uppercase: string;
-}
-export interface UserInfo {
-    skill_level_reading: LanguageLevel;
-    skill_level_writing: LanguageLevel;
-    skill_level_grammar: LanguageLevel;
-    skill_level_speaking: LanguageLevel;
-    skill_level_listening: LanguageLevel;
-    skill_level_understanding: LanguageLevel;
-    goal_longterm: string;
-    goal_weekly: string;
-    study_buddy: Buddy;
-    story_genre: string;
-    study_duration: number;
-    /**
-     * The 2 letter language code of the language the user speaks natively.
-     * With the function getLanguageName, the language name can be retrieved.
-     */
-    mother_tongue: Language;
-    /**
-     * The language the user targets to learn.
-     */
-    target_language: Language;
-    motivation_type: string;
-    onboarding_completed: boolean;
-    context_menu_on_select: boolean;
-    user_name?: string;
-    /**
-     * ISO 3166-1 alpha-2 country code of user's target location (exposed to plugins)
-     */
-    target_country: string;
-    /**
-     * Optional: nearest big city (>100,000) near user's location
-     */
-    target_city?: string;
-}
-export declare class SettingsController {
-    private pluginId;
-    private supabase;
-    private guild;
-    constructor(supabase: SupabaseClient, pluginId: string, guild: Guild);
-    /**
-     * Fetches settings based on guild configuration.
-     * If guild doesn't allow user settings, fetches guild-level settings.
-     * Otherwise, fetches user-specific settings.
-     * @returns The settings object or null if not found.
-     */
-    private fetchSettings;
-    /**
-     * Sets settings for the plugin.
-     * Automatically saves as guild settings if guild doesn't allow user settings,
-     * otherwise saves as user-specific settings.
-     * @param settings - The settings object to save.
-     * @throws {Error} if RLS blocks the operation.
-     */
-    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.
-     * @returns The settings for the plugin.
-     */
-    getSettings<T extends object>(defaultSettings: T): Promise<T>;
-}