temp 0.9.4: temp

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/temp@0.9.4
Kind: HOW

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

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:10dcd7cd4739604a2073d86d3d0256158e090852d4db79833b829e874d4a6b4e","contract":["temp.path generates unique file paths with optional affixes","temp.mkdir and temp.mkdirSync create temporary directories","temp.open and temp.openSync create and open temporary files returning file descriptor and path","temp.createWriteStream creates a writable stream to a temporary file","temp.track enables tracking and temp.cleanupSync and temp.cleanup remove temporary files and directories"],"goal":"verify pkg:npm/temp@0.9.4","kind":"HOW","packages":["pkg:npm/temp@0.9.4"],"schemaVersion":1,"symbols":["temp"]},"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"],"verifierAdapter":"node-typescript@1"}

{
  "name": "sample-temp",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-temp",
      "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",
  "version": "1.0.0",
  "private": true,
  "description": "Clean-room code sample for temp@0.9.4",
  "main": "src/index.js",
  "license": "MIT-0",
  "dependencies": {
    "temp": "0.9.4"
  }
}

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

const temp = require('temp');

/**
 * Generates a unique temporary path with optional affixes.
 *
 * @param {string|Object} [affixes] - Prefix string or options object { prefix, suffix, dir }.
 * @param {string} [defaultPrefix] - Default prefix if affixes is not provided.
 * @returns {string} Unique temporary file or directory path.
 */
function getTempPath(affixes, defaultPrefix) {
  return temp.path(affixes, defaultPrefix);
}

/**
 * Creates a temporary directory asynchronously or synchronously.
 *
 * @param {string|Object} [affixes] - Prefix string or options object.
 * @param {boolean} [sync=false] - Whether to create synchronously.
 * @returns {Promise<string>|string} Temporary directory path.
 */
function createTempDir(affixes, sync = false) {
  if (sync) {
    return temp.mkdirSync(affixes);
  }
  return temp.mkdir(affixes);
}

/**
 * Creates and opens a temporary file asynchronously or synchronously.
 *
 * @param {string|Object} [affixes] - Prefix string or options object.
 * @param {boolean} [sync=false] - Whether to create synchronously.
 * @returns {Promise<{path: string, fd: number}>|{path: string, fd: number}}
 */
function openTempFile(affixes, sync = false) {
  if (sync) {
    return temp.openSync(affixes);
  }
  return temp.open(affixes);
}

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

/**
 * Enables tracking and performs cleanup of temporary resources.
 *
 * @param {boolean} [sync=false] - Whether to clean up synchronously.
 * @returns {Promise<{files: number, dirs: number}>|{files: number, dirs: number}}
 */
function cleanupTemp(sync = false) {
  if (sync) {
    return temp.cleanupSync();
  }
  return temp.cleanup();
}

module.exports = {
  temp,
  getTempPath,
  createTempDir,
  openTempFile,
  createTempWriteStream,
  cleanupTemp
};

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

const require = createRequire(import.meta.url);
const {
  temp,
  getTempPath,
  createTempDir,
  openTempFile,
  createTempWriteStream,
  cleanupTemp
} = require('../src/index.js');

async function testAll() {
  // 1. temp.path generates unique file paths with optional affixes
  const p1 = getTempPath('prefix-');
  assert.ok(typeof p1 === 'string' && p1.length > 0, 'temp.path should return a non-empty string');
  assert.ok(p1.includes('prefix-'), 'temp.path should include given prefix');

  const p2 = getTempPath({ prefix: 'custom-', suffix: '.tmp' });
  assert.ok(p2.includes('custom-'), 'temp.path should contain custom prefix');
  assert.ok(p2.endsWith('.tmp'), 'temp.path should contain custom suffix');

  // Enable tracking
  const trackedInstance = temp.track();
  assert.equal(trackedInstance, temp, 'temp.track() should return temp module instance');

  // 2. temp.mkdir and temp.mkdirSync create temporary directories
  const syncDir = createTempDir('test-sync-dir', true);
  assert.ok(fs.existsSync(syncDir), 'temp.mkdirSync must create directory on disk');
  assert.ok(fs.statSync(syncDir).isDirectory(), 'created sync path must be a directory');

  const asyncDir = await createTempDir({ prefix: 'test-async-dir-' });
  assert.ok(fs.existsSync(asyncDir), 'temp.mkdir must create directory on disk');
  assert.ok(fs.statSync(asyncDir).isDirectory(), 'created async path must be a directory');

  // 3. temp.open and temp.openSync create and open temporary files returning file descriptor and path
  const syncFile = openTempFile({ prefix: 'sync-file-', suffix: '.txt' }, true);
  assert.ok(typeof syncFile.fd === 'number' && syncFile.fd > 0, 'temp.openSync must return a valid numeric fd');
  assert.ok(fs.existsSync(syncFile.path), 'temp.openSync must create file on disk');
  fs.writeSync(syncFile.fd, 'sync-payload');
  fs.closeSync(syncFile.fd);
  assert.equal(fs.readFileSync(syncFile.path, 'utf8'), 'sync-payload');

  const asyncFile = await openTempFile('async-file');
  assert.ok(typeof asyncFile.fd === 'number' && asyncFile.fd > 0, 'temp.open must return a valid numeric fd');
  assert.ok(fs.existsSync(asyncFile.path), 'temp.open must create file on disk');
  fs.writeSync(asyncFile.fd, 'async-payload');
  fs.closeSync(asyncFile.fd);
  assert.equal(fs.readFileSync(asyncFile.path, 'utf8'), 'async-payload');

  // 4. temp.createWriteStream creates a writable stream to a temporary file
  const writeStream = createTempWriteStream('stream-target');
  assert.ok(writeStream.path, 'createWriteStream must expose created file path');
  await new Promise((resolve, reject) => {
    writeStream.on('error', reject);
    writeStream.on('finish', resolve);
    writeStream.write('stream data chunk');
    writeStream.end();
  });
  assert.ok(fs.existsSync(writeStream.path), 'stream file must exist on disk');
  assert.equal(fs.readFileSync(writeStream.path, 'utf8'), 'stream data chunk');

  // 5. temp.track enables tracking and temp.cleanupSync and temp.cleanup remove temporary files and directories
  const syncCleanupResult = cleanupTemp(true);
  assert.ok(syncCleanupResult.files >= 3, 'cleanupSync should clean all tracked files');
  assert.ok(syncCleanupResult.dirs >= 2, 'cleanupSync should clean all tracked directories');
  assert.ok(!fs.existsSync(syncFile.path), 'syncFile should no longer exist after cleanup');
  assert.ok(!fs.existsSync(asyncFile.path), 'asyncFile should no longer exist after cleanup');
  assert.ok(!fs.existsSync(writeStream.path), 'stream file should no longer exist after cleanup');
  assert.ok(!fs.existsSync(syncDir), 'syncDir should no longer exist after cleanup');
  assert.ok(!fs.existsSync(asyncDir), 'asyncDir should no longer exist after cleanup');

  const asyncDirToClean = await createTempDir('async-clean-dir');
  const asyncFileToClean = await openTempFile('async-clean-file');
  fs.closeSync(asyncFileToClean.fd);
  assert.ok(fs.existsSync(asyncDirToClean), 'new async dir should exist before cleanup');
  assert.ok(fs.existsSync(asyncFileToClean.path), 'new async file should exist before cleanup');

  const asyncCleanupResult = await cleanupTemp(false);
  assert.ok(asyncCleanupResult.files >= 1, 'async cleanup should remove files');
  assert.ok(asyncCleanupResult.dirs >= 1, 'async cleanup should remove dirs');
  assert.ok(!fs.existsSync(asyncDirToClean), 'async dir should be removed after async cleanup');
  assert.ok(!fs.existsSync(asyncFileToClean.path), 'async file should be removed after async cleanup');

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

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