msgpackr 1.11.2 → 1.11.4

package/dist/test.js

@@ -967,7 +967,10 @@
 		if (typeof property === 'string') return property;
 		if (typeof property === 'number' || typeof property === 'boolean' || typeof property === 'bigint') return property.toString();
 		if (property == null) return property + '';
-		throw new Error('Invalid property type for record', typeof property);
+		if (currentUnpackr.allowArraysInMapKeys && Array.isArray(property) && property.flat().every(item => ['string', 'number', 'boolean', 'bigint'].includes(typeof item))) {
+			return property.flat().toString();
+		}
+		throw new Error(`Invalid property type for record: ${typeof property}`);
 	}
 	// the registration of the record definition extension (as "r")
 	const recordDefinition = (id, highByte) => {
@@ -1017,20 +1020,33 @@
 			referenceMap = new Map();
 		let token = src[position$1];
 		let target;
-		// TODO: handle Maps, Sets, and other types that can cycle; this is complicated, because you potentially need to read
-		// ahead past references to record structure definitions
+		// TODO: handle any other types that can cycle and make the code more robust if there are other extensions
 		if (token >= 0x90 && token < 0xa0 || token == 0xdc || token == 0xdd)
 			target = [];
+		else if (token >= 0x80 && token < 0x90 || token == 0xde || token == 0xdf)
+			target = new Map();
+		else if ((token >= 0xc7 && token <= 0xc9 || token >= 0xd4 && token <= 0xd8) && src[position$1 + 1] === 0x73)
+			target = new Set();
 		else
 			target = {};
 
 		let refEntry = { target }; // a placeholder object
 		referenceMap.set(id, refEntry);
 		let targetProperties = read(); // read the next value as the target object to id
-		if (refEntry.used) // there is a cycle, so we have to assign properties to original target
-			return Object.assign(target, targetProperties)
-		refEntry.target = targetProperties; // the placeholder wasn't used, replace with the deserialized one
-		return targetProperties // no cycle, can just use the returned read object
+		if (!refEntry.used) {
+			// no cycle, can just use the returned read object
+			return refEntry.target = targetProperties // replace the placeholder with the real one
+		} else {
+			// there is a cycle, so we have to assign properties to original target
+			Object.assign(target, targetProperties);
+		}
+
+		// copy over map/set entries if we're able to
+		if (target instanceof Map)
+			for (let [k, v] of targetProperties.entries()) target.set(k, v);
+		if (target instanceof Set)
+			for (let i of Array.from(targetProperties)) target.add(i);
+		return target
 	};
 
 	currentExtensions[0x70] = (data) => {
@@ -1049,18 +1065,16 @@
 	let glbl = typeof globalThis === 'object' ? globalThis : window;
 	currentExtensions[0x74] = (data) => {
 		let typeCode = data[0];
+		// we always have to slice to get a new ArrayBuffer that is aligned
+		let buffer = Uint8Array.prototype.slice.call(data, 1).buffer;
+
 		let typedArrayName = typedArrays[typeCode];
 		if (!typedArrayName) {
-			if (typeCode === 16) {
-				let ab = new ArrayBuffer(data.length - 1);
-				let u8 = new Uint8Array(ab);
-				u8.set(data.subarray(1));
-				return ab;
-			}
+			if (typeCode === 16) return buffer
+			if (typeCode === 17) return new DataView(buffer)
 			throw new Error('Could not find typed array for code ' + typeCode)
 		}
-		// we have to always slice/copy here to get a new ArrayBuffer that is word/byte aligned
-		return new glbl[typedArrayName](Uint8Array.prototype.slice.call(data, 1).buffer)
+		return new glbl[typedArrayName](buffer)
 	};
 	currentExtensions[0x78] = () => {
 		let data = read();
@@ -1088,13 +1102,13 @@
 			return new Date(
 				((data[0] << 22) + (data[1] << 14) + (data[2] << 6) + (data[3] >> 2)) / 1000000 +
 				((data[3] & 0x3) * 0x100000000 + data[4] * 0x1000000 + (data[5] << 16) + (data[6] << 8) + data[7]) * 1000)
-		else if (data.length == 12)// TODO: Implement support for negative
+		else if (data.length == 12)
 			return new Date(
 				((data[0] << 24) + (data[1] << 16) + (data[2] << 8) + data[3]) / 1000000 +
 				(((data[4] & 0x80) ? -0x1000000000000 : 0) + data[6] * 0x10000000000 + data[7] * 0x100000000 + data[8] * 0x1000000 + (data[9] << 16) + (data[10] << 8) + data[11]) * 1000)
 		else
 			return new Date('invalid')
-	}; // notepack defines extension 0 to mean undefined, so use that as the default here
+	};
 	// registration of bulk record definition?
 	// currentExtensions[0x52] = () =>
 
@@ -1698,11 +1712,11 @@
 				} else if (type === 'boolean') {
 					target[position++] = value ? 0xc3 : 0xc2;
 				} else if (type === 'bigint') {
-					if (value < (BigInt(1)<<BigInt(63)) && value >= -(BigInt(1)<<BigInt(63))) {
+					if (value < 0x8000000000000000 && value >= -0x8000000000000000) {
 						// use a signed int as long as it fits
 						target[position++] = 0xd3;
 						targetView.setBigInt64(position, value);
-					} else if (value < (BigInt(1)<<BigInt(64)) && value > 0) {
+					} else if (value < 0x10000000000000000 && value > 0) {
 						// if we can fit an unsigned int, use that
 						target[position++] = 0xcf;
 						targetView.setBigUint64(position, value);
@@ -1713,7 +1727,7 @@
 							targetView.setFloat64(position, Number(value));
 						} else if (this.largeBigIntToString) {
 							return pack(value.toString());
-						} else if (this.useBigIntExtension && value < BigInt(2)**BigInt(1023) && value > -(BigInt(2)**BigInt(1023))) {
+						} else if ((this.useBigIntExtension || this.moreTypes) && value < BigInt(2)**BigInt(1023) && value > -(BigInt(2)**BigInt(1023))) {
 							target[position++] = 0xc7;
 							position++;
 							target[position++] = 0x42; // "B" for BigInt
@@ -2032,7 +2046,7 @@
 		}
 	};
 
-	extensionClasses = [ Date, Set, Error, RegExp, ArrayBuffer, Object.getPrototypeOf(Uint8Array.prototype).constructor /*TypedArray*/, C1Type ];
+	extensionClasses = [ Date, Set, Error, RegExp, ArrayBuffer, Object.getPrototypeOf(Uint8Array.prototype).constructor /*TypedArray*/, DataView, C1Type ];
 	extensions = [{
 		pack(date, allocateForWrite, pack) {
 			let seconds = date.getTime() / 1000;
@@ -2119,6 +2133,13 @@
 			else
 				writeBuffer(typedArray, allocateForWrite);
 		}
+	}, {
+		pack(arrayBuffer, allocateForWrite) {
+			if (this.moreTypes)
+				writeExtBuffer(arrayBuffer, 0x11, allocateForWrite);
+			else
+				writeBuffer(hasNodeBuffer$1 ? Buffer.from(arrayBuffer) : new Uint8Array(arrayBuffer), allocateForWrite);
+		}
 	}, {
 		pack(c1, allocateForWrite) { // specific 0xC1 object
 			let { target, position} = allocateForWrite(1);
@@ -2749,10 +2770,14 @@
 				throw new Error('Could not find typed structure ' + recordId);
 		}
 		var construct = structure.construct;
+		var fullConstruct = structure.fullConstruct;
 		if (!construct) {
 			construct = structure.construct = function LazyObject() {
 			};
-			var prototype = construct.prototype;
+			fullConstruct = structure.fullConstruct = function LoadedObject() {
+			};
+			fullConstruct.prototype = unpackr.structPrototype ?? {};
+			var prototype = construct.prototype = unpackr.structPrototype ? Object.create(unpackr.structPrototype) : {};
 			let properties = [];
 			let currentOffset = 0;
 			let lastRefProperty;
@@ -2953,12 +2978,12 @@
 					Object.defineProperty(prototype, property.key, { get: withSource(property.get), enumerable: true });
 					let valueFunction = 'v' + i++;
 					args.push(valueFunction);
-					objectLiteralProperties.push('[' + JSON.stringify(property.key) + ']:' + valueFunction + '(s)');
+					objectLiteralProperties.push('o[' + JSON.stringify(property.key) + ']=' + valueFunction + '(s)');
 				}
 				if (hasInheritedProperties) {
 					objectLiteralProperties.push('__proto__:this');
 				}
-				let toObject = (new Function(...args, 'return function(s){return{' + objectLiteralProperties.join(',') + '}}')).apply(null, properties.map(prop => prop.get));
+				let toObject = (new Function(...args, 'var c=this;return function(s){var o=new c();' + objectLiteralProperties.join(';') + ';return o;}')).apply(fullConstruct, properties.map(prop => prop.get));
 				Object.defineProperty(prototype, 'toJSON', {
 					value(omitUnderscoredProperties) {
 						return toObject.call(this, this[sourceSymbol]);
@@ -3434,7 +3459,10 @@
 				d: -352523523642364364364264264264264264262642642n,
 				e: 0xffffffffffffffffffffffffffn,
 				f: -0xffffffffffffffffffffffffffn,
+				o: -12345678901234567890n,
+				array: [],
 			};
+			
 			let serialized = packr.pack(data);
 			let deserialized = packr.unpack(serialized);
 			assert.deepEqual(data, deserialized);
@@ -3750,7 +3778,7 @@
 				}
 		});
 
-		test('moreTyesp: Error with causes', function() {
+		test('moreTypes: Error with causes', function() {
 			const object = {
 				error: new Error('test'),
 				errorWithCause: new Error('test-1', { cause: new Error('test-2')}),
@@ -3800,6 +3828,39 @@
 			assert.equal(u8[1], 2);
 		});
 
+		test('structured cloning: self reference with more types', function() {
+			let set = new Set();
+			set.add(['hello', 1, 2, { map: new Map([[set, set], ['a', 'b']]) }]);
+
+			let packr = new Packr({
+				moreTypes: true,
+				structuredClone: true,
+			});
+			let serialized = packr.pack(set);
+			let deserialized = packr.unpack(serialized);
+			assert.equal(deserialized.constructor.name, 'Set');
+			let map = Array.from(deserialized)[0][3].map;
+			assert.equal(map.get(deserialized), deserialized);
+
+			let sizeTestMap = new Map();
+			for (let i = 0; i < 50; i++) {
+				sizeTestMap.set(i || sizeTestMap, sizeTestMap);
+				let deserialized = packr.unpack(packr.pack(sizeTestMap));
+				assert.equal(deserialized.size, i + 1);
+				assert(deserialized.has(deserialized));
+				assert(deserialized.has(i || deserialized));
+			}
+
+			let sizeTestSet = new Set();
+			for (let i = 0; i < 50; i++) {
+				sizeTestSet.add(i || sizeTestSet);
+				let deserialized = packr.unpack(packr.pack(sizeTestSet));
+				assert.equal(deserialized.size, i + 1);
+				assert(deserialized.has(deserialized));
+				assert(deserialized.has(i || deserialized));
+			}
+		});
+
 		test('structured cloning: types', function() {
 			let b = typeof Buffer != 'undefined' ? Buffer.alloc(20) : new Uint8Array(20);
 			let fa = new Float32Array(b.buffer, 8, 2);
@@ -3810,7 +3871,9 @@
 				set: new Set(['a', 'b']),
 				regexp: /test/gi,
 				float32Array: fa,
-				uint16Array: new Uint16Array([3,4])
+				uint16Array: new Uint16Array([3, 4]),
+				arrayBuffer: new Uint8Array([0xde, 0xad]).buffer,
+				dataView: new DataView(new Uint8Array([0xbe, 0xef]).buffer),
 			};
 			let packr = new Packr({
 				moreTypes: true,
@@ -3827,6 +3890,10 @@
 			assert.equal(deserialized.uint16Array.constructor.name, 'Uint16Array');
 			assert.equal(deserialized.uint16Array[0], 3);
 			assert.equal(deserialized.uint16Array[1], 4);
+			assert.equal(deserialized.arrayBuffer.constructor.name, 'ArrayBuffer');
+			assert.equal(new DataView(deserialized.arrayBuffer).getUint16(), 0xdead);
+			assert.equal(deserialized.dataView.constructor.name, 'DataView');
+			assert.equal(deserialized.dataView.getUint16(), 0xbeef);
 		});
 		test('big bundledStrings', function() {
 			const MSGPACK_OPTIONS = {bundleStrings: true};
@@ -4245,6 +4312,18 @@
 			assert.deepEqual(deserialized, data);
 		});
 
+		test('arrays in map keys', function() {
+			const msgpackr = new Packr({ mapsAsObjects: true, allowArraysInMapKeys: true });
+
+			const map = new Map();
+			map.set([1, 2, 3], 1);
+			map.set([1, 2, ['foo', 3.14]], 2);
+
+			const packed = msgpackr.pack(map);
+			const unpacked = msgpackr.unpack(packed);
+			assert.deepEqual(unpacked, { '1,2,3': 1, '1,2,foo,3.14': 2 });
+		});
+
 		test('utf16 causing expansion', function() {
 			this.timeout(10000);
 			let data = {fixstr: 'ᾐᾑᾒᾓᾔᾕᾖᾗᾘᾙᾚᾛᾜᾝ', str8:'ᾐᾑᾒᾓᾔᾕᾖᾗᾘᾙᾚᾛᾜᾝᾐᾑᾒᾓᾔᾕᾖᾗᾘᾙᾚᾛᾜᾝᾐᾑᾒᾓᾔᾕᾖᾗᾘᾙᾚᾛᾜᾝᾐᾑᾒᾓᾔᾕᾖᾗᾘᾙᾚᾛᾜᾝᾐᾑᾒᾓᾔᾕᾖᾗᾘᾙᾚᾛᾜᾝᾐᾑᾒᾓᾔᾕᾖᾗᾘᾙᾚᾛᾜᾝᾐᾑᾒᾓᾔᾕᾖᾗᾘᾙᾚᾛᾜᾝᾐᾑᾒᾓᾔᾕᾖᾗᾘᾙᾚᾛᾜᾝᾐᾑᾒᾓᾔᾕᾖᾗᾘᾙᾚᾛᾜᾝᾐᾑᾒᾓᾔᾕᾖᾗᾘᾙᾚᾛᾜᾝᾐᾑᾒᾓᾔᾕᾖᾗᾘᾙᾚᾛᾜᾝᾐᾑᾒᾓᾔᾕᾖᾗᾘᾙᾚᾛᾜᾝᾐᾑᾒᾓᾔᾕᾖᾗᾘᾙᾚᾛᾜᾝᾐᾑᾒᾓᾔᾕᾖᾗᾘᾙᾚᾛᾜᾝᾐᾑᾒᾓᾔᾕᾖᾗᾘᾙᾚᾛᾜᾝᾐᾑᾒᾓᾔᾕᾖᾗᾘᾙᾚᾛᾜᾝ'};