Merge pull request #2 from ArkerLabs/lua

Lua

README.md

@@ -1,5 +1,7 @@
-Redisk
-=====
+<h1 align="center">
+  <img src="https://raw.githubusercontent.com/arkerlabs/redisk/master/docs/images/logo.png" alt="Redisk">
+</h1>
+
 [![npm version](https://badge.fury.io/js/redisk.svg)](https://badge.fury.io/js/redisk)
 
 Redisk is a TypeScript ORM library for Redis.
@@ -13,7 +15,7 @@ Redisk is a TypeScript ORM library for Redis.
 * Retrieve entities by his primary keys or his unique keys.
 * Indexes support.
 * List entities with common filters, like limit, count and sort by.
-* Find entities with multiple conditions.
+* Find entities with multiple conditions ('>', '<', '=', '!=').
 * Search (Similar to LIKE in SQL)
 * And much more.
 
@@ -64,7 +66,6 @@ npm install redisk --save
     - [Supported types](#supported-types)
   - [Primary](#primary)
   - [Unique](#unique)
-  - [Index](#index)
   - [Embedding other entities](#embedding-other-entities)
 - [Queries](#queries)
   - [Save](#save)
@@ -73,7 +74,7 @@ npm install redisk --save
   - [Get by unique key](#get-by-unique-key)
   - [Count](#count)
   - [List all](#list-all)
-  - [Find all by index](#find-all-by-index)
+  - [List all with conditions](#find-all-by-index)
     - [Simple](#simple)
     - [Multiple conditions](#multiple-conditions)
   - [Pattern matching](#pattern-matching)
@@ -113,22 +114,21 @@ export class User {
   @Property()
   public readonly id: string;
 
-  @Property({sortable: false, searchable: true})
+  @Property({searchable: true})
   public name: string;
 
   @Unique()
   @Property()
   public email: string;
 
-  @Index()
-  @Property()
+  @Property({indexed: true})
   public color: string;
 
   @HasOne(Group, {cascadeInsert: true, cascadeUpdate: true})
   @Property()
   public group: Group;
 
-  @Property({sortable: true, searchable: false})
+  @Property({indexed: true})
   public created: Date;
 
   constructor(
@@ -162,15 +162,16 @@ export class User {
 
 ### Property
 The decorator `Property` is used to save the fields into redis.
-Optionally, you can pass the options `sortable` if you want to use the field to sort in the 'list' method or `searchable` if you want to use pattern matching in this field.
+
+Optionally, you can pass the options `indexed` if you want to use the field to sort or to use as a condition in the 'list' method or `searchable` if you want to use pattern matching in this field.
 
 Both options are false by default.
 
 ```ts
 @Entity('user')
 export class User {
 
-    @Property({sortable: true, searchable: false})
+    @Property({indexed: true, searchable: false})
     public readonly created: Date;
 
 }
@@ -210,18 +211,6 @@ export class User {
 }
 ```
 
-### Index
-Use the decorator `Index` on the fields that you want to query later with the find() method.
-```ts
-@Entity('user')
-export class User {
-
-  @Index()
-  @Property()
-  public readonly color: string;
-}
-```
-
 ### Embedding other entities
 You can make one to one relations with the `HasOne` decorator.
 
@@ -282,50 +271,87 @@ const limit = 10;
 const offset = 0;
 await redis.list(User, limit, offset); // Returns 10 user entities
 
-await redisk.list(User, undefined, undefined, {
+await redisk.list(User, undefined, undefined, undefined, {
     field: 'created',
     strategy: 'DESC',
 }); // Returns an array of entities sorted by his creation date in descending order
 ```
 
-### Find all by index
+### List all with conditions
 #### Simple
+Returns an array of users where his color is red
+
+```ts
+const where = 
+    conditions: [
+        {
+            key: 'color',
+            value: 'red',
+            comparator: '=',
+        },
+    ],
+    type: 'AND',
+};
+await redisk.find(User, where, limit, offset); 
+```
+
+Returns an array of users where his creation date is greater than the day 23
 ```ts
-const conditions = [
-    {
-        key: 'color',
-        value: 'red',
-    },
-];
-await redisk.find(User, conditions, limit, offset); // Returns an array of entities that match the conditions
+const where = 
+    conditions: [
+        {
+            key: 'created',
+            value: new Date('2020-02-23 00:00:00'),
+            comparator: '>',
+        },
+    ],
+    type: 'AND',
+};
+await redisk.find(User, where, limit, offset); 
 ```
 
 #### Multiple conditions
+Returns an array of entities that his color field is 'red' or 'blue'.
+
+Warning: When using multiple conditions...
+
 ```ts
-const conditions = [
-    {
-        key: 'color',
-        value: 'red',
-    },
-    {
-        key: 'color',
-        value: 'blue',
-    },
-];
-await redisk.find(User, conditions, limit, offset, 'OR'); // Returns an array of entities that his color field is 'red' or 'blue'
+const where = 
+    conditions: [
+        {
+            key: 'color',
+            value: 'red',
+            comparator: '=',
+        },
+        {
+            key: 'color',
+            value: 'blue',
+            comparator: '=',
+        },
+    ],
+    type: 'OR',
+};
+await redisk.find(User, where, limit, offset);
 ```
+
+Returns an array of entities that his color field is 'red' and his food field is 'avocado'
 ```ts
-const conditions = [
-    {
-        key: 'color',
-        value: 'red',
-    },
-    {
-        key: 'food',
-        value: 'avocado',
-    },
-];
-await redisk.find(User, conditions, limit, offset, 'AND'); // Returns an array of entities that his color field is 'red' and his food field is 'avocado'
+const where = 
+    conditions: [
+        {
+            key: 'color',
+            value: 'red',
+            comparator: '=',
+        },
+        {
+            key: 'color',
+            value: 'blue',
+            comparator: '=',
+        },
+    ],
+    type: 'AND',
+};
+await redisk.find(User, where, limit, offset);
 ```
 
 ### Pattern matching

package.json

@@ -27,6 +27,8 @@
   "keywords": [
     "typescript",
     "redis",
+    "redisk",
+    "ts",
     "orm"
   ],
   "author": "ArkerLabs",
@@ -37,6 +39,7 @@
   "homepage": "https://github.com/ArkerLabs/redisk#readme",
   "devDependencies": {
     "@types/jest": "^24.9.1",
+    "@types/node": "^13.9.0",
     "jest": "^25.1.0",
     "ts-jest": "^25.0.0",
     "typescript": "^3.7.5"

src/client/client.ts

@@ -16,10 +16,12 @@ export interface Client {
     sinter(keys: string[] | string): Promise<string[]>;
     sunion(keys: string[]): Promise<string[]>;
     zrange(key: string, start: number, stop: number): Promise<string[]>;
+    zrangebyscore(key: string, min: string, max: string, offset: number, count: number): Promise<string[]>;
     zrevrange(key: string, start: number, stop: number): Promise<string[]>;
     lrange(key: string, start: number, stop: number): Promise<string[]>;
     lrem(key: string, count: number, element: string): Promise<void>;
     del(key: string): Promise<void>;
     get(key: string): Promise<string>;
     hmget(key: string, properties: string[]): Promise<string[]>;
+    eval(...args: any[]): Promise<any[]>;
 }

src/client/redis.client.ts

@@ -81,6 +81,10 @@ export class RedisClient implements Client {
         return await this.client.sunionAsync(keys);
     }
 
+    async zrangebyscore(key: string, min: string, max: string, offset: number, count: number): Promise<string[]> {
+        return await this.client.zrangebyscoreAsync(key, min, max, 'LIMIT', offset, count);
+    }
+
     async zrange(key: string, start: number, stop: number): Promise<string[]> {
         return await this.client.zrangeAsync(key, start, stop);
     }
@@ -108,4 +112,8 @@ export class RedisClient implements Client {
     async hmget(key: string, properties: string[]): Promise<string[]> {
         return await this.client.hmgetAsync(key, properties);
     }
+
+    async eval(...args: any[]): Promise<any[]> {
+        return await this.client.evalAsync(args);
+    }
 }

src/decorators/index.ts

@@ -1,5 +1,4 @@
 export * from './entity.decorator';
-export * from './index.decorator';
 export * from './primary.decorator';
 export * from './property.decorator';
 export * from './unique.decorator';

src/decorators/property.decorator.ts

@@ -1,26 +1,22 @@
 import { MetadataStorage } from '../metadata/metadata.storage';
 import 'reflect-metadata';
 
-export function Property(options: {sortable: boolean, searchable: boolean} = {
-    sortable: false,
+export function Property(options: {searchable?: boolean, indexed?: boolean} = {
     searchable: false,
+    indexed: false,
 // tslint:disable-next-line: ban-types
 }): Function {
     return (object: object, propertyName: string) => {
         const type = Reflect.getMetadata('design:type', object, propertyName).name;
 
-        if (options.sortable && (type !== 'Date' && type !== 'Number')) {
-            throw new Error('You can only make Dates and numbers sortables');
-        }
-
         if (MetadataStorage.getGlobal().properties[object.constructor.name] === undefined) {
-            MetadataStorage.getGlobal().properties[object.constructor.name] = [];
+            MetadataStorage.getGlobal().properties[object.constructor.name] = {};
         }
-        MetadataStorage.getGlobal().properties[object.constructor.name].push({
+        MetadataStorage.getGlobal().properties[object.constructor.name][propertyName] = {
             name: propertyName,
-            sortable: options.sortable,
             searchable: options.searchable,
+            indexed: options.indexed,
             type,
-        });
+        };
     };
 }

src/interfaces/where-condition.ts

@@ -0,0 +1,5 @@
+export interface WhereCondition {
+    key: string;
+    value: any;
+    comparator: '>' | '<' | '=' | '!=';
+}