dexie 4.1.0-beta.43 → 4.1.0-beta.45

package/README.md

@@ -1,9 +1,31 @@
 # Dexie.js
 
-[![NPM Version][npm-image]][npm-url] ![Build Status](https://github.com/dexie/Dexie.js/actions/workflows/main.yml/badge.svg)
+[![NPM Version][npm-image]][npm-url] ![Build Status](https://github.com/dexie/Dexie.js/actions/workflows/main.yml/badge.svg) [![Join our Discord](https://img.shields.io/discord/1328303736363421747?label=Discord&logo=discord&style=badge)](https://discord.gg/huhre7MHBF)
 
 Dexie.js is a wrapper library for indexedDB - the standard database in the browser. https://dexie.org.
 
+
+```
+ /$$   /$$                     /$$                   /$$     /$$                          
+| $$  | $$                    | $$                  | $$    | $$                          
+| $$  | $$  /$$$$$$   /$$$$$$$| $$   /$$  /$$$$$$  /$$$$$$  | $$$$$$$   /$$$$$$  /$$$$$$$ 
+| $$$$$$$$ |____  $$ /$$_____/| $$  /$$/ |____  $$|_  $$_/  | $$__  $$ /$$__  $$| $$__  $$
+| $$__  $$  /$$$$$$$| $$      | $$$$$$/   /$$$$$$$  | $$    | $$  \ $$| $$  \ $$| $$  \ $$
+| $$  | $$ /$$__  $$| $$      | $$_  $$  /$$__  $$  | $$ /$$| $$  | $$| $$  | $$| $$  | $$
+| $$  | $$|  $$$$$$$|  $$$$$$$| $$ \  $$|  $$$$$$$  |  $$$$/| $$  | $$|  $$$$$$/| $$  | $$
+|__/  |__/ \_______/ \_______/|__/  \__/ \_______/   \___/  |__/  |__/ \______/ |__/  |__/
+                                                    
+🌟 Welcome to Dexie Global Hackathon 25! 🌟
+📅 Date: February 14 --> April 13, 2025
+🕒 Start coding with Dexie Cloud and win prices!
+
+For more information: dexie.org/hackathon 
+
+Good luck! 🚀
+
+```
+[dexie.org/hackathon](https://dexie.org/hackathon/)
+
 #### Why Dexie.js?
 
 IndexedDB is the portable database for all browser engines. Dexie.js makes it fun and easy to work with.

package/dist/dexie.d.ts

@@ -4,7 +4,7 @@
  *
  * By David Fahlander, david.fahlander@gmail.com
  *
- * Version 4.1.0-beta.43, Fri Feb 07 2025
+ * Version 4.1.0-beta.45, Mon Mar 31 2025
  *
  * https://dexie.org
  *
@@ -1337,22 +1337,25 @@ declare class DexieYProvider$1<YDoc extends YjsDoc = any> implements DexieYProvi
 	private stopObserving;
 	private cleanupHandlers;
 	private graceTimer;
-	private graceTimeout?;
+	private graceTimeout;
 	doc: YDoc;
 	awareness?: any;
-	whenLoaded: Promise<void>;
-	whenSynced: Promise<void>;
+	private _error?;
+	private _whenLoaded;
+	private _whenSynced;
 	on: DexieEventSet & ((name: string, f: (...args: any[]) => any) => void);
 	off: (name: string, f: (...args: any[]) => any) => void;
 	destroyed: boolean;
 	static on: DexieEventSet & ((name: string, f: (...args: any[]) => any) => void);
 	static getOrCreateDocument(db: Dexie, table: string, prop: string, id: any): YjsDoc;
-	static load<YDoc extends YjsDoc>(doc: YDoc): DexieYProvider$1<YDoc>;
-	static release<YDoc extends YjsDoc>(doc: YDoc, options?: ReleaseOptions): void;
+	static load<YDoc extends YjsDoc>(doc: YDoc, options?: ReleaseOptions): DexieYProvider$1<YDoc>;
+	static release<YDoc extends YjsDoc>(doc: YDoc): void;
 	private _release;
 	static for<YDoc extends YjsDoc>(doc: YDoc): DexieYProvider$1<YDoc> | undefined;
 	static getDocCache: typeof getDocCache;
 	static currentUpdateRow: YUpdateRow | null;
+	get whenLoaded(): Promise<void>;
+	get whenSynced(): Promise<void>;
 	constructor(doc: YDoc);
 	destroy(): void;
 	addCleanupHandler(cleanupHandler: (() => void) | Unsubscribable): void;

package/dist/dexie.js

@@ -4,7 +4,7 @@
  *
  * By David Fahlander, david.fahlander@gmail.com
  *
- * Version 4.1.0-beta.43, Fri Feb 07 2025
+ * Version 4.1.0-beta.45, Mon Mar 31 2025
  *
  * https://dexie.org
  *
@@ -1179,7 +1179,7 @@
         }
     }
 
-    var DEXIE_VERSION = '4.1.0-beta.43';
+    var DEXIE_VERSION = '4.1.0-beta.45';
     var maxString = String.fromCharCode(65535);
     var minKey = -Infinity;
     var INVALID_KEY_ARGUMENT = "Invalid key provided. Keys must be of type string, number, Date or Array<string | number | Date>.";
@@ -1340,7 +1340,7 @@
     var destroyedDocs = new WeakSet();
     function throwIfDestroyed(doc) {
         if (destroyedDocs.has(doc))
-            throw new Error('Y.Doc has been destroyed');
+            throw new Error("Y.Doc ".concat(doc.meta.parentId, " has been destroyed"));
     }
     function getYDocCacheKey(table, primaryKey, ydocProp) {
         return "".concat(table, "[").concat(primaryKey, "].").concat(ydocProp);
@@ -6608,18 +6608,11 @@
             var _this = this;
             this.refCount = 1;
             this.cleanupHandlers = [];
+            this.graceTimeout = -1;
             this.destroyed = false;
             this.on = createEvents();
             this.doc = doc;
             this.off = function (name, f) { var _a; return (_a = _this.on[name]) === null || _a === void 0 ? void 0 : _a.unsubscribe(f); };
-            this.whenLoaded = new Promise(function (resolve, reject) {
-                _this.on('load', resolve);
-                _this.on('error', reject);
-            });
-            this.whenSynced = new Promise(function (resolve, reject) {
-                _this.on('sync', resolve);
-                _this.on('error', reject);
-            });
             if ('dispose' in Symbol) {
                 this[Symbol.dispose] =
                     function () { return DexieYProvider.release(doc); };
@@ -6627,16 +6620,20 @@
             doc.on('load', function () { return _this.on('load').fire(); });
             doc.on('sync', function (sync) { return sync !== false && _this.on('sync').fire(); });
             doc.on('destroy', this.destroy.bind(this));
+            this.on('error', function (error) {
+                _this._error = error;
+            });
             var _a = doc.meta || {}, db = _a.db, parentTable = _a.parentTable, parentId = _a.parentId, updatesTable = _a.updatesTable;
-            if (db && parentTable && updatesTable) {
-                if (!db.table(parentTable) || !db.table(updatesTable)) {
-                    throw new Error("Table ".concat(parentTable, " or ").concat(updatesTable, " not found in db"));
-                }
-                throwIfDestroyed(doc);
-                var Y = getYLibrary(db);
-                this.stopObserving = observeYDocUpdates(this, doc, db, parentTable, updatesTable, parentId, Y);
-                db.on.y.fire(this, Y);
+            if (!db || !parentTable || !updatesTable) {
+                throw new Error("Missing Dexie-related metadata in Y.Doc. Documents need to be obtained through Y.Doc properties from dexie queries.");
             }
+            if (!db.table(parentTable) || !db.table(updatesTable)) {
+                throw new Error("Table ".concat(parentTable, " or ").concat(updatesTable, " not found in db"));
+            }
+            throwIfDestroyed(doc);
+            var Y = getYLibrary(db);
+            this.stopObserving = observeYDocUpdates(this, doc, db, parentTable, updatesTable, parentId, Y);
+            db.on.y.fire(this, Y);
         }
         DexieYProvider.getOrCreateDocument = function (db, table, prop, id) {
             var _a, _b;
@@ -6644,39 +6641,42 @@
             var updatesTable = (_b = (_a = db.table(table).schema.yProps) === null || _a === void 0 ? void 0 : _a.find(function (p) { return p.prop === prop; })) === null || _b === void 0 ? void 0 : _b.updatesTable;
             return getOrCreateDocument(db, docCache, getYLibrary(db), table, prop, updatesTable, id);
         };
-        DexieYProvider.load = function (doc) {
+        DexieYProvider.load = function (doc, options) {
+            var _a;
             var p = wm.get(doc);
             if (p) {
                 ++p.refCount;
+                if ((options === null || options === void 0 ? void 0 : options.gracePeriod) != null && p.graceTimeout < options.gracePeriod) {
+                    p.graceTimeout = options.gracePeriod;
+                }
+                if (p.graceTimer) {
+                    clearTimeout(p.graceTimer);
+                    p.graceTimer = null;
+                }
             }
             else {
                 p = new DexieYProvider(doc);
+                p.graceTimeout = (_a = options === null || options === void 0 ? void 0 : options.gracePeriod) !== null && _a !== void 0 ? _a : -1;
                 wm.set(doc, p);
             }
             return p;
         };
-        DexieYProvider.release = function (doc, options) {
-            var _a, _b, _c;
-            if (destroyedDocs.has(doc))
+        DexieYProvider.release = function (doc) {
+            if (!doc || destroyedDocs.has(doc))
                 return;
             var p = wm.get(doc);
             if (p) {
                 if (--p.refCount <= 0) {
-                    var pendingGracePeriod = ((_a = p.graceTimeout) !== null && _a !== void 0 ? _a : 0) - Date.now();
-                    var computedGracePeriod = Math.max((_b = options === null || options === void 0 ? void 0 : options.gracePeriod) !== null && _b !== void 0 ? _b : -1, ((_c = p.graceTimeout) !== null && _c !== void 0 ? _c : 0) - Date.now());
-                    if (computedGracePeriod < 0) {
+                    if (p.graceTimeout < 0) {
                         p._release();
                     }
-                    else if (!p.graceTimer || computedGracePeriod > pendingGracePeriod) {
-                        if (p.graceTimer)
-                            clearTimeout(p.graceTimer);
-                        p.graceTimeout = Date.now() + computedGracePeriod;
+                    else if (!p.graceTimer) {
                         p.graceTimer = setTimeout(function () {
                             p.graceTimer = null;
                             if (p.refCount === 0) {
                                 p._release();
                             }
-                        }, computedGracePeriod
+                        }, p.graceTimeout
                         );
                     }
                 }
@@ -6687,6 +6687,8 @@
         };
         DexieYProvider.prototype._release = function () {
             var _this = this;
+            if (!this.doc)
+                return;
             Promise.resolve(DexieYProvider.on('beforeunload').fire(this)).finally(function () {
                 var _a;
                 if (_this.refCount === 0) {
@@ -6697,13 +6699,62 @@
         DexieYProvider.for = function (doc) {
             return wm.get(doc);
         };
+        Object.defineProperty(DexieYProvider.prototype, "whenLoaded", {
+            get: function () {
+                var _this = this;
+                if (!this._whenLoaded) {
+                    this._whenLoaded = new Promise(function (resolve, reject) {
+                        if (_this.doc.isLoaded)
+                            resolve();
+                        else if (_this._error)
+                            reject(_this._error);
+                        else if (destroyedDocs.has(_this.doc)) {
+                            reject(new exceptions.Abort('Document was destroyed before loaded'));
+                        }
+                        else {
+                            _this.on('load', resolve);
+                            _this.on('error', reject);
+                            _this.doc.on('destroy', function () { return reject(new exceptions.Abort('Document was destroyed before loaded')); });
+                        }
+                    });
+                }
+                return this._whenLoaded;
+            },
+            enumerable: false,
+            configurable: true
+        });
+        Object.defineProperty(DexieYProvider.prototype, "whenSynced", {
+            get: function () {
+                var _this = this;
+                if (!this._whenSynced) {
+                    this._whenSynced = new Promise(function (resolve, reject) {
+                        if (_this.doc.isSynced)
+                            resolve();
+                        else if (_this._error)
+                            reject(_this._error);
+                        else if (destroyedDocs.has(_this.doc)) {
+                            reject(new exceptions.Abort('Document was destroyed before synced'));
+                        }
+                        else {
+                            _this.on('sync', resolve);
+                            _this.on('error', reject);
+                            _this.doc.on('destroy', function () { return reject(new exceptions.Abort('Document was destroyed before synced')); });
+                        }
+                    });
+                }
+                return this._whenSynced;
+            },
+            enumerable: false,
+            configurable: true
+        });
         DexieYProvider.prototype.destroy = function () {
-            var _a;
+            var _a, _b;
+            console.debug("YDoc ".concat((_a = this.doc.meta) === null || _a === void 0 ? void 0 : _a.parentId, " was destroyed"));
             wm.delete(this.doc);
             this.doc = null;
             this.destroyed = true;
             this.refCount = 0;
-            (_a = this.stopObserving) === null || _a === void 0 ? void 0 : _a.call(this);
+            (_b = this.stopObserving) === null || _b === void 0 ? void 0 : _b.call(this);
             this.on = createEvents();
             this.cleanupHandlers.forEach(function (cleanup) { return cleanup(); });
         };