forked from refinedev/refine
-
Notifications
You must be signed in to change notification settings - Fork 0
/
IDataContext.ts
140 lines (121 loc) · 4.01 KB
/
IDataContext.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
import { SorterResult } from "antd/lib/table/interface";
import { BaseRecord, Identifier } from "../../interfaces";
export interface Pagination {
current?: number;
pageSize?: number;
}
export type Sort = SorterResult<any> | SorterResult<any>[];
export interface Search {
field?: string;
value?: string;
}
// Filters are used as a suffix of a field name:
// | Filter | Description |
// | ------------------- | ------------------------------ |
// | No suffix or `eq` | Equal |
// | ne | Not equal |
// | lt | Less than |
// | gt | Greater than |
// | lte | Less than or equal to |
// | gte | Greater than or equal to |
// | in | Included in an array |
// | nin | Not included in an array |
// | contains | Contains |
// | ncontains | Doesn't contain |
// | containss | Contains, case sensitive |
// | ncontainss | Doesn't contain, case sensitive|
// | null | Is null or not null |
export type CrudOperators =
| "eq"
| "ne"
| "lt"
| "gt"
| "lte"
| "gte"
| "in"
| "nin"
| "contains"
| "ncontains"
| "containss"
| "ncontainss"
| "null";
export type CrudFilter = {
field: string;
operator: CrudOperators;
value: any;
};
export type CrudFilters = CrudFilter[];
export interface GetListResponse<RecordType = BaseRecord> {
data: RecordType[];
total: number;
}
export interface CreateResponse<RecordType = BaseRecord> {
data: RecordType;
}
export interface CreateManyResponse<RecordType = BaseRecord> {
data: RecordType[];
}
export interface UpdateResponse<RecordType = BaseRecord> {
data: RecordType;
}
export interface UpdateManyResponse<RecordType = BaseRecord> {
data: RecordType[];
}
export interface GetOneResponse<RecordType = BaseRecord> {
data: RecordType;
}
export interface GetManyResponse<RecordType = BaseRecord> {
data: RecordType[];
}
export interface DeleteOneResponse<RecordType = BaseRecord> {
data: RecordType;
}
export interface DeleteManyResponse<RecordType = BaseRecord> {
data: RecordType[];
}
export interface IDataContext {
getList: <RecordType extends BaseRecord = BaseRecord>(
resource: string,
params: {
pagination?: Pagination;
search?: Search;
sort?: Sort;
filters?: CrudFilter[];
},
) => Promise<GetListResponse<RecordType>>;
getMany: <RecordType extends BaseRecord = BaseRecord>(
resource: string,
ids: Identifier[],
) => Promise<GetManyResponse<RecordType>>;
getOne: <RecordType extends BaseRecord = BaseRecord>(
resource: string,
id: Identifier,
) => Promise<GetOneResponse<RecordType>>;
create: <RecordType extends BaseRecord = BaseRecord>(
resource: string,
params: BaseRecord,
) => Promise<CreateResponse<RecordType>>;
createMany: <RecordType extends BaseRecord = BaseRecord>(
resource: string,
params: BaseRecord[],
) => Promise<CreateManyResponse<RecordType>>;
update: <RecordType extends BaseRecord = BaseRecord>(
resource: string,
id: Identifier,
params: BaseRecord,
) => Promise<UpdateResponse<RecordType>>;
updateMany: <RecordType extends BaseRecord = BaseRecord>(
resource: string,
ids: Identifier[],
params: BaseRecord,
) => Promise<UpdateManyResponse<RecordType>>;
deleteOne: <RecordType extends BaseRecord = BaseRecord>(
resource: string,
id: Identifier,
) => Promise<DeleteOneResponse<RecordType>>;
deleteMany: <RecordType extends BaseRecord = BaseRecord>(
resource: string,
ids: Identifier[],
) => Promise<DeleteManyResponse<RecordType>>;
getApiUrl: () => string;
}