document-dataply 0.0.1 → 0.0.2-alpha.0

package/dist/cjs/index.js

@@ -6776,11 +6776,11 @@ var require_cjs = __commonJS({
        * Retrieves metadata from the dataply.
        * @returns Metadata of the dataply.
        */
-      async getMetadata() {
+      async getMetadata(tx) {
         if (!this.initialized) {
           throw new Error("Dataply instance is not initialized");
         }
-        return this.runWithDefault((tx) => this.rowTableEngine.getMetadata(tx));
+        return this.runWithDefault((tx2) => this.rowTableEngine.getMetadata(tx2), tx);
       }
       /**
        * Inserts data. Returns the PK of the added row.
@@ -6932,8 +6932,8 @@ var require_cjs = __commonJS({
        * Retrieves metadata from the dataply.
        * @returns Metadata of the dataply.
        */
-      async getMetadata() {
-        return this.api.getMetadata();
+      async getMetadata(tx) {
+        return this.api.getMetadata(tx);
       }
       /**
        * Inserts data. Returns the PK of the added row.
@@ -7073,7 +7073,7 @@ var DocumentSerializeStrategyAsync = class extends import_dataply.SerializeStrat
   }
   async readHead() {
     const tx = this.txContext.get();
-    const metadata = await this.api.getDocumentMetadata(tx);
+    const metadata = await this.api.getDocumentInnerMetadata(tx);
     if (metadata.treeHeads[this.treeKey]) {
       return metadata.treeHeads[this.treeKey];
     }
@@ -7081,9 +7081,9 @@ var DocumentSerializeStrategyAsync = class extends import_dataply.SerializeStrat
   }
   async writeHead(head) {
     const tx = this.txContext.get();
-    const metadata = await this.api.getDocumentMetadata(tx);
+    const metadata = await this.api.getDocumentInnerMetadata(tx);
     metadata.treeHeads[this.treeKey] = head;
-    await this.api.updateDocumentMetadata(metadata, tx);
+    await this.api.updateDocumentInnerMetadata(metadata, tx);
   }
 };
 
@@ -7124,7 +7124,7 @@ var DocumentDataplyAPI = class extends import_dataply3.DataplyAPI {
       if (!await this.verifyDocumentFile(tx)) {
         throw new Error("Document metadata verification failed");
       }
-      const metadata = await this.getDocumentMetadata(tx);
+      const metadata = await this.getDocumentInnerMetadata(tx);
       this.treeHeads = metadata.treeHeads;
       return tx;
     });
@@ -7193,19 +7193,27 @@ var DocumentDataplyAPI = class extends import_dataply3.DataplyAPI {
     return result;
   }
   async getDocumentMetadata(tx) {
+    const metadata = await this.getMetadata(tx);
+    return {
+      pageSize: metadata.pageSize,
+      pageCount: metadata.pageCount,
+      rowCount: metadata.rowCount
+    };
+  }
+  async getDocumentInnerMetadata(tx) {
     const row = await this.select(1, false, tx);
     if (!row) {
       throw new Error("Document metadata not found");
     }
     return JSON.parse(row);
   }
-  async updateDocumentMetadata(metadata, tx) {
+  async updateDocumentInnerMetadata(metadata, tx) {
     await this.update(1, JSON.stringify(metadata), tx);
   }
   async updateTreeHead(tx) {
-    const metadata = await this.getDocumentMetadata(tx);
+    const metadata = await this.getDocumentInnerMetadata(tx);
     metadata.treeHeads = this.treeHeads;
-    await this.updateDocumentMetadata(metadata, tx);
+    await this.updateDocumentInnerMetadata(metadata, tx);
   }
 };
 var DocumentDataply = class {
@@ -7222,9 +7230,21 @@ var DocumentDataply = class {
   constructor(file, options) {
     this.api = new DocumentDataplyAPI(file, options ?? {});
   }
+  /**
+   * Initialize the document database
+   */
   async init() {
     await this.api.init();
   }
+  /**
+   * Get the metadata of the document database
+   */
+  async getMetadata(tx) {
+    return this.api.runWithDefault((tx2) => this.api.getDocumentMetadata(tx2), tx);
+  }
+  /**
+   * Create a transaction
+   */
   createTransaction() {
     return this.api.createTransaction();
   }
@@ -7250,7 +7270,7 @@ var DocumentDataply = class {
     return result;
   }
   /**
-   * Return optimized tree for query
+   * Get the selectivity candidate for the given query
    * @param query 
    * @returns 
    */
@@ -7273,9 +7293,9 @@ var DocumentDataply = class {
     };
   }
   async insertDocument(document, tx) {
-    const metadata = await this.api.getDocumentMetadata(tx);
+    const metadata = await this.api.getDocumentInnerMetadata(tx);
     const id = metadata.lastId++;
-    await this.api.updateDocumentMetadata(metadata, tx);
+    await this.api.updateDocumentInnerMetadata(metadata, tx);
     const dataplyDocument = Object.assign({
       _id: id
     }, document);
@@ -7286,6 +7306,12 @@ var DocumentDataply = class {
       document: dataplyDocument
     };
   }
+  /**
+   * Insert a document into the database
+   * @param document The document to insert
+   * @param tx The transaction to use
+   * @returns True if the document was inserted successfully
+   */
   async insert(document, tx) {
     return this.api.runWithDefault(async (tx2) => {
       const { k, document: dataplyDocument } = await this.insertDocument(document, tx2);
@@ -7298,6 +7324,13 @@ var DocumentDataply = class {
       return true;
     }, tx);
   }
+  /**
+   * Select documents from the database
+   * @param query The query to use
+   * @param limit The maximum number of documents to return
+   * @param tx The transaction to use
+   * @returns The documents that match the query
+   */
   async select(query, limit = Infinity, tx) {
     return this.api.runWithDefault(async (tx2) => {
       const verbose = this.verboseQuery(query);
@@ -7331,6 +7364,9 @@ var DocumentDataply = class {
       return documents;
     }, tx);
   }
+  /**
+   * Close the document database
+   */
   async close() {
     await this.api.close();
   }

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

@@ -1,14 +1,14 @@
-import type { DataplyTreeValue, DocumentDataplyMetadata, DocumentDataplyOptions, DocumentJSON, FlattenedDocumentJSON, Primitive, DocumentDataplyQuery, FinalFlatten, DocumentDataplyCondition, DataplyDocument } from '../types';
+import type { DataplyTreeValue, DocumentDataplyInnerMetadata, DocumentDataplyOptions, DocumentJSON, FlattenedDocumentJSON, Primitive, DocumentDataplyQuery, FinalFlatten, DocumentDataplyCondition, DataplyDocument, DocumentDataplyMetadata } from '../types';
 import { DataplyAPI, Transaction, BPTreeAsync } from 'dataply';
 import { DocumentValueComparator } from './bptree/documentComparator';
 export declare class DocumentDataplyAPI<T extends DocumentJSON> extends DataplyAPI {
     runWithDefault: <T_1>(callback: (tx: Transaction) => Promise<T_1>, tx?: Transaction) => Promise<T_1>;
-    treeHeads: DocumentDataplyMetadata['treeHeads'];
+    treeHeads: DocumentDataplyInnerMetadata['treeHeads'];
     readonly trees: Map<string, BPTreeAsync<number, DataplyTreeValue<Primitive>>>;
     readonly comparator: DocumentValueComparator<DataplyTreeValue<Primitive>, Primitive>;
     constructor(file: string, options: DocumentDataplyOptions);
     ensureTree<T extends Primitive>(field: string): Promise<BPTreeAsync<number, DataplyTreeValue<T>>>;
-    createDocumentMetadata(): DocumentDataplyMetadata;
+    createDocumentMetadata(): DocumentDataplyInnerMetadata;
     initializeDocumentFile(tx: Transaction): Promise<void>;
     verifyDocumentFile(tx: Transaction): Promise<boolean>;
     /**
@@ -18,18 +18,29 @@ export declare class DocumentDataplyAPI<T extends DocumentJSON> extends DataplyA
      */
     flattenDocument(document: T): FlattenedDocumentJSON;
     getDocumentMetadata(tx: Transaction): Promise<DocumentDataplyMetadata>;
-    updateDocumentMetadata(metadata: DocumentDataplyMetadata, tx: Transaction): Promise<void>;
+    getDocumentInnerMetadata(tx: Transaction): Promise<DocumentDataplyInnerMetadata>;
+    updateDocumentInnerMetadata(metadata: DocumentDataplyInnerMetadata, tx: Transaction): Promise<void>;
     updateTreeHead(tx: Transaction): Promise<void>;
 }
 export declare class DocumentDataply<T extends DocumentJSON> {
     protected readonly api: DocumentDataplyAPI<T>;
     private readonly operatorConverters;
     constructor(file: string, options?: DocumentDataplyOptions);
+    /**
+     * Initialize the document database
+     */
     init(): Promise<void>;
+    /**
+     * Get the metadata of the document database
+     */
+    getMetadata(tx?: Transaction): Promise<DocumentDataplyMetadata>;
+    /**
+     * Create a transaction
+     */
     createTransaction(): Transaction;
     private verboseQuery;
     /**
-     * Return optimized tree for query
+     * Get the selectivity candidate for the given query
      * @param query
      * @returns
      */
@@ -44,7 +55,23 @@ export declare class DocumentDataply<T extends DocumentJSON> {
         }[];
     } | null>;
     private insertDocument;
+    /**
+     * Insert a document into the database
+     * @param document The document to insert
+     * @param tx The transaction to use
+     * @returns True if the document was inserted successfully
+     */
     insert(document: T, tx?: Transaction): Promise<boolean>;
+    /**
+     * Select documents from the database
+     * @param query The query to use
+     * @param limit The maximum number of documents to return
+     * @param tx The transaction to use
+     * @returns The documents that match the query
+     */
     select(query: Partial<DocumentDataplyQuery<FinalFlatten<DataplyDocument<T>>>>, limit?: number, tx?: Transaction): Promise<DataplyDocument<T>[]>;
+    /**
+     * Close the document database
+     */
     close(): Promise<void>;
 }

package/dist/types/types/index.d.ts

@@ -9,7 +9,7 @@ export type DocumentJSON = {
 export type FlattenedDocumentJSON = {
     [key: string]: Primitive;
 };
-export interface DocumentDataplyMetadata {
+export interface DocumentDataplyInnerMetadata {
     magicString: string;
     version: number;
     createdAt: number;
@@ -17,6 +17,20 @@ export interface DocumentDataplyMetadata {
     lastId: number;
     treeHeads: Record<string, SerializeStrategyHead>;
 }
+export interface DocumentDataplyMetadata {
+    /**
+     * The size of a page in bytes.
+     */
+    pageSize: number;
+    /**
+     * The total number of pages in the dataply.
+     */
+    pageCount: number;
+    /**
+     * The total number of data rows in the dataply.
+     */
+    rowCount: number;
+}
 export type DataplyDocumentBase = {
     _id: number;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "document-dataply",
-  "version": "0.0.1",
+  "version": "0.0.2-alpha.0",
   "description": "",
   "license": "MIT",
   "author": "izure <admin@izure.org>",
@@ -26,7 +26,7 @@
     "build": "node build/index.js && tsc"
   },
   "dependencies": {
-    "dataply": "^0.0.14"
+    "dataply": "^0.0.16-alpha.0"
   },
   "devDependencies": {
     "@types/jest": "^30.0.0",