temp 0.9.4: createWriteStream

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 temp.createWriteStream in pkg:npm/temp@0.9.4
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/temp@0.9.4
Demonstrate these symbols/APIs:
  - temp.createWriteStream

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:ddf977c8fef8eee2a44dad1cdfc865e886b90ca7ad3fd50e806ea7ddc3cf390f","contract":["temp.createWriteStream creates a writable stream to a temporary file and exposes the file path","temp.createWriteStream accepts string prefix and custom affixes object { prefix, suffix }","temp.createWriteStream writes data to disk and completes via stream finish event","temp.track tracks temporary stream files and temp.cleanupSync removes them after stream is closed"],"goal":"verify temp.createWriteStream in pkg:npm/temp@0.9.4","kind":"HOW","packages":["pkg:npm/temp@0.9.4"],"schemaVersion":1,"symbols":["temp.createWriteStream"]},"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/temp@0.9.4"],"schemaVersion":1,"subject":"pkg:npm/temp@0.9.4","symbols":["temp.createWriteStream"],"verifierAdapter":"node-typescript@1"}

{
  "name": "sample-temp-create-write-stream",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-temp-create-write-stream",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "temp": "0.9.4"
      }
    },
    "node_modules/balanced-match": {
      "version": "1.0.2",
      "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz",
      "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==",
      "license": "MIT"
    },
    "node_modules/brace-expansion": {
      "version": "1.1.18",
      "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.18.tgz",
      "integrity": "sha512-Edep/X9fGqVNmzKBVsDYIOtD+z1tuezV70LBjdCst9Tqu76lsnvRiZ6oTic1n+/BIwX6QDGAO94PN4N2SADvtw==",
      "license": "MIT",
      "dependencies": {
        "balanced-match": "^1.0.0",
        "concat-map": "0.0.1"
      }
    },
    "node_modules/concat-map": {
      "version": "0.0.1",
      "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz",
      "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==",
      "license": "MIT"
    },
    "node_modules/fs.realpath": {
      "version": "1.0.0",
      "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz",
      "integrity": "sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==",
      "license": "ISC"
    },
    "node_modules/glob": {
      "version": "7.2.3",
      "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz",
      "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==",
      "deprecated": "Old versions of glob are not supported, and contain widely publicized security vulnerabilities, which have been fixed in the current version. Please update. Support for old versions may be purchased (at exorbitant rates) by contacting i@izs.me",
      "license": "ISC",
      "dependencies": {
        "fs.realpath": "^1.0.0",
        "inflight": "^1.0.4",
        "inherits": "2",
        "minimatch": "^3.1.1",
        "once": "^1.3.0",
        "path-is-absolute": "^1.0.0"
      },
      "engines": {
        "node": "*"
      },
      "funding": {
        "url": "https://github.com/sponsors/isaacs"
      }
    },
    "node_modules/inflight": {
      "version": "1.0.6",
      "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz",
      "integrity": "sha512-k92I/b08q4wvFscXCLvqfsHCrjrF7yiXsQuIVvVE7N82W3+aqpzuUdBbfhWcy/FZR3/4IgflMgKLOsvPDrGCJA==",
      "deprecated": "This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful.",
      "license": "ISC",
      "dependencies": {
        "once": "^1.3.0",
        "wrappy": "1"
      }
    },
    "node_modules/inherits": {
      "version": "2.0.4",
      "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz",
      "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==",
      "license": "ISC"
    },
    "node_modules/minimatch": {
      "version": "3.1.5",
      "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.5.tgz",
      "integrity": "sha512-VgjWUsnnT6n+NUk6eZq77zeFdpW2LWDzP6zFGrCbHXiYNul5Dzqk2HHQ5uFH2DNW5Xbp8+jVzaeNt94ssEEl4w==",
      "license": "ISC",
      "dependencies": {
        "brace-expansion": "^1.1.7"
      },
      "engines": {
        "node": "*"
      }
    },
    "node_modules/minimist": {
      "version": "1.2.8",
      "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz",
      "integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==",
      "license": "MIT",
      "funding": {
        "url": "https://github.com/sponsors/ljharb"
      }
    },
    "node_modules/mkdirp": {
      "version": "0.5.6",
      "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-0.5.6.tgz",
      "integrity": "sha512-FP+p8RB8OWpF3YZBCrP5gtADmtXApB5AMLn+vdyA+PyxCjrCs00mjyUozssO33cwDeT3wNGdLxJ5M//YqtHAJw==",
      "license": "MIT",
      "dependencies": {
        "minimist": "^1.2.6"
      },
      "bin": {
        "mkdirp": "bin/cmd.js"
      }
    },
    "node_modules/once": {
      "version": "1.4.0",
      "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz",
      "integrity": "sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==",
      "license": "ISC",
      "dependencies": {
        "wrappy": "1"
      }
    },
    "node_modules/path-is-absolute": {
      "version": "1.0.1",
      "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz",
      "integrity": "sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg==",
      "license": "MIT",
      "engines": {
        "node": ">=0.10.0"
      }
    },
    "node_modules/rimraf": {
      "version": "2.6.3",
      "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-2.6.3.tgz",
      "integrity": "sha512-mwqeW5XsA2qAejG46gYdENaxXjx9onRNCfn7L0duuP4hCuTIi/QO7PDK07KJfp1d+izWPrzEJDcSqBa0OZQriA==",
      "deprecated": "Rimraf versions prior to v4 are no longer supported",
      "license": "ISC",
      "dependencies": {
        "glob": "^7.1.3"
      },
      "bin": {
        "rimraf": "bin.js"
      }
    },
    "node_modules/temp": {
      "version": "0.9.4",
      "resolved": "https://registry.npmjs.org/temp/-/temp-0.9.4.tgz",
      "integrity": "sha512-yYrrsWnrXMcdsnu/7YMYAofM1ktpL5By7vZhf15CrXijWWrEYZks5AXBudalfSWJLlnen/QUJUB5aoB0kqZUGA==",
      "license": "MIT",
      "dependencies": {
        "mkdirp": "^0.5.1",
        "rimraf": "~2.6.2"
      },
      "engines": {
        "node": ">=6.0.0"
      }
    },
    "node_modules/wrappy": {
      "version": "1.0.2",
      "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz",
      "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==",
      "license": "ISC"
    }
  }
}

{
  "name": "sample-temp-create-write-stream",
  "version": "1.0.0",
  "private": true,
  "description": "Clean-room code sample for temp.createWriteStream in temp@0.9.4",
  "main": "src/index.js",
  "license": "MIT-0",
  "dependencies": {
    "temp": "0.9.4"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify temp.createWriteStream in pkg:npm/temp@0.9.4",
  "kind": "HOW",
  "packages": [
    "pkg:npm/temp@0.9.4"
  ],
  "symbols": [
    "temp.createWriteStream"
  ]
}

const temp = require('temp');

/**
 * Creates a writable stream to a temporary file.
 *
 * @param {string|Object} [affixes] - Prefix string or options object { prefix, suffix, dir }.
 * @returns {import('node:fs').WriteStream} Writable file stream with path property.
 */
function createTempWriteStream(affixes) {
  return temp.createWriteStream(affixes);
}

/**
 * Enables automatic cleanup tracking.
 *
 * @returns {typeof temp}
 */
function enableTracking() {
  return temp.track();
}

/**
 * Performs synchronous cleanup of tracked temporary files.
 *
 * @returns {{files: number, dirs: number}}
 */
function cleanupSync() {
  return temp.cleanupSync();
}

/**
 * Performs asynchronous cleanup of tracked temporary files.
 *
 * @returns {Promise<{files: number, dirs: number}>}
 */
function cleanupAsync() {
  return temp.cleanup();
}

module.exports = {
  temp,
  createTempWriteStream,
  enableTracking,
  cleanupSync,
  cleanupAsync
};

import assert from 'node:assert/strict';
import fs from 'node:fs';
import { createRequire } from 'node:module';

const require = createRequire(import.meta.url);
const {
  temp,
  createTempWriteStream,
  enableTracking,
  cleanupSync
} = require('../src/index.js');

async function testAll() {
  // 1. temp.createWriteStream creates a writable stream to a temporary file and exposes the file path
  const stream1 = createTempWriteStream();
  assert.ok(stream1, 'createTempWriteStream should return a stream');
  assert.ok(typeof stream1.path === 'string' && stream1.path.length > 0, 'stream must expose created file path');

  await new Promise((resolve, reject) => {
    stream1.on('error', reject);
    stream1.on('finish', resolve);
    stream1.write('stream default chunk');
    stream1.end();
  });
  assert.ok(fs.existsSync(stream1.path), 'temporary file must exist after writing');
  assert.equal(fs.readFileSync(stream1.path, 'utf8'), 'stream default chunk');

  // 2. temp.createWriteStream accepts string prefix and custom affixes object { prefix, suffix }
  const streamPrefix = createTempWriteStream('custom-prefix-');
  assert.ok(streamPrefix.path.includes('custom-prefix-'), 'stream file path should include custom prefix');
  await new Promise((resolve, reject) => {
    streamPrefix.on('error', reject);
    streamPrefix.on('finish', resolve);
    streamPrefix.end();
  });
  assert.ok(fs.existsSync(streamPrefix.path), 'prefix stream file must exist');

  const streamAffixes = createTempWriteStream({ prefix: 'affix-pre-', suffix: '.log' });
  assert.ok(streamAffixes.path.includes('affix-pre-'), 'stream file path should include affix prefix');
  assert.ok(streamAffixes.path.endsWith('.log'), 'stream file path should end with affix suffix');
  await new Promise((resolve, reject) => {
    streamAffixes.on('error', reject);
    streamAffixes.on('finish', resolve);
    streamAffixes.write('log content');
    streamAffixes.end();
  });
  assert.ok(fs.existsSync(streamAffixes.path), 'affixes stream file must exist');
  assert.equal(fs.readFileSync(streamAffixes.path, 'utf8'), 'log content');

  // 3. temp.createWriteStream writes data to disk and completes via stream finish event
  const streamData = createTempWriteStream({ prefix: 'data-verify-' });
  const testPayload = 'hello world from temp write stream\nsecond line';
  await new Promise((resolve, reject) => {
    streamData.on('error', reject);
    streamData.on('finish', resolve);
    streamData.write(testPayload);
    streamData.end();
  });
  const diskContent = fs.readFileSync(streamData.path, 'utf8');
  assert.equal(diskContent, testPayload, 'file content on disk must match written payload');

  // 4. temp.track tracks temporary stream files and temp.cleanupSync removes them after stream is closed
  enableTracking();
  const trackedStream = createTempWriteStream('tracked-stream-');
  const trackedPath = trackedStream.path;
  await new Promise((resolve, reject) => {
    trackedStream.on('error', reject);
    trackedStream.on('finish', resolve);
    trackedStream.write('tracking test');
    trackedStream.end();
  });
  assert.ok(fs.existsSync(trackedPath), 'tracked stream file must exist before cleanup');

  const cleanupStats = cleanupSync();
  assert.ok(typeof cleanupStats.files === 'number' && cleanupStats.files >= 1, 'cleanupSync should clean files');
  assert.ok(!fs.existsSync(trackedPath), 'tracked stream file must no longer exist after cleanup');

  // Clean up remaining test files
  for (const p of [stream1.path, streamPrefix.path, streamAffixes.path, streamData.path]) {
    if (fs.existsSync(p)) {
      try {
        fs.unlinkSync(p);
      } catch {}
    }
  }

  console.log('Contract tests passed successfully.');
}

testAll().catch((err) => {
  console.error('Contract test failure:', err);
  process.exit(1);
});