@andrian.yablonskyy/thub-common 1.0.7 → 1.0.8

package/README.md

@@ -46,7 +46,8 @@ A minimal `fetch`-based HTTP client for the Coordinator's `/api/v1` surface, wit
 ```js
 const { ApiClient } = require('@andrian.yablonskyy/thub-common');
 
-const client = new ApiClient({ baseUrl: 'https://thub.example.com', token: 'agt_...' });
+// userAgent is optional; the Coordinator records "thub-agent/<v>" / "thub-client/<v>" versions for its dashboard
+const client = new ApiClient({ baseUrl: 'https://thub.example.com', token: 'agt_...', userAgent: 'thub-agent/1.0.8' });
 const job = await client.post('/jobs', spec);
 await client.streamEvents(`/jobs/${job.jobId}/logs/stream`, {
   onEvent: ({ event, id, data }) => console.log(event, data)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@andrian.yablonskyy/thub-common",
-  "version": "1.0.7",
+  "version": "1.0.8",
   "description": "Shared job-spec schema, state enums and a thin API client used by the Agent and Client",
   "main": "src/index.js",
   "files": [

package/src/api-client.js

@@ -20,12 +20,15 @@
  * and manual usage identical").
  */
 class ApiClient{
-  constructor({ baseUrl, token }){
+  // `userAgent` (e.g. "thub-agent/1.0.8") is how the Coordinator learns
+  // which Agent/Client version is talking to it, for the dashboard.
+  constructor({ baseUrl, token, userAgent }){
     if (!baseUrl){
       throw new Error('ApiClient requires baseUrl');
     }
     this.baseUrl = baseUrl.replace(/\/+$/, '');
     this.token = token;
+    this.userAgent = userAgent;
   }
 
   _url(path){
@@ -34,6 +37,9 @@ class ApiClient{
 
   _headers(extra = {}){
     const headers = { ...extra };
+    if (this.userAgent){
+      headers['User-Agent'] = this.userAgent;
+    }
     if (this.token){
       headers.Authorization = `Bearer ${this.token}`;
     }