koffi-cream 2.14.0 → 2.15.0

package/README.md

@@ -1,5 +1,5 @@
 # koffi-cream
-A lighter packaging of Niels Martignène's excellent [Koffi](https://koffi.dev).
+A lighter repackaging of Niels Martignène's excellent [Koffi](https://koffi.dev).
 
 Just `npm install koffi-cream` instead of `koffi` and use it like the real thing:
 
@@ -12,7 +12,10 @@ const some_func = lib.func('int some_func(int a, int b)')
 ```
 
 > [!IMPORTANT]
-> **This package is neither a fork nor a patch. It *is* the original Koffi**, only packaged differently to avoid downloading a megalithic[^1] package bloated with files unnecessary to the average user[^2].
+> **koffi-cream is neither a fork nor a patch. It *is* the original Koffi**, only packaged differently to avoid downloading a megalithic[^1] package bloated with files unnecessary to the average user[^2].
+
+[^1]: As of 2.14.0, Koffi weights 16.9 MB compressed and 86 MB uncompressed.
+[^2]: Koffi's package includes 18 native binaries (of which 17 are not compatible with your platform), the build tools and the full source code.
 
 
 ## The why and the how
@@ -24,17 +27,14 @@ This way, when you install `koffi-cream`, your package manager will only downloa
 - `koffi-cream` (this package): 5.1 kB compressed / 19.8 kB uncompressed
 - `@septh/koffi-win32-x64`: 536.2 kB compressed / 2.4 MB uncompressed
 
-**That's 97.2% off compared to the original Koffi package!**
+**That's 74.2% off compared to the original Koffi package!**
 
 > [!NOTE]
-> The `os` and `cpu` are standard properties, supported by all package managers. But the `libc` property, used to distinguish Linux distros between gnu and musl, is newer and only supported by `npm 10.4.0` and later, `pnpm 7.1.0` and later, and `yarn 3.2.0` and later.
-
-[^1]: As of 2.14.0, Koffi weights 16.9 MB compressed and 86 MB uncompressed.
-[^2]: Koffi's package includes 18 natives binaries (of which 17 are not compatible with your platform), the build tools and the full source code.
+> The `libc` property, used to distinguish Linux distros between gnu and musl, is only supported by `npm 10.4.0` and later, `pnpm 7.1.0` and later, and `yarn 3.2.0` and later.
 
 
 ## Available packages
-`koffi-cream` only offers a subset of Koffi's 18 native builds:
+`koffi-cream` purposely only offers a subset of Koffi's 18 native builds:
 
 | Koffi binary  | koffi-cream package                                                                        |
 |---------------|--------------------------------------------------------------------------------------------|
@@ -57,13 +57,13 @@ This way, when you install `koffi-cream`, your package manager will only downloa
 | win32-ia32    | ❌                                                                                        |
 | win32-x64     | [@septh/koffi-win32-x64](https://www.npmjs.com/package/@septh/koffi-win32-x64)             |
 
-I do not plan to add the missing builds. If you need one of these, you'll have to stick with Koffi.
+I do not plan to add the other builds. If you need one of these, you'll have to stick with Koffi.
 
 
 ## Version numbering
 To make things easy on the user, `koffi-cream`'s version number will always be aligned with Koffi's.
 
-Hence, there is no `koffi-cream` 1.x or 2.0; the first version published is 2.11.0 which ships with Koffi's 2.11.0 binaries.
+Hence, there is no `koffi-cream` 1.x or 2.0; the first version published is 2.11.0 which ships with Koffi 2.11.0 binaries.
 
 
 ## Related

package/index.d.ts

@@ -1,23 +1,5 @@
-// Copyright (C) 2025  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
-// the Software without restriction, including without limitation the rights to use,
-// copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
-// Software, and to permit persons to whom the Software is furnished to do so,
-// subject to the following conditions:
-//
-// The above copyright notice and this permission notice shall be included in all
-// copies or substantial portions of the Software.
-//
-// THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
-// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
-// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
-// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-// OTHER DEALINGS IN THE SOFTWARE.
+// SPDX-License-Identifier: MIT
+// SPDX-FileCopyrightText: 2025 Niels Martignène <niels.martignene@protonmail.com>
 
 type LoadOptions = {
     lazy?: boolean,
@@ -277,7 +259,30 @@ type PrimitiveTypes =
     | 'wchar_t';
 export const types: Record<PrimitiveTypes, IKoffiCType>;
 
-// Internal stuff, don't use!
-export const node: {
-    env: { __brand: 'IKoffiNodeEnv' }
-};
+export interface IKoffiPollOptions {
+    readable?: boolean;
+    writable?: boolean;
+    disconnect?: boolean;
+}
+
+export interface IKoffiPollEvents {
+    readable: boolean;
+    writable: boolean;
+    disconnect: boolean;
+}
+
+export namespace node {
+    export const env: { __brand: 'IKoffiNodeEnv' };
+
+    export class PollHandle {
+        start(opts: IKoffiPollOptions, callback: (ev: IKoffiPollEvents) => void): void;
+        start(callback: (ev: IKoffiPollEvents) => void): void;
+        stop(): void;
+        close(): void;
+        unref(): void;
+        ref(): void;
+    }
+
+    export function poll(fd: number, opts: IKoffiPollOptions, callback: (ev: IKoffiPollEvents) => void): PollHandle;
+    export function poll(fd: number, callback: (ev: IKoffiPollEvents) => void): PollHandle;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "koffi-cream",
-  "version": "2.14.0",
+  "version": "2.15.0",
   "description": "A lighter packaging for Koffi, the fast and simple C FFI (foreign function interface) for Node.js",
   "author": {
     "name": "Stephan 'Septh' Schreiber",
@@ -41,18 +41,18 @@
   "main": "index.js",
   "types": "index.d.ts",
   "optionalDependencies": {
-    "@septh/koffi-darwin-arm64": "2.14.0",
-    "@septh/koffi-darwin-x64": "2.14.0",
-    "@septh/koffi-freebsd-arm64": "2.14.0",
-    "@septh/koffi-freebsd-x64": "2.14.0",
-    "@septh/koffi-linux-arm64-glibc": "2.14.0",
-    "@septh/koffi-linux-loong64": "2.14.0",
-    "@septh/koffi-linux-riscv64": "2.14.0",
-    "@septh/koffi-linux-x64-glibc": "2.14.0",
-    "@septh/koffi-linux-arm64-musl": "2.14.0",
-    "@septh/koffi-linux-x64-musl": "2.14.0",
-    "@septh/koffi-openbsd-x64": "2.14.0",
-    "@septh/koffi-win32-arm64": "2.14.0",
-    "@septh/koffi-win32-x64": "2.14.0"
+    "@septh/koffi-darwin-arm64": "2.15.0",
+    "@septh/koffi-darwin-x64": "2.15.0",
+    "@septh/koffi-freebsd-arm64": "2.15.0",
+    "@septh/koffi-freebsd-x64": "2.15.0",
+    "@septh/koffi-linux-arm64-glibc": "2.15.0",
+    "@septh/koffi-linux-loong64": "2.15.0",
+    "@septh/koffi-linux-riscv64": "2.15.0",
+    "@septh/koffi-linux-x64-glibc": "2.15.0",
+    "@septh/koffi-linux-arm64-musl": "2.15.0",
+    "@septh/koffi-linux-x64-musl": "2.15.0",
+    "@septh/koffi-openbsd-x64": "2.15.0",
+    "@septh/koffi-win32-arm64": "2.15.0",
+    "@septh/koffi-win32-x64": "2.15.0"
   }
 }