albedo-node 0.5.91 → 0.6.0

package/dist/index.d.ts

@@ -12,6 +12,28 @@ interface ObjectIdConstructor {
     new (buffer?: ByteBuffer): ObjectIdInstance;
     fromString(str: string): ObjectIdInstance;
 }
+/**
+ * Controls when fsync is called to guarantee write durability.
+ */
+type WriteDurability = "all" | {
+    periodic: number;
+} | "manual";
+/**
+ * Controls how page reads interact with the WAL.
+ */
+type ReadDurability = "shared" | "process";
+/**
+ * Options for opening a bucket.
+ */
+interface OpenBucketOptions {
+    buildIdIndex?: boolean;
+    mode?: string;
+    auto_vaccuum?: boolean;
+    page_cache_capacity?: number;
+    wal?: boolean;
+    write_durability?: WriteDurability;
+    read_durability?: ReadDurability;
+}
 export declare const albedo: any;
 export default albedo;
 export declare const BSON: {
@@ -68,7 +90,7 @@ export declare class Bucket {
      * const bucket = Bucket.open('data.db');
      * ```
      */
-    static open(path: string): Bucket;
+    static open(path: string, options?: OpenBucketOptions): Bucket;
     /**
      * Close the bucket and release native resources.
      * @example
@@ -136,6 +158,30 @@ export declare class Bucket {
      * ```
      */
     list<T>(query?: object | Query): Generator<T>;
+    /**
+     * Async iterator that continuously polls for documents matching the
+     * optional query. Unlike `list`, when there are no more results the
+     * iterator waits for `pollingTimeout` milliseconds and retries,
+     * making it suitable for watching a bucket for new data.
+     *
+     * The native cursor is closed automatically when the consumer breaks
+     * out of the loop or the iterator is otherwise disposed.
+     *
+     * @param query - filter or `Query` object
+     * @param options - polling configuration
+     * @param options.pollingTimeout - ms to wait before retrying when
+     *   `listData` returns `null` (default `50`)
+     * @yields each document deserialized from the bucket
+     * @example
+     * ```ts
+     * for await (const user of bucket.stream<User>(where('active', { $eq: true }))) {
+     *   console.log(user);
+     * }
+     * ```
+     */
+    stream<T>(query?: object | Query, options?: {
+        pollingTimeout?: number;
+    }): AsyncGenerator<T>;
     /**
      * Collect all documents matching the optional query into an array.
      * @param query - filter or `Query` object

package/dist/index.js

@@ -89,8 +89,8 @@ class Bucket {
      * const bucket = Bucket.open('data.db');
      * ```
      */
-    static open(path) {
-        const handle = exports.albedo.open(path);
+    static open(path, options) {
+        const handle = options ? exports.albedo.open_with_options(path, options) : exports.albedo.open(path);
         return new Bucket(handle);
     }
     /**
@@ -183,6 +183,45 @@ class Bucket {
             exports.albedo.listClose(cursor);
         }
     }
+    /**
+     * Async iterator that continuously polls for documents matching the
+     * optional query. Unlike `list`, when there are no more results the
+     * iterator waits for `pollingTimeout` milliseconds and retries,
+     * making it suitable for watching a bucket for new data.
+     *
+     * The native cursor is closed automatically when the consumer breaks
+     * out of the loop or the iterator is otherwise disposed.
+     *
+     * @param query - filter or `Query` object
+     * @param options - polling configuration
+     * @param options.pollingTimeout - ms to wait before retrying when
+     *   `listData` returns `null` (default `50`)
+     * @yields each document deserialized from the bucket
+     * @example
+     * ```ts
+     * for await (const user of bucket.stream<User>(where('active', { $eq: true }))) {
+     *   console.log(user);
+     * }
+     * ```
+     */
+    async *stream(query, options) {
+        const pollingTimeout = options?.pollingTimeout ?? 50;
+        const cursor = exports.albedo.list(this.handle, Bucket.convertToQuery(query));
+        try {
+            while (true) {
+                const data = exports.albedo.listData(cursor);
+                if (data !== null) {
+                    yield data;
+                }
+                else {
+                    await new Promise((r) => setTimeout(r, pollingTimeout));
+                }
+            }
+        }
+        finally {
+            exports.albedo.listClose(cursor);
+        }
+    }
     /**
      * Collect all documents matching the optional query into an array.
      * @param query - filter or `Query` object

package/example/bun.lock

@@ -5,7 +5,7 @@
     "": {
       "name": "example",
       "dependencies": {
-        "albedo-node": "0.5.90",
+        "albedo-node": "0.5.91",
       },
       "devDependencies": {
         "@types/bun": "latest",
@@ -20,10 +20,12 @@
 
     "@types/node": ["@types/node@24.10.13", "", { "dependencies": { "undici-types": "~7.16.0" } }, "sha512-oH72nZRfDv9lADUBSo104Aq7gPHpQZc4BTx38r9xf9pg5LfP6EzSyH2n7qFmmxRQXh7YlUXODcYsg6PuTDSxGg=="],
 
-    "albedo-node": ["albedo-node@0.5.90", "", {}, "sha512-YoKDQ/tJSv+YF4zaEby2pqHrRQjKPXDXkAVwt2kX00d/dTz2ZigPLvJcBt3yVNu207+k4woxAWSe3ofLiRedXA=="],
+    "albedo-node": ["albedo-node@0.5.91", "", { "dependencies": { "detect-libc": "^2.1.2" } }, "sha512-jjb4t9jKi3COnLnoc94ABnoHB24hVcsB5bdLWqlaYjI2I4kGSxpAnVP7PYkCnAoB3vuHtC1EqbRfgZiQBgihzA=="],
 
     "bun-types": ["bun-types@1.3.9", "", { "dependencies": { "@types/node": "*" } }, "sha512-+UBWWOakIP4Tswh0Bt0QD0alpTY8cb5hvgiYeWCMet9YukHbzuruIEeXC2D7nMJPB12kbh8C7XJykSexEqGKJg=="],
 
+    "detect-libc": ["detect-libc@2.1.2", "", {}, "sha512-Btj2BOOO83o3WyH59e8MgXsxEQVcarkUOpEYrubB0urwnN10yQ364rsiByU11nZlqWYZm05i/of7io4mzihBtQ=="],
+
     "typescript": ["typescript@5.9.3", "", { "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" } }, "sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw=="],
 
     "undici-types": ["undici-types@7.16.0", "", {}, "sha512-Zz+aZWSj8LE6zoxD+xrjh4VfkIG8Ya6LvYkZqtUQGJPZjYl53ypCaUwWqo7eI0x66KBGeRo+mlBEkMSeSZ38Nw=="],

package/example/package.json

@@ -10,6 +10,6 @@
     "typescript": "^5"
   },
   "dependencies": {
-    "albedo-node": "0.5.90"
+    "albedo-node": "0.5.91"
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "albedo-node",
-  "version": "0.5.91",
+  "version": "0.6.0",
   "description": "High-performance embedded database for Node.js with native bindings, BSON support, indexing, and replication",
   "keywords": [
     "albedo",