entities 6.0.1: encodeXML

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

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:18ed162f4dba90bd5410f4b41783a1caa8c3970f77cb88ba804be00aaf6a22a8","contract":["assert entities.encodeXML encodes special XML characters to predefined entities","assert entities.encodeXML leaves standard ASCII alphanumeric and punctuation unchanged","assert entities.encodeXML encodes non-ASCII characters to hexadecimal numeric character references","assert entities.encodeXML handles empty and string inputs correctly"],"goal":"verify entities.encodeXML in pkg:npm/entities@6.0.1","kind":"HOW","packages":["pkg:npm/entities@6.0.1"],"schemaVersion":1,"symbols":["entities.encodeXML"]},"contractCommand":["node","test/contract.mjs"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","language":"javascript","libc":"glibc","libcVersion":"2.39","moduleSystem":"cjs","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.encodeXML"],"verifierAdapter":"node-typescript@1"}

const entities = require('entities');

/**
 * Encodes XML special characters and non-ASCII characters into XML entities.
 *
 * @param {string} str - The input string to encode.
 * @returns {string} The XML-encoded string.
 */
function encodeXML(str) {
  return entities.encodeXML(str);
}

module.exports = {
  encodeXML,
  entities,
};

{
  "name": "sample-entities-encode-xml",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-entities-encode-xml",
      "version": "1.0.0",
      "license": "MIT-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-xml",
  "version": "1.0.0",
  "description": "Clean-room sample verifying entities.encodeXML in pkg:npm/entities@6.0.1",
  "main": "index.js",
  "license": "MIT-0",
  "dependencies": {
    "entities": "6.0.1"
  }
}

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

import assert from 'node:assert';
import * as entities from 'entities';
import { encodeXML } from '../index.js';

// 1. Assert entities.encodeXML encodes special XML characters to predefined entities
assert.strictEqual(
  encodeXML('<tag attr="val">&\'</tag>'),
  '&lt;tag attr=&quot;val&quot;&gt;&amp;&apos;&lt;/tag&gt;',
  'entities.encodeXML encodes special XML characters to predefined entities'
);
assert.strictEqual(
  entities.encodeXML('<>&"\''),
  '&lt;&gt;&amp;&quot;&apos;',
  'entities.encodeXML encodes all five predefined XML entities'
);

// 2. Assert entities.encodeXML leaves standard ASCII alphanumeric and punctuation unchanged
assert.strictEqual(
  encodeXML('Hello, World! 123 - / : ; = ? @ [ ] _ ` { | } ~'),
  'Hello, World! 123 - / : ; = ? @ [ ] _ ` { | } ~',
  'entities.encodeXML leaves standard ASCII alphanumeric and punctuation unchanged'
);

// 3. Assert entities.encodeXML encodes non-ASCII characters to hexadecimal numeric character references
assert.strictEqual(
  encodeXML('© 2026'),
  '&#xa9; 2026',
  'entities.encodeXML encodes non-ASCII characters to hexadecimal numeric character references'
);
assert.strictEqual(
  encodeXML('café'),
  'caf&#xe9;',
  'entities.encodeXML encodes accented characters'
);

// 4. Assert entities.encodeXML handles empty and string inputs correctly
assert.strictEqual(
  encodeXML(''),
  '',
  'entities.encodeXML handles empty string input correctly'
);
assert.strictEqual(
  encodeXML('plain text without entities'),
  'plain text without entities',
  'entities.encodeXML handles string inputs without entities correctly'
);

console.log('All contract assertions passed.');