@valkey/valkey-glide 1.3.4 → 1.3.5-rc2

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,6 +1,21 @@
-# Valkey GLIDE
+# Welcome to Valkey GLIDE!
 
-Valkey General Language Independent Driver for the Enterprise (GLIDE), is an open-source Valkey client library. Valkey GLIDE is one of the official client libraries for Valkey, and it supports all Valkey commands. Valkey GLIDE supports Valkey 7.2 and above, and Redis open-source 6.2, 7.0 and 7.2. Application programmers use Valkey GLIDE to safely and reliably connect their applications to Valkey- and Redis OSS- compatible services. Valkey GLIDE is designed for reliability, optimized performance, and high-availability, for Valkey and Redis OSS based applications. It is sponsored and supported by AWS, and is pre-configured with best practices learned from over a decade of operating Redis OSS-compatible services used by hundreds of thousands of customers. To help ensure consistency in application development and operations, Valkey GLIDE is implemented using a core driver framework, written in Rust, with language specific extensions. This design ensures consistency in features across languages and reduces overall complexity.
+Valkey General Language Independent Driver for the Enterprise (GLIDE) is the official open-source Valkey client library, proudly part of the Valkey organization. Our mission is to make your experience with Valkey and Redis OSS seamless and enjoyable. Whether you're a seasoned developer or just starting out, Valkey GLIDE is here to support you every step of the way.
+
+# Why Choose Valkey GLIDE?
+
+- **Community and Open Source**: Join our vibrant community and contribute to the project. We are always here to respond, and the client is for the community.
+- **Reliability**: Built with best practices learned from over a decade of operating Redis OSS-compatible services.
+- **Performance**: Optimized for high performance and low latency.
+- **High Availability**: Designed to ensure your applications are always up and running.
+- **Cross-Language Support**: Implemented using a core driver framework written in Rust, with language-specific extensions to ensure consistency and reduce complexity.
+- **Stability and Fault Tolerance**: We brought our years of experience to create a bulletproof client.
+- **Backed and Supported by AWS and GCP**: Ensuring robust support and continuous improvement of the project.
+
+## Documentation
+
+See GLIDE's [documentation site](https://valkey.io/valkey-glide/).  
+Visit our [wiki](https://github.com/valkey-io/valkey-glide/wiki/NodeJS-wrapper) for examples and further details on TLS, Read strategy, Timeouts and various other configurations.
 
 ## Supported Engine Versions
 
@@ -14,31 +29,34 @@ The release of Valkey GLIDE was tested on the following platforms:
 
 Linux:
 
-- Ubuntu 22.04.1 (x86_64 and aarch64)
-- Amazon Linux 2023 (AL2023) (x86_64)
+- Ubuntu 22.04.5 (x86_64/amd64 and arm64/aarch64)
+- Amazon Linux 2023 (AL2023) (x86_64/amd64 and arm64/aarch64)
 
 macOS:
 
-- macOS (Apple silicon/aarch_64 and Intel/x86_64)
-  Testing are being done on macOS arm64 platforms.
-  Please note that the package is not tested on macOS intel platforms, only minimal testing is done during CD.
+- macOS 14.7 (Apple silicon/aarch_64)
+- macOS 13.7 (x86_64/amd64)
 
 Alpine:
 
-- node:alpine (default on aarch64 and x86_64)
+- node:alpine (x86_64/amd64 and arm64/aarch64)
 
 ## NodeJS supported version
 
-Node.js 16.20 or higher.
-
-## Documentation
-
-Visit our [wiki](https://github.com/valkey-io/valkey-glide/wiki/NodeJS-wrapper) for examples and further details on TLS, Read strategy, Timeouts and various other configurations.
+Node.js 16 or higher.
 
 ### Building & Testing
 
 Development instructions for local building & testing the package are in the [DEVELOPER.md](https://github.com/valkey-io/valkey-glide/blob/main/node/DEVELOPER.md#build-from-source) file.
 
+# Quick Start
+
+## Installation
+
+```bash
+npm i @valkey/valkey-glide
+```
+
 ## Basic Examples
 
 #### Standalone Mode:
@@ -103,4 +121,8 @@ Currently, the package is tested on:
 | Operation systems | C lib                | Architecture      |
 | ----------------- | -------------------- | ----------------- |
 | `Linux`           | `glibc`, `musl libc` | `x86_64`, `arm64` |
-| `macOS`           | `Darwin`            | `arm64`, `x86_64` |
+| `macOS`           | `Darwin`             | `x86_64`, `arm64` |
+
+## Community and Feedback
+
+We encourage you to join our community to support, share feedback, and ask questions. You can approach us for anything on our Valkey Slack: [Join Valkey Slack](https://join.slack.com/t/valkey-oss-developer/shared_invite/zt-2nxs51chx-EB9hu9Qdch3GMfRcztTSkQ).

package/build-ts/{src/BaseClient.d.ts → BaseClient.d.ts}

@@ -1,19 +1,15 @@
-/**
- * Copyright Valkey GLIDE Project Contributors - SPDX Identifier: Apache-2.0
- */
-import { Script } from "glide-rs";
-import * as net from "net";
-import { Buffer, Writer } from "protobufjs";
-import { AggregationType, BaseScanOptions, BitFieldGet, // eslint-disable-line @typescript-eslint/no-unused-vars
+import { Buffer, Writer } from "protobufjs/minimal";
+import { AggregationType, BaseScanOptions, BatchOptions, BitFieldGet, // eslint-disable-line @typescript-eslint/no-unused-vars
 BitFieldSubCommands, // eslint-disable-line @typescript-eslint/no-unused-vars
-BitOffsetOptions, BitwiseOperation, Boundary, // eslint-disable-line @typescript-eslint/no-unused-vars
+BitOffsetOptions, BitwiseOperation, Boundary, ClusterBatchOptions, // 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, ValkeyError } from "./Errors";
+import { ConnectionError, RequestError, ValkeyError } from "./Errors";
 import { GlideClientConfiguration } from "./GlideClient";
-import { GlideClusterClientConfiguration, RouteOption, Routes } from "./GlideClusterClient";
-import { command_request, connection_request, response } from "./ProtobufMessage";
+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 = {
@@ -30,7 +26,7 @@ export declare enum ProtocolVersion {
     /** Use RESP3 to communicate with the server nodes. */
     RESP3 = 0
 }
-export type GlideReturnType = "OK" | string | number | null | boolean | bigint | Buffer | Set<GlideReturnType> | ReturnTypeRecord | ReturnTypeMap | ReturnTypeAttribute | GlideReturnType[];
+export type GlideReturnType = "OK" | string | number | null | boolean | bigint | Buffer | Set<GlideReturnType> | ReturnTypeRecord | ReturnTypeMap | ReturnTypeAttribute | RequestError | GlideReturnType[];
 /**
  * Union type that can store either a valid UTF-8 string or array of bytes.
  */
@@ -48,7 +44,16 @@ export declare enum Decoder {
      */
     String = 1
 }
-/** An extension to command option types with {@link Decoder}. */
+/**
+ * An extension to command option types with {@link Decoder}.
+ *
+ * WARNING:
+ *
+ * Be aware that if decoding fails during a command execution (due to
+ * invalid inputs, incorrect decoder), data COULD BE UNRECOVERABLY LOST.
+ *
+ * Use with caution.
+ */
 export interface DecoderOption {
     /**
      * {@link Decoder} type which defines how to handle the response.
@@ -102,24 +107,6 @@ export type ElementAndScore = {
     /** The element score. */
     score: Score;
 };
-/**
- * @internal
- * This function converts an input from GlideRecord or Record types to GlideRecord.
- *
- * @param keysAndValues - key names and their values.
- * @returns GlideRecord array containing keys and their values.
- */
-export declare function convertGlideRecord(keysAndValues: GlideRecord<GlideString> | Record<string, GlideString>): GlideRecord<GlideString>;
-/**
- * @internal
- * Recursively downcast `GlideRecord` to `Record`. Use if `data` keys are always strings.
- */
-export declare function convertGlideRecordToRecord<T>(data: GlideRecord<T>): Record<string, T>;
-/**
- * @internal
- * Check whether an object is a `GlideRecord` (see {@link GlideRecord}).
- */
-export declare function isGlideRecord(obj?: unknown): boolean;
 /** Represents the return type of {@link xinfoStream} command. */
 export type ReturnTypeXinfoStream = Record<string, StreamEntries | Record<string, StreamEntries | Record<string, StreamEntries>[]>[]>;
 /**
@@ -127,11 +114,6 @@ export type ReturnTypeXinfoStream = Record<string, StreamEntries | Record<string
  * See {@link ReturnTypeXinfoStream}.
  */
 export type StreamEntries = GlideString | number | (GlideString | number | GlideString[])[][];
-/**
- * @internal
- * Reverse of {@link convertGlideRecordToRecord}.
- */
-export declare function convertRecordToGlideRecord<T>(data: Record<string, T>): GlideRecord<T>;
 /** Represents the credentials for connecting to a server. */
 export interface ServerCredentials {
     /**
@@ -352,12 +334,10 @@ export interface PubSubMsg {
     channel: GlideString;
     pattern?: GlideString | null;
 }
+export type WritePromiseOptions = BaseOptions | (BaseOptions & (ClusterBatchOptions | BatchOptions));
 /**
- * @internal
- * A type to combine RouterOption and DecoderOption to be used for creating write promises for the command.
- * See - {@link DecoderOption} and {@link RouteOption}
+ * Base client interface for GLIDE
  */
-export type WritePromiseOptions = RouteOption & DecoderOption;
 export declare class BaseClient {
     private socket;
     protected readonly promiseCallbackFunctions: [PromiseFunction, ErrorFunction, Decoder | undefined][] | [PromiseFunction, ErrorFunction][];
@@ -377,28 +357,15 @@ export declare class BaseClient {
     protected toProtobufRoute(route: Routes | undefined): command_request.Routes | undefined;
     processResponse(message: response.Response): void;
     processPush(response: response.Response): void;
-    /**
-     * @internal
-     */
-    protected constructor(socket: net.Socket, options?: BaseClientConfiguration);
     protected getCallbackIndex(): number;
     private writeBufferedRequestsToSocket;
     protected ensureClientIsOpen(): void;
-    /**
-     * @internal
-     */
-    protected createWritePromise<T>(command: command_request.Command | command_request.Command[], options?: WritePromiseOptions): Promise<T>;
     protected createUpdateConnectionPasswordPromise(command: command_request.UpdateConnectionPassword): Promise<GlideString>;
     protected createScriptInvocationPromise<T = GlideString>(command: command_request.ScriptInvocation, options?: {
         keys?: GlideString[];
         args?: GlideString[];
     } & DecoderOption): Promise<T>;
-    protected writeOrBufferCommandRequest(callbackIdx: number, command: command_request.Command | command_request.Command[], route?: command_request.Routes): void;
     protected writeOrBufferRequest<TRequest>(message: TRequest, encodeDelimited: (message: TRequest, writer: Writer) => void): void;
-    /**
-     * @internal
-     */
-    protected processResultWithSetCommands(result: GlideReturnType[] | null, setCommandsIndexes: number[]): GlideReturnType[] | null;
     cancelPubSubFuturesWithExceptionSafe(exception: ConnectionError): void;
     isPubsubConfigured(config: GlideClientConfiguration | GlideClusterClientConfiguration): boolean;
     getPubsubCallbackAndContext(config: GlideClientConfiguration | GlideClusterClientConfiguration): [((msg: PubSubMsg, context: any) => void) | null | undefined, any];
@@ -406,13 +373,13 @@ export declare class BaseClient {
     tryGetPubSubMessage(decoder?: Decoder): PubSubMsg | null;
     notificationToPubSubMessageSafe(pushNotification: response.Response, decoder?: Decoder): PubSubMsg | null;
     completePubSubFuturesSafe(): void;
-    /** Get the value associated with the given key, or null if no such value exists.
+    /** Get the value associated with the given `key`, or `null` if no such `key` exists.
      *
      * @see {@link https://valkey.io/commands/get/|valkey.io} for details.
      *
-     * @param key - The key to retrieve from the database.
+     * @param key - The `key` to retrieve from the database.
      * @param options - (Optional) See {@link DecoderOption}.
-     * @returns If `key` exists, returns the value of `key`. Otherwise, return null.
+     * @returns If `key` exists, returns the value of `key`. Otherwise, return `null`.
      *
      * @example
      * ```typescript
@@ -1287,9 +1254,9 @@ export declare class BaseClient {
      *
      * @param key - The key of the hash.
      * @param count - The number of field names to return.
+     *     If `count` is positive, returns unique elements.
+     *     If negative, allows for duplicates.
      * @param options - (Optional) See {@link DecoderOption}.
-     *
-     *     If `count` is positive, returns unique elements. If negative, allows for duplicates.
      * @returns An `array` of random field names from the hash stored at `key`,
      *     or an `empty array` when the key does not exist.
      *
@@ -1308,9 +1275,9 @@ export declare class BaseClient {
      *
      * @param key - The key of the hash.
      * @param count - The number of field names to return.
+     *     If `count` is positive, returns unique elements.
+     *     If negative, allows for duplicates.
      * @param options - (Optional) See {@link DecoderOption}.
-     *
-     *     If `count` is positive, returns unique elements. If negative, allows for duplicates.
      * @returns A 2D `array` of `[fieldName, value]` `arrays`, where `fieldName` is a random
      *     field name from the hash and `value` is the associated value of the field name.
      *     If the hash does not exist or is empty, the response will be an empty `array`.
@@ -3812,7 +3779,7 @@ export declare class BaseClient {
      * @param start - Filters the claimed entries to those that have an ID equal or greater than the
      *     specified value.
      * @param options - (Optional) Additional parameters:
-     * - (Optional) `count`: the number of claimed entries.
+     * - (Optional) `count`: the number of claimed entries. Default value is 100.
      * - (Optional) `decoder`: see {@link DecoderOption}.
      * @returns A `tuple` containing the following elements:
      *   - A stream ID to be used as the start argument for the next call to `XAUTOCLAIM`. This ID is
@@ -3859,7 +3826,7 @@ export declare class BaseClient {
      * @param start - Filters the claimed entries to those that have an ID equal or greater than the
      *     specified value.
      * @param options - (Optional) Additional parameters:
-     * - (Optional) `count`: limits the number of claimed entries to the specified value.
+     * - (Optional) `count`: limits the number of claimed entries to the specified value. Default value is 100.
      * @returns An `array` containing the following elements:
      *   - A stream ID to be used as the start argument for the next call to `XAUTOCLAIM`. This ID is
      *     equivalent to the next ID in the stream after the entries that were scanned, or "0-0" if
@@ -3936,7 +3903,7 @@ export declare class BaseClient {
      * @see {@link https://valkey.io/commands/xgroup-destroy/|valkey.io} for more details.
      *
      * @param key - The key of the stream.
-     * @param groupname - The newly created consumer group name.
+     * @param groupname - The consumer group name to delete.
      * @returns `true` if the consumer group is destroyed. Otherwise, `false`.
      *
      * @example
@@ -3966,14 +3933,14 @@ export declare class BaseClient {
      * console.log(infoResult);
      * // Output: {
      * //   length: 2,
-     * //   'radix-tree-keys': 1,
-     * //   'radix-tree-nodes': 2,
-     * //   'last-generated-id': '1719877599564-1',
-     * //   'max-deleted-entry-id': '0-0',
-     * //   'entries-added': 2,
-     * //   'recorded-first-entry-id': '1719877599564-0',
-     * //   'first-entry': [ '1719877599564-0', ['some_field", "some_value', ...] ],
-     * //   'last-entry': [ '1719877599564-0', ['some_field", "some_value', ...] ],
+     * //   "radix-tree-keys": 1,
+     * //   "radix-tree-nodes": 2,
+     * //   "last-generated-id": "1719877599564-1",
+     * //   "max-deleted-entry-id": "0-0",
+     * //   "entries-added": 2,
+     * //   "recorded-first-entry-id": "1719877599564-0",
+     * //   "first-entry": [ "1719877599564-0", ["some_field", "some_value", ...] ],
+     * //   "last-entry": [ "1719877599564-0", ["some_field", "some_value", ...] ],
      * //   groups: 1,
      * // }
      * ```
@@ -3984,27 +3951,27 @@ export declare class BaseClient {
      * const infoResult = await client.xinfoStream("my_stream", 15); // limit of 15 entries
      * console.log(infoResult);
      * // Output: {
-     * //   'length': 2,
-     * //   'radix-tree-keys': 1,
-     * //   'radix-tree-nodes': 2,
-     * //   'last-generated-id': '1719877599564-1',
-     * //   'max-deleted-entry-id': '0-0',
-     * //   'entries-added': 2,
-     * //   'recorded-first-entry-id': '1719877599564-0',
-     * //   'entries': [ [ '1719877599564-0', ['some_field", "some_value', ...] ] ],
-     * //   'groups': [ {
-     * //     'name': 'group',
-     * //     'last-delivered-id': '1719877599564-0',
-     * //     'entries-read': 1,
-     * //     'lag': 1,
-     * //     'pel-count': 1,
-     * //     'pending': [ [ '1719877599564-0', 'consumer', 1722624726802, 1 ] ],
-     * //     'consumers': [ {
-     * //         'name': 'consumer',
-     * //         'seen-time': 1722624726802,
-     * //         'active-time': 1722624726802,
-     * //         'pel-count': 1,
-     * //         'pending': [ [ '1719877599564-0', 'consumer', 1722624726802, 1 ] ],
+     * //   "length": 2,
+     * //   "radix-tree-keys": 1,
+     * //   "radix-tree-nodes": 2,
+     * //   "last-generated-id": "1719877599564-1",
+     * //   "max-deleted-entry-id": "0-0",
+     * //   "entries-added": 2,
+     * //   "recorded-first-entry-id": "1719877599564-0",
+     * //   "entries": [ [ "1719877599564-0", ["some_field", "some_value", ...] ] ],
+     * //   "groups': [ {
+     * //     "name': "group",
+     * //     "last-delivered-id": "1719877599564-0",
+     * //     "entries-read": 1,
+     * //     "lag": 1,
+     * //     "pel-count": 1,
+     * //     "pending": [ [ "1719877599564-0", "consumer", 1722624726802, 1 ] ],
+     * //     "consumers": [ {
+     * //         "name": "consumer",
+     * //         "seen-time": 1722624726802,
+     * //         "active-time": 1722624726802,
+     * //         "pel-count": 1,
+     * //         "pending": [ [ "1719877599564-0", "consumer", 1722624726802, 1 ] ],
      * //         }
      * //       ]
      * //     }
@@ -4973,14 +4940,14 @@ export declare class BaseClient {
      * ```typescript
      * const response = await client.watch(["sampleKey"]);
      * console.log(response); // Output: "OK"
-     * const transaction = new Transaction().set("SampleKey", "foobar");
+     * const transaction = new Batch(true).set("SampleKey", "foobar");
      * const result = await client.exec(transaction);
      * console.log(result); // Output: "OK" - Executes successfully and keys are unwatched.
      * ```
      * ```typescript
      * const response = await client.watch(["sampleKey"]);
      * console.log(response); // Output: "OK"
-     * const transaction = new Transaction().set("SampleKey", "foobar");
+     * const transaction = new Batch(true).set("SampleKey", "foobar");
      * await client.set("sampleKey", "hello world");
      * const result = await client.exec(transaction);
      * console.log(result); // Output: null - null is returned when the watched key is modified before transaction execution.
@@ -5063,6 +5030,7 @@ export declare class BaseClient {
      * - (Optional) `count`: the maximum number of popped elements. If not specified, pops one member.
      * - (Optional) `decoder`: see {@link DecoderOption}.
      * @returns A `Record` which stores the key name where elements were popped out and the array of popped elements.
+     *     If no member could be popped, returns `null`.
      *
      * @example
      * ```typescript
@@ -5260,36 +5228,12 @@ export declare class BaseClient {
      * ```
      */
     sortStore(key: GlideString, destination: GlideString, options?: SortOptions): Promise<number>;
-    /**
-     * @internal
-     */
-    protected createClientRequest(options: BaseClientConfiguration): connection_request.IConnectionRequest;
-    /**
-     * @internal
-     */
-    protected configureAdvancedConfigurationBase(options: AdvancedBaseClientConfiguration, request: connection_request.IConnectionRequest): void;
-    /**
-     * @internal
-     */
-    protected connectToServer(options: BaseClientConfiguration): Promise<void>;
     /**
      *  Terminate the client by closing all associated resources, including the socket and any active promises.
      *  All open promises will be closed with an exception.
      * @param errorMessage - If defined, this error message will be passed along with the exceptions when closing all open promises.
      */
     close(errorMessage?: string): void;
-    /**
-     * @internal
-     */
-    protected static __createClientInternal<TConnection extends BaseClient>(options: BaseClientConfiguration, connectedSocket: net.Socket, constructor: (socket: net.Socket, options?: BaseClientConfiguration) => TConnection): Promise<TConnection>;
-    /**
-     * @internal
-     */
-    protected static GetSocket(path: string): Promise<net.Socket>;
-    /**
-     * @internal
-     */
-    protected static createClientInternal<TConnection extends BaseClient>(options: BaseClientConfiguration, constructor: (socket: net.Socket, options?: BaseClientConfiguration) => TConnection): Promise<TConnection>;
     /**
      * Update the current connection with a new password.
      *