Merge pull request #3158 from janhq/dev

chore: release 0.5.2 to main

core/src/browser/fs.ts

@@ -55,20 +55,6 @@ const unlinkSync = (...args: any[]) => globalThis.core.api?.unlinkSync(...args)
  */
 const appendFileSync = (...args: any[]) => globalThis.core.api?.appendFileSync(...args)
 
-/**
- * Synchronizes a file from a source path to a destination path.
- * @param {string} src - The source path of the file to be synchronized.
- * @param {string} dest - The destination path where the file will be synchronized to.
- * @returns {Promise<any>} - A promise that resolves when the file has been successfully synchronized.
- */
-const syncFile: (src: string, dest: string) => Promise<any> = (src, dest) =>
-  globalThis.core.api?.syncFile(src, dest)
-
-/**
- * Copy file sync.
- */
-const copyFileSync = (...args: any[]) => globalThis.core.api?.copyFileSync(...args)
-
 const copyFile: (src: string, dest: string) => Promise<void> = (src, dest) =>
   globalThis.core.api?.copyFile(src, dest)
 
@@ -95,9 +81,7 @@ export const fs = {
   rm,
   unlinkSync,
   appendFileSync,
-  copyFileSync,
   copyFile,
-  syncFile,
   fileStat,
   writeBlob,
 }

core/src/node/api/processors/download.ts

@@ -1,6 +1,6 @@
 import { resolve, sep } from 'path'
 import { DownloadEvent } from '../../../types/api'
-import { normalizeFilePath } from '../../helper/path'
+import { normalizeFilePath, validatePath } from '../../helper/path'
 import { getJanDataFolderPath } from '../../helper'
 import { DownloadManager } from '../../helper/download'
 import { createWriteStream, renameSync } from 'fs'
@@ -37,6 +37,7 @@ export class Downloader implements Processor {
     const modelId = array.pop() ?? ''
 
     const destination = resolve(getJanDataFolderPath(), normalizedPath)
+    validatePath(destination)
     const rq = request({ url, strictSSL, proxy })
 
     // Put request to download manager instance

core/src/node/api/processors/fs.ts

@@ -1,5 +1,5 @@
-import { join } from 'path'
-import { normalizeFilePath } from '../../helper/path'
+import { join, resolve } from 'path'
+import { normalizeFilePath, validatePath } from '../../helper/path'
 import { getJanDataFolderPath } from '../../helper'
 import { Processor } from './Processor'
 import fs from 'fs'
@@ -15,17 +15,29 @@ export class FileSystem implements Processor {
   process(route: string, ...args: any): any {
     const instance = this as any
     const func = instance[route]
-
     if (func) {
       return func(...args)
     } else {
       return import(FileSystem.moduleName).then((mdl) =>
         mdl[route](
-          ...args.map((arg: any) => {
-            return typeof arg === 'string' &&
-              (arg.startsWith(`file:/`) || arg.startsWith(`file:\\`))
-              ? join(getJanDataFolderPath(), normalizeFilePath(arg))
-              : arg
+          ...args.map((arg: any, index: number) => {
+            if(index !== 0) {
+              return arg
+            }
+            if (index === 0 && typeof arg !== 'string') {
+              throw new Error(`Invalid argument ${JSON.stringify(args)}`)
+            }
+            const path =
+            (arg.startsWith(`file:/`) || arg.startsWith(`file:\\`))
+            ? join(getJanDataFolderPath(), normalizeFilePath(arg))
+            : arg
+
+            if(path.startsWith(`http://`) || path.startsWith(`https://`)) {
+              return path
+            }
+            const absolutePath = resolve(path)
+            validatePath(absolutePath)
+            return absolutePath
           })
         )
       )
@@ -42,8 +54,11 @@ export class FileSystem implements Processor {
       path = join(getJanDataFolderPath(), normalizeFilePath(path))
     }
 
+    const absolutePath = resolve(path)
+    validatePath(absolutePath)
+
     return new Promise((resolve, reject) => {
-      fs.rm(path, { recursive: true, force: true }, (err) => {
+      fs.rm(absolutePath, { recursive: true, force: true }, (err) => {
         if (err) {
           reject(err)
         } else {
@@ -63,8 +78,11 @@ export class FileSystem implements Processor {
       path = join(getJanDataFolderPath(), normalizeFilePath(path))
     }
 
+    const absolutePath = resolve(path)
+    validatePath(absolutePath)
+
     return new Promise((resolve, reject) => {
-      fs.mkdir(path, { recursive: true }, (err) => {
+      fs.mkdir(absolutePath, { recursive: true }, (err) => {
         if (err) {
           reject(err)
         } else {
@@ -73,4 +91,5 @@ export class FileSystem implements Processor {
       })
     })
   }
+
 }

core/src/node/api/processors/fsExt.ts

@@ -1,6 +1,6 @@
 import { join } from 'path'
 import fs from 'fs'
-import { appResourcePath, normalizeFilePath } from '../../helper/path'
+import { appResourcePath, normalizeFilePath, validatePath } from '../../helper/path'
 import { getJanDataFolderPath, getJanDataFolderPath as getPath } from '../../helper'
 import { Processor } from './Processor'
 import { FileStat } from '../../../types'
@@ -18,19 +18,6 @@ export class FSExt implements Processor {
     return func(...args)
   }
 
-  // Handles the 'syncFile' IPC event. This event is triggered to synchronize a file from a source path to a destination path.
-  syncFile(src: string, dest: string) {
-    const reflect = require('@alumna/reflect')
-    return reflect({
-      src,
-      dest,
-      recursive: true,
-      delete: false,
-      overwrite: true,
-      errorOnExist: false,
-    })
-  }
-
   // Handles the 'getJanDataFolderPath' IPC event. This event is triggered to get the user space path.
   getJanDataFolderPath() {
     return Promise.resolve(getPath())
@@ -70,14 +57,18 @@ export class FSExt implements Processor {
   writeBlob(path: string, data: any) {
     try {
       const normalizedPath = normalizeFilePath(path)
+
       const dataBuffer = Buffer.from(data, 'base64')
-      fs.writeFileSync(join(getJanDataFolderPath(), normalizedPath), dataBuffer)
+      const writePath = join(getJanDataFolderPath(), normalizedPath)
+      validatePath(writePath)
+      fs.writeFileSync(writePath, dataBuffer)
     } catch (err) {
       console.error(`writeFile ${path} result: ${err}`)
     }
   }
 
   copyFile(src: string, dest: string): Promise<void> {
+    validatePath(dest)
     return new Promise((resolve, reject) => {
       fs.copyFile(src, dest, (err) => {
         if (err) {

core/src/node/helper/config.ts

@@ -7,7 +7,8 @@ import childProcess from 'child_process'
 const configurationFileName = 'settings.json'
 
 // TODO: do no specify app name in framework module
-const defaultJanDataFolder = join(os.homedir(), 'jan')
+// TODO: do not default the os.homedir
+const defaultJanDataFolder = join(os?.homedir() || '', 'jan')
 const defaultAppConfig: AppConfiguration = {
   data_folder: defaultJanDataFolder,
   quick_ask: false,

core/src/node/helper/download.ts

@@ -11,7 +11,7 @@ export class DownloadManager {
   // store the download information with key is model id
   public downloadProgressMap: Record<string, DownloadState> = {}
 
-  // store the download infomation with key is normalized file path
+  // store the download information with key is normalized file path
   public downloadInfo: Record<string, DownloadState> = {}
 
   constructor() {

core/src/node/helper/path.ts

@@ -1,4 +1,5 @@
-import { join } from 'path'
+import { join, resolve } from 'path'
+import { getJanDataFolderPath } from './config'
 
 /**
  * Normalize file path
@@ -33,3 +34,11 @@ export async function appResourcePath(): Promise<string> {
   // server
   return join(global.core.appPath(), '../../..')
 }
+
+export function validatePath(path: string) {
+  const janDataFolderPath = getJanDataFolderPath()
+  const absolutePath = resolve(__dirname, path)
+  if (!absolutePath.startsWith(janDataFolderPath)) {
+    throw new Error(`Invalid path: ${absolutePath}`)
+  }
+}

core/src/types/api/index.ts

@@ -90,7 +90,6 @@ export enum ExtensionRoute {
 }
 export enum FileSystemRoute {
   appendFileSync = 'appendFileSync',
-  copyFileSync = 'copyFileSync',
   unlinkSync = 'unlinkSync',
   existsSync = 'existsSync',
   readdirSync = 'readdirSync',
@@ -100,7 +99,6 @@ export enum FileSystemRoute {
   writeFileSync = 'writeFileSync',
 }
 export enum FileManagerRoute {
-  syncFile = 'syncFile',
   copyFile = 'copyFile',
   getJanDataFolderPath = 'getJanDataFolderPath',
   getResourcePath = 'getResourcePath',

core/src/types/assistant/assistantEntity.ts

@@ -6,6 +6,7 @@
 export type AssistantTool = {
   type: string
   enabled: boolean
+  useTimeWeightedRetriever?: boolean
   settings: any
 }
 

core/src/types/message/messageEntity.ts

@@ -83,6 +83,8 @@ export enum MessageStatus {
 export enum ErrorCode {
   InvalidApiKey = 'invalid_api_key',
 
+  AuthenticationError = 'authentication_error',
+
   InsufficientQuota = 'insufficient_quota',
 
   InvalidRequestError = 'invalid_request_error',

electron/preload.ts

@@ -3,16 +3,19 @@
  * @module preload
  */
 
-import { APIEvents, APIRoutes } from '@janhq/core/node'
+import { APIEvents, APIRoutes, AppConfiguration, getAppConfigurations, updateAppConfiguration } from '@janhq/core/node'
 import { contextBridge, ipcRenderer } from 'electron'
+import { readdirSync } from 'fs'
 
 const interfaces: { [key: string]: (...args: any[]) => any } = {}
 
 // Loop over each route in APIRoutes
 APIRoutes.forEach((method) => {
   // For each method, create a function on the interfaces object
   // This function invokes the method on the ipcRenderer with any provided arguments
+
   interfaces[method] = (...args: any[]) => ipcRenderer.invoke(method, ...args)
+
 })
 
 // Loop over each method in APIEvents
@@ -22,6 +25,33 @@ APIEvents.forEach((method) => {
   // The handler for the event is provided as an argument to the function
   interfaces[method] = (handler: any) => ipcRenderer.on(method, handler)
 })
+
+
+interfaces['changeDataFolder'] = async path => {
+  const appConfiguration: AppConfiguration = await ipcRenderer.invoke('getAppConfigurations')
+  const currentJanDataFolder = appConfiguration.data_folder
+  appConfiguration.data_folder = path
+  const reflect = require('@alumna/reflect')
+  const { err } = await reflect({
+      src: currentJanDataFolder,
+      dest: path,
+      recursive: true,
+      delete: false,
+      overwrite: true,
+      errorOnExist: false,
+    })
+  if (err) {
+    console.error(err)
+    throw err
+  }
+  await ipcRenderer.invoke('updateAppConfiguration', appConfiguration)
+}
+
+interfaces['isDirectoryEmpty'] = async path => {
+  const dirChildren = await readdirSync(path)
+  return dirChildren.filter((x) => x !== '.DS_Store').length === 0
+}
+
 // Expose the 'interfaces' object in the main world under the name 'electronAPI'
 // This allows the renderer process to access these methods directly
 contextBridge.exposeInMainWorld('electronAPI', {

extensions/assistant-extension/src/index.ts

@@ -126,6 +126,7 @@ export default class JanAssistantExtension extends AssistantExtension {
         {
           type: 'retrieval',
           enabled: false,
+          useTimeWeightedRetriever: false,
           settings: {
             top_k: 2,
             chunk_size: 1024,

extensions/assistant-extension/src/node/index.ts

@@ -11,13 +11,14 @@ export function toolRetrievalUpdateTextSplitter(
 export async function toolRetrievalIngestNewDocument(
   file: string,
   model: string,
-  engine: string
+  engine: string,
+  useTimeWeighted: boolean
 ) {
   const filePath = path.join(getJanDataFolderPath(), normalizeFilePath(file))
   const threadPath = path.dirname(filePath.replace('files', ''))
   retrieval.updateEmbeddingEngine(model, engine)
   return retrieval
-    .ingestAgentKnowledge(filePath, `${threadPath}/memory`)
+    .ingestAgentKnowledge(filePath, `${threadPath}/memory`, useTimeWeighted)
     .catch((err) => {
       console.error(err)
     })
@@ -33,8 +34,11 @@ export async function toolRetrievalLoadThreadMemory(threadId: string) {
     })
 }
 
-export async function toolRetrievalQueryResult(query: string) {
-  return retrieval.generateResult(query).catch((err) => {
+export async function toolRetrievalQueryResult(
+  query: string,
+  useTimeWeighted: boolean = false
+) {
+  return retrieval.generateResult(query, useTimeWeighted).catch((err) => {
     console.error(err)
   })
 }