model-redis 0.3.0 → 0.4.0

package/README.md

@@ -7,6 +7,7 @@ projects that do not require complex data models.
 
 ## Features
 
+- 📦 **CommonJS & ESM compatible** - Works seamlessly with both module systems
 - 📋 Schema-based validation with type checking
 - 🔑 Primary key and indexed field support
 - 🔗 Model relationships (one-to-one, one-to-many)
@@ -23,15 +24,20 @@ npm install model-redis
 
 ## Getting Started
 
-`setUpTable([object])` - *Async Function* to bind the Redis connection
+`setUpTable([object])` - Function to bind the Redis connection
 to the ORM table. It takes an optional connected redis client object
 or configuration for the Redis module. This will return a `Table` class we
 can use later for our models.
 
+The function returns synchronously, making it compatible with both CommonJS and ESM.
+Redis connection happens in the background, and operations automatically await the connection.
+
 It is recommended you place this in a utility or lib file within your project
 and require it when needed.
 
-The simplest way to use this is to pass nothing to the `setUpTable` function.
+### CommonJS Usage
+
+The simplest way to use this in CommonJS is to pass nothing to the `setUpTable` function.
 This will create a connected client to Redis using the default settings:
 
 ```javascript
@@ -39,11 +45,23 @@ This will create a connected client to Redis using the default settings:
 
 const {setUpTable} = require('model-redis');
 
-const Table = await setUpTable();
+const Table = setUpTable();
 
 module.exports = Table;
 ```
 
+### ESM Usage
+
+For ESM projects, you can still use `await` if preferred (though it's no longer required):
+
+```javascript
+import {setUpTable} from 'model-redis';
+
+const Table = await setUpTable();
+
+export default Table;
+```
+
 You can also pass your own configuration options to the Redis client. See the
 redis [client configuration guide](https://github.com/redis/node-redis/blob/master/docs/client-configuration.md)
 for available options:
@@ -62,7 +80,7 @@ const conf = {
     password: 'hunter42'
 };
 
-const Table = await setUpTable({redisConf: conf});
+const Table = setUpTable({redisConf: conf});
 
 module.exports = Table;
 ```
@@ -79,11 +97,13 @@ const {createClient} = require('redis');
 const client = createClient();
 await client.connect();
 
-const Table = await setUpTable({redisClient: client});
+const Table = setUpTable({redisClient: client});
 
 module.exports = Table;
 ```
 
+**Note:** When passing a custom client, ensure it's connected before passing it to `setUpTable`.
+
 ### Prefix Key
 
 At some point, the Redis package removed the option to prefix a string to the
@@ -94,7 +114,7 @@ keys. This functionality has been added back with this package:
 
 const {setUpTable} = require('model-redis');
 
-const Table = await setUpTable({
+const Table = setUpTable({
     prefix: 'auth_app:'
 });
 
@@ -262,7 +282,7 @@ All of these methods are extensible so proper business logic can be implemented.
 Model Redis supports relationships between models through the model registry system:
 
 ```javascript
-const Table = await setUpTable();
+const Table = setUpTable();
 
 // Define User model
 class User extends Table {

package/index.js

@@ -2,20 +2,24 @@
 const table = require('./src/redis_model')
 var client = null
 
-async function setUpTable(obj){
+function setUpTable(obj){
 	obj = obj || {};
 
+	let connectionPromise;
+
 	if(obj.redisClient){
 		client = obj.redisClient;
+		// If a client is provided, assume it's already connected or will be connected externally
+		connectionPromise = Promise.resolve(client);
 	}else{
 		const {createClient} = require('redis');
 		client = createClient(obj.redisConf || {});
-		await client.connect();
+		// Connect in background and store the promise
+		connectionPromise = client.connect().then(() => client);
 	}
 
-	// test client connection
-
-	return table(client, obj.prefix);
+	// Return Table class immediately with connection promise injected
+	return table(client, obj.prefix, connectionPromise);
 }
 
 module.exports = {client, setUpTable};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "model-redis",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Simple ORM model for Redis in Node.js",
   "main": "index.js",
   "scripts": {

package/src/redis_model.js

@@ -21,12 +21,19 @@ class QueryHelper{
     }
 }
 
-function setUpTable(client, prefix=''){
+function setUpTable(client, prefix='', connectionPromise=null){
 
     function redisPrefix(key){
         return `${prefix}${key}`;
     }
 
+    // Helper function to await connection if promise exists
+    async function ensureClientReady(){
+        if(connectionPromise){
+            await connectionPromise;
+        }
+    }
+
     class Table{
         static errors = {
             ObjectValidateError: objValidate.ObjectValidateError,
@@ -60,6 +67,9 @@ function setUpTable(client, prefix=''){
 
         static async get(index, queryHelper){
             try{
+                // Ensure client is connected before proceeding
+                await ensureClientReady();
+
                 if(typeof index === 'object'){
                     index = index[this._key];
                 }
@@ -117,6 +127,9 @@ function setUpTable(client, prefix=''){
         }
 
         static async exists(index){
+            // Ensure client is connected before proceeding
+            await ensureClientReady();
+
             if(typeof index === 'object'){
                 index = index[this._key];
             }
@@ -130,6 +143,9 @@ function setUpTable(client, prefix=''){
         static async list(){
             // return a list of all the index keys for this table.
             try{
+                // Ensure client is connected before proceeding
+                await ensureClientReady();
+
                 return await client.SMEMBERS(
                     redisPrefix(this.prototype.constructor.name)
                 );
@@ -166,6 +182,8 @@ function setUpTable(client, prefix=''){
         static async create(data){
             // Add a entry to this redis table.
             try{
+                // Ensure client is connected before proceeding
+                await ensureClientReady();
 
                 // Validate the passed data by the keyMap schema.
                 data = objValidate.processKeys(this._keyMap, data);
@@ -210,6 +228,9 @@ function setUpTable(client, prefix=''){
         async update(data){
             // Update an existing entry.
             try{
+                // Ensure client is connected before proceeding
+                await ensureClientReady();
+
                 // Validate the passed data, ignoring required fields.
                 data = objValidate.processKeys(this.constructor._keyMap, data, true);
 
@@ -271,6 +292,9 @@ function setUpTable(client, prefix=''){
             // Remove an entry from this table.
 
             try{
+                // Ensure client is connected before proceeding
+                await ensureClientReady();
+
                 // Remove the index key from the tables members list.
                 await client.SREM(
                     redisPrefix(this.constructor.name),