@rimori/client 1.4.0 → 1.4.3

package/src/core/controller/SettingsController.ts

@@ -1,6 +1,7 @@
-import { SupabaseClient } from "@supabase/supabase-js";
-import { LanguageLevel } from "../../utils/difficultyConverter";
-import { Language } from "../../utils/Language";
+import { SupabaseClient } from '@supabase/supabase-js';
+import { LanguageLevel } from '../../utils/difficultyConverter';
+import { Language } from '../../utils/Language';
+import { Guild } from '../core';
 
 export interface Buddy {
   id: string;
@@ -37,45 +38,117 @@ export interface UserInfo {
   context_menu_on_select: boolean;
   user_name?: string;
   /**
-   * ISO 3166-1 alpha-2 country code of user's location (exposed to plugins)
+   * ISO 3166-1 alpha-2 country code of user's target location (exposed to plugins)
    */
-  location_country: string;
+  target_country: string;
   /**
    * Optional: nearest big city (>100,000) near user's location
    */
-  location_city?: string;
+  target_city?: string;
 }
 
 export class SettingsController {
   private pluginId: string;
   private supabase: SupabaseClient;
+  private guild: Guild;
 
-  constructor(supabase: SupabaseClient, pluginId: string) {
+  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 { data } = await this.supabase.from("plugin_settings").select("*").eq("plugin_id", this.pluginId)
+    const isGuildSetting = !this.guild.allowUserPluginSettings;
 
-    if (!data || data.length === 0) {
-      return null;
-    }
+    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[0].settings;
+    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> {
-    await this.supabase.from("plugin_settings").upsert({ plugin_id: this.pluginId, settings });
+    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. 
+   * @returns The settings for the plugin.
    */
   public async getSettings<T extends object>(defaultSettings: T): Promise<T> {
-    const storedSettings = await this.fetchSettings() as T | null;
+    const storedSettings = (await this.fetchSettings()) as T | null;
 
     if (!storedSettings) {
       await this.setSettings(defaultSettings);
@@ -88,7 +161,7 @@ export class SettingsController {
 
     if (storedKeys.length !== defaultKeys.length) {
       const validStoredSettings = Object.fromEntries(
-        Object.entries(storedSettings).filter(([key]) => defaultKeys.includes(key))
+        Object.entries(storedSettings).filter(([key]) => defaultKeys.includes(key)),
       );
       const mergedSettings = { ...defaultSettings, ...validStoredSettings } as T;
 

package/src/core/controller/SharedContentController.ts

@@ -1,12 +1,12 @@
 import { SupabaseClient } from '@supabase/supabase-js';
-import { RimoriClient } from "../../plugin/RimoriClient";
-import { ObjectRequest } from "./ObjectController";
+import { RimoriClient } from '../../plugin/RimoriClient';
+import { ObjectRequest } from './ObjectController';
 
 export interface SharedContentObjectRequest extends ObjectRequest {
-  fixedProperties?: Record<string, string | number | boolean>
+  fixedProperties?: Record<string, string | number | boolean>;
 }
 
-export type SharedContentFilter = Record<string, string | number | boolean>
+export type SharedContentFilter = Record<string, string | number | boolean>;
 
 export class SharedContentController {
   private supabase: SupabaseClient;
@@ -34,10 +34,11 @@ export class SharedContentController {
     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[] },
+    options?: { privateTopic?: boolean; skipDbSave?: boolean; alwaysGenerateNew?: boolean; excludeIds?: string[] },
   ): Promise<SharedContent<T>> {
-    let query = this.supabase.from("shared_content")
-      .select("*, scc:shared_content_completed(id, state)")
+    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);
@@ -62,7 +63,7 @@ export class SharedContentController {
 
     // console.log('newAssignments:', newAssignments);
 
-    if (!(options?.alwaysGenerateNew) && newAssignments.length > 0) {
+    if (!options?.alwaysGenerateNew && newAssignments.length > 0) {
       const index = Math.floor(Math.random() * newAssignments.length);
       return newAssignments[index];
     }
@@ -73,13 +74,13 @@ export class SharedContentController {
 
     //create the shared content object
     const data: SharedContent<T> = {
-      id: "internal-temp-id-" + Math.random().toString(36).substring(2, 15),
+      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;
@@ -88,7 +89,11 @@ export class SharedContentController {
     return await this.createSharedContent(data);
   }
 
-  private async generateNewAssignment(contentType: string, generatorInstructions: SharedContentObjectRequest, filter?: SharedContentFilter): Promise<any> {
+  private async generateNewAssignment(
+    contentType: string,
+    generatorInstructions: SharedContentObjectRequest,
+    filter?: SharedContentFilter,
+  ): Promise<any> {
     const fullInstructions = await this.getGeneratorInstructions(contentType, generatorInstructions, filter);
 
     console.log('fullInstructions:', fullInstructions);
@@ -96,29 +101,34 @@ export class SharedContentController {
     return await this.rimoriClient.ai.getObject(fullInstructions);
   }
 
-  private async getGeneratorInstructions(contentType: string, generatorInstructions: ObjectRequest, filter?: SharedContentFilter): Promise<ObjectRequest> {
+  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. ",
-    }
+      type: 'string',
+      description: 'What the topic is about. Short. ',
+    };
     generatorInstructions.tool.keywords = {
-      type: [{ text: { type: "string" } }],
-      description: "Keywords around the topic of the assignment.",
-    }
+      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)")
+    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)
+      .is('deleted_at', null);
 
     if (filter) {
       query.contains('data', filter);
@@ -134,7 +144,13 @@ export class SharedContentController {
   }
 
   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();
+    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');
@@ -145,7 +161,7 @@ export class SharedContentController {
   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")
+      .from('shared_content_completed')
       .upsert({ content_type: contentType, id: assignmentId } as any, { onConflict: 'id' });
 
     if (error) {
@@ -172,11 +188,11 @@ export class SharedContentController {
     reaction,
     bookmarked,
   }: {
-    contentType: string
-    id: string
-    state?: 'completed' | 'ongoing' | 'hidden'
-    reaction?: 'liked' | 'disliked' | null
-    bookmarked?: boolean
+    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;
@@ -184,9 +200,7 @@ export class SharedContentController {
     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' });
+    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);
@@ -201,8 +215,17 @@ export class SharedContentController {
    * @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);
+  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);
@@ -229,14 +252,23 @@ export class SharedContentController {
    * @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();
+  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);
@@ -262,7 +294,11 @@ export class SharedContentController {
     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();
+    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);
@@ -284,7 +320,7 @@ export class SharedContentController {
    */
   public async removeSharedContent(id: string): Promise<SharedContent<any>> {
     const { data: deletedContent, error } = await this.supabase
-      .from("shared_content")
+      .from('shared_content')
       .update({ deleted_at: new Date().toISOString() })
       .eq('id', id)
       .select();
@@ -324,4 +360,4 @@ export interface SharedContent<T> {
 
   /** Whether this content should only be visible to the creator. Defaults to false if not specified */
   privateTopic?: boolean;
-}
+}

package/src/core/controller/VoiceController.ts

@@ -4,12 +4,14 @@ export async function getSTTResponse(backendUrl: string, audio: Blob, token: str
 
   return await fetch(`${backendUrl}/voice/stt`, {
     method: 'POST',
-    headers: { 'Authorization': `Bearer ${token}` },
+    headers: { Authorization: `Bearer ${token}` },
     body: formData,
-  }).then(r => r.json()).then(r => {
-    // console.log("STT response: ", r);
-    return r.text;
-  });
+  })
+    .then((r) => r.json())
+    .then((r) => {
+      // console.log("STT response: ", r);
+      return r.text;
+    });
 }
 
 export async function getTTSResponse(backendUrl: string, request: TTSRequest, token: string) {
@@ -17,10 +19,10 @@ export async function getTTSResponse(backendUrl: string, request: TTSRequest, to
     method: 'POST',
     headers: {
       'Content-Type': 'application/json',
-      'Authorization': `Bearer ${token}`
+      Authorization: `Bearer ${token}`,
     },
     body: JSON.stringify(request),
-  }).then(r => r.blob());
+  }).then((r) => r.blob());
 }
 
 interface TTSRequest {
@@ -28,4 +30,4 @@ interface TTSRequest {
   voice: string;
   speed: number;
   language?: string;
-}
+}

package/src/core/core.ts

@@ -1,17 +1,16 @@
 // Core functionality exports
-export * from "../fromRimori/PluginTypes";
-export * from "../plugin/PluginController";
-export * from "../plugin/RimoriClient";
-export * from "../utils/difficultyConverter";
-export * from "../utils/Language";
-export * from "../utils/PluginUtils";
-export * from "../worker/WorkerSetup";
-export { EventBusMessage } from "../fromRimori/EventBus";
-export { Buddy, UserInfo } from "./controller/SettingsController";
-export { SharedContent } from "./controller/SharedContentController";
-export { Exercise, TriggerAction } from "./controller/ExerciseController";
-export { Message, OnLLMResponse, ToolInvocation } from "./controller/AIController";
-export { MacroAccomplishmentPayload, MicroAccomplishmentPayload } from "../plugin/AccomplishmentHandler";
-export { Tool } from "../fromRimori/PluginTypes";
-export { SharedContentObjectRequest } from "./controller/SharedContentController";
-
+export * from '../fromRimori/PluginTypes';
+export * from '../plugin/PluginController';
+export * from '../plugin/RimoriClient';
+export * from '../utils/difficultyConverter';
+export * from '../utils/Language';
+export * from '../utils/PluginUtils';
+export * from '../worker/WorkerSetup';
+export { EventBusMessage } from '../fromRimori/EventBus';
+export { Buddy, UserInfo } from './controller/SettingsController';
+export { SharedContent } from './controller/SharedContentController';
+export { Exercise, TriggerAction } from './controller/ExerciseController';
+export { Message, OnLLMResponse, ToolInvocation } from './controller/AIController';
+export { MacroAccomplishmentPayload, MicroAccomplishmentPayload } from '../plugin/AccomplishmentHandler';
+export { Tool } from '../fromRimori/PluginTypes';
+export { SharedContentObjectRequest } from './controller/SharedContentController';