mute-stream 1.0.0

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 pkg:npm/mute-stream@1.0.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/mute-stream@1.0.0

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:c3678ff86670a96c2a93521436ac3e2d3977537cb99f45cca0f31b46a1f5532b","contract":["MuteStream instantiates a readable and writable stream with muted initially false","MuteStream passes through data chunks unchanged when unmuted","mute sets muted to true and suppresses data emission when replace option is not set","unmute sets muted to false and restores normal data emission","MuteStream with replace option emits replacement characters for data chunks when muted","end emits remaining data and closes stream when unmuted, or suppresses final chunk when muted without replacement","MuteStream pipes data to destination stream when unmuted and suppresses it when muted","isTTY property can be explicitly set and retrieved on MuteStream"],"goal":"verify pkg:npm/mute-stream@1.0.0","kind":"HOW","packages":["pkg:npm/mute-stream@1.0.0"],"schemaVersion":1},"contractCommand":["node","test/contract.mjs"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","libc":"glibc","libcVersion":"2.39","os":"linux","osVersionBucket":"24","packageManager":"npm","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/mute-stream@1.0.0"],"schemaVersion":1,"subject":"pkg:npm/mute-stream@1.0.0","verifierAdapter":"node-typescript@1"}

{
  "name": "sample-mute-stream",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-mute-stream",
      "version": "1.0.0",
      "dependencies": {
        "mute-stream": "1.0.0"
      }
    },
    "node_modules/mute-stream": {
      "version": "1.0.0",
      "resolved": "https://registry.npmjs.org/mute-stream/-/mute-stream-1.0.0.tgz",
      "integrity": "sha512-avsJQhyd+680gKXyG/sQc0nXaC6rBkPOfyHYcFb9+hdkqQkR9bdnkJ0AMZhke0oesPqIO+mFFJ+IdBc7mst4IA==",
      "license": "ISC",
      "engines": {
        "node": "^14.17.0 || ^16.13.0 || >=18.0.0"
      }
    }
  }
}

{
  "name": "sample-mute-stream",
  "version": "1.0.0",
  "type": "module",
  "private": true,
  "dependencies": {
    "mute-stream": "1.0.0"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify pkg:npm/mute-stream@1.0.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/mute-stream@1.0.0"
  ]
}

import assert from 'node:assert/strict';
import { PassThrough } from 'node:stream';
import MuteStream from 'mute-stream';

// 1. MuteStream instantiates a readable and writable stream with muted initially false
{
  const ms = new MuteStream();
  assert.equal(ms.readable, true, 'ms.readable should be true');
  assert.equal(ms.writable, true, 'ms.writable should be true');
  assert.equal(ms.muted, false, 'ms.muted should initially be false');
}

// 2. MuteStream passes through data chunks unchanged when unmuted
{
  const ms = new MuteStream();
  const chunks = [];
  ms.on('data', (c) => chunks.push(c.toString()));
  ms.write('hello world');
  assert.deepEqual(chunks, ['hello world']);
}

// 3. mute sets muted to true and suppresses data emission when replace option is not set
{
  const ms = new MuteStream();
  const chunks = [];
  ms.on('data', (c) => chunks.push(c.toString()));
  ms.mute();
  assert.equal(ms.muted, true);
  const ret = ms.write('secret data');
  assert.equal(ret, true);
  assert.deepEqual(chunks, []);
}

// 4. unmute sets muted to false and restores normal data emission
{
  const ms = new MuteStream();
  const chunks = [];
  ms.on('data', (c) => chunks.push(c.toString()));
  ms.mute();
  ms.write('hidden');
  ms.unmute();
  assert.equal(ms.muted, false);
  ms.write('visible');
  assert.deepEqual(chunks, ['visible']);
}

// 5. MuteStream with replace option emits replacement characters for data chunks when muted
{
  const ms = new MuteStream({ replace: '*' });
  const chunks = [];
  ms.on('data', (c) => chunks.push(c.toString()));
  ms.mute();
  ms.write('secret');
  assert.deepEqual(chunks, ['******']);
}

// 6. end emits remaining data and closes stream when unmuted, or suppresses final chunk when muted without replacement
{
  const ms1 = new MuteStream();
  const chunks1 = [];
  let ended1 = false;
  ms1.on('data', (c) => chunks1.push(c.toString()));
  ms1.on('end', () => { ended1 = true; });
  ms1.end('final chunk');
  assert.deepEqual(chunks1, ['final chunk']);
  assert.equal(ended1, true);

  const ms2 = new MuteStream();
  const chunks2 = [];
  let ended2 = false;
  ms2.on('data', (c) => chunks2.push(c.toString()));
  ms2.on('end', () => { ended2 = true; });
  ms2.mute();
  ms2.end('suppressed chunk');
  assert.deepEqual(chunks2, []);
  assert.equal(ended2, true);

  const ms3 = new MuteStream({ replace: '?' });
  const chunks3 = [];
  let ended3 = false;
  ms3.on('data', (c) => chunks3.push(c.toString()));
  ms3.on('end', () => { ended3 = true; });
  ms3.mute();
  ms3.end('masked');
  assert.deepEqual(chunks3, ['??????']);
  assert.equal(ended3, true);
}

// 7. MuteStream pipes data to destination stream when unmuted and suppresses it when muted
{
  const ms = new MuteStream();
  const dest = new PassThrough();
  const destChunks = [];
  dest.on('data', (c) => destChunks.push(c.toString()));
  ms.pipe(dest);

  ms.write('first');
  ms.mute();
  ms.write('ignored');
  ms.unmute();
  ms.write('second');
  assert.deepEqual(destChunks, ['first', 'second']);
}

// 8. isTTY property can be explicitly set and retrieved on MuteStream
{
  const ms = new MuteStream();
  assert.equal(ms.isTTY, false);
  ms.isTTY = true;
  assert.equal(ms.isTTY, true);
}