Merge pull request #1 from aipotheosis-labs/resource_api

beta version: support apps, app configuration, linked accounts, functions and meta function endpoint

Author: jiwei-aipolabs

.env.example

@@ -0,0 +1,8 @@
+TEST_ACI_API_KEY="xx"
+TEST_BASE_URL=https://api.aci.dev/v1
+TEST_PROJECT_ID=5f263205-7900-4a0e-bf85-0e1a3d898664
+TEST_AGENT_ID=b5378229-f0d9-4219-a6e5-18fdec8391b4
+TEST_LINKED_ACCOUNT_OWNER_ID = [email protected]
+TEST_APP_NAME = ARXIV
+TEST_FUNCTION_NAME = ARXIV__SEARCH_PAPERS
+TEST_OPENAI_API_KEY = "xx"

.eslintignore

@@ -0,0 +1,3 @@
+dist
+node_modules
+coverage 

.eslintrc.json

@@ -0,0 +1,30 @@
+{
+  "env": {
+    "browser": true,
+    "es2021": true,
+    "node": true,
+    "jest": true
+  },
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "sourceType": "module"
+  },
+  "plugins": [
+    "@typescript-eslint"
+  ],
+  "rules": {
+    "indent": ["error", 2, { "SwitchCase": 1 }],
+    "linebreak-style": ["error", "unix"],
+    "quotes": ["error", "single"],
+    "semi": ["error", "always"],
+    "@typescript-eslint/no-explicit-any": "warn",
+    "@typescript-eslint/explicit-function-return-type": "off",
+    "@typescript-eslint/no-unused-vars": "warn"
+  },
+  "ignorePatterns": ["dist/**/*"]
+} 

.prettierrc

@@ -0,0 +1,9 @@
+{
+  "singleQuote": true,
+  "trailingComma": "es5",
+  "tabWidth": 2,
+  "semi": true,
+  "printWidth": 100,
+  "bracketSpacing": true,
+  "arrowParens": "avoid"
+} 

DEVELOPMENT.md

@@ -0,0 +1,125 @@
+# ACI TypeScript SDK Development Guide
+
+This guide provides instructions for setting up and developing the ACI TypeScript SDK locally.
+
+## Prerequisites
+
+- Node.js (v16 or higher)
+- pnpm (recommended) or npm
+- Git
+
+## Installation
+
+1. Clone the repository:
+```bash
+git clone https://github.com/aipotheosis-labs/aci-typescript-sdk.git
+cd aci-typescript-sdk
+```
+
+2. Install dependencies:
+```bash
+pnpm install
+```
+
+## Environment Configuration
+
+1. Create a `.env` file in the root directory:
+```bash
+cp .env.example .env
+```
+
+2. Add the following environment variables to your `.env` file:
+```env
+# API Configuration
+ACI_API_KEY=your_api_key_here
+ACI_API_URL=https://api.aipolabs.com/v1  # or your custom API URL
+```
+
+Replace `your_api_key_here` with your actual ACI API key.
+
+## Development
+
+### Building the Project
+
+To build the TypeScript code:
+```bash
+pnpm run build
+```
+
+This will compile the TypeScript code into JavaScript in the `dist` directory.
+
+### Running Tests
+
+> [!IMPORTANT]
+> You need to configure following app configurations in your ACI account to run the tests:
+> - ARXIV
+> - BRAVE_SEARCH
+> - GITHUB
+
+The project uses Jest for testing. To run the tests:
+```bash 
+pnpm test
+```
+
+To run tests in watch mode during development:
+```bash
+pnpm test -- --watch
+```
+
+### Code Quality
+
+The project uses ESLint for linting and Prettier for code formatting.
+
+To run the linter:
+```bash
+pnpm run lint
+```
+
+To format your code:
+```bash
+pnpm run format
+```
+
+## Project Structure
+
+```
+src/
+├── index.ts           # Main entry point
+├── client.ts          # API client implementation
+├── constants.ts       # SDK constants
+├── exceptions.ts      # Custom exceptions
+├── meta_functions/    # Meta functions implementation
+├── resource/          # Resource implementations
+├── schemas/           # Zod schemas
+└── types/            # TypeScript type definitions
+```
+
+## Publishing
+
+The project uses Changesets for versioning and publishing. To create a new version:
+
+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.

__tests__/client.test.ts

@@ -1,8 +1,6 @@
-import axios, { AxiosError, InternalAxiosRequestConfig } from 'axios';
 import MockAdapter from 'axios-mock-adapter';
 import { ACI } from '../src/client';
-import { DEFAULT_MAX_RETRIES } from '../src/constants';
-import { UnknownError, RateLimitError, ServerError, ValidationError } from '../src/exceptions';
+import { ValidationError } from '../src/exceptions';
 
 describe('ACI Client', () => {
   let client: ACI;
@@ -39,7 +37,7 @@ describe('ACI Client', () => {
       const searchPromise = client.apps.search({});
       await jest.runAllTimersAsync(); // Ensure timers related to retry delays are processed
       const result = await searchPromise;
-      
+
       expect(mock.history.get.length).toBe(2);
       expect(mock.history.get[0].url).toBe('/apps/search');
       expect(mock.history.get[1].url).toBe('/apps/search');
@@ -59,7 +57,7 @@ describe('ACI Client', () => {
       const searchPromise = client.apps.search({});
       await jest.runAllTimersAsync();
       const result = await searchPromise;
-      
+
       expect(mock.history.get.length).toBe(2);
       expect(mock.history.get[0].url).toBe('/apps/search');
       expect(mock.history.get[1].url).toBe('/apps/search');
@@ -79,7 +77,7 @@ describe('ACI Client', () => {
       const searchPromise = client.apps.search({});
       await jest.runAllTimersAsync();
       const result = await searchPromise;
-      
+
       expect(mock.history.get.length).toBe(2);
       expect(mock.history.get[0].url).toBe('/apps/search');
       expect(mock.history.get[1].url).toBe('/apps/search');
@@ -96,4 +94,4 @@ describe('ACI Client', () => {
       expect(mock.history.get[0].url).toBe('/apps/search');
     });
   });
-}); 
+});

__tests__/meta_functions/aci_execute_function_mock.test.ts

@@ -0,0 +1,170 @@
+import { FunctionDefinitionFormat } from '../../src/types/functions';
+import { 
+  ACIExecuteFunction, 
+  getAciExecuteFunctionSchema, 
+  wrapFunctionArgumentsIfNotPresent 
+} from '../../src/meta_functions/aci_execute_function';
+import { ACI } from '../../src/client';
+import MockAdapter from 'axios-mock-adapter';
+
+describe('ACI_EXECUTE_FUNCTION Meta Function', () => {
+  let client: ACI;
+  let mock: MockAdapter;
+  const mockApiKey = 'test-api-key';
+
+  beforeEach(() => {
+    client = new ACI({ apiKey: mockApiKey });
+    mock = new MockAdapter(client['client']);
+  });
+
+  afterEach(() => {
+    mock.reset();
+  });
+
+  describe('Schema', () => {
+    it('should have the correct name and description', () => {
+      const schema = getAciExecuteFunctionSchema();
+      expect(schema.name).toBe('ACI_EXECUTE_FUNCTION');
+      expect(schema.description).toContain('Execute a specific retrieved function');
+    });
+
+    it('should have the required properties', () => {
+      const schema = getAciExecuteFunctionSchema();
+      expect(schema.parameters.properties).toHaveProperty('function_name');
+      expect(schema.parameters.properties).toHaveProperty('function_arguments');
+      expect(schema.parameters.required).toContain('function_name');
+      expect(schema.parameters.required).toContain('function_arguments');
+    });
+
+    it('should format schema for OpenAI correctly', () => {
+      const openAISchema = ACIExecuteFunction.toJsonSchema(FunctionDefinitionFormat.OPENAI);
+      expect(openAISchema).toHaveProperty('type', 'function');
+      expect(openAISchema).toHaveProperty('function');
+      expect(openAISchema.function).toHaveProperty('name', 'ACI_EXECUTE_FUNCTION');
+    });
+
+    it('should format schema for Anthropic correctly', () => {
+      const anthropicSchema = ACIExecuteFunction.toJsonSchema(FunctionDefinitionFormat.ANTHROPIC);
+      expect(anthropicSchema).toHaveProperty('name', 'ACI_EXECUTE_FUNCTION');
+      expect(anthropicSchema).toHaveProperty('input_schema');
+    });
+  });
+
+  describe('wrapFunctionArgumentsIfNotPresent helper', () => {
+    it('should wrap arguments when function_arguments is not present', () => {
+      const input = {
+        function_name: 'calendar_create_event',
+        title: 'Meeting',
+        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'
+        }
+      });
+    });
+
+    it('should not modify input if function_arguments is already present', () => {
+      const input = {
+        function_name: 'calendar_create_event',
+        function_arguments: {
+          title: 'Meeting',
+          start_time: '2023-01-01T10:00:00Z'
+        }
+      };
+
+      const result = wrapFunctionArgumentsIfNotPresent(input);
+      expect(result).toEqual(input);
+    });
+  });
+
+  describe('Integration with client', () => {
+    const mockResponse = {
+      success: true,
+      data: { id: '123', title: 'Meeting' }
+    };
+
+    it('should call the execute endpoint with the correct parameters', async () => {
+      mock.onPost('/functions/calendar_create_event/execute').reply(200, mockResponse);
+
+      const linkedAccountOwnerId = 'user-123';
+      const result = await client.handleFunctionCall(
+        'ACI_EXECUTE_FUNCTION',
+        {
+          function_name: 'calendar_create_event',
+          function_arguments: {
+            title: 'Team Meeting',
+            start_time: '2023-01-01T10:00:00Z',
+            end_time: '2023-01-01T11:00:00Z'
+          }
+        },
+        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',
+          end_time: '2023-01-01T11:00:00Z'
+        },
+        linked_account_owner_id: linkedAccountOwnerId
+      });
+      expect(result).toEqual(mockResponse);
+    });
+
+    it('should handle unwrapped function arguments', async () => {
+      mock.onPost('/functions/calendar_create_event/execute').reply(200, mockResponse);
+
+      const linkedAccountOwnerId = 'user-123';
+      // Note: function_arguments is not wrapped
+      const result = await client.handleFunctionCall(
+        'ACI_EXECUTE_FUNCTION',
+        {
+          function_name: 'calendar_create_event',
+          title: 'Team Meeting',
+          start_time: '2023-01-01T10:00:00Z'
+        },
+        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'
+        },
+        linked_account_owner_id: linkedAccountOwnerId
+      });
+      expect(result).toEqual(mockResponse);
+    });
+
+    it('should handle function execution errors', async () => {
+      const errorResponse = {
+        success: false,
+        error: 'Invalid parameters'
+      };
+
+      mock.onPost('/functions/calendar_create_event/execute').reply(200, errorResponse);
+
+      const linkedAccountOwnerId = 'user-123';
+      const result = await client.handleFunctionCall(
+        'ACI_EXECUTE_FUNCTION',
+        {
+          function_name: 'calendar_create_event',
+          function_arguments: { title: 'Meeting' }
+        },
+        linkedAccountOwnerId
+      );
+
+      expect(mock.history.post.length).toBe(1);
+      expect(result).toEqual(errorResponse);
+    });
+  });
+});