pretur.sync/lib/request.d.ts

Front-end back-end communication infrastructure

import { SpecType, EmptySpec, Model } from 'pretur.spec';
import { Query } from './query';
export interface RequestBase {
    requestId: number;
}
export interface SelectRequest<T extends SpecType = EmptySpec> extends RequestBase {
    type: 'select';
    scope: string;
    model: T['name'];
    query: Query<T>;
}
export interface ValidateRequest<T = any> extends RequestBase {
    type: 'validate';
    name: string;
    data: T;
}
export interface OperateRequest<T = any> extends RequestBase {
    type: 'operate';
    name: string;
    data?: T;
}
export interface InsertMutateRequest<T extends SpecType = EmptySpec> extends RequestBase {
    type: 'mutate';
    action: 'insert';
    scope: string;
    model: T['name'];
    data: Partial<Model<T>>;
}
export interface UpdateMutateRequest<T extends SpecType = EmptySpec> extends RequestBase {
    type: 'mutate';
    action: 'update';
    scope: string;
    model: T['name'];
    data: Partial<T['fields']>;
}
export interface RemoveMutateRequest<T extends SpecType = EmptySpec> extends RequestBase {
    type: 'mutate';
    action: 'remove';
    scope: string;
    model: T['name'];
    identifiers: Partial<T['fields']>;
}
export declare type MutateRequest<T extends SpecType = EmptySpec> = InsertMutateRequest<T> | UpdateMutateRequest<T> | RemoveMutateRequest<T>;
export interface BatchMutateRequest extends RequestBase {
    type: 'batchMutate';
    queue: MutateRequest[];
}
export declare type Request = SelectRequest | ValidateRequest | OperateRequest | MutateRequest | BatchMutateRequest;