feat: class-based plugin manager

Author: louis-jan

core/core.ts

@@ -7,7 +7,23 @@
  * @returns   Promise<any>
  *
  */
-const invokePluginFunc: (plugin: string, method: string, ...args: any[]) => Promise<any> = (plugin, method, ...args) =>
+const executeOnMain: (
+  plugin: string,
+  method: string,
+  ...args: any[]
+) => Promise<any> = (plugin, method, ...args) =>
+  window.coreAPI?.invokePluginFunc(plugin, method, ...args) ??
+  window.electronAPI?.invokePluginFunc(plugin, method, ...args);
+
+/**
+ * @deprecated This object is deprecated and should not be used.
+ * Use individual functions instead.
+ */
+const invokePluginFunc: (
+  plugin: string,
+  method: string,
+  ...args: any[]
+) => Promise<any> = (plugin, method, ...args) =>
   window.coreAPI?.invokePluginFunc(plugin, method, ...args) ??
   window.electronAPI?.invokePluginFunc(plugin, method, ...args);
 
@@ -17,8 +33,12 @@ const invokePluginFunc: (plugin: string, method: string, ...args: any[]) => Prom
  * @param {string} fileName - The name to use for the downloaded file.
  * @returns {Promise<any>} A promise that resolves when the file is downloaded.
  */
-const downloadFile: (url: string, fileName: string) => Promise<any> = (url, fileName) =>
-  window.coreAPI?.downloadFile(url, fileName) ?? window.electronAPI?.downloadFile(url, fileName);
+const downloadFile: (url: string, fileName: string) => Promise<any> = (
+  url,
+  fileName
+) =>
+  window.coreAPI?.downloadFile(url, fileName) ??
+  window.electronAPI?.downloadFile(url, fileName);
 
 /**
  * Deletes a file from the local file system.
@@ -51,6 +71,7 @@ export type RegisterExtensionPoint = (
  */
 export const core = {
   invokePluginFunc,
+  executeOnMain,
   downloadFile,
   deleteFile,
   appDataPath,
@@ -59,4 +80,10 @@ export const core = {
 /**
  * Functions exports
  */
-export { invokePluginFunc, downloadFile, deleteFile, appDataPath };
+export {
+  invokePluginFunc,
+  executeOnMain,
+  downloadFile,
+  deleteFile,
+  appDataPath,
+};

core/events.ts

@@ -6,12 +6,16 @@ export enum EventName {
   OnNewMessageRequest = "onNewMessageRequest",
   OnNewMessageResponse = "onNewMessageResponse",
   OnMessageResponseUpdate = "onMessageResponseUpdate",
-  OnMessageResponseFinished = "OnMessageResponseFinished",
+  OnMessageResponseFinished = "onMessageResponseFinished",
   OnDownloadUpdate = "onDownloadUpdate",
   OnDownloadSuccess = "onDownloadSuccess",
   OnDownloadError = "onDownloadError",
 }
 
+export type MessageHistory = {
+  role: string;
+  content: string;
+};
 /**
  * The `NewMessageRequest` type defines the shape of a new message request object.
  */
@@ -23,6 +27,7 @@ export type NewMessageRequest = {
   message?: string;
   createdAt?: string;
   updatedAt?: string;
+  history?: MessageHistory[];
 };
 
 /**

core/fs.ts

@@ -0,0 +1,49 @@
+/**
+ * Writes data to a file at the specified path.
+ * @param {string} path - The path to the file.
+ * @param {string} data - The data to write to the file.
+ * @returns {Promise<any>} A Promise that resolves when the file is written successfully.
+ */
+const writeFile: (path: string, data: string) => Promise<any> = (path, data) =>
+  window.coreAPI?.writeFile(path, data) ??
+  window.electronAPI?.writeFile(path, data);
+
+/**
+ * Reads the contents of a file at the specified path.
+ * @param {string} path - The path of the file to read.
+ * @returns {Promise<any>} A Promise that resolves with the contents of the file.
+ */
+const readFile: (path: string) => Promise<any> = (path) =>
+  window.coreAPI?.readFile(path) ?? window.electronAPI?.readFile(path);
+
+/**
+ * List the directory files
+ * @param {string} path - The path of the directory to list files.
+ * @returns {Promise<any>} A Promise that resolves with the contents of the directory.
+ */
+const listFiles: (path: string) => Promise<any> = (path) =>
+  window.coreAPI?.listFiles(path) ?? window.electronAPI?.listFiles(path);
+
+/**
+ * Creates a directory at the specified path.
+ * @param {string} path - The path of the directory to create.
+ * @returns {Promise<any>} A Promise that resolves when the directory is created successfully.
+ */
+const mkdir: (path: string) => Promise<any> = (path) =>
+  window.coreAPI?.mkdir(path) ?? window.electronAPI?.mkdir(path);
+
+/**
+ * Deletes a file from the local file system.
+ * @param {string} path - The path of the file to delete.
+ * @returns {Promise<any>} A Promise that resolves when the file is deleted.
+ */
+const deleteFile: (path: string) => Promise<any> = (path) =>
+  window.coreAPI?.deleteFile(path) ?? window.electronAPI?.deleteFile(path);
+
+export const fs = {
+  writeFile,
+  readFile,
+  listFiles,
+  mkdir,
+  deleteFile,
+};

core/index.ts

@@ -67,46 +67,6 @@ export enum StoreService {
  * @enum {string}
  */
 export enum DataService {
-  /**
-   * Gets a list of conversations.
-   */
-  GetConversations = "getConversations",
-
-  /**
-   * Creates a new conversation.
-   */
-  CreateConversation = "createConversation",
-
-  /**
-   * Updates an existing conversation.
-   */
-  UpdateConversation = "updateConversation",
-
-  /**
-   * Deletes an existing conversation.
-   */
-  DeleteConversation = "deleteConversation",
-
-  /**
-   * Creates a new message in an existing conversation.
-   */
-  CreateMessage = "createMessage",
-
-  /**
-   * Updates an existing message in an existing conversation.
-   */
-  UpdateMessage = "updateMessage",
-
-  /**
-   * Gets a list of messages for an existing conversation.
-   */
-  GetConversationMessages = "getConversationMessages",
-
-  /**
-   * Gets a conversation matching an ID.
-   */
-  GetConversationById = "getConversationById",
-
   /**
    * Creates a new conversation using the prompt instruction.
    */
@@ -131,11 +91,6 @@ export enum DataService {
    * Updates a bot matching an ID.
    */
   UpdateBot = "updateBot",
-
-  /**
-   * Gets the plugin manifest.
-   */
-  GetPluginManifest = "getPluginManifest",
 }
 
 /**
@@ -283,6 +238,7 @@ export {
   RegisterExtensionPoint,
   deleteFile,
   downloadFile,
+  executeOnMain,
   invokePluginFunc,
 } from "./core";
 
@@ -295,10 +251,19 @@ export {
   EventName,
   NewMessageRequest,
   NewMessageResponse,
+  MessageHistory,
 } from "./events";
 
 /**
  * Preferences module exports.
  * @module
  */
 export { preferences } from "./preferences";
+export { fs } from "./fs";
+
+export { JanPlugin, PluginType } from "./plugin";
+export {
+  ConversationalPlugin,
+  Conversation,
+  Message,
+} from "./plugins/conversational";

core/plugin.ts

@@ -0,0 +1,12 @@
+export enum PluginType {
+  Conversational = "conversational",
+  Inference = "inference",
+  Preference = "preference",
+  SystemMonitoring = "systemMonitoring",
+}
+
+export abstract class JanPlugin {
+  abstract type(): PluginType;
+  abstract onLoad(): void;
+  abstract onUnload(): void;
+}

core/plugins/conversational.ts

@@ -0,0 +1,26 @@
+import { JanPlugin, PluginType } from "../plugin";
+
+export interface Conversation {
+  _id: string;
+  modelId?: string;
+  botId?: string;
+  name: string;
+  message?: string;
+  summary?: string;
+  createdAt?: string;
+  updatedAt?: string;
+  messages: Message[];
+}
+export interface Message {
+  message?: string;
+  user?: string;
+  _id: string;
+  createdAt?: string;
+  updatedAt?: string;
+}
+
+export abstract class ConversationalPlugin extends JanPlugin {
+  abstract getConversations(): Promise<any[]>;
+  abstract saveConversation(conversation: Conversation): Promise<void>;
+  abstract deleteConversation(conversationId: string): Promise<void>;
+}

electron/handlers/fs.ts

@@ -0,0 +1,96 @@
+import { app, ipcMain } from "electron";
+import * as fs from "fs";
+import { join } from "path";
+
+/**
+ * Handles file system operations.
+ */
+export function handleFs() {
+  /**
+   * Reads a file from the user data directory.
+   * @param event - The event object.
+   * @param path - The path of the file to read.
+   * @returns A promise that resolves with the contents of the file.
+   */
+  ipcMain.handle("readFile", async (event, path: string): Promise<string> => {
+    return new Promise((resolve, reject) => {
+      fs.readFile(join(app.getPath("userData"), path), "utf8", (err, data) => {
+        if (err) {
+          reject(err);
+        } else {
+          resolve(data);
+        }
+      });
+    });
+  });
+
+  /**
+   * Writes data to a file in the user data directory.
+   * @param event - The event object.
+   * @param path - The path of the file to write to.
+   * @param data - The data to write to the file.
+   * @returns A promise that resolves when the file has been written.
+   */
+  ipcMain.handle(
+    "writeFile",
+    async (event, path: string, data: string): Promise<void> => {
+      return new Promise((resolve, reject) => {
+        fs.writeFile(
+          join(app.getPath("userData"), path),
+          data,
+          "utf8",
+          (err) => {
+            if (err) {
+              reject(err);
+            } else {
+              resolve();
+            }
+          }
+        );
+      });
+    }
+  );
+
+  /**
+   * Creates a directory in the user data directory.
+   * @param event - The event object.
+   * @param path - The path of the directory to create.
+   * @returns A promise that resolves when the directory has been created.
+   */
+  ipcMain.handle("mkdir", async (event, path: string): Promise<void> => {
+    return new Promise((resolve, reject) => {
+      fs.mkdir(
+        join(app.getPath("userData"), path),
+        { recursive: true },
+        (err) => {
+          if (err) {
+            reject(err);
+          } else {
+            resolve();
+          }
+        }
+      );
+    });
+  });
+
+  /**
+   * Lists the files in a directory in the user data directory.
+   * @param event - The event object.
+   * @param path - The path of the directory to list files from.
+   * @returns A promise that resolves with an array of file names.
+   */
+  ipcMain.handle(
+    "listFiles",
+    async (event, path: string): Promise<string[]> => {
+      return new Promise((resolve, reject) => {
+        fs.readdir(join(app.getPath("userData"), path), (err, files) => {
+          if (err) {
+            reject(err);
+          } else {
+            resolve(files);
+          }
+        });
+      });
+    }
+  );
+}

electron/main.ts

@@ -12,6 +12,7 @@ import { rmdir, unlink, createWriteStream } from "fs";
 import { init } from "./core/plugin/index";
 import { setupMenu } from "./utils/menu";
 import { dispose } from "./utils/disposable";
+import { handleFs } from "./handlers/fs";
 
 const pacote = require("pacote");
 const request = require("request");
@@ -127,6 +128,7 @@ function handleAppUpdates() {
  * Handles various IPC messages from the renderer process.
  */
 function handleIPCs() {
+  handleFs();
   /**
    * Handles the "setNativeThemeLight" IPC message by setting the native theme source to "light".
    * This will change the appearance of the app to the light theme.