chubakabra 0.2.0 → 0.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "chubakabra",
-	"version": "0.2.0",
+	"version": "0.3.0",
 	"type": "module",
 	"description": "Browser and Node.js utilities for working with key-addressable byte ranges in large binary files",
 	"exports": {

package/src/node/index.js

@@ -7,17 +7,22 @@ const RANGE_SIZE = 16
 export function readKvrHeader(path)
 {
 	const fd = fs.openSync(path, "r")
-	const b = Buffer.alloc(HEADER_SIZE)
-	fs.readSync(fd, b, 0, HEADER_SIZE, 0)
+	const buf = Buffer.alloc(HEADER_SIZE)
+	fs.readSync(fd, buf, 0, HEADER_SIZE, 0)
 	fs.closeSync(fd)
 
-	if (b.toString("ascii", 0, 3) !== MAGIC || b[3] !== 1)
+	if (
+		buf[0] !== 0x4B || // K
+		buf[1] !== 0x56 || // V
+		buf[2] !== 0x52 || // R
+		buf[3] !== 1
+	)
 		throw new Error("Invalid KVR file")
 
 	return {
-		keySize: b.readUInt16LE(4),
-		indexCount: b.readUInt32LE(6),
-		indexOffset: Number(b.readBigUInt64LE(10))
+		keySize: buf.readUInt16LE(4),
+		indexCount: buf.readUInt32LE(6),
+		indexOffset: Number(buf.readBigUInt64LE(10))
 	}
 }
 
@@ -37,6 +42,7 @@ export function readKvrIndex(path)
 	for (let i = 0; i < h.indexCount; i++)
 	{
 		const o = i * entrySize
+
 		entries.push({
 			key: buf.subarray(o, o + h.keySize),
 			range: [
@@ -46,7 +52,10 @@ export function readKvrIndex(path)
 		})
 	}
 
-	return { keySize: h.keySize, entries }
+	return {
+		keySize: h.keySize,
+		entries
+	}
 }
 
 export function readKvrRange(path, range)
@@ -61,11 +70,23 @@ export function readKvrRange(path, range)
 
 export function writeKvr(path, entries, codec)
 {
+	if (entries.length === 0)
+		throw new Error("Empty entries")
+
 	const keySize = entries[0].key.length * codec.size
+
+	for (const e of entries)
+	{
+		if (e.key.length * codec.size !== keySize)
+			throw new Error("Inconsistent key size")
+	}
+
 	const fd = fs.openSync(path, "w")
 
 	const header = Buffer.alloc(HEADER_SIZE)
-	header.write(MAGIC, 0)
+	header[0] = 0x4B
+	header[1] = 0x56
+	header[2] = 0x52
 	header[3] = 1
 	header.writeUInt16LE(keySize, 4)
 	header.writeUInt32LE(entries.length, 6)
@@ -76,7 +97,6 @@ export function writeKvr(path, entries, codec)
 	let offset = HEADER_SIZE
 	const index = []
 
-	// DATA
 	for (const e of entries)
 	{
 		index.push({
@@ -89,21 +109,19 @@ export function writeKvr(path, entries, codec)
 		offset += e.data.length
 	}
 
-	// INDEX
 	const indexOffset = offset
 
 	for (const i of index)
 	{
-		const b = Buffer.alloc(keySize + RANGE_SIZE)
-		i.key.copy(b, 0)
-		b.writeBigUInt64LE(BigInt(i.from), keySize)
-		b.writeBigUInt64LE(BigInt(i.to), keySize + 8)
+		const buf = Buffer.alloc(keySize + RANGE_SIZE)
+		i.key.copy(buf, 0)
+		buf.writeBigUInt64LE(BigInt(i.from), keySize)
+		buf.writeBigUInt64LE(BigInt(i.to), keySize + 8)
 
-		fs.writeSync(fd, b, 0, b.length, offset)
-		offset += b.length
+		fs.writeSync(fd, buf, 0, buf.length, offset)
+		offset += buf.length
 	}
 
-	// PATCH header
 	header.writeBigUInt64LE(BigInt(indexOffset), 10)
 	fs.writeSync(fd, header, 0, HEADER_SIZE, 0)
 
@@ -112,19 +130,19 @@ export function writeKvr(path, entries, codec)
 
 export function packKey(arr, codec)
 {
-	const b = Buffer.alloc(arr.length * codec.size)
+	const buf = Buffer.alloc(arr.length * codec.size)
 	for (let i = 0; i < arr.length; i++)
-		codec.write(b, arr[i], i * codec.size)
-	return b
+		codec.write(buf, arr[i], i * codec.size)
+	return buf
 }
 
 export function unpackKey(buf, codec)
 {
-	const n = buf.length / codec.size
-	const a = new Array(n)
-	for (let i = 0; i < n; i++)
-		a[i] = codec.read(buf, i * codec.size)
-	return a
+	const count = buf.length / codec.size
+	const arr = new Array(count)
+	for (let i = 0; i < count; i++)
+		arr[i] = codec.read(buf, i * codec.size)
+	return arr
 }
 
 export function createElementCodec(type)