@valkey/valkey-glide 1.3.4 → 1.3.5-rc2

package/build-ts/Errors.js

@@ -0,0 +1,42 @@
+"use strict";
+/**
+ * Copyright Valkey GLIDE Project Contributors - SPDX Identifier: Apache-2.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfigurationError = exports.ConnectionError = exports.ExecAbortError = exports.TIMEOUT_ERROR = exports.TimeoutError = exports.RequestError = exports.ClosingError = exports.ValkeyError = void 0;
+/// Base class for errors.
+class ValkeyError extends Error {
+    constructor(message) {
+        super();
+        this.message = message ?? "No error message provided";
+    }
+    get name() {
+        return this.constructor.name;
+    }
+}
+exports.ValkeyError = ValkeyError;
+/// Errors that report that the client has closed and is no longer usable.
+class ClosingError extends ValkeyError {
+}
+exports.ClosingError = ClosingError;
+/// Errors that were reported during a request.
+class RequestError extends ValkeyError {
+}
+exports.RequestError = RequestError;
+/// Errors that are thrown when a request times out.
+class TimeoutError extends RequestError {
+}
+exports.TimeoutError = TimeoutError;
+exports.TIMEOUT_ERROR = new TimeoutError("Operation timed out");
+/// Errors that are thrown when a transaction is aborted.
+class ExecAbortError extends RequestError {
+}
+exports.ExecAbortError = ExecAbortError;
+/// Errors that are thrown when a connection disconnects. These errors can be temporary, as the client will attempt to reconnect.
+class ConnectionError extends RequestError {
+}
+exports.ConnectionError = ConnectionError;
+/// Errors that are thrown when a request cannot be completed in current configuration settings.
+class ConfigurationError extends RequestError {
+}
+exports.ConfigurationError = ConfigurationError;

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

@@ -1,11 +1,9 @@
 /**
  * Copyright Valkey GLIDE Project Contributors - SPDX Identifier: Apache-2.0
  */
-import * as net from "net";
 import { AdvancedBaseClientConfiguration, BaseClient, BaseClientConfiguration, DecoderOption, GlideReturnType, GlideString, PubSubMsg } from "./BaseClient";
-import { FlushMode, FunctionListOptions, FunctionListResponse, FunctionRestorePolicy, FunctionStatsFullResponse, InfoOptions, LolwutOptions, ScanOptions } from "./Commands";
-import { connection_request } from "./ProtobufMessage";
-import { Transaction } from "./Transaction";
+import { Batch } from "./Batch";
+import { BatchOptions, FlushMode, FunctionListOptions, FunctionListResponse, FunctionRestorePolicy, FunctionStatsFullResponse, InfoOptions, LolwutOptions, ScanOptions } from "./Commands";
 export declare namespace GlideClientConfiguration {
     /**
      * Enum representing pubsub subscription modes.
@@ -127,22 +125,20 @@ export type GlideClientConfiguration = BaseClientConfiguration & {
 export type AdvancedGlideClientConfiguration = AdvancedBaseClientConfiguration & {};
 /**
  * Client used for connection to standalone servers.
+ * Use {@link createClient} to request a client.
  *
- * @see For full documentation refer to {@link https://github.com/valkey-io/valkey-glide/wiki/NodeJS-wrapper#standalone|Valkey Glide Wiki}.
+ * @see For full documentation refer to {@link https://github.com/valkey-io/valkey-glide/wiki/NodeJS-wrapper#standalone | Valkey Glide Wiki}.
  */
 export declare class GlideClient extends BaseClient {
     /**
-     * @internal
-     */
-    protected createClientRequest(options: GlideClientConfiguration): connection_request.IConnectionRequest;
-    /**
-     * Creates a new `GlideClient` instance and establishes a connection to a standalone Valkey Glide server.
+     * Creates a new `GlideClient` instance and establishes a connection to a standalone Valkey server.
      *
      * @param options - The configuration options for the client, including server addresses, authentication credentials, TLS settings, database selection, reconnection strategy, and Pub/Sub subscriptions.
      * @returns A promise that resolves to a connected `GlideClient` instance.
      *
      * @remarks
-     * Use this static method to create and connect a `GlideClient` to a standalone Valkey Glide server. The client will automatically handle connection establishment, including any authentication and TLS configurations.
+     * Use this static method to create and connect a `GlideClient` to a standalone Valkey server.
+     * The client will automatically handle connection establishment, including any authentication and TLS configurations.
      *
      * @example
      * ```typescript
@@ -184,22 +180,53 @@ export declare class GlideClient extends BaseClient {
      */
     static createClient(options: GlideClientConfiguration): Promise<GlideClient>;
     /**
-     * @internal
-     */
-    static __createClient(options: BaseClientConfiguration, connectedSocket: net.Socket): Promise<GlideClient>;
-    /**
-     * Execute a transaction by processing the queued commands.
+     * Execute a batch by processing the queued commands.
+     *
+     * **Notes:**
+     * - **Atomic Batches - Transactions:** If the transaction fails due to a `WATCH` command, `EXEC` will return `null`.
      *
      * @see {@link https://github.com/valkey-io/valkey-glide/wiki/NodeJS-wrapper#transaction|Valkey Glide Wiki} for details on Valkey Transactions.
      *
-     * @param transaction - A {@link Transaction} object containing a list of commands to be executed.
-     * @param options - (Optional) See {@link DecoderOption}.
+     * @param batch - A {@link Batch} object containing a list of commands to be executed.
+     * @param raiseOnError - Determines how errors are handled within the batch response.
+     *   - If `true`, the first the first encountered error in the batch will be raised as an exception of type {@link RequestError}
+     * after all retries and reconnections have been exhausted.
+     *  - If `false`, errors will be included as part of the batch response, allowing the caller to process both successful and failed commands together.
+     * In this case, error details will be provided as instances of {@link RequestError} in the response list.
+     * @param options - (Optional) See {@link BatchOptions} and {@link DecoderOption}.
      * @returns A list of results corresponding to the execution of each command in the transaction.
      *     If a command returns a value, it will be included in the list. If a command doesn't return a value,
      *     the list entry will be `null`.
      *     If the transaction failed due to a `WATCH` command, `exec` will return `null`.
+     *
+     * @see {@link https://valkey.io/docs/topics/transactions/|Valkey Transactions (Atomic Batches)} for details.
+     * @see {@link https://valkey.io/docs/topics/pipelining/|Valkey Pipelines (Non-Atomic Batches)} for details.
+     *
+     * @example
+     * ```typescript
+     * // Example 1: Atomic Batch (Transaction) with Options
+     * const transaction = new Batch(true) // Atomic (Transactional)
+     *     .set("key", "value")
+     *     .get("key");
+     *
+     * const result = await client.exec(transaction, false, {timeout: 1000}); // Execute the transaction with raiseOnError = false and a timeout of 1000ms
+     * console.log(result); // Output: ['OK', 'value']
+     * ```
+     *
+     * @example
+     * ```typescript
+     * // Example 2: Non-Atomic Batch (Pipelining) with Options
+     * const pipeline = new Batch(false) // Non-Atomic (Pipelining)
+     *    .set("key1", "value1")
+     *    .set("key2", "value2")
+     *   .get("key1")
+     *   .get("key2");
+     *
+     * const result = await client.exec(pipeline, false, {timeout: 1000}); // Execute the pipeline with raiseOnError = false and a timeout of 1000ms
+     * console.log(result); // Output: ['OK', 'OK', 'value1', 'value2']
+     * ```
      */
-    exec(transaction: Transaction, options?: DecoderOption): Promise<GlideReturnType[] | null>;
+    exec(batch: Batch, raiseOnError: boolean, options?: BatchOptions & DecoderOption): Promise<GlideReturnType[] | null>;
     /** Executes a single command, without checking inputs. Every part of the command, including subcommands,
      *  should be added as a separate value in args.
      *
@@ -251,11 +278,20 @@ export declare class GlideClient extends BaseClient {
     /**
      * Gets information and statistics about the server.
      *
+     * Starting from server version 7, command supports multiple section arguments.
+     *
      * @see {@link https://valkey.io/commands/info/|valkey.io} for details.
      *
      * @param sections - (Optional) A list of {@link InfoOptions} values specifying which sections of information to retrieve.
      *     When no parameter is provided, {@link InfoOptions.Default|Default} is assumed.
      * @returns A string containing the information for the sections requested.
+     *
+     * @example
+     * ```typescript
+     * // Example usage of the info method with retrieving total_net_input_bytes from the result
+     * const result = await client.info(new Section[] { Section.STATS });
+     * console.log(someParsingFunction(result, "total_net_input_bytes")); // Output: 1
+     * ```
      */
     info(sections?: InfoOptions[]): Promise<string>;
     /**