Skip to content

Commit 8a0c0c5

Browse files
committed
Update README, ESLint config, TypeScript definitions, and include test files in the TypeScript config.
1 parent 3de4697 commit 8a0c0c5

File tree

6 files changed

+17
-10
lines changed

6 files changed

+17
-10
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Autobox Engine (TypeScript)
1+
# Autobox Engine
22

33
> Multi-agent AI simulation runtime engine powered by TypeScript, BullMQ, and OpenAI
44
@@ -133,23 +133,27 @@ The API server will be available at `http://localhost:3000` with Swagger documen
133133
The project includes four example simulations in `examples/simulations/`:
134134

135135
### 1. Summer Vacation Planning
136+
136137
**File**: `summer_vacation.json`
137138
**Scenario**: A couple (ANA and JOHN) decides on a vacation destination
138139
**Agents**: 2 workers
139140
**Use Case**: Decision-making, negotiation, relationship dynamics
140141

141142
### 2. Crime Detective
143+
142144
**File**: `crime_detective.json`
143145
**Scenario**: Detective solves a murder at a high-society gala
144146
**Agents**: DETECTIVE, SINGER, DRIVER, BANKER
145147
**Use Case**: Mystery solving, interrogation, deduction
146148

147149
### 3. Gift Choice
150+
148151
**File**: `gift_choice.json`
149152
**Scenario**: Selecting the perfect gift
150153
**Use Case**: Preference elicitation, recommendation
151154

152155
### 4. Nordic Team Planning
156+
153157
**File**: `nordic_team.json`
154158
**Scenario**: Software development project planning
155159
**Agents**: Team with Nordic names
@@ -199,17 +203,20 @@ yarn test
199203
## API Endpoints
200204

201205
### Health & Information
206+
202207
- `GET /health` - Health check
203208
- `GET /ping` - Simple ping endpoint
204209
- `GET /v1/info` - Get agent information (names and IDs)
205210

206211
### Simulation Control
212+
207213
- `GET /v1/status` - Get current simulation status
208214
- `GET /v1/metrics` - Get simulation metrics
209215
- `POST /v1/instructions/agents/:agent_id` - Send instruction to specific agent
210216
- `POST /v1/abort` - Abort running simulation
211217

212218
### Documentation
219+
213220
- `GET /` - OpenAPI specification (JSON)
214221
- `GET /docs` - Interactive Swagger UI
215222

@@ -430,6 +437,7 @@ ISC License - see LICENSE file for details
430437
## Support
431438

432439
For questions and support:
440+
433441
- Open an issue on GitHub
434442
- Check the [CLAUDE.md](CLAUDE.md) file for detailed development guidance
435443

eslint.config.js renamed to eslint.config.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,6 @@ export default [
3131
},
3232
},
3333
{
34-
ignores: ['dist/**', 'node_modules/**', '*.js', '*.cjs', '*.mjs'],
34+
ignores: ['dist/**', 'node_modules/**', '*.js', '*.cjs', '*.mjs', 'tests/**'],
3535
},
3636
];

src/clients/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
export { createStreamRedisClient, getRedisClient, initializeRedisClient } from "./redis";
1+
export { createStreamRedisClient, getRedisClient, initializeRedisClient } from './redis';

src/core/llm/createAiProcessor.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ export const createAiProcessor = ({
2424
}: {
2525
name: string;
2626
messages: ChatCompletionMessageParam[];
27-
}): Promise<any> => {
27+
}): Promise<z.infer<typeof schema> | string | null> => {
2828
logger.info(`[${name}] thinking...`);
2929

3030
const completionMessages = [
@@ -40,7 +40,7 @@ export const createAiProcessor = ({
4040
if (schema) {
4141
completionParams = {
4242
...completionParams,
43-
response_format: zodResponseFormat(schema as any, 'output'),
43+
response_format: zodResponseFormat(schema, 'output'),
4444
};
4545
}
4646

src/utils/zodParse.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { z, ZodError, ZodType } from 'zod';
22
import { logger } from '../config';
33

4-
export const zodParse = <Schema extends ZodType<any>>(
4+
export const zodParse = <Schema extends ZodType>(
55
schema: Schema,
66
input: unknown
77
): z.infer<Schema> => {

tsconfig.json

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,11 @@
2828
"experimentalDecorators": true
2929
},
3030
"include": [
31-
"src/**/*"
31+
"src/**/*",
32+
"tests/**/*"
3233
],
3334
"exclude": [
3435
"node_modules",
35-
"dist",
36-
"**/*.test.ts",
37-
"**/*.spec.ts"
36+
"dist"
3837
]
3938
}

0 commit comments

Comments
 (0)