Merge pull request #9 from alexpota/feat/valkey-glide-support

feat: add Valkey GLIDE support

Author: alexpota

CHANGELOG.md

@@ -5,6 +5,20 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.3.0]
+
+### Added
+
+- **Valkey GLIDE Support**: Added support for Valkey's official GLIDE client via `GlideAdapter`
+- **Re-exported Adapters**: `NodeRedisAdapter`, `IoredisAdapter`, and `GlideAdapter` are now re-exported from `nestjs-redlock-universal` for convenience
+- Updated peer dependency to `redlock-universal ^0.8.0`
+
+### Documentation
+
+- Added Valkey GLIDE configuration examples
+- Updated all examples to use re-exported adapters from `nestjs-redlock-universal`
+- Updated features list to mention Valkey support
+
 ## [0.1.0] - 2025-01-05
 
 ### Added

README.md

@@ -1,6 +1,6 @@
 # nestjs-redlock-universal
 
-> NestJS integration for [redlock-universal](https://www.npmjs.com/package/redlock-universal) - Distributed Redis locks with decorators and dependency injection
+> NestJS integration for [redlock-universal](https://www.npmjs.com/package/redlock-universal) - Distributed Redis and Valkey locks with decorators and dependency injection
 
 [![npm version](https://img.shields.io/npm/v/nestjs-redlock-universal.svg)](https://www.npmjs.com/package/nestjs-redlock-universal)
 [![npm downloads](https://img.shields.io/npm/dm/nestjs-redlock-universal.svg)](https://www.npmjs.com/package/nestjs-redlock-universal)
@@ -9,22 +9,24 @@
 
 ## Overview
 
-NestJS wrapper for [redlock-universal](https://www.npmjs.com/package/redlock-universal), providing **distributed Redis locks** through NestJS decorators, modules, and dependency injection.
+NestJS wrapper for [redlock-universal](https://www.npmjs.com/package/redlock-universal), providing **distributed Redis and Valkey locks** through NestJS decorators, modules, and dependency injection.
 
 ## Features
 
 - **NestJS Native**: First-class integration with dependency injection and lifecycle hooks
-- **Distributed Locks**: Redlock algorithm for multi-instance Redis setups
+- **Distributed Locks**: Redlock algorithm for multi-instance Redis/Valkey setups
 - **Simple API**: Method decorator for zero-boilerplate distributed locking
 - **High Performance**: <1ms lock acquisition with automatic extension
 - **Type-Safe**: Full TypeScript support with strict type checking
-- **Universal**: Works with both `node-redis` v4+ and `ioredis` v5+ clients
+- **Universal**: Works with `node-redis` v4+, `ioredis` v5+, and Valkey GLIDE v2+
 
 ## Table of Contents
 
 - [Installation](#installation)
 - [Quick Start](#quick-start)
 - [Configuration](#configuration)
+  - [Using ioredis](#using-ioredis)
+  - [Using Valkey GLIDE](#using-valkey-glide)
 - [API Reference](#api-reference)
 - [Advanced Usage](#advanced-usage)
 - [Testing](#testing)
@@ -39,14 +41,17 @@ This package wraps `redlock-universal`, so you need to install both packages:
 npm install nestjs-redlock-universal redlock-universal
 ```
 
-You'll also need a Redis client:
+You'll also need a Redis/Valkey client:
 
 ```bash
 # For node-redis
 npm install redis
 
 # OR for ioredis
 npm install ioredis
+
+# OR for Valkey GLIDE (official Valkey client)
+npm install @valkey/valkey-glide
 ```
 
 ## Quick Start
@@ -55,8 +60,7 @@ npm install ioredis
 
 ```typescript
 import { Module } from '@nestjs/common';
-import { RedlockModule } from 'nestjs-redlock-universal';
-import { NodeRedisAdapter } from 'redlock-universal';
+import { RedlockModule, NodeRedisAdapter } from 'nestjs-redlock-universal';
 import { createClient } from 'redis';
 
 // Create and connect Redis clients
@@ -138,8 +142,7 @@ export class OrderService {
 ### Synchronous Configuration
 
 ```typescript
-import { RedlockModule } from 'nestjs-redlock-universal';
-import { NodeRedisAdapter } from 'redlock-universal';
+import { RedlockModule, NodeRedisAdapter } from 'nestjs-redlock-universal';
 
 RedlockModule.forRoot({
   nodes: [
@@ -159,6 +162,7 @@ RedlockModule.forRoot({
 
 ```typescript
 import { ConfigService } from '@nestjs/config';
+import { RedlockModule, NodeRedisAdapter } from 'nestjs-redlock-universal';
 
 RedlockModule.forRootAsync({
   useFactory: async (configService: ConfigService) => {
@@ -179,7 +183,7 @@ RedlockModule.forRootAsync({
 ### Using ioredis
 
 ```typescript
-import { IoredisAdapter } from 'redlock-universal';
+import { RedlockModule, IoredisAdapter } from 'nestjs-redlock-universal';
 import Redis from 'ioredis';
 
 const redis1 = new Redis({ host: 'localhost', port: 6379 });
@@ -195,6 +199,32 @@ RedlockModule.forRoot({
 })
 ```
 
+### Using Valkey GLIDE
+
+```typescript
+import { RedlockModule, GlideAdapter } from 'nestjs-redlock-universal';
+import { GlideClient } from '@valkey/valkey-glide';
+
+// Create Valkey GLIDE clients
+const valkey1 = await GlideClient.createClient({
+  addresses: [{ host: 'localhost', port: 6379 }],
+});
+const valkey2 = await GlideClient.createClient({
+  addresses: [{ host: 'localhost', port: 6380 }],
+});
+const valkey3 = await GlideClient.createClient({
+  addresses: [{ host: 'localhost', port: 6381 }],
+});
+
+RedlockModule.forRoot({
+  nodes: [
+    new GlideAdapter(valkey1),
+    new GlideAdapter(valkey2),
+    new GlideAdapter(valkey3),
+  ],
+})
+```
+
 ### Logger Integration
 
 The module supports external loggers for lock operations. Winston works directly, while Pino and Bunyan require adapters:
@@ -362,6 +392,9 @@ export class AdvancedService {
 For development or single-instance deployments:
 
 ```typescript
+import { RedlockModule, NodeRedisAdapter } from 'nestjs-redlock-universal';
+import { createClient } from 'redis';
+
 const redis = createClient({ url: 'redis://localhost:6379' });
 await redis.connect();
 
@@ -535,7 +568,7 @@ Most NestJS Redis libraries focus on caching. This library is purpose-built for
 - ✅ Automatic lock extension via `using()`
 - ✅ NestJS decorator for zero-boilerplate
 - ✅ Built on `redlock-universal`
-- ✅ Universal Redis client support (node-redis + ioredis)
+- ✅ Universal Redis/Valkey client support (node-redis, ioredis, Valkey GLIDE)
 
 ## License
 

package-lock.json

@@ -1,12 +1,15 @@
 {
   "name": "nestjs-redlock-universal",
-  "version": "0.2.3",
-  "description": "NestJS integration for redlock-universal - Distributed Redis locks with decorators, modules, and dependency injection",
+  "version": "0.3.0",
+  "description": "NestJS integration for redlock-universal - Distributed Redis and Valkey locks with decorators, modules, and dependency injection",
   "keywords": [
     "nestjs",
     "nest",
     "redlock",
     "redis",
+    "valkey",
+    "valkey-glide",
+    "valkey-lock",
     "lock",
     "distributed",
     "distributed-lock",
@@ -90,7 +93,7 @@
   "peerDependencies": {
     "@nestjs/common": "^8.0.0 || ^9.0.0 || ^10.0.0 || ^11.0.0",
     "@nestjs/core": "^8.0.0 || ^9.0.0 || ^10.0.0 || ^11.0.0",
-    "redlock-universal": "^0.7.5",
+    "redlock-universal": "^0.8.0",
     "reflect-metadata": "^0.1.13 || ^0.2.0"
   },
   "devDependencies": {
@@ -110,7 +113,7 @@
     "lint-staged": "^16.2.6",
     "prettier": "^3.0.0",
     "redis": "^5.9.0",
-    "redlock-universal": "^0.7.5",
+    "redlock-universal": "^0.8.0",
     "reflect-metadata": "^0.1.13",
     "tsup": "^8.0.0",
     "typescript": "^5.2.0",

package.json

@@ -21,3 +21,6 @@ export {
   DEFAULT_RETRY_DELAY_MS,
   MIN_NODES_FOR_REDLOCK,
 } from './constants';
+
+// Re-export adapters from redlock-universal for convenience
+export { NodeRedisAdapter, IoredisAdapter, GlideAdapter } from 'redlock-universal';