@proteinjs/conversation 1.0.5 → 1.0.7

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@proteinjs/conversation",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "publishConfig": {
     "access": "public"
   },
   "scripts": {
-    "clean": "rm -rf dist/ node_modules/ package-lock.json",
+    "clean": "rm -rf dist/ node_modules/",
     "build": "tsc",
     "watch": "tsc -w -p .",
     "start": "node ./dist/index.js",
@@ -19,16 +19,22 @@
     "@types/jest": "^29.5.4",
     "@types/node": "20.5.9",
     "@types/readline-sync": "1.4.4",
+    "@typescript-eslint/eslint-plugin": "7.8.0",
+    "@typescript-eslint/parser": "7.8.0",
+    "eslint": "8.57.0",
+    "eslint-config-prettier": "9.1.0",
+    "eslint-plugin-prettier": "5.1.3",
     "jest": "^29.6.4",
     "ts-jest": "^29.1.1"
   },
   "dependencies": {
     "@proteinjs/util": "1.1.0",
-    "@proteinjs/util-node": "1.1.0",
+    "@proteinjs/util-node": "1.2.0",
     "fs-extra": "11.1.1",
     "openai": "4.4.0",
     "readline-sync": "1.4.10",
     "tiktoken": "1.0.11",
     "typescript": "5.2.2"
-  }
-}
+  },
+  "gitHead": "c80aa2d5ec21217b51a064ffdceada8e3d7644e8"
+}

package/src/CodegenConversation.ts

@@ -27,6 +27,7 @@ export class CodegenConversation {
     conversation.addAssistantMessagesToHistory([CodegenConversation.INITIAL_QUESTION]);
     const initialUserInput = this.respondToUser(CodegenConversation.INITIAL_QUESTION);
     let response = await conversation.generateResponse([initialUserInput], CodegenConversation.MODEL);
+    // eslint-disable-next-line no-constant-condition
     while (true) {
       const userInput = this.respondToUser(response);
       response = await conversation.generateResponse([userInput], CodegenConversation.MODEL);
@@ -52,8 +53,9 @@ export class CodegenConversation {
       new GitModuleFactory(),
     ];
     const modules: ConversationModule[] = [];
-    for (let moduleFactory of moduleFactories)
+    for (const moduleFactory of moduleFactories) {
       modules.push(await moduleFactory.createModule(this.repoPath));
+    }
 
     return modules;
   }
@@ -73,12 +75,12 @@ export class CodegenConversation {
       // `Use the ${searchFilesFunctionName} function to find the file if needed; read the file if needed`,
       // `If the user is referring to a function, object, class, or type and you don't have the relevant file content, first inspect the conversation summary in the chat history (if it exists) to find a file name, and call the ${searchFilesFunctionName} function and read the file before responding to the user`,
       // `Before calling ${searchFilesFunctionName}, ${searchLibrariesFunctionName} or ${searchPackagesFunctionName}, use the conversation summary in the chat history to identify a file or keyword to search for instead; after reading that file, respond to the user's request`,
-      // 
+      //
       // `Use the ${getRecentlyAccessedFilePathsFunctionName} function find a file that might pertain to the user's request before searching files, libraries or packages; read that file then respond to the user`,
       // `When trying to locate code, use the ${getRecentlyAccessedFilePathsFunctionName} function to search recently accessed files first, then proceed to calling other functions: ${searchLibrariesFunctionName}, ${searchPackagesFunctionName}, ${searchFilesFunctionName}`,
       // `The conversation summary indicates files recently worked in as well`,
       // `If that doesn't yield results, proceed to calling the ${searchLibrariesFunctionName} function, then fall back to functions: ${searchPackagesFunctionName}, ${searchFilesFunctionName}`,
-      // 
+      //
       // `To find code, a file, or a library, call ${getRecentlyAccessedFilePathsFunctionName} and read the most recent file, after trying that call ${searchLibrariesFunctionName} then ${searchFilesFunctionName} to find a relevant file`,
       // `The file mentioned in the conversation summary should be read if we're not already working in a file`,
       // `If there is a conversation summary assistant message, use that to pick a file to read before responding to the user if not already working with a specific file`,
@@ -89,4 +91,4 @@ export class CodegenConversation {
   private respondToUser(message: string) {
     return readline.question(`${textColorMap.cyan}[${CodegenConversation.BOT_NAME}] ${message}${Reset}\n`);
   }
-}
+}

package/src/Conversation.ts

@@ -10,7 +10,7 @@ import { TiktokenModel, encoding_for_model } from 'tiktoken';
 import { searchLibrariesFunctionName } from './fs/package/PackageFunctions';
 
 export type ConversationParams = {
-  name: string,
+  name: string;
   modules?: ConversationModule[];
   logLevel?: LogLevel;
   limits?: {
@@ -18,7 +18,7 @@ export type ConversationParams = {
     maxMessagesInHistory?: number;
     tokenLimit?: number;
   };
-}
+};
 
 export class Conversation {
   private tokenLimit = 3000;
@@ -33,26 +33,30 @@ export class Conversation {
 
   constructor(params: ConversationParams) {
     this.params = params;
-    this.history = new MessageHistory({ maxMessages: params.limits?.maxMessagesInHistory, enforceMessageLimit: params.limits?.enforceLimits });
+    this.history = new MessageHistory({
+      maxMessages: params.limits?.maxMessagesInHistory,
+      enforceMessageLimit: params.limits?.enforceLimits,
+    });
     this.logger = new Logger(params.name, params.logLevel);
 
-    if (params.modules)
+    if (params.modules) {
       this.addModules(params.modules);
+    }
 
     if (typeof params.limits?.enforceLimits === 'undefined' || params.limits.enforceLimits) {
-      this.addFunctions('Conversation', [
-        summarizeConversationHistoryFunction(this),
-      ]);
+      this.addFunctions('Conversation', [summarizeConversationHistoryFunction(this)]);
     }
 
-    if (params.limits?.tokenLimit)
+    if (params.limits?.tokenLimit) {
       this.tokenLimit = params.limits.tokenLimit;
+    }
   }
 
   private addModules(modules: ConversationModule[]) {
-    for (let module of modules) {
-      if (module.getSystemMessages().length < 1)
+    for (const module of modules) {
+      if (module.getSystemMessages().length < 1) {
         continue;
+      }
 
       this.addSystemMessagesToHistory([
         `The following are instructions from the ${module.getName()} module: ${module.getSystemMessages().join('. ')}`,
@@ -66,10 +70,11 @@ export class Conversation {
     this.functions.push(...functions);
     let functionInstructions = `The following are instructions from functions in the ${moduleName} module:`;
     let functionInstructionsAdded = false;
-    for (let f of functions) {
+    for (const f of functions) {
       if (f.instructions) {
-        if (!f.instructions || f.instructions.length < 1)
+        if (!f.instructions || f.instructions.length < 1) {
           continue;
+        }
 
         functionInstructionsAdded = true;
         const instructionsParagraph = f.instructions.join('. ');
@@ -77,8 +82,9 @@ export class Conversation {
       }
     }
 
-    if (!functionInstructionsAdded)
+    if (!functionInstructionsAdded) {
       return;
+    }
 
     this.addSystemMessagesToHistory([functionInstructions]);
   }
@@ -88,21 +94,37 @@ export class Conversation {
   }
 
   private async enforceTokenLimit(messages: string[], model?: TiktokenModel) {
-    if (this.params.limits?.enforceLimits === false)
+    if (this.params.limits?.enforceLimits === false) {
       return;
-    
+    }
+
     const resolvedModel = model ? model : DEFAULT_MODEL;
     const encoder = encoding_for_model(resolvedModel);
     const conversation = this.history.toString() + messages.join('. ');
     const encoded = encoder.encode(conversation);
     console.log(`current tokens: ${encoded.length}`);
-    if (encoded.length < this.tokenLimit)
+    if (encoded.length < this.tokenLimit) {
       return;
+    }
 
     const summarizeConversationRequest = `First, call the ${summarizeConversationHistoryFunctionName} function`;
-    await OpenAi.generateResponse([summarizeConversationRequest], model, this.history, this.functions, this.messageModerators, this.params.logLevel);
+    await OpenAi.generateResponse(
+      [summarizeConversationRequest],
+      model,
+      this.history,
+      this.functions,
+      this.messageModerators,
+      this.params.logLevel
+    );
     const referenceSummaryRequest = `If there's a file mentioned in the conversation summary, find and read the file to better respond to my next request. If that doesn't find anything, call the ${searchLibrariesFunctionName} function on other keywords in the conversation summary to find a file to read`;
-    await OpenAi.generateResponse([referenceSummaryRequest], model, this.history, this.functions, this.messageModerators, this.params.logLevel);
+    await OpenAi.generateResponse(
+      [referenceSummaryRequest],
+      model,
+      this.history,
+      this.functions,
+      this.messageModerators,
+      this.params.logLevel
+    );
   }
 
   summarizeConversationHistory(summary: string) {
@@ -116,7 +138,9 @@ export class Conversation {
   }
 
   addSystemMessagesToHistory(messages: string[], unshift = false) {
-    const chatCompletions: ChatCompletionMessageParam[] = messages.map(message => { return { role: 'system', content: message }});
+    const chatCompletions: ChatCompletionMessageParam[] = messages.map((message) => {
+      return { role: 'system', content: message };
+    });
     if (unshift) {
       this.history.getMessages().unshift(...chatCompletions);
       this.history.prune();
@@ -128,40 +152,66 @@ export class Conversation {
   }
 
   addAssistantMessagesToHistory(messages: string[], unshift = false) {
-    const chatCompletions: ChatCompletionMessageParam[] = messages.map(message => { return { role: 'assistant', content: message }});
+    const chatCompletions: ChatCompletionMessageParam[] = messages.map((message) => {
+      return { role: 'assistant', content: message };
+    });
     if (unshift) {
       this.history.getMessages().unshift(...chatCompletions);
       this.history.prune();
-    } else
+    } else {
       this.history.push(chatCompletions);
+    }
   }
 
   addUserMessagesToHistory(messages: string[], unshift = false) {
-    const chatCompletions: ChatCompletionMessageParam[] = messages.map(message => { return { role: 'user', content: message }});
+    const chatCompletions: ChatCompletionMessageParam[] = messages.map((message) => {
+      return { role: 'user', content: message };
+    });
     if (unshift) {
       this.history.getMessages().unshift(...chatCompletions);
       this.history.prune();
-    } else
+    } else {
       this.history.push(chatCompletions);
+    }
   }
 
   async generateResponse(messages: string[], model?: TiktokenModel) {
     await this.enforceTokenLimit(messages, model);
-    return await OpenAi.generateResponse(messages, model, this.history, this.functions, this.messageModerators, this.params.logLevel);
+    return await OpenAi.generateResponse(
+      messages,
+      model,
+      this.history,
+      this.functions,
+      this.messageModerators,
+      this.params.logLevel
+    );
   }
 
   async generateCode(description: string[], model?: TiktokenModel) {
     this.logger.info(`Generating code for description:\n${description.join('\n')}`);
-    const code = await OpenAi.generateCode(description, model, this.history, this.functions, this.messageModerators, !this.generatedCode, this.params.logLevel);
+    const code = await OpenAi.generateCode(
+      description,
+      model,
+      this.history,
+      this.functions,
+      this.messageModerators,
+      !this.generatedCode,
+      this.params.logLevel
+    );
     this.logger.info(`Generated code:\n${code.slice(0, 150)}${code.length > 150 ? '...' : ''}`);
     this.generatedCode = true;
     return code;
   }
 
-  async updateCodeFromFile(codeToUpdateFilePath: string, dependencyCodeFilePaths: string[], description: string, model?: TiktokenModel) {
+  async updateCodeFromFile(
+    codeToUpdateFilePath: string,
+    dependencyCodeFilePaths: string[],
+    description: string,
+    model?: TiktokenModel
+  ) {
     const codeToUpdate = await Fs.readFile(codeToUpdateFilePath);
     let dependencyDescription = `Assume the following exists:\n`;
-    for (let dependencyCodeFilePath of dependencyCodeFilePaths) {
+    for (const dependencyCodeFilePath of dependencyCodeFilePaths) {
       const dependencCode = await Fs.readFile(dependencyCodeFilePath);
       dependencyDescription += dependencCode + '\n\n';
     }
@@ -171,15 +221,34 @@ export class Conversation {
   }
 
   async updateCode(code: string, description: string, model?: TiktokenModel) {
-    this.logger.info(`Updating code:\n${code.slice(0, 150)}${code.length > 150 ? '...' : ''}\nFrom description: ${description}`);
-    const updatedCode = await OpenAi.updateCode(code, description, model, this.history, this.functions, this.messageModerators, !this.generatedCode, this.params.logLevel);
+    this.logger.info(
+      `Updating code:\n${code.slice(0, 150)}${code.length > 150 ? '...' : ''}\nFrom description: ${description}`
+    );
+    const updatedCode = await OpenAi.updateCode(
+      code,
+      description,
+      model,
+      this.history,
+      this.functions,
+      this.messageModerators,
+      !this.generatedCode,
+      this.params.logLevel
+    );
     this.logger.info(`Updated code:\n${updatedCode.slice(0, 150)}${updatedCode.length > 150 ? '...' : ''}`);
     this.generatedCode = true;
     return updatedCode;
   }
 
   async generateList(description: string[], model?: TiktokenModel) {
-    const list = await OpenAi.generateList(description, model, this.history, this.functions, this.messageModerators, !this.generatedList, this.params.logLevel);
+    const list = await OpenAi.generateList(
+      description,
+      model,
+      this.history,
+      this.functions,
+      this.messageModerators,
+      !this.generatedList,
+      this.params.logLevel
+    );
     this.generatedList = true;
     return list;
   }
@@ -199,9 +268,9 @@ export const summarizeConversationHistoryFunction = (conversation: Conversation)
             description: 'A 1-3 sentence summary of the current chat history',
           },
         },
-        required: ['summary']
+        required: ['summary'],
       },
     },
     call: async (params: { summary: string }) => conversation.summarizeConversationHistory(params.summary),
-  }
-}
+  };
+};

package/src/ConversationModule.ts

@@ -2,7 +2,7 @@ import { Function } from './Function';
 import { MessageModerator } from './history/MessageModerator';
 
 export interface ConversationModule {
-  getName(): string,
+  getName(): string;
   getSystemMessages(): string[];
   getFunctions(): Function[];
   getMessageModerators(): MessageModerator[];
@@ -10,4 +10,4 @@ export interface ConversationModule {
 
 export interface ConversationModuleFactory {
   createModule(repoPath: string): Promise<ConversationModule>;
-}
+}

package/src/Function.ts

@@ -1,6 +1,5 @@
 import { ChatCompletionCreateParams } from 'openai/resources/chat';
 
-
 export interface Function {
   definition: ChatCompletionCreateParams.Function;
   call(obj: any): Promise<any>;