plist 3.1.0 → 4.0.0

package/README.md

@@ -20,33 +20,44 @@ and vice-versa.
 Install using `npm`:
 
 ``` bash
-$ npm install --save plist
+$ npm install plist
 ```
 
-Then `require()` the _plist_ module in your file:
+Then import the `parse()` and `build()` functions:
 
 ``` js
-var plist = require('plist');
+import { parse, build } from 'plist';
 
-// now use the `parse()` and `build()` functions
-var val = plist.parse('<plist><string>Hello World!</string></plist>');
+const val = parse('<plist><string>Hello World!</string></plist>');
 console.log(val);  // "Hello World!"
 ```
 
 
 ### Browser
 
-Include the `dist/plist.js` in a `<script>` tag in your HTML file:
+Use an [import map](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script/type/importmap)
+to resolve the bare module specifiers used by plist and its dependencies,
+then import directly from the source:
 
 ``` html
-<script src="plist.js"></script>
-<script>
-  // now use the `parse()` and `build()` functions
-  var val = plist.parse('<plist><string>Hello World!</string></plist>');
+<script type="importmap">
+  {
+    "imports": {
+      "@xmldom/xmldom": "https://esm.sh/@xmldom/xmldom",
+      "xmlbuilder": "https://esm.sh/xmlbuilder"
+    }
+  }
+</script>
+<script type="module">
+  import { parse, build } from './node_modules/plist/index.js';
+
+  const val = parse('<plist><string>Hello World!</string></plist>');
   console.log(val);  // "Hello World!"
 </script>
 ```
 
+See the [browser example](./examples/browser/) for a drag-and-drop demo.
+
 
 ## API
 
@@ -54,20 +65,20 @@ Include the `dist/plist.js` in a `<script>` tag in your HTML file:
 
 Parsing a plist from filename:
 
-``` javascript
-var fs = require('fs');
-var plist = require('plist');
+``` js
+import { readFileSync } from 'node:fs';
+import { parse } from 'plist';
 
-var obj = plist.parse(fs.readFileSync('myPlist.plist', 'utf8'));
+const obj = parse(readFileSync('myPlist.plist', 'utf8'));
 console.log(JSON.stringify(obj));
 ```
 
 Parsing a plist from string payload:
 
-``` javascript
-var plist = require('plist');
+``` js
+import { parse } from 'plist';
 
-var xml =
+const xml =
   '<?xml version="1.0" encoding="UTF-8"?>' +
   '<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">' +
   '<plist version="1.0">' +
@@ -84,7 +95,7 @@ var xml =
     '</dict>' +
   '</plist>';
 
-console.log(plist.parse(xml));
+console.log(parse(xml));
 
 // [
 //   "metadata",
@@ -102,10 +113,10 @@ console.log(plist.parse(xml));
 Given an existing JavaScript Object, you can turn it into an XML document
 that complies with the plist DTD:
 
-``` javascript
-var plist = require('plist');
+``` js
+import { build } from 'plist';
 
-var json = [
+const obj = [
   "metadata",
   {
     "bundle-identifier": "com.company.app",
@@ -115,7 +126,7 @@ var json = [
   }
 ];
 
-console.log(plist.build(json));
+console.log(build(obj));
 
 // <?xml version="1.0" encoding="UTF-8"?>
 // <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
@@ -134,12 +145,6 @@ console.log(plist.build(json));
 // </plist>
 ```
 
-## Cross Platform Testing Credits
-
-Much thanks to Sauce Labs for providing free resources that enable cross-browser testing on this project!
-
-[![Testing Powered By SauceLabs](https://opensource.saucelabs.com/images/opensauce/powered-by-saucelabs-badge-red.png?sanitize=true "Testing Powered By SauceLabs")](https://saucelabs.com)
-
 
 ## License
 

package/index.js

@@ -1,13 +1,2 @@
-/**
- * Parser functions.
- */
-
-var parserFunctions = require('./lib/parse');
-Object.keys(parserFunctions).forEach(function (k) { exports[k] = parserFunctions[k]; });
-
-/**
- * Builder functions.
- */
-
-var builderFunctions = require('./lib/build');
-Object.keys(builderFunctions).forEach(function (k) { exports[k] = builderFunctions[k]; });
+export { parse } from './lib/parse.js';
+export { build } from './lib/build.js';

package/lib/build.js

@@ -1,15 +1,20 @@
-/**
- * Module dependencies.
- */
-
-var base64 = require('base64-js');
-var xmlbuilder = require('xmlbuilder');
+import xmlbuilder from 'xmlbuilder';
 
 /**
- * Module exports.
+ * Encode a Uint8Array into a base64 string.
+ *
+ * @param {Uint8Array} bytes
+ * @returns {String} base64 encoded string
+ * @api private
  */
 
-exports.build = build;
+function uint8ArrayToBase64(bytes) {
+  let binary = '';
+  for (let i = 0; i < bytes.length; i++) {
+    binary += String.fromCharCode(bytes[i]);
+  }
+  return btoa(binary);
+}
 
 /**
  * Accepts a `Date` instance and returns an ISO date string.
@@ -40,9 +45,9 @@ function ISODateString(d){
  * @api private
  */
 
-var toString = Object.prototype.toString;
+const toString = Object.prototype.toString;
 function type (obj) {
-  var m = toString.call(obj).match(/\[object (.*)\]/);
+  const m = toString.call(obj).match(/\[object (.*)\]/);
   return m ? m[1] : m;
 }
 
@@ -55,18 +60,18 @@ function type (obj) {
  * @api public
  */
 
-function build (obj, opts) {
-  var XMLHDR = {
+export function build (obj, opts) {
+  const XMLHDR = {
     version: '1.0',
     encoding: 'UTF-8'
   };
 
-  var XMLDTD = {
+  const XMLDTD = {
     pubid: '-//Apple//DTD PLIST 1.0//EN',
     sysid: 'http://www.apple.com/DTDs/PropertyList-1.0.dtd'
   };
 
-  var doc = xmlbuilder.create('plist');
+  const doc = xmlbuilder.create('plist');
 
   doc.dec(XMLHDR.version, XMLHDR.encoding, XMLHDR.standalone);
   doc.dtd(XMLDTD.pubid, XMLDTD.sysid);
@@ -88,23 +93,29 @@ function build (obj, opts) {
  */
 
 function walk_obj(next, next_child) {
-  var tag_type, i, prop;
-  var name = type(next);
+  const name = type(next);
 
   if ('Undefined' == name) {
     return;
   } else if (Array.isArray(next)) {
     next_child = next_child.ele('array');
-    for (i = 0; i < next.length; i++) {
+    for (let i = 0; i < next.length; i++) {
       walk_obj(next[i], next_child);
     }
 
-  } else if (Buffer.isBuffer(next)) {
-    next_child.ele('data').raw(next.toString('base64'));
+  } else if (next instanceof ArrayBuffer) {
+    next_child.ele('data').raw(uint8ArrayToBase64(new Uint8Array(next)));
+
+  } else if (ArrayBuffer.isView(next)) {
+    // Handles Uint8Array, Buffer, and all typed arrays
+    const bytes = next instanceof Uint8Array
+      ? next
+      : new Uint8Array(next.buffer, next.byteOffset, next.byteLength);
+    next_child.ele('data').raw(uint8ArrayToBase64(bytes));
 
   } else if ('Object' == name) {
     next_child = next_child.ele('dict');
-    for (prop in next) {
+    for (const prop in next) {
       if (next.hasOwnProperty(prop)) {
         next_child.ele('key').txt(prop);
         walk_obj(next[prop], next_child);
@@ -114,7 +125,7 @@ function walk_obj(next, next_child) {
   } else if ('Number' == name) {
     // detect if this is an integer or real
     // TODO: add an ability to force one way or another via a "cast"
-    tag_type = (next % 1 === 0) ? 'integer' : 'real';
+    const tag_type = (next % 1 === 0) ? 'integer' : 'real';
     next_child.ele(tag_type).txt(next.toString());
 
   } else if ('BigInt' == name) {
@@ -129,13 +140,6 @@ function walk_obj(next, next_child) {
   } else if ('String' == name) {
     next_child.ele('string').txt(next);
 
-  } else if ('ArrayBuffer' == name) {
-    next_child.ele('data').raw(base64.fromByteArray(next));
-
-  } else if (next && next.buffer && 'ArrayBuffer' == type(next.buffer)) {
-    // a typed array
-    next_child.ele('data').raw(base64.fromByteArray(new Uint8Array(next.buffer), next_child));
-
   } else if ('Null' === name) {
     next_child.ele('null').txt('');
 

package/lib/parse.js

@@ -1,19 +1,25 @@
-/**
- * Module dependencies.
- */
-
-const { DOMParser } = require('@xmldom/xmldom');
+import { DOMParser } from '@xmldom/xmldom';
 
 /**
- * Module exports.
+ * Decode a base64 string into a Uint8Array.
+ *
+ * @param {String} base64 - base64 encoded string
+ * @returns {Uint8Array}
+ * @api private
  */
 
-exports.parse = parse;
-
-var TEXT_NODE = 3;
-var CDATA_NODE = 4;
-var COMMENT_NODE = 8;
+function base64ToUint8Array(base64) {
+  const binary = atob(base64);
+  const bytes = new Uint8Array(binary.length);
+  for (let i = 0; i < binary.length; i++) {
+    bytes[i] = binary.charCodeAt(i);
+  }
+  return bytes;
+}
 
+const TEXT_NODE = 3;
+const CDATA_NODE = 4;
+const COMMENT_NODE = 8;
 
 /**
  * We ignore raw text (usually whitespace), <!-- xml comments -->,
@@ -24,10 +30,12 @@ var COMMENT_NODE = 8;
  * @api private
  */
 
-function shouldIgnoreNode (node) {
-  return node.nodeType === TEXT_NODE
-    || node.nodeType === COMMENT_NODE
-    || node.nodeType === CDATA_NODE;
+function shouldIgnoreNode(node) {
+  return (
+    node.nodeType === TEXT_NODE ||
+    node.nodeType === COMMENT_NODE ||
+    node.nodeType === CDATA_NODE
+  );
 }
 
 /**
@@ -40,8 +48,8 @@ function shouldIgnoreNode (node) {
  * @returns {Boolean}
  * @api private
  */
-function isEmptyNode(node){
-  if(!node.childNodes || node.childNodes.length === 0) {
+function isEmptyNode(node) {
+  if (!node.childNodes || node.childNodes.length === 0) {
     return true;
   } else {
     return false;
@@ -62,13 +70,13 @@ function invariant(test, message) {
  * @api public
  */
 
-function parse (xml) {
-  var doc = new DOMParser().parseFromString(xml);
+export function parse(xml) {
+  const doc = new DOMParser().parseFromString(xml, "text/xml");
   invariant(
-    doc.documentElement.nodeName === 'plist',
-    'malformed document. First element should be <plist>'
+    doc.documentElement.nodeName === "plist",
+    "malformed document. First element should be <plist>",
   );
-  var plist = parsePlistXML(doc.documentElement);
+  let plist = parsePlistXML(doc.documentElement);
 
   // the root <plist> node gets interpreted as an Array,
   // so pull out the inner data first
@@ -85,143 +93,121 @@ function parse (xml) {
  * @api private
  */
 
-function parsePlistXML (node) {
-  var i, new_obj, key, val, new_arr, res, counter, type;
-
-  if (!node)
-    return null;
+function parsePlistXML(node) {
+  if (!node) return null;
 
-  if (node.nodeName === 'plist') {
-    new_arr = [];
+  if (node.nodeName === "plist") {
+    const new_arr = [];
     if (isEmptyNode(node)) {
       return new_arr;
     }
-    for (i=0; i < node.childNodes.length; i++) {
+    for (let i = 0; i < node.childNodes.length; i++) {
       if (!shouldIgnoreNode(node.childNodes[i])) {
-        new_arr.push( parsePlistXML(node.childNodes[i]));
+        new_arr.push(parsePlistXML(node.childNodes[i]));
       }
     }
     return new_arr;
-  } else if (node.nodeName === 'dict') {
-    new_obj = {};
-    key = null;
-    counter = 0;
+  } else if (node.nodeName === "dict") {
+    const new_obj = {};
+    let key = null;
+    let counter = 0;
     if (isEmptyNode(node)) {
       return new_obj;
     }
-    for (i=0; i < node.childNodes.length; i++) {
+    for (let i = 0; i < node.childNodes.length; i++) {
       if (shouldIgnoreNode(node.childNodes[i])) continue;
       if (counter % 2 === 0) {
         invariant(
-          node.childNodes[i].nodeName === 'key',
-          'Missing key while parsing <dict/>.'
+          node.childNodes[i].nodeName === "key",
+          "Missing key while parsing <dict/>.",
         );
         key = parsePlistXML(node.childNodes[i]);
       } else {
         invariant(
-          node.childNodes[i].nodeName !== 'key',
-          'Unexpected key "'
-            + parsePlistXML(node.childNodes[i])
-            + '" while parsing <dict/>.'
+          node.childNodes[i].nodeName !== "key",
+          'Unexpected key "' +
+            parsePlistXML(node.childNodes[i]) +
+            '" while parsing <dict/>.',
         );
         new_obj[key] = parsePlistXML(node.childNodes[i]);
       }
       counter += 1;
     }
     if (counter % 2 === 1) {
-      new_obj[key] = '';
+      new_obj[key] = "";
     }
-    
-    return new_obj;
 
-  } else if (node.nodeName === 'array') {
-    new_arr = [];
+    return new_obj;
+  } else if (node.nodeName === "array") {
+    const new_arr = [];
     if (isEmptyNode(node)) {
       return new_arr;
     }
-    for (i=0; i < node.childNodes.length; i++) {
+    for (let i = 0; i < node.childNodes.length; i++) {
       if (!shouldIgnoreNode(node.childNodes[i])) {
-        res = parsePlistXML(node.childNodes[i]);
+        const res = parsePlistXML(node.childNodes[i]);
         if (null != res) new_arr.push(res);
       }
     }
     return new_arr;
-
-  } else if (node.nodeName === '#text') {
+  } else if (node.nodeName === "#text") {
     // TODO: what should we do with text types? (CDATA sections)
-
-  } else if (node.nodeName === 'key') {
+  } else if (node.nodeName === "key") {
     if (isEmptyNode(node)) {
-      return '';
+      return "";
     }
 
     invariant(
-      node.childNodes[0].nodeValue !== '__proto__',
-      '__proto__ keys can lead to prototype pollution. More details on CVE-2022-22912'
+      node.childNodes[0].nodeValue !== "__proto__",
+      "__proto__ keys can lead to prototype pollution. More details on CVE-2022-22912",
     );
 
     return node.childNodes[0].nodeValue;
-  } else if (node.nodeName === 'string') {
-    res = '';
+  } else if (node.nodeName === "string") {
+    let res = "";
     if (isEmptyNode(node)) {
       return res;
     }
-    for (i=0; i < node.childNodes.length; i++) {
-      var type = node.childNodes[i].nodeType;
+    for (let i = 0; i < node.childNodes.length; i++) {
+      const type = node.childNodes[i].nodeType;
       if (type === TEXT_NODE || type === CDATA_NODE) {
         res += node.childNodes[i].nodeValue;
       }
     }
     return res;
-
-  } else if (node.nodeName === 'integer') {
-    invariant(
-      !isEmptyNode(node),
-      'Cannot parse "" as integer.'
-    );
+  } else if (node.nodeName === "integer") {
+    invariant(!isEmptyNode(node), 'Cannot parse "" as integer.');
     return parseInt(node.childNodes[0].nodeValue, 10);
-
-  } else if (node.nodeName === 'real') {
-    invariant(
-      !isEmptyNode(node),
-      'Cannot parse "" as real.'
-    );
-    res = '';
-    for (i=0; i < node.childNodes.length; i++) {
+  } else if (node.nodeName === "real") {
+    invariant(!isEmptyNode(node), 'Cannot parse "" as real.');
+    let res = "";
+    for (let i = 0; i < node.childNodes.length; i++) {
       if (node.childNodes[i].nodeType === TEXT_NODE) {
         res += node.childNodes[i].nodeValue;
       }
     }
     return parseFloat(res);
-
-  } else if (node.nodeName === 'data') {
-    res = '';
+  } else if (node.nodeName === "data") {
+    let res = "";
     if (isEmptyNode(node)) {
-      return Buffer.from(res, 'base64');
+      return base64ToUint8Array(res);
     }
-    for (i=0; i < node.childNodes.length; i++) {
+    for (let i = 0; i < node.childNodes.length; i++) {
       if (node.childNodes[i].nodeType === TEXT_NODE) {
-        res += node.childNodes[i].nodeValue.replace(/\s+/g, '');
+        res += node.childNodes[i].nodeValue.replace(/\s+/g, "");
       }
     }
-    return Buffer.from(res, 'base64');
-
-  } else if (node.nodeName === 'date') {
-    invariant(
-      !isEmptyNode(node),
-      'Cannot parse "" as Date.'
-    )
+    return base64ToUint8Array(res);
+  } else if (node.nodeName === "date") {
+    invariant(!isEmptyNode(node), 'Cannot parse "" as Date.');
     return new Date(node.childNodes[0].nodeValue);
-
-  } else if (node.nodeName === 'null') {
+  } else if (node.nodeName === "null") {
     return null;
-
-  } else if (node.nodeName === 'true') {
+  } else if (node.nodeName === "true") {
     return true;
-
-  } else if (node.nodeName === 'false') {
+  } else if (node.nodeName === "false") {
     return false;
   } else {
-    throw new Error('Invalid PLIST tag ' + node.nodeName);
+    throw new Error("Invalid PLIST tag " + node.nodeName);
   }
 }

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "plist",
   "description": "Apple's property list parser/builder for Node.js and browsers",
-  "version": "3.1.0",
+  "version": "4.0.0",
+  "type": "module",
   "author": "Nathan Rajlich <nathan@tootallnate.net>",
   "contributors": [
     "Hans Huebner <hans.huebner@gmail.com>",
@@ -23,22 +24,19 @@
     "parser",
     "xml"
   ],
-  "main": "index.js",
+  "exports": "./index.js",
+  "files": [
+    "index.js",
+    "lib"
+  ],
   "dependencies": {
-    "@xmldom/xmldom": "^0.8.8",
-    "base64-js": "^1.5.1",
+    "@xmldom/xmldom": "^0.9.10",
     "xmlbuilder": "^15.1.1"
   },
-  "devDependencies": {
-    "browserify": "^17.0.0",
-    "mocha": "^9.2.2",
-    "multiline": "^2.0.0",
-    "zuul": "3.12.0"
-  },
   "scripts": {
-    "test": "make test"
+    "test": "node --test test/*.js"
   },
   "engines": {
-    "node": ">=10.4.0"
+    "node": ">=18"
   }
 }

package/.github/workflows/ci.yml

@@ -1,24 +0,0 @@
-name: ci
-
-on:
-  push:
-  pull_request:
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: [ '14', '16', '18' ]
-
-    steps:
-    - uses: actions/checkout@v2
-
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
-      with:
-        node-version: ${{ matrix.node-version }}
-
-    - run: npm install
-    - run: npm test

package/.jshintrc

@@ -1,4 +0,0 @@
-{
-  "laxbreak": true,
-  "laxcomma": true
-}