Merge pull request #5 from aipotheosis-labs/more_code_example

clean code

Author: jiwei-aipolabs

.eslintrc.json

@@ -22,7 +22,7 @@
     "linebreak-style": ["error", "unix"],
     "quotes": ["error", "single"],
     "semi": ["error", "always"],
-    "@typescript-eslint/no-explicit-any": "warn",
+    "@typescript-eslint/no-explicit-any": "off",
     "@typescript-eslint/explicit-function-return-type": "off",
     "@typescript-eslint/no-unused-vars": "warn"
   },

DEVELOPMENT.md renamed to CONTRIBUTING.md

@@ -30,7 +30,6 @@ cp .env.example .env
 
 2. Add the following environment variables to your `.env` file:
 
-Replace `your_api_key_here` with your actual ACI API key.
 
 ## Development
 
@@ -50,6 +49,7 @@ This will compile the TypeScript code into JavaScript in the `dist` directory.
 > - ARXIV
 > - BRAVE_SEARCH
 > - GITHUB
+> We might need to change test logic so you don't need to do this in the future.
 
 The project uses Jest for testing. To run the tests:
 ```bash 
@@ -58,7 +58,7 @@ pnpm test
 
 To run tests in watch mode during development:
 ```bash
-pnpm test -- --watch
+pnpm runtest
 ```
 
 ### Code Quality
@@ -78,6 +78,8 @@ pnpm run format
 ## Project Structure
 
 ```
+__tests__/            # Test files
+examples/             # Examples
 src/
 ├── index.ts           # Main entry point
 ├── client.ts          # API client implementation
@@ -92,29 +94,14 @@ src/
 ## Publishing
 
 The project uses Changesets for versioning and publishing. To create a new version:
+You need change the version in the `package.json` then commit and push to the main branch.
+The CI will build the project and publish the new version to npm.
 
-1. Create a changeset:
-```bash
-pnpm run changeset
-```
 
-2. Update the version:
-```bash
-pnpm run version
-```
-
-3. Publish to npm:
-```bash
-pnpm run release
-```
 
 ## Contributing
 
 1. Create a new branch for your feature or bugfix
 2. Make your changes
 3. Run tests and ensure they pass
-4. Submit a pull request
-
-## License
-
-This project is licensed under the MIT License - see the LICENSE file for details.
+4. Submit a pull request

__tests__/meta_functions/aci_execute_function_mock.test.ts

@@ -1,9 +1,9 @@
 import { FunctionDefinitionFormat } from '../../src/types/functions';
-import { 
-  ACIExecuteFunction, 
-  getAciExecuteFunctionSchema, 
-  wrapFunctionArgumentsIfNotPresent 
-} from '../../src/meta_functions/aci_execute_function';
+import {
+  ACIExecuteFunction,
+  getAciExecuteFunctionSchema,
+  wrapFunctionArgumentsIfNotPresent,
+} from '../../src/meta_functions/aci-execute-function';
 import { ACI } from '../../src/client';
 import MockAdapter from 'axios-mock-adapter';
 
@@ -55,16 +55,16 @@ describe('ACI_EXECUTE_FUNCTION Meta Function', () => {
       const input = {
         function_name: 'calendar_create_event',
         title: 'Meeting',
-        start_time: '2023-01-01T10:00:00Z'
+        start_time: '2023-01-01T10:00:00Z',
       };
 
       const result = wrapFunctionArgumentsIfNotPresent(input);
       expect(result).toEqual({
         function_name: 'calendar_create_event',
         function_arguments: {
           title: 'Meeting',
-          start_time: '2023-01-01T10:00:00Z'
-        }
+          start_time: '2023-01-01T10:00:00Z',
+        },
       });
     });
 
@@ -73,8 +73,8 @@ describe('ACI_EXECUTE_FUNCTION Meta Function', () => {
         function_name: 'calendar_create_event',
         function_arguments: {
           title: 'Meeting',
-          start_time: '2023-01-01T10:00:00Z'
-        }
+          start_time: '2023-01-01T10:00:00Z',
+        },
       };
 
       const result = wrapFunctionArgumentsIfNotPresent(input);
@@ -85,7 +85,7 @@ describe('ACI_EXECUTE_FUNCTION Meta Function', () => {
   describe('Integration with client', () => {
     const mockResponse = {
       success: true,
-      data: { id: '123', title: 'Meeting' }
+      data: { id: '123', title: 'Meeting' },
     };
 
     it('should call the execute endpoint with the correct parameters', async () => {
@@ -99,10 +99,10 @@ describe('ACI_EXECUTE_FUNCTION Meta Function', () => {
           function_arguments: {
             title: 'Team Meeting',
             start_time: '2023-01-01T10:00:00Z',
-            end_time: '2023-01-01T11:00:00Z'
-          }
+            end_time: '2023-01-01T11:00:00Z',
+          },
         },
-        linkedAccountOwnerId
+        linkedAccountOwnerId,
       });
 
       expect(mock.history.post.length).toBe(1);
@@ -111,9 +111,9 @@ describe('ACI_EXECUTE_FUNCTION Meta Function', () => {
         function_input: {
           title: 'Team Meeting',
           start_time: '2023-01-01T10:00:00Z',
-          end_time: '2023-01-01T11:00:00Z'
+          end_time: '2023-01-01T11:00:00Z',
         },
-        linked_account_owner_id: linkedAccountOwnerId
+        linked_account_owner_id: linkedAccountOwnerId,
       });
       expect(result).toEqual(mockResponse);
     });
@@ -128,27 +128,27 @@ describe('ACI_EXECUTE_FUNCTION Meta Function', () => {
         functionArguments: {
           function_name: 'calendar_create_event',
           title: 'Team Meeting',
-          start_time: '2023-01-01T10:00:00Z'
+          start_time: '2023-01-01T10:00:00Z',
         },
-        linkedAccountOwnerId
+        linkedAccountOwnerId,
       });
 
       expect(mock.history.post.length).toBe(1);
       expect(mock.history.post[0].url).toBe('/functions/calendar_create_event/execute');
       expect(JSON.parse(mock.history.post[0].data)).toEqual({
         function_input: {
           title: 'Team Meeting',
-          start_time: '2023-01-01T10:00:00Z'
+          start_time: '2023-01-01T10:00:00Z',
         },
-        linked_account_owner_id: linkedAccountOwnerId
+        linked_account_owner_id: linkedAccountOwnerId,
       });
       expect(result).toEqual(mockResponse);
     });
 
     it('should handle function execution errors', async () => {
       const errorResponse = {
         success: false,
-        error: 'Invalid parameters'
+        error: 'Invalid parameters',
       };
 
       mock.onPost('/functions/calendar_create_event/execute').reply(200, errorResponse);
@@ -158,13 +158,13 @@ describe('ACI_EXECUTE_FUNCTION Meta Function', () => {
         functionName: 'ACI_EXECUTE_FUNCTION',
         functionArguments: {
           function_name: 'calendar_create_event',
-          function_arguments: { title: 'Meeting' }
+          function_arguments: { title: 'Meeting' },
         },
-        linkedAccountOwnerId
+        linkedAccountOwnerId,
       });
 
       expect(mock.history.post.length).toBe(1);
       expect(result).toEqual(errorResponse);
     });
   });
-}); 
+});

__tests__/meta_functions/aci_handle_execution.test.ts

@@ -1,9 +1,6 @@
 import OpenAI from 'openai';
 import { ACI } from '../../src/client';
-import { 
-  ACISearchFunctions, 
-  ACIExecuteFunction 
-} from '../../src/meta_functions';
+import { ACISearchFunctions, ACIExecuteFunction } from '../../src/meta_functions';
 import { FunctionDefinitionFormat } from '../../src/types/functions';
 // load .env.local
 import dotenv from 'dotenv';
@@ -13,123 +10,121 @@ dotenv.config();
 describe('AI Integration Tests', () => {
   let aciClient: ACI;
   let openaiClient: OpenAI;
-  
+
   beforeAll(() => {
     // Create a real API clients using environment variables
-    aciClient = new ACI({ 
-      apiKey: process.env.TEST_ACI_API_KEY as string
+    aciClient = new ACI({
+      apiKey: process.env.TEST_ACI_API_KEY as string,
     });
-    
+
     openaiClient = new OpenAI({
       apiKey: process.env.TEST_OPENAI_API_KEY as string,
     });
   });
-  
+
   // Helper to extract the first function_call from OpenAI output
   function getFirstFunctionCall(output: any[]) {
     return output.find(item => item.type === 'function_call');
   }
-  
+
   it('completes a full AI workflow: search and execute GitHub star repo', async () => {
     // Get the function schemas in OpenAI format
     const aciSearchFunctionsSchema = ACISearchFunctions.toJsonSchema(
       FunctionDefinitionFormat.OPENAI_RESPONSES
     );
-    
+
     const aciExecuteFunctionSchema = ACIExecuteFunction.toJsonSchema(
       FunctionDefinitionFormat.OPENAI_RESPONSES
     );
-    
+
     // Step 1: Initial user query and function search
     const userMessage = 'Can you star aipotheosis-labs/aci github repo?';
-    
+
     // Using as any to bypass TypeScript errors for the test
     const searchResponse = await openaiClient.responses.create({
       model: 'gpt-4o',
       input: userMessage,
-      tools: [aciSearchFunctionsSchema, aciExecuteFunctionSchema] as any
+      tools: [aciSearchFunctionsSchema, aciExecuteFunctionSchema] as any,
     });
-    
+
     const searchToolCall = getFirstFunctionCall(searchResponse.output);
     expect(searchToolCall).toBeDefined();
-    
+
     if (!searchToolCall || searchToolCall.type !== 'function_call') {
       throw new Error('No tool call returned from OpenAI');
     }
-    
+
     // Verify it's calling the search function
     expect(searchToolCall.name).toBe('ACI_SEARCH_FUNCTIONS');
-    
+
     // Step 2: Handle the ACI search function call
     const searchArguments = JSON.parse(searchToolCall.arguments);
     const searchResults = await aciClient.handleFunctionCall({
       functionName: searchToolCall.name,
       functionArguments: searchArguments,
       linkedAccountOwnerId: 'test-user-id',
       allowedAppsOnly: false,
-      format: FunctionDefinitionFormat.OPENAI_RESPONSES
+      format: FunctionDefinitionFormat.OPENAI_RESPONSES,
     });
-    
+
     // Verify we found the GitHub star repository function
     expect(Array.isArray(searchResults)).toBe(true);
     expect(searchResults.length).toBeGreaterThan(0);
-    
+
     // Find the GitHub star repository function
     const githubStarFunction = searchResults.find(
-      (func: any) => func.function?.name === 'GITHUB__STAR_REPOSITORY' || 
-                    func.name === 'GITHUB__STAR_REPOSITORY'
+      (func: any) =>
+        func.function?.name === 'GITHUB__STAR_REPOSITORY' || func.name === 'GITHUB__STAR_REPOSITORY'
     );
     expect(githubStarFunction).toBeDefined();
-  
-  
+
     // Second OpenAI call to trigger execution
     const executeResponse = await openaiClient.responses.create({
       model: 'gpt-4o',
       input: [
         {
           role: 'system',
           content:
-            "You are a helpful assistant with access to an unlimited number of tools via some meta functions: " +
-            "ACI_SEARCH_FUNCTIONS, and ACI_EXECUTE_FUNCTION. " +
-            "You can use ACI_SEARCH_FUNCTIONS to find relevant functions across all apps. Try to limit the number of results per request to 1. " +
-            "Once you have identified the function you need to use, you can use ACI_EXECUTE_FUNCTION to execute the function provided you have the correct input arguments." +
-            "When you useing ACI_SEARCH_FUNCTIONS, the limit parameter is 10 typically"
+            'You are a helpful assistant with access to an unlimited number of tools via some meta functions: ' +
+            'ACI_SEARCH_FUNCTIONS, and ACI_EXECUTE_FUNCTION. ' +
+            'You can use ACI_SEARCH_FUNCTIONS to find relevant functions across all apps. Try to limit the number of results per request to 1. ' +
+            'Once you have identified the function you need to use, you can use ACI_EXECUTE_FUNCTION to execute the function provided you have the correct input arguments.' +
+            'When you useing ACI_SEARCH_FUNCTIONS, the limit parameter is 10 typically',
         },
         {
           role: 'user',
-          content: userMessage
+          content: userMessage,
         },
         {
-          ...searchToolCall
+          ...searchToolCall,
         },
         {
-          type: "function_call_output",
+          type: 'function_call_output',
           call_id: searchToolCall.call_id,
-          "output": JSON.stringify(searchResults)
-
+          output: JSON.stringify(searchResults),
         },
       ],
-      tools: [aciSearchFunctionsSchema, aciExecuteFunctionSchema] as any
+      tools: [aciSearchFunctionsSchema, aciExecuteFunctionSchema] as any,
     } as any);
-    
+
     // Extract the execution tool call
     const executeToolCall = getFirstFunctionCall(executeResponse.output);
     expect(executeToolCall).toBeDefined();
-    
+
     if (!executeToolCall || executeToolCall.type !== 'function_call') {
       throw new Error('No execution tool call returned from OpenAI');
     }
-    
+
     // Verify it's calling the execute function
     expect(executeToolCall.name).toBe('ACI_EXECUTE_FUNCTION');
-    
+
     // Step 4: Check the execution parameters
     const executeArguments = JSON.parse(executeToolCall.arguments);
     expect(executeArguments.function_name).toBe('GITHUB__STAR_REPOSITORY');
     expect(executeArguments.function_arguments.path.owner).toBe('aipotheosis-labs');
     expect(executeArguments.function_arguments.path.repo).toBe('aci');
-    
+
     // Note: We're not actually executing the function as it would require
     // real GitHub credentials, but we've verified the LLM generates the correct parameters
   }, 60000); // Longer timeout for this complex test
-}); 
+});