koffi 2.16.2 → 3.0.0-alpha.10

package/CHANGELOG.md

@@ -3,6 +3,46 @@
 > [!NOTE]
 > Consult the [migration guide](migration) to migrate between major Koffi versions.
 
+## Koffi 3
+
+### Koffi 3.0
+
+#### Koffi 3.0.0 (WIP)
+
+*Not yet released*
+
+**Main changes:**
+
+- Replace use of externals with type objects:
+  * Use `koffi.type()` to resolve type specifiers (strings or objects) to type objects
+  * Access type information directly on type objects without `koffi.introspect()`
+- Replace use of externals with BigInt pointers
+- Support ESM and CJS module types
+- Rewrite call preparation and execution for vastly improved performance
+
+**Other changes:**
+
+- Add `koffi.enumeration()` to create [enum types](input#enum-types)
+- Use proper types for various objects and handles:
+  * Use *LibraryHandle* objects for loaded libraries
+  * Use *CallbackHandle* objects for registered callbacks
+  * Use *PollHandle* for socket poll handles
+- Add `Symbol.dispose` on library objects and registered callbacks
+- Prefer types to interfaces in TypeScript declaration file
+- Fix various bugs and small leaks (such as library handles)
+
+**Newly deprecated functions:**
+
+- Deprecate `koffi.resolve()` function, replace with `koffi.type()`
+- Deprecate `koffi.introspect()` function, replace with `koffi.type()`
+
+**Removed deprecated functions:**
+
+- Remove `koffi.callback()` long replaced with `koffi.proto()`
+- Remove `koffi.handle()` long replaced with `koffi.opaque()`
+
+Consult the [migration guide](migration) for more information.
+
 ## Koffi 2
 
 ### Koffi 2.16
@@ -65,7 +105,7 @@
 
 *Released on 2026-04-03*
 
-- Fix *IsOnCentralStack()* assertion/crash when using callbacks in recent Node versions
+- Fix "IsOnCentralStack()" assertion/crash when using callbacks in recent Node versions
 - Support SetUnhandledExceptionFilter on Windows x64 and x86 ([@longhun12346](https://github.com/longhun12346))
 - Fix incorrect stack alignment when relaying callbacks on 32-bit x86 platforms
 
@@ -81,7 +121,7 @@
 
 #### Koffi 2.15.1
 
-*Released on 2025-01-24*
+*Released on 2026-01-24*
 
 - Fix possible union-related crashes
 - Support MinGW-w64 x64 builds on Windows

package/LICENSE.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (C) 2025  Niels Martignène <niels.martignene@protonmail.com>
+Copyright (C) 2026  Niels Martignène <niels.martignene@protonmail.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the “Software”), to deal in

package/README.md

@@ -9,14 +9,14 @@ Koffi is a fast and easy-to-use C FFI module for Node.js, featuring:
 
 The following combinations of OS and architectures __are officially supported and tested__ at the moment:
 
-ISA / OS           | Windows     | Linux (glibc) | Linux (musl) | macOS       | FreeBSD     | OpenBSD
------------------- | ----------- | ------------- | ------------ | ----------- | ----------- | --------
-x86 (IA32) [^1]    | ✅ Yes      | ✅ Yes        | 🟨 Probably  | ⬜️ *N/A*    | ✅ Yes      | ✅ Yes
-x86_64 (AMD64)     | ✅ Yes      | ✅ Yes        | ✅ Yes       | ✅ Yes      | ✅ Yes      | ✅ Yes
-ARM32 LE [^2]      | ⬜️ *N/A*    | ✅ Yes        | 🟨 Probably  | ⬜️ *N/A*    | 🟨 Probably | 🟨 Probably
-ARM64 (AArch64) LE | ✅ Yes      | ✅ Yes        | ✅ Yes       | ✅ Yes      | ✅ Yes      | 🟨 Probably
-RISC-V 64 [^3]     | ⬜️ *N/A*    | ✅ Yes        | 🟨 Probably  | ⬜️ *N/A*    | 🟨 Probably | 🟨 Probably
-LoongArch64        | ⬜️ *N/A*    | ✅ Yes        | 🟨 Probably  | ⬜️ *N/A*    | 🟨 Probably | 🟨 Probably
+ISA / OS           | Windows     | Linux/glibc | Linux/musl  | macOS       | FreeBSD     | OpenBSD
+------------------ | ----------- | ----------- | ----------- | ----------- | ----------- | --------
+x86 (IA32) [^1]    | ✅ Yes      | ✅ Yes      | 🟨 Probably | ⬜️ *N/A*    | ✅ Yes      | ✅ Yes
+x86_64 (AMD64)     | ✅ Yes      | ✅ Yes      | ✅ Yes      | ✅ Yes      | ✅ Yes      | ✅ Yes
+ARM32 LE [^2]      | ⬜️ *N/A*    | ✅ Yes      | 🟨 Probably | ⬜️ *N/A*    | 🟨 Probably | 🟨 Probably
+ARM64 (AArch64) LE | ✅ Yes      | ✅ Yes      | ✅ Yes      | ✅ Yes      | ✅ Yes      | 🟨 Probably
+RISC-V 64 [^3]     | ⬜️ *N/A*    | ✅ Yes      | 🟨 Probably | ⬜️ *N/A*    | 🟨 Probably | 🟨 Probably
+LoongArch64        | ⬜️ *N/A*    | ✅ Yes      | 🟨 Probably | ⬜️ *N/A*    | 🟨 Probably | 🟨 Probably
 
 [^1]: The following call conventions are supported: cdecl, stdcall, MS fastcall, thiscall.
 [^2]: The prebuilt binary uses the hard float ABI and expects a VFP coprocessor. Build from source to use Koffi with a different ABI (softfp, soft).