@harperfast/rocksdb-js 1.4.2 → 2.0.0

package/README.md

@@ -668,12 +668,25 @@ complete, use the `'aftercommit'` event.
 ## Event API
 
 `rocksdb-js` provides a EventEmitter-like API that lets you asynchronously notify events to one or
-more synchronous listener callbacks. Events are scoped by database path.
+more synchronous listener callbacks. There are two types of events:
+
+- Per-database events: scoped by database path.
+- Process-global events: not scoped by database path.
 
 Unlike `EventEmitter`, events are emitted asynchronously, but in the same order that the listeners
 were added.
 
 ```typescript
+// Process-global events
+RocksDatabase.on('log.warn', console.warn);
+
+RocksDatabase.on('foo', (...args) => {
+	console.log(args);
+});
+RocksDatabase.notify('foo', 'bar');
+RocksDatabase.off('foo', callback);
+
+// Per-database events
 const callback = (name) => console.log(`Hi from ${name}`);
 db.addListener('foo', callback);
 db.notify('foo');
@@ -1103,6 +1116,18 @@ for (const entry of rangeIter) {
 Returns the size of the given transaction log sequence file in bytes. Omit the sequence number to
 get the total size of all the transaction log sequence files for this log.
 
+### Transaction Log Initialization
+
+When a database is opened, `rocksdb-js` will automatically discover the transaction log files. If
+a corrupt transaction log file is detected, the `log.warn` event is emitted on the global
+`RocksDatabase` instance. This should be wired up prior to opening the database.
+
+```typescript
+RocksDatabase.on('log.warn', console.warn);
+
+const db = RocksDatabase.open('path/to/db');
+```
+
 ### Transaction Log Parser
 
 #### `parseTransactionLog(file)`

package/dist/index.cjs

@@ -80,6 +80,10 @@ function locateBinding() {
 }
 const binding = req(locateBinding());
 const config = binding.config;
+const addGlobalListener = binding.addListener;
+const removeGlobalListener = binding.removeListener;
+const globalListenerCount = binding.listenerCount;
+const globalNotify = binding.notify;
 const constants = binding.constants;
 const NativeDatabase = binding.Database;
 const NativeIterator = binding.Iterator;
@@ -595,8 +599,6 @@ const VALUE_BUFFER = createFixedBuffer(64 * 1024);
 const ITERATOR_STATE_BUFFER = Buffer.allocUnsafeSlow(8);
 const ITERATOR_STATE = new Uint32Array(ITERATOR_STATE_BUFFER.buffer, ITERATOR_STATE_BUFFER.byteOffset, 2);
 const MAX_KEY_SIZE = 1024 * 1024;
-const RESET_BUFFER_MODE = 1024;
-const REUSE_BUFFER_MODE = 512;
 const SAVE_BUFFER_SIZE = 8192;
 /**
 * A store wraps the `NativeDatabase` binding and database settings so that a
@@ -886,7 +888,7 @@ var Store = class {
 	encodeValue(value) {
 		if (value && value["binary-data"]) return value["binary-data"];
 		if (typeof this.encoder?.encode === "function") {
-			if (this.encoder.copyBuffers) return this.encoder.encode(value, REUSE_BUFFER_MODE | RESET_BUFFER_MODE);
+			if (this.encoder.copyBuffers) return this.encoder.encode(value, 1536);
 			const valueBuffer = this.encoder.encode(value);
 			if (typeof valueBuffer === "string") return Buffer.from(valueBuffer);
 			return valueBuffer;
@@ -1386,6 +1388,60 @@ var RocksDatabase = class RocksDatabase extends DBI {
 	static config(options) {
 		config(options);
 	}
+	/**
+	* Registers a process-wide event listener. Internal events emitted by the
+	* native binding use namespaced keys (e.g. `'transactionLog:warning'`).
+	*
+	* Listeners are not tied to any specific database — they fire for every
+	* matching event emitted in this process.
+	*
+	* @example
+	* ```typescript
+	* RocksDatabase.on('transactionLog:warning', (warning) => {
+	*   console.warn(warning);
+	* });
+	* ```
+	*/
+	static on(event, callback) {
+		addGlobalListener(event, callback);
+	}
+	/**
+	* Alias for {@link RocksDatabase.on}, mirroring the Node `EventEmitter` API.
+	*/
+	static addListener(event, callback) {
+		addGlobalListener(event, callback);
+	}
+	/**
+	* Removes a previously-registered process-wide event listener. The
+	* callback identity must match the one passed to {@link RocksDatabase.on}.
+	*
+	* @returns `true` if a matching listener was removed.
+	*/
+	static off(event, callback) {
+		return removeGlobalListener(event, callback);
+	}
+	/**
+	* Alias for {@link RocksDatabase.off}, mirroring the Node `EventEmitter` API.
+	*/
+	static removeListener(event, callback) {
+		return removeGlobalListener(event, callback);
+	}
+	/**
+	* Returns the number of process-wide listeners registered for the given event.
+	*/
+	static listenerCount(event) {
+		return globalListenerCount(event);
+	}
+	/**
+	* Emits a process-wide event. Mostly intended for tests and as a peer to
+	* {@link RocksDatabase.on} — native code should call `emitGlobalEvent` in
+	* `napi/global_events.h` directly rather than round-tripping through JS.
+	*
+	* @returns `true` if there was at least one listener.
+	*/
+	static notify(event, ...args) {
+		return globalNotify(event, args);
+	}
 	destroy() {
 		this.store.db.destroy();
 	}
@@ -1861,7 +1917,6 @@ var RocksDatabase = class RocksDatabase extends DBI {
 //#region src/parse-transaction-log.ts
 const { TRANSACTION_LOG_TOKEN, TRANSACTION_LOG_ENTRY_HEADER_SIZE: TRANSACTION_LOG_ENTRY_HEADER_SIZE$1 } = constants;
 const MIN_VALID_TIMESTAMP = Date.UTC(2026, 0, 27);
-const VALID_FLAGS_MASK = 1;
 /**
 * Loads an entire transaction log file into memory.
 * @param path - The path to the transaction log file.
@@ -1915,7 +1970,7 @@ function parseTransactionLog(path, options = {}) {
 			const data = read(length);
 			const entryAnomalies = [];
 			if (!Number.isFinite(timestamp) || timestamp < MIN_VALID_TIMESTAMP) entryAnomalies.push(`timestamp ${timestamp} predates 2026-01-27 (possible corruption)`);
-			if ((flags & ~VALID_FLAGS_MASK) !== 0) entryAnomalies.push(`flags 0x${flags.toString(16).padStart(2, "0")} contains undefined bits (expected 0x00 or 0x01)`);
+			if ((flags & -2) !== 0) entryAnomalies.push(`flags 0x${flags.toString(16).padStart(2, "0")} contains undefined bits (expected 0x00 or 0x01)`);
 			const entry = {
 				timestamp,
 				length,
@@ -2132,7 +2187,7 @@ function loadLastPosition(transactionLog, readUncommitted) {
 //#region src/index.ts
 const versions = {
 	rocksdb: version,
-	"rocksdb-js": "1.4.2"
+	"rocksdb-js": "2.0.0"
 };
 
 //#endregion