entities 7.0.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/entities@7.0.1
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/entities@7.0.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:103ee92a5f544f500ffa8c747a38a2908f14964c87c117c620b02091e02acd76","constraints":{"executionContext":"node"},"contract":["decodeHTML decodes named HTML entities, decimal numeric entities, and hex numeric entities into characters","decodeHTMLStrict decodes valid entities and leaves unclosed or unrecognized entities unchanged","decodeHTMLAttribute decodes HTML entities in attribute context","decodeXML and encodeXML convert between XML special characters and predefined XML entities","escapeUTF8 escapes XML special characters (\u003c, \u003e, \u0026, \", ') preserving valid UTF-8 characters","escapeAttribute and escapeText selectively escape characters for HTML attribute and text contexts","encodeHTML and encodeNonAsciiHTML encode HTML special and non-ASCII characters to HTML entities","decode and encode support custom EntityLevel and EncodingMode/DecodingMode configurations"],"goal":"verify pkg:npm/entities@7.0.1","kind":"HOW","packages":["pkg:npm/entities@7.0.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":"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@7.0.1"],"schemaVersion":1,"subject":"pkg:npm/entities@7.0.1","verifierAdapter":"node-typescript@1"}

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

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

{
  "schemaVersion": 1,
  "goal": "verify pkg:npm/entities@7.0.1",
  "kind": "HOW",
  "packages": [
    "pkg:npm/entities@7.0.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 {
  decodeHTML,
  decodeHTMLStrict,
  decodeHTMLAttribute,
  decodeXML,
  encodeXML,
  encodeHTML,
  encodeNonAsciiHTML,
  escapeUTF8,
  escapeAttribute,
  escapeText,
  decode,
  encode,
  EntityLevel,
  EncodingMode,
  DecodingMode
} from 'entities';

// 1. decodeHTML decodes named HTML entities, decimal numeric entities, and hex numeric entities into characters
assert.equal(
  decodeHTML('© & < > " ' ☃'),
  '© & < > " \' ☃'
);
assert.equal(
  decodeHTML('&AElig; &thorn; &euro;'),
  'Æ þ €'
);

// 2. decodeHTMLStrict decodes valid entities and leaves unclosed or unrecognized entities unchanged
assert.equal(
  decodeHTMLStrict('&copy; &amp; &notanentity; &amp'),
  '© & &notanentity; &amp'
);

// 3. decodeHTMLAttribute decodes HTML entities in attribute context
assert.equal(
  decodeHTMLAttribute('&quot;test&quot; &amp; &lt;tag&gt;'),
  '"test" & <tag>'
);

// 4. decodeXML and encodeXML convert between XML special characters and predefined XML entities
const rawXml = '<root id="1" valid="true">&test</root>';
const encodedXml = encodeXML(rawXml);
assert.equal(
  encodedXml,
  '&lt;root id=&quot;1&quot; valid=&quot;true&quot;&gt;&amp;test&lt;/root&gt;'
);
assert.equal(decodeXML(encodedXml), rawXml);

// 5. escapeUTF8 escapes XML special characters (<, >, &, ", ') preserving valid UTF-8 characters
assert.equal(
  escapeUTF8('<div class="box">&copy; \'item\'</div>'),
  '&lt;div class=&quot;box&quot;&gt;&amp;copy; &apos;item&apos;&lt;/div&gt;'
);

// 6. escapeAttribute and escapeText selectively escape characters for HTML attribute and text contexts
assert.equal(
  escapeAttribute('value with "quotes" and & ampersand but <tag> and \'single\''),
  'value with &quot;quotes&quot; and &amp; ampersand but <tag> and \'single\''
);
assert.equal(
  escapeText('text with <tag> & ampersand but "quotes" and \'single\''),
  'text with &lt;tag&gt; &amp; ampersand but "quotes" and \'single\''
);

// 7. encodeHTML and encodeNonAsciiHTML encode HTML special and non-ASCII characters to HTML entities
assert.equal(
  encodeNonAsciiHTML('<tag>&©'),
  '&lt;tag&gt;&amp;&copy;'
);
assert.equal(
  encodeHTML('<tag>'),
  '&lt;tag&gt;'
);

// 8. decode and encode support custom EntityLevel and EncodingMode/DecodingMode configurations
assert.equal(
  decode('&lt;&amp;&copy;', { level: EntityLevel.XML }),
  '<&&copy;'
);
assert.equal(
  decode('&lt;&amp;&copy;', { level: EntityLevel.HTML, mode: DecodingMode.Strict }),
  '<&©'
);
assert.equal(
  encode('<tag>', { level: EntityLevel.XML, mode: EncodingMode.UTF8 }),
  '&lt;tag&gt;'
);

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