dataply 0.0.7 → 0.0.9

package/dist/types/core/DataplyAPI.d.ts

@@ -1,15 +1,12 @@
 import type { DataplyOptions, DataplyMetadata } from '../types';
-import { type IHookall, type IHookallSync } from 'hookall';
+import { type IHookall } from 'hookall';
 import { PageFileSystem } from './PageFileSystem';
 import { RowTableEngine } from './RowTableEngine';
 import { TextCodec } from '../utils/TextCodec';
 import { LockManager } from './transaction/LockManager';
 import { Transaction } from './transaction/Transaction';
-interface DataplyAPISyncHook {
-    create: (_: void, file: string, fileHandle: number, options: Required<DataplyOptions>) => void;
-}
 interface DataplyAPIAsyncHook {
-    init: () => Promise<void>;
+    init: (tx: Transaction, isNewlyCreated: boolean) => Promise<Transaction>;
     close: () => Promise<void>;
 }
 /**
@@ -17,17 +14,28 @@ interface DataplyAPIAsyncHook {
  */
 export declare class DataplyAPI {
     protected readonly file: string;
+    /**
+     * These are not the same options that were used when the database was created.
+     * They are simply the options received when the instance was created.
+     * If you want to retrieve the options used during database creation, use `getMetadata()` instead.
+     */
     readonly options: Required<DataplyOptions>;
+    /** File handle. Database file descriptor */
     protected readonly fileHandle: number;
+    /** Page file system. Used for managing pages. If you know what it is, you can skip this. */
     protected readonly pfs: PageFileSystem;
+    /** Row table engine. Used for managing rows. If you know what it is, you can skip this. */
     protected readonly rowTableEngine: RowTableEngine;
+    /** Lock manager. Used for managing transactions */
     protected readonly lockManager: LockManager;
+    /** Text codec. Used for encoding and decoding text data */
     protected readonly textCodec: TextCodec;
-    protected readonly hook: {
-        sync: IHookallSync<DataplyAPISyncHook>;
-        async: IHookall<DataplyAPIAsyncHook>;
-    };
+    /** Hook */
+    protected readonly hook: IHookall<DataplyAPIAsyncHook>;
+    /** Whether the database was initialized via `init()` */
     protected initialized: boolean;
+    /** Whether the database was created this time. */
+    private readonly isNewlyCreated;
     private txIdCounter;
     constructor(file: string, options: DataplyOptions);
     /**
@@ -94,6 +102,14 @@ export declare class DataplyAPI {
      * @returns PK of the added data
      */
     insert(data: string | Uint8Array, incrementRowCount?: boolean, tx?: Transaction): Promise<number>;
+    /**
+     * Inserts overflow data forcly. Returns the PK of the added row.
+     * @param data Data to add
+     * @param incrementRowCount Whether to increment the row count to metadata
+     * @param tx Transaction
+     * @returns PK of the added data
+     */
+    insertAsOverflow(data: string | Uint8Array, incrementRowCount?: boolean, tx?: Transaction): Promise<number>;
     /**
      * Inserts multiple data in batch.
      * If a transaction is not provided, it internally creates a single transaction to process.

package/dist/types/core/RowTableEngine.d.ts

@@ -64,7 +64,7 @@ export declare class RowTableEngine {
      * @param tx Transaction
      * @returns PK of the inserted data
      */
-    insert(data: Uint8Array, incrementRowCount: boolean, tx: Transaction): Promise<number>;
+    insert(data: Uint8Array, incrementRowCount: boolean, overflowForcly: boolean, tx: Transaction): Promise<number>;
     /**
      * Looks up the RID by PK.
      * Checks Pending Updates first if a transaction exists.

package/dist/types/index.d.ts

@@ -2,7 +2,7 @@ export * from 'serializable-bptree';
 export * from 'ryoiki';
 export * from 'cache-entanglement';
 export type { DataplyOptions } from './types';
-export type * from './core/Page';
+export * from './core/Page';
 export { Dataply } from './core/Dataply';
 export { DataplyAPI } from './core/DataplyAPI';
 export { Transaction } from './core/transaction/Transaction';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dataply",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "description": "A lightweight storage engine for Node.js with support for MVCC, WAL.",
   "license": "MIT",
   "author": "izure <admin@izure.org>",

package/readme.md

@@ -178,6 +178,8 @@ Rolls back all added transactions.
 
 If you want to extend Dataply's functionality, use the `DataplyAPI` class. Unlike the standard `Dataply` class, `DataplyAPI` provides direct access to internal components like `PageFileSystem` or `RowTableEngine`, offering much more flexibility for custom implementations.
 
+For a detailed guide and examples on how to extend Dataply using Hooks, see [Extending Dataply Guide](docs/extension.md).
+
 ### Using DataplyAPI
 
 ```typescript
@@ -222,7 +224,7 @@ graph TD
 - **Fixed-size Pages**: All data is managed in fixed-size units (default 8KB) called pages.
 - **VFS Cache**: Minimizes disk I/O by caching frequently accessed pages in memory.
 - **Dirty Page Tracking**: Tracks modified pages (Dirty) to synchronize them with disk efficiently only at the time of commit.
-- **Detailed Structure**: For technical details on the physical layout, see [structure.md](structure.md).
+- **Detailed Structure**: For technical details on the physical layout, see [structure.md](docs/structure.md).
 
 #### Page & Row Layout
 Dataply uses a **Slotted Page** architecture to manage records efficiently:

package/dist/types/core/RowIndexBPTree.d.ts

@@ -1,6 +0,0 @@
-import { BPTreeAsync } from 'serializable-bptree';
-export declare class RowIndexBPTree<K, V, C> extends BPTreeAsync<K, V> {
-    private _bindContext?;
-    bindContext(context?: C): void;
-    getContext(): C | undefined;
-}