@rimori/client 1.1.9 → 1.1.10

package/dist/controller/SharedContentController.d.ts

@@ -1,15 +1,6 @@
 import { SupabaseClient } from '@supabase/supabase-js';
 import { RimoriClient } from "../plugin/RimoriClient";
 import { ObjectRequest } from "./ObjectController";
-export interface BasicAssignment<T> {
-    id: string;
-    createdAt: Date;
-    topic: string;
-    createdBy: string;
-    verified: boolean;
-    keywords: any;
-    data: T;
-}
 export interface SharedContentObjectRequest extends ObjectRequest {
     fixedProperties?: Record<string, string | number | boolean>;
 }
@@ -26,10 +17,10 @@ export declare class SharedContentController {
      * @param privateTopic - An optional flag to indicate if the topic should be private and only be visible to the user.
      * @returns The new shared content.
      */
-    getNewSharedContent<T>(contentType: string, generatorInstructions: SharedContentObjectRequest, filter?: SharedContentFilter, privateTopic?: boolean): Promise<BasicAssignment<T>>;
+    getNewSharedContent<T>(contentType: string, generatorInstructions: SharedContentObjectRequest, filter?: SharedContentFilter, privateTopic?: boolean): Promise<SharedContent<T>>;
     private getGeneratorInstructions;
     private getCompletedTopics;
-    getSharedContent<T>(contentType: string, id: string): Promise<BasicAssignment<T>>;
+    getSharedContent<T>(contentType: string, id: string): Promise<SharedContent<T>>;
     completeSharedContent(contentType: string, assignmentId: string): Promise<void>;
     /**
      * Fetch shared content from the database based on optional filters.
@@ -38,19 +29,19 @@ export declare class SharedContentController {
      * @param limit - Optional limit for the number of results.
      * @returns Array of shared content matching the criteria.
      */
-    getSharedContentList<T>(contentType: string, filter?: SharedContentFilter, limit?: number): Promise<BasicAssignment<T>[]>;
+    getSharedContentList<T>(contentType: string, filter?: SharedContentFilter, limit?: number): Promise<SharedContent<T>[]>;
     /**
      * Insert new shared content into the database.
      * @param param
      * @param param.contentType - The type of content to insert.
-     * @param param.topic - The topic of the content.
+     * @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.
      */
-    createSharedContent<T>({ contentType, topic, keywords, data, privateTopic }: Omit<SharedContent<T>, 'id'>): Promise<BasicAssignment<T>>;
+    createSharedContent<T>({ contentType, title, keywords, data, privateTopic }: Omit<SharedContent<T>, 'id'>): Promise<SharedContent<T>>;
     /**
      * Update existing shared content in the database.
      * @param id - The ID of the content to update.
@@ -58,14 +49,14 @@ export declare class SharedContentController {
      * @returns The updated shared content.
      * @throws {Error} if update fails.
      */
-    updateSharedContent<T>(id: string, updates: Partial<SharedContent<T>>): Promise<BasicAssignment<T>>;
+    updateSharedContent<T>(id: string, updates: Partial<SharedContent<T>>): Promise<SharedContent<T>>;
     /**
      * 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.
      */
-    removeSharedContent(id: string): Promise<BasicAssignment<any>>;
+    removeSharedContent(id: string): Promise<SharedContent<any>>;
 }
 /**
  * Interface representing shared content in the system.
@@ -76,8 +67,8 @@ export interface SharedContent<T> {
     id: string;
     /** The type/category of the content (e.g. 'grammar_exercises', 'flashcards', etc.) */
     contentType: string;
-    /** The human readable title/topic of the content */
-    topic: 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 */

package/dist/controller/SharedContentController.js

@@ -81,7 +81,7 @@ export class SharedContentController {
     getCompletedTopics(contentType, filter) {
         return __awaiter(this, void 0, void 0, function* () {
             const query = this.supabase.from("shared_content")
-                .select("topic, keywords, scc:shared_content_completed(id)")
+                .select("title, keywords, scc:shared_content_completed(id)")
                 .eq('content_type', contentType)
                 .not('scc.id', 'is', null)
                 .is('deleted_at', null);
@@ -93,7 +93,7 @@ export class SharedContentController {
                 console.error('error fetching old assignments:', error);
                 return [];
             }
-            return oldAssignments.map(({ topic, keywords }) => `${topic}(${keywords.join(',')})`);
+            return oldAssignments.map(({ title, keywords }) => `${title}(${keywords.join(',')})`);
         });
     }
     getSharedContent(contentType, id) {
@@ -136,7 +136,7 @@ export class SharedContentController {
      * Insert new shared content into the database.
      * @param param
      * @param param.contentType - The type of content to insert.
-     * @param param.topic - The topic of the content.
+     * @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.
@@ -144,11 +144,11 @@ export class SharedContentController {
      * @throws {Error} if insertion fails.
      */
     createSharedContent(_a) {
-        return __awaiter(this, arguments, void 0, function* ({ contentType, topic, keywords, data, privateTopic }) {
+        return __awaiter(this, arguments, void 0, function* ({ contentType, title, keywords, data, privateTopic }) {
             const { data: newContent, error } = yield this.supabase.from("shared_content").insert({
                 private: privateTopic,
                 content_type: contentType,
-                topic,
+                title,
                 keywords,
                 data,
             }).select();
@@ -171,8 +171,8 @@ export class SharedContentController {
             const updateData = {};
             if (updates.contentType)
                 updateData.content_type = updates.contentType;
-            if (updates.topic)
-                updateData.topic = updates.topic;
+            if (updates.title)
+                updateData.title = updates.title;
             if (updates.keywords)
                 updateData.keywords = updates.keywords;
             if (updates.data)

package/dist/core.d.ts

@@ -4,4 +4,4 @@ export * from "./utils/difficultyConverter";
 export * from "./utils/PluginUtils";
 export * from "./worker/WorkerSetup";
 export * from "./utils/Language";
-export { SharedContent, BasicAssignment } from "./controller/SharedContentController";
+export { SharedContent } from "./controller/SharedContentController";

package/dist/plugin/RimoriClient.d.ts

@@ -4,7 +4,7 @@ import { GenericSchema } from "@supabase/supabase-js/dist/module/lib/types";
 import { Message, OnLLMResponse, Tool } from "../controller/AIController";
 import { ObjectRequest } from "../controller/ObjectController";
 import { UserInfo } from "../controller/SettingsController";
-import { BasicAssignment, SharedContent, SharedContentFilter, SharedContentObjectRequest } from "../controller/SharedContentController";
+import { SharedContent, SharedContentFilter, SharedContentObjectRequest } from "../controller/SharedContentController";
 import { AccomplishmentPayload } from "./AccomplishmentHandler";
 import { EventBusMessage, EventHandler, EventPayload } from "./fromRimori/EventBus";
 import { Plugin } from "./fromRimori/PluginTypes";
@@ -135,7 +135,7 @@ export declare class RimoriClient {
              * @param id The id of the shared content item.
              * @returns The shared content item.
              */
-            get: <T = any>(contentType: string, id: string) => Promise<BasicAssignment<T>>;
+            get: <T = any>(contentType: string, id: string) => Promise<SharedContent<T>>;
             /**
              * Get a list of shared content items.
              * @param contentType The type of shared content to get. E.g. assignments, exercises, etc.
@@ -143,7 +143,7 @@ export declare class RimoriClient {
              * @param limit The optional limit for the number of results.
              * @returns The list of shared content items.
              */
-            getList: <T = any>(contentType: string, filter?: SharedContentFilter, limit?: number) => Promise<BasicAssignment<T>[]>;
+            getList: <T = any>(contentType: string, filter?: SharedContentFilter, limit?: number) => Promise<SharedContent<T>[]>;
             /**
              * Get new shared content.
              * @param contentType The type of shared content to fetch. E.g. assignments, exercises, etc.
@@ -152,20 +152,20 @@ export declare class RimoriClient {
              * @param privateTopic An optional flag to indicate if the topic should be private and only be visible to the user. This is useful if the topic is not meant to be shared with other users. Like for personal topics or if the content is based on the personal study goal.
              * @returns The new shared content.
              */
-            getNew: <T = any>(contentType: string, generatorInstructions: SharedContentObjectRequest, filter?: SharedContentFilter, privateTopic?: boolean) => Promise<BasicAssignment<T>>;
+            getNew: <T = any>(contentType: string, generatorInstructions: SharedContentObjectRequest, filter?: SharedContentFilter, privateTopic?: boolean) => Promise<SharedContent<T>>;
             /**
              * Create a new shared content item.
              * @param content The content to create.
              * @returns The new shared content item.
              */
-            create: <T = any>(content: Omit<SharedContent<T>, "id">) => Promise<BasicAssignment<T>>;
+            create: <T = any>(content: Omit<SharedContent<T>, "id">) => Promise<SharedContent<T>>;
             /**
              * Update a shared content item.
              * @param id The id of the shared content item to update.
              * @param content The content to update.
              * @returns The updated shared content item.
              */
-            update: <T = any>(id: string, content: Partial<SharedContent<T>>) => Promise<BasicAssignment<T>>;
+            update: <T = any>(id: string, content: Partial<SharedContent<T>>) => Promise<SharedContent<T>>;
             /**
               * Complete a shared content item.
               * @param contentType The type of shared content to complete. E.g. assignments, exercises, etc.
@@ -177,7 +177,7 @@ export declare class RimoriClient {
              * @param id The id of the shared content item to remove.
              * @returns The removed shared content item.
              */
-            remove: (id: string) => Promise<BasicAssignment<any>>;
+            remove: (id: string) => Promise<SharedContent<any>>;
         };
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rimori/client",
-  "version": "1.1.9",
+  "version": "1.1.10",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "exports": {

package/src/controller/SharedContentController.ts

@@ -2,16 +2,6 @@ import { SupabaseClient } from '@supabase/supabase-js';
 import { RimoriClient } from "../plugin/RimoriClient";
 import { ObjectRequest } from "./ObjectController";
 
-export interface BasicAssignment<T> {
-  id: string;
-  createdAt: Date;
-  topic: string;
-  createdBy: string;
-  verified: boolean;
-  keywords: any;
-  data: T;
-}
-
 export interface SharedContentObjectRequest extends ObjectRequest {
   fixedProperties?: Record<string, string | number | boolean>
 }
@@ -41,7 +31,7 @@ export class SharedContentController {
     //this filter is there if the content should be filtered additionally by a column and value
     filter?: SharedContentFilter,
     privateTopic?: boolean,
-  ): Promise<BasicAssignment<T>> {
+  ): Promise<SharedContent<T>> {
     const query = this.supabase.from("shared_content")
       .select("*, scc:shared_content_completed(id)")
       .eq('content_type', contentType)
@@ -111,7 +101,7 @@ export class SharedContentController {
 
   private async getCompletedTopics(contentType: string, filter?: SharedContentFilter): Promise<string[]> {
     const query = this.supabase.from("shared_content")
-      .select("topic, keywords, scc:shared_content_completed(id)")
+      .select("title, keywords, scc:shared_content_completed(id)")
       .eq('content_type', contentType)
       .not('scc.id', 'is', null)
       .is('deleted_at', null)
@@ -126,10 +116,10 @@ export class SharedContentController {
       console.error('error fetching old assignments:', error);
       return [];
     }
-    return oldAssignments.map(({ topic, keywords }) => `${topic}(${keywords.join(',')})`);
+    return oldAssignments.map(({ title, keywords }) => `${title}(${keywords.join(',')})`);
   }
 
-  public async getSharedContent<T>(contentType: string, id: string): Promise<BasicAssignment<T>> {
+  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);
@@ -149,7 +139,7 @@ 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<BasicAssignment<T>[]> {
+  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) {
@@ -170,18 +160,18 @@ export class SharedContentController {
    * Insert new shared content into the database.
    * @param param
    * @param param.contentType - The type of content to insert.
-   * @param param.topic - The topic of the content.
+   * @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, topic, keywords, data, privateTopic }: Omit<SharedContent<T>, 'id'>): Promise<BasicAssignment<T>> {
+  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,
-      topic,
+      title,
       keywords,
       data,
     }).select();
@@ -201,11 +191,11 @@ export class SharedContentController {
    * @returns The updated shared content.
    * @throws {Error} if update fails.
    */
-  public async updateSharedContent<T>(id: string, updates: Partial<SharedContent<T>>): Promise<BasicAssignment<T>> {
+  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.topic) updateData.topic = updates.topic;
+    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;
@@ -230,7 +220,7 @@ export class SharedContentController {
    * @returns The deleted shared content record.
    * @throws {Error} if deletion fails or content not found.
    */
-  public async removeSharedContent(id: string): Promise<BasicAssignment<any>> {
+  public async removeSharedContent(id: string): Promise<SharedContent<any>> {
     const { data: deletedContent, error } = await this.supabase
       .from("shared_content")
       .update({ deleted_at: new Date().toISOString() })
@@ -261,8 +251,8 @@ export interface SharedContent<T> {
   /** The type/category of the content (e.g. 'grammar_exercises', 'flashcards', etc.) */
   contentType: string;
 
-  /** The human readable title/topic of the content */
-  topic: string;
+  /** The human readable title of the content */
+  title: string;
 
   /** Array of keywords/tags associated with the content for search and categorization */
   keywords: string[];

package/src/core.ts

@@ -5,4 +5,4 @@ export * from "./utils/difficultyConverter";
 export * from "./utils/PluginUtils";
 export * from "./worker/WorkerSetup";
 export * from "./utils/Language";
-export { SharedContent, BasicAssignment } from "./controller/SharedContentController";
+export { SharedContent } from "./controller/SharedContentController";

package/src/plugin/RimoriClient.ts

@@ -4,7 +4,7 @@ import { GenericSchema } from "@supabase/supabase-js/dist/module/lib/types";
 import { generateText, Message, OnLLMResponse, streamChatGPT, Tool } from "../controller/AIController";
 import { generateObject as generateObjectFunction, ObjectRequest } from "../controller/ObjectController";
 import { SettingsController, UserInfo } from "../controller/SettingsController";
-import { BasicAssignment, SharedContent, SharedContentController, SharedContentFilter, SharedContentObjectRequest } from "../controller/SharedContentController";
+import { SharedContent, SharedContentController, SharedContentFilter, SharedContentObjectRequest } from "../controller/SharedContentController";
 import { getPlugins } from "../controller/SidePluginController";
 import { getSTTResponse, getTTSResponse } from "../controller/VoiceController";
 import { AccomplishmentHandler, AccomplishmentPayload } from "./AccomplishmentHandler";
@@ -240,7 +240,7 @@ export class RimoriClient {
        * @param id The id of the shared content item.
        * @returns The shared content item.
        */
-      get: async <T = any>(contentType: string, id: string): Promise<BasicAssignment<T>> => {
+      get: async <T = any>(contentType: string, id: string): Promise<SharedContent<T>> => {
         return await this.sharedContentController.getSharedContent(contentType, id);
       },
       /**
@@ -250,7 +250,7 @@ export class RimoriClient {
        * @param limit The optional limit for the number of results.
        * @returns The list of shared content items.
        */
-      getList: async <T = any>(contentType: string, filter?: SharedContentFilter, limit?: number): Promise<BasicAssignment<T>[]> => {
+      getList: async <T = any>(contentType: string, filter?: SharedContentFilter, limit?: number): Promise<SharedContent<T>[]> => {
         return await this.sharedContentController.getSharedContentList(contentType, filter, limit);
       },
       /**
@@ -266,7 +266,7 @@ export class RimoriClient {
         generatorInstructions: SharedContentObjectRequest,
         filter?: SharedContentFilter,
         privateTopic?: boolean,
-      ): Promise<BasicAssignment<T>> => {
+      ): Promise<SharedContent<T>> => {
         return await this.sharedContentController.getNewSharedContent(contentType, generatorInstructions, filter, privateTopic);
       },
       /**
@@ -274,7 +274,7 @@ export class RimoriClient {
        * @param content The content to create.
        * @returns The new shared content item.
        */
-      create: async <T = any>(content: Omit<SharedContent<T>, 'id'>): Promise<BasicAssignment<T>> => {
+      create: async <T = any>(content: Omit<SharedContent<T>, 'id'>): Promise<SharedContent<T>> => {
         return await this.sharedContentController.createSharedContent(content);
       },
       /**
@@ -283,7 +283,7 @@ export class RimoriClient {
        * @param content The content to update.
        * @returns The updated shared content item.
        */
-      update: async <T = any>(id: string, content: Partial<SharedContent<T>>): Promise<BasicAssignment<T>> => {
+      update: async <T = any>(id: string, content: Partial<SharedContent<T>>): Promise<SharedContent<T>> => {
         return await this.sharedContentController.updateSharedContent(id, content);
       },
       /**
@@ -299,7 +299,7 @@ export class RimoriClient {
        * @param id The id of the shared content item to remove.
        * @returns The removed shared content item.
        */
-      remove: async (id: string): Promise<BasicAssignment<any>> => {
+      remove: async (id: string): Promise<SharedContent<any>> => {
         return await this.sharedContentController.removeSharedContent(id);
       }
     }