fix: Update code based on comments from @james

core/src/fs.ts

@@ -25,7 +25,7 @@ const readFile: (path: string) => Promise<any> = (path) => global.core.api?.read
  * @param {string} path
  * @returns {boolean} A boolean indicating whether the path is a file.
  */
-const checkFileExists = (path: string): Promise<boolean> => global.core.api?.checkFileExists(path)
+const exists = (path: string): Promise<boolean> => global.core.api?.exists(path)
 /**
  * List the directory files
  * @param {string} path - The path of the directory to list files.
@@ -75,7 +75,7 @@ export const fs = {
   isDirectory,
   writeFile,
   readFile,
-  checkFileExists,
+  exists,
   listFiles,
   mkdir,
   rmdir,

core/src/types/index.ts

@@ -41,11 +41,8 @@ export type MessageRequest = {
   /** Messages for constructing a chat completion request **/
   messages?: ChatCompletionMessage[];
 
-  /** Runtime parameters for constructing a chat completion request **/
-  parameters?: ModelRuntimeParams;
-
   /** Settings for constructing a chat completion request **/
-  model?: ModelInfo
+  model?: ModelInfo;
 };
 
 /**

electron/handlers/fs.ts

@@ -56,7 +56,7 @@ export function handleFsIPCs() {
    * @param path - The path of the file to check.
    * @returns A promise that resolves with a boolean indicating whether the file exists.
    */
-  ipcMain.handle('checkFileExists', async (_event, path: string) => {
+  ipcMain.handle('exists', async (_event, path: string) => {
     return new Promise((resolve, reject) => {
       const fullPath = join(userSpacePath, path)
       fs.existsSync(fullPath) ? resolve(true) : resolve(false)

electron/invokers/fs.ts

@@ -31,7 +31,7 @@ export function fsInvokers() {
      * Reads a file at the specified path.
      * @param {string} path - The path of the file to read.
      */
-    checkFileExists: (path: string) => ipcRenderer.invoke('checkFileExists', path),
+    exists: (path: string) => ipcRenderer.invoke('exists', path),
 
     /**
      * Writes data to a file at the specified path.

extensions/inference-nitro-extension/src/@types/global.d.ts

@@ -10,18 +10,17 @@ declare const INFERENCE_URL: string;
  * @property settings.embedding - Whether to use embedding.
  */
 interface EngineSettings {
-    ctx_len: number;
-    ngl: number;
-    cont_batching: boolean;
-    embedding: boolean;
+  ctx_len: number;
+  ngl: number;
+  cont_batching: boolean;
+  embedding: boolean;
 }
 
 /**
  * The response from the initModel function.
  * @property error - An error message if the model fails to load.
  */
 interface ModelOperationResponse {
-    error?: any;
-    modelFile?: string;
-  }
-
+  error?: any;
+  modelFile?: string;
+}

extensions/inference-nitro-extension/src/index.ts

@@ -33,17 +33,17 @@ import { join } from "path";
  * It also subscribes to events emitted by the @janhq/core package and handles new message requests.
  */
 export default class JanInferenceNitroExtension implements InferenceExtension {
-  private static readonly _homeDir = 'engines'
-  private static readonly _engineMetadataFileName = 'nitro.json'
+  private static readonly _homeDir = "engines";
+  private static readonly _engineMetadataFileName = "nitro.json";
 
-  static _currentModel: Model;
+  private static _currentModel: Model;
 
-  static _engineSettings: EngineSettings = {
-    "ctx_len": 2048,
-    "ngl": 100,
-    "cont_batching": false,
-    "embedding": false
-  }
+  private static _engineSettings: EngineSettings = {
+    ctx_len: 2048,
+    ngl: 100,
+    cont_batching: false,
+    embedding: false,
+  };
 
   controller = new AbortController();
   isCancelled = false;
@@ -59,12 +59,12 @@ export default class JanInferenceNitroExtension implements InferenceExtension {
    * Subscribes to events emitted by the @janhq/core package.
    */
   onLoad(): void {
-    fs.mkdir(JanInferenceNitroExtension._homeDir)
-    this.writeDefaultEngineSettings()
+    fs.mkdir(JanInferenceNitroExtension._homeDir);
+    this.writeDefaultEngineSettings();
 
     // Events subscription
     events.on(EventName.OnMessageSent, (data) =>
-    JanInferenceNitroExtension.handleMessageRequest(data, this)
+      JanInferenceNitroExtension.handleMessageRequest(data, this)
     );
 
     events.on(EventName.OnModelInit, (model: Model) => {
@@ -112,42 +112,51 @@ export default class JanInferenceNitroExtension implements InferenceExtension {
 
   private async writeDefaultEngineSettings() {
     try {
-      const engine_json = join(JanInferenceNitroExtension._homeDir, JanInferenceNitroExtension._engineMetadataFileName)
-      if (await fs.checkFileExists(engine_json)) {
-        JanInferenceNitroExtension._engineSettings = JSON.parse(await fs.readFile(engine_json))
-      }
-      else {
-        await fs.writeFile(engine_json, JSON.stringify(JanInferenceNitroExtension._engineSettings, null, 2))
+      const engineFile = join(
+        JanInferenceNitroExtension._homeDir,
+        JanInferenceNitroExtension._engineMetadataFileName
+      );
+      if (await fs.exists(engineFile)) {
+        JanInferenceNitroExtension._engineSettings = JSON.parse(
+          await fs.readFile(engineFile)
+        );
+      } else {
+        await fs.writeFile(
+          engineFile,
+          JSON.stringify(JanInferenceNitroExtension._engineSettings, null, 2)
+        );
       }
     } catch (err) {
-      console.error(err)
+      console.error(err);
     }
   }
 
   private static async handleModelInit(model: Model) {
-    if (model.engine !== "nitro") { return }
+    if (model.engine !== "nitro") {
+      return;
+    }
     const userSpacePath = await getUserSpace();
     const modelFullPath = join(userSpacePath, "models", model.id, model.id);
 
-    const nitro_init_result = await executeOnMain(MODULE, "initModel", {
+    const nitroInitResult = await executeOnMain(MODULE, "initModel", {
       modelFullPath: modelFullPath,
-      model: model
+      model: model,
     });
 
-    if (nitro_init_result.error === null) {
-      events.emit(EventName.OnModelFail, model)
-    }
-    else{
+    if (nitroInitResult.error === null) {
+      events.emit(EventName.OnModelFail, model);
+    } else {
       JanInferenceNitroExtension._currentModel = model;
       events.emit(EventName.OnModelReady, model);
     }
   }
 
   private static async handleModelStop(model: Model) {
-    if (model.engine !== 'nitro') { return }
-    else {
-      await executeOnMain(MODULE, "stopModel")
-      events.emit(EventName.OnModelStopped, model)
+    if (model.engine !== "nitro") {
+      return;
+    } else {
+      await executeOnMain(MODULE, "stopModel");
+      events.emit(EventName.OnModelStopped, model);
     }
   }
 
@@ -171,18 +180,17 @@ export default class JanInferenceNitroExtension implements InferenceExtension {
 
     return new Promise(async (resolve, reject) => {
       requestInference(
-          data.messages ?? [], 
-          JanInferenceNitroExtension._engineSettings, 
-          JanInferenceNitroExtension._currentModel
-        )
-        .subscribe({
+        data.messages ?? [],
+        JanInferenceNitroExtension._engineSettings,
+        JanInferenceNitroExtension._currentModel
+      ).subscribe({
         next: (_content) => {},
-          complete: async () => {
-            resolve(message);
-          },
-          error: async (err) => {
-            reject(err);
-          },
+        complete: async () => {
+          resolve(message);
+        },
+        error: async (err) => {
+          reject(err);
+        },
       });
     });
   }
@@ -197,7 +205,9 @@ export default class JanInferenceNitroExtension implements InferenceExtension {
     data: MessageRequest,
     instance: JanInferenceNitroExtension
   ) {
-    if (data.model.engine !== 'nitro') { return }
+    if (data.model.engine !== "nitro") {
+      return;
+    }
     const timestamp = Date.now();
     const message: ThreadMessage = {
       id: ulid(),
@@ -216,11 +226,11 @@ export default class JanInferenceNitroExtension implements InferenceExtension {
     instance.controller = new AbortController();
 
     requestInference(
-        data.messages ?? [], 
-        JanInferenceNitroExtension._engineSettings, 
-        JanInferenceNitroExtension._currentModel, 
-        instance.controller
-      ).subscribe({
+      data.messages ?? [],
+      JanInferenceNitroExtension._engineSettings,
+      JanInferenceNitroExtension._currentModel,
+      instance.controller
+    ).subscribe({
       next: (content) => {
         const messageContent: ThreadContent = {
           type: ContentType.Text,

extensions/inference-nitro-extension/src/module.ts

@@ -26,9 +26,9 @@ let currentModelFile = null;
  */
 function stopModel(): Promise<ModelOperationResponse> {
   return new Promise((resolve, reject) => {
-    checkAndUnloadNitro()
-    resolve({ error: undefined})
-  })
+    checkAndUnloadNitro();
+    resolve({ error: undefined });
+  });
 }
 
 /**
@@ -39,33 +39,32 @@ function stopModel(): Promise<ModelOperationResponse> {
  * TODO: Should it be startModel instead?
  */
 function initModel(wrapper: any): Promise<ModelOperationResponse> {
-    currentModelFile = wrapper.modelFullPath;
-    if (wrapper.model.engine !== "nitro") {
-      return Promise.resolve({ error: "Not a nitro model" })
-    }
-    else {
-      log.info("Started to load model " + wrapper.model.modelFullPath);
-      const settings = {
-        llama_model_path: currentModelFile,
-        ...wrapper.model.settings,
-      };
-      log.info(`Load model settings: ${JSON.stringify(settings, null, 2)}`);
-      return (
-        // 1. Check if the port is used, if used, attempt to unload model / kill nitro process
-        validateModelVersion()
-          .then(checkAndUnloadNitro)
-          // 2. Spawn the Nitro subprocess
-          .then(spawnNitroProcess)
-          // 4. Load the model into the Nitro subprocess (HTTP POST request)
-          .then(() => loadLLMModel(settings))
-          // 5. Check if the model is loaded successfully
-          .then(validateModelStatus)
-          .catch((err) => {
-            log.error("error: " + JSON.stringify(err));
-            return { error: err, currentModelFile };
-          })
-        );
-    }
+  currentModelFile = wrapper.modelFullPath;
+  if (wrapper.model.engine !== "nitro") {
+    return Promise.resolve({ error: "Not a nitro model" });
+  } else {
+    log.info("Started to load model " + wrapper.model.modelFullPath);
+    const settings = {
+      llama_model_path: currentModelFile,
+      ...wrapper.model.settings,
+    };
+    log.info(`Load model settings: ${JSON.stringify(settings, null, 2)}`);
+    return (
+      // 1. Check if the port is used, if used, attempt to unload model / kill nitro process
+      validateModelVersion()
+        .then(checkAndUnloadNitro)
+        // 2. Spawn the Nitro subprocess
+        .then(spawnNitroProcess)
+        // 4. Load the model into the Nitro subprocess (HTTP POST request)
+        .then(() => loadLLMModel(settings))
+        // 5. Check if the model is loaded successfully
+        .then(validateModelStatus)
+        .catch((err) => {
+          log.error("error: " + JSON.stringify(err));
+          return { error: err, currentModelFile };
+        })
+    );
+  }
 }
 
 /**
@@ -148,13 +147,12 @@ async function checkAndUnloadNitro() {
     // If inUse - try unload or kill process, otherwise do nothing
     if (inUse) {
       // Attempt to unload model
-      return await fetch(NITRO_HTTP_UNLOAD_MODEL_URL, {
+      return fetch(NITRO_HTTP_UNLOAD_MODEL_URL, {
         method: "GET",
         headers: {
           "Content-Type": "application/json",
         },
-      })
-      .catch((err) => {
+      }).catch((err) => {
         console.error(err);
         // Fallback to kill the port
         return killSubprocess();

extensions/inference-openai-extension/src/@types/global.d.ts

@@ -3,25 +3,25 @@ import { Model } from "@janhq/core";
 declare const MODULE: string;
 
 declare interface EngineSettings {
-    base_url?: string;
-    api_key?: string;
+  base_url?: string;
+  api_key?: string;
 }
 
 enum OpenAIChatCompletionModelName {
-    'gpt-3.5-turbo-instruct' = 'gpt-3.5-turbo-instruct',
-    'gpt-3.5-turbo-instruct-0914' = 'gpt-3.5-turbo-instruct-0914',
-    'gpt-4-1106-preview' = 'gpt-4-1106-preview',
-    'gpt-3.5-turbo-0613' = 'gpt-3.5-turbo-0613',
-    'gpt-3.5-turbo-0301' = 'gpt-3.5-turbo-0301',
-    'gpt-3.5-turbo' = 'gpt-3.5-turbo',
-    'gpt-3.5-turbo-16k-0613' = 'gpt-3.5-turbo-16k-0613',
-    'gpt-3.5-turbo-1106' = 'gpt-3.5-turbo-1106',
-    'gpt-4-vision-preview' = 'gpt-4-vision-preview',
-    'gpt-4' = 'gpt-4',
-    'gpt-4-0314' = 'gpt-4-0314',
-    'gpt-4-0613' = 'gpt-4-0613',
+  "gpt-3.5-turbo-instruct" = "gpt-3.5-turbo-instruct",
+  "gpt-3.5-turbo-instruct-0914" = "gpt-3.5-turbo-instruct-0914",
+  "gpt-4-1106-preview" = "gpt-4-1106-preview",
+  "gpt-3.5-turbo-0613" = "gpt-3.5-turbo-0613",
+  "gpt-3.5-turbo-0301" = "gpt-3.5-turbo-0301",
+  "gpt-3.5-turbo" = "gpt-3.5-turbo",
+  "gpt-3.5-turbo-16k-0613" = "gpt-3.5-turbo-16k-0613",
+  "gpt-3.5-turbo-1106" = "gpt-3.5-turbo-1106",
+  "gpt-4-vision-preview" = "gpt-4-vision-preview",
+  "gpt-4" = "gpt-4",
+  "gpt-4-0314" = "gpt-4-0314",
+  "gpt-4-0613" = "gpt-4-0613",
 }
 
 declare type OpenAIModel = Omit<Model, "id"> & {
-    id: OpenAIChatCompletionModelName;
-};
+  id: OpenAIChatCompletionModelName;
+};