-
Notifications
You must be signed in to change notification settings - Fork 1
/
prismicio-types.d.ts
244 lines (222 loc) · 5.9 KB
/
prismicio-types.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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
// Code generated by Slice Machine. DO NOT EDIT.
import type * as prismic from "@prismicio/client";
type Simplify<T> = { [KeyType in keyof T]: T[KeyType] };
/**
* Content for Author documents
*/
interface AuthorDocumentData {
/**
* First Name field in *Author*
*
* - **Field Type**: Text
* - **Placeholder**: *None*
* - **API ID Path**: author.first_name
* - **Tab**: Main
* - **Documentation**: https://prismic.io/docs/field#key-text
*/
first_name: prismic.KeyTextField;
/**
* Last Name field in *Author*
*
* - **Field Type**: Text
* - **Placeholder**: *None*
* - **API ID Path**: author.last_name
* - **Tab**: Main
* - **Documentation**: https://prismic.io/docs/field#key-text
*/
last_name: prismic.KeyTextField;
/**
* Avatar field in *Author*
*
* - **Field Type**: Image
* - **Placeholder**: *None*
* - **API ID Path**: author.avatar
* - **Tab**: Main
* - **Documentation**: https://prismic.io/docs/field#image
*/
avatar: prismic.ImageField<never>;
}
/**
* Author document from Prismic
*
* - **API ID**: `author`
* - **Repeatable**: `true`
* - **Documentation**: https://prismic.io/docs/custom-types
*
* @typeParam Lang - Language API ID of the document.
*/
export type AuthorDocument<Lang extends string = string> = prismic.PrismicDocumentWithUID<
Simplify<AuthorDocumentData>,
"author",
Lang
>;
type BlogDocumentDataSlicesSlice = never;
/**
* Content for Blog documents
*/
interface BlogDocumentData {
/**
* Cover Image field in *Blog*
*
* - **Field Type**: Image
* - **Placeholder**: *None*
* - **API ID Path**: blog.cover_image
* - **Tab**: Main
* - **Documentation**: https://prismic.io/docs/field#image
*/
cover_image: prismic.ImageField<never>;
/**
* Title field in *Blog*
*
* - **Field Type**: Text
* - **Placeholder**: *None*
* - **API ID Path**: blog.title
* - **Tab**: Main
* - **Documentation**: https://prismic.io/docs/field#key-text
*/
title: prismic.KeyTextField;
/**
* Summary field in *Blog*
*
* - **Field Type**: Text
* - **Placeholder**: Article Summary
* - **API ID Path**: blog.post_summary
* - **Tab**: Main
* - **Documentation**: https://prismic.io/docs/field#key-text
*/
post_summary: prismic.KeyTextField;
/**
* Post Date field in *Blog*
*
* - **Field Type**: Date
* - **Placeholder**: *None*
* - **API ID Path**: blog.post_date
* - **Tab**: Main
* - **Documentation**: https://prismic.io/docs/field#date
*/
post_date: prismic.DateField;
/**
* Content field in *Blog*
*
* - **Field Type**: Rich Text
* - **Placeholder**: *None*
* - **API ID Path**: blog.content
* - **Tab**: Main
* - **Documentation**: https://prismic.io/docs/field#rich-text-title
*/
content: prismic.RichTextField;
/**
* Author field in *Blog*
*
* - **Field Type**: Content Relationship
* - **Placeholder**: *None*
* - **API ID Path**: blog.author
* - **Tab**: Main
* - **Documentation**: https://prismic.io/docs/field#link-content-relationship
*/
author: prismic.ContentRelationshipField<"author">;
/**
* Category field in *Blog*
*
* - **Field Type**: Content Relationship
* - **Placeholder**: *None*
* - **API ID Path**: blog.category
* - **Tab**: Main
* - **Documentation**: https://prismic.io/docs/field#link-content-relationship
*/
category: prismic.ContentRelationshipField<"category">;
/**
* Slice Zone field in *Blog*
*
* - **Field Type**: Slice Zone
* - **Placeholder**: *None*
* - **API ID Path**: blog.slices[]
* - **Tab**: Main
* - **Documentation**: https://prismic.io/docs/field#slices
*/
slices: prismic.SliceZone<BlogDocumentDataSlicesSlice>;
/**
* Meta Title field in *Blog*
*
* - **Field Type**: Text
* - **Placeholder**: A title of the page used for social media and search engines
* - **API ID Path**: blog.meta_title
* - **Tab**: SEO & Metadata
* - **Documentation**: https://prismic.io/docs/field#key-text
*/
meta_title: prismic.KeyTextField;
/**
* Meta Description field in *Blog*
*
* - **Field Type**: Text
* - **Placeholder**: A brief summary of the page
* - **API ID Path**: blog.meta_description
* - **Tab**: SEO & Metadata
* - **Documentation**: https://prismic.io/docs/field#key-text
*/
meta_description: prismic.KeyTextField;
}
/**
* Blog document from Prismic
*
* - **API ID**: `blog`
* - **Repeatable**: `true`
* - **Documentation**: https://prismic.io/docs/custom-types
*
* @typeParam Lang - Language API ID of the document.
*/
export type BlogDocument<Lang extends string = string> = prismic.PrismicDocumentWithUID<
Simplify<BlogDocumentData>,
"blog",
Lang
>;
/**
* Content for Category documents
*/
interface CategoryDocumentData {
/**
* Name field in *Category*
*
* - **Field Type**: Text
* - **Placeholder**: *None*
* - **API ID Path**: category.name
* - **Tab**: Main
* - **Documentation**: https://prismic.io/docs/field#key-text
*/
name: prismic.KeyTextField;
}
/**
* Category document from Prismic
*
* - **API ID**: `category`
* - **Repeatable**: `true`
* - **Documentation**: https://prismic.io/docs/custom-types
*
* @typeParam Lang - Language API ID of the document.
*/
export type CategoryDocument<Lang extends string = string> = prismic.PrismicDocumentWithUID<
Simplify<CategoryDocumentData>,
"category",
Lang
>;
export type AllDocumentTypes = AuthorDocument | BlogDocument | CategoryDocument;
declare module "@prismicio/client" {
interface CreateClient {
(
repositoryNameOrEndpoint: string,
options?: prismic.ClientConfig,
): prismic.Client<AllDocumentTypes>;
}
namespace Content {
export type {
AuthorDocument,
AuthorDocumentData,
BlogDocument,
BlogDocumentData,
BlogDocumentDataSlicesSlice,
CategoryDocument,
CategoryDocumentData,
AllDocumentTypes,
};
}
}