Merge pull request #7 from Aditya-ds-1806/release/dicedb-driver-v1.3.0

Release: v1.3.0

Author: Aditya-ds-1806

index.ts

@@ -3,7 +3,7 @@
  * --------------------------------------------------------------
  * This file was automatically generated.
  * Source: build.ts
- * Date: 2025-04-19T21:44:43.742Z
+ * Date: 2025-04-19T22:01:56.203Z
  * 
  * ⚠️ DO NOT MODIFY THIS FILE MANUALLY ⚠️
  * Changes will be overwritten the next time it is built.
@@ -286,6 +286,17 @@ class DiceDB extends DiceDBBase {
 	}
 
 
+	/**
+     * Get all keys matching a pattern
+     * 
+     * @param {string} pattern - The pattern to match keys against
+     * @returns A promise that resolves with the list of matching keys
+     */
+	async keys(pattern: string) {
+		return this.execCommand('KEYS', pattern) as Promise<DiceDBResponse>;
+	}
+
+
 	/**
      * Executes the PING command to test the connection to the server.
      *
@@ -348,7 +359,7 @@ class DiceDB extends DiceDBBase {
      * options for adding elements.
      *
      * @param {string} key - The key of the sorted set.
-     * @param {Record<string, number | string>} map - A map of members and their scores.
+     * @param {Record<string, number | string> | Map<string, number | string>} map - A map of members and their scores.
      * @param opts - The options for adding elements to the sorted set.
      * @returns A promise that resolves when the elements are added successfully.
      */

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "dicedb-driver",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
   "scripts": {

package.json

@@ -0,0 +1,20 @@
+import Command from "../../lib/Command";
+import { validateKey } from "../../lib/Validators";
+import { COMMANDS } from "../constants/commands";
+
+export default class KeysCommand extends Command {
+    static get command() {
+        return COMMANDS.KEYS;
+    }
+
+    /**
+     * Get all keys matching a pattern
+     * 
+     * @param {string} pattern - The pattern to match keys against
+     * @returns A promise that resolves with the list of matching keys
+     */
+    async exec(pattern: string) {
+        validateKey(pattern);
+        return super.exec(pattern);
+    }
+};

src/commands/Keys.ts

@@ -21,6 +21,7 @@ export const COMMANDS = Object.freeze({
     HSET: 'HSET',
     INCR: 'INCR',
     INCRBY: 'INCRBY',
+    KEYS: 'KEYS',
     PING: 'PING',
     SET: 'SET',
     TTL: 'TTL',
@@ -61,6 +62,7 @@ export const COMMAND_TO_COMMAND_NAME = Object.freeze({
     [COMMANDS.HSET]: 'hSet',
     [COMMANDS.INCR]: 'increment',
     [COMMANDS.INCRBY]: 'incrementBy',
+    [COMMANDS.KEYS]: 'keys',
     [COMMANDS.PING]: 'ping',
     [COMMANDS.SET]: 'set',
     [COMMANDS.TTL]: 'ttl',

src/constants/commands.ts

@@ -3,7 +3,7 @@
  * --------------------------------------------------------------
  * This file was automatically generated.
  * Source: build.ts
- * Date: 2025-04-19T21:44:44.059Z
+ * Date: 2025-04-19T22:01:56.519Z
  * 
  * ⚠️ DO NOT MODIFY THIS FILE MANUALLY ⚠️
  * Changes will be overwritten the next time it is built.
@@ -36,6 +36,7 @@ import HSetCommand from './commands/HSet';
 import HandshakeCommand from './commands/Handshake';
 import IncrementCommand from './commands/Increment';
 import IncrementByCommand from './commands/IncrementBy';
+import KeysCommand from './commands/Keys';
 import PingCommand from './commands/Ping';
 import SetCommand from './commands/Set';
 import TTLCommand from './commands/TTL';
@@ -78,6 +79,7 @@ commandRegistry.set(HSetCommand.command, HSetCommand);
 commandRegistry.set(HandshakeCommand.command, HandshakeCommand);
 commandRegistry.set(IncrementCommand.command, IncrementCommand);
 commandRegistry.set(IncrementByCommand.command, IncrementByCommand);
+commandRegistry.set(KeysCommand.command, KeysCommand);
 commandRegistry.set(PingCommand.command, PingCommand);
 commandRegistry.set(SetCommand.command, SetCommand);
 commandRegistry.set(TTLCommand.command, TTLCommand);

src/registry.ts

@@ -2674,6 +2674,100 @@ describe('DiceDB test cases', () => {
         });
     });
 
+    describe('KeysCommand', () => {
+        beforeEach(async () => {
+            try {
+                // Clear any existing keys
+                await db.flushDB();
+
+                // Set up test data
+                await db.set('user:1', 'John');
+                await db.set('user:2', 'Jane');
+                await db.set('post:1', 'Hello');
+                await db.hSet('hash:1', { field1: 'value1' });
+                await db.zAdd('zset:1', { member1: 10 });
+            } catch {
+                // Ignore errors during setup
+            }
+        });
+
+        it('should return all keys matching exact pattern', async () => {
+            const response = await db.keys('user:1');
+            expect(response.success).to.be.true;
+            expect(response.data.result).to.have.lengthOf(1);
+            expect(response.data.result).to.include('user:1');
+        });
+
+        it('should return all keys matching wildcard pattern *', async () => {
+            const response = await db.keys('*');
+            expect(response.success).to.be.true;
+            expect(response.data.result).to.have.lengthOf(5); // All test keys
+            expect(response.data.result).to.include.members([
+                'user:1',
+                'user:2',
+                'post:1',
+                'hash:1',
+                'zset:1',
+            ]);
+        });
+
+        it('should return all keys matching prefix pattern', async () => {
+            const response = await db.keys('user:*');
+            expect(response.success).to.be.true;
+            expect(response.data.result).to.have.lengthOf(2);
+            expect(response.data.result).to.include.members([
+                'user:1',
+                'user:2',
+            ]);
+        });
+
+        it('should return all keys matching suffix pattern', async () => {
+            const response = await db.keys('*:1');
+            expect(response.success).to.be.true;
+            expect(response.data.result).to.have.lengthOf(4);
+            expect(response.data.result).to.include.members([
+                'user:1',
+                'post:1',
+                'hash:1',
+                'zset:1',
+            ]);
+        });
+
+        it('should return all keys matching question mark pattern', async () => {
+            const response = await db.keys('user:?');
+            expect(response.success).to.be.true;
+            expect(response.data.result).to.have.lengthOf(2);
+            expect(response.data.result).to.include.members([
+                'user:1',
+                'user:2',
+            ]);
+        });
+
+        it('should return empty array for non-matching pattern', async () => {
+            const response = await db.keys('nonexistent:*');
+            expect(response.success).to.be.true;
+            expect(response.data.result).to.have.lengthOf(0);
+        });
+
+        it('should return empty array when database is empty', async () => {
+            await db.flushDB();
+            const response = await db.keys('*');
+            expect(response.success).to.be.true;
+            expect(response.data.result).to.have.lengthOf(0);
+        });
+
+        it('should throw error for invalid pattern', async () => {
+            try {
+                await db.keys({ invalid: 'pattern' });
+                expect.fail('Should have thrown error');
+            } catch (error) {
+                expect(error.message).to.include(
+                    'key must be a string or number',
+                );
+            }
+        });
+    });
+
     it('should run all commands concurrently without error', async () => {
         const data = await Promise.allSettled([
             db.ping(),