msgpackr 1.10.2 → 1.11.1

package/README.md

@@ -184,9 +184,11 @@ The following options properties can be provided to the Packr or Unpackr constru
 * `useTimestamp32` - Encode JS `Date`s in 32-bit format when possible by dropping the milliseconds. This is a more efficient encoding of dates. You can also cause dates to use 32-bit format by manually setting the milliseconds to zero (`date.setMilliseconds(0)`).
 * `sequential` - Encode structures in serialized data, and reference previously encoded structures with expectation that decoder will read the encoded structures in the same order as encoded, with `unpackMultiple`.
 * `largeBigIntToFloat` - If a bigint needs to be encoded that is larger than will fit in 64-bit integers, it will be encoded as a float-64 (otherwise will throw a RangeError).
+* `largeBigIntToString` - If a bigint needs to be encoded that is larger than will fit in 64-bit integers, it will be encoded as a string (otherwise will throw a RangeError).
 * `useBigIntExtension` - If a bigint needs to be encoded that is larger than will fit in 64-bit integers, it will be encoded using a custom extension that supports up to about 1000-bits of integer precision.
 * `encodeUndefinedAsNil` - Encodes a value of `undefined` as a MessagePack `nil`, the same as a `null`.
-* `int64AsType` - This will decode uint64 and int64 numbers as the specified type. The type can be `bigint` (default), `number`,  `string`, or `auto` (where range [-2^53...2^53] is represented by number and everything else by a bigint). 
+* `int64AsType` - This will decode uint64 and int64 numbers as the specified type. The type can be `bigint` (default), `number`,  `string`, or `auto` (where range [-2^53...2^53] is represented by number and everything else by a bigint).
+* `skipValues` - This can be an array of property values that will indicate properties that should be skipped when serializing objects. For example, to mimic `JSON.stringify`'s behavior of skipping properties with a value of `undefined`, you can provide `skipValues: [undefined]`. Note, that this will only apply to serializing objects as standard MessagePack maps, not to records. Also, the array is checked by calling the `include` method, so you can provide an object with an `includes` if you want a custom function to skip values. 
 * `onInvalidDate` - This can be provided as function that will be called when an invalid date is provided. The function can throw an error, or return a value that will be encoded in place of the invalid date. If not provided, an invalid date will be encoded as an invalid timestamp (which decodes with msgpackr back to an invalid date).
 * `writeFunction` - This can be provided as function that will be called when a function is encountered. The function can throw an error, or return a value that will be encoded in place of the function. If not provided, a function will be encoded as undefined (similar to `JSON.stringify`).
 * `mapAsEmptyObject` - Encodes JS `Map`s as empty objects (for back-compat with older libraries).
@@ -271,7 +273,7 @@ addExtension({
 	pack(instance) {
 		// define how your custom class should be encoded
 		return Buffer.from([instance.myData]); // return a buffer
-	}
+	},
 	unpack(buffer) {
 		// define how your custom class should be decoded
 		let instance = new MyCustomClass();

package/dist/index-no-eval.cjs

@@ -946,7 +946,7 @@
 		let length = data.length;
 		let value = BigInt(data[0] & 0x80 ? data[0] - 0x100 : data[0]);
 		for (let i = 1; i < length; i++) {
-			value <<= 8n;
+			value <<= BigInt(8);
 			value += BigInt(data[i]);
 		}
 		return value;
@@ -1142,7 +1142,7 @@
 			let structures;
 			let referenceMap;
 			let encodeUtf8 = ByteArray.prototype.utf8Write ? function(string, position) {
-				return target.utf8Write(string, position, 0xffffffff)
+				return target.utf8Write(string, position, target.byteLength - position)
 			} : (textEncoder && textEncoder.encodeInto) ?
 				function(string, position) {
 					return textEncoder.encodeInto(string, target.subarray(position)).written
@@ -1167,7 +1167,7 @@
 			if (!this.structures && options.useRecords != false)
 				this.structures = [];
 			// two byte record ids for shared structures
-			let useTwoByteRecords = maxSharedStructures > 32 || (maxOwnStructures + maxSharedStructures > 64);		
+			let useTwoByteRecords = maxSharedStructures > 32 || (maxOwnStructures + maxSharedStructures > 64);
 			let sharedLimitId = maxSharedStructures + 0x40;
 			let maxStructureId = maxSharedStructures + maxOwnStructures + 0x40;
 			if (maxStructureId > 8256) {
@@ -1185,7 +1185,7 @@
 				}
 				safeEnd = target.length - 10;
 				if (safeEnd - position < 0x800) {
-					// don't start too close to the end, 
+					// don't start too close to the end,
 					target = new ByteArrayAllocate(target.length);
 					targetView = target.dataView || (target.dataView = new DataView(target.buffer, 0, target.length));
 					safeEnd = target.length - 10;
@@ -1528,7 +1528,7 @@
 								targetView.setUint32(position, referee.id);
 								position += 4;
 								return
-							} else 
+							} else
 								referenceMap.set(value, { offset: position - start });
 						}
 						let constructor = value.constructor;
@@ -1556,7 +1556,7 @@
 									pack(entryValue);
 								}
 							}
-						} else {	
+						} else {
 							for (let i = 0, l = extensions.length; i < l; i++) {
 								let extensionClass = extensionClasses[i];
 								if (value instanceof extensionClass) {
@@ -1624,11 +1624,11 @@
 									if (json !== value)
 										return pack(json)
 								}
-								
+
 								// if there is a writeFunction, use it, otherwise just encode as undefined
 								if (type === 'function')
 									return pack(this.writeFunction && this.writeFunction(value));
-								
+
 								// no extension found, write as plain object
 								writeObject(value);
 							}
@@ -1650,18 +1650,20 @@
 						if (this.largeBigIntToFloat) {
 							target[position++] = 0xcb;
 							targetView.setFloat64(position, Number(value));
-						} else if (this.useBigIntExtension && value < 2n**(1023n) && value > -(2n**(1023n))) {
+						} else if (this.largeBigIntToString) {
+							return pack(value.toString());
+						} else if (this.useBigIntExtension && value < BigInt(2)**BigInt(1023) && value > -(BigInt(2)**BigInt(1023))) {
 							target[position++] = 0xc7;
 							position++;
 							target[position++] = 0x42; // "B" for BigInt
 							let bytes = [];
 							let alignedSign;
 							do {
-								let byte = value & 0xffn;
-								alignedSign = (byte & 0x80n) === (value < 0n ? 0x80n : 0n);
+								let byte = value & BigInt(0xff);
+								alignedSign = (byte & BigInt(0x80)) === (value < BigInt(0) ? BigInt(0x80) : BigInt(0));
 								bytes.push(byte);
-								value >>= 8n;
-							} while (!((value === 0n || value === -1n) && alignedSign));
+								value >>= BigInt(8);
+							} while (!((value === BigInt(0) || value === BigInt(-1)) && alignedSign));
 							target[position-2] = bytes.length;
 							for (let i = bytes.length; i > 0;) {
 								target[position++] = Number(bytes[--i]);
@@ -1669,7 +1671,8 @@
 							return
 						} else {
 							throw new RangeError(value + ' was too large to fit in MessagePack 64-bit integer format, use' +
-								' useBigIntExtension or set largeBigIntToFloat to convert to float-64')
+								' useBigIntExtension, or set largeBigIntToFloat to convert to float-64, or set' +
+								' largeBigIntToString to convert to string')
 						}
 					}
 					position += 8;
@@ -1686,9 +1689,19 @@
 				}
 			};
 
-			const writePlainObject = (this.variableMapSize || this.coercibleKeyAsNumber) ? (object) => {
+			const writePlainObject = (this.variableMapSize || this.coercibleKeyAsNumber || this.skipValues) ? (object) => {
 				// this method is slightly slower, but generates "preferred serialization" (optimally small for smaller objects)
-				let keys = Object.keys(object);
+				let keys;
+				if (this.skipValues) {
+					keys = [];
+					for (let key in object) {
+						if ((typeof object.hasOwnProperty !== 'function' || object.hasOwnProperty(key)) &&
+							!this.skipValues.includes(object[key]))
+							keys.push(key);
+					}
+				} else {
+					keys = Object.keys(object);
+				}
 				let length = keys.length;
 				if (length < 0x10) {
 					target[position++] = 0x80 | length;
@@ -1729,6 +1742,10 @@
 						size++;
 					}
 				}
+				if (size > 0xffff) {
+					throw new Error('Object is too large to serialize with fast 16-bit map size,' +
+					' use the "variableMapSize" option to serialize this object');
+				}
 				target[objectOffset++ + start] = size >> 8;
 				target[objectOffset + start] = size & 0xff;
 			};
@@ -1807,9 +1824,9 @@
 					}
 			};
 
-			// craete reference to useRecords if useRecords is a function
+			// create reference to useRecords if useRecords is a function
 			const checkUseRecords = typeof this.useRecords == 'function' && this.useRecords;
-			
+
 			const writeObject = checkUseRecords ? (object) => {
 				checkUseRecords(object) ? writeRecord(object) : writePlainObject(object);
 			} : writeRecord;
@@ -1937,9 +1954,15 @@
 		useBuffer(buffer) {
 			// this means we are finished using our own buffer and we can write over it safely
 			target = buffer;
-			targetView = new DataView(target.buffer, target.byteOffset, target.byteLength);
+			target.dataView || (target.dataView = new DataView(target.buffer, target.byteOffset, target.byteLength));
 			position = 0;
 		}
+		set position (value) {
+			position = value;
+		}
+		get position() {
+			return position;
+		}
 		clearSharedData() {
 			if (this.structures)
 				this.structures = [];
@@ -2077,7 +2100,7 @@
 			target[position++] = length >> 8;
 			target[position++] = length & 0xff;
 		} else {
-			var { target, position, targetView } = allocateForWrite(length + 5);
+			let { target, position, targetView } = allocateForWrite(length + 5);
 			target[position++] = 0xc6;
 			targetView.setUint32(position, length);
 			position += 4;
@@ -2285,6 +2308,8 @@
 	exports.FLOAT32_OPTIONS = FLOAT32_OPTIONS;
 	exports.NEVER = NEVER;
 	exports.Packr = Packr;
+	exports.RESERVE_START_SPACE = RESERVE_START_SPACE;
+	exports.RESET_BUFFER_MODE = RESET_BUFFER_MODE;
 	exports.REUSE_BUFFER_MODE = REUSE_BUFFER_MODE;
 	exports.Unpackr = Unpackr;
 	exports.addExtension = addExtension;