@valkey/valkey-glide-darwin-arm64 1.2.0-rc10 → 1.2.0-rc2

package/build-ts/index.d.ts

@@ -9,6 +9,4 @@ export * from "./src/GlideClient";
 export * from "./src/GlideClusterClient";
 export * from "./src/Logger";
 export * from "./src/server-modules/GlideJson";
-export * from "./src/server-modules/GlideFt";
-export * from "./src/server-modules/GlideFtOptions";
 export * from "./src/Transaction";

package/build-ts/index.js

@@ -28,7 +28,5 @@ __exportStar(require("./src/GlideClient"), exports);
 __exportStar(require("./src/GlideClusterClient"), exports);
 __exportStar(require("./src/Logger"), exports);
 __exportStar(require("./src/server-modules/GlideJson"), exports);
-__exportStar(require("./src/server-modules/GlideFt"), exports);
-__exportStar(require("./src/server-modules/GlideFtOptions"), exports);
 __exportStar(require("./src/Transaction"), exports);
 //# sourceMappingURL=index.js.map

package/build-ts/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;AAEH,qCAAqD;AAA5C,6GAAA,iBAAiB,OAAA;AAAE,kGAAA,MAAM,OAAA;AAClC,mDAAiC;AACjC,iDAA+B;AAC/B,+CAA6B;AAC7B,oDAAkC;AAClC,2DAAyC;AACzC,+CAA6B;AAC7B,iEAA+C;AAC/C,+DAA6C;AAC7C,sEAAoD;AACpD,oDAAkC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;AAEH,qCAAqD;AAA5C,6GAAA,iBAAiB,OAAA;AAAE,kGAAA,MAAM,OAAA;AAClC,mDAAiC;AACjC,iDAA+B;AAC/B,+CAA6B;AAC7B,oDAAkC;AAClC,2DAAyC;AACzC,+CAA6B;AAC7B,iEAA+C;AAC/C,oDAAkC"}

package/build-ts/src/BaseClient.d.ts

@@ -112,10 +112,7 @@ export type ReadFrom =
 "primary"
 /** Spread the requests between all replicas in a round robin manner.
     If no replica is available, route the requests to the primary.*/
- | "preferReplica"
-/** Spread the requests between replicas in the same client's Aviliablity zone in a round robin manner.
-    If no replica is available, route the requests to the primary.*/
- | "AZAffinity";
+ | "preferReplica";
 /**
  * Configuration settings for creating a client. Shared settings for standalone and cluster clients.
  */
@@ -187,18 +184,6 @@ export interface BaseClientConfiguration {
      * used.
      */
     inflightRequestsLimit?: number;
-    /**
-     * Availability Zone of the client.
-     * If ReadFrom strategy is AZAffinity, this setting ensures that readonly commands are directed to replicas within the specified AZ if exits.
-     *
-     * @example
-     * ```typescript
-     * // Example configuration for setting client availability zone and read strategy
-     * configuration.clientAz = 'us-east-1a'; // Sets the client's availability zone
-     * configuration.readFrom = 'AZAffinity'; // Directs read operations to nodes within the same AZ
-     * ```
-     */
-    clientAz?: string;
 }
 /**
  * Enum of Valkey data types
@@ -238,7 +223,6 @@ export declare class BaseClient {
     private readonly pubsubFutures;
     private pendingPushNotification;
     private readonly inflightRequestsLimit;
-    private readonly clientAz;
     private config;
     protected configurePubsub(options: GlideClusterClientConfiguration | GlideClientConfiguration, configuration: connection_request.IConnectionRequest): void;
     private handleReadData;
@@ -246,7 +230,7 @@ export declare class BaseClient {
     processPush(response: response.Response): void;
     protected getCallbackIndex(): number;
     private writeBufferedRequestsToSocket;
-    protected writeOrBufferCommandRequest(callbackIdx: number, command: command_request.Command | command_request.Command[] | command_request.ScriptInvocation | command_request.ClusterScan | command_request.UpdateConnectionPassword, route?: command_request.Routes): void;
+    protected writeOrBufferCommandRequest(callbackIdx: number, command: command_request.Command | command_request.Command[] | command_request.ScriptInvocation | command_request.ClusterScan, route?: command_request.Routes): void;
     private writeOrBufferRequest;
     cancelPubSubFuturesWithExceptionSafe(exception: ConnectionError): void;
     isPubsubConfigured(config: GlideClientConfiguration | GlideClusterClientConfiguration): boolean;
@@ -383,14 +367,6 @@ export declare class BaseClient {
      *
      * @see {@link https://valkey.io/commands/del/|valkey.io} for details.
      *
-     * @remarks In cluster mode, if keys in `keys` map to different hash slots,
-     * the command will be split across these slots and executed separately for each.
-     * This means the command is atomic only at the slot level. If one or more slot-specific
-     * requests fail, the entire call will return the first encountered error, even
-     * though some requests may have succeeded while others did not.
-     * If this behavior impacts your application logic, consider splitting the
-     * request into sub-requests per slot to ensure atomicity.
-     *
      * @param keys - The keys we wanted to remove.
      * @returns The number of keys that were removed.
      *
@@ -472,14 +448,7 @@ export declare class BaseClient {
     /** Retrieve the values of multiple keys.
      *
      * @see {@link https://valkey.io/commands/mget/|valkey.io} for details.
-     *
-     * @remarks In cluster mode, if keys in `keys` map to different hash slots,
-     * the command will be split across these slots and executed separately for each.
-     * This means the command is atomic only at the slot level. If one or more slot-specific
-     * requests fail, the entire call will return the first encountered error, even
-     * though some requests may have succeeded while others did not.
-     * If this behavior impacts your application logic, consider splitting the
-     * request into sub-requests per slot to ensure atomicity.
+     * @remarks When in cluster mode, the command may route to multiple nodes when `keys` map to different hash slots.
      *
      * @param keys - A list of keys to retrieve values for.
      * @param options - (Optional) See {@link DecoderOption}.
@@ -499,18 +468,10 @@ export declare class BaseClient {
     /** Set multiple keys to multiple values in a single operation.
      *
      * @see {@link https://valkey.io/commands/mset/|valkey.io} for details.
-     *
-     * @remarks In cluster mode, if keys in `keyValueMap` map to different hash slots,
-     * the command will be split across these slots and executed separately for each.
-     * This means the command is atomic only at the slot level. If one or more slot-specific
-     * requests fail, the entire call will return the first encountered error, even
-     * though some requests may have succeeded while others did not.
-     * If this behavior impacts your application logic, consider splitting the
-     * request into sub-requests per slot to ensure atomicity.
+     * @remarks When in cluster mode, the command may route to multiple nodes when keys in `keyValueMap` map to different hash slots.
      *
      * @param keysAndValues - A list of key-value pairs to set.
-     *
-     * @returns A simple "OK" response.
+     * @returns always "OK".
      *
      * @example
      * ```typescript
@@ -1091,7 +1052,7 @@ export declare class BaseClient {
      *
      * @param key - The key of the set.
      * @param cursor - The cursor that points to the next iteration of results. A value of `"0"` indicates the start of the search.
-     * @param options - (Optional) See {@link HScanOptions} and {@link DecoderOption}.
+     * @param options - (Optional) The {@link HScanOptions}.
      * @returns An array of the `cursor` and the subset of the hash held by `key`.
      * The first element is always the `cursor` for the next iteration of results. `"0"` will be the `cursor`
      * returned on the last iteration of the hash. The second element is always an array of the subset of the
@@ -1968,14 +1929,6 @@ export declare class BaseClient {
     /**
      * Returns the number of keys in `keys` that exist in the database.
      *
-     * @remarks In cluster mode, if keys in `keys` map to different hash slots,
-     * the command will be split across these slots and executed separately for each.
-     * This means the command is atomic only at the slot level. If one or more slot-specific
-     * requests fail, the entire call will return the first encountered error, even
-     * though some requests may have succeeded while others did not.
-     * If this behavior impacts your application logic, consider splitting the
-     * request into sub-requests per slot to ensure atomicity.
-     *
      * @see {@link https://valkey.io/commands/exists/|valkey.io} for details.
      *
      * @param keys - The keys list to check.
@@ -1995,14 +1948,6 @@ export declare class BaseClient {
      * This command, similar to {@link del}, removes specified keys and ignores non-existent ones.
      * However, this command does not block the server, while {@link https://valkey.io/commands/del|`DEL`} does.
      *
-     * @remarks In cluster mode, if keys in `keys` map to different hash slots,
-     * the command will be split across these slots and executed separately for each.
-     * This means the command is atomic only at the slot level. If one or more slot-specific
-     * requests fail, the entire call will return the first encountered error, even
-     * though some requests may have succeeded while others did not.
-     * If this behavior impacts your application logic, consider splitting the
-     * request into sub-requests per slot to ensure atomicity.
-     *
      * @see {@link https://valkey.io/commands/unlink/|valkey.io} for details.
      *
      * @param keys - The keys we wanted to unlink.
@@ -3620,6 +3565,7 @@ export declare class BaseClient {
      *     attributes of a consumer group for the stream at `key`.
      * @example
      * ```typescript
+     *     <pre>{@code
      * const result = await client.xinfoGroups("my_stream");
      * console.log(result); // Output:
      * // [
@@ -3931,11 +3877,13 @@ export declare class BaseClient {
      *
      * @example
      * ```typescript
+     *  <pre>{@code
      * const entryId = await client.xadd("mystream", ["myfield", "mydata"]);
      * // read messages from streamId
      * const readResult = await client.xreadgroup(["myfield", "mydata"], "mygroup", "my0consumer");
      * // acknowledge messages on stream
      * console.log(await client.xack("mystream", "mygroup", [entryId])); // Output: 1
+     * </pre>
      * ```
      */
     xack(key: GlideString, group: GlideString, ids: string[]): Promise<number>;
@@ -4798,14 +4746,7 @@ export declare class BaseClient {
      * Updates the last access time of the specified keys.
      *
      * @see {@link https://valkey.io/commands/touch/|valkey.io} for more details.
-     *
-     * @remarks In cluster mode, if keys in `keys` map to different hash slots,
-     * the command will be split across these slots and executed separately for each.
-     * This means the command is atomic only at the slot level. If one or more slot-specific
-     * requests fail, the entire call will return the first encountered error, even
-     * though some requests may have succeeded while others did not.
-     * If this behavior impacts your application logic, consider splitting the
-     * request into sub-requests per slot to ensure atomicity.
+     * @remarks When in cluster mode, the command may route to multiple nodes when `keys` map to different hash slots.
      *
      * @param keys - The keys to update the last access time of.
      * @returns The number of keys that were updated. A key is ignored if it doesn't exist.
@@ -4825,14 +4766,7 @@ export declare class BaseClient {
      * transaction. Executing a transaction will automatically flush all previously watched keys.
      *
      * @see {@link https://valkey.io/commands/watch/|valkey.io} and {@link https://valkey.io/topics/transactions/#cas|Valkey Glide Wiki} for more details.
-     *
-     * @remarks In cluster mode, if keys in `keys` map to different hash slots,
-     * the command will be split across these slots and executed separately for each.
-     * This means the command is atomic only at the slot level. If one or more slot-specific
-     * requests fail, the entire call will return the first encountered error, even
-     * though some requests may have succeeded while others did not.
-     * If this behavior impacts your application logic, consider splitting the
-     * request into sub-requests per slot to ensure atomicity.
+     * @remarks When in cluster mode, the command may route to multiple nodes when `keys` map to different hash slots.
      *
      * @param keys - The keys to watch.
      * @returns A simple `"OK"` response.
@@ -5134,25 +5068,5 @@ export declare class BaseClient {
      * @param errorMessage - If defined, this error message will be passed along with the exceptions when closing all open promises.
      */
     close(errorMessage?: string): void;
-    /**
-     * Update the current connection with a new password.
-     *
-     * This method is useful in scenarios where the server password has changed or when utilizing short-lived passwords for enhanced security.
-     * It allows the client to update its password to reconnect upon disconnection without the need to recreate the client instance.
-     * This ensures that the internal reconnection mechanism can handle reconnection seamlessly, preventing the loss of in-flight commands.
-     *
-     * This method updates the client's internal password configuration and does not perform password rotation on the server side.
-     *
-     * @param password - `String | null`. The new password to update the current password, or `null` to remove the current password.
-     * @param immidiateAuth - A `boolean` flag. If `true`, the client will authenticate immediately with the new password against all connections, Using `AUTH` command.
-     *                 If password supplied is an empty string, the client will not perform auth and instead a warning will be returned.
-     *                 The default is `false`.
-     *
-     * @example
-     * ```typescript
-     * await client.updateConnectionPassword("newPassword", true) // "OK"
-     * ```
-     */
-    updateConnectionPassword(password: string | null, immediateAuth?: boolean): Promise<GlideString>;
 }
 export {};

package/build-ts/src/BaseClient.js

@@ -381,7 +381,6 @@ class BaseClient {
         this.MAP_READ_FROM_STRATEGY = {
             primary: ProtobufMessage_1.connection_request.ReadFrom.Primary,
             preferReplica: ProtobufMessage_1.connection_request.ReadFrom.PreferReplica,
-            AZAffinity: ProtobufMessage_1.connection_request.ReadFrom.AZAffinity,
         };
         // if logger has been initialized by the external-user on info level this log will be shown
         Logger_1.Logger.log("info", "Client lifetime", `construct client`);
@@ -477,15 +476,10 @@ class BaseClient {
                         callbackIdx,
                         clusterScan: command,
                     })
-                    : command instanceof ProtobufMessage_1.command_request.UpdateConnectionPassword
-                        ? ProtobufMessage_1.command_request.CommandRequest.create({
-                            callbackIdx,
-                            updateConnectionPassword: command,
-                        })
-                        : ProtobufMessage_1.command_request.CommandRequest.create({
-                            callbackIdx,
-                            scriptInvocation: command,
-                        });
+                    : ProtobufMessage_1.command_request.CommandRequest.create({
+                        callbackIdx,
+                        scriptInvocation: command,
+                    });
         message.route = route;
         this.writeOrBufferRequest(message, (message, writer) => {
             ProtobufMessage_1.command_request.CommandRequest.encodeDelimited(message, writer);
@@ -770,14 +764,6 @@ class BaseClient {
      *
      * @see {@link https://valkey.io/commands/del/|valkey.io} for details.
      *
-     * @remarks In cluster mode, if keys in `keys` map to different hash slots,
-     * the command will be split across these slots and executed separately for each.
-     * This means the command is atomic only at the slot level. If one or more slot-specific
-     * requests fail, the entire call will return the first encountered error, even
-     * though some requests may have succeeded while others did not.
-     * If this behavior impacts your application logic, consider splitting the
-     * request into sub-requests per slot to ensure atomicity.
-     *
      * @param keys - The keys we wanted to remove.
      * @returns The number of keys that were removed.
      *
@@ -873,14 +859,7 @@ class BaseClient {
     /** Retrieve the values of multiple keys.
      *
      * @see {@link https://valkey.io/commands/mget/|valkey.io} for details.
-     *
-     * @remarks In cluster mode, if keys in `keys` map to different hash slots,
-     * the command will be split across these slots and executed separately for each.
-     * This means the command is atomic only at the slot level. If one or more slot-specific
-     * requests fail, the entire call will return the first encountered error, even
-     * though some requests may have succeeded while others did not.
-     * If this behavior impacts your application logic, consider splitting the
-     * request into sub-requests per slot to ensure atomicity.
+     * @remarks When in cluster mode, the command may route to multiple nodes when `keys` map to different hash slots.
      *
      * @param keys - A list of keys to retrieve values for.
      * @param options - (Optional) See {@link DecoderOption}.
@@ -904,18 +883,10 @@ class BaseClient {
     /** Set multiple keys to multiple values in a single operation.
      *
      * @see {@link https://valkey.io/commands/mset/|valkey.io} for details.
-     *
-     * @remarks In cluster mode, if keys in `keyValueMap` map to different hash slots,
-     * the command will be split across these slots and executed separately for each.
-     * This means the command is atomic only at the slot level. If one or more slot-specific
-     * requests fail, the entire call will return the first encountered error, even
-     * though some requests may have succeeded while others did not.
-     * If this behavior impacts your application logic, consider splitting the
-     * request into sub-requests per slot to ensure atomicity.
+     * @remarks When in cluster mode, the command may route to multiple nodes when keys in `keyValueMap` map to different hash slots.
      *
      * @param keysAndValues - A list of key-value pairs to set.
-     *
-     * @returns A simple "OK" response.
+     * @returns always "OK".
      *
      * @example
      * ```typescript
@@ -1610,7 +1581,7 @@ class BaseClient {
      *
      * @param key - The key of the set.
      * @param cursor - The cursor that points to the next iteration of results. A value of `"0"` indicates the start of the search.
-     * @param options - (Optional) See {@link HScanOptions} and {@link DecoderOption}.
+     * @param options - (Optional) The {@link HScanOptions}.
      * @returns An array of the `cursor` and the subset of the hash held by `key`.
      * The first element is always the `cursor` for the next iteration of results. `"0"` will be the `cursor`
      * returned on the last iteration of the hash. The second element is always an array of the subset of the
@@ -2637,14 +2608,6 @@ class BaseClient {
     /**
      * Returns the number of keys in `keys` that exist in the database.
      *
-     * @remarks In cluster mode, if keys in `keys` map to different hash slots,
-     * the command will be split across these slots and executed separately for each.
-     * This means the command is atomic only at the slot level. If one or more slot-specific
-     * requests fail, the entire call will return the first encountered error, even
-     * though some requests may have succeeded while others did not.
-     * If this behavior impacts your application logic, consider splitting the
-     * request into sub-requests per slot to ensure atomicity.
-     *
      * @see {@link https://valkey.io/commands/exists/|valkey.io} for details.
      *
      * @param keys - The keys list to check.
@@ -2668,14 +2631,6 @@ class BaseClient {
      * This command, similar to {@link del}, removes specified keys and ignores non-existent ones.
      * However, this command does not block the server, while {@link https://valkey.io/commands/del|`DEL`} does.
      *
-     * @remarks In cluster mode, if keys in `keys` map to different hash slots,
-     * the command will be split across these slots and executed separately for each.
-     * This means the command is atomic only at the slot level. If one or more slot-specific
-     * requests fail, the entire call will return the first encountered error, even
-     * though some requests may have succeeded while others did not.
-     * If this behavior impacts your application logic, consider splitting the
-     * request into sub-requests per slot to ensure atomicity.
-     *
      * @see {@link https://valkey.io/commands/unlink/|valkey.io} for details.
      *
      * @param keys - The keys we wanted to unlink.
@@ -4520,6 +4475,7 @@ class BaseClient {
      *     attributes of a consumer group for the stream at `key`.
      * @example
      * ```typescript
+     *     <pre>{@code
      * const result = await client.xinfoGroups("my_stream");
      * console.log(result); // Output:
      * // [
@@ -4867,11 +4823,13 @@ class BaseClient {
      *
      * @example
      * ```typescript
+     *  <pre>{@code
      * const entryId = await client.xadd("mystream", ["myfield", "mydata"]);
      * // read messages from streamId
      * const readResult = await client.xreadgroup(["myfield", "mydata"], "mygroup", "my0consumer");
      * // acknowledge messages on stream
      * console.log(await client.xack("mystream", "mygroup", [entryId])); // Output: 1
+     * </pre>
      * ```
      */
     xack(key, group, ids) {
@@ -5867,14 +5825,7 @@ class BaseClient {
      * Updates the last access time of the specified keys.
      *
      * @see {@link https://valkey.io/commands/touch/|valkey.io} for more details.
-     *
-     * @remarks In cluster mode, if keys in `keys` map to different hash slots,
-     * the command will be split across these slots and executed separately for each.
-     * This means the command is atomic only at the slot level. If one or more slot-specific
-     * requests fail, the entire call will return the first encountered error, even
-     * though some requests may have succeeded while others did not.
-     * If this behavior impacts your application logic, consider splitting the
-     * request into sub-requests per slot to ensure atomicity.
+     * @remarks When in cluster mode, the command may route to multiple nodes when `keys` map to different hash slots.
      *
      * @param keys - The keys to update the last access time of.
      * @returns The number of keys that were updated. A key is ignored if it doesn't exist.
@@ -5898,14 +5849,7 @@ class BaseClient {
      * transaction. Executing a transaction will automatically flush all previously watched keys.
      *
      * @see {@link https://valkey.io/commands/watch/|valkey.io} and {@link https://valkey.io/topics/transactions/#cas|Valkey Glide Wiki} for more details.
-     *
-     * @remarks In cluster mode, if keys in `keys` map to different hash slots,
-     * the command will be split across these slots and executed separately for each.
-     * This means the command is atomic only at the slot level. If one or more slot-specific
-     * requests fail, the entire call will return the first encountered error, even
-     * though some requests may have succeeded while others did not.
-     * If this behavior impacts your application logic, consider splitting the
-     * request into sub-requests per slot to ensure atomicity.
+     * @remarks When in cluster mode, the command may route to multiple nodes when `keys` map to different hash slots.
      *
      * @param keys - The keys to watch.
      * @returns A simple `"OK"` response.
@@ -6250,7 +6194,6 @@ class BaseClient {
      * @internal
      */
     createClientRequest(options) {
-        var _a;
         const readFrom = options.readFrom
             ? this.MAP_READ_FROM_STRATEGY[options.readFrom]
             : ProtobufMessage_1.connection_request.ReadFrom.Primary;
@@ -6274,7 +6217,6 @@ class BaseClient {
             readFrom,
             authenticationInfo,
             inflightRequestsLimit: options.inflightRequestsLimit,
-            clientAz: (_a = options.clientAz) !== null && _a !== void 0 ? _a : null,
         };
     }
     /**
@@ -6346,39 +6288,6 @@ class BaseClient {
             }
         });
     }
-    /**
-     * Update the current connection with a new password.
-     *
-     * This method is useful in scenarios where the server password has changed or when utilizing short-lived passwords for enhanced security.
-     * It allows the client to update its password to reconnect upon disconnection without the need to recreate the client instance.
-     * This ensures that the internal reconnection mechanism can handle reconnection seamlessly, preventing the loss of in-flight commands.
-     *
-     * This method updates the client's internal password configuration and does not perform password rotation on the server side.
-     *
-     * @param password - `String | null`. The new password to update the current password, or `null` to remove the current password.
-     * @param immidiateAuth - A `boolean` flag. If `true`, the client will authenticate immediately with the new password against all connections, Using `AUTH` command.
-     *                 If password supplied is an empty string, the client will not perform auth and instead a warning will be returned.
-     *                 The default is `false`.
-     *
-     * @example
-     * ```typescript
-     * await client.updateConnectionPassword("newPassword", true) // "OK"
-     * ```
-     */
-    updateConnectionPassword(password_1) {
-        return __awaiter(this, arguments, void 0, function* (password, immediateAuth = false) {
-            var _a;
-            const updateConnectionPassword = ProtobufMessage_1.command_request.UpdateConnectionPassword.create({
-                password,
-                immediateAuth,
-            });
-            const response = yield this.createWritePromise(updateConnectionPassword);
-            if (response === "OK" && !((_a = this.config) === null || _a === void 0 ? void 0 : _a.credentials)) {
-                this.config = Object.assign(Object.assign({}, this.config), { credentials: Object.assign(Object.assign({}, this.config.credentials), { password: password ? password : "" }) });
-            }
-            return response;
-        });
-    }
 }
 exports.BaseClient = BaseClient;
 //# sourceMappingURL=BaseClient.js.map