@wxn0brp/db-storage-bin 0.0.2 → 0.0.3

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 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.3](https://github.com/wxn0brp/ValtheraDB-storage-bin/compare/v0.0.2...v0.0.3) (2025-08-24)
+
+
+### Bug Fixes
+
+* crc ([2b872a1](https://github.com/wxn0brp/ValtheraDB-storage-bin/commit/2b872a11fc42c32bbbeed80c76d62524426392d5))
+
 ### 0.0.2 (2025-08-24)
 
 

package/README.md

@@ -1,13 +1,11 @@
 # ValtheraDB Bin Plugin
 
-This is a proof-of-concept for an addon/plugin for the `@wxn0brp/db` (ValtheraDB) library.
-
 The purpose of this experiment is to create a storage layer that allows ValtheraDB, which normally operates on a directory/file structure, to instead use a single binary file for data storage.
 
 ## Installation
 
 ```bash
-yarn add github:wxn0brP/ValtheraDB-storage-bin#dist
+yarn add @wxn0brp/db-storage-bin
 ```
 
 ## Usage
@@ -55,6 +53,11 @@ Returns an object containing:
 -   `options`:
     -   `preferredSize`: The preferred block size for the database (default: `256`).
 
+## Documentation
+
+- [Data Structure](https://github.com/wxn0brP/ValtheraDB-storage-bin/blob/master/docs/data-structure.md)
+- [ValtheraDB-Core](https://github.com/wxn0brP/ValtheraDB-core)
+
 ## License
 
 This project is licensed under the MIT License.

package/dist/bin/data.js

@@ -1,3 +1,4 @@
+import { getFileCrc } from "../crc32.js";
 import { _log } from "../log.js";
 import { saveHeaderAndPayload } from "./head.js";
 import { detectCollisions, pushToFreeList, readData, roundUpCapacity, writeData } from "./utils.js";
@@ -69,6 +70,14 @@ export async function writeLogic(cmp, collection, data) {
         await saveHeaderAndPayload(cmp);
         await _log(2, "Capacity exceeded");
     }
+    else {
+        if (cmp.options.crc) {
+            const { computedCrc } = await getFileCrc(fd);
+            const crcBuf = Buffer.alloc(16);
+            crcBuf.writeUInt32LE(computedCrc);
+            await writeData(fd, 16, crcBuf, 16);
+        }
+    }
 }
 export async function readLogic(cmp, collection) {
     const collectionMeta = findCollection(cmp, collection);

package/docs/data-structure.md

@@ -0,0 +1,44 @@
+# Data Structure
+
+This document describes the data structure used by the binary database format.
+
+## File Layout
+
+The file is structured as follows:
+
+1. **Header (64 bytes)**: Contains metadata about the file.
+2. **Payload**: Contains the serialized collections and free list data.
+3. **Data Blocks**: Contains the actual data for each collection.
+
+### Header
+
+The header is a fixed-size block of 64 bytes, structured as follows:
+
+| Offset | Size | Name         | Description                                           |
+|--------|------|--------------|-------------------------------------------------------|
+| 0      | 4    | Version      | File format version (currently 1)                     |
+| 4      | 4    | Payload Len  | Length of the payload data                            |
+| 8      | 4    | Payload Off  | Offset of the payload data from the header start      |
+| 12     | 4    | Block Size   | Preferred block size for allocations                  |
+| 16     | 4    | CRC32        | CRC32 checksum of the file (excluding this field)     |
+| 20     | 44   | Reserved     | Reserved for future use                               |
+
+### Payload
+
+The payload contains the serialized list of collections and free blocks. It is a msgpack-encoded object with the following structure:
+
+```ts
+{
+  c: [string, number, number][]; // Collections: [name, offset, capacity]
+  f: [number, number][];         // Free blocks: [offset, capacity]
+}
+```
+
+### Data Blocks
+
+Each collection's data is stored in a data block. A data block consists of:
+
+1. **Length (4 bytes)**: A 32-bit unsigned integer representing the length of the data (Uint32).
+2. **Data (variable)**: The actual data, padded to the nearest block size.
+
+The data is serialized using msgpack.

package/package.json

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

package/src/bin/data.ts

@@ -1,4 +1,5 @@
 import { BinManager, CollectionMeta } from ".";
+import { getFileCrc } from "../crc32";
 import { _log } from "../log";
 import { FileMeta, saveHeaderAndPayload } from "./head";
 import { detectCollisions, pushToFreeList, readData, roundUpCapacity, writeData } from "./utils";
@@ -78,6 +79,13 @@ export async function writeLogic(cmp: BinManager, collection: string, data: obje
         });
         await saveHeaderAndPayload(cmp);
         await _log(2, "Capacity exceeded");
+    } else {
+        if (cmp.options.crc) {
+            const { computedCrc } = await getFileCrc(fd);
+            const crcBuf = Buffer.alloc(16);
+            crcBuf.writeUInt32LE(computedCrc);
+            await writeData(fd, 16, crcBuf, 16);
+        }
     }
 }