tspace-mysql 1.5.7 → 1.5.8

package/README.md

@@ -63,7 +63,7 @@ npm install tspace-mysql -g
     - [Observer](#observer)
     - [Logger](#logger)
     - [Hooks](#hooks)
-  - [SoftDelete](#soft-delete)
+  - [SoftDelete](#softdelete)
   - [Schema](#schema)
     - [Schema Model](#schema-model)
     - [Validation](#validation)
@@ -75,6 +75,7 @@ npm install tspace-mysql -g
     - [Many To Many](#many-to-many)
     - [Deeply Nested Relations](#deeply-nested-relations)
     - [Relation Exists](#relation-exists)
+    - [Relation Trashed](#relation-trashed)
     - [Built in Relation Functions](#built-in-relation-functions)
   - [Decorator](#decorator)
   - [Type Safety](#type-safety)
@@ -1414,6 +1415,10 @@ class User extends Model {
 const user = await new User().where('user_id',1).findOne()
 // SELECT * FROM `users` WHERE `users`.`userId` = '1' and `users`.`deletedAtCustom` IS NULL LIMIT 1;
 
+// find in trashed
+const user = await new User().trashed().findMany()
+// SELECT * FROM `users` WHERE `users`.`userId` = '1' and `users`.`deletedAtCustom` IS NOT NULL;
+
 ```
 
 ### Relationships
@@ -1700,6 +1705,9 @@ class Post extends Model {
 }
 // normal relations
 await new User().relations('posts').findMany()
+// SELECT * FROM `users` WHERE `users`.`deleted_at`;
+// SELECT * FROM `posts` WHERE `posts`.`userId` IN (...) AND `posts`.`deleted_at` IS NULL;
+
 /*
  * @returns [
  *  {
@@ -1730,6 +1738,11 @@ await new User().relations('posts').findMany()
 */
 
 await new User().relationsExists('posts').findMany()
+// SELECT * FROM `users` WHERE `users`.`deleted_at` IS NULL 
+// AND EXISTS (SELECT 1 FROM `posts` WHERE `users`.`id` = `posts`.`user_id` AND `posts`.`deletedA_at` IS NULL );
+
+// SELECT * FROM `posts` WHERE `posts`.`user_id` IN (...) AND `posts`.`deleted_at` IS NULL;
+
 /*
  * @returns [
  *  {
@@ -1748,6 +1761,130 @@ await new User().relationsExists('posts').findMany()
  * because posts id 1 and id 3 has been removed from database (using soft delete)
  */
 
+```
+
+#### Relation Trashed
+Relationships can return results only if they are deleted in table, considering soft deletes.
+Let's illustrate this with an example:
+```js
+
++-------------+--------------+----------------------------+--------------------+
+|                     table users                         |                    |
++-------------+--------------+----------------------------+--------------------+
+| id          | username     | email                      | deleted_at         |
+|-------------|--------------|----------------------------|--------------------|
+| 1           | tspace1      | tspace1@gmail.com          |                    |
+| 2           | tspace2      | tspace2@gmail.com          |                    |
+| 3           | tspace3      | tspace3@gmail.com          |2020-07-15 00:00:00 |
++-------------+--------------+----------------------------+--------------------+
+
++-------------+--------------+----------------------------+--------------------+
+|                     table posts                         |                    |
++-------------+--------------+----------------------------+--------------------+
+| id          | user_id      | title                      | deleted_at         |
+|-------------|--------------|----------------------------|--------------------|
+| 1           | 1            | posts 1                    |2020-07-15 00:00:00 |
+| 2           | 2            | posts 2                    |                    |
+| 3           | 3            | posts 3                    |2020-07-15 00:00:00 |
++-------------+--------------+----------------------------+--------------------+
+
+import { Model } from 'tspace-mysql'
+
+class User extends Model {
+    constructor(){
+        super()
+        this.hasMany({ name : 'posts' , model : Post })
+        this.useSoftDelete()
+    }
+}
+
++--------------------------------------------------------------------------+
+
+class Post extends Model {
+    constructor(){
+        super()
+        this.hasMany({ name : 'comments' , model : Comment })
+        this.belongsTo({ name : 'user' , model : User })
+        this.useSoftDelete()
+    }
+}
+
+// normal relations
+await new User().relations('posts').findMany()
+// SELECT * FROM `users` WHERE `users`.`deleted_at` IS NULL;
+// SELECT * FROM `posts` WHERE `posts`.`user_id` IN (...) AND `posts`.`deleted_at` IS NULL;
+
+/*
+ * @returns [
+ *  {
+ *      id : 1,
+ *      username:  "tspace1",
+ *      email : "tspace1@gmail.com",
+ *      posts : []
+ *  }
+ *  {
+ *      id : 2,
+ *      username:  "tspace2",
+ *      email : "tspace2@gmail.com",
+ *      posts : [
+ *        {
+ *          id : 2,
+ *          user_id :  2,
+ *          title : "posts 2"
+ *        }
+ *    ]
+ *  }
+ * ]
+ */
+
+// relationsTrashed
+await new User().relationsTrashed('posts').findMany()
+// SELECT * FROM `users` WHERE `users`.`deleted_at` IS NULL;
+// SELECT * FROM `posts` WHERE `posts`.`user_id` IN (...) AND `posts`.`deleted_at` IS NOT NULL;
+
+/*
+ * @returns [
+ *  {
+ *      id : 1,
+ *      username:  "tspace1",
+ *      email : "tspace1@gmail.com",
+ *      posts : [
+ *       {
+ *          id : 1,
+ *          user_id :  1,
+ *          title : "posts 1"
+ *        }
+ *      ]
+ *  }
+ *  {
+ *      id : 2,
+ *      username:  "tspace2",
+ *      email : "tspace2@gmail.com",
+ *      posts : []
+ *  }
+ * ]
+ */
+
+// relationsTrashed + trashed
+await new User().relationsTrashed('posts').trashed().findMany()
+// SELECT * FROM `users` WHERE `users`.`deleted_at` IS NOT NULL;
+// SELECT * FROM `posts` WHERE `posts`.`user_id` IN (...) AND `posts`.`deleted_at` IS NOT NULL;
+/*
+ * @returns [
+ *  {
+ *      id : 3,
+ *      username:  "tspace3",
+ *      email : "tspace3@gmail.com",
+ *      posts : [
+ *        {
+ *          id : 3,
+ *          user_id :  3,
+ *          title : "posts 3"
+ *        }
+ *      ]
+ *  }
+ * ]
+ */
 
 ```
 
@@ -2452,7 +2589,8 @@ const users = await new User()
 
 ## Repository
 ```js
-Repository is a mechanism that encapsulates all database operations related to a specific model. It provides methods for querying, inserting, updating, and deleting records in the database associated with the model.
+Repository is a mechanism that encapsulates all database operations related to a specific model. 
+It provides methods for querying, inserting, updating, and deleting records in the database associated with the model.
 
 ** The Repository check always type safety if model is used the type of schema 
 
@@ -2656,6 +2794,7 @@ import { Schema , Blueprint , DB } from 'tspace-mysql'
 (async () => {
     await new Schema().table('users', {
         id           : new Blueprint().int().notNull().primary().autoIncrement(),
+        // or id     : new Blueprint().serial().primary(),
         uuid         : new Blueprint().varchar(120).null()
         name         : new Blueprint().varchar(120).default('name'),
         email        : new Blueprint().varchar(255).unique().notNull(),

package/build/lib/core/Abstracts/AbstractModel.d.ts

@@ -58,17 +58,19 @@ declare abstract class AbstractModel<T, R> extends Builder {
     abstract registry(func: Record<string, Function>): this;
     abstract onlyTrashed(): this;
     abstract trashed(): this;
-    abstract restore(): Promise<any[]>;
+    abstract restore(): Promise<T[]>;
     abstract with<K extends R extends object ? keyof R : string>(...nameRelations: K[]): this;
     abstract withQuery<K extends R extends object ? keyof R : string, TModel extends Model>(nameRelations: K, callback: (query: TModel) => TModel): this;
     abstract withExists<K extends R extends object ? keyof R : string>(...nameRelations: K[]): this;
     abstract withTrashed<K extends R extends object ? keyof R : string>(...nameRelations: K[]): this;
     abstract withAll<K extends R extends object ? keyof R : string>(...nameRelations: K[]): this;
+    abstract withCount<K extends R extends object ? keyof R : string>(...nameRelations: K[]): this;
     abstract has<K extends R extends object ? keyof R : string>(...nameRelations: K[]): this;
     abstract relations<K extends R extends object ? keyof R : string>(...nameRelations: K[]): this;
-    abstract TRelationQueryOptions<K extends R extends object ? keyof R : string, TModel extends Model>(nameRelations: K, callback: (query: TModel) => TModel): this;
+    abstract relationQuery<K extends R extends object ? keyof R : string, TModel extends Model>(nameRelations: K, callback: (query: TModel) => TModel): this;
     abstract relationsExists<K extends R extends object ? keyof R : string>(...nameRelations: K[]): this;
     abstract relationsAll<K extends R extends object ? keyof R : string>(...nameRelations: K[]): this;
+    abstract relationsCount<K extends R extends object ? keyof R : string>(...nameRelations: K[]): this;
     abstract relationsTrashed<K extends R extends object ? keyof R : string>(...nameRelations: K[]): this;
 }
 export { AbstractModel };

package/build/lib/core/Abstracts/AbstractModel.js.map

@@ -1 +1 @@
-{"version":3,"file":"AbstractModel.js","sourceRoot":"","sources":["../../../../src/lib/core/Abstracts/AbstractModel.ts"],"names":[],"mappings":";;;AAEA,wCAAoC;AAIpC,MAAe,aAAmB,SAAQ,iBAAO;CAuEhD;AAEQ,sCAAa;AACtB,kBAAe,aAAa,CAAA"}
+{"version":3,"file":"AbstractModel.js","sourceRoot":"","sources":["../../../../src/lib/core/Abstracts/AbstractModel.ts"],"names":[],"mappings":";;;AAEA,wCAAoC;AAIpC,MAAe,aAAmB,SAAQ,iBAAO;CAyEhD;AAEQ,sCAAa;AACtB,kBAAe,aAAa,CAAA"}

package/build/lib/core/Blueprint.d.ts

@@ -21,81 +21,103 @@ declare class Blueprint<T = any> {
     private _column;
     private _valueType;
     /**
-     * Assign type 'int' in table
+     * Assign type 'serial' in table
      * @static
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
+     */
+    static serial(_?: number): Blueprint<number>;
+    /**
+     * Assign type 'serial' in table
+     * @return {Blueprint<T>} Blueprint
+     */
+    serial(_?: number): Blueprint<number>;
+    /**
+     * Assign type 'INT' in table
+     * @static
+     * @return {Blueprint<T>} Blueprint
      */
     static int(_?: number): Blueprint<number>;
     /**
-     * Assign type 'int' in table
-     * @return {this} this
+     * Assign type 'INT' in table
+     * @return {Blueprint<T>} Blueprint
      */
     int(_?: number): Blueprint<number>;
     /**
      * Assign type 'TINYINT' in table
      * @static
      * @param {number} number
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
-    static tinyInt(number?: number): Blueprint<number>;
+    static tinyInt(number?: number): Blueprint<number | boolean>;
     /**
      * Assign type 'TINYINT' in table
      * @param {number} number
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
-    tinyInt(number?: number): Blueprint<number>;
+    tinyInt(number?: number): Blueprint<number | boolean>;
     /**
      * Assign type 'TINYINT' in table
      * @static
      * @param {number} number
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
-    static tinyint(number?: number): Blueprint<number>;
+    static tinyint(number?: number): Blueprint<number | boolean>;
     /**
      * Assign type 'TINYINT' in table
      * @param {number} number
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
-    tinyint(number?: number): Blueprint<number>;
+    tinyint(number?: number): Blueprint<number | boolean>;
     /**
      * Assign type 'BIGINT' in table
      * @static
      * @param {number} number [number = 10]
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     static bigInt(number?: number): Blueprint<number>;
     /**
      * Assign type 'BIGINT' in table
      * @param {number} number [number = 10]
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     bigInt(number?: number): Blueprint<number>;
     /**
      * Assign type 'BIGINT' in table
      * @static
      * @param {number} number [number = 10]
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     static bigint(number?: number): Blueprint<number>;
     /**
      * Assign type 'BIGINT' in table
      * @param {number} number [number = 10]
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     bigint(number?: number): Blueprint<number>;
+    /**
+     * Assign type 'BOOLEAN' in table
+     * @static
+     * @return {Blueprint<T>} Blueprint
+     */
+    static boolean(): Blueprint<number | boolean>;
+    /**
+     * Assign type 'BOOLEAN' in table
+     * @return {Blueprint<T>} Blueprint
+     */
+    boolean(): Blueprint<number | boolean>;
     /**
      * Assign type 'DOUBLE' in table
      * @static
      * @param {number} length  between 1-255
      * @param {number} decimal  0.000...n
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     static double(length?: number, decimal?: number): Blueprint<number>;
     /**
      * Assign type 'DOUBLE' in table
      * @param {number} length  between 1-255
      * @param {number} decimal  0.000...n
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     double(length?: number, decimal?: number): Blueprint<number>;
     /**
@@ -103,249 +125,260 @@ declare class Blueprint<T = any> {
      * @static
      * @param {number} length  between 1-255
      * @param {number} decimal 0.000...n
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     static float(length?: number, decimal?: number): Blueprint<number>;
     /**
      * Assign type 'FLOAT' in table
      * @param {number} length  between 1-255
      * @param {number} decimal 0.000...n
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     float(length?: number, decimal?: number): Blueprint<number>;
     /**
      * Assign type 'VARCHAR' in table
      * @static
      * @param {number} length  [length = 191] length of string
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     static varchar(length?: number): Blueprint<string>;
     /**
      * Assign type 'VARCHAR' in table
      * @param {number} length  [length = 191] length of string
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     varchar(length?: number): Blueprint<string>;
     /**
      * Assign type 'CHAR' in table
      * @static
      * @param {number} length [length = 1] length of string
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     static char(length?: number): Blueprint<string>;
     /**
      * Assign type 'CHAR' in table
      * @param {number} length [length = 1] length of string
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     char(length?: number): Blueprint<string>;
     /**
      * Assign type 'LONGTEXT' in table
      * @static
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     static longText(): Blueprint<string>;
     /**
      * Assign type 'LONGTEXT' in table
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     longText(): Blueprint<string>;
+    /**
+     * Assign type 'BINARY' in table
+     * @static
+     * @return {Blueprint<T>} Blueprint
+     */
+    static binary(): Blueprint<string>;
+    /**
+     * Assign type 'BINARY' in table
+     * @return {Blueprint<T>} Blueprint
+     */
+    binary(): Blueprint<string>;
     /**
      * Assign type 'LONGTEXT' in table
      * @static
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     static longtext(): Blueprint<string>;
     /**
      * Assign type 'LONGTEXT' in table
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     longtext(): Blueprint<string>;
     /**
      * Assign type 'JSON' in table
      * @static
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     static json(): Blueprint<string>;
     /**
      * Assign type 'JSON' in table
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     json(): Blueprint<string>;
     /**
      * Assign type 'MEDIUMTEXT' in table
      * @static
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     static mediumText(): Blueprint<string>;
     /**
      * Assign type 'MEDIUMTEXT' in table
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     mediumText(): Blueprint<string>;
     /**
      * Assign type 'MEDIUMTEXT' in table
      * @static
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     static mediumtext(): Blueprint<string>;
     /**
      * Assign type 'MEDIUMTEXT' in table
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     mediumtext(): Blueprint<string>;
     /**
      * Assign type 'TINYTEXT' in table
      * @static
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     static tinyText(): Blueprint<string>;
     /**
      * Assign type 'TINYTEXT' in table
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     tinyText(): Blueprint<string>;
     /**
      * Assign type 'TINYTEXT' in table
      * @static
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     static tinytext(): Blueprint<string>;
     /**
      * Assign type 'TINYTEXT' in table
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     tinytext(): Blueprint<string>;
     /**
      * Assign type 'TEXT' in table
      * @static
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     static text(): Blueprint<string>;
     /**
      * Assign type 'TEXT' in table
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     text(): Blueprint<string>;
     /**
      * Assign type 'ENUM'
      * @static
      * @param {...string} enums n1, n2, n3, ...n
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     static enum(...enums: Array<string>): Blueprint<string>;
     /**
      * Assign type 'ENUM'
      * @param {...string} enums n1, n2, n3, ...n
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     enum(...enums: Array<string>): Blueprint<string>;
     /**
      * Assign type 'DATE' in table
      * @static
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     static date(): Blueprint<Date | string>;
     /**
      * Assign type 'DATE' in table
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     date(): Blueprint<Date | string>;
     /**
      * Assign type 'DATETIME' in table
      * @static
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     static dateTime(): Blueprint<Date | string>;
     /**
      * Assign type 'DATETIME' in table
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     dateTime(): Blueprint<Date | string>;
     /**
      * Assign type 'DATETIME' in table
      * @static
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     static datetime(): Blueprint<Date | string>;
     /**
      * Assign type 'DATETIME' in table
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     datetime(): Blueprint<Date | string>;
     /**
      * Assign type 'TIMESTAMP' in table
      * @static
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
-    static timestamp(): Blueprint<Date | string>;
+    static timestamp(): Blueprint<Date>;
     /**
      * Assign type 'TIMESTAMP' in table
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
-    timestamp(): Blueprint<Date | string>;
+    timestamp(): Blueprint<Date>;
     /**
      * Assign attributes 'UNSIGNED' in table
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     unsigned(): Blueprint<T>;
     /**
      * Assign attributes 'UNIQUE' in table
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     unique(): Blueprint<T>;
     /**
      * Assign attributes 'NULL' in table
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     null(): Blueprint<T | null>;
     /**
      * Assign attributes 'NOT NULL' in table
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     notNull(): Blueprint<T>;
     /**
      * Assign attributes 'NOT NULL' in table
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     notnull(): Blueprint<T>;
     /**
      * Assign attributes 'PRIMARY KEY' in table
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     primary(): Blueprint<T>;
     /**
      * Assign attributes 'default' in table
      * @param {string | number} value  default value
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     default(value: string | number): Blueprint<T>;
     /**
      * Assign attributes 'defaultValue' in table
      * @param {string | number} value  default value
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     defaultValue(value: string | number): Blueprint<T>;
     /**
      * Assign attributes 'default currentTimestamp' in table
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     currentTimestamp(): Blueprint<T>;
     /**
      * Assign attributes 'default currentTimestamp' in table
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     currenttimestamp(): Blueprint<T>;
     /**
      * Assign attributes 'autoIncrement' in table
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
-    autoIncrement(): Blueprint<T | null>;
+    autoIncrement(): Blueprint<T>;
     /**
      * Assign attributes 'autoIncrement' in table
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
-    autoincrement(): Blueprint<T | null>;
+    autoincrement(): Blueprint<T>;
     /**
      * Assign attributes 'foreign' in table
      * Reference bettwen Column Main to Column Child
@@ -354,7 +387,7 @@ declare class Blueprint<T = any> {
      * @property {Model | string}  property.on
      * @property {string?} property.onDelete
      * @property {string?}  property.onUpdate
-     * @return {this} this
+     * @return {Blueprint<T>} Blueprint
      */
     foreign({ references, on, onDelete, onUpdate }: {
         references?: string;