add user agent (#42)

* add user agent

* change to version

Author: danaelhe

src/dots/DigitalOceanApiKeyAuthenticationProvider.ts

@@ -1,4 +1,6 @@
 import { AuthenticationProvider, RequestInformation } from "@microsoft/kiota-abstractions";
+// @ts-expect-error: Importing JSON for dynamic version in User-Agent header
+import pkg from '../../package.json' assert { type: "json" };
 
 /** Authenticate a request by using an API Key */
 export class DigitalOceanApiKeyAuthenticationProvider implements AuthenticationProvider {
@@ -18,7 +20,8 @@ export class DigitalOceanApiKeyAuthenticationProvider implements AuthenticationP
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
         additionalAuthenticationContext?: Record<string, unknown> | undefined
     ): Promise<void> {
-        request.headers.add("Authorization", `Bearer ${this.apiKey}`);
-        return Promise.resolve();
+    request.headers.add("Authorization", `Bearer ${this.apiKey}`);
+    request.headers.add("User-Agent", `DigitalOcean-Dots/${pkg.version}`);
+    return Promise.resolve();
     }
 }

tests/mocked/DigitalOceanApiKeyAuthenticationProvider.test.ts

@@ -0,0 +1,14 @@
+
+import { DigitalOceanApiKeyAuthenticationProvider } from "../../src/dots/DigitalOceanApiKeyAuthenticationProvider.js";
+import { RequestInformation } from "@microsoft/kiota-abstractions";
+// @ts-expect-error: Importing JSON for dynamic version in test
+import pkg from '../../package.json' assert { type: "json" };
+
+describe("DigitalOceanApiKeyAuthenticationProvider", () => {
+    it("should add the User-Agent header to every request", async () => {
+        const provider = new DigitalOceanApiKeyAuthenticationProvider("dummy-token");
+        const request = new RequestInformation();
+        await provider.authenticateRequest(request);
+    expect(request.headers.get("User-Agent")).toContain(`DigitalOcean-Dots/${pkg.version}`);
+    });
+});