@valkey/valkey-glide-darwin-arm64 1.2.1 → 1.3.0-rc2

package/build-ts/src/BaseClient.js

@@ -191,77 +191,6 @@ function getRequestErrorClass(type) {
     }
     return Errors_1.RequestError;
 }
-/**
- * @internal
- */
-function toProtobufRoute(route) {
-    if (!route) {
-        return undefined;
-    }
-    if (route === "allPrimaries") {
-        return ProtobufMessage_1.command_request.Routes.create({
-            simpleRoutes: ProtobufMessage_1.command_request.SimpleRoutes.AllPrimaries,
-        });
-    }
-    else if (route === "allNodes") {
-        return ProtobufMessage_1.command_request.Routes.create({
-            simpleRoutes: ProtobufMessage_1.command_request.SimpleRoutes.AllNodes,
-        });
-    }
-    else if (route === "randomNode") {
-        return ProtobufMessage_1.command_request.Routes.create({
-            simpleRoutes: ProtobufMessage_1.command_request.SimpleRoutes.Random,
-        });
-    }
-    else if (route.type === "primarySlotKey") {
-        return ProtobufMessage_1.command_request.Routes.create({
-            slotKeyRoute: ProtobufMessage_1.command_request.SlotKeyRoute.create({
-                slotType: ProtobufMessage_1.command_request.SlotTypes.Primary,
-                slotKey: route.key,
-            }),
-        });
-    }
-    else if (route.type === "replicaSlotKey") {
-        return ProtobufMessage_1.command_request.Routes.create({
-            slotKeyRoute: ProtobufMessage_1.command_request.SlotKeyRoute.create({
-                slotType: ProtobufMessage_1.command_request.SlotTypes.Replica,
-                slotKey: route.key,
-            }),
-        });
-    }
-    else if (route.type === "primarySlotId") {
-        return ProtobufMessage_1.command_request.Routes.create({
-            slotKeyRoute: ProtobufMessage_1.command_request.SlotIdRoute.create({
-                slotType: ProtobufMessage_1.command_request.SlotTypes.Primary,
-                slotId: route.id,
-            }),
-        });
-    }
-    else if (route.type === "replicaSlotId") {
-        return ProtobufMessage_1.command_request.Routes.create({
-            slotKeyRoute: ProtobufMessage_1.command_request.SlotIdRoute.create({
-                slotType: ProtobufMessage_1.command_request.SlotTypes.Replica,
-                slotId: route.id,
-            }),
-        });
-    }
-    else if (route.type === "routeByAddress") {
-        let port = route.port;
-        let host = route.host;
-        if (port === undefined) {
-            const split = host.split(":");
-            if (split.length !== 2) {
-                throw new Errors_1.RequestError("No port provided, expected host to be formatted as `{hostname}:{port}`. Received " +
-                    host);
-            }
-            host = split[0];
-            port = Number(split[1]);
-        }
-        return ProtobufMessage_1.command_request.Routes.create({
-            byAddressRoute: { host, port },
-        });
-    }
-}
 class BaseClient {
     configurePubsub(options, configuration) {
         if (options.pubsubSubscriptions) {
@@ -324,13 +253,81 @@ class BaseClient {
         }
         this.remainingReadData = undefined;
     }
+    toProtobufRoute(route) {
+        if (!route) {
+            return undefined;
+        }
+        if (route === "allPrimaries") {
+            return ProtobufMessage_1.command_request.Routes.create({
+                simpleRoutes: ProtobufMessage_1.command_request.SimpleRoutes.AllPrimaries,
+            });
+        }
+        else if (route === "allNodes") {
+            return ProtobufMessage_1.command_request.Routes.create({
+                simpleRoutes: ProtobufMessage_1.command_request.SimpleRoutes.AllNodes,
+            });
+        }
+        else if (route === "randomNode") {
+            return ProtobufMessage_1.command_request.Routes.create({
+                simpleRoutes: ProtobufMessage_1.command_request.SimpleRoutes.Random,
+            });
+        }
+        else if (route.type === "primarySlotKey") {
+            return ProtobufMessage_1.command_request.Routes.create({
+                slotKeyRoute: ProtobufMessage_1.command_request.SlotKeyRoute.create({
+                    slotType: ProtobufMessage_1.command_request.SlotTypes.Primary,
+                    slotKey: route.key,
+                }),
+            });
+        }
+        else if (route.type === "replicaSlotKey") {
+            return ProtobufMessage_1.command_request.Routes.create({
+                slotKeyRoute: ProtobufMessage_1.command_request.SlotKeyRoute.create({
+                    slotType: ProtobufMessage_1.command_request.SlotTypes.Replica,
+                    slotKey: route.key,
+                }),
+            });
+        }
+        else if (route.type === "primarySlotId") {
+            return ProtobufMessage_1.command_request.Routes.create({
+                slotKeyRoute: ProtobufMessage_1.command_request.SlotIdRoute.create({
+                    slotType: ProtobufMessage_1.command_request.SlotTypes.Primary,
+                    slotId: route.id,
+                }),
+            });
+        }
+        else if (route.type === "replicaSlotId") {
+            return ProtobufMessage_1.command_request.Routes.create({
+                slotKeyRoute: ProtobufMessage_1.command_request.SlotIdRoute.create({
+                    slotType: ProtobufMessage_1.command_request.SlotTypes.Replica,
+                    slotId: route.id,
+                }),
+            });
+        }
+        else if (route.type === "routeByAddress") {
+            let port = route.port;
+            let host = route.host;
+            if (port === undefined) {
+                const split = host.split(":");
+                if (split.length !== 2) {
+                    throw new Errors_1.RequestError("No port provided, expected host to be formatted as `{hostname}:{port}`. Received " +
+                        host);
+                }
+                host = split[0];
+                port = Number(split[1]);
+            }
+            return ProtobufMessage_1.command_request.Routes.create({
+                byAddressRoute: { host, port },
+            });
+        }
+    }
     processResponse(message) {
         var _a;
         if (message.closingError != null) {
             this.close(message.closingError);
             return;
         }
-        const [resolve, reject] = this.promiseCallbackFunctions[message.callbackIdx];
+        const [resolve, reject, decoder = this.defaultDecoder] = this.promiseCallbackFunctions[message.callbackIdx];
         this.availableCallbackSlots.push(message.callbackIdx);
         if (message.requestError != null) {
             const errorType = getRequestErrorClass(message.requestError.type);
@@ -346,7 +343,15 @@ class BaseClient {
                 // Response from type long
                 pointer = new PointerResponse(message.respPointer, message.respPointer.high, message.respPointer.low);
             }
-            resolve(pointer);
+            try {
+                resolve((0, glide_rs_1.valueFromSplitPointer)(pointer.high, pointer.low, decoder === Decoder.String));
+            }
+            catch (err) {
+                Logger_1.Logger.log("error", "Decoder", `Decoding error: '${err}'`);
+                reject(err instanceof Errors_1.ValkeyError
+                    ? err
+                    : new Error(`Decoding error: '${err}'`));
+            }
         }
         else if (message.constantResponse === ProtobufMessage_1.response.ConstantResponse.OK) {
             resolve("OK");
@@ -392,6 +397,7 @@ class BaseClient {
             primary: ProtobufMessage_1.connection_request.ReadFrom.Primary,
             preferReplica: ProtobufMessage_1.connection_request.ReadFrom.PreferReplica,
             AZAffinity: ProtobufMessage_1.connection_request.ReadFrom.AZAffinity,
+            AZAffinityReplicasAndPrimary: ProtobufMessage_1.connection_request.ReadFrom.AZAffinityReplicasAndPrimary,
         };
         // 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`);
@@ -426,49 +432,57 @@ class BaseClient {
             }
         });
     }
+    ensureClientIsOpen() {
+        if (this.isClosed) {
+            throw new Errors_1.ClosingError("Unable to execute requests; the client is closed. Please create a new client.");
+        }
+    }
     /**
      * @internal
      */
     createWritePromise(command, options = {}) {
-        var _a;
-        const route = toProtobufRoute(options === null || options === void 0 ? void 0 : options.route);
-        const stringDecoder = ((_a = options === null || options === void 0 ? void 0 : options.decoder) !== null && _a !== void 0 ? _a : this.defaultDecoder) === Decoder.String;
-        if (this.isClosed) {
-            throw new Errors_1.ClosingError("Unable to execute requests; the client is closed. Please create a new client.");
-        }
+        this.ensureClientIsOpen();
+        const route = this.toProtobufRoute(options === null || options === void 0 ? void 0 : options.route);
         return new Promise((resolve, reject) => {
             const callbackIndex = this.getCallbackIndex();
             this.promiseCallbackFunctions[callbackIndex] = [
-                (resolveAns) => {
-                    try {
-                        if (resolveAns instanceof PointerResponse) {
-                            //   valueFromSplitPointer method is used to convert a pointer from a protobuf response into a TypeScript object.
-                            //   The protobuf response is received on a socket and the value in the response is a pointer to a Rust object.
-                            //   The pointer is a split pointer because JavaScript doesn't support `u64` and pointers in Rust can be `u64`,
-                            //   so we represent it with two`u32`(`high` and`low`).
-                            if (typeof resolveAns === "number") {
-                                resolveAns = (0, glide_rs_1.valueFromSplitPointer)(0, resolveAns, stringDecoder);
-                            }
-                            else {
-                                resolveAns = (0, glide_rs_1.valueFromSplitPointer)(resolveAns.high, resolveAns.low, stringDecoder);
-                            }
-                        }
-                        if (command instanceof ProtobufMessage_1.command_request.ClusterScan) {
-                            const resolveAnsArray = resolveAns;
-                            resolveAnsArray[0] = new glide_rs_1.ClusterScanCursor(resolveAnsArray[0].toString());
-                        }
-                        resolve(resolveAns);
-                    }
-                    catch (err) {
-                        Logger_1.Logger.log("error", "Decoder", `Decoding error: '${err}'`);
-                        reject(err);
-                    }
-                },
+                resolve,
                 reject,
+                options === null || options === void 0 ? void 0 : options.decoder,
             ];
             this.writeOrBufferCommandRequest(callbackIndex, command, route);
         });
     }
+    createUpdateConnectionPasswordPromise(command) {
+        this.ensureClientIsOpen();
+        return new Promise((resolve, reject) => {
+            const callbackIdx = this.getCallbackIndex();
+            this.promiseCallbackFunctions[callbackIdx] = [resolve, reject];
+            this.writeOrBufferRequest(new ProtobufMessage_1.command_request.CommandRequest({
+                callbackIdx,
+                updateConnectionPassword: command,
+            }), (message, writer) => {
+                ProtobufMessage_1.command_request.CommandRequest.encodeDelimited(message, writer);
+            });
+        });
+    }
+    createScriptInvocationPromise(command, options = {}) {
+        this.ensureClientIsOpen();
+        return new Promise((resolve, reject) => {
+            const callbackIdx = this.getCallbackIndex();
+            this.promiseCallbackFunctions[callbackIdx] = [
+                resolve,
+                reject,
+                options === null || options === void 0 ? void 0 : options.decoder,
+            ];
+            this.writeOrBufferRequest(new ProtobufMessage_1.command_request.CommandRequest({
+                callbackIdx,
+                scriptInvocation: command,
+            }), (message, writer) => {
+                ProtobufMessage_1.command_request.CommandRequest.encodeDelimited(message, writer);
+            });
+        });
+    }
     writeOrBufferCommandRequest(callbackIdx, command, route) {
         const message = Array.isArray(command)
             ? ProtobufMessage_1.command_request.CommandRequest.create({
@@ -476,27 +490,13 @@ class BaseClient {
                 transaction: ProtobufMessage_1.command_request.Transaction.create({
                     commands: command,
                 }),
+                route,
             })
-            : command instanceof ProtobufMessage_1.command_request.Command
-                ? ProtobufMessage_1.command_request.CommandRequest.create({
-                    callbackIdx,
-                    singleCommand: command,
-                })
-                : command instanceof ProtobufMessage_1.command_request.ClusterScan
-                    ? ProtobufMessage_1.command_request.CommandRequest.create({
-                        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,
-                        });
-        message.route = route;
+            : ProtobufMessage_1.command_request.CommandRequest.create({
+                callbackIdx,
+                singleCommand: command,
+                route,
+            });
         this.writeOrBufferRequest(message, (message, writer) => {
             ProtobufMessage_1.command_request.CommandRequest.encodeDelimited(message, writer);
         });
@@ -748,7 +748,8 @@ class BaseClient {
      * @param value - The value to store with the given key.
      * @param options - (Optional) See {@link SetOptions} and {@link DecoderOption}.
      * @returns - If the value is successfully set, return OK.
-     * If value isn't set because of `onlyIfExists` or `onlyIfDoesNotExist` conditions, return null.
+     * If `conditional` in `options` is not set, the value will be set regardless of prior value existence.
+     * If value isn't set because of `onlyIfExists` or `onlyIfDoesNotExist` or `onlyIfEqual` conditions, return `null`.
      * If `returnOldValue` is set, return the old value as a string.
      *
      * @example
@@ -768,6 +769,13 @@ class BaseClient {
      * // Example usage of get method to retrieve the value of a key
      * const result4 = await client.get("key");
      * console.log(result4); // Output: 'new_value' - Value wasn't modified back to being "value" because of "NX" flag.
+     *
+     * // Example usage of set method with conditional option IFEQ
+     * await client.set("key", "value we will compare to");
+     * const result5 = await client.set("key", "new_value", {conditionalSet: "onlyIfEqual", comparisonValue: "value we will compare to"});
+     * console.log(result5); // Output: 'OK' - Set "new_value" to "key" only if comparisonValue is equal to the current value of "key".
+     * const result6 = await client.set("key", "another_new_value", {conditionalSet: "onlyIfEqual", comparisonValue: "value we will compare to"});
+     * console.log(result6); // Output: `null` - Value wasn't set because the comparisonValue is not equal to the current value of "key". Value of "key" remains "new_value".
      * ```
      */
     set(key, value, options) {
@@ -1155,11 +1163,12 @@ class BaseClient {
      * The offset can also be a negative number indicating an offset starting at the end of the list, with `-1` being
      * the last byte of the list, `-2` being the penultimate, and so on.
      *
-     * @see {@link https://valkey.io/commands/bitpos/|valkey.io} for more details.
+     * @see {@link https://valkey.io/commands/bitpos/|valkey.io} for details.
      *
      * @param key - The key of the string.
      * @param bit - The bit value to match. Must be `0` or `1`.
-     * @param start - (Optional) The starting offset. If not supplied, the search will start at the beginning of the string.
+     * @param options - (Optional) The {@link BitOffsetOptions}.
+     *
      * @returns The position of the first occurrence of `bit` in the binary value of the string held at `key`.
      *      If `start` was provided, the search begins at the offset indicated by `start`.
      *
@@ -1169,51 +1178,20 @@ class BaseClient {
      * const result1 = await client.bitpos("key1", 1);
      * console.log(result1); // Output: 1 - The first occurrence of bit value 1 in the string stored at "key1" is at the second position.
      *
-     * const result2 = await client.bitpos("key1", 1, -1);
+     * const result2 = await client.bitpos("key1", 1, { start: -1 });
      * console.log(result2); // Output: 10 - The first occurrence of bit value 1, starting at the last byte in the string stored at "key1", is at the eleventh position.
-     * ```
-     */
-    bitpos(key, bit, start) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.createWritePromise((0, Commands_1.createBitPos)(key, bit, start));
-        });
-    }
-    /**
-     * Returns the position of the first bit matching the given `bit` value. The offsets are zero-based indexes, with
-     * `0` being the first element of the list, `1` being the next, and so on. These offsets can also be negative
-     * numbers indicating offsets starting at the end of the list, with `-1` being the last element of the list, `-2`
-     * being the penultimate, and so on.
-     *
-     * If you are using Valkey 7.0.0 or above, the optional `indexType` can also be provided to specify whether the
-     * `start` and `end` offsets specify BIT or BYTE offsets. If `indexType` is not provided, BYTE offsets
-     * are assumed. If BIT is specified, `start=0` and `end=2` means to look at the first three bits. If BYTE is
-     * specified, `start=0` and `end=2` means to look at the first three bytes.
-     *
-     * @see {@link https://valkey.io/commands/bitpos/|valkey.io} for more details.
-     *
-     * @param key - The key of the string.
-     * @param bit - The bit value to match. Must be `0` or `1`.
-     * @param start - The starting offset.
-     * @param end - The ending offset.
-     * @param indexType - (Optional) The index offset type. This option can only be specified if you are using Valkey
-     *      version 7.0.0 or above. Could be either {@link BitmapIndexType.BYTE} or {@link BitmapIndexType.BIT}. If no
-     *      index type is provided, the indexes will be assumed to be byte indexes.
-     * @returns The position of the first occurrence from the `start` to the `end` offsets of the `bit` in the binary
-     *      value of the string held at `key`.
      *
-     * @example
-     * ```typescript
      * await client.set("key1", "A12");  // "A12" has binary value 01000001 00110001 00110010
-     * const result1 = await client.bitposInterval("key1", 1, 1, -1);
-     * console.log(result1); // Output: 10 - The first occurrence of bit value 1 in the second byte to the last byte of the string stored at "key1" is at the eleventh position.
+     * const result3 = await client.bitpos("key1", 1, { start: 1, end: -1 });
+     * console.log(result3); // Output: 10 - The first occurrence of bit value 1 in the second byte to the last byte of the string stored at "key1" is at the eleventh position.
      *
-     * const result2 = await client.bitposInterval("key1", 1, 2, 9, BitmapIndexType.BIT);
-     * console.log(result2); // Output: 7 - The first occurrence of bit value 1 in the third to tenth bits of the string stored at "key1" is at the eighth position.
+     * const result4 = await client.bitpos("key1", 1, { start: 2, end: 9, indexType: BitmapIndexType.BIT });
+     * console.log(result4); // Output: 7 - The first occurrence of bit value 1 in the third to tenth bits of the string stored at "key1" is at the eighth position.
      * ```
      */
-    bitposInterval(key, bit, start, end, indexType) {
+    bitpos(key, bit, options) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.createWritePromise((0, Commands_1.createBitPos)(key, bit, start, end, indexType));
+            return this.createWritePromise((0, Commands_1.createBitPos)(key, bit, options));
         });
     }
     /**
@@ -2944,7 +2922,7 @@ class BaseClient {
                 keys: (_a = options === null || options === void 0 ? void 0 : options.keys) === null || _a === void 0 ? void 0 : _a.map(Buffer.from),
                 args: (_b = options === null || options === void 0 ? void 0 : options.args) === null || _b === void 0 ? void 0 : _b.map(Buffer.from),
             });
-            return this.createWritePromise(scriptInvocation, options);
+            return this.createScriptInvocationPromise(scriptInvocation, options);
         });
     }
     /**
@@ -3468,7 +3446,6 @@ class BaseClient {
      * @param key - The key of the sorted set.
      * @param rangeQuery - The range query object representing the type of range query to perform.
      * - For range queries by index (rank), use {@link RangeByIndex}.
-     * - For range queries by lexicographical order, use {@link RangeByLex}.
      * - For range queries by score, use {@link RangeByScore}.
      * @param options - (Optional) Additional parameters:
      * - (Optional) `reverse`: if `true`, reverses the sorted set, with index `0` as the element with the highest score.
@@ -5329,7 +5306,7 @@ class BaseClient {
      * @see {@link https://valkey.io/commands/bitcount/|valkey.io} for more details.
      *
      * @param key - The key for the string to count the set bits of.
-     * @param options - The offset options.
+     * @param options - The offset options - see {@link BitOffsetOptions}.
      * @returns If `options` is provided, returns the number of set bits in the string interval specified by `options`.
      *     If `options` is not provided, returns the number of set bits in the string stored at `key`.
      *     Otherwise, if `key` is missing, returns `0` as it is treated as an empty string.
@@ -6300,7 +6277,11 @@ class BaseClient {
      */
     connectToServer(options) {
         return new Promise((resolve, reject) => {
-            this.promiseCallbackFunctions[0] = [resolve, reject];
+            this.promiseCallbackFunctions[0] = [
+                resolve,
+                reject,
+                options === null || options === void 0 ? void 0 : options.defaultDecoder,
+            ];
             const message = ProtobufMessage_1.connection_request.ConnectionRequest.create(this.createClientRequest(options));
             this.writeOrBufferRequest(message, (message, writer) => {
                 ProtobufMessage_1.connection_request.ConnectionRequest.encodeDelimited(message, writer);
@@ -6390,7 +6371,7 @@ class BaseClient {
                 password,
                 immediateAuth,
             });
-            const response = yield this.createWritePromise(updateConnectionPassword);
+            const response = yield this.createUpdateConnectionPasswordPromise(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 : "" }) });
             }