idb-ts 3.13.0 → 3.15.0

package/lib/index.js

@@ -1,22 +1,6 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-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;
-require("reflect-metadata");
+import { __awaiter } from 'tslib';
+import 'reflect-metadata';
+
 class FieldQueryBuilder {
     constructor(parent, field) {
         this.parent = parent;
@@ -459,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;
@@ -534,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.');
         }
@@ -579,7 +573,7 @@ class Database {
                     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);
@@ -588,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;
@@ -611,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);
@@ -624,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);
                                         }
                                     });
@@ -635,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);
                 };
             });
@@ -681,7 +675,7 @@ 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();
@@ -696,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;
@@ -724,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 = () => {
@@ -889,7 +883,7 @@ 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);
             }),
@@ -904,7 +898,7 @@ class Database {
                     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);
@@ -915,7 +909,7 @@ class Database {
                 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);
             }),
@@ -928,7 +922,7 @@ class Database {
             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);
             }),
@@ -954,7 +948,7 @@ class Database {
                     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);
@@ -968,7 +962,7 @@ class Database {
                         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);
@@ -984,7 +978,7 @@ 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);
@@ -1000,7 +994,7 @@ 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);
@@ -1012,7 +1006,7 @@ class Database {
                     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);
@@ -1025,7 +1019,7 @@ class Database {
                     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);
@@ -1037,7 +1031,7 @@ class Database {
                     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);
@@ -1162,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 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "idb-ts",
-  "version": "3.13.0",
+  "version": "3.15.0",
   "description": "Easy CRUD for indexed-db, written in TypeScript",
   "main": "lib/index.js",
   "module": "lib/index.esm.js",
@@ -15,8 +15,8 @@
   },
   "scripts": {
     "prepare": "pnpm run build",
-    "build": "pnpm run build:tsc && pnpm run build:rollup",
-    "build:tsc": "tsc",
+    "build": "rm -rf lib && pnpm run build:tsc && pnpm run build:rollup",
+    "build:tsc": "tsc -p tsconfig.build.json",
     "build:rollup": "rollup -c",
     "lint": "eslint .",
     "lint:fix": "prettier --write . && eslint . --fix",
@@ -25,7 +25,9 @@
     "test:types": "tsc -p tsconfig.test.json --noEmit",
     "test:watch": "jest --watchAll --runInBand --detectOpenHandles",
     "test:coverage": "jest --coverage --runInBand --detectOpenHandles",
-    "test:coverage:watch": "jest --coverage --watchAll --runInBand --detectOpenHandles"
+    "test:coverage:watch": "jest --coverage --watchAll --runInBand --detectOpenHandles",
+    "test:performance": "npx tsx performance.ts",
+    "docs:generate": "typedoc"
   },
   "repository": {
     "type": "git",
@@ -70,6 +72,7 @@
     "prettier": "^3.8.3",
     "rollup": "^4.60.1",
     "ts-jest": "^29.4.9",
+    "typedoc": "^0.28.19",
     "typescript": "^6.0.3"
   }
-}
+}

package/lib/jest.setup.d.ts

@@ -1 +0,0 @@
-import 'fake-indexeddb/auto';

package/lib/jest.setup.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-require("fake-indexeddb/auto");
-if (typeof globalThis.structuredClone === 'undefined') {
-    globalThis.structuredClone = (obj) => JSON.parse(JSON.stringify(obj));
-}