From d7dc4dc5a26bc2d5d0b2a7be531175bb9246d3d2 Mon Sep 17 00:00:00 2001
From: LongYinan <lynweklm@gmail.com>
Date: Thu, 15 Feb 2024 15:43:21 +0800
Subject: [PATCH] feat(napi): extends the Map types interoperability (#1950)

---
 crates/napi/Cargo.toml                        |   6 +
 .../napi/src/bindgen_runtime/js_values/map.rs | 103 +++++++++++++++++-
 examples/napi/Cargo.toml                      |   3 +
 .../__snapshots__/typegen.spec.ts.md          |  10 ++
 .../__snapshots__/typegen.spec.ts.snap        | Bin 4294 -> 4352 bytes
 examples/napi/__tests__/values.spec.ts        |  10 ++
 examples/napi/index.d.ts                      |  10 ++
 examples/napi/src/map.rs                      |  35 +++++-
 8 files changed, 175 insertions(+), 2 deletions(-)

diff --git a/crates/napi/Cargo.toml b/crates/napi/Cargo.toml
index d1990c7f..22f864db 100644
--- a/crates/napi/Cargo.toml
+++ b/crates/napi/Cargo.toml
@@ -28,6 +28,7 @@ deferred_trace = ["napi4"]
 error_anyhow = ["anyhow"]
 experimental = ["napi-sys/experimental"]
 full = ["latin1", "napi9", "async", "serde-json", "experimental", "chrono_date"]
+object_indexmap = ["indexmap"]
 latin1 = ["encoding_rs"]
 napi1 = []
 napi2 = ["napi1", "napi-sys/napi2"]
@@ -40,6 +41,7 @@ napi8 = ["napi7", "napi-sys/napi8"]
 napi9 = ["napi8", "napi-sys/napi9"]
 noop = []
 serde-json = ["serde", "serde_json"]
+serde-json-ordered = ["serde-json", "serde_json/preserve_order"]
 tokio_fs = ["tokio/fs"]
 tokio_full = ["tokio/full"]
 tokio_io_std = ["tokio/io-std"]
@@ -93,3 +95,7 @@ version = "1"
 [dependencies.serde_json]
 optional = true
 version = "1"
+
+[dependencies.indexmap]
+optional = true
+version = "2"
diff --git a/crates/napi/src/bindgen_runtime/js_values/map.rs b/crates/napi/src/bindgen_runtime/js_values/map.rs
index 1a7e8c28..4534da0e 100644
--- a/crates/napi/src/bindgen_runtime/js_values/map.rs
+++ b/crates/napi/src/bindgen_runtime/js_values/map.rs
@@ -1,6 +1,9 @@
-use std::collections::HashMap;
+use std::collections::{BTreeMap, HashMap};
 use std::hash::{BuildHasher, Hash};
 
+#[cfg(feature = "object_indexmap")]
+use indexmap::IndexMap;
+
 use crate::bindgen_prelude::{Env, Result, ToNapiValue, *};
 
 impl<K, V, S> TypeName for HashMap<K, V, S> {
@@ -49,3 +52,101 @@ where
     Ok(map)
   }
 }
+
+impl<K, V> TypeName for BTreeMap<K, V> {
+  fn type_name() -> &'static str {
+    "BTreeMap"
+  }
+
+  fn value_type() -> ValueType {
+    ValueType::Object
+  }
+}
+
+impl<K: From<String> + Ord, V: FromNapiValue> ValidateNapiValue for BTreeMap<K, V> {}
+
+impl<K, V> ToNapiValue for BTreeMap<K, V>
+where
+  K: AsRef<str>,
+  V: ToNapiValue,
+{
+  unsafe fn to_napi_value(raw_env: sys::napi_env, val: Self) -> Result<sys::napi_value> {
+    let env = Env::from(raw_env);
+    let mut obj = env.create_object()?;
+    for (k, v) in val.into_iter() {
+      obj.set(k.as_ref(), v)?;
+    }
+
+    unsafe { Object::to_napi_value(raw_env, obj) }
+  }
+}
+
+impl<K, V> FromNapiValue for BTreeMap<K, V>
+where
+  K: From<String> + Ord,
+  V: FromNapiValue,
+{
+  unsafe fn from_napi_value(env: sys::napi_env, napi_val: sys::napi_value) -> Result<Self> {
+    let obj = unsafe { Object::from_napi_value(env, napi_val)? };
+    let mut map = BTreeMap::default();
+    for key in Object::keys(&obj)?.into_iter() {
+      if let Some(val) = obj.get(&key)? {
+        map.insert(K::from(key), val);
+      }
+    }
+
+    Ok(map)
+  }
+}
+
+#[cfg(feature = "object_indexmap")]
+impl<K, V, S> TypeName for IndexMap<K, V, S> {
+  fn type_name() -> &'static str {
+    "IndexMap"
+  }
+
+  fn value_type() -> ValueType {
+    ValueType::Object
+  }
+}
+
+#[cfg(feature = "object_indexmap")]
+impl<K: From<String> + Hash + Eq, V: FromNapiValue> ValidateNapiValue for IndexMap<K, V> {}
+
+#[cfg(feature = "object_indexmap")]
+impl<K, V, S> ToNapiValue for IndexMap<K, V, S>
+where
+  K: AsRef<str>,
+  V: ToNapiValue,
+  S: Default + BuildHasher,
+{
+  unsafe fn to_napi_value(raw_env: sys::napi_env, val: Self) -> Result<sys::napi_value> {
+    let env = Env::from(raw_env);
+    let mut obj = env.create_object()?;
+    for (k, v) in val.into_iter() {
+      obj.set(k.as_ref(), v)?;
+    }
+
+    unsafe { Object::to_napi_value(raw_env, obj) }
+  }
+}
+
+#[cfg(feature = "object_indexmap")]
+impl<K, V, S> FromNapiValue for IndexMap<K, V, S>
+where
+  K: From<String> + Hash + Eq,
+  V: FromNapiValue,
+  S: Default + BuildHasher,
+{
+  unsafe fn from_napi_value(env: sys::napi_env, napi_val: sys::napi_value) -> Result<Self> {
+    let obj = unsafe { Object::from_napi_value(env, napi_val)? };
+    let mut map = IndexMap::default();
+    for key in Object::keys(&obj)?.into_iter() {
+      if let Some(val) = obj.get(&key)? {
+        map.insert(K::from(key), val);
+      }
+    }
+
+    Ok(map)
+  }
+}
diff --git a/examples/napi/Cargo.toml b/examples/napi/Cargo.toml
index 311e49a5..2a359cf4 100644
--- a/examples/napi/Cargo.toml
+++ b/examples/napi/Cargo.toml
@@ -19,6 +19,7 @@ napi-shared = { path = "../napi-shared" }
 serde = "1"
 serde_derive = "1"
 serde_json = "1"
+indexmap = "2"
 
 [target.'cfg(not(target_family = "wasm"))'.dependencies]
 napi = { path = "../../crates/napi", default-features = false, features = [
@@ -27,6 +28,7 @@ napi = { path = "../../crates/napi", default-features = false, features = [
   "experimental",
   "latin1",
   "chrono_date",
+  "object_indexmap",
   "tokio",
   "async",
   "tokio_rt",
@@ -43,6 +45,7 @@ napi = { path = "../../crates/napi", default-features = false, features = [
   "experimental",
   "latin1",
   "chrono_date",
+  "object_indexmap",
   "tokio",
   "async",
   "tokio_rt",
diff --git a/examples/napi/__tests__/__snapshots__/typegen.spec.ts.md b/examples/napi/__tests__/__snapshots__/typegen.spec.ts.md
index 3b6b9133..9c63b059 100644
--- a/examples/napi/__tests__/__snapshots__/typegen.spec.ts.md
+++ b/examples/napi/__tests__/__snapshots__/typegen.spec.ts.md
@@ -392,6 +392,8 @@ Generated by [AVA](https://avajs.dev).
     ␊
     export function fnReceivedAliased(s: AliasedStruct, e: ALIAS): void␊
     ␊
+    export function getBtreeMapping(): BTreeMap␊
+    ␊
     export function getBuffer(): Buffer␊
     ␊
     export function getCwd(callback: (arg0: string) => void): void␊
@@ -402,6 +404,8 @@ Generated by [AVA](https://avajs.dev).
     ␊
     export function getGlobal(): typeof global␊
     ␊
+    export function getIndexMapping(): IndexMap␊
+    ␊
     export function getMapping(): Record<string, number>␊
     ␊
     export function getModuleFileName(): string␊
@@ -425,6 +429,8 @@ Generated by [AVA](https://avajs.dev).
     ␊
     export function getWords(): Array<string>␊
     ␊
+    export function indexmapPassthrough(fixture: IndexMap): IndexMap␊
+    ␊
     /** default enum values are continuos i32s start from 0 */␊
     export const enum Kind {␊
       /** Barks */␊
@@ -544,6 +550,10 @@ Generated by [AVA](https://avajs.dev).
       name: string␊
     }␊
     ␊
+    export function sumBtreeMapping(nums: BTreeMap): number␊
+    ␊
+    export function sumIndexMapping(nums: IndexMap): number␊
+    ␊
     export function sumMapping(nums: Record<string, number>): number␊
     ␊
     export function sumNums(nums: Array<number>): number␊
diff --git a/examples/napi/__tests__/__snapshots__/typegen.spec.ts.snap b/examples/napi/__tests__/__snapshots__/typegen.spec.ts.snap
index 8c15e912cd569664e708c472084f644959354e8b..f74ab62bee9a3cfb0fedb961feef0b9dc9637953 100644
GIT binary patch
literal 4352
zcmV+b5&!N%RzV<BZeeh9Xm4~Nb~6eC0Gw#WTSQvcjoVz|EslfT=*2+(*r8?HY<E{^
zV2`B>uOEvD00000000BETVHS7IFg^c!{GqG?Kj}f;Sf1+{@4kExyIN*yB%kp#CG8B
z?93t??69TkZpLa-LsGVT5(B$W`+Cp!ve^BE`w<RBiV`JJ>UJiZ07;9g`te_}s#sO}
z+iaSO_)`7(@1U7Z;pV^9LgZ;e=D<Nx4I~y)Lad2iWk3>`kr_*YDNZxB5L*5DZ%INm
z{r%`K|Mty)e1m`f<=?;g&A;A^9^EH2*W!T#O2~9Y&W3MK9$bvc{YP7m?h{Zc<N86u
z6rHAkjayrAlL@IwoKmI8iyIA+)AW4$5n}!Q<bZtIB18gB1W#Aw-o1foXf)-V{hR|)
ztL0Rr=Jos6gW~bSfK0Xsx!t<mdUXH(7P(J;iUn6%=CKy?Cn7S<1Sc~g$xpWRCnDkJ
zoJmlGrYV^*NE1c0AX6Y&K22G?gD^rbKwdKiMAJE8%Pb``PN*UtJktHwdrmVJd9B+Y
zws7jTi4Qqj($q}u(f#}6HRA~pGeT|i{YU;PTr!>v3`s#fSujPIB6<OS@0QJLh$_w<
z!s!wQL}|(Re7gZe$&4byiY!4dL}HPYrkcg%n&|~Xcxc;$Vgg%)%t0IMXxpJ9t7~lb
ziqt4*NL|cGxh4<ajt{ri8>D?)=BZ{6QpR!a%O!Aa+i{qLaso^7k&%D=_5c24+HoS+
z3qhBxHb8&&cAgI(KCDf94*E#U&BV9;)wjL<79<cVfhe&A5-+Hvu?DFK<w^BO6#Se6
zk3m^3y`Y*D=WhxGR7^8S+zCuq155UY_a8ppKKjGp+iySFhTC!~5_B&4Im+S)1qsJ?
zB<6uPKQO%*<w}d?$dice0Xbw6ry{OEN|wM0PuLYpa+(h1{G6W}0f@MeOPWqrZpn5W
zeF7X?KXLcw)<NEGg+v^OaRf7(r`j8b5qw`Zwn!o7JYP;hHssi++^G?62f7vI8XODx
zg5i_t&qwU$Q);YNDU25Y+OVO>$~*<L)+41Z@)X`MrMGS!fYF?ee?0d1_k*y_o|P)P
zs*liijoSDv)eG#sSe$ytuapJYw?H9q)rB6hY9$9H(r3c+G!1v7TtBMO5z0VlTf6qL
z7{N&7Tzhjfjc0TTL$%^DzIZFek}3G!vK`>Y;prVO#U<l&qCsh+&dn$bV}vTcsd5if
zdI@`nzop6vgs<RW6<xw=P*6=@!)kj_XW1eo&l0L3LVGwMhxu$~mhDQgq_J29O3~MT
z11LDI*RUd=w!%30Zr>wpAdIMv7w5crzWU|8&9t`(ms2grg~15yxVNllEgLXsLDV^(
zhFF{kG+7S<yceMIRNo1~3S5&#FPLi2UvLdK_OvePY6@on$@2l33XuZkTZBxFSPaNJ
z#`SkYDd{S3^t?eIQB4bps+P$1QYW<X7ESY+4_>3T*4s05t>IVd%jvcYr`il$dCIKv
z$*2UbE6rt8ps(SA4nSCejK<@#@BNx0ZH=*^fxAtC(aVjYZ};hJLTErCo9TxXb!!GS
z-QK6vt?4~xoTls-XiejqC3@kM-VRv+n=f>?Q9BazyXn>@z%iQ|fcInLB|l^u)ufOg
zaOx+;!}o4DsL^(c!5pmB3CC=@_bb2)5sxLHZdCxjNkZ&UhfnN^<`U)8GaejnbcYks
zAl|9bZhztMn?rjET7w*$e~ky03YFv4V!dj8rS9yryiymi6dFp|=sEgGn~4@^!lZAJ
zrNN7gGhne>Kxd49q?26g6neBjQzu+$%40a6MOQS<0q<>>TwL>QUtOXpADOKuE0IgW
z5uIoQ|DWU^fBoOT*SvBL*B3N1&X6|_d*V;2x*Unrdb#Cz3U{K`W_@M!|0C4$R@Zl_
z{4=3{kWAwZ)@;ySotzHyQg{vZzRu0<w73`+Q?@tO7d(lIdurl2<puq7Pxa<Jff?hF
z6l!?8y*ZX`tf|zIgXlrnA<drqF>$O8cK1%W)r|JOXiDciT}5|Wl;#$UA%)U~5;6gK
zxM~|mWvBw}Mhd*)T`xew^A1r7!|#OAcN*Y34eYjh_yLWKnMZK|gL<*{&Ie&!gPhSA
z$k2eygz&B)j%t?k*!bHtjv>>N1;#BDoxySOB0`D*i9pH$c_F2c<@QrKFFPjt2ZZvK
zI~g0pA5%?J*T>fYoa9*wLpfLd1Akl@5-R7rrA{-Cd*!CA9YvBvw1S#?wy#*~a!+y3
z2=IJKhHp-WW3wkivQHlGY!Pxu_Q`H|^HN3?BxAGRhKUX=0(z@~9ramLr;%)guGD?L
zMAJDw_6SCn0Z)AQwY)mnA3>IM^*D<4jf*txkeH_Fl*X3>5<PtQkjl9l;L5)LuzrmZ
zZTF67jfhz%HXczsjki>($wG>Jz6f~f?gmmd9t6<v(reKs!Vp=cVbx3NsXG@W404KL
zvdOim9f@ib{mgIET<t!79AzzrjUg@|$zup^`epzVsxF=IT^M^EwRns3*az`D!ICyR
z?&U#1;17*}PpRya=P8>ru7~#E+6QxR?ayuZql@uaisi}f-gnVvl+T{7CwvL|-Lt1d
zH8!#uO_?{C;+VEM!!q02CEE~MtWmL8zw|8@p0mf%CTF*y?rI3T>k;bKq#tf?L%7|V
zj^Eo59dWJ5xiy>|M2_NwXSp7b$n-NIpGieiQ%V7&BTZyuKqiJ4MR<GAfY@+AL!OK?
zdd;Jc>bNwVk83uo5p@g1;euV2Mn9gqNp7@ejt}olLpitXAuH<{cke|P*_}Ea@?@lM
z8fIeZyb5n^iYwqI<^j8TBltYv7Ja!rL(Z=ZnCV=C5w{aQDsZBBy6ZO4PC1_LmD^&7
zeM#(qUP!^k5!EnElHF6ra}5!*hX7l*?SFlY6LHGYl&J<==gu0&GpgAY7<RTaAzSz&
z&dPRRi;HZvSp|=&enU0myOC;NlR6m2THb;Bou2JJ+mv2Y##N+5E@LlXrm38R_7L1n
zJOptCQonn$XZ?_3@zH%Ln$~+FHl}mP<|j7B-(|&ox-|yRlDfQcq}VUuo%TjPdCkBa
zbzwGf(M*7-T$~16x8|$CO;#BscG0$L3)aPWKK+Q4!t~NZ1hKX;B@7c`ni{!myLmJ(
zT-c=t2SMISk%81^h@ag3&~r0)Obm5y0$EjhhJ-A<fxUnkNKAE}^MDN~R7C#_ZTQUu
zYHVh|m+lyYSD<45G!$$YQ~JHgNo*6X66mGLl`9RINzh`th;j@jnUlhJE^=iT;h~>5
zs%~61oO_lpU*Hq^J?9+o%7u5Y$+aN+WY7FuNWk_d_;8E?t$p$oe~;M>*(cBN=L?MW
zl6~?WKAbUw^FM|eI6^)S`cY;8V@-9gMj|osteVEH{4!Kj%0-Z5p)j`y0gjmp^APAD
zF`D+wY;%XEt(Oeg)oHHQ(Tn5ZyEl_Rj?TxEZcUqjgjsbHLPxrKGS0Ml9Hn&W&Qg!w
z1`{uR;zsQyA&N^vq2$&=JY5SxKI4H~3v?(%dM?X@P@q;AQJ018w4)XmZv^(hm)3Ad
zK9fW8nT&eOfyZoaR5rfb2se8{vMvOxD9>eGN*asR8@YI~%yg0GZ1=(Q<wTr3*^6LM
zKX5(kJ!4bBX&keNZ{YRK_yxqkt{^F*B4|x(0g@d8MRcTdE9RgNwFEe&S%!84;}{eB
z945Ax;GS>?=E1KM-+^oS<GoJS9JE>3je06=Clo)r%x2Fz&OyIS#grOtjkz%~BXiRb
zq&?vY+<437o`b|5-37!#Cf_^frPG`vmq_vyj#&zgXn%<K43viCEME?#XWZU@z`tRJ
zJWVZO$oVq_O)RS}Ut-0CsS&d6%2SvPelH2zH_^8=zNB+_r35!K&8p`C@m}_?z*u{_
zq-9HdN?mH5s9zx7IqlI4_k)m0Al=*|Whf#`nqh!K7XgYHyTNNpB|kM$!sSkErIFP&
z#-1xvrRA)=BJ9bYvUZWoq*#*2VS8^1@?3S^A(fZPrlBwqTSQ!K-Cmk1GG#I;-jAqu
zUV*WeROwa0na7vtC4@9z%9K8zetZop6^ZFb=P0dTr6tV@jeceF9i_Pn<U491vj9}C
zeaCv8a=`TI_3!X~sdU48ZgD-IxUd?>si59XqQjRtpMJCnjFy=R2CTcBVH>GpGHKPS
zHF+_Eg!2B%rEK$Bez`wF6G%UVw!6ycb!dDW#pumnt+feWLafot*TA*8!;awxQ++lr
zv#CXEWD~!%BOAB-l@ksZN|w$Y7y7)cjjTGJxw}tky?i=9me{4H*K};If>RSLt5!#g
zYi|s-OikD1gX8mt=PqqE@1J`I2X9k_6?*tl)hh2QBF{2~66h8j$Q4Ls<~}nwwgT2_
z(BhrPl>lazfX58f^On0nxhd~T;Ob~SUEr8zl(V?om}P0M&N&nn1SZ$oV<0mdJw4&p
z+jd&8RLb3Xmg3fMV0QqE%gH`o*^8CJizk@@)uzm3pS=H8flS~5?!>nr$Zg2sz|bMO
zO6_yy^jRq>UqcnS?rceCMzQj#Rhie!Gt{^}=`m@X>M=xbJp5Mf5-scVK_I6Yw3b~n
zG1$hol-D48H}dwfd9~^hivsY7%}n@2+oEoV7`USa%bVACaGL9{KIo>ww64piy3Jgd
z)Tj}cqC{@jZ9y;`W>r;pOw5(4cY)&lHr9o>DDPoF{8#J7R>TuG3Dim#HXEuc?A|<-
z|C|hnErJTEqwTh{)yr*#wh7TGSzTZ#MdJmPkc{wqB0T8!v5VoADvj`VXVRmKx&KOM
zX*RghGzd>-C;W=0ENR4i`XcRJ5QS!RNKJbXG!ZRqk@G}LmTj78kU1a6l4Uwl=0A_6
zDBo-ID9|=0d&2RWXv45B9NP~2R!)K4-av(tSIJb}$!ze`P`{N-X&X7c=YHSAOV=Ag
z6BOKia<BMlnlFGRSVDi#{J0nN|NRr*c2NTUfy$S)I1ta5stN`5oII5;YY`F4=v``i
z80$RY07*ZB2{l;uTC|~u3%{`#qgQdr=GK0^l@K#!++XwTiAnIxl?WG3Ad8xJo0bgo
zv{IZ!HSNfzD_woo9h04HSW`lFia~XgvG{s;#?*Z!P^{9p{#AhD+Bjeqqq7*M&QTKg
zppI8u(;G_(_-}OqiAB<X0qF!5uhg2fm{v1xCWMA_tt_mYteTm;w{a+(A^t-7QW$0S
zsx9tZ0J*k6s?`N%szt8<IXxN4D_lH${>mL(fT>)k=sJ2Orp5)dg5w2cD|J0l7*iT8
zD4!Q51mn=f4HinVsW+cjrNPDffL=Go7Yi0_Y6_>isiJhOhbDVn`T*++!%8-5$0N3p
z-%xTDMRs2C*1GW>na|kP7DV{uwv1w9mMW0=1?dF`@+H+oju*eRJEfW1gF9PFhhzLi
zHgM`{?QXc-*ajZBV{uYx$J%?@-XVr&@425%3~1H0!*sgo%St>Q${lVxC5z4SE6+b%
zJJ@#gxK>)bZhb2^o(-zS>gyQ4w;N7{#BY|h6ln@FSf#x~6q}nUxuG7LhfNj`I}o|v
zq>oMDZf+LOo|-(STcA=EG;|K?T9u&!y}4P~&$a?!dsqRyrY=3m_~gg6Be@Na<w==t
z`4J!N7Yruu=WYU~<wr-^{;1M&+i!F&XZgi$b124g<NJioLHV^w#C&XDyL=4aoV+|c
ueQ`GNrj9+`+$?tYzN@D157u83to7|!i|`u$@!8X!#ruC&ZawAFLjVAyJa=&b

literal 4294
zcmV;%5IOHbRzV<BZeeh9Xm4~Nb~6eC0G$VY!CuO*g|rd8RiEMOB*O9!n<VyIT<N*=
zN#CF*oga$`00000000BETkmcgIg+2-!{PvcyEov?;gFW$IJOf6v%)xmEZbQp@gG>q
z&MdOQ4%J<fXtziW$+oRY4BWoKe!ee@-6z~fI274zvAfwV*^^CxM9r@H@n5m3SXKS^
z@hBDXwff6HKr@}f-T$bm$kK#NfP<tONGzm;SQEXN14&>^#w-P<IGwAh(CROLPZFx>
z9}gD){>^`UgMa?*x8MBdZ>|oWZ4#Pk@zen&WV9e>y^E8lmjkl-Y~$G`0hKbYpC(Mv
zQ3}|&u>p5;AvK9psuVf8(;zub&qr4f>+grJ$mb10B+x|gbU~gx>6(U0Q^wiP84$IY
zjYMi*e|*=?A3t@;aD$Nhjr)yfo0}VCll&A5uC&ZzE#yx`%rz67jD;jW+18(kgr74e
zK@pm!WXvE<6w!i=fXuT|%Hl1A5qb*pmMI{bP6(ULQ!?g+D&oN--G6`Nbj~8Lwex8M
zr(T+PkFyy~&E%eKZjyJ5Cq#@1wauH){8hMSJn0&eoO(EAiZDg=6#U*To7WI6IkyO>
zGw2efCF7G$1&ER{MTP~Lfu4%QA}LKZi^(n1Q-tu)I^BE%8-z?i8|<j#(2><OR(nNi
z6f~sHXQW({hi}J+Tk8$dKF+dKv!^NJIQQ8MxVG&$OhP$<nYd!)pMU$m|26G6k=v=D
zGgca)KYKgR?d|Q-v?rhs#l%d!<FCH$?e`#oPzgkd8IX8NC5<&mMJP{}k3_-G8SogC
z<<e8CNq+uDKtRQG4v9N~>7r}N{`B$F=lf@W>VEs}XWMXJOhtmuBtJ)4?4uyz*bc=c
z@a6}mr~OQ6G3$F0(dm){CUGj_2Bc&OobZI*uq2~tPfpJHsS$vP3pu0daN(A0%h4ym
zvGp@|Z|)uB{YFT{aTtd%rdg`JaTvk(Wn+WnV$QSK2xLW$eafv8VJFb7DAwRu$RmbN
zravFCnNO*KUZgOX0%*gAA}g~L%v$%Ay3A5|&y?P{cK}9nI{v}H<KGX$R(n<|@2WgP
z+cj$A3#zBsd%ig3j^8Q^uy27v;Hn8dV#}567D!(R&(bv9jdJ~{N=GOIp>1v2$9x2R
zk#X(K%`~3T8T8bG$N1txiWyVzy=8la8;7TNFca5|PlyJkjXF1@%#9JM_^Qf1Na;1~
z9sHguClJ1ZgGF==i*8OedIyV6x6HCZNH$NXh6wFpmmFl{v01ho!IH{i<tTYy`xT(z
zxZc5neBKD-;JbZ~u!7L1I-Z{M>iKGy_d3(wI$Tb*9Oniju;bpcp4DtXw+2z>coAZ8
zB2Z<072v%Dm8JSY2v*>#EPBdReg1-LxU;8qMi(PE14v$X$w-J4DBmDtWW=INJ}|Do
z>q$u$furXQ`jBdxOVo0SY%gU(D{s*#8~flTYHPhcLsuLAQhhnycIi}`fh$g#RX%en
zf$OE_GAhv5a6tzktU&sMLDBbqNs-pZSkb`Eroias%FsJ)I-3w0P{?NbAw^xAK}ol_
zDRpalj~S;a`vq##xMhi+I;FQorobjs-E7nj#pGeSwF+>|Mh4*Hz<9~qOrx3<@)J(|
zB!Bqc4F@&aRz8?lD|Ny#8}0oH@La@W38-5YfNzozJJjKGyP}yy`SgqjhdbTiL{x~k
zO0=Cv4!=6IH=s4hf%(^XV5v|UUM*Iu*0<`xKFeEm2{WOgkd2n3kF;}915KFpEwVIt
zk#Pnrb`9u^@hdvaq)wql`!jXIm8Lv~^Ko=T(+u$5cFn~t@A&ExO?lsJJz0oM5{~FZ
z8~Fbs|NPru|55VFIow{-xp9WPao7`oO4W5=q}IzV#*@1fr8es;qyHbFmbbdTN#&mj
z{exs0Z?I;A9_r*Yn3vpZDED=4Zm0RhFrTu$u^#ax%I~R(=alF4uRYb9@dU<<Lz1iE
zPJMGM+dxyPBL~rfutlmpw`1a19qjIdaF;XMd(@Q9dAf)mwkXvt7(fbz3ngR%@?cRn
zj>=F4+Km)=!@He=gx3wC5{BOjqi<Efw<_3m_3#5488eUk00#A9>75V4xCS|<F_4}C
z84KZEK^)aM<FWC#X&l2`52qNnP;?B(`HKiCx+DTAyW~hpA&c#&a#D0m_Foao7w%-N
z4S!5EO<f;f18|tlQ|QTwY9IK{(vVO&*)4RMdE6^DW#uT6B%({Gk!Snzr7rdq_ly9~
zW~BH2q&F~o(j)t1XKRCy1F}zc!<&~fsvsGd{WeUrYZ1^}4eY4TnmUbSBXouC^Cg;2
z@UcZO=5yeQ@4gmSC;KDFk}h_lSl_uw(-w(onvQ6E-6hfX_BNFh)y0+l_-XYTBiil*
z(JB$MMr=Hyb{ZE{so_+LY%&da>Fx%yY<v|!!%MG48wx{Yk$THs3Qyg+AYqVG43iCS
zMd?T^N72rFk!EUlXD6E17}kckgd~e0xasQw45_+y!gp!xbyVZc&tn_J9|TM4?6{Y&
z0s?<v1bjqgn>>%$gmK-o2iHEBgKK|w+>a*4V<~1QyL;b7>ruXZv6}D==npSn^whw}
zYBXZrVDe*H=M2kiZI^6AXtDbFV*S##Sa{BMqIJ%0MctJUc2^^mtw}rF-kNZ`B^|%F
zCOYC;k#lP}d=)v06F$#$mqezYA^Ad<G$o}JFgnsiHo9bJcu|Bq-3r8-1M2Z)FsHXX
zx>Co5;oK?NtV+}^5QhtPRT%wv<R-b+nmInaGxg-evWKj!XWYFPO=J)1w8xXazN?st
zk@G6NwaKr5>zD`Z=DpyPfLru<dxo4}8E~#M2}aybct6L9;?b_#L_6hpv{!74A@(J)
z0eUJ07l%|sFG+S!8P7CC%pL-4?b!d?7>DANr72Stw#J<`jAvA{8!+r_W<s{`D9)wr
zz!n$Ts<R3nQ~jQ5#&;uCza}*>477Xz^#?uPeYq~Zri`mdiA=^`z)Vv)0qr5Un|KJ~
z2BiM*e9!tJ`QoGdk~gjPL~KmwfK5(pjK9f>`E)A`o+Wj8<4Cbzz&q`geDaEcIqKYO
z;-Z-VQL#7`xMs~)f*UU8kl01*loqUs@qBcJl*07VLIkn4F(nKWVVWAbY`b|hFI?EA
z1qVScq?m)$W{98N{m^qWw@eImVggyq^b84EcmsP0W008YJm&!$kgJIH8QSoh3Dnrk
zek<KE2CqQH{%OeBFsAfJk&)OYS|!kHlPgym<|aXl=_1N8m}E{0<C(~mU4(5vZ?wE|
z*>LVzHao&6^n1=Z;FSySUc*~K_Q{_4IhBCz&+*|H16up!1^yneJF-t+;?E<D^^$$^
z9X^~fgY!GX3>+bMf_{`4z(7--slG@|JgcN}mwp*4D&-<bGFO-zgaF4(g?R{ckQhyS
zX12LO)0RsH?CMlk>+tBf_u>8U&;9ekuvyb4AYr_`385psd@|0odF-cj=FU=!-Ubsd
zeeOo>B_Z-lLayXiLcCZBLB8ODTM2X^M0zfZgOH;xF`_05-DpQGF5U?2fiJ9Kk9;8q
z<O}Jym;;a5+^B4Pw-Rplf@DnyR#BeIvXoR7t2J_QG@I)@&spz-XS1O=dA=7xw|wAQ
z)_crGg3~x=5nsdW8}mzuf!#ooM@7(@mI5SO1oG%e<5o;S=l9x{2nMFMZxi1qtGU>%
ze$xcBS*x{rD$F6|KbkCI%hF6hze&Z28U>8$E-@w((-5RRrSmx&%}$qGLM&wRy>l@d
zjV^MDBun9#rBI2<hltNWX-LkpSx<T<=;J5+8)nGT)DnhVG(%9uvP$g@)-{+)9^0-w
zwN~NxQl)JZy`b?moxocqxS8pE`P?Pm%k~u*Xz#?=G`>%%3*8X4@9_tB##`Zj5HblQ
zh0S6mwwlMDXJa#!sf2QtR1x-kPg&bT#!}44PS~cJqBmCocR=N}vZ)?ScIHt{TN{_A
zij0^{^7nnJo#izai7LIwIkWg0EpbS@q)h4a(bYRxs7Q>ioHJ6NW0i46=egFrF*$|8
zBm{B_rLa^0D$~C6y6UuIit_dk_`XnV;T^NMp5K{k=HpaQ&s%Ts7tTjlHc3!Z<-wqE
zlf!AFK};sKdax=lW@%7b-@3GDR?6YFM?nH1{?K+Wvt|t{*hUIkb3`kZw3l?M^zt=u
zZGNs{_`!6VjeV?ZVk#NC$9806W5063;bO$Xf#O1+7xjnBj>qnPQP>`z&X3nMDcKbr
zo9oud1f-U$qs6T^hEg`9Y4XAGdBbxTqmqZsy@P`{mfVJHU#U`c+mgt$E1@K{1qX5i
zQkl7r&8;YhwHh>k=W!)~*&E<71NFLQ>?t=TR0-T1uBHnd(>diVZZ<{pG*jms@+`f{
zXSSHPxs6bsaO=@JEm$b!=3GYZndcS`3%JQXUW@aU!pj{Q1J$OKW1oEdR)I|5DelC#
zpU8d4UBK`hIy&`p<@8x0DPKbsx$bP)<eXx4QLXx|8p|(nd(vZ4CCkSUz44-J`9ZX-
zue*V~VbEGO&BS0E+frOL?ES;r%j)%|MJ#f_LpC-c3T+Fg9b(`f6f7ZL-N9+5zxtr7
z2GhDOpUXCLRpOvTT!<36U$q6nkdswa&2cAJ4&DTccgR@h;-b8VF7aQj8e1N-TPGMQ
zU1+MOmZ9zHq5Rim8Em0ZNF8<R&Q>e871}C9qhvLKp%e|KR6^3nZ+7sY+s7t`x2iD0
zoyNpM6Lb58%+joJA*m3aj8FItO<7WjtF%S4n;>${=#Z-RAZQ|L*dpVJmTbOmG+$<X
z5KA`Kkuv{zEP07sokxMTanBQumpmKlbRo}rXm#ln*zFBe0eRIz%R8A3FdFI$$&|Ly
z$tUjj6TEc27c@b^-6v1-pQiZ|Xo6+xPt1=eLI2-B;dK`!;2)@L<{}L|o2jN?L(36V
z+00zqEqm$a-ok}n6%5eEAFzql<`)uTri?Rcp1n;Ao`3@3(uqf2<!uvjVV+u2FRvf%
z+XS7fNP1v;uMTU9rcN=8Y-03Z56>8$uLO#93AeurP}~}K$YL~>f0Q{2;uh4wf@^wb
zDFOdoUI${4v|k4rfyG<3A`zt3n41Zq8Cxj}t0t?)Cev%oyEBWAlrM#GRj<C_!6kny
zOM+@$U~X1q`d`zNk-XgD!soBt!6lelZHkVZS5#>nGAlS<fODxlhYBM+{VC;>T%lu_
zHos3oAvWda^JOt?{yv~(jVZ(wy-mj8RM%CMj`hIgYYU6KsuZeVvsN`?YgzGvD=#ba
z%9U1)@6dd>wXy`jC%1(IYqKoFdXI>{JCMiJ&p2NEy6lwB-5xyHQaT*twXv>KS1WhJ
zWrNo6haHQPN;}rptM3*uG<&c8{8>P&t{kS*O^+*TbSMwFcN8o(udO_9ZRKF=vD{KI
z>8kZzI@PSZT&%W^@e8xwNJ#ujS4)wmAcJ+uTST#miCG)!fq7VG0kH#->2>;82k!1}
z`tpUz+_?oRR6#}OpsrPORG@cvQ~RM(0BjFyURP9N2N|FLxN;=-;jug~k{>_fgRR*&
zQ8?$9o0cCPW&JZk%Wc0(wVcH_s@0(w%Z=|7HUZ^V;}G+CdFd+9dw=rg?DXht=uI7a
oy1Se1?tQnMzCT!hO|ZJPVJ*UI_~(}|S{CpB0dUvl)x<&o0QSRk$p8QV

diff --git a/examples/napi/__tests__/values.spec.ts b/examples/napi/__tests__/values.spec.ts
index 4de2771b..7807e55c 100644
--- a/examples/napi/__tests__/values.spec.ts
+++ b/examples/napi/__tests__/values.spec.ts
@@ -34,6 +34,11 @@ const {
   sumNums,
   getMapping,
   sumMapping,
+  getBtreeMapping,
+  sumBtreeMapping,
+  getIndexMapping,
+  sumIndexMapping,
+  indexmapPassthrough,
   getCwd,
   Animal,
   Kind,
@@ -202,6 +207,11 @@ test('array', (t) => {
 test('map', (t) => {
   t.deepEqual(getMapping(), { a: 101, b: 102 })
   t.is(sumMapping({ a: 101, b: 102 }), 203)
+  t.deepEqual(getBtreeMapping(), { a: 101, b: 102 })
+  t.is(sumBtreeMapping({ a: 101, b: 102 }), 203)
+  t.deepEqual(getIndexMapping(), { a: 101, b: 102 })
+  t.is(sumIndexMapping({ a: 101, b: 102 }), 203)
+  t.deepEqual(indexmapPassthrough({ a: 101, b: 102 }), { a: 101, b: 102 })
 })
 
 test('enum', (t) => {
diff --git a/examples/napi/index.d.ts b/examples/napi/index.d.ts
index 72b926a1..8dd4e2f9 100644
--- a/examples/napi/index.d.ts
+++ b/examples/napi/index.d.ts
@@ -382,6 +382,8 @@ export function fibonacci(n: number): number
 
 export function fnReceivedAliased(s: AliasedStruct, e: ALIAS): void
 
+export function getBtreeMapping(): BTreeMap
+
 export function getBuffer(): Buffer
 
 export function getCwd(callback: (arg0: string) => void): void
@@ -392,6 +394,8 @@ export function getExternal(external: ExternalObject<number>): number
 
 export function getGlobal(): typeof global
 
+export function getIndexMapping(): IndexMap
+
 export function getMapping(): Record<string, number>
 
 export function getModuleFileName(): string
@@ -415,6 +419,8 @@ export function getUndefined(): void
 
 export function getWords(): Array<string>
 
+export function indexmapPassthrough(fixture: IndexMap): IndexMap
+
 /** default enum values are continuos i32s start from 0 */
 export const enum Kind {
   /** Barks */
@@ -534,6 +540,10 @@ export interface StrictObject {
   name: string
 }
 
+export function sumBtreeMapping(nums: BTreeMap): number
+
+export function sumIndexMapping(nums: IndexMap): number
+
 export function sumMapping(nums: Record<string, number>): number
 
 export function sumNums(nums: Array<number>): number
diff --git a/examples/napi/src/map.rs b/examples/napi/src/map.rs
index c4d0bd43..d2f659be 100644
--- a/examples/napi/src/map.rs
+++ b/examples/napi/src/map.rs
@@ -1,4 +1,6 @@
-use std::collections::HashMap;
+use std::collections::{BTreeMap, HashMap};
+
+use indexmap::IndexMap;
 
 #[napi]
 fn get_mapping() -> HashMap<String, u32> {
@@ -12,3 +14,34 @@ fn get_mapping() -> HashMap<String, u32> {
 fn sum_mapping(nums: HashMap<String, u32>) -> u32 {
   nums.into_values().sum()
 }
+
+#[napi]
+fn get_btree_mapping() -> BTreeMap<String, u32> {
+  let mut map = BTreeMap::new();
+  map.insert("a".to_string(), 101);
+  map.insert("b".to_string(), 102);
+  map
+}
+
+#[napi]
+fn sum_btree_mapping(nums: BTreeMap<String, u32>) -> u32 {
+  nums.into_values().sum()
+}
+
+#[napi]
+fn get_index_mapping() -> IndexMap<String, u32> {
+  let mut map = IndexMap::new();
+  map.insert("a".to_string(), 101);
+  map.insert("b".to_string(), 102);
+  map
+}
+
+#[napi]
+fn sum_index_mapping(nums: IndexMap<String, u32>) -> u32 {
+  nums.into_values().sum()
+}
+
+#[napi]
+fn indexmap_passthrough(fixture: IndexMap<String, u32>) -> IndexMap<String, u32> {
+  fixture
+}