@trkyshorty/node-lzf 1.1.0 → 1.3.0

package/README.md

@@ -25,8 +25,12 @@ from source via `node-gyp-build` (requires a C++ toolchain).
 
 Prebuilds are produced by the `prebuild` GitHub Actions workflow
 (`npm run prebuild` runs `prebuildify --napi --strip` for the current
-platform). Before `npm publish`, download the merged `prebuilds` artifact
-from the workflow run and place it in the package root as `prebuilds/`.
+platform). Releases are fully automatic: bump `version` in `package.json`
+and push to `master`. If that version is not on npm yet, the workflow builds
+and tests every platform, publishes the package with the merged `prebuilds/`
+via npm trusted publishing (with provenance) and tags the commit
+`v<version>`. Pushes that keep the version publish nothing; a manual run
+always builds and tests.
 
 ### Usage
 
@@ -44,6 +48,30 @@ const compressed2 = await lzf.compressAsync(data);
 const restored2 = await lzf.decompressAsync(compressed2, data.length);
 ```
 
+#### TypeScript
+
+Type definitions are bundled, no `@types` package is needed. The module is
+CommonJS (`export =`), so import it as a namespace — or as a default import
+when `esModuleInterop` is enabled:
+
+```typescript
+import * as lzf from '@trkyshorty/node-lzf';
+// with "esModuleInterop": true you can also write:
+// import lzf from '@trkyshorty/node-lzf';
+
+const data: Buffer = Buffer.from('some data to compress');
+
+// sync
+const compressed: Buffer = lzf.compress(data);
+const restored: Buffer = lzf.decompress(compressed, data.length);
+
+// async
+async function roundtrip(input: Buffer): Promise<Buffer> {
+    const packed = await lzf.compressAsync(input);
+    return lzf.decompressAsync(packed, input.length);
+}
+```
+
 ### API
 
 TypeScript definitions are bundled (`index.d.ts`).

package/binding.gyp

@@ -12,11 +12,16 @@
         "src/lzf"
       ],
       "defines": [ "NAPI_DISABLE_CPP_EXCEPTIONS" ],
+      # -Wno-implicit-fallthrough: upstream liblzf (src/lzf/lzf_d.cc) deliberately unrolls its
+      # copy loops with "case" fallthrough (Duff's device); the warning gcc enables with -Wextra
+      # is not a bug here. The vendored code and our own code (src/lzf.cc) build as a single
+      # target, so the suppression is target-wide; we do not rewrite the algorithm. MSVC does
+      # not emit this warning, so no flag is added on Windows.
       "conditions": [
         [
           'OS=="linux" or OS=="freebsd" or OS=="openbsd" or OS=="solaris"',
           {
-            "cflags": [ "-O3" ],
+            "cflags": [ "-O3", "-Wno-implicit-fallthrough" ],
             "cflags_cc": [ "-O3" ],
             "conditions": [
               ["target_arch=='x64'", { "cflags": [ "-fPIC" ] }]
@@ -27,7 +32,7 @@
           "OS=='mac'",
           {
             "xcode_settings": {
-              "OTHER_CFLAGS": [ "-O3" ]
+              "OTHER_CFLAGS": [ "-O3", "-Wno-implicit-fallthrough" ]
             }
           }
         ],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trkyshorty/node-lzf",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "description": "lzf compression module for nodejs (Topface/node-lzf fork)",
   "keywords": [
     "lzf",

package/src/lzf/lzfP.h

@@ -78,8 +78,17 @@
 /*
  * Unconditionally aligning does not cost very much, so do it if unsure
  */
+/*
+ * node-lzf: upstream used `# define STRICT_ALIGN !(defined(__i386) || defined (__amd64))`;
+ * a `defined` operator produced by macro expansion is undefined behavior in the standard
+ * (gcc/clang -Wexpansion-to-defined). We select the same value directly with #if.
+ */
 #ifndef STRICT_ALIGN
-# define STRICT_ALIGN !(defined(__i386) || defined (__amd64))
+# if defined(__i386) || defined (__amd64)
+#  define STRICT_ALIGN 0
+# else
+#  define STRICT_ALIGN 1
+# endif
 #endif
 
 /*
@@ -142,7 +151,12 @@ using namespace std;
 
 #ifndef LZF_USE_OFFSETS
 # if defined (WIN32)
-#  define LZF_USE_OFFSETS defined(_M_X64)
+   /* node-lzf: replaces upstream's macro-expanded `defined(_M_X64)`; same rationale as STRICT_ALIGN. */
+#  if defined(_M_X64)
+#   define LZF_USE_OFFSETS 1
+#  else
+#   define LZF_USE_OFFSETS 0
+#  endif
 # else
 #  if __cplusplus > 199711L
 #   include <cstdint>