-
Notifications
You must be signed in to change notification settings - Fork 49
/
index.d.ts
166 lines (142 loc) 路 3.29 KB
/
index.d.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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
export type DirectusUser = object | null;
export interface DirectusAuthCredentials {
email: string;
password: string;
otp?: string;
}
export interface DirectusAuthResponse {
user: DirectusUser;
access_token: string;
expires: number;
refresh_token?: string;
}
export interface DirectusPasswordForgotCredentials {
email: string;
reset_url?: string;
}
export interface DirectusPasswordResetCredentials {
token: string;
password: string;
}
export interface DirectusQueryParams {
fields?: Array<string>;
sort?: string | Array<string>;
filter?: Record<string, unknown>;
limit?: number;
offset?: number;
page?: number;
alias?: string | Array<string>;
deep?: Record<string, unknown>;
search?: string;
meta?: 'total_count' | 'filter_count' | '*';
}
export interface DirectusItemRequest {
collection: string;
id?: string;
params?: DirectusQueryParams;
}
export interface DirectusItemCreation {
collection: string;
items: Array<Object> | Object;
}
export interface DirectusItemUpdate {
collection: string;
id: string;
item: Object;
}
export interface DirectusItemDeletion {
collection: string;
items: Array<string> | string;
}
// User Interfaces
export interface DirectusUserRequest {
id?: string;
params?: DirectusQueryParams;
}
export interface DirectusUserCreation {
users: Array<Object> | Object;
}
export interface DirectusUserUpdate {
id: string;
user: Object;
}
export interface DirectusUserDeletion {
users: Array<string> | string;
}
export type DirectusThumbnailFormat = 'jpg' | 'png' | 'webp' | 'tiff';
export type DirectusThumbnailFit = 'cover' | 'contain' | 'inside' | 'outside';
export interface DirectusThumbnailOptions {
width?: number;
height?: number;
quality?: number;
fit?: DirectusThumbnailFit;
format?: DirectusThumbnailFormat;
withoutEnlargement?: boolean;
key?: string;
}
export interface DirectusRegisterCredentials {
email: string;
password: string;
}
export type DirectusFile = object | null;
export interface DirectusFileRequest {
id?: string;
params?: DirectusQueryParams;
}
export interface DirectusNotificationObject {
id?: number;
timestamp?: string;
status?: 'inbox' | 'archived';
recipient: Array<string> | string;
sender?: Array<string> | string;
subject: string;
message?: string;
collection?: string;
item?: string;
}
export interface DirectusCollectionRequest {
collection?: string;
}
export interface DirectusCollectionMeta {
collection?: string;
icon?: string;
note?: string;
display_template?: string;
hidden?: boolean;
singleton?: boolean;
translations?: [
{
language?: string;
translation?: string;
}
];
archive_field?: string;
archive_value?: string;
unarchive_value?: string;
archive_app_filter?: boolean;
sort_field?: string;
item_duplication_fields?: string[];
sort?: number;
collapse?: 'open' | 'closed' | 'locked';
}
export interface DirectusCollectionCreation {
collection: string;
meta?: DirectusCollectionMeta;
schema?: {
name?: string;
comment?: string;
};
}
export interface DirectusCollectionUpdate {
collection: string;
meta: DirectusCollectionMeta;
}
export interface DirectusRevision {
id: number;
activity?: any;
collection: string;
item?: string;
data?: Object;
delta?: Object;
parent?: any;
}