@vulog/aima-client 1.2.3 → 1.2.4

package/dist/index.d.mts

@@ -21,6 +21,7 @@ type ClientOptions = {
     logResponse?: boolean;
     store?: Store;
     onLog?: (...args: any[]) => void;
+    userAgent?: string;
 };
 type ClientError = {
     formattedError: {

package/dist/index.d.ts

@@ -21,6 +21,7 @@ type ClientOptions = {
     logResponse?: boolean;
     store?: Store;
     onLog?: (...args: any[]) => void;
+    userAgent?: string;
 };
 type ClientError = {
     formattedError: {

package/dist/index.js

@@ -160,7 +160,8 @@ var getClient = (options) => {
     headers: {
       "Cache-Control": "no-cache",
       "Content-Type": "application/json",
-      "X-Api-Key": options.apiKey
+      "X-Api-Key": options.apiKey,
+      "User-Agent": options.userAgent ?? `aima-node/${"1.2.4"} ${options.fleetId}`
     },
     withCredentials: false
   });

package/dist/index.mjs

@@ -124,7 +124,8 @@ var getClient = (options) => {
     headers: {
       "Cache-Control": "no-cache",
       "Content-Type": "application/json",
-      "X-Api-Key": options.apiKey
+      "X-Api-Key": options.apiKey,
+      "User-Agent": options.userAgent ?? `aima-node/${"1.2.4"} ${options.fleetId}`
     },
     withCredentials: false
   });

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@vulog/aima-client",
-    "version": "1.2.3",
+    "version": "1.2.4",
     "main": "dist/index.js",
     "module": "dist/index.mjs",
     "types": "dist/index.d.ts",

package/src/getClient.test.ts

@@ -18,4 +18,30 @@ describe('getClient', () => {
         const client = getClient(options);
         expect(client.defaults.baseURL).toEqual(options.baseUrl);
     });
+
+    test('User-Agent should contain package version', () => {
+        const options: ClientOptions = {
+            fleetId: 'fleetId',
+            baseUrl: 'baseUrl',
+            clientId: 'clientId',
+            clientSecret: 'clientSecret',
+            apiKey: 'apiKey',
+        };
+        const client = getClient(options);
+        expect(client.defaults.headers['User-Agent']).toEqual(`aima-node/1.1.98 ${options.fleetId}`);
+    });
+
+    test('User-Agent should use custom value when provided', () => {
+        const customUserAgent = 'custom-user-agent/1.0';
+        const options: ClientOptions = {
+            fleetId: 'fleetId',
+            baseUrl: 'baseUrl',
+            clientId: 'clientId',
+            clientSecret: 'clientSecret',
+            apiKey: 'apiKey',
+            userAgent: customUserAgent,
+        };
+        const client = getClient(options);
+        expect(client.defaults.headers['User-Agent']).toEqual(customUserAgent);
+    });
 });

package/src/getClient.ts

@@ -5,6 +5,9 @@ import { LRUCache } from 'lru-cache';
 import { CurlHelper } from './CurlHelper';
 import { Client, ClientError, ClientOptions, Store, Token } from './types';
 
+// eslint-disable-next-line no-underscore-dangle
+declare const __VERSION__: string;
+
 type RefreshSubscriber = (token?: string, error?: any) => void;
 
 const clientCache = new LRUCache<
@@ -70,6 +73,7 @@ const getClient = (options: ClientOptions): Client => {
             'Cache-Control': 'no-cache',
             'Content-Type': 'application/json',
             'X-Api-Key': options.apiKey,
+            'User-Agent': options.userAgent ?? `aima-node/${__VERSION__} ${options.fleetId}`,
         },
         withCredentials: false,
     }) as Client;

package/src/types.ts

@@ -23,6 +23,7 @@ export type ClientOptions = {
     logResponse?: boolean;
     store?: Store;
     onLog?: (...args: any[]) => void;
+    userAgent?: string;
 };
 
 export type ClientError = {

package/tsup.config.ts

@@ -1,8 +1,14 @@
 import { defineConfig } from 'tsup';
+import { readFileSync } from 'fs';
+
+const packageJson = JSON.parse(readFileSync('./package.json', 'utf-8'));
 
 export default defineConfig({
     entry: ['src/index.ts'],
     clean: true,
     format: ['cjs', 'esm'],
     dts: true,
+    define: {
+        __VERSION__: JSON.stringify(packageJson.version),
+    },
 });

package/vitest.config.ts

@@ -4,5 +4,8 @@ export default defineConfig({
     test: {
         globals: true,
         environment: 'node',
+        env: {
+            VERSION: '1.1.98',
+        },
     },
 });