@valkey/valkey-glide 1.1.0-rc8 → 1.1.0

package/README.md

@@ -6,16 +6,20 @@ Valkey General Language Independent Driver for the Enterprise (GLIDE), is an ope
 
 Refer to the [Supported Engine Versions table](https://github.com/valkey-io/valkey-glide/blob/main/README.md#supported-engine-versions) for details.
 
-## Current Status
-
-We've made Valkey GLIDE an open-source project, and are releasing it in Preview to the community to gather feedback, and actively collaborate on the project roadmap. We welcome questions and contributions from all Redis stakeholders.
-This preview release is recommended for testing purposes only.
-
 # Getting Started - Node Wrapper
 
 ## System Requirements
 
-In this release, Valkey GLIDE is available for Python and Java. Support for Node.js is actively under development, with plans to include more programming languages in the future. We're tracking future features on the [roadmap](https://github.com/orgs/aws/projects/187/).
+The release of Valkey GLIDE was tested on the following platforms:
+
+Linux:
+
+-   Ubuntu 22.04.1 (x86_64)
+-   Amazon Linux 2023 (AL2023) (x86_64)
+
+macOS:
+
+-   macOS 12.7 (Apple silicon/aarch_64 and Intel/x86_64)
 
 ## NodeJS supported version
 
@@ -29,6 +33,63 @@ Visit our [wiki](https://github.com/valkey-io/valkey-glide/wiki/NodeJS-wrapper)
 
 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.
 
+## Basic Examples
+
+#### Standalone Mode:
+
+```typescript
+import { GlideClient, GlideClusterClient, Logger } from "@valkey/valkey-glide";
+// When Valkey is in standalone mode, add address of the primary node, and any replicas you'd like to be able to read from.
+const addresses = [
+    {
+        host: "localhost",
+        port: 6379,
+    },
+];
+// Check `GlideClientConfiguration/GlideClusterClientConfiguration` for additional options.
+const client = await GlideClient.createClient({
+    addresses: addresses,
+    // if the server uses TLS, you'll need to enable it. Otherwise, the connection attempt will time out silently.
+    // useTLS: true,
+    clientName: "test_standalone_client",
+});
+// The empty array signifies that there are no additional arguments.
+const pong = await client.customCommand(["PING"]);
+console.log(pong);
+const set_response = await client.set("foo", "bar");
+console.log(`Set response is = ${set_response}`);
+const get_response = await client.get("foo");
+console.log(`Get response is = ${get_response}`);
+```
+
+#### Cluster Mode:
+
+```typescript
+import { GlideClient, GlideClusterClient, Logger } from "@valkey/valkey-glide";
+// When Valkey is in cluster mode, add address of any nodes, and the client will find all nodes in the cluster.
+const addresses = [
+    {
+        host: "localhost",
+        port: 6379,
+    },
+];
+// Check `GlideClientConfiguration/GlideClusterClientConfiguration` for additional options.
+const client = await GlideClusterClient.createClient({
+    addresses: addresses,
+    // if the cluster nodes use TLS, you'll need to enable it. Otherwise the connection attempt will time out silently.
+    // useTLS: true,
+    clientName: "test_cluster_client",
+});
+// The empty array signifies that there are no additional arguments.
+const pong = await client.customCommand(["PING"], { route: "randomNode" });
+console.log(pong);
+const set_response = await client.set("foo", "bar");
+console.log(`Set response is = ${set_response}`);
+const get_response = await client.get("foo");
+console.log(`Get response is = ${get_response}`);
+client.close();
+```
+
 ### Supported platforms
 
 Currentlly the package is supported on:

package/build-ts/index.js

@@ -65,7 +65,7 @@ function loadNativeBinding() {
 }
 function initialize() {
     const nativeBinding = loadNativeBinding();
-    const { AggregationType, BaseScanOptions, ZScanOptions, HScanOptions, BitEncoding, BitFieldGet, BitFieldIncrBy, BitFieldOffset, BitFieldOverflow, BitFieldSet, BitFieldSubCommands, BitOffset, BitOffsetMultiplier, BitOffsetOptions, BitOverflowControl, BitmapIndexType, BitwiseOperation, ConditionalChange, Decoder, DecoderOption, GeoAddOptions, CoordOrigin, MemberOrigin, SearchOrigin, GeoBoxShape, GeoCircleShape, GeoSearchShape, GeoSearchResultOptions, GeoSearchStoreResultOptions, SortOrder, GeoUnit, GeospatialData, GlideClient, GlideClusterClient, GlideClientConfiguration, GlideRecord, GlideString, SortedSetDataType, StreamEntryDataType, HashDataType, FunctionListOptions, FunctionListResponse, FunctionStatsSingleResponse, FunctionStatsFullResponse, FunctionRestorePolicy, SlotIdTypes, SlotKeyTypes, TimeUnit, RouteByAddress, RouteOption, Routes, RestoreOptions, SingleNodeRoute, PeriodicChecksManualInterval, PeriodicChecks, Logger, Limit, LolwutOptions, LPosOptions, ListDirection, ExpireOptions, FlushMode, InfoOptions, InsertPosition, SetOptions, ZAddOptions, InfBoundary, KeyWeight, Boundary, UpdateOptions, ProtocolVersion, RangeByIndex, RangeByScore, RangeByLex, ReadFrom, ServerCredentials, SortClusterOptions, SortOptions, SortedSetRange, StreamGroupOptions, StreamTrimOptions, StreamAddOptions, StreamReadGroupOptions, StreamReadOptions, StreamClaimOptions, StreamPendingOptions, ClosingError, ConfigurationError, ExecAbortError, ValkeyError, GlideReturnType, StreamEntries, ReturnTypeXinfoStream, RequestError, TimeoutError, ConnectionError, ClusterTransaction, Transaction, PubSubMsg, ScoreFilter, SignedEncoding, UnsignedEncoding, UpdateByScore, createLeakedArray, createLeakedAttribute, createLeakedBigint, createLeakedDouble, createLeakedMap, createLeakedString, parseInfoResponse, } = nativeBinding;
+    const { AggregationType, BaseScanOptions, ZScanOptions, HScanOptions, BitEncoding, BitFieldGet, BitFieldIncrBy, BitFieldOffset, BitFieldOverflow, BitFieldSet, BitFieldSubCommands, BitOffset, BitOffsetMultiplier, BitOffsetOptions, BitOverflowControl, BitmapIndexType, BitwiseOperation, ConditionalChange, Decoder, DecoderOption, GeoAddOptions, CoordOrigin, MemberOrigin, SearchOrigin, GeoBoxShape, GeoCircleShape, GeoSearchShape, GeoSearchResultOptions, GeoSearchStoreResultOptions, SortOrder, GeoUnit, GeospatialData, GlideClient, GlideClusterClient, GlideClientConfiguration, GlideRecord, GlideString, SortedSetDataType, StreamEntryDataType, HashDataType, FunctionListOptions, FunctionListResponse, FunctionStatsSingleResponse, FunctionStatsFullResponse, FunctionRestorePolicy, SlotIdTypes, SlotKeyTypes, TimeUnit, RouteByAddress, RouteOption, Routes, RestoreOptions, SingleNodeRoute, PeriodicChecksManualInterval, PeriodicChecks, Logger, Limit, LolwutOptions, LPosOptions, ListDirection, ExpireOptions, FlushMode, InfoOptions, InsertPosition, SetOptions, ZAddOptions, InfBoundary, KeyWeight, Boundary, UpdateOptions, ProtocolVersion, RangeByIndex, RangeByScore, RangeByLex, ReadFrom, ServerCredentials, SortClusterOptions, SortOptions, SortedSetRange, StreamGroupOptions, StreamTrimOptions, StreamAddOptions, StreamReadGroupOptions, StreamReadOptions, StreamClaimOptions, StreamPendingOptions, ClosingError, ConfigurationError, ExecAbortError, ValkeyError, GlideReturnType, StreamEntries, ReturnTypeXinfoStream, RequestError, TimeoutError, ConnectionError, ClusterTransaction, Transaction, PubSubMsg, ScoreFilter, SignedEncoding, UnsignedEncoding, UpdateByScore, createLeakedArray, createLeakedAttribute, createLeakedBigint, createLeakedDouble, createLeakedMap, createLeakedString, parseInfoResponse, Script, ObjectType, ClusterScanCursor, BaseClientConfiguration, GlideClusterClientConfiguration, LevelOptions, ReturnTypeRecord, ReturnTypeMap, ClusterResponse, ReturnTypeAttribute, } = nativeBinding;
     module.exports = {
         AggregationType,
         BaseScanOptions,
@@ -177,6 +177,16 @@ function initialize() {
         createLeakedMap,
         createLeakedString,
         parseInfoResponse,
+        Script,
+        ObjectType,
+        ClusterScanCursor,
+        BaseClientConfiguration,
+        GlideClusterClientConfiguration,
+        LevelOptions,
+        ReturnTypeRecord,
+        ReturnTypeMap,
+        ClusterResponse,
+        ReturnTypeAttribute,
     };
     globalObject = Object.assign(global, nativeBinding);
 }

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

@@ -3622,7 +3622,7 @@ export declare class BaseClient {
      * // ]
      * ```
      */
-    xinfoGroups(key: string, options?: DecoderOption): Promise<Record<string, GlideString | number | null>[]>;
+    xinfoGroups(key: GlideString, options?: DecoderOption): Promise<Record<string, GlideString | number | null>[]>;
     /**
      * Changes the ownership of a pending message.
      *

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

@@ -1174,7 +1174,7 @@ export declare function createXReadGroup(group: GlideString, consumer: GlideStri
  */
 export declare function createXInfoStream(key: GlideString, options: boolean | number): command_request.Command;
 /** @internal */
-export declare function createXInfoGroups(key: string): command_request.Command;
+export declare function createXInfoGroups(key: GlideString): command_request.Command;
 /**
  * @internal
  */

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

@@ -1,7 +1,7 @@
 /**
  * Copyright Valkey GLIDE Project Contributors - SPDX Identifier: Apache-2.0
  */
-type LevelOptions = "error" | "warn" | "info" | "debug" | "trace";
+export type LevelOptions = "error" | "warn" | "info" | "debug" | "trace";
 export declare class Logger {
     private static _instance;
     private static logger_level;
@@ -28,4 +28,3 @@ export declare class Logger {
      */
     static setLoggerConfig(level: LevelOptions, fileName?: string): void;
 }
-export {};

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

@@ -761,7 +761,7 @@ export declare class BaseTransaction<T extends BaseTransaction<T>> {
      * Command Response - the number of the removed elements.
      * If `key` does not exist, 0 is returned.
      */
-    lrem(key: GlideString, count: number, element: string): T;
+    lrem(key: GlideString, count: number, element: GlideString): T;
     /** Inserts all the specified values at the tail of the list stored at `key`.
      * `elements` are inserted one after the other to the tail of the list, from the leftmost element to the rightmost element.
      * If `key` does not exist, it is created as empty list before performing the push operations.
@@ -1820,7 +1820,7 @@ export declare class BaseTransaction<T extends BaseTransaction<T>> {
      *     attributes of a consumer group for the stream at `key`.
      *     The response comes in format `GlideRecord<GlideString | number | null>[]`, see {@link GlideRecord}.
      */
-    xinfoGroups(key: string): T;
+    xinfoGroups(key: GlideString): T;
     /**
      * Returns the server time.
      *

package/package.json

@@ -1,8 +1,8 @@
 {
     "name": "@valkey/valkey-glide",
     "types": "build-ts/index.d.ts",
-    "version": "v1.1.0-rc8",
-    "description": "An AWS-sponsored, open-source Redis client.",
+    "version": "1.1.0",
+    "description": "General Language Independent Driver for the Enterprise (GLIDE) for Valkey",
     "main": "build-ts/index.js",
     "module": "build-ts/index.js",
     "type": "commonjs",
@@ -26,7 +26,7 @@
         "client",
         "valkey-glide"
     ],
-    "author": "Amazon Web Services",
+    "author": "Valkey GLIDE Maintainers",
     "license": "Apache-2.0",
     "bugs": {
         "url": "https://github.com/valkey-io/valkey-glide/issues"
@@ -40,12 +40,12 @@
         "typescript": "^4.9.4"
     },
     "optionalDependencies": {
-        "@valkey/valkey-glide-darwin-arm64": "v1.1.0-rc8",
-        "@valkey/valkey-glide-darwin-x64": "v1.1.0-rc8",
-        "@valkey/valkey-glide-linux-arm64": "v1.1.0-rc8",
-        "@valkey/valkey-glide-linux-x64": "v1.1.0-rc8",
-        "@valkey/valkey-glide-linux-musl-arm64": "v1.1.0-rc8",
-        "@valkey/valkey-glide-linux-musl-x64": "v1.1.0-rc8"
+        "@valkey/valkey-glide-darwin-arm64": "1.1.0",
+        "@valkey/valkey-glide-darwin-x64": "1.1.0",
+        "@valkey/valkey-glide-linux-arm64": "1.1.0",
+        "@valkey/valkey-glide-linux-x64": "1.1.0",
+        "@valkey/valkey-glide-linux-musl-arm64": "1.1.0",
+        "@valkey/valkey-glide-linux-musl-x64": "1.1.0"
     },
     "eslintConfig": {
         "extends": [