entities 6.0.1: encode

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

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:71970edd6c95dc56d615b7ef9b7ef62d213236e7d49e60b3c6074cf5438d415e","constraints":{"executionContext":"node"},"contract":["encode defaults to XML extensive encoding when called without options","encode accepts EntityLevel directly to switch between XML and HTML entity sets","encode supports EncodingMode.UTF8 to escape XML special characters while preserving UTF-8 content","encode supports EncodingMode.Attribute to escape characters required for HTML attribute values","encode supports EncodingMode.Text to escape characters required for HTML text content","encode supports EncodingMode.ASCII to convert non-ASCII characters to HTML entities while keeping ASCII text intact","encode supports EncodingMode.Extensive to thoroughly encode characters with entity equivalents","encode handles emojis and high code points across different encoding modes"],"goal":"verify entities.encode in pkg:npm/entities@6.0.1","kind":"HOW","packages":["pkg:npm/entities@6.0.1"],"schemaVersion":1,"symbols":["entities.encode"]},"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.encode"],"verifierAdapter":"node-typescript@1"}

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

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

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

// 1. encode defaults to XML extensive encoding when called without options
assert.equal(
  encode('foo & "bar" <baz> ü'),
  'foo &amp; &quot;bar&quot; &lt;baz&gt; &#xfc;'
);
assert.equal(
  encode('<root valid="true">&item</root>'),
  '&lt;root valid=&quot;true&quot;&gt;&amp;item&lt;/root&gt;'
);

// 2. encode accepts EntityLevel directly to switch between XML and HTML entity sets
assert.equal(
  encode('ü & < > \'', EntityLevel.HTML),
  '&uuml; &amp; &lt; &gt; &apos;'
);
assert.equal(
  encode('ü & < > \'', EntityLevel.XML),
  '&#xfc; &amp; &lt; &gt; &apos;'
);

// 3. encode supports EncodingMode.UTF8 to escape XML special characters while preserving UTF-8 content
assert.equal(
  encode('<div class="main">Hello 🌍 & "quote" \'single\'</div>', { mode: EncodingMode.UTF8 }),
  '&lt;div class=&quot;main&quot;&gt;Hello 🌍 &amp; &quot;quote&quot; &apos;single&apos;&lt;/div&gt;'
);

// 4. encode supports EncodingMode.Attribute to escape characters required for HTML attribute values
assert.equal(
  encode('value with "quotes" and & ampersand but <tag> and \'single\'', { mode: EncodingMode.Attribute }),
  'value with &quot;quotes&quot; and &amp; ampersand but <tag> and \'single\''
);

// 5. encode supports EncodingMode.Text to escape characters required for HTML text content
assert.equal(
  encode('text with <tag> & ampersand but "quotes" and \'single\'', { mode: EncodingMode.Text }),
  'text with &lt;tag&gt; &amp; ampersand but "quotes" and \'single\''
);

// 6. encode supports EncodingMode.ASCII to convert non-ASCII characters to HTML entities while keeping ASCII text intact
assert.equal(
  encode('<test> #123! übermaßen & ©</test>', { level: EntityLevel.HTML, mode: EncodingMode.ASCII }),
  '&lt;test&gt; #123! &uuml;berma&szlig;en &amp; &copy;&lt;/test&gt;'
);

// 7. encode supports EncodingMode.Extensive to thoroughly encode characters with entity equivalents
assert.equal(
  encode('<div>© 123</div>', { level: EntityLevel.HTML, mode: EncodingMode.Extensive }),
  '&lt;div&gt;&copy; 123&lt;&sol;div&gt;'
);

// 8. encode handles emojis and high code points across different encoding modes
assert.equal(
  encode('😄🍾🥳', { level: EntityLevel.HTML }),
  '&#x1f604;&#x1f37e;&#x1f973;'
);
assert.equal(
  encode('😄🍾🥳', { mode: EncodingMode.UTF8 }),
  '😄🍾🥳'
);

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