/*
 * MIT License
 *
 * Copyright (c) 2018-2020 Ardalan Amini
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

import * as Odin from "..";
import Query from "../base/Query";
import DB, { Operator, JoinQuery, Order, Callback, Iterator } from "../DB";
import Filter from "../DB/Filter";
import Join from "../DB/Join";
declare namespace Relation {
    interface Relation {
        name: string;
        relations: Relation[];
    }
    interface RelationCount {
        name: string;
        relation?: RelationCount;
    }
}
declare abstract class Relation<T extends Odin = Odin, A = undefined> {
    readonly model: Odin;
    readonly relation: typeof Odin;
    readonly localKey: string;
    readonly foreignKey: string;
    protected readonly filter: (q: Filter<T>) => Filter<T>;
    readonly as: string;
    constructor(model: Odin, relation: typeof Odin, localKey: string, foreignKey: string, filter: (q: Filter<T>) => Filter<T>, caller: (...args: any[]) => any);
    protected _query(relations?: string[]): Query<T>;
    abstract load(query: DB<T> | Join<T>, relations: Relation.Relation[], withTrashed?: boolean, filter?: (q: Filter) => Filter): DB<T> | Join<T>;
    abstract loadCount(query: DB<T> | Join<T>, relations: string[], withTrashed?: boolean, filter?: (q: Filter) => Filter): DB<T> | Join<T>;
    /******************************* With Trashed *******************************/
    withTrashed<T extends Record<string, unknown>>(): Query<T>;
    /*********************************** Lean ***********************************/
    lean<T extends Record<string, unknown>>(): Query<T>;
    /****************************** With Relations ******************************/
    with(...relations: string[]): Query<T>;
    /*********************************** Joins **********************************/
    join(collection: string | typeof Odin, query?: JoinQuery<T>, as?: string): Query<T>;
    /******************************* Where Clauses ******************************/
    where(field: string, value: any): Query<T>;
    where(field: string, operator: Operator, value: any): Query<T>;
    whereIn(field: string, values: any[]): Query<T>;
    whereNotIn(field: string, values: any[]): Query<T>;
    whereBetween(field: string, start: any, end: any): Query<T>;
    whereNotBetween(field: string, start: any, end: any): Query<T>;
    whereNull(field: string): Query<T>;
    whereNotNull(field: string): Query<T>;
    /******************** Ordering, Grouping, Limit & Offset ********************/
    orderBy(field: string, order?: Order): Query<T>;
    skip(offset: number): Query<T>;
    offset(offset: number): Query<T>;
    limit(limit: number): Query<T>;
    take(limit: number): Query<T>;
    /*********************************** Read ***********************************/
    exists(): Promise<boolean>;
    exists(callback: Callback<boolean>): void;
    count(): Promise<number>;
    count(callback: Callback<number>): void;
    iterate<T extends Record<string, unknown>>(): Iterator<T>;
    get(): Promise<T[]>;
    get(callback: Callback<T[]>): void;
    first(): Promise<T>;
    first(callback: Callback<T>): void;
    value(field: string): Promise<any>;
    value(field: string, callback: Callback<any>): void;
    pluck(field: string): Promise<any>;
    pluck(field: string, callback: Callback<any>): void;
    max(field: string): Promise<any>;
    max(field: string, callback: Callback<any>): void;
    min(field: string): Promise<any>;
    min(field: string, callback: Callback<any>): void;
    /********************************** Inserts *********************************/
    insert(items: T[]): Promise<A extends undefined ? number : any>;
    insert(items: T[], callback: Callback<A extends undefined ? number : any>): void;
    create(item: T): Promise<T>;
    create(item: T, callback: Callback<T>): void;
    save(model: T): Promise<T>;
    save(model: T, callback: Callback<T>): void;
    /********************************** Updates *********************************/
    update(update: T): Promise<number>;
    update(update: T, callback: Callback<number>): void;
    increment(field: string, count?: number): Promise<number>;
    increment(field: string, callback: Callback<number>): void;
    increment(field: string, count: number, callback: Callback<number>): void;
    decrement(field: string, count?: number): Promise<number>;
    decrement(field: string, callback: Callback<number>): void;
    decrement(field: string, count: number, callback: Callback<number>): void;
    /********************************** Deletes *********************************/
    delete(): Promise<number>;
    delete(callback: Callback<number>): void;
}
export default Relation;