minizlib 2.1.2: BrotliCompress

Clean-room public code sample — generation instructions

Write a brand-new, minimal, self-contained code sample in this clean-room directory.
Do not copy, paraphrase, or reference any existing project source. Work only from this spec.

A csx.json manifest scaffold already exists. Do not recreate it from memory. Preserve its case.goal, packages and symbols; fill its empty case.contract with exact assertions and correct its environment, commands and verifierAdapter for the files you generate.

Goal: verify minizlib.BrotliCompress in pkg:npm/minizlib@2.1.2
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/minizlib@2.1.2
Demonstrate these symbols/APIs:
  - minizlib.BrotliCompress

Rules:
  - One focused purpose; the smallest project that proves the goal.
  - Include a contract test (test/contract.*) that runs OFFLINE and exits 0 exactly when the goal behavior works.
  - Pin every dependency with a lockfile so resolution is reproducible.
  - No secrets, credentials, or tokens. No real URLs (only example.com or localhost). No absolute paths.
  - No personal names, emails, company names, or project identifiers of any kind.
  - No binaries and no generated output (node_modules, dist, target, venv, .git, .env).
  - Keep it under 200 files and 256KB packed.

{"case":{"caseId":"case:sha256:3421db124e77660378f5c36708303542911e4bc2a70d6b2b224ac6f4e850c052","constraints":{"executionContext":"node"},"contract":["assert minizlib.BrotliCompress compresses buffer synchronously via end and read","assert minizlib.BrotliCompress compresses chunked data streams via data and end events","assert minizlib.BrotliCompress handles compression of empty buffer payload","assert minizlib.BrotliCompress accepts custom brotli compression parameters","assert minizlib.BrotliCompress preserves large payload integrity during roundtrip decompression"],"goal":"verify minizlib.BrotliCompress in pkg:npm/minizlib@2.1.2","kind":"HOW","packages":["pkg:npm/minizlib@2.1.2"],"schemaVersion":1,"symbols":["minizlib.BrotliCompress"]},"contractCommand":["node","test/contract.mjs"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","executionContext":"node","language":"javascript","libc":"glibc","libcVersion":"2.39","moduleSystem":"cjs","os":"linux","osVersionBucket":"24","packageManager":"npm","packageManagerVersion":"10.9.8","runtime":"node","runtimeVersion":"22.23.2","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/minizlib@2.1.2"],"schemaVersion":1,"subject":"pkg:npm/minizlib@2.1.2","symbols":["minizlib.BrotliCompress"],"verifierAdapter":"node-typescript@1"}

const minizlib = require('minizlib');

function createBrotliCompress(options) {
  return new minizlib.BrotliCompress(options);
}

function compressSync(buffer, options) {
  const compressor = new minizlib.BrotliCompress(options);
  compressor.end(buffer);
  return compressor.read();
}

exports.BrotliCompress = minizlib.BrotliCompress;
exports.createBrotliCompress = createBrotliCompress;
exports.compressSync = compressSync;
exports.minizlib = minizlib;

{
  "name": "sample-minizlib-brotlicompress",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-minizlib-brotlicompress",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "minizlib": "2.1.2"
      }
    },
    "node_modules/minipass": {
      "version": "3.3.6",
      "resolved": "https://registry.npmjs.org/minipass/-/minipass-3.3.6.tgz",
      "integrity": "sha512-DxiNidxSEK+tHG6zOIklvNOwm3hvCrbUrdtzY74U6HKTJxvIDfOUL5W5P2Ghd3DTkhhKPYGqeNUIh5qcM4YBfw==",
      "license": "ISC",
      "dependencies": {
        "yallist": "^4.0.0"
      },
      "engines": {
        "node": ">=8"
      }
    },
    "node_modules/minizlib": {
      "version": "2.1.2",
      "resolved": "https://registry.npmjs.org/minizlib/-/minizlib-2.1.2.tgz",
      "integrity": "sha512-bAxsR8BVfj60DWXHE3u30oHzfl4G7khkSuPW+qvpd7jFRHm7dLxOjUk1EHACJ/hxLY8phGJ0YhYHZo7jil7Qdg==",
      "license": "MIT",
      "dependencies": {
        "minipass": "^3.0.0",
        "yallist": "^4.0.0"
      },
      "engines": {
        "node": ">= 8"
      }
    },
    "node_modules/yallist": {
      "version": "4.0.0",
      "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz",
      "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==",
      "license": "ISC"
    }
  }
}

{
  "name": "sample-minizlib-brotlicompress",
  "version": "1.0.0",
  "description": "Minimal clean-room sample verifying minizlib.BrotliCompress in minizlib",
  "main": "index.js",
  "license": "MIT-0",
  "dependencies": {
    "minizlib": "2.1.2"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify minizlib.BrotliCompress in pkg:npm/minizlib@2.1.2",
  "kind": "HOW",
  "packages": [
    "pkg:npm/minizlib@2.1.2"
  ],
  "symbols": [
    "minizlib.BrotliCompress"
  ]
}

import assert from 'node:assert';
import zlib from 'node:zlib';
import pkg from '../index.js';

const { BrotliCompress, compressSync, createBrotliCompress } = pkg;

// 1. assert minizlib.BrotliCompress compresses buffer synchronously via end and read
{
  const text = 'Hello CodeSampleX Brotli compression test';
  const original = Buffer.from(text, 'utf8');

  const compressor = new BrotliCompress();
  compressor.end(original);
  const result = compressor.read();
  assert(Buffer.isBuffer(result), 'Result should be a Buffer');
  const decompressed = zlib.brotliDecompressSync(result);
  assert.strictEqual(decompressed.toString('utf8'), text, 'Decompressed text must match original');

  const helperResult = compressSync(original);
  assert(Buffer.isBuffer(helperResult), 'Helper result should be a Buffer');
  const helperDecompressed = zlib.brotliDecompressSync(helperResult);
  assert.strictEqual(helperDecompressed.toString('utf8'), text, 'Helper decompressed text must match original');
}

// 2. assert minizlib.BrotliCompress compresses chunked data streams via data and end events
await new Promise((resolve, reject) => {
  const text = 'Streaming brotli chunked compression verification with minizlib';
  const original = Buffer.from(text, 'utf8');

  const compressor = createBrotliCompress();
  const chunks = [];
  compressor.on('data', chunk => chunks.push(chunk));
  compressor.on('end', () => {
    try {
      const output = Buffer.concat(chunks);
      const decompressed = zlib.brotliDecompressSync(output).toString('utf8');
      assert.strictEqual(decompressed, text, 'Streamed compression must match original when decompressed');
      resolve();
    } catch (err) {
      reject(err);
    }
  });
  compressor.on('error', reject);

  const half = Math.floor(original.length / 2);
  compressor.write(original.subarray(0, half));
  compressor.end(original.subarray(half));
});

// 3. assert minizlib.BrotliCompress handles compression of empty buffer payload
{
  const original = Buffer.alloc(0);
  const compressor = new BrotliCompress();
  compressor.end(original);
  const result = compressor.read();
  assert(Buffer.isBuffer(result), 'Result must be a Buffer');
  assert(result.length > 0, 'Empty brotli stream produces minimal header');
  const decompressed = zlib.brotliDecompressSync(result);
  assert.strictEqual(decompressed.length, 0, 'Decompressed empty payload must have 0 length');
}

// 4. assert minizlib.BrotliCompress accepts custom brotli compression parameters
{
  const text = 'Testing Brotli compression quality settings';
  const original = Buffer.from(text, 'utf8');
  const compressor = new BrotliCompress({
    params: {
      [zlib.constants.BROTLI_PARAM_QUALITY]: 4,
    },
  });
  compressor.end(original);
  const result = compressor.read();
  assert(Buffer.isBuffer(result), 'Result should be a Buffer');
  const decompressed = zlib.brotliDecompressSync(result);
  assert.strictEqual(decompressed.toString('utf8'), text, 'Decompressed text must match original');
}

// 5. assert minizlib.BrotliCompress preserves large payload integrity during roundtrip decompression
{
  const largeData = Buffer.alloc(64 * 1024);
  for (let i = 0; i < largeData.length; i++) {
    largeData[i] = (i % 251);
  }

  const compressor = new BrotliCompress();
  compressor.end(largeData);
  const result = compressor.read();
  assert(Buffer.isBuffer(result), 'Result should be a Buffer');
  const decompressed = zlib.brotliDecompressSync(result);
  assert.strictEqual(decompressed.length, largeData.length, 'Decompressed size must match');
  assert.strictEqual(Buffer.compare(decompressed, largeData), 0, 'Decompressed buffer must match byte-for-byte');
}

console.log('All minizlib.BrotliCompress contract assertions passed.');