@rimori/client 2.4.0 → 2.5.0-next.2

package/src/controller/ObjectController.ts

@@ -1,120 +0,0 @@
-type PrimitiveType = 'string' | 'number' | 'boolean';
-
-// This is the type that can appear in the `type` property
-type ObjectToolParameterType =
-  | PrimitiveType
-  | { [key: string]: ObjectToolParameter } // for nested objects
-  | [{ [key: string]: ObjectToolParameter }]; // for arrays of objects (notice the tuple type)
-
-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 async function generateObject<T = any>(backendUrl: string, request: ObjectRequest, token: string): Promise<T> {
-  return await 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());
-}
-
-// TODO adjust stream to work with object
-export type OnLLMResponse = (id: string, response: string, finished: boolean, toolInvocations?: any[]) => void;
-
-export async function streamObject(
-  backendUrl: string,
-  request: ObjectRequest,
-  onResponse: OnLLMResponse,
-  token: string,
-) {
-  const messageId = Math.random().toString(36).substring(3);
-  const response = await 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: any[] = [];
-  while (!done) {
-    const { value } = await 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/src/controller/SettingsController.ts

@@ -1,186 +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 type UserRole = 'user' | 'plugin_moderator' | 'lang_moderator' | 'admin';
-
-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 language the user speaks natively.
-   */
-  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;
-  /**
-   * The user's role: 'user', 'plugin_moderator', 'lang_moderator', or 'admin'
-   */
-  user_role: UserRole;
-}
-
-export class SettingsController {
-  private pluginId: string;
-  private supabase: SupabaseClient;
-  private guild: Guild;
-
-  constructor(supabase: SupabaseClient, pluginId: string, guild: Guild) {
-    this.supabase = supabase;
-    this.pluginId = pluginId;
-    this.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 async fetchSettings(): Promise<any | null> {
-    const isGuildSetting = !this.guild.allowUserPluginSettings;
-
-    const { data } = await this.supabase
-      .from('plugin_settings')
-      .select('*')
-      .eq('plugin_id', this.pluginId)
-      .eq('guild_id', this.guild.id)
-      .eq('is_guild_setting', isGuildSetting)
-      .maybeSingle();
-
-    return data?.settings ?? null;
-  }
-
-  /**
-   * 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.
-   */
-  public async setSettings(settings: any): Promise<void> {
-    const isGuildSetting = !this.guild.allowUserPluginSettings;
-
-    const payload: any = {
-      plugin_id: this.pluginId,
-      settings,
-      guild_id: this.guild.id,
-      is_guild_setting: isGuildSetting,
-    };
-
-    if (isGuildSetting) {
-      payload.user_id = null;
-    }
-
-    // Try UPDATE first (safe with RLS). If nothing updated, INSERT.
-    const updateQuery = this.supabase
-      .from('plugin_settings')
-      .update({ settings })
-      .eq('plugin_id', this.pluginId)
-      .eq('guild_id', this.guild.id)
-      .eq('is_guild_setting', isGuildSetting);
-
-    const { data: updatedRows, error: updateError } = await (isGuildSetting
-      ? updateQuery.is('user_id', null).select('id')
-      : updateQuery.select('id'));
-
-    if (updateError) {
-      if (updateError.code === '42501' || updateError.message?.includes('policy')) {
-        throw new Error(`Cannot set ${isGuildSetting ? 'guild' : 'user'} settings: Permission denied.`);
-      }
-      // proceed to try insert in case of other issues
-    }
-
-    if (updatedRows && updatedRows.length > 0) {
-      return; // updated successfully
-    }
-
-    // No row updated -> INSERT
-    const { error: insertError } = await this.supabase.from('plugin_settings').insert(payload);
-
-    if (insertError) {
-      // In case of race condition (duplicate), try one more UPDATE
-      if (insertError.code === '23505' /* unique_violation */) {
-        const retry = this.supabase
-          .from('plugin_settings')
-          .update({ settings })
-          .eq('plugin_id', this.pluginId)
-          .eq('guild_id', this.guild.id)
-          .eq('is_guild_setting', isGuildSetting);
-        const { error: retryError } = await (isGuildSetting ? retry.is('user_id', null) : retry);
-        if (!retryError) return;
-      }
-
-      throw insertError;
-    }
-  }
-
-  /**
-   * 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.
-   */
-  public async getSettings<T extends object>(defaultSettings: T): Promise<T> {
-    const storedSettings = (await this.fetchSettings()) as T | null;
-
-    if (!storedSettings) {
-      await this.setSettings(defaultSettings);
-      return defaultSettings;
-    }
-
-    // Handle settings migration
-    const storedKeys = Object.keys(storedSettings);
-    const defaultKeys = Object.keys(defaultSettings);
-
-    if (storedKeys.length !== defaultKeys.length) {
-      const validStoredSettings = Object.fromEntries(
-        Object.entries(storedSettings).filter(([key]) => defaultKeys.includes(key)),
-      );
-      const mergedSettings = { ...defaultSettings, ...validStoredSettings } as T;
-
-      await this.setSettings(mergedSettings);
-      return mergedSettings;
-    }
-
-    return storedSettings;
-  }
-}

package/src/controller/SharedContentController.ts

@@ -1,365 +0,0 @@
-import { SupabaseClient } from '@supabase/supabase-js';
-import { RimoriClient } from '../plugin/RimoriClient';
-import { ObjectRequest } from './ObjectController';
-
-export interface SharedContentObjectRequest extends ObjectRequest {
-  fixedProperties?: Record<string, string | number | boolean>;
-}
-
-export type SharedContentFilter = Record<string, string | number | boolean>;
-
-export class SharedContentController {
-  private supabase: SupabaseClient;
-  private rimoriClient: RimoriClient;
-
-  constructor(supabase: SupabaseClient, rimoriClient: RimoriClient) {
-    this.supabase = supabase;
-    this.rimoriClient = rimoriClient;
-  }
-
-  /**
-   * Fetch new shared content for a given content type.
-   * @param contentType - The type of content to fetch.
-   * @param generatorInstructions - The instructions for the generator. The object needs to have a tool property with a topic and keywords property to let a new unique topic be generated.
-   * @param filter - An optional filter to apply to the query.
-   * @param options - Optional options.
-   * @param options.privateTopic - If the topic should be private and only be visible to the user.
-   * @param options.skipDbSave - If true, do not persist a newly generated content to the DB (default false).
-   * @param options.alwaysGenerateNew - If true, always generate a new content even if there is already a content with the same filter.
-   * @param options.excludeIds - Optional list of shared_content ids to exclude from selection.
-   * @returns The new shared content.
-   */
-  public async getNewSharedContent<T>(
-    contentType: string,
-    generatorInstructions: SharedContentObjectRequest,
-    //this filter is there if the content should be filtered additionally by a column and value
-    filter?: SharedContentFilter,
-    options?: { privateTopic?: boolean; skipDbSave?: boolean; alwaysGenerateNew?: boolean; excludeIds?: string[] },
-  ): Promise<SharedContent<T>> {
-    // The db cache of the shared content is temporary disabled until the new shared content implementation is completed
-    // if (false) {
-    //   let query = this.supabase
-    //     .from('shared_content')
-    //     .select('*, scc:shared_content_completed(id, state)')
-    //     .eq('content_type', contentType)
-    //     .not('scc.state', 'in', '("completed","ongoing","hidden")')
-    //     .is('deleted_at', null);
-
-    //   if (options?.excludeIds?.length ?? 0 > 0) {
-    //     const excludeIds = options.excludeIds.filter((id) => !id.startsWith('internal-temp-id-'));
-    //     // Supabase expects raw PostgREST syntax like '("id1","id2")'.
-    //     const excludeList = `(${excludeIds.map((id) => `"${id}"`).join(',')})`;
-    //     query = query.not('id', 'in', excludeList);
-    //   }
-
-    //   if (filter) {
-    //     query.contains('data', filter);
-    //   }
-
-    //   const { data: newAssignments, error } = await query.limit(30);
-
-    //   if (error) {
-    //     console.error('error fetching new assignments:', error);
-    //     throw new Error('error fetching new assignments');
-    //   }
-
-    //   // console.log('newAssignments:', newAssignments);
-
-    //   if (!options?.alwaysGenerateNew && newAssignments.length > 0) {
-    //     const index = Math.floor(Math.random() * newAssignments.length);
-    //     return newAssignments[index];
-    //   }
-    // }
-    const instructions = await this.generateNewAssignment(contentType, generatorInstructions, filter);
-
-    console.log('instructions:', instructions);
-
-    //create the shared content object
-    const data: SharedContent<T> = {
-      id: 'internal-temp-id-' + Math.random().toString(36).substring(2, 15),
-      contentType,
-      title: instructions.title,
-      keywords: instructions.keywords.map(({ text }: { text: string }) => text),
-      data: { ...instructions, title: undefined, keywords: undefined, ...generatorInstructions.fixedProperties },
-      privateTopic: options?.privateTopic,
-    };
-
-    if (options?.skipDbSave) {
-      return data;
-    }
-
-    return await this.createSharedContent(data);
-  }
-
-  private async generateNewAssignment(
-    contentType: string,
-    generatorInstructions: SharedContentObjectRequest,
-    filter?: SharedContentFilter,
-  ): Promise<any> {
-    const fullInstructions = await this.getGeneratorInstructions(contentType, generatorInstructions, filter);
-
-    console.log('fullInstructions:', fullInstructions);
-
-    return await this.rimoriClient.ai.getObject(fullInstructions);
-  }
-
-  private async getGeneratorInstructions(
-    contentType: string,
-    generatorInstructions: ObjectRequest,
-    filter?: SharedContentFilter,
-  ): Promise<ObjectRequest> {
-    const completedTopics = await this.getCompletedTopics(contentType, filter);
-
-    generatorInstructions.instructions += `
-    The following topics are already taken: ${completedTopics.join(', ')}`;
-
-    generatorInstructions.tool.title = {
-      type: 'string',
-      description: 'What the topic is about. Short. ',
-    };
-    generatorInstructions.tool.keywords = {
-      type: [{ text: { type: 'string' } }],
-      description: 'Keywords around the topic of the assignment.',
-    };
-    return generatorInstructions;
-  }
-
-  private async getCompletedTopics(contentType: string, filter?: SharedContentFilter): Promise<string[]> {
-    const query = this.supabase
-      .from('shared_content')
-      .select('title, keywords, scc:shared_content_completed(id)')
-      .eq('content_type', contentType)
-      .not('scc.id', 'is', null)
-      .is('deleted_at', null);
-
-    if (filter) {
-      query.contains('data', filter);
-    }
-
-    const { data: oldAssignments, error } = await query;
-
-    if (error) {
-      console.error('error fetching old assignments:', error);
-      return [];
-    }
-    return oldAssignments.map(({ title, keywords }) => `${title}(${keywords.join(',')})`);
-  }
-
-  public async getSharedContent<T>(contentType: string, id: string): Promise<SharedContent<T>> {
-    const { data, error } = await this.supabase
-      .from('shared_content')
-      .select()
-      .eq('content_type', contentType)
-      .eq('id', id)
-      .is('deleted_at', null)
-      .single();
-    if (error) {
-      console.error('error fetching shared content:', error);
-      throw new Error('error fetching shared content');
-    }
-    return data;
-  }
-
-  public async completeSharedContent(contentType: string, assignmentId: string) {
-    // Idempotent completion: upsert on (id, user_id) so repeated calls don't fail
-    const { error } = await this.supabase
-      .from('shared_content_completed')
-      .upsert({ content_type: contentType, id: assignmentId } as any, { onConflict: 'id' });
-
-    if (error) {
-      console.error('error completing shared content:', error);
-      throw new Error('error completing shared content');
-    }
-  }
-
-  /**
-   * Update state details for a shared content entry in shared_content_completed.
-   * Assumes table has columns: state ('completed'|'ongoing'|'hidden'), reaction ('liked'|'disliked'|null), bookmarked boolean.
-   * Upserts per (id, content_type, user).
-   * @param param
-   * @param param.contentType - The content type.
-   * @param param.id - The shared content id.
-   * @param param.state - The state to set.
-   * @param param.reaction - Optional reaction.
-   * @param param.bookmarked - Optional bookmark flag.
-   */
-  public async updateSharedContentState({
-    contentType,
-    id,
-    state,
-    reaction,
-    bookmarked,
-  }: {
-    contentType: string;
-    id: string;
-    state?: 'completed' | 'ongoing' | 'hidden';
-    reaction?: 'liked' | 'disliked' | null;
-    bookmarked?: boolean;
-  }): Promise<void> {
-    const payload: Record<string, unknown> = { content_type: contentType, id };
-    if (state !== undefined) payload.state = state;
-    if (reaction !== undefined) payload.reaction = reaction;
-    if (bookmarked !== undefined) payload.bookmarked = bookmarked;
-
-    // Prefer upsert, fall back to insert/update if upsert not allowed
-    const { error } = await this.supabase.from('shared_content_completed').upsert(payload as any, { onConflict: 'id' });
-
-    if (error) {
-      console.error('error updating shared content state:', error);
-      throw new Error('error updating shared content state');
-    }
-  }
-
-  /**
-   * Fetch shared content from the database based on optional filters.
-   * @param contentType - The type of content to fetch.
-   * @param filter - Optional filter to apply to the query.
-   * @param limit - Optional limit for the number of results.
-   * @returns Array of shared content matching the criteria.
-   */
-  public async getSharedContentList<T>(
-    contentType: string,
-    filter?: SharedContentFilter,
-    limit?: number,
-  ): Promise<SharedContent<T>[]> {
-    const query = this.supabase
-      .from('shared_content')
-      .select('*')
-      .eq('content_type', contentType)
-      .is('deleted_at', null)
-      .limit(limit ?? 30);
-
-    if (filter) {
-      query.contains('data', filter);
-    }
-
-    const { data, error } = await query;
-
-    if (error) {
-      console.error('error fetching shared content:', error);
-      throw new Error('error fetching shared content');
-    }
-
-    return data;
-  }
-
-  /**
-   * Insert new shared content into the database.
-   * @param param
-   * @param param.contentType - The type of content to insert.
-   * @param param.title - The title of the content.
-   * @param param.keywords - Keywords associated with the content.
-   * @param param.data - The content data to store.
-   * @param param.privateTopic - Optional flag to indicate if the topic should be private.
-   * @returns The inserted shared content.
-   * @throws {Error} if insertion fails.
-   */
-  public async createSharedContent<T>({
-    contentType,
-    title,
-    keywords,
-    data,
-    privateTopic,
-  }: Omit<SharedContent<T>, 'id'>): Promise<SharedContent<T>> {
-    const { data: newContent, error } = await this.supabase
-      .from('shared_content')
-      .insert({
-        private: privateTopic,
-        content_type: contentType,
-        title,
-        keywords,
-        data,
-      })
-      .select();
-
-    if (error) {
-      console.error('error inserting shared content:', error);
-      throw new Error('error inserting shared content');
-    }
-
-    return newContent[0];
-  }
-
-  /**
-   * Update existing shared content in the database.
-   * @param id - The ID of the content to update.
-   * @param updates - The updates to apply to the shared content.
-   * @returns The updated shared content.
-   * @throws {Error} if update fails.
-   */
-  public async updateSharedContent<T>(id: string, updates: Partial<SharedContent<T>>): Promise<SharedContent<T>> {
-    const updateData: any = {};
-
-    if (updates.contentType) updateData.content_type = updates.contentType;
-    if (updates.title) updateData.title = updates.title;
-    if (updates.keywords) updateData.keywords = updates.keywords;
-    if (updates.data) updateData.data = updates.data;
-    if (updates.privateTopic !== undefined) updateData.private = updates.privateTopic;
-
-    const { data: updatedContent, error } = await this.supabase
-      .from('shared_content')
-      .update(updateData)
-      .eq('id', id)
-      .select();
-
-    if (error) {
-      console.error('error updating shared content:', error);
-      throw new Error('error updating shared content');
-    }
-
-    if (!updatedContent || updatedContent.length === 0) {
-      throw new Error('shared content not found');
-    }
-
-    return updatedContent[0];
-  }
-
-  /**
-   * Soft delete shared content by setting the deleted_at timestamp.
-   * @param id - The ID of the content to delete.
-   * @returns The deleted shared content record.
-   * @throws {Error} if deletion fails or content not found.
-   */
-  public async removeSharedContent(id: string): Promise<SharedContent<any>> {
-    const { data: deletedContent, error } = await this.supabase
-      .from('shared_content')
-      .update({ deleted_at: new Date().toISOString() })
-      .eq('id', id)
-      .select();
-
-    if (error) {
-      console.error('error deleting shared content:', error);
-      throw new Error('error deleting shared content');
-    }
-
-    if (!deletedContent || deletedContent.length === 0) {
-      throw new Error('shared content not found or already deleted');
-    }
-
-    return deletedContent[0];
-  }
-}
-
-/**
- * Interface representing shared content in the system.
- * @template T The type of data stored in the content
- */
-export interface SharedContent<T> {
-  /** The id of the content */
-  id: string;
-
-  /** The type/category of the content (e.g. 'grammar_exercises', 'flashcards', etc.) */
-  contentType: string;
-
-  /** The human readable title of the content */
-  title: string;
-
-  /** Array of keywords/tags associated with the content for search and categorization */
-  keywords: string[];
-
-  /** The actual content data of type T */
-  data: T;
-
-  /** Whether this content should only be visible to the creator. Defaults to false if not specified */
-  privateTopic?: boolean;
-}