plist 3.1.0: parse

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 plist.parse in pkg:npm/plist@3.1.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/plist@3.1.0
Demonstrate these symbols/APIs:
  - plist.parse

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:ac92aff254e50a6d373adb2be2ddc12810f45febcba607c35e76ae14ffe5f758","contract":["parse parses dictionary with primitive types (string, integer, real, boolean)","parse parses nested dictionaries and arrays","parse decodes base64 data nodes to Buffer and date nodes to Date instances","parse returns empty array for empty plist tag and empty object for empty dict","parse throws Error on malformed xml missing plist root element","parse throws Error on __proto__ keys to prevent prototype pollution"],"goal":"verify plist.parse in pkg:npm/plist@3.1.0","kind":"HOW","packages":["pkg:npm/plist@3.1.0"],"schemaVersion":1,"symbols":["plist.parse"]},"contractCommand":["node","test/contract.cjs"],"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/plist@3.1.0"],"schemaVersion":1,"subject":"pkg:npm/plist@3.1.0","symbols":["plist.parse"],"verifierAdapter":"node-typescript@1"}

const plist = require('plist');

/**
 * Parses a Plist XML string into JavaScript data structures.
 * @param {string} xml - The XML string to decode.
 * @returns {any} The decoded value from the Plist XML.
 */
function parsePlist(xml) {
  return plist.parse(xml);
}

module.exports = {
  parsePlist,
};

{
  "name": "sample-plist-parse",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-plist-parse",
      "version": "1.0.0",
      "dependencies": {
        "plist": "3.1.0"
      }
    },
    "node_modules/@xmldom/xmldom": {
      "version": "0.8.15",
      "resolved": "https://registry.npmjs.org/@xmldom/xmldom/-/xmldom-0.8.15.tgz",
      "integrity": "sha512-/5NV/vDALVFDXgLmfsy9TRCBlKwO2LNBFzpzvb9iIj+jR+eSc6DLYYvVOdivT/jm7MtU6TebYuRmzEOI7w40UA==",
      "license": "MIT",
      "engines": {
        "node": ">=10.0.0"
      }
    },
    "node_modules/base64-js": {
      "version": "1.5.1",
      "resolved": "https://registry.npmjs.org/base64-js/-/base64-js-1.5.1.tgz",
      "integrity": "sha512-AKpaYlHn8t4SVbOHCy+b5+KKgvR4vrsD8vbvrbiQJps7fKDTkjkDry6ji0rUJjC0kzbNePLwzxq8iypo41qeWA==",
      "funding": [
        {
          "type": "github",
          "url": "https://github.com/sponsors/feross"
        },
        {
          "type": "patreon",
          "url": "https://www.patreon.com/feross"
        },
        {
          "type": "consulting",
          "url": "https://feross.org/support"
        }
      ],
      "license": "MIT"
    },
    "node_modules/plist": {
      "version": "3.1.0",
      "resolved": "https://registry.npmjs.org/plist/-/plist-3.1.0.tgz",
      "integrity": "sha512-uysumyrvkUX0rX/dEVqt8gC3sTBzd4zoWfLeS29nb53imdaXVvLINYXTI2GNqzaMuvacNx4uJQ8+b3zXR0pkgQ==",
      "license": "MIT",
      "dependencies": {
        "@xmldom/xmldom": "^0.8.8",
        "base64-js": "^1.5.1",
        "xmlbuilder": "^15.1.1"
      },
      "engines": {
        "node": ">=10.4.0"
      }
    },
    "node_modules/xmlbuilder": {
      "version": "15.1.1",
      "resolved": "https://registry.npmjs.org/xmlbuilder/-/xmlbuilder-15.1.1.tgz",
      "integrity": "sha512-yMqGBqtXyeN1e3TGYvgNgDVZ3j84W4cwkOXQswghol6APgZWaff9lnbvN7MHYJOiXsvGPXtjTYJEiC9J2wv9Eg==",
      "license": "MIT",
      "engines": {
        "node": ">=8.0"
      }
    }
  }
}

{
  "name": "sample-plist-parse",
  "version": "1.0.0",
  "private": true,
  "description": "Verify plist.parse in pkg:npm/plist@3.1.0",
  "main": "index.js",
  "scripts": {
    "test": "node test/contract.cjs"
  },
  "dependencies": {
    "plist": "3.1.0"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify plist.parse in pkg:npm/plist@3.1.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/plist@3.1.0"
  ],
  "symbols": [
    "plist.parse"
  ]
}

const assert = require('node:assert');
const { parsePlist } = require('../index.js');

// 1. parse parses dictionary with primitive types (string, integer, real, boolean)
{
  const xml = `<?xml version="1.0" encoding="UTF-8"?>
<plist version="1.0">
<dict>
  <key>appName</key>
  <string>CodeSampleX</string>
  <key>count</key>
  <integer>42</integer>
  <key>score</key>
  <real>99.5</real>
  <key>isActive</key>
  <true/>
  <key>isArchived</key>
  <false/>
</dict>
</plist>`;
  const result = parsePlist(xml);
  assert.strictEqual(result.appName, 'CodeSampleX');
  assert.strictEqual(result.count, 42);
  assert.strictEqual(result.score, 99.5);
  assert.strictEqual(result.isActive, true);
  assert.strictEqual(result.isArchived, false);
}

// 2. parse parses nested dictionaries and arrays
{
  const xml = `<?xml version="1.0" encoding="UTF-8"?>
<plist version="1.0">
<dict>
  <key>metadata</key>
  <dict>
    <key>tags</key>
    <array>
      <string>alpha</string>
      <string>beta</string>
    </array>
  </dict>
</dict>
</plist>`;
  const result = parsePlist(xml);
  assert.deepStrictEqual(result.metadata.tags, ['alpha', 'beta']);
}

// 3. parse decodes base64 data nodes to Buffer and date nodes to Date instances
{
  const xml = `<?xml version="1.0" encoding="UTF-8"?>
<plist version="1.0">
<dict>
  <key>payload</key>
  <data>SGVsbG8gV29ybGQ=</data>
  <key>timestamp</key>
  <date>2026-08-26T12:00:00Z</date>
</dict>
</plist>`;
  const result = parsePlist(xml);
  assert(Buffer.isBuffer(result.payload));
  assert.strictEqual(result.payload.toString('utf8'), 'Hello World');
  assert(result.timestamp instanceof Date);
  assert.strictEqual(result.timestamp.toISOString(), '2026-08-26T12:00:00.000Z');
}

// 4. parse returns empty array for empty plist tag and empty object for empty dict
{
  const emptyPlistXml = `<?xml version="1.0" encoding="UTF-8"?>
<plist version="1.0"></plist>`;
  const emptyDictXml = `<?xml version="1.0" encoding="UTF-8"?>
<plist version="1.0">
<dict></dict>
</plist>`;
  assert.deepStrictEqual(parsePlist(emptyPlistXml), []);
  assert.deepStrictEqual(parsePlist(emptyDictXml), {});
}

// 5. parse throws Error on malformed xml missing plist root element
{
  assert.throws(
    () => parsePlist('<root><key>test</key></root>'),
    /malformed document/
  );
}

// 6. parse throws Error on __proto__ keys to prevent prototype pollution
{
  const maliciousXml = `<?xml version="1.0" encoding="UTF-8"?>
<plist version="1.0">
<dict>
  <key>__proto__</key>
  <string>polluted</string>
</dict>
</plist>`;
  assert.throws(
    () => parsePlist(maliciousXml),
    /__proto__ keys can lead to prototype pollution/
  );
}