entities 6.0.1: EntityLevel

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.EntityLevel 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.EntityLevel

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:66decfe8f252d227276d5711f151520670a7436bb4694bef447a1d53a06323dd","constraints":{"executionContext":"node"},"contract":["EntityLevel enum defines XML (0) and HTML (1) levels with bidirectional mappings","decode with EntityLevel.XML decodes XML entities and numeric references but preserves HTML-only named entities","decode with EntityLevel.HTML decodes both XML entities and HTML named entities","decode and decodeStrict accept EntityLevel as numeric shorthand or options object","encode with EntityLevel.XML encodes characters outside XML as numeric hex entities","encode with EntityLevel.HTML encodes characters with HTML named entities","encode accepts EntityLevel directly or combined with EncodingMode options"],"goal":"verify entities.EntityLevel in pkg:npm/entities@6.0.1","kind":"HOW","packages":["pkg:npm/entities@6.0.1"],"schemaVersion":1,"symbols":["entities.EntityLevel"]},"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.EntityLevel"],"verifierAdapter":"node-typescript@1"}

{
  "name": "sample-entities-entitylevel",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-entities-entitylevel",
      "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-entitylevel",
  "version": "1.0.0",
  "type": "module",
  "private": true,
  "dependencies": {
    "entities": "6.0.1"
  }
}

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

import assert from 'node:assert/strict';
import {
  decode,
  decodeStrict,
  encode,
  EntityLevel,
  EncodingMode
} from 'entities';

// 1. EntityLevel enum defines XML (0) and HTML (1) levels with bidirectional mappings
assert.equal(EntityLevel.XML, 0);
assert.equal(EntityLevel.HTML, 1);
assert.equal(EntityLevel[0], 'XML');
assert.equal(EntityLevel[1], 'HTML');

// 2. decode with EntityLevel.XML decodes XML entities and numeric references but preserves HTML-only named entities
assert.equal(
  decode('& < > " '', { level: EntityLevel.XML }),
  '& < > " \''
);
assert.equal(
  decode('&#169; &#xA9;', { level: EntityLevel.XML }),
  '© ©'
);
assert.equal(
  decode('&copy; &euro; &trade;', { level: EntityLevel.XML }),
  '&copy; &euro; &trade;'
);

// 3. decode with EntityLevel.HTML decodes both XML entities and HTML named entities
assert.equal(
  decode('&copy; &euro; &trade; &amp; &quot;', { level: EntityLevel.HTML }),
  '© € ™ & "'
);

// 4. decode and decodeStrict accept EntityLevel as numeric shorthand or options object
assert.equal(decode('&copy;', EntityLevel.XML), '&copy;');
assert.equal(decode('&copy;', EntityLevel.HTML), '©');
assert.equal(decode('&copy;', { level: EntityLevel.XML }), '&copy;');
assert.equal(decode('&copy;', { level: EntityLevel.HTML }), '©');
assert.equal(decodeStrict('&copy;', EntityLevel.XML), '&copy;');
assert.equal(decodeStrict('&copy;', EntityLevel.HTML), '©');

// 5. encode with EntityLevel.XML encodes characters outside XML as numeric hex entities
assert.equal(
  encode('© & < > " \'', { level: EntityLevel.XML }),
  '&#xa9; &amp; &lt; &gt; &quot; &apos;'
);

// 6. encode with EntityLevel.HTML encodes characters with HTML named entities
assert.equal(
  encode('© & < > " \'', { level: EntityLevel.HTML }),
  '&copy; &amp; &lt; &gt; &quot; &apos;'
);

// 7. encode accepts EntityLevel directly or combined with EncodingMode options
assert.equal(encode('©', EntityLevel.XML), '&#xa9;');
assert.equal(encode('©', EntityLevel.HTML), '&copy;');
assert.equal(
  encode('©', { level: EntityLevel.HTML, mode: EncodingMode.ASCII }),
  '&copy;'
);
assert.equal(
  encode('©', { level: EntityLevel.XML, mode: EncodingMode.ASCII }),
  '&#xa9;'
);

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