-
Notifications
You must be signed in to change notification settings - Fork 29
/
types.ts
129 lines (111 loc) · 2.35 KB
/
types.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
export type Fetch = typeof fetch;
/**
* microCMS createClient params
*/
export interface MicroCMSClient {
serviceDomain: string;
apiKey: string;
customFetch?: Fetch;
}
type depthNumber = 1 | 2 | 3;
/**
* microCMS queries
* https://document.microcms.io/content-api/get-list-contents#h9ce528688c
* https://document.microcms.io/content-api/get-content#h9ce528688c
*/
export interface MicroCMSQueries {
draftKey?: string;
limit?: number;
offset?: number;
orders?: string;
fields?: string | string[];
q?: string;
depth?: depthNumber;
ids?: string | string[];
filters?: string;
}
/**
* microCMS contentId
* https://document.microcms.io/manual/content-id-setting
*/
export interface MicroCMSContentId {
id: string;
}
/**
* microCMS content common date
*/
export interface MicroCMSDate {
createdAt: string;
updatedAt: string;
publishedAt?: string;
revisedAt?: string;
}
/**
* microCMS image
*/
export interface MicroCMSImage {
url: string;
width?: number;
height?: number;
}
/**
* microCMS list api Response
*/
export interface MicroCMSListResponse<T> {
contents: (T & MicroCMSListContent)[];
totalCount: number;
limit: number;
offset: number;
}
/**
* microCMS list content common types
*/
export type MicroCMSListContent = MicroCMSContentId & MicroCMSDate;
/**
* microCMS object content common types
*/
export type MicroCMSObjectContent = MicroCMSDate;
export interface MakeRequest {
endpoint: string;
contentId?: string;
queries?: MicroCMSQueries & Record<string, any>;
method?: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
customHeaders?: HeadersInit;
customBody?: string;
}
export interface GetRequest {
endpoint: string;
contentId?: string;
queries?: MicroCMSQueries;
}
export interface GetListDetailRequest {
endpoint: string;
contentId: string;
queries?: MicroCMSQueries;
}
export interface GetListRequest {
endpoint: string;
queries?: MicroCMSQueries;
}
export interface GetObjectRequest {
endpoint: string;
queries?: MicroCMSQueries;
}
export interface WriteApiRequestResult {
id: string;
}
export interface CreateRequest<T> {
endpoint: string;
contentId?: string;
content: T;
isDraft?: boolean;
}
export interface UpdateRequest<T> {
endpoint: string;
contentId?: string;
content: Partial<T>;
}
export interface DeleteRequest {
endpoint: string;
contentId: string;
}