feat: support cortex configs and engines commands (#782)

Author: louis-jan

cortex-js/src/app.module.ts

@@ -26,6 +26,11 @@ import { StatusController } from './infrastructure/controllers/status.controller
 import { ProcessController } from './infrastructure/controllers/process.controller';
 import { DownloadManagerModule } from './infrastructure/services/download-manager/download-manager.module';
 import { ContextModule } from './infrastructure/services/context/context.module';
+import { ExtensionsModule } from './extensions/extensions.module';
+import { ConfigsModule } from './usecases/configs/configs.module';
+import { EnginesModule } from './usecases/engines/engines.module';
+import { ConfigsController } from './infrastructure/controllers/configs.controller';
+import { EnginesController } from './infrastructure/controllers/engines.controller';
 
 @Module({
   imports: [
@@ -50,6 +55,9 @@ import { ContextModule } from './infrastructure/services/context/context.module'
     TelemetryModule,
     ContextModule,
     DownloadManagerModule,
+    ExtensionsModule,
+    ConfigsModule,
+    EnginesModule,
   ],
   controllers: [
     AssistantsController,
@@ -60,6 +68,8 @@ import { ContextModule } from './infrastructure/services/context/context.module'
     StatusController,
     ProcessController,
     EventsController,
+    ConfigsController,
+    EnginesController,
   ],
   providers: [
     {

cortex-js/src/app.ts

@@ -7,9 +7,12 @@ export const getApp = async () => {
   const app = await NestFactory.create(AppModule, {
     snapshot: true,
     cors: true,
-    logger: console
+    logger: console,
   });
 
+  // Set the global prefix for the API /v1/
+  app.setGlobalPrefix('v1');
+
   const fileService = app.get(FileManagerService);
   await fileService.getConfig();
 

cortex-js/src/command.module.ts

@@ -34,6 +34,16 @@ import { EventEmitterModule } from '@nestjs/event-emitter';
 import { DownloadManagerModule } from './infrastructure/services/download-manager/download-manager.module';
 import { ServeStopCommand } from './infrastructure/commanders/sub-commands/serve-stop.command';
 import { ContextModule } from './infrastructure/services/context/context.module';
+import { ExtensionsModule } from './extensions/extensions.module';
+import { ConfigsCommand } from './infrastructure/commanders/configs.command';
+import { EnginesCommand } from './infrastructure/commanders/engines.command';
+import { ConfigsModule } from './usecases/configs/configs.module';
+import { EnginesModule } from './usecases/engines/engines.module';
+import { ConfigsGetCommand } from './infrastructure/commanders/configs/configs-get.command';
+import { ConfigsListCommand } from './infrastructure/commanders/configs/configs-list.command';
+import { ConfigsSetCommand } from './infrastructure/commanders/configs/configs-set.command';
+import { EnginesListCommand } from './infrastructure/commanders/engines/engines-list.command';
+import { EnginesGetCommand } from './infrastructure/commanders/engines/engines-get.command';
 
 @Module({
   imports: [
@@ -55,6 +65,9 @@ import { ContextModule } from './infrastructure/services/context/context.module'
     TelemetryModule,
     ContextModule,
     DownloadManagerModule,
+    ExtensionsModule,
+    ConfigsModule,
+    EnginesModule,
   ],
   providers: [
     CortexCommand,
@@ -67,6 +80,7 @@ import { ContextModule } from './infrastructure/services/context/context.module'
     PresetCommand,
     EmbeddingCommand,
     BenchmarkCommand,
+    EnginesCommand,
 
     // Questions
     InitRunModeQuestions,
@@ -88,6 +102,16 @@ import { ContextModule } from './infrastructure/services/context/context.module'
 
     // Serve
     ServeStopCommand,
+
+    // Configs
+    ConfigsCommand,
+    ConfigsGetCommand,
+    ConfigsListCommand,
+    ConfigsSetCommand,
+
+    // Engines
+    EnginesListCommand,
+    EnginesGetCommand,
   ],
 })
 export class CommandModule {}

cortex-js/src/domain/abstracts/engine.abstract.ts

@@ -4,7 +4,7 @@ import { Model, ModelSettingParams } from '../../domain/models/model.interface';
 import { Extension } from './extension.abstract';
 
 export abstract class EngineExtension extends Extension {
-  abstract provider: string;
+  abstract onLoad(): void;
 
   abstract inference(
     dto: any,

cortex-js/src/domain/abstracts/extension.abstract.ts

@@ -4,7 +4,7 @@
  */
 export abstract class Extension {
   /** @type {string} Name of the extension. */
-  name?: string;
+  name: string;
 
   /** @type {string} Product Name of the extension. */
   productName?: string;

cortex-js/src/domain/abstracts/oai.abstract.ts

@@ -10,6 +10,8 @@ export abstract class OAIEngineExtension extends EngineExtension {
     super();
   }
 
+  override onLoad(): void {}
+
   override async inference(
     createChatDto: any,
     headers: Record<string, string>,

cortex-js/src/extensions/extensions.module.ts

@@ -0,0 +1,25 @@
+import { Module } from '@nestjs/common';
+import GroqEngineExtension from './groq.engine';
+import MistralEngineExtension from './mistral.engine';
+import OpenAIEngineExtension from './openai.engine';
+import { HttpModule, HttpService } from '@nestjs/axios';
+import { ConfigsUsecases } from '@/usecases/configs/configs.usecase';
+import { ConfigsModule } from '@/usecases/configs/configs.module';
+
+const provider = {
+  provide: 'EXTENSIONS_PROVIDER',
+  inject: [HttpService, ConfigsUsecases],
+  useFactory: (httpService: HttpService, configUsecases: ConfigsUsecases) => [
+    new OpenAIEngineExtension(httpService, configUsecases),
+    new GroqEngineExtension(httpService, configUsecases),
+    new MistralEngineExtension(httpService, configUsecases),
+  ],
+};
+
+@Module({
+  imports: [HttpModule, ConfigsModule],
+  controllers: [],
+  providers: [provider],
+  exports: [provider],
+})
+export class ExtensionsModule {}

cortex-js/src/extensions/groq.engine.ts

@@ -0,0 +1,31 @@
+import { HttpService } from '@nestjs/axios';
+import { OAIEngineExtension } from '../domain/abstracts/oai.abstract';
+import { ConfigsUsecases } from '@/usecases/configs/configs.usecase';
+
+/**
+ * A class that implements the InferenceExtension interface from the @janhq/core package.
+ * The class provides methods for initializing and stopping a model, and for making inference requests.
+ * It also subscribes to events emitted by the @janhq/core package and handles new message requests.
+ */
+export default class GroqEngineExtension extends OAIEngineExtension {
+  apiUrl = 'https://api.groq.com/openai/v1/chat/completions';
+  name = 'groq';
+  productName = 'Groq Inference Engine';
+  description = 'This extension enables fast Groq chat completion API calls';
+  version = '0.0.1';
+
+  constructor(
+    protected readonly httpService: HttpService,
+    protected readonly configsUsecases: ConfigsUsecases,
+  ) {
+    super(httpService);
+  }
+
+  async onLoad() {
+    const configs = (await this.configsUsecases.getGroupConfigs(
+      this.name,
+    )) as unknown as { apiKey: string };
+    if (!configs?.apiKey)
+      await this.configsUsecases.saveConfig('apiKey', '', this.name);
+  }
+}