ordered-binary 1.5.2 → 1.6.0

package/README.md

@@ -1,7 +1,6 @@
 [![npm version](https://img.shields.io/npm/dw/ordered-binary)](https://www.npmjs.org/package/ordered-binary)
 [![npm version](https://img.shields.io/npm/v/ordered-binary.svg?style=flat-square)](https://www.npmjs.org/package/ordered-binary)
 [![license](https://img.shields.io/badge/license-MIT-brightgreen)](LICENSE)
-<a href="https://dev.doctorevidence.com/"><img src="./assets/powers-dre.png" width="203" /></a>
 
 The ordered-binary package provides a representation of JavaScript primitives, serialized into binary format (NodeJS Buffers or Uint8Arrays), such that the binary values are naturally ordered such that it matches the natural ordering or values. For example, since -2.0321 > -2.04, then `toBufferKey(-2.0321)` will be greater than `toBufferKey(-2.04)` as a binary representation, in left-to-right evaluation. This is particular useful for storing keys as binaries with something like LMDB or LevelDB, to avoid any custom sorting.
 

package/dist/index.cjs

@@ -20,6 +20,12 @@ control character types:
 
 const float64Array = new Float64Array(2);
 const int32Array = new Int32Array(float64Array.buffer, 0, 4);
+const {lowIdx, highIdx} = (() => {
+	if (new Uint8Array(new Uint32Array([0xFFEE1100]).buffer)[0] === 0xFF) {
+		return { lowIdx: 1, highIdx: 0 };
+	}
+	return { lowIdx: 0, highIdx: 1 };
+})();
 let nullTerminate = false;
 let textEncoder;
 try {
@@ -69,7 +75,7 @@ function writeKey(key, target, position, inSequence) {
 			}
 		} else {
 			if (target.utf8Write)
-				position += target.utf8Write(key, position, 0xffffffff);
+				position += target.utf8Write(key, position, target.byteLength - position);
 			else
 				position += textEncoder.encodeInto(key, target.subarray(position)).written;
 			if (position > target.length - 4)
@@ -78,8 +84,8 @@ function writeKey(key, target, position, inSequence) {
 		break
 	case 'number':
 		float64Array[0] = key;
-		let lowInt = int32Array[0];
-		let highInt = int32Array[1];
+		let lowInt = int32Array[lowIdx];
+		let highInt = int32Array[highIdx];
 		let length;
 		if (key < 0) {
 			targetView.setInt32(position + 4, ~((lowInt >>> 4) | (highInt << 28)));
@@ -127,18 +133,18 @@ function writeKey(key, target, position, inSequence) {
 		if (BigInt(asFloat) > key) {
 			float64Array[0] = asFloat;
 			if (asFloat > 0) {
-				if (int32Array[0])
-					int32Array[0]--;
+				if (int32Array[lowIdx])
+					int32Array[lowIdx]--;
 				else {
-					int32Array[1]--;
-					int32Array[0] = 0xffffffff;
+					int32Array[highIdx]--;
+					int32Array[lowIdx] = 0xffffffff;
 				}
 			} else {
-				if (int32Array[0] < 0xffffffff)
-					int32Array[0]++;
+				if (int32Array[lowIdx] < 0xffffffff)
+					int32Array[lowIdx]++;
 				else {
-					int32Array[1]++;
-					int32Array[0] = 0;
+					int32Array[highIdx]++;
+					int32Array[lowIdx] = 0;
 				}
 			}
 			asFloat = float64Array[0];
@@ -148,7 +154,7 @@ function writeKey(key, target, position, inSequence) {
 			return writeKey(asFloat, target, position, inSequence)
 		writeKey(asFloat, target, position, inSequence);
 		position += 9; // always increment by 9 if we are adding fractional bits
-		let exponent = BigInt((int32Array[1] >> 20 & 0x7ff) - 1079);
+		let exponent = BigInt((int32Array[highIdx] >> 20 & 0x7ff) - 1079);
 		let nextByte = difference >> exponent;
 		target[position - 1] |= Number(nextByte);
 		difference -= nextByte << exponent;
@@ -222,8 +228,8 @@ function readKey(buffer, start, end, inSequence) {
 				highInt = highInt ^ 0x7fffffff;
 				lowInt = ~lowInt;
 			}
-			int32Array[1] = highInt;
-			int32Array[0] = lowInt;
+			int32Array[highIdx] = highInt;
+			int32Array[lowIdx] = lowInt;
 			value = float64Array[0];
 			position += 9;
 			if (size > 9 && buffer[position] > 0) {
@@ -243,6 +249,7 @@ function readKey(buffer, start, end, inSequence) {
 			position++;
 		}
 		value = readStringSafely(buffer, end);
+		if (position < end) position--; // if have a null terminator for the string, count that as the array separator
 	}
 	while (position < end) {
 		if (buffer[position] === 0)

package/index.js

@@ -16,6 +16,12 @@ control character types:
 
 const float64Array = new Float64Array(2)
 const int32Array = new Int32Array(float64Array.buffer, 0, 4)
+const {lowIdx, highIdx} = (() => {
+	if (new Uint8Array(new Uint32Array([0xFFEE1100]).buffer)[0] === 0xFF) {
+		return { lowIdx: 1, highIdx: 0 };
+	}
+	return { lowIdx: 0, highIdx: 1 };
+})();
 let nullTerminate = false
 let textEncoder
 try {
@@ -65,7 +71,7 @@ export function writeKey(key, target, position, inSequence) {
 			}
 		} else {
 			if (target.utf8Write)
-				position += target.utf8Write(key, position, 0xffffffff)
+				position += target.utf8Write(key, position, target.byteLength - position)
 			else
 				position += textEncoder.encodeInto(key, target.subarray(position)).written
 			if (position > target.length - 4)
@@ -74,8 +80,8 @@ export function writeKey(key, target, position, inSequence) {
 		break
 	case 'number':
 		float64Array[0] = key
-		let lowInt = int32Array[0]
-		let highInt = int32Array[1]
+		let lowInt = int32Array[lowIdx]
+		let highInt = int32Array[highIdx]
 		let length
 		if (key < 0) {
 			targetView.setInt32(position + 4, ~((lowInt >>> 4) | (highInt << 28)))
@@ -123,18 +129,18 @@ export function writeKey(key, target, position, inSequence) {
 		if (BigInt(asFloat) > key) {
 			float64Array[0] = asFloat;
 			if (asFloat > 0) {
-				if (int32Array[0])
-					int32Array[0]--;
+				if (int32Array[lowIdx])
+					int32Array[lowIdx]--;
 				else {
-					int32Array[1]--;
-					int32Array[0] = 0xffffffff;
+					int32Array[highIdx]--;
+					int32Array[lowIdx] = 0xffffffff;
 				}
 			} else {
-				if (int32Array[0] < 0xffffffff)
-					int32Array[0]++;
+				if (int32Array[lowIdx] < 0xffffffff)
+					int32Array[lowIdx]++;
 				else {
-					int32Array[1]++;
-					int32Array[0] = 0;
+					int32Array[highIdx]++;
+					int32Array[lowIdx] = 0;
 				}
 			}
 			asFloat = float64Array[0];
@@ -144,7 +150,7 @@ export function writeKey(key, target, position, inSequence) {
 			return writeKey(asFloat, target, position, inSequence)
 		writeKey(asFloat, target, position, inSequence)
 		position += 9; // always increment by 9 if we are adding fractional bits
-		let exponent = BigInt((int32Array[1] >> 20 & 0x7ff) - 1079);
+		let exponent = BigInt((int32Array[highIdx] >> 20 & 0x7ff) - 1079);
 		let nextByte = difference >> exponent;
 		target[position - 1] |= Number(nextByte);
 		difference -= nextByte << exponent;
@@ -218,8 +224,8 @@ export function readKey(buffer, start, end, inSequence) {
 				highInt = highInt ^ 0x7fffffff
 				lowInt = ~lowInt
 			}
-			int32Array[1] = highInt
-			int32Array[0] = lowInt
+			int32Array[highIdx] = highInt
+			int32Array[lowIdx] = lowInt
 			value = float64Array[0]
 			position += 9
 			if (size > 9 && buffer[position] > 0) {
@@ -239,6 +245,7 @@ export function readKey(buffer, start, end, inSequence) {
 			position++
 		}
 		value = readStringSafely(buffer, end)
+		if (position < end) position-- // if have a null terminator for the string, count that as the array separator
 	}
 	while (position < end) {
 		if (buffer[position] === 0)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "ordered-binary",
   "author": "Kris Zyp",
-  "version": "1.5.2",
+  "version": "1.6.0",
   "description": "Conversion of JavaScript primitives to and from Buffer with binary order matching natural primitive order",
   "license": "MIT",
   "repository": {

package/tests/test.js

@@ -111,6 +111,8 @@ suite('key buffers', () => {
       [4, 5])
     assert.deepEqual(fromBufferKey(toBufferKey(['hello', 5.25])),
       ['hello', 5.25])
+    assert.deepEqual(fromBufferKey(toBufferKey([5, 'hello', null, 5.25])),
+      [5, 'hello', null, 5.25])
     assert.deepEqual(fromBufferKey(toBufferKey([true, 1503579323825])),
       [true, 1503579323825])
     assert.deepEqual(fromBufferKey(toBufferKey([-0.2525, 'sec\x00nd'])),