genaicode 0.0.35 → 0.0.37

package/src/prompt/function-defs/download-file.js

@@ -0,0 +1,25 @@
+/**
+ * Function definition for downloadFile
+ */
+export const downloadFile = {
+  name: 'downloadFile',
+  description: 'Download file from url, and save to file',
+  parameters: {
+    type: 'object',
+    properties: {
+      filePath: {
+        type: 'string',
+        description: 'The file path to save the downloaded file.',
+      },
+      downloadUrl: {
+        type: 'string',
+        description: 'The url of the file that will be used for downloading.',
+      },
+      explanation: {
+        type: 'string',
+        description: 'The reasoning behind downloading this image.',
+      },
+    },
+    required: ['filePath', 'downloadUrl'],
+  },
+};

package/src/prompt/function-defs/explanation.js

@@ -0,0 +1,17 @@
+/**
+ * Function definition for explanation
+ */
+export const explanation = {
+  name: 'explanation',
+  description: 'Explain the reasoning behind the suggested code changes or reasoning for lack of code changes',
+  parameters: {
+    type: 'object',
+    properties: {
+      text: {
+        type: 'string',
+        description: 'The explanation text',
+      },
+    },
+    required: ['text'],
+  },
+};

package/src/prompt/function-defs/generate-image.js

@@ -0,0 +1,51 @@
+/**
+ * Function definition for generateImage
+ */
+export const generateImage = {
+  name: 'generateImage',
+  description: 'Generate an image using AI service and save it as a file.',
+  parameters: {
+    type: 'object',
+    properties: {
+      prompt: {
+        type: 'string',
+        description:
+          'The prompt that will be used to generate the image. This prompt must be detailed, it will be used by image generation model.',
+      },
+      filePath: {
+        type: 'string',
+        description: 'The file path to save the generated image.',
+      },
+      contextImagePath: {
+        type: 'string',
+        description:
+          'Path to a image file that will be used as a context for image generation. It is useful if there is a need to edit an image with genAI.',
+      },
+      size: {
+        type: 'object',
+        properties: {
+          width: {
+            type: 'number',
+            description: 'width of the image',
+          },
+          height: {
+            type: 'number',
+            description: 'height of the image',
+          },
+        },
+        required: ['width', 'height'],
+        description: 'The size of the image to generate.',
+      },
+      cheap: {
+        type: 'boolean',
+        description:
+          'true value means that the prompt will be executed with cheaper model, which work faster, but provides lower quality results, so please use it only in situation when lower quality results are acceptable for the prompt.',
+      },
+      explanation: {
+        type: 'string',
+        description: 'The explanation of the reasoning behind generating this image',
+      },
+    },
+    required: ['prompt', 'filePath', 'size', 'cheap'],
+  },
+};

package/src/prompt/function-defs/get-image-assets.js

@@ -0,0 +1,21 @@
+/**
+ * Function definition for getImageAssets
+ */
+export const getImageAssets = {
+  name: 'getImageAssets',
+  description:
+    'This function returns a map of application image assets. This map contains absolute file path, and basic metadata information. It does not contain contents. Contents must be requested using dedicated tool.',
+  parameters: {
+    type: 'object',
+    properties: {
+      filePaths: {
+        type: 'array',
+        description: 'An array of absolute paths of files that should be used to provided context.',
+        items: {
+          type: 'string',
+        },
+      },
+    },
+    required: [],
+  },
+};

package/src/prompt/function-defs/get-source-code.js

@@ -0,0 +1,21 @@
+/**
+ * Function definition for getSourceCode
+ */
+export const getSourceCode = {
+  name: 'getSourceCode',
+  description:
+    'This function returns source code of the application in Map format, where absolute file path is the key, and the value is an object, where one of the properties may be the content of the file. Some keys may not provide content. This function can be called only once during the conversation, and only if suggested by the user.',
+  parameters: {
+    type: 'object',
+    properties: {
+      filePaths: {
+        type: 'array',
+        description: 'An array of absolute paths of files that should be used to provided context.',
+        items: {
+          type: 'string',
+        },
+      },
+    },
+    required: [],
+  },
+};

package/src/prompt/function-defs/imgly-remove-background.js

@@ -0,0 +1,25 @@
+/**
+ * Function definition for imglyRemoveBackground
+ */
+export const imglyRemoveBackground = {
+  name: 'imglyRemoveBackground',
+  description: 'Removes background from an image using @imgly/background-removal-node',
+  parameters: {
+    type: 'object',
+    properties: {
+      inputFilePath: {
+        type: 'string',
+        description: 'The file path of the input image.',
+      },
+      outputFilePath: {
+        type: 'string',
+        description: 'The file path to save the output image with removed background.',
+      },
+      explanation: {
+        type: 'string',
+        description: 'The explanation of the reasoning behind removing the background from this image',
+      },
+    },
+    required: ['inputFilePath', 'outputFilePath'],
+  },
+};

package/src/prompt/function-defs/move-file.js

@@ -0,0 +1,25 @@
+/**
+ * Function definition for moveFile
+ */
+export const moveFile = {
+  name: 'moveFile',
+  description: 'Move a file from one location to another',
+  parameters: {
+    type: 'object',
+    properties: {
+      source: {
+        type: 'string',
+        description: 'The current file path.',
+      },
+      destination: {
+        type: 'string',
+        description: 'The new file path.',
+      },
+      explanation: {
+        type: 'string',
+        description: 'The explanation of the reasoning behind moving this file',
+      },
+    },
+    required: ['source', 'destination'],
+  },
+};

package/src/prompt/function-defs/patch-file.js

@@ -0,0 +1,39 @@
+/**
+ * Function definition for patchFile
+ */
+export const patchFile = {
+  name: 'patchFile',
+  description:
+    'Partially update a file content. The file must already exists in the application source code. The function should be called only if there is a need to actually change something.',
+  parameters: {
+    type: 'object',
+    properties: {
+      filePath: {
+        type: 'string',
+        description: 'The file path to patch.',
+      },
+      patch: {
+        type: 'string',
+        description: `Modification to the file expressed in patch format. Example patch:
+
+\`\`\`
+Index: filename.js
+===================================================================
+--- filename.js
++++ filename.js
+@@ -1,2 +1,3 @@
+ line1
++line3
+ line2
+\
+\`\`\`
+          `,
+      },
+      explanation: {
+        type: 'string',
+        description: 'The explanation of the reasoning behind the suggested code changes for this file',
+      },
+    },
+    required: ['filePath', 'patch'],
+  },
+};

package/src/prompt/function-defs/resize-image.js

@@ -0,0 +1,36 @@
+/**
+ * Function definition for resizeImage
+ */
+export const resizeImage = {
+  name: 'resizeImage',
+  description: 'Resize image to the desired size',
+  parameters: {
+    type: 'object',
+    properties: {
+      filePath: {
+        type: 'string',
+        description: 'The file path of the image.',
+      },
+      size: {
+        type: 'object',
+        properties: {
+          width: {
+            type: 'number',
+            description: 'width of the image',
+          },
+          height: {
+            type: 'number',
+            description: 'height of the image',
+          },
+        },
+        required: ['width', 'height'],
+        description: 'The size of the image to generate.',
+      },
+      explanation: {
+        type: 'string',
+        description: 'The explanation of the reasoning behind removing the background from this image',
+      },
+    },
+    required: ['filePath', 'size'],
+  },
+};

package/src/prompt/function-defs/split-image.js

@@ -0,0 +1,45 @@
+/**
+ * Function definition for splitImage
+ */
+export const splitImage = {
+  name: 'splitImage',
+  description: 'Split an image into multiple parts and save them as separate files.',
+  parameters: {
+    type: 'object',
+    properties: {
+      inputFilePath: {
+        type: 'string',
+        description: 'The file path of the input image to be split.',
+      },
+      parts: {
+        type: 'array',
+        items: {
+          type: 'object',
+          properties: {
+            rect: {
+              type: 'object',
+              properties: {
+                x: { type: 'number', description: 'The x-coordinate of the top-left corner of the rectangle.' },
+                y: { type: 'number', description: 'The y-coordinate of the top-left corner of the rectangle.' },
+                width: { type: 'number', description: 'The width of the rectangle.' },
+                height: { type: 'number', description: 'The height of the rectangle.' },
+              },
+              required: ['x', 'y', 'width', 'height'],
+            },
+            outputFilePath: {
+              type: 'string',
+              description: 'The file path to save the extracted part of the image.',
+            },
+          },
+          required: ['rect', 'outputFilePath'],
+        },
+        description: 'An array of parts to extract from the image, each with a rectangle and output file path.',
+      },
+      explanation: {
+        type: 'string',
+        description: 'The explanation of the reasoning behind splitting this image',
+      },
+    },
+    required: ['inputFilePath', 'parts'],
+  },
+};

package/src/prompt/function-defs/update-file.js

@@ -0,0 +1,26 @@
+/**
+ * Function definition for updateFile
+ */
+export const updateFile = {
+  name: 'updateFile',
+  description:
+    'Update a file with new content. The file must already exists in the application source code. The function should be called only if there is a need to actually change something.',
+  parameters: {
+    type: 'object',
+    properties: {
+      filePath: {
+        type: 'string',
+        description: 'The file path to update.',
+      },
+      newContent: {
+        type: 'string',
+        description: 'The content to update the file with. Must not be empty.',
+      },
+      explanation: {
+        type: 'string',
+        description: 'The explanation of the reasoning behind the suggested code changes for this file',
+      },
+    },
+    required: ['filePath', 'newContent'],
+  },
+};

package/src/prompt/prompt-service-ask-question.test.js

@@ -0,0 +1,163 @@
+import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
+import { promptService } from './prompt-service.js';
+import * as vertexAi from '../ai-service/vertex-ai.js';
+import * as readline from 'readline';
+import '../cli/cli-params.js';
+import '../files/read-files.js';
+import '../files/find-files.js';
+
+vi.mock('../ai-service/vertex-ai.js', () => ({ generateContent: vi.fn() }));
+vi.mock('readline', () => ({
+  createInterface: vi.fn(),
+}));
+vi.mock('../cli/cli-params.js', () => ({
+  requireExplanations: false,
+  considerAllFiles: false,
+  dependencyTree: false,
+  explicitPrompt: false,
+  allowFileCreate: false,
+  allowFileDelete: false,
+  allowDirectoryCreate: false,
+  allowFileMove: false,
+  verbosePrompt: false,
+  disableContextOptimization: false,
+  vision: false,
+  imagen: false,
+  temperature: 0.7,
+  cheap: false,
+  askQuestion: true,
+}));
+
+// Mock find-files module
+vi.mock('../files/find-files.js', () => ({
+  getSourceFiles: () => [],
+  getImageAssetFiles: () => [],
+}));
+
+// Mock read-files module
+vi.mock('../files/read-files.js', () => ({
+  getSourceCode: () => ({}),
+  getImageAssets: vi.fn(() => ({})),
+}));
+
+vi.mock('../main/config.js', () => ({
+  rootDir: '/mocked/root/dir',
+  rcConfig: {
+    rootDir: '.',
+    extensions: ['.js', '.ts', '.tsx', '.jsx'],
+  },
+}));
+
+describe('promptService with askQuestion', () => {
+  let mockReadline;
+
+  beforeEach(() => {
+    vi.resetAllMocks();
+    console.log = vi.fn();
+
+    mockReadline = {
+      question: vi.fn(),
+      close: vi.fn(),
+    };
+    vi.spyOn(readline, 'createInterface').mockReturnValue(mockReadline);
+  });
+
+  afterEach(() => {
+    vi.clearAllMocks();
+  });
+
+  it('should handle askQuestion when enabled', async () => {
+    const mockAskQuestionCall = [
+      {
+        name: 'askQuestion',
+        args: {
+          content: 'Do you want to proceed with code generation?',
+          shouldPrompt: true,
+          promptNecessity: 80,
+          stopCodegen: false,
+        },
+      },
+    ];
+    const mockAskQuestionCall2 = [
+      {
+        name: 'askQuestion',
+        args: {
+          content: 'Ok lets go',
+          shouldPrompt: false,
+          promptNecessity: 80,
+          stopCodegen: false,
+        },
+      },
+    ];
+    const mockCodegenSummary = [
+      {
+        name: 'codegenSummary',
+        args: {
+          fileUpdates: [],
+          contextPaths: [],
+          explanation: 'No updates needed',
+        },
+      },
+    ];
+
+    vertexAi.generateContent
+      .mockResolvedValueOnce(mockAskQuestionCall)
+      .mockResolvedValueOnce(mockAskQuestionCall2)
+      .mockResolvedValueOnce(mockCodegenSummary);
+
+    mockReadline.question.mockImplementationOnce((_, callback) => {
+      callback('Yes');
+    });
+
+    await promptService(vertexAi.generateContent);
+
+    expect(vertexAi.generateContent).toHaveBeenCalledTimes(3);
+    expect(mockReadline.question).toHaveBeenCalledWith('Your answer: ', expect.any(Function));
+    expect(console.log).toHaveBeenCalledWith('Assistant asks:', expect.any(Object));
+    expect(console.log).toHaveBeenCalledWith('The question was answered');
+  });
+
+  it('should stop code generation when askQuestion returns stopCodegen: true', async () => {
+    const mockAskQuestionCall = [
+      {
+        name: 'askQuestion',
+        args: {
+          content: 'Stopping code generation as requested.',
+          shouldPrompt: false,
+          promptNecessity: 100,
+          stopCodegen: true,
+        },
+      },
+    ];
+
+    vertexAi.generateContent.mockResolvedValueOnce(mockAskQuestionCall);
+
+    const result = await promptService(vertexAi.generateContent);
+
+    expect(vertexAi.generateContent).toHaveBeenCalledTimes(1);
+    expect(result).toEqual([]);
+    expect(console.log).toHaveBeenCalledWith('Assistant requested to stop code generation. Exiting...');
+  });
+
+  it('should proceed with code generation when askQuestion returns shouldPrompt: false', async () => {
+    const mockAskQuestionCall = [];
+    const mockCodegenSummary = [
+      {
+        name: 'codegenSummary',
+        args: {
+          fileUpdates: [],
+          contextPaths: [],
+          explanation: 'No updates needed',
+        },
+      },
+    ];
+
+    vertexAi.generateContent.mockResolvedValueOnce(mockAskQuestionCall).mockResolvedValueOnce(mockCodegenSummary);
+
+    await promptService(vertexAi.generateContent);
+
+    expect(vertexAi.generateContent).toHaveBeenCalledTimes(2);
+    expect(mockReadline.question).not.toHaveBeenCalled();
+    expect(console.log).toHaveBeenCalledWith('Assistant did not ask a question. Proceeding with code generation.');
+  });
+});

package/src/prompt/prompt-service.js

@@ -2,12 +2,13 @@ import assert from 'node:assert';
 import fs from 'fs';
 import * as diff from 'diff';
 import mime from 'mime-types';
+import { createInterface } from 'readline';
 
 import { getSystemPrompt } from './systemprompt.js';
 import { getCodeGenPrompt } from './prompt-codegen.js';
 import { functionDefs } from './function-calling.js';
 import { getSourceCode, getImageAssets } from '../files/read-files.js';
-import { disableContextOptimization, temperature, vision, cheap } from '../cli/cli-params.js';
+import { disableContextOptimization, temperature, vision, cheap, askQuestion } from '../cli/cli-params.js';
 import { validateFunctionCall } from './function-calling-validate.js';
 
 /** A function that communicates with model using */
@@ -26,24 +27,56 @@ export async function promptService(generateContentFn, generateImageFn, codegenP
   const getSourceCodeResponse = {
     type: 'user',
     functionResponses: [{ name: 'getSourceCode', content: messages.sourceCode }],
+    cache: true,
   };
   prompt.push(getSourceCodeResponse);
 
   if (vision) {
     prompt.slice(-1)[0].text = messages.suggestImageAssets;
     prompt.push(
-      ...[
-        { type: 'assistant', text: messages.requestImageAssets, functionCalls: [{ name: 'getImageAssets' }] },
-        {
-          type: 'user',
-          functionResponses: [{ name: 'getImageAssets', content: messages.imageAssets }],
-        },
-      ],
+      { type: 'assistant', text: messages.requestImageAssets, functionCalls: [{ name: 'getImageAssets' }] },
+      { type: 'user', functionResponses: [{ name: 'getImageAssets', content: messages.imageAssets }] },
     );
   }
 
   prompt.slice(-1)[0].text = messages.prompt;
 
+  // New step: Allow the assistant to ask a question if --ask-question is enabled
+  if (askQuestion) {
+    console.log('Allowing the assistant to ask a question...');
+    let questionAsked = false;
+    while (!questionAsked) {
+      const askQuestionResult = await generateContentFn(prompt, functionDefs, 'askQuestion', temperature, cheap);
+      const askQuestionCall = askQuestionResult.find((call) => call.name === 'askQuestion');
+      if (askQuestionCall) {
+        console.log('Assistant asks:', askQuestionCall.args);
+        const userAnswer = askQuestionCall.args.shouldPrompt
+          ? await getUserInput('Your answer: ')
+          : 'Lets proceed with code generation.';
+        prompt.push(
+          { type: 'assistant', functionCalls: [askQuestionCall] },
+          {
+            type: 'user',
+            text: userAnswer,
+            functionResponses: [{ name: 'askQuestion', call_id: askQuestionCall.id }],
+          },
+        );
+        console.log('The question was answered');
+        if (askQuestionCall.args.stopCodegen) {
+          console.log('Assistant requested to stop code generation. Exiting...');
+          return [];
+        }
+        if (!askQuestionCall.args.shouldPrompt) {
+          console.log('Proceeding with code generation.');
+          break;
+        }
+      } else {
+        console.log('Assistant did not ask a question. Proceeding with code generation.');
+        break;
+      }
+    }
+  }
+
   let baseRequest = [prompt, functionDefs, 'codegenSummary', temperature, cheap];
   let baseResult = await generateContentFn(...baseRequest);
 
@@ -78,6 +111,7 @@ export async function promptService(generateContentFn, generateImageFn, codegenP
     prompt.push({
       type: 'user',
       functionResponses: baseResult.map((call) => ({ name: call.name, call_id: call.id })),
+      cache: true,
     });
 
     const result = [];
@@ -285,3 +319,17 @@ function prepareMessages(prompt) {
       'Function call was invalid, please analyze the error and respond with corrected function call.',
   };
 }
+
+async function getUserInput(prompt) {
+  const rl = createInterface({
+    input: process.stdin,
+    output: process.stdout,
+  });
+
+  return new Promise((resolve) => {
+    rl.question(prompt, (answer) => {
+      rl.close();
+      resolve(answer);
+    });
+  });
+}

package/src/prompt/prompt-service.test.js

@@ -31,6 +31,7 @@ vi.mock('../cli/cli-params.js', () => ({
   imagen: false,
   temperature: 0.7,
   cheap: false,
+  askQuestion: false,
 }));
 vi.mock('fs');
 vi.mock('diff');

package/src/prompt/systemprompt.js

@@ -1,5 +1,5 @@
 import { CODEGEN_TRIGGER } from './prompt-consts.js';
-import { verbosePrompt } from '../cli/cli-params.js';
+import { verbosePrompt, askQuestion } from '../cli/cli-params.js';
 import { verifySystemPromptLimit } from './limits.js';
 import { rcConfig } from '../main/config.js';
 
@@ -21,6 +21,13 @@ export function getSystemPrompt() {
   When suggesting changes always use absolute file paths.
   `;
 
+  if (askQuestion) {
+    systemPrompt +=
+      '\nYou have the ability to ask the user a question at the beginning of the conversation if you need more information or clarification. ' +
+      'Use this feature wisely to gather any crucial information that would help you better understand the task or provide more accurate code generation. ' +
+      "To ask a question, use the 'askQuestion' function.";
+  }
+
   if (verbosePrompt) {
     console.log('System prompt:');
     console.log(systemPrompt);

package/src/prompt/systemprompt.test.js

@@ -14,6 +14,7 @@ vi.mock('../cli/cli-params.js', () => ({
   allowDirectoryCreate: false,
   allowFileMove: false,
   verbosePrompt: false,
+  askQuestion: false,
 }));
 
 vi.mock('../files/find-files.js', () => ({