@valkey/valkey-glide 1.3.5-rc0 → 1.3.5-rc11

package/README.md

@@ -27,23 +27,36 @@ Refer to the [Supported Engine Versions table](https://github.com/valkey-io/valk
 
 The release of Valkey GLIDE was tested on the following platforms:
 
-Linux:
+### Linux GNU
 
-- Ubuntu 22.04.5 (x86_64/amd64 and arm64/aarch64)
-- Amazon Linux 2023 (AL2023) (x86_64/amd64 and arm64/aarch64)
+Tests are actively running on **Ubuntu 24**, but the package is being build for any linux using **glibc 2.17** or higher.
+Manual tests have been done on:
 
-macOS:
+- Fedora 39
+- Ubuntu 22.04
+- Amazon Linux 2
+- Debian 12.
 
-- macOS 14.7 (Apple silicon/aarch_64)
-- macOS 13.7 (x86_64/amd64)
+### MacOS (Darwin)
 
-Alpine:
+MacOS Apple Silicon/aarch_64 and x86_64/amd64.
+
+- Full tests are running on MacOS 15.0 arm64/aarch64
+- Minimal tests are running on: MacOS 13.5 x86*64/amd64 *(We do not recommend using MacOS Intel for production, It is supported for development purposes)\_
+
+### Alpine
+
+All alpine versions that are using _musl libc_ 1.2.3 (All Alpine non deprecated alpine versions) or higher should be supported.
+Tests are running on:
 
 - node:alpine (x86_64/amd64 and arm64/aarch64)
 
 ## NodeJS supported version
 
 Node.js 16 or higher.
+**For npm users on linux it is recommended to use npm >=11 since it support optional download base on libc, yarn users should not be concerned**
+
+- Note: The library is dependent on the [protobufjs library](https://protobufjs.github.io/protobuf.js/#installation), which add a size to the package. The package is using the protobufjs/minimal version, hence, if size matter, bundlers should be able to strip the unused code. It should reduce the size of the dependency from 19kb gzipped to 6.5kb gzipped.
 
 ### Building & Testing
 
@@ -59,7 +72,7 @@ npm i @valkey/valkey-glide
 
 ## Basic Examples
 
-#### Standalone Mode:
+#### Standalone Mode
 
 ```typescript
 import { GlideClient, GlideClusterClient, Logger } from "@valkey/valkey-glide";
@@ -86,7 +99,7 @@ const get_response = await client.get("foo");
 console.log(`Get response is = ${get_response}`);
 ```
 
-#### Cluster Mode:
+#### Cluster Mode
 
 ```typescript
 import { GlideClient, GlideClusterClient, Logger } from "@valkey/valkey-glide";

package/build-ts/BaseClient.d.ts

@@ -1,15 +1,15 @@
 import { Buffer, Writer } from "protobufjs/minimal";
-import { AggregationType, BaseScanOptions, BatchOptions, BitFieldGet, // eslint-disable-line @typescript-eslint/no-unused-vars
+import { Script } from "../build-ts/native";
+import { command_request, connection_request, response } from "../build-ts/ProtobufMessage";
+import { AggregationType, BaseScanOptions, BitFieldGet, // eslint-disable-line @typescript-eslint/no-unused-vars
 BitFieldSubCommands, // eslint-disable-line @typescript-eslint/no-unused-vars
-BitOffsetOptions, BitwiseOperation, Boundary, ClusterBatchOptions, // eslint-disable-line @typescript-eslint/no-unused-vars
+BitOffsetOptions, BitwiseOperation, Boundary, // eslint-disable-line @typescript-eslint/no-unused-vars
 ExpireOptions, GeoAddOptions, // eslint-disable-line @typescript-eslint/no-unused-vars
 GeoSearchResultOptions, GeoSearchShape, GeoSearchStoreResultOptions, GeoUnit, GeospatialData, HScanOptions, InsertPosition, KeyWeight, LPosOptions, ListDirection, // eslint-disable-line @typescript-eslint/no-unused-vars
 RangeByIndex, RangeByLex, RangeByScore, RestoreOptions, ScoreFilter, SearchOrigin, SetOptions, SortOptions, StreamAddOptions, StreamClaimOptions, StreamGroupOptions, StreamPendingOptions, StreamReadGroupOptions, StreamReadOptions, StreamTrimOptions, TimeUnit, ZAddOptions, ZScanOptions } from "./Commands";
 import { ConnectionError, RequestError, ValkeyError } from "./Errors";
 import { GlideClientConfiguration } from "./GlideClient";
 import { GlideClusterClientConfiguration, Routes } from "./GlideClusterClient";
-import { Script } from "./native";
-import { command_request, connection_request, response } from "../build-ts/ProtobufMessage";
 type PromiseFunction = (value?: any) => void;
 type ErrorFunction = (error: ValkeyError) => void;
 export type ReturnTypeRecord = {
@@ -334,7 +334,6 @@ export interface PubSubMsg {
     channel: GlideString;
     pattern?: GlideString | null;
 }
-export type WritePromiseOptions = BaseOptions | (BaseOptions & (ClusterBatchOptions | BatchOptions));
 /**
  * Base client interface for GLIDE
  */

package/build-ts/BaseClient.js

@@ -43,11 +43,11 @@ exports.convertRecordToGlideRecord = convertRecordToGlideRecord;
  */
 const net = __importStar(require("net"));
 const minimal_1 = require("protobufjs/minimal");
+const native_1 = require("../build-ts/native");
+const ProtobufMessage_1 = require("../build-ts/ProtobufMessage");
 const Commands_1 = require("./Commands");
 const Errors_1 = require("./Errors");
 const Logger_1 = require("./Logger");
-const native_1 = require("./native");
-const ProtobufMessage_1 = require("../build-ts/ProtobufMessage");
 var ProtocolVersion;
 (function (ProtocolVersion) {
     /** Use RESP2 to communicate with the server nodes. */
@@ -6047,4 +6047,3 @@ class BaseClient {
     }
 }
 exports.BaseClient = BaseClient;
-//# sourceMappingURL=BaseClient.js.map

package/build-ts/Batch.js

@@ -3455,4 +3455,3 @@ class Transaction extends Batch {
     }
 }
 exports.Transaction = Transaction;
-//# sourceMappingURL=Batch.js.map

package/build-ts/Commands.js

@@ -216,8 +216,8 @@ exports.createXGroupSetid = createXGroupSetid;
 exports.createScriptExists = createScriptExists;
 exports.createScriptFlush = createScriptFlush;
 exports.createScriptKill = createScriptKill;
-const native_1 = require("./native");
 const long_1 = __importDefault(require("long"));
+const native_1 = require("../build-ts/native");
 const BaseClient_1 = require("./BaseClient");
 const ProtobufMessage_1 = require("../build-ts/ProtobufMessage");
 var RequestType = ProtobufMessage_1.command_request.RequestType;
@@ -2706,4 +2706,3 @@ function createScriptFlush(mode) {
 function createScriptKill() {
     return createCommand(RequestType.ScriptKill, []);
 }
-//# sourceMappingURL=Commands.js.map

package/build-ts/Errors.js

@@ -40,4 +40,3 @@ exports.ConnectionError = ConnectionError;
 class ConfigurationError extends RequestError {
 }
 exports.ConfigurationError = ConfigurationError;
-//# sourceMappingURL=Errors.js.map

package/build-ts/GlideClient.js

@@ -897,4 +897,3 @@ class GlideClient extends BaseClient_1.BaseClient {
     }
 }
 exports.GlideClient = GlideClient;
-//# sourceMappingURL=GlideClient.js.map

package/build-ts/GlideClusterClient.d.ts

@@ -1,10 +1,10 @@
 /**
  * Copyright Valkey GLIDE Project Contributors - SPDX Identifier: Apache-2.0
  */
+import { ClusterScanCursor, Script } from "../build-ts/native";
 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";
 /** An extension to command option types with {@link Routes}. */
 export interface RouteOption {
     /**

package/build-ts/GlideClusterClient.js

@@ -4,10 +4,10 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GlideClusterClient = exports.GlideClusterClientConfiguration = void 0;
+const native_1 = require("../build-ts/native");
+const ProtobufMessage_1 = require("../build-ts/ProtobufMessage");
 const BaseClient_1 = require("./BaseClient");
 const Commands_1 = require("./Commands");
-const native_1 = require("./native");
-const ProtobufMessage_1 = require("../build-ts/ProtobufMessage");
 /* eslint-disable-next-line @typescript-eslint/no-namespace */
 var GlideClusterClientConfiguration;
 (function (GlideClusterClientConfiguration) {
@@ -1249,4 +1249,3 @@ class GlideClusterClient extends BaseClient_1.BaseClient {
     }
 }
 exports.GlideClusterClient = GlideClusterClient;
-//# sourceMappingURL=GlideClusterClient.js.map

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 native_1 = require("../build-ts/native");
 const LEVEL = new Map([
     ["error", 0 /* Level.Error */],
     ["warn", 1 /* Level.Warn */],
@@ -14,39 +14,50 @@ 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 {
     constructor(level, fileName) {
         Logger.logger_level = (0, native_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);
     }
     /**
-     * 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,10 +65,10 @@ 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);
@@ -65,4 +76,3 @@ class Logger {
 }
 exports.Logger = Logger;
 Logger.logger_level = 0;
-//# sourceMappingURL=Logger.js.map