-
Notifications
You must be signed in to change notification settings - Fork 17
/
Copy pathprismicio-types.d.ts
560 lines (512 loc) · 14.4 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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
// Code generated by Slice Machine. DO NOT EDIT.
import type * as prismic from "@prismicio/client";
type Simplify<T> = { [KeyType in keyof T]: T[KeyType] };
/**
* Item in *Navigation → Links*
*/
export interface NavigationDocumentDataLinksItem {
/**
* Label field in *Navigation → Links*
*
* - **Field Type**: Title
* - **Placeholder**: Optional - Label for the link
* - **API ID Path**: navigation.links[].label
* - **Documentation**: https://prismic.io/docs/field#rich-text-title
*/
label: prismic.TitleField;
/**
* Link field in *Navigation → Links*
*
* - **Field Type**: Link
* - **Placeholder**: Link for navigation item
* - **API ID Path**: navigation.links[].link
* - **Documentation**: https://prismic.io/docs/field#link-content-relationship
*/
link: prismic.LinkField;
}
/**
* Content for Navigation documents
*/
interface NavigationDocumentData {
/**
* Links field in *Navigation*
*
* - **Field Type**: Group
* - **Placeholder**: *None*
* - **API ID Path**: navigation.links[]
* - **Tab**: Main
* - **Documentation**: https://prismic.io/docs/field#group
*/
links: prismic.GroupField<Simplify<NavigationDocumentDataLinksItem>>;
}
/**
* Navigation document from Prismic
*
* - **API ID**: `navigation`
* - **Repeatable**: `false`
* - **Documentation**: https://prismic.io/docs/custom-types
*
* @typeParam Lang - Language API ID of the document.
*/
export type NavigationDocument<Lang extends string = string> =
prismic.PrismicDocumentWithoutUID<
Simplify<NavigationDocumentData>,
"navigation",
Lang
>;
type PageDocumentDataSlicesSlice =
| HeroSlice
| ImageSlice
| TextWithFeaturesSlice
| TextWithImageSlice;
/**
* Content for Page documents
*/
interface PageDocumentData {
/**
* Title field in *Page*
*
* - **Field Type**: Title
* - **Placeholder**: Title for the page
* - **API ID Path**: page.title
* - **Tab**: Main
* - **Documentation**: https://prismic.io/docs/field#rich-text-title
*/
title: prismic.TitleField;
/**
* Slice Zone field in *Page*
*
* - **Field Type**: Slice Zone
* - **Placeholder**: *None*
* - **API ID Path**: page.slices[]
* - **Tab**: Main
* - **Documentation**: https://prismic.io/docs/field#slices
*/
slices: prismic.SliceZone<PageDocumentDataSlicesSlice>;
}
/**
* Page document from Prismic
*
* - **API ID**: `page`
* - **Repeatable**: `true`
* - **Documentation**: https://prismic.io/docs/custom-types
*
* @typeParam Lang - Language API ID of the document.
*/
export type PageDocument<Lang extends string = string> =
prismic.PrismicDocumentWithUID<Simplify<PageDocumentData>, "page", Lang>;
/**
* Content for Settings documents
*/
interface SettingsDocumentData {
/**
* Site Title field in *Settings*
*
* - **Field Type**: Title
* - **Placeholder**: Title of the site
* - **API ID Path**: settings.siteTitle
* - **Tab**: Main
* - **Documentation**: https://prismic.io/docs/field#rich-text-title
*/
siteTitle: prismic.TitleField;
/**
* Logo field in *Settings*
*
* - **Field Type**: Image
* - **Placeholder**: *None*
* - **API ID Path**: settings.logo
* - **Tab**: Main
* - **Documentation**: https://prismic.io/docs/field#image
*/
logo: prismic.ImageField<never>;
/**
* Newsletter Description field in *Settings*
*
* - **Field Type**: Rich Text
* - **Placeholder**: Text above the sign up form
* - **API ID Path**: settings.newsletterDescription
* - **Tab**: Main
* - **Documentation**: https://prismic.io/docs/field#rich-text-title
*/
newsletterDescription: prismic.RichTextField;
/**
* Newsletter Disclaimer field in *Settings*
*
* - **Field Type**: Rich Text
* - **Placeholder**: Small text below sign up form
* - **API ID Path**: settings.newsletterDisclaimer
* - **Tab**: Main
* - **Documentation**: https://prismic.io/docs/field#rich-text-title
*/
newsletterDisclaimer: prismic.RichTextField;
}
/**
* Settings document from Prismic
*
* - **API ID**: `settings`
* - **Repeatable**: `false`
* - **Documentation**: https://prismic.io/docs/custom-types
*
* @typeParam Lang - Language API ID of the document.
*/
export type SettingsDocument<Lang extends string = string> =
prismic.PrismicDocumentWithoutUID<
Simplify<SettingsDocumentData>,
"settings",
Lang
>;
export type AllDocumentTypes =
| NavigationDocument
| PageDocument
| SettingsDocument;
/**
* Primary content in *Hero → Default → Primary*
*/
export interface HeroSliceDefaultPrimary {
/**
* Text field in *Hero → Default → Primary*
*
* - **Field Type**: Rich Text
* - **Placeholder**: Introductory text for the page
* - **API ID Path**: hero.default.primary.text
* - **Documentation**: https://prismic.io/docs/field#rich-text-title
*/
text: prismic.RichTextField;
/**
* Image field in *Hero → Default → Primary*
*
* - **Field Type**: Image
* - **Placeholder**: *None*
* - **API ID Path**: hero.default.primary.image
* - **Documentation**: https://prismic.io/docs/field#image
*/
image: prismic.ImageField<never>;
}
/**
* Default variation for Hero Slice
*
* - **API ID**: `default`
* - **Description**: Hero
* - **Documentation**: https://prismic.io/docs/slice
*/
export type HeroSliceDefault = prismic.SharedSliceVariation<
"default",
Simplify<HeroSliceDefaultPrimary>,
never
>;
/**
* Primary content in *Hero → With Button → Primary*
*/
export interface HeroSliceWithButtonPrimary {
/**
* Text field in *Hero → With Button → Primary*
*
* - **Field Type**: Rich Text
* - **Placeholder**: Introductory text for the page
* - **API ID Path**: hero.withButton.primary.text
* - **Documentation**: https://prismic.io/docs/field#rich-text-title
*/
text: prismic.RichTextField;
/**
* Button Text field in *Hero → With Button → Primary*
*
* - **Field Type**: Text
* - **Placeholder**: *None*
* - **API ID Path**: hero.withButton.primary.buttonText
* - **Documentation**: https://prismic.io/docs/field#key-text
*/
buttonText: prismic.KeyTextField;
/**
* Button Link field in *Hero → With Button → Primary*
*
* - **Field Type**: Link
* - **Placeholder**: *None*
* - **API ID Path**: hero.withButton.primary.buttonLink
* - **Documentation**: https://prismic.io/docs/field#link-content-relationship
*/
buttonLink: prismic.LinkField;
/**
* Image field in *Hero → With Button → Primary*
*
* - **Field Type**: Image
* - **Placeholder**: *None*
* - **API ID Path**: hero.withButton.primary.image
* - **Documentation**: https://prismic.io/docs/field#image
*/
image: prismic.ImageField<never>;
}
/**
* With Button variation for Hero Slice
*
* - **API ID**: `withButton`
* - **Description**: Hero
* - **Documentation**: https://prismic.io/docs/slice
*/
export type HeroSliceWithButton = prismic.SharedSliceVariation<
"withButton",
Simplify<HeroSliceWithButtonPrimary>,
never
>;
/**
* Slice variation for *Hero*
*/
type HeroSliceVariation = HeroSliceDefault | HeroSliceWithButton;
/**
* Hero Shared Slice
*
* - **API ID**: `hero`
* - **Description**: Hero
* - **Documentation**: https://prismic.io/docs/slice
*/
export type HeroSlice = prismic.SharedSlice<"hero", HeroSliceVariation>;
/**
* Primary content in *Image → White → Primary*
*/
export interface ImageSliceWhitePrimary {
/**
* Image field in *Image → White → Primary*
*
* - **Field Type**: Image
* - **Placeholder**: *None*
* - **API ID Path**: image.white.primary.image
* - **Documentation**: https://prismic.io/docs/field#image
*/
image: prismic.ImageField<never>;
/**
* With Accent field in *Image → White → Primary*
*
* - **Field Type**: Boolean
* - **Placeholder**: *None*
* - **Default Value**: true
* - **API ID Path**: image.white.primary.withAccent
* - **Documentation**: https://prismic.io/docs/field#boolean
*/
withAccent: prismic.BooleanField;
}
/**
* White variation for Image Slice
*
* - **API ID**: `white`
* - **Description**: Image
* - **Documentation**: https://prismic.io/docs/slice
*/
export type ImageSliceWhite = prismic.SharedSliceVariation<
"white",
Simplify<ImageSliceWhitePrimary>,
never
>;
/**
* Primary content in *Image → Light Slate → Primary*
*/
export interface ImageSliceLightSlatePrimary {
/**
* Image field in *Image → Light Slate → Primary*
*
* - **Field Type**: Image
* - **Placeholder**: *None*
* - **API ID Path**: image.lightSlate.primary.image
* - **Documentation**: https://prismic.io/docs/field#image
*/
image: prismic.ImageField<never>;
/**
* With Accent field in *Image → Light Slate → Primary*
*
* - **Field Type**: Boolean
* - **Placeholder**: *None*
* - **Default Value**: true
* - **API ID Path**: image.lightSlate.primary.withAccent
* - **Documentation**: https://prismic.io/docs/field#boolean
*/
withAccent: prismic.BooleanField;
}
/**
* Light Slate variation for Image Slice
*
* - **API ID**: `lightSlate`
* - **Description**: Image
* - **Documentation**: https://prismic.io/docs/slice
*/
export type ImageSliceLightSlate = prismic.SharedSliceVariation<
"lightSlate",
Simplify<ImageSliceLightSlatePrimary>,
never
>;
/**
* Slice variation for *Image*
*/
type ImageSliceVariation = ImageSliceWhite | ImageSliceLightSlate;
/**
* Image Shared Slice
*
* - **API ID**: `image`
* - **Description**: Image
* - **Documentation**: https://prismic.io/docs/slice
*/
export type ImageSlice = prismic.SharedSlice<"image", ImageSliceVariation>;
/**
* Item in *TextWithFeatures → Default → Primary → Features*
*/
export interface TextWithFeaturesSliceDefaultPrimaryFeaturesItem {
/**
* Feature Description field in *TextWithFeatures → Default → Primary → Features*
*
* - **Field Type**: Rich Text
* - **Placeholder**: Description of a feature
* - **API ID Path**: text_with_features.default.primary.features[].description
* - **Documentation**: https://prismic.io/docs/field#rich-text-title
*/
description: prismic.RichTextField;
}
/**
* Primary content in *TextWithFeatures → Default → Primary*
*/
export interface TextWithFeaturesSliceDefaultPrimary {
/**
* Icon field in *TextWithFeatures → Default → Primary*
*
* - **Field Type**: Image
* - **Placeholder**: *None*
* - **API ID Path**: text_with_features.default.primary.icon
* - **Documentation**: https://prismic.io/docs/field#image
*/
icon: prismic.ImageField<never>;
/**
* Text field in *TextWithFeatures → Default → Primary*
*
* - **Field Type**: Rich Text
* - **Placeholder**: Primary text with rich formatting
* - **API ID Path**: text_with_features.default.primary.text
* - **Documentation**: https://prismic.io/docs/field#rich-text-title
*/
text: prismic.RichTextField;
/**
* Features field in *TextWithFeatures → Default → Primary*
*
* - **Field Type**: Group
* - **Placeholder**: *None*
* - **API ID Path**: text_with_features.default.primary.features[]
* - **Documentation**: https://prismic.io/docs/field#group
*/
features: prismic.GroupField<
Simplify<TextWithFeaturesSliceDefaultPrimaryFeaturesItem>
>;
}
/**
* Default variation for TextWithFeatures Slice
*
* - **API ID**: `default`
* - **Description**: TextWithFeatures
* - **Documentation**: https://prismic.io/docs/slice
*/
export type TextWithFeaturesSliceDefault = prismic.SharedSliceVariation<
"default",
Simplify<TextWithFeaturesSliceDefaultPrimary>,
never
>;
/**
* Slice variation for *TextWithFeatures*
*/
type TextWithFeaturesSliceVariation = TextWithFeaturesSliceDefault;
/**
* TextWithFeatures Shared Slice
*
* - **API ID**: `text_with_features`
* - **Description**: TextWithFeatures
* - **Documentation**: https://prismic.io/docs/slice
*/
export type TextWithFeaturesSlice = prismic.SharedSlice<
"text_with_features",
TextWithFeaturesSliceVariation
>;
/**
* Primary content in *TextWithImage → Default → Primary*
*/
export interface TextWithImageSliceDefaultPrimary {
/**
* Text field in *TextWithImage → Default → Primary*
*
* - **Field Type**: Rich Text
* - **Placeholder**: Text displayed next to image
* - **API ID Path**: text_with_image.default.primary.text
* - **Documentation**: https://prismic.io/docs/field#rich-text-title
*/
text: prismic.RichTextField;
/**
* Image field in *TextWithImage → Default → Primary*
*
* - **Field Type**: Image
* - **Placeholder**: *None*
* - **API ID Path**: text_with_image.default.primary.image
* - **Documentation**: https://prismic.io/docs/field#image
*/
image: prismic.ImageField<never>;
}
/**
* Default variation for TextWithImage Slice
*
* - **API ID**: `default`
* - **Description**: TextWithImage
* - **Documentation**: https://prismic.io/docs/slice
*/
export type TextWithImageSliceDefault = prismic.SharedSliceVariation<
"default",
Simplify<TextWithImageSliceDefaultPrimary>,
never
>;
/**
* Slice variation for *TextWithImage*
*/
type TextWithImageSliceVariation = TextWithImageSliceDefault;
/**
* TextWithImage Shared Slice
*
* - **API ID**: `text_with_image`
* - **Description**: TextWithImage
* - **Documentation**: https://prismic.io/docs/slice
*/
export type TextWithImageSlice = prismic.SharedSlice<
"text_with_image",
TextWithImageSliceVariation
>;
declare module "@prismicio/client" {
interface CreateClient {
(
repositoryNameOrEndpoint: string,
options?: prismic.ClientConfig,
): prismic.Client<AllDocumentTypes>;
}
namespace Content {
export type {
NavigationDocument,
NavigationDocumentData,
NavigationDocumentDataLinksItem,
PageDocument,
PageDocumentData,
PageDocumentDataSlicesSlice,
SettingsDocument,
SettingsDocumentData,
AllDocumentTypes,
HeroSlice,
HeroSliceDefaultPrimary,
HeroSliceWithButtonPrimary,
HeroSliceVariation,
HeroSliceDefault,
HeroSliceWithButton,
ImageSlice,
ImageSliceWhitePrimary,
ImageSliceLightSlatePrimary,
ImageSliceVariation,
ImageSliceWhite,
ImageSliceLightSlate,
TextWithFeaturesSlice,
TextWithFeaturesSliceDefaultPrimaryFeaturesItem,
TextWithFeaturesSliceDefaultPrimary,
TextWithFeaturesSliceVariation,
TextWithFeaturesSliceDefault,
TextWithImageSlice,
TextWithImageSliceDefaultPrimary,
TextWithImageSliceVariation,
TextWithImageSliceDefault,
};
}
}