feat: local engine management

.github/workflows/jan-electron-linter-and-test.yml

@@ -44,16 +44,16 @@ jobs:
       - uses: actions/checkout@v3
         with:
           ref: ${{ github.base_ref }}
-      - name: Use Node.js v20.9.0
+      - name: Use Node.js 20.x
         uses: actions/setup-node@v3
         with:
-          node-version: v20.9.0
+          node-version: 20
 
       - name: Install dependencies
         run: |
-          yarn
+          make build-joi
           yarn build:core
-          yarn build:joi
+          yarn
 
       - name: Run test coverage
         run: yarn test:coverage
@@ -187,7 +187,7 @@ jobs:
           fetch-depth: 0
 
       - name: Installing node
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
           node-version: 20
 

core/src/browser/extension.ts

@@ -11,6 +11,7 @@
   Model = 'model',
   SystemMonitoring = 'systemMonitoring',
   HuggingFace = 'huggingFace',
+  Engine = 'engine',
 }
 
 export interface ExtensionType {
@@ -102,7 +103,7 @@
    * @property {Array} platform
    */
   compatibility(): Compatibility | undefined {
     return undefined
   }
 
   /**
@@ -110,8 +111,8 @@
    * @param models
    */
   async registerModels(models: Model[]): Promise<void> {
     for (const model of models) {
       ModelManager.instance().register(model)
     }
   }
 
@@ -122,8 +123,8 @@
    */
   async registerSettings(settings: SettingComponentProps[]): Promise<void> {
     if (!this.name) {
       console.error('Extension name is not defined')
       return
     }
 
     const extensionSettingFolderPath = await joinPath([
@@ -141,18 +142,18 @@
 
       // Persists new settings
       if (await fs.existsSync(settingFilePath)) {
         const oldSettings = JSON.parse(await fs.readFileSync(settingFilePath, 'utf-8'))
         settings.forEach((setting) => {
           // Keep setting value
           if (setting.controllerProps && Array.isArray(oldSettings))
             setting.controllerProps.value = oldSettings.find(
               (e: any) => e.key === setting.key
             )?.controllerProps?.value
         })
       }
       await fs.writeFileSync(settingFilePath, JSON.stringify(settings, null, 2))
     } catch (err) {
       console.error(err)
     }
   }
 
@@ -196,23 +197,23 @@
    * @returns
    */
   async getSettings(): Promise<SettingComponentProps[]> {
     if (!this.name) return []
 
     const settingPath = await joinPath([
       await getJanDataFolderPath(),
       this.settingFolderName,
       this.name,
       this.settingFileName,
     ])
 
     try {
       if (!(await fs.existsSync(settingPath))) return []
       const content = await fs.readFileSync(settingPath, 'utf-8')
       const settings: SettingComponentProps[] = JSON.parse(content)
       return settings
     } catch (err) {
       console.warn(err)
       return []
     }
   }
 

core/src/browser/extensions/enginesManagement.ts

@@ -0,0 +1,91 @@
+import {
+  InferenceEngine,
+  Engines,
+  EngineVariant,
+  EngineReleased,
+  DefaultEngineVariant,
+} from '../../types'
+import { BaseExtension, ExtensionTypeEnum } from '../extension'
+
+/**
+ * Engine management extension. Persists and retrieves engine management.
+ * @abstract
+ * @extends BaseExtension
+ */
+export abstract class EngineManagementExtension extends BaseExtension {
+  type(): ExtensionTypeEnum | undefined {
+    return ExtensionTypeEnum.Engine
+  }
+
+  /**
+   * @returns A Promise that resolves to an object of list engines.
+   */
+  abstract getEngines(): Promise<Engines>
+
+  /**
+   * @param name - Inference engine name.
+   * @returns A Promise that resolves to an array of installed engine.
+   */
+  abstract getInstalledEngines(name: InferenceEngine): Promise<EngineVariant[]>
+
+  /**
+   * @param name - Inference engine name.
+   * @param version - Version of the engine.
+   * @param platform - Optional to sort by operating system. macOS, linux, windows.
+   * @returns A Promise that resolves to an array of latest released engine by version.
+   */
+  abstract getReleasedEnginesByVersion(
+    name: InferenceEngine,
+    version: string,
+    platform?: string
+  ): Promise<EngineReleased[]>
+
+  /**
+   * @param name - Inference engine name.
+   * @param platform - Optional to sort by operating system. macOS, linux, windows.
+   * @returns A Promise that resolves to an array of latest released engine.
+   */
+  abstract getLatestReleasedEngine(
+    name: InferenceEngine,
+    platform?: string
+  ): Promise<EngineReleased[]>
+
+  /**
+   * @param name - Inference engine name.
+   * @returns A Promise that resolves to intall of engine.
+   */
+  abstract installEngine(
+    name: InferenceEngine,
+    engineConfig: { variant: string; version?: string }
+  ): Promise<{ messages: string }>
+
+  /**
+   * @param name - Inference engine name.
+   * @returns A Promise that resolves to unintall of engine.
+   */
+  abstract uninstallEngine(
+    name: InferenceEngine,
+    engineConfig: { variant: string; version: string }
+  ): Promise<{ messages: string }>
+
+  /**
+   * @param name - Inference engine name.
+   * @returns A Promise that resolves to an object of default engine.
+   */
+  abstract getDefaultEngineVariant(name: InferenceEngine): Promise<DefaultEngineVariant>
+
+  /**
+   * @body variant - string
+   * @body version - string
+   * @returns A Promise that resolves to set default engine.
+   */
+  abstract setDefaultEngineVariant(
+    name: InferenceEngine,
+    engineConfig: { variant: string; version: string }
+  ): Promise<{ messages: string }>
+
+  /**
+   * @returns A Promise that resolves to update engine.
+   */
+  abstract updateEngine(name: InferenceEngine): Promise<{ messages: string }>
+}

core/src/browser/extensions/index.ts

@@ -28,3 +28,8 @@ export { ModelExtension } from './model'
  * Base AI Engines.
  */
 export * from './engines'
+
+/**
+ *  Engines Management
+ */
+export * from './enginesManagement'

core/src/types/engine/index.ts

@@ -0,0 +1,28 @@
+import { InferenceEngine } from '../../types'
+
+export type Engines = {
+  [key in InferenceEngine]: EngineVariant[]
+}
+
+export type EngineVariant = {
+  engine: InferenceEngine
+  name: string
+  version: string
+}
+
+export type DefaultEngineVariant = {
+  engine: InferenceEngine
+  variant: string
+  version: string
+}
+
+export type EngineReleased = {
+  created_at: string
+  download_count: number
+  name: string
+  size: number
+}
+
+export enum EngineEvent {
+  OnEngineUpdate = 'OnEngineUpdate',
+}

core/src/types/index.ts

@@ -10,3 +10,4 @@ export * from './huggingface'
 export * from './miscellaneous'
 export * from './api'
 export * from './setting'
+export * from './engine'

extensions/engine-management-extension/jest.config.js

@@ -0,0 +1,5 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+}

extensions/engine-management-extension/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@janhq/engine-management-extension",
+  "productName": "Engine Management",
+  "version": "1.0.0",
+  "description": "Extension for managing engines and their configurations",
+  "main": "dist/index.js",
+  "node": "dist/node/index.cjs.js",
+  "author": "Jan <[email protected]>",
+  "license": "MIT",
+  "scripts": {
+    "test": "jest",
+    "build": "rolldown -c rolldown.config.mjs",
+    "build:publish": "rimraf *.tgz --glob || true && yarn build && ../../.github/scripts/auto-sign.sh && npm pack && cpx *.tgz ../../pre-install"
+  },
+  "exports": {
+    ".": "./dist/index.js",
+    "./main": "./dist/module.js"
+  },
+  "devDependencies": {
+    "@rollup/plugin-replace": "^6.0.2",
+    "cpx": "^1.5.0",
+    "rimraf": "^3.0.2",
+    "rolldown": "^1.0.0-beta.1",
+    "ts-loader": "^9.5.0",
+    "typescript": "^5.3.3",
+    "webpack": "^5.88.2",
+    "webpack-cli": "^5.1.4"
+  },
+  "dependencies": {
+    "@janhq/core": "../../core/package.tgz",
+    "cpu-instructions": "^0.0.13",
+    "ky": "^1.7.2",
+    "p-queue": "^8.0.1"
+  },
+  "bundledDependencies": [
+    "cpu-instructions",
+    "@janhq/core"
+  ],
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "files": [
+    "dist/*",
+    "package.json",
+    "README.md"
+  ]
+}

extensions/engine-management-extension/rolldown.config.mjs

@@ -0,0 +1,45 @@
+import { defineConfig } from 'rolldown'
+import replace from '@rollup/plugin-replace'
+import pkgJson from './package.json' with { type: 'json' }
+
+export default defineConfig([
+  {
+    input: 'src/index.ts',
+    output: {
+      format: 'esm',
+      file: 'dist/index.js',
+    },
+    plugins: [
+      replace({
+        NODE: JSON.stringify(`${pkgJson.name}/${pkgJson.node}`),
+        API_URL: JSON.stringify('http://127.0.0.1:39291'),
+        SOCKET_URL: JSON.stringify('ws://127.0.0.1:39291'),
+        CORTEX_ENGINE_VERSION: JSON.stringify('v0.1.42'),
+      }),
+    ],
+  },
+  {
+    input: 'src/node/index.ts',
+    external: ['@janhq/core/node'],
+    output: {
+      format: 'cjs',
+      file: 'dist/node/index.cjs.js',
+    },
+    plugins: [
+      replace({
+        CORTEX_ENGINE_VERSION: JSON.stringify('v0.1.42'),
+      }),
+    ],
+  },
+  {
+    input: 'src/node/cpuInfo.ts',
+    output: {
+      format: 'cjs',
+      file: 'dist/node/cpuInfo.js',
+    },
+    external: ['cpu-instructions'],
+    resolve: {
+      extensions: ['.ts', '.js', '.svg'],
+    },
+  },
+])

extensions/engine-management-extension/src/@types/global.d.ts

@@ -0,0 +1,16 @@
+export {}
+declare global {
+  declare const API_URL: string
+  declare const CORTEX_ENGINE_VERSION: string
+  declare const SOCKET_URL: string
+  declare const NODE: string
+
+  interface Core {
+    api: APIFunctions
+    events: EventEmitter
+  }
+  interface Window {
+    core?: Core | undefined
+    electronAPI?: any | undefined
+  }
+}

extensions/engine-management-extension/src/error.ts

@@ -0,0 +1,10 @@
+/**
+ * Custom Engine Error
+ */
+export class EngineError extends Error {
+  message: string
+  constructor(message: string) {
+    super()
+    this.message = message
+  }
+}