idb-ts 3.13.0 → 3.15.0

package/lib/index.d.ts

@@ -173,6 +173,9 @@ declare class Database {
     private retentionTimer;
     private retentionCleanupRunning;
     private retentionPolicies;
+    private printEnabled;
+    private printDebug;
+    private printError;
     private constructor();
     private calculateDatabaseVersion;
     static build<T extends Record<string, EntityRepository<any>>>(dbName: string, classes: Function[]): Promise<DatabaseWithRepositories<T>>;

package/lib/index.esm.js

@@ -1,13 +1,6 @@
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.KeyGenerators = exports.Database = void 0;
-exports.KeyPath = KeyPath;
-exports.CompositeKeyPath = CompositeKeyPath;
-exports.DataClass = DataClass;
-exports.Index = Index;
-exports.Validate = Validate;
-exports.RetentionPolicy = RetentionPolicy;
-const tslib_1 = require("tslib");
-require("reflect-metadata");
+import { __awaiter } from 'tslib';
+import 'reflect-metadata';
+
 class FieldQueryBuilder {
     constructor(parent, field) {
         this.parent = parent;
@@ -225,7 +218,7 @@ class QueryBuilder {
         return this;
     }
     loadCandidates() {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        return __awaiter(this, void 0, void 0, function* () {
             const store = this.transaction
                 ? this.transaction.objectStore(this.storeName)
                 : this.db
@@ -325,7 +318,7 @@ class QueryBuilder {
         return result;
     }
     collectMatches() {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        return __awaiter(this, void 0, void 0, function* () {
             const candidates = yield this.loadCandidates();
             return candidates.filter((item) => this.evaluateClauses(item, this.clauses));
         });
@@ -355,7 +348,7 @@ class QueryBuilder {
         return nextResults;
     }
     aggregateValues(field, reducer) {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        return __awaiter(this, void 0, void 0, function* () {
             const results = yield this.collectMatches();
             const values = field
                 ? results.map((item) => item[field])
@@ -364,7 +357,7 @@ class QueryBuilder {
         });
     }
     aggregateGroupedCount(field) {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        return __awaiter(this, void 0, void 0, function* () {
             var _a;
             const results = yield this.collectMatches();
             const groups = new Map();
@@ -384,13 +377,13 @@ class QueryBuilder {
         });
     }
     execute() {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        return __awaiter(this, void 0, void 0, function* () {
             const results = yield this.collectMatches();
             return this.applyPagination(this.sortResults(results));
         });
     }
     count() {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        return __awaiter(this, void 0, void 0, function* () {
             if (this.groupField) {
                 return this.aggregateGroupedCount(this.groupField);
             }
@@ -399,13 +392,13 @@ class QueryBuilder {
         });
     }
     sum(field) {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        return __awaiter(this, void 0, void 0, function* () {
             const total = yield this.aggregateValues(field, (values) => values.reduce((accumulator, value) => accumulator + (Number(value) || 0), 0));
             return total;
         });
     }
     avg(field) {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        return __awaiter(this, void 0, void 0, function* () {
             const values = yield this.aggregateValues(field, (items) => items);
             if (!values.length) {
                 return 0;
@@ -415,7 +408,7 @@ class QueryBuilder {
         });
     }
     min(field) {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        return __awaiter(this, void 0, void 0, function* () {
             const values = yield this.aggregateValues(field, (items) => items);
             if (!values.length) {
                 return null;
@@ -424,7 +417,7 @@ class QueryBuilder {
         });
     }
     max(field) {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        return __awaiter(this, void 0, void 0, function* () {
             const values = yield this.aggregateValues(field, (items) => items);
             if (!values.length) {
                 return null;
@@ -450,7 +443,6 @@ class KeyGenerators {
         return Math.random().toString(36).substring(2, 15);
     }
 }
-exports.KeyGenerators = KeyGenerators;
 function KeyPath(options) {
     return (target, propertyKey) => {
         const constructor = target.constructor;
@@ -525,12 +517,23 @@ function DataClass(options = {}) {
     };
 }
 class Database {
-    constructor(dbName, classes) {
+    constructor(dbName, classes, printEnabled = false) {
         this.db = null;
         this.entityRepositories = new Map();
         this.retentionTimer = null;
         this.retentionCleanupRunning = false;
+        this.printDebug = (...data) => {
+            if (!this.printEnabled)
+                return;
+            console.debug('[idb-ts]:DEBUG:', ...data);
+        };
+        this.printError = (...error) => {
+            if (!this.printEnabled)
+                return;
+            console.error('[idb-ts]:ERROR:', ...error);
+        };
         this.dbName = dbName;
+        this.printEnabled = printEnabled;
         if (!classes.every((cls) => Reflect.getMetadata('dataclass', cls))) {
             throw new Error('All classes should be decorated with @DataClass.');
         }
@@ -555,7 +558,7 @@ class Database {
         return Math.max(...versions);
     }
     static build(dbName, classes) {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        return __awaiter(this, void 0, void 0, function* () {
             const instance = new Database(dbName, classes);
             yield instance.initDB();
             instance.generateEntityRepositories();
@@ -563,14 +566,14 @@ class Database {
         });
     }
     initDB() {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        return __awaiter(this, void 0, void 0, function* () {
             return new Promise((resolve, reject) => {
                 const request = indexedDB.open(this.dbName, this.dbVersion);
                 request.onupgradeneeded = (event) => {
                     const db = request.result;
                     const oldVersion = event.oldVersion;
                     const newVersion = event.newVersion || this.dbVersion;
-                    console.debug(`Database upgrade from version ${oldVersion} to ${newVersion}`);
+                    this.printDebug(`Database upgrade from version ${oldVersion} to ${newVersion}`);
                     this.classes.forEach((cls) => {
                         var _a;
                         const keyPathMetadata = Reflect.getMetadata('keypath', cls);
@@ -579,7 +582,7 @@ class Database {
                         const storeName = cls.name.toLowerCase();
                         if (classVersion > oldVersion) {
                             if (!db.objectStoreNames.contains(storeName)) {
-                                console.debug(`Creating object store: ${storeName} (version ${classVersion})`);
+                                this.printDebug(`Creating object store: ${storeName} (version ${classVersion})`);
                                 const storeOptions = {};
                                 if (keyPathMetadata) {
                                     storeOptions.keyPath = keyPathMetadata.fields;
@@ -602,7 +605,7 @@ class Database {
                                 });
                             }
                             else {
-                                console.debug(`Updating object store: ${storeName} (version ${classVersion})`);
+                                this.printDebug(`Updating object store: ${storeName} (version ${classVersion})`);
                                 const transaction = request.transaction;
                                 if (transaction) {
                                     const store = transaction.objectStore(storeName);
@@ -615,7 +618,7 @@ class Database {
                                             ? { unique: false }
                                             : ((_a = indexField.options) !== null && _a !== void 0 ? _a : { unique: false });
                                         if (!store.indexNames.contains(indexName)) {
-                                            console.debug(`Adding index: ${indexName} to ${storeName}`);
+                                            this.printDebug(`Adding index: ${indexName} to ${storeName}`);
                                             store.createIndex(indexName, indexName, indexOptions);
                                         }
                                     });
@@ -626,12 +629,12 @@ class Database {
                 };
                 request.onsuccess = () => {
                     this.db = request.result;
-                    console.debug(`Database initialized (version ${this.dbVersion}) with object stores for: ${this.classes.map((cls) => `${cls.name}(v${Reflect.getMetadata('version', cls) || 1})`).join(', ')}`);
+                    this.printDebug(`Database initialized (version ${this.dbVersion}) with object stores for: ${this.classes.map((cls) => `${cls.name}(v${Reflect.getMetadata('version', cls) || 1})`).join(', ')}`);
                     this.startRetentionCleanup();
                     resolve();
                 };
                 request.onerror = () => {
-                    console.error('Error initializing database:', request.error);
+                    this.printError('Error initializing database:', request.error);
                     reject(request.error);
                 };
             });
@@ -672,14 +675,14 @@ class Database {
         if (!cleanupIntervalMs || !this.db || this.retentionTimer) {
             return;
         }
-        console.debug(`Retention cleanup enabled for ${this.retentionPolicies.length} entities every ${cleanupIntervalMs}ms`);
+        this.printDebug(`Retention cleanup enabled for ${this.retentionPolicies.length} entities every ${cleanupIntervalMs}ms`);
         void this.runRetentionCleanup();
         this.retentionTimer = setInterval(() => {
             void this.runRetentionCleanup();
         }, cleanupIntervalMs);
     }
     runRetentionCleanup() {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        return __awaiter(this, void 0, void 0, function* () {
             if (!this.db ||
                 this.retentionCleanupRunning ||
                 !this.retentionPolicies.length) {
@@ -687,11 +690,11 @@ class Database {
             }
             this.retentionCleanupRunning = true;
             try {
-                console.debug('Retention cleanup tick started');
+                this.printDebug('Retention cleanup tick started');
                 for (const { storeName, className, policy } of this.retentionPolicies) {
                     yield this.cleanupExpiredRecords(storeName, className, policy);
                 }
-                console.debug('Retention cleanup tick finished');
+                this.printDebug('Retention cleanup tick finished');
             }
             finally {
                 this.retentionCleanupRunning = false;
@@ -715,11 +718,11 @@ class Database {
                     }
                     const value = cursor.value;
                     const timestamp = value === null || value === void 0 ? void 0 : value[policy.field];
-                    console.debug(`Retention cleanup inspecting ${className}.${policy.field}:`, timestamp, 'cutoff:', cutoff);
+                    this.printDebug(`Retention cleanup inspecting ${className}.${policy.field}:`, timestamp, 'cutoff:', cutoff);
                     if (typeof timestamp === 'number' && timestamp <= cutoff) {
                         const deleteRequest = cursor.delete();
                         deleteRequest.onsuccess = () => {
-                            console.debug(`Retention cleanup removed expired record from ${className}`);
+                            this.printDebug(`Retention cleanup removed expired record from ${className}`);
                             cursor.continue();
                         };
                         deleteRequest.onerror = () => {
@@ -813,7 +816,7 @@ class Database {
                 request.onerror = () => reject(request.error);
             });
         };
-        const updateStoredItem = (store, item) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const updateStoredItem = (store, item) => __awaiter(this, void 0, void 0, function* () {
             const key = extractKey(item);
             let existingItem;
             if (key !== undefined && key !== null) {
@@ -861,7 +864,7 @@ class Database {
                 const storeName = cls.name.toLowerCase();
                 return new QueryBuilder(self.db, storeName, transaction);
             },
-            create: (item) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+            create: (item) => __awaiter(this, void 0, void 0, function* () {
                 var _a;
                 const keyPathMetadata = Reflect.getMetadata('keypath', cls);
                 if (((_a = keyPathMetadata === null || keyPathMetadata === void 0 ? void 0 : keyPathMetadata.options) === null || _a === void 0 ? void 0 : _a.generator) &&
@@ -880,56 +883,56 @@ class Database {
                 applyTimestampFields(item);
                 return this.performOperation(cls.name, 'readwrite', (store) => {
                     return createStoredItem(store, item).then(() => {
-                        console.debug(`Item added to ${cls.name}:`, item);
+                        this.printDebug(`Item added to ${cls.name}:`, item);
                     });
                 }, transaction);
             }),
-            createMany: (items) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+            createMany: (items) => __awaiter(this, void 0, void 0, function* () {
                 const repository = this.createEntityRepository(cls, transaction);
                 for (const item of items) {
                     yield repository.create(item);
                 }
             }),
-            read: (key) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+            read: (key) => __awaiter(this, void 0, void 0, function* () {
                 return this.performOperation(cls.name, 'readonly', (store) => {
                     const request = store.get(key);
                     return new Promise((resolve, reject) => {
                         request.onsuccess = () => {
-                            console.debug(`Item read from ${cls.name}:`, request.result);
+                            this.printDebug(`Item read from ${cls.name}:`, request.result);
                             resolve(request.result);
                         };
                         request.onerror = () => reject(request.error);
                     });
                 }, transaction);
             }),
-            update: (item) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+            update: (item) => __awaiter(this, void 0, void 0, function* () {
                 validateItem(item);
                 return this.performOperation(cls.name, 'readwrite', (store) => {
                     return updateStoredItem(store, item).then(() => {
-                        console.debug(`Item updated in ${cls.name}:`, item);
+                        this.printDebug(`Item updated in ${cls.name}:`, item);
                     });
                 }, transaction);
             }),
-            updateMany: (items) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+            updateMany: (items) => __awaiter(this, void 0, void 0, function* () {
                 const repository = this.createEntityRepository(cls, transaction);
                 for (const item of items) {
                     yield repository.update(item);
                 }
             }),
-            delete: (key) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+            delete: (key) => __awaiter(this, void 0, void 0, function* () {
                 return this.performOperation(cls.name, 'readwrite', (store) => {
                     return deleteStoredItem(store, key).then(() => {
-                        console.debug(`Item deleted from ${cls.name}:`, key);
+                        this.printDebug(`Item deleted from ${cls.name}:`, key);
                     });
                 }, transaction);
             }),
-            deleteMany: (keys) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+            deleteMany: (keys) => __awaiter(this, void 0, void 0, function* () {
                 const repository = this.createEntityRepository(cls, transaction);
                 for (const key of keys) {
                     yield repository.delete(key);
                 }
             }),
-            deleteWhere: (predicate) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+            deleteWhere: (predicate) => __awaiter(this, void 0, void 0, function* () {
                 var _a;
                 const repository = this.createEntityRepository(cls, transaction);
                 const query = repository.query();
@@ -940,33 +943,33 @@ class Database {
                     .filter((key) => key !== undefined && key !== null);
                 yield repository.deleteMany(keys);
             }),
-            list: () => tslib_1.__awaiter(this, void 0, void 0, function* () {
+            list: () => __awaiter(this, void 0, void 0, function* () {
                 return this.performOperation(cls.name, 'readonly', (store) => {
                     const request = store.getAll();
                     return new Promise((resolve, reject) => {
                         request.onsuccess = () => {
-                            console.debug(`All items from ${cls.name}:`, request.result);
+                            this.printDebug(`All items from ${cls.name}:`, request.result);
                             resolve(request.result);
                         };
                         request.onerror = () => reject(request.error);
                     });
                 }, transaction);
             }),
-            listPaginated: (page, pageSize) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+            listPaginated: (page, pageSize) => __awaiter(this, void 0, void 0, function* () {
                 return this.performOperation(cls.name, 'readonly', (store) => {
                     const request = store.getAll();
                     return new Promise((resolve, reject) => {
                         request.onsuccess = () => {
                             const items = request.result;
                             const paginatedItems = items.slice((page - 1) * pageSize, page * pageSize);
-                            console.debug(`Paginated items from ${cls.name}:`, paginatedItems);
+                            this.printDebug(`Paginated items from ${cls.name}:`, paginatedItems);
                             resolve(paginatedItems);
                         };
                         request.onerror = () => reject(request.error);
                     });
                 }, transaction);
             }),
-            findByIndex: (indexName, value) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+            findByIndex: (indexName, value) => __awaiter(this, void 0, void 0, function* () {
                 return this.performOperation(cls.name, 'readonly', (store) => {
                     if (!store.indexNames.contains(indexName)) {
                         throw new Error(`Index '${indexName}' does not exist on ${cls.name}`);
@@ -975,14 +978,14 @@ class Database {
                     const request = index.getAll(value);
                     return new Promise((resolve, reject) => {
                         request.onsuccess = () => {
-                            console.debug(`Items found by index ${indexName} with value ${value}:`, request.result);
+                            this.printDebug(`Items found by index ${indexName} with value ${value}:`, request.result);
                             resolve(request.result);
                         };
                         request.onerror = () => reject(request.error);
                     });
                 }, transaction);
             }),
-            findOneByIndex: (indexName, value) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+            findOneByIndex: (indexName, value) => __awaiter(this, void 0, void 0, function* () {
                 return this.performOperation(cls.name, 'readonly', (store) => {
                     if (!store.indexNames.contains(indexName)) {
                         throw new Error(`Index '${indexName}' does not exist on ${cls.name}`);
@@ -991,44 +994,44 @@ class Database {
                     const request = index.get(value);
                     return new Promise((resolve, reject) => {
                         request.onsuccess = () => {
-                            console.debug(`Item found by index ${indexName} with value ${value}:`, request.result);
+                            this.printDebug(`Item found by index ${indexName} with value ${value}:`, request.result);
                             resolve(request.result);
                         };
                         request.onerror = () => reject(request.error);
                     });
                 }, transaction);
             }),
-            count: () => tslib_1.__awaiter(this, void 0, void 0, function* () {
+            count: () => __awaiter(this, void 0, void 0, function* () {
                 return this.performOperation(cls.name, 'readonly', (store) => {
                     const request = store.count();
                     return new Promise((resolve, reject) => {
                         request.onsuccess = () => {
-                            console.debug(`Count for ${cls.name}:`, request.result);
+                            this.printDebug(`Count for ${cls.name}:`, request.result);
                             resolve(request.result);
                         };
                         request.onerror = () => reject(request.error);
                     });
                 }, transaction);
             }),
-            exists: (key) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+            exists: (key) => __awaiter(this, void 0, void 0, function* () {
                 return this.performOperation(cls.name, 'readonly', (store) => {
                     const request = store.count(key);
                     return new Promise((resolve, reject) => {
                         request.onsuccess = () => {
                             const exists = request.result > 0;
-                            console.debug(`Exists check for ${cls.name} with key ${key}:`, exists);
+                            this.printDebug(`Exists check for ${cls.name} with key ${key}:`, exists);
                             resolve(exists);
                         };
                         request.onerror = () => reject(request.error);
                     });
                 }, transaction);
             }),
-            clear: () => tslib_1.__awaiter(this, void 0, void 0, function* () {
+            clear: () => __awaiter(this, void 0, void 0, function* () {
                 return this.performOperation(cls.name, 'readwrite', (store) => {
                     const request = store.clear();
                     return new Promise((resolve, reject) => {
                         request.onsuccess = () => {
-                            console.debug(`Cleared all items from ${cls.name}`);
+                            this.printDebug(`Cleared all items from ${cls.name}`);
                             resolve();
                         };
                         request.onerror = () => reject(request.error);
@@ -1038,7 +1041,7 @@ class Database {
         };
     }
     performOperation(className, mode, operation, transaction) {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        return __awaiter(this, void 0, void 0, function* () {
             if (!this.db && !transaction) {
                 throw new Error('Database not initialized.');
             }
@@ -1088,13 +1091,13 @@ class Database {
                 handle[entityName] = this.createEntityRepository(entityClass, nativeTransaction);
             }
         });
-        handle.commit = () => tslib_1.__awaiter(this, void 0, void 0, function* () {
+        handle.commit = () => __awaiter(this, void 0, void 0, function* () {
             if (typeof nativeTransaction.commit === 'function') {
                 nativeTransaction.commit();
             }
             yield completion;
         });
-        handle.rollback = () => tslib_1.__awaiter(this, void 0, void 0, function* () {
+        handle.rollback = () => __awaiter(this, void 0, void 0, function* () {
             rollbackRequested = true;
             try {
                 nativeTransaction.abort();
@@ -1106,12 +1109,12 @@ class Database {
         return handle;
     }
     beginTransaction(entityNames_1) {
-        return tslib_1.__awaiter(this, arguments, void 0, function* (entityNames, mode = 'readwrite') {
+        return __awaiter(this, arguments, void 0, function* (entityNames, mode = 'readwrite') {
             return this.createTransactionHandle(entityNames, mode);
         });
     }
     transaction(callback) {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        return __awaiter(this, void 0, void 0, function* () {
             const tx = this.createTransactionHandle(this.classes.map((cls) => cls.name), 'readwrite');
             try {
                 const result = yield callback(tx);
@@ -1153,4 +1156,5 @@ class Database {
         return cls ? Reflect.getMetadata('version', cls) || 1 : undefined;
     }
 }
-exports.Database = Database;
+
+export { CompositeKeyPath, DataClass, Database, Index, KeyGenerators, KeyPath, RetentionPolicy, Validate };