typespec_rs 0.5.0

A Rust implementation of the TypeSpec type system — parser, checker, and emitter
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
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
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
//! Complete AST node type definitions for TypeSpec-Rust
//! Ported from TypeSpec compiler/src/core/types.ts

use super::node::NodeId;
use super::token::Span;

/// SyntaxKind enum - identifies the type of AST node
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum SyntaxKind {
    // File structure
    TypeSpecScript,
    ImportStatement,

    // Identifiers and expressions
    Identifier,
    MemberExpression,
    StringLiteral,
    NumericLiteral,
    BooleanLiteral,

    // Model
    ModelStatement,
    ModelExpression,
    ModelProperty,
    ModelSpreadProperty,

    // Scalar
    ScalarStatement,
    ScalarConstructor,

    // Interface
    InterfaceStatement,

    // Union
    UnionStatement,
    UnionVariant,

    // Enum
    EnumStatement,
    EnumMember,
    EnumSpreadMember,

    // Namespace
    NamespaceStatement,
    UsingStatement,

    // Operation
    OperationStatement,
    OperationSignatureDeclaration,
    OperationSignatureReference,

    // Alias and const
    AliasStatement,
    ConstStatement,

    // Decorator
    DecoratorDeclarationStatement,
    DecoratorExpression,
    AugmentDecoratorStatement,

    // Expression types
    ArrayExpression,
    TupleExpression,
    UnionExpression,
    IntersectionExpression,
    TypeReference,
    CallExpression,
    ValueOfExpression,
    TypeOfExpression,

    // String template
    StringTemplateExpression,
    StringTemplateHead,
    StringTemplateMiddle,
    StringTemplateTail,
    StringTemplateSpan,

    // Object literal
    ObjectLiteral,
    ObjectLiteralProperty,
    ObjectLiteralSpreadProperty,
    ArrayLiteral,

    // Keywords
    ExternKeyword,
    InternalKeyword,
    VoidKeyword,
    NeverKeyword,
    UnknownKeyword,

    // Template
    TemplateParameterDeclaration,
    TemplateArgument,

    // Function
    FunctionDeclarationStatement,
    FunctionParameter,
    FunctionTypeExpression,

    // Directive
    DirectiveExpression,

    // Doc
    Doc,
    DocText,

    // Misc
    EmptyStatement,
    InvalidStatement,

    // Modifier
    LineComment,
    BlockComment,
}

// ============================================================================
// Expression Nodes
// ============================================================================

/// Identifier node - basic identifier like `Foo`
#[derive(Debug, Clone)]
pub struct Identifier {
    pub id: NodeId,
    pub span: Span,
    pub value: String,
}

/// Member expression - `foo.bar` or `foo::bar`
#[derive(Debug, Clone)]
pub struct MemberExpression {
    pub id: NodeId,
    pub span: Span,
    pub object: NodeId,   // Identifier or MemberExpression
    pub property: NodeId, // Identifier
    pub selector: MemberSelector,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum MemberSelector {
    Dot,         // .
    DoubleColon, // ::
}

/// String literal - `"hello"`
#[derive(Debug, Clone)]
pub struct StringLiteral {
    pub id: NodeId,
    pub span: Span,
    pub value: String,
}

/// Numeric literal - `42`, `3.14`
#[derive(Debug, Clone)]
pub struct NumericLiteral {
    pub id: NodeId,
    pub span: Span,
    pub value: f64,
    pub value_as_string: String,
}

/// Boolean literal - `true`, `false`
#[derive(Debug, Clone)]
pub struct BooleanLiteral {
    pub id: NodeId,
    pub span: Span,
    pub value: bool,
}

/// Array expression - `string[]`
#[derive(Debug, Clone)]
pub struct ArrayExpression {
    pub id: NodeId,
    pub span: Span,
    pub element_type: NodeId,
}

/// Tuple expression - `[string, number]`
#[derive(Debug, Clone)]
pub struct TupleExpression {
    pub id: NodeId,
    pub span: Span,
    pub values: Vec<NodeId>,
}

/// Union expression - `string | null`
#[derive(Debug, Clone)]
pub struct UnionExpression {
    pub id: NodeId,
    pub span: Span,
    pub options: Vec<NodeId>,
}

/// Intersection expression - `Foo & Bar`
#[derive(Debug, Clone)]
pub struct IntersectionExpression {
    pub id: NodeId,
    pub span: Span,
    pub options: Vec<NodeId>,
}

/// Type reference - `MyType` or `Namespace.MyType`
#[derive(Debug, Clone)]
pub struct TypeReference {
    pub id: NodeId,
    pub span: Span,
    pub name: NodeId, // Identifier or MemberExpression
    pub arguments: Vec<NodeId>,
}

/// Call expression - `foo(arg1, arg2)`
#[derive(Debug, Clone)]
pub struct CallExpression {
    pub id: NodeId,
    pub span: Span,
    pub target: NodeId, // Identifier or MemberExpression
    pub arguments: Vec<NodeId>,
}

/// Value of expression - `valueof T`
#[derive(Debug, Clone)]
pub struct ValueOfExpression {
    pub id: NodeId,
    pub span: Span,
    pub target: NodeId,
}

/// Type of expression - `typeof expr`
#[derive(Debug, Clone)]
pub struct TypeOfExpression {
    pub id: NodeId,
    pub span: Span,
    pub target: NodeId,
}

// ============================================================================
// String Template
// ============================================================================

#[derive(Debug, Clone)]
pub struct StringTemplateExpression {
    pub id: NodeId,
    pub span: Span,
    pub head: NodeId,
    pub spans: Vec<NodeId>,
}

#[derive(Debug, Clone)]
pub struct StringTemplateHead {
    pub id: NodeId,
    pub span: Span,
    pub value: String,
}

#[derive(Debug, Clone)]
pub struct StringTemplateMiddle {
    pub id: NodeId,
    pub span: Span,
    pub value: String,
}

#[derive(Debug, Clone)]
pub struct StringTemplateTail {
    pub id: NodeId,
    pub span: Span,
    pub value: String,
}

#[derive(Debug, Clone)]
pub struct StringTemplateSpan {
    pub id: NodeId,
    pub span: Span,
    pub expression: NodeId,
    pub literal: NodeId, // StringTemplateMiddle or StringTemplateTail
}

// ============================================================================
// Object Literal
// ============================================================================

#[derive(Debug, Clone)]
pub struct ObjectLiteral {
    pub id: NodeId,
    pub span: Span,
    pub properties: Vec<NodeId>,
}

#[derive(Debug, Clone)]
pub struct ObjectLiteralProperty {
    pub id: NodeId,
    pub span: Span,
    pub key: NodeId,
    pub value: NodeId,
}

#[derive(Debug, Clone)]
pub struct ObjectLiteralSpreadProperty {
    pub id: NodeId,
    pub span: Span,
    pub target: NodeId,
}

#[derive(Debug, Clone)]
pub struct ArrayLiteral {
    pub id: NodeId,
    pub span: Span,
    pub values: Vec<NodeId>,
}

// ============================================================================
// Keywords
// ============================================================================

#[derive(Debug, Clone)]
pub struct ExternKeyword {
    pub id: NodeId,
    pub span: Span,
}

#[derive(Debug, Clone)]
pub struct InternalKeyword {
    pub id: NodeId,
    pub span: Span,
}

#[derive(Debug, Clone)]
pub struct VoidKeyword {
    pub id: NodeId,
    pub span: Span,
}

#[derive(Debug, Clone)]
pub struct NeverKeyword {
    pub id: NodeId,
    pub span: Span,
}

#[derive(Debug, Clone)]
pub struct UnknownKeyword {
    pub id: NodeId,
    pub span: Span,
}

// ============================================================================
// Model
// ============================================================================

/// Model declaration - `model Foo { ... }`
#[derive(Debug, Clone)]
pub struct ModelDeclaration {
    pub id: NodeId,
    pub span: Span,
    pub name: NodeId,
    pub properties: Vec<NodeId>,
    pub extends: Option<NodeId>, // Expression for extends clause
    pub is: Option<NodeId>,      // Expression for `model is` clause
    pub decorators: Vec<NodeId>,
    pub template_parameters: Vec<NodeId>,
    pub body_range: Span,
    pub modifiers: Vec<NodeId>,
}

/// Model expression - inline model in type position
#[derive(Debug, Clone)]
pub struct ModelExpression {
    pub id: NodeId,
    pub span: Span,
    pub properties: Vec<NodeId>,
    pub body_range: Span,
}

/// Model property - `name: type`
#[derive(Debug, Clone)]
pub struct ModelProperty {
    pub id: NodeId,
    pub span: Span,
    pub name: NodeId,
    pub value: NodeId, // Type expression
    pub decorators: Vec<NodeId>,
    pub optional: bool,
    pub default: Option<NodeId>, // Default value expression
}

/// Model spread property - `...Target`
#[derive(Debug, Clone)]
pub struct ModelSpreadProperty {
    pub id: NodeId,
    pub span: Span,
    pub target: NodeId,
}

// ============================================================================
// Scalar
// ============================================================================

/// Scalar declaration - `scalar Foo extends string`
#[derive(Debug, Clone)]
pub struct ScalarDeclaration {
    pub id: NodeId,
    pub span: Span,
    pub name: NodeId,
    pub extends: Option<NodeId>,
    pub decorators: Vec<NodeId>,
    pub constructors: Vec<NodeId>,
    pub template_parameters: Vec<NodeId>,
    pub body_range: Span,
    pub modifiers: Vec<NodeId>,
}

/// Scalar constructor - `constructor(...)`
#[derive(Debug, Clone)]
pub struct ScalarConstructor {
    pub id: NodeId,
    pub span: Span,
    pub name: NodeId,
    pub parameters: Vec<NodeId>,
}

// ============================================================================
// Interface
// ============================================================================

/// Interface declaration - `interface Foo { ... }`
#[derive(Debug, Clone)]
pub struct InterfaceDeclaration {
    pub id: NodeId,
    pub span: Span,
    pub name: NodeId,
    pub operations: Vec<NodeId>,
    pub extends: Vec<NodeId>,
    pub decorators: Vec<NodeId>,
    pub template_parameters: Vec<NodeId>,
    pub body_range: Span,
    pub modifiers: Vec<NodeId>,
}

// ============================================================================
// Union
// ============================================================================

/// Union declaration - `union Foo { ... }`
#[derive(Debug, Clone)]
pub struct UnionDeclaration {
    pub id: NodeId,
    pub span: Span,
    pub name: NodeId,
    pub variants: Vec<NodeId>,
    pub decorators: Vec<NodeId>,
    pub template_parameters: Vec<NodeId>,
    pub modifiers: Vec<NodeId>,
}

/// Union variant - individual variant in a union
#[derive(Debug, Clone)]
pub struct UnionVariant {
    pub id: NodeId,
    pub span: Span,
    pub name: Option<NodeId>,
    pub value: NodeId,
    pub decorators: Vec<NodeId>,
}

// ============================================================================
// Enum
// ============================================================================

/// Enum declaration - `enum Foo { ... }`
#[derive(Debug, Clone)]
pub struct EnumDeclaration {
    pub id: NodeId,
    pub span: Span,
    pub name: NodeId,
    pub members: Vec<NodeId>,
    pub decorators: Vec<NodeId>,
    pub modifiers: Vec<NodeId>,
}

/// Enum member - individual member in an enum
#[derive(Debug, Clone)]
pub struct EnumMember {
    pub id: NodeId,
    pub span: Span,
    pub name: NodeId,
    pub value: Option<NodeId>, // StringLiteral or NumericLiteral
    pub decorators: Vec<NodeId>,
}

/// Enum spread member - `...Target`
#[derive(Debug, Clone)]
pub struct EnumSpreadMember {
    pub id: NodeId,
    pub span: Span,
    pub target: NodeId,
}

// ============================================================================
// Namespace
// ============================================================================

/// Namespace declaration - `namespace Foo { ... }`
#[derive(Debug, Clone)]
pub struct NamespaceDeclaration {
    pub id: NodeId,
    pub span: Span,
    pub name: NodeId,
    pub statements: Vec<NodeId>,
    pub decorators: Vec<NodeId>,
    pub modifiers: Vec<NodeId>,
}

/// Using declaration - `using Foo;`
#[derive(Debug, Clone)]
pub struct UsingDeclaration {
    pub id: NodeId,
    pub span: Span,
    pub name: NodeId, // Identifier or MemberExpression
}

// ============================================================================
// Operation
// ============================================================================

/// Operation declaration - `op Foo(...): ReturnType;`
#[derive(Debug, Clone)]
pub struct OperationDeclaration {
    pub id: NodeId,
    pub span: Span,
    pub name: NodeId,
    pub signature: NodeId, // OperationSignatureDeclaration or OperationSignatureReference
    pub decorators: Vec<NodeId>,
    pub template_parameters: Vec<NodeId>,
    pub modifiers: Vec<NodeId>,
}

/// Operation signature declaration
#[derive(Debug, Clone)]
pub struct OperationSignatureDeclaration {
    pub id: NodeId,
    pub span: Span,
    pub parameters: NodeId, // ModelExpression
    pub return_type: NodeId,
}

/// Operation signature reference - `op foo is Bar;`
#[derive(Debug, Clone)]
pub struct OperationSignatureReference {
    pub id: NodeId,
    pub span: Span,
    pub base_operation: NodeId, // TypeReference
}

// ============================================================================
// Alias and Const
// ============================================================================

/// Alias statement - `alias Foo = Bar;`
#[derive(Debug, Clone)]
pub struct AliasStatement {
    pub id: NodeId,
    pub span: Span,
    pub name: NodeId,
    pub value: NodeId,
    pub template_parameters: Vec<NodeId>,
    pub modifiers: Vec<NodeId>,
}

/// Const statement - `const foo = 42;`
#[derive(Debug, Clone)]
pub struct ConstStatement {
    pub id: NodeId,
    pub span: Span,
    pub name: NodeId,
    pub value: NodeId,
    pub type_annotation: Option<NodeId>,
    pub modifiers: Vec<NodeId>,
}

// ============================================================================
// Decorator
// ============================================================================

/// Decorator declaration - `extern dec myDec(target: Type);`
#[derive(Debug, Clone)]
pub struct DecoratorDeclaration {
    pub id: NodeId,
    pub span: Span,
    pub name: NodeId,
    pub target: NodeId,          // FunctionParameter
    pub parameters: Vec<NodeId>, // Additional parameters
    pub modifiers: Vec<NodeId>,
}

/// Decorator expression - `@myDec(args)`
#[derive(Debug, Clone)]
pub struct DecoratorExpression {
    pub id: NodeId,
    pub span: Span,
    pub target: NodeId, // Identifier or MemberExpression
    pub arguments: Vec<NodeId>,
}

/// Augment decorator statement - `@@myDec(args)` (at namespace level)
#[derive(Debug, Clone)]
pub struct AugmentDecoratorStatement {
    pub id: NodeId,
    pub span: Span,
    pub target: NodeId,      // Identifier or MemberExpression
    pub target_type: NodeId, // TypeReference
    pub arguments: Vec<NodeId>,
}

// ============================================================================
// Function
// ============================================================================

/// Function declaration - `extern fn myFunc(...): ReturnType;`
#[derive(Debug, Clone)]
pub struct FunctionDeclaration {
    pub id: NodeId,
    pub span: Span,
    pub name: NodeId,
    pub parameters: Vec<NodeId>,
    pub return_type: Option<NodeId>,
    pub modifiers: Vec<NodeId>,
}

/// Function parameter
#[derive(Debug, Clone)]
pub struct FunctionParameter {
    pub id: NodeId,
    pub span: Span,
    pub name: NodeId,
    pub type_annotation: Option<NodeId>,
    pub optional: bool,
    pub rest: bool,
}

/// Function type expression - `fn(...) => ...`
#[derive(Debug, Clone)]
pub struct FunctionTypeExpression {
    pub id: NodeId,
    pub span: Span,
    pub parameters: Vec<NodeId>,
    pub return_type: Option<NodeId>,
}

// ============================================================================
// Template
// ============================================================================

/// Template parameter declaration - `T` in `model Foo<T> { ... }`
#[derive(Debug, Clone)]
pub struct TemplateParameterDeclaration {
    pub id: NodeId,
    pub span: Span,
    pub name: NodeId,
    pub constraint: Option<NodeId>,
    pub default: Option<NodeId>,
}

/// Template argument - `string` in `Foo<string>`
#[derive(Debug, Clone)]
pub struct TemplateArgument {
    pub id: NodeId,
    pub span: Span,
    pub name: Option<NodeId>, // Optional named argument
    pub argument: NodeId,
}

// ============================================================================
// Import / Export
// ============================================================================

/// Import statement - `import "./foo";`
#[derive(Debug, Clone)]
pub struct ImportStatement {
    pub id: NodeId,
    pub span: Span,
    pub path: NodeId, // StringLiteral
}

// ============================================================================
// Directive
// ============================================================================

/// Directive expression - `#pragma ...`
#[derive(Debug, Clone)]
pub struct DirectiveExpression {
    pub id: NodeId,
    pub span: Span,
    pub target: NodeId, // Identifier
    pub arguments: Vec<NodeId>,
}

// ============================================================================
// Doc Comments
// ============================================================================

#[derive(Debug, Clone)]
pub struct Doc {
    pub id: NodeId,
    pub span: Span,
    pub content: Vec<NodeId>,
    pub tags: Vec<NodeId>,
}

#[derive(Debug, Clone)]
pub struct DocText {
    pub id: NodeId,
    pub span: Span,
    pub text: String,
}

// ============================================================================
// Comments
// ============================================================================

#[derive(Debug, Clone)]
pub struct LineComment {
    pub id: NodeId,
    pub span: Span,
}

#[derive(Debug, Clone)]
pub struct BlockComment {
    pub id: NodeId,
    pub span: Span,
    pub parsed_as_docs: bool,
}

// ============================================================================
// Miscellaneous
// ============================================================================

#[derive(Debug, Clone)]
pub struct EmptyStatement {
    pub id: NodeId,
    pub span: Span,
}

#[derive(Debug, Clone)]
pub struct InvalidStatement {
    pub id: NodeId,
    pub span: Span,
    pub decorators: Vec<NodeId>,
}

// ============================================================================
// Root Node
// ============================================================================

/// TypeSpec script root node
#[derive(Debug, Clone)]
pub struct TypeSpecScript {
    pub id: NodeId,
    pub span: Span,
    pub statements: Vec<NodeId>,
    pub comments: Vec<NodeId>,
    pub parse_diagnostics: Vec<NodeId>,
}

// ============================================================================
// Modifier
// ============================================================================

#[derive(Debug, Clone)]
pub struct Modifier {
    pub id: NodeId,
    pub span: Span,
    pub kind: ModifierKind,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ModifierKind {
    Extern,
    Internal,
}