@localisprimary/esi 1.1.0 → 1.3.0

package/README.md

@@ -12,7 +12,7 @@ A slightly opinionated TypeScript client for the [EVE Online API](https://develo
 import { EsiClient } from '@localisprimary/esi'
 
 // Create client (optionally with auth token)
-const esi = new EsiClient({ token: 'bearer-token' })
+const esi = new EsiClient({ userAgent: 'foo@example.com', token: 'bearer-token' })
 
 // Get all alliances
 const alliances = await esi.getAlliances()
@@ -23,9 +23,20 @@ const alliance = await esi.getAlliance({ alliance_id: 123 })
 console.log(alliance.data)
 ```
 
+## Options
+
+The `EsiClient` constructor accepts an options object with the following properties:
+| Parameter | Description | Type | Default | Required |
+|-----------|-------------|------|---------|----------|
+| `token` | Optional auth token for authenticated requests | `string` | `undefined` | No |
+| `userAgent` | User agent string for requests. Resolves to `"localisprimary/esi <userAgent>"` | `string` | `undefined` | No* |
+| `useRequestHeaders` | When false, fall back to query parameters for user agent and token | `boolean` | `true` | No |
+
+<small>* Will be required in a future version.</small>
+
 ## Methods
 
-This client provides methods for all EVE ESI endpoints. Methods return a Promise that resolves to an `EsiResponse<T>` object or throws an `EsiError`.
+This client provides methods for all EVE ESI endpoints. Methods return a `Promise` that resolves to an `EsiResponse<T>` or throws an `EsiError`.
 
 ```typescript
 interface EsiResponse<TData, THeaders = Record<string, string>> {
@@ -44,7 +55,7 @@ All methods are fully typed: `getAlliance` will take `GetAllianceParams` and ret
 
 `Params` types make no distinction between path, query, or body parameters, it's all the same object:
 ```typescript
-const esi = new EsiClient({ token: 'bearer-token' })
+const esi = new EsiClient({ userAgent: 'foo@example.com', token: 'bearer-token' })
 
 // POST https://esi.evetech.net/characters/{character_id}/mail
 esi.postCharacterMail({

package/dist/client.d.ts

@@ -1,9 +1,13 @@
 import * as Types from './types';
 export declare class EsiClient {
     private readonly baseUrl;
+    private readonly userAgent;
     private readonly token?;
+    private readonly useRequestHeaders;
     constructor(options?: {
         token?: string;
+        userAgent?: string;
+        useRequestHeaders?: boolean;
     });
     private request;
     /**

package/dist/client.js

@@ -1,7 +1,17 @@
+const COMPATIBILITY_DATE = '2025-07-29';
 export class EsiClient {
     constructor(options = {}) {
         this.baseUrl = 'https://esi.evetech.net';
+        this.userAgent = 'localisprimary/esi';
+        this.useRequestHeaders = true;
         this.token = options.token;
+        this.useRequestHeaders = options.useRequestHeaders ?? true;
+        if (options.userAgent?.length) {
+            this.userAgent += ` ${options.userAgent}`;
+        }
+        else {
+            console.warn('@localisprimary/esi: No user agent provided in constructor. This will be required in a future release.');
+        }
     }
     async request(method, path, params, body) {
         const url = new URL(path, this.baseUrl);
@@ -12,15 +22,24 @@ export class EsiClient {
                 }
             });
         }
+        if (!this.useRequestHeaders) {
+            url.searchParams.append('user_agent', this.userAgent);
+            url.searchParams.append('compatibility_date', COMPATIBILITY_DATE);
+            if (this.token) {
+                url.searchParams.append('token', this.token);
+            }
+        }
         const headers = {
             'Content-Type': 'application/json',
+            'X-Compatibility-Date': COMPATIBILITY_DATE,
+            'X-User-Agent': this.userAgent,
         };
         if (this.token) {
             headers['Authorization'] = `Bearer ${this.token}`;
         }
         const response = await fetch(url.toString(), {
             method,
-            headers,
+            headers: this.useRequestHeaders ? headers : undefined,
             body: body ? JSON.stringify(body) : undefined,
         });
         const data = await response.json();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@localisprimary/esi",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "type": "module",
   "description": "Auto-generated TypeScript client for the EVE Online API",
   "main": "dist/index.js",