tspace-mysql 1.3.0 → 1.3.2

package/README.md

@@ -27,14 +27,14 @@ npm install tspace-mysql --save
   - [Belongs To](#belongs-to)
   - [Many To Many](#many-to-many)
   - [Relation in Relation](#relation-in-relation)
+  - [Built in Relation Functions](#built-in-relation-functions)
 - [Query Builder](#query-builder)
 - [Cli](#cli)
   - [Make Model](#make-model)
   - [Make Migration](#make-migration)
   - [Migrate](#migrate)
   - [Query](#query)
-  - [Generate Models](#generate-models)
-  - [Dump Database](#dump-database)
+  - [Menerate Models](#generate-models)
 - [Blueprint](#blueprint)
 
 ## Configuration
@@ -91,6 +91,8 @@ const selectQuery = await new DB('users').select('id','username').findOne()
 const selectQueries = await new DB('users').select('id','username').findMany() 
     // selectQueries => [{ id : 1, username : 'tspace' } , { id : 2, username : 'tspace2'}]
 
+const selectQueryRaw = await new DB('users').selectRaw('COUNT(id)').findMany() 
+
 /**
  * @example except
  */
@@ -125,8 +127,11 @@ const users = await new DB('users').where('id','!=',1).findMany()
 const whereIn = await new DB('users').whereIn('id',[1,2]).findMany()
 const whereBetween = await new DB('users').whereBetween('id',[1,2]).findMany()
 const whereSubQuery = await new DB('users').whereSubQuery('id','select id from users').findMany()
-// await new DB('users').whereSubQuery('id',new DB('users').select('id').toString()).findMany()
+// same As await new DB('users').whereSubQuery('id',new DB('users').select('id').toString()).findMany()
 const whereNull = await new DB('users').whereNull('username').findOne()
+const whereNotNull = await new DB('users').whereNotNull('username').findOne()
+const whereQuery = await new DB('users').whereQuery(query => query.where('id',1).where('username','tspace')).whereIn('id',[1,2]).findOne()
+    // SELECT * FROM `users` WHERE ( `users`.`id` = '1' AND `users`.`username` = 'tspace') AND `users`.`id` IN ('1','2'') LIMIT 1
 ```
 
 Running A Hook Query
@@ -173,12 +178,22 @@ const users = await new DB('users')
     .where('name','tspace4')
     .where('email','tspace4@gmail.com')
     .createNotExists({
-            name :'tspace4',
-            email : 'tspace4@gmail.com'
+        name :'tspace4',
+        email : 'tspace4@gmail.com'
     })
     .save()
     // if has exists return null, if not exists created new data
 
+const users = await new DB('users')
+    .where('name','tspace4')
+    .where('email','tspace4@gmail.com')
+    .createOrSelect({
+        name :'tspace4',
+        email : 'tspace4@gmail.com'
+    })
+    .save()
+    // if has exists return data, if not exists created new data
+
 ```
 Running A Update Query
 ```js
@@ -375,15 +390,17 @@ class User extends Model {
      * this.useTable('users')
      * this.useTableSingular() // 'user'
      * this.useTablePlural() // 'users'
-     * this.usePattern('snake_case') // by defalut snake_case
+     * this.usePattern('snake_case')   
      * this.useUUID('uuid') // => runing a uuid (universally unique identifier) when insert new data
      * this.useRegistry()
+     * this.useLoadRelationInRegistry()
+     * this.useBuiltInRelationFunctions()
      * this.useSchema({
      *   id : Number,
      *   username : String
      *   created_at : Date,
      *   updated_at : Date,
-     *  }) // validate type of schema when return result
+     *  }) // validate type of schema when return results
     */
 
     /*
@@ -589,6 +606,48 @@ await new User().relations('posts')
     .findMany()
 ```
 
+## Built in Relation Functions
+Relationships can using built in function in results 
+let's example a built in function :
+```js
+import { Model } from 'tspace-mysql'
+
+class User extends Model {
+    constructor(){
+        super()
+        this.hasMany({ name : 'posts' , model : Post })
+        this.useBuiltInRelationFunctions()
+    }
+}
++--------------------------------------------------------------------------+
+class Post extends Model {
+    constructor(){
+        super()
+        this.hasMany({ name : 'comments' , model : Comment })
+        this.belongsTo({ name : 'user' , model : User })
+        this.useBuiltInRelationFunctions()
+    }
+}
++--------------------------------------------------------------------------+
+class Comment extends Model {
+    constructor(){
+        super()
+        this.hasMany({ name : 'users' , model : User })
+        this.belongsTo({ name : 'post' , model : Post })
+        this.useBuiltInRelationFunctions()
+    }
+}
++--------------------------------------------------------------------------+
+const user = await new User().findOne()
+const posts = await user.$posts()
+
+/** Warning built in function has Big-O effect */
+for (const post of posts) {
+    const comments = await post.$comments()
+}
+
+```
+
 ## Query Builder
 Methods builder for queries
 ```js
@@ -612,6 +671,7 @@ orWhereRaw(sql)
 orWhereIn(column , [])
 orWhereSubQuery(colmn , rawSQL)
 select(column1 ,column2 ,...N)
+selectRaw(column1 ,column2 ,...N)
 except(column1 ,column2 ,...N)
 only(column1 ,column2 ,...N)
 hidden(column1 ,column2 ,...N)
@@ -620,10 +680,15 @@ rightJoin (primary key , table.foreign key)
 leftJoin (primary key , table.foreign key) 
 limit (limit)
 having (condition)
+havingRaw (condition)
 orderBy (column ,'ASC' || 'DSCE')
+orderByRaw(column ,'ASC' || 'DSCE')
 latest (column)
+latestRaw (column)
 oldest (column)
+oldestRaw (column)
 groupBy (column)
+groupByRaw (column)
 create(objects)
 createMultiple(array objects)
 update (objects)
@@ -777,13 +842,6 @@ tspace-mysql generate:models
 
 ```
 
-# Dump Database
-Command will be dump database to .sql
-```js
-tspace-mysql dump:db
-
-```
-
 ## Blueprint
 Schema table created by command make:migration,  you may use the:
 ```js

package/dist/cli/dump/db.d.ts

@@ -1,4 +1,4 @@
-declare const _default: (cmd: {
-    [x: string]: any;
-}) => void;
-export default _default;
+declare const _default: (cmd: {
+    [x: string]: any;
+}) => void;
+export default _default;

package/dist/cli/dump/db.js

@@ -1,25 +1,25 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const lib_1 = require("../../lib");
-exports.default = (cmd) => {
-    const { dir, cwd, fs, db, type } = cmd;
-    if (dir) {
-        try {
-            fs.accessSync(cwd + `/${dir}`, fs.F_OK, {
-                recursive: true
-            });
-        }
-        catch (e) {
-            fs.mkdirSync(cwd + `/${dir}`, {
-                recursive: true
-            });
-        }
-    }
-    const directory = `${cwd}/${dir}/dump_${+new Date()}.sql`;
-    new lib_1.DB().backupToFile({
-        filePath: directory,
-        database: db
-    })
-        .then(r => console.log('dump file successfully'))
-        .catch(err => console.log(err));
-};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const lib_1 = require("../../lib");
+exports.default = (cmd) => {
+    const { dir, cwd, fs, db } = cmd;
+    if (dir) {
+        try {
+            fs.accessSync(cwd + `/${dir}`, fs.F_OK, {
+                recursive: true
+            });
+        }
+        catch (e) {
+            fs.mkdirSync(cwd + `/${dir}`, {
+                recursive: true
+            });
+        }
+    }
+    const directory = `${cwd}/${dir}/dump_${+new Date()}.sql`;
+    new lib_1.DB().backupToFile({
+        filePath: directory,
+        database: db
+    })
+        .then(r => console.log('dump file successfully'))
+        .catch(err => console.log(err));
+};

package/dist/cli/generate/make.d.ts

@@ -1,4 +1,4 @@
-declare const _default: (cmd: {
-    [x: string]: any;
-}) => void;
-export default _default;
+declare const _default: (cmd: {
+    [x: string]: any;
+}) => void;
+export default _default;

package/dist/cli/generate/make.js

@@ -1,45 +1,45 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const model_1 = __importDefault(require("./model"));
-const pluralize_1 = __importDefault(require("pluralize"));
-const lib_1 = require("../../lib");
-exports.default = (cmd) => {
-    const { dir, cwd, type, fs, npm } = cmd;
-    if (dir) {
-        try {
-            fs.accessSync(cwd + `/${dir}`, fs.F_OK, {
-                recursive: true
-            });
-        }
-        catch (e) {
-            fs.mkdirSync(cwd + `/${dir}`, {
-                recursive: true
-            });
-        }
-    }
-    const snakeCaseToPascal = (data) => {
-        let str = data.split('_');
-        for (let i = 0; i < str.length; i++) {
-            str[i] = str[i].slice(0, 1).toUpperCase() + str[i].slice(1, str[i].length);
-        }
-        return str.join('');
-    };
-    new lib_1.DB().rawQuery('SHOW TABLES').then(tables => {
-        var _a;
-        for (let i = 0; i < tables.length; i++) {
-            const table = String((_a = Object.values(tables[i])) === null || _a === void 0 ? void 0 : _a.shift());
-            const model = snakeCaseToPascal(pluralize_1.default.singular(table));
-            const data = (0, model_1.default)(model, npm);
-            fs.writeFile(`${cwd}/${dir}/${model}${type !== null && type !== void 0 ? type : '.ts'}`, data, (err) => {
-                if (err)
-                    throw err;
-            });
-            console.log(`Model : '${model}' created successfully`);
-        }
-        console.log('\nGenerate Models has completed');
-    })
-        .catch(err => console.log(err));
-};
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const model_1 = __importDefault(require("./model"));
+const pluralize_1 = __importDefault(require("pluralize"));
+const lib_1 = require("../../lib");
+exports.default = (cmd) => {
+    const { dir, cwd, type, fs, npm } = cmd;
+    if (dir) {
+        try {
+            fs.accessSync(cwd + `/${dir}`, fs.F_OK, {
+                recursive: true
+            });
+        }
+        catch (e) {
+            fs.mkdirSync(cwd + `/${dir}`, {
+                recursive: true
+            });
+        }
+    }
+    const snakeCaseToPascal = (data) => {
+        let str = data.split('_');
+        for (let i = 0; i < str.length; i++) {
+            str[i] = str[i].slice(0, 1).toUpperCase() + str[i].slice(1, str[i].length);
+        }
+        return str.join('');
+    };
+    new lib_1.DB().rawQuery('SHOW TABLES').then(tables => {
+        var _a;
+        for (let i = 0; i < tables.length; i++) {
+            const table = String((_a = Object.values(tables[i])) === null || _a === void 0 ? void 0 : _a.shift());
+            const model = snakeCaseToPascal(pluralize_1.default.singular(table));
+            const data = (0, model_1.default)(model, npm);
+            fs.writeFile(`${cwd}/${dir}/${model}${type !== null && type !== void 0 ? type : '.ts'}`, data, (err) => {
+                if (err)
+                    throw err;
+            });
+            console.log(`Model : '${model}' created successfully`);
+        }
+        console.log('\nGenerate Models has completed');
+    })
+        .catch(err => console.log(err));
+};

package/dist/cli/generate/model.d.ts

@@ -1,2 +1,2 @@
-declare const Model: (model: string, npm: string) => string;
-export default Model;
+declare const Model: (model: string, npm: string) => string;
+export default Model;

package/dist/cli/generate/model.js

@@ -1,6 +1,6 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const Model = (model, npm) => {
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const Model = (model, npm) => {
     return `import { Model } from '${npm}'
 class ${model} extends Model {
   constructor(){
@@ -25,6 +25,6 @@ class ${model} extends Model {
 }
 export { ${model} }
 export default ${model}
-`;
-};
-exports.default = Model;
+`;
+};
+exports.default = Model;

package/dist/cli/index.d.ts

@@ -1,2 +1,2 @@
-#!/usr/bin/env node
-export {};
+#!/usr/bin/env node
+export {};

package/dist/cli/index.js

@@ -1,58 +1,58 @@
-#!/usr/bin/env node
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r;
-Object.defineProperty(exports, "__esModule", { value: true });
-const fs_1 = __importDefault(require("fs"));
-const make_1 = __importDefault(require("./models/make"));
-const make_2 = __importDefault(require("./tables/make"));
-const make_3 = __importDefault(require("./migrate/make"));
-const make_4 = __importDefault(require("./generate/make"));
-const query_1 = __importDefault(require("./query"));
-const db_1 = __importDefault(require("./dump/db"));
-const commands = {
-    'query': query_1.default,
-    'make:model': make_1.default,
-    'make:table': make_2.default,
-    'make:migration': make_2.default,
-    'migrate': make_3.default,
-    'generate:models': make_4.default,
-    'dump:db': db_1.default,
-};
-try {
-    const name = (_c = (_b = (_a = process.argv.slice(2)) === null || _a === void 0 ? void 0 : _a.find(data => {
-        return data === null || data === void 0 ? void 0 : data.includes('--name=');
-    })) === null || _b === void 0 ? void 0 : _b.replace('--name=', '')) !== null && _c !== void 0 ? _c : null;
-    const sql = (_d = process.argv.slice(3)[0]) !== null && _d !== void 0 ? _d : '';
-    const migrate = (_f = (_e = process.argv.slice(2)) === null || _e === void 0 ? void 0 : _e.includes('--m')) !== null && _f !== void 0 ? _f : false;
-    const dir = (_j = (_h = (_g = process.argv.slice(2)) === null || _g === void 0 ? void 0 : _g.find(data => {
-        return data === null || data === void 0 ? void 0 : data.includes('--dir=');
-    })) === null || _h === void 0 ? void 0 : _h.replace('--dir=', '/')) !== null && _j !== void 0 ? _j : null;
-    const db = (_m = (_l = (_k = process.argv.slice(2)) === null || _k === void 0 ? void 0 : _k.find(data => {
-        return data === null || data === void 0 ? void 0 : data.includes('--db=');
-    })) === null || _l === void 0 ? void 0 : _l.replace('--db=', '')) !== null && _m !== void 0 ? _m : null;
-    let type = (_q = (_p = (_o = process.argv.slice(2)) === null || _o === void 0 ? void 0 : _o.find(data => {
-        return data === null || data === void 0 ? void 0 : data.includes('--type=');
-    })) === null || _p === void 0 ? void 0 : _p.replace('--type=', '.')) !== null && _q !== void 0 ? _q : '.ts';
-    type = ['.js', '.ts'].includes(type) ? type : '.ts';
-    const file = (_r = process.argv.slice(3)[0]) !== null && _r !== void 0 ? _r : '';
-    const cmd = {
-        name,
-        file,
-        dir,
-        migrate,
-        type,
-        cwd: process.cwd(),
-        fs: fs_1.default,
-        sql,
-        db,
-        npm: 'tspace-mysql'
-    };
-    commands[process.argv[2]](cmd);
-}
-catch (err) {
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r;
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = __importDefault(require("fs"));
+const make_1 = __importDefault(require("./models/make"));
+const make_2 = __importDefault(require("./tables/make"));
+const make_3 = __importDefault(require("./migrate/make"));
+const make_4 = __importDefault(require("./generate/make"));
+const query_1 = __importDefault(require("./query"));
+const db_1 = __importDefault(require("./dump/db"));
+const commands = {
+    'query': query_1.default,
+    'make:model': make_1.default,
+    'make:table': make_2.default,
+    'make:migration': make_2.default,
+    'migrate': make_3.default,
+    'generate:models': make_4.default,
+    'dump:db': db_1.default,
+};
+try {
+    const name = (_c = (_b = (_a = process.argv.slice(2)) === null || _a === void 0 ? void 0 : _a.find(data => {
+        return data === null || data === void 0 ? void 0 : data.includes('--name=');
+    })) === null || _b === void 0 ? void 0 : _b.replace('--name=', '')) !== null && _c !== void 0 ? _c : null;
+    const sql = (_d = process.argv.slice(3)[0]) !== null && _d !== void 0 ? _d : '';
+    const migrate = (_f = (_e = process.argv.slice(2)) === null || _e === void 0 ? void 0 : _e.includes('--m')) !== null && _f !== void 0 ? _f : false;
+    const dir = (_j = (_h = (_g = process.argv.slice(2)) === null || _g === void 0 ? void 0 : _g.find(data => {
+        return data === null || data === void 0 ? void 0 : data.includes('--dir=');
+    })) === null || _h === void 0 ? void 0 : _h.replace('--dir=', '/')) !== null && _j !== void 0 ? _j : null;
+    const db = (_m = (_l = (_k = process.argv.slice(2)) === null || _k === void 0 ? void 0 : _k.find(data => {
+        return data === null || data === void 0 ? void 0 : data.includes('--db=');
+    })) === null || _l === void 0 ? void 0 : _l.replace('--db=', '')) !== null && _m !== void 0 ? _m : null;
+    let type = (_q = (_p = (_o = process.argv.slice(2)) === null || _o === void 0 ? void 0 : _o.find(data => {
+        return data === null || data === void 0 ? void 0 : data.includes('--type=');
+    })) === null || _p === void 0 ? void 0 : _p.replace('--type=', '.')) !== null && _q !== void 0 ? _q : '.ts';
+    type = ['.js', '.ts'].includes(type) ? type : '.ts';
+    const file = (_r = process.argv.slice(3)[0]) !== null && _r !== void 0 ? _r : '';
+    const cmd = {
+        name,
+        file,
+        dir,
+        migrate,
+        type,
+        cwd: process.cwd(),
+        fs: fs_1.default,
+        sql,
+        db,
+        npm: 'tspace-mysql'
+    };
+    commands[process.argv[2]](cmd);
+}
+catch (err) {
     console.log(`
         tspace-mysql make:model User --m --dir=app/Models  
         tspace-mysql make:migration users --dir=app/Models/Migrations
@@ -60,6 +60,6 @@ catch (err) {
         tspace-mysql query "SELECT * FROM users"
         tspace-mysql generate:models --dir=app/Models 
         tspace-mysql dump:db --dir=app/Models 
-    `);
-    console.log(`Read more https://www.npmjs.com/package/tspace-mysql`);
-}
+    `);
+    console.log(`Read more https://www.npmjs.com/package/tspace-mysql`);
+}

package/dist/cli/migrate/make.d.ts

@@ -1,4 +1,4 @@
-declare const _default: (formCommand: {
-    [x: string]: any;
-}) => void;
-export default _default;
+declare const _default: (formCommand: {
+    [x: string]: any;
+}) => void;
+export default _default;

package/dist/cli/migrate/make.js

@@ -1,30 +1,30 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const child_process_1 = require("child_process");
-exports.default = (formCommand) => {
-    var _a, _b, _c;
-    const { type, dir, cwd, fs } = formCommand;
-    try {
-        if (dir == null)
-            throw new Error('Not found directory');
-        const path = `${cwd}/${dir}`;
-        const files = (_a = fs.readdirSync(path)) !== null && _a !== void 0 ? _a : [];
-        if (!(files === null || files === void 0 ? void 0 : files.length))
-            console.log('this folder is empty');
-        const cmd = type === '.js' ? 'node' : 'ts-node';
-        for (const _file of files) {
-            const run = (0, child_process_1.exec)(`${cmd} ${path}/${_file}`);
-            (_b = run === null || run === void 0 ? void 0 : run.stdout) === null || _b === void 0 ? void 0 : _b.on('data', (data) => {
-                if (data)
-                    console.log(data);
-            });
-            (_c = run === null || run === void 0 ? void 0 : run.stderr) === null || _c === void 0 ? void 0 : _c.on('data', (err) => {
-                if (err)
-                    console.error(err);
-            });
-        }
-    }
-    catch (err) {
-        console.log(err.message);
-    }
-};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const child_process_1 = require("child_process");
+exports.default = (formCommand) => {
+    var _a, _b, _c;
+    const { type, dir, cwd, fs } = formCommand;
+    try {
+        if (dir == null)
+            throw new Error('Not found directory');
+        const path = `${cwd}/${dir}`;
+        const files = (_a = fs.readdirSync(path)) !== null && _a !== void 0 ? _a : [];
+        if (!(files === null || files === void 0 ? void 0 : files.length))
+            console.log('this folder is empty');
+        const cmd = type === '.js' ? 'node' : 'ts-node';
+        for (const _file of files) {
+            const run = (0, child_process_1.exec)(`${cmd} ${path}/${_file}`);
+            (_b = run === null || run === void 0 ? void 0 : run.stdout) === null || _b === void 0 ? void 0 : _b.on('data', (data) => {
+                if (data)
+                    console.log(data);
+            });
+            (_c = run === null || run === void 0 ? void 0 : run.stderr) === null || _c === void 0 ? void 0 : _c.on('data', (err) => {
+                if (err)
+                    console.error(err);
+            });
+        }
+    }
+    catch (err) {
+        console.log(err.message);
+    }
+};

package/dist/cli/models/make.d.ts

@@ -1,4 +1,4 @@
-declare const _default: (cmd: {
-    [x: string]: any;
-}) => void;
-export default _default;
+declare const _default: (cmd: {
+    [x: string]: any;
+}) => void;
+export default _default;