Merge pull request #884 from napi-rs/ts-args-return-type

feat(napi-derive): support renmae function args and return type

crates/backend/src/ast.rs

@@ -16,6 +16,8 @@ pub struct NapiFn {
   pub parent: Option<Ident>,
   pub strict: bool,
   pub js_mod: Option<String>,
+  pub ts_args_type: Option<String>,
+  pub ts_return_type: Option<String>,
 }
 
 #[derive(Debug, Clone)]

crates/backend/src/typegen.rs

@@ -67,6 +67,7 @@ static KNOWN_TYPES: Lazy<HashMap<&'static str, &'static str>> = Lazy::new(|| {
     ("char", "string"),
     ("JsObject", "object"),
     ("Object", "object"),
+    ("Array", "unknown[]"),
     ("Value", "any"),
     ("Map", "Record<string, any>"),
     ("HashMap", "Record<{}, {}>"),

crates/backend/src/typegen/fn.rs

@@ -11,8 +11,15 @@ impl ToTypeDef for NapiFn {
       r#"{prefix} {name}({args}){ret}"#,
       prefix = self.gen_ts_func_prefix(),
       name = &self.js_name,
-      args = self.gen_ts_func_args(),
-      ret = self.gen_ts_func_ret(),
+      args = self
+        .ts_args_type
+        .clone()
+        .unwrap_or_else(|| self.gen_ts_func_args()),
+      ret = self
+        .ts_return_type
+        .clone()
+        .map(|t| format!(": {}", t))
+        .unwrap_or_else(|| self.gen_ts_func_ret()),
     );
 
     TypeDef {

crates/macro/src/parser/attrs.rs

@@ -53,12 +53,13 @@ macro_rules! attrgen {
       (strict, Strict(Span)),
       (object, Object(Span)),
       (namespace, Namespace(Span, String, Span)),
+      (ts_args_type, TsArgsType(Span, String, Span)),
+      (ts_return_type, TsReturnType(Span, String, Span)),
 
       // impl later
       // (inspectable, Inspectable(Span)),
       // (typescript_custom_section, TypescriptCustomSection(Span)),
       // (skip_typescript, SkipTypescript(Span)),
-      // (typescript_type, TypeScriptType(Span, String, Span)),
       // (getter_with_clone, GetterWithClone(Span)),
 
       // For testing purposes only.

crates/macro/src/parser/mod.rs

@@ -575,6 +575,8 @@ fn napi_fn_from_decl(
       attrs,
       strict: opts.strict().is_some(),
       js_mod: opts.namespace().map(|(m, _)| m.to_owned()),
+      ts_args_type: opts.ts_args_type().map(|(m, _)| m.to_owned()),
+      ts_return_type: opts.ts_return_type().map(|(m, _)| m.to_owned()),
     }
   })
 }
@@ -603,6 +605,12 @@ impl ParseNapi for syn::ItemFn {
 }
 impl ParseNapi for syn::ItemStruct {
   fn parse_napi(&mut self, tokens: &mut TokenStream, opts: BindgenAttrs) -> BindgenResult<Napi> {
+    if opts.ts_args_type().is_some() || opts.ts_return_type().is_some() {
+      bail_span!(
+        self,
+        "#[napi] can't be applied to a struct with #[napi(ts_args_type)] or #[napi(ts_return_type)]"
+      );
+    }
     let napi = self.convert_to_ast(opts);
     self.to_tokens(tokens);
 
@@ -611,6 +619,12 @@ impl ParseNapi for syn::ItemStruct {
 }
 impl ParseNapi for syn::ItemImpl {
   fn parse_napi(&mut self, tokens: &mut TokenStream, opts: BindgenAttrs) -> BindgenResult<Napi> {
+    if opts.ts_args_type().is_some() || opts.ts_return_type().is_some() {
+      bail_span!(
+        self,
+        "#[napi] can't be applied to impl with #[napi(ts_args_type)] or #[napi(ts_return_type)]"
+      );
+    }
     // #[napi] macro will be remove from impl items after converted to ast
     let napi = self.convert_to_ast(opts);
     self.to_tokens(tokens);
@@ -618,18 +632,28 @@ impl ParseNapi for syn::ItemImpl {
     napi
   }
 }
-
 impl ParseNapi for syn::ItemEnum {
   fn parse_napi(&mut self, tokens: &mut TokenStream, opts: BindgenAttrs) -> BindgenResult<Napi> {
+    if opts.ts_args_type().is_some() || opts.ts_return_type().is_some() {
+      bail_span!(
+        self,
+        "#[napi] can't be applied to a enum with #[napi(ts_args_type)] or #[napi(ts_return_type)]"
+      );
+    }
     let napi = self.convert_to_ast(opts);
     self.to_tokens(tokens);
 
     napi
   }
 }
-
 impl ParseNapi for syn::ItemConst {
   fn parse_napi(&mut self, tokens: &mut TokenStream, opts: BindgenAttrs) -> BindgenResult<Napi> {
+    if opts.ts_args_type().is_some() || opts.ts_return_type().is_some() {
+      bail_span!(
+        self,
+        "#[napi] can't be applied to a const with #[napi(ts_args_type)] or #[napi(ts_return_type)]"
+      );
+    }
     let napi = self.convert_to_ast(opts);
     self.to_tokens(tokens);
     napi

examples/napi/__test__/typegen.spec.ts.md

@@ -42,6 +42,7 @@ Generated by [AVA](https://avajs.dev).
     export function createExternalString(content: string): ExternalObject<string>␊
     export function getExternal(external: ExternalObject<number>): number␊
     export function mutateExternal(external: ExternalObject<number>, newVal: number): void␊
+    export function tsRename(a: { foo: number }): string[]␊
     export function xxh64Alias(input: Buffer): BigInt␊
     export function mapOption(val?: number | undefined | null): number | undefined | null␊
     export function add(a: number, b: number): number␊

examples/napi/__test__/values.spec.ts

@@ -55,6 +55,7 @@ import {
   xxh2,
   xxh3,
   xxh64Alias,
+  tsRename,
 } from '../'
 
 test('export const', (t) => {
@@ -194,6 +195,10 @@ test('Result', (t) => {
   t.throws(() => throwError(), null, 'Manual Error')
 })
 
+test('function ts type override', (t) => {
+  t.deepEqual(tsRename({ foo: 1, bar: 2, baz: 2 }), ['foo', 'bar', 'baz'])
+})
+
 test('serde-json', (t) => {
   const packageJson = readPackageJson()
   t.is(packageJson.name, 'napi-rs')

examples/napi/index.d.ts

@@ -32,6 +32,7 @@ export function createExternal(size: number): ExternalObject<number>
 export function createExternalString(content: string): ExternalObject<string>
 export function getExternal(external: ExternalObject<number>): number
 export function mutateExternal(external: ExternalObject<number>, newVal: number): void
+export function tsRename(a: { foo: number }): string[]
 export function xxh64Alias(input: Buffer): BigInt
 export function mapOption(val?: number | undefined | null): number | undefined | null
 export function add(a: number, b: number): number

examples/napi/src/fn_ts_override.rs

@@ -0,0 +1,6 @@
+use napi::bindgen_prelude::{Object, Result};
+
+#[napi(ts_args_type = "a: { foo: number }", ts_return_type = "string[]")]
+fn ts_rename(a: Object) -> Result<Object> {
+  a.get_property_names()
+}

examples/napi/src/lib.rs

@@ -16,6 +16,7 @@ mod either;
 mod r#enum;
 mod error;
 mod external;
+mod fn_ts_override;
 mod js_mod;
 mod nullable;
 mod number;