drf-react-by-schema 0.15.2 → 0.15.4

package/dist/api.d.ts

@@ -1,14 +1,8 @@
+import { AxiosError } from 'axios';
 import { serverEndPointType } from './context/DRFReactBySchemaContext';
-import { Item, SchemaType, modelOptionsType, DataSchemaColumnsType, ItemSchemaColumnsType, PaginatedResult } from './utils';
+import { Item, SchemaType, modelOptionsType, DataSchemaColumnsType, ItemSchemaColumnsType, Id, TargetApiParams } from './utils';
 import { GridFilterModel, GridSortModel } from '@mui/x-data-grid';
 import { AlertColor } from '@mui/material/Alert';
-type Id = string | number | null;
-export interface TargetApiParams {
-    path: string;
-    serverEndPoint: serverEndPointType | null;
-    data: Item;
-    id: Id;
-}
 interface TargetApiParamsOptionalId {
     path: string;
     serverEndPoint: serverEndPointType | null;
@@ -18,17 +12,17 @@ interface TargetApiParamsOptionalId {
 export declare const getRawData: ({ path, serverEndPoint, }: {
     path: string;
     serverEndPoint: serverEndPointType | null;
-}) => Promise<any>;
+}) => Promise<Item[] | AxiosError<unknown, any>>;
 /**
  *
  * @param options - params
- * @returns Id when succesfully updated, false otherwise
+ * @returns updatedData when succesfully updated, axiosError otherwise
  */
-export declare const updateData: ({ path, serverEndPoint, data, id }: TargetApiParams) => Promise<any>;
-export declare const partialUpdateData: ({ path, serverEndPoint, data, id }: TargetApiParams) => Promise<any>;
-export declare const createData: ({ path, serverEndPoint, data }: Omit<TargetApiParams, 'id'>) => Promise<any>;
-export declare const deleteData: (path: string, serverEndPoint: serverEndPointType | null, id: Id) => Promise<boolean>;
-export declare const createOrUpdateData: ({ path, serverEndPoint, data, id, }: TargetApiParamsOptionalId) => Promise<any>;
+export declare const updateData: ({ path, serverEndPoint, data, id }: TargetApiParams) => Promise<Item>;
+export declare const partialUpdateData: ({ path, serverEndPoint, data, id }: TargetApiParams) => Promise<Item>;
+export declare const createData: ({ path, serverEndPoint, data }: Omit<TargetApiParams, 'id'>) => Promise<Item>;
+export declare const deleteData: (path: string, serverEndPoint: serverEndPointType | null, id: Id) => Promise<true | AxiosError<unknown, any>>;
+export declare const createOrUpdateData: ({ path, serverEndPoint, data, id, }: TargetApiParamsOptionalId) => Promise<Item>;
 export declare const updateDataBySchema: ({ model, modelObjectId, serverEndPoint, data, schema, path, }: {
     model: string;
     modelObjectId: Id;
@@ -36,24 +30,24 @@ export declare const updateDataBySchema: ({ model, modelObjectId, serverEndPoint
     data: Item;
     schema: SchemaType;
     path?: string | null | undefined;
-}) => Promise<any>;
+}) => Promise<Item>;
 export declare const addExistingRelatedModel: ({ model, serverEndPoint, id, data, }: {
     model: string;
     serverEndPoint: serverEndPointType | null;
     id: Id;
     data: Item;
-}) => Promise<any>;
+}) => Promise<Item>;
 export declare const getAutoComplete: ({ model, serverEndPoint, }: {
     model: string;
     serverEndPoint: serverEndPointType | null;
 }) => Promise<false | Item[]>;
-export declare const loginByPayload: (payload: Item, serverEndPoint: serverEndPointType | null) => Promise<boolean>;
+export declare const loginByPayload: (payload: Item, serverEndPoint: serverEndPointType | null) => Promise<boolean | AxiosError<unknown, any>>;
 export declare const clearJWT: () => boolean;
 export declare const hasJWT: () => boolean;
 export declare const setAuthToken: (token: string | null) => void;
-export declare const isLoggedIn: (serverEndPoint: serverEndPointType | null) => Promise<false | Item[] | PaginatedResult>;
-export declare const getSignUpOptions: (serverEndPoint: serverEndPointType | null) => Promise<false | SchemaType>;
-export declare const signUp: (data: Item, serverEndPoint: serverEndPointType | null) => Promise<any>;
+export declare const isLoggedIn: (serverEndPoint: serverEndPointType | null) => Promise<false | Item>;
+export declare const getSignUpOptions: (serverEndPoint: serverEndPointType | null) => Promise<SchemaType | AxiosError<unknown, any>>;
+export declare const signUp: (data: Item, serverEndPoint: serverEndPointType | null) => Promise<Item>;
 export interface GetGenericModelListProps {
     model: string;
     serverEndPoint: serverEndPointType | null;
@@ -91,5 +85,5 @@ export declare const getGenericModel: ({ model, serverEndPoint, id, relatedModel
     relatedModel?: string | undefined;
     relatedModelId?: string | undefined;
 }) => Promise<false | ItemSchemaColumnsType>;
-export declare const getAllModels: (serverEndPoint: serverEndPointType | null) => Promise<Item[] | PaginatedResult>;
+export declare const getAllModels: (serverEndPoint: serverEndPointType | null) => Promise<Item[] | AxiosError<unknown, any>>;
 export {};