document-dataply 0.0.3-alpha.2 → 0.0.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 izure
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/cjs/index.js

@@ -10045,6 +10045,18 @@ var DocumentDataply = class _DocumentDataply {
       return deletedCount;
     }, tx));
   }
+  /**
+   * Count documents from the database that match the query
+   * @param query The query to use (only indexed fields + _id allowed)
+   * @param tx The transaction to use
+   * @returns The number of documents that match the query
+   */
+  async count(query, tx) {
+    return this.api.readLock(() => this.api.runWithDefault(async (tx2) => {
+      const pks = await this.getKeys(query);
+      return pks.size;
+    }, tx));
+  }
   /**
    * Select documents from the database
    * @param query The query to use (only indexed fields + _id allowed)
@@ -10065,6 +10077,7 @@ var DocumentDataply = class _DocumentDataply {
     }
     const {
       limit = Infinity,
+      offset = 0,
       sortOrder = "asc",
       orderBy: orderByField
     } = options;
@@ -10092,17 +10105,25 @@ var DocumentDataply = class _DocumentDataply {
           const cmp = aVal < bVal ? -1 : aVal > bVal ? 1 : 0;
           return sortOrder === "asc" ? cmp : -cmp;
         });
-        const limitedResults = results.slice(0, limit === Infinity ? void 0 : limit);
+        const start = offset;
+        const end = limit === Infinity ? void 0 : start + limit;
+        const limitedResults = results.slice(start, end);
         for (const doc of limitedResults) {
           yield doc;
         }
       } else {
         let i = 0;
+        let yieldedCount = 0;
         for (const key of keys) {
-          if (i >= limit) break;
+          if (yieldedCount >= limit) break;
+          if (i < offset) {
+            i++;
+            continue;
+          }
           const stringified = await self.api.select(key, false, tx2);
           if (!stringified) continue;
           yield JSON.parse(stringified);
+          yieldedCount++;
           i++;
         }
       }

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

@@ -149,6 +149,13 @@ export declare class DocumentDataply<T extends DocumentJSON, IC extends IndexCon
      * @returns The number of deleted documents
      */
     delete(query: Partial<DocumentDataplyIndexedQuery<T, IC>>, tx?: Transaction): Promise<number>;
+    /**
+     * Count documents from the database that match the query
+     * @param query The query to use (only indexed fields + _id allowed)
+     * @param tx The transaction to use
+     * @returns The number of documents that match the query
+     */
+    count(query: Partial<DocumentDataplyIndexedQuery<T, IC>>, tx?: Transaction): Promise<number>;
     /**
      * Select documents from the database
      * @param query The query to use (only indexed fields + _id allowed)

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

@@ -62,9 +62,25 @@ export interface DataplyTreeValue<T> {
     k: number;
     v: T;
 }
+/**
+ * Options for querying documents.
+ */
 export type DocumentDataplyQueryOptions<T extends DocumentJSON, IC extends IndexConfig<T>> = {
+    /**
+     * The maximum number of documents to return.
+     */
     limit?: number;
+    /**
+     * The number of documents to skip.
+     */
+    offset?: number;
+    /**
+     * The field to order the results by.
+     */
     orderBy?: ExtractIndexKeys<T, IC> | '_id';
+    /**
+     * The order to sort the results by.
+     */
     sortOrder?: BPTreeOrder;
 };
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "document-dataply",
-  "version": "0.0.3-alpha.2",
+  "version": "0.0.3",
   "description": "Simple and powerful JSON document database supporting complex queries and flexible indexing policies.",
   "license": "MIT",
   "author": "izure <admin@izure.org>",
@@ -42,7 +42,7 @@
     "dataply"
   ],
   "dependencies": {
-    "dataply": "^0.0.19-alpha.0"
+    "dataply": "^0.0.19"
   },
   "devDependencies": {
     "@types/jest": "^30.0.0",
@@ -51,4 +51,4 @@
     "ts-jest": "^29.4.6",
     "typescript": "^5.9.3"
   }
-}
+}

package/{README.md → readme.md}

@@ -1,4 +1,5 @@
 ![node.js workflow](https://github.com/izure1/document-dataply/actions/workflows/node.js.yml/badge.svg)
+![Performance Benchmark](https://github.com/izure1/document-dataply/actions/workflows/benchmark.yml/badge.svg)
 ![License](https://img.shields.io/badge/license-MIT-blue.svg)
 
 # Document-Dataply
@@ -180,24 +181,17 @@ Flushes changes and closes the database files.
 
 ## Benchmark
 
-The following benchmarks were conducted using the `npm run benchmark` command. The results show the performance of various operations on a dataset of **10,000** documents.
+Automated benchmarks are executed on every push to the `main` branch and for every pull request. This ensures that performance regressions are detected early.
 
-- **Package Version**: `0.0.3-alpha.1`
-- **Batch Size**: 1,000 items per batch (for bulk operations)
-- **Iterations**: 5 full lifecycle cycles
+- **Dataset**: 10,000 documents
+- **Operations**: Batch Insert, Indexed Select, Partial Update, Full Update, Delete
 
-### Benchmark Results
+### Performance Trend
 
-| Operation | Count | Avg Time (ms) | Ops/s | Min (ms) | Max (ms) | Remarks |
-| :--- | :---: | :---: | :---: | :---: | :---: | :--- |
-| **InsertBatch** | 10,000 | 6499.22 | **1,538** | 5891.53 | 7403.67 | 1000 items per batch |
-| **Select** | 100 | 30.09 | **3,323** | 26.09 | 37.16 | Indexed Equality |
-| **Partial Update** | 100 | 86.44 | **1,157** | 74.15 | 115.22 | Bulk Update |
-| **Full Update** | 1 | 20.77 | **48** | 16.10 | 25.61 | Single Update |
-| **Delete** | 100 | 5893.65 | **17** | 5523.06 | 6173.39 | Page Reclamation |
+You can view the real-time performance trend and detailed metrics on our [Performance Dashboard](https://izure1.github.io/document-dataply/dev/bench/).
 
-> [!NOTE]
-> **Performance Analysis**: The `Delete (Bulk)` operation takes more time compared to other operations because it involves intensive index tree restructuring and physical **Page Reclamation (Garbage Collection)** logic to maintain storage efficiency after massive data removal.
+> [!TIP]
+> **Continuous Monitoring**: We use `github-action-benchmark` to monitor performance changes. For every PR, a summary of the performance impact is automatically commented to help maintain high efficiency.
 
 ## License