-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathtypeDefs.txt
737 lines (641 loc) · 18.3 KB
/
typeDefs.txt
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
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
### Type definitions saved at 2023-11-15T22:58:31.256Z ###
enum RemoteFileFit {
COVER
FILL
OUTSIDE
CONTAIN
}
enum RemoteFileFormat {
AUTO
JPG
PNG
WEBP
AVIF
}
enum RemoteFileLayout {
FIXED
FULL_WIDTH
CONSTRAINED
}
enum RemoteFilePlaceholder {
DOMINANT_COLOR
BLURRED
TRACED_SVG
NONE
}
enum RemoteFileCropFocus {
CENTER
TOP
RIGHT
BOTTOM
LEFT
ENTROPY
EDGES
FACES
}
type RemoteFileResize {
width: Int
height: Int
src: String
}
"""Remote Interface"""
interface RemoteFile {
id: ID!
mimeType: String!
filename: String!
filesize: Int
width: Int
height: Int
publicUrl: String!
resize(
width: Int
height: Int
aspectRatio: Float
fit: RemoteFileFit = COVER
"""
The image formats to generate. Valid values are AUTO (meaning the same
format as the source image), JPG, PNG, WEBP and AVIF.
The default value is [AUTO, WEBP, AVIF], and you should rarely need to
change this. Take care if you specify JPG or PNG when you do
not know the formats of the source images, as this could lead to unwanted
results such as converting JPEGs to PNGs. Specifying
both PNG and JPG is not supported and will be ignored.
"""
format: RemoteFileFormat = AUTO
cropFocus: [RemoteFileCropFocus]
quality: Int = 75
): RemoteFileResize
"""
Data used in the <GatsbyImage /> component. See https://gatsby.dev/img for more info.
"""
gatsbyImage(
"""
The layout for the image.
FIXED: A static image sized, that does not resize according to the screen width
FULL_WIDTH: The image resizes to fit its container. Pass a "sizes" option if
it isn't going to be the full width of the screen.
CONSTRAINED: Resizes to fit its container, up to a maximum width, at which point it will remain fixed in size.
"""
layout: RemoteFileLayout = CONSTRAINED
"""
The display width of the generated image for layout = FIXED, and the display
width of the largest image for layout = CONSTRAINED.
The actual largest image resolution will be this value multiplied by the largest value in outputPixelDensities
Ignored if layout = FLUID.
"""
width: Int
"""
If set, the height of the generated image. If omitted, it is calculated from
the supplied width, matching the aspect ratio of the source image.
"""
height: Int
"""
Format of generated placeholder image, displayed while the main image loads.
BLURRED: a blurred, low resolution image, encoded as a base64 data URI
DOMINANT_COLOR: a solid color, calculated from the dominant color of the image (default).
TRACED_SVG: deprecated. Will use DOMINANT_COLOR.
NONE: no placeholder. Set the argument "backgroundColor" to use a fixed background color.
"""
placeholder: RemoteFilePlaceholder = DOMINANT_COLOR
"""
If set along with width or height, this will set the value of the other
dimension to match the provided aspect ratio, cropping the image if needed.
If neither width or height is provided, height will be set based on the intrinsic width of the source image.
"""
aspectRatio: Float
"""
The image formats to generate. Valid values are AUTO (meaning the same
format as the source image), JPG, PNG, WEBP and AVIF.
The default value is [AUTO, WEBP, AVIF], and you should rarely need to
change this. Take care if you specify JPG or PNG when you do
not know the formats of the source images, as this could lead to unwanted
results such as converting JPEGs to PNGs. Specifying
both PNG and JPG is not supported and will be ignored.
"""
formats: [RemoteFileFormat!] = [AUTO, WEBP, AVIF]
"""
A list of image pixel densities to generate for FIXED and CONSTRAINED
images. You should rarely need to change this. It will never generate images
larger than the source, and will always include a 1x image.
Default is [ 1, 2 ] for fixed images, meaning 1x, 2x, and [0.25, 0.5, 1, 2]
for fluid. In this case, an image with a fluid layout and width = 400 would
generate images at 100, 200, 400 and 800px wide.
"""
outputPixelDensities: [Float] = [0.25, 0.5, 1, 2]
"""
Specifies the image widths to generate. You should rarely need to change
this. For FIXED and CONSTRAINED images it is better to allow these to be
determined automatically,
based on the image size. For FULL_WIDTH images this can be used to override
the default, which is [750, 1080, 1366, 1920].
It will never generate any images larger than the source.
"""
breakpoints: [Int] = [750, 1080, 1366, 1920]
"""
The "sizes" property, passed to the img tag. This describes the display size of the image.
This does not affect the generated images, but is used by the browser to
decide which images to download. You can leave this blank for fixed images,
or if the responsive image
container will be the full width of the screen. In these cases we will generate an appropriate value.
"""
sizes: String
"""
Background color applied to the wrapper, or when "letterboxing" an image to another aspect ratio.
"""
backgroundColor: String
fit: RemoteFileFit = COVER
cropFocus: [RemoteFileCropFocus]
quality: Int = 75
): GatsbyImageData
}
type File implements Node @dontInfer {
sourceInstanceName: String!
absolutePath: String!
relativePath: String!
extension: String!
size: Int!
prettySize: String!
modifiedTime: Date! @dateformat
accessTime: Date! @dateformat
changeTime: Date! @dateformat
birthTime: Date! @dateformat
root: String!
dir: String!
base: String!
ext: String!
name: String!
relativeDirectory: String!
dev: Int!
mode: Int!
nlink: Int!
uid: Int!
gid: Int!
rdev: Int!
ino: Float!
atimeMs: Float!
mtimeMs: Float!
ctimeMs: Float!
atime: Date! @dateformat
mtime: Date! @dateformat
ctime: Date! @dateformat
birthtime: Date @deprecated(reason: "Use `birthTime` instead")
birthtimeMs: Float @deprecated(reason: "Use `birthTime` instead")
blksize: Int
blocks: Int
}
type Directory implements Node @dontInfer {
sourceInstanceName: String!
absolutePath: String!
relativePath: String!
extension: String!
size: Int!
prettySize: String!
modifiedTime: Date! @dateformat
accessTime: Date! @dateformat
changeTime: Date! @dateformat
birthTime: Date! @dateformat
root: String!
dir: String!
base: String!
ext: String!
name: String!
relativeDirectory: String!
dev: Int!
mode: Int!
nlink: Int!
uid: Int!
gid: Int!
rdev: Int!
ino: Float!
atimeMs: Float!
mtimeMs: Float!
ctimeMs: Float!
atime: Date! @dateformat
mtime: Date! @dateformat
ctime: Date! @dateformat
birthtime: Date @deprecated(reason: "Use `birthTime` instead")
birthtimeMs: Float @deprecated(reason: "Use `birthTime` instead")
}
type Site implements Node @derivedTypes @dontInfer {
buildTime: Date @dateformat
siteMetadata: SiteMetadata!
port: Int
host: String
trailingSlash: String
adapter: SiteAdapter
headers: [SiteHeaders]
polyfill: Boolean
pathPrefix: String
jsxRuntime: String
graphqlTypegen: Boolean
}
type SiteMetadata @derivedTypes {
title: String!
siteUrl: String!
description: String!
twitterUsername: String
author: SiteSiteMetadataAuthor
siteImage: String
siteRss: String
siteSitemap: String
location: String
social: SiteSiteMetadataSocial
}
type SiteSiteMetadataAuthor {
name: String
url: String
summary: String
}
type SiteSiteMetadataSocial {
email: String
phone: String
facebook: String
instagram: String
twitter: String
linkedin: String
github: String
}
type SiteAdapter {
name: String
}
type SiteHeaders @derivedTypes {
source: String
headers: [SiteHeadersHeaders]
}
type SiteHeadersHeaders {
key: String
value: String
}
type SiteSiteMetadata {
title: String
description: String
}
type SiteFunction implements Node @dontInfer {
functionRoute: String!
pluginName: String!
originalAbsoluteFilePath: String!
originalRelativeFilePath: String!
relativeCompiledFilePath: String!
absoluteCompiledFilePath: String!
matchPath: String
}
type SitePage implements Node @dontInfer {
path: String!
component: String!
internalComponentName: String!
componentChunkName: String!
matchPath: String
pageContext: JSON @proxy(from: "context", fromNode: false)
pluginCreator: SitePlugin @link(by: "id", from: "pluginCreatorId")
}
type SitePlugin implements Node @dontInfer {
resolve: String
name: String
version: String
nodeAPIs: [String]
browserAPIs: [String]
ssrAPIs: [String]
pluginFilepath: String
pluginOptions: JSON
packageJson: JSON
}
type SiteBuildMetadata implements Node @dontInfer {
buildTime: Date @dateformat
}
enum GatsbyImageFormat {
NO_CHANGE
AUTO
JPG
PNG
WEBP
AVIF
}
enum GatsbyImageLayout {
FIXED
FULL_WIDTH
CONSTRAINED
}
enum GatsbyImagePlaceholder {
DOMINANT_COLOR
TRACED_SVG
BLURRED
NONE
}
enum ImageFormat {
NO_CHANGE
AUTO
JPG
PNG
WEBP
AVIF
}
enum ImageFit {
COVER
CONTAIN
FILL
INSIDE
OUTSIDE
}
enum ImageLayout {
FIXED
FULL_WIDTH
CONSTRAINED
}
enum ImageCropFocus {
CENTER
NORTH
NORTHEAST
EAST
SOUTHEAST
SOUTH
SOUTHWEST
WEST
NORTHWEST
ENTROPY
ATTENTION
}
input DuotoneGradient {
highlight: String!
shadow: String!
opacity: Int
}
enum PotraceTurnPolicy {
TURNPOLICY_BLACK
TURNPOLICY_WHITE
TURNPOLICY_LEFT
TURNPOLICY_RIGHT
TURNPOLICY_MINORITY
TURNPOLICY_MAJORITY
}
input Potrace {
turnPolicy: PotraceTurnPolicy
turdSize: Float
alphaMax: Float
optCurve: Boolean
optTolerance: Float
threshold: Int
blackOnWhite: Boolean
color: String
background: String
}
type ImageSharpFixed {
base64: String
tracedSVG: String
aspectRatio: Float
width: Float!
height: Float!
src: String!
srcSet: String!
srcWebp: String
srcSetWebp: String
originalName: String
}
type ImageSharpFluid {
base64: String
tracedSVG: String
aspectRatio: Float!
src: String!
srcSet: String!
srcWebp: String
srcSetWebp: String
sizes: String!
originalImg: String
originalName: String
presentationWidth: Int!
presentationHeight: Int!
}
enum ImagePlaceholder {
DOMINANT_COLOR
TRACED_SVG
BLURRED
NONE
}
input BlurredOptions {
"""Width of the generated low-res preview. Default is 20px"""
width: Int
"""
Force the output format for the low-res preview. Default is to use the same
format as the input. You should rarely need to change this
"""
toFormat: ImageFormat
}
input JPGOptions {
quality: Int
progressive: Boolean = true
}
input PNGOptions {
quality: Int
compressionSpeed: Int = 4
}
input WebPOptions {
quality: Int
}
input AVIFOptions {
quality: Int
lossless: Boolean
speed: Int
}
input TransformOptions {
grayscale: Boolean
duotone: DuotoneGradient
rotate: Int
trim: Float
cropFocus: ImageCropFocus = ATTENTION
fit: ImageFit = COVER
}
type ImageSharpOriginal {
width: Float
height: Float
src: String
}
type ImageSharpResize {
src: String
tracedSVG: String
width: Int
height: Int
aspectRatio: Float
originalName: String
}
type ImageSharp implements Node @childOf(types: ["File"]) @dontInfer {
fixed(width: Int, height: Int, base64Width: Int, jpegProgressive: Boolean = true, pngCompressionSpeed: Int = 4, grayscale: Boolean, duotone: DuotoneGradient, traceSVG: Potrace, quality: Int, jpegQuality: Int, pngQuality: Int, webpQuality: Int, toFormat: ImageFormat, toFormatBase64: ImageFormat, cropFocus: ImageCropFocus = ATTENTION, fit: ImageFit = COVER, background: String = "rgba(0,0,0,1)", rotate: Int, trim: Float): ImageSharpFixed
fluid(
maxWidth: Int
maxHeight: Int
base64Width: Int
grayscale: Boolean
jpegProgressive: Boolean = true
pngCompressionSpeed: Int = 4
duotone: DuotoneGradient
traceSVG: Potrace
quality: Int
jpegQuality: Int
pngQuality: Int
webpQuality: Int
toFormat: ImageFormat
toFormatBase64: ImageFormat
cropFocus: ImageCropFocus = ATTENTION
fit: ImageFit = COVER
background: String = "rgba(0,0,0,1)"
rotate: Int
trim: Float
sizes: String
"""
A list of image widths to be generated. Example: [ 200, 340, 520, 890 ]
"""
srcSetBreakpoints: [Int] = []
): ImageSharpFluid
gatsbyImageData(
"""
The layout for the image.
FIXED: A static image sized, that does not resize according to the screen width
FULL_WIDTH: The image resizes to fit its container. Pass a "sizes" option if
it isn't going to be the full width of the screen.
CONSTRAINED: Resizes to fit its container, up to a maximum width, at which point it will remain fixed in size.
"""
layout: ImageLayout = CONSTRAINED
"""
The display width of the generated image for layout = FIXED, and the maximum
display width of the largest image for layout = CONSTRAINED.
Ignored if layout = FLUID.
"""
width: Int
"""
The display height of the generated image for layout = FIXED, and the
maximum display height of the largest image for layout = CONSTRAINED.
The image will be cropped if the aspect ratio does not match the source
image. If omitted, it is calculated from the supplied width,
matching the aspect ratio of the source image.
"""
height: Int
"""
If set along with width or height, this will set the value of the other
dimension to match the provided aspect ratio, cropping the image if needed.
If neither width or height is provided, height will be set based on the intrinsic width of the source image.
"""
aspectRatio: Float
"""
Format of generated placeholder image, displayed while the main image loads.
BLURRED: a blurred, low resolution image, encoded as a base64 data URI
DOMINANT_COLOR: a solid color, calculated from the dominant color of the image (default).
TRACED_SVG: deprecated. Will use DOMINANT_COLOR.
NONE: no placeholder. Set "background" to use a fixed background color.
"""
placeholder: ImagePlaceholder
"""
Options for the low-resolution placeholder image. Set placeholder to "BLURRED" to use this
"""
blurredOptions: BlurredOptions
"""
Options for traced placeholder SVGs. You also should set placeholder to "TRACED_SVG".
"""
tracedSVGOptions: Potrace
"""
The image formats to generate. Valid values are "AUTO" (meaning the same
format as the source image), "JPG", "PNG", "WEBP" and "AVIF".
The default value is [AUTO, WEBP], and you should rarely need to change
this. Take care if you specify JPG or PNG when you do
not know the formats of the source images, as this could lead to unwanted
results such as converting JPEGs to PNGs. Specifying
both PNG and JPG is not supported and will be ignored.
"""
formats: [ImageFormat]
"""
A list of image pixel densities to generate. It will never generate images
larger than the source, and will always include a 1x image.
Default is [ 1, 2 ] for FIXED images, meaning 1x and 2x and [0.25, 0.5, 1,
2] for CONSTRAINED. In this case, an image with a constrained layout
and width = 400 would generate images at 100, 200, 400 and 800px wide.
Ignored for FULL_WIDTH images, which use breakpoints instead
"""
outputPixelDensities: [Float]
"""
Specifies the image widths to generate. For FIXED and CONSTRAINED images it
is better to allow these to be determined automatically,
based on the image size. For FULL_WIDTH images this can be used to override
the default, which is [750, 1080, 1366, 1920].
It will never generate any images larger than the source.
"""
breakpoints: [Int]
"""
The "sizes" property, passed to the img tag. This describes the display size of the image.
This does not affect the generated images, but is used by the browser to decide which images to download.
You should usually leave this blank, and a suitable value will be calculated. The exception is if a FULL_WIDTH image
does not actually span the full width of the screen, in which case you should pass the correct size here.
"""
sizes: String
"""The default quality. This is overridden by any format-specific options"""
quality: Int
"""Options to pass to sharp when generating JPG images."""
jpgOptions: JPGOptions
"""Options to pass to sharp when generating PNG images."""
pngOptions: PNGOptions
"""Options to pass to sharp when generating WebP images."""
webpOptions: WebPOptions
"""Options to pass to sharp when generating AVIF images."""
avifOptions: AVIFOptions
"""
Options to pass to sharp to control cropping and other image manipulations.
"""
transformOptions: TransformOptions
"""
Background color applied to the wrapper. Also passed to sharp to use as a
background when "letterboxing" an image to another aspect ratio.
"""
backgroundColor: String
): GatsbyImageData!
original: ImageSharpOriginal
resize(width: Int, height: Int, quality: Int, jpegQuality: Int, pngQuality: Int, webpQuality: Int, jpegProgressive: Boolean = true, pngCompressionLevel: Int = 9, pngCompressionSpeed: Int = 4, grayscale: Boolean, duotone: DuotoneGradient, base64: Boolean, traceSVG: Potrace, toFormat: ImageFormat, cropFocus: ImageCropFocus = ATTENTION, fit: ImageFit = COVER, background: String = "rgba(0,0,0,1)", rotate: Int, trim: Float): ImageSharpResize
}
type MdxFrontmatter {
title: String!
image: File @fileByRelativePath
published: Boolean
featuredPost: Boolean
author: String
path: String
date: Date @dateformat
category: String
tags: [String]
publicId: String
videoTitle: String
embeddedImagesLocal: [File] @fileByRelativePath
description: String
featured: Boolean
videoUrl: String
videoPoster: String
}
type MdxHeadingMdx {
value: String
depth: Int
}
enum HeadingsMdx {
h1
h2
h3
h4
h5
h6
}
type MdxWordCount {
paragraphs: Int
sentences: Int
words: Int
}
type Mdx implements Node @childOf(mimeTypes: ["text/markdown", "text/x-markdown"], types: ["File"]) @dontInfer {
rawBody: String!
fileAbsolutePath: String!
frontmatter: MdxFrontmatter!
slug: String!
body: String!
excerpt(pruneLength: Int = 140, truncate: Boolean): String!
headings(depth: HeadingsMdx): [MdxHeadingMdx]
html: String
mdxAST: JSON
tableOfContents(maxDepth: Int): JSON
timeToRead: Int
wordCount: MdxWordCount
}
type Frontmatter {
title: String!
embeddedImagesLocal: File @fileByRelativePath
}