cbor-x 0.9.2 → 1.1.0

package/index.d.ts

@@ -1,4 +1,4 @@
-export { Decoder, decode, addExtension, FLOAT32_OPTIONS, clearSource, roundFloat32 } from './decode.js'
+export { Decoder, decode, addExtension, FLOAT32_OPTIONS, clearSource, roundFloat32, isNativeAccelerationEnabled } from './decode.js'
 export { Encoder, encode } from './encode.js'
 import { Transform, Readable } from 'stream'
 

package/index.js

@@ -1,5 +1,3 @@
-export { Encoder, addExtension, encode, NEVER, ALWAYS, DECIMAL_ROUND, DECIMAL_FIT } from './encode.js'
-export { Tag, Decoder, decodeMultiple, decode, FLOAT32_OPTIONS, clearSource, roundFloat32 } from './decode.js'
+export { Encoder, addExtension, encode, NEVER, ALWAYS, DECIMAL_ROUND, DECIMAL_FIT, REUSE_BUFFER_MODE } from './encode.js'
+export { Tag, Decoder, decodeMultiple, decode, FLOAT32_OPTIONS, clearSource, roundFloat32, isNativeAccelerationEnabled } from './decode.js'
 export { decodeIter, encodeIter } from './iterators.js'
-export const useRecords = false
-export const mapsAsObjects = true

package/node-index.js

@@ -1,5 +1,5 @@
 export { Encoder, addExtension, encode, NEVER, ALWAYS, DECIMAL_ROUND, DECIMAL_FIT, REUSE_BUFFER_MODE } from './encode.js'
-export { Tag, Decoder, decodeMultiple, decode, FLOAT32_OPTIONS, clearSource, roundFloat32 } from './decode.js'
+export { Tag, Decoder, decodeMultiple, decode, FLOAT32_OPTIONS, clearSource, roundFloat32, isNativeAccelerationEnabled } from './decode.js'
 export { EncoderStream, DecoderStream } from './stream.js'
 export { decodeIter, encodeIter } from './iterators.js'
 export const useRecords = false
@@ -16,9 +16,7 @@ function tryRequire(moduleId) {
 		let require = createRequire(import.meta.url)
 		return require(moduleId)
 	} catch (error) {
-		if (typeof window == 'undefined')
-			console.warn('Native extraction module not loaded, cbor-x will still run, but with decreased performance. ' + error.message.split('\n')[0])
-		else
+		if (typeof window != 'undefined')
 			console.warn('For browser usage, directly use cbor-x/decode or cbor-x/encode modules. ' + error.message.split('\n')[0])
 	}
 }

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "cbor-x",
   "author": "Kris Zyp",
-  "version": "0.9.2",
-  "description": "Ultra-fast CBOR implementation with tag extensions for records and structured cloning",
+  "version": "1.1.0",
+  "description": "Ultra-fast and conformant CBOR (RFC 8949) implementation with support for numerous tag extensions including records and structured cloning",
   "license": "MIT",
   "types": "./index.d.ts",
   "main": "./dist/node.cjs",
@@ -52,10 +52,17 @@
       }
     }
   },
+  "files": [
+    "/dist",
+    "*.md",
+    "/*.js",
+    "/*.ts"
+  ],
   "optionalDependencies": {
-    "cbor-extract": "^0.3.2"
+    "cbor-extract": "^1.0.0"
   },
   "devDependencies": {
+    "@rollup/plugin-json": "^4.1.0",
     "@types/node": "latest",
     "async": "^3",
     "cbor": "^5",
@@ -64,7 +71,9 @@
     "esm": "^3.2.25",
     "mocha": "^8.1.3",
     "rollup": "^1.20.3",
-    "@rollup/plugin-json": "^4.1.0",
     "rollup-plugin-babel-minify": "^9.0.0"
+  },
+  "dependencies": {
+    "esbuild": "^0.13.15"
   }
 }

package/.vscode/launch.json

@@ -1,22 +0,0 @@
-{
-    // Use IntelliSense to learn about possible attributes.
-    // Hover to view descriptions of existing attributes.
-    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-    "version": "0.2.0",
-    "configurations": [
-        {
-            "type": "pwa-node",
-            "request": "launch",
-            "name": "Run cbor-x tests",
-            "runtimeArgs": [
-                "test"
-            ],
-            "runtimeExecutable": "npm",
-            "skipFiles": [
-                "<node_internals>/**"
-            ],
-            "console": "internalConsole", 
-            "outputCapture": "std"
-        }
-    ]
-}

package/tests/benchmark-stream.cjs

@@ -1,282 +0,0 @@
-#!/usr/bin/env node
-
-var PassThrough = require("stream").PassThrough;
-var async = require("async");
-
-let { EncoderStream, DecoderStream } = require("..");
-var msgpack = require("msgpack-lite");
-var Encoder = require("msgpack-lite/lib/encoder").Encoder;
-var Decoder = require("msgpack-lite/lib/decoder").Decoder;
-var notepack = require("notepack");
-
-var pkg = require("../package.json");
-
-// a sample fluentd message
-var data = ["tag", [[1440949922, {"message": "hi there"}]]];
-var packed = msgpack.encode(data); // 30 bytes per message
-var packsize = packed.length;
-var opcount = 1000000;
-var joincount = 100;
-var packjoin = repeatbuf(packed, joincount); // 3KB per chunk
-var limit = 2;
-
-var blocksToJoin = []
-var streamForJoin = new EncoderStream();
-streamForJoin.on("data", data => blocksToJoin.push(data));
-for (var j = 0; j < joincount; j++) {
-  streamForJoin.write(data);
-}
-var packjoinWithRecords = Buffer.concat(blocksToJoin)
-
-var argv = Array.prototype.slice.call(process.argv, 2);
-
-if (argv[0] === "-v") {
-  console.warn(pkg.name + " " + pkg.version);
-  process.exit(0);
-}
-
-if (argv[0] - 0) limit = argv.shift() - 0;
-
-var list = [
-  ['new EncoderStream().write(obj);', encode5],
-  ['new DecoderStream().write(buf);', decode5],
-  ['stream.write(msgpack.encode(obj));', encode1],
-  ['stream.write(msgpack.decode(buf));', decode1],
-  ['stream.write(notepack.encode(obj));', encode4],
-  ['stream.write(notepack.decode(buf));', decode4],
-  ['msgpack.Encoder().on("data",ondata).encode(obj);', encode2],
-  ['msgpack.createDecodeStream().write(buf);', decode3],
-  ['msgpack.createEncodeStream().write(obj);', encode3],
-  ['msgpack.Decoder().on("data",ondata).decode(buf);', decode2],
-//  ['stream.write(Buffer.from(JSON.stringify(obj)));', stringify],
-//  ['stream.write(JSON.parse(buf));', parse]
-];
-
-function encode5(callback) {
-  var stream = new EncoderStream();
-  var cnt = counter(callback);
-  stream.on("data", cnt.inc);
-  stream.on("end", cnt.end);
-  for (var j = 0; j < opcount; j++) {
-    stream.write(data);
-  }
-  stream.end();
-}
-
-function encode1(callback) {
-  var stream = new PassThrough();
-  var cnt = counter(callback);
-  stream.on("data", cnt.buf);
-  stream.on("end", cnt.end);
-  for (var j = 0; j < opcount; j++) {
-    stream.write(msgpack.encode(data));
-  }
-  stream.end();
-}
-
-function encode2(callback) {
-  var stream = new PassThrough();
-  var cnt = counter(callback);
-  stream.on("data", cnt.buf);
-  stream.on("end", cnt.end);
-  var encoder = Encoder();
-  encoder.on("data", function(chunk) {
-    stream.write(chunk);
-  });
-  encoder.on("end", function() {
-    stream.end();
-  });
-  for (var j = 0; j < opcount; j++) {
-    encoder.encode(data);
-  }
-  encoder.end();
-}
-
-function encode3(callback) {
-  var stream = msgpack.createEncodeStream();
-  var cnt = counter(callback);
-  stream.on("data", cnt.buf);
-  stream.on("end", cnt.end);
-  for (var j = 0; j < opcount; j++) {
-    stream.write(data);
-  }
-  stream.end();
-}
-
-function encode4(callback) {
-  var stream = new PassThrough();
-  var cnt = counter(callback);
-  stream.on("data", cnt.buf);
-  stream.on("end", cnt.end);
-  for (var j = 0; j < opcount; j++) {
-    stream.write(notepack.encode(data));
-  }
-  stream.end();
-}
-
-function decode5(callback) {
-  var stream = new DecoderStream();
-  var cnt = counter(callback);
-  stream.on("data", cnt.inc);
-  stream.on("end", cnt.end);
-  for (var j = 0; j < opcount / joincount; j++) {
-    stream.write(packjoinWithRecords);
-  }
-  stream.end();
-}
-
-function decode1(callback) {
-  var stream = new PassThrough({objectMode: true});
-  var cnt = counter(callback);
-  stream.on("data", cnt.inc);
-  stream.on("end", cnt.end);
-  for (var j = 0; j < opcount; j++) {
-    stream.write(msgpack.decode(packed));
-  }
-  stream.end();
-}
-
-function decode2(callback) {
-  var stream = new PassThrough({objectMode: true});
-  var cnt = counter(callback);
-  stream.on("data", cnt.inc);
-  stream.on("end", cnt.end);
-  var decoder = Decoder();
-  decoder.on("data", function(chunk) {
-    stream.write(chunk);
-  });
-  decoder.on("end", function() {
-    stream.end();
-  });
-  for (var j = 0; j < opcount / joincount; j++) {
-    decoder.decode(packjoin);
-  }
-  decoder.end();
-}
-
-function decode3(callback) {
-  var stream = msgpack.createDecodeStream();
-  var cnt = counter(callback);
-  stream.on("data", cnt.inc);
-  stream.on("end", cnt.end);
-  for (var j = 0; j < opcount / joincount; j++) {
-    stream.write(packjoin);
-  }
-  stream.end();
-}
-
-function decode4(callback) {
-  var stream = new PassThrough({objectMode: true});
-  var cnt = counter(callback);
-  stream.on("data", cnt.inc);
-  stream.on("end", cnt.end);
-  for (var j = 0; j < opcount; j++) {
-    stream.write(notepack.decode(packed));
-  }
-  stream.end();
-}
-
-function rpad(str, len, chr) {
-  if (!chr) chr = " ";
-  str += "";
-  while (str.length < len) str += chr;
-  return str;
-}
-
-function lpad(str, len, chr) {
-  if (!chr) chr = " ";
-  str += "";
-  while (str.length < len) str = chr + str;
-  return str;
-}
-
-function repeatbuf(buf, cnt) {
-  var array = [];
-  for (var i = 0; i < cnt; i++) {
-    array.push(buf);
-  }
-  return Buffer.concat(array);
-}
-
-function counter(callback) {
-  var cnt = 0;
-  return {buf: b, inc: i, end: e};
-
-  function b(buf) {
-    cnt += buf.length / packsize;
-  }
-
-  function i() {
-    cnt++;
-  }
-
-  function e() {
-    cnt = Math.round(cnt);
-    callback(null, cnt);
-  }
-}
-
-function run() {
-  // task filter
-  if (argv.length) {
-    list = list.filter(function(pair) {
-      var name = pair[0];
-      var match = argv.filter(function(grep) {
-        return (name.indexOf(grep) > -1);
-      });
-      return match.length;
-    });
-  }
-
-  // run tasks repeatedly
-  var tasks = [];
-  for (var i = 0; i < limit; i++) {
-    tasks.push(oneset);
-  }
-  async.series(tasks, end);
-
-  // run a series of tasks
-  function oneset(callback) {
-    async.eachSeries(list, bench, callback);
-  }
-
-  // run a single benchmark
-  function bench(pair, callback) {
-    process.stdout.write(".");
-    var func = pair[1];
-    var start = new Date() - 0;
-    func(function(err, cnt) {
-      var end = new Date() - 0;
-      var array = pair[2] || (pair[2] = []);
-      array.push(end - start);
-      pair[3] = cnt;
-      setTimeout(callback, 100);
-    });
-  }
-
-  // show result
-  function end() {
-    var title = "operation (" + opcount + " x " + limit + ")";
-    process.stdout.write("\n");
-
-    // table header
-    var COL1 = 48;
-    console.log(rpad(title, COL1), "|", "  op   ", "|", " ms  ", "|", " op/s ");
-    console.log(rpad("", COL1, "-"), "|", "------:", "|", "----:", "|", "-----:");
-
-    // table body
-    list.forEach(function(pair) {
-      var name = pair[0];
-      var op = pair[3];
-      var array = pair[2];
-      array = array.sort(function(a, b) {
-        return a > b;
-      });
-      var fastest = array[0];
-      var score = Math.floor(opcount / fastest * 1000);
-      console.log(rpad(name, COL1), "|", lpad(op, 7), "|", lpad(fastest, 5), "|", lpad(score, 6));
-    });
-  }
-}
-
-run();

package/tests/benchmark.cjs

@@ -1,245 +0,0 @@
-var cborX = tryRequire("../dist/node.cjs");
-var msgpack_node = tryRequire("msgpack");
-var msgpack_msgpack = tryRequire("@msgpack/msgpack");
-var msgpack_lite = tryRequire("msgpack-lite");
-var msgpack_js = tryRequire("msgpack-js");
-var msgpack_js_v5 = tryRequire("msgpack-js-v5");
-var msgpack5 = tryRequire("msgpack5");
-var msgpack_unpack = tryRequire("msgpack-unpack");
-var msgpack_codec = tryRequire("msgpack.codec");
-var notepack = tryRequire("notepack");
-var what_the_pack = tryRequire("what-the-pack");
-var avro = tryRequire('avsc')
-var cbor = tryRequire('cbor')
-var cborSync = tryRequire('cbor-sync')
-var zlib = require('zlib')
-var deflateSync = zlib.deflateSync
-var inflateSync = zlib.inflateSync
-//var deflateSync = zlib.brotliCompressSync
-//var inflateSync = zlib.brotliDecompressSync
-var constants = zlib.constants
-
-msgpack5 = msgpack5 && msgpack5();
-msgpack_codec = msgpack_codec && msgpack_codec.msgpack;
-what_the_pack = what_the_pack && what_the_pack.initialize(2**20);
-
-var pkg = require("../package.json");
-var data = require("./example4.json");
-var packed = msgpack_lite && msgpack_lite.encode(data);
-var expected = JSON.stringify(data);
-
-var argv = Array.prototype.slice.call(process.argv, 2);
-
-if (argv[0] === "-v") {
-  console.warn(pkg.name + " " + pkg.version);
-  process.exit(0);
-}
-
-var limit = 5;
-if (argv[0] - 0) limit = argv.shift() - 0;
-limit *= 1000;
-
-var COL1 = 58;
-var COL2 = 7;
-var COL3 = 5;
-var COL4 = 6;
-
-console.log(rpad("operation", COL1), "|", "  op  ", "|", "  ms ", "|", " op/s ");
-console.log(rpad("", COL1, "-"), "|", lpad(":", COL2, "-"), "|", lpad(":", COL3, "-"), "|", lpad(":", COL4, "-"));
-
-var buf, obj;
-
-if (cborX) {
-  let encoder = new cborX.Encoder({ useRecords: false, pack: true })
-  buf = bench('cbor-x packed and compress: encoder.encode(obj);', (data) => deflateSync(encoder.encode(data), { level: constants.Z_BEST_SPEED}), data);
-  console.log('size', buf.length)
-  
-  buf = bench('cbor-x packed: encoder.encode(obj);', encoder.encode.bind(encoder), data);
-
-  obj = bench('cbor-x packed: encoder.decode(buf);', encoder.decode.bind(encoder), buf);
-  test(obj);
-  console.log('size', buf.length)
-
-
-  encoder = new cborX.Encoder({ useRecords: true, pack: true })
-  buf = bench('cbor-x packed and useRecords and compress: encoder.encode(obj);', (data) => deflateSync(encoder.encode(data), { level: constants.Z_BEST_SPEED}), data);
-  console.log('size', buf.length)
-  
-  buf = bench('cbor-x packed and useRecords: encoder.encode(obj);', encoder.encode.bind(encoder), data);
-
-  obj = bench('cbor-x packed and useRecords: encoder.decode(buf);', encoder.decode.bind(encoder), buf);
-  test(obj);
-  console.log('size', buf.length)
-
-  buf = bench('require("cbor-x").encode(obj) and compress;', (data) => deflateSync(cborX.encode(data)), data);
-  console.log('size', buf.length)
-  buf = bench('require("cbor-x").encode(obj);', cborX.encode, data);
-//    buf = bench('require("msgpack").serialize(obj);', data => {let result = packr.serialize(data); packr.resetMemory(); return result;}, data);
-
-  obj = bench('require("cbor-x").decode(buf);', cborX.decode, buf);
-  test(obj);
-  console.log('size', buf.length)
-
-
-  encoder = new cborX.Encoder({  })
-  buf = bench('cbor-x w/ shared structures: encoder.encode(obj);', (data) => deflateSync(encoder.encode(data), { level: constants.Z_BEST_SPEED}), data);
-  console.log('size', buf.length)
-  
-  buf = bench('cbor-x w/ shared structures: encoder.encode(obj);', encoder.encode.bind(encoder), data);
-
-  obj = bench('cbor-x w/ shared structures: encoder.decode(buf);', encoder.decode.bind(encoder), buf);
-  test(obj);
-  console.log('size', buf.length)
-}
-if (JSON) {
-  buf = bench('buf = Buffer(JSON.stringify(obj));', JSON_stringify, data);
-  obj = bench('obj = JSON.parse(buf);', JSON.parse, buf);
-  test(obj);
-}
-
-
-if (JSON) {
-  buf = bench('buf = Buffer(JSON.stringify(obj));', JSON_stringify, data);
-  obj = bench('obj = JSON.parse(buf);', JSON.parse, buf);
-  test(obj);
-}
-
-if (msgpack_lite) {
-  buf = bench('buf = require("msgpack-lite").encode(obj);', msgpack_lite.encode, data);
-  obj = bench('obj = require("msgpack-lite").decode(buf);', msgpack_lite.decode, packed);
-  test(obj);
-}
-
-if (msgpack_msgpack) {
-  buf = bench('buf = require("@msgpack/msgpack").encode(obj);', msgpack_msgpack.encode, data);
-  obj = bench('obj = require("@msgpack/msgpack").decode(buf);', msgpack_msgpack.decode, buf);
-  test(obj);
-}
-
-if (msgpack_node) {
-  buf = bench('buf = require("msgpack").pack(obj);', msgpack_node.pack, data);
-  obj = bench('obj = require("msgpack").unpack(buf);', msgpack_node.unpack, buf);
-  test(obj);
-}
-
-if (msgpack_codec) {
-  buf = bench('buf = Buffer(require("msgpack.codec").msgpack.pack(obj));', msgpack_codec_pack, data);
-  obj = bench('obj = require("msgpack.codec").msgpack.unpack(buf);', msgpack_codec.unpack, buf);
-  test(obj);
-}
-
-if (msgpack_js_v5) {
-  buf = bench('buf = require("msgpack-js-v5").encode(obj);', msgpack_js_v5.encode, data);
-  obj = bench('obj = require("msgpack-js-v5").decode(buf);', msgpack_js_v5.decode, buf);
-  test(obj);
-}
-
-if (msgpack_js) {
-  buf = bench('buf = require("msgpack-js").encode(obj);', msgpack_js.encode, data);
-  obj = bench('obj = require("msgpack-js").decode(buf);', msgpack_js.decode, buf);
-  test(obj);
-}
-
-if (msgpack5) {
-  buf = bench('buf = require("msgpack5")().encode(obj);', msgpack5.encode, data);
-  obj = bench('obj = require("msgpack5")().decode(buf);', msgpack5.decode, buf);
-  test(obj);
-}
-
-if (notepack) {
-  buf = bench('buf = require("notepack").encode(obj);', notepack.encode, data);
-  obj = bench('obj = require("notepack").decode(buf);', notepack.decode, buf);
-  test(obj);
-}
-if (what_the_pack) {
-  buf = bench('require("what-the-pack")... encoder.encode(obj);', what_the_pack.encode, data);
-  obj = bench('require("what-the-pack")... encoder.decode(buf);', what_the_pack.decode, buf);
-  test(obj);
-}
-
-if (msgpack_unpack) {
-  obj = bench('obj = require("msgpack-unpack").decode(buf);', msgpack_unpack, packed);
-  test(obj);
-}
-
-if (avro) {
-  const type = avro.Type.forValue(data);
-  buf = bench('require("avsc")...make schema/type...type.toBuffer(obj);', type.toBuffer.bind(type), data);
-  obj = bench('require("avsc")...make schema/type...type.fromBuffer(obj);', type.fromBuffer.bind(type), buf);
-}
-
-if (cbor) {
-  buf = bench('buf = require("cbor").encode(obj);', cbor.encode, data);
-  obj = bench('obj = require("cbor").decode(buf);', cbor.decode, buf);
-  test(obj);
-}
-if (cborSync) {
-  buf = bench('buf = require("cbor-sync").encode(obj);', cborSync.encode, data);
-  obj = bench('obj = require("cbor-sync").decode(buf);', cborSync.decode, buf);
-  test(obj);
-}
-
-function JSON_stringify(src) {
-  return Buffer(JSON.stringify(src));
-}
-
-function msgpack_codec_pack(data) {
-  return Buffer(msgpack_codec.pack(data));
-}
-
-function bench(name, func, src) {
-  if (argv.length) {
-    var match = argv.filter(function(grep) {
-      return (name.indexOf(grep) > -1);
-    });
-    if (!match.length) return SKIP;
-  }
-  var ret, duration;
-  var start = new Date() - 0;
-  var count = 0;
-  while (1) {
-    var end = new Date() - 0;
-    duration = end - start;
-    if (duration >= limit) break;
-    while ((++count) % 100) ret = func(src);
-  }
-  name = rpad(name, COL1);
-  var score = Math.floor(count / duration * 1000);
-  count = lpad(count, COL2);
-  duration = lpad(duration, COL3);
-  score = lpad(score, COL4);
-  console.log(name, "|", count, "|", duration, "|", score);
-  return ret;
-}
-
-function rpad(str, len, chr) {
-  if (!chr) chr = " ";
-  while (str.length < len) str += chr;
-  return str;
-}
-
-function lpad(str, len, chr) {
-  if (!chr) chr = " ";
-  str += "";
-  while (str.length < len) str = chr + str;
-  return str;
-}
-
-function test(actual) {
-  if (actual === SKIP) return;
-  actual = JSON.stringify(actual);
-  if (actual === expected) return;
-  console.warn("expected: " + expected);
-  console.warn("actual:   " + actual);
-}
-
-function SKIP() {
-}
-
-function tryRequire(name) {
-  try {
-    return require(name);
-  } catch (e) {
-    // ignore
-  }
-}

package/tests/example.json

@@ -1,52 +0,0 @@
-{
-  "int0": 0,
-  "int1": 1,
-  "int1-": -1,
-  "int8": 255,
-  "int8-": -255,
-  "int16": 256,
-  "int16-": -256,
-  "int32": 65536,
-  "int32-": -65536,
-  "nil": null,
-  "true": true,
-  "false": false,
-  "float": 0.5,
-  "float-": -0.5,
-  "string0": "",
-  "string1": "A",
-  "string4": "foobarbaz",
-  "string8": "Omnes viae Romam ducunt.",
-  "string16": "L’homme n’est qu’un roseau, le plus faible de la nature ; mais c’est un roseau pensant. Il ne faut pas que l’univers entier s’arme pour l’écraser : une vapeur, une goutte d’eau, suffit pour le tuer. Mais, quand l’univers l’écraserait, l’homme serait encore plus noble que ce qui le tue, puisqu’il sait qu’il meurt, et l’avantage que l’univers a sur lui, l’univers n’en sait rien. Toute notre dignité consiste donc en la pensée. C’est de là qu’il faut nous relever et non de l’espace et de la durée, que nous ne saurions remplir. Travaillons donc à bien penser : voilà le principe de la morale.",
-  "array0": [],
-  "array1": [
-    "foo"
-  ],
-  "array8": [
-    1,
-    2,
-    4,
-    8,
-    16,
-    32,
-    64,
-    128,
-    256,
-    512,
-    1024,
-    2048,
-    4096,
-    8192,
-    16384,
-    32768,
-    65536,
-    131072,
-    262144,
-    524288,
-    1048576
-  ],
-  "map0": {},
-  "map1": {
-    "foo": "bar"
-  }
-}