entities 6.0.1: decode

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 entities.decode in pkg:npm/entities@6.0.1
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/entities@6.0.1
Demonstrate these symbols/APIs:
  - entities.decode

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:caab6a7d36b7e98375c706c0220bdb7c2b94872e5b966925b94834558a765d82","contract":["decode defaults to EntityLevel.XML decoding XML predefined and numeric entities while preserving HTML entities","decode with EntityLevel.HTML decodes named HTML entities, decimal numeric entities, and hex numeric entities","decode with DecodingOptions object supports level configuration (XML vs HTML)","decode with DecodingOptions supports mode configuration (Strict vs Legacy for trailing semicolons)"],"goal":"verify entities.decode in pkg:npm/entities@6.0.1","kind":"HOW","packages":["pkg:npm/entities@6.0.1"],"schemaVersion":1,"symbols":["entities.decode"]},"contractCommand":["node","test/contract.mjs"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","executionContext":"node","language":"javascript","libc":"glibc","libcVersion":"2.39","moduleSystem":"esm","os":"linux","osVersionBucket":"24","packageManager":"npm","packageManagerVersion":"10.9.8","runtime":"node","runtimeVersion":"22.23.2","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/entities@6.0.1"],"schemaVersion":1,"subject":"pkg:npm/entities@6.0.1","symbols":["entities.decode"],"verifierAdapter":"node-typescript@1"}

{
  "name": "sample-entities-decode",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-entities-decode",
      "version": "1.0.0",
      "dependencies": {
        "entities": "6.0.1"
      }
    },
    "node_modules/entities": {
      "version": "6.0.1",
      "resolved": "https://registry.npmjs.org/entities/-/entities-6.0.1.tgz",
      "integrity": "sha512-aN97NXWF6AWBTahfVOIrB/NShkzi5H7F9r1s9mD3cDj4Ko5f2qhhVoYMibXF7GlLveb/D2ioWay8lxI97Ven3g==",
      "license": "BSD-2-Clause",
      "engines": {
        "node": ">=0.12"
      },
      "funding": {
        "url": "https://github.com/fb55/entities?sponsor=1"
      }
    }
  }
}

{
  "name": "sample-entities-decode",
  "version": "1.0.0",
  "type": "module",
  "private": true,
  "dependencies": {
    "entities": "6.0.1"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify entities.decode in pkg:npm/entities@6.0.1",
  "kind": "HOW",
  "packages": [
    "pkg:npm/entities@6.0.1"
  ],
  "symbols": [
    "entities.decode"
  ]
}

import assert from 'node:assert/strict';
import { decode, EntityLevel, DecodingMode } from 'entities';

// 1. decode defaults to EntityLevel.XML decoding XML predefined and numeric entities while preserving HTML entities
assert.equal(decode('&lt;&gt;&amp;&quot;&apos;'), '<>&"\'');
assert.equal(decode('&#60;&#62;&#38;&#34;&#39;'), '<>&"\'');
assert.equal(decode('&#x3c;&#x3e;&#x26;&#x22;&#x27;'), '<>&"\'');
assert.equal(decode('&copy;&euro;&trade;'), '&copy;&euro;&trade;');

// 2. decode with EntityLevel.HTML decodes named HTML entities, decimal numeric entities, and hex numeric entities
assert.equal(decode('&copy;&euro;&trade;', EntityLevel.HTML), '©€™');
assert.equal(decode('&lt;&amp;&#x2603;&copy;', EntityLevel.HTML), '<&☃©');

// 3. decode with DecodingOptions object supports level configuration (XML vs HTML)
assert.equal(decode('&lt;&amp;&copy;', { level: EntityLevel.XML }), '<&&copy;');
assert.equal(decode('&lt;&amp;&copy;', { level: EntityLevel.HTML }), '<&©');

// 4. decode with DecodingOptions supports mode configuration (Strict vs Legacy for trailing semicolons)
assert.equal(decode('&amp text', { level: EntityLevel.HTML, mode: DecodingMode.Legacy }), '& text');
assert.equal(decode('&amp text', { level: EntityLevel.HTML, mode: DecodingMode.Strict }), '&amp text');

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