oxc-graphql-parser 0.0.4

Spec-compliant GraphQL parser.
Documentation
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
use crate::Error;
use crate::LimitTracker;
use std::fmt;
use std::slice::Iter;

pub use oxc_allocator::{Box as AstBox, Vec as AstVec};

#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Hash)]
pub struct Span {
    pub start: usize,
    pub end: usize,
}

impl Span {
    pub fn new(start: usize, end: usize) -> Self {
        Self { start, end }
    }
}

#[derive(Debug, PartialEq)]
pub struct Ast<'a, T> {
    source: &'a str,
    root: T,
    errors: Vec<Error>,
    comments: Vec<Span>,
    recursion_limit: LimitTracker,
    token_limit: LimitTracker,
}

impl<'a, T> Ast<'a, T> {
    pub(crate) fn new(
        source: &'a str,
        root: T,
        errors: Vec<Error>,
        comments: Vec<Span>,
        recursion_limit: LimitTracker,
        token_limit: LimitTracker,
    ) -> Self {
        Self { source, root, errors, comments, recursion_limit, token_limit }
    }

    pub fn root(&self) -> &T {
        &self.root
    }

    pub fn into_root(self) -> T {
        self.root
    }

    pub fn source(&self) -> &str {
        self.source
    }

    pub fn errors(&self) -> Iter<'_, Error> {
        self.errors.iter()
    }

    /// Comment token spans in document order.
    ///
    /// GraphQL comments are always line comments: each span covers `#` through
    /// the end of the line (excluding the line terminator).
    ///
    /// NOTE: Only comments consumed while parsing are recorded.
    /// [`Parser::parse`] reads to the end of input, so it collects every comment in the source.
    /// Partial roots ([`Parser::parse_selection_set`], [`Parser::parse_type`])
    /// stop at the end of the root, so comments past it are not included.
    ///
    /// [`Parser::parse`]: crate::Parser::parse
    /// [`Parser::parse_selection_set`]: crate::Parser::parse_selection_set
    /// [`Parser::parse_type`]: crate::Parser::parse_type
    pub fn comments(&self) -> &[Span] {
        &self.comments
    }

    pub fn recursion_limit(&self) -> LimitTracker {
        self.recursion_limit
    }

    pub fn token_limit(&self) -> LimitTracker {
        self.token_limit
    }
}

impl<'a> Ast<'a, Document<'a>> {
    pub fn document(&self) -> &Document<'a> {
        self.root()
    }
}

impl<'a> Ast<'a, SelectionSet<'a>> {
    pub fn field_set(&self) -> &SelectionSet<'a> {
        self.root()
    }
}

impl<'a> Ast<'a, Type<'a>> {
    pub fn ty(&self) -> &Type<'a> {
        self.root()
    }
}

#[derive(Debug, PartialEq)]
pub struct Document<'a> {
    pub definitions: AstVec<'a, Definition<'a>>,
    pub span: Span,
}

#[derive(Debug, PartialEq)]
pub enum Definition<'a> {
    Operation(OperationDefinition<'a>),
    Fragment(FragmentDefinition<'a>),
    Directive(DirectiveDefinition<'a>),
    Schema(SchemaDefinition<'a>),
    SchemaExtension(SchemaExtension<'a>),
    ScalarType(ScalarTypeDefinition<'a>),
    ScalarTypeExtension(ScalarTypeExtension<'a>),
    ObjectType(ObjectTypeDefinition<'a>),
    ObjectTypeExtension(ObjectTypeExtension<'a>),
    InterfaceType(InterfaceTypeDefinition<'a>),
    InterfaceTypeExtension(InterfaceTypeExtension<'a>),
    UnionType(UnionTypeDefinition<'a>),
    UnionTypeExtension(UnionTypeExtension<'a>),
    EnumType(EnumTypeDefinition<'a>),
    EnumTypeExtension(EnumTypeExtension<'a>),
    InputObjectType(InputObjectTypeDefinition<'a>),
    InputObjectTypeExtension(InputObjectTypeExtension<'a>),
}

impl<'a> Definition<'a> {
    pub fn name(&self) -> Option<&Name<'a>> {
        match self {
            Self::Operation(definition) => definition.name.as_ref(),
            Self::Fragment(definition) => Some(&definition.name),
            Self::Directive(definition) => Some(&definition.name),
            Self::Schema(_) | Self::SchemaExtension(_) => None,
            Self::ScalarType(definition) => Some(&definition.name),
            Self::ScalarTypeExtension(definition) => Some(&definition.name),
            Self::ObjectType(definition) => Some(&definition.name),
            Self::ObjectTypeExtension(definition) => Some(&definition.name),
            Self::InterfaceType(definition) => Some(&definition.name),
            Self::InterfaceTypeExtension(definition) => Some(&definition.name),
            Self::UnionType(definition) => Some(&definition.name),
            Self::UnionTypeExtension(definition) => Some(&definition.name),
            Self::EnumType(definition) => Some(&definition.name),
            Self::EnumTypeExtension(definition) => Some(&definition.name),
            Self::InputObjectType(definition) => Some(&definition.name),
            Self::InputObjectTypeExtension(definition) => Some(&definition.name),
        }
    }

    /// The source span of the definition, whichever variant it is.
    ///
    /// When adding a new variant, remember to extend this match as well.
    pub fn span(&self) -> Span {
        match self {
            Self::Operation(definition) => definition.span,
            Self::Fragment(definition) => definition.span,
            Self::Directive(definition) => definition.span,
            Self::Schema(definition) => definition.span,
            Self::SchemaExtension(definition) => definition.span,
            Self::ScalarType(definition) => definition.span,
            Self::ScalarTypeExtension(definition) => definition.span,
            Self::ObjectType(definition) => definition.span,
            Self::ObjectTypeExtension(definition) => definition.span,
            Self::InterfaceType(definition) => definition.span,
            Self::InterfaceTypeExtension(definition) => definition.span,
            Self::UnionType(definition) => definition.span,
            Self::UnionTypeExtension(definition) => definition.span,
            Self::EnumType(definition) => definition.span,
            Self::EnumTypeExtension(definition) => definition.span,
            Self::InputObjectType(definition) => definition.span,
            Self::InputObjectTypeExtension(definition) => definition.span,
        }
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct Name<'a> {
    pub value: &'a str,
    pub span: Span,
}

impl Name<'_> {
    pub fn as_str(&self) -> &str {
        self.value
    }
}

impl fmt::Display for Name<'_> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str(self.value)
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct StringValue<'a> {
    pub raw: &'a str,
    pub value: &'a str,
    pub block: bool,
    pub span: Span,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum OperationType {
    Query,
    Mutation,
    Subscription,
}

#[derive(Debug, PartialEq)]
pub struct OperationDefinition<'a> {
    pub description: Option<StringValue<'a>>,
    pub operation_type: OperationType,
    pub name: Option<Name<'a>>,
    pub variable_definitions: AstVec<'a, VariableDefinition<'a>>,
    pub directives: AstVec<'a, Directive<'a>>,
    pub selection_set: Option<SelectionSet<'a>>,
    pub span: Span,
}

#[derive(Debug, PartialEq)]
pub struct FragmentDefinition<'a> {
    pub description: Option<StringValue<'a>>,
    pub name: Name<'a>,
    pub variable_definitions: AstVec<'a, VariableDefinition<'a>>,
    pub type_condition: NamedType<'a>,
    pub directives: AstVec<'a, Directive<'a>>,
    pub selection_set: Option<SelectionSet<'a>>,
    pub span: Span,
}

#[derive(Debug, PartialEq)]
pub struct SelectionSet<'a> {
    pub selections: AstVec<'a, Selection<'a>>,
    pub span: Span,
}

#[derive(Debug, PartialEq)]
pub enum Selection<'a> {
    Field(Field<'a>),
    FragmentSpread(FragmentSpread<'a>),
    InlineFragment(InlineFragment<'a>),
}

impl Selection<'_> {
    /// The source span of the selection, whichever variant it is.
    ///
    /// When adding a new variant, remember to extend this match as well.
    pub fn span(&self) -> Span {
        match self {
            Self::Field(selection) => selection.span,
            Self::FragmentSpread(selection) => selection.span,
            Self::InlineFragment(selection) => selection.span,
        }
    }
}

#[derive(Debug, PartialEq)]
pub struct Field<'a> {
    pub alias: Option<Name<'a>>,
    pub name: Name<'a>,
    pub arguments: AstVec<'a, Argument<'a>>,
    pub directives: AstVec<'a, Directive<'a>>,
    pub selection_set: Option<SelectionSet<'a>>,
    pub span: Span,
}

#[derive(Debug, PartialEq)]
pub struct FragmentSpread<'a> {
    pub name: Name<'a>,
    pub directives: AstVec<'a, Directive<'a>>,
    pub span: Span,
}

#[derive(Debug, PartialEq)]
pub struct InlineFragment<'a> {
    pub type_condition: Option<NamedType<'a>>,
    pub directives: AstVec<'a, Directive<'a>>,
    pub selection_set: Option<SelectionSet<'a>>,
    pub span: Span,
}

#[derive(Debug, PartialEq)]
pub struct VariableDefinition<'a> {
    pub description: Option<StringValue<'a>>,
    pub variable: Variable<'a>,
    pub ty: Option<Type<'a>>,
    pub default_value: Option<Value<'a>>,
    pub directives: AstVec<'a, Directive<'a>>,
    pub span: Span,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct Variable<'a> {
    pub name: Name<'a>,
    pub span: Span,
}

#[derive(Debug, PartialEq)]
pub struct Argument<'a> {
    pub name: Name<'a>,
    pub value: Option<Value<'a>>,
    pub span: Span,
}

#[derive(Debug, PartialEq)]
pub struct Directive<'a> {
    pub name: Name<'a>,
    pub arguments: AstVec<'a, Argument<'a>>,
    pub span: Span,
}

#[derive(Debug, PartialEq)]
pub enum Value<'a> {
    Variable(Variable<'a>),
    Int(IntValue<'a>),
    Float(FloatValue<'a>),
    String(StringValue<'a>),
    Boolean(BooleanValue),
    Null(NullValue),
    Enum(EnumValue<'a>),
    List(ListValue<'a>),
    Object(ObjectValue<'a>),
    Missing(Span),
}

impl Value<'_> {
    pub fn span(&self) -> Span {
        match self {
            Self::Variable(value) => value.span,
            Self::Int(value) => value.span,
            Self::Float(value) => value.span,
            Self::String(value) => value.span,
            Self::Boolean(value) => value.span,
            Self::Null(value) => value.span,
            Self::Enum(value) => value.name.span,
            Self::List(value) => value.span,
            Self::Object(value) => value.span,
            Self::Missing(span) => *span,
        }
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct IntValue<'a> {
    pub raw: &'a str,
    pub span: Span,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct FloatValue<'a> {
    pub raw: &'a str,
    pub span: Span,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct BooleanValue {
    pub value: bool,
    pub span: Span,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct NullValue {
    pub span: Span,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct EnumValue<'a> {
    pub name: Name<'a>,
}

#[derive(Debug, PartialEq)]
pub struct ListValue<'a> {
    pub values: AstVec<'a, Value<'a>>,
    pub span: Span,
}

#[derive(Debug, PartialEq)]
pub struct ObjectValue<'a> {
    pub fields: AstVec<'a, ObjectField<'a>>,
    pub span: Span,
}

#[derive(Debug, PartialEq)]
pub struct ObjectField<'a> {
    pub name: Name<'a>,
    pub value: Option<Value<'a>>,
    pub span: Span,
}

#[derive(Debug, PartialEq)]
pub enum Type<'a> {
    Named(NamedType<'a>),
    List(ListType<'a>),
    NonNull(NonNullType<'a>),
    Missing(Span),
}

impl Type<'_> {
    pub fn span(&self) -> Span {
        match self {
            Self::Named(value) => value.name.span,
            Self::List(value) => value.span,
            Self::NonNull(value) => value.span,
            Self::Missing(span) => *span,
        }
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct NamedType<'a> {
    pub name: Name<'a>,
}

#[derive(Debug)]
pub struct ListType<'a> {
    pub ty: AstBox<'a, Type<'a>>,
    pub span: Span,
}

impl PartialEq for ListType<'_> {
    fn eq(&self, other: &Self) -> bool {
        self.ty.as_ref() == other.ty.as_ref() && self.span == other.span
    }
}

#[derive(Debug)]
pub struct NonNullType<'a> {
    pub ty: AstBox<'a, Type<'a>>,
    pub span: Span,
}

impl PartialEq for NonNullType<'_> {
    fn eq(&self, other: &Self) -> bool {
        self.ty.as_ref() == other.ty.as_ref() && self.span == other.span
    }
}

#[derive(Debug, PartialEq)]
pub struct SchemaDefinition<'a> {
    pub description: Option<StringValue<'a>>,
    pub directives: AstVec<'a, Directive<'a>>,
    pub root_operations: AstVec<'a, RootOperationTypeDefinition<'a>>,
    pub span: Span,
}

#[derive(Debug, PartialEq)]
pub struct SchemaExtension<'a> {
    pub directives: AstVec<'a, Directive<'a>>,
    pub root_operations: AstVec<'a, RootOperationTypeDefinition<'a>>,
    pub span: Span,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct RootOperationTypeDefinition<'a> {
    pub operation_type: OperationType,
    pub named_type: NamedType<'a>,
    pub span: Span,
}

#[derive(Debug, PartialEq)]
pub struct DirectiveDefinition<'a> {
    pub description: Option<StringValue<'a>>,
    pub name: Name<'a>,
    pub arguments: AstVec<'a, InputValueDefinition<'a>>,
    pub repeatable: bool,
    pub locations: AstVec<'a, DirectiveLocation<'a>>,
    pub span: Span,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct DirectiveLocation<'a> {
    pub name: &'a str,
    pub span: Span,
}

#[derive(Debug, PartialEq)]
pub struct ScalarTypeDefinition<'a> {
    pub description: Option<StringValue<'a>>,
    pub name: Name<'a>,
    pub directives: AstVec<'a, Directive<'a>>,
    pub span: Span,
}

#[derive(Debug, PartialEq)]
pub struct ScalarTypeExtension<'a> {
    pub name: Name<'a>,
    pub directives: AstVec<'a, Directive<'a>>,
    pub span: Span,
}

#[derive(Debug, PartialEq)]
pub struct ObjectTypeDefinition<'a> {
    pub description: Option<StringValue<'a>>,
    pub name: Name<'a>,
    pub interfaces: AstVec<'a, NamedType<'a>>,
    pub directives: AstVec<'a, Directive<'a>>,
    pub fields: AstVec<'a, FieldDefinition<'a>>,
    pub span: Span,
}

#[derive(Debug, PartialEq)]
pub struct ObjectTypeExtension<'a> {
    pub name: Name<'a>,
    pub interfaces: AstVec<'a, NamedType<'a>>,
    pub directives: AstVec<'a, Directive<'a>>,
    pub fields: AstVec<'a, FieldDefinition<'a>>,
    pub span: Span,
}

#[derive(Debug, PartialEq)]
pub struct InterfaceTypeDefinition<'a> {
    pub description: Option<StringValue<'a>>,
    pub name: Name<'a>,
    pub interfaces: AstVec<'a, NamedType<'a>>,
    pub directives: AstVec<'a, Directive<'a>>,
    pub fields: AstVec<'a, FieldDefinition<'a>>,
    pub span: Span,
}

#[derive(Debug, PartialEq)]
pub struct InterfaceTypeExtension<'a> {
    pub name: Name<'a>,
    pub interfaces: AstVec<'a, NamedType<'a>>,
    pub directives: AstVec<'a, Directive<'a>>,
    pub fields: AstVec<'a, FieldDefinition<'a>>,
    pub span: Span,
}

#[derive(Debug, PartialEq)]
pub struct UnionTypeDefinition<'a> {
    pub description: Option<StringValue<'a>>,
    pub name: Name<'a>,
    pub directives: AstVec<'a, Directive<'a>>,
    pub members: AstVec<'a, NamedType<'a>>,
    pub span: Span,
}

#[derive(Debug, PartialEq)]
pub struct UnionTypeExtension<'a> {
    pub name: Name<'a>,
    pub directives: AstVec<'a, Directive<'a>>,
    pub members: AstVec<'a, NamedType<'a>>,
    pub span: Span,
}

#[derive(Debug, PartialEq)]
pub struct EnumTypeDefinition<'a> {
    pub description: Option<StringValue<'a>>,
    pub name: Name<'a>,
    pub directives: AstVec<'a, Directive<'a>>,
    pub values: AstVec<'a, EnumValueDefinition<'a>>,
    pub span: Span,
}

#[derive(Debug, PartialEq)]
pub struct EnumTypeExtension<'a> {
    pub name: Name<'a>,
    pub directives: AstVec<'a, Directive<'a>>,
    pub values: AstVec<'a, EnumValueDefinition<'a>>,
    pub span: Span,
}

#[derive(Debug, PartialEq)]
pub struct EnumValueDefinition<'a> {
    pub description: Option<StringValue<'a>>,
    pub value: EnumValue<'a>,
    pub directives: AstVec<'a, Directive<'a>>,
    pub span: Span,
}

#[derive(Debug, PartialEq)]
pub struct InputObjectTypeDefinition<'a> {
    pub description: Option<StringValue<'a>>,
    pub name: Name<'a>,
    pub directives: AstVec<'a, Directive<'a>>,
    pub fields: AstVec<'a, InputValueDefinition<'a>>,
    pub span: Span,
}

#[derive(Debug, PartialEq)]
pub struct InputObjectTypeExtension<'a> {
    pub name: Name<'a>,
    pub directives: AstVec<'a, Directive<'a>>,
    pub fields: AstVec<'a, InputValueDefinition<'a>>,
    pub span: Span,
}

#[derive(Debug, PartialEq)]
pub struct FieldDefinition<'a> {
    pub description: Option<StringValue<'a>>,
    pub name: Name<'a>,
    pub arguments: AstVec<'a, InputValueDefinition<'a>>,
    pub ty: Option<Type<'a>>,
    pub directives: AstVec<'a, Directive<'a>>,
    pub span: Span,
}

#[derive(Debug, PartialEq)]
pub struct InputValueDefinition<'a> {
    pub description: Option<StringValue<'a>>,
    pub name: Name<'a>,
    pub ty: Option<Type<'a>>,
    pub default_value: Option<Value<'a>>,
    pub directives: AstVec<'a, Directive<'a>>,
    pub span: Span,
}