@rimori/client 2.1.7 → 2.2.0

package/dist/cli/types/DatabaseTypes.d.ts

@@ -42,8 +42,10 @@ export interface DbColumnDefinition {
     restrict?: {
         /** Restrictions for the user */
         user: Partial<Omit<DbPermissionDefinition, 'delete'>>;
-        /** Restrictions for the moderator */
-        moderator?: Partial<Omit<DbPermissionDefinition, 'delete'>>;
+        /** Restrictions for the guild moderator */
+        guild_moderator?: Partial<Omit<DbPermissionDefinition, 'delete'>>;
+        /** Restrictions for the language moderator */
+        lang_moderator?: Partial<Omit<DbPermissionDefinition, 'delete'>>;
     };
 }
 /**
@@ -69,8 +71,12 @@ export interface DbTableDefinition {
     description: string;
     /** Permissions for the table */
     permissions: {
+        /** Permissions for the user */
         user: DbPermissionDefinition;
-        moderator?: DbPermissionDefinition;
+        /** Permissions for the guild moderator */
+        guild_moderator?: DbPermissionDefinition;
+        /** Permissions for the language moderator */
+        lang_moderator?: DbPermissionDefinition;
     };
     /** Column definitions for the table */
     columns: {
@@ -81,11 +87,13 @@ export interface DbTableDefinition {
  * Permission definition for a database table.
  * NONE means the action is not allowed.
  * OWN means only do the action on your own records.
+ * GUILD means do the action on all records in the guild.
+ * LANG means do the action on all records in the language.
  * ALL means do the action on all records.
  *
  * Defines the permissions for a database table.
  */
-export type DbPermission = 'NONE' | 'OWN' | 'ALL';
+export type DbPermission = 'NONE' | 'OWN' | 'GUILD' | 'LANG' | 'ALL';
 /**
  * Permission definition for a database table.
  * Defines the permissions for a database table.

package/dist/controller/AccomplishmentController.js

@@ -6,7 +6,9 @@ export class AccomplishmentController {
     }
     emitAccomplishment(payload) {
         const accomplishmentPayload = Object.assign(Object.assign({}, payload), { type: 'durationMinutes' in payload ? 'macro' : 'micro' });
-        this.validateAccomplishment(accomplishmentPayload);
+        if (!this.validateAccomplishment(accomplishmentPayload)) {
+            return;
+        }
         const sanitizedPayload = this.sanitizeAccomplishment(accomplishmentPayload);
         const topic = 'global.accomplishment.trigger' + (accomplishmentPayload.type === 'macro' ? 'Macro' : 'Micro');
         EventBus.emit(this.pluginId, topic, sanitizedPayload);
@@ -29,7 +31,8 @@ export class AccomplishmentController {
         }
         //durationMinutes is required
         if (payload.type === 'macro' && payload.durationMinutes < 4) {
-            throw new Error('The duration must be at least 4 minutes');
+            console.warn('The duration must be at least 4 minutes');
+            return false;
         }
         //errorRatio is required
         if (payload.type === 'macro' && (payload.errorRatio < 0 || payload.errorRatio > 1)) {
@@ -43,6 +46,7 @@ export class AccomplishmentController {
                 }
             });
         }
+        return true;
     }
     sanitizeAccomplishment(payload) {
         var _a;

package/dist/controller/SharedContentController.js

@@ -28,31 +28,34 @@ export class SharedContentController {
     //this filter is there if the content should be filtered additionally by a column and value
     filter, options) {
         return __awaiter(this, void 0, void 0, function* () {
-            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 === null || options === void 0 ? void 0 : options.excludeIds) && options.excludeIds.length > 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 } = yield 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 === null || options === void 0 ? void 0 : options.alwaysGenerateNew) && newAssignments.length > 0) {
-                const index = Math.floor(Math.random() * newAssignments.length);
-                return newAssignments[index];
-            }
+            // 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 = yield this.generateNewAssignment(contentType, generatorInstructions, filter);
             console.log('instructions:', instructions);
             //create the shared content object

package/dist/fromRimori/PluginTypes.d.ts

@@ -31,7 +31,7 @@ export interface MenuEntry {
     plugin_id: string;
     action_key: string;
     text: string;
-    icon?: React.ReactNode;
+    iconUrl?: string;
 }
 export type MainPanelAction = {
     plugin_id: string;

package/dist/plugin/CommunicationHandler.d.ts

@@ -2,9 +2,16 @@ import { SupabaseClient } from '@supabase/supabase-js';
 import { UserInfo } from '../controller/SettingsController';
 import { ActivePlugin, Plugin } from '../fromRimori/PluginTypes';
 export interface Guild {
-    id: string;
-    longTermGoalOverride: string;
     allowUserPluginSettings: boolean;
+    city: string | null;
+    country: string | null;
+    description: string | null;
+    id: string;
+    isPublic: boolean;
+    name: string;
+    ownerId: string;
+    primaryLanguage: string;
+    scope: string;
 }
 export interface RimoriInfo {
     url: string;
@@ -19,6 +26,7 @@ export interface RimoriInfo {
     profile: UserInfo;
     mainPanelPlugin?: ActivePlugin;
     sidePanelPlugin?: ActivePlugin;
+    interfaceLanguage: string;
 }
 export declare class RimoriCommunicationHandler {
     private port;

package/dist/plugin/RimoriClient.d.ts

@@ -131,7 +131,8 @@ export declare class RimoriClient {
          * @param text Optional text to be used for the action like for example text that the translator would look up.
          */
         emitSidebarAction: (pluginId: string, actionKey: string, text?: string) => void;
-        onMainPanelAction: (callback: (data: MainPanelAction) => void, actionsToListen?: string[]) => void;
+        onMainPanelAction: (callback: (data: MainPanelAction) => void, actionsToListen?: string | string[]) => void;
+        onSidePanelAction: (callback: (data: MainPanelAction) => void, actionsToListen?: string | string[]) => void;
     };
     navigation: {
         toDashboard: () => void;

package/dist/plugin/RimoriClient.js

@@ -97,10 +97,25 @@ export class RimoriClient {
                 this.event.emit('global.sidebar.triggerAction', { plugin_id: pluginId, action_key: actionKey, text });
             },
             onMainPanelAction: (callback, actionsToListen = []) => {
+                const listeningActions = Array.isArray(actionsToListen) ? actionsToListen : [actionsToListen];
                 // this needs to be a emit and on because the main panel action is triggered by the user and not by the plugin
                 this.event.emit('action.requestMain');
                 this.event.on('action.requestMain', ({ data }) => {
-                    if (actionsToListen.includes(data.action)) {
+                    console.log('Received action ' + data.action);
+                    console.log('Listening to actions', listeningActions);
+                    if (actionsToListen.length === 0 || actionsToListen.includes(data.action)) {
+                        callback(data);
+                    }
+                });
+            },
+            onSidePanelAction: (callback, actionsToListen = []) => {
+                const listeningActions = Array.isArray(actionsToListen) ? actionsToListen : [actionsToListen];
+                // this needs to be a emit and on because the main panel action is triggered by the user and not by the plugin
+                this.event.emit('action.requestSidebar');
+                this.event.on('action.requestSidebar', ({ data }) => {
+                    console.log('Received action ' + data.action);
+                    console.log('Listening to actions', listeningActions);
+                    if (actionsToListen.length === 0 || actionsToListen.includes(data.action)) {
                         callback(data);
                     }
                 });
@@ -261,7 +276,7 @@ export class RimoriClient {
         this.accomplishmentHandler = new AccomplishmentController(info.pluginId);
         this.settingsController = new SettingsController(supabase, info.pluginId, info.guild);
         this.sharedContentController = new SharedContentController(supabase, this);
-        this.translator = new Translator(info.profile.mother_tongue.code);
+        this.translator = new Translator(info.interfaceLanguage);
         //only init logger in workers and on main plugin pages
         if (this.getQueryParam('applicationMode') !== 'sidebar') {
             Logger.getInstance(this);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rimori/client",
-  "version": "2.1.7",
+  "version": "2.2.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "bin": {

package/src/cli/types/DatabaseTypes.ts

@@ -3,14 +3,7 @@
 /**
  * Supported database column data types for table schema definitions.
  */
-type DbColumnType =
-  | 'decimal'
-  | 'integer'
-  | 'text'
-  | 'boolean'
-  | 'json'
-  | 'timestamp'
-  | 'uuid';
+type DbColumnType = 'decimal' | 'integer' | 'text' | 'boolean' | 'json' | 'timestamp' | 'uuid';
 
 /**
  * Foreign key relationship configuration with cascade delete support.
@@ -55,10 +48,12 @@ export interface DbColumnDefinition {
   restrict?: {
     /** Restrictions for the user */
     user: Partial<Omit<DbPermissionDefinition, 'delete'>>;
-    /** Restrictions for the moderator */
-    moderator?: Partial<Omit<DbPermissionDefinition, 'delete'>>;
+    /** Restrictions for the guild moderator */
+    guild_moderator?: Partial<Omit<DbPermissionDefinition, 'delete'>>;
+    /** Restrictions for the language moderator */
+    lang_moderator?: Partial<Omit<DbPermissionDefinition, 'delete'>>;
     /** Restrictions for the maintainer */
-    // maintainer?: Partial<DbPermissionDefinition>,
+    // maintainer?: Partial<Omit<DbPermissionDefinition, 'delete'>>;
   };
 }
 
@@ -86,9 +81,14 @@ export interface DbTableDefinition {
   description: string;
   /** Permissions for the table */
   permissions: {
+    /** Permissions for the user */
     user: DbPermissionDefinition;
-    moderator?: DbPermissionDefinition;
-    // maintainer?: DbPermissionDefinition,
+    /** Permissions for the guild moderator */
+    guild_moderator?: DbPermissionDefinition;
+    /** Permissions for the language moderator */
+    lang_moderator?: DbPermissionDefinition;
+    /** Permissions for the maintainer */
+    // maintainer?: DbPermissionDefinition;
   };
   /** Column definitions for the table */
   columns: {
@@ -100,11 +100,13 @@ export interface DbTableDefinition {
  * Permission definition for a database table.
  * NONE means the action is not allowed.
  * OWN means only do the action on your own records.
+ * GUILD means do the action on all records in the guild.
+ * LANG means do the action on all records in the language.
  * ALL means do the action on all records.
  *
  * Defines the permissions for a database table.
  */
-export type DbPermission = 'NONE' | 'OWN' | 'ALL';
+export type DbPermission = 'NONE' | 'OWN' | 'GUILD' | 'LANG' | 'ALL';
 
 /**
  * Permission definition for a database table.
@@ -120,5 +122,4 @@ export interface DbPermissionDefinition {
 /**
  * Full table definition that includes automatically generated fields.
  */
-export type FullTable<T extends Record<string, DbColumnDefinition>> = T &
-  BaseTableStructure;
+export type FullTable<T extends Record<string, DbColumnDefinition>> = T & BaseTableStructure;

package/src/controller/AccomplishmentController.ts

@@ -49,7 +49,9 @@ export class AccomplishmentController {
       type: 'durationMinutes' in payload ? 'macro' : 'micro',
     } as AccomplishmentPayload;
 
-    this.validateAccomplishment(accomplishmentPayload);
+    if (!this.validateAccomplishment(accomplishmentPayload)) {
+      return;
+    }
 
     const sanitizedPayload = this.sanitizeAccomplishment(accomplishmentPayload);
 
@@ -58,7 +60,7 @@ export class AccomplishmentController {
     EventBus.emit(this.pluginId, topic, sanitizedPayload);
   }
 
-  private validateAccomplishment(payload: AccomplishmentPayload) {
+  private validateAccomplishment(payload: AccomplishmentPayload): boolean {
     if (!skillCategories.includes(payload.skillCategory)) {
       throw new Error(`Invalid skill category: ${payload.skillCategory}`);
     }
@@ -82,7 +84,8 @@ export class AccomplishmentController {
 
     //durationMinutes is required
     if (payload.type === 'macro' && payload.durationMinutes < 4) {
-      throw new Error('The duration must be at least 4 minutes');
+      console.warn('The duration must be at least 4 minutes');
+      return false;
     }
 
     //errorRatio is required
@@ -98,6 +101,7 @@ export class AccomplishmentController {
         }
       });
     }
+    return true;
   }
 
   private sanitizeAccomplishment(payload: AccomplishmentPayload) {

package/src/controller/SharedContentController.ts

@@ -36,38 +36,40 @@ export class SharedContentController {
     filter?: SharedContentFilter,
     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)')
-      .eq('content_type', contentType)
-      .not('scc.state', 'in', '("completed","ongoing","hidden")')
-      .is('deleted_at', null);
-
-    if (options?.excludeIds && options.excludeIds.length > 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];
-    }
-
+    // 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);

package/src/fromRimori/PluginTypes.ts

@@ -49,7 +49,7 @@ export interface MenuEntry {
   // text of the menu entry. Shown in the context menu
   text: string;
   // icon of the menu entry. Shown in the context menu
-  icon?: React.ReactNode;
+  iconUrl?: string;
 }
 
 // an action from the main panel that can be triggered and performs an action in the main panel

package/src/plugin/CommunicationHandler.ts

@@ -7,9 +7,16 @@ import { ActivePlugin, Plugin } from '../fromRimori/PluginTypes';
 declare const WorkerGlobalScope: any;
 
 export interface Guild {
-  id: string;
-  longTermGoalOverride: string;
   allowUserPluginSettings: boolean;
+  city: string | null;
+  country: string | null;
+  description: string | null;
+  id: string;
+  isPublic: boolean;
+  name: string;
+  ownerId: string;
+  primaryLanguage: string;
+  scope: string;
 }
 
 export interface RimoriInfo {
@@ -25,6 +32,7 @@ export interface RimoriInfo {
   profile: UserInfo;
   mainPanelPlugin?: ActivePlugin;
   sidePanelPlugin?: ActivePlugin;
+  interfaceLanguage: string;
 }
 
 export class RimoriCommunicationHandler {

package/src/plugin/RimoriClient.ts

@@ -43,7 +43,7 @@ export class RimoriClient {
     this.accomplishmentHandler = new AccomplishmentController(info.pluginId);
     this.settingsController = new SettingsController(supabase, info.pluginId, info.guild);
     this.sharedContentController = new SharedContentController(supabase, this);
-    this.translator = new Translator(info.profile.mother_tongue.code);
+    this.translator = new Translator(info.interfaceLanguage);
 
     //only init logger in workers and on main plugin pages
     if (this.getQueryParam('applicationMode') !== 'sidebar') {
@@ -238,11 +238,27 @@ export class RimoriClient {
       this.event.emit('global.sidebar.triggerAction', { plugin_id: pluginId, action_key: actionKey, text });
     },
 
-    onMainPanelAction: (callback: (data: MainPanelAction) => void, actionsToListen: string[] = []) => {
+    onMainPanelAction: (callback: (data: MainPanelAction) => void, actionsToListen: string | string[] = []) => {
+      const listeningActions = Array.isArray(actionsToListen) ? actionsToListen : [actionsToListen];
       // this needs to be a emit and on because the main panel action is triggered by the user and not by the plugin
       this.event.emit('action.requestMain');
       this.event.on<MainPanelAction>('action.requestMain', ({ data }) => {
-        if (actionsToListen.includes(data.action)) {
+        console.log('Received action ' + data.action);
+        console.log('Listening to actions', listeningActions);
+        if (actionsToListen.length === 0 || actionsToListen.includes(data.action)) {
+          callback(data);
+        }
+      });
+    },
+
+    onSidePanelAction: (callback: (data: MainPanelAction) => void, actionsToListen: string | string[] = []) => {
+      const listeningActions = Array.isArray(actionsToListen) ? actionsToListen : [actionsToListen];
+      // this needs to be a emit and on because the main panel action is triggered by the user and not by the plugin
+      this.event.emit('action.requestSidebar');
+      this.event.on<MainPanelAction>('action.requestSidebar', ({ data }) => {
+        console.log('Received action ' + data.action);
+        console.log('Listening to actions', listeningActions);
+        if (actionsToListen.length === 0 || actionsToListen.includes(data.action)) {
           callback(data);
         }
       });