@rimori/client 1.1.2 → 1.1.4

package/README.md

@@ -857,6 +857,27 @@ interface MyPluginData extends SharedContent<any> {
 }
 ```
 
+The SharedContent has this type definition:
+
+````
+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;
+
+  /** 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;
+}
+```
+
 ## Examples
 
 ### Complete Plugin Example

package/dist/controller/SharedContentController.d.ts

@@ -59,11 +59,27 @@ export declare class SharedContentController {
      * @throws {Error} if update fails.
      */
     updateSharedContent<T>(id: string, updates: Partial<SharedContent<T>>): Promise<BasicAssignment<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.
+     */
+    deleteSharedContent(id: string): Promise<BasicAssignment<any>>;
 }
+/**
+ * Interface representing shared content in the system.
+ * @template T The type of data stored in the content
+ */
 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;
+    /** 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;
 }

package/dist/controller/SharedContentController.js

@@ -28,6 +28,7 @@ export class SharedContentController {
                 .select("*, scc:shared_content_completed(id)")
                 .eq('content_type', contentType)
                 .is('scc.id', null)
+                .is('deleted_at', null)
                 .limit(10);
             if (filter) {
                 query.contains('data', filter);
@@ -82,7 +83,8 @@ export class SharedContentController {
             const query = this.supabase.from("shared_content")
                 .select("topic, keywords, scc:shared_content_completed(id)")
                 .eq('content_type', contentType)
-                .not('scc.id', 'is', null);
+                .not('scc.id', 'is', null)
+                .is('deleted_at', null);
             if (filter) {
                 query.contains('data', filter);
             }
@@ -96,7 +98,7 @@ export class SharedContentController {
     }
     getSharedContent(contentType, id) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { data, error } = yield this.supabase.from("shared_content").select().eq('content_type', contentType).eq('id', id).single();
+            const { data, error } = yield 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');
@@ -118,7 +120,7 @@ export class SharedContentController {
      */
     getSharedContentList(contentType, filter, limit) {
         return __awaiter(this, void 0, void 0, function* () {
-            const query = this.supabase.from("shared_content").select("*").eq('content_type', contentType).limit(limit !== null && limit !== void 0 ? limit : 30);
+            const query = this.supabase.from("shared_content").select("*").eq('content_type', contentType).is('deleted_at', null).limit(limit !== null && limit !== void 0 ? limit : 30);
             if (filter) {
                 query.contains('data', filter);
             }
@@ -188,4 +190,27 @@ export class SharedContentController {
             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.
+     */
+    deleteSharedContent(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data: deletedContent, error } = yield 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];
+        });
+    }
 }

package/dist/core.d.ts

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

package/dist/plugin/RimoriClient.d.ts

@@ -172,6 +172,12 @@ export declare class RimoriClient {
               * @param assignmentId The id of the shared content item to complete.
               */
             complete: (contentType: string, assignmentId: string) => Promise<void>;
+            /**
+             * Delete a shared content item.
+             * @param id The id of the shared content item to delete.
+             * @returns The deleted shared content item.
+             */
+            delete: (id: string) => Promise<BasicAssignment<any>>;
         };
     };
 }

package/dist/plugin/RimoriClient.js

@@ -176,6 +176,14 @@ export class RimoriClient {
                   */
                 complete: (contentType, assignmentId) => __awaiter(this, void 0, void 0, function* () {
                     return yield this.sharedContentController.completeSharedContent(contentType, assignmentId);
+                }),
+                /**
+                 * Delete a shared content item.
+                 * @param id The id of the shared content item to delete.
+                 * @returns The deleted shared content item.
+                 */
+                delete: (id) => __awaiter(this, void 0, void 0, function* () {
+                    return yield this.sharedContentController.deleteSharedContent(id);
                 })
             }
         };

package/package.json

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

package/src/controller/SharedContentController.ts

@@ -46,6 +46,7 @@ export class SharedContentController {
       .select("*, scc:shared_content_completed(id)")
       .eq('content_type', contentType)
       .is('scc.id', null)
+      .is('deleted_at', null)
       .limit(10);
 
     if (filter) {
@@ -113,6 +114,7 @@ export class SharedContentController {
       .select("topic, 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);
@@ -128,7 +130,7 @@ export class SharedContentController {
   }
 
   public async getSharedContent<T>(contentType: string, id: string): Promise<BasicAssignment<T>> {
-    const { data, error } = await this.supabase.from("shared_content").select().eq('content_type', contentType).eq('id', id).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');
@@ -148,7 +150,7 @@ export class SharedContentController {
    * @returns Array of shared content matching the criteria.
    */
   public async getSharedContentList<T>(contentType: string, filter?: SharedContentFilter, limit?: number): Promise<BasicAssignment<T>[]> {
-    const query = this.supabase.from("shared_content").select("*").eq('content_type', contentType).limit(limit ?? 30);
+    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);
@@ -221,12 +223,50 @@ export class SharedContentController {
 
     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 deleteSharedContent(id: string): Promise<BasicAssignment<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 type/category of the content (e.g. 'grammar_exercises', 'flashcards', etc.) */
   contentType: string;
+
+  /** The human readable title/topic of the content */
   topic: 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;
 }

package/src/core.ts

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

package/src/plugin/RimoriClient.ts

@@ -293,6 +293,14 @@ export class RimoriClient {
         */
       complete: async (contentType: string, assignmentId: string) => {
         return await this.sharedContentController.completeSharedContent(contentType, assignmentId);
+      },
+      /**
+       * Delete a shared content item.
+       * @param id The id of the shared content item to delete.
+       * @returns The deleted shared content item.
+       */
+      delete: async (id: string): Promise<BasicAssignment<any>> => {
+        return await this.sharedContentController.deleteSharedContent(id);
       }
     }
   }