@valkey/valkey-glide 1.3.5-rc9 → 2.0.0-rc7

package/build-ts/GlideClusterClient.d.ts

@@ -1,10 +1,7 @@
 /**
  * Copyright Valkey GLIDE Project Contributors - SPDX Identifier: Apache-2.0
  */
-import { AdvancedBaseClientConfiguration, BaseClient, BaseClientConfiguration, DecoderOption, GlideReturnType, GlideString, PubSubMsg } from "./BaseClient";
-import { ClusterBatch } from "./Batch";
-import { ClusterBatchOptions, ClusterScanOptions, FlushMode, FunctionListOptions, FunctionListResponse, FunctionRestorePolicy, FunctionStatsSingleResponse, InfoOptions, LolwutOptions } from "./Commands";
-import { ClusterScanCursor, Script } from "./native";
+import { AdvancedBaseClientConfiguration, BaseClient, BaseClientConfiguration, ClusterBatch, ClusterBatchOptions, ClusterScanCursor, ClusterScanOptions, DecoderOption, FlushMode, FunctionListOptions, FunctionListResponse, FunctionRestorePolicy, FunctionStatsSingleResponse, GlideReturnType, GlideString, InfoOptions, LolwutOptions, PubSubMsg, Script } from ".";
 /** An extension to command option types with {@link Routes}. */
 export interface RouteOption {
     /**
@@ -134,6 +131,9 @@ export type GlideClusterClientConfiguration = BaseClientConfiguration & {
  * ```typescript
  * const config: AdvancedGlideClusterClientConfiguration = {
  *   connectionTimeout: 500, // Set the connection timeout to 500ms
+ *   tlsAdvancedConfiguration: {
+ *     insecure: true, // Skip TLS certificate verification (use only in development)
+ *   },
  * };
  * ```
  */
@@ -425,6 +425,12 @@ export declare class GlideClusterClient extends BaseClient {
      *       console.log(`Received message: ${msg.payload}`);
      *     },
      *   },
+     *   connectionBackoff: {
+     *     numberOfRetries: 5,
+     *     factor: 1000,
+     *     exponentBase: 2,
+     *     jitter: 20,
+     *   },
      * });
      * ```
      *
@@ -432,6 +438,8 @@ export declare class GlideClusterClient extends BaseClient {
      * - **Cluster Topology Discovery**: The client will automatically discover the cluster topology based on the seed addresses provided.
      * - **Authentication**: If `credentials` are provided, the client will attempt to authenticate using the specified username and password.
      * - **TLS**: If `useTLS` is set to `true`, the client will establish secure connections using TLS.
+     *      Should match the TLS configuration of the server/cluster, otherwise the connection attempt will fail.
+     *      For advanced tls configuration, please use the {@link AdvancedGlideClusterClientConfiguration} option.
      * - **Periodic Checks**: The `periodicChecks` setting allows you to configure how often the client checks for cluster topology changes.
      * - **Pub/Sub Subscriptions**: Any channels or patterns specified in `pubsubSubscriptions` will be subscribed to upon connection.
      */

package/build-ts/GlideClusterClient.js

@@ -4,10 +4,8 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GlideClusterClient = exports.GlideClusterClientConfiguration = void 0;
+const _1 = require(".");
 const ProtobufMessage_1 = require("../build-ts/ProtobufMessage");
-const BaseClient_1 = require("./BaseClient");
-const Commands_1 = require("./Commands");
-const native_1 = require("./native");
 /* eslint-disable-next-line @typescript-eslint/no-namespace */
 var GlideClusterClientConfiguration;
 (function (GlideClusterClientConfiguration) {
@@ -48,7 +46,7 @@ function convertClusterGlideRecord(res, isRoutedToSingleNodeByDefault, route) {
         (Boolean(route) && route !== "allPrimaries" && route !== "allNodes");
     return isSingleNodeResponse
         ? res
-        : (0, BaseClient_1.convertGlideRecordToRecord)(res);
+        : (0, _1.convertGlideRecordToRecord)(res);
 }
 /**
  * Client used for connection to cluster servers.
@@ -56,7 +54,7 @@ function convertClusterGlideRecord(res, isRoutedToSingleNodeByDefault, route) {
  *
  * @see For full documentation refer to {@link https://github.com/valkey-io/valkey-glide/wiki/NodeJS-wrapper#cluster | Valkey Glide Wiki}.
  */
-class GlideClusterClient extends BaseClient_1.BaseClient {
+class GlideClusterClient extends _1.BaseClient {
     /**
      * @internal
      */
@@ -120,6 +118,12 @@ class GlideClusterClient extends BaseClient_1.BaseClient {
      *       console.log(`Received message: ${msg.payload}`);
      *     },
      *   },
+     *   connectionBackoff: {
+     *     numberOfRetries: 5,
+     *     factor: 1000,
+     *     exponentBase: 2,
+     *     jitter: 20,
+     *   },
      * });
      * ```
      *
@@ -127,6 +131,8 @@ class GlideClusterClient extends BaseClient_1.BaseClient {
      * - **Cluster Topology Discovery**: The client will automatically discover the cluster topology based on the seed addresses provided.
      * - **Authentication**: If `credentials` are provided, the client will attempt to authenticate using the specified username and password.
      * - **TLS**: If `useTLS` is set to `true`, the client will establish secure connections using TLS.
+     *      Should match the TLS configuration of the server/cluster, otherwise the connection attempt will fail.
+     *      For advanced tls configuration, please use the {@link AdvancedGlideClusterClientConfiguration} option.
      * - **Periodic Checks**: The `periodicChecks` setting allows you to configure how often the client checks for cluster topology changes.
      * - **Pub/Sub Subscriptions**: Any channels or patterns specified in `pubsubSubscriptions` will be subscribed to upon connection.
      */
@@ -175,7 +181,7 @@ class GlideClusterClient extends BaseClient_1.BaseClient {
                 (resolveAns) => {
                     try {
                         resolve([
-                            new native_1.ClusterScanCursor(resolveAns[0].toString()),
+                            new _1.ClusterScanCursor(resolveAns[0].toString()),
                             resolveAns[1],
                         ]);
                     }
@@ -277,7 +283,7 @@ class GlideClusterClient extends BaseClient_1.BaseClient {
      * ```
      */
     async customCommand(args, options) {
-        const command = (0, Commands_1.createCustomCommand)(args);
+        const command = (0, _1.createCustomCommand)(args);
         return super.createWritePromise(command, options);
     }
     /**
@@ -374,7 +380,7 @@ class GlideClusterClient extends BaseClient_1.BaseClient {
      * ```
      */
     async ping(options) {
-        return this.createWritePromise((0, Commands_1.createPing)(options?.message), options);
+        return this.createWritePromise((0, _1.createPing)(options?.message), options);
     }
     /**
      * Gets information and statistics about the server.
@@ -401,7 +407,7 @@ class GlideClusterClient extends BaseClient_1.BaseClient {
      * ```
      */
     async info(options) {
-        return this.createWritePromise((0, Commands_1.createInfo)(options?.sections), { decoder: BaseClient_1.Decoder.String, ...options }).then((res) => convertClusterGlideRecord(res, false, options?.route));
+        return this.createWritePromise((0, _1.createInfo)(options?.sections), { decoder: _1.Decoder.String, ...options }).then((res) => convertClusterGlideRecord(res, false, options?.route));
     }
     /**
      * Gets the name of the connection to which the request is routed.
@@ -431,7 +437,7 @@ class GlideClusterClient extends BaseClient_1.BaseClient {
      * ```
      */
     async clientGetName(options) {
-        return this.createWritePromise((0, Commands_1.createClientGetName)(), options).then((res) => convertClusterGlideRecord(res, true, options?.route));
+        return this.createWritePromise((0, _1.createClientGetName)(), options).then((res) => convertClusterGlideRecord(res, true, options?.route));
     }
     /**
      * Rewrites the configuration file with the current configuration.
@@ -451,8 +457,8 @@ class GlideClusterClient extends BaseClient_1.BaseClient {
      * ```
      */
     async configRewrite(options) {
-        return this.createWritePromise((0, Commands_1.createConfigRewrite)(), {
-            decoder: BaseClient_1.Decoder.String,
+        return this.createWritePromise((0, _1.createConfigRewrite)(), {
+            decoder: _1.Decoder.String,
             ...options,
         });
     }
@@ -474,8 +480,8 @@ class GlideClusterClient extends BaseClient_1.BaseClient {
      * ```
      */
     async configResetStat(options) {
-        return this.createWritePromise((0, Commands_1.createConfigResetStat)(), {
-            decoder: BaseClient_1.Decoder.String,
+        return this.createWritePromise((0, _1.createConfigResetStat)(), {
+            decoder: _1.Decoder.String,
             ...options,
         });
     }
@@ -497,7 +503,7 @@ class GlideClusterClient extends BaseClient_1.BaseClient {
      * ```
      */
     async clientId(options) {
-        return this.createWritePromise((0, Commands_1.createClientId)(), options).then((res) => convertClusterGlideRecord(res, true, options?.route));
+        return this.createWritePromise((0, _1.createClientId)(), options).then((res) => convertClusterGlideRecord(res, true, options?.route));
     }
     /**
      * Reads the configuration parameters of the running server.
@@ -528,7 +534,7 @@ class GlideClusterClient extends BaseClient_1.BaseClient {
      * ```
      */
     async configGet(parameters, options) {
-        return this.createWritePromise((0, Commands_1.createConfigGet)(parameters), options).then((res) => (0, BaseClient_1.convertGlideRecordToRecord)(res));
+        return this.createWritePromise((0, _1.createConfigGet)(parameters), options).then((res) => (0, _1.convertGlideRecordToRecord)(res));
     }
     /**
      * Sets configuration parameters to the specified values.
@@ -550,8 +556,8 @@ class GlideClusterClient extends BaseClient_1.BaseClient {
      * ```
      */
     async configSet(parameters, options) {
-        return this.createWritePromise((0, Commands_1.createConfigSet)(parameters), {
-            decoder: BaseClient_1.Decoder.String,
+        return this.createWritePromise((0, _1.createConfigSet)(parameters), {
+            decoder: _1.Decoder.String,
             ...options,
         });
     }
@@ -581,7 +587,7 @@ class GlideClusterClient extends BaseClient_1.BaseClient {
      * ```
      */
     async echo(message, options) {
-        return this.createWritePromise((0, Commands_1.createEcho)(message), options).then((res) => convertClusterGlideRecord(res, true, options?.route));
+        return this.createWritePromise((0, _1.createEcho)(message), options).then((res) => convertClusterGlideRecord(res, true, options?.route));
     }
     /**
      * Returns the server time.
@@ -614,7 +620,7 @@ class GlideClusterClient extends BaseClient_1.BaseClient {
      * ```
      */
     async time(options) {
-        return this.createWritePromise((0, Commands_1.createTime)(), options).then((res) => convertClusterGlideRecord(res, true, options?.route));
+        return this.createWritePromise((0, _1.createTime)(), options).then((res) => convertClusterGlideRecord(res, true, options?.route));
     }
     /**
      * Copies the value stored at the `source` to the `destination` key. When `replace` is `true`,
@@ -638,7 +644,7 @@ class GlideClusterClient extends BaseClient_1.BaseClient {
      * ```
      */
     async copy(source, destination, options) {
-        return this.createWritePromise((0, Commands_1.createCopy)(source, destination, options));
+        return this.createWritePromise((0, _1.createCopy)(source, destination, options));
     }
     /**
      * Displays a piece of generative computer art and the server version.
@@ -657,7 +663,7 @@ class GlideClusterClient extends BaseClient_1.BaseClient {
      * ```
      */
     async lolwut(options) {
-        return this.createWritePromise((0, Commands_1.createLolwut)(options), options).then((res) => convertClusterGlideRecord(res, true, options?.route));
+        return this.createWritePromise((0, _1.createLolwut)(options), options).then((res) => convertClusterGlideRecord(res, true, options?.route));
     }
     /**
      * Invokes a previously loaded function.
@@ -679,7 +685,7 @@ class GlideClusterClient extends BaseClient_1.BaseClient {
      * ```
      */
     async fcallWithRoute(func, args, options) {
-        return this.createWritePromise((0, Commands_1.createFCall)(func, [], args), options).then((res) => convertClusterGlideRecord(res, true, options?.route));
+        return this.createWritePromise((0, _1.createFCall)(func, [], args), options).then((res) => convertClusterGlideRecord(res, true, options?.route));
     }
     /**
      * Invokes a previously loaded read-only function.
@@ -702,7 +708,7 @@ class GlideClusterClient extends BaseClient_1.BaseClient {
      * ```
      */
     async fcallReadonlyWithRoute(func, args, options) {
-        return this.createWritePromise((0, Commands_1.createFCallReadOnly)(func, [], args), options).then((res) => convertClusterGlideRecord(res, true, options?.route));
+        return this.createWritePromise((0, _1.createFCallReadOnly)(func, [], args), options).then((res) => convertClusterGlideRecord(res, true, options?.route));
     }
     /**
      * Deletes a library and all its functions.
@@ -722,8 +728,8 @@ class GlideClusterClient extends BaseClient_1.BaseClient {
      * ```
      */
     async functionDelete(libraryCode, options) {
-        return this.createWritePromise((0, Commands_1.createFunctionDelete)(libraryCode), {
-            decoder: BaseClient_1.Decoder.String,
+        return this.createWritePromise((0, _1.createFunctionDelete)(libraryCode), {
+            decoder: _1.Decoder.String,
             ...options,
         });
     }
@@ -749,7 +755,7 @@ class GlideClusterClient extends BaseClient_1.BaseClient {
      * ```
      */
     async functionLoad(libraryCode, options) {
-        return this.createWritePromise((0, Commands_1.createFunctionLoad)(libraryCode, options?.replace), options);
+        return this.createWritePromise((0, _1.createFunctionLoad)(libraryCode, options?.replace), options);
     }
     /**
      * Deletes all function libraries.
@@ -769,8 +775,8 @@ class GlideClusterClient extends BaseClient_1.BaseClient {
      * ```
      */
     async functionFlush(options) {
-        return this.createWritePromise((0, Commands_1.createFunctionFlush)(options?.mode), {
-            decoder: BaseClient_1.Decoder.String,
+        return this.createWritePromise((0, _1.createFunctionFlush)(options?.mode), {
+            decoder: _1.Decoder.String,
             ...options,
         });
     }
@@ -805,13 +811,13 @@ class GlideClusterClient extends BaseClient_1.BaseClient {
      * ```
      */
     async functionList(options) {
-        return this.createWritePromise((0, Commands_1.createFunctionList)(options), options).then((res) => res.length == 0
+        return this.createWritePromise((0, _1.createFunctionList)(options), options).then((res) => res.length == 0
             ? res // no libs
             : (Array.isArray(res[0])
                 ? // single node response
-                    res.map(BaseClient_1.convertGlideRecordToRecord)
+                    res.map(_1.convertGlideRecordToRecord)
                 : // multi node response
-                    (0, BaseClient_1.convertGlideRecordToRecord)(res)));
+                    (0, _1.convertGlideRecordToRecord)(res)));
     }
     /**
      * Returns information about the function that's currently running and information about the
@@ -863,7 +869,7 @@ class GlideClusterClient extends BaseClient_1.BaseClient {
      * ```
      */
     async functionStats(options) {
-        return this.createWritePromise((0, Commands_1.createFunctionStats)(), options).then((res) => (0, BaseClient_1.convertGlideRecordToRecord)(res));
+        return this.createWritePromise((0, _1.createFunctionStats)(), options).then((res) => (0, _1.convertGlideRecordToRecord)(res));
     }
     /**
      * Kills a function that is currently executing.
@@ -881,8 +887,8 @@ class GlideClusterClient extends BaseClient_1.BaseClient {
      * ```
      */
     async functionKill(options) {
-        return this.createWritePromise((0, Commands_1.createFunctionKill)(), {
-            decoder: BaseClient_1.Decoder.String,
+        return this.createWritePromise((0, _1.createFunctionKill)(), {
+            decoder: _1.Decoder.String,
             ...options,
         });
     }
@@ -902,7 +908,7 @@ class GlideClusterClient extends BaseClient_1.BaseClient {
      * ```
      */
     async functionDump(options) {
-        return this.createWritePromise((0, Commands_1.createFunctionDump)(), { decoder: BaseClient_1.Decoder.Bytes, ...options }).then((res) => convertClusterGlideRecord(res, true, options?.route));
+        return this.createWritePromise((0, _1.createFunctionDump)(), { decoder: _1.Decoder.Bytes, ...options }).then((res) => convertClusterGlideRecord(res, true, options?.route));
     }
     /**
      * Restores libraries from the serialized payload returned by {@link functionDump}.
@@ -923,7 +929,7 @@ class GlideClusterClient extends BaseClient_1.BaseClient {
      * ```
      */
     async functionRestore(payload, options) {
-        return this.createWritePromise((0, Commands_1.createFunctionRestore)(payload, options?.policy), { decoder: BaseClient_1.Decoder.String, ...options });
+        return this.createWritePromise((0, _1.createFunctionRestore)(payload, options?.policy), { decoder: _1.Decoder.String, ...options });
     }
     /**
      * Deletes all the keys of all the existing databases. This command never fails.
@@ -944,8 +950,8 @@ class GlideClusterClient extends BaseClient_1.BaseClient {
      * ```
      */
     async flushall(options) {
-        return this.createWritePromise((0, Commands_1.createFlushAll)(options?.mode), {
-            decoder: BaseClient_1.Decoder.String,
+        return this.createWritePromise((0, _1.createFlushAll)(options?.mode), {
+            decoder: _1.Decoder.String,
             ...options,
         });
     }
@@ -968,8 +974,8 @@ class GlideClusterClient extends BaseClient_1.BaseClient {
      * ```
      */
     async flushdb(options) {
-        return this.createWritePromise((0, Commands_1.createFlushDB)(options?.mode), {
-            decoder: BaseClient_1.Decoder.String,
+        return this.createWritePromise((0, _1.createFlushDB)(options?.mode), {
+            decoder: _1.Decoder.String,
             ...options,
         });
     }
@@ -991,7 +997,7 @@ class GlideClusterClient extends BaseClient_1.BaseClient {
      * ```
      */
     async dbsize(options) {
-        return this.createWritePromise((0, Commands_1.createDBSize)(), options);
+        return this.createWritePromise((0, _1.createDBSize)(), options);
     }
     /** Publish a message on pubsub channel.
      * This command aggregates PUBLISH and SPUBLISH commands functionalities.
@@ -1020,7 +1026,7 @@ class GlideClusterClient extends BaseClient_1.BaseClient {
      * ```
      */
     async publish(message, channel, sharded = false) {
-        return this.createWritePromise((0, Commands_1.createPublish)(message, channel, sharded));
+        return this.createWritePromise((0, _1.createPublish)(message, channel, sharded));
     }
     /**
      * Lists the currently active shard channels.
@@ -1045,7 +1051,7 @@ class GlideClusterClient extends BaseClient_1.BaseClient {
      * ```
      */
     async pubsubShardChannels(options) {
-        return this.createWritePromise((0, Commands_1.createPubsubShardChannels)(options?.pattern), options);
+        return this.createWritePromise((0, _1.createPubsubShardChannels)(options?.pattern), options);
     }
     /**
      * Returns the number of subscribers (exclusive of clients subscribed to patterns) for the specified shard channels.
@@ -1068,7 +1074,7 @@ class GlideClusterClient extends BaseClient_1.BaseClient {
      * ```
      */
     async pubsubShardNumSub(channels, options) {
-        return this.createWritePromise((0, Commands_1.createPubSubShardNumSub)(channels), options).then((res) => res.map((r) => {
+        return this.createWritePromise((0, _1.createPubSubShardNumSub)(channels), options).then((res) => res.map((r) => {
             return { channel: r.key, numSub: r.value };
         }));
     }
@@ -1090,7 +1096,7 @@ class GlideClusterClient extends BaseClient_1.BaseClient {
      * ```
      */
     async lastsave(options) {
-        return this.createWritePromise((0, Commands_1.createLastSave)(), options).then((res) => convertClusterGlideRecord(res, true, options?.route));
+        return this.createWritePromise((0, _1.createLastSave)(), options).then((res) => convertClusterGlideRecord(res, true, options?.route));
     }
     /**
      * Returns a random existing key name.
@@ -1109,7 +1115,7 @@ class GlideClusterClient extends BaseClient_1.BaseClient {
      * ```
      */
     async randomKey(options) {
-        return this.createWritePromise((0, Commands_1.createRandomKey)(), options);
+        return this.createWritePromise((0, _1.createRandomKey)(), options);
     }
     /**
      * Flushes all the previously watched keys for a transaction. Executing a transaction will
@@ -1131,8 +1137,8 @@ class GlideClusterClient extends BaseClient_1.BaseClient {
      * ```
      */
     async unwatch(options) {
-        return this.createWritePromise((0, Commands_1.createUnWatch)(), {
-            decoder: BaseClient_1.Decoder.String,
+        return this.createWritePromise((0, _1.createUnWatch)(), {
+            decoder: _1.Decoder.String,
             ...options,
         });
     }
@@ -1202,7 +1208,7 @@ class GlideClusterClient extends BaseClient_1.BaseClient {
      * ```
      */
     async scriptExists(sha1s, options) {
-        return this.createWritePromise((0, Commands_1.createScriptExists)(sha1s), options);
+        return this.createWritePromise((0, _1.createScriptExists)(sha1s), options);
     }
     /**
      * Flushes the Lua scripts cache.
@@ -1221,8 +1227,8 @@ class GlideClusterClient extends BaseClient_1.BaseClient {
      * ```
      */
     async scriptFlush(options) {
-        return this.createWritePromise((0, Commands_1.createScriptFlush)(options?.mode), {
-            decoder: BaseClient_1.Decoder.String,
+        return this.createWritePromise((0, _1.createScriptFlush)(options?.mode), {
+            decoder: _1.Decoder.String,
             ...options,
         });
     }
@@ -1242,8 +1248,8 @@ class GlideClusterClient extends BaseClient_1.BaseClient {
      * ```
      */
     async scriptKill(options) {
-        return this.createWritePromise((0, Commands_1.createScriptKill)(), {
-            decoder: BaseClient_1.Decoder.String,
+        return this.createWritePromise((0, _1.createScriptKill)(), {
+            decoder: _1.Decoder.String,
             ...options,
         });
     }

package/build-ts/Logger.d.ts

@@ -2,31 +2,46 @@
  * Copyright Valkey GLIDE Project Contributors - SPDX Identifier: Apache-2.0
  */
 export type LevelOptions = "error" | "warn" | "info" | "debug" | "trace" | "off";
+/**
+ * A singleton class that allows logging which is consistent with logs from the internal GLIDE core.
+ * The logger can be set up in 2 ways -
+ *   1. By calling {@link init}, which configures the logger only if it wasn't previously configured.
+ *   2. By calling {@link setLoggerConfig}, which replaces the existing configuration, and means that new logs
+ *     will not be saved with the logs that were sent before the call. The previous logs will remain unchanged.
+ * If none of these functions are called, the first log attempt will initialize a new logger with default configuration.
+ */
 export declare class Logger {
     private static _instance;
     private static logger_level;
     private constructor();
     /**
-     * take the arguments from the user and provide to the core-logger (see ../logger-core)
-     * if the level is higher then the logger level (error is 0, warn 1, etc.) simply return without operation
-     * if a logger instance doesn't exist, create new one with default mode (decided by rust core, normally - level: error, target: console)
-     * logIdentifier arg is a string contain data that suppose to give the log a context and make it easier to find certain type of logs.
-     * when the log is connect to certain task the identifier should be the task id, when the log is not part of specific task the identifier should give a context to the log - for example, "socket connection".
-     * External users shouldn't use this function.
+     * Logs the provided message if the provided log level is lower then the logger level.
+     *
+     * @param logLevel - The log level of the provided message.
+     * @param logIdentifier - The log identifier should give the log a context.
+     * @param message - The message to log.
+     * @param err - The exception or error to log.
      */
-    static log(logLevel: LevelOptions, logIdentifier: string, message: string): void;
+    static log(logLevel: LevelOptions, logIdentifier: string, message: string, err?: Error): void;
     /**
-     * Initialize a logger if it wasn't initialized before - this method is meant to be used when there is no intention to replace an existing logger.
-     * The logger will filter all logs with a level lower than the given level,
-     * If given a fileName argument, will write the logs to files postfixed with fileName. If fileName isn't provided, the logs will be written to the console.
-     * To turn off the logger, provide the level "off".
+     * Initialize a logger if it wasn't initialized before - this method is meant to be used when there is no intention to
+     * replace an existing logger.
+     * The logger will filter all logs with a level lower than the given level.
+     * If given a fileName argument, will write the logs to files postfixed with fileName. If fileName isn't provided,
+     * the logs will be written to the console.
+     *
+     * @param level - Set the logger level to one of [ERROR, WARN, INFO, DEBUG, TRACE, OFF].
+     *   If log level isn't provided, the logger will be configured with default configuration.
+     *   To turn off logging completely, set the level to level "off".
+     * @param fileName - If provided the target of the logs will be the file mentioned.
+     *   Otherwise, logs will be printed to the console.
      */
     static init(level?: LevelOptions, fileName?: string): void;
     /**
-     * configure the logger.
-     * the level argument is the level of the logs you want the system to provide (error logs, warn logs, etc.)
-     * the filename argument is optional - if provided the target of the logs will be the file mentioned, else will be the console
-     * To turn off the logger, provide the level "off".
+     * Creates a new logger instance and configure it with the provided log level and file name.
+     *
+     * @param level - Set the logger level to one of [ERROR, WARN, INFO, DEBUG, TRACE, OFF].
+     * @param fileName - The target of the logs will be the file mentioned.
      */
     static setLoggerConfig(level: LevelOptions, fileName?: string): void;
 }

package/build-ts/Logger.js

@@ -4,7 +4,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Logger = void 0;
-const native_1 = require("./native");
+const _1 = require(".");
 const LEVEL = new Map([
     ["error", 0 /* Level.Error */],
     ["warn", 1 /* Level.Warn */],
@@ -14,39 +14,52 @@ const LEVEL = new Map([
     ["off", 5 /* Level.Off */],
     [undefined, undefined],
 ]);
-/*
- * A singleton class that allows logging which is consistent with logs from the internal rust core.
+/**
+ * A singleton class that allows logging which is consistent with logs from the internal GLIDE core.
  * The logger can be set up in 2 ways -
- *    1. By calling init, which configures the logger only if it wasn't previously configured.
- *     2. By calling Logger.setLoggerConfig, which replaces the existing configuration, and means that new logs will not be saved with the logs that were sent before the call. The previous logs will remain unchanged.
- * If no call to any of these function is received, the first log attempt will configure the logger with default configuration decided by rust core.
+ *   1. By calling {@link init}, which configures the logger only if it wasn't previously configured.
+ *   2. By calling {@link setLoggerConfig}, which replaces the existing configuration, and means that new logs
+ *     will not be saved with the logs that were sent before the call. The previous logs will remain unchanged.
+ * If none of these functions are called, the first log attempt will initialize a new logger with default configuration.
  */
 class Logger {
+    static _instance;
+    static logger_level = 0;
     constructor(level, fileName) {
-        Logger.logger_level = (0, native_1.InitInternalLogger)(LEVEL.get(level), fileName);
+        Logger.logger_level = (0, _1.InitInternalLogger)(LEVEL.get(level), fileName);
     }
     /**
-     * take the arguments from the user and provide to the core-logger (see ../logger-core)
-     * if the level is higher then the logger level (error is 0, warn 1, etc.) simply return without operation
-     * if a logger instance doesn't exist, create new one with default mode (decided by rust core, normally - level: error, target: console)
-     * logIdentifier arg is a string contain data that suppose to give the log a context and make it easier to find certain type of logs.
-     * when the log is connect to certain task the identifier should be the task id, when the log is not part of specific task the identifier should give a context to the log - for example, "socket connection".
-     * External users shouldn't use this function.
+     * Logs the provided message if the provided log level is lower then the logger level.
+     *
+     * @param logLevel - The log level of the provided message.
+     * @param logIdentifier - The log identifier should give the log a context.
+     * @param message - The message to log.
+     * @param err - The exception or error to log.
      */
-    static log(logLevel, logIdentifier, message) {
+    static log(logLevel, logIdentifier, message, err) {
         if (!Logger._instance) {
             new Logger();
         }
+        if (err) {
+            message += `: ${err.stack}`;
+        }
         const level = LEVEL.get(logLevel) || 0;
         if (!(level <= Logger.logger_level))
             return;
-        (0, native_1.log)(level, logIdentifier, message);
+        (0, _1.log)(level, logIdentifier, message);
     }
     /**
-     * Initialize a logger if it wasn't initialized before - this method is meant to be used when there is no intention to replace an existing logger.
-     * The logger will filter all logs with a level lower than the given level,
-     * If given a fileName argument, will write the logs to files postfixed with fileName. If fileName isn't provided, the logs will be written to the console.
-     * To turn off the logger, provide the level "off".
+     * Initialize a logger if it wasn't initialized before - this method is meant to be used when there is no intention to
+     * replace an existing logger.
+     * The logger will filter all logs with a level lower than the given level.
+     * If given a fileName argument, will write the logs to files postfixed with fileName. If fileName isn't provided,
+     * the logs will be written to the console.
+     *
+     * @param level - Set the logger level to one of [ERROR, WARN, INFO, DEBUG, TRACE, OFF].
+     *   If log level isn't provided, the logger will be configured with default configuration.
+     *   To turn off logging completely, set the level to level "off".
+     * @param fileName - If provided the target of the logs will be the file mentioned.
+     *   Otherwise, logs will be printed to the console.
      */
     static init(level, fileName) {
         if (!this._instance) {
@@ -54,14 +67,13 @@ class Logger {
         }
     }
     /**
-     * configure the logger.
-     * the level argument is the level of the logs you want the system to provide (error logs, warn logs, etc.)
-     * the filename argument is optional - if provided the target of the logs will be the file mentioned, else will be the console
-     * To turn off the logger, provide the level "off".
+     * Creates a new logger instance and configure it with the provided log level and file name.
+     *
+     * @param level - Set the logger level to one of [ERROR, WARN, INFO, DEBUG, TRACE, OFF].
+     * @param fileName - The target of the logs will be the file mentioned.
      */
     static setLoggerConfig(level, fileName) {
         this._instance = new this(level, fileName);
     }
 }
 exports.Logger = Logger;
-Logger.logger_level = 0;