serializable-bptree 8.1.6 → 8.1.7

package/README.md

@@ -7,7 +7,7 @@
 This is a B+tree that's totally okay with duplicate values. If you need to keep track of the B+ tree's state, don't just leave it in memory - make sure you write it down.
 
 ```typescript
-import { readFileSync, writeFileSync, unlinkSync, existsSync } from 'fs'
+import { readFileSync, writeFileSync, unlinkSync, existsSync } from 'node:fs'
 import {
   BPTreeSync,
   SerializeStrategySync,
@@ -91,6 +91,8 @@ Additionally, this library supports asynchronous operations and rule-based query
 
 ```bash
 npm i serializable-bptree
+# or
+npx jsr add @izure/serializable-bptree
 ```
 
 ```typescript

package/dist/cjs/index.cjs

@@ -343,6 +343,30 @@ var MVCCTransaction = class {
       deleted
     };
   }
+  /**
+   * Checks for conflicts among multiple transactions.
+   * A conflict occurs if two or more transactions modify (write or delete) the same key.
+   * @param transactions Array of transactions to check.
+   * @returns An array of keys that are in conflict.
+   */
+  static CheckConflicts(transactions) {
+    const modifiedKeys = /* @__PURE__ */ new Map();
+    const conflicts = /* @__PURE__ */ new Set();
+    for (const tx of transactions) {
+      const txModified = /* @__PURE__ */ new Set([
+        ...tx.writeBuffer.keys(),
+        ...tx.deleteBuffer
+      ]);
+      for (const key of txModified) {
+        const count = modifiedKeys.get(key) ?? 0;
+        if (count > 0) {
+          conflicts.add(key);
+        }
+        modifiedKeys.set(key, count + 1);
+      }
+    }
+    return Array.from(conflicts);
+  }
   /**
    * Cleans up both deletedCache and versionIndex based on minActiveVersion.
    * Root transactions call this after commit to reclaim memory.
@@ -1632,6 +1656,15 @@ var BPTreeTransaction = class _BPTreeTransaction {
     }
     return best;
   }
+  /**
+   * Checks for conflicts between multiple transactions.
+   * 
+   * @param transactions Array of BPTreeTransaction instances to check
+   * @returns An array of keys that are in conflict. Empty array if no conflicts.
+   */
+  static CheckConflicts(transactions) {
+    return MVCCTransaction.CheckConflicts(transactions.map((tx) => tx.mvcc));
+  }
   /**
    * Returns the ID of the root node.
    * @returns The root node ID.
@@ -2084,11 +2117,7 @@ var BPTreeSyncTransaction = class extends BPTreeTransaction {
         const { root, order } = head;
         this.strategy.head = head;
         this.order = order;
-        this._writeHead({
-          root,
-          order: this.order,
-          data: this.strategy.head.data
-        });
+        this.rootId = root;
       }
       if (this.order < 3) {
         throw new Error(`The 'order' parameter must be greater than 2. but got a '${this.order}'.`);
@@ -2414,6 +2443,12 @@ var BPTreeSyncTransaction = class extends BPTreeTransaction {
     return node;
   }
   delete(key, value) {
+    if (value === void 0) {
+      value = this.get(key);
+    }
+    if (value === void 0) {
+      return;
+    }
     let node = this.insertableNodeByPrimary(value);
     let found = false;
     while (true) {
@@ -2865,14 +2900,6 @@ var BPTreeAsyncTransaction = class extends BPTreeTransaction {
       next,
       prev
     };
-    const head = await this._readHead();
-    if (head) {
-      await this._writeHead({
-        root: head.root,
-        order: head.order,
-        data: this.strategy.head.data
-      });
-    }
     await this.mvcc.create(id, node);
     return node;
   }
@@ -3165,11 +3192,7 @@ var BPTreeAsyncTransaction = class extends BPTreeTransaction {
         const { root, order } = head;
         this.strategy.head = head;
         this.order = order;
-        await this._writeHead({
-          root,
-          order: this.order,
-          data: this.strategy.head.data
-        });
+        this.rootId = root;
       }
       if (this.order < 3) {
         throw new Error(`The 'order' parameter must be greater than 2. but got a '${this.order}'.`);
@@ -3498,6 +3521,12 @@ var BPTreeAsyncTransaction = class extends BPTreeTransaction {
   }
   async delete(key, value) {
     return this.writeLock(0, async () => {
+      if (value === void 0) {
+        value = await this.get(key);
+      }
+      if (value === void 0) {
+        return;
+      }
       let node = await this.insertableNodeByPrimary(value);
       let found = false;
       while (true) {

package/dist/esm/index.mjs

@@ -307,6 +307,30 @@ var MVCCTransaction = class {
       deleted
     };
   }
+  /**
+   * Checks for conflicts among multiple transactions.
+   * A conflict occurs if two or more transactions modify (write or delete) the same key.
+   * @param transactions Array of transactions to check.
+   * @returns An array of keys that are in conflict.
+   */
+  static CheckConflicts(transactions) {
+    const modifiedKeys = /* @__PURE__ */ new Map();
+    const conflicts = /* @__PURE__ */ new Set();
+    for (const tx of transactions) {
+      const txModified = /* @__PURE__ */ new Set([
+        ...tx.writeBuffer.keys(),
+        ...tx.deleteBuffer
+      ]);
+      for (const key of txModified) {
+        const count = modifiedKeys.get(key) ?? 0;
+        if (count > 0) {
+          conflicts.add(key);
+        }
+        modifiedKeys.set(key, count + 1);
+      }
+    }
+    return Array.from(conflicts);
+  }
   /**
    * Cleans up both deletedCache and versionIndex based on minActiveVersion.
    * Root transactions call this after commit to reclaim memory.
@@ -1596,6 +1620,15 @@ var BPTreeTransaction = class _BPTreeTransaction {
     }
     return best;
   }
+  /**
+   * Checks for conflicts between multiple transactions.
+   * 
+   * @param transactions Array of BPTreeTransaction instances to check
+   * @returns An array of keys that are in conflict. Empty array if no conflicts.
+   */
+  static CheckConflicts(transactions) {
+    return MVCCTransaction.CheckConflicts(transactions.map((tx) => tx.mvcc));
+  }
   /**
    * Returns the ID of the root node.
    * @returns The root node ID.
@@ -2048,11 +2081,7 @@ var BPTreeSyncTransaction = class extends BPTreeTransaction {
         const { root, order } = head;
         this.strategy.head = head;
         this.order = order;
-        this._writeHead({
-          root,
-          order: this.order,
-          data: this.strategy.head.data
-        });
+        this.rootId = root;
       }
       if (this.order < 3) {
         throw new Error(`The 'order' parameter must be greater than 2. but got a '${this.order}'.`);
@@ -2378,6 +2407,12 @@ var BPTreeSyncTransaction = class extends BPTreeTransaction {
     return node;
   }
   delete(key, value) {
+    if (value === void 0) {
+      value = this.get(key);
+    }
+    if (value === void 0) {
+      return;
+    }
     let node = this.insertableNodeByPrimary(value);
     let found = false;
     while (true) {
@@ -2829,14 +2864,6 @@ var BPTreeAsyncTransaction = class extends BPTreeTransaction {
       next,
       prev
     };
-    const head = await this._readHead();
-    if (head) {
-      await this._writeHead({
-        root: head.root,
-        order: head.order,
-        data: this.strategy.head.data
-      });
-    }
     await this.mvcc.create(id, node);
     return node;
   }
@@ -3129,11 +3156,7 @@ var BPTreeAsyncTransaction = class extends BPTreeTransaction {
         const { root, order } = head;
         this.strategy.head = head;
         this.order = order;
-        await this._writeHead({
-          root,
-          order: this.order,
-          data: this.strategy.head.data
-        });
+        this.rootId = root;
       }
       if (this.order < 3) {
         throw new Error(`The 'order' parameter must be greater than 2. but got a '${this.order}'.`);
@@ -3462,6 +3485,12 @@ var BPTreeAsyncTransaction = class extends BPTreeTransaction {
   }
   async delete(key, value) {
     return this.writeLock(0, async () => {
+      if (value === void 0) {
+        value = await this.get(key);
+      }
+      if (value === void 0) {
+        return;
+      }
       let node = await this.insertableNodeByPrimary(value);
       let found = false;
       while (true) {

package/dist/types/BPTreeAsync.d.ts

@@ -10,5 +10,5 @@ export declare class BPTreeAsync<K, V> extends BPTreeAsyncTransaction<K, V> {
      */
     createTransaction(): Promise<BPTreeAsyncTransaction<K, V>>;
     insert(key: K, value: V): Promise<void>;
-    delete(key: K, value: V): Promise<void>;
+    delete(key: K, value?: V): Promise<void>;
 }

package/dist/types/BPTreeSync.d.ts

@@ -10,5 +10,5 @@ export declare class BPTreeSync<K, V> extends BPTreeSyncTransaction<K, V> {
      */
     createTransaction(): BPTreeSyncTransaction<K, V>;
     insert(key: K, value: V): void;
-    delete(key: K, value: V): void;
+    delete(key: K, value?: V): void;
 }

package/dist/types/base/BPTreeTransaction.d.ts

@@ -55,6 +55,13 @@ export declare abstract class BPTreeTransaction<K, V> {
         tree: T;
         condition: BPTreeCondition<unknown>;
     } | null;
+    /**
+     * Checks for conflicts between multiple transactions.
+     *
+     * @param transactions Array of BPTreeTransaction instances to check
+     * @returns An array of keys that are in conflict. Empty array if no conflicts.
+     */
+    static CheckConflicts<K, V>(transactions: BPTreeTransaction<K, V>[]): string[];
     /**
      * Returns the ID of the root node.
      * @returns The root node ID.
@@ -131,10 +138,13 @@ export declare abstract class BPTreeTransaction<K, V> {
     abstract insert(key: K, value: V): Deferred<void>;
     /**
      * Deletes the pair that matches the key and value.
+     *
      * @param key The key of the pair. This key must be unique.
      * @param value The value of the pair.
+     *
+     * @warning If the 'value' is not specified, a full scan will be performed to find the value associated with the key, which may lead to performance degradation.
      */
-    abstract delete(key: K, value: V): Deferred<void>;
+    abstract delete(key: K, value?: V): Deferred<void>;
     /**
      * It returns whether there is a value in the tree.
      * @param key The key value to search for. This key must be unique.

package/dist/types/transaction/BPTreeAsyncTransaction.d.ts

@@ -43,7 +43,7 @@ export declare class BPTreeAsyncTransaction<K, V> extends BPTreeTransaction<K, V
     where(condition: BPTreeCondition<V>, order?: BPTreeOrder): Promise<BPTreePair<K, V>>;
     insert(key: K, value: V): Promise<void>;
     protected _deleteEntry(node: BPTreeUnknownNode<K, V>, key: BPTreeNodeKey<K>): Promise<BPTreeUnknownNode<K, V>>;
-    delete(key: K, value: V): Promise<void>;
+    delete(key: K, value?: V): Promise<void>;
     getHeadData(): Promise<SerializableData>;
     setHeadData(data: SerializableData): Promise<void>;
     commit(label?: string): Promise<TransactionResult<string, BPTreeNode<K, V>>>;

package/dist/types/transaction/BPTreeSyncTransaction.d.ts

@@ -40,7 +40,7 @@ export declare class BPTreeSyncTransaction<K, V> extends BPTreeTransaction<K, V>
     where(condition: BPTreeCondition<V>, order?: BPTreeOrder): BPTreePair<K, V>;
     insert(key: K, value: V): void;
     protected _deleteEntry(node: BPTreeUnknownNode<K, V>, key: BPTreeNodeKey<K>): BPTreeUnknownNode<K, V>;
-    delete(key: K, value: V): void;
+    delete(key: K, value?: V): void;
     getHeadData(): SerializableData;
     setHeadData(data: SerializableData): void;
     commit(label?: string): TransactionResult<string, BPTreeNode<K, V>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "serializable-bptree",
-  "version": "8.1.6",
+  "version": "8.1.7",
   "description": "Store the B+tree flexibly, not only in-memory.",
   "types": "./dist/types/index.d.ts",
   "main": "./dist/cjs/index.cjs",
@@ -38,13 +38,13 @@
   "license": "MIT",
   "devDependencies": {
     "@types/jest": "^30.0.0",
-    "esbuild": "^0.27.2",
+    "esbuild": "^0.27.3",
     "jest": "^30.2.0",
     "ts-jest": "^29.4.6",
     "typescript": "^5.9.3"
   },
   "dependencies": {
-    "mvcc-api": "^1.3.3",
+    "mvcc-api": "^1.3.4",
     "ryoiki": "^1.2.0"
   }
 }