idb-ts 3.0.3 → 3.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +23 -6
- package/lib/index.esm.js +181 -0
- package/package.json +22 -3
package/README.md
CHANGED
|
@@ -1,12 +1,29 @@
|
|
|
1
1
|
# 🚀 idb-ts
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
3
|
+
<p align="center">
|
|
4
|
+
<a href="https://www.npmjs.com/package/idb-ts">
|
|
5
|
+
<img src="https://img.shields.io/npm/v/idb-ts.svg" alt="npm version">
|
|
6
|
+
</a>
|
|
7
|
+
<a href="https://badgen.net/bundlephobia/min/idb-ts">
|
|
8
|
+
<img src="https://badgen.net/bundlephobia/min/idb-ts&cache-control=no-cache" alt="minified">
|
|
9
|
+
</a>
|
|
10
|
+
<a href="https://badgen.net/bundlephobia/minzip/idb-ts">
|
|
11
|
+
<img src="https://badgen.net/bundlephobia/minzip/idb-ts&cache-control=no-cache" alt="minified + gzipped">
|
|
12
|
+
</a>
|
|
13
|
+
</p>
|
|
14
|
+
|
|
15
|
+
<p align="center">
|
|
16
|
+
<a href="https://github.com/maifeeulasad/idb-ts/stargazers">
|
|
17
|
+
<img src="https://img.shields.io/github/stars/maifeeulasad/idb-ts" alt="GitHub stars">
|
|
18
|
+
</a>
|
|
19
|
+
<a href="https://github.com/maifeeulasad/idb-ts/watchers">
|
|
20
|
+
<img src="https://img.shields.io/github/watchers/maifeeulasad/idb-ts" alt="GitHub watchers">
|
|
21
|
+
</a>
|
|
22
|
+
<a href="https://img.shields.io/github/commits-since/maifeeulasad/idb-ts/latest/main?include_prereleases">
|
|
23
|
+
<img src="https://img.shields.io/github/commits-since/maifeeulasad/idb-ts/latest/main?include_prereleases" alt="Commits after release">
|
|
24
|
+
</a>
|
|
25
|
+
</p>
|
|
6
26
|
|
|
7
|
-
[](https://github.com/maifeeulasad/idb-ts/stargazers)
|
|
8
|
-
[](https://github.com/maifeeulasad/idb-ts/watchers)
|
|
9
|
-
[](https://img.shields.io/github/commits-since/maifeeulasad/idb-ts/latest/main?include_prereleases)
|
|
10
27
|
|
|
11
28
|
## 📌 Introduction
|
|
12
29
|
**idb-ts** is a lightweight, declarative, and type-safe way to work with IndexedDB using TypeScript. Effortlessly perform CRUD operations on your database with clean, structured code! 🔥
|
package/lib/index.esm.js
ADDED
|
@@ -0,0 +1,181 @@
|
|
|
1
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
2
|
+
exports.DataClass = exports.KeyPath = exports.Database = void 0;
|
|
3
|
+
const tslib_1 = require("tslib");
|
|
4
|
+
require("reflect-metadata");
|
|
5
|
+
function KeyPath() {
|
|
6
|
+
return (target, propertyKey) => {
|
|
7
|
+
const constructor = target.constructor;
|
|
8
|
+
Reflect.defineMetadata("keypath", [propertyKey], constructor);
|
|
9
|
+
};
|
|
10
|
+
}
|
|
11
|
+
exports.KeyPath = KeyPath;
|
|
12
|
+
function DataClass() {
|
|
13
|
+
return (target) => {
|
|
14
|
+
if (!Reflect.getMetadata("keypath", target)) {
|
|
15
|
+
throw new Error(`No keypath field defined for the class ${target.name}.`);
|
|
16
|
+
}
|
|
17
|
+
const keyPathFields = Reflect.getMetadata("keypath", target) || [];
|
|
18
|
+
if (keyPathFields.length > 1) {
|
|
19
|
+
throw new Error(`Only one keypath field can be defined for the class ${target.name}.`);
|
|
20
|
+
}
|
|
21
|
+
Reflect.defineMetadata("dataclass", true, target);
|
|
22
|
+
};
|
|
23
|
+
}
|
|
24
|
+
exports.DataClass = DataClass;
|
|
25
|
+
class Database {
|
|
26
|
+
constructor(dbName, classes) {
|
|
27
|
+
this.db = null;
|
|
28
|
+
this.dbName = dbName;
|
|
29
|
+
if (!classes.every(cls => Reflect.getMetadata("dataclass", cls))) {
|
|
30
|
+
throw new Error("All classes should be decorated with @DataClass.");
|
|
31
|
+
}
|
|
32
|
+
this.classes = classes;
|
|
33
|
+
}
|
|
34
|
+
static build(dbName, classes) {
|
|
35
|
+
return tslib_1.__awaiter(this, void 0, void 0, function* () {
|
|
36
|
+
const instance = new Database(dbName, classes);
|
|
37
|
+
yield instance.initDB();
|
|
38
|
+
return instance;
|
|
39
|
+
});
|
|
40
|
+
}
|
|
41
|
+
initDB() {
|
|
42
|
+
return tslib_1.__awaiter(this, void 0, void 0, function* () {
|
|
43
|
+
return new Promise((resolve, reject) => {
|
|
44
|
+
const request = indexedDB.open(this.dbName, 1);
|
|
45
|
+
request.onupgradeneeded = () => {
|
|
46
|
+
const db = request.result;
|
|
47
|
+
this.classes.forEach((cls) => {
|
|
48
|
+
const keyPathFields = Reflect.getMetadata("keypath", cls) || [];
|
|
49
|
+
const storeName = cls.name.toLowerCase() + "s";
|
|
50
|
+
if (!db.objectStoreNames.contains(storeName)) {
|
|
51
|
+
db.createObjectStore(storeName, { keyPath: keyPathFields[0] });
|
|
52
|
+
}
|
|
53
|
+
});
|
|
54
|
+
};
|
|
55
|
+
request.onsuccess = () => {
|
|
56
|
+
this.db = request.result;
|
|
57
|
+
console.log(`Database initialized with object stores for: ${this.classes.map(cls => cls.name).join(", ")}`);
|
|
58
|
+
resolve();
|
|
59
|
+
};
|
|
60
|
+
request.onerror = () => {
|
|
61
|
+
console.error("Error initializing database:", request.error);
|
|
62
|
+
reject(request.error);
|
|
63
|
+
};
|
|
64
|
+
});
|
|
65
|
+
});
|
|
66
|
+
}
|
|
67
|
+
getObjectStore(className, mode) {
|
|
68
|
+
if (!this.db) {
|
|
69
|
+
throw new Error("Database not initialized.");
|
|
70
|
+
}
|
|
71
|
+
const storeName = className.toLowerCase() + "s";
|
|
72
|
+
const transaction = this.db.transaction(storeName, mode);
|
|
73
|
+
return transaction.objectStore(storeName);
|
|
74
|
+
}
|
|
75
|
+
create(cls, item) {
|
|
76
|
+
return tslib_1.__awaiter(this, void 0, void 0, function* () {
|
|
77
|
+
return new Promise((resolve, reject) => {
|
|
78
|
+
try {
|
|
79
|
+
const store = this.getObjectStore(cls.name, "readwrite");
|
|
80
|
+
const request = store.add(item);
|
|
81
|
+
request.onsuccess = () => {
|
|
82
|
+
console.log(`Item added to ${cls.name}:`, item);
|
|
83
|
+
resolve();
|
|
84
|
+
};
|
|
85
|
+
request.onerror = () => {
|
|
86
|
+
console.error(`Error adding item to ${cls.name}:`, request.error);
|
|
87
|
+
reject(request.error);
|
|
88
|
+
};
|
|
89
|
+
}
|
|
90
|
+
catch (error) {
|
|
91
|
+
reject(error);
|
|
92
|
+
}
|
|
93
|
+
});
|
|
94
|
+
});
|
|
95
|
+
}
|
|
96
|
+
read(cls, key) {
|
|
97
|
+
return tslib_1.__awaiter(this, void 0, void 0, function* () {
|
|
98
|
+
return new Promise((resolve, reject) => {
|
|
99
|
+
try {
|
|
100
|
+
const store = this.getObjectStore(cls.name, "readonly");
|
|
101
|
+
const request = store.get(key);
|
|
102
|
+
request.onsuccess = () => {
|
|
103
|
+
console.log(`Item read from ${cls.name}:`, request.result);
|
|
104
|
+
resolve(request.result);
|
|
105
|
+
};
|
|
106
|
+
request.onerror = () => {
|
|
107
|
+
console.error(`Error reading item from ${cls.name}:`, request.error);
|
|
108
|
+
reject(request.error);
|
|
109
|
+
};
|
|
110
|
+
}
|
|
111
|
+
catch (error) {
|
|
112
|
+
reject(error);
|
|
113
|
+
}
|
|
114
|
+
});
|
|
115
|
+
});
|
|
116
|
+
}
|
|
117
|
+
update(cls, item) {
|
|
118
|
+
return tslib_1.__awaiter(this, void 0, void 0, function* () {
|
|
119
|
+
return new Promise((resolve, reject) => {
|
|
120
|
+
try {
|
|
121
|
+
const store = this.getObjectStore(cls.name, "readwrite");
|
|
122
|
+
const request = store.put(item);
|
|
123
|
+
request.onsuccess = () => {
|
|
124
|
+
console.log(`Item updated in ${cls.name}:`, item);
|
|
125
|
+
resolve();
|
|
126
|
+
};
|
|
127
|
+
request.onerror = () => {
|
|
128
|
+
console.error(`Error updating item in ${cls.name}:`, request.error);
|
|
129
|
+
reject(request.error);
|
|
130
|
+
};
|
|
131
|
+
}
|
|
132
|
+
catch (error) {
|
|
133
|
+
reject(error);
|
|
134
|
+
}
|
|
135
|
+
});
|
|
136
|
+
});
|
|
137
|
+
}
|
|
138
|
+
delete(cls, key) {
|
|
139
|
+
return tslib_1.__awaiter(this, void 0, void 0, function* () {
|
|
140
|
+
return new Promise((resolve, reject) => {
|
|
141
|
+
try {
|
|
142
|
+
const store = this.getObjectStore(cls.name, "readwrite");
|
|
143
|
+
const request = store.delete(key);
|
|
144
|
+
request.onsuccess = () => {
|
|
145
|
+
console.log(`Item deleted from ${cls.name}:`, key);
|
|
146
|
+
resolve();
|
|
147
|
+
};
|
|
148
|
+
request.onerror = () => {
|
|
149
|
+
console.error(`Error deleting item from ${cls.name}:`, request.error);
|
|
150
|
+
reject(request.error);
|
|
151
|
+
};
|
|
152
|
+
}
|
|
153
|
+
catch (error) {
|
|
154
|
+
reject(error);
|
|
155
|
+
}
|
|
156
|
+
});
|
|
157
|
+
});
|
|
158
|
+
}
|
|
159
|
+
list(cls) {
|
|
160
|
+
return tslib_1.__awaiter(this, void 0, void 0, function* () {
|
|
161
|
+
return new Promise((resolve, reject) => {
|
|
162
|
+
try {
|
|
163
|
+
const store = this.getObjectStore(cls.name, "readonly");
|
|
164
|
+
const request = store.getAll();
|
|
165
|
+
request.onsuccess = () => {
|
|
166
|
+
console.log(`All items from ${cls.name}:`, request.result);
|
|
167
|
+
resolve(request.result);
|
|
168
|
+
};
|
|
169
|
+
request.onerror = () => {
|
|
170
|
+
console.error(`Error listing items from ${cls.name}:`, request.error);
|
|
171
|
+
reject(request.error);
|
|
172
|
+
};
|
|
173
|
+
}
|
|
174
|
+
catch (error) {
|
|
175
|
+
reject(error);
|
|
176
|
+
}
|
|
177
|
+
});
|
|
178
|
+
});
|
|
179
|
+
}
|
|
180
|
+
}
|
|
181
|
+
exports.Database = Database;
|
package/package.json
CHANGED
|
@@ -1,11 +1,21 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "idb-ts",
|
|
3
|
-
"version": "3.0
|
|
3
|
+
"version": "3.2.0",
|
|
4
4
|
"description": "Easy CRUD for indexed-db, written in TypeScript",
|
|
5
5
|
"main": "lib/index.js",
|
|
6
|
+
"module": "lib/index.esm.js",
|
|
7
|
+
"type": "module",
|
|
8
|
+
"exports": {
|
|
9
|
+
".": {
|
|
10
|
+
"import": "./lib/index.esm.js",
|
|
11
|
+
"require": "./lib/index.js"
|
|
12
|
+
}
|
|
13
|
+
},
|
|
6
14
|
"scripts": {
|
|
7
15
|
"prepare": "npm run build",
|
|
8
|
-
"build": "tsc"
|
|
16
|
+
"build": "npm run build:tsc && npm run build:rollup",
|
|
17
|
+
"build:tsc": "tsc",
|
|
18
|
+
"build:rollup": "rollup -c"
|
|
9
19
|
},
|
|
10
20
|
"repository": {
|
|
11
21
|
"type": "git",
|
|
@@ -14,7 +24,13 @@
|
|
|
14
24
|
"keywords": [
|
|
15
25
|
"idb",
|
|
16
26
|
"ts",
|
|
17
|
-
"indexed-db"
|
|
27
|
+
"indexed-db",
|
|
28
|
+
"typescript",
|
|
29
|
+
"database",
|
|
30
|
+
"db",
|
|
31
|
+
"indexeddb",
|
|
32
|
+
"crud",
|
|
33
|
+
"storage"
|
|
18
34
|
],
|
|
19
35
|
"author": "Maifee Ul Asad <maifeeulasad@gmail.com>",
|
|
20
36
|
"license": "MIT",
|
|
@@ -29,6 +45,9 @@
|
|
|
29
45
|
"reflect-metadata": "^0.2.2"
|
|
30
46
|
},
|
|
31
47
|
"devDependencies": {
|
|
48
|
+
"@rollup/plugin-typescript": "^12.1.2",
|
|
49
|
+
"rollup": "^4.37.0",
|
|
50
|
+
"tslib": "^2.8.1",
|
|
32
51
|
"typescript": "^4.6.3"
|
|
33
52
|
}
|
|
34
53
|
}
|