TEC-200: userAgent config for attribution

README.md

@@ -87,11 +87,12 @@ await client.revokeCredential(cred.id);
 
 ## Configuration
 
-| Option    | Type     | Default                     | Description              |
-| --------- | -------- | --------------------------- | ------------------------ |
-| `apiKey`  | `string` | ---                         | API key from [agentscore.sh](https://agentscore.sh) |
-| `baseUrl` | `string` | `https://api.agentscore.sh` | API base URL             |
-| `timeout` | `number` | `10000`                     | Request timeout in ms    |
+| Option      | Type     | Default                     | Description              |
+| ----------- | -------- | --------------------------- | ------------------------ |
+| `apiKey`    | `string` | ---                         | API key from [agentscore.sh](https://agentscore.sh) |
+| `baseUrl`   | `string` | `https://api.agentscore.sh` | API base URL             |
+| `timeout`   | `number` | `10000`                     | Request timeout in ms    |
+| `userAgent` | `string` | ---                         | Prepended to the default `User-Agent` as `"{userAgent} (@agent-score/sdk@{version})"`. Use to attribute API calls to your app. |
 
 ## Error Handling
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agent-score/sdk",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "TypeScript client for the AgentScore trust and reputation API",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
@@ -58,7 +58,7 @@
     "eslint-plugin-unused-imports": "^4.4.1",
     "tsup": "^8.5.1",
     "typescript": "^6.0.3",
-    "typescript-eslint": "^8.58.2",
+    "typescript-eslint": "^8.59.0",
     "vitest": "^4.1.4"
   }
 }

src/index.ts

@@ -27,6 +27,7 @@ export class AgentScore {
   private readonly baseUrl: string;
   private readonly apiKey: string;
   private readonly timeout: number;
+  private readonly userAgent: string;
 
   constructor(config: AgentScoreConfig) {
     if (!config.apiKey) {
@@ -37,6 +38,8 @@ export class AgentScore {
     this.baseUrl = base;
     this.apiKey = config.apiKey;
     this.timeout = config.timeout ?? DEFAULT_TIMEOUT;
+    const defaultUa = `@agent-score/sdk@${__VERSION__}`;
+    this.userAgent = config.userAgent ? `${config.userAgent} (${defaultUa})` : defaultUa;
   }
 
   async getReputation(address: string, options?: GetReputationOptions): Promise<ReputationResponse> {
@@ -115,7 +118,7 @@ export class AgentScore {
     const headers: Record<string, string> = {
       ...(options?.headers as Record<string, string>),
       'X-API-Key': this.apiKey,
-      'User-Agent': `agentscore-sdk/${__VERSION__}`,
+      'User-Agent': this.userAgent,
     };
 
     const controller = new AbortController();

src/types.ts

@@ -2,6 +2,8 @@ export interface AgentScoreConfig {
   apiKey: string;
   baseUrl?: string;
   timeout?: number;
+  /** Prepended to the default User-Agent as `"{userAgent} (@agent-score/sdk@{version})"`. Use to attribute API calls to your app. */
+  userAgent?: string;
 }
 
 export type Grade = 'A' | 'B' | 'C' | 'D' | 'F';