slim-ef/lib/specification/specification.interface.d.ts

An implementation of basic entity framework functionnalities in typescript

import { SlimExpressionFunction } from 'slim-exp';
import { SelectQueryBuilder } from 'typeorm';
export interface CriteriaExpression<T, S extends object = any, C extends object = any> {
    func: SlimExpressionFunction<T, S, C>;
    context?: C;
}
export interface FieldsSelector<T, R extends object = any> {
    fieldsToSelect?: {
        field: string;
    }[];
    builder?: SlimExpressionFunction<T, R, any>;
}
export interface ISpecification<T = undefined> {
    getIncludePaths(): string[];
    getIncludes(): SlimExpressionFunction<T>[];
    getDistinct(): boolean;
    getCriterias(): CriteriaExpression<T>[];
    getChainedIncludes(): {
        initial: SlimExpressionFunction<T>;
        chain: SlimExpressionFunction<any, any>[];
    }[];
    getOrderBy(): SlimExpressionFunction<T>;
    getGroupBy(): SlimExpressionFunction<T>;
    getFunction(): {
        type: FunctionQueryType;
        func: SlimExpressionFunction<T>;
    };
    getOrderByDescending(): SlimExpressionFunction<T>;
    getThenGroupBy(): SlimExpressionFunction<T>[];
    getThenOrderBy(): SlimExpressionFunction<T>[];
    getTake(): number;
    getSkip(): number;
    getIsPagingEnabled(): boolean;
    getSelector<R extends object = any>(): FieldsSelector<T, R>;
}
export declare enum QueryType {
    ONE = 0,
    ALL = 1,
    RAW_ONE = 2,
    RAW_ALL = 3
}
export declare type FunctionQueryType = 'SUM' | 'COUNT' | 'MIN' | 'MAX' | 'AVG';
export declare type QuerySpecificationEvaluatorConstructor<T = any> = new (initialQuery: (alias: string) => SelectQueryBuilder<T>, spec: ISpecification<T>) => IQuerySpecificationEvaluator<T>;
export declare class IQuerySpecificationEvaluator<T = any> {
    constructor(initialQuery: (alias: string) => SelectQueryBuilder<T>, spec: ISpecification<T>);
    executeQuery<R = T, Q = R[]>(type: QueryType): Promise<Q>;
    getQuery(): Promise<string> | string;
    getParams(): Promise<any> | any;
}