msgpackr 1.10.2 → 1.11.0

package/index.d.cts

@@ -38,22 +38,23 @@ interface Extension {
 	Class?: Function
 	type?: number
 	pack?(value: any): Buffer | Uint8Array
-	unpack?(messagePack: Buffer | Uint8Array): any	
+	unpack?(messagePack: Buffer | Uint8Array): any
 	read?(datum: any): any
 	write?(instance: any): any
 }
+export type UnpackOptions = { start?: number; end?: number; lazy?: boolean; } | number;
 export class Unpackr {
 	constructor(options?: Options)
-	unpack(messagePack: Buffer | Uint8Array): any
-	decode(messagePack: Buffer | Uint8Array): any
+	unpack(messagePack: Buffer | Uint8Array, options?: UnpackOptions): any
+	decode(messagePack: Buffer | Uint8Array, options?: UnpackOptions): any
 	unpackMultiple(messagePack: Buffer | Uint8Array): any[]
 	unpackMultiple(messagePack: Buffer | Uint8Array, forEach: (value: any, start?: number, end?: number) => any): void
 }
 export class Decoder extends Unpackr {}
-export function unpack(messagePack: Buffer | Uint8Array): any
+export function unpack(messagePack: Buffer | Uint8Array, options?: UnpackOptions): any
 export function unpackMultiple(messagePack: Buffer | Uint8Array): any[]
 export function unpackMultiple(messagePack: Buffer | Uint8Array, forEach: (value: any, start?: number, end?: number) => any): void
-export function decode(messagePack: Buffer | Uint8Array): any
+export function decode(messagePack: Buffer | Uint8Array, options?: UnpackOptions): any
 export function addExtension(extension: Extension): void
 export function clearSource(): void
 export function roundFloat32(float32Number: number): number
@@ -61,12 +62,20 @@ export const C1: {}
 export let isNativeAccelerationEnabled: boolean
 
 export class Packr extends Unpackr {
-	pack(value: any): Buffer
-	encode(value: any): Buffer
+	offset: number;
+	position: number;
+	pack(value: any, encodeOptions?: number): Buffer
+	encode(value: any, encodeOptions?: number): Buffer
+	useBuffer(buffer: Buffer | Uint8Array): void;
+	clearSharedData(): void;
 }
 export class Encoder extends Packr {}
-export function pack(value: any): Buffer
-export function encode(value: any): Buffer
+export function pack(value: any, encodeOptions?: number): Buffer
+export function encode(value: any, encodeOptions?: number): Buffer
+
+export const REUSE_BUFFER_MODE: number;
+export const RESET_BUFFER_MODE: number;
+export const RESERVE_START_SPACE: number;
 
 import { Transform, Readable } from 'stream'
 

package/index.d.ts

@@ -38,22 +38,23 @@ interface Extension {
 	Class?: Function
 	type?: number
 	pack?(value: any): Buffer | Uint8Array
-	unpack?(messagePack: Buffer | Uint8Array): any	
+	unpack?(messagePack: Buffer | Uint8Array): any
 	read?(datum: any): any
 	write?(instance: any): any
 }
+export type UnpackOptions = { start?: number; end?: number; lazy?: boolean; } | number;
 export class Unpackr {
 	constructor(options?: Options)
-	unpack(messagePack: Buffer | Uint8Array): any
-	decode(messagePack: Buffer | Uint8Array): any
+	unpack(messagePack: Buffer | Uint8Array, options?: UnpackOptions): any
+	decode(messagePack: Buffer | Uint8Array, options?: UnpackOptions): any
 	unpackMultiple(messagePack: Buffer | Uint8Array): any[]
 	unpackMultiple(messagePack: Buffer | Uint8Array, forEach: (value: any, start?: number, end?: number) => any): void
 }
 export class Decoder extends Unpackr {}
-export function unpack(messagePack: Buffer | Uint8Array): any
+export function unpack(messagePack: Buffer | Uint8Array, options?: UnpackOptions): any
 export function unpackMultiple(messagePack: Buffer | Uint8Array): any[]
 export function unpackMultiple(messagePack: Buffer | Uint8Array, forEach: (value: any, start?: number, end?: number) => any): void
-export function decode(messagePack: Buffer | Uint8Array): any
+export function decode(messagePack: Buffer | Uint8Array, options?: UnpackOptions): any
 export function addExtension(extension: Extension): void
 export function clearSource(): void
 export function roundFloat32(float32Number: number): number
@@ -61,12 +62,20 @@ export const C1: {}
 export let isNativeAccelerationEnabled: boolean
 
 export class Packr extends Unpackr {
-	pack(value: any): Buffer
-	encode(value: any): Buffer
+	offset: number;
+	position: number;
+	pack(value: any, encodeOptions?: number): Buffer
+	encode(value: any, encodeOptions?: number): Buffer
+	useBuffer(buffer: Buffer | Uint8Array): void;
+	clearSharedData(): void;
 }
 export class Encoder extends Packr {}
-export function pack(value: any): Buffer
-export function encode(value: any): Buffer
+export function pack(value: any, encodeOptions?: number): Buffer
+export function encode(value: any, encodeOptions?: number): Buffer
+
+export const REUSE_BUFFER_MODE: number;
+export const RESET_BUFFER_MODE: number;
+export const RESERVE_START_SPACE: number;
 
 import { Transform, Readable } from 'stream'
 

package/index.js

@@ -1,4 +1,4 @@
-export { Packr, Encoder, addExtension, pack, encode, NEVER, ALWAYS, DECIMAL_ROUND, DECIMAL_FIT, REUSE_BUFFER_MODE } from './pack.js'
+export { Packr, Encoder, addExtension, pack, encode, NEVER, ALWAYS, DECIMAL_ROUND, DECIMAL_FIT, REUSE_BUFFER_MODE, RESET_BUFFER_MODE, RESERVE_START_SPACE } from './pack.js'
 export { Unpackr, Decoder, C1, unpack, unpackMultiple, decode, FLOAT32_OPTIONS, clearSource, roundFloat32, isNativeAccelerationEnabled } from './unpack.js'
 export { decodeIter, encodeIter } from './iterators.js'
 export const useRecords = false

package/pack.js

@@ -53,7 +53,7 @@ export class Packr extends Unpackr {
 		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) {
@@ -71,7 +71,7 @@ export class Packr extends Unpackr {
 			}
 			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
@@ -414,7 +414,7 @@ export class Packr extends Unpackr {
 							targetView.setUint32(position, referee.id)
 							position += 4
 							return
-						} else 
+						} else
 							referenceMap.set(value, { offset: position - start })
 					}
 					let constructor = value.constructor
@@ -442,7 +442,7 @@ export class Packr extends Unpackr {
 								pack(entryValue)
 							}
 						}
-					} else {	
+					} else {
 						for (let i = 0, l = extensions.length; i < l; i++) {
 							let extensionClass = extensionClasses[i]
 							if (value instanceof extensionClass) {
@@ -510,11 +510,11 @@ export class Packr extends Unpackr {
 								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)
 						}
@@ -572,9 +572,19 @@ export class Packr extends Unpackr {
 			}
 		}
 
-		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
@@ -693,9 +703,9 @@ export class Packr extends Unpackr {
 				}
 		}
 
-		// 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
@@ -823,9 +833,15 @@ export class Packr extends Unpackr {
 	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 = []
@@ -834,12 +850,6 @@ export class Packr extends Unpackr {
 	}
 }
 
-function copyBinary(source, target, targetOffset, offset, endOffset) {
-	while (offset < endOffset) {
-		target[targetOffset++] = source[offset++]
-	}
-}
-
 extensionClasses = [ Date, Set, Error, RegExp, ArrayBuffer, Object.getPrototypeOf(Uint8Array.prototype).constructor /*TypedArray*/, C1Type ]
 extensions = [{
 	pack(date, allocateForWrite, pack) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "msgpackr",
   "author": "Kris Zyp",
-  "version": "1.10.2",
+  "version": "1.11.0",
   "description": "Ultra-fast MessagePack implementation with extensions for records and structured cloning",
   "license": "MIT",
   "types": "./index.d.ts",

package/struct.js

@@ -504,6 +504,8 @@ function readStruct(src, position, srcEnd, unpackr) {
 		src = Uint8Array.prototype.slice.call(src, position, srcEnd);
 		srcEnd -= position;
 		position = 0;
+		if (!unpackr.getStructures)
+			throw new Error(`Reference to shared structure ${recordId} without getStructures method`);
 		unpackr._mergeStructures(unpackr.getStructures());
 		if (!unpackr.typedStructs)
 			throw new Error('Could not find any shared typed structures');