tspace-mysql 1.5.4 → 1.5.6

package/README.md

@@ -19,6 +19,7 @@ npm install tspace-mysql -g
 - [Configuration](#configuration)
 - [Query Builder](#query-builder)
   - [Returning Results](#returning-results)
+  - [Query Statement](#query-statements)
   - [Select Statements](#select-statements)
   - [Raw Expressions](#raw-expressions)
   - [Ordering, Grouping, Limit and Offset](#ordering-grouping-limit-and-offset)
@@ -32,6 +33,7 @@ npm install tspace-mysql -g
   - [Basic Where Clauses](#basic-where-clauses)
     - [Where Clauses](#where-clauses)
     - [Or Where Clauses](#or-where-clauses)
+    - [Where Object Clauses](#where-object-clauses)
     - [JSON Where Clauses](#json-where-clauses)
     - [Additional Where Clauses](#additional-where-clauses)
     - [Logical Grouping](#logical-grouping)
@@ -207,6 +209,19 @@ const users = await new DB("users").makeUpdateStatement() // query string for up
 const users = await new DB("users").makeDeleteStatement() // query string for delete statement
 
 const users = await new DB("users").makeCreateTableStatement() // query string for create table statement
+
+```
+
+## Query Statements
+
+```js
+const query = await DB.query(
+  "SELECT * FROM users WHERE id = :id AND email IS :email AND name IN :username", {
+  id : 1,
+  email : null,
+  username : ['name1','name2']
+})
+// SELECT * FROM users WHERE id = '1' AND email IS NULL AND username in ('name1','name2');
 ```
 
 ## Select Statements
@@ -386,6 +401,30 @@ const users = await new DB("users")
 // ( `users`.`id` <> '2' AND `users`.`username` = 'try to find' AND `users`.`email` = 'find@example.com');
 ```
 
+### Where Object Clauses
+
+```js
+const whereObject = await new DB("users")
+  .whereObject({
+    id : DB.op('eq',1),
+    username : DB.op('in',['user1','user2']),
+    name : DB.op('like','%value%')
+  })
+   .findMany();
+
+// You can also use .where as well.
+const where = await new DB("users")
+  .where({
+    id : DB.op('eq',1),
+    username : DB.op('in',['user1','user2']),
+    name : DB.op('like','%value%')
+  })
+   .findMany();
+
+// SELECT * FROM `users` WHERE `users`.`id` = '1' AND `users`.`username` IN ('user1','user2') AND `users`.`name` LIKE '%value%';
+
+```
+
 ### JSON Where Clauses
 
 ```js
@@ -1085,7 +1124,7 @@ tspace-mysql make:model <model name> --dir=< directory >
 
 ## Model Conventions
 
-Models generated by the make:model command will be placed in the specific directory.
+Your database schema using models. These models represent tables in the database
 Let's example a basic model class:
 
 ```js
@@ -1181,7 +1220,7 @@ class User extends Model {
       super()
       // By default, the model knows that the table name for this User is 'users'
 
-      this.useTable('fixtable') // fixtable
+      this.useTable('fix_table') // fixtable
       this.useTablePlural() // users
       this.useTableSingular() // user
     }
@@ -1201,7 +1240,6 @@ class UserPhone extends Model {
       // The table name is user_phones
       this.useSnakeCase()
 
-
       this.useCamelCase()
        // The table name is userPhones
     }
@@ -1220,10 +1258,10 @@ const userPhone = await new UserPhone().where('user_id',1).findOne()
 
 import { Model } from 'tspace-mysql'
 class User extends Model {
-    constructor() {
-      super()
-      this.useUUID() // insert uuid when creating
-    }
+  constructor() {
+    super()
+    this.useUUID() // insert uuid when creating
+  }
 }
 
 ```
@@ -1234,21 +1272,21 @@ class User extends Model {
 
 import { Model } from 'tspace-mysql'
 class User extends Model {
-    constructor() {
-      super()
-      // insert created_at and updated_at when creating
-      // update updated_at when updating
-      // 'created_at' and 'updated_at' still relate to pettern the model
-      // this.useCamelCase() will covert 'created_at' to 'createdAt' and 'updated_at' to 'updatedAt'
-      this.useTimestamp() 
-
-      // custom the columns
-      this.useTimestamp({
-       createdAt : 'createdAtCustom',
-       updatedAt : 'updatedAtCustom'
-      })
+  constructor() {
+    super()
+    // insert created_at and updated_at when creating
+    // update updated_at when updating
+    // 'created_at' and 'updated_at' still relate to pettern the model
+    // this.useCamelCase() will covert 'created_at' to 'createdAt' and 'updated_at' to 'updatedAt'
+    this.useTimestamp() 
+
+    // custom the columns
+    this.useTimestamp({
+      createdAt : 'createdAtCustom',
+      updatedAt : 'updatedAtCustom'
+    })
 
-    }
+  }
 }
 
 ```
@@ -1352,8 +1390,8 @@ class User extends Model {
       super()
       this.useSoftDelete() // All query will be where 'deleted_at' is null
 
-      // you can also use patterns camelCase to covert the 'deleted_at' to 'deletedAt'
-      // you can also customize the  column 'deleted_at'
+      // You can also use patterns camelCase to covert the 'deleted_at' to 'deletedAt'
+      // You can also customize the  column 'deleted_at'
       this.useSoftDelete('deletedAtCustom')
     }
 }
@@ -1400,7 +1438,7 @@ export default User
 +--------------------------------------------------------------------------+
 
 import User from '../User'
-const user = await new User().relations('phone').findOne() // can use the method .with('roles') also
+const user = await new User().relations('phone').findOne() // You can also use the method .with('roles').
 // user?.phone => {...}
 const userUsingFunction = await new User().phone().findOne()
 // userUsingFunction?.phone => {...}
@@ -1983,7 +2021,7 @@ await Schema.sync(`/src/Models`, {
   changed: true,
 });
 
-// also you can sync by Model
+// You can also synchronize using the Model.
 await new User().sync({ force: true, foreign: true, changed: true });
 ```
 
@@ -2007,11 +2045,11 @@ const schemaUser = {
     updatedAt :new Blueprint().timestamp().null()
 }
 
-type SchemaUserType = SchemaType<typeof schemaUser>
+type TSchemaUser = SchemaType<typeof schemaUser>
 
-// you can re-assign type for schema
+// You can also reassign the type for the schema
 /**
-  type SchemaUserType = SchemaType<typeof schemaUser , {
+  type TSchemaUser = SchemaType<typeof schemaUser , {
       id : number,
       uuid : string,
       ...
@@ -2019,7 +2057,7 @@ type SchemaUserType = SchemaType<typeof schemaUser>
 
 */
 
-class User extends Model<SchemaUserType>  { // add this type for the Model
+class User extends Model<TSchemaUser>  { // Add this '<TSchemaUser>' to activate the type for the Model.
   constructor() {
     super()
     this.useSchema(schemaUser)
@@ -2028,7 +2066,7 @@ class User extends Model<SchemaUserType>  { // add this type for the Model
   }
 }
 
-export { User , SchemaUserType }
+export { User , TSchemaUser }
 export default User
 
 +--------------------------------------------------------------------------+
@@ -2045,9 +2083,9 @@ const schemaPhone = {
     updatedAt :new Blueprint().timestamp().null()
 }
 
-type SchemaPhoneType = SchemaType<typeof schemaPhone>
+type TSchemaPhone = SchemaType<typeof schemaPhone>
 
-class Phone extends Model<SchemaPhoneType>  {
+class Phone extends Model<TSchemaPhone>  {
   constructor() {
     super()
     this.useSchema(schemaPhone)
@@ -2055,7 +2093,7 @@ class Phone extends Model<SchemaPhoneType>  {
   }
 }
 
-export { Phone , SchemaPhoneType }
+export { Phone , TSchemaPhone }
 export default Phone
 
 +--------------------------------------------------------------------------+
@@ -2064,8 +2102,8 @@ export default Phone
 ### Safety Select
 
 ```js
-import { User , schemaUserType } from './User.ts'
-import { Phone, schemaPhoneType } from './Phone.ts'
+import { User , TSchemaUser } from './User.ts'
+import { Phone, TSchemaPhone } from './Phone.ts'
 
 const users = await new User().select('id','username').findMany() ✅
 const users = await new User().select('idx','username').findMany() ❌
@@ -2079,8 +2117,8 @@ const users = await new User().except('idx','username').findMany() ❌
 
 ```js
 
-import { User , schemaUserType } from './User.ts'
-import { Phone, schemaPhoneType } from './Phone.ts'
+import { User , TSchemaUser } from './User.ts'
+import { Phone, TSchemaPhone } from './Phone.ts'
 
 const users = await new User().orderBy('id','DESC').findMany() ✅
 const users = await new User().orderBy('idx','DESC').findMany() ❌
@@ -2096,8 +2134,8 @@ const users = await new User().oldest('idx').findMany() ❌
 ### Safety GroupBy
 
 ```js
-import { User , schemaUserType } from './User.ts'
-import { Phone, schemaPhoneType } from './Phone.ts'
+import { User , TSchemaUser } from './User.ts'
+import { Phone, TSchemaPhone } from './Phone.ts'
 
 const users = await new User().groupBy('id').findMany() ✅
 const users = await new User().groupBy('idx').findMany() ❌
@@ -2107,8 +2145,8 @@ const users = await new User().groupBy('idx').findMany() ❌
 ### Safety Where
 
 ```js
-import { User , schemaUserType } from './User.ts'
-import { Phone, schemaPhoneType } from './Phone.ts'
+import { User , TSchemaUser } from './User.ts'
+import { Phone, TSchemaPhone } from './Phone.ts'
 
 const users = await new User().where('id',1).findMany() ✅
 const users = await new User().where('idxx',1).findMany() ❌
@@ -2145,8 +2183,8 @@ const users = await new User()
 ### Safety Insert
 
 ```js
-import { User , schemaUserType } from './User.ts'
-import { Phone, schemaPhoneType } from './Phone.ts'
+import { User , TSchemaUser } from './User.ts'
+import { Phone, TSchemaPhone } from './Phone.ts'
 
 const users = await new User().create({ id : 10 }).save() ✅
 
@@ -2157,8 +2195,8 @@ const users = await new User().create({ idx : 10 }).save() ❌
 ### Safety Update
 
 ```js
-import { User , schemaUserType } from './User.ts'
-import { Phone, schemaPhoneType } from './Phone.ts'
+import { User , TSchemaUser } from './User.ts'
+import { Phone, TSchemaPhone } from './Phone.ts'
 
 const users = await new User().update({ id : 10 }).where('id',1).save() ✅
 const users = await new User().update({ id : 10 }).where('idx',1).save() ❌
@@ -2169,8 +2207,8 @@ const users = await new User().update({ idx : 10 }).where('idx',1).save() ❌
 ### Safety Delete
 
 ```js
-import { User , schemaUserType } from './User.ts'
-import { Phone, schemaPhoneType } from './Phone.ts'
+import { User , TSchemaUser } from './User.ts'
+import { Phone, TSchemaPhone } from './Phone.ts'
 
 const users = await new User().where('id',1).delete() ✅
 const users = await new User().where('idx',1).delete() ❌
@@ -2192,7 +2230,7 @@ import { Phone } from './Phone.ts'
     user.phones ❌
   }
 
-// You can also specify the type for the results
+// You can also specify the type for the results.
 // bad 👎👎👎
   const users = await new User()
   .relations('phone','phones')
@@ -2210,15 +2248,15 @@ import { Phone } from './Phone.ts'
 // good 👍👍👍
 const users = await new User()
 .relations('phone','phones')
-.findMany<{ phone : schemaPhoneType , phones : schemaPhoneType[] }>()
+.findMany<{ phone : TSchemaPhone , phones : TSchemaPhone[] }>()
 
 for(const user of users) {
   user.phone  ✅
   user.phones ✅
-  user.phone.id  ✅
-  user.phone.idx ❌
-  user.phones.map(phone => phone.id) ✅
-  user.phones.map(phone => phone.idx) ❌
+  user.phone?.id  ✅
+  user.phone?.idx ❌
+  user.phones.map(phone => phone?.id) ✅
+  user.phones.map(phone => phone?.idx) ❌
 }
 
 +--------------------------------------------------------------------------+
@@ -2228,14 +2266,14 @@ for(const user of users) {
   .relations('phone','phones')
   .relationQuery('phone' , (query : Phone) => query.relations('user'))
   .relationQuery('phones' , (query : Phone) => query.relations('user'))
-  .findMany<{ phone : schemaPhoneType , phones : schemaPhoneType[] }>()
+  .findMany<{ phone : TSchemaPhone , phones : TSchemaPhone[] }>()
 
   for(const user of users) {
     user.phone.user ❌
     user.phones.map(phone =>phone.user) ❌
   }
 
-  // You can also specify the type for the results
+  // You can also specify the type for the results.
   // bad 👎👎👎
   const users = await new User()
   .relations('phone','phones')
@@ -2256,8 +2294,8 @@ for(const user of users) {
   .relationQuery('phone' , (query : Phone) => query.relations('user'))
   .relationQuery('phones' , (query : Phone) => query.relations('user'))
   .findMany<{ 
-    phone : Partial<SchemaPhoneType> & { user : SchemaUserType};
-    phones : (Partial<SchemaPhoneType> & { user : SchemaUserType})[];
+    phone : Partial<TSchemaPhone> & { user : TSchemaUser};
+    phones : (Partial<TSchemaPhone> & { user : TSchemaUser})[];
   }>()
 
   for(const user of users) {
@@ -2273,7 +2311,7 @@ for(const user of users) {
 // If you don't want to set types for every returning method such as 'findOne', 'findMany', and so on...
 
 import { Model , Blueprint , SchemaType , RelationType } from 'tspace-mysql'
-import { Phone , SchemaPhoneType }  from '../Phone'
+import { Phone , TSchemaPhone }  from '../Phone'
 
 const schemaUser = {
     id :new Blueprint().int().notNull().primary().autoIncrement(),
@@ -2286,14 +2324,15 @@ const schemaUser = {
     updatedAt :new Blueprint().timestamp().null()
 }
 
-type SchemaUserType = SchemaType<typeof schemaUser>
+type TSchemaUser = SchemaType<typeof schemaUser>
 
 type RelationUserType =  RelationType<{
-    phones : SchemaPhoneType[]
-    phone : SchemaPhoneType
+  phones : TSchemaPhone[]
+  phone : TSchemaPhone
 }>
 
-class User extends Model<SchemaUserType, RelationUserType>  {
+// Add this '<TSchemaUser, RelationUserType>' to activate the type for the Model.
+class User extends Model<TSchemaUser, RelationUserType>  { 
   constructor() {
     super()
     this.useSchema(schemaUser)
@@ -2304,7 +2343,7 @@ class User extends Model<SchemaUserType, RelationUserType>  {
   }
 }
 
-export { User , SchemaUserType }
+export { User , TSchemaUser }
 
 +--------------------------------------------------------------------------+
 
@@ -2320,13 +2359,13 @@ const schemaPhone = {
     updatedAt :new Blueprint().timestamp().null()
 }
 
-type SchemaPhoneType = SchemaType<typeof schemaPhone>
+type TSchemaPhone = SchemaType<typeof schemaPhone>
 
 type RelationPhoneType = RelationType<{
-    user : SchemaPhoneType[]
+  user : TSchemaUser[]
 }>
 
-class Phone extends Model<SchemaPhoneType,RelationPhoneType>  {
+class Phone extends Model<TSchemaPhone,RelationPhoneType>  {
   constructor() {
     super()
     this.useSchema(schemaPhone)
@@ -2335,7 +2374,7 @@ class Phone extends Model<SchemaPhoneType,RelationPhoneType>  {
   }
 }
 
-export { Phone , SchemaPhoneType }
+export { Phone , TSchemaPhone }
 
 +--------------------------------------------------------------------------+
 

package/build/lib/Interface.d.ts

@@ -167,17 +167,29 @@ export interface GlobalSetting {
     logger?: boolean;
 }
 export interface Operator {
-    equals: string;
-    notEquals: string;
-    greaterThan: string;
-    lessThan: string;
-    greaterThanOrEqual: string;
-    lessThanOrEqual: string;
+    eq: string;
+    notEq: string;
+    more: string;
+    less: string;
+    moreOrEq: string;
+    lessOrEq: string;
     like: string;
     notLike: string;
     in: string;
     notIn: string;
     isNull: string;
     isNotNull: string;
+    '|eq': string;
+    '|notEq': string;
+    '|more': string;
+    '|less': string;
+    '|moreOrEq': string;
+    '|lessOrEq': string;
+    '|like': string;
+    '|notLike': string;
+    '|in': string;
+    '|notIn': string;
+    '|isNull': string;
+    '|isNotNull': string;
 }
 export type PoolEvent = 'CONNECTION' | 'RELEASE' | 'QUERY' | 'SLOW_QUERY' | 'SELECT' | 'INSERT' | 'UPDATE' | 'DELETE';

package/build/lib/constants/index.js

@@ -49,6 +49,7 @@ const CONSTANTS = Object.freeze({
     KEY: 'KEY',
     RAW: '$RAW:',
     OP: '$OP:',
+    VALUE: '$VALUE:',
     IGNORE: '$IGNORE',
     WHEN: 'WHEN',
     THEN: 'THEN',

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

@@ -28,7 +28,7 @@ declare abstract class AbstractModel<T, R> extends Builder {
         updated: Function;
         deleted: Function;
     }) | undefined;
-    protected abstract column<K extends keyof T>(key: K): K;
+    protected abstract column<K extends keyof T | `${string}.${string}`>(key: K): K;
     protected abstract useUUID(): this;
     protected abstract usePrimaryKey(primaryKey: string): this;
     protected abstract useRegistry(): this;

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

@@ -2,6 +2,12 @@ import { AbstractBuilder } from './Abstracts/AbstractBuilder';
 import { Pagination, ConnectionOptions, Connection, ConnectionTransaction, NonEmptyArray } from '../Interface';
 declare class Builder extends AbstractBuilder {
     constructor();
+    /**
+     * The 'instance' method is used get instance.
+     * @static
+     * @return {Builder} instance of the Builder
+     */
+    static get instance(): Builder;
     /**
      * The 'distinct' method is used to apply the DISTINCT keyword to a database query.
      *
@@ -976,13 +982,6 @@ declare class Builder extends AbstractBuilder {
      * @return {promise<any>}
      */
     rawQuery(sql: string): Promise<any>;
-    /**
-     * This 'query' method is used to execute sql statement
-     *
-     * @param {string} sql
-     * @return {promise<any>}
-     */
-    query(sql: string): Promise<any>;
     /**
      *
      * plus value then update
@@ -1343,6 +1342,10 @@ declare class Builder extends AbstractBuilder {
     private _insertNotExists;
     private _insert;
     protected _checkValueHasRaw(value: any): string;
+    protected _checkValueHasOp(str: string): {
+        op: string;
+        value: string;
+    } | null;
     private _insertMultiple;
     private _insertOrSelect;
     private _updateOrInsert;

package/build/lib/core/Builder.js

@@ -26,11 +26,20 @@ const utils_1 = require("../utils");
 const constants_1 = require("../constants");
 const DB_1 = require("./DB");
 const connection_1 = require("../connection");
+const State_1 = require("./Handlers/State");
 class Builder extends AbstractBuilder_1.AbstractBuilder {
     constructor() {
         super();
         this._initialConnection();
     }
+    /**
+     * The 'instance' method is used get instance.
+     * @static
+     * @return {Builder} instance of the Builder
+     */
+    static get instance() {
+        return new this();
+    }
     /**
      * The 'distinct' method is used to apply the DISTINCT keyword to a database query.
      *
@@ -350,15 +359,60 @@ class Builder extends AbstractBuilder_1.AbstractBuilder {
         for (const column in columns) {
             const operator = '=';
             const value = this.$utils.escape(columns[column]);
-            this.$state.set('WHERE', [
-                ...this.$state.get('WHERE'),
-                [
-                    this.$state.get('WHERE').length ? `${this.$constants('AND')}` : '',
-                    `${this.bindColumn(String(column))}`,
-                    `${operator}`,
-                    `${this._checkValueHasRaw(value)}`
-                ].join(' ')
-            ]);
+            const useOp = this._checkValueHasOp(value);
+            if (useOp == null) {
+                this.$state.set('WHERE', [
+                    ...this.$state.get('WHERE'),
+                    [
+                        this.$state.get('WHERE').length ? `${this.$constants('AND')}` : '',
+                        `${this.bindColumn(String(column))}`,
+                        `${operator}`,
+                        `${this._checkValueHasRaw(value)}`
+                    ].join(' ')
+                ]);
+                return this;
+            }
+            switch (useOp.op) {
+                case 'IN': {
+                    this.whereIn(column, Array.isArray(useOp.value) ? useOp.value : useOp.value.split(','));
+                    break;
+                }
+                case '|IN': {
+                    this.orWhereIn(column, Array.isArray(useOp.value) ? useOp.value : useOp.value.split(','));
+                    break;
+                }
+                case 'NOT IN': {
+                    this.whereNotIn(column, Array.isArray(useOp.value) ? useOp.value : useOp.value.split(','));
+                    break;
+                }
+                case '|NOT IN': {
+                    this.orWhereNotIn(column, Array.isArray(useOp.value) ? useOp.value : useOp.value.split(','));
+                    break;
+                }
+                case 'IS NULL': {
+                    this.whereNull(column);
+                    break;
+                }
+                case '|IS NULL': {
+                    this.orWhereNull(column);
+                    break;
+                }
+                case 'IS NOT NULL': {
+                    this.whereNotNull(column);
+                    break;
+                }
+                case '|IS NOT NULL': {
+                    this.orWhereNotNull(column);
+                    break;
+                }
+                default: {
+                    if (useOp.op.includes('|')) {
+                        this.orWhere(column, useOp.op.replace('|', ''), useOp.value);
+                        break;
+                    }
+                    this.where(column, useOp.op, useOp.value);
+                }
+            }
         }
         return this;
     }
@@ -2155,17 +2209,6 @@ class Builder extends AbstractBuilder_1.AbstractBuilder {
             return yield this._queryStatement(sql);
         });
     }
-    /**
-     * This 'query' method is used to execute sql statement
-     *
-     * @param {string} sql
-     * @return {promise<any>}
-     */
-    query(sql) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return yield this._queryStatement(sql);
-        });
-    }
     /**
      *
      * plus value then update
@@ -3355,9 +3398,26 @@ class Builder extends AbstractBuilder_1.AbstractBuilder {
         });
     }
     _checkValueHasRaw(value) {
-        return typeof value === 'string' && value.startsWith(this.$constants('RAW'))
+        const detectedValue = typeof value === 'string' && value.startsWith(this.$constants('RAW'))
             ? `${this.$utils.covertBooleanToNumber(value)}`.replace(this.$constants('RAW'), '')
             : `'${this.$utils.covertBooleanToNumber(value)}'`;
+        return detectedValue;
+    }
+    _checkValueHasOp(str) {
+        var _a;
+        if (!str.includes(this.$constants('OP')) || !str.includes(this.$constants('VALUE'))) {
+            return null;
+        }
+        const opRegex = new RegExp(`\\${this.$constants('OP')}\\(([^)]+)\\)`);
+        const valueRegex = new RegExp(`\\${this.$constants('VALUE')}\\(([^)]+)\\)`);
+        const opMatch = str.match(opRegex);
+        const valueMatch = str.match(valueRegex);
+        const op = opMatch ? opMatch[1] : '';
+        const value = valueMatch ? valueMatch[1] : '';
+        return {
+            op: op.replace(this.$constants('OP'), ''),
+            value: (_a = value === null || value === void 0 ? void 0 : value.replace(this.$constants('VALUE'), '')) !== null && _a !== void 0 ? _a : ''
+        };
     }
     _insertMultiple() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -3597,6 +3657,7 @@ class Builder extends AbstractBuilder_1.AbstractBuilder {
                 }
             };
         })();
+        this.$state = new State_1.StateHandler('default');
         this.$logger = (() => {
             let logger = [];
             return {