content-disposition 1.1.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/content-disposition@1.1.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/content-disposition@1.1.0
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:8e2f3931979b520bea76d5de75bfba5f182e28735416b3efc15c593162e87794","constraints":{"executionContext":"node"},"contract":["contentDisposition() generates attachment disposition without parameters when called with no arguments","contentDisposition(filename) formats attachment disposition header with quoted basename","contentDisposition(filename, { type }) supports custom disposition types including inline","contentDisposition(filename) generates ISO-8859-1 fallback filename and RFC 5987 UTF-8 encoded filename* parameter for Unicode filenames","contentDisposition(filename, { fallback }) supports custom fallback filename string and boolean false to omit fallback","contentDisposition.parse(header) parses disposition header string into type and parameters map","contentDisposition.parse(header) decodes RFC 5987 extended UTF-8 parameters into standard parameter keys","contentDisposition.parse(header) throws TypeError on invalid arguments or malformed header syntax"],"goal":"verify pkg:npm/content-disposition@1.1.0","kind":"HOW","packages":["pkg:npm/content-disposition@1.1.0"],"schemaVersion":1,"symbols":["contentDisposition","contentDisposition.parse"]},"contractCommand":["node","test/contract.cjs"],"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/content-disposition@1.1.0"],"schemaVersion":1,"verifierAdapter":"node-typescript@1"}

{
  "name": "sample-content-disposition",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-content-disposition",
      "version": "1.0.0",
      "dependencies": {
        "content-disposition": "1.1.0"
      }
    },
    "node_modules/content-disposition": {
      "version": "1.1.0",
      "resolved": "https://registry.npmjs.org/content-disposition/-/content-disposition-1.1.0.tgz",
      "integrity": "sha512-5jRCH9Z/+DRP7rkvY83B+yGIGX96OYdJmzngqnw2SBSxqCFPd0w2km3s5iawpGX8krnwSGmF0FW5Nhr0Hfai3g==",
      "license": "MIT",
      "engines": {
        "node": ">=18"
      },
      "funding": {
        "type": "opencollective",
        "url": "https://opencollective.com/express"
      }
    }
  }
}

{
  "name": "sample-content-disposition",
  "version": "1.0.0",
  "private": true,
  "description": "Clean-room verification for content-disposition",
  "main": "src/index.js",
  "dependencies": {
    "content-disposition": "1.1.0"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify pkg:npm/content-disposition@1.1.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/content-disposition@1.1.0"
  ],
  "constraints": {
    "executionContext": "node"
  },
  "runtimeConditions": {
    "ecosystem": "npm",
    "language": "javascript",
    "moduleSystem": "cjs",
    "packageManager": "npm@10.9.8",
    "runtime": "node@22.23.2"
  }
}

const contentDisposition = require('content-disposition');

/**
 * Format a Content-Disposition header.
 * @param {string} [filename] - File name or path
 * @param {object} [options] - Options object
 * @returns {string} Content-Disposition header value
 */
function createDisposition(filename, options) {
  return contentDisposition(filename, options);
}

/**
 * Parse a Content-Disposition header string.
 * @param {string} header - Header string
 * @returns {{ type: string, parameters: Record<string, string> }} Parsed disposition
 */
function parseDisposition(header) {
  return contentDisposition.parse(header);
}

module.exports = {
  contentDisposition,
  createDisposition,
  parseDisposition
};

const assert = require('node:assert');
const contentDisposition = require('content-disposition');
const { createDisposition, parseDisposition } = require('../src/index.js');

// 1. contentDisposition() generates attachment disposition without parameters when called with no arguments
assert.strictEqual(contentDisposition(), 'attachment');
assert.strictEqual(createDisposition(), 'attachment');

// 2. contentDisposition(filename) formats attachment disposition header with quoted basename
assert.strictEqual(
  contentDisposition('report.pdf'),
  'attachment; filename="report.pdf"'
);
assert.strictEqual(
  contentDisposition('nested/directory/archive.tar.gz'),
  'attachment; filename="archive.tar.gz"'
);

// 3. contentDisposition(filename, { type }) supports custom disposition types including inline
assert.strictEqual(
  contentDisposition('photo.jpg', { type: 'inline' }),
  'inline; filename="photo.jpg"'
);
assert.strictEqual(
  contentDisposition(undefined, { type: 'inline' }),
  'inline'
);

// 4. contentDisposition(filename) generates ISO-8859-1 fallback filename and RFC 5987 UTF-8 encoded filename* parameter for Unicode filenames
assert.strictEqual(
  contentDisposition('€ rates.txt'),
  'attachment; filename="? rates.txt"; filename*=UTF-8\'\'%E2%82%AC%20rates.txt'
);

// 5. contentDisposition(filename, { fallback }) supports custom fallback filename string and boolean false to omit fallback
assert.strictEqual(
  contentDisposition('€ rates.txt', { fallback: 'euro_rates.txt' }),
  'attachment; filename="euro_rates.txt"; filename*=UTF-8\'\'%E2%82%AC%20rates.txt'
);
assert.strictEqual(
  contentDisposition('€ rates.txt', { fallback: false }),
  'attachment; filename*=UTF-8\'\'%E2%82%AC%20rates.txt'
);

// 6. contentDisposition.parse(header) parses disposition header string into type and parameters map
const basicParsed = parseDisposition('attachment; filename="plans.pdf"');
assert.strictEqual(basicParsed.type, 'attachment');
assert.deepStrictEqual(basicParsed.parameters, { filename: 'plans.pdf' });

const inlineParsed = parseDisposition('inline');
assert.strictEqual(inlineParsed.type, 'inline');
assert.deepStrictEqual(inlineParsed.parameters, {});

// 7. contentDisposition.parse(header) decodes RFC 5987 extended UTF-8 parameters into standard parameter keys
const extendedParsed = parseDisposition(
  "attachment; filename=\"EURO rates.txt\"; filename*=UTF-8''%e2%82%ac%20rates.txt"
);
assert.strictEqual(extendedParsed.type, 'attachment');
assert.deepStrictEqual(extendedParsed.parameters, { filename: '€ rates.txt' });

// 8. contentDisposition.parse(header) throws TypeError on invalid arguments or malformed header syntax
assert.throws(() => {
  parseDisposition(null);
}, TypeError);
assert.throws(() => {
  parseDisposition('attachment; filename=');
}, TypeError);

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