tspace-mysql 1.8.2 → 1.8.3

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

@@ -1,8 +1,8 @@
-import { AbstractModel } from './Abstracts/AbstractModel';
-import { Blueprint } from './Blueprint';
-import { TSchemaModel } from './UtilityTypes';
-import { JoinModel } from './JoinModel';
-import type { TCache, TRelationOptions, TPagination, TRelationQueryOptions, TValidateSchema, TGlobalSetting, TRawStringQuery, TFreezeStringQuery, TPattern, TSchemaKeys, TSchemaColumns, TModelConstructorOrObject, TRelationResults, TRelationKeys } from '../types';
+import { AbstractModel } from "./Abstracts/AbstractModel";
+import { Blueprint } from "./Blueprint";
+import { TSchemaModel } from "./UtilityTypes";
+import { JoinModel } from "./JoinModel";
+import type { TCache, TRelationOptions, TPagination, TRelationQueryOptions, TValidateSchema, TGlobalSetting, TRawStringQuery, TFreezeStringQuery, TPattern, TSchemaKeys, TSchemaColumns, TModelConstructorOrObject, TRelationResults, TRelationKeys } from "../types";
 /**
  *
  * 'Model' class is a representation of a database table
@@ -75,7 +75,7 @@ declare class Model<TS extends Record<string, any> = any, TR = unknown> extends
      * @property {string} parttern
      * @returns {Record | string} T
      */
-    static formatPattern<T extends Record<string, any> | string>({ data, pattern }: {
+    static formatPattern<T extends Record<string, any> | string>({ data, pattern, }: {
         data: T;
         pattern: TPattern;
     }): T;
@@ -177,28 +177,28 @@ declare class Model<TS extends Record<string, any> = any, TR = unknown> extends
         deleted: Function;
     }): this;
     /**
-    * The "useLogger" method is used to keeping query data and changed in models.
-    *
-    * @type     {object}  options
-    * @property {boolean} options.selected - default is false
-    * @property {boolean} options.inserted - default is true
-    * @property {boolean} options.updated  - default is true
-    * @property {boolean} options.deleted  - default is true
-    * @example
-    * class User extends Model {
-    *     constructor() {
-    *        super()
-    *        this.useLogger({
-    *          selected : true,
-    *          inserted : true,
-    *          updated  : true,
-    *          deleted  : true,
-    *       })
-    *   }
-    * }
-    * @returns {this} this
-    */
-    protected useLogger({ selected, inserted, updated, deleted }?: {
+     * The "useLogger" method is used to keeping query data and changed in models.
+     *
+     * @type     {object}  options
+     * @property {boolean} options.selected - default is false
+     * @property {boolean} options.inserted - default is true
+     * @property {boolean} options.updated  - default is true
+     * @property {boolean} options.deleted  - default is true
+     * @example
+     * class User extends Model {
+     *     constructor() {
+     *        super()
+     *        this.useLogger({
+     *          selected : true,
+     *          inserted : true,
+     *          updated  : true,
+     *          deleted  : true,
+     *       })
+     *   }
+     * }
+     * @returns {this} this
+     */
+    protected useLogger({ selected, inserted, updated, deleted, }?: {
         selected?: boolean | undefined;
         inserted?: boolean | undefined;
         updated?: boolean | undefined;
@@ -485,7 +485,7 @@ declare class Model<TS extends Record<string, any> = any, TR = unknown> extends
      *     this.useHook([(results) => console.log(results)])
      *   }
      * }
-    */
+     */
     protected useHooks(arrayFunctions: Function[]): this;
     /**
      * The "beforeCreatingTable" method is used exection function when creating the table.
@@ -503,7 +503,7 @@ declare class Model<TS extends Record<string, any> = any, TR = unknown> extends
      *      })
      *   }
      * }
-    */
+     */
     protected beforeCreatingTable(fn: () => Promise<any>): this;
     /**
      * The "whenCreatingTable" method is used exection function when creating the table.
@@ -521,7 +521,7 @@ declare class Model<TS extends Record<string, any> = any, TR = unknown> extends
      *      })
      *   }
      * }
-    */
+     */
     protected whenCreatingTable(fn: () => Promise<any>): this;
     /**
      * exceptColumns for method except
@@ -536,7 +536,7 @@ declare class Model<TS extends Record<string, any> = any, TR = unknown> extends
      * @returns   {this}   this
      */
     protected buildMethodRelation<K extends TR extends object ? TRelationKeys<TR> : string>(name: K, callback?: Function): this;
-    meta(meta: 'MAIN' | 'SUBORDINATE'): this;
+    meta(meta: "MAIN" | "SUBORDINATE"): this;
     /**
      * The 'typeOfSchema' method is used get type of schema.
      * @returns {TS} type of schema
@@ -564,7 +564,7 @@ declare class Model<TS extends Record<string, any> = any, TR = unknown> extends
      * @param {string[]} ...columns
      * @returns {this} this
      */
-    select<K extends Extract<TSchemaKeys<TS>, string> | `${string}.${string}` | TRawStringQuery | '*'>(...columns: K[]): this;
+    select<K extends Extract<TSchemaKeys<TS>, string> | `${string}.${string}` | TRawStringQuery | "*">(...columns: K[]): this;
     /**
      *
      * @override
@@ -592,7 +592,7 @@ declare class Model<TS extends Record<string, any> = any, TR = unknown> extends
      * @param {string?} order by default order = 'asc' but you can used 'asc' or  'desc'
      * @returns {this}
      */
-    orderBy<K extends Extract<TSchemaKeys<TS>, string> | `${string}.${string}`>(column: K, order?: 'ASC' | 'asc' | 'DESC' | 'desc'): this;
+    orderBy<K extends Extract<TSchemaKeys<TS>, string> | `${string}.${string}`>(column: K, order?: "ASC" | "asc" | "DESC" | "desc"): this;
     /**
      *
      * @override
@@ -702,7 +702,7 @@ declare class Model<TS extends Record<string, any> = any, TR = unknown> extends
      * @property {Function} actions.returnId
      * @returns {this} this
      */
-    protected _actionStatement({ sql, returnId }: {
+    protected _actionStatement({ sql, returnId, }: {
         sql: string;
         returnId?: boolean;
     }): Promise<any>;
@@ -721,7 +721,7 @@ declare class Model<TS extends Record<string, any> = any, TR = unknown> extends
      */
     disableSoftDelete(condition?: boolean): this;
     /**
-    * The 'ignoreSoftDelete' method is used to disable the soft delete.
+     * The 'ignoreSoftDelete' method is used to disable the soft delete.
      * @param {boolean} condition
      * @returns {this} this
      */
@@ -876,9 +876,6 @@ declare class Model<TS extends Record<string, any> = any, TR = unknown> extends
      * @returns {this} this
      * @example
      *   import { Model } from 'tspace-mysql'
-import { alias } from 'yargs';
-     *   import { pattern } from '../../tests/schema-spec';
-     *   import { TRelationOptions } from '../types';
      *   class User extends Model {
      *       constructor(){
      *           super()
@@ -906,8 +903,6 @@ import { alias } from 'yargs';
      * @returns {this} this
      * @example
      *   import { Model } from 'tspace-mysql'
-     * import utils from '../utils/index';
-     *   import { TRelationOptions } from '../types';
      *   class User extends Model {
      *       constructor(){
      *           super()
@@ -1062,6 +1057,9 @@ import { alias } from 'yargs';
     withQuery<K extends TR extends object ? TRelationKeys<TR> : string, M = `$${K & string}` extends keyof TR ? TR[`$${K & string}`] extends (infer T)[] ? T : TR[`$${K & string}`] : Model>(nameRelation: K, callback: (query: M) => M, options?: {
         pivot: boolean;
     }): this;
+    withQueryExists<K extends TR extends object ? TRelationKeys<TR> : string, M = `$${K & string}` extends keyof TR ? TR[`$${K & string}`] extends (infer T)[] ? T : TR[`$${K & string}`] : Model>(nameRelation: K, callback: (query: M) => M, options?: {
+        pivot: boolean;
+    }): this;
     /**
      *
      * The 'relationQuery' method is particularly useful when you want to filter or add conditions records based on related data.
@@ -1114,6 +1112,58 @@ import { alias } from 'yargs';
     relationQuery<K extends TR extends object ? TRelationKeys<TR> : string, M = `$${K & string}` extends keyof TR ? TR[`$${K & string}`] extends (infer T)[] ? T : TR[`$${K & string}`] : Model>(nameRelation: K, callback: (query: M) => M, options?: {
         pivot: boolean;
     }): this;
+    /**
+     *
+     * The 'relationQueryExists' method is particularly useful when you want to filter or add conditions records based on related data.
+     *
+     * 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 {
+     *       constructor(){
+     *           super()
+     *           this.hasMany({ name : 'posts' , model : Post })
+     *       }
+     *   }
+     *
+     *   class Post extends Model {
+     *       constructor(){
+     *           super()
+     *           this.hasMany({ name : 'comments' , model : Comment })
+     *           this.belongsTo({ name : 'user' , model : User })
+     *       }
+     *   }
+     *
+     *   class Comment extends Model {
+     *       constructor(){
+     *           super()
+     *           this.hasMany({ name : 'users' , model : User })
+     *           this.belongsTo({ name : 'post' , model : Post })
+     *       }
+     *   }
+     *
+     *   await new User().relations('posts')
+     *   .relationQuery('posts', (query : Post) => {
+     *       return query.relations('comments','user')
+     *       .relationQuery('comments', (query : Comment) => {
+     *           return query.relations('user','post')
+     *       })
+     *       .relationQuery('user', (query : User) => {
+     *           return query.relations('posts').relationsQuery('posts',(query : Post)=> {
+     *               return query.relations('comments','user')
+     *               // relation n, n, ...n
+     *           })
+     *       })
+     *   })
+     *  .findMany()
+     * @returns {this} this
+     */
+    relationQueryExists<K extends TR extends object ? TRelationKeys<TR> : string, M = `$${K & string}` extends keyof TR ? TR[`$${K & string}`] extends (infer T)[] ? T : TR[`$${K & string}`] : Model>(nameRelation: K, callback: (query: M) => M, options?: {
+        pivot: boolean;
+    }): this;
     /**
      *
      * The 'findWithQuery' method is used to find instance call back from relation.
@@ -1138,7 +1188,7 @@ import { alias } from 'yargs';
      * @property {string} relation.freezeTable
      * @returns  {this}   this
      */
-    protected hasOne<K extends TR extends object ? TRelationKeys<TR> : string>({ name, as, model, localKey, foreignKey, freezeTable }: TRelationOptions<K>): this;
+    protected hasOne<K extends TR extends object ? TRelationKeys<TR> : string>({ name, as, model, localKey, foreignKey, freezeTable, }: TRelationOptions<K>): this;
     /**
      * The 'hasMany' relationship defines a one-to-many relationship between two database tables.
      *
@@ -1155,7 +1205,7 @@ import { alias } from 'yargs';
      * @property {string} relation.freezeTable
      * @returns   {this}   this
      */
-    protected hasMany<K extends TR extends object ? TRelationKeys<TR> : string>({ name, as, model, localKey, foreignKey, freezeTable }: TRelationOptions<K>): this;
+    protected hasMany<K extends TR extends object ? TRelationKeys<TR> : string>({ name, as, model, localKey, foreignKey, freezeTable, }: TRelationOptions<K>): this;
     /**
      * The 'belongsTo' relationship defines a one-to-one or many-to-one relationship between two database tables.
      *
@@ -1172,7 +1222,7 @@ import { alias } from 'yargs';
      * @property {string} relation.freezeTable
      * @returns   {this}   this
      */
-    protected belongsTo<K extends TR extends object ? TRelationKeys<TR> : string>({ name, as, model, localKey, foreignKey, freezeTable }: TRelationOptions<K>): this;
+    protected belongsTo<K extends TR extends object ? TRelationKeys<TR> : string>({ name, as, model, localKey, foreignKey, freezeTable, }: TRelationOptions<K>): this;
     /**
      * The 'belongsToMany' relationship defines a many-to-many relationship between two database tables.
      *
@@ -1192,7 +1242,7 @@ import { alias } from 'yargs';
      * @property {class?} relation.modelPivot model for pivot
      * @returns  {this}   this
      */
-    protected belongsToMany<K extends TR extends object ? TRelationKeys<TR> : string>({ name, as, model, localKey, foreignKey, freezeTable, pivot, oldVersion, modelPivot }: TRelationOptions<K>): this;
+    protected belongsToMany<K extends TR extends object ? TRelationKeys<TR> : string>({ name, as, model, localKey, foreignKey, freezeTable, pivot, oldVersion, modelPivot, }: TRelationOptions<K>): this;
     /**
      * The 'hasOneBuilder' method is useful for creating 'hasOne' relationship to function
      *
@@ -1207,7 +1257,7 @@ import { alias } from 'yargs';
      * @param    {Function?} callback callback of query
      * @returns  {this} this
      */
-    protected hasOneBuilder({ name, as, model, localKey, foreignKey, freezeTable }: TRelationQueryOptions, callback?: Function): this;
+    protected hasOneBuilder({ name, as, model, localKey, foreignKey, freezeTable, }: TRelationQueryOptions, callback?: Function): this;
     /**
      * The 'hasManyBuilder' method is useful for creating 'hasMany' relationship to function
      *
@@ -1222,7 +1272,7 @@ import { alias } from 'yargs';
      * @param    {function?} callback callback of query
      * @returns  {this} this
      */
-    protected hasManyBuilder({ name, as, model, localKey, foreignKey, freezeTable }: TRelationQueryOptions, callback?: Function): this;
+    protected hasManyBuilder({ name, as, model, localKey, foreignKey, freezeTable, }: TRelationQueryOptions, callback?: Function): this;
     /**
      * The 'belongsToBuilder' method is useful for creating 'belongsTo' relationship to function
      * @param    {object}  relation registry relation in your model
@@ -1236,7 +1286,7 @@ import { alias } from 'yargs';
      * @param    {function?} callback callback of query
      * @returns  {this} this
      */
-    protected belongsToBuilder({ name, as, model, localKey, foreignKey, freezeTable }: TRelationQueryOptions, callback?: Function): this;
+    protected belongsToBuilder({ name, as, model, localKey, foreignKey, freezeTable, }: TRelationQueryOptions, callback?: Function): this;
     /**
      * The 'belongsToManyBuilder' method is useful for creating 'belongsToMany' relationship to function
      *
@@ -1251,7 +1301,7 @@ import { alias } from 'yargs';
      * @param    {function?} callback callback of query
      * @returns  {this} this
      */
-    protected belongsToManyBuilder({ name, as, model, localKey, foreignKey, freezeTable, pivot, oldVersion, modelPivot }: TRelationQueryOptions, callback?: Function): this;
+    protected belongsToManyBuilder({ name, as, model, localKey, foreignKey, freezeTable, pivot, oldVersion, modelPivot, }: TRelationQueryOptions, callback?: Function): this;
     /**
      * The 'trashed' method is used to specify that you want to retrieve only the soft-deleted records from a database table.
      *
@@ -1332,14 +1382,14 @@ import { alias } from 'yargs';
         [P in K]: any;
     }): this;
     /**
-    * @override
-    * @param    {string} column
-    * @param    {object}  property object { key , value , operator }
-    * @property {string}  property.key
-    * @property {string}  property.value
-    * @property {string?} property.operator
-    * @returns   {this}
-    */
+     * @override
+     * @param    {string} column
+     * @param    {object}  property object { key , value , operator }
+     * @property {string}  property.key
+     * @property {string}  property.value
+     * @property {string?} property.operator
+     * @returns   {this}
+     */
     whereJSON<K extends TSchemaColumns<TS>>(column: K, { key, value, operator }: {
         key: string;
         value: string;
@@ -1603,7 +1653,7 @@ import { alias } from 'yargs';
      * @property {boolean} options.oldest
      * @returns {string} return sql query
      */
-    toString({ latest, oldest }?: {
+    toString({ latest, oldest, }?: {
         latest?: boolean;
         oldest?: boolean;
     }): string;
@@ -1615,7 +1665,7 @@ import { alias } from 'yargs';
      * @property {boolean} options.oldest
      * @returns {string} return sql query
      */
-    toSQL({ latest, oldest }?: {
+    toSQL({ latest, oldest, }?: {
         latest?: boolean;
         oldest?: boolean;
     }): string;
@@ -1624,7 +1674,7 @@ import { alias } from 'yargs';
      * @param {string=} column [column=id]
      * @returns {promise<Array>}
      */
-    toArray<K extends Extract<TSchemaKeys<TS>, string> | 'id'>(column?: K): Promise<any[]>;
+    toArray<K extends Extract<TSchemaKeys<TS>, string> | "id">(column?: K): Promise<any[]>;
     /**
      *
      * @override
@@ -1636,38 +1686,38 @@ import { alias } from 'yargs';
      * @override
      * @param {Function?} cb callback function return query sql
      * @returns {promise<Record<string,any> | null>} Record | null
-    */
+     */
     first<K, R = TRelationResults<TR>>(cb?: Function): Promise<(unknown extends TS ? Record<string, any> : TS & K & Partial<R extends any ? TS & Partial<R> : R>) | null>;
     /**
      * @override
      * @param {Function?} cb callback function return query sql
      * @returns {promise<Record<string,any> | null>} Record | null
-    */
+     */
     findOne<K, R = TRelationResults<TR>>(cb?: Function): Promise<(unknown extends TS ? Record<string, any> : TS & K & Partial<R extends any ? TS & Partial<R> : R>) | null>;
     /**
      * @override
      * @returns {promise<object | Error>} Record | throw error
-    */
-    firstOrError<K, R = TRelationResults<TR>>(message?: string, options?: Record<string, any>): Promise<(unknown extends TS ? Record<string, any> : TS & K & Partial<R extends any ? TS & Partial<R> : R>)>;
+     */
+    firstOrError<K, R = TRelationResults<TR>>(message?: string, options?: Record<string, any>): Promise<unknown extends TS ? Record<string, any> : TS & K & Partial<R extends any ? TS & Partial<R> : R>>;
     /**
      *
      * @override
      * @returns {promise<any>} Record | throw error
-    */
-    findOneOrError<K, R = TRelationResults<TR>>(message?: string, options?: Record<string, any>): Promise<(unknown extends TS ? Record<string, any> : TS & K & Partial<R extends any ? TS & Partial<R> : R>)>;
+     */
+    findOneOrError<K, R = TRelationResults<TR>>(message?: string, options?: Record<string, any>): Promise<unknown extends TS ? Record<string, any> : TS & K & Partial<R extends any ? TS & Partial<R> : R>>;
     /**
      *
      * @override
      * @param {Function?} cb callback function return query sql
      * @returns {promise<array>} Array
-    */
+     */
     get<K, R = TRelationResults<TR>>(cb?: Function): Promise<(unknown extends TS ? Record<string, any> : TS & K & Partial<TR extends any ? TS & Partial<R> : R>)[]>;
     /**
      *
      * @override
      * @param {Function?} cb callback function return query sql
      * @returns {promise<array>} Array
-    */
+     */
     findMany<K, R = TRelationResults<TR>>(cb?: Function): Promise<(unknown extends TS ? Record<string, any> : TS & K & Partial<TR extends any ? TS & Partial<R> : R>)[]>;
     /**
      * @override
@@ -1680,20 +1730,20 @@ import { alias } from 'yargs';
         limit?: number;
         page?: number;
         alias?: boolean;
-    }): Promise<TPagination<(TS & K & Partial<R extends any ? TS & Partial<R> : R>)>>;
-    /**
-    *
-    * @override
-    * @param     {?object} paginationOptions by default page = 1 , limit = 15
-    * @property  {number}  paginationOptions.limit
-    * @property  {number}  paginationOptions.page
-    * @returns   {promise<Pagination>} Pagination
-    */
+    }): Promise<TPagination<TS & K & Partial<R extends any ? TS & Partial<R> : R>>>;
+    /**
+     *
+     * @override
+     * @param     {?object} paginationOptions by default page = 1 , limit = 15
+     * @property  {number}  paginationOptions.limit
+     * @property  {number}  paginationOptions.page
+     * @returns   {promise<Pagination>} Pagination
+     */
     paginate<K, R = TRelationResults<TR>>(paginationOptions?: {
         limit?: number;
         page?: number;
         alias?: boolean;
-    }): Promise<TPagination<(TS & K & Partial<R extends any ? TS & Partial<R> : R>)>>;
+    }): Promise<TPagination<TS & K & Partial<R extends any ? TS & Partial<R> : R>>>;
     /**
      * @override
      * @param {string} column
@@ -1831,11 +1881,11 @@ import { alias } from 'yargs';
         [P in K]: any;
     }): this;
     /**
-    *
-    * @override
-    * @param {object} data create not exists data
-    * @returns {this} this
-    */
+     *
+     * @override
+     * @param {object} data create not exists data
+     * @returns {this} this
+     */
     createNotExists<K extends TSchemaKeys<TS> | TRawStringQuery | TFreezeStringQuery>(data: K extends TSchemaKeys<TS> ? {
         [P in K]: TS[K] | TRawStringQuery;
     } : {
@@ -1882,14 +1932,14 @@ import { alias } from 'yargs';
      * @returns {this} this
      */
     updateMultiple<K extends TSchemaKeys<TS> | TRawStringQuery | TFreezeStringQuery>(cases: {
-        when: (K extends TSchemaKeys<TS> ? Partial<{
+        when: K extends TSchemaKeys<TS> ? Partial<{
             [K in TSchemaKeys<TS>]: TS[K];
         }> : {
             [P in K]: any;
-        });
-        columns: (K extends TSchemaKeys<TS> ? Partial<{
+        };
+        columns: K extends TSchemaKeys<TS> ? Partial<{
             [K in TSchemaKeys<TS>]: TS[K];
-        }> : Record<string, any>);
+        }> : Record<string, any>;
     }[]): this;
     /**
      * The 'getSchemaModel' method is used get a schema model
@@ -1933,7 +1983,7 @@ import { alias } from 'yargs';
      * @property {boolean} options.index - add columns to index
      * @returns {Promise<void>}
      */
-    sync({ force, foreign, changed, index }?: {
+    sync({ force, foreign, changed, index, }?: {
         force?: boolean | undefined;
         foreign?: boolean | undefined;
         changed?: boolean | undefined;