Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
101 changes: 100 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,32 @@ You can install the A2A SDK using `npm`.
npm install @a2a-js/sdk
```

### For Server Usage
### A2A Server

If you plan to use the A2A server functionality (`A2AExpressApp`), you'll also need to install Express as it's a peer dependency:

```bash
npm install express
```

### Persistent Task Storage

For production deployments requiring persistent task storage, install Drizzle ORM, a database driver, and drizzle-kit for migrations:

```bash
# SQLite
npm install drizzle-orm better-sqlite3
npm install -D drizzle-kit

# PostgreSQL
npm install drizzle-orm pg
npm install -D drizzle-kit

# MySQL
npm install drizzle-orm mysql2
npm install -D drizzle-kit
```

You can also find JavaScript samples [here](https://github.com/google-a2a/a2a-samples/tree/main/samples/js).

---
Expand Down Expand Up @@ -669,6 +687,87 @@ app.post('/webhook/task-updates', (req, res) => {
});
```

---

## Persistent Task Storage

By default, the SDK provides an `InMemoryTaskStore` which stores tasks in memory. For production deployments, use the `DatabaseTaskStore` with Drizzle ORM to persist tasks to SQLite, PostgreSQL, or MySQL.

### Quick Setup

**1. Create a schema file** (e.g., `src/schema.ts`):

```typescript
// For SQLite
export { sqliteTasks as tasks } from '@a2a-js/sdk/server/drizzle';
// For PostgreSQL: export { pgTasks as tasks } from '@a2a-js/sdk/server/drizzle';
// For MySQL: export { mysqlTasks as tasks } from '@a2a-js/sdk/server/drizzle';
```

**2. Create `drizzle.config.ts`** in your project root:

```typescript
import { defineConfig } from 'drizzle-kit';

export default defineConfig({
schema: './src/schema.ts',
out: './drizzle',
dialect: 'sqlite', // or 'postgresql' or 'mysql'
dbCredentials: {
url: 'tasks.db', // or your connection string
},
});
```

**3. Apply the schema:**

```bash
# For development (applies changes directly):
npx drizzle-kit push

# For production (version-controlled migrations):
npx drizzle-kit generate
npx drizzle-kit migrate
```

### Usage Examples

**SQLite:**

```typescript
import { drizzle } from 'drizzle-orm/better-sqlite3';
import Database from 'better-sqlite3';
import { DatabaseTaskStore, sqliteTasks } from '@a2a-js/sdk/server/drizzle';

const sqlite = new Database('tasks.db');
const db = drizzle(sqlite);
const taskStore = new DatabaseTaskStore({ db, table: sqliteTasks, dialect: 'sqlite' });
```

**PostgreSQL** (with connection pooling):

```typescript
import { drizzle } from 'drizzle-orm/node-postgres';
import { Pool } from 'pg';
import { DatabaseTaskStore, pgTasks } from '@a2a-js/sdk/server/drizzle';

const pool = new Pool({ connectionString: process.env.DATABASE_URL });
const db = drizzle(pool);
const taskStore = new DatabaseTaskStore({ db, table: pgTasks, dialect: 'postgresql' });
```

**MySQL** (with connection pooling):

```typescript
import { drizzle } from 'drizzle-orm/mysql2';
import mysql from 'mysql2/promise';
import { DatabaseTaskStore, mysqlTasks } from '@a2a-js/sdk/server/drizzle';

const pool = mysql.createPool(process.env.DATABASE_URL);
const db = drizzle(pool);
const taskStore = new DatabaseTaskStore({ db, table: mysqlTasks, dialect: 'mysql' });
```

## License

This project is licensed under the terms of the [Apache 2.0 License](https://raw.githubusercontent.com/google-a2a/a2a-python/refs/heads/main/LICENSE).
Expand Down
131 changes: 131 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 10 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,11 @@
"import": "./dist/server/express/index.js",
"require": "./dist/server/express/index.cjs"
},
"./server/drizzle": {
"types": "./dist/server/drizzle/index.d.ts",
"import": "./dist/server/drizzle/index.js",
"require": "./dist/server/drizzle/index.cjs"
},
"./client": {
"types": "./dist/client/index.d.ts",
"import": "./dist/client/index.js",
Expand All @@ -51,6 +56,7 @@
"@types/supertest": "^6.0.3",
"c8": "^10.1.3",
"chai": "^5.2.0",
"drizzle-orm": "^0.44.7",
"esbuild": "^0.27.0",
"eslint": "^9.39.1",
"eslint-config-prettier": "^10.1.8",
Expand Down Expand Up @@ -88,11 +94,15 @@
"uuid": "^11.1.0"
},
"peerDependencies": {
"drizzle-orm": ">=0.30.0",
"express": "^4.21.2 || ^5.1.0"
},
"peerDependenciesMeta": {
"express": {
"optional": true
},
"drizzle-orm": {
"optional": true
}
},
"mocha": {
Expand Down
Loading
Loading