simple-zstd 2.0.0 → 2.1.0

package/.github/workflows/ci.yml

@@ -1,4 +1,6 @@
 name: CI
+permissions:
+  contents: read
 
 on:
   push:
@@ -15,17 +17,17 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [20.x, 22.x, 24.x]
+        node-version: [22.x, 24.x]
 
     steps:
       - name: Install zstd
         run: sudo apt-get update && sudo apt-get install -y zstd
 
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
 
       - name: Setup Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v4
+        uses: actions/setup-node@v6
         with:
           node-version: ${{ matrix.node-version }}
           cache: 'npm'

package/.github/workflows/release.yml

@@ -2,6 +2,12 @@ name: Release
 
 on:
   workflow_dispatch:
+    inputs:
+      version:
+        description: 'Version bump type (patch, minor, major) or explicit version (e.g. 2.1.0)'
+        required: true
+        default: 'patch'
+        type: string
 
 permissions:
   contents: write
@@ -17,12 +23,12 @@ jobs:
         run: sudo apt-get update && sudo apt-get install -y zstd
 
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
         with:
           fetch-depth: 0
 
       - name: Setup Node.js
-        uses: actions/setup-node@v4
+        uses: actions/setup-node@v6
         with:
           node-version: '24.x'
           cache: 'npm'
@@ -40,6 +46,6 @@ jobs:
           git config user.email "github-actions[bot]@users.noreply.github.com"
 
       - name: Run release-it
-        run: npx release-it
+        run: npx release-it ${{ inputs.version }} --ci
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [2.1.0](https://github.com/Stieneee/simple-zstd/compare/v2.0.0...v2.1.0) (2026-03-14)
+
+### Bug Fixes
+
+* handle stdin EPIPE errors in ProcessDuplex ([250d16d](https://github.com/Stieneee/simple-zstd/commit/250d16d3b8a81c9b1b295064cc5dae82423defeb))
+
 ## [2.0.0](https://github.com/Stieneee/simple-zstd/compare/1.4.2...v2.0.0) (2025-11-12)
 
 ### ⚠ BREAKING CHANGES

package/README.md

@@ -16,7 +16,7 @@ simple-zstd is a lightweight wrapper around the system-installed zstd binary, in
 - **Promise-Based**: All operations return promises for modern async/await patterns
 - **Stream & Buffer**: Support for both streaming and buffer-based compression/decompression
 - **Smart Decompression**: Automatic detection and passthrough of non-compressed data
-- **Dictionary Support**: Use compression dictionaries via Buffer or file path
+- **Dictionary Support**: Create and use compression dictionaries via Buffer or file path
 - **Process Pooling**: Pre-spawn child processes for latency-sensitive applications
 - **Node.js 18+**: Built on modern Node.js features
 
@@ -87,6 +87,13 @@ interface PoolOpts {
     streamOptions?: DuplexOptions;
   };
 }
+
+interface CreateDictionaryOpts {
+  trainingFiles: Array<string | Buffer>; // Training corpus as file paths and/or in-memory Buffers
+  maxDictSize?: number; // Optional max dictionary size in bytes
+  zstdOptions?: string[]; // Additional zstd options for dictionary training
+  spawnOptions?: SpawnOptions; // Node.js child_process spawn options
+}
 ```
 
 ### Static Functions
@@ -95,6 +102,7 @@ interface PoolOpts {
 // Compression
 compress(compLevel: number, opts?: ZSTDOpts): Promise<Duplex>
 compressBuffer(buffer: Buffer, compLevel: number, opts?: ZSTDOpts): Promise<Buffer>
+createDictionary(opts: CreateDictionaryOpts): Promise<Buffer>
 
 // Decompression (with automatic passthrough for non-compressed data)
 decompress(opts?: ZSTDOpts): Promise<Duplex>
@@ -321,7 +329,36 @@ for (let i = 0; i < 1000; i++) {
 // Temp file is automatically cleaned up when no longer referenced
 ```
 
-### Example 6: Smart Decompression (Auto-detect)
+### Example 6: Creating a Dictionary from Training Files
+
+```typescript
+import path from "node:path";
+import { createDictionary, compressBuffer, decompressBuffer } from "simple-zstd";
+
+async function trainAndUseDictionary() {
+  const trainingFiles = [
+    path.join("sample", "training-files", "user-0.json"),
+    path.join("sample", "training-files", "user-1.json"),
+    path.join("sample", "training-files", "user-2.json"),
+    Buffer.from('{"event":"user-signup","country":"Canada"}'),
+  ];
+
+  const dictionary = await createDictionary({
+    trainingFiles,
+    maxDictSize: 112640,
+  });
+
+  const payload = Buffer.from('{"event":"user-login","country":"Canada"}');
+  const compressed = await compressBuffer(payload, 3, { dictionary });
+  const decompressed = await decompressBuffer(compressed, { dictionary });
+
+  console.log(decompressed.toString()); // {"event":"user-login","country":"Canada"}
+}
+
+trainAndUseDictionary().catch(console.error);
+```
+
+### Example 7: Smart Decompression (Auto-detect)
 
 The decompression functions automatically detect if data is zstd-compressed and pass through uncompressed data unchanged.
 

package/dist/src/buffer-writable.js

@@ -1,31 +1,19 @@
 "use strict";
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var _BufferWritable_buf;
 Object.defineProperty(exports, "__esModule", { value: true });
 const node_stream_1 = require("node:stream");
 class BufferWritable extends node_stream_1.Writable {
+    #buf;
     constructor(options) {
         super(options);
-        _BufferWritable_buf.set(this, void 0);
-        __classPrivateFieldSet(this, _BufferWritable_buf, [], "f");
+        this.#buf = [];
     }
     _write(chunk, encoding, callback = () => null) {
-        __classPrivateFieldGet(this, _BufferWritable_buf, "f").push(chunk);
+        this.#buf.push(chunk);
         callback();
     }
     _writev(chunks, callback = () => null) {
         for (const { chunk } of chunks) {
-            __classPrivateFieldGet(this, _BufferWritable_buf, "f").push(chunk);
+            this.#buf.push(chunk);
         }
         callback();
     }
@@ -33,9 +21,8 @@ class BufferWritable extends node_stream_1.Writable {
         callback();
     }
     getBuffer() {
-        return Buffer.concat(__classPrivateFieldGet(this, _BufferWritable_buf, "f")) || Buffer.alloc(0);
+        return Buffer.concat(this.#buf) || Buffer.alloc(0);
     }
 }
-_BufferWritable_buf = new WeakMap();
 exports.default = BufferWritable;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYnVmZmVyLXdyaXRhYmxlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2J1ZmZlci13cml0YWJsZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7Ozs7OztBQUFBLDZDQUF3RDtBQUV4RCxNQUFxQixjQUFlLFNBQVEsc0JBQVE7SUFHbEQsWUFBWSxPQUF3QjtRQUNsQyxLQUFLLENBQUMsT0FBTyxDQUFDLENBQUM7UUFIakIsc0NBQW9CO1FBSWxCLHVCQUFBLElBQUksdUJBQVEsRUFBRSxNQUFBLENBQUM7SUFDakIsQ0FBQztJQUVELE1BQU0sQ0FBQyxLQUFhLEVBQUUsUUFBZ0IsRUFBRSxXQUF1QixHQUFHLEVBQUUsQ0FBQyxJQUFJO1FBQ3ZFLHVCQUFBLElBQUksMkJBQUssQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDLENBQUM7UUFDdEIsUUFBUSxFQUFFLENBQUM7SUFDYixDQUFDO0lBRUQsT0FBTyxDQUFDLE1BQWtELEVBQUUsV0FBdUIsR0FBRyxFQUFFLENBQUMsSUFBSTtRQUMzRixLQUFLLE1BQU0sRUFBRSxLQUFLLEVBQUUsSUFBSSxNQUFNLEVBQUUsQ0FBQztZQUMvQix1QkFBQSxJQUFJLDJCQUFLLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxDQUFDO1FBQ3hCLENBQUM7UUFDRCxRQUFRLEVBQUUsQ0FBQztJQUNiLENBQUM7SUFFRCxNQUFNLENBQUMsV0FBdUIsR0FBRyxFQUFFLENBQUMsSUFBSTtRQUN0QyxRQUFRLEVBQUUsQ0FBQztJQUNiLENBQUM7SUFFRCxTQUFTO1FBQ1AsT0FBTyxNQUFNLENBQUMsTUFBTSxDQUFDLHVCQUFBLElBQUksMkJBQUssQ0FBQyxJQUFJLE1BQU0sQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDLENBQUM7SUFDckQsQ0FBQztDQUNGOztrQkEzQm9CLGNBQWMifQ==
+//# sourceMappingURL=buffer-writable.js.map

package/dist/src/buffer-writable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"buffer-writable.js","sourceRoot":"","sources":["../../src/buffer-writable.ts"],"names":[],"mappings":";;AAAA,6CAAwD;AAExD,MAAqB,cAAe,SAAQ,sBAAQ;IAClD,IAAI,CAAgB;IAEpB,YAAY,OAAwB;QAClC,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC;IACjB,CAAC;IAED,MAAM,CAAC,KAAa,EAAE,QAAgB,EAAE,WAAuB,GAAG,EAAE,CAAC,IAAI;QACvE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACtB,QAAQ,EAAE,CAAC;IACb,CAAC;IAED,OAAO,CAAC,MAAkD,EAAE,WAAuB,GAAG,EAAE,CAAC,IAAI;QAC3F,KAAK,MAAM,EAAE,KAAK,EAAE,IAAI,MAAM,EAAE,CAAC;YAC/B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,CAAC;QACD,QAAQ,EAAE,CAAC;IACb,CAAC;IAED,MAAM,CAAC,WAAuB,GAAG,EAAE,CAAC,IAAI;QACtC,QAAQ,EAAE,CAAC;IACb,CAAC;IAED,SAAS;QACP,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACrD,CAAC;CACF;AA3BD,iCA2BC"}

package/dist/src/index.d.ts

@@ -1,6 +1,6 @@
 import { Duplex } from 'node:stream';
-import { ZSTDOpts, PoolOpts } from './types';
-export type { ZSTDOpts, PoolOpts, CompressOpts, DecompressOpts, DictionaryObject } from './types';
+import { ZSTDOpts, PoolOpts, CreateDictionaryOpts } from './types';
+export type { ZSTDOpts, PoolOpts, CompressOpts, DecompressOpts, DictionaryObject, CreateDictionaryOpts, } from './types';
 /**
  * Clear the dictionary cache and cleanup all temporary files
  * This is useful for testing or manual cache management
@@ -11,6 +11,7 @@ export declare function compress(compLevel: number, opts?: ZSTDOpts): Promise<Du
 export declare function compressBuffer(buffer: Buffer, compLevel: number, opts?: ZSTDOpts): Promise<Buffer>;
 export declare function decompress(opts?: ZSTDOpts): Promise<Duplex>;
 export declare function decompressBuffer(buffer: Buffer, opts?: ZSTDOpts): Promise<Buffer>;
+export declare function createDictionary(opts: CreateDictionaryOpts): Promise<Buffer>;
 export declare class SimpleZSTD {
     #private;
     private constructor();