@spinajs/orm 2.0.179 → 2.0.181

package/lib/cjs/model.d.ts

@@ -1,285 +1,285 @@
-import { ModelData, ModelDataWithRelationData, PartialArray, PickRelations } from './types.js';
-import { IModelDescriptor, InsertBehaviour, IUpdateResult, ISelectQueryBuilder, IWhereBuilder, QueryScope, IHistoricalModel, IModelBase, IRelationDescriptor } from './interfaces.js';
-import { WhereFunction } from './types.js';
-import { RawQuery, UpdateQueryBuilder, TruncateTableQueryBuilder, QueryBuilder, SelectQueryBuilder, DeleteQueryBuilder, InsertQueryBuilder } from './builders.js';
-import { Op } from './enums.js';
-import { Class, IContainer } from '@spinajs/di';
-import { Wrap } from './statements.js';
-import { DateTime } from 'luxon';
-import { OrmDriver } from './driver.js';
-export declare function extractModelDescriptor(targetOrForward: any): IModelDescriptor;
-export declare class ModelBase<M = unknown> implements IModelBase {
-    private _container;
-    /**
-     * List of hidden properties from JSON / dehydrations
-     * eg. password field of user
-     */
-    protected _hidden: string[];
-    static readonly _queryScopes: QueryScope;
-    /**
-     * Gets descriptor for this model. It contains information about relations, orm driver, connection properties,
-     * db table attached, column information and others.
-     */
-    get ModelDescriptor(): IModelDescriptor;
-    /**
-     * Gets di container associated with this model ( via connection object  eg. different drivers have their own implementation of things)
-     */
-    get Container(): IContainer;
-    get PrimaryKeyName(): string;
-    get PrimaryKeyValue(): any;
-    set PrimaryKeyValue(newVal: any);
-    valueOf(): any;
-    driver(): OrmDriver;
-    /**
-     * Recursivelly takes all relation data and returns as single array
-     */
-    getFlattenRelationModels(recursive?: boolean): ModelBase[];
-    static getModelDescriptor(): void;
-    static getRelationDescriptor(_relation: string): void;
-    /**
-     * Clears all data in table
-     */
-    static truncate(): void;
-    /**
-     * Get all data from db
-     */
-    static all<T extends typeof ModelBase>(this: T, _page?: number, _perPage?: number): SelectQueryBuilder<Array<InstanceType<T>>>;
-    /**
-     * Inserts data to DB.
-     *
-     * @param _data - data to insert
-     */
-    static insert<T extends typeof ModelBase>(this: T, _data: InstanceType<T> | Partial<InstanceType<T>> | PickRelations<T> | Array<InstanceType<T>> | Array<Partial<InstanceType<T>>>, _insertBehaviour?: InsertBehaviour): InsertQueryBuilder;
-    /**
-     * Search entities in db
-     *
-     * @param column - column to search or function
-     * @param operator - boolean operator
-     * @param value - value to compare
-     */
-    static where<T extends typeof ModelBase>(this: T, val: boolean): ISelectQueryBuilder<Array<InstanceType<T>>> & T['_queryScopes'];
-    static where<T extends typeof ModelBase>(this: T, val: PartialArray<InstanceType<T>> | PickRelations<T>): ISelectQueryBuilder<Array<InstanceType<T>>> & T['_queryScopes'];
-    static where<T extends typeof ModelBase>(this: T, func: WhereFunction<InstanceType<T>>): ISelectQueryBuilder<Array<InstanceType<T>>> & T['_queryScopes'];
-    static where<T extends typeof ModelBase>(this: T, column: string, operator: Op, value: any): ISelectQueryBuilder<Array<InstanceType<T>>> & T['_queryScopes'];
-    static where<T extends typeof ModelBase>(this: T, column: string, value: any): ISelectQueryBuilder<Array<InstanceType<T>>> & T['_queryScopes'];
-    static where<T extends typeof ModelBase>(this: T, statement: Wrap): ISelectQueryBuilder<Array<InstanceType<T>>> & T['_queryScopes'];
-    static where<T extends typeof ModelBase>(this: T, column: string | boolean | WhereFunction<InstanceType<T>> | RawQuery | PartialArray<InstanceType<T>> | Wrap | PickRelations<T>, operator?: Op | any, value?: any): ISelectQueryBuilder<Array<InstanceType<T>>> & T['_queryScopes'];
-    /**
-     * Updates single or multiple records at once with provided value based on condition
-     *
-     * @param _data - data to set
-     */
-    static update<T extends typeof ModelBase>(this: T, _data: Partial<InstanceType<T>>): UpdateQueryBuilder<InstanceType<T>> & T['_queryScopes'];
-    /**
-     * Tries to find all models with given primary keys
-     */
-    static find<T extends typeof ModelBase>(this: T, _pks: any[]): Promise<Array<InstanceType<T>>>;
-    /**
-     * Tries to get first result from db
-     *
-     * Orders by Primary key, if pk not exists then by unique constraints and lastly by CreateAt if no unique columns exists.
-     */
-    static first<T extends typeof ModelBase>(this: T, callback?: (builder: IWhereBuilder<T> & T['_queryScopes']) => void): Promise<InstanceType<T>>;
-    /**
-     * Tries to get first result from db
-     *
-     * Orders by Primary key, if pk not exists then by unique constraints and lastly by CreateAt if no unique columns exists.
-     */
-    static last<T extends typeof ModelBase>(this: T, callback?: (builder: IWhereBuilder<T> & T['_queryScopes']) => void): Promise<InstanceType<T>>;
-    /**
-     * Tries to get newest result from db. It throws if model dont have CreatedAt decorated property
-     */
-    static newest<T extends typeof ModelBase>(this: T, callback?: (builder: IWhereBuilder<T> & T['_queryScopes']) => void): Promise<InstanceType<T>>;
-    /**
-     * Tries to get oldest result from db. It throws if model dont have CreatedAt decorated property
-     */
-    static oldest<T extends typeof ModelBase>(this: T, callback?: (builder: IWhereBuilder<T> & T['_queryScopes']) => void): Promise<InstanceType<T>>;
-    /**
-     * Returns total count of entries in db for this model
-     */
-    static count<T extends typeof ModelBase>(this: T, callback?: (builder: IWhereBuilder<T> & T['_queryScopes']) => void): Promise<number>;
-    /**
-     * Tries to find all models in db. If not all exists, throws exception
-     */
-    static findOrFail<T extends typeof ModelBase>(this: T, _pks: any[]): Promise<Array<InstanceType<T>>>;
-    /**
-     * gets model by specified pk, if not exists, returns null
-     *
-     */
-    static get<T extends typeof ModelBase>(this: T, _pk: any): Promise<InstanceType<T>>;
-    /**
-     * Finds model by specified pk. If model not exists in db throws exception
-     *
-     */
-    static getOrFail<T extends typeof ModelBase>(this: T, _pk: any): Promise<InstanceType<T>>;
-    /**
-     *
-     * Checks if model with pk key or unique fields exists and if not creates one AND NOT save in db
-     * NOTE: it checks for unique fields constraint
-     */
-    static getOrNew<T extends typeof ModelBase>(this: T, _pk?: any, _data?: Partial<InstanceType<T>>): Promise<InstanceType<T>>;
-    /**
-     * Creates query on this model. used for quering db for partial data, to perform some kind of operations
-     * that dont need full ORM model to involve, or other non standard operations eg. joins or raw data queries based on this model
-     */
-    static query<T extends typeof ModelBase>(this: T): ISelectQueryBuilder<Array<InstanceType<T>>> & T['_queryScopes'];
-    /**
-     *
-     * Checks if model with pk key / unique fields exists and if not creates one and saves to db
-     * NOTE: it checks for unique fields too.
-     *
-     * @param data - model width data to check
-     */
-    static getOrCreate<T extends typeof ModelBase>(this: T, _pk: any, _data?: Partial<InstanceType<T>>): Promise<InstanceType<T>>;
-    /**
-     * Creates new model & saves is to db
-     *
-     * @param  data - initial model data
-     */
-    static create<T extends typeof ModelBase>(this: T, _data: Partial<InstanceType<T>>): Promise<InstanceType<T>>;
-    /**
-     * Deletes model from db
-     *
-     * @param pk - primary key
-     */
-    static destroy<T extends typeof ModelBase>(this: T, _pk?: any | any[]): DeleteQueryBuilder<InstanceType<T>> & T['_queryScopes'];
-    /**
-     * Checks if model exists in db
-     */
-    static exists(): Promise<boolean>;
-    constructor(data?: Partial<M>);
-    /**
-     * Fills model with data. It only fills properties that exists in database
-     *
-     * @param data - data to fill
-     */
-    hydrate(data: Partial<this>): void;
-    /**
-     *
-     * Attachess model to proper relation an sets foreign key
-     *
-     * @param data - model to attach
-     */
-    attach(data: ModelBase): void;
-    /**
-     * Extracts all data from model. It takes only properties that exists in DB
-     */
-    dehydrate(omit?: string[]): ModelData<this>;
-    /**
-     *
-     * Extracts all data from model with relation data. Relation data are dehydrated recursively.
-     *
-     * @param omit - fields to omit
-     */
-    dehydrateWithRelations(omit?: string[]): ModelDataWithRelationData<this>;
-    toSql(): Partial<this>;
-    /**
-     * deletes enitt from db. If model have SoftDelete decorator, model is marked as deleted
-     */
-    destroy(): Promise<void>;
-    /**
-     * If model can be in achived state - sets archived at date and saves it to db
-     */
-    archive(): Promise<void>;
-    update(): Promise<void>;
-    /**
-     * Save all changes to db. It creates new entry id db or updates existing one if
-     * primary key exists
-     */
-    insert(insertBehaviour?: InsertBehaviour): Promise<IUpdateResult>;
-    /**
-     *
-     * Shorthand for inserting model when no primary key exists, or update
-     * its value in db if primary key is set
-     *
-     * @param insertBehaviour - insert mode
-     */
-    insertOrUpdate(insertBehaviour?: InsertBehaviour): Promise<void>;
-    /**
-     * Gets model data from database and returns as fresh instance.
-     *
-     * If primary key is not fetched, tries to load by columns with unique constraint.
-     * If there is no unique columns or primary key, throws error
-     */
-    fresh(): Promise<this>;
-    /**
-     * Refresh model from database.
-     *
-     * If no primary key is set, tries to fetch data base on columns
-     * with unique constraints. If none exists, throws exception
-     */
-    refresh(): Promise<void>;
-    toJSON(): ModelData<this>;
-    /**
-     * sets default values for model. values are taken from DB default column prop
-     */
-    protected setDefaults(): void;
-    protected createSelectQuery(): {
-        query: SelectQueryBuilder<unknown>;
-        description: IModelDescriptor;
-        model: Class<any>;
-        container: IContainer;
-    };
-    protected createUpdateQuery(): {
-        query: UpdateQueryBuilder<unknown>;
-        description: IModelDescriptor;
-        model: Class<any>;
-        container: IContainer;
-    };
-    protected createInsertQuery(): {
-        query: InsertQueryBuilder;
-        description: IModelDescriptor;
-        model: Class<any>;
-        container: IContainer;
-    };
-}
-export declare abstract class HistoricalModel implements IHistoricalModel {
-    readonly __action__: 'update' | 'insert' | 'delete';
-    readonly __revision__: number;
-    readonly __start__: DateTime;
-    readonly __end__: DateTime;
-}
-/**
- * Helper function to create query based on model
- *
- * @param model - source model for query
- * @param query - query class
- * @param injectModel - should inject model information into query, if not, query will return raw data
- *
- * @returns
- */
-export declare function createQuery<T extends QueryBuilder>(model: Class<any>, query: Class<T>, injectModel?: boolean): {
-    query: T extends import("@spinajs/di").AsyncService ? Promise<T> : T;
-    description: IModelDescriptor;
-    model: Class<any>;
-    container: IContainer;
-};
-export declare const MODEL_STATIC_MIXINS: {
-    getModelDescriptor(): IModelDescriptor;
-    getRelationDescriptor(relation: string): IRelationDescriptor;
-    truncate(): TruncateTableQueryBuilder;
-    driver(): OrmDriver;
-    query(): SelectQueryBuilder;
-    where(column: string | boolean | WhereFunction<any> | RawQuery | Wrap | {}, operator?: Op | any, value?: any): SelectQueryBuilder;
-    update<T extends typeof ModelBase>(data: Partial<InstanceType<T>>): UpdateQueryBuilder<unknown>;
-    all(page?: number, perPage?: number): SelectQueryBuilder<unknown>;
-    /**
-     * Try to insert new value
-     */
-    insert<T_1 extends typeof ModelBase>(this: T_1, data: InstanceType<T_1> | Partial<InstanceType<T_1>> | InstanceType<T_1>[] | Partial<InstanceType<T_1>>[], insertBehaviour?: InsertBehaviour): Promise<IUpdateResult>;
-    find<T_2 extends typeof ModelBase>(this: T_2, pks: any[]): Promise<InstanceType<T_2>[]>;
-    findOrFail<T_3 extends typeof ModelBase>(this: T_3, pks: any[]): Promise<InstanceType<T_3>[]>;
-    get<T_4 extends typeof ModelBase>(this: T_4, pk: any): Promise<InstanceType<T_4>>;
-    getOrFail<T_5 extends typeof ModelBase>(this: T_5, pk: any): Promise<InstanceType<T_5>>;
-    destroy<T_6 extends typeof ModelBase>(pks?: any | any[]): IWhereBuilder<InstanceType<T_6>>;
-    create<T_7 extends typeof ModelBase>(this: T_7, data: Partial<InstanceType<T_7>>): Promise<InstanceType<T_7>>;
-    getOrCreate<T_8 extends typeof ModelBase>(this: T_8, pk: any, data: Partial<InstanceType<T_8>>): Promise<InstanceType<T_8>>;
-    getOrNew<T_9 extends typeof ModelBase>(this: T_9, pk: any, data?: Partial<InstanceType<T_9>>): Promise<InstanceType<T_9>>;
-    exists<T_10 extends typeof ModelBase>(this: T_10, pk: any): Promise<boolean>;
-    first<T_11 extends typeof ModelBase>(this: T_11, callback?: (builder: IWhereBuilder<T_11>) => void): Promise<InstanceType<T_11>>;
-    last<T_12 extends typeof ModelBase>(this: T_12, callback?: (builder: IWhereBuilder<T_12>) => void): Promise<InstanceType<T_12>>;
-    newest<T_13 extends typeof ModelBase>(this: T_13, callback?: (builder: IWhereBuilder<T_13>) => void): Promise<InstanceType<T_13>>;
-    oldest<T_14 extends typeof ModelBase>(this: T_14, callback?: (builder: IWhereBuilder<T_14>) => void): Promise<InstanceType<T_14>>;
-    count<T_15 extends typeof ModelBase>(this: T_15, callback?: (builder: IWhereBuilder<T_15>) => void): Promise<number>;
-};
+import { ModelData, ModelDataWithRelationData, PartialArray, PickRelations } from './types.js';
+import { IModelDescriptor, InsertBehaviour, IUpdateResult, ISelectQueryBuilder, IWhereBuilder, QueryScope, IHistoricalModel, IModelBase, IRelationDescriptor } from './interfaces.js';
+import { WhereFunction } from './types.js';
+import { RawQuery, UpdateQueryBuilder, TruncateTableQueryBuilder, QueryBuilder, SelectQueryBuilder, DeleteQueryBuilder, InsertQueryBuilder } from './builders.js';
+import { Op } from './enums.js';
+import { Class, IContainer } from '@spinajs/di';
+import { Wrap } from './statements.js';
+import { DateTime } from 'luxon';
+import { OrmDriver } from './driver.js';
+export declare function extractModelDescriptor(targetOrForward: any): IModelDescriptor;
+export declare class ModelBase<M = unknown> implements IModelBase {
+    private _container;
+    /**
+     * List of hidden properties from JSON / dehydrations
+     * eg. password field of user
+     */
+    protected _hidden: string[];
+    static readonly _queryScopes: QueryScope;
+    /**
+     * Gets descriptor for this model. It contains information about relations, orm driver, connection properties,
+     * db table attached, column information and others.
+     */
+    get ModelDescriptor(): IModelDescriptor;
+    /**
+     * Gets di container associated with this model ( via connection object  eg. different drivers have their own implementation of things)
+     */
+    get Container(): IContainer;
+    get PrimaryKeyName(): string;
+    get PrimaryKeyValue(): any;
+    set PrimaryKeyValue(newVal: any);
+    valueOf(): any;
+    driver(): OrmDriver;
+    /**
+     * Recursivelly takes all relation data and returns as single array
+     */
+    getFlattenRelationModels(recursive?: boolean): ModelBase[];
+    static getModelDescriptor(): void;
+    static getRelationDescriptor(_relation: string): void;
+    /**
+     * Clears all data in table
+     */
+    static truncate(): void;
+    /**
+     * Get all data from db
+     */
+    static all<T extends typeof ModelBase>(this: T, _page?: number, _perPage?: number): SelectQueryBuilder<Array<InstanceType<T>>>;
+    /**
+     * Inserts data to DB.
+     *
+     * @param _data - data to insert
+     */
+    static insert<T extends typeof ModelBase>(this: T, _data: InstanceType<T> | Partial<InstanceType<T>> | PickRelations<T> | Array<InstanceType<T>> | Array<Partial<InstanceType<T>>>, _insertBehaviour?: InsertBehaviour): InsertQueryBuilder;
+    /**
+     * Search entities in db
+     *
+     * @param column - column to search or function
+     * @param operator - boolean operator
+     * @param value - value to compare
+     */
+    static where<T extends typeof ModelBase>(this: T, val: boolean): ISelectQueryBuilder<Array<InstanceType<T>>> & T['_queryScopes'];
+    static where<T extends typeof ModelBase>(this: T, val: PartialArray<InstanceType<T>> | PickRelations<T>): ISelectQueryBuilder<Array<InstanceType<T>>> & T['_queryScopes'];
+    static where<T extends typeof ModelBase>(this: T, func: WhereFunction<InstanceType<T>>): ISelectQueryBuilder<Array<InstanceType<T>>> & T['_queryScopes'];
+    static where<T extends typeof ModelBase>(this: T, column: string, operator: Op, value: any): ISelectQueryBuilder<Array<InstanceType<T>>> & T['_queryScopes'];
+    static where<T extends typeof ModelBase>(this: T, column: string, value: any): ISelectQueryBuilder<Array<InstanceType<T>>> & T['_queryScopes'];
+    static where<T extends typeof ModelBase>(this: T, statement: Wrap): ISelectQueryBuilder<Array<InstanceType<T>>> & T['_queryScopes'];
+    static where<T extends typeof ModelBase>(this: T, column: string | boolean | WhereFunction<InstanceType<T>> | RawQuery | PartialArray<InstanceType<T>> | Wrap | PickRelations<T>, operator?: Op | any, value?: any): ISelectQueryBuilder<Array<InstanceType<T>>> & T['_queryScopes'];
+    /**
+     * Updates single or multiple records at once with provided value based on condition
+     *
+     * @param _data - data to set
+     */
+    static update<T extends typeof ModelBase>(this: T, _data: Partial<InstanceType<T>>): UpdateQueryBuilder<InstanceType<T>> & T['_queryScopes'];
+    /**
+     * Tries to find all models with given primary keys
+     */
+    static find<T extends typeof ModelBase>(this: T, _pks: any[]): Promise<Array<InstanceType<T>>>;
+    /**
+     * Tries to get first result from db
+     *
+     * Orders by Primary key, if pk not exists then by unique constraints and lastly by CreateAt if no unique columns exists.
+     */
+    static first<T extends typeof ModelBase>(this: T, callback?: (builder: IWhereBuilder<T> & T['_queryScopes']) => void): Promise<InstanceType<T>>;
+    /**
+     * Tries to get first result from db
+     *
+     * Orders by Primary key, if pk not exists then by unique constraints and lastly by CreateAt if no unique columns exists.
+     */
+    static last<T extends typeof ModelBase>(this: T, callback?: (builder: IWhereBuilder<T> & T['_queryScopes']) => void): Promise<InstanceType<T>>;
+    /**
+     * Tries to get newest result from db. It throws if model dont have CreatedAt decorated property
+     */
+    static newest<T extends typeof ModelBase>(this: T, callback?: (builder: IWhereBuilder<T> & T['_queryScopes']) => void): Promise<InstanceType<T>>;
+    /**
+     * Tries to get oldest result from db. It throws if model dont have CreatedAt decorated property
+     */
+    static oldest<T extends typeof ModelBase>(this: T, callback?: (builder: IWhereBuilder<T> & T['_queryScopes']) => void): Promise<InstanceType<T>>;
+    /**
+     * Returns total count of entries in db for this model
+     */
+    static count<T extends typeof ModelBase>(this: T, callback?: (builder: IWhereBuilder<T> & T['_queryScopes']) => void): Promise<number>;
+    /**
+     * Tries to find all models in db. If not all exists, throws exception
+     */
+    static findOrFail<T extends typeof ModelBase>(this: T, _pks: any[]): Promise<Array<InstanceType<T>>>;
+    /**
+     * gets model by specified pk, if not exists, returns null
+     *
+     */
+    static get<T extends typeof ModelBase>(this: T, _pk: any): Promise<InstanceType<T>>;
+    /**
+     * Finds model by specified pk. If model not exists in db throws exception
+     *
+     */
+    static getOrFail<T extends typeof ModelBase>(this: T, _pk: any): Promise<InstanceType<T>>;
+    /**
+     *
+     * Checks if model with pk key or unique fields exists and if not creates one AND NOT save in db
+     * NOTE: it checks for unique fields constraint
+     */
+    static getOrNew<T extends typeof ModelBase>(this: T, _pk?: any, _data?: Partial<InstanceType<T>>): Promise<InstanceType<T>>;
+    /**
+     * Creates query on this model. used for quering db for partial data, to perform some kind of operations
+     * that dont need full ORM model to involve, or other non standard operations eg. joins or raw data queries based on this model
+     */
+    static query<T extends typeof ModelBase>(this: T): ISelectQueryBuilder<Array<InstanceType<T>>> & T['_queryScopes'];
+    /**
+     *
+     * Checks if model with pk key / unique fields exists and if not creates one and saves to db
+     * NOTE: it checks for unique fields too.
+     *
+     * @param data - model width data to check
+     */
+    static getOrCreate<T extends typeof ModelBase>(this: T, _pk: any, _data?: Partial<InstanceType<T>>): Promise<InstanceType<T>>;
+    /**
+     * Creates new model & saves is to db
+     *
+     * @param  data - initial model data
+     */
+    static create<T extends typeof ModelBase>(this: T, _data: Partial<InstanceType<T>>): Promise<InstanceType<T>>;
+    /**
+     * Deletes model from db
+     *
+     * @param pk - primary key
+     */
+    static destroy<T extends typeof ModelBase>(this: T, _pk?: any | any[]): DeleteQueryBuilder<InstanceType<T>> & T['_queryScopes'];
+    /**
+     * Checks if model exists in db
+     */
+    static exists(): Promise<boolean>;
+    constructor(data?: Partial<M>);
+    /**
+     * Fills model with data. It only fills properties that exists in database
+     *
+     * @param data - data to fill
+     */
+    hydrate(data: Partial<this>): void;
+    /**
+     *
+     * Attachess model to proper relation an sets foreign key
+     *
+     * @param data - model to attach
+     */
+    attach(data: ModelBase): void;
+    /**
+     * Extracts all data from model. It takes only properties that exists in DB
+     */
+    dehydrate(omit?: string[]): ModelData<this>;
+    /**
+     *
+     * Extracts all data from model with relation data. Relation data are dehydrated recursively.
+     *
+     * @param omit - fields to omit
+     */
+    dehydrateWithRelations(omit?: string[]): ModelDataWithRelationData<this>;
+    toSql(): Partial<this>;
+    /**
+     * deletes enitt from db. If model have SoftDelete decorator, model is marked as deleted
+     */
+    destroy(): Promise<void>;
+    /**
+     * If model can be in achived state - sets archived at date and saves it to db
+     */
+    archive(): Promise<void>;
+    update(): Promise<void>;
+    /**
+     * Save all changes to db. It creates new entry id db or updates existing one if
+     * primary key exists
+     */
+    insert(insertBehaviour?: InsertBehaviour): Promise<IUpdateResult>;
+    /**
+     *
+     * Shorthand for inserting model when no primary key exists, or update
+     * its value in db if primary key is set
+     *
+     * @param insertBehaviour - insert mode
+     */
+    insertOrUpdate(insertBehaviour?: InsertBehaviour): Promise<void>;
+    /**
+     * Gets model data from database and returns as fresh instance.
+     *
+     * If primary key is not fetched, tries to load by columns with unique constraint.
+     * If there is no unique columns or primary key, throws error
+     */
+    fresh(): Promise<this>;
+    /**
+     * Refresh model from database.
+     *
+     * If no primary key is set, tries to fetch data base on columns
+     * with unique constraints. If none exists, throws exception
+     */
+    refresh(): Promise<void>;
+    toJSON(): ModelData<this>;
+    /**
+     * sets default values for model. values are taken from DB default column prop
+     */
+    protected setDefaults(): void;
+    protected createSelectQuery(): {
+        query: SelectQueryBuilder<unknown>;
+        description: IModelDescriptor;
+        model: Class<any>;
+        container: IContainer;
+    };
+    protected createUpdateQuery(): {
+        query: UpdateQueryBuilder<unknown>;
+        description: IModelDescriptor;
+        model: Class<any>;
+        container: IContainer;
+    };
+    protected createInsertQuery(): {
+        query: InsertQueryBuilder;
+        description: IModelDescriptor;
+        model: Class<any>;
+        container: IContainer;
+    };
+}
+export declare abstract class HistoricalModel implements IHistoricalModel {
+    readonly __action__: 'update' | 'insert' | 'delete';
+    readonly __revision__: number;
+    readonly __start__: DateTime;
+    readonly __end__: DateTime;
+}
+/**
+ * Helper function to create query based on model
+ *
+ * @param model - source model for query
+ * @param query - query class
+ * @param injectModel - should inject model information into query, if not, query will return raw data
+ *
+ * @returns
+ */
+export declare function createQuery<T extends QueryBuilder>(model: Class<any>, query: Class<T>, injectModel?: boolean): {
+    query: T extends import("@spinajs/di").AsyncService ? Promise<T> : T;
+    description: IModelDescriptor;
+    model: Class<any>;
+    container: IContainer;
+};
+export declare const MODEL_STATIC_MIXINS: {
+    getModelDescriptor(): IModelDescriptor;
+    getRelationDescriptor(relation: string): IRelationDescriptor;
+    truncate(): TruncateTableQueryBuilder;
+    driver(): OrmDriver;
+    query(): SelectQueryBuilder;
+    where(column: string | boolean | WhereFunction<any> | RawQuery | Wrap | {}, operator?: Op | any, value?: any): SelectQueryBuilder;
+    update<T extends typeof ModelBase>(data: Partial<InstanceType<T>>): UpdateQueryBuilder<unknown>;
+    all(page?: number, perPage?: number): SelectQueryBuilder<unknown>;
+    /**
+     * Try to insert new value
+     */
+    insert<T_1 extends typeof ModelBase>(this: T_1, data: InstanceType<T_1> | Partial<InstanceType<T_1>> | InstanceType<T_1>[] | Partial<InstanceType<T_1>>[], insertBehaviour?: InsertBehaviour): Promise<IUpdateResult>;
+    find<T_2 extends typeof ModelBase>(this: T_2, pks: any[]): Promise<InstanceType<T_2>[]>;
+    findOrFail<T_3 extends typeof ModelBase>(this: T_3, pks: any[]): Promise<InstanceType<T_3>[]>;
+    get<T_4 extends typeof ModelBase>(this: T_4, pk: any): Promise<InstanceType<T_4>>;
+    getOrFail<T_5 extends typeof ModelBase>(this: T_5, pk: any): Promise<InstanceType<T_5>>;
+    destroy<T_6 extends typeof ModelBase>(pks?: any | any[]): IWhereBuilder<InstanceType<T_6>>;
+    create<T_7 extends typeof ModelBase>(this: T_7, data: Partial<InstanceType<T_7>>): Promise<InstanceType<T_7>>;
+    getOrCreate<T_8 extends typeof ModelBase>(this: T_8, pk: any, data: Partial<InstanceType<T_8>>): Promise<InstanceType<T_8>>;
+    getOrNew<T_9 extends typeof ModelBase>(this: T_9, pk: any, data?: Partial<InstanceType<T_9>>): Promise<InstanceType<T_9>>;
+    exists<T_10 extends typeof ModelBase>(this: T_10, pk: any): Promise<boolean>;
+    first<T_11 extends typeof ModelBase>(this: T_11, callback?: (builder: IWhereBuilder<T_11>) => void): Promise<InstanceType<T_11>>;
+    last<T_12 extends typeof ModelBase>(this: T_12, callback?: (builder: IWhereBuilder<T_12>) => void): Promise<InstanceType<T_12>>;
+    newest<T_13 extends typeof ModelBase>(this: T_13, callback?: (builder: IWhereBuilder<T_13>) => void): Promise<InstanceType<T_13>>;
+    oldest<T_14 extends typeof ModelBase>(this: T_14, callback?: (builder: IWhereBuilder<T_14>) => void): Promise<InstanceType<T_14>>;
+    count<T_15 extends typeof ModelBase>(this: T_15, callback?: (builder: IWhereBuilder<T_15>) => void): Promise<number>;
+};
 //# sourceMappingURL=model.d.ts.map