@rimori/client 1.1.2 → 1.1.3

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

@@ -60,10 +60,19 @@ export declare class SharedContentController {
      */
     updateSharedContent<T>(id: string, updates: Partial<SharedContent<T>>): Promise<BasicAssignment<T>>;
 }
+/**
+ * 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/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/package.json

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

package/src/controller/SharedContentController.ts

@@ -223,10 +223,23 @@ export class SharedContentController {
   }
 }
 
+/**
+ * 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";