Compare commits
5 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| af1da75a82 | |||
| e19768688d | |||
| 6d706d4c15 | |||
| 97f2bcce2e | |||
| 2a7fa18c0e |
9
index.html
Normal file
9
index.html
Normal file
@ -0,0 +1,9 @@
|
||||
<html>
|
||||
<body>
|
||||
<script type="module">
|
||||
import {Cache, Database} from './dist/index.mjs';
|
||||
|
||||
const db = new Database('test', []);
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@ztimson/utils",
|
||||
"version": "0.25.0",
|
||||
"version": "0.25.5",
|
||||
"description": "Utility library",
|
||||
"author": "Zak Timson",
|
||||
"license": "MIT",
|
||||
@ -31,6 +31,7 @@
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/jest": "^29.5.12",
|
||||
"fake-indexeddb": "^6.0.1",
|
||||
"jest": "^29.7.0",
|
||||
"jest-junit": "^16.0.0",
|
||||
"ts-jest": "^29.1.2",
|
||||
|
||||
46
src/cache.ts
46
src/cache.ts
@ -1,10 +1,11 @@
|
||||
import {deepCopy} from './objects.ts';
|
||||
import {Table} from './database.ts';
|
||||
import {deepCopy, JSONSanitize} from './objects.ts';
|
||||
|
||||
export type CacheOptions = {
|
||||
/** Delete keys automatically after x amount of seconds */
|
||||
ttl?: number;
|
||||
/** Storage to persist cache */
|
||||
storage?: Storage;
|
||||
storage?: Storage | Table<any, any>;
|
||||
/** Key cache will be stored under */
|
||||
storageKey?: string;
|
||||
/** Keep or delete cached items once expired, defaults to delete */
|
||||
@ -30,13 +31,16 @@ export class Cache<K extends string | number | symbol, T> {
|
||||
* @param options
|
||||
*/
|
||||
constructor(public readonly key?: keyof T, public readonly options: CacheOptions = {}) {
|
||||
if(options.storageKey && !options.storage && typeof(Storage) !== 'undefined')
|
||||
options.storage = localStorage;
|
||||
if(options.storageKey && options.storage) {
|
||||
const stored = options.storage.getItem(options.storageKey);
|
||||
if(stored) {
|
||||
try { Object.assign(this.store, JSON.parse(stored)); }
|
||||
catch { }
|
||||
if(options.storageKey && !options.storage && typeof(Storage) !== 'undefined') options.storage = localStorage;
|
||||
if(options.storage) {
|
||||
if(options.storage instanceof Table) {
|
||||
(async () => (await options.storage?.getAll()).forEach((v: any) => {
|
||||
console.log(v);
|
||||
this.add(v)
|
||||
}))()
|
||||
} else if(options.storageKey) {
|
||||
const stored = options.storage?.getItem(options.storageKey);
|
||||
if(stored != null) try { Object.assign(this.store, JSON.parse(stored)); } catch { }
|
||||
}
|
||||
}
|
||||
return new Proxy(this, {
|
||||
@ -57,9 +61,14 @@ export class Cache<K extends string | number | symbol, T> {
|
||||
return <K>value[this.key];
|
||||
}
|
||||
|
||||
private save() {
|
||||
if(this.options.storageKey && this.options.storage)
|
||||
this.options.storage.setItem(this.options.storageKey, JSON.stringify(this.store));
|
||||
private save(key: K) {
|
||||
if(this.options.storage) {
|
||||
if(this.options.storage instanceof Table) {
|
||||
this.options.storage.put(key, this.store[key]);
|
||||
} else if(this.options.storageKey) {
|
||||
this.options.storage.setItem(this.options.storageKey, JSONSanitize(this.store));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
@ -111,7 +120,7 @@ export class Cache<K extends string | number | symbol, T> {
|
||||
*/
|
||||
delete(key: K): this {
|
||||
delete this.store[key];
|
||||
this.save();
|
||||
this.save(key);
|
||||
return this;
|
||||
}
|
||||
|
||||
@ -130,14 +139,17 @@ export class Cache<K extends string | number | symbol, T> {
|
||||
*/
|
||||
expire(key: K): this {
|
||||
this.complete = false;
|
||||
if(this.options.expiryPolicy == 'keep') (<any>this.store[key])._expired = true;
|
||||
else this.delete(key);
|
||||
if(this.options.expiryPolicy == 'keep') {
|
||||
(<any>this.store[key])._expired = true;
|
||||
this.save(key);
|
||||
} else this.delete(key);
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get item from the cache
|
||||
* @param {K} key Key to lookup
|
||||
* @param expired Include expired items
|
||||
* @return {T} Cached item
|
||||
*/
|
||||
get(key: K, expired?: boolean): CachedValue<T> | null {
|
||||
@ -177,10 +189,10 @@ export class Cache<K extends string | number | symbol, T> {
|
||||
set(key: K, value: T, ttl = this.options.ttl): this {
|
||||
if(this.options.expiryPolicy == 'keep') delete (<any>value)._expired;
|
||||
this.store[key] = value;
|
||||
this.save();
|
||||
this.save(key);
|
||||
if(ttl) setTimeout(() => {
|
||||
this.expire(key);
|
||||
this.save();
|
||||
this.save(key);
|
||||
}, (ttl || 0) * 1000);
|
||||
return this;
|
||||
}
|
||||
|
||||
92
src/database.ts
Normal file
92
src/database.ts
Normal file
@ -0,0 +1,92 @@
|
||||
import {ASet} from './aset.ts';
|
||||
|
||||
export type TableOptions = {
|
||||
name: string;
|
||||
key?: string;
|
||||
};
|
||||
|
||||
export class Database {
|
||||
connection!: Promise<IDBDatabase>;
|
||||
|
||||
constructor(public readonly database: string, public readonly tables: (string | TableOptions)[], public version?: number) {
|
||||
this.connection = new Promise((resolve, reject) => {
|
||||
const req = indexedDB.open(this.database, this.version);
|
||||
const tableNames = new ASet(tables.map(t => (typeof t == 'object' ? t.name : t).toString()));
|
||||
|
||||
req.onerror = () => reject(req.error);
|
||||
|
||||
req.onsuccess = () => {
|
||||
const db = req.result;
|
||||
if(tableNames.symmetricDifference(new ASet(Array.from(db.objectStoreNames))).length) {
|
||||
db.close();
|
||||
Object.assign(this, new Database(this.database, this.tables, db.version + 1));
|
||||
} else {
|
||||
this.version = db.version;
|
||||
resolve(db);
|
||||
}
|
||||
};
|
||||
|
||||
req.onupgradeneeded = () => {
|
||||
const db = req.result;
|
||||
const existingTables = new ASet(Array.from(db.objectStoreNames));
|
||||
existingTables.difference(tableNames).forEach(name => db.deleteObjectStore(name));
|
||||
tableNames.difference(existingTables).forEach(name => db.createObjectStore(name));
|
||||
};
|
||||
});
|
||||
}
|
||||
|
||||
includes(name: string): boolean {
|
||||
return this.tables.some(t => (typeof t === 'string' ? name === t : name === t.name));
|
||||
}
|
||||
|
||||
table<K extends IDBValidKey = any, T = any>(name: any): Table<K, T> {
|
||||
return new Table<K, T>(this, name.toString());
|
||||
}
|
||||
}
|
||||
|
||||
export class Table<K extends IDBValidKey = any, T = any> {
|
||||
constructor(private readonly database: Database, public readonly name: string) {}
|
||||
|
||||
async tx<R>(table: string, fn: (store: IDBObjectStore) => IDBRequest, readonly = false): Promise<R> {
|
||||
const db = await this.database.connection;
|
||||
const tx = db.transaction(table, readonly ? 'readonly' : 'readwrite');
|
||||
const store = tx.objectStore(table);
|
||||
return new Promise<R>((resolve, reject) => {
|
||||
const request = fn(store);
|
||||
request.onsuccess = () => resolve(request.result as R); // ✅ explicit cast
|
||||
request.onerror = () => reject(request.error);
|
||||
});
|
||||
}
|
||||
|
||||
add(value: T, key?: K): Promise<void> {
|
||||
return this.tx(this.name, store => store.add(value, key));
|
||||
}
|
||||
|
||||
count(): Promise<number> {
|
||||
return this.tx(this.name, store => store.count(), true);
|
||||
}
|
||||
|
||||
put(key: K, value: T): Promise<void> {
|
||||
return this.tx(this.name, store => store.put(value, key));
|
||||
}
|
||||
|
||||
getAll(): Promise<T[]> {
|
||||
return this.tx(this.name, store => store.getAll(), true);
|
||||
}
|
||||
|
||||
getAllKeys(): Promise<K[]> {
|
||||
return this.tx(this.name, store => store.getAllKeys(), true);
|
||||
}
|
||||
|
||||
get(key: K): Promise<T> {
|
||||
return this.tx(this.name, store => store.get(key), true);
|
||||
}
|
||||
|
||||
delete(key: K): Promise<void> {
|
||||
return this.tx(this.name, store => store.delete(key));
|
||||
}
|
||||
|
||||
clear(): Promise<void> {
|
||||
return this.tx(this.name, store => store.clear());
|
||||
}
|
||||
}
|
||||
@ -4,6 +4,7 @@ export * from './aset';
|
||||
export * from './cache';
|
||||
export * from './color';
|
||||
export * from './csv';
|
||||
export * from './database';
|
||||
export * from './files';
|
||||
export * from './emitter';
|
||||
export * from './errors';
|
||||
|
||||
Reference in New Issue
Block a user