minizlib 3.1.0: BrotliDecompress

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.BrotliDecompress in pkg:npm/minizlib@3.1.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/minizlib@3.1.0
Demonstrate these symbols/APIs:
  - minizlib.BrotliDecompress
Constraints:
  - executionContext: node
Required runtime conditions:
  - ecosystem: npm
  - language: javascript
  - moduleSystem: cjs
  - packageManager: npm@10.9.8
  - runtime: node@22.23.2

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:7f77fe6d3f2543229d4bf48863c3e1611f483e9c6be9bf5b0b0c5cd2bed03651","constraints":{"executionContext":"node"},"contract":["assert minizlib.BrotliDecompress decompresses brotli buffer synchronously via end and read","assert minizlib.BrotliDecompress decompresses chunked brotli streams via data and end events","assert minizlib.BrotliDecompress handles decompression of empty buffer payload","assert minizlib.BrotliDecompress emits error event on corrupted or invalid input stream","assert minizlib.BrotliDecompress preserves large payload integrity during decompression"],"goal":"verify minizlib.BrotliDecompress in pkg:npm/minizlib@3.1.0","kind":"HOW","packages":["pkg:npm/minizlib@3.1.0"],"schemaVersion":1,"symbols":["minizlib.BrotliDecompress"]},"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@3.1.0"],"schemaVersion":1,"subject":"pkg:npm/minizlib@3.1.0","symbols":["minizlib.BrotliDecompress"],"verifierAdapter":"node-typescript@1"}

const minizlib = require('minizlib');

function createBrotliDecompress(options) {
  return new minizlib.BrotliDecompress(options);
}

function decompressSync(buffer, options) {
  const decompressor = new minizlib.BrotliDecompress(options);
  decompressor.end(buffer);
  return decompressor.read();
}

exports.BrotliDecompress = minizlib.BrotliDecompress;
exports.createBrotliDecompress = createBrotliDecompress;
exports.decompressSync = decompressSync;
exports.minizlib = minizlib;

{
  "name": "sample-minizlib-brotlidecompress",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-minizlib-brotlidecompress",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "minizlib": "3.1.0"
      }
    },
    "node_modules/minipass": {
      "version": "7.1.3",
      "resolved": "https://registry.npmjs.org/minipass/-/minipass-7.1.3.tgz",
      "integrity": "sha512-tEBHqDnIoM/1rXME1zgka9g6Q2lcoCkxHLuc7ODJ5BxbP5d4c2Z5cGgtXAku59200Cx7diuHTOYfSBD8n6mm8A==",
      "license": "BlueOak-1.0.0",
      "engines": {
        "node": ">=16 || 14 >=14.17"
      }
    },
    "node_modules/minizlib": {
      "version": "3.1.0",
      "resolved": "https://registry.npmjs.org/minizlib/-/minizlib-3.1.0.tgz",
      "integrity": "sha512-KZxYo1BUkWD2TVFLr0MQoM8vUUigWD3LlD83a/75BqC+4qE0Hb1Vo5v1FgcfaNXvfXzr+5EhQ6ing/CaBijTlw==",
      "license": "MIT",
      "dependencies": {
        "minipass": "^7.1.2"
      },
      "engines": {
        "node": ">= 18"
      }
    }
  }
}

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

{
  "schemaVersion": 1,
  "goal": "verify minizlib.BrotliDecompress in pkg:npm/minizlib@3.1.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/minizlib@3.1.0"
  ],
  "symbols": [
    "minizlib.BrotliDecompress"
  ],
  "constraints": {
    "executionContext": "node"
  },
  "runtimeConditions": {
    "ecosystem": "npm",
    "language": "javascript",
    "moduleSystem": "cjs",
    "packageManager": "npm@10.9.8",
    "runtime": "node@22.23.2"
  }
}

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

const { BrotliDecompress, decompressSync, createBrotliDecompress } = pkg;

// 1. assert minizlib.BrotliDecompress decompresses brotli buffer synchronously via end and read
{
  const text = 'Hello CodeSampleX Brotli decompression test';
  const original = Buffer.from(text, 'utf8');
  const compressed = zlib.brotliCompressSync(original);

  const decompressor = new BrotliDecompress();
  decompressor.end(compressed);
  const result = decompressor.read();
  assert(Buffer.isBuffer(result), 'Result should be a Buffer');
  assert.strictEqual(result.toString('utf8'), text, 'Decompressed text must match original');

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

// 2. assert minizlib.BrotliDecompress decompresses chunked brotli streams via data and end events
await new Promise((resolve, reject) => {
  const text = 'Streaming brotli chunked decompression verification';
  const original = Buffer.from(text, 'utf8');
  const compressed = zlib.brotliCompressSync(original);

  const decompressor = createBrotliDecompress();
  const chunks = [];
  decompressor.on('data', chunk => chunks.push(chunk));
  decompressor.on('end', () => {
    try {
      const output = Buffer.concat(chunks).toString('utf8');
      assert.strictEqual(output, text, 'Streamed decompression must match original');
      resolve();
    } catch (err) {
      reject(err);
    }
  });
  decompressor.on('error', reject);

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

// 3. assert minizlib.BrotliDecompress handles decompression of empty buffer payload
{
  const original = Buffer.alloc(0);
  const compressed = zlib.brotliCompressSync(original);

  const decompressor = new BrotliDecompress();
  decompressor.end(compressed);
  const result = decompressor.read();
  const len = result ? result.length : 0;
  assert.strictEqual(len, 0, 'Decompressed empty payload must have 0 length');
}

// 4. assert minizlib.BrotliDecompress emits error event on corrupted or invalid input stream
await new Promise((resolve, reject) => {
  const decompressor = new BrotliDecompress();
  let errorHandled = false;
  decompressor.on('error', err => {
    errorHandled = true;
    assert(err instanceof Error, 'Emitted error should be an Error instance');
    resolve();
  });
  try {
    decompressor.end(Buffer.from('not valid brotli payload'));
  } catch (err) {
    errorHandled = true;
    assert(err instanceof Error, 'Caught error should be an Error instance');
    resolve();
  }
  setTimeout(() => {
    if (!errorHandled) {
      reject(new Error('Expected error on invalid brotli data'));
    }
  }, 100);
});

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

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

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