tspace-mysql 1.4.7 → 1.4.9

package/dist/lib/tspace/Blueprint.js

@@ -5,7 +5,7 @@ exports.Blueprint = void 0;
  * Make schema for table with Blueprint
  * @example
  *   import { Schema , Blueprint }  from 'tspace-mysql'
- *   await new Schema().table('persos1',{
+ *   await new Schema().table('users',{
  *      id          : new Blueprint().int().notNull().primary().autoIncrement(),
  *      name        : new Blueprint().varchar(255).default('my name'),
  *      email       : new Blueprint().varchar(255).unique(),
@@ -18,10 +18,10 @@ exports.Blueprint = void 0;
  */
 class Blueprint {
     constructor() {
-        this.type = 'INT';
-        this.attributes = [];
-        this.foreignKey = null;
-        this.valueType = String;
+        this._type = 'INT';
+        this._attributes = [];
+        this._foreignKey = null;
+        this._valueType = String;
     }
     /**
      * Assign type 'int' in table
@@ -29,7 +29,7 @@ class Blueprint {
      */
     int(_) {
         this._addAssignType('INT');
-        this.valueType = Number;
+        this._valueType = Number;
         return this;
     }
     /**
@@ -39,7 +39,7 @@ class Blueprint {
      */
     tinyInt(number = 1) {
         this._addAssignType(`TINYINT(${number})`);
-        this.valueType = Number;
+        this._valueType = Number;
         return this;
     }
     /**
@@ -49,7 +49,7 @@ class Blueprint {
      */
     tinyint(number = 1) {
         this._addAssignType(`TINYINT(${number})`);
-        this.valueType = Number;
+        this._valueType = Number;
         return this;
     }
     /**
@@ -59,7 +59,7 @@ class Blueprint {
      */
     bigInt(number = 10) {
         this._addAssignType(`BIGINT(${number})`);
-        this.valueType = Number;
+        this._valueType = Number;
         return this;
     }
     /**
@@ -69,7 +69,7 @@ class Blueprint {
      */
     bigint(number = 10) {
         this._addAssignType(`BIGINT(${number})`);
-        this.valueType = Number;
+        this._valueType = Number;
         return this;
     }
     /**
@@ -79,7 +79,7 @@ class Blueprint {
      * @return {this} this
      */
     double(length = 0, decimal = 0) {
-        this.valueType = Number;
+        this._valueType = Number;
         if (!length || !decimal) {
             this._addAssignType(`DOUBLE`);
             return this;
@@ -94,7 +94,7 @@ class Blueprint {
      * @return {this} this
      */
     float(length = 0, decimal = 0) {
-        this.valueType = Number;
+        this._valueType = Number;
         if (!length || !decimal) {
             this._addAssignType(`FLOAT`);
             return this;
@@ -204,7 +204,7 @@ class Blueprint {
      */
     date() {
         this._addAssignType(`DATE`);
-        this.valueType = Date;
+        this._valueType = Date;
         return this;
     }
     /**
@@ -213,7 +213,7 @@ class Blueprint {
      */
     dateTime() {
         this._addAssignType(`DATETIME`);
-        this.valueType = Date;
+        this._valueType = Date;
         return this;
     }
     /**
@@ -222,7 +222,7 @@ class Blueprint {
      */
     datetime() {
         this._addAssignType(`DATETIME`);
-        this.valueType = Date;
+        this._valueType = Date;
         return this;
     }
     /**
@@ -231,7 +231,7 @@ class Blueprint {
      */
     timestamp() {
         this._addAssignType(`TIMESTAMP`);
-        this.valueType = Date;
+        this._valueType = Date;
         return this;
     }
     /**
@@ -315,8 +315,18 @@ class Blueprint {
         this._addAssignAttribute(`AUTO_INCREMENT`);
         return this;
     }
+    /**
+     * Assign attributes 'foreign' in table
+     * Reference bettwen Column Main to Column Child
+     * @param    {object}  property object { key , value , operator }
+     * @property {string?}  property.reference
+     * @property {Model | string}  property.on
+     * @property {string?} property.onDelete
+     * @property {string?}  property.onUpdate
+     * @return {this} this
+     */
     foreign({ references, on, onDelete, onUpdate }) {
-        this.foreignKey = {
+        this._foreignKey = {
             references: references == null ? 'id' : references,
             on: typeof on === 'string' ? on : new on(),
             onDelete: onDelete == null ? 'CASCADE' : onDelete,
@@ -324,12 +334,24 @@ class Blueprint {
         };
         return this;
     }
+    get type() {
+        return this._type;
+    }
+    get attributes() {
+        return this._attributes;
+    }
+    get foreignKey() {
+        return this._foreignKey;
+    }
+    get valueType() {
+        return this._valueType;
+    }
     _addAssignType(type) {
-        this.type = type;
+        this._type = type;
         return this;
     }
     _addAssignAttribute(attribute) {
-        this.attributes = [...this.attributes, attribute];
+        this._attributes = [...this.attributes, attribute];
         return this;
     }
 }

package/dist/lib/tspace/Builder.d.ts

@@ -1,5 +1,5 @@
-import { AbstractBuilder } from './Abstract/AbstractBuilder';
-import { Pagination, Backup, ConnectionOptions, BackupToFile, Connection, ConnectionTransaction, BackupTableToFile } from './Interface';
+import { AbstractBuilder } from './Abstracts/AbstractBuilder';
+import { Pagination, Backup, ConnectionOptions, BackupToFile, Connection, ConnectionTransaction, BackupTableToFile } from '../Interface';
 declare class Builder extends AbstractBuilder {
     constructor();
     /**
@@ -94,7 +94,7 @@ declare class Builder extends AbstractBuilder {
      * @param {any?} value
      * @return {this}
      */
-    where(column: string | any, operator?: any, value?: any): this;
+    where(column: string | Record<string, any>, operator?: any, value?: any): this;
     /**
      * The 'orWhere' method is used to add conditions to a database query.
      *
@@ -403,6 +403,14 @@ declare class Builder extends AbstractBuilder {
      * @return {this}
      */
     orWhereQuery(callback: Function): this;
+    /**
+     * The 'orWhereGroup' method is used to add conditions to a database query to create a grouped condition.
+     *
+     * It allows you to specify conditions that records in the database must meet in order to be included in the result set.
+     * @param {function} callback callback query
+     * @return {this}
+     */
+    orWhereGroup(callback: Function): this;
     /**
      * The 'whereCases' method is used to add conditions with cases to a database query.
      *
@@ -829,12 +837,18 @@ declare class Builder extends AbstractBuilder {
     */
     toRawSQL(): string;
     /**
-     *
+     * The 'getTableName' method is used to get table name
      * @return {string} return table name
      */
     getTableName(): string;
     /**
-     *
+     * The 'getSchema' method is used to get schema information
+     * @return {this} this this
+     */
+    getSchema(): Promise<any[]>;
+    /**
+     * The 'bindColumn' method is used to concat table and column -> `users`.`id`
+     * @param {string} column
      * @return {string} return table.column
      */
     bindColumn(column: string): string;
@@ -1251,7 +1265,7 @@ declare class Builder extends AbstractBuilder {
      * @param {number} rows number of rows
      * @return {promise<any>}
      */
-    faker(rows?: number): Promise<any>;
+    faker(rows: number, cb?: Function): Promise<Record<string, any>[]>;
     /**
      *
      * truncate of table
@@ -1264,7 +1278,7 @@ declare class Builder extends AbstractBuilder {
      * @return {promise<boolean>}
      */
     drop(): Promise<boolean>;
-    protected _exceptColumns(): Promise<string[]>;
+    protected exceptColumns(): Promise<string[]>;
     protected _updateHandler(column: string, value?: string | number | null | boolean): string;
     protected copyBuilder(instance: Builder, options?: {
         update?: boolean;
@@ -1282,6 +1296,7 @@ declare class Builder extends AbstractBuilder {
         insert: () => string;
         update: () => string;
         delete: () => string;
+        where: () => string | null;
         any: () => string;
     };
     protected _buildQueryStatement(): {
@@ -1289,6 +1304,7 @@ declare class Builder extends AbstractBuilder {
         insert: () => string;
         update: () => string;
         delete: () => string;
+        where: () => string | null;
         any: () => string;
     };
     protected _getState(key: string): any;
@@ -1300,10 +1316,9 @@ declare class Builder extends AbstractBuilder {
         sql: string;
         returnId?: boolean;
     }): Promise<any>;
-    private _queryWhereIsExists;
     private _insertNotExists;
     private _insert;
-    private _checkValueHasRaw;
+    protected _checkValueHasRaw(value: any): string;
     private _insertMultiple;
     private _insertOrSelect;
     private _updateOrInsert;
@@ -1312,8 +1327,8 @@ declare class Builder extends AbstractBuilder {
     private _queryUpdate;
     private _queryInsert;
     private _queryInsertMultiple;
-    private _valueAndOperator;
-    private _valueTrueFalse;
+    protected _valueAndOperator(value: string, operator: string, useDefault?: boolean): string[];
+    protected _valueTrueFalse(value: any): any;
     private _initialConnection;
 }
 export { Builder };