@minimaltech/ra-infra/dist/base/providers/default-rest-data.provider.d.ts

Minimal Technology ReactJS Infrastructure

import { AnyType, ICustomParams, IDataProvider, IRestDataProviderOptions, ISendParams, ISendResponse, TRequestMethod, TRequestType } from '../../common';
import { DefaultNetworkRequestService } from '../../base/services';
import { ValueOrPromise } from '@loopback/context';
import { CreateParams, CreateResult, DeleteManyParams, DeleteManyResult, DeleteParams, DeleteResult, GetListParams, GetListResult, GetManyParams, GetManyReferenceParams, GetManyReferenceResult, GetManyResult, GetOneParams, GetOneResult, Identifier, QueryFunctionContext, RaRecord, UpdateManyParams, UpdateManyResult, UpdateParams, UpdateResult } from 'react-admin';
import { BaseProvider } from './base.provider';
export declare class DefaultRestDataProvider<TResource extends string = string> extends BaseProvider<IDataProvider<TResource>> {
    protected restDataProviderOptions: IRestDataProviderOptions;
    protected networkService: DefaultNetworkRequestService;
    constructor(restDataProviderOptions: IRestDataProviderOptions);
    getListHelper<RecordType extends RaRecord = AnyType>(opts: {
        resource: TResource;
        type: TRequestType;
        queryKey: Record<string, AnyType>;
        filter: Record<string, AnyType>;
        requestProps: {
            headers?: HeadersInit;
            body?: AnyType;
            method: TRequestMethod;
        };
    }): Promise<{
        data: RecordType[];
        total?: number;
    }>;
    getList<RecordType extends RaRecord = AnyType>(opts: {
        resource: TResource;
        params: GetListParams & QueryFunctionContext & ICustomParams;
    }): Promise<GetListResult<RecordType>>;
    getOne<RecordType extends RaRecord = AnyType>(opts: {
        resource: TResource;
        params: GetOneParams<RecordType> & QueryFunctionContext & ICustomParams;
    }): Promise<GetOneResult<RecordType>>;
    getMany<RecordType extends RaRecord = AnyType>(opts: {
        resource: TResource;
        params: GetManyParams<RecordType> & QueryFunctionContext & ICustomParams;
    }): Promise<GetManyResult<RecordType>>;
    getManyReference<RecordType extends RaRecord = AnyType>(opts: {
        resource: TResource;
        params: GetManyReferenceParams & QueryFunctionContext & ICustomParams;
    }): Promise<GetManyReferenceResult<RecordType>>;
    update<RecordType extends RaRecord = AnyType>(opts: {
        resource: TResource;
        params: UpdateParams;
    }): Promise<UpdateResult<RecordType>>;
    updateMany<RecordType extends RaRecord = AnyType>(opts: {
        resource: TResource;
        params: UpdateManyParams;
    }): Promise<UpdateManyResult<RecordType>>;
    create<RecordType extends Omit<RaRecord, 'id'> = AnyType, ResultRecordType extends RaRecord = RecordType & {
        id: Identifier;
    }>(opts: {
        resource: TResource;
        params: CreateParams;
    }): Promise<CreateResult<ResultRecordType>>;
    delete<RecordType extends RaRecord = AnyType>(opts: {
        resource: TResource;
        params: DeleteParams<RecordType>;
    }): Promise<DeleteResult<RecordType>>;
    deleteMany<RecordType extends RaRecord = AnyType>(opts: {
        resource: TResource;
        params: DeleteManyParams<RecordType>;
    }): Promise<DeleteManyResult<RecordType>>;
    send<ReturnType = AnyType>(opts: {
        resource: TResource;
        params: ISendParams;
    }): Promise<ISendResponse<ReturnType>>;
    value(): ValueOrPromise<IDataProvider<TResource>>;
}