riptc 0.1.2

Rust implementation of the InertiaJS protocol compatible with `riptc` for generating strong TypeScript bindings.
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
//! Utilities for building up SWC trees.
//!
//! Since this code is freshly generated and not using any prior code,
//! we can simplify a lot of the tree building by using dummy spans and
//! syntax contexts.

mod comments;

use bon::builder;
use comments::create_comment_span;
use swc_atoms::Atom;
use swc_common::{DUMMY_SP, SyntaxContext};
use swc_ecma_ast::{
    AssignPatProp, BindingIdent, BlockStmt, CallExpr, Callee, Decl, ExportDecl, Expr, ExprOrSpread,
    FnExpr, Function, Ident, IdentName, ImportDecl, ImportNamedSpecifier, ImportPhase,
    ImportStarAsSpecifier, MemberExpr, ModuleDecl, ModuleExportName, ModuleItem, ObjectPat,
    ObjectPatProp, Param, Prop, PropName, ReturnStmt, Stmt, Str, TsEntityName, TsFnParam,
    TsIndexSignature, TsInterfaceBody, TsInterfaceDecl, TsKeywordType, TsKeywordTypeKind,
    TsLitType, TsModuleBlock, TsModuleDecl, TsModuleName, TsNamespaceBody, TsPropertySignature,
    TsQualifiedName, TsType, TsTypeAnn, TsTypeElement, TsTypeLit, TsTypeParamInstantiation,
    TsTypeRef, TsUnionOrIntersectionType, TsUnionType,
};

pub use comments::get_comments;

/// Wraps any function with an identifier
#[builder(finish_fn = build)]
pub fn binding_fn_expr(
    name: impl Into<Atom>,
    #[builder(default)] stmts: Vec<Stmt>,
    #[builder(default)] params: Vec<Param>,
    comment: Option<&str>,
) -> FnExpr {
    FnExpr {
        ident: Some(ident(name)),
        function: Box::new(
            binding_fn()
                .params(params)
                .stmts(stmts)
                .maybe_comment(comment)
                .build(),
        ),
    }
}

/// Creates a binding function
#[builder(finish_fn = build)]
pub fn binding_fn(
    #[builder(default)] params: Vec<Param>,
    #[builder(default)] stmts: Vec<Stmt>,
    comment: Option<&str>,
) -> Function {
    Function {
        params,
        decorators: vec![],
        span: create_comment_span(comment),
        ctxt: SyntaxContext::default(),
        body: Some(block_stmt().stmts(stmts).build()),
        is_generator: false,
        is_async: false,
        type_params: None,
        return_type: None,
    }
}

/// A binding parameter for a function.
/// ```ts
/// name: string
/// ```
#[builder(finish_fn = build)]
pub fn binding_param(name: impl Into<Atom>, type_ann: Option<TsType>) -> Param {
    Param {
        span: DUMMY_SP,
        decorators: vec![],
        pat: BindingIdent {
            id: ident(name),
            type_ann: type_ann.map(|t| {
                Box::new(TsTypeAnn {
                    span: DUMMY_SP,
                    type_ann: Box::new(t),
                })
            }),
        }
        .into(),
    }
}

/// Creates a destructuring parameter from a list of type elements.
/// ```ts
/// { name: string }
/// ```
pub fn destructuring_param_from_elements(
    elements: impl Iterator<Item = (Atom, TsTypeElement)>,
) -> Param {
    let (names, type_anns): (Vec<Atom>, Vec<TsTypeElement>) = elements.unzip();
    destructuring_param()
        .names(names.into_iter())
        .type_ann(object_type_from_elements(type_anns.into_iter()))
        .build()
}

/// A binding parameter for a function.
/// ```ts
/// { name: string }
/// ```
#[builder(finish_fn = build)]
pub fn destructuring_param(names: impl Iterator<Item: Into<Atom>>, type_ann: TsType) -> Param {
    Param {
        span: DUMMY_SP,
        decorators: vec![],
        pat: ObjectPat {
            span: DUMMY_SP,
            props: names
                .map(|name| {
                    ObjectPatProp::Assign(AssignPatProp {
                        span: DUMMY_SP,
                        key: ident(name).into(),
                        value: None,
                    })
                })
                .collect(),
            optional: false,
            type_ann: Some(Box::new(TsTypeAnn {
                span: DUMMY_SP,
                type_ann: Box::new(type_ann),
            })),
        }
        .into(),
    }
}

/// Non-spread arguments for a function call
#[builder(finish_fn = build)]
pub fn call_args(#[builder(default)] args: Vec<Expr>) -> impl Iterator<Item = ExprOrSpread> {
    args.into_iter().map(|arg| ExprOrSpread {
        spread: None,
        expr: Box::new(arg),
    })
}

/// Wraps any str as an identifier
pub fn ident(name: impl Into<Atom>) -> Ident {
    let atom: Atom = name.into();
    Ident::new(atom, DUMMY_SP, SyntaxContext::default())
}

/// Creates a type declaration for an interface.
/// ```ts
/// interface Name {
///     name: string;
/// }
/// ```
#[builder(finish_fn = build)]
pub fn interface_decl_stmt(
    name: impl Into<Atom>,
    elements: impl Iterator<Item = TsTypeElement>,
) -> Stmt {
    Stmt::Decl(Decl::TsInterface(Box::new(TsInterfaceDecl {
        span: DUMMY_SP,
        id: ident(name),
        declare: false,
        type_params: None,
        extends: vec![],
        body: TsInterfaceBody {
            span: DUMMY_SP,
            body: elements.collect(),
        },
    })))
}

/// Create a bare namespace statement:
/// ```ts
/// namespace <name> {
///   // <body>
/// }
/// ```
pub fn nested_namespace_decl(name: impl Into<Atom>, items: Vec<ModuleItem>) -> ModuleDecl {
    let name: Atom = name.into();
    ModuleDecl::ExportDecl(ExportDecl {
        span: DUMMY_SP,
        decl: Decl::TsModule(Box::new(TsModuleDecl {
            span: DUMMY_SP,
            id: TsModuleName::Ident(ident(name)),
            body: Some(TsNamespaceBody::TsModuleBlock(TsModuleBlock {
                span: DUMMY_SP,
                body: items,
            })),
            declare: false,
            global: false,
            // i haven't found that this does anything but maybe it does so let's leave it
            // as true, lol
            namespace: true,
        })),
    })
}

pub fn union_type(types: impl Iterator<Item: Into<TsType>>) -> TsType {
    TsType::TsUnionOrIntersectionType(TsUnionOrIntersectionType::TsUnionType(TsUnionType {
        span: DUMMY_SP,
        types: types.map(|t| Box::new(t.into())).collect(),
    }))
}

/// References another type by name
#[builder(finish_fn = build)]
pub fn type_ref(name: impl Into<Atom>, generics: Option<Vec<TsType>>) -> TsType {
    TsType::TsTypeRef(TsTypeRef {
        span: DUMMY_SP,
        type_name: TsEntityName::Ident(ident(name)),
        type_params: generics.map(|tp| {
            Box::new(TsTypeParamInstantiation {
                span: DUMMY_SP,
                params: tp.into_iter().map(Box::new).collect(),
            })
        }),
    })
}

#[builder(finish_fn = build)]
pub fn qualified_type_ref(
    name: impl Into<Atom>,
    generics: Option<Vec<TsType>>,
    qualifier: impl Into<Atom>,
) -> TsType {
    TsType::TsTypeRef(TsTypeRef {
        span: DUMMY_SP,
        type_name: TsEntityName::TsQualifiedName(Box::new(TsQualifiedName {
            span: DUMMY_SP,
            left: TsEntityName::Ident(ident(qualifier)),
            right: ident(name).into(),
        })),
        type_params: generics.map(|tp| {
            Box::new(TsTypeParamInstantiation {
                span: DUMMY_SP,
                params: tp.into_iter().map(Box::new).collect(),
            })
        }),
    })
}

/// Takes a list of statements and wraps them in a block statement for a function body
#[builder(finish_fn = build)]
pub fn block_stmt(#[builder(default)] stmts: Vec<Stmt>) -> BlockStmt {
    BlockStmt {
        span: DUMMY_SP,
        ctxt: SyntaxContext::default(),
        stmts,
    }
}

/// Wraps any expression with a statement
/// `import {xyz} from "@inertiajs/core"`
#[builder(finish_fn = build)]
pub fn import_decl(
    destruct_field_ident: Ident,
    // provide a rename so we can always prefix with __
    destruct_field_rename_ident: Ident,
    src: impl Into<Atom>,
) -> ImportDecl {
    ImportDecl {
        span: DUMMY_SP,
        specifiers: vec![
            ImportNamedSpecifier {
                span: DUMMY_SP,
                local: destruct_field_rename_ident,
                imported: Some(ModuleExportName::Ident(destruct_field_ident)),
                is_type_only: false,
            }
            .into(),
        ],
        src: Box::new(Str {
            span: DUMMY_SP,
            value: src.into(),
            raw: None,
        }),
        type_only: false,
        with: None,
        phase: ImportPhase::Evaluation,
    }
}

/// `import * as x from "@inertiajs/core"`
#[builder(finish_fn = build)]
pub fn import_star_as_decl(src: impl Into<Atom>, rename: impl Into<Atom>) -> ImportDecl {
    let rename: Atom = rename.into();
    ImportDecl {
        span: DUMMY_SP,
        specifiers: vec![
            ImportStarAsSpecifier {
                span: DUMMY_SP,
                local: ident(rename.clone()),
            }
            .into(),
        ],
        src: Box::new(Str {
            span: DUMMY_SP,
            value: src.into(),
            raw: None,
        }),
        type_only: false,
        with: None,
        phase: ImportPhase::Evaluation,
    }
}

/// Calls a function on an object, like `inertia.reload(args...)`
#[builder(finish_fn = build)]
pub fn fn_call_expr(
    callee_name: impl Into<Atom> + Copy,
    name: impl Into<Atom> + Copy,
    args: impl Iterator<Item = ExprOrSpread>,
    generics: Option<Vec<TsType>>,
) -> Expr {
    Expr::Call(CallExpr {
        span: DUMMY_SP,
        ctxt: SyntaxContext::default(),
        callee: Callee::Expr(
            Expr::Member(MemberExpr {
                span: DUMMY_SP,
                obj: ident(callee_name).into(),
                prop: IdentName::new(name.into(), DUMMY_SP).into(),
            })
            .into(),
        ),
        args: args.collect(),
        type_args: generics.map(|g| {
            Box::new(TsTypeParamInstantiation {
                span: DUMMY_SP,
                params: g.into_iter().map(Box::new).collect(),
            })
        }),
    })
}

/// Wraps a list of atoms in a shorthand object expression.
/// ```ts
/// { name }
/// ```
/// Builds an object prop, making it a shorthand if you don't provide an inner
#[builder]
pub fn object_prop(key: impl Into<Atom>, inner: Option<Expr>) -> Prop {
    match inner {
        Some(inner) => Prop::KeyValue(swc_ecma_ast::KeyValueProp {
            key: PropName::Ident(IdentName {
                span: DUMMY_SP,
                sym: key.into(),
            }),
            value: inner.into(),
        }),
        None => Prop::Shorthand(ident(key)),
    }
}

/// Creates a type from a list of type elements.
/// ```ts
/// { name: string }
/// ```
pub fn object_type_from_elements(elements: impl Iterator<Item = TsTypeElement>) -> TsType {
    TsType::TsTypeLit(TsTypeLit {
        span: DUMMY_SP,
        members: elements.collect(),
    })
}

pub fn tuple_type_from_elements(elements: impl Iterator<Item = TsType>) -> TsType {
    TsType::TsTupleType(swc_ecma_ast::TsTupleType {
        span: DUMMY_SP,
        elem_types: elements
            .map(|ty| swc_ecma_ast::TsTupleElement {
                span: DUMMY_SP,
                label: None,
                ty: Box::new(ty),
            })
            .collect(),
    })
}

pub fn object_expr_from_props(props: impl Iterator<Item = Prop>) -> Expr {
    Expr::Object(swc_ecma_ast::ObjectLit {
        span: DUMMY_SP,
        props: props
            .map(|p| swc_ecma_ast::PropOrSpread::Prop(Box::new(p)))
            .collect(),
    })
}

/// Creates a type element from a key and type annotation.
/// ```ts
/// { name: string }
/// ```
#[builder(finish_fn = build)]
pub fn object_member_type_element(
    key: impl Into<Atom>,
    type_ann: TsType,
    optional: bool,
) -> TsTypeElement {
    TsTypeElement::TsPropertySignature(TsPropertySignature {
        span: DUMMY_SP,
        key: Box::new(lit_str(key).into()),
        type_ann: Some(Box::new(TsTypeAnn {
            span: DUMMY_SP,
            type_ann: Box::new(type_ann),
        })),
        computed: false,
        optional,
        readonly: false,
    })
}

pub fn lit_str(value: impl Into<Atom>) -> Str {
    Str {
        span: DUMMY_SP,
        value: value.into(),
        raw: None,
    }
}

pub fn lit_str_as_const(value: impl Into<Atom>) -> Expr {
    Expr::TsConstAssertion(swc_ecma_ast::TsConstAssertion {
        span: DUMMY_SP,
        expr: Box::new(Expr::Lit(swc_ecma_ast::Lit::Str(lit_str(value)))),
    })
}

pub fn lit_str_type(value: impl Into<Atom>) -> TsType {
    TsType::TsLitType(TsLitType {
        span: DUMMY_SP,
        lit: swc_ecma_ast::TsLit::Str(lit_str(value)),
    })
}

/// Wraps an expression in a return statement.
/// ```ts
/// return expr;
/// ```
pub fn return_stmt(expr: impl Into<Expr>) -> Stmt {
    Stmt::Return(ReturnStmt {
        span: DUMMY_SP,
        arg: Some(Box::new(expr.into())),
    })
}

pub fn ts_keyword(kind: TsKeywordTypeKind) -> TsType {
    TsType::TsKeywordType(TsKeywordType {
        span: DUMMY_SP,
        kind,
    })
}

/// Returns a type literal with a single index signature:
///
/// ```ts
/// {
///   [ param_name: key_type ]: value_type
/// }
/// ```
pub fn index_signature(param_name: &str, key_type: TsType, value_type: TsType) -> TsType {
    TsType::TsTypeLit(TsTypeLit {
        span: DUMMY_SP,
        members: vec![TsTypeElement::TsIndexSignature(TsIndexSignature {
            span: DUMMY_SP,
            // assign the `key_type` to the param
            params: vec![TsFnParam::Ident(swc_ecma_ast::BindingIdent {
                id: swc_ecma_ast::Ident::new(param_name.into(), DUMMY_SP, SyntaxContext::default()),
                type_ann: Some(Box::new(TsTypeAnn {
                    span: DUMMY_SP,
                    type_ann: Box::new(key_type),
                })),
            })],
            type_ann: Some(Box::new(TsTypeAnn {
                span: DUMMY_SP,
                type_ann: Box::new(value_type),
            })),
            readonly: false,
            is_static: false,
        })],
    })
}

/// Given an input union type, extract each of its individual parts
pub fn split_union_type(maybe_union: Box<TsType>) -> impl Iterator<Item = Box<TsType>> {
    let mut types = vec![];
    match *maybe_union {
        TsType::TsUnionOrIntersectionType(TsUnionOrIntersectionType::TsUnionType(union)) => {
            for ty in union.types {
                if let TsType::TsUnionOrIntersectionType(TsUnionOrIntersectionType::TsUnionType(
                    inner_union,
                )) = *ty
                {
                    types.extend(inner_union.types.into_iter());
                } else {
                    types.push(ty);
                }
            }
        }
        _ => types.push(maybe_union),
    }

    types.into_iter()
}

pub fn never_type() -> TsType {
    TsType::TsKeywordType(TsKeywordType {
        span: DUMMY_SP,
        kind: TsKeywordTypeKind::TsNeverKeyword,
    })
}

pub fn null_type() -> TsType {
    TsType::TsKeywordType(TsKeywordType {
        span: DUMMY_SP,
        kind: TsKeywordTypeKind::TsNullKeyword,
    })
}

// pub fn lit_str_tuple_expr(elements: impl Iterator<Item = impl Into<Atom>>) -> Expr {
//     Expr::Array(swc_ecma_ast::ArrayLit {
//         span: DUMMY_SP,
//         elems: elements
//             .map(|e| {
//                 Some(ExprOrSpread {
//                     spread: None,
//                     expr: Box::new(lit_str(e).into()),
//                 })
//             })
//             .collect(),
//     })
// }

/// Creates a function with a return type.
#[builder(finish_fn = build)]
pub fn fn_overload(params: Vec<Param>, return_type: TsType, comment: Option<&str>) -> Function {
    Function {
        params,
        decorators: vec![],
        span: create_comment_span(comment),
        ctxt: SyntaxContext::default(),
        body: None,
        is_generator: false,
        is_async: false,
        type_params: None,
        return_type: Some(Box::new(TsTypeAnn {
            span: DUMMY_SP,
            type_ann: Box::new(return_type),
        })),
    }
}

#[builder(finish_fn = build)]
pub fn fn_param(name: impl Into<Atom>, type_ann: Option<TsType>) -> TsFnParam {
    TsFnParam::Ident(BindingIdent {
        id: ident(name),
        type_ann: type_ann.map(|t| {
            Box::new(TsTypeAnn {
                span: DUMMY_SP,
                type_ann: Box::new(t),
            })
        }),
    })
}

pub fn into_null_union_type(ty: TsType) -> TsType {
    union_type(vec![ty, null_type()].into_iter())
}