entities 6.0.1: DecodingMode

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

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:7337422564e6f1705c1473d981677f7ec372c8ae2ce0dd0fdbb7ef525eae553b","contract":["entities.DecodingMode defines Legacy (0), Strict (1), and Attribute (2) enum values","entities.decodeHTML with DecodingMode.Legacy decodes legacy entities without trailing semicolons","entities.decodeHTML with DecodingMode.Strict requires trailing semicolon and preserves unclosed entities","entities.decodeHTML with DecodingMode.Attribute preserves entities followed by equals sign in attribute contexts","entities.decode options mode accepts DecodingMode and configures entity decoding behavior"],"goal":"verify entities.DecodingMode in pkg:npm/entities@6.0.1","kind":"HOW","packages":["pkg:npm/entities@6.0.1"],"schemaVersion":1,"symbols":["entities.DecodingMode"]},"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","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.DecodingMode"],"verifierAdapter":"node-typescript@1"}

import { DecodingMode, decode, decodeHTML, EntityLevel } from 'entities';

export { DecodingMode, decode, decodeHTML, EntityLevel };

export function decodeWithMode(input, mode) {
  return decodeHTML(input, mode);
}

{
  "name": "sample-entities-decoding-mode",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-entities-decoding-mode",
      "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-decoding-mode",
  "version": "1.0.0",
  "description": "Demonstrate entities.DecodingMode usage and decoding semantics",
  "type": "module",
  "main": "index.mjs",
  "scripts": {
    "test": "node test/contract.mjs"
  },
  "license": "MIT-0",
  "dependencies": {
    "entities": "6.0.1"
  }
}

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

import assert from 'node:assert/strict';
import { DecodingMode, decode, decodeHTML, EntityLevel } from 'entities';
import { decodeWithMode } from '../index.mjs';

// 1. entities.DecodingMode defines Legacy (0), Strict (1), and Attribute (2) enum values
{
  assert.equal(DecodingMode.Legacy, 0);
  assert.equal(DecodingMode.Strict, 1);
  assert.equal(DecodingMode.Attribute, 2);

  assert.equal(DecodingMode[0], 'Legacy');
  assert.equal(DecodingMode[1], 'Strict');
  assert.equal(DecodingMode[2], 'Attribute');
}

// 2. entities.decodeHTML with DecodingMode.Legacy decodes legacy entities without trailing semicolons
{
  assert.equal(decodeHTML('&ampfoo', DecodingMode.Legacy), '&foo');
  assert.equal(decodeHTML('&copy2026', DecodingMode.Legacy), '©2026');
  assert.equal(decodeHTML('&quottest', DecodingMode.Legacy), '"test');
  assert.equal(decodeWithMode('&ampfoo', DecodingMode.Legacy), '&foo');
}

// 3. entities.decodeHTML with DecodingMode.Strict requires trailing semicolon and preserves unclosed entities
{
  assert.equal(decodeHTML('&ampfoo', DecodingMode.Strict), '&ampfoo');
  assert.equal(decodeHTML('&foo', DecodingMode.Strict), '&foo');
  assert.equal(decodeHTML('&copy2026', DecodingMode.Strict), '&copy2026');
  assert.equal(decodeHTML('©2026', DecodingMode.Strict), '©2026');
  assert.equal(decodeWithMode('&ampfoo', DecodingMode.Strict), '&ampfoo');
  assert.equal(decodeWithMode('&foo', DecodingMode.Strict), '&foo');
}

// 4. entities.decodeHTML with DecodingMode.Attribute preserves entities followed by equals sign in attribute contexts
{
  assert.equal(decodeHTML('?a=1&not=2', DecodingMode.Attribute), '?a=1&not=2');
  assert.equal(decodeHTML('?a=1&not=2', DecodingMode.Legacy), '?a=1¬=2');
  assert.equal(decodeHTML('?a=1¬=2', DecodingMode.Attribute), '?a=1¬=2');
  assert.equal(decodeWithMode('?a=1&not=2', DecodingMode.Attribute), '?a=1&not=2');
}

// 5. entities.decode options mode accepts DecodingMode and configures entity decoding behavior
{
  assert.equal(decode('&ampfoo', { mode: DecodingMode.Strict, level: EntityLevel.HTML }), '&ampfoo');
  assert.equal(decode('&foo', { mode: DecodingMode.Strict, level: EntityLevel.HTML }), '&foo');
  assert.equal(decode('&ampfoo', { mode: DecodingMode.Legacy, level: EntityLevel.HTML }), '&foo');
}

console.log('All entities.DecodingMode contract tests passed successfully.');