PERF-1344: added JWT authentication headers (#496)

* PERF-1344: added JWT authentication headers

* PERF-1344: added JWT test

* PERF-1344: refactored structure according to Ilya's comments

src/interfaces/client_params.ts

@@ -7,6 +7,11 @@ export type ClientParams = {
 	 */
 	apiKey?: string;
 
+	/**
+	 * Header for auth requests, if nothing is set default one will be used.
+	 */
+	header?: string;
+
 	/**
 	 * Whether to enable response compression (e.g., gzip).
 	 * Defaults to `false` if not specified.

src/lokalise/base_client.ts

@@ -26,7 +26,7 @@ export class BaseClient {
 		const { apiKey } = params;
 		if (!apiKey || apiKey.trim().length === 0) {
 			throw new Error(
-				"Instantiation failed: A non-empty API key must be provided.",
+				"Instantiation failed: A non-empty API key or JWT must be provided.",
 			);
 		}
 

src/lokalise/lokalise_api.ts

@@ -43,6 +43,7 @@ export class LokaliseApi extends BaseClient {
 
 		// Default to "api2" version if not explicitly provided
 		this.clientData.version = params.version ?? "api2";
+		this.clientData.authHeader = params.header ?? this.clientData.authHeader;
 	}
 
 	/**

test/lokalise/lokalise_api.spec.ts

@@ -5,7 +5,7 @@ describe("LokaliseApi", () => {
 	it("is expected to throw an error if the API key is not provided", () => {
 		expect(() => {
 			new LokaliseApi({ apiKey: "" });
-		}).toThrow("Instantiation failed: A non-empty API key must be provided.");
+		}).toThrow("Instantiation failed: A non-empty API key or JWT must be provided.");
 	});
 
 	it("is expected to contain clientData", () => {
@@ -15,6 +15,14 @@ describe("LokaliseApi", () => {
 		expect(client.clientData.enableCompression).to.be.false;
 		expect(client.clientData.version).to.eq("api2");
 	});
+
+	it("is expected to contain custom header", () => {
+		const client = new LokaliseApi({ apiKey: process.env.API_KEY, header:"Authorization" });
+		expect(client.clientData.token).to.eq(process.env.API_KEY);
+		expect(client.clientData.authHeader).to.eq("Authorization");
+		expect(client.clientData.enableCompression).to.be.false;
+		expect(client.clientData.version).to.eq("api2");
+	});
 });
 
 describe("LokaliseApi host", () => {