pretur.sync/lib/query.d.ts

Front-end back-end communication infrastructure

import { SpecType } from 'pretur.spec';
import { Filter, FilterFields } from './filter';
export declare type Ordering = 'NONE' | 'ASC' | 'DESC';
export interface QueryOrder {
    field: string;
    ordering: Ordering;
    chain?: string[];
}
export interface QueryPagination {
    skip: number;
    take: number;
}
export declare type QueryInclude<T extends SpecType> = {
    [P in keyof T['records']]?: SubQuery<T['records'][P]>;
} & {
    [P in keyof T['sets']]?: SubQuery<T['sets'][P]>;
};
export interface SubQuery<T extends SpecType> {
    extra?: any;
    include?: QueryInclude<T>;
    filters?: FilterFields<T>;
    attributes?: (keyof T['fields'])[];
    required?: boolean;
}
export interface Query<T extends SpecType> {
    byId?: Partial<T['fields']>;
    count?: boolean;
    extra?: any;
    include?: QueryInclude<T>;
    filters?: Filter<T>;
    attributes?: (keyof T['fields'])[];
    pagination?: QueryPagination;
    order?: QueryOrder;
}