v14.7.0

Author: bodrovis

dist/main.d.ts

@@ -75,6 +75,7 @@ interface ClientData {
     tokenType: string;
     authHeader: string;
     enableCompression: boolean;
+    silent: boolean;
     host?: string;
     version?: string;
     requestTimeout?: number;
@@ -1333,6 +1334,10 @@ type ClientParams = {
      * Request timeout in milliseconds. If not provided, requests have no explicit timeout.
      */
     requestTimeout?: number;
+    /**
+     * Silent mode (supress all warning/error messages). Defaults to false.
+     */
+    silent?: boolean;
 };
 
 interface ProjectSettings {
@@ -3081,7 +3086,7 @@ declare class BaseClient {
      * @param params - Configuration parameters including API key and optional features.
      * @throws Error if the API key is not provided or is empty.
      */
-    constructor(params: ClientParams);
+    constructor({ apiKey, enableCompression, silent, tokenType, host, requestTimeout, }: ClientParams);
 }
 
 /**

dist/main.js

@@ -1,5 +1,16 @@
 # Changelog
 
+## 14.7.0 (09-May-2025)
+
+* Added `silent` option for `LokaliseApi` to supress warning messages (default is `false`):
+
+```js
+const client = new LokaliseApi({
+  // other config ...
+  silent: true,
+});
+```
+
 ## 14.6.0 (08-May-2025)
 
 * Added support for [Get team details](https://developers.lokalise.com/reference/get-team-details) endpoint

dist/main.js.map

@@ -30,6 +30,17 @@ const client = new LokaliseApi({
 
 Then use your `client` as usual.
 
+## Silent mode
+
+To supress all warning messages, set the `silent` option to `true` (`false` by default):
+
+```js
+const client = new LokaliseApi({
+  // other config ...
+  silent: true,
+});
+```
+
 ## Proxy support
 
 If you are behind a firewall and have to use proxy in order to communicate with Lokalise API, that's not a problem! You can take advantage of the [global-agent](https://github.com/gajus/global-agent) package which allows to enable proxy globally without the need to do any changes to your API-related script.

docs/additional_info/changelog.md

@@ -1,6 +1,6 @@
 {
 	"name": "@lokalise/node-api",
-	"version": "14.6.0",
+	"version": "14.7.0",
 	"description": "Official Lokalise API 2.0 Node.js client",
 	"license": "BSD-3-Clause",
 	"repository": {

docs/additional_info/customizing_client.md

@@ -9,6 +9,7 @@ import type {
 	ListFileParams,
 	UploadFileParams,
 } from "../types/files.js";
+import { warn } from "../utils/logger.js";
 import { BaseCollection } from "./base_collection.js";
 
 export class Files extends BaseCollection<File, QueuedProcess> {
@@ -39,7 +40,8 @@ export class Files extends BaseCollection<File, QueuedProcess> {
 		headers: Headers,
 	): T {
 		if (this.isResponseTooBig(headers)) {
-			console.warn(
+			warn(
+				this.clientData.silent,
 				"\x1b[33m\x1b[1mWarning:\x1b[0m Project too big for sync export. Please use our async export lokaliseApi.files().async_download() method.",
 			);
 		}

package-lock.json

@@ -3,6 +3,7 @@ export interface ClientData {
 	tokenType: string;
 	authHeader: string;
 	enableCompression: boolean;
+	silent: boolean;
 	host?: string;
 	version?: string;
 	requestTimeout?: number;

package.json

@@ -38,4 +38,9 @@ export type ClientParams = {
 	 * Request timeout in milliseconds. If not provided, requests have no explicit timeout.
 	 */
 	requestTimeout?: number;
+
+	/**
+	 * Silent mode (supress all warning/error messages). Defaults to false.
+	 */
+	silent?: boolean;
 };

src/collections/files.ts

@@ -15,25 +15,33 @@ export class BaseClient {
 		authHeader: "x-api-token",
 		enableCompression: false,
 		requestTimeout: undefined,
+		silent: false,
 	};
 
 	/**
 	 * Constructs a new BaseClient instance.
 	 * @param params - Configuration parameters including API key and optional features.
 	 * @throws Error if the API key is not provided or is empty.
 	 */
-	constructor(params: ClientParams) {
-		const { apiKey } = params;
+	constructor({
+		apiKey,
+		enableCompression = false,
+		silent = false,
+		tokenType = "",
+		host,
+		requestTimeout,
+	}: ClientParams) {
 		if (typeof apiKey !== "string" || apiKey.trim().length === 0) {
 			throw new Error(
 				"Instantiation failed: A non-empty API key or JWT must be provided.",
 			);
 		}
 
 		this.clientData.token = apiKey;
-		this.clientData.enableCompression = params.enableCompression ?? false;
-		this.clientData.tokenType = params.tokenType ?? "";
-		this.clientData.host = params.host;
-		this.clientData.requestTimeout = params.requestTimeout;
+		this.clientData.enableCompression = enableCompression;
+		this.clientData.silent = silent;
+		this.clientData.tokenType = tokenType;
+		this.clientData.host = host;
+		this.clientData.requestTimeout = requestTimeout;
 	}
 }

src/interfaces/client_data.ts

@@ -0,0 +1,11 @@
+/**
+ * Emits a warning to the console unless `silent` is true.
+ *
+ * @param silent - If true, suppresses the log output.
+ * @param args - The items to log, passed to `console.warn`.
+ */
+export function warn(silent: boolean, ...args: unknown[]): void {
+	if (silent) return;
+
+	console.warn(...args);
+}

src/interfaces/client_params.ts

@@ -15,6 +15,7 @@ describe("LokaliseApi", () => {
 		expect(client.clientData.token).to.eq(process.env.API_KEY);
 		expect(client.clientData.authHeader).to.eq("x-api-token");
 		expect(client.clientData.enableCompression).to.be.false;
+		expect(client.clientData.silent).to.be.false;
 		expect(client.clientData.version).to.eq("api2");
 	});
 

src/lokalise/base_client.ts

@@ -0,0 +1,26 @@
+import { warn } from "../../src/utils/logger.js";
+import { describe, expect, it, vi } from "../setup.js";
+
+describe("logger", () => {
+	it("warns when silent is disabled", async () => {
+		const message = "sample message";
+		const warnSpy = vi.spyOn(console, "warn").mockImplementation(() => {});
+
+		warn(false, message);
+
+		expect(warnSpy).toHaveBeenCalledWith(message);
+
+		warnSpy.mockRestore();
+	});
+
+	it("does not warn when silent is enabled", async () => {
+		const message = "sample message";
+		const warnSpy = vi.spyOn(console, "warn").mockImplementation(() => {});
+
+		warn(true, message);
+
+		expect(warnSpy).not.toHaveBeenCalledWith(message);
+
+		warnSpy.mockRestore();
+	});
+});