v2.0.0

2.0.0 (2024-12-06)

The MongoDB Node.js team is pleased to announce version 2.0.0 of the @mongodb-js/zstd package!

Release Notes

Compatibility with mongodb

zstd@2.0’s API is identical to zstd@1.x and will work wherever 1.x is supported. However, the driver’s peer dependency matrix is updated only in mongodb@6.12 and usage with versions <=6.12 will produce peer dependency warnings upon installation when using npm.

Support for linux s390x glibc platforms

@mongodb-js/zstd now publishes a prebuild for Linux s390x platforms with glibc>=2.23.

Minimum Node.js version is now v16.20.1

The minimum supported Node.js version is now v16.20.1. We strive to keep our minimum supported Node.js version in sync with the runtime's release cadence to keep up with the latest security updates and modern language features.

Internal re-write to C++

zstd@2.0 has been rewritten in C++ instead of Rust. The API of zstd@2.0 is identical to zstd@1.x and works as a drop-in replacement.

Add Signature to Github Releases

The Github release for the mongodb package now contains a detached signature file for the NPM package (named
@mongodb-js/zstd-X.Y.Z.tgz.sig), on every major and patch release to 2.x. To verify the signature, follow the instructions in the 'Release Integrity' section of the README.md file.

Changelog

Features

• NODE-4569: add "musl" builds for Alpine Linux (#12) (b3dedc3)
• NODE-6539: add base napi C++ template with standard Node team tooling (#28) (8c40b08)
• NODE-6540: Add c++ zstd compression API (#30) (6673245)
• NODE-6588: add ssdlc to zstd (#43) (016d857)

Bug Fixes

• bundle release build on windows (#59) (999c506)
• NODE-6590: add build for x64 macos (#45) (4972129)
• NODE-6590: specify correct entrypoint in package.json and include binding.gyp in the package (#47) (f562b59)

We invite you to try the @mongodb-js/zstd library immediately, and report any issues to the NODE project. A compatible driver release will be available soon.

v2.0.0-alpha.3

2.0.0-alpha.3 (2024-12-05)

Bug Fixes

• bundle release build on windows (#59) (999c506)

v2.0.0-alpha.2

2.0.0-alpha.2 (2024-12-04)

Bug Fixes

• NODE-6590: add build for x64 macos (#45) (4972129)

v2.0.0-alpha.1

2.0.1-alpha.0 (2024-12-02)

Bug Fixes

• NODE-6590: specify correct entrypoint in package.json and include binding.gyp in the package (#47) (f562b59)

v2.0.0-alpha.0

chore(main): release 2.0.0-alpha.0 (#41)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Bailey Pearson <bailey.pearson@mongodb.com>

v1.2.2

The MongoDB Node.js team is pleased to announce version 1.2.2 of the zstd package!

Release Highlights

This release fixes darwin x86_64 builds.

v1.2.1

The MongoDB Node.js team is pleased to announce version 1.2.0 of the zstd package!

Release Highlights

This release fixes JS stack traces when errors are thrown in the native bindings.

v1.2.0

The MongoDB Node.js team is pleased to announce version 1.2.0 of the zstd package!

Release Highlights

This release fixes a security vulnerability introduced in the zstd-safe library

v1.1.0

The MongoDB Node.js team is pleased to announce version 1.1.0 of the zstd package!

Release Highlights

This release allows the use of the library on Alpine Linux (musl).

v1.0.0

The MongoDB Node.js team is pleased to announce version 1.0.0 of the zstd package!

Release Highlights

This library allows zstd compression in Node.js, which can compress and decompress buffers with various levels (1-22).

Usage

import { compress, decompress } from '@mongodb-js/zstd';

(async () => {
  const buffer = Buffer.from('test');
  const compressed = await compress(buffer, 10);
  const decompressed = await decompress(compressed);
})();

API

export function compress(buffer: Buffer | ArrayBuffer | Uint8Array, level: number): Promise<Buffer>
export function decompress(buffer: Buffer): Promise<Buffer>

Supported Platforms

	node12	node14	node16	node17
Windows x64	✓	✓	✓	✓
macOS x64	✓	✓	✓	✓
macOS arm64	✓	✓	✓	✓
Linux x64 gnu	✓	✓	✓	✓
Linux arm gnu	✓	✓	✓	✓
Linux arm64 gnu	✓	✓	✓	✓