Merge branch 'kriszyp:master' into chore/semantic-release

Author: roggervalf

SECURITY.md

@@ -0,0 +1,11 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.4.x   | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+Please report security vulnerabilities to [email protected].

index.d.ts

@@ -1,4 +1,4 @@
-export { Unpackr, Decoder, unpack, decode, addExtension, FLOAT32_OPTIONS, clearSource } from './unpack'
+export { Unpackr, Decoder, unpack, decode, addExtension, FLOAT32_OPTIONS, clearSource, roundFloat32 } from './unpack'
 import { Options } from './unpack'
 export { Packr, Encoder, pack, encode } from './pack'
 import { Transform, Readable } from 'stream'

index.js

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

pack.js

@@ -58,7 +58,7 @@ export class Packr extends Unpackr {
 		let transitionsCount = 0
 		let serializationsSinceTransitionRebuild = 0
 
-		this.pack = this.encode = function(value) {
+		this.pack = this.encode = function(value, encodeOptions) {
 			if (!target) {
 				target = new ByteArrayAllocate(8192)
 				targetView = new DataView(target.buffer, 0, 8192)
@@ -123,6 +123,11 @@ export class Packr extends Unpackr {
 					referenceMap = null
 					return serialized
 				}
+				if (encodeOptions === REUSE_BUFFER_MODE) {
+					target.start = start
+					target.end = position
+					return target
+				}
 				return target.subarray(start, position) // position can change if we call pack again in saveStructures, so we get the buffer now
 			} finally {
 				if (sharedStructures) {
@@ -146,13 +151,15 @@ export class Packr extends Unpackr {
 						if (sharedStructures.length > sharedLength) {
 							sharedStructures = sharedStructures.slice(0, sharedLength)
 						}
-
+						// we can't rely on start/end with REUSE_BUFFER_MODE since they will (probably) change when we save
+						let returnBuffer = target.subarray(start, position)
 						if (packr.saveStructures(sharedStructures, lastSharedStructuresLength) === false) {
 							// get updated structures and try again if the update failed
 							packr._mergeStructures(packr.getStructures())
 							return packr.pack(value)
 						}
 						lastSharedStructuresLength = sharedLength
+						return returnBuffer
 					}
 				}
 			}
@@ -817,3 +824,4 @@ export const Encoder = Packr
 export { FLOAT32_OPTIONS } from './unpack.js'
 import { FLOAT32_OPTIONS } from './unpack.js'
 export const { NEVER, ALWAYS, DECIMAL_ROUND, DECIMAL_FIT } = FLOAT32_OPTIONS
+export const REUSE_BUFFER_MODE = 1000

package.json

@@ -1,10 +1,11 @@
 {
   "name": "msgpackr",
   "author": "Kris Zyp",
-  "version": "1.4.4",
+  "version": "1.4.5",
   "description": "Ultra-fast MessagePack implementation with extensions for records and structured cloning",
   "license": "MIT",
   "types": "./index.d.ts",
+  "main": "./dist/index.js",
   "keywords": [
     "MessagePack",
     "msgpack",
@@ -19,6 +20,7 @@
   "scripts": {
     "benchmark": "node ./tests/benchmark.cjs",
     "build": "rollup -c",
+    "dry-run": "npm publish --dry-run",
     "prepare": "npm run build",
     "semantic-release": "semantic-release",
     "test": "mocha tests/test**.*js -u tdd --experimental-json-modules"

tests/test-compatibility.cjs

@@ -1,18 +1,20 @@
 const data = require('./example4.json');
-const { pack, unpack } = require('msgpackr/pack');
+const { pack, unpack, Packr } = require('msgpackr/pack');
 const chai = require('chai');
 
 function tryRequire(module) {
 	try {
 		return require(module)
 	} catch(error) {
+		console.log(error)
 	}
 }
 //if (typeof chai === 'undefined') { chai = require('chai') }
 const assert = chai.assert
 //if (typeof msgpackr === 'undefined') { msgpackr = require('..') }
 var msgpack_msgpack = tryRequire('@msgpack/msgpack');
 var msgpack_lite = tryRequire('msgpack-lite');
+var msgpack = tryRequire('msgpack');
 
 const addCompatibilitySuite = (data) => () => {
 	if (msgpack_msgpack) {
@@ -41,8 +43,22 @@ const addCompatibilitySuite = (data) => () => {
 			assert.deepEqual(deserialized, data)
 		})
 	}
+	if (msgpack) {
+		test.skip('from msgpack', function(){
+			var serialized = msgpack.pack(data)
+			var deserialized = unpack(serialized)
+			assert.deepEqual(deserialized, data)
+		})
+
+		test('to msgpack', function(){
+			var serialized = pack(data)
+			var deserialized = msgpack.unpack(serialized)
+			assert.deepEqual(deserialized, data)
+		})
+	}
 }
 
 suite('msgpackr compatibility tests (example)', addCompatibilitySuite(require('./example.json')))
 suite('msgpackr compatibility tests (example4)', addCompatibilitySuite(require('./example4.json')))
-suite('msgpackr compatibility tests (example5)', addCompatibilitySuite(require('./example5.json')))
+suite('msgpackr compatibility tests (example5)', addCompatibilitySuite(require('./example5.json')))
+suite.skip('msgpackr compatibility tests with dates', addCompatibilitySuite({ date: new Date() }))

unpack.d.ts

@@ -25,8 +25,10 @@ export interface Options {
 interface Extension {
 	Class: Function
 	type: number
-	pack(value: any): Buffer | Uint8Array
-	unpack(messagePack: Buffer | Uint8Array): any
+	pack?(value: any): Buffer | Uint8Array
+	unpack?(messagePack: Buffer | Uint8Array): any	
+	read?(datum: any): any
+	write?(instance: any): any
 }
 export class Unpackr {
 	constructor(options?: Options)