Skip to main content

fresh_plugin_api_macros/
lib.rs

1//! # Fresh Plugin API Macros
2//!
3//! Proc macros for generating TypeScript definitions from Rust QuickJS API implementations.
4//!
5//! ## Overview
6//!
7//! This crate provides the `#[plugin_api_impl]` attribute macro that:
8//! 1. Parses method signatures from a `JsEditorApi` impl block
9//! 2. Generates TypeScript type definitions (`.d.ts`)
10//! 3. Automatically writes to `plugins/lib/fresh.d.ts` during compilation
11//!
12//! ## Usage
13//!
14//! ```rust,ignore
15//! use fresh_plugin_api_macros::{plugin_api, plugin_api_impl};
16//!
17//! #[plugin_api_impl]
18//! #[rquickjs::methods(rename_all = "camelCase")]
19//! impl JsEditorApi {
20//!     /// Get the active buffer ID (0 if none)
21//!     pub fn get_active_buffer_id(&self) -> u32 { ... }
22//!
23//!     /// Create a virtual buffer (async)
24//!     #[plugin_api(async_promise, js_name = "createVirtualBuffer", ts_return = "number")]
25//!     #[qjs(rename = "_createVirtualBufferStart")]
26//!     pub fn create_virtual_buffer_start(&self, opts: Object) -> u64 { ... }
27//! }
28//! ```
29//!
30//! ## Attributes
31//!
32//! ### `#[plugin_api_impl]`
33//!
34//! Apply to the impl block to enable TypeScript generation. Generates:
35//! - `{IMPL_NAME}_TYPESCRIPT_DEFINITIONS: &str` - Full `.d.ts` content
36//! - `{IMPL_NAME}_JS_METHODS: &[&str]` - List of all JS method names
37//!
38//! ### `#[plugin_api(...)]`
39//!
40//! Apply to individual methods for customization:
41//!
42//! | Attribute | Description | Example |
43//! |-----------|-------------|---------|
44//! | `skip` | Exclude from TypeScript | `#[plugin_api(skip)]` |
45//! | `js_name = "..."` | Custom JS method name | `#[plugin_api(js_name = "myMethod")]` |
46//! | `async_promise` | Returns `Promise<T>` | `#[plugin_api(async_promise)]` |
47//! | `async_thenable` | Returns `ProcessHandle<T>` (cancellable) | `#[plugin_api(async_thenable)]` |
48//! | `ts_type = "..."` | Custom TypeScript type for parameter | `#[plugin_api(ts_type = "BufferInfo")]` |
49//! | `ts_return = "..."` | Custom TypeScript return type | `#[plugin_api(ts_return = "string")]` |
50//!
51//! ## Type Mapping
52//!
53//! | Rust Type | TypeScript Type | Notes |
54//! |-----------|-----------------|-------|
55//! | `u8`, `u16`, `u32`, `i32`, etc. | `number` | All numeric types |
56//! | `bool` | `boolean` | |
57//! | `String`, `&str` | `string` | |
58//! | `()` | `void` | |
59//! | `Option<T>` | `T \| null` | |
60//! | `Vec<T>` | `T[]` | |
61//! | `rquickjs::Ctx<'js>` | *(skipped)* | Runtime context |
62//! | `rquickjs::function::Opt<T>` | `T?` | Optional parameter |
63//! | `rquickjs::function::Rest<T>` | `...T[]` | Variadic parameter |
64//! | `rquickjs::Result<T>` | `T` | Unwrapped |
65//! | `rquickjs::Object<'js>` | `Record<string, unknown>` | Use `ts_type` for specifics |
66//!
67//! ## Async Methods
68//!
69//! Async methods must be explicitly marked with `#[plugin_api(async_promise)]` or
70//! `#[plugin_api(async_thenable)]`. There is no heuristic-based detection.
71//!
72//! - `async_promise`: For operations that complete with a result
73//! - `async_thenable`: For cancellable operations (e.g., process spawning)
74//!
75//! ## File Output
76//!
77//! The macro automatically writes `plugins/lib/fresh.d.ts` when:
78//! 1. Building the main crate (not the macro crate)
79//! 2. The content has changed (avoids unnecessary rebuilds)
80//!
81//! ## Design Principles
82//!
83//! 1. **Single Source of Truth**: API defined once in Rust, TypeScript generated
84//! 2. **Explicit Over Implicit**: No magic naming conventions, use attributes
85//! 3. **Deterministic Output**: Same input always produces same output
86//! 4. **Preserve Original Code**: Macro passes through impl block unchanged
87//! 5. **Clear Errors**: Compile-time errors with helpful messages
88
89use proc_macro::TokenStream;
90use quote::{format_ident, quote};
91use syn::{
92    parse_macro_input, spanned::Spanned, Attribute, FnArg, GenericArgument, ImplItem, ImplItemFn,
93    ItemImpl, Meta, Pat, PathArguments, ReturnType, Type,
94};
95
96// ============================================================================
97// Error Handling
98// ============================================================================
99
100/// Create a compile error with a helpful message and source span
101fn compile_error(span: proc_macro2::Span, message: &str) -> proc_macro2::TokenStream {
102    syn::Error::new(span, message).to_compile_error()
103}
104
105// ============================================================================
106// API Method Classification
107// ============================================================================
108
109/// Classification of API method return behavior
110#[derive(Debug, Clone, Copy, PartialEq, Eq)]
111enum ApiKind {
112    /// Synchronous method - returns value directly
113    Sync,
114    /// Async method returning `Promise<T>`
115    AsyncPromise,
116    /// Async method returning `ProcessHandle<T>` (cancellable)
117    AsyncThenable,
118}
119
120impl ApiKind {
121    /// Wrap a TypeScript type in the appropriate async wrapper
122    fn wrap_return_type(&self, inner: &str) -> String {
123        match self {
124            ApiKind::Sync => inner.to_string(),
125            ApiKind::AsyncPromise => format!("Promise<{}>", inner),
126            ApiKind::AsyncThenable => format!("ProcessHandle<{}>", inner),
127        }
128    }
129}
130
131// ============================================================================
132// Parsed Structures (Intermediate Representation)
133// ============================================================================
134
135/// Parsed API method - intermediate representation for code generation
136#[derive(Debug)]
137struct ApiMethod {
138    /// JavaScript method name (camelCase)
139    js_name: String,
140    /// Method classification (sync/async)
141    kind: ApiKind,
142    /// Parsed parameters
143    params: Vec<ParamInfo>,
144    /// TypeScript return type
145    return_type: String,
146    /// Documentation from doc comments
147    doc: String,
148    /// Raw TypeScript signature override (from `ts_raw = "..."`)
149    /// When set, replaces the entire auto-generated signature line.
150    ts_raw: Option<String>,
151}
152
153/// Parsed parameter information
154#[derive(Debug)]
155struct ParamInfo {
156    /// Parameter name (camelCase)
157    name: String,
158    /// TypeScript type
159    ts_type: String,
160    /// Whether parameter is optional (from `Opt<T>`)
161    optional: bool,
162    /// Whether parameter is variadic (from `Rest<T>`)
163    variadic: bool,
164}
165
166impl ParamInfo {
167    /// Format as TypeScript parameter
168    fn to_typescript(&self) -> String {
169        if self.variadic {
170            format!("...{}: {}[]", self.name, self.ts_type)
171        } else if self.optional {
172            format!("{}?: {}", self.name, self.ts_type)
173        } else {
174            format!("{}: {}", self.name, self.ts_type)
175        }
176    }
177}
178
179// ============================================================================
180// String Utilities
181// ============================================================================
182
183/// Convert snake_case identifier to camelCase
184///
185/// # Examples
186/// ```ignore
187/// assert_eq!(to_camel_case("get_active_buffer"), "getActiveBuffer");
188/// assert_eq!(to_camel_case("simple"), "simple");
189/// ```
190fn to_camel_case(s: &str) -> String {
191    let mut result = String::with_capacity(s.len());
192    let mut capitalize_next = false;
193
194    for c in s.chars() {
195        if c == '_' {
196            capitalize_next = true;
197        } else if capitalize_next {
198            result.push(c.to_ascii_uppercase());
199            capitalize_next = false;
200        } else {
201            result.push(c);
202        }
203    }
204    result
205}
206
207// ============================================================================
208// Attribute Parsing
209// ============================================================================
210
211/// Extract documentation from `#[doc = "..."]` attributes
212fn extract_doc_comment(attrs: &[Attribute]) -> String {
213    attrs
214        .iter()
215        .filter_map(|attr| {
216            if !attr.path().is_ident("doc") {
217                return None;
218            }
219            if let Meta::NameValue(meta) = &attr.meta {
220                if let syn::Expr::Lit(expr_lit) = &meta.value {
221                    if let syn::Lit::Str(lit_str) = &expr_lit.lit {
222                        return Some(lit_str.value().trim().to_string());
223                    }
224                }
225            }
226            None
227        })
228        .collect::<Vec<_>>()
229        .join("\n")
230}
231
232/// Parse a string value from attribute tokens like `key = "value"`
233fn parse_attr_string_value(tokens: &str, key: &str) -> Option<String> {
234    let start = tokens.find(key)?;
235    let rest = &tokens[start..];
236    let eq_pos = rest.find('=')?;
237    let after_eq = rest[eq_pos + 1..].trim();
238
239    if !after_eq.starts_with('"') {
240        return None;
241    }
242
243    let end_quote = after_eq[1..].find('"')?;
244    Some(after_eq[1..end_quote + 1].to_string())
245}
246
247/// Check if `#[plugin_api(...)]` contains a specific flag
248fn has_plugin_api_flag(attrs: &[Attribute], flag: &str) -> bool {
249    attrs.iter().any(|attr| {
250        if !attr.path().is_ident("plugin_api") {
251            return false;
252        }
253        if let Meta::List(meta_list) = &attr.meta {
254            meta_list.tokens.to_string().contains(flag)
255        } else {
256            false
257        }
258    })
259}
260
261/// Get a string value from `#[plugin_api(key = "value")]`
262fn get_plugin_api_value(attrs: &[Attribute], key: &str) -> Option<String> {
263    for attr in attrs {
264        if !attr.path().is_ident("plugin_api") {
265            continue;
266        }
267        if let Meta::List(meta_list) = &attr.meta {
268            if let Some(value) = parse_attr_string_value(&meta_list.tokens.to_string(), key) {
269                return Some(value);
270            }
271        }
272    }
273    None
274}
275
276/// Get custom JS name from `#[qjs(rename = "...")]` or `#[plugin_api(js_name = "...")]`
277fn get_js_name(attrs: &[Attribute]) -> Option<String> {
278    // First check plugin_api attribute (takes precedence)
279    if let Some(name) = get_plugin_api_value(attrs, "js_name") {
280        return Some(name);
281    }
282
283    // Then check qjs attribute
284    for attr in attrs {
285        if !attr.path().is_ident("qjs") {
286            continue;
287        }
288        if let Meta::List(meta_list) = &attr.meta {
289            if let Some(name) = parse_attr_string_value(&meta_list.tokens.to_string(), "rename") {
290                return Some(name);
291            }
292        }
293    }
294    None
295}
296
297// ============================================================================
298// Type Analysis
299// ============================================================================
300
301/// Extract inner type from generic wrapper like `Option<T>`, `Vec<T>`
302fn extract_inner_type(ty: &Type) -> Option<Type> {
303    if let Type::Path(type_path) = ty {
304        if let Some(segment) = type_path.path.segments.last() {
305            if let PathArguments::AngleBracketed(args) = &segment.arguments {
306                if let Some(GenericArgument::Type(inner)) = args.args.first() {
307                    return Some(inner.clone());
308                }
309            }
310        }
311    }
312    None
313}
314
315/// Get the final segment name from a type path (e.g., "Opt" from "rquickjs::function::Opt")
316fn get_type_name(ty: &Type) -> Option<String> {
317    if let Type::Path(type_path) = ty {
318        type_path.path.segments.last().map(|s| s.ident.to_string())
319    } else {
320        None
321    }
322}
323
324/// Check if type is QuickJS context (`Ctx<'js>`) - should be skipped from parameters
325fn is_ctx_type(ty: &Type) -> bool {
326    if let Type::Path(type_path) = ty {
327        // Check final segment
328        if let Some(segment) = type_path.path.segments.last() {
329            if segment.ident == "Ctx" {
330                return true;
331            }
332        }
333        // Check full path for "Ctx" anywhere
334        let path_str: String = type_path
335            .path
336            .segments
337            .iter()
338            .map(|s| s.ident.to_string())
339            .collect::<Vec<_>>()
340            .join("::");
341        path_str.contains("Ctx")
342    } else {
343        false
344    }
345}
346
347/// Check if type is `Opt<T>` (optional parameter)
348fn is_opt_type(ty: &Type) -> bool {
349    get_type_name(ty).is_some_and(|n| n == "Opt")
350}
351
352/// Check if type is `Rest<T>` (variadic parameter)
353fn is_rest_type(ty: &Type) -> bool {
354    get_type_name(ty).is_some_and(|n| n == "Rest")
355}
356
357// ============================================================================
358// Rust to TypeScript Type Conversion
359// ============================================================================
360
361/// Convert a Rust type to its TypeScript equivalent
362///
363/// Handles:
364/// - Primitive types (numbers, bool, string)
365/// - Generic wrappers (Option, Vec, Result)
366/// - QuickJS types (Opt, Rest, Object, Value)
367/// - Known API types (BufferInfo, etc.)
368fn rust_to_typescript(ty: &Type, attrs: &[Attribute]) -> String {
369    // Check for explicit ts_type override
370    if let Some(custom) = get_plugin_api_value(attrs, "ts_type") {
371        return custom;
372    }
373
374    match ty {
375        Type::Path(type_path) => {
376            let type_name = type_path
377                .path
378                .segments
379                .last()
380                .map(|s| s.ident.to_string())
381                .unwrap_or_else(|| "unknown".to_string());
382
383            match type_name.as_str() {
384                // Numeric types -> number
385                "u8" | "u16" | "u32" | "u64" | "i8" | "i16" | "i32" | "i64" | "usize" | "isize"
386                | "f32" | "f64" => "number".to_string(),
387
388                // Boolean
389                "bool" => "boolean".to_string(),
390
391                // String types
392                "String" | "str" => "string".to_string(),
393
394                // Unit type
395                "()" => "void".to_string(),
396
397                // Option<T> -> T | null
398                "Option" => {
399                    let inner = extract_inner_type(ty)
400                        .map(|t| rust_to_typescript(&t, &[]))
401                        .unwrap_or_else(|| "unknown".to_string());
402                    format!("{} | null", inner)
403                }
404
405                // Vec<T> -> T[]
406                "Vec" => {
407                    let inner = extract_inner_type(ty)
408                        .map(|t| rust_to_typescript(&t, &[]))
409                        .unwrap_or_else(|| "unknown".to_string());
410                    format!("{}[]", inner)
411                }
412
413                // Opt<T> -> extract inner (optionality handled at param level)
414                "Opt" => extract_inner_type(ty)
415                    .map(|t| rust_to_typescript(&t, &[]))
416                    .unwrap_or_else(|| "unknown".to_string()),
417
418                // Rest<T> -> extract inner (variadic handled at param level)
419                "Rest" => extract_inner_type(ty)
420                    .map(|t| rust_to_typescript(&t, &[]))
421                    .unwrap_or_else(|| "unknown".to_string()),
422
423                // Result<T, E> -> extract T
424                "Result" => extract_inner_type(ty)
425                    .map(|t| rust_to_typescript(&t, &[]))
426                    .unwrap_or_else(|| "unknown".to_string()),
427
428                // QuickJS types
429                "Value" => "unknown".to_string(),
430                "Object" => "Record<string, unknown>".to_string(),
431
432                // Rust collections
433                "HashMap" | "BTreeMap" => "Record<string, unknown>".to_string(),
434
435                // Known API types - pass through unchanged
436                "BufferInfo"
437                | "CursorInfo"
438                | "ViewportInfo"
439                | "SpawnResult"
440                | "BackgroundProcessResult"
441                | "DirEntry"
442                | "FileStat"
443                | "CreateVirtualBufferResult"
444                | "PromptSuggestion"
445                | "TextPropertyEntry"
446                | "JsTextPropertyEntry"
447                | "CreateVirtualBufferOptions"
448                | "CreateVirtualBufferInSplitOptions"
449                | "CreateVirtualBufferInExistingSplitOptions"
450                | "VirtualBufferResult"
451                | "ActionSpec"
452                | "ActionPopupAction"
453                | "ActionPopupOptions"
454                | "ViewTokenWire"
455                | "ViewTokenStyle"
456                | "LayoutHints"
457                | "FileExplorerDecoration"
458                | "TsCompositeLayoutConfig"
459                | "TsCompositeSourceConfig"
460                | "TsCompositePaneStyle"
461                | "TsHighlightSpan"
462                | "TsActionPopupAction"
463                | "JsDiagnostic"
464                | "CreateTerminalOptions"
465                | "TerminalResult" => type_name,
466
467                // Types renamed by ts-rs — map Rust name to TypeScript name
468                "CompositeHunk" => "TsCompositeHunk".to_string(),
469                "CreateCompositeBufferOptions" => "TsCreateCompositeBufferOptions".to_string(),
470                "Suggestion" => "PromptSuggestion".to_string(),
471
472                // Default: use type name as-is
473                _ => type_name,
474            }
475        }
476        Type::Tuple(tuple) if tuple.elems.is_empty() => "void".to_string(),
477        Type::Reference(reference) => rust_to_typescript(&reference.elem, attrs),
478        _ => "unknown".to_string(),
479    }
480}
481
482// ============================================================================
483// Method Parsing
484// ============================================================================
485
486/// Parse a method from the impl block into an ApiMethod
487///
488/// Returns `None` if the method should be skipped (marked with `skip` or internal)
489fn parse_method(method: &ImplItemFn) -> Option<ApiMethod> {
490    // Skip methods marked with #[plugin_api(skip)]
491    if has_plugin_api_flag(&method.attrs, "skip") {
492        return None;
493    }
494
495    let rust_name = method.sig.ident.to_string();
496    let doc = extract_doc_comment(&method.attrs);
497
498    // Determine method kind from explicit attributes only (no heuristics)
499    let kind = if has_plugin_api_flag(&method.attrs, "async_thenable") {
500        ApiKind::AsyncThenable
501    } else if has_plugin_api_flag(&method.attrs, "async_promise") {
502        ApiKind::AsyncPromise
503    } else {
504        ApiKind::Sync
505    };
506
507    // Get JS name: explicit > snake_to_camel conversion
508    let js_name = get_js_name(&method.attrs).unwrap_or_else(|| to_camel_case(&rust_name));
509
510    // Skip internal methods (names starting with underscore)
511    if js_name.starts_with('_') {
512        return None;
513    }
514
515    // Parse parameters
516    let params: Vec<ParamInfo> = method
517        .sig
518        .inputs
519        .iter()
520        .filter_map(|arg| {
521            let FnArg::Typed(pat_type) = arg else {
522                return None;
523            };
524            let Pat::Ident(pat_ident) = &*pat_type.pat else {
525                return None;
526            };
527
528            let raw_name = pat_ident.ident.to_string();
529
530            // Skip self parameter
531            if raw_name == "self" {
532                return None;
533            }
534
535            // Strip leading underscore (Rust convention for "unused" params)
536            let param_name = raw_name.strip_prefix('_').unwrap_or(&raw_name);
537
538            let ty = &*pat_type.ty;
539
540            // Skip QuickJS context parameter
541            if is_ctx_type(ty) {
542                return None;
543            }
544
545            Some(ParamInfo {
546                name: to_camel_case(param_name),
547                ts_type: rust_to_typescript(ty, &pat_type.attrs),
548                optional: is_opt_type(ty),
549                variadic: is_rest_type(ty),
550            })
551        })
552        .collect();
553
554    // Parse return type
555    let return_type = match &method.sig.output {
556        ReturnType::Default => "void".to_string(),
557        ReturnType::Type(_, ty) => {
558            // Check for explicit ts_return override
559            get_plugin_api_value(&method.attrs, "ts_return")
560                .unwrap_or_else(|| rust_to_typescript(ty, &method.attrs))
561        }
562    };
563
564    // Check for raw TS signature override
565    let ts_raw = get_plugin_api_value(&method.attrs, "ts_raw");
566
567    Some(ApiMethod {
568        js_name,
569        kind,
570        params,
571        return_type,
572        doc,
573        ts_raw,
574    })
575}
576
577// ============================================================================
578// TypeScript Code Generation
579// ============================================================================
580
581/// Generate TypeScript method signature with JSDoc
582fn generate_ts_method(method: &ApiMethod) -> String {
583    let mut lines = Vec::new();
584
585    // JSDoc comment
586    if !method.doc.is_empty() {
587        lines.push("  /**".to_string());
588        for line in method.doc.lines() {
589            lines.push(format!("   * {}", line));
590        }
591        lines.push("   */".to_string());
592    }
593
594    // Use raw TS override if provided, otherwise auto-generate
595    if let Some(raw) = &method.ts_raw {
596        lines.push(format!("  {};", raw));
597    } else {
598        // Method signature
599        let params: String = method
600            .params
601            .iter()
602            .map(ParamInfo::to_typescript)
603            .collect::<Vec<_>>()
604            .join(", ");
605
606        let return_type = method.kind.wrap_return_type(&method.return_type);
607
608        lines.push(format!(
609            "  {}({}): {};",
610            method.js_name, params, return_type
611        ));
612    }
613
614    lines.join("\n")
615}
616
617/// Generate the TypeScript preamble (header comment and getEditor declaration)
618fn generate_ts_preamble() -> &'static str {
619    r#"/**
620 * Fresh Editor TypeScript Plugin API
621 *
622 * This file provides type definitions for the Fresh editor's TypeScript plugin system.
623 * Plugins have access to the global `editor` object which provides methods to:
624 * - Query editor state (buffers, cursors, viewports)
625 * - Modify buffer content (insert, delete text)
626 * - Add visual decorations (overlays, highlighting)
627 * - Interact with the editor UI (status messages, prompts)
628 *
629 * AUTO-GENERATED FILE - DO NOT EDIT MANUALLY
630 * Generated by fresh-plugin-api-macros + ts-rs from JsEditorApi impl
631 */
632
633/**
634 * Get the editor API instance.
635 * Plugins must call this at the top of their file to get a scoped editor object.
636 */
637declare function getEditor(): EditorAPI;
638
639/**
640 * Register a function as a named handler on the global scope.
641 *
642 * Handler functions registered this way can be referenced by name in
643 * `editor.registerCommand()`, `editor.on()`, and mode keybindings.
644 *
645 * The `fn` parameter is typed as `Function` because the runtime passes
646 * different argument shapes depending on the caller: command handlers
647 * receive no arguments, event handlers receive an event-specific data
648 * object (e.g. `{ buffer_id: number }`), and prompt handlers receive
649 * `{ prompt_type: string, input: string }`. Type-annotate your handler
650 * parameters to match the event you are handling.
651 *
652 * @param name - Handler name (referenced by registerCommand, on, etc.)
653 * @param fn - The handler function
654 */
655declare function registerHandler(name: string, fn: Function): void;
656
657/** Handle for a cancellable async operation */
658interface ProcessHandle<T> extends PromiseLike<T> {
659  /** Promise that resolves to the result when complete */
660  readonly result: Promise<T>;
661  /** Cancel/kill the operation. Returns true if cancelled, false if already completed */
662  kill(): Promise<boolean>;
663}
664
665/** Buffer identifier */
666type BufferId = number;
667
668/** Split identifier */
669type SplitId = number;
670
671/**
672 * Payload delivered to handlers registered with `editor.on("mouse_click", ...)`.
673 *
674 * All coordinate fields are in cell (terminal character) units. `buffer_*`
675 * fields are `null` when the click did not land in any buffer panel.
676 */
677interface MouseClickHookArgs {
678  /** Screen column (0-indexed). */
679  column: number;
680  /** Screen row (0-indexed). */
681  row: number;
682  /** Mouse button: "left", "right", "middle". */
683  button: string;
684  /** Modifier keys (e.g. "shift"). */
685  modifiers: string;
686  /** X offset of the content area the click landed in. */
687  content_x: number;
688  /** Y offset of the content area the click landed in. */
689  content_y: number;
690  /** Buffer under the click, or `null` when outside any buffer panel. */
691  buffer_id: number | null;
692  /** 0-indexed buffer row (line number) of the click, accounting for scroll. */
693  buffer_row: number | null;
694  /** 0-indexed byte column inside the buffer row. */
695  buffer_col: number | null;
696}
697
698"#
699}
700
701/// Generate the EditorAPI interface (methods only)
702/// Types are provided separately via ts-rs
703fn generate_editor_api_interface(methods: &[ApiMethod]) -> String {
704    let method_sigs: Vec<String> = methods.iter().map(generate_ts_method).collect();
705
706    format!(
707        "/**\n * Main editor API interface\n */\ninterface EditorAPI {{\n{}\n}}\n",
708        method_sigs.join("\n\n")
709    )
710}
711
712/// Built-in TypeScript types that don't need to be collected
713const BUILTIN_TS_TYPES: &[&str] = &[
714    "number",
715    "string",
716    "boolean",
717    "void",
718    "unknown",
719    "null",
720    "undefined",
721    "Record",
722    "Array",
723    "Promise",
724    "ProcessHandle",
725    "PromiseLike",
726    "BufferId",
727    "SplitId", // Defined in preamble
728];
729
730/// Extract type names from a TypeScript type string
731///
732/// Handles:
733/// - Simple types: "SpawnResult" -> ["SpawnResult"]
734/// - Generics: "ProcessHandle<SpawnResult>" -> ["SpawnResult"]
735/// - Union: "string | null" -> []
736/// - Arrays: "BufferInfo[]" -> ["BufferInfo"]
737fn extract_type_references(ts_type: &str) -> Vec<String> {
738    let mut types = Vec::new();
739
740    // Remove generic wrappers like ProcessHandle<...>, Promise<...>, Array<...>
741    let mut current = ts_type.to_string();
742
743    // Strip outer generics repeatedly
744    while let Some(start) = current.find('<') {
745        if let Some(end) = current.rfind('>') {
746            let outer = current[..start].trim().to_string();
747            let inner = current[start + 1..end].trim().to_string();
748
749            // But check if outer is a custom type we need
750            if !BUILTIN_TS_TYPES.contains(&outer.as_str()) && !outer.is_empty() {
751                types.push(outer);
752            }
753
754            // Process the inner type
755            current = inner;
756        } else {
757            break;
758        }
759    }
760
761    // Handle union types (split by |)
762    for part in current.split('|') {
763        let part = part.trim();
764
765        // Skip built-in types
766        if BUILTIN_TS_TYPES.contains(&part) {
767            continue;
768        }
769
770        // Handle array types like "BufferInfo[]"
771        let part = part.trim_end_matches("[]");
772
773        // Skip Record<...> and other generics
774        if part.contains('<') || part.contains('>') {
775            continue;
776        }
777
778        // Skip empty or built-in
779        if part.is_empty() || BUILTIN_TS_TYPES.contains(&part) {
780            continue;
781        }
782
783        // This looks like a custom type reference
784        if part.chars().next().is_some_and(|c| c.is_uppercase()) {
785            types.push(part.to_string());
786        }
787    }
788
789    types
790}
791
792/// Collect all type references from methods
793fn collect_referenced_types(methods: &[ApiMethod]) -> Vec<String> {
794    let mut types = std::collections::HashSet::new();
795
796    for method in methods {
797        // Collect from return type
798        for ty in extract_type_references(&method.return_type) {
799            types.insert(ty);
800        }
801
802        // Collect from parameters
803        for param in &method.params {
804            for ty in extract_type_references(&param.ts_type) {
805                types.insert(ty);
806            }
807        }
808    }
809
810    let mut sorted: Vec<String> = types.into_iter().collect();
811    sorted.sort();
812    sorted
813}
814
815// ============================================================================
816// Proc Macros
817// ============================================================================
818
819/// Generate TypeScript definitions from a QuickJS impl block
820///
821/// # Generated Constants
822///
823/// - `{IMPL_NAME}_TS_PREAMBLE: &str` - Header comment + getEditor + ProcessHandle + BufferId/SplitId
824/// - `{IMPL_NAME}_TS_EDITOR_API: &str` - Just the EditorAPI interface with methods
825/// - `{IMPL_NAME}_JS_METHODS: &[&str]` - List of all JS method names
826///
827/// The main crate should combine these with ts-rs generated types to create fresh.d.ts.
828///
829/// # Example
830///
831/// ```rust,ignore
832/// #[plugin_api_impl]
833/// #[rquickjs::methods(rename_all = "camelCase")]
834/// impl JsEditorApi {
835///     /// Get the active buffer ID
836///     pub fn get_active_buffer_id(&self) -> u32 { ... }
837///
838///     /// Spawn a process (cancellable)
839///     #[plugin_api(async_thenable, js_name = "spawnProcess", ts_return = "SpawnResult")]
840///     #[qjs(rename = "_spawnProcessStart")]
841///     pub fn spawn_process_start(&self, cmd: String) -> u64 { ... }
842/// }
843/// ```
844///
845/// # Errors
846///
847/// Compile-time error if applied to non-impl items.
848#[proc_macro_attribute]
849pub fn plugin_api_impl(_attr: TokenStream, item: TokenStream) -> TokenStream {
850    let input = parse_macro_input!(item as ItemImpl);
851
852    // Extract impl target name
853    let impl_name = match &*input.self_ty {
854        Type::Path(type_path) => type_path
855            .path
856            .segments
857            .last()
858            .map(|s| s.ident.to_string())
859            .unwrap_or_else(|| "Unknown".to_string()),
860        _ => {
861            return compile_error(
862                input.self_ty.span(),
863                "plugin_api_impl requires a named type (e.g., `impl JsEditorApi`)",
864            )
865            .into();
866        }
867    };
868
869    // Generate constant names
870    let preamble_const = format_ident!("{}_TS_PREAMBLE", impl_name.to_uppercase());
871    let editor_api_const = format_ident!("{}_TS_EDITOR_API", impl_name.to_uppercase());
872    let methods_const = format_ident!("{}_JS_METHODS", impl_name.to_uppercase());
873
874    // Parse methods into intermediate representation
875    let methods: Vec<ApiMethod> = input
876        .items
877        .iter()
878        .filter_map(|item| {
879            if let ImplItem::Fn(method) = item {
880                parse_method(method)
881            } else {
882                None
883            }
884        })
885        .collect();
886
887    // Generate TypeScript parts
888    let preamble = generate_ts_preamble();
889    let editor_api = generate_editor_api_interface(&methods);
890
891    // Collect JS method names
892    let js_names: Vec<&str> = methods.iter().map(|m| m.js_name.as_str()).collect();
893
894    // Collect referenced types (for ts-rs export)
895    let referenced_types = collect_referenced_types(&methods);
896    let types_const = format_ident!("{}_REFERENCED_TYPES", impl_name.to_uppercase());
897
898    // Strip #[plugin_api(...)] attributes from method parameters before emitting,
899    // since plugin_api is a proc_macro_attribute and can't appear on parameters.
900    // The attribute was already read during parse_method for ts_type overrides.
901    let mut cleaned_input = input.clone();
902    for item in &mut cleaned_input.items {
903        if let ImplItem::Fn(method) = item {
904            for arg in &mut method.sig.inputs {
905                if let FnArg::Typed(pat_type) = arg {
906                    pat_type
907                        .attrs
908                        .retain(|attr| !attr.path().is_ident("plugin_api"));
909                }
910            }
911        }
912    }
913
914    // Generate output: original impl + constants
915    let expanded = quote! {
916        #cleaned_input
917
918        /// TypeScript preamble (header, getEditor, ProcessHandle, BufferId, SplitId)
919        ///
920        /// Combine with ts-rs types and EDITOR_API to create fresh.d.ts
921        pub const #preamble_const: &str = #preamble;
922
923        /// TypeScript EditorAPI interface (methods only)
924        ///
925        /// Combine with preamble and ts-rs types to create fresh.d.ts
926        pub const #editor_api_const: &str = #editor_api;
927
928        /// List of all JavaScript method names exposed in the API
929        ///
930        /// Useful for verification and debugging.
931        pub const #methods_const: &[&str] = &[#(#js_names),*];
932
933        /// List of TypeScript types referenced in method signatures
934        ///
935        /// These types need to be defined (via ts-rs or manually) in fresh.d.ts.
936        /// Use this to automatically collect type definitions.
937        pub const #types_const: &[&str] = &[#(#referenced_types),*];
938    };
939
940    TokenStream::from(expanded)
941}
942
943/// Marker attribute for customizing individual API methods
944///
945/// This attribute is parsed by `#[plugin_api_impl]` but doesn't generate any code itself.
946///
947/// # Options
948///
949/// - `skip` - Exclude method from TypeScript generation
950/// - `js_name = "..."` - Custom JavaScript method name
951/// - `async_promise` - Method returns `Promise<T>`
952/// - `async_thenable` - Method returns `ProcessHandle<T>` (cancellable)
953/// - `ts_type = "..."` - Custom TypeScript type for a parameter
954/// - `ts_return = "..."` - Custom TypeScript return type
955/// - `ts_raw = "..."` - Raw TypeScript signature (replaces auto-generated signature)
956///
957/// # Examples
958///
959/// ```rust,ignore
960/// // Skip internal helper
961/// #[plugin_api(skip)]
962/// fn internal_helper(&self) { ... }
963///
964/// // Async method with custom return type
965/// #[plugin_api(async_promise, js_name = "fetchData", ts_return = "DataResult")]
966/// fn fetch_data_start(&self) -> u64 { ... }
967///
968/// // Cancellable operation
969/// #[plugin_api(async_thenable, js_name = "spawnProcess", ts_return = "SpawnResult")]
970/// fn spawn_process_start(&self, cmd: String) -> u64 { ... }
971/// ```
972#[proc_macro_attribute]
973pub fn plugin_api(_attr: TokenStream, item: TokenStream) -> TokenStream {
974    // Marker attribute - passes through unchanged
975    item
976}
977
978// ============================================================================
979// Unit Tests
980// ============================================================================
981
982#[cfg(test)]
983mod tests {
984    use super::*;
985
986    #[test]
987    fn test_to_camel_case() {
988        assert_eq!(to_camel_case("get_active_buffer"), "getActiveBuffer");
989        assert_eq!(to_camel_case("simple"), "simple");
990        assert_eq!(to_camel_case("a_b_c"), "aBC");
991        // Note: leading underscores in parameter names are stripped by parse_method
992        // before to_camel_case is called, so "process_id" is the input, not "_process_id"
993        assert_eq!(to_camel_case("process_id"), "processId");
994        assert_eq!(to_camel_case("already_camel"), "alreadyCamel");
995        assert_eq!(to_camel_case(""), "");
996        assert_eq!(to_camel_case("_leading"), "Leading");
997        assert_eq!(to_camel_case("trailing_"), "trailing");
998    }
999
1000    #[test]
1001    fn test_parse_attr_string_value() {
1002        assert_eq!(
1003            parse_attr_string_value(r#"js_name = "myMethod""#, "js_name"),
1004            Some("myMethod".to_string())
1005        );
1006        assert_eq!(
1007            parse_attr_string_value(r#"skip, js_name = "foo""#, "js_name"),
1008            Some("foo".to_string())
1009        );
1010        assert_eq!(parse_attr_string_value(r#"skip"#, "js_name"), None);
1011        assert_eq!(parse_attr_string_value(r#"js_name = 123"#, "js_name"), None);
1012    }
1013
1014    #[test]
1015    fn test_api_kind_wrap_return_type() {
1016        assert_eq!(ApiKind::Sync.wrap_return_type("number"), "number");
1017        assert_eq!(
1018            ApiKind::AsyncPromise.wrap_return_type("number"),
1019            "Promise<number>"
1020        );
1021        assert_eq!(
1022            ApiKind::AsyncThenable.wrap_return_type("SpawnResult"),
1023            "ProcessHandle<SpawnResult>"
1024        );
1025    }
1026
1027    #[test]
1028    fn test_param_info_to_typescript() {
1029        let regular = ParamInfo {
1030            name: "bufferId".to_string(),
1031            ts_type: "number".to_string(),
1032            optional: false,
1033            variadic: false,
1034        };
1035        assert_eq!(regular.to_typescript(), "bufferId: number");
1036
1037        let optional = ParamInfo {
1038            name: "line".to_string(),
1039            ts_type: "number".to_string(),
1040            optional: true,
1041            variadic: false,
1042        };
1043        assert_eq!(optional.to_typescript(), "line?: number");
1044
1045        let variadic = ParamInfo {
1046            name: "parts".to_string(),
1047            ts_type: "string".to_string(),
1048            optional: false,
1049            variadic: true,
1050        };
1051        assert_eq!(variadic.to_typescript(), "...parts: string[]");
1052    }
1053
1054    #[test]
1055    fn test_generate_ts_preamble_contains_required_declarations() {
1056        let preamble = generate_ts_preamble();
1057
1058        // Check essential declarations
1059        assert!(preamble.contains("declare function getEditor(): EditorAPI"));
1060        assert!(preamble.contains("interface ProcessHandle<T>"));
1061        assert!(preamble.contains("type BufferId = number"));
1062        assert!(preamble.contains("type SplitId = number"));
1063
1064        // Check it's marked as auto-generated
1065        assert!(preamble.contains("AUTO-GENERATED FILE"));
1066    }
1067
1068    #[test]
1069    fn test_extract_type_references() {
1070        // Simple type
1071        assert_eq!(extract_type_references("SpawnResult"), vec!["SpawnResult"]);
1072
1073        // Built-in types return empty
1074        assert!(extract_type_references("number").is_empty());
1075        assert!(extract_type_references("string").is_empty());
1076        assert!(extract_type_references("void").is_empty());
1077
1078        // Generic wrapper - extracts inner type
1079        assert_eq!(
1080            extract_type_references("ProcessHandle<SpawnResult>"),
1081            vec!["SpawnResult"]
1082        );
1083        assert_eq!(
1084            extract_type_references("Promise<BufferInfo>"),
1085            vec!["BufferInfo"]
1086        );
1087
1088        // Union with null
1089        assert_eq!(
1090            extract_type_references("CursorInfo | null"),
1091            vec!["CursorInfo"]
1092        );
1093
1094        // Array type
1095        assert_eq!(extract_type_references("BufferInfo[]"), vec!["BufferInfo"]);
1096
1097        // Built-in generics return empty
1098        assert!(extract_type_references("Record<string, unknown>").is_empty());
1099        assert!(extract_type_references("Promise<void>").is_empty());
1100    }
1101
1102    #[test]
1103    fn test_collect_referenced_types() {
1104        let methods = vec![
1105            ApiMethod {
1106                js_name: "spawnProcess".to_string(),
1107                kind: ApiKind::AsyncThenable,
1108                params: vec![],
1109                return_type: "SpawnResult".to_string(),
1110                doc: "".to_string(),
1111                ts_raw: None,
1112            },
1113            ApiMethod {
1114                js_name: "listBuffers".to_string(),
1115                kind: ApiKind::Sync,
1116                params: vec![],
1117                return_type: "BufferInfo[]".to_string(),
1118                doc: "".to_string(),
1119                ts_raw: None,
1120            },
1121        ];
1122
1123        let types = collect_referenced_types(&methods);
1124        assert!(types.contains(&"SpawnResult".to_string()));
1125        assert!(types.contains(&"BufferInfo".to_string()));
1126    }
1127
1128    #[test]
1129    fn test_generate_ts_method_sync() {
1130        let method = ApiMethod {
1131            js_name: "getActiveBufferId".to_string(),
1132            kind: ApiKind::Sync,
1133            params: vec![],
1134            return_type: "number".to_string(),
1135            doc: "Get the active buffer ID".to_string(),
1136            ts_raw: None,
1137        };
1138
1139        let ts = generate_ts_method(&method);
1140        assert!(ts.contains("getActiveBufferId(): number;"));
1141        assert!(ts.contains("Get the active buffer ID"));
1142    }
1143
1144    #[test]
1145    fn test_generate_ts_method_async_promise() {
1146        let method = ApiMethod {
1147            js_name: "delay".to_string(),
1148            kind: ApiKind::AsyncPromise,
1149            params: vec![ParamInfo {
1150                name: "ms".to_string(),
1151                ts_type: "number".to_string(),
1152                optional: false,
1153                variadic: false,
1154            }],
1155            return_type: "void".to_string(),
1156            doc: "".to_string(),
1157            ts_raw: None,
1158        };
1159
1160        let ts = generate_ts_method(&method);
1161        assert!(ts.contains("delay(ms: number): Promise<void>;"));
1162    }
1163
1164    #[test]
1165    fn test_generate_ts_method_async_thenable() {
1166        let method = ApiMethod {
1167            js_name: "spawnProcess".to_string(),
1168            kind: ApiKind::AsyncThenable,
1169            params: vec![
1170                ParamInfo {
1171                    name: "command".to_string(),
1172                    ts_type: "string".to_string(),
1173                    optional: false,
1174                    variadic: false,
1175                },
1176                ParamInfo {
1177                    name: "args".to_string(),
1178                    ts_type: "string".to_string(),
1179                    optional: false,
1180                    variadic: false,
1181                },
1182            ],
1183            return_type: "SpawnResult".to_string(),
1184            doc: "Spawn a process".to_string(),
1185            ts_raw: None,
1186        };
1187
1188        let ts = generate_ts_method(&method);
1189        assert!(
1190            ts.contains("spawnProcess(command: string, args: string): ProcessHandle<SpawnResult>;")
1191        );
1192    }
1193
1194    // ========================================================================
1195    // Tests for ts-rs renamed type mappings
1196    // ========================================================================
1197
1198    /// Helper to parse a Rust type string into a syn::Type
1199    fn parse_type(s: &str) -> Type {
1200        syn::parse_str::<Type>(s).unwrap()
1201    }
1202
1203    #[test]
1204    fn test_renamed_type_composite_hunk() {
1205        let ty = parse_type("Vec<CompositeHunk>");
1206        let ts = rust_to_typescript(&ty, &[]);
1207        assert_eq!(ts, "TsCompositeHunk[]");
1208    }
1209
1210    #[test]
1211    fn test_renamed_type_create_composite_buffer_options() {
1212        let ty = parse_type("CreateCompositeBufferOptions");
1213        let ts = rust_to_typescript(&ty, &[]);
1214        assert_eq!(ts, "TsCreateCompositeBufferOptions");
1215    }
1216
1217    #[test]
1218    fn test_renamed_type_suggestion() {
1219        let ty = parse_type("Vec<Suggestion>");
1220        let ts = rust_to_typescript(&ty, &[]);
1221        assert_eq!(ts, "PromptSuggestion[]");
1222    }
1223
1224    #[test]
1225    fn test_passthrough_type_terminal_result() {
1226        let ty = parse_type("TerminalResult");
1227        let ts = rust_to_typescript(&ty, &[]);
1228        assert_eq!(ts, "TerminalResult");
1229    }
1230
1231    #[test]
1232    fn test_passthrough_type_create_terminal_options() {
1233        let ty = parse_type("CreateTerminalOptions");
1234        let ts = rust_to_typescript(&ty, &[]);
1235        assert_eq!(ts, "CreateTerminalOptions");
1236    }
1237
1238    #[test]
1239    fn test_passthrough_type_cursor_info() {
1240        let ty = parse_type("CursorInfo");
1241        let ts = rust_to_typescript(&ty, &[]);
1242        assert_eq!(ts, "CursorInfo");
1243    }
1244
1245    #[test]
1246    fn test_option_cursor_info() {
1247        let ty = parse_type("Option<CursorInfo>");
1248        let ts = rust_to_typescript(&ty, &[]);
1249        assert_eq!(ts, "CursorInfo | null");
1250    }
1251
1252    #[test]
1253    fn test_extract_type_references_renamed_types() {
1254        // Renamed types should be extracted by their TS name
1255        assert_eq!(
1256            extract_type_references("TsCompositeHunk[]"),
1257            vec!["TsCompositeHunk"]
1258        );
1259        assert_eq!(
1260            extract_type_references("TsCreateCompositeBufferOptions"),
1261            vec!["TsCreateCompositeBufferOptions"]
1262        );
1263        assert_eq!(
1264            extract_type_references("PromptSuggestion[]"),
1265            vec!["PromptSuggestion"]
1266        );
1267    }
1268
1269    #[test]
1270    fn test_extract_type_references_terminal_types() {
1271        assert_eq!(
1272            extract_type_references("Promise<TerminalResult>"),
1273            vec!["TerminalResult"]
1274        );
1275        assert_eq!(
1276            extract_type_references("CreateTerminalOptions"),
1277            vec!["CreateTerminalOptions"]
1278        );
1279    }
1280
1281    #[test]
1282    fn test_extract_type_references_cursor_types() {
1283        assert_eq!(
1284            extract_type_references("CursorInfo | null"),
1285            vec!["CursorInfo"]
1286        );
1287        assert_eq!(extract_type_references("CursorInfo[]"), vec!["CursorInfo"]);
1288    }
1289
1290    #[test]
1291    fn test_generate_ts_method_with_renamed_param_type() {
1292        let method = ApiMethod {
1293            js_name: "updateCompositeAlignment".to_string(),
1294            kind: ApiKind::Sync,
1295            params: vec![
1296                ParamInfo {
1297                    name: "bufferId".to_string(),
1298                    ts_type: "number".to_string(),
1299                    optional: false,
1300                    variadic: false,
1301                },
1302                ParamInfo {
1303                    name: "hunks".to_string(),
1304                    ts_type: "TsCompositeHunk[]".to_string(),
1305                    optional: false,
1306                    variadic: false,
1307                },
1308            ],
1309            return_type: "boolean".to_string(),
1310            doc: "Update alignment hunks".to_string(),
1311            ts_raw: None,
1312        };
1313
1314        let ts = generate_ts_method(&method);
1315        assert!(ts.contains(
1316            "updateCompositeAlignment(bufferId: number, hunks: TsCompositeHunk[]): boolean;"
1317        ));
1318    }
1319
1320    #[test]
1321    fn test_generate_ts_method_cursor_return_types() {
1322        let method = ApiMethod {
1323            js_name: "getPrimaryCursor".to_string(),
1324            kind: ApiKind::Sync,
1325            params: vec![],
1326            return_type: "CursorInfo | null".to_string(),
1327            doc: "Get primary cursor".to_string(),
1328            ts_raw: None,
1329        };
1330        let ts = generate_ts_method(&method);
1331        assert!(ts.contains("getPrimaryCursor(): CursorInfo | null;"));
1332
1333        let method = ApiMethod {
1334            js_name: "getAllCursors".to_string(),
1335            kind: ApiKind::Sync,
1336            params: vec![],
1337            return_type: "CursorInfo[]".to_string(),
1338            doc: "Get all cursors".to_string(),
1339            ts_raw: None,
1340        };
1341        let ts = generate_ts_method(&method);
1342        assert!(ts.contains("getAllCursors(): CursorInfo[];"));
1343
1344        let method = ApiMethod {
1345            js_name: "getAllCursorPositions".to_string(),
1346            kind: ApiKind::Sync,
1347            params: vec![],
1348            return_type: "number[]".to_string(),
1349            doc: "Get all cursor positions".to_string(),
1350            ts_raw: None,
1351        };
1352        let ts = generate_ts_method(&method);
1353        assert!(ts.contains("getAllCursorPositions(): number[];"));
1354    }
1355
1356    #[test]
1357    fn test_generate_ts_method_terminal() {
1358        let method = ApiMethod {
1359            js_name: "createTerminal".to_string(),
1360            kind: ApiKind::AsyncPromise,
1361            params: vec![ParamInfo {
1362                name: "opts".to_string(),
1363                ts_type: "CreateTerminalOptions".to_string(),
1364                optional: true,
1365                variadic: false,
1366            }],
1367            return_type: "TerminalResult".to_string(),
1368            doc: "Create a terminal".to_string(),
1369            ts_raw: None,
1370        };
1371
1372        let ts = generate_ts_method(&method);
1373        assert!(
1374            ts.contains("createTerminal(opts?: CreateTerminalOptions): Promise<TerminalResult>;")
1375        );
1376    }
1377
1378    #[test]
1379    fn test_collect_referenced_types_includes_renamed() {
1380        let methods = vec![
1381            ApiMethod {
1382                js_name: "updateAlignment".to_string(),
1383                kind: ApiKind::Sync,
1384                params: vec![ParamInfo {
1385                    name: "hunks".to_string(),
1386                    ts_type: "TsCompositeHunk[]".to_string(),
1387                    optional: false,
1388                    variadic: false,
1389                }],
1390                return_type: "boolean".to_string(),
1391                doc: "".to_string(),
1392                ts_raw: None,
1393            },
1394            ApiMethod {
1395                js_name: "setSuggestions".to_string(),
1396                kind: ApiKind::Sync,
1397                params: vec![ParamInfo {
1398                    name: "suggestions".to_string(),
1399                    ts_type: "PromptSuggestion[]".to_string(),
1400                    optional: false,
1401                    variadic: false,
1402                }],
1403                return_type: "boolean".to_string(),
1404                doc: "".to_string(),
1405                ts_raw: None,
1406            },
1407            ApiMethod {
1408                js_name: "getPrimaryCursor".to_string(),
1409                kind: ApiKind::Sync,
1410                params: vec![],
1411                return_type: "CursorInfo | null".to_string(),
1412                doc: "".to_string(),
1413                ts_raw: None,
1414            },
1415            ApiMethod {
1416                js_name: "createTerminal".to_string(),
1417                kind: ApiKind::AsyncPromise,
1418                params: vec![ParamInfo {
1419                    name: "opts".to_string(),
1420                    ts_type: "CreateTerminalOptions".to_string(),
1421                    optional: true,
1422                    variadic: false,
1423                }],
1424                return_type: "TerminalResult".to_string(),
1425                doc: "".to_string(),
1426                ts_raw: None,
1427            },
1428        ];
1429
1430        let types = collect_referenced_types(&methods);
1431        assert!(types.contains(&"TsCompositeHunk".to_string()));
1432        assert!(types.contains(&"PromptSuggestion".to_string()));
1433        assert!(types.contains(&"CursorInfo".to_string()));
1434        assert!(types.contains(&"TerminalResult".to_string()));
1435        assert!(types.contains(&"CreateTerminalOptions".to_string()));
1436    }
1437
1438    #[test]
1439    fn test_all_known_types_are_passthrough_or_renamed() {
1440        // Verify that all known types produce expected output
1441        let passthrough_types = vec![
1442            "BufferInfo",
1443            "CursorInfo",
1444            "ViewportInfo",
1445            "SpawnResult",
1446            "BackgroundProcessResult",
1447            "DirEntry",
1448            "PromptSuggestion",
1449            "ActionSpec",
1450            "ActionPopupOptions",
1451            "VirtualBufferResult",
1452            "TerminalResult",
1453            "CreateTerminalOptions",
1454            "TsHighlightSpan",
1455            "JsDiagnostic",
1456        ];
1457
1458        for type_name in &passthrough_types {
1459            let ty = parse_type(type_name);
1460            let ts = rust_to_typescript(&ty, &[]);
1461            assert_eq!(
1462                &ts, type_name,
1463                "Type {} should pass through unchanged",
1464                type_name
1465            );
1466        }
1467
1468        // Renamed types
1469        let renamed = vec![
1470            ("CompositeHunk", "TsCompositeHunk"),
1471            (
1472                "CreateCompositeBufferOptions",
1473                "TsCreateCompositeBufferOptions",
1474            ),
1475            ("Suggestion", "PromptSuggestion"),
1476        ];
1477
1478        for (rust_name, ts_name) in &renamed {
1479            let ty = parse_type(rust_name);
1480            let ts = rust_to_typescript(&ty, &[]);
1481            assert_eq!(
1482                &ts, ts_name,
1483                "Type {} should be renamed to {}",
1484                rust_name, ts_name
1485            );
1486        }
1487    }
1488}