tspace-mysql 1.6.2 → 1.6.3

package/build/lib/core/Model.js

@@ -36,10 +36,25 @@ let globalSettings = {
 /**
  *
  * 'Model' class is a representation of a database table
+ * @generic {Type} TS
+ * @generic {Type} TR
  * @example
- * class User extends Model {
- *     ...........
+ * import { Model, Blueprint , TSchema , TRelation } from 'tspace-mysql'
+ *
+ * const schema = {
+ *   id    : new Blueprint().int().primary().autoIncrement(),
+ *   uuid  : new Blueprint().varchar(50).null(),
+ *   email : new Blueprint().varchar(50).null(),
+ *   name  : new Blueprint().varchar(255).null(),
+ * }
+ *
+ * type TS = TSchema<typeof schema>
+ * type TR = TRelation<{}>
+ *
+ * class User extends Model<TS,TR> {
+ *     ...........configration
  * }
+ *
  * const users = await new User().findMany()
  * console.log(users)
  */
@@ -208,7 +223,7 @@ class Model extends AbstractModel_1.AbstractModel {
      * It's automatically create, called when not exists table or columns.
      * @param {object} schema using Blueprint for schema
      * @example
-     * import { Blueprint, TypeRelationModel } from 'tspace-mysql';
+     * import { Blueprint, TR } from 'tspace-mysql';
      * class User extends Model {
      *     constructor() {
      *        super()
@@ -243,7 +258,7 @@ class Model extends AbstractModel_1.AbstractModel {
      * }
      */
     useRegistry() {
-        this.$state.set('REGISTRY', Object.assign(Object.assign({}, this.$state.get('REGISTRY')), { '$attach': this._attach, '$detach': this._detach }));
+        this.$state.set('REGISTRY', Object.assign(Object.assign({}, this.$state.get('REGISTRY')), { '$save': this._save.bind(this), '$attach': this._attach.bind(this), '$detach': this._detach.bind(this) }));
         return this;
     }
     /**
@@ -674,14 +689,14 @@ class Model extends AbstractModel_1.AbstractModel {
     }
     /**
      * The 'typeOfSchema' method is used get type of schema.
-     * @returns {TypeSchemaModel} type of schema
+     * @returns {TS} type of schema
      */
     typeOfSchema() {
         return {};
     }
     /**
      * The 'typeOfRelation' method is used get type of relation.
-     * @returns {TypeRelationModel} type of Relation
+     * @returns {TR} type of Relation
      */
     typeOfRelation() {
         return {};
@@ -1284,7 +1299,7 @@ class Model extends AbstractModel_1.AbstractModel {
      * @returns {this} this
      */
     registry(func) {
-        this.$state.set('REGISTRY', Object.assign(Object.assign({}, func), { attach: this._attach, detach: this._detach }));
+        this.$state.set('REGISTRY', Object.assign(Object.assign({}, func), { '$save': this._save.bind(this), '$attach': this._attach.bind(this), '$detach': this._detach.bind(this) }));
         return this;
     }
     /**
@@ -1295,7 +1310,7 @@ class Model extends AbstractModel_1.AbstractModel {
      * @param {...string} nameRelations ...name registry in models using (hasOne , hasMany , belongsTo , belongsToMany)
      * @returns {this} this
      * @example
-     *   import { Model , TypeRelationModel } from 'tspace-mysql'
+     *   import { Model , TR } from 'tspace-mysql'
      *
      *   class User extends Model {
      *       constructor(){
@@ -1330,7 +1345,7 @@ class Model extends AbstractModel_1.AbstractModel {
      * @param {...string} nameRelations ...name registry in models using (hasOne , hasMany , belongsTo , belongsToMany)
      * @returns {this} this
      * @example
-     *   import { Model , TypeRelationModel } from 'tspace-mysql'
+     *   import { Model , TR } from 'tspace-mysql'
      *
      *   class User extends Model {
      *       constructor(){
@@ -1536,6 +1551,7 @@ class Model extends AbstractModel_1.AbstractModel {
      * Use relation '${name}' registry models then return callback queries
      * @param {string} nameRelation name relation in registry in your model
      * @param {function} callback query callback
+     * @param {object} options pivot the query
      * @example
      *   import { Model } from 'tspace-mysql'
      *   class User extends Model {
@@ -1577,10 +1593,14 @@ class Model extends AbstractModel_1.AbstractModel {
      *  .findMany()
      * @returns {this} this
      */
-    withQuery(nameRelation, callback) {
-        var _a;
+    withQuery(nameRelation, callback, options = { pivot: false }) {
+        var _a, _b;
         this.with(nameRelation);
-        (_a = this.$relation) === null || _a === void 0 ? void 0 : _a.callback(nameRelation, callback);
+        if (options.pivot) {
+            (_a = this.$relation) === null || _a === void 0 ? void 0 : _a.callbackPivot(String(nameRelation), callback);
+            return this;
+        }
+        (_b = this.$relation) === null || _b === void 0 ? void 0 : _b.callback(String(nameRelation), callback);
         return this;
     }
     /**
@@ -1590,6 +1610,7 @@ class Model extends AbstractModel_1.AbstractModel {
      * Use relation '${name}' registry models then return callback queries
      * @param {string} nameRelation name relation in registry in your model
      * @param {function} callback query callback
+     * @param {object} options pivot the query
      * @example
      *   import { Model } from 'tspace-mysql'
      *   class User extends Model {
@@ -1631,8 +1652,8 @@ class Model extends AbstractModel_1.AbstractModel {
      *  .findMany()
      * @returns {this} this
      */
-    relationQuery(nameRelation, callback) {
-        return this.withQuery(nameRelation, callback);
+    relationQuery(nameRelation, callback, options = { pivot: false }) {
+        return this.withQuery(nameRelation, callback, options);
     }
     /**
      *
@@ -4061,6 +4082,20 @@ class Model extends AbstractModel_1.AbstractModel {
         }
         return data;
     }
+    _save() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const result = this.$state.get('RESULT');
+            if (result.id == null) {
+                throw this._assertError(`This '$save' must be required the 'id' for the function`);
+            }
+            const update = JSON.parse(JSON.stringify(Object.assign({}, result)));
+            return yield this
+                .where('id', result.id)
+                .update(update)
+                .dd()
+                .save();
+        });
+    }
     _attach(name, dataId, fields) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a;