@wxn0brp/db-storage-bin 0.0.3 → 0.0.5

package/CHANGELOG.md

@@ -2,6 +2,21 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [0.0.5](https://github.com/wxn0brp/ValtheraDB-storage-bin/compare/v0.0.4...v0.0.5) (2025-09-04)
+
+
+### Bug Fixes
+
+* crc and new crc mode ([cc79715](https://github.com/wxn0brp/ValtheraDB-storage-bin/commit/cc7971591dbcd39fd5b9371644d2c3e9997f0dbc))
+
+### [0.0.4](https://github.com/wxn0brp/ValtheraDB-storage-bin/compare/v0.0.3...v0.0.4) (2025-09-04)
+
+
+### Features
+
+* add generic, BinManager.write<T> ([a2bb851](https://github.com/wxn0brp/ValtheraDB-storage-bin/commit/a2bb851c2b3977d133b85bde917dd268b3256a41))
+* format.encode(data, collection) ([6a20cb5](https://github.com/wxn0brp/ValtheraDB-storage-bin/commit/6a20cb57444ac6e9e1d5a61a63316f6e3184118e))
+
 ### [0.0.3](https://github.com/wxn0brp/ValtheraDB-storage-bin/compare/v0.0.2...v0.0.3) (2025-08-24)
 
 

package/dist/bin/data.d.ts

@@ -2,5 +2,5 @@ import { BinManager, CollectionMeta } from "./index.js";
 import { FileMeta } from "./head.js";
 export declare function findCollection(cmp: BinManager, name: string): CollectionMeta | undefined;
 export declare function findFreeSlot(cmp: BinManager, size: number): Promise<FileMeta["freeList"][number] | undefined>;
-export declare function writeLogic(cmp: BinManager, collection: string, data: object[]): Promise<void>;
+export declare function writeLogic(cmp: BinManager, collection: string, data: any): Promise<void>;
 export declare function readLogic(cmp: BinManager, collection: string): Promise<any>;

package/dist/bin/data.js

@@ -23,7 +23,7 @@ export async function writeLogic(cmp, collection, data) {
     const { fd, meta } = cmp;
     await _log(3, "Writing data to collection:", collection);
     const existingCollection = findCollection(cmp, collection);
-    const encoded = Buffer.from(await cmp.options.format.encode(data));
+    const encoded = Buffer.from(await cmp.options.format.encode(data, collection));
     const length = encoded.length;
     const capacity = roundUpCapacity(meta, length + 4);
     let offset = existingCollection?.offset;
@@ -71,7 +71,8 @@ export async function writeLogic(cmp, collection, data) {
         await _log(2, "Capacity exceeded");
     }
     else {
-        if (cmp.options.crc) {
+        const crc = cmp.options.crc;
+        if (crc === 3 || crc === 4) {
             const { computedCrc } = await getFileCrc(fd);
             const crcBuf = Buffer.alloc(16);
             crcBuf.writeUInt32LE(computedCrc);
@@ -85,5 +86,5 @@ export async function readLogic(cmp, collection) {
         throw new Error("Collection not found");
     const len = await readData(cmp.fd, collectionMeta.offset, 4);
     const data = await readData(cmp.fd, collectionMeta.offset + 4, len.readUInt32LE(0));
-    return await cmp.options.format.decode(data);
+    return await cmp.options.format.decode(data, collection);
 }

package/dist/bin/head.js

@@ -51,7 +51,7 @@ export async function openFile(cmp) {
         }
         if (!validCrc) {
             await _log(0, "err", "Invalid CRC");
-            if (options.crc === 2)
+            if (options.crc === 2 || options.crc === 4)
                 throw new Error("Invalid CRC");
         }
     }
@@ -76,7 +76,7 @@ export async function readHeaderPayload(cmp) {
         await _log(6, "err", `Incomplete payload header read: expected ${payloadLength} bytes, got ${bytesRead}`);
         throw new Error(`Incomplete payload header read: expected ${payloadLength} bytes, got ${bytesRead}`);
     }
-    const obj = await cmp.options.format.decode(payloadBuf);
+    const obj = await cmp.options.format.decode(payloadBuf, "");
     meta.collections = (obj.c || []).map(([name, offset, capacity]) => ({ name, offset, capacity }));
     meta.freeList = (obj.f || []).map(([offset, capacity]) => ({ offset, capacity }));
     await _log(6, "Collections and freeList loaded", meta);
@@ -94,7 +94,7 @@ export async function saveHeaderAndPayload(cmp, recursion = false) {
     const { collections, freeList, fileSize } = meta;
     await _log(6, "Saving header payload:", collections, freeList);
     const payloadObj = getHeaderPayload(meta);
-    const payloadBuf = Buffer.from(await cmp.options.format.encode(payloadObj));
+    const payloadBuf = Buffer.from(await cmp.options.format.encode(payloadObj, ""));
     if (payloadBuf.length > 64 * 1024) {
         console.error("Header payload too large");
         throw new Error("Header payload too large");

package/dist/bin/index.d.ts

@@ -11,12 +11,14 @@ export interface Options {
      * 0 - crc off
      * 1 - warn if error
      * 2 - throw if error
+     * 3 - 1 & save always on edit
+     * 4 - 2 & save always on edit
      */
     crc: number;
     overwriteRemovedCollection: boolean;
     format: {
-        encode(data: any): Promise<Parameters<typeof Buffer.from>[0]>;
-        decode(data: Buffer): Promise<any>;
+        encode(data: any, collection: string): Promise<Parameters<typeof Buffer.from>[0]>;
+        decode(data: Buffer, collection: string): Promise<any>;
     };
 }
 export declare class BinManager {
@@ -34,7 +36,8 @@ export declare class BinManager {
     constructor(path: string, options?: Partial<Options>);
     open(): Promise<void>;
     close(): Promise<void>;
-    write(collection: string, data: object[]): Promise<void>;
+    [Symbol.asyncDispose](): Promise<void>;
+    write<T = object[]>(collection: string, data: T): Promise<void>;
     read(collection: string): Promise<any>;
     optimize(): Promise<void>;
     removeCollection(collection: string): Promise<void>;

package/dist/bin/index.js

@@ -64,6 +64,9 @@ export class BinManager {
             this.fd = null;
         }
     }
+    [Symbol.asyncDispose]() {
+        return this.close();
+    }
     async write(collection, data) {
         if (!this.fd)
             throw new Error("File not open");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wxn0brp/db-storage-bin",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "author": "wxn0brP",

package/src/bin/data.ts

@@ -27,12 +27,12 @@ export async function findFreeSlot(cmp: BinManager, size: number): Promise<FileM
     return slot;
 }
 
-export async function writeLogic(cmp: BinManager, collection: string, data: object[]) {
+export async function writeLogic(cmp: BinManager, collection: string, data: any) {
     const { fd, meta } = cmp;
     await _log(3, "Writing data to collection:", collection);
 
     const existingCollection = findCollection(cmp, collection);
-    const encoded = Buffer.from(await cmp.options.format.encode(data));
+    const encoded = Buffer.from(await cmp.options.format.encode(data, collection));
     const length = encoded.length;
     const capacity = roundUpCapacity(meta, length + 4);
 
@@ -80,7 +80,8 @@ export async function writeLogic(cmp: BinManager, collection: string, data: obje
         await saveHeaderAndPayload(cmp);
         await _log(2, "Capacity exceeded");
     } else {
-        if (cmp.options.crc) {
+        const crc = cmp.options.crc;
+        if (crc === 3 || crc === 4) {
             const { computedCrc } = await getFileCrc(fd);
             const crcBuf = Buffer.alloc(16);
             crcBuf.writeUInt32LE(computedCrc);
@@ -95,5 +96,5 @@ export async function readLogic(cmp: BinManager, collection: string) {
 
     const len = await readData(cmp.fd, collectionMeta.offset, 4);
     const data = await readData(cmp.fd, collectionMeta.offset + 4, len.readUInt32LE(0));
-    return await cmp.options.format.decode(data);
+    return await cmp.options.format.decode(data, collection);
 }

package/src/bin/head.ts

@@ -74,7 +74,7 @@ export async function openFile(cmp: BinManager) {
         }
         if (!validCrc) {
             await _log(0, "err", "Invalid CRC");
-            if (options.crc === 2)
+            if (options.crc === 2 || options.crc === 4)
                 throw new Error("Invalid CRC");
         }
     }
@@ -106,7 +106,7 @@ export async function readHeaderPayload(cmp: BinManager) {
         throw new Error(`Incomplete payload header read: expected ${payloadLength} bytes, got ${bytesRead}`);
     }
 
-    const obj = await cmp.options.format.decode(payloadBuf) as {
+    const obj = await cmp.options.format.decode(payloadBuf, "") as {
         c: [string, number, number][];
         f: [number, number][];
     };
@@ -133,7 +133,7 @@ export async function saveHeaderAndPayload(cmp: BinManager, recursion = false) {
 
     const payloadObj = getHeaderPayload(meta);
 
-    const payloadBuf = Buffer.from(await cmp.options.format.encode(payloadObj));
+    const payloadBuf = Buffer.from(await cmp.options.format.encode(payloadObj, ""));
     if (payloadBuf.length > 64 * 1024) {
         console.error("Header payload too large");
         throw new Error("Header payload too large");

package/src/bin/index.ts

@@ -29,12 +29,14 @@ export interface Options {
      * 0 - crc off
      * 1 - warn if error
      * 2 - throw if error
+     * 3 - 1 & save always on edit
+     * 4 - 2 & save always on edit
      */
     crc: number;
     overwriteRemovedCollection: boolean;
     format: {
-        encode(data: any): Promise<Parameters<typeof Buffer.from>[0]>;
-        decode(data: Buffer): Promise<any>;
+        encode(data: any, collection: string): Promise<Parameters<typeof Buffer.from>[0]>;
+        decode(data: Buffer, collection: string): Promise<any>;
     }
 }
 
@@ -87,7 +89,11 @@ export class BinManager {
         }
     }
 
-    async write(collection: string, data: object[]) {
+    [Symbol.asyncDispose]() {
+        return this.close();
+    }
+
+    async write<T = object[]>(collection: string, data: T) {
         if (!this.fd) throw new Error("File not open");
         await writeLogic(this, collection, data);
     }