cbor-x 1.3.3 → 1.4.0

package/SECURITY.md

@@ -1,11 +1,11 @@
-# Security Policy
-
-## Supported Versions
-
-| Version | Supported          |
-| ------- | ------------------ |
-| 0.9.x   | :white_check_mark: |
-
-## Reporting a Vulnerability
-
-Please report security vulnerabilities to kriszyp@gmail.com.
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 0.9.x   | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+Please report security vulnerabilities to kriszyp@gmail.com.

package/benchmark.md

@@ -1,73 +1,73 @@
-Here are more comprehensive benchmarks. This is comparison with the next fastest JS projects using the benchmark tool from `msgpack-lite` (and data is from some clinical research data we use that has a good mix of different value types and structures). It also includes comparison to V8 native JSON functionality, and JavaScript Avro (`avsc`, a very optimized Avro implementation):
-
-operation                                                  |   op   |   ms  |  op/s
----------------------------------------------------------- | ------: | ----: | -----:
-buf = Buffer(JSON.stringify(obj));                         |   82000 |  5004 |  16386
-obj = JSON.parse(buf);                                     |   88600 |  5000 |  17720
-require("cbor-x").encode(obj);                             |  161500 |  5002 |  32287
-require("cbor-x").decode(buf);                           |   94600 |  5004 |  18904
-cbor-x w/ shared structures: encoder.encode(obj);            |  178400 |  5002 |  35665
-cbor-x w/ shared structures: encoder.decode(buf);          |  376700 |  5000 |  75340
-buf = require("cbor").encode(obj);                         |    7700 |  5008 |   1537
-obj = require("cbor").decode(buf);                         |    3100 |  5119 |    605
-buf = require("cbor-sync").encode(obj);                    |   18000 |  5025 |   3582
-obj = require("cbor-sync").decode(buf);                    |   20900 |  5011 |   4170
-buf = require("msgpack-lite").encode(obj);                 |   30100 |  5012 |   6005
-obj = require("msgpack-lite").decode(buf);                 |   16200 |  5001 |   3239
-buf = require("@msgpack/msgpack").encode(obj);             |  101200 |  5001 |  20235
-obj = require("@msgpack/msgpack").decode(buf);             |   71200 |  5004 |  14228
-buf = require("notepack").encode(obj);                     |   62600 |  5005 |  12507
-obj = require("notepack").decode(buf);                     |   32400 |  5007 |   6470
-require("what-the-pack")... encoder.encode(obj);           |   63500 |  5002 |  12694
-require("what-the-pack")... encoder.decode(buf);           |   32000 |  5001 |   6398
-require("avsc")...make schema/type...type.toBuffer(obj);   |   84600 |  5003 |  16909
-require("avsc")...make schema/type...type.toBuffer(obj);   |   99300 |  5001 |  19856
-
-(`avsc` is schema-based and more comparable in style to cbor-x with shared structures).
-
-Here is a benchmark of streaming data (again borrowed from `msgpack-lite`'s benchmarking), where cbor-x is able to take advantage of the structured record extension and really pull away from other tools:
-
-operation (1000000 x 2)                          |   op    |  ms   |  op/s
------------------------------------------------- | ------: | ----: | -----:
-new EncoderStream().write(obj);                  | 1000000 |   533 | 1876172
-new DecoderStream().write(buf);                  | 1000000 |   297 | 3367003
-stream.write(msgpack.encode(obj));               | 1000000 |  3179 | 314564
-stream.write(msgpack.decode(buf));               | 1000000 |  2151 | 464900
-stream.write(notepack.encode(obj));              | 1000000 |   944 | 1059322
-stream.write(notepack.decode(buf));              | 1000000 |  1131 | 884173
-msgpack.Encoder().on("data",ondata).encode(obj); | 1000000 |  1687 | 592768
-msgpack.createDecodeStream().write(buf);         | 1000000 |  2084 | 479846
-msgpack.createEncodeStream().write(obj);         | 1000000 |  1475 | 677966
-msgpack.Decoder().on("data",ondata).decode(buf); | 1000000 |  2264 | 441696
-
-
-
-These are the benchmarks from notepack package. The larger test data for these benchmarks is very heavily weighted with large binary/buffer data and objects with extreme numbers of keys (much more than I typically see with real-world data, but YMMV):
-
-node ./benchmarks/encode
-
-library          |   tiny            |  small          | medium         | large
----------------- | ----------------: | --------------: | ---------------| -------:
-notepack         | 2,171,621 ops/sec | 546,905 ops/sec | 29,578 ops/sec | 265 ops/sec   
-msgpack-js       | 967,682 ops/sec   | 184,455 ops/sec | 20,556 ops/sec | 259 ops/sec   
-cbor-x         | 2,392,826 ops/sec | 556,915 ops/sec | 70,573 ops/sec | 313 ops/sec   
-msgpack-lite     | 553,143 ops/sec   | 132,318 ops/sec | 11,816 ops/sec | 186 ops/sec   
-@msgpack/msgpack | 2,157,655 ops/sec | 573,236 ops/sec | 25,864 ops/sec | 90.26 ops/sec 
-
-
-node ./benchmarks/decode
-
-library          |   tiny            |  small          | medium          | large
----------------- | ----------------: | --------------: | --------------- | -------:
-notepack         | 2,220,904 ops/sec | 560,630 ops/sec | 28,177 ops/sec  | 275 ops/sec   
-msgpack-js       | 965,719 ops/sec   | 222,047 ops/sec | 21,431 ops/sec  | 257 ops/sec   
-cbor-x         | 2,320,046 ops/sec | 589,167 ops/sec | 70,299 ops/sec  | 329 ops/sec   
-cbor-x records | 3,750,547 ops/sec | 912,419 ops/sec | 136,853 ops/sec | 733 ops/sec   
-msgpack-lite     | 569,222 ops/sec   | 129,008 ops/sec | 12,424 ops/sec  | 180 ops/sec   
-@msgpack/msgpack | 2,089,697 ops/sec | 557,507 ops/sec | 20,256 ops/sec  | 85.03 ops/sec 
-
-This was run by adding the cbor-x to the benchmarks for notepack.
-
-All benchmarks were performed on Node 14.8.0 (Windows i7-4770 3.4Ghz). They can be run with:
-npm install --no-save msgpack msgpack-js @msgpack/msgpack msgpack-lite notepack avsc
-node tests/benchmark
+Here are more comprehensive benchmarks. This is comparison with the next fastest JS projects using the benchmark tool from `msgpack-lite` (and data is from some clinical research data we use that has a good mix of different value types and structures). It also includes comparison to V8 native JSON functionality, and JavaScript Avro (`avsc`, a very optimized Avro implementation):
+
+operation                                                  |   op   |   ms  |  op/s
+---------------------------------------------------------- | ------: | ----: | -----:
+buf = Buffer(JSON.stringify(obj));                         |   82000 |  5004 |  16386
+obj = JSON.parse(buf);                                     |   88600 |  5000 |  17720
+require("cbor-x").encode(obj);                             |  161500 |  5002 |  32287
+require("cbor-x").decode(buf);                           |   94600 |  5004 |  18904
+cbor-x w/ shared structures: encoder.encode(obj);            |  178400 |  5002 |  35665
+cbor-x w/ shared structures: encoder.decode(buf);          |  376700 |  5000 |  75340
+buf = require("cbor").encode(obj);                         |    7700 |  5008 |   1537
+obj = require("cbor").decode(buf);                         |    3100 |  5119 |    605
+buf = require("cbor-sync").encode(obj);                    |   18000 |  5025 |   3582
+obj = require("cbor-sync").decode(buf);                    |   20900 |  5011 |   4170
+buf = require("msgpack-lite").encode(obj);                 |   30100 |  5012 |   6005
+obj = require("msgpack-lite").decode(buf);                 |   16200 |  5001 |   3239
+buf = require("@msgpack/msgpack").encode(obj);             |  101200 |  5001 |  20235
+obj = require("@msgpack/msgpack").decode(buf);             |   71200 |  5004 |  14228
+buf = require("notepack").encode(obj);                     |   62600 |  5005 |  12507
+obj = require("notepack").decode(buf);                     |   32400 |  5007 |   6470
+require("what-the-pack")... encoder.encode(obj);           |   63500 |  5002 |  12694
+require("what-the-pack")... encoder.decode(buf);           |   32000 |  5001 |   6398
+require("avsc")...make schema/type...type.toBuffer(obj);   |   84600 |  5003 |  16909
+require("avsc")...make schema/type...type.toBuffer(obj);   |   99300 |  5001 |  19856
+
+(`avsc` is schema-based and more comparable in style to cbor-x with shared structures).
+
+Here is a benchmark of streaming data (again borrowed from `msgpack-lite`'s benchmarking), where cbor-x is able to take advantage of the structured record extension and really pull away from other tools:
+
+operation (1000000 x 2)                          |   op    |  ms   |  op/s
+------------------------------------------------ | ------: | ----: | -----:
+new EncoderStream().write(obj);                  | 1000000 |   533 | 1876172
+new DecoderStream().write(buf);                  | 1000000 |   297 | 3367003
+stream.write(msgpack.encode(obj));               | 1000000 |  3179 | 314564
+stream.write(msgpack.decode(buf));               | 1000000 |  2151 | 464900
+stream.write(notepack.encode(obj));              | 1000000 |   944 | 1059322
+stream.write(notepack.decode(buf));              | 1000000 |  1131 | 884173
+msgpack.Encoder().on("data",ondata).encode(obj); | 1000000 |  1687 | 592768
+msgpack.createDecodeStream().write(buf);         | 1000000 |  2084 | 479846
+msgpack.createEncodeStream().write(obj);         | 1000000 |  1475 | 677966
+msgpack.Decoder().on("data",ondata).decode(buf); | 1000000 |  2264 | 441696
+
+
+
+These are the benchmarks from notepack package. The larger test data for these benchmarks is very heavily weighted with large binary/buffer data and objects with extreme numbers of keys (much more than I typically see with real-world data, but YMMV):
+
+node ./benchmarks/encode
+
+library          |   tiny            |  small          | medium         | large
+---------------- | ----------------: | --------------: | ---------------| -------:
+notepack         | 2,171,621 ops/sec | 546,905 ops/sec | 29,578 ops/sec | 265 ops/sec   
+msgpack-js       | 967,682 ops/sec   | 184,455 ops/sec | 20,556 ops/sec | 259 ops/sec   
+cbor-x         | 2,392,826 ops/sec | 556,915 ops/sec | 70,573 ops/sec | 313 ops/sec   
+msgpack-lite     | 553,143 ops/sec   | 132,318 ops/sec | 11,816 ops/sec | 186 ops/sec   
+@msgpack/msgpack | 2,157,655 ops/sec | 573,236 ops/sec | 25,864 ops/sec | 90.26 ops/sec 
+
+
+node ./benchmarks/decode
+
+library          |   tiny            |  small          | medium          | large
+---------------- | ----------------: | --------------: | --------------- | -------:
+notepack         | 2,220,904 ops/sec | 560,630 ops/sec | 28,177 ops/sec  | 275 ops/sec   
+msgpack-js       | 965,719 ops/sec   | 222,047 ops/sec | 21,431 ops/sec  | 257 ops/sec   
+cbor-x         | 2,320,046 ops/sec | 589,167 ops/sec | 70,299 ops/sec  | 329 ops/sec   
+cbor-x records | 3,750,547 ops/sec | 912,419 ops/sec | 136,853 ops/sec | 733 ops/sec   
+msgpack-lite     | 569,222 ops/sec   | 129,008 ops/sec | 12,424 ops/sec  | 180 ops/sec   
+@msgpack/msgpack | 2,089,697 ops/sec | 557,507 ops/sec | 20,256 ops/sec  | 85.03 ops/sec 
+
+This was run by adding the cbor-x to the benchmarks for notepack.
+
+All benchmarks were performed on Node 14.8.0 (Windows i7-4770 3.4Ghz). They can be run with:
+npm install --no-save msgpack msgpack-js @msgpack/msgpack msgpack-lite notepack avsc
+node tests/benchmark

package/browser.js

@@ -1,11 +1,11 @@
-exports.Encoder = require('./encode').Encoder
-exports.Decoder = require('./decode').Decoder
-exports.addExtension = require('./encode').addExtension
-let encoder = new exports.Encoder({ useRecords: false })
-exports.decode = encoder.decode
-exports.encode = encoder.encode
-Object.assign(exports, {
-	ALWAYS:1,
-	DECIMAL_ROUND: 3,
-	DECIMAL_FIT: 4
-})
+exports.Encoder = require('./encode').Encoder
+exports.Decoder = require('./decode').Decoder
+exports.addExtension = require('./encode').addExtension
+let encoder = new exports.Encoder({ useRecords: false })
+exports.decode = encoder.decode
+exports.encode = encoder.encode
+Object.assign(exports, {
+	ALWAYS:1,
+	DECIMAL_ROUND: 3,
+	DECIMAL_FIT: 4
+})

package/decode.d.ts

@@ -1,46 +1,2 @@
-export enum FLOAT32_OPTIONS {
-	NEVER = 0,
-	ALWAYS = 1,
-	DECIMAL_ROUND = 3,
-	DECIMAL_FIT = 4
-}
-
-export interface Options {
-	useFloat32?: FLOAT32_OPTIONS
-	useRecords?: boolean
-	structures?: {}[]
-	structuredClone?: boolean
-	mapsAsObjects?: boolean
-	variableMapSize?: boolean
-	copyBuffers?: boolean
-	bundleStrings?: boolean
-	useTimestamp32?: boolean
-	largeBigIntToFloat?: boolean
-	encodeUndefinedAsNil?: boolean
-	maxSharedStructures?: number
-	maxOwnStructures?: number
-	useSelfDescribedHeader?: boolean
-	keyMap?: {}
-	shouldShareStructure?: (keys: string[]) => boolean
-	getStructures?(): {}[]
-	saveStructures?(structures: {}[]): boolean | void
-	onInvalidDate?: () => any
-}
-interface Extension {
-	Class: Function
-	tag: number
-	encode(value: any): Buffer | Uint8Array
-	decode(messagePack: Buffer | Uint8Array): any
-}
-export class Decoder {
-	constructor(options?: Options)
-	decode(messagePack: Buffer | Uint8Array): any
-	decodeMultiple(messagePack: Buffer | Uint8Array, forEach?: (value: any) => any): [] | void
-}
-export function decode(messagePack: Buffer | Uint8Array): any
-export function decodeMultiple(messagePack: Buffer | Uint8Array, forEach?: (value: any) => any): [] | void
-export function addExtension(extension: Extension): void
-export function clearSource(): void
-export function roundFloat32(float32Number: number): number
-export let isNativeAccelerationEnabled: boolean
-
+export { decode, decodeMultiple, Decoder, addExtension, clearSource,roundFloat32, isNativeAccelerationEnabled,
+	Extension, Options, FLOAT32_OPTIONS} from '.'

package/decode.js

@@ -822,8 +822,6 @@ export class Tag {
 	}
 }
 
-let glbl = typeof self == 'object' ? self : global
-
 currentExtensions[0] = (dateString) => {
 	// string date extension
 	return new Date(dateString)
@@ -890,7 +888,7 @@ currentExtensions[15] = (value) => {
 		return bundledStrings[1].slice(bundledStrings.position1, bundledStrings.position1 += value)
 	return new Tag(value, 15)
 }
-
+let glbl = { Error, RegExp }
 currentExtensions[27] = (data) => { // http://cbor.schmorp.de/generic-object
 	return (glbl[data[0]] || Error)(data[1], data[2])
 }
@@ -1015,13 +1013,17 @@ currentExtensionRanges.push((tag, input) => {
 })
 
 const isLittleEndianMachine = new Uint8Array(new Uint16Array([1]).buffer)[0] == 1
-export const typedArrays = ['Uint8', 'Uint8Clamped', 'Uint16', 'Uint32', 'BigUint64','Int8', 'Int16', 'Int32', 'BigInt64', 'Float32', 'Float64']
+export const typedArrays = [Uint8Array, Uint8ClampedArray, Uint16Array, Uint32Array,
+	typeof BigUint64Array == 'undefined' ? { name:'BigUint64Array' } : BigUint64Array, Int8Array, Int16Array, Int32Array,
+	typeof BigInt64Array == 'undefined' ? { name:'BigInt64Array' } : BigInt64Array, Float32Array, Float64Array]
 const typedArrayTags = [64, 68, 69, 70, 71, 72, 77, 78, 79, 85, 86]
 for (let i = 0; i < typedArrays.length; i++) {
 	registerTypedArray(typedArrays[i], typedArrayTags[i])
 }
-function registerTypedArray(typedArrayId, tag, littleEndian) {
-	let TypedArray = glbl[typedArrayId + 'Array']
+function registerTypedArray(TypedArray, tag) {
+	let dvMethod = 'get' + TypedArray.name.slice(0, -5)
+	if (typeof TypedArray !== 'function')
+		TypedArray = null;
 	let bytesPerElement = TypedArray.BYTES_PER_ELEMENT
 	for (let littleEndian = 0; littleEndian < 2; littleEndian++) {
 		if (!littleEndian && bytesPerElement == 1)
@@ -1038,7 +1040,7 @@ function registerTypedArray(typedArrayId, tag, littleEndian) {
 			let dv = new DataView(buffer.buffer, buffer.byteOffset, buffer.byteLength)
 			let elements = buffer.length >> sizeShift
 			let ta = new TypedArray(elements)
-			let method = dv['get' + typedArrayId]
+			let method = dv[dvMethod]
 			for (let i = 0; i < elements; i++) {
 				ta[i] = method.call(dv, i << sizeShift, littleEndian)
 			}