@types/jsesc 2.5.1

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/%40types/jsesc@2.5.1
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/%40types/jsesc@2.5.1
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:cf1d3978013f9e97f3875a433d0d5a90bcbc73c7562b8c8754cef8baf52fc95c","constraints":{"executionContext":"node"},"contract":["package manifest specifies index.d.ts type declarations and TypeScript version","declares jsesc main function signature accepting argument and optional Opts configuration","declares jsesc namespace with version property","declares Opts interface with quotes, numbers, wrap, es6, escapeEverything, and minimal options","declares Opts interface formatting and mode options including isScriptContext, compact, indent, indentLevel, json, and lowercaseHex","exports jsesc using CommonJS export assignment"],"goal":"verify pkg:npm/%40types/jsesc@2.5.1","kind":"HOW","packages":["pkg:npm/%40types/jsesc@2.5.1"],"schemaVersion":1},"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/%40types/jsesc@2.5.1"],"schemaVersion":1,"subject":"pkg:npm/%40types/jsesc@2.5.1","verifierAdapter":"node-typescript@1"}

{
  "name": "sample-types-jsesc",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-types-jsesc",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "@types/jsesc": "2.5.1"
      }
    },
    "node_modules/@types/jsesc": {
      "version": "2.5.1",
      "resolved": "https://registry.npmjs.org/@types/jsesc/-/jsesc-2.5.1.tgz",
      "integrity": "sha512-9VN+6yxLOPLOav+7PwjZbxiID2bVaeq0ED4qSQmdQTdjnXJSaCVKTR58t15oqH1H5t8Ng2ZX1SabJVoN9Q34bw==",
      "license": "MIT"
    }
  }
}

{
  "name": "sample-types-jsesc",
  "version": "1.0.0",
  "private": true,
  "type": "module",
  "license": "MIT-0",
  "dependencies": {
    "@types/jsesc": "2.5.1"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify pkg:npm/%40types/jsesc@2.5.1",
  "kind": "HOW",
  "packages": [
    "pkg:npm/%40types/jsesc@2.5.1"
  ],
  "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/strict';
import { createRequire } from 'node:module';
import fs from 'node:fs';
import path from 'node:path';

const require = createRequire(import.meta.url);

// 1. Resolve @types/jsesc package manifest and verify type declaration entry points
const pkgPath = require.resolve('@types/jsesc/package.json');
const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf8'));

assert.equal(pkg.name, '@types/jsesc', 'Package name must be @types/jsesc');
assert.equal(pkg.version, '2.5.1', 'Package version must be 2.5.1');
assert.equal(pkg.types, 'index.d.ts', 'Package types entry must point to index.d.ts');
assert.equal(pkg.typeScriptVersion, '3.0', 'TypeScript version must be 3.0');

const typesDir = path.dirname(pkgPath);
const dtsContent = fs.readFileSync(path.join(typesDir, 'index.d.ts'), 'utf8');

// 2. Verify jsesc main function declaration
assert.ok(
  dtsContent.includes('declare function jsesc(argument: any, opts?: jsesc.Opts): string;'),
  'jsesc main function signature must accept argument and optional opts returning string'
);

// 3. Verify jsesc namespace and version property
assert.ok(
  dtsContent.includes('declare namespace jsesc {'),
  'jsesc namespace must be declared'
);
assert.ok(
  dtsContent.includes('var version: string;'),
  'jsesc version string property must be declared'
);

// 4. Verify Opts interface declaration and core options
assert.ok(
  dtsContent.includes('interface Opts {'),
  'Opts interface must be declared'
);
assert.ok(
  dtsContent.includes("quotes?: 'single' | 'double' | 'backtick';"),
  'quotes option must support single, double, and backtick'
);
assert.ok(
  dtsContent.includes("numbers?: 'binary' | 'octal' | 'decimal' | 'hexadecimal';"),
  'numbers option must support binary, octal, decimal, and hexadecimal'
);
assert.ok(
  dtsContent.includes('wrap?: boolean;') &&
  dtsContent.includes('es6?: boolean;') &&
  dtsContent.includes('escapeEverything?: boolean;') &&
  dtsContent.includes('minimal?: boolean;'),
  'Opts interface must declare boolean flags for wrap, es6, escapeEverything, minimal'
);

// 5. Verify formatting, context, and mode options
assert.ok(
  dtsContent.includes('isScriptContext?: boolean;') &&
  dtsContent.includes('compact?: boolean;') &&
  dtsContent.includes('indent?: string;') &&
  dtsContent.includes('indentLevel?: number;') &&
  dtsContent.includes('json?: boolean;') &&
  dtsContent.includes('lowercaseHex?: boolean;'),
  'Opts interface must declare isScriptContext, compact, indent, indentLevel, json, lowercaseHex'
);

// 6. Verify CommonJS export declaration
assert.ok(
  dtsContent.includes('export = jsesc;'),
  'CommonJS export = jsesc declaration must be present'
);

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